Cpp.AttributedDeclarator Class

The predicate is identifies nodes that represent attributed declarators in the syntax tree.

For example, consider the following C++ code:

int [[nodiscard]] *p;

The predicate is matches the attributed_declarator node for the pointer p with the [[nodiscard]] attribute.

This example demonstrates using the AttributedDeclarator.is predicate to find declarators annotated with attributes (for example: [[nodiscard]] or [[deprecated]]). The C++ snippet below would produce AttributedDeclarator nodes that match the rule:

rule CheckAttributedDeclaratorIs = { defectAttributedDeclaratorIs }
defect defectAttributedDeclaratorIs =
    when
        Cpp.AttributedDeclarator.is(&ad)
        and ad.nodeText(&txt)
    raise "Found attributed declarator: "{txt}""
    on ad

The predicate is identifies nodes that represent attributed declarators in the syntax tree.

For example, consider the following C++ code:

int [[nodiscard]] *p;

The predicate is matches the attributed_declarator node for the pointer p with the [[nodiscard]] attribute.

This example demonstrates using the AttributedDeclarator.is predicate to find declarators annotated with attributes (for example: [[nodiscard]] or [[deprecated]]). The C++ snippet below would produce AttributedDeclarator nodes that match the rule:

rule CheckAttributedDeclaratorIs = { defectAttributedDeclaratorIs }
defect defectAttributedDeclaratorIs =
    when
        Cpp.AttributedDeclarator.is(&ad)
        and ad.nodeText(&txt)
    raise "Found attributed declarator: "{txt}""
    on ad

The declarator predicate retrieves the child node representing the core declarator within an AttributedDeclarator syntax node.

Example C++ code:

int [[nodiscard]] *p;

The corresponding tree-sitter node is:

attributed_declarator
  ├─ attribute_declaration (e.g., [[nodiscard]])
  └─ declarator (e.g., *p)

The declarator predicate selects the child node labeled 'declarator' inside the attributed_declarator node. In this example, it corresponds to the pointer declarator *p.

This example demonstrates using AttributedDeclarator.declarator(&child) to capture the inner declarator of an attributed declarator. The C++ snippet below contains an attributed pointer declarator that will trigger the rule:

rule CheckAttributedDeclaratorDeclarator = { defectAttributedDeclaratorDeclarator }
defect defectAttributedDeclaratorDeclarator =
    when
        Cpp.AttributedDeclarator.is(&ad)
        and ad.declarator(&child)
        and child.nodeText(&txt)
    raise "AttributedDeclarator.declarator matched: "{txt}""
    on ad

The attributeDeclaration predicate identifies the attribute_declaration child node within an attributed_declarator syntax node. This represents C++ attribute specifiers applied to a declarator.

For example:

int [[nodiscard]] *p;

This code corresponds to the Tree-sitter node: attributed_declarator. The predicate matches the attribute_declaration child node for the [[nodiscard]] attribute.

This example demonstrates using AttributedDeclarator.attributeDeclaration to find an attribute-declaration node attached to an attributed declarator. The C++ snippet below contains an attributed pointer declaration that will trigger the rule:

rule CheckAttributedDeclaratorAttributeDeclaration = { defectAttributedDeclaratorAttributeDeclaration }
defect defectAttributedDeclaratorAttributeDeclaration =
    when
        Cpp.AttributedDeclarator.is(&ad)
        and ad.attributeDeclaration(&attrDecl)
        and attrDecl.nodeText(&txt)
    raise "AttributedDeclarator.attributeDeclaration matched: "{txt}""
    on ad

The typeDeclarator predicate identifies the child node representing the core type declarator within an AttributedDeclarator syntax node.

Example C++ code:

int [[nodiscard]] *p;

The equivalent tree-sitter node is attributed_declarator. In this code, the attributed_declarator node corresponds to the declaration of p with the attribute [[nodiscard]]. The typeDeclarator predicate matches the child node that represents the underlying type declarator (e.g., the pointer *p). This allows static analysis to focus on the actual type being declared, ignoring attributes.

This example demonstrates using AttributedDeclarator.typeDeclarator to find the underlying type declarator inside an attributed declarator. Given the C++ declaration `int [[nodiscard]] *p;`, the rule matches the type declarator (e.g. the pointer declarator) inside the attributed declarator.

rule CheckTypeDeclarator = { defectTypeDeclarator }
defect defectTypeDeclarator =
    when
        Cpp.AttributedDeclarator.is(&ad)
        and ad.typeDeclarator(&child)
        and child.nodeText(&txt)
    raise "AttributedDeclarator.typeDeclarator matched: "{txt}""
    on ad

The fieldDeclarator predicate identifies a child node of type field_declarator within an attributed_declarator syntax node.

Example C++ code:

struct S {
    int [[deprecated]] field;
};

Equivalent tree-sitter node (in snake_case): attributed_declarator

(attributed_declarator
  (type_declarator (primitive_type) "int")
  (attribute_declaration (attribute) "[[deprecated]]")
  (field_declarator (identifier) "field"))

The fieldDeclarator predicate matches the field_declarator child node representing the member variable field inside the attributed_declarator.

This example demonstrates using AttributedDeclarator.fieldDeclarator to find an attributed field inside a struct/class. The C++ snippet below shows a struct field with an attribute that will produce an AttributedDeclarator node whose fieldDeclarator child we match.

rule CheckFieldDeclarator = { defectFieldDeclarator }
defect defectFieldDeclarator =
    when
        Cpp.AttributedDeclarator.is(&ad)
        and ad.fieldDeclarator(&field)                          // &field is the output child node bound by the predicate
        and field.nodeText(&txt)
    raise "AttributedDeclarator.fieldDeclarator matched: '{txt}'"
    on ad

// Example C++ that triggers the rule:
// struct S { int [[deprecated]] field; };