Merge pull request #22705 from hvitved/unified/more-to-string

Unified: Implement `{Constructor,Function,Variable}Declaration.toString`

Author: hvitved

unified/ql/lib/codeql/unified/internal/AstPlugin.qll

@@ -0,0 +1,43 @@
+overlay[local]
+module;
+
+private import unified
+private import codeql.util.Unit
+
+private module Plugins {
+  private import AstPluginSwift
+}
+
+class AstPlugin extends Unit {
+  bindingset[f]
+  string getFunctionDeclarationKeyword(FunctionDeclaration f) { none() }
+
+  bindingset[c]
+  string getConstructorDeclarationKeyword(ConstructorDeclaration c) { none() }
+
+  bindingset[cls]
+  string getClassLikeDeclarationKeyword(ClassLikeDeclaration cls) { none() }
+
+  bindingset[decl]
+  string getVariableDeclarationKeyword(VariableDeclaration decl) { none() }
+}
+
+bindingset[f]
+string getFunctionDeclarationKeyword(FunctionDeclaration f) {
+  result = any(AstPlugin p).getFunctionDeclarationKeyword(f)
+}
+
+bindingset[c]
+string getConstructorDeclarationKeyword(ConstructorDeclaration c) {
+  result = any(AstPlugin p).getConstructorDeclarationKeyword(c)
+}
+
+bindingset[cls]
+string getClassLikeDeclarationKeyword(ClassLikeDeclaration cls) {
+  result = any(AstPlugin p).getClassLikeDeclarationKeyword(cls)
+}
+
+bindingset[decl]
+string getVariableDeclarationKeyword(VariableDeclaration decl) {
+  result = any(AstPlugin p).getVariableDeclarationKeyword(decl)
+}

unified/ql/lib/codeql/unified/internal/AstPluginSwift.qll

@@ -0,0 +1,22 @@
+overlay[local]
+module;
+
+private import unified
+private import AstPlugin
+
+private class AstPluginSwift extends AstPlugin {
+  bindingset[f]
+  override string getFunctionDeclarationKeyword(FunctionDeclaration f) {
+    exists(f) and result = "func"
+  }
+
+  override string getClassLikeDeclarationKeyword(ClassLikeDeclaration cls) {
+    cls.hasModifier(result) and
+    result in ["class", "struct", "enum", "actor", "extension", "protocol"]
+  }
+
+  override string getVariableDeclarationKeyword(VariableDeclaration decl) {
+    decl.hasModifier(result) and
+    result in ["var", "let"]
+  }
+}

unified/ql/lib/codeql/unified/internal/FacadeAst.qll

@@ -4,6 +4,7 @@
 overlay[local?]
 module;
 
+private import AstPlugin
 private import codeql.files.FileSystem
 private import codeql.unified.internal.NameBinding as NameBinding
 
@@ -153,17 +154,18 @@ module Unified {
         NameBinding::getStaticBindingTargetFromRef(this.getABaseType().getType())
     }
 
-    private string getKind() {
-      this.hasModifier(result) and
-      result in ["class", "struct", "interface", "enum", "actor", "extension", "protocol"]
+    override string toString() {
+      result = concat(getClassLikeDeclarationKeyword(this) + " ") + concat(this.getName())
     }
-
-    override string toString() { result = concat(this.getKind() + " ") + concat(this.getName()) }
   }
 
   class ConstructorDeclaration extends G::ConstructorDeclaration {
     /** Gets the name of this constructor. */
     string getName() { result = this.getNameNode().getValue() }
+
+    override string toString() {
+      result = concat(getConstructorDeclarationKeyword(this) + " ") + concat(this.getName())
+    }
   }
 
   class ContinueExpr extends G::ContinueExpr {
@@ -174,6 +176,22 @@ module Unified {
   class FunctionDeclaration extends G::FunctionDeclaration {
     /** Gets the name of this function. */
     string getName() { result = this.getNameNode().getValue() }
+
+    override string toString() {
+      result = concat(getFunctionDeclarationKeyword(this) + " ") + concat(this.getName())
+    }
+  }
+
+  class VariableDeclaration extends G::VariableDeclaration {
+    /** Gets the name node of this variable declaration, if any. */
+    Identifier getNameNode() { result = this.getPattern() }
+
+    /** Gets the name of the variable being declared, if any. */
+    string getName() { result = this.getNameNode().getValue() }
+
+    override string toString() {
+      result = concat(getVariableDeclarationKeyword(this) + " ") + concat(this.getName())
+    }
   }
 
   class LabeledStmt extends G::LabeledStmt {