Cpp.Declarator Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the declarator nodes in the syntax tree of your code

Since R2026a

Description

The PQL class Declarator represents the node declarator in the syntax tree of your code.

int a = 1;
int *p;
int arr[3] = {1,2,3};

The three declarations above include different forms of declarator, such as the simple identifier a, the pointer *p, and the array arr, that correspond to the declarator node in the PQL syntax tree.

Predicates

expand all

Type

Type	Raisable	Printable
`Declarator`	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(required Declarator &declarator)`	Matches a `declarator` node directly and returns it via the output variable.	This PQL defect checks for `declarator` nodes present in the code. defect decl_is = when Cpp.Declarator.is(&d) and d.nodeText(&txt) raise "Declarator.is matched: \"{txt}\"" on d In this C++ code, the defect finds each declarator such as identifiers, pointers, and array declarators. int a = 1; int *p; int arr[3] = {1,2,3};
`cast(Cpp.Node.Node node, required Declarator &cast)`	Checks whether a generic `node` is a `declarator`. if so, provides the `declarator` as an output. Use it when you have a `Cpp.Node.Node` and want to treat it specifically as a `declarator`.	This PQL defect checks for nodes that are declarators by casting a generic node to `declarator`. defect decl_cast = when Cpp.Node.is(&n, &,&,&) and Cpp.Declarator.cast(n, &d) and d.nodeText(&txt) raise "Declarator.cast matched: \"{txt}\"" on d In this C++ code, the defect finds declarator nodes by first capturing generic nodes and then casting them to declarators, e.g., the identifier `x` and pointer `p`. int x = 42; int *p = nullptr;
`isa(Cpp.Node.Node node)`	Tests whether a generic `node` is a `declarator`. Use this in boolean checks or negations to filter nodes by type.	This PQL defect checks for nodes that are not declarators by using `isa` in a negated form. defect not_declarator = when Cpp.Node.is(&n, &,&,&) and not Cpp.Declarator.isa(n) raise "Node is not a declarator" on n In this C++ code, the defect distinguishes non-declarator nodes (e.g., function definitions or expressions) from declarators like `y` below. int y = 7; int foo() { return 0; }

is(required Declarator &declarator)

Matches a declarator node directly and returns it via the output variable.

This PQL defect checks for declarator nodes present in the code.

defect decl_is =
when
    Cpp.Declarator.is(&d)
    and d.nodeText(&txt)
raise "Declarator.is matched: \"{txt}\""
on d

In this C++ code, the defect finds each declarator such as identifiers, pointers, and array declarators.

int a = 1;
int *p;
int arr[3] = {1,2,3};

cast(Cpp.Node.Node node, required Declarator &cast)

Checks whether a generic node is a declarator. if so, provides the declarator as an output. Use it when you have a Cpp.Node.Node and want to treat it specifically as a declarator.

This PQL defect checks for nodes that are declarators by casting a generic node to declarator.

defect decl_cast =
when
    Cpp.Node.is(&n, &,&,&)
    and Cpp.Declarator.cast(n, &d)
    and d.nodeText(&txt)
raise "Declarator.cast matched: \"{txt}\""
on d

In this C++ code, the defect finds declarator nodes by first capturing generic nodes and then casting them to declarators, e.g., the identifier x and pointer p.

int x = 42;
int *p = nullptr;

isa(Cpp.Node.Node node)

Tests whether a generic node is a declarator. Use this in boolean checks or negations to filter nodes by type.

This PQL defect checks for nodes that are not declarators by using isa in a negated form.

defect not_declarator =
when
    Cpp.Node.is(&n, &,&,&)
    and not Cpp.Declarator.isa(n)
raise "Node is not a declarator"
on n

In this C++ code, the defect distinguishes non-declarator nodes (e.g., function definitions or expressions) from declarators like y below.

int y = 7;
int foo() { return 0; }

Version History

Introduced in R2026a