Merge pull request #10067 from erik-krogh/paramSig

QL: support signature parameters in QL-for-QL

Author: erik-krogh

.github/workflows/ql-for-ql-tests.yml

@@ -44,7 +44,7 @@ jobs:
           CODEQL: ${{ steps.find-codeql.outputs.codeql-path }}
       - name: Check QL formatting
         run: |
-          find ql/ql "(" -name "*.ql" -or -name "*.qll" ")" -print0 | xargs -0 "${CODEQL}" query format --check-only
+          find ql/ql/src "(" -name "*.ql" -or -name "*.qll" ")" -print0 | xargs -0 "${CODEQL}" query format --check-only
         env:
           CODEQL: ${{ steps.find-codeql.outputs.codeql-path }}
       - name: Check QL compilation

ql/Cargo.lock

@@ -10,7 +10,7 @@ edition = "2018"
 flate2 = "1.0"
 node-types = { path = "../node-types" }
 tree-sitter = ">= 0.20, < 0.21"
-tree-sitter-ql = { git = "https://github.com/tree-sitter/tree-sitter-ql.git", rev = "4b8078c7fdcce9d4ca06ce3cfec3a61e8c3f4555"}
+tree-sitter-ql = { git = "https://github.com/tree-sitter/tree-sitter-ql.git", rev = "d08db734f8dc52f6bc04db53a966603122bc6985"}
 tree-sitter-ql-dbscheme = { git = "https://github.com/erik-krogh/tree-sitter-ql-dbscheme.git", rev = "63e1344353f63931e88bfbc2faa2e78e1421b213"}
 tree-sitter-ql-yaml = {git = "https://github.com/erik-krogh/tree-sitter-ql.git", rev = "cf704bf3671e1ae148e173464fb65a4d2bbf5f99"}
 clap = "2.33"

ql/extractor/Cargo.toml

@@ -11,6 +11,6 @@ clap = "2.33"
 node-types = { path = "../node-types" }
 tracing = "0.1"
 tracing-subscriber = { version = "0.3.3", features = ["env-filter"] }
-tree-sitter-ql = { git = "https://github.com/tree-sitter/tree-sitter-ql.git", rev = "4b8078c7fdcce9d4ca06ce3cfec3a61e8c3f4555"}
+tree-sitter-ql = { git = "https://github.com/tree-sitter/tree-sitter-ql.git", rev = "d08db734f8dc52f6bc04db53a966603122bc6985"}
 tree-sitter-ql-dbscheme = { git = "https://github.com/erik-krogh/tree-sitter-ql-dbscheme.git", rev = "63e1344353f63931e88bfbc2faa2e78e1421b213"}
 tree-sitter-ql-yaml = {git = "https://github.com/erik-krogh/tree-sitter-ql.git", rev = "cf704bf3671e1ae148e173464fb65a4d2bbf5f99"}

ql/generator/Cargo.toml

@@ -743,7 +743,9 @@ class Module extends TModule, ModuleDeclaration {
   }
 
   /** Gets a ref to the module that this module implements. */
-  TypeExpr getImplements(int i) { toQL(result) = mod.getImplements(i).getTypeExpr() }
+  TypeRef getImplements(int i) {
+    exists(SignatureExpr sig | sig.toQL() = mod.getImplements(i) | result = sig.asType())
+  }
 
   /** Gets the module expression that this module is an alias for, if any. */
   ModuleExpr getAlias() { toQL(result) = mod.getAFieldOrChild().(QL::ModuleAliasBody).getChild() }
