Merge pull request #2971 from matt-gretton-dann/codeql-c-extractor/40-spaceship

C++20 Add DB Support for the <=> operator

cpp/ql/src/semmle/code/cpp/exprs/ArithmeticOperation.qll

@@ -16,7 +16,7 @@ class UnaryMinusExpr extends UnaryArithmeticOperation, @arithnegexpr {
 
   override string getCanonicalQLClass() { result = "UnaryMinusExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -30,7 +30,7 @@ class UnaryPlusExpr extends UnaryArithmeticOperation, @unaryplusexpr {
 
   override string getCanonicalQLClass() { result = "UnaryPlusExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -109,7 +109,7 @@ class PrefixIncrExpr extends IncrementOperation, PrefixCrementOperation, @preinc
 
   override string getCanonicalQLClass() { result = "PrefixIncrExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -125,7 +125,7 @@ class PrefixDecrExpr extends DecrementOperation, PrefixCrementOperation, @predec
 
   override string getCanonicalQLClass() { result = "PrefixDecrExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -141,7 +141,7 @@ class PostfixIncrExpr extends IncrementOperation, PostfixCrementOperation, @post
 
   override string getCanonicalQLClass() { result = "PostfixIncrExpr" }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 
   override string toString() { result = "... " + getOperator() }
 }
@@ -159,7 +159,7 @@ class PostfixDecrExpr extends DecrementOperation, PostfixCrementOperation, @post
 
   override string getCanonicalQLClass() { result = "PostfixDecrExpr" }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 
   override string toString() { result = "... " + getOperator() }
 }
@@ -210,7 +210,7 @@ class AddExpr extends BinaryArithmeticOperation, @addexpr {
 
   override string getCanonicalQLClass() { result = "AddExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -224,7 +224,7 @@ class SubExpr extends BinaryArithmeticOperation, @subexpr {
 
   override string getCanonicalQLClass() { result = "SubExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -238,7 +238,7 @@ class MulExpr extends BinaryArithmeticOperation, @mulexpr {
 
   override string getCanonicalQLClass() { result = "MulExpr" }
 
-  override int getPrecedence() { result = 13 }
+  override int getPrecedence() { result = 14 }
 }
 
 /**
@@ -252,7 +252,7 @@ class DivExpr extends BinaryArithmeticOperation, @divexpr {
 
   override string getCanonicalQLClass() { result = "DivExpr" }
 
-  override int getPrecedence() { result = 13 }
+  override int getPrecedence() { result = 14 }
 }
 
 /**
@@ -266,7 +266,7 @@ class RemExpr extends BinaryArithmeticOperation, @remexpr {
 
   override string getCanonicalQLClass() { result = "RemExpr" }
 
-  override int getPrecedence() { result = 13 }
+  override int getPrecedence() { result = 14 }
 }
 
 /**
@@ -283,7 +283,7 @@ class ImaginaryMulExpr extends BinaryArithmeticOperation, @jmulexpr {
 
   override string getCanonicalQLClass() { result = "ImaginaryMulExpr" }
 
-  override int getPrecedence() { result = 13 }
+  override int getPrecedence() { result = 14 }
 }
 
 /**
@@ -300,7 +300,7 @@ class ImaginaryDivExpr extends BinaryArithmeticOperation, @jdivexpr {
 
   override string getCanonicalQLClass() { result = "ImaginaryDivExpr" }
 
-  override int getPrecedence() { result = 13 }
+  override int getPrecedence() { result = 14 }
 }
 
 /**
@@ -318,7 +318,7 @@ class RealImaginaryAddExpr extends BinaryArithmeticOperation, @fjaddexpr {
 
   override string getCanonicalQLClass() { result = "RealImaginaryAddExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -336,7 +336,7 @@ class ImaginaryRealAddExpr extends BinaryArithmeticOperation, @jfaddexpr {
 
   override string getCanonicalQLClass() { result = "ImaginaryRealAddExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -354,7 +354,7 @@ class RealImaginarySubExpr extends BinaryArithmeticOperation, @fjsubexpr {
 
   override string getCanonicalQLClass() { result = "RealImaginarySubExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -372,7 +372,7 @@ class ImaginaryRealSubExpr extends BinaryArithmeticOperation, @jfsubexpr {
 
   override string getCanonicalQLClass() { result = "ImaginaryRealSubExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -416,7 +416,7 @@ class PointerAddExpr extends PointerArithmeticOperation, @paddexpr {
 
   override string getCanonicalQLClass() { result = "PointerAddExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -431,7 +431,7 @@ class PointerSubExpr extends PointerArithmeticOperation, @psubexpr {
 
   override string getCanonicalQLClass() { result = "PointerSubExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }
 
 /**
@@ -446,5 +446,5 @@ class PointerDiffExpr extends PointerArithmeticOperation, @pdiffexpr {
 
   override string getCanonicalQLClass() { result = "PointerDiffExpr" }
 
-  override int getPrecedence() { result = 12 }
+  override int getPrecedence() { result = 13 }
 }

cpp/ql/src/semmle/code/cpp/exprs/BitwiseOperation.qll

@@ -14,7 +14,7 @@ class UnaryBitwiseOperation extends UnaryOperation, @un_bitwise_op_expr { }
 class ComplementExpr extends UnaryBitwiseOperation, @complementexpr {
   override string getOperator() { result = "~" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   override string getCanonicalQLClass() { result = "ComplementExpr" }
 }
@@ -33,7 +33,7 @@ class BinaryBitwiseOperation extends BinaryOperation, @bin_bitwise_op_expr { }
 class LShiftExpr extends BinaryBitwiseOperation, @lshiftexpr {
   override string getOperator() { result = "<<" }
 
-  override int getPrecedence() { result = 11 }
+  override int getPrecedence() { result = 12 }
 
   override string getCanonicalQLClass() { result = "LShiftExpr" }
 }
@@ -47,7 +47,7 @@ class LShiftExpr extends BinaryBitwiseOperation, @lshiftexpr {
 class RShiftExpr extends BinaryBitwiseOperation, @rshiftexpr {
   override string getOperator() { result = ">>" }
 
-  override int getPrecedence() { result = 11 }
+  override int getPrecedence() { result = 12 }
 
   override string getCanonicalQLClass() { result = "RShiftExpr" }
 }

cpp/ql/src/semmle/code/cpp/exprs/Call.qll

@@ -74,7 +74,7 @@ abstract class Call extends Expr, NameQualifiableElement {
    */
   abstract Function getTarget();
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 
   override string toString() { none() }
 

cpp/ql/src/semmle/code/cpp/exprs/Cast.qll

@@ -84,7 +84,7 @@ class CStyleCast extends Cast, @c_style_cast {
 
   override string getCanonicalQLClass() { result = "CStyleCast" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -103,7 +103,7 @@ class StaticCast extends Cast, @static_cast {
 
   override string getCanonicalQLClass() { result = "StaticCast" }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 }
 
 /**
@@ -121,7 +121,7 @@ class ConstCast extends Cast, @const_cast {
 
   override string getCanonicalQLClass() { result = "ConstCast" }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 }
 
 /**
@@ -139,7 +139,7 @@ class ReinterpretCast extends Cast, @reinterpret_cast {
 
   override string getCanonicalQLClass() { result = "ReinterpretCast" }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 }
 
 private predicate isArithmeticOrEnum(Type type) {
@@ -608,7 +608,7 @@ class PrvalueAdjustmentConversion extends Cast {
 class DynamicCast extends Cast, @dynamic_cast {
   override string toString() { result = "dynamic_cast<" + this.getType().getName() + ">..." }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 
   override string getCanonicalQLClass() { result = "DynamicCast" }
 
@@ -631,7 +631,7 @@ class UuidofOperator extends Expr, @uuidof {
     else result = "__uuidof(0)"
   }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   /** Gets the contained type. */
   Type getTypeOperand() { uuidof_bind(underlyingElement(this), unresolveElement(result)) }
@@ -669,7 +669,7 @@ class TypeidOperator extends Expr, @type_id {
 
   override string toString() { result = "typeid ..." }
 
-  override int getPrecedence() { result = 16 }
+  override int getPrecedence() { result = 17 }
 
   override predicate mayBeImpure() { this.getExpr().mayBeImpure() }
 
@@ -700,7 +700,7 @@ class SizeofPackOperator extends Expr, @sizeof_pack {
  * A C/C++ sizeof expression.
  */
 abstract class SizeofOperator extends Expr, @runtime_sizeof {
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -763,7 +763,7 @@ class SizeofTypeOperator extends SizeofOperator {
  * A C++11 `alignof` expression.
  */
 abstract class AlignofOperator extends Expr, @runtime_alignof {
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**

cpp/ql/src/semmle/code/cpp/exprs/Expr.qll

@@ -642,7 +642,7 @@ class AddressOfExpr extends UnaryOperation, @address_of {
 
   override string getOperator() { result = "&" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   override predicate mayBeImpure() { this.getOperand().mayBeImpure() }
 
@@ -664,7 +664,7 @@ class ReferenceToExpr extends Conversion, @reference_to {
 
   override string getCanonicalQLClass() { result = "ReferenceToExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**
@@ -687,7 +687,7 @@ class PointerDereferenceExpr extends UnaryOperation, @indirect {
 
   override string getOperator() { result = "*" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   override predicate mayBeImpure() {
     this.getChild(0).mayBeImpure() or
@@ -721,7 +721,7 @@ class ReferenceDereferenceExpr extends Conversion, @ref_indirect {
  * A C++ `new` or `new[]` expression.
  */
 class NewOrNewArrayExpr extends Expr, @any_new_expr {
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   /**
    * Gets the `operator new` or `operator new[]` that allocates storage.
@@ -898,7 +898,7 @@ class DeleteExpr extends Expr, @delete_expr {
 
   override string getCanonicalQLClass() { result = "DeleteExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   /**
    * Gets the compile-time type of the object being deleted.
@@ -972,7 +972,7 @@ class DeleteArrayExpr extends Expr, @delete_array_expr {
 
   override string getCanonicalQLClass() { result = "DeleteArrayExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 
   /**
    * Gets the element type of the array being deleted.
@@ -1216,3 +1216,18 @@ private predicate constantTemplateLiteral(Expr e) {
   or
   constantTemplateLiteral(e.(Cast).getExpr())
 }
+
+/**
+ * A C++ three-way comparison operation, also known as the _spaceship
+ * operation_.  This is specific to C++20 and later.
+ * ```
+ * auto c = (a <=> b);
+ * ```
+ */
+class SpaceshipExpr extends BinaryOperation, @spaceshipexpr {
+  override string getCanonicalQLClass() { result = "SpaceshipExpr" }
+
+  override int getPrecedence() { result = 11 }
+
+  override string getOperator() { result = "<=>" }
+}

cpp/ql/src/semmle/code/cpp/exprs/LogicalOperation.qll

@@ -16,7 +16,7 @@ class NotExpr extends UnaryLogicalOperation, @notexpr {
 
   override string getCanonicalQLClass() { result = "NotExpr" }
 
-  override int getPrecedence() { result = 15 }
+  override int getPrecedence() { result = 16 }
 }
 
 /**

cpp/ql/src/semmlecode.cpp.dbscheme

@@ -1231,6 +1231,7 @@ funbind(
              | @ltexpr
              | @geexpr
              | @leexpr
+             | @spaceshipexpr
              ;
 
 @bin_bitwise_op_expr = @lshiftexpr
@@ -1636,6 +1637,7 @@ case @expr.kind of
 | 323 = @vec_fill
 | 324 = @builtinconvertvector
 | 325 = @builtincomplex
+| 326 = @spaceshipexpr
 ;
 
 new_allocated_type(

cpp/upgrades/c9ac0461491edef3b1ab79f03d007a47522dda90/upgrade.properties

@@ -0,0 +1,2 @@
+description: Add support for C++'s <=> operator
+compatibility: backwards