Merge pull request #17689 from hvitved/rust/print-ast

Rust: `PrintAst` improvements

rust/ql/lib/codeql/rust/printast/PrintAst.qll

@@ -2,48 +2,51 @@
  * Provides queries to pretty-print a Rust AST as a graph.
  */
 
-import PrintAstNode
+import codeql.rust.printast.PrintAstNode
 
-cached
+module PrintAst<shouldPrintSig/1 shouldPrint> {
-private int getOrder(PrintAstNode node) {
+  import PrintAstNode<shouldPrint/1>
-  node =
-    rank[result](PrintAstNode n, Location loc |
-      loc = n.getLocation()
-    |
-      n
-      order by
-        loc.getFile().getAbsolutePath(), loc.getStartLine(), loc.getStartColumn(), loc.getEndLine(),
-        loc.getEndColumn()
-    )
-}
 
-/** Holds if `node` belongs to the output tree, and its property `key` has the given `value`. */
+  pragma[nomagic]
-query predicate nodes(PrintAstNode node, string key, string value) {
+  private predicate orderBy(
-  node.shouldBePrinted() and
+    PrintAstNode n, string filepath, int startline, int startcolumn, int endline, int endcolumn
-  (
+  ) {
+    n.getLocation().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
+  }
+
+  private int getOrder(PrintAstNode node) {
+    node =
+      rank[result](PrintAstNode n, string filepath, int startline, int startcolumn, int endline,
+        int endcolumn |
+        orderBy(n, filepath, startline, startcolumn, endline, endcolumn)
+      |
+        n order by filepath, startline, startcolumn, endline, endcolumn
+      )
+  }
+
+  /** Holds if `node` belongs to the output tree, and its property `key` has the given `value`. */
+  query predicate nodes(PrintAstNode node, string key, string value) {
     key = "semmle.label" and value = node.toString()
     or
     key = "semmle.order" and value = getOrder(node).toString()
     or
     value = node.getProperty(key)
-  )
+  }
-}
 
-/**
+  /**
- * Holds if `target` is a child of `source` in the AST, and property `key` of the edge has the
+   * Holds if `target` is a child of `source` in the AST, and property `key` of the edge has the
- * given `value`.
+   * given `value`.
- */
+   */
-query predicate edges(PrintAstNode source, PrintAstNode target, string key, string value) {
+  query predicate edges(PrintAstNode source, PrintAstNode target, string key, string value) {
-  source.shouldBePrinted() and
+    exists(int index, string accessor | source.hasChild(target, index, accessor) |
-  target.shouldBePrinted() and
+      key = "semmle.label" and value = accessor
-  exists(int index, string accessor | source.hasChild(target, index, accessor) |
+      or
-    key = "semmle.label" and value = accessor
+      key = "semmle.order" and value = index.toString()
-    or
+    )
-    key = "semmle.order" and value = index.toString()
+  }
-  )
-}
 
-/** Holds if property `key` of the graph has the given `value`. */
+  /** Holds if property `key` of the graph has the given `value`. */
-query predicate graphProperties(string key, string value) {
+  query predicate graphProperties(string key, string value) {
-  key = "semmle.graphKind" and value = "tree"
+    key = "semmle.graphKind" and value = "tree"
+  }
 }

rust/ql/lib/codeql/rust/printast/PrintAstNode.qll

@@ -6,105 +6,81 @@
 import rust
 import codeql.rust.elements.internal.generated.ParentChild
 
-private newtype TPrintAstConfiguration = TMakePrintAstConfiguration()
+signature predicate shouldPrintSig(Locatable e);
 
-/**
+module PrintAstNode<shouldPrintSig/1 shouldPrint> {
- * The hook to customize the files and functions printed by this module.
- */
-class PrintAstConfiguration extends TPrintAstConfiguration {
   /**
-   * Gets the string representation of this singleton
+   * An AST node that should be printed.
    */
-  string toString() { result = "PrintAstConfiguration" }
+  private newtype TPrintAstNode = TPrintLocatable(Locatable ast) { shouldPrint(ast) }
 
   /**
-   * Holds if the AST for `e` should be printed. By default, holds for all.
+   * A node in the output tree.
    */
-  predicate shouldPrint(Locatable e) { any() }
+  class PrintAstNode extends TPrintAstNode {
-}
+    /**
+     * Gets a textual representation of this node.
+     */
+    abstract string toString();
 
-private predicate shouldPrint(Locatable e) { any(PrintAstConfiguration config).shouldPrint(e) }
+    /**
+     * Gets the child node at index `index`. Child indices must be unique,
+     * but need not be contiguous.
+     */
+    abstract predicate hasChild(PrintAstNode child, int index, string label);
 
-/**
+    /**
- * An AST node that should be printed.
+     * Gets the location of this node in the source code.
- */
+     */
-private newtype TPrintAstNode = TPrintLocatable(Locatable ast)
+    abstract Location getLocation();
 
-/**
+    /**
- * A node in the output tree.
+     * Gets the value of an additional property of this node, where the name of
- */
+     * the property is `key`.
-class PrintAstNode extends TPrintAstNode {
+     */
-  /**
+    string getProperty(string key) { none() }
-   * Gets a textual representation of this node.
-   */
-  abstract string toString();
 
-  /**
+    /**
-   * Gets the child node at index `index`. Child indices must be unique,
+     * Gets the underlying AST node, if any.
-   * but need not be contiguous.
+     */
-   */
+    abstract Locatable getAstNode();
-  abstract predicate hasChild(PrintAstNode child, int index, string label);
-
-  /**
-   * Holds if this node should be printed in the output.
-   */
-  abstract predicate shouldBePrinted();
-
-  /**
-   * Gets the location of this node in the source code.
-   */
-  abstract Location getLocation();
-
-  /**
-   * Gets the value of an additional property of this node, where the name of
-   * the property is `key`.
-   */
-  string getProperty(string key) { none() }
-
-  /**
-   * Gets the underlying AST node, if any.
-   */
-  abstract Locatable getAstNode();
-}
-
-private string prettyPrint(Locatable e) {
-  result = "[" + concat(e.getPrimaryQlClasses(), ", ") + "] " + e
-}
-
-private class Unresolved extends Locatable {
-  Unresolved() { this != this.resolve() }
-}
-
-/**
- * A graph node representing a real Locatable node.
- */
-class PrintLocatable extends PrintAstNode, TPrintLocatable {
-  Locatable ast;
-
-  PrintLocatable() { this = TPrintLocatable(ast) }
-
-  override string toString() { result = prettyPrint(ast) }
-
-  final override predicate shouldBePrinted() { shouldPrint(ast) }
-
-  override predicate hasChild(PrintAstNode child, int index, string label) {
-    child = TPrintLocatable(any(Locatable c | c = getChildAndAccessor(ast, index, label)))
   }
 
-  final override Locatable getAstNode() { result = ast }
+  private string prettyPrint(Locatable e) { result = "[" + e.getPrimaryQlClasses() + "] " + e }
 
-  final override Location getLocation() { result = ast.getLocation() }
+  private class Unresolved extends Locatable {
-}
+    Unresolved() { this != this.resolve() }
+  }
 
-/**
+  /**
- * A specialization of graph node for "unresolved" children, that is nodes in
+   * A graph node representing a real Locatable node.
- * the parallel conversion AST.
+   */
- */
+  class PrintLocatable extends PrintAstNode, TPrintLocatable {
-class PrintUnresolved extends PrintLocatable {
+    Locatable ast;
-  override Unresolved ast;
 
-  override predicate hasChild(PrintAstNode child, int index, string label) {
+    PrintLocatable() { this = TPrintLocatable(ast) }
-    // only print immediate unresolved children from the "parallel" AST
+
-    child = TPrintLocatable(getImmediateChildAndAccessor(ast, index, label).(Unresolved))
+    override string toString() { result = prettyPrint(ast) }
+
+    override predicate hasChild(PrintAstNode child, int index, string label) {
+      child = TPrintLocatable(any(Locatable c | c = getChildAndAccessor(ast, index, label)))
+    }
+
+    final override Locatable getAstNode() { result = ast }
+
+    final override Location getLocation() { result = ast.getLocation() }
+  }
+
+  /**
+   * A specialization of graph node for "unresolved" children, that is nodes in
+   * the parallel conversion AST.
+   */
+  class PrintUnresolved extends PrintLocatable {
+    override Unresolved ast;
+
+    override predicate hasChild(PrintAstNode child, int index, string label) {
+      // only print immediate unresolved children from the "parallel" AST
+      child = TPrintLocatable(getImmediateChildAndAccessor(ast, index, label).(Unresolved))
+    }
   }
 }

rust/ql/src/queries/ide-contextual-queries/printAst.ql

@@ -17,17 +17,10 @@ import codeql.rust.elements.internal.generated.ParentChild
  */
 external string selectedSourceFile();
 
-class PrintAstConfigurationOverride extends PrintAstConfiguration {
+predicate shouldPrint(Locatable e) {
-  /**
+  e.getFile() = getFileBySourceArchiveName(selectedSourceFile())
-   * Holds if the location matches the selected file in the VS Code extension and
+  or
-   * the element is `e`.
+  exists(Locatable parent | shouldPrint(parent) and parent = getImmediateParent(e))
-   */
-  override predicate shouldPrint(Locatable e) {
-    super.shouldPrint(e) and
-    (
-      e.getFile() = getFileBySourceArchiveName(selectedSourceFile())
-      or
-      exists(Locatable parent | this.shouldPrint(parent) and parent = getImmediateParent(e))
-    )
-  }
 }
+
+import PrintAst<shouldPrint/1>