Cpp.File Class

Namespace: Cpp
Superclasses: AstNodeProperties

Represents the file nodes in the syntax tree of your code

Since R2026a

Description

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

Predicates

Type

Type	Raisable	Printable
File	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 File &ast)	Retrieves syntax nodes of the type File and binds them to ast. A File represents the root of the AST corresponding to a single source file.
getFirstNode(File self, File &first)	Retrieves the first node in the abstract syntax tree for the file. This predicate binds first to the earliest node in the source file.
getLastNode(File self, File &last)	Retrieves the last node in the abstract syntax tree for the file. This predicate binds last to the final node in the source file.
getFilePath(File self, Lang.String &file_path)	Retrieves the file system path of the source file associated with this File and stores it in file_path.
getLanguage(File self, Lang.String &lang)	Retrieves the language identifier of the grammar used to parse the source file (for example, c or cpp) and stores it in lang.
getSourceText(File self, Lang.String &text)	Retrieves the complete UTF-8 source text of the file and stores it in text. This allows direct inspection of the original source code corresponding to the AST.

Version History

Introduced in R2026a