Slang

https://sv-lang.com/
Admin
Slang is a powerful toolkit for SystemVerilog compilation, elaboration, and analysis, providing...
Tokens:461,883
Snippets:6,565
Trust Score:7.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Define Macro Example

Source: https://sv-lang.com/command-line-ref.html

Define macros with values at the start of source files. This example shows defining multiple macros.

```bash
-D,--define-macro <macro>=<value>
+define+<macro>=<value>[+<macro>=<value>...]
```

```bash
slang -DFOO=2 -DBAR=asdf -D BAZ=3
```

--------------------------------

### Install Slang using CMake

Source: https://sv-lang.com/building.html

Installs the slang library using CMake. Use the --prefix option to specify a custom installation directory.

```bash
cmake --install build --strip
```

--------------------------------

### Example Slang-Tidy Configuration File

Source: https://sv-lang.com/tools.html

A complete example of a .slang-tidy configuration file, demonstrating the use of both 'Checks' and 'CheckConfigs' sections with specific settings.

```config
Checks:
    -*, 
    synthesis-only-assigned-on-reset,
    style-enforce-port-suffix

CheckConfigs:
    clkName: clk,
    clkNameRegexString: "clk_signal\S*|clock_port\S*",
    resetIsActiveHigh: false,
    inputPortSuffix: _k,
    outputPortSuffix: _p
```

--------------------------------

### Example of Inferring Input Ports as Variables

Source: https://sv-lang.com/command-line-ref.html

This example demonstrates how input ports are treated as nets by default, allowing connection to `inout` ports. When `--infer-input-ports-as-vars` is enabled, this connection becomes an error.

```systemverilog
module m(input logic w);
    n n(w);
endmodule

module n(inout logic w);
endmodule
```

--------------------------------

### Install pyslang Python Package

Source: https://sv-lang.com/index.html

Install the pyslang library using pip. This is the recommended way to use slang for Python scripting.

```bash
pip install pyslang
```

--------------------------------

### Install Test Dependencies and Run Python Tests

Source: https://sv-lang.com/building.html

Install the necessary test and development dependencies for Pyslang and execute the Python tests using the pytest framework.

```bash
pip install '.[test]'
pytest
```

--------------------------------

### Install Pyslang with Cached Build Products

Source: https://sv-lang.com/building.html

Install Pyslang while caching build products across rebuilds. This requires installing pybind11 and scikit-build-core first, and specifies a build directory.

```bash
pip install pybind11 scikit-build-core
pip install . --no-build-isolation --config-settings build-dir=build/python_build
```

--------------------------------

### Install Pyslang with Fully-Isolated Build

Source: https://sv-lang.com/building.html

Install the Pyslang Python package, which includes building the C++ slang library with bindings. This method performs a fully-isolated build each time and may take 5-10 minutes.

```bash
pip install .
```

--------------------------------

### Translate Off Format Example

Source: https://sv-lang.com/command-line-ref.html

Define custom directives for skipping code regions during preprocessing. This example uses 'pragma' as the common keyword.

```bash
--translate-off-format <common>,<start>,<end>
```

```verilog
module m;
    // pragma translate_off
    ... some code to skip ...
    // pragma translate_on
endmodule
```

--------------------------------

### slang::OS::setupConsole

Source: https://sv-lang.com/classslang_1_1_o_s.html

Performs the initial one-time setup for the OS console.

```APIDOC
## slang::OS::setupConsole

### Description
Does initial one-time setup of OS console.

### Method
static void

### Endpoint
N/A (static function call)

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### utf8Len

Source: https://sv-lang.com/_char_info_8h.html

Gets the length of a UTF-8 sequence starting with the given character.

```APIDOC
## utf8Len

### Description
Gets the length of the UTF-8 sequence starting with the given first character.

### Signature
int utf8Len(unsigned char first) constexpr
```

--------------------------------

### Setup Diagnostic Engine and Text Client

Source: https://sv-lang.com/diagnostic-apis.html

Shows how to initialize a DiagnosticEngine, register a TextDiagnosticClient, issue diagnostics, and retrieve the formatted report string.

```C++
DiagnosticEngine diagEngine(sourceManager);

auto client = std::make_shared<TextDiagnosticClient>();
diagEngine.addClient(client);

for (Diagnostic& diag : diags)
    diagEngine.issue(diag);

std::string report = client->getString();
```

--------------------------------

### getText

Source: https://sv-lang.com/classslang_1_1ast_1_1_op_info.html

Gets the string representation of the given binary operator. For example, BinaryOperator::Add returns "+".

```APIDOC
## getText

