feat(ast): Introduce SubscriptExpression and VariableDeclaration classes with methods for indexing and initialization

Author: GeekMasher

ql/lib/codeql/bicep/ast/Expr.qll

@@ -16,7 +16,6 @@ private import internal.NullableType
 private import internal.ParenthesizedExpression
 private import internal.PrimaryExpression
 private import internal.ResourceExpression
-private import internal.SubscriptExpression
 private import internal.TernaryExpression
 private import internal.UnaryExpression
 private import Idents
@@ -121,7 +120,21 @@ final class NullableType extends Expr instanceof NullableTypeImpl { }
 /**
  * A ParenthesizedExpression expression in the AST.
  */
-final class ParenthesizedExpression extends Expr instanceof ParenthesizedExpressionImpl { }
+class ParenthesizedExpression extends Expr instanceof ParenthesizedExpressionImpl { 
+  /**
+   * Gets the expression contained within the parentheses.
+   */
+  Expr getExpression(int index) {
+    result = ParenthesizedExpressionImpl.super.getExpression(index)
+  }
+
+  /**
+   *  Get the expressions contained within the parentheses.
+   */
+  Expr getExpressions() {
+    result = ParenthesizedExpressionImpl.super.getExpressions()
+  }
+}
 
 /**
  * A PrimaryExpression expression in the AST.
@@ -133,11 +146,6 @@ final class PrimaryExpression extends Expr instanceof PrimaryExpressionImpl { }
  */
 final class ResourceExpression extends Expr instanceof ResourceExpressionImpl { }
 
-/**
- * A SubscriptExpression expression in the AST.
- */
-final class SubscriptExpression extends Expr instanceof SubscriptExpressionImpl { }
-
 /**
  * A TernaryExpression expression in the AST.
  */

ql/lib/codeql/bicep/ast/Literals.qll

@@ -4,6 +4,8 @@
 
 private import AstNodes
 private import Expr
+private import Idents
+private import Variables
 private import internal.AstNodes
 private import internal.TreeSitter
 private import internal.Literals
@@ -14,6 +16,7 @@ private import internal.NullableReturnType
 private import internal.Number
 private import internal.String
 private import internal.StringContent
+private import internal.SubscriptExpression
 
 /**
  * A literal in the AST.
@@ -29,6 +32,35 @@ class Array extends Literals instanceof ArrayImpl {
   Expr getElement(int index) { result = ArrayImpl.super.getElement(index) }
 }
 
+/**
+ * A SubscriptExpression expression in the AST.
+ */
+class SubscriptExpression extends Expr instanceof SubscriptExpressionImpl {
+  /**
+   * Gets the index of the subscript expression.
+   */
+  Expr getIndex() { result = SubscriptExpressionImpl.super.getIndex() }
+
+  /**
+   * Gets the object of the subscript expression.
+   */
+  Idents getIdentifier() { result = SubscriptExpressionImpl.super.getObject() }
+
+  /**
+   * Gets the array that this subscript expression is indexing into.
+   * This is equivalent to the variable declaration that contains the
+   * subscript expression.
+   */
+  Array getArray() {
+    exists(VariableDeclaration variable |
+      variable.getEnclosingCfgScope() = this.getEnclosingCfgScope() and
+      variable.getIdentifier().getName() = this.getIdentifier().getName()
+    |
+      result = variable.getInitializer()
+    )
+  }
+}
+
 /**
  *  A Boolean unknown AST node.
  */
