Cpp.UserDefinedLiteral Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the user_defined_literal nodes in the syntax tree of your code

Since R2026a

Description

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

Predicates

expand all

Type

Type	Raisable	Printable
`UserDefinedLiteral`	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 UserDefinedLiteral &udl)`	Retrieves syntax nodes of the type `UserDefinedLiteral` for your C/C++ code and stores it in `udl`.
`isa(Cpp.Node.Node node)`	Checks if `node` is a `user_defined_literal`.
`cast(Cpp.Node.Node node, required UserDefinedLiteral &cast)`	Retrieves syntax nodes of the type `UserDefinedLiteral` from the nodes in `node`. Retrieval occurs if `node` is compatible with `UserDefinedLiteral` type.
`concatenatedString(UserDefinedLiteral self, Cpp.Node.Node &child)`	Matches the concatenated string part of a `user-defined literal`.
`literalSuffix(UserDefinedLiteral self, Cpp.Node.Node &child)`	Matches the literal suffix of a `user-defined literal`.
`numberLiteral(UserDefinedLiteral self, Cpp.Node.Node &child)`	Matches the numeric literal part of a `user-defined literal`.
`rawStringLiteral(UserDefinedLiteral self, Cpp.Node.Node &child)`	Matches the raw string literal part of a `user-defined literal`.
`stringLiteral(UserDefinedLiteral self, Cpp.Node.Node &child)`	Matches the string literal part of a `user-defined literal`.
`charLiteral(UserDefinedLiteral self, Cpp.Node.Node &child)`	Matches the character literal part of a `user-defined literal`.
`isEnclosedInUserDefinedLiteral (Cpp.Node.Node child)`	Checks if `node` is inside a `user-defined literal`.
`getEnclosingUserDefinedLiteral (Cpp.Node.Node child, required UserDefinedLiteral &parent)`	Finds the nearest `UserDefinedLiteral` ancestor of `node` and returns it as `parent`.

Version History

Introduced in R2026a