Merge pull request #4434 from erik-krogh/printAST

Approved by asgerf

Author: codeql-ci

javascript/ql/src/printAst.ql

@@ -0,0 +1,28 @@
+/**
+ * @name Print AST
+ * @description Outputs a representation of a file's Abstract Syntax Tree. This
+ *              query is used by the VS Code extension.
+ * @id js/print-ast
+ * @kind graph
+ * @tags ide-contextual-queries/print-ast
+ */
+
+import javascript
+import semmle.javascript.PrintAst
+import definitions
+
+/**
+ * The source file to generate an AST from.
+ */
+external string selectedSourceFile();
+
+class PrintAstConfigurationOverride extends PrintAstConfiguration {
+  /**
+   * Holds if the location matches the selected file in the VS Code extension and
+   * the element is not a synthetic constructor.
+   */
+  override predicate shouldPrint(Locatable e, Location l) {
+    super.shouldPrint(e, l) and
+    l.getFile() = getEncodedFile(selectedSourceFile())
+  }
+}

javascript/ql/src/semmle/javascript/Classes.qll

@@ -256,6 +256,8 @@ class ClassDefinition extends @class_definition, ClassOrInterface, AST::ValueNod
   ClassDefinition getSuperClassDefinition() {
     result = getSuperClass().analyze().getAValue().(AbstractClass).getClass()
   }
+
+  override string getAPrimaryQlClass() { result = "ClassDefinition" }
 }
 
 /**
@@ -342,6 +344,8 @@ private class ClassInitializedMember extends MemberDeclaration {
   ClassInitializedMember() { this instanceof MethodDefinition or this.isStatic() }
 
   int getIndex() { properties(this, _, result, _, _) }
+
+  override string getAPrimaryQlClass() { result = "ClassInitializedMember" }
 }
 
 /**
@@ -361,6 +365,8 @@ class SuperExpr extends @super_expr, Expr {
    * which is the nearest enclosing non-arrow function.
    */
   Function getBinder() { result = getEnclosingFunction().getThisBinder() }
+
+  override string getAPrimaryQlClass() { result = "SuperExpr" }
 }
 
 /**
@@ -412,6 +418,8 @@ class SuperPropAccess extends PropAccess {
  */
 class NewTargetExpr extends @newtarget_expr, Expr {
   override predicate isImpure() { none() }
+
+  override string getAPrimaryQlClass() { result = "NewTargetExpr" }
 }
 
 /**
@@ -574,6 +582,8 @@ class MemberDeclaration extends @property, Documentable {
    * True if this is abstract, ambient, or an overload signature.
    */
   predicate isSignature() { not isConcrete() }
+
+  override string getAPrimaryQlClass() { result = "MemberDeclaration" }
 }
 
 /**
@@ -748,7 +758,9 @@ private predicate hasOverloadedConstructorCallSignature(ClassOrInterface type) {
  * }
  * ```
  */
-class MethodDefinition extends MethodDeclaration, MemberDefinition { }
+class MethodDefinition extends MethodDeclaration, MemberDefinition {
+  override string getAPrimaryQlClass() { result = "MethodDefinition" }
+}
 
 /**
  * A method signature declared in a class or interface, that is, a method without a function body.
@@ -763,7 +775,9 @@ class MethodDefinition extends MethodDeclaration, MemberDefinition { }
  *
  * Note that TypeScript call signatures are not considered method signatures.
  */
-class MethodSignature extends MethodDeclaration, MemberSignature { }
+class MethodSignature extends MethodDeclaration, MemberSignature {
+  override string getAPrimaryQlClass() { result = "MethodSignature" }
+}
 
 /**
  * A constructor declaration in a class, either a concrete definition or a signature without a body.
@@ -792,6 +806,8 @@ class ConstructorDeclaration extends MethodDeclaration {
 
   /** Holds if this is a synthetic default constructor. */
   predicate isSynthetic() { getLocation().isEmpty() }
+
+  override string getAPrimaryQlClass() { result = "ConstructorDeclaration" }
 }
 
 /**
@@ -813,7 +829,9 @@ class ConstructorDeclaration extends MethodDeclaration {
  * }
  * ```
  */
-class ConstructorDefinition extends ConstructorDeclaration, MethodDefinition { }
+class ConstructorDefinition extends ConstructorDeclaration, MethodDefinition {
+  override string getAPrimaryQlClass() { result = "ConstructorDefinition" }
+}
 
 /**
  * A constructor signature declared in a class, that is, a constructor without a function body.
@@ -824,7 +842,9 @@ class ConstructorDefinition extends ConstructorDeclaration, MethodDefinition { }
  * }
  * ```
  */
-class ConstructorSignature extends ConstructorDeclaration, MethodSignature { }
+class ConstructorSignature extends ConstructorDeclaration, MethodSignature {
+  override string getAPrimaryQlClass() { result = "ConstructorSignature" }
+}
 
 /**
  * A function generated by the extractor to implement a synthetic default constructor.
@@ -925,7 +945,9 @@ abstract class AccessorMethodSignature extends MethodSignature, AccessorMethodDe
  * }
  * ```
  */