@@ -76,24 +108,23 @@ class StringLiteral extends Literals instanceof StringImpl {
    * Gets the value of the string literal.
    */
   string getValue() {
-    result = concat(int index, string output |
-      exists(StringContentLiteral content |
-        content = StringImpl.super.getChild(index) and
-        output = content.getValue()
+    result =
+      concat(int index, string output |
+        exists(StringContentLiteral content |
+          content = StringImpl.super.getChild(index) and
+          output = content.getValue()
+        )
+        or
+        exists(Interpolation interpolation |
+          interpolation = StringImpl.super.getChild(index) and
+          output = interpolation.getValue()
+        )
+      |
+        output order by index
       )
-      or
-      exists(Interpolation interpolation |
-        interpolation = StringImpl.super.getChild(index) and
-        output = interpolation.getValue()
-      )
-    |
-      output order by index
-    )
   }
 
-  Interpolation getInterpolation(int index) {
-    result = StringImpl.super.getChild(index)
-  }
+  Interpolation getInterpolation(int index) { result = StringImpl.super.getChild(index) }
 }
 
 /**

ql/lib/codeql/bicep/ast/Misc.qll

@@ -1,5 +1,4 @@
 private import AstNodes
-
 private import internal.Array
 private import internal.ArrayType
 private import internal.Boolean
@@ -28,14 +27,12 @@ private import internal.Type
 private import internal.TypeArguments
 private import internal.TypeDeclaration
 private import internal.UnionType
-private import internal.VariableDeclaration
 
 /**
  *  A ArrayType unknown AST node.
  */
 class ArrayType extends AstNode instanceof ArrayTypeImpl { }
 
-
 /**
  *  A CompatibleIdentifier unknown AST node.
  */
@@ -101,13 +98,11 @@ class ModuleDeclaration extends AstNode instanceof ModuleDeclarationImpl { }
  */
 class NegatedType extends AstNode instanceof NegatedTypeImpl { }
 
-
 /**
  *  A ParameterizedType unknown AST node.
  */
 class ParameterizedType extends AstNode instanceof ParameterizedTypeImpl { }
 
-
 /**
  *  A ParenthesizedType unknown AST node.
  */
@@ -132,12 +127,10 @@ class TestBlock extends AstNode instanceof TestBlockImpl { }
  *  A Type unknown AST node.
  */
 class Type extends AstNode instanceof TypeImpl {
-    /**
-     *  Returns the type of this AST node.
-     */
-    string getType() {
-        result = TypeImpl.super.getType()
-    }
+  /**
+   *  Returns the type of this AST node.
+   */
+  string getType() { result = TypeImpl.super.getType() }
 }
 
 /**
@@ -154,9 +147,3 @@ class TypeDeclaration extends AstNode instanceof TypeDeclarationImpl { }
  *  A UnionType unknown AST node.
  */
 class UnionType extends AstNode instanceof UnionTypeImpl { }
-
-
-/**
- *  A VariableDeclaration unknown AST node.
- */
-class VariableDeclaration extends AstNode instanceof VariableDeclarationImpl { }

ql/lib/codeql/bicep/ast/Variables.qll

@@ -7,3 +7,20 @@ private import Idents
 private import Stmts
 private import codeql.bicep.controlflow.BasicBlocks as BasicBlocks
 private import codeql.bicep.controlflow.ControlFlowGraph
+// Internal
+private import internal.VariableDeclaration
+
+/**
+ *  A VariableDeclaration unknown AST node.
+ */
+class VariableDeclaration extends AstNode instanceof VariableDeclarationImpl {
+    /**
+     * Gets the identifier of the variable declaration.
+     */
+    Idents getIdentifier() { result = VariableDeclarationImpl.super.getIdentifier() }
+    
+    /**
+     * Gets the initializer expression of the variable declaration.
+     */
+    Expr getInitializer() { result = VariableDeclarationImpl.super.getInitializer() }
+}

ql/lib/codeql/bicep/ast/internal/AstNodes.qll

@@ -88,7 +88,7 @@ class TIdents = TIdentifier or TPropertyIdentifier;
  */
 class TStmts =
   TInfrastructure or TAssertStatement or TForStatement or TIfStatement or TImportStatement or
-      TImportWithStatement or TStatement or TUsingStatement;
+      TImportWithStatement or TStatement or TUsingStatement or TVariableDeclaration;
 
 /**
  * A expersion value in a Bicep program

ql/lib/codeql/bicep/ast/internal/ParenthesizedExpression.qll

@@ -3,12 +3,12 @@
  *
  *  WARNING: this file is generated, do not edit manually
  */
+
 private import AstNodes
 private import TreeSitter
 private import codeql.bicep.ast.AstNodes
 private import Expr
 
-
 /**
  *  A ParenthesizedExpression AST Node.
  */
@@ -21,6 +21,7 @@ class ParenthesizedExpressionImpl extends TParenthesizedExpression, ExprImpl {
 
   override string toString() { result = ast.toString() }
 
+  ExprImpl getExpression(int index) { toTreeSitter(result) = ast.getChild(index) }
 
-
-}
+  ExprImpl getExpressions() { result = this.getExpression(_) }
+}

ql/lib/codeql/bicep/ast/internal/SubscriptExpression.qll

@@ -3,12 +3,12 @@
  *
  *  WARNING: this file is generated, do not edit manually
  */
+
 private import AstNodes
 private import TreeSitter
 private import codeql.bicep.ast.AstNodes
 private import Expr
 
-
 /**
  *  A SubscriptExpression AST Node.
  */
@@ -21,6 +21,7 @@ class SubscriptExpressionImpl extends TSubscriptExpression, ExprImpl {
 
   override string toString() { result = ast.toString() }
 
+  ExprImpl getIndex() { toTreeSitter(result) = ast.getIndex() }
 
-
-}
+  ExprImpl getObject() { toTreeSitter(result) = ast.getObject() }
+}

ql/lib/codeql/bicep/ast/internal/VariableDeclaration.qll

@@ -3,14 +3,18 @@
  *
  *  WARNING: this file is generated, do not edit manually
  */
+
 private import AstNodes
 private import TreeSitter
 private import codeql.bicep.ast.AstNodes
+private import Stmts
+private import Idents
+private import Expr
 
 /**
  *  A VariableDeclaration AST Node.
  */
-class VariableDeclarationImpl extends TVariableDeclaration, AstNode {
+class VariableDeclarationImpl extends TVariableDeclaration, StmtsImpl {
   private BICEP::VariableDeclaration ast;
 
   override string getAPrimaryQlClass() { result = "VariableDeclaration" }
@@ -19,6 +23,7 @@ class VariableDeclarationImpl extends TVariableDeclaration, AstNode {
 
   override string toString() { result = ast.toString() }
 
+  IdentsImpl getIdentifier() { toTreeSitter(result) = ast.getChild(0) }
 
-
-}
+  ExprImpl getInitializer() { toTreeSitter(result) = ast.getChild(1) }
+}