Merge pull request #310 from github/hvitved/more-instanceof

More uses of `instanceof` in the external/internal AST layer

Author: hvitved

ql/lib/codeql/ruby/ast/Call.qll

@@ -8,7 +8,7 @@ private import codeql.ruby.dataflow.internal.DataFlowImplCommon
 /**
  * A call.
  */
-class Call extends Expr, TCall {
+class Call extends Expr instanceof CallImpl {
   override string getAPrimaryQlClass() { result = "Call" }
 
   /**
@@ -23,7 +23,7 @@ class Call extends Expr, TCall {
    * yield 0, bar: 1
    * ```
    */
-  final Expr getArgument(int n) { result = this.(CallImpl).getArgumentImpl(n) }
+  final Expr getArgument(int n) { result = super.getArgumentImpl(n) }
 
   /**
    * Gets an argument of this method call.
@@ -49,7 +49,7 @@ class Call extends Expr, TCall {
   /**
    * Gets the number of arguments of this method call.
    */
-  final int getNumberOfArguments() { result = this.(CallImpl).getNumberOfArgumentsImpl() }
+  final int getNumberOfArguments() { result = super.getNumberOfArgumentsImpl() }
 
   /** Gets a potential target of this call, if any. */
   final Callable getATarget() {
@@ -59,7 +59,7 @@ class Call extends Expr, TCall {
   }
 
   override AstNode getAChild(string pred) {
-    result = super.getAChild(pred)
+    result = Expr.super.getAChild(pred)
     or
     pred = "getArgument" and result = this.getArgument(_)
   }
@@ -68,7 +68,7 @@ class Call extends Expr, TCall {
 /**
  * A method call.
  */
-class MethodCall extends Call, TMethodCall {
+class MethodCall extends Call instanceof MethodCallImpl {
   override string getAPrimaryQlClass() { result = "MethodCall" }
 
   /**
@@ -84,7 +84,7 @@ class MethodCall extends Call, TMethodCall {
    * the call to `qux` is the `Expr` for `Baz`; for the call to `corge` there
    * is no result.
    */
-  final Expr getReceiver() { result = this.(MethodCallImpl).getReceiverImpl() }
+  final Expr getReceiver() { result = super.getReceiverImpl() }
 
   /**
    * Gets the name of the method being called. For example, in:
@@ -95,20 +95,20 @@ class MethodCall extends Call, TMethodCall {
    *
    * the result is `"bar"`.
    */
-  final string getMethodName() { result = this.(MethodCallImpl).getMethodNameImpl() }
+  final string getMethodName() { result = super.getMethodNameImpl() }
 
   /**
    * Gets the block of this method call, if any.
    * ```rb
    * foo.each { |x| puts x }
    * ```
    */
-  Block getBlock() { none() }
+  final Block getBlock() { result = super.getBlockImpl() }
 
   override string toString() { result = "call to " + this.getMethodName() }
 
   override AstNode getAChild(string pred) {
-    result = super.getAChild(pred)
+    result = Call.super.getAChild(pred)
     or
     pred = "getReceiver" and result = this.getReceiver()
     or
@@ -135,7 +135,7 @@ class SetterMethodCall extends MethodCall, TMethodCallSynth {
  * a[0]
  * ```
  */
-class ElementReference extends MethodCall, TElementReference {
+class ElementReference extends MethodCall instanceof ElementReferenceImpl {
   final override string getAPrimaryQlClass() { result = "ElementReference" }
 
   final override string toString() { result = "...[...]" }
@@ -147,11 +147,7 @@ class ElementReference extends MethodCall, TElementReference {
  * yield x, y
  * ```
  */
-class YieldCall extends Call, TYieldCall {
-  Ruby::Yield g;
-
-  YieldCall() { this = TYieldCall(g) }
-
+class YieldCall extends Call instanceof YieldCallImpl {
   final override string getAPrimaryQlClass() { result = "YieldCall" }
 
   final override string toString() { result = "yield ..." }
@@ -167,7 +163,7 @@ class YieldCall extends Call, TYieldCall {
  * end
  * ```
  */
-class SuperCall extends MethodCall, TSuperCall {
+class SuperCall extends MethodCall instanceof SuperCallImpl {
   final override string getAPrimaryQlClass() { result = "SuperCall" }
 }
 

ql/lib/codeql/ruby/ast/Variable.qll

@@ -7,9 +7,9 @@ private import internal.TreeSitter
 private import internal.Variable
 
 /** A variable declared in a scope. */
-class Variable extends TVariable {
+class Variable instanceof VariableImpl {
   /** Gets the name of this variable. */
-  string getName() { none() }
+  final string getName() { result = super.getNameImpl() }
 
   /** Holds if the name of this variable is `name`. */
   final predicate hasName(string name) { this.getName() = name }
@@ -18,21 +18,23 @@ class Variable extends TVariable {
   final string toString() { result = this.getName() }
 
   /** Gets the location of this variable. */
-  Location getLocation() { none() }
+  final Location getLocation() { result = super.getLocationImpl() }
 
   /** Gets the scope this variable is declared in. */
-  Scope getDeclaringScope() { none() }
+  final Scope getDeclaringScope() {
+    toGenerated(result) = this.(VariableReal).getDeclaringScopeImpl()
+  }
 
   /** Gets an access to this variable. */
   VariableAccess getAnAccess() { result.getVariable() = this }
 }
 
 /** A local variable. */
 class LocalVariable extends Variable, TLocalVariable {
-  override LocalVariableAccess getAnAccess() { none() }
+  override LocalVariableAccess getAnAccess() { result.getVariable() = this }
 
   /** Gets the access where this local variable is first introduced. */
-  VariableAccess getDefiningAccess() { none() }
+  VariableAccess getDefiningAccess() { result = this.(LocalVariableReal).getDefiningAccessImpl() }
 
   /**
    * Holds if this variable is captured. For example in
@@ -52,27 +54,27 @@ class LocalVariable extends Variable, TLocalVariable {
 }
 
 /** A global variable. */
-class GlobalVariable extends VariableReal, TGlobalVariable instanceof GlobalVariable::Range {
+class GlobalVariable extends Variable instanceof GlobalVariableImpl {
   final override GlobalVariableAccess getAnAccess() { result.getVariable() = this }
 }
 
 /** An instance variable. */
-class InstanceVariable extends VariableReal, TInstanceVariable instanceof InstanceVariable::Range {
+class InstanceVariable extends Variable instanceof InstanceVariableImpl {
   /** Holds is this variable is a class instance variable. */
   final predicate isClassInstanceVariable() { super.isClassInstanceVariable() }
 
   final override InstanceVariableAccess getAnAccess() { result.getVariable() = this }
 }
 
 /** A class variable. */
-class ClassVariable extends VariableReal, TClassVariable instanceof ClassVariable::Range {
+class ClassVariable extends Variable instanceof ClassVariableImpl {
   final override ClassVariableAccess getAnAccess() { result.getVariable() = this }
 }
 
 /** An access to a variable. */
-class VariableAccess extends Expr, TVariableAccess {
+class VariableAccess extends Expr instanceof VariableAccessImpl {
   /** Gets the variable this identifier refers to. */
-  final Variable getVariable() { result = this.(VariableAccessImpl).getVariableImpl() }
+  final Variable getVariable() { result = super.getVariableImpl() }
 
   /**
    * Holds if this access is a write access belonging to the explicit
@@ -106,6 +108,8 @@ class VariableAccess extends Expr, TVariableAccess {
    * as is the first access to `e`.
    */
   predicate isImplicitWrite() { implicitWriteAccess(toGenerated(this)) }
+
+  final override string toString() { result = VariableAccessImpl.super.toString() }
 }
 
 /** An access to a variable where the value is updated. */
@@ -122,7 +126,7 @@ class VariableReadAccess extends VariableAccess {
 }
 
 /** An access to a local variable. */
-class LocalVariableAccess extends VariableAccess, TLocalVariableAccess {
+class LocalVariableAccess extends VariableAccess instanceof LocalVariableAccessImpl {
   final override string getAPrimaryQlClass() { result = "LocalVariableAccess" }
 
   /**
@@ -150,7 +154,7 @@ class LocalVariableWriteAccess extends LocalVariableAccess, VariableWriteAccess
 class LocalVariableReadAccess extends LocalVariableAccess, VariableReadAccess { }
 
 /** An access to a global variable. */
-class GlobalVariableAccess extends VariableAccess, TGlobalVariableAccess {
+class GlobalVariableAccess extends VariableAccess instanceof GlobalVariableAccessImpl {
   final override string getAPrimaryQlClass() { result = "GlobalVariableAccess" }
 }
 
@@ -161,7 +165,7 @@ class GlobalVariableWriteAccess extends GlobalVariableAccess, VariableWriteAcces
 class GlobalVariableReadAccess extends GlobalVariableAccess, VariableReadAccess { }
 
 /** An access to an instance variable. */
-class InstanceVariableAccess extends VariableAccess, TInstanceVariableAccess {
+class InstanceVariableAccess extends VariableAccess instanceof InstanceVariableAccessImpl {
   final override string getAPrimaryQlClass() { result = "InstanceVariableAccess" }
 }
 
@@ -172,7 +176,7 @@ class InstanceVariableWriteAccess extends InstanceVariableAccess, VariableWriteA
 class InstanceVariableReadAccess extends InstanceVariableAccess, VariableReadAccess { }
 
 /** An access to a class variable. */
-class ClassVariableAccess extends VariableAccess, TClassVariableAccess {
+class ClassVariableAccess extends VariableAccess instanceof ClassVariableAccessRealImpl {
   final override string getAPrimaryQlClass() { result = "ClassVariableAccess" }
 }
 

ql/lib/codeql/ruby/ast/internal/Call.qll

@@ -12,7 +12,7 @@ predicate isScopeResolutionMethodCall(Ruby::ScopeResolution g, Ruby::Identifier
   not exists(Ruby::Call c | c.getMethod() = g)
 }
 
-abstract class CallImpl extends Call {
+abstract class CallImpl extends Expr, TCall {
   abstract AstNode getArgumentImpl(int n);
 
   /**
@@ -27,10 +27,12 @@ abstract class CallImpl extends Call {
   abstract int getNumberOfArgumentsImpl();
 }
 
-abstract class MethodCallImpl extends CallImpl, MethodCall {
+abstract class MethodCallImpl extends CallImpl, TMethodCall {
   abstract AstNode getReceiverImpl();
 
   abstract string getMethodNameImpl();
+
+  abstract Block getBlockImpl();
 }
 
 class MethodCallSynth extends MethodCallImpl, TMethodCallSynth {
@@ -47,6 +49,8 @@ class MethodCallSynth extends MethodCallImpl, TMethodCallSynth {
   final override AstNode getArgumentImpl(int n) { synthChild(this, n + 1, result) and n >= 0 }
 
   final override int getNumberOfArgumentsImpl() { this = TMethodCallSynth(_, _, _, _, result) }
+
+  final override Block getBlockImpl() { none() }
 }
 
 class IdentifierMethodCall extends MethodCallImpl, TIdentifierMethodCall {
@@ -61,6 +65,8 @@ class IdentifierMethodCall extends MethodCallImpl, TIdentifierMethodCall {
   final override Expr getArgumentImpl(int n) { none() }
 
   final override int getNumberOfArgumentsImpl() { result = 0 }
+
+  final override Block getBlockImpl() { none() }
 }
 
 class ScopeResolutionMethodCall extends MethodCallImpl, TScopeResolutionMethodCall {
@@ -76,6 +82,8 @@ class ScopeResolutionMethodCall extends MethodCallImpl, TScopeResolutionMethodCa
   final override Expr getArgumentImpl(int n) { none() }
 
   final override int getNumberOfArgumentsImpl() { result = 0 }
+
+  final override Block getBlockImpl() { none() }
 }
 
 class RegularMethodCall extends MethodCallImpl, TRegularMethodCall {
@@ -114,7 +122,7 @@ class RegularMethodCall extends MethodCallImpl, TRegularMethodCall {
       count(g.getArguments().getChild(_)) + count(g.getMethod().(Ruby::ArgumentList).getChild(_))
   }
 
-  final override Block getBlock() { toGenerated(result) = g.getBlock() }
+  final override Block getBlockImpl() { toGenerated(result) = g.getBlock() }
 }
 
 class ElementReferenceImpl extends MethodCallImpl, TElementReference {
@@ -129,9 +137,13 @@ class ElementReferenceImpl extends MethodCallImpl, TElementReference {
   final override int getNumberOfArgumentsImpl() { result = count(g.getChild(_)) }
 
   final override string getMethodNameImpl() { result = "[]" }
+
+  final override Block getBlockImpl() { none() }
 }
 
-class TokenSuperCall extends SuperCall, MethodCallImpl, TTokenSuperCall {
+abstract class SuperCallImpl extends MethodCallImpl, TSuperCall { }
+
+class TokenSuperCall extends SuperCallImpl, TTokenSuperCall {
   private Ruby::Super g;
 
   TokenSuperCall() { this = TTokenSuperCall(g) }
@@ -143,9 +155,11 @@ class TokenSuperCall extends SuperCall, MethodCallImpl, TTokenSuperCall {
   final override Expr getArgumentImpl(int n) { none() }
 
   final override int getNumberOfArgumentsImpl() { result = 0 }
+
+  final override Block getBlockImpl() { none() }
 }
 
-class RegularSuperCall extends SuperCall, MethodCallImpl, TRegularSuperCall {
+class RegularSuperCall extends SuperCallImpl, TRegularSuperCall {
   private Ruby::Call g;
 
   RegularSuperCall() { this = TRegularSuperCall(g) }
@@ -158,10 +172,14 @@ class RegularSuperCall extends SuperCall, MethodCallImpl, TRegularSuperCall {
 
   final override int getNumberOfArgumentsImpl() { result = count(g.getArguments().getChild(_)) }
 
-  final override Block getBlock() { toGenerated(result) = g.getBlock() }
+  final override Block getBlockImpl() { toGenerated(result) = g.getBlock() }
 }
 
-class YieldCallImpl extends CallImpl, YieldCall {
+class YieldCallImpl extends CallImpl, TYieldCall {
+  Ruby::Yield g;
+
+  YieldCallImpl() { this = TYieldCall(g) }
+
   final override Expr getArgumentImpl(int n) { toGenerated(result) = g.getChild().getChild(n) }
 
   final override int getNumberOfArgumentsImpl() { result = count(g.getChild().getChild(_)) }

ql/lib/codeql/ruby/ast/internal/Module.qll

@@ -220,7 +220,7 @@ private string resolveScopeExpr(ConstantReadAccess c, int priority) {
   )
 }
 
-pragma[noinline]
+pragma[nomagic]
 private string resolveScopeExprConstantReadAccess(ConstantReadAccess c, int priority, string name) {
   result = resolveScopeExpr(c.getScopeExpr(), priority) and
   name = c.getName()

ql/lib/codeql/ruby/ast/internal/Operation.qll

@@ -21,6 +21,8 @@ abstract class UnaryOperationImpl extends OperationImpl, MethodCallImpl, TUnaryO
   final override Expr getArgumentImpl(int n) { none() }
 
   final override int getNumberOfArgumentsImpl() { result = 0 }
+
+  final override Block getBlockImpl() { none() }
 }
 
 class UnaryOperationGenerated extends UnaryOperationImpl {
@@ -77,6 +79,8 @@ abstract class BinaryOperationImpl extends OperationImpl, MethodCallImpl, TBinar
   final override Expr getArgumentImpl(int n) { n = 0 and result = this.getRightOperandImpl() }
 
   final override int getNumberOfArgumentsImpl() { result = 1 }
+
+  final override Block getBlockImpl() { none() }
 }
 
 class BinaryOperationReal extends BinaryOperationImpl {