Ast.SubscriptDesignator Class

Namespace: Ast
Superclasses: AstNodeProperties

Represents the subscript_designator nodes in the syntax tree of your code

Since R2026a

Description

The PQL class SubscriptDesignator represents the node subscript_designator in the syntax tree of your code.

Predicates

Type

Type	Raisable	Printable
`SubscriptDesignator`	Yes	No

Syntaxes

This class defines these predicates that act on the objects of this class. In addition, objects of this class can access the predicates defined by the base class AstNodeProperties. An object of this class is an object of AstNodeProperties class.

Predicates Description Example

Predicates	Description	Example
`is(SubscriptDesignator &designator)`	The `is` predicate identifies nodes that represent array subscripts in an expression. It matches each subscript designator. Example C++ code: int arr[3][2] = {{1, 2}, {3, 4}}; int x = arr[1][0]; The equivalent tree-sitter node is `subscript_designator`. The `is` predicate matches each `subscript_designator` node corresponding to the `[1]` and `[0]` subscripts in the expression `arr[1][0]`.	This example shows how to use the `SubscriptDesignator.is` predicate to find array subscript expressions (e.g. `arr[1][0]`) in a small C++ snippet. The rule matches the `SubscriptDesignator` node and reports its source text. rule CheckSubscriptDesignatorIs = { defectSubscriptIs } defect defectSubscriptIs = when Cpp.SubscriptDesignator.is(&sd) and sd.nodeText(&txt) raise "Found SubscriptDesignator: "{txt}"" on sd // Example C++ that would trigger this rule: // int arr[3][2] = {{1, 2}, {3, 4}}; // int x = arr[1][0];
`isa(Cpp.Node.Node node, SubscriptDesignator &cast)`	The `is` predicate identifies nodes that represent array subscripts in an expression. It matches each subscript designator. Example C++ code: int arr[3][2] = {{1, 2}, {3, 4}}; int x = arr[1][0]; The equivalent tree-sitter node is `subscript_designator`. The `is` predicate matches each `subscript_designator` node corresponding to the `[1]` and `[0]` subscripts in the expression `arr[1][0]`.	This example shows how to use the `SubscriptDesignator.is` predicate to find array subscript expressions (e.g. `arr[1][0]`) in a small C++ snippet. The rule matches the `SubscriptDesignator` node and reports its source text. rule CheckSubscriptDesignatorIs = { defectSubscriptIs } defect defectSubscriptIs = when Cpp.SubscriptDesignator.is(&sd) and sd.nodeText(&txt) raise "Found SubscriptDesignator: "{txt}"" on sd // Example C++ that would trigger this rule: // int arr[3][2] = {{1, 2}, {3, 4}}; // int x = arr[1][0];
`expression(SubscriptDesignator self, Cpp.Node.Node &child)`	The predicate `expression` retrieves the index expression from a subscript designator node. For example: int arr[3][2] = {{1, 2}, {3, 4}}; int x = arr[1][0]; The Tree-sitter node is `subscript_designator`. The `expression` predicate matches the values `1` and `0` inside the brackets `[1]` and `[0]`.	This example shows how to use the `SubscriptDesignator.expression` predicate to match the expression inside a `C++` array subscript (e.g. `arr[1]`). The `C++` snippet below will trigger the rule because the subscript designator contains the literal expression `1`: rule CheckSubscriptExpression = { defectSubscriptExpression } defect defectSubscriptExpression = when Cpp.SubscriptDesignator.is(&sd) and sd.expression(&expr) // &expr is the output child node (the expression inside the brackets) and expr.nodeText(&txt) raise "SubscriptDesignator.expression matched: '{txt}'" on sd

is(SubscriptDesignator &designator)

The is predicate identifies nodes that represent array subscripts in an expression. It matches each subscript designator.

Example C++ code:

int arr[3][2] = {{1, 2}, {3, 4}};
int x = arr[1][0];

The equivalent tree-sitter node is subscript_designator. The is predicate matches each subscript_designator node corresponding to the [1] and [0] subscripts in the expression arr[1][0].

This example shows how to use the SubscriptDesignator.is predicate to find array subscript expressions (e.g. arr[1][0]) in a small C++ snippet. The rule matches the SubscriptDesignator node and reports its source text.

rule CheckSubscriptDesignatorIs = { defectSubscriptIs }
defect defectSubscriptIs =
    when
        Cpp.SubscriptDesignator.is(&sd)
        and sd.nodeText(&txt)
    raise "Found SubscriptDesignator: "{txt}""
    on sd

// Example C++ that would trigger this rule:
// int arr[3][2] = {{1, 2}, {3, 4}};
// int x = arr[1][0];

isa(Cpp.Node.Node node, SubscriptDesignator &cast)

The is predicate identifies nodes that represent array subscripts in an expression. It matches each subscript designator.

Example C++ code:

int arr[3][2] = {{1, 2}, {3, 4}};
int x = arr[1][0];

The equivalent tree-sitter node is subscript_designator. The is predicate matches each subscript_designator node corresponding to the [1] and [0] subscripts in the expression arr[1][0].

rule CheckSubscriptDesignatorIs = { defectSubscriptIs }
defect defectSubscriptIs =
    when
        Cpp.SubscriptDesignator.is(&sd)
        and sd.nodeText(&txt)
    raise "Found SubscriptDesignator: "{txt}""
    on sd

// Example C++ that would trigger this rule:
// int arr[3][2] = {{1, 2}, {3, 4}};
// int x = arr[1][0];

expression(SubscriptDesignator self, Cpp.Node.Node &child)

The predicate expression retrieves the index expression from a subscript designator node.

For example:

int arr[3][2] = {{1, 2}, {3, 4}};
int x = arr[1][0];

The Tree-sitter node is subscript_designator. The expression predicate matches the values 1 and 0 inside the brackets [1] and [0].

This example shows how to use the SubscriptDesignator.expression predicate to match the expression inside a C++ array subscript (e.g. arr[1]). The C++ snippet below will trigger the rule because the subscript designator contains the literal expression `1`:

rule CheckSubscriptExpression = { defectSubscriptExpression }
defect defectSubscriptExpression =
    when
        Cpp.SubscriptDesignator.is(&sd)
        and sd.expression(&expr)                    // &expr is the output child node (the expression inside the brackets)
        and expr.nodeText(&txt)
    raise "SubscriptDesignator.expression matched: '{txt}'"
    on sd

Version History

Introduced in R2026a