### Description
Gets the string representation of the given binary operator. For example, BinaryOperator::Add returns "+".

### Method
static std::string_view

### Parameters
#### Path Parameters
- **op** (BinaryOperator) - Description: The binary operator to get the string representation for.
```

--------------------------------

### slang::SourceLocation::offset() const

Source: https://sv-lang.com/classslang_1_1_source_location.html

Gets the character offset of the source location within its buffer. This is the position relative to the start of the buffer.

```APIDOC
## slang::SourceLocation::offset() const

### Description
Returns the character offset of this location within the source buffer.

### Method
`size_t`

### Returns
- `size_t`: The character offset within the source buffer.
```

--------------------------------

### Enable Documentation Build with CMake

Source: https://sv-lang.com/building.html

Run CMake to configure the build with documentation enabled. The generated documentation will be located in `build/docs/html/`.

```bash
cmake -B build -DSLANG_INCLUDE_DOCS=ON
cmake --build build --target docs
```

--------------------------------

### slang::utf8Len

Source: https://sv-lang.com/namespaceslang.html

Gets the length of the UTF-8 sequence starting with the given first character. Returns 0 if the given character is invalid for a UTF-8 sequence.

```APIDOC
## slang::utf8Len(unsigned char first) constexpr

### Description
Gets the length of the UTF-8 sequence starting with the given first character. Returns 0 if the given character is invalid for a UTF-8 sequence.

### Parameters
#### Path Parameters
- **first** (unsigned char) - The first byte of the potential UTF-8 sequence.

### Returns
(int) The length of the UTF-8 sequence in bytes, or 0 if invalid.
```

--------------------------------

### SystemVerilog Package Example for slang-reflect

Source: https://sv-lang.com/tools.html

Demonstrates how slang-reflect processes SystemVerilog packages with public parameters to generate corresponding C++ header files.

```systemverilog
package foo;
    localparam foo_local /* public */ = 12;
endpackage

package bar;
    localparam bar_local /* public */ = 12;
endpackage

module top;
    localparam top_local /* verilator public */ = 12;
endmodule
```

--------------------------------

### getSymbolPathCB

Source: https://sv-lang.com/classslang_1_1_diagnostic_engine.html

Gets the callback to use for getting a symbol path for a given symbol.

```APIDOC
## getSymbolPathCB

### Description
Gets the callback to use for getting a symbol path for a given symbol.

### Returns
- const SymbolPathCB& - The registered symbol path callback.
```

--------------------------------

### Create and Activate Python Virtual Environment

Source: https://sv-lang.com/building.html

Set up a virtual environment for Python development and activate it. This isolates project dependencies.

```bash
python3 -m venv venv
source venv/bin/activate
```

--------------------------------

### Define Libraries with Library Map File

Source: https://sv-lang.com/user-manual.html

Libraries can be defined using library map files, passed to slang with the --libmap flag. This example shows how to include another map file and declare a library with specific files.

```systemverilog
include some/other/lib.map;

// Declare a library called "my_lib" with some files in it
library my_lib some_file.sv, "all/in/dir/*.sv", other/file2.sv;
```

--------------------------------

### Compile with Include Paths, Macros, and Warnings

Source: https://sv-lang.com/user-manual.html

Use this command to specify include directories, define preprocessor macros, and enable specific warning flags during compilation.

```bash
> slang myMod1.sv myMod2.sv -I/path/to/includes/ -DMY_MACRO=1 -Wextra -Wno-width-trunc
```

```bash
> slang myMod1.sv myMod2.sv +incdir+/path/to/includes/ +define+MY_MACRO=1 -Wextra -Wno-width-trunc
```

--------------------------------

### Integrate Slang as an External Package with CMake

Source: https://sv-lang.com/building.html

Integrates the slang library into your CMake project by finding the installed package. This method requires slang to be installed on the system.

```cmake
cmake_minimum_required(VERSION 3.28)
project(example)

find_package(slang 1.0.0)

add_executable(example example.cpp)
target_link_libraries(example PRIVATE slang::slang)
```

--------------------------------

### Configure and Build Slang

Source: https://sv-lang.com/building.html

These commands configure the build using CMake and then build the project. The -j flag allows for parallel compilation.

```bash
cmake -B build
cmake --build build -j
```

--------------------------------

### Specify Library Search Directories and Extensions

Source: https://sv-lang.com/user-manual.html

Use --libdir to specify directories where slang should search for library modules and --libext to define the file extensions for these modules. Slang will dynamically load missing modules found in these locations.

```bash
slang --libdir src/core:lib/utils --libext .v:.sv:myext
```

--------------------------------

### Constructors

Source: https://sv-lang.com/structslang_1_1syntax_1_1_compilation_unit_syntax.html

Demonstrates how to construct a new instance of CompilationUnitSyntax.

```APIDOC
## CompilationUnitSyntax Constructor

