Cpp.Character Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the character nodes in the syntax tree of your code

Since R2026a

Description

The PQL class Cpp.Character represents the node character in the syntax tree of your code.

void test_char() {
    char c = 'a';
    wchar_t w = L'b';
    char16_t c16 = u'c';
    char32_t c32 = U'd';
    char esc = '\n';
}

The above C++ shows several character literal tokens. Each quoted literal (for example 'a' or L'b') corresponds to a character node in the syntax tree and is represented by Cpp.Character in PQL.

Predicates

expand all

Type

Type	Raisable	Printable
`Character`	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 Character &character)`	Checks whether the current node is a `character` node and returns that node as `character`. Use this to directly match character literal nodes.	This PQL defect checks for character literal nodes directly. defect CharIsExample = when Cpp.Character.is(&ch) and ch.nodeText(&txt) raise "Found character literal via is: \"{txt}\"" on ch In this C++ code the defect finds direct character literals such as `'a'` or `L'b'`. #include <iostream> int main() { char c = 'a'; wchar_t w = L'b'; std::cout << c << w << '\n'; return 0; }
`cast(Cpp.Node.Node node, required Character &cast)`	Checks whether a `node` (a generic `Node`) is actually a `character` node and if so returns it as `cast`. Use this to test a Node obtained from other node-to-Node conversions.	This PQL defect checks for nodes that are character literals. defect CharCastExample = when Cpp.Node.is(&n, &,&,&) and Cpp.Character.cast(n, &ch) and ch.nodeText(&txt) raise "Found character literal via cast: \"{txt}\"" on ch In this C++ code the defect finds the character literal node . #include <iostream> int main() { char c = 'x'; (void)c; return 0; }
`isa(Cpp.Node.Node node)`	Returns true when the given generic `node` is a `character` node. Use this in conditions or to negate character-node matches.	This PQL defect checks whether a generic node corresponds to a character literal. defect CharIsaExample = when Cpp.Node.is(&n, &,&,&) and Cpp.Character.isa(n) raise "Node is a character literal as tested by isa" on ch0 In this C++ code the defect verifies that a node is a character literal like `'\\n'` or `'a'`. #include <iostream> void f() { char esc = '\n'; (void)esc; } int main() { f(); return 0; }

is(required Character &character)

Checks whether the current node is a character node and returns that node as character. Use this to directly match character literal nodes.

This PQL defect checks for character literal nodes directly.

defect CharIsExample =
when
    Cpp.Character.is(&ch)
    and ch.nodeText(&txt)
raise "Found character literal via is: \"{txt}\""
on ch

In this C++ code the defect finds direct character literals such as 'a' or L'b'.

#include <iostream>

int main() {
    char c = 'a';
    wchar_t w = L'b';
    std::cout << c << w << '\n';
    return 0;
}

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

Checks whether a node (a generic Node) is actually a character node and if so returns it as cast. Use this to test a Node obtained from other node-to-Node conversions.

This PQL defect checks for nodes that are character literals.

defect CharCastExample =
when
    Cpp.Node.is(&n, &,&,&)
    and Cpp.Character.cast(n, &ch)
    and ch.nodeText(&txt)
raise "Found character literal via cast: \"{txt}\""
on ch

In this C++ code the defect finds the character literal node .

#include <iostream>

int main() {
    char c = 'x';
    (void)c;
    return 0;
}

isa(Cpp.Node.Node node)

Returns true when the given generic node is a character node. Use this in conditions or to negate character-node matches.

This PQL defect checks whether a generic node corresponds to a character literal.

defect CharIsaExample =
when
    Cpp.Node.is(&n, &,&,&)
    and Cpp.Character.isa(n)
raise "Node is a character literal as tested by isa"
on ch0

In this C++ code the defect verifies that a node is a character literal like '\\n' or 'a'.

#include <iostream>

void f() {
    char esc = '\n';
    (void)esc;
}

int main() {
    f();
    return 0;
}

Version History

Introduced in R2026a