Merge pull request #183 from github/hvitved/assign-op-desugar

Desugar setter assignments

Author: hvitved

ql/src/codeql_ruby/AST.qll

@@ -51,7 +51,7 @@ class AstNode extends TAstNode {
   string toString() { none() }
 
   /** Gets the location of this node. */
-  Location getLocation() { result = toGeneratedInclSynth(this).getLocation() }
+  Location getLocation() { result = getLocation(this) }
 
   /** Gets a child node of this `AstNode`. */
   final AstNode getAChild() { result = this.getAChild(_) }

ql/src/codeql_ruby/ast/Call.qll

@@ -1,5 +1,6 @@
 private import codeql_ruby.AST
 private import internal.AST
+private import internal.Call
 private import internal.TreeSitter
 
 /**
@@ -20,7 +21,7 @@ class Call extends Expr, TCall {
    * yield 0, bar: 1
    * ```
    */
-  Expr getArgument(int n) { none() }
+  final Expr getArgument(int n) { result = this.(CallImpl).getArgumentImpl(n) }
 
   /**
    * Gets an argument of this method call.
@@ -46,24 +47,11 @@ class Call extends Expr, TCall {
   /**
    * Gets the number of arguments of this method call.
    */
-  final int getNumberOfArguments() { result = count(this.getAnArgument()) }
+  final int getNumberOfArguments() { result = this.(CallImpl).getNumberOfArgumentsImpl() }
 
   override AstNode getAChild(string pred) { pred = "getArgument" and result = this.getArgument(_) }
 }
 
-bindingset[s]
-private string getMethodName(MethodCall mc, string s) {
-  (
-    not mc instanceof LhsExpr
-    or
-    mc.getParent() instanceof AssignOperation
-  ) and
-  result = s
-  or
-  mc instanceof LhsExpr and
-  result = s + "="
-}
-
 /**
  * A method call.
  */