### Description
Constructs a new instance of the CompilationUnitSyntax struct.

### Signature
CompilationUnitSyntax(const SyntaxList<MemberSyntax>& members, Token endOfFile)

### Parameters
* **members** (const SyntaxList<MemberSyntax>&) - The list of members for the compilation unit.
* **endOfFile** (Token) - The end of file token.
```

```APIDOC
## CompilationUnitSyntax Copy Constructor

### Description
Copy constructor for CompilationUnitSyntax.

### Signature
CompilationUnitSyntax(const CompilationUnitSyntax&) defaulted explicit
```

--------------------------------

### getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_charge_strength_syntax.html

Gets a child member.

```APIDOC
## getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member.
```

```APIDOC
## getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member.
```

```APIDOC
## getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
PtrTokenOrSyntax getChildPtr(size_t index)

### Parameters
- **index** (size_t) - The index of the child member.
```

--------------------------------

### getBufferKind

Source: https://sv-lang.com/classslang_1_1_source_manager.html

Gets the kind for the given buffer.

```APIDOC
## getBufferKind(BufferID buffer) const

### Description
Gets the kind for the given buffer.

### Method
`getBufferKind`

### Parameters
#### Query Parameters
- **buffer** (BufferID) - Required - The source buffer ID.
```

--------------------------------

### Process Options

Source: https://sv-lang.com/classslang_1_1driver_1_1_driver.html

Applies all configured options after parsing. Optionally checks for file validity.

```cpp
bool processOptions(bool checkFiles = true)
```

--------------------------------

### getWaiverManager

Source: https://sv-lang.com/classslang_1_1_diagnostic_engine.html

Gets the waiver manager, if configured.

```APIDOC
## getWaiverManager

### Description
Gets the waiver manager, if configured.

### Returns
- std::shared_ptr<WaiverManager> - The configured waiver manager, or nullptr if none is set.
```

--------------------------------

### Create Syntax Visitor

Source: https://sv-lang.com/namespaceslang_1_1syntax.html

Creates a SyntaxVisitor from provided handler functions. Each function must accept the visitor object and the Syntax type to match against.

```cpp
#include <slang/syntax/SyntaxVisitor.h>
template<typename... Functions>
auto slang::syntax::makeSyntaxVisitor(Functions... funcs)
```

```cpp
int count = 0;
makeSyntaxVisitor([&](auto& visitor, const HierarchicalInstanceSyntax& node) {
    count++;
    visitor.visitDefault(node);
})
```

--------------------------------

### RangeListSyntax::getChildPtr

Source: https://sv-lang.com/structslang_1_1syntax_1_1_range_list_syntax.html

Gets a child member as a PtrTokenOrSyntax.

```APIDOC
## RangeListSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
PtrTokenOrSyntax getChildPtr(size_t index)

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### Typical Compilation Flow with Driver

Source: https://sv-lang.com/classslang_1_1driver_1_1_driver.html

Demonstrates a standard sequence of operations for compiling code using the Driver class. Ensure proper error handling after each step.

```cpp
Driver driver;
driver.addStandardArgs();
if (!driver.parseCommandLine(someStr)) { ...error }
if (!driver.processOptions()) { ...error }
if (!driver.parseAllSources()) { ...error }
if (!driver.runFullCompilation()) { ...error }
else { ...success }
```

--------------------------------

### InstanceNameSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_instance_name_syntax.html

Gets a child member of the InstanceNameSyntax.

```APIDOC
## InstanceNameSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

```APIDOC
## InstanceNameSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

--------------------------------

### SystemVerilog Pragma Diagnostic Control Example

Source: https://sv-lang.com/user-manual.html

Demonstrates the usage of slang's extended `pragma diagnostic` directives to control warning output within specific regions of SystemVerilog code.

```systemverilog
module m;
    ; // warn
`pragma diagnostic ignore="-Wempty-member"
    ; // hidden
`pragma diagnostic push
    ; // also hidden
`pragma diagnostic error="-Wempty-member"
    ; // error
`pragma diagnostic warn="-Wempty-member"
    ; // warn
`pragma diagnostic pop
`pragma diagnostic pop  // does nothing
    ; // hidden again

`pragma diagnostic fatal="empty-member" // ok to not use -W
`pragma diagnostic ignore=("default", "empty-member")
    ; // ignored
endmodule

```

