Ast.StaticAssertDeclaration Class

Namespace: Ast
Superclasses: AstNodeProperties

Represents the static_assert_declaration nodes in the syntax tree of your code

Since R2026a

Description

The PQL class StaticAssertDeclaration represents the node static_assert_declaration in the syntax tree of your code.

Predicates

expand all

Type

Type	Raisable	Printable
`StaticAssertDeclaration`	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(StaticAssertDeclaration &decl)`	The `is` predicate identifies a syntax node representing a complete `static_assert` statement in C++ code. The following example illustrates its usage: // C++ code: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); // Corresponding tree-sitter node: // static_assert_declaration The predicate matches the entire `static_assert_declaration` node corresponding to the `static_assert` statement above. This allows queries to target and analyze the full `static_assert` construct.	This example demonstrates using the `StaticAssertDeclaration.is` predicate to match `static_assert` declarations in `C++` code. Example `C++` that would trigger the rule: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); rule CheckStaticAssertIs = { defectStaticAssert } defect defectStaticAssert = when Cpp.StaticAssertDeclaration.is(&decl) and decl.nodeText(&txt) raise "StaticAssertDeclaration.is matched: "{txt}"" on decl
`isa(Cpp.Node.Node node, StaticAssertDeclaration &cast)`	The `is` predicate identifies a syntax node representing a complete `static_assert` statement in C++ code. The following example illustrates its usage: // C++ code: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); // Corresponding tree-sitter node: // static_assert_declaration The predicate matches the entire `static_assert_declaration` node corresponding to the `static_assert` statement above. This allows queries to target and analyze the full `static_assert` construct.	This example demonstrates using the `StaticAssertDeclaration.is` predicate to match `static_assert` declarations in `C++` code. Example `C++` that would trigger the rule: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); rule CheckStaticAssertIs = { defectStaticAssert } defect defectStaticAssert = when Cpp.StaticAssertDeclaration.is(&decl) and decl.nodeText(&txt) raise "StaticAssertDeclaration.is matched: "{txt}"" on decl
`condition(StaticAssertDeclaration self, Cpp.Node.Node &child)`	The `condition` predicate retrieves the expression that forms the compile-time condition tested by a `static_assert` declaration. Example C++ code: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); Equivalent tree-sitter node: (static_assert_declaration (condition_expression (binary_expression (call_expression (type_identifier)) (==) (integer_literal)))) The `condition` predicate matches the `sizeof(int) == 4` expression inside the `static_assert`. This allows static analysis to inspect or verify the compile-time assertion condition.	This example demonstrates using the `StaticAssertDeclaration.condition` predicate to find the condition expression of a `C++` `static_assert`. The `C++` snippet below contains a `static_assert` that will be matched by the rule: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); rule CheckStaticAssertCondition = { defectStaticAssertCondition } defect defectStaticAssertCondition = when Cpp.StaticAssertDeclaration.is(&decl) and decl.condition(&cond) and cond.nodeText(&txt) raise "Static assert condition matched: '{txt}'" on cond
`message(StaticAssertDeclaration self, Cpp.Node.Node &child)`	The `message` predicate extracts the string literal message from a `static_assert` declaration in C++ code. Example C++ code: static_assert(sizeof(int) == 4, "Integers must be 4 bytes"); Equivalent tree-sitter node: (static_assert_declaration condition: (binary_expression left: (sizeof_expression (type_identifier)) operator: "==" right: (integer_literal)) message: (string_literal)) The `message` predicate matches the string literal `"Integers must be 4 bytes"` in the `static_assert_declaration` node. This allows static analysis to retrieve or inspect the assertion message.	This example demonstrates how to use the `StaticAssertDeclaration.message` predicate to match the optional message (second argument) of a `C++` `static_assert`. The `C++` snippet below contains a `static_assert` with a message that will be captured by the rule. rule CheckStaticAssertMessage = { defectStaticAssertMessage } defect defectStaticAssertMessage = when Cpp.StaticAssertDeclaration.is(&decl) and decl.message(&msg) and msg.nodeText(&txt) raise "StaticAssertDeclaration.message matched: '{txt}'" on msg

is(StaticAssertDeclaration &decl)

The is predicate identifies a syntax node representing a complete static_assert statement in C++ code.

The following example illustrates its usage:

// C++ code:
static_assert(sizeof(int) == 4, "Integers must be 4 bytes");

// Corresponding tree-sitter node:
// static_assert_declaration

The predicate matches the entire static_assert_declaration node corresponding to the static_assert statement above. This allows queries to target and analyze the full static_assert construct.

This example demonstrates using the StaticAssertDeclaration.is predicate to match static_assert declarations in C++ code. Example C++ that would trigger the rule:

static_assert(sizeof(int) == 4, "Integers must be 4 bytes");

rule CheckStaticAssertIs = { defectStaticAssert }
defect defectStaticAssert =
    when
        Cpp.StaticAssertDeclaration.is(&decl)
        and decl.nodeText(&txt)
    raise "StaticAssertDeclaration.is matched: "{txt}""
    on decl

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

The is predicate identifies a syntax node representing a complete static_assert statement in C++ code.

The following example illustrates its usage:

// C++ code:
static_assert(sizeof(int) == 4, "Integers must be 4 bytes");

// Corresponding tree-sitter node:
// static_assert_declaration

The predicate matches the entire static_assert_declaration node corresponding to the static_assert statement above. This allows queries to target and analyze the full static_assert construct.

This example demonstrates using the StaticAssertDeclaration.is predicate to match static_assert declarations in C++ code. Example C++ that would trigger the rule:

static_assert(sizeof(int) == 4, "Integers must be 4 bytes");

rule CheckStaticAssertIs = { defectStaticAssert }
defect defectStaticAssert =
    when
        Cpp.StaticAssertDeclaration.is(&decl)
        and decl.nodeText(&txt)
    raise "StaticAssertDeclaration.is matched: "{txt}""
    on decl

condition(StaticAssertDeclaration self, Cpp.Node.Node &child)

The condition predicate retrieves the expression that forms the compile-time condition tested by a static_assert declaration.

Example C++ code:

static_assert(sizeof(int) == 4, "Integers must be 4 bytes");

Equivalent tree-sitter node:

(static_assert_declaration (condition_expression (binary_expression (call_expression (type_identifier)) (==) (integer_literal))))

The condition predicate matches the sizeof(int) == 4 expression inside the static_assert. This allows static analysis to inspect or verify the compile-time assertion condition.

This example demonstrates using the StaticAssertDeclaration.condition predicate to find the condition expression of a C++ static_assert. The C++ snippet below contains a static_assert that will be matched by the rule:

static_assert(sizeof(int) == 4, "Integers must be 4 bytes");
rule CheckStaticAssertCondition = { defectStaticAssertCondition }
defect defectStaticAssertCondition =
    when
        Cpp.StaticAssertDeclaration.is(&decl)
        and decl.condition(&cond)
        and cond.nodeText(&txt)
    raise "Static assert condition matched: '{txt}'"
    on cond

message(StaticAssertDeclaration self, Cpp.Node.Node &child)

The message predicate extracts the string literal message from a static_assert declaration in C++ code.

Example C++ code:

static_assert(sizeof(int) == 4, "Integers must be 4 bytes");

Equivalent tree-sitter node:

(static_assert_declaration
  condition: (binary_expression
               left: (sizeof_expression (type_identifier))
               operator: "=="
               right: (integer_literal))
  message: (string_literal))

The message predicate matches the string literal "Integers must be 4 bytes" in the static_assert_declaration node. This allows static analysis to retrieve or inspect the assertion message.

This example demonstrates how to use the StaticAssertDeclaration.message predicate to match the optional message (second argument) of a C++ static_assert. The C++ snippet below contains a static_assert with a message that will be captured by the rule.

rule CheckStaticAssertMessage = { defectStaticAssertMessage }
defect defectStaticAssertMessage =
    when
        Cpp.StaticAssertDeclaration.is(&decl)
        and decl.message(&msg)
        and msg.nodeText(&txt)
    raise "StaticAssertDeclaration.message matched: '{txt}'"
    on msg

Version History

Introduced in R2026a