Desugar compound assignments

Author: hvitved

ql/src/codeql_ruby/ast/Literal.qll

@@ -752,31 +752,25 @@ class HashLiteral extends Literal, THashLiteral {
  * ```
  */
 class RangeLiteral extends Literal, TRangeLiteral {
-  private Generated::Range g;
-
-  RangeLiteral() { this = TRangeLiteral(g) }
-
   final override string getAPrimaryQlClass() { result = "RangeLiteral" }
 
   /** Gets the begin expression of this range, if any. */
-  final Expr getBegin() { toGenerated(result) = g.getBegin() }
+  Expr getBegin() { none() }
 
   /** Gets the end expression of this range, if any. */
-  final Expr getEnd() { toGenerated(result) = g.getEnd() }
+  Expr getEnd() { none() }
 
   /**
    * Holds if the range is inclusive of the end value, i.e. uses the `..`
    * operator.
    */
-  final predicate isInclusive() { g instanceof @range_dotdot }
+  predicate isInclusive() { none() }
 
   /**
    * Holds if the range is exclusive of the end value, i.e. uses the `...`
    * operator.
    */
-  final predicate isExclusive() { g instanceof @range_dotdotdot }
-
-  final override string toString() { result = "_ " + g.getOperator() + " _" }
+  predicate isExclusive() { none() }
 
   final override AstNode getAChild(string pred) {
     result = super.getAChild(pred)
@@ -785,6 +779,44 @@ class RangeLiteral extends Literal, TRangeLiteral {
     or
     pred = "getEnd" and result = this.getEnd()
   }
+
+  final override string toString() {
+    exists(string op |
+      this.isInclusive() and op = ".."
+      or
+      this.isExclusive() and op = "..."
+    |
+      result = "_ " + op + " _"
+    )
+  }
+}
+
+private class RangeLiteralReal extends RangeLiteral, TRangeLiteralReal {
+  private Generated::Range g;
+
+  RangeLiteralReal() { this = TRangeLiteralReal(g) }
+
+  final override Expr getBegin() { toGenerated(result) = g.getBegin() }
+
+  final override Expr getEnd() { toGenerated(result) = g.getEnd() }
+
+  final override predicate isInclusive() { g instanceof @range_dotdot }
+
+  final override predicate isExclusive() { g instanceof @range_dotdotdot }
+}
+
+private class RangeLiteralSynth extends RangeLiteral, TRangeLiteralSynth {
+  private boolean inclusive;
+
+  RangeLiteralSynth() { this = TRangeLiteralSynth(_, _, inclusive) }
+
+  final override Expr getBegin() { result = TIntegerLiteralSynth(this, 0, _) }
+
+  final override Expr getEnd() { result = TIntegerLiteralSynth(this, 1, _) }
+
+  final override predicate isInclusive() { inclusive = true }
+
+  final override predicate isExclusive() { inclusive = false }
 }
 
 /**

ql/src/codeql_ruby/ast/Operation.qll

@@ -91,12 +91,8 @@ class UnaryMinusExpr extends UnaryArithmeticOperation, TUnaryMinusExpr {
  * foo(*args)
  * ```
  */
-class SplatExpr extends UnaryOperation, TSplatArgument {
-  private Generated::SplatArgument g;
-
-  SplatExpr() { this = TSplatArgument(g) }
-
-  final override Expr getOperand() { toGenerated(result) = g.getChild() }
+class SplatExpr extends UnaryOperation, TSplatExpr {
+  final override Expr getOperand() { result = this.(SplatExprImpl).getOperandImpl() }
 
   final override string getOperator() { result = "*" }
 
@@ -109,10 +105,10 @@ class SplatExpr extends UnaryOperation, TSplatArgument {
  * foo(**options)
  * ```
  */
-class HashSplatExpr extends UnaryOperation, THashSplatArgument {
+class HashSplatExpr extends UnaryOperation, THashSplatExpr {
   private Generated::HashSplatArgument g;
 
-  HashSplatExpr() { this = THashSplatArgument(g) }
+  HashSplatExpr() { this = THashSplatExpr(g) }
 
   final override Expr getOperand() { toGenerated(result) = g.getChild() }
 

ql/src/codeql_ruby/ast/Pattern.qll

@@ -1,6 +1,7 @@
 private import codeql_ruby.AST
 private import codeql.Locations
 private import internal.AST
+private import internal.Pattern
 private import internal.TreeSitter
 private import internal.Variable
 
@@ -62,20 +63,9 @@ class VariablePattern extends Pattern, LhsExpr, TVariablePattern { }
 class TuplePattern extends Pattern, TTuplePattern {
   override string getAPrimaryQlClass() { result = "TuplePattern" }
 
-  private Generated::AstNode getChild(int i) {
-    result = toGenerated(this).(Generated::DestructuredParameter).getChild(i)
-    or
-    result = toGenerated(this).(Generated::DestructuredLeftAssignment).getChild(i)
-    or
-    toGenerated(this) =
-      any(Generated::LeftAssignmentList lal |
-        if
-          strictcount(int j | exists(lal.getChild(j))) = 1 and
-          lal.getChild(0) instanceof Generated::DestructuredLeftAssignment
-        then result = lal.getChild(0).(Generated::DestructuredLeftAssignment).getChild(i)
-        else result = lal.getChild(i)
-      )
-  }
+  private TuplePatternImpl getImpl() { result = toGenerated(this) }
+
+  private Generated::AstNode getChild(int i) { result = this.getImpl().getChildNode(i) }
 
   /** Gets the `i`th pattern in this tuple pattern. */
   final Pattern getElement(int i) {
@@ -96,9 +86,7 @@ class TuplePattern extends Pattern, TTuplePattern {
    * a, b, *rest, c, d = value
    * ```
    */
-  final int getRestIndex() {
-    result = unique(int i | getChild(i) instanceof Generated::RestAssignment)
-  }
+  final int getRestIndex() { result = this.getImpl().getRestIndex() }
 
   override Variable getAVariable() { result = this.getElement(_).getAVariable() }
 

ql/src/codeql_ruby/ast/internal/AST.qll

@@ -138,7 +138,7 @@ private module Cached {
     } or
     THashKeySymbolLiteral(Generated::HashKeySymbol g) or
     THashLiteral(Generated::Hash g) or
-    THashSplatArgument(Generated::HashSplatArgument g) or
+    THashSplatExpr(Generated::HashSplatArgument g) or
     THashSplatParameter(Generated::HashSplatParameter g) or
     THereDoc(Generated::HeredocBeginning g) or
     TIdentifierMethodCall(Generated::Identifier g) { isIdentifierMethodCall(g) } or
@@ -198,7 +198,10 @@ private module Cached {
     TParenthesizedExpr(Generated::ParenthesizedStatements g) or
     TRShiftExprReal(Generated::Binary g) { g instanceof @binary_ranglerangle } or
     TRShiftExprSynth(AST::AstNode parent, int i) { mkSynthChild(RShiftExprKind(), parent, i) } or
-    TRangeLiteral(Generated::Range g) or
+    TRangeLiteralReal(Generated::Range g) or
+    TRangeLiteralSynth(AST::AstNode parent, int i, boolean inclusive) {
+      mkSynthChild(RangeLiteralKind(inclusive), parent, i)
+    } or
     TRationalLiteral(Generated::Rational g) or
     TRedoStmt(Generated::Redo g) or
     TRegexLiteral(Generated::Regex g) or
@@ -232,7 +235,8 @@ private module Cached {
     TSingletonClass(Generated::SingletonClass g) or
     TSingletonMethod(Generated::SingletonMethod g) or
     TSpaceshipExpr(Generated::Binary g) { g instanceof @binary_langleequalrangle } or
-    TSplatArgument(Generated::SplatArgument g) or
+    TSplatExprReal(Generated::SplatArgument g) or
+    TSplatExprSynth(AST::AstNode parent, int i) { mkSynthChild(SplatExprKind(), parent, i) } or
     TSplatParameter(Generated::SplatParameter g) or
     TStmtSequenceSynth(AST::AstNode parent, int i) { mkSynthChild(StmtSequenceKind(), parent, i) } or
     TStringArrayLiteral(Generated::StringArray g) or
@@ -337,7 +341,7 @@ private module Cached {
     n = TGlobalVariableAccessReal(result, _) or
     n = THashKeySymbolLiteral(result) or
     n = THashLiteral(result) or
-    n = THashSplatArgument(result) or
+    n = THashSplatExpr(result) or
     n = THashSplatParameter(result) or
     n = THereDoc(result) or
     n = TIdentifierMethodCall(result) or
@@ -367,7 +371,7 @@ private module Cached {
     n = TPair(result) or
     n = TParenthesizedExpr(result) or
     n = TRShiftExprReal(result) or
-    n = TRangeLiteral(result) or
+    n = TRangeLiteralReal(result) or
     n = TRationalLiteral(result) or
     n = TRedoStmt(result) or
     n = TRegexLiteral(result) or
@@ -388,7 +392,7 @@ private module Cached {
     n = TSingletonClass(result) or
     n = TSingletonMethod(result) or
     n = TSpaceshipExpr(result) or
-    n = TSplatArgument(result) or
+    n = TSplatExprReal(result) or
     n = TSplatParameter(result) or
     n = TStringArrayLiteral(result) or
     n = TStringConcatenation(result) or
@@ -458,10 +462,14 @@ private module Cached {
     or
     result = TMulExprSynth(parent, i)
     or
+    result = TRangeLiteralSynth(parent, i, _)
+    or
     result = TRShiftExprSynth(parent, i)
     or
     result = TSelfSynth(parent, i)
     or
+    result = TSplatExprSynth(parent, i)
+    or
     result = TStmtSequenceSynth(parent, i)
     or
     result = TSubExprSynth(parent, i)
@@ -493,18 +501,11 @@ private module Cached {
     )
   }
 
-  private Location synthLocation(AST::AstNode n) {
-    exists(Synthesis s, AST::AstNode parent, int i |
-      s.child(parent, i, _, SomeLocation(result)) and
-      n = getSynthChild(parent, i)
-    )
-  }
-
   cached
   Location getLocation(AST::AstNode n) {
-    result = synthLocation(n)
+    synthLocation(n, result)
     or
-    not exists(synthLocation(n)) and
+    not synthLocation(n, _) and
     result = toGeneratedInclSynth(n).getLocation()
   }
 }
@@ -538,9 +539,10 @@ class TSelf = TSelfReal or TSelfSynth;
 
 class TExpr =
   TSelf or TArgumentList or TRescueClause or TRescueModifierExpr or TPair or TStringConcatenation or
-      TCall or TBlockArgument or TSplatArgument or THashSplatArgument or TConstantAccess or
-      TControlExpr or TWhenExpr or TLiteral or TCallable or TVariableAccess or TStmtSequence or
-      TOperation or TSimpleParameter;
+      TCall or TBlockArgument or TConstantAccess or TControlExpr or TWhenExpr or TLiteral or
+      TCallable or TVariableAccess or TStmtSequence or TOperation or TSimpleParameter;
+
+class TSplatExpr = TSplatExprReal or TSplatExprSynth;
 
 class TStmtSequence =
   TBeginBlock or TEndBlock or TThen or TElse or TDo or TEnsure or TStringInterpolationComponent or
@@ -586,7 +588,7 @@ class TOperation = TUnaryOperation or TBinaryOperation or TAssignment;
 
 class TUnaryOperation =
   TUnaryLogicalOperation or TUnaryArithmeticOperation or TUnaryBitwiseOperation or TDefinedExpr or
-      TSplatArgument or THashSplatArgument;
+      TSplatExpr or THashSplatExpr;
 
 class TUnaryLogicalOperation = TNotExpr;
 
@@ -624,6 +626,8 @@ class TBinaryBitwiseOperation =
 
 class TLShiftExpr = TLShiftExprReal or TLShiftExprSynth;
 
+class TRangeLiteral = TRangeLiteralReal or TRangeLiteralSynth;
+
 class TRShiftExpr = TRShiftExprReal or TRShiftExprSynth;
 
 class TBitwiseAndExpr = TBitwiseAndExprReal or TBitwiseAndExprSynth;

ql/src/codeql_ruby/ast/internal/Operation.qll

@@ -29,3 +29,19 @@ class AssignOperationImpl extends AssignmentImpl, AssignOperation {
 
   final override AstNode getRightOperandImpl() { toGenerated(result) = g.getRight() }
 }
+
+abstract class SplatExprImpl extends SplatExpr {
+  abstract Expr getOperandImpl();
+}
+
+class SplatExprReal extends SplatExprImpl, TSplatExprReal {
+  private Generated::SplatArgument g;
+
+  SplatExprReal() { this = TSplatExprReal(g) }
+
+  final override Expr getOperandImpl() { toGenerated(result) = g.getChild() }
+}
+
+class SplatExprSynth extends SplatExprImpl, TSplatExprSynth {
+  final override Expr getOperandImpl() { synthChild(this, 0, result) }
+}

ql/src/codeql_ruby/ast/internal/Pattern.qll

@@ -0,0 +1,32 @@
+private import codeql_ruby.AST
+private import AST
+private import TreeSitter
+
+abstract class TuplePatternImpl extends Generated::AstNode {
+  abstract Generated::AstNode getChildNode(int i);
+
+  final int getRestIndex() {
+    result = unique(int i | this.getChildNode(i) instanceof Generated::RestAssignment)
+  }
+}
+
+class TuplePatternParameterImpl extends TuplePatternImpl, Generated::DestructuredParameter {
+  override Generated::AstNode getChildNode(int i) { result = this.getChild(i) }
+}
+
+class DestructuredLeftAssignmentImpl extends TuplePatternImpl, Generated::DestructuredLeftAssignment {
+  override Generated::AstNode getChildNode(int i) { result = this.getChild(i) }
+}
+
+class LeftAssignmentListImpl extends TuplePatternImpl, Generated::LeftAssignmentList {
+  override Generated::AstNode getChildNode(int i) {
+    this =
+      any(Generated::LeftAssignmentList lal |
+        if
+          strictcount(int j | exists(lal.getChild(j))) = 1 and
+          lal.getChild(0) instanceof Generated::DestructuredLeftAssignment
+        then result = lal.getChild(0).(Generated::DestructuredLeftAssignment).getChild(i)
+        else result = lal.getChild(i)
+      )
+  }
+}