--------------------------------

### ClockingSkewSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_clocking_skew_syntax.html

Gets a child member of ClockingSkewSyntax.

```APIDOC
## ClockingSkewSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
TokenOrSyntax getChild(size_t index) 
```

### Parameters
* **index** (size_t) - The index of the child member.
```

```APIDOC
## ClockingSkewSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
```cpp
ConstTokenOrSyntax getChild(size_t index) const
```

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_anonymous_program_syntax.html

Gets a child member at a given index.

```APIDOC
## getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index) 
ConstTokenOrSyntax getChild(size_t index) const 
PtrTokenOrSyntax getChildPtr(size_t index)
```

--------------------------------

### Module with ANSI Port Declaration

Source: https://sv-lang.com/command-line-ref.html

Example demonstrating a module with an ANSI port declaration. This is used to illustrate the effect of compatibility flags.

```SystemVerilog
module m(input a, output b);
    wire [31:0] a;
    logic [31:0] b;
    assign b = a;
endmodule

```

--------------------------------

### getRootNoFinalize

Source: https://sv-lang.com/classslang_1_1ast_1_1_compilation.html

Gets the root of the design without finalizing it.

```APIDOC
## const RootSymbol& getRootNoFinalize() const

### Description
Gets the root of the design without attempting to finalize it.
This means that (if the design has not been finalized previously) things like defparams will not be resolved, root instances will not have been created, etc.

### Returns
* const RootSymbol& - The root symbol of the design.
```

--------------------------------

### ASTVisitor visit() Entry Point

Source: https://sv-lang.com/classslang_1_1ast_1_1_a_s_t_visitor.html

The public entry point for initiating the visiting process on an AST node. It accepts any AST node type T.

```cpp
template<typename T>
void visit(const T& t)
```

--------------------------------

### getPrecedence

Source: https://sv-lang.com/classslang_1_1ast_1_1_op_info.html

Gets the precedence of the given binary operator.

```APIDOC
## getPrecedence

### Description
Gets the precedence of the given binary operator.

### Method
static int

### Parameters
#### Path Parameters
- **op** (BinaryOperator) - Description: The binary operator to get the precedence for.
```

--------------------------------

### Generated C++ Header for slang-reflect (Package Example)

Source: https://sv-lang.com/tools.html

Illustrates the C++ header file generated by slang-reflect for SystemVerilog packages, including namespaces and static constexpr variables for parameters.

```cpp
// bar.h
#pragma once
#include ...

namespace bar {
    static constexpr uint32_t bar_local = 12;
}

// foo.h
#pragma once
#include ...

namespace foo {
    static constexpr uint32_t foo_local = 12;
}

// top.h
#pragma once
#include ...

namespace top {
    static constexpr uint32_t top_local = 12;
}
```

--------------------------------

### getChild (TokenOrSyntax)

Source: https://sv-lang.com/structslang_1_1syntax_1_1_simple_sequence_expr_syntax.html

Gets the child member at the specified index.

```APIDOC
## getChild (TokenOrSyntax)

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
`TokenOrSyntax getChild(size_t index)`
```

--------------------------------

### slang::syntax::SyntaxTree::fromFile

Source: https://sv-lang.com/classslang_1_1syntax_1_1_syntax_tree.html

Creates a syntax tree from a full compilation unit specified by a file path.

```APIDOC
## Function documentation
### static TreeOrError slang::syntax::SyntaxTree::fromFile(std::string_view path)

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::syntax::SyntaxTree::fromFile(std::string_view path, SourceManager& sourceManager, const Bag& options = {})

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.
```

--------------------------------

### RangeListSyntax::getChild (ConstTokenOrSyntax)

Source: https://sv-lang.com/structslang_1_1syntax_1_1_range_list_syntax.html

Gets a child member as a ConstTokenOrSyntax.

```APIDOC
## RangeListSyntax::getChild (ConstTokenOrSyntax)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### RangeListSyntax::getChild (TokenOrSyntax)

Source: https://sv-lang.com/structslang_1_1syntax_1_1_range_list_syntax.html

Gets a child member as a TokenOrSyntax.

```APIDOC
## RangeListSyntax::getChild (TokenOrSyntax)

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### InstanceConfigRuleSyntax Overview

Source: https://sv-lang.com/structslang_1_1syntax_1_1_instance_config_rule_syntax.html

This section details the InstanceConfigRuleSyntax struct, its inheritance, constructors, and member functions.