@@ -83,22 +71,7 @@ class MethodCall extends Call, TMethodCall {
    * the call to `qux` is the `Expr` for `Baz`; for the call to `corge` there
    * is no result.
    */
-  Expr getReceiver() { none() }
-
-  /**
-   * Holds if the receiver is `self` or there is no receiver, which has the same
-   * meaning as an explict `self`. For example:
-   *
-   * ```rb
-   * self.foo
-   * foo
-   * ```
-   */
-  predicate receiverIsSelf() {
-    this.getReceiver() instanceof Self
-    or
-    not exists(this.getReceiver())
-  }
+  final Expr getReceiver() { result = this.(MethodCallImpl).getReceiverImpl() }
 
   /**
    * Gets the name of the method being called. For example, in:
@@ -109,7 +82,7 @@ class MethodCall extends Call, TMethodCall {
    *
    * the result is `"bar"`.
    */
-  string getMethodName() { none() }
+  final string getMethodName() { result = this.(MethodCallImpl).getMethodNameImpl() }
 
   /**
    * Gets the block of this method call, if any.
@@ -119,79 +92,27 @@ class MethodCall extends Call, TMethodCall {
    */
   Block getBlock() { none() }
 
-  override string toString() { result = "call to " + concat(this.getMethodName(), "/") }
+  override string toString() { result = "call to " + this.getMethodName() }
 
-  final override AstNode getAChild(string pred) {
-    result = Call.super.getAChild(pred)
+  override AstNode getAChild(string pred) {
+    result = super.getAChild(pred)
     or
     pred = "getReceiver" and result = this.getReceiver()
     or
     pred = "getBlock" and result = this.getBlock()
   }
 }
 
-private class IdentifierMethodCall extends MethodCall, TIdentifierMethodCall {
-  private Generated::Identifier g;
-
-  IdentifierMethodCall() { this = TIdentifierMethodCall(g) }
-
-  final override string getMethodName() { result = getMethodName(this, g.getValue()) }
-
-  final override Self getReceiver() { result = TSelfSynth(this, 0) }
-}
-
-private class ScopeResolutionMethodCall extends MethodCall, TScopeResolutionMethodCall {
-  private Generated::ScopeResolution g;
-  private Generated::Identifier i;
-
-  ScopeResolutionMethodCall() { this = TScopeResolutionMethodCall(g, i) }
-
-  final override Expr getReceiver() { toGenerated(result) = g.getScope() }
-
-  final override string getMethodName() { result = getMethodName(this, i.getValue()) }
-}
-
-private class RegularMethodCall extends MethodCall, TRegularMethodCall {
-  private Generated::Call g;
-
-  RegularMethodCall() { this = TRegularMethodCall(g) }
-
-  final override Expr getReceiver() {
-    toGenerated(result) = g.getReceiver()
-    or
-    not exists(g.getReceiver()) and
-    toGenerated(result) = g.getMethod().(Generated::ScopeResolution).getScope()
-    or
-    result = TSelfSynth(this, 0)
-  }
-
-  final override string getMethodName() {
-    exists(string res | result = getMethodName(this, res) |
-      res = "call" and g.getMethod() instanceof Generated::ArgumentList
-      or
-      res = g.getMethod().(Generated::Token).getValue()
-      or
-      res = g.getMethod().(Generated::ScopeResolution).getName().(Generated::Token).getValue()
-    )
-  }
-
-  final override Expr getArgument(int n) {
-    toGenerated(result) = g.getArguments().getChild(n)
-    or
-    toGenerated(result) = g.getMethod().(Generated::ArgumentList).getChild(n)
-  }
-
-  final override Block getBlock() { toGenerated(result) = g.getBlock() }
-}
-
 /**
  * A call to a setter method.
  * ```rb
  * self.foo = 10
  * a[0] = 10
  * ```
  */
-class SetterMethodCall extends MethodCall, LhsExpr {
+class SetterMethodCall extends MethodCall {
+  SetterMethodCall() { this = TMethodCallSynth(_, _, _, true, _) }
+
   final override string getAPrimaryQlClass() { result = "SetterMethodCall" }
 }
 
@@ -202,18 +123,8 @@ class SetterMethodCall extends MethodCall, LhsExpr {
  * ```
  */
 class ElementReference extends MethodCall, TElementReference {
-  private Generated::ElementReference g;
-
-  ElementReference() { this = TElementReference(g) }
-
   final override string getAPrimaryQlClass() { result = "ElementReference" }
 
-  final override Expr getReceiver() { toGenerated(result) = g.getObject() }
-
-  final override string getMethodName() { result = getMethodName(this, "[]") }
-
-  final override Expr getArgument(int n) { toGenerated(result) = g.getChild(n) }
-
   final override string toString() { result = "...[...]" }
 }
 
@@ -224,14 +135,12 @@ class ElementReference extends MethodCall, TElementReference {
  * ```
  */
 class YieldCall extends Call, TYieldCall {
-  private Generated::Yield g;
+  Generated::Yield g;
 
   YieldCall() { this = TYieldCall(g) }
 
   final override string getAPrimaryQlClass() { result = "YieldCall" }
 
-  final override Expr getArgument(int n) { toGenerated(result) = g.getChild().getChild(n) }
-
   final override string toString() { result = "yield ..." }
 }
 
@@ -249,28 +158,6 @@ class SuperCall extends MethodCall, TSuperCall {
   final override string getAPrimaryQlClass() { result = "SuperCall" }
 }
 
-private class TokenSuperCall extends SuperCall, TTokenSuperCall {
-  private Generated::Super g;
-
-  TokenSuperCall() { this = TTokenSuperCall(g) }
-
-  final override string getMethodName() { result = getMethodName(this, g.getValue()) }
-}
-
-private class RegularSuperCall extends SuperCall, TRegularSuperCall {
-  private Generated::Call g;
-
-  RegularSuperCall() { this = TRegularSuperCall(g) }
-
-  final override string getMethodName() {
-    result = getMethodName(this, g.getMethod().(Generated::Super).getValue())
-  }
-
-  final override Expr getArgument(int n) { toGenerated(result) = g.getArguments().getChild(n) }
-
-  final override Block getBlock() { toGenerated(result) = g.getBlock() }
-}
-
 /**
  * A block argument in a method call.
  * ```rb

ql/src/codeql_ruby/ast/Literal.qll

@@ -42,14 +42,22 @@ class NumericLiteral extends Literal, TNumericLiteral { }
  * ```
  */
 class IntegerLiteral extends NumericLiteral, TIntegerLiteral {
+  /** Gets the numerical value of this integer literal. */
+  int getValue() { none() }
+
+  final override string toString() { result = this.getValueText() }
+
+  final override string getAPrimaryQlClass() { result = "IntegerLiteral" }
+}
+
+private class IntegerLiteralReal extends IntegerLiteral, TIntegerLiteralReal {
   private Generated::Integer g;
 
-  IntegerLiteral() { this = TIntegerLiteral(g) }
+  IntegerLiteralReal() { this = TIntegerLiteralReal(g) }
 
   final override string getValueText() { result = g.getValue() }
 
-  /** Gets the numerical value of this integer literal. */
-  final int getValue() {
+  final override int getValue() {
     exists(string s, string values, string str |
       s = this.getValueText().toLowerCase() and
       (
@@ -83,10 +91,16 @@ class IntegerLiteral extends NumericLiteral, TIntegerLiteral {
         )
     )
   }
+}
 
-  final override string toString() { result = this.getValueText() }
+private class IntegerLiteralSynth extends IntegerLiteral, TIntegerLiteralSynth {
+  private int value;
 
-  final override string getAPrimaryQlClass() { result = "IntegerLiteral" }
+  IntegerLiteralSynth() { this = TIntegerLiteralSynth(_, _, value) }
+
+  final override string getValueText() { result = value.toString() }
+
+  final override int getValue() { result = value }
 }
 
 /**

ql/src/codeql_ruby/ast/Operation.qll

@@ -1,6 +1,7 @@
 private import codeql_ruby.AST
 private import internal.AST
 private import internal.TreeSitter
+private import internal.Operation
 
 /**
  * An operation.
@@ -492,10 +493,10 @@ class NoRegexMatchExpr extends BinaryOperation, TNoRegexMatchExpr {
  */
 class Assignment extends Operation, TAssignment {
   /** Gets the left hand side of this assignment. */
-  Pattern getLeftOperand() { none() }
+  final Pattern getLeftOperand() { result = this.(AssignmentImpl).getLeftOperandImpl() }
 
   /** Gets the right hand side of this assignment. */
-  Expr getRightOperand() { none() }
+  final Expr getRightOperand() { result = this.(AssignmentImpl).getRightOperandImpl() }
 
   final override Expr getAnOperand() {
     result = this.getLeftOperand() or result = this.getRightOperand()
@@ -524,35 +525,15 @@ class AssignExpr extends Assignment, TAssignExpr {
   final override string getAPrimaryQlClass() { result = "AssignExpr" }
 }
 
-private class AssignExprReal extends AssignExpr, TAssignExprReal {
-  private Generated::Assignment g;
-
-  AssignExprReal() { this = TAssignExprReal(g) }
-
-  final override Pattern getLeftOperand() { toGenerated(result) = g.getLeft() }
-
-  final override Expr getRightOperand() { toGenerated(result) = g.getRight() }
-}
-
-private class AssignExprSynth extends AssignExpr, TAssignExprSynth {
-  final override Pattern getLeftOperand() { synthChild(this, 0, result) }
-
-  final override Expr getRightOperand() { synthChild(this, 1, result) }
-}
-
 /**
  * A binary assignment operation other than `=`.
  */
 class AssignOperation extends Assignment, TAssignOperation {
-  private Generated::OperatorAssignment g;
+  Generated::OperatorAssignment g;
 
   AssignOperation() { g = toGenerated(this) }
 
   final override string getOperator() { result = g.getOperator() }
-
-  final override LhsExpr getLeftOperand() { toGenerated(result) = g.getLeft() }
-
-  final override Expr getRightOperand() { toGenerated(result) = g.getRight() }
 }
 
 /**

ql/src/codeql_ruby/ast/Variable.qll

@@ -75,7 +75,7 @@ class ClassVariable extends VariableReal, TClassVariable {
 /** An access to a variable. */
 class VariableAccess extends Expr, TVariableAccess {
   /** Gets the variable this identifier refers to. */
-  Variable getVariable() { none() }
+  final Variable getVariable() { result = this.(VariableAccessImpl).getVariableImpl() }
 
   /**
    * Holds if this access is a write access belonging to the explicit
@@ -126,8 +126,6 @@ class VariableReadAccess extends VariableAccess {
 
 /** An access to a local variable. */
 class LocalVariableAccess extends VariableAccess, TLocalVariableAccess {
-  override LocalVariable getVariable() { none() }
-
   final override string getAPrimaryQlClass() { result = "LocalVariableAccess" }
 
   /**
@@ -156,8 +154,6 @@ class LocalVariableReadAccess extends LocalVariableAccess, VariableReadAccess {
 
 /** An access to a global variable. */
 class GlobalVariableAccess extends VariableAccess, TGlobalVariableAccess {
-  override GlobalVariable getVariable() { none() }
-
   final override string getAPrimaryQlClass() { result = "GlobalVariableAccess" }
 }
 
@@ -169,14 +165,10 @@ class GlobalVariableReadAccess extends GlobalVariableAccess, VariableReadAccess
 
 /** An access to an instance variable. */
 class InstanceVariableAccess extends VariableAccess, TInstanceVariableAccess {
-  override InstanceVariable getVariable() { none() }
-
   final override string getAPrimaryQlClass() { result = "InstanceVariableAccess" }
 }
 
 /** An access to a class variable. */
 class ClassVariableAccess extends VariableAccess, TClassVariableAccess {
-  override ClassVariable getVariable() { none() }
-
   final override string getAPrimaryQlClass() { result = "ClassVariableAccess" }
 }