-class GetterMethodDeclaration extends AccessorMethodDeclaration, @property_getter { }
+class GetterMethodDeclaration extends AccessorMethodDeclaration, @property_getter {
+  override string getAPrimaryQlClass() { result = "GetterMethodDeclaration" }
+}
 
 /**
  * A concrete getter method definition in a class, that is, a getter method with a function body.
@@ -945,7 +967,9 @@ class GetterMethodDeclaration extends AccessorMethodDeclaration, @property_gette
  * }
  * ```
  */
-class GetterMethodDefinition extends GetterMethodDeclaration, AccessorMethodDefinition { }
+class GetterMethodDefinition extends GetterMethodDeclaration, AccessorMethodDefinition {
+  override string getAPrimaryQlClass() { result = "GetterMethodDefinition" }
+}
 
 /**
  * A getter method signature declared in a class or interface, that is, a getter method without a function body.
@@ -958,7 +982,9 @@ class GetterMethodDefinition extends GetterMethodDeclaration, AccessorMethodDefi
  * }
  * ```
  */
-class GetterMethodSignature extends GetterMethodDeclaration, AccessorMethodSignature { }
+class GetterMethodSignature extends GetterMethodDeclaration, AccessorMethodSignature {
+  override string getAPrimaryQlClass() { result = "GetterMethodSignature" }
+}
 
 /**
  * A setter method declaration in a class or interface, either a concrete definition or a signature without a body.
@@ -981,7 +1007,9 @@ class GetterMethodSignature extends GetterMethodDeclaration, AccessorMethodSigna
  * }
  * ```
  */
-class SetterMethodDeclaration extends AccessorMethodDeclaration, @property_setter { }
+class SetterMethodDeclaration extends AccessorMethodDeclaration, @property_setter {
+  override string getAPrimaryQlClass() { result = "SetterMethodDeclaration" }
+}
 
 /**
  * A concrete setter method definition in a class, that is, a setter method with a function body
@@ -1000,7 +1028,9 @@ class SetterMethodDeclaration extends AccessorMethodDeclaration, @property_sette
  * }
  * ```
  */
-class SetterMethodDefinition extends SetterMethodDeclaration, AccessorMethodDefinition { }
+class SetterMethodDefinition extends SetterMethodDeclaration, AccessorMethodDefinition {
+  override string getAPrimaryQlClass() { result = "SetterMethodDefinition" }
+}
 
 /**
  * A setter method signature declared in a class or interface, that is, a setter method without a function body.
@@ -1013,7 +1043,9 @@ class SetterMethodDefinition extends SetterMethodDeclaration, AccessorMethodDefi
  * }
  * ```
  */
-class SetterMethodSignature extends SetterMethodDeclaration, AccessorMethodSignature { }
+class SetterMethodSignature extends SetterMethodDeclaration, AccessorMethodSignature {
+  override string getAPrimaryQlClass() { result = "SetterMethodSignature" }
+}
 
 /**
  * A field declaration in a class or interface, either a concrete definition or an abstract or ambient field signature.
@@ -1047,6 +1079,8 @@ class FieldDeclaration extends MemberDeclaration, @field {
 
   /** Holds if this is a TypeScript field marked as definitely assigned with the `!` operator. */
   predicate hasDefiniteAssignmentAssertion() { has_definite_assignment_assertion(this) }
+
+  override string getAPrimaryQlClass() { result = "FieldDeclaration" }
 }
 
 /**
@@ -1203,4 +1237,6 @@ class IndexSignature extends @index_signature, MemberSignature {
   override InterfaceDefinition getDeclaringType() {
     result = MemberSignature.super.getDeclaringType()
   }
+
+  override string getAPrimaryQlClass() { result = "IndexSignature" }
 }

javascript/ql/src/semmle/javascript/ES2015Modules.qll

@@ -79,6 +79,8 @@ class ImportDeclaration extends Stmt, Import, @import_declaration {
 
   /** Holds if this is declared with the `type` keyword, so it only imports types. */
   predicate isTypeOnly() { has_type_keyword(this) }
+
+  override string getAPrimaryQlClass() { result = "ImportDeclaration" }
 }
 
 /** A literal path expression appearing in an `import` declaration. */
@@ -129,6 +131,8 @@ class ImportSpecifier extends Expr, @import_specifier {
 
   /** Gets the local variable into which this specifier imports. */
   VarDecl getLocal() { result = getChildExpr(1) }
+
+  override string getAPrimaryQlClass() { result = "ImportSpecifier" }
 }
 
 /**
@@ -262,6 +266,8 @@ abstract class ExportDeclaration extends Stmt, @export_declaration {
 
   /** Holds if is declared with the `type` keyword, so only types are exported. */
   predicate isTypeOnly() { has_type_keyword(this) }
+
+  override string getAPrimaryQlClass() { result = "ExportDeclaration" }
 }
 
 /**
@@ -511,6 +517,8 @@ class ExportSpecifier extends Expr, @exportspecifier {
    * an exported name since it does not export a unique symbol.
    */
   string getExportedName() { result = getExported().getName() }
+
+  override string getAPrimaryQlClass() { result = "ExportSpecifier" }
 }
 
 /**