```APIDOC
## Struct InstanceConfigRuleSyntax

Concrete syntax definition for an InstanceConfigRule.

### Base classes

* **ConfigRuleSyntax**: Concrete syntax definition for a ConfigRule.

### Public static functions

* **isKind(SyntaxKind kind)**: Returns true if the provided syntax kind is represented by this type.

### Constructors

* **InstanceConfigRuleSyntax(Token instance, Token topModule, const SyntaxList<ConfigInstanceIdentifierSyntax>& instanceNames, ConfigRuleClauseSyntax& ruleClause, Token semi)**: Constructs a new instance of the InstanceConfigRuleSyntax struct.
* **InstanceConfigRuleSyntax(const InstanceConfigRuleSyntax&)**: Copy constructor.

### Public functions

* **isChildOptional(size_t index) const**: Returns true if child member at the provided index is a nullable pointer.
* **getChild(size_t index)**: Gets the child member at the provided index.
* **getChild(size_t index) const**: Gets the child member as a pointer at the provided index.
* **getChildPtr(size_t index)**: Gets the child member (token or syntax node) at the provided index.
* **setChild(size_t index, TokenOrSyntax child)**: Sets the child member at the provided index.

### Public variables

* **instance** (Token): The instance member.
* **topModule** (Token): The topModule member.
* **instanceNames** (SyntaxList<ConfigInstanceIdentifierSyntax>): The instanceNames member.
* **ruleClause** (not_null<ConfigRuleClauseSyntax*>): The ruleClause member.
* **semi** (Token): The semi member.
```

--------------------------------

### SystemTimingCheckSyntax Constructors and Functions

Source: https://sv-lang.com/structslang_1_1syntax_1_1_system_timing_check_syntax.html

Provides details on how to construct a SystemTimingCheckSyntax object and interact with its members.

```APIDOC
## SystemTimingCheckSyntax

Concrete syntax definition for a SystemTimingCheck.

### Constructors

*   **SystemTimingCheckSyntax(const SyntaxList<AttributeInstanceSyntax>& attributes, Token name, Token openParen, const SeparatedSyntaxList<TimingCheckArgSyntax>& args, Token closeParen, Token semi)**: Constructs a new instance of the SystemTimingCheckSyntax struct.
*   **SystemTimingCheckSyntax(const SystemTimingCheckSyntax&)**: Copy constructor.

### Public Functions

*   **bool isChildOptional(size_t index) const**: Returns true if child member (token or syntax node) at the provided index within this struct is a nullable pointer.
*   **TokenOrSyntax getChild(size_t index)**: Gets the child member (token or syntax node) at the provided index within this struct.
*   **ConstTokenOrSyntax getChild(size_t index) const**: Gets the child member (token or syntax node) as a pointer at the provided index within this struct.
*   **PtrTokenOrSyntax getChildPtr(size_t index)**: Gets the child member (token or syntax node) at the provided index within this struct.
*   **void setChild(size_t index, TokenOrSyntax child)**: Sets the child member (token or syntax node) at the provided index within this struct.

### Public Variables

*   **Token name**: The name member.
*   **Token openParen**: The openParen member.
*   **SeparatedSyntaxList<TimingCheckArgSyntax> args**: The args member.
*   **Token closeParen**: The closeParen member.
*   **Token semi**: The semi member.

### Static Functions

*   **static bool isKind(SyntaxKind kind)**: Returns true if the provided syntax kind is represented by this type.
```

--------------------------------

### ProceduralBlockSyntax::getChildPtr

Source: https://sv-lang.com/structslang_1_1syntax_1_1_procedural_block_syntax.html

Gets a pointer to a child member of the ProceduralBlockSyntax.

```APIDOC
## ProceduralBlockSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
PtrTokenOrSyntax getChildPtr(size_t index)
```

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
(PtrTokenOrSyntax) A pointer to the child member at the specified index.
```

--------------------------------

### OneStepDelaySyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_one_step_delay_syntax.html

Gets a child member at a given index.

```APIDOC
## OneStepDelaySyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
TokenOrSyntax getChild(size_t index)
```

### Parameters
* **index** (size_t) - The index of the child member.
```

