SyntaxTree class
#include <slang/syntax/SyntaxTree.h>
The SyntaxTree is the easiest way to interface with the lexer / preprocessor / parser stack.
Give it some source text and it produces a parse tree.
The SyntaxTree object owns all of the memory for the parse tree, so it must live for as long as you need to access its syntax nodes.
Public static functions
-
static TreeOrError fromFile(std::
string_view path) - Creates a syntax tree from a full compilation unit.
-
static TreeOrError fromFile(std::
string_view path, SourceManager& sourceManager, const Bag& options = {}) - Creates a syntax tree from a full compilation unit.
-
static TreeOrError fromFiles(std::
span<const std:: string_view> paths) - Creates a syntax tree by concatenating several files loaded from disk.
-
static TreeOrError fromFiles(std::
span<const std:: string_view> paths, SourceManager& sourceManager, const Bag& options = {}) - Creates a syntax tree by concatenating several files loaded from disk.
-
static std::
shared_ptr<SyntaxTree> fromText(std:: string_view text, std:: string_view name = "source", std:: string_view path = "") - Creates a syntax tree by guessing at what might be in the given source snippet.
-
static std::
shared_ptr<SyntaxTree> fromText(std:: string_view text, const Bag& options, std:: string_view name = "source"sv, std:: string_view path = "") - Creates a syntax tree by guessing at what might be in the given source snippet.
-
static std::
shared_ptr<SyntaxTree> fromText(std:: string_view text, SourceManager& sourceManager, std:: string_view name = "source"sv, std:: string_view path = "", const Bag& options = {}, const SourceLibrary* library = nullptr) - Creates a syntax tree by guessing at what might be in the given source snippet.
-
static std::
shared_ptr<SyntaxTree> fromFileInMemory(std:: string_view text, SourceManager& sourceManager, std:: string_view name = "source"sv, std:: string_view path = "", const Bag& options = {}) - Creates a syntax tree from a full compilation unit already in memory.
-
static std::
shared_ptr<SyntaxTree> fromBuffer(const SourceBuffer& buffer, SourceManager& sourceManager, const Bag& options = {}, MacroList inheritedMacros = {}) - Creates a syntax tree from an already loaded source buffer.
-
static std::
shared_ptr<SyntaxTree> fromBuffers(std:: span<const SourceBuffer> buffers, SourceManager& sourceManager, const Bag& options = {}, MacroList inheritedMacros = {}) - Creates a syntax tree by concatenating several loaded source buffers.
-
static std::
shared_ptr<SyntaxTree> fromLibraryMapFile(std:: string_view path, SourceManager& sourceManager, const Bag& options = {}) - Creates a syntax tree from a library map file.
-
static std::
shared_ptr<SyntaxTree> fromLibraryMapText(std:: string_view text, SourceManager& sourceManager, std:: string_view name = "source"sv, std:: string_view path = "", const Bag& options = {}) - Creates a syntax tree from a library map located in memory.
-
static std::
shared_ptr<SyntaxTree> fromLibraryMapBuffer(const SourceBuffer& buffer, SourceManager& sourceManager, const Bag& options = {}) - Creates a syntax tree from a library map already loaded into a source buffer.
- static SourceManager& getDefaultSourceManager()
- This is a shared default source manager for cases where the user doesn't care about managing the lifetime of loaded source.
Public functions
- Diagnostics& diagnostics()
- Gets any diagnostics generated while parsing.
- BumpAllocator& allocator()
- Gets the allocator containing the memory for the parse tree.
- SourceManager& sourceManager()
- Gets the source manager used to build the syntax tree.
- const SourceManager& sourceManager() const
- Gets the source manager used to build the syntax tree.
- const SourceLibrary* getSourceLibrary() const
- Gets the source library with which the syntax tree is associated.
- SyntaxNode& root()
- Gets the root of the syntax tree.
- const SyntaxNode& root() const
- Gets the root of the syntax tree.
- const Bag& options() const
- The options used to construct the syntax tree.
-
const parsing::
ParserMetadata& getMetadata() const - Gets various bits of metadata collected during parsing.
- MacroList getDefinedMacros() const
- Gets the list of macros that were defined at the end of the loaded source file.
- IncludeList getIncludeDirectives() const
- Gets the list of include directives that were encountered while parsing.
-
std::
span<const BufferID> getSourceBufferIds() const - Gets the list of source buffer IDs that this syntax tree was created from.
- bool validate() const
- Checks that the syntax tree is valid, in the sense that it round trips through text and back again to an equivalent tree.
Public variables
- bool isLibraryUnit
- Indicates whether this syntax tree represents a "library" compilation unit, which means that modules declared within it are not automatically instantiated.
Function documentation
static TreeOrError slang::
Creates a syntax tree from a full compilation unit.
| Returns | the created and parsed syntax tree. |
|---|
path is the path to the source file on disk.
static TreeOrError slang::
Creates a syntax tree from a full compilation unit.
| Returns | the created and parsed syntax tree on success, or an OS error code if the file fails to load. |
|---|
path is the path to the source file on disk. sourceManager is the manager that owns all of the loaded source code. options is an optional bag of lexer, preprocessor, and parser options.
static TreeOrError slang::
Creates a syntax tree by concatenating several files loaded from disk.
| Returns | the created and parsed syntax tree on success, or an OS error code if the file fails to load. |
|---|
paths is the list of paths to the source files on disk.
static TreeOrError slang::
Creates a syntax tree by concatenating several files loaded from disk.
| Returns | the created and parsed syntax tree on success, or an OS error code if the file fails to load. |
|---|
paths is the list of paths to the source files on disk. sourceManager is the manager that owns all of the loaded source code. options is an optional bag of lexer, preprocessor, and parser options.
static std::
Creates a syntax tree by guessing at what might be in the given source snippet.
| Returns | the created and parsed syntax tree. |
|---|
text is the actual source code text. name is an optional name to give to the loaded source buffer. path is an optional path to give to the loaded source buffer.
static std::
Creates a syntax tree by guessing at what might be in the given source snippet.
| Returns | the created and parsed syntax tree. |
|---|
text is the actual source code text. options is a bag of lexer, preprocessor, and parser options. name is an optional name to give to the loaded source buffer. path is an optional path to give to the loaded source buffer.
static std::
Creates a syntax tree by guessing at what might be in the given source snippet.
| Returns | the created and parsed syntax tree. |
|---|
text is the actual source code text. sourceManager is the manager that owns all of the loaded source code. name is an optional name to give to the loaded source buffer. path is an optional path to give to the loaded source buffer. options is an optional bag of lexer, preprocessor, and parser options. library the source library to associated with the parsed tree
static std::
Creates a syntax tree from a full compilation unit already in memory.
| Returns | the created and parsed syntax tree. |
|---|
text is the actual source code text. sourceManager is the manager that owns all of the loaded source code. name is an optional name to give to the loaded source buffer. path is an optional path to give to the loaded source buffer. options is an optional bag of lexer, preprocessor, and parser options.
static std::
Creates a syntax tree from an already loaded source buffer.
| Returns | the created and parsed syntax tree. |
|---|
buffer is the loaded source buffer. sourceManager is the manager that owns the buffer. options is an optional bag of lexer, preprocessor, and parser options. inheritedMacros is a list of macros to predefine in the new syntax tree.
static std::
Creates a syntax tree by concatenating several loaded source buffers.
| Returns | the created and parsed syntax tree. |
|---|
buffers is the list of buffers that should be concatenated to form the compilation unit to parse. sourceManager is the manager that owns the buffers. options is an optional bag of lexer, preprocessor, and parser options. inheritedMacros is a list of macros to predefine in the new syntax tree.
static std::
Creates a syntax tree from a library map file.
| Returns | the created and parsed syntax tree. |
|---|
path is the path to the source file on disk. sourceManager is the manager that owns all of the loaded source code. options is an optional bag of lexer, preprocessor, and parser options.
static std::
Creates a syntax tree from a library map located in memory.
| Returns | the created and parsed syntax tree. |
|---|
text is the actual source code text. sourceManager is the manager that owns all of the loaded source code. name is an optional name to give to the loaded source buffer. path is an optional path to give to the loaded source buffer. options is an optional bag of lexer, preprocessor, and parser options.
static std::
Creates a syntax tree from a library map already loaded into a source buffer.
| Returns | the created and parsed syntax tree. |
|---|
buffer is the loaded source buffer. sourceManager is the manager that owns the buffer. options is an optional bag of lexer, preprocessor, and parser options.
static SourceManager& slang::
This is a shared default source manager for cases where the user doesn't care about managing the lifetime of loaded source.
Note that all of the source loaded by this thing will live in memory for the lifetime of the process.
bool slang::
Checks that the syntax tree is valid, in the sense that it round trips through text and back again to an equivalent tree.
The parser will always create a valid syntax tree. It's possible to create an invalid syntax tree by manipulating the tree structure directly or with the help of a SyntaxRewriter.