@@ -2293,7 +2295,7 @@ class ModuleExpr extends TModuleExpr, TypeRef {
 
   /**
    * Gets the `i`th type argument if this module is a module instantiation.
-   * The result is either a `PredicateExpr` or a `TypeExpr`.
+   * The result is either a `PredicateExpr`, `TypeExpr`, or `ModuleExpr`.
    */
   SignatureExpr getArgument(int i) {
     result.toQL() = me.getAFieldOrChild().(QL::ModuleInstantiation).getChild(i)
@@ -2313,14 +2315,16 @@ class ModuleExpr extends TModuleExpr, TypeRef {
   }
 }
 
-/** A signature expression, either a `PredicateExpr` or a `TypeExpr`. */
+/** A signature expression, either a `PredicateExpr`, a `TypeExpr`, or a `ModuleExpr`. */
 class SignatureExpr extends TSignatureExpr, AstNode {
   QL::SignatureExpr sig;
 
   SignatureExpr() {
     toQL(this) = sig.getPredicate()
     or
     toQL(this) = sig.getTypeExpr()
+    or
+    toQL(this) = sig.getModExpr()
   }
 
   /** Gets the generated AST node that contains this signature expression. */
@@ -2329,8 +2333,8 @@ class SignatureExpr extends TSignatureExpr, AstNode {
   /** Gets this signature expression if it represents a predicate expression. */
   PredicateExpr asPredicate() { result = this }
 
-  /** Gets this signature expression if it represents a type expression. */
-  TypeExpr asType() { result = this }
+  /** Gets this signature expression if it represents a type expression (either a `TypeExpr` or a `ModuleExpr`). */
+  TypeRef asType() { result = this }
 }
 
 /** An argument to an annotation. */

ql/ql/src/codeql_ql/ast/Ast.qll

@@ -88,7 +88,7 @@ class TTypeRef = TImport or TModuleExpr or TType;
 
 class TYamlNode = TYamlCommemt or TYamlEntry or TYamlKey or TYamlListitem or TYamlValue;
 
-class TSignatureExpr = TPredicateExpr or TType;
+class TSignatureExpr = TPredicateExpr or TType or TModuleExpr;
 
 class TComment = TQLDoc or TBlockComment or TLineComment;
 

ql/ql/src/codeql_ql/ast/internal/AstNodes.qll

@@ -314,7 +314,7 @@ private predicate definesModule(
   )
   or
   // signature module in a paramertized module
-  exists(Module mod, SignatureExpr sig, TypeExpr ty, int i |
+  exists(Module mod, SignatureExpr sig, TypeRef ty, int i |
     mod = container.asModule() and
     mod.hasParameter(i, name, sig) and
     public = false and

ql/ql/src/codeql_ql/ast/internal/Module.qll

@@ -1069,6 +1069,9 @@ module QL {
     /** Gets the name of the primary QL class for this element. */
     final override string getAPrimaryQlClass() { result = "SignatureExpr" }
 
+    /** Gets the node corresponding to the field `mod_expr`. */
+    final ModuleExpr getModExpr() { ql_signature_expr_mod_expr(this, result) }
+
     /** Gets the node corresponding to the field `predicate`. */
     final PredicateExpr getPredicate() { ql_signature_expr_predicate(this, result) }
 
@@ -1077,7 +1080,9 @@ module QL {
 
     /** Gets a field or child node of this node. */
     final override AstNode getAFieldOrChild() {
-      ql_signature_expr_predicate(this, result) or ql_signature_expr_type_expr(this, result)
+      ql_signature_expr_mod_expr(this, result) or
+      ql_signature_expr_predicate(this, result) or
+      ql_signature_expr_type_expr(this, result)
     }
   }
 

ql/ql/src/codeql_ql/ast/internal/TreeSitter.qll

@@ -737,6 +737,11 @@ ql_set_literal_def(
   unique int id: @ql_set_literal
 );
 
+ql_signature_expr_mod_expr(
+  unique int ql_signature_expr: @ql_signature_expr ref,
+  unique int mod_expr: @ql_module_expr ref
+);
+
 ql_signature_expr_predicate(
   unique int ql_signature_expr: @ql_signature_expr ref,
   unique int predicate: @ql_predicate_expr ref

ql/ql/src/ql.dbscheme

@@ -0,0 +1,19 @@
+signature class Foo;
+
+class FooImpl extends string {
+  FooImpl() { this = "foo" }
+}
+
+signature module ParamSig<Foo F> {
+  F getThing();
+}
+
+module ParamImpl implements ParamSig<FooImpl> {
+  FooImpl getThing() { any() }
+}
+
+module ParamMod<ParamSig<FooImpl> Impl> {
+  FooImpl getTheThing() { result = Impl::getThing() }
+}
+
+FooImpl foo() { result = ParamMod<ParamImpl>::getTheThing() }