```APIDOC
## OneStepDelaySyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
```cpp
ConstTokenOrSyntax getChild(size_t index) const
```

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### InstanceNameSyntax::getChildPtr

Source: https://sv-lang.com/structslang_1_1syntax_1_1_instance_name_syntax.html

Gets a child member of the InstanceNameSyntax as a pointer.

```APIDOC
## InstanceNameSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
PtrTokenOrSyntax getChildPtr(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

--------------------------------

### Create SyntaxTree from File

Source: https://sv-lang.com/classslang_1_1syntax_1_1_syntax_tree.html

Creates a syntax tree from a full compilation unit by reading from a specified file path.

```APIDOC
## fromFile

### Description
Creates a syntax tree from a full compilation unit.

### Method
static TreeOrError fromFile(std::string_view path)

### Parameters
#### Path Parameters
- **path** (std::string_view) - Description: The path to the source file.
```

```APIDOC
## fromFile

### Description
Creates a syntax tree from a full compilation unit, utilizing a provided SourceManager and options.

### Method
static TreeOrError fromFile(std::string_view path, SourceManager& sourceManager, const Bag& options = {})

### Parameters
#### Path Parameters
- **path** (std::string_view) - Description: The path to the source file.
- **sourceManager** (SourceManager&) - Description: The source manager to use for loading.
- **options** (const Bag&) - Description: Optional configuration options.
```

--------------------------------

### MacroFormalArgumentSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_macro_formal_argument_syntax.html

Gets a child member at a given index.

```APIDOC
## MacroFormalArgumentSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.

### Returns
The child member at the specified index.
```

```APIDOC
## MacroFormalArgumentSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member to retrieve.

### Returns
A const pointer to the child member at the specified index.
```

```APIDOC
## MacroFormalArgumentSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
PtrTokenOrSyntax getChildPtr(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.

### Returns
A pointer to the child member at the specified index.
```

--------------------------------

### Include Directory Options

Source: https://sv-lang.com/command-line-ref.html

Specify directories for include directives. Use `-I` for quoted paths and `--isystem` for angle-bracketed paths.

```bash
-I,--include-directory <dir-pattern>[,...]
+incdir+<dir>[+<dir>...]
```

```bash
--isystem <dir-pattern>[,...]
```

--------------------------------

### MacroActualArgumentSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_macro_actual_argument_syntax.html

Gets a child member at a given index.

```APIDOC
## MacroActualArgumentSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
TokenOrSyntax getChild(size_t index)
```

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
TokenOrSyntax - The child member at the specified index.
```

```APIDOC
## MacroActualArgumentSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
```cpp
ConstTokenOrSyntax getChild(size_t index) const
```

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
ConstTokenOrSyntax - A const pointer to the child member at the specified index.
```

```APIDOC
## MacroActualArgumentSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
PtrTokenOrSyntax getChildPtr(size_t index)
```

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
PtrTokenOrSyntax - A pointer to the child member at the specified index.
```

--------------------------------

### slang::syntax::SyntaxTree::fromText

Source: https://sv-lang.com/classslang_1_1syntax_1_1_syntax_tree.html

Creates a syntax tree from source code provided as a string.

```APIDOC
## Function documentation
### static std::shared_ptr<SyntaxTree> slang::syntax::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.

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::shared_ptr<SyntaxTree> slang::syntax::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.

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::shared_ptr<SyntaxTree> slang::syntax::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.

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
```

--------------------------------

### EmptyMemberSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_empty_member_syntax.html

Gets a child member at a specific index.

```APIDOC
## EmptyMemberSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member.

### Returns
(TokenOrSyntax) The child member at the specified index.
```

```APIDOC
## EmptyMemberSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member.

### Returns
(ConstTokenOrSyntax) The child member as a pointer at the specified index.
```

--------------------------------

### runPreprocessor

Source: https://sv-lang.com/classslang_1_1driver_1_1_driver.html

Runs the preprocessor on all loaded buffers and outputs the result to stdout.

```APIDOC
## bool runPreprocessor(bitmask<PreprocessOutputFlags> flags)

### Description
Runs the preprocessor on all loaded buffers and outputs the result to stdout.

### Method
`bool runPreprocessor(bitmask<PreprocessOutputFlags> flags)`

### Parameters
- **flags** (bitmask<PreprocessOutputFlags>) - Flags to control preprocessor output.

### Response
#### Success Response (true)
Returns true if the preprocessor ran successfully.

#### Success Response (false)
Returns false if the preprocessor failed.
```

--------------------------------

### Run Preprocessor

Source: https://sv-lang.com/classslang_1_1driver_1_1_driver.html

Executes the preprocessor on all loaded source buffers and directs the output to standard output.

```cpp
bool runPreprocessor(bitmask<PreprocessOutputFlags> flags)
```

--------------------------------

### ExpressionCoverageBinInitializerSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_expression_coverage_bin_initializer_syntax.html

Gets a child member at a given index.

```APIDOC
## ExpressionCoverageBinInitializerSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Method
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member to retrieve.
```

```APIDOC
## ExpressionCoverageBinInitializerSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Method
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member to retrieve.
```

--------------------------------

### slang::syntax::SyntaxTree::fromFiles

Source: https://sv-lang.com/classslang_1_1syntax_1_1_syntax_tree.html

Creates a syntax tree by concatenating several files loaded from disk.

```APIDOC
## Function documentation
### static TreeOrError slang::syntax::SyntaxTree::fromFiles(std::span<const std::string_view> paths)

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::syntax::SyntaxTree::fromFiles(std::span<const std::string_view> paths, SourceManager& sourceManager, const Bag& options = {})

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.
```

--------------------------------

### ExpressionConstraintSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_expression_constraint_syntax.html

Gets a child member at a given index.

```APIDOC
## getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
(TokenOrSyntax) The child member at the specified index.
```

```APIDOC
## getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
(ConstTokenOrSyntax) The child member as a pointer at the specified index.
```

--------------------------------

### Optionally Write Dependency Files

Source: https://sv-lang.com/classslang_1_1driver_1_1_driver.html

Writes dependency files if they were requested through command-line options.

```cpp
void optionallyWriteDepFiles()
```

--------------------------------

### EqualsTypeClauseSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_equals_type_clause_syntax.html

Gets a child member at a given index.

```APIDOC
## getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Method
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member.
```

```APIDOC
## getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Method
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### EmptyPortConnectionSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_empty_port_connection_syntax.html

Gets a child member at a given index.

```APIDOC
## EmptyPortConnectionSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member.

### Returns
The child member at the specified index.
```

```APIDOC
## EmptyPortConnectionSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member.

### Returns
A const pointer to the child member at the specified index.
```

--------------------------------

### Using SmallVector and BumpAllocator for Arena Allocation

Source: https://sv-lang.com/commoncomp.html

Demonstrates how to use slang::SmallVector to build a list of elements locally and then copy them into a slang::BumpAllocator. This is useful for creating dynamic lists of trivially destructible objects within an arena.

```cpp
SmallVector<int> smallVec;
smallVec.append(3);
smallVec.append(4);
smallVec.append(5);

BumpAllocator alloc;
span<int> finalList = smallVec.copy(alloc);
```

--------------------------------

### runPreprocessor

Source: https://sv-lang.com/classslang_1_1driver_1_1_driver.html

Runs the preprocessor on all loaded buffers and outputs the result to stdout. Errors are printed to stderr.

```APIDOC
## bool slang::driver::Driver::runPreprocessor(bitmask<PreprocessOutputFlags> flags)

### Description
Runs the preprocessor on all loaded buffers and outputs the result to stdout. Any errors encountered will be printed to stderr.

### Method
bool

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **flags** (bitmask<PreprocessOutputFlags>) - Flags controlling preprocessor output.

### Returns
* bool - true on success, false on failure.
```

--------------------------------

### DividerClauseSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_divider_clause_syntax.html

Gets a child member at a given index.

```APIDOC
## DividerClauseSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member.

### Returns
The child member as a `TokenOrSyntax`.
```

```APIDOC
## DividerClauseSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member.

### Returns
The child member as a `ConstTokenOrSyntax` pointer.
```

```APIDOC
## DividerClauseSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
PtrTokenOrSyntax getChildPtr(size_t index)

### Parameters
- **index** (size_t) - The index of the child member.

### Returns
The child member as a `PtrTokenOrSyntax`.
```

--------------------------------

### DistConstraintListSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_dist_constraint_list_syntax.html

Gets a child member at a given index.

```APIDOC
## DistConstraintListSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
TokenOrSyntax getChild(size_t index)
```

### Parameters
* **index** (size_t) - The index of the child member.
```

```APIDOC
## DistConstraintListSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
```cpp
ConstTokenOrSyntax getChild(size_t index) const
```

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### slang::ast::ValuePath::ValuePath()

Source: https://sv-lang.com/classslang_1_1ast_1_1_value_path.html

Constructs an empty ValuePath.

```APIDOC
## ValuePath() defaulted

### Description
Constructs an empty path.
```

--------------------------------

### DelaySyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_delay_syntax.html

Gets a child member at a given index.

```APIDOC
## DelaySyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Method
TokenOrSyntax

### Parameters
* **index** (size_t) - The index of the child member.

### Returns
* **TokenOrSyntax** - The child member.
```

--------------------------------

### Clone Slang Repository

Source: https://sv-lang.com/building.html

Use this command to download the slang source code from GitHub.

```bash
git clone https://github.com/MikePopoloski/slang.git
```

--------------------------------

### Parse SystemVerilog File

Source: https://sv-lang.com/parsing.html

Constructs a SyntaxTree from a SystemVerilog source file on disk. The result is wrapped in std::expected to handle potential file loading errors.

```cpp
auto result = SyntaxTree::fromFile("path/to/file.sv");
if (result) {
    /* do something with *result */
}
else {
    /* do something with result.error() */
}
```

--------------------------------

### DefaultDistItemSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_default_dist_item_syntax.html

Gets a child member at a given index.

```APIDOC
## DefaultDistItemSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
The child member as a `TokenOrSyntax` object.
```

```APIDOC
## DefaultDistItemSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
The child member as a `ConstTokenOrSyntax` pointer.
```

--------------------------------

### DefParamSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_def_param_syntax.html

Gets a child member at a given index.

```APIDOC
## DefParamSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

```APIDOC
## DefParamSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

```APIDOC
## DefParamSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
PtrTokenOrSyntax getChildPtr(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

--------------------------------

### Create ASTVisitor with makeVisitor

Source: https://sv-lang.com/namespaceslang_1_1ast.html

Creates an ASTVisitor from a variadic list of handler functions. Use this to easily construct visitors for AST traversal.

```cpp
template<typename... Functions>
auto makeVisitor(Functions... funcs)
```

--------------------------------

### CoverageOptionSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_coverage_option_syntax.html

Gets a child member at a given index.

```APIDOC
## CoverageOptionSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
TokenOrSyntax getChild(size_t index)

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
The child member as a `TokenOrSyntax` object.
```

```APIDOC
## CoverageOptionSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Signature
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
* **index** (size_t) - The index of the child member to retrieve.

### Returns
The child member as a `ConstTokenOrSyntax` pointer.
```

--------------------------------

### makeSyntaxVisitor

Source: https://sv-lang.com/namespaceslang_1_1syntax.html

Creates a SyntaxVisitor from provided handler functions.

```APIDOC
## template<typename... Functions>
auto slang::syntax::makeSyntaxVisitor(Functions... funcs)

### Description
Creates a SyntaxVisitor out of the provided handler functions. The provided callable arguments must take two parameters, the first of which is the visitor object itself (so that you can call visitDefault on it if desired) and the second is the Syntax type to match against.

### Parameters
- **funcs** (Functions...): A variadic pack of handler functions.
```

--------------------------------

### ClockingSkewSyntax::getChildPtr

Source: https://sv-lang.com/structslang_1_1syntax_1_1_clocking_skew_syntax.html

Gets a child member of ClockingSkewSyntax as a pointer.

```APIDOC
## ClockingSkewSyntax::getChildPtr

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
```cpp
PtrTokenOrSyntax getChildPtr(size_t index)
```

### Parameters
* **index** (size_t) - The index of the child member.
```

--------------------------------

### Enable Legacy Protect Directives

Source: https://sv-lang.com/command-line-ref.html

Activate legacy source protection directives for compatibility with older tools.

```bash
--enable-legacy-protect
```

--------------------------------

### Integrate Slang using FetchContent with CMake

Source: https://sv-lang.com/building.html

Integrates the slang library into your CMake project by fetching the source directly from GitHub. This method builds slang as part of your project.

```cmake
cmake_minimum_required(VERSION 3.28)
project(example)

# Note: this example just pulls the head master branch
# for slang, but a real project would very likely pin
# this to a specific tag and only update when ready
# to accept a new version.
include(FetchContent)
FetchContent_Declare(
  slang
  GIT_REPOSITORY https://github.com/MikePopoloski/slang.git
  GIT_SHALLOW ON)
FetchContent_MakeAvailable(slang)

add_executable(example example.cpp)
target_link_libraries(example PRIVATE slang::slang)
```

--------------------------------

### ClassNameSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_class_name_syntax.html

Gets a child member at a given index.

```APIDOC
## ClassNameSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Method
TokenOrSyntax getChild(size_t index)

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

```APIDOC
## ClassNameSyntax::getChild (const)

### Description
Gets the child member (token or syntax node) as a pointer at the provided index within this struct.

### Method
ConstTokenOrSyntax getChild(size_t index) const

### Parameters
- **index** (size_t) - The index of the child member to retrieve.
```

--------------------------------

### ClassSpecifierSyntax::getChild

Source: https://sv-lang.com/structslang_1_1syntax_1_1_class_specifier_syntax.html

Gets a child member at a given index.

```APIDOC
## ClassSpecifierSyntax::getChild

### Description
Gets the child member (token or syntax node) at the provided index within this struct.

### Signature
`TokenOrSyntax getChild(size_t index)`
`ConstTokenOrSyntax getChild(size_t index) const`
```
Tokens:
Raw