Cpp.FriendDeclaration Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the friend_declaration nodes in the syntax tree of your code

Since R2026a

Description

FriendDeclaration class represents the C++ syntax node friend_declaration in your code and contains predicates to query properties and children of this node.

Predicates

expand all

Type

Type	Raisable	Printable
`FriendDeclaration`	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
`is(required FriendDeclaration &friendDeclaration)`	Finds syntax nodes of the type `FriendDeclaration` in your C++ code and returns them as `friendDeclaration`. This includes friend declarations of functions, classes, types, and templates.
`isa(Cpp.Node.Node node)`	Checks if `node` is a `FriendDeclaration`. Use this relation if you want to negate the condition (for example: `not Cpp.FriendDeclaration.isa(n)`).
`cast(Cpp.Node.Node node, required FriendDeclaration &cast)`	Finds syntax nodes of the type `FriendDeclaration` from the nodes in `node`. Retrieval occurs if `node` is compatible with the `FriendDeclaration` type. Use this relation if you need further `FriendDeclaration` properties.
`declaration(FriendDeclaration self, Cpp.Node.Node &child)`	Matches a declaration used in a friend declaration. For example, in `friend void foo();`, this predicate matches the declaration node.
`functionDefinition(FriendDeclaration self, Cpp.Node.Node &child)`	Matches a function definition used in a friend declaration. For example, in `friend void baz() {}`, this predicate matches the function definition node.
`typeIdentifier(FriendDeclaration self, Cpp.Node.Node &child)`	Matches a type identifier used in a friend declaration. For example, in `friend class Bar;`, this predicate matches `Bar`.
`qualifiedIdentifier(FriendDeclaration self, Cpp.Node.Node &child)`	Matches a qualified identifier used in a friend declaration. For example, in `friend typename T::Nested;`, this predicate matches `T::Nested`.
`templateType(FriendDeclaration self, Cpp.Node.Node &child)`	Matches a template type used in a friend declaration. For example, in `friend template<typename U> class Baz;`, this predicate matches the template type node for `Baz`.
`isEnclosedInFriendDeclaration(Cpp.Node.Node child)`	Checks if `child` appears inside a `FriendDeclaration`.
`getEnclosingFriendDeclaration(Cpp.Node.Node child, required FriendDeclaration &parent)`	Finds the nearest enclosing `FriendDeclaration` ancestor of `child` and returns it as `parent`.

Version History

Introduced in R2026a