slang namespace

Classes

class AbortAssertionExpr

Represents an abort (accept_on / reject_on) property expression.

class AssertionPortSymbol

class AssignmentExpression

Represents an assignment expression.

class AssignmentPatternExpressionBase

Base class for assignment pattern expressions.

struct AssociativeArray

Represents a SystemVerilog associative array, for use during constant evaluation.

class AssociativeArrayType

Represents an unpacked array that provides associative lookup.

template<typename TDerived, bool VisitStatements, bool VisitExpressions>

struct ASTVisitor

class Bag

class BinaryAssertionExpr

Represents a binary operator in a sequence or property expression.

class BinaryExpression

Represents a binary operator expression.

template<typename T>

class bitmask

class BlockStatement

Represents a sequential or parallel block statement.

struct BufferID

class BumpAllocator

class CallExpression

Represents a subroutine call.

class CaseAssertionExpr

Represents a case operator in a property expression.

class CHandleType

Represents storage for pointers passed using the DPI (a "C" compatible handle).

class ClassBuilder

A helper class for constructing class types programmatically.

class ClassType

Represents a class definition type.

class ClockingArgumentExpression

class ClockingAssertionExpr

Represents an assertion expression with attached clocking control.

class CommandLine

class Compilation

struct CompilationOptions

Contains various options that can control compilation behavior.

class CompilationUnitSymbol

The root of a single compilation unit.

class ConcatenationExpression

Represents a concatenation expression.

class ConditionalAssertionExpr

Represents a conditional operator in a property expression.

class ConditionalConstraint

Represents a constraint defined by an if-else condition.

class ConditionalExpression

Represents a conditional operator expression.

struct ConstantRange

class ConstantValue

class ConstraintBlockSymbol

Represents a named constraint block declaration within a class.

class ConstraintList

Represents a list of constraints.

struct ConstTokenOrSyntax

A token or a constant syntax node.

class ContinuousAssignSymbol

Represents a continuous assignment statement.

class ConversionExpression

Represents a type conversion expression (implicit or explicit).

class CopyClassExpression

Represents a new expression that copies a class instance.

template<typename T>

class CopyPtr

class CVConstIterator

class CVIterator

class DataTypeExpression

class DeclaredType

class DefParamSymbol

Represents a defparam directive.

class DesignTreeNode

class Diagnostic

Wraps up a reported diagnostic along with location in source and any arguments.

class DiagnosticEngine

class Diagnostics

A collection of diagnostics.

class DisableSoftConstraint

Represents a constraint that disables a soft random variable.

class DistExpression

class DynamicArrayType

Represents a dynamically sized unpacked array.

class ElabSystemTaskSymbol

Represents an elaboration system task, such as $error or $warning.

class ElementSelectExpression

Represents a single element selection expression.

class EmptyArgumentExpression

class EmptyMemberSymbol

class EmptyStatement

Represents an empty statement, used as a placeholder or an anchor for attributes.

class EnumType

Represents an enumerated type.

class EnumValueSymbol

Represents an enumerated value / member.

class ErrorType

class EvalContext

class EventType

class ExplicitImportSymbol

Represents an explicit import from a package.

class Expression

The base class for all expressions in SystemVerilog.

class ExpressionConstraint

Represents a constraint defined by a logical expression.

class FieldSymbol

Represents a field member of a struct or union.

class FirstMatchAssertionExpr

Represents a first_match operator in a sequence expression.

class FixedSizeUnpackedArrayType

class FloatingType

class ForeachConstraint

Represents a constraint that iterates over the elements of an array.

class FormalArgumentSymbol

Represents a formal argument in subroutine (task or function).

class ForwardingTypedefSymbol

template<typename Fn>

class function_ref

class GenerateBlockArraySymbol

Represents an array of generate blocks, as generated by a loop generate construct.

class GenerateBlockSymbol

class GenericClassDefSymbol

class GenvarSymbol

Represents a genvar declaration.

class HierarchicalReferenceExpression

class HierarchicalValueExpression

Represents an expression that references a named value via hierarchical path.

class ImplicationConstraint

Represents a constraint defined by an implication.

class InsideExpression

Represents a set membership operator expression.

class InstanceSymbolBase

Common functionality for module, interface, program, and primitive instances.

class IntegerLiteral

Represents an integer literal.

class IntegralType

class InterfacePortSymbol

class InvalidExpression

class InvalidStatement

template<typename DerivedT, typename IteratorCategoryT, typename T, typename DifferenceTypeT = std::ptrdiff_t, typename PointerT = T*, typename ReferenceT = T&>

class iterator_facade

template<typename TIterator>

class iterator_range

A range represented by an interator pair, begin and end.

class IteratorSymbol

Represents an iterator variable created for array manipulation methods.

class JsonWriter

class Lexer

struct LexerOptions

Contains various options that can control lexing behavior.

struct logic_t

class Lookup

Centralized functionality for looking up symbols by name in the AST.

class LookupLocation

struct LookupResult

A structure that contains the results of a name lookup operation.

class LValue

class LValueReferenceExpression

class MemberAccessExpression

Represents an access of a structure variable's members.

class MethodBuilder

A helper class for constructing method symbols programmatically.

class MinTypMaxExpression

Represents a min:typ:max expression.

class ModportPortSymbol

Represents a single port specifier in a modport declaration.

class ModportSymbol

Represents a modport within an interface definition.

class NamedValueExpression

Represents an expression that references a named value.

class NetSymbol

Represents a net declaration.

class NetType

class NewArrayExpression

Represents a new[] expression that creates a dynamic array.

class NewClassExpression

Represents a new expression that creates a class instance.

template<typename T>

class not_null

class NullLiteral

Represents a null literal.

class NullType

struct NumericTokenFlags

Various flags for numeric tokens.

class OpenRangeExpression

class OS

A collection of various OS-specific utility functions.

class PackageSymbol

A SystemVerilog package construct.

class PackedArrayType

class PackedStructType

Represents a packed structure of members.

class PackedUnionType

Represents a packed union of members.

class ParameterSymbol

Represents a parameter value.

struct ParamOverrideNode

class Parser

Implements a full syntax parser for SystemVerilog.

class ParserBase

struct ParserOptions

Contains various options that can control parsing behavior.

class PortSymbol

class PredefinedIntegerType

Represents the predefined integer types, which are essentially predefined vector types.

class Preprocessor

struct PreprocessorOptions

Contains various options that can control preprocessing behavior.

class PropertySymbol

Represents a named property object.

class QueueType

Represents an unpacked array that provides queue semantics.

class RangeSelectExpression

Represents a range selection expression.

struct real_t

class RealLiteral

Represents a real number literal.

class ReplicatedAssignmentPatternExpression

Represents a replicated assignment pattern expression.

class ReplicationExpression

Represents a replication expression.

class RootSymbol

Represents the entirety of a design, along with all contained compilation units.

template<typename T, typename Index>

class SafeIndexedVector

class ScalarType

Represents the single-bit scalar types.

class Scope

template<typename F>

class ScopeGuard

class ScriptSession

template<typename T>

class SeparatedSyntaxList

class SequenceConcatExpr

Represents an assertion expression defined as a simple regular expression.

struct SequenceRange

Represents a range of potential sequence matches.

struct SequenceRepetition

Encodes a repetition of some sub-sequence.

class SequenceSymbol

Represents a named sequence object.

struct shortreal_t

class SimpleAssertionExpr

Represents an assertion expression defined as a simple regular expression.

class SimpleAssignmentPatternExpression

Represents an assignment pattern expression.

class SimpleSystemSubroutine

template<typename K, typename V, size_t N, typename Entry = ska::detailv3::sherwood_v3_entry<std::pair<K, V>>, typename Alloc = StackAllocator<Entry, N>>

class SmallMap

template<typename T, size_t N, typename Entry = ska::detailv3::sherwood_v3_entry<T>, typename Alloc = StackAllocator<Entry, N>>

class SmallSet

template<typename T>

class SmallVector

template<typename T, size_t N>

class SmallVectorSized

class SolveBeforeConstraint

Represents a constraint that enforces ordering of solving variables.

struct SourceBuffer

class SourceLocation

class SourceManager

class SourceRange

Combines a pair of source locations that denote a range of source text.

class SpecparamSymbol

Represents a specify parameter.

class Statement

The base class for all statements in SystemVerilog.

class StatementBinder

class StatementList

Represents a list of statements.

class StorageElement

class StreamingConcatenationExpression

Represents a streaming concatenation.

class StringLiteral

Represents a string literal.

template<typename T>

class StringTable

class StringType

Represents an ASCII string type.

class StrongWeakAssertionExpr

Represents a strong or weak operator in a property expression.

class StructuredAssignmentPatternExpression

Represents an assignment pattern expression.

class SubroutineSymbol

Represents a subroutine (task or function).

class SVInt

class SVIntStorage

struct SVQueue

Represents a SystemVerilog queue, for use during constant evaluation.

class Symbol

class SyntaxFacts

template<typename T>

class SyntaxList

A syntax node that represents a list of child syntax nodes.

class SyntaxListBase

A base class for syntax nodes that represent a list of items.

class SyntaxNode

Base class for all syntax nodes.

class SyntaxPrinter

template<typename TDerived>

class SyntaxRewriter

class SyntaxTree

template<typename TDerived>

class SyntaxVisitor

class TimeLiteral

Represents a time literal.

struct TimeScale

struct TimeScaleValue

A combination of a unit and magnitude for a time scale value.

class Token

class TokenList

A syntax node that represents a list of child tokens.

struct TokenOrSyntax

A token or a syntax node.

template<typename TNode>

struct TokenOrSyntaxBase

A base class template for a sum type representing either a token or a syntax node.

class TransparentMemberSymbol

class Trivia

class Type

class TypeAliasType

Represents a type alias, which is introduced via a typedef or type parameter.

template<typename T>

class TypedBumpAllocator

class TypeReferenceExpression

class TypeRefType

Represents the result of a type reference expression, i.e. the type() operator.

class UnaryAssertionExpr

Represents a unary operator in a property expression.

class UnaryExpression

Represents a unary operator expression.

class UnbasedUnsizedIntegerLiteral

Represents an unbased unsized integer literal, which fills all bits in an expression.

class UnboundedLiteral

Represents the unboudned queue or range literal.

class UnboundedType

class UniquenessConstraint

Represents a constraint that enforces uniqueness of variables.

class UnknownModuleSymbol

class UnpackedStructType

Represents an unpacked structure of members.

class UnpackedUnionType

Represents an unpacked union of members.

class UntypedType

Represents an 'untyped' type, which is used for e.g. arguments of sequences.

class ValueExpressionBase

Common base class for both NamedValueExpression and HierarchicalValueExpression.

class ValueSymbol

class VariableSymbol

Represents a variable declaration.

class VersionInfo

Provides access to compile-time generated version info about the library.

class VirtualInterfaceType

Represents a virtual interface type.

class VoidType

class WildcardImportSymbol

Enums

enum class BindFlags { None = 0, Constant = 1 << 0, NoHierarchicalNames = 1 << 1, InsideConcatenation = 1 << 2, UnevaluatedBranch = 1 << 3, AllowDataType = 1 << 4, EnumInitializer = 1 << 5, NoAttributes = 1 << 6, AssignmentAllowed = 1 << 7, AssignmentDisallowed = 1 << 8, NonProcedural = 1 << 9, StaticInitializer = 1 << 10, StreamingAllowed = 1 << 11, TopLevelStatement = 1 << 12, AllowUnboundedLiteral = 1 << 13, SpecparamsAllowed = 1 << 14, FunctionOrFinal = 1 << 15, NonBlockingTimingControl = 1 << 16, EventExpression = 1 << 17, AllowTypeReferences = 1 << 18, AssertionExpr = 1 << 19 }

Specifies flags that control expression and statement binding.

enum class EvalFlags: uint8_t { None = 0, IsScript = 1, IsVerifying = 2, CacheResults = 4 }

Various flags that can be applied to a constant expression evaluation.

enum class LookupFlags { None = 0, Constant = 1 << 0, Type = 1 << 1, AllowDeclaredAfter = 1 << 2, DisallowWildcardImport = 1 << 3, NoUndeclaredError = 1 << 4, NoUndeclaredErrorIfUninstantiated = 1 << 5, TypedefTarget = 1 << 6, NoParentScope = 1 << 7, RegisterUpwardNames = 1 << 8, ForceHierarchical = AllowDeclaredAfter | RegisterUpwardNames | NoUndeclaredErrorIfUninstantiated }

Additional modifiers for a lookup operation.

enum class MinTypMax { Min, Typ, Max }

enum class DiagnosticSeverity { Ignored, Note, Warning, Error, Fatal }

enum class LiteralBase: uint8_t { Binary, Octal, Decimal, Hex }

Specifies the base of an integer (for converting to/from a string)

enum class TimeUnit: uint8_t { Seconds, Milliseconds, Microseconds, Nanoseconds, Picoseconds, Femtoseconds }

Scale unit for a time value.

enum class TimeScaleMagnitude: uint8_t { One = 1, Ten = 10, Hundred = 100 }

enum class KeywordVersion: uint8_t { v1364_1995 = 0, v1364_2001_noconfig = 1, v1364_2001 = 2, v1364_2005 = 3, v1800_2005 = 4, v1800_2009 = 5, v1800_2012 = 6, v1800_2017 = 7 }

enum class TriviaKind: uint8_t { Unknown, Whitespace, EndOfLine, LineComment, BlockComment, DisabledText, SkippedTokens, SkippedSyntax, Directive }

The kind of trivia we've stored.

enum class MethodFlags: uint16_t { None = 0, Virtual = 1 << 0, Pure = 1 << 1, Static = 1 << 2, Constructor = 1 << 3, InterfaceImport = 1 << 4, DPIImport = 1 << 5, DPIContext = 1 << 6, NotConst = 1 << 7, Randomize = 1 << 8 }

Specifies various flags that can apply to subroutines.

enum class SymbolIndex: uint32_t { }

enum class DeclaredTypeFlags { None = 0, InferImplicit = 1 << 0, RequireConstant = 1 << 1, AutomaticInitializer = 1 << 2, Port = 1 << 3, TypedefTarget = 1 << 4, NetType = 1 << 5, UserDefinedNetType = 1 << 6, FormalArgMergeVar = 1 << 7, Rand = 1 << 8, DPIReturnType = 1 << 9, DPIArg = 1 << 10, SpecparamsAllowed = 1 << 11, NeedsTypeCheck = Port | NetType | UserDefinedNetType | FormalArgMergeVar | Rand | DPIReturnType | DPIArg }

Various flags that control declared type resolution.

enum class IntegralFlags: uint8_t { Unsigned = 0, TwoState = 0, Signed = 1, FourState = 2, Reg = 4 }

Specifies possible traits for integral types.

Typedefs

using bitwidth_t = uint32_t

A type that can represent the largest possible bit width of a SystemVerilog integer.

Functions

auto countLeadingZeros32(uint32_t value) -> uint32_t

auto countLeadingZeros64(uint64_t value) -> uint32_t

auto checkedAddS32(int32_t a, int32_t b) -> std::optional<int32_t>

auto checkedSubS32(int32_t a, int32_t b) -> std::optional<int32_t>

auto checkedMulU32(uint32_t a, uint32_t b) -> std::optional<uint32_t>

auto clog2(const SVInt& v) -> uint32_t

Returns the ceiling of the log_2 of the value. If value is zero, returns zero.

ENUM(VariableLifetime, LIFETIME)

Specifies the storage lifetime of a variable.

ENUM(Visibility, VISIBILITY)

Specifies the visibility of class members.

ENUM(ArgumentDirection, DIRECTION)

Specifies behavior of an argument passed to a subroutine.

ENUM(ProceduralBlockKind, BLOCK)

Specifies possible procedural block kinds.

ENUM(StatementBlockKind, BLOCK)

Specifies possible statement block kinds.

ENUM(DefinitionKind, DEF)

Specifies possible definition kinds.

ENUM(UnconnectedDrive, UD)

Specifies possible unconnected drive settings.

ENUM(EdgeKind, EDGE)

Specifies possible edge kinds.

ENUM(SubroutineKind, SRK)

Specifies possible subroutine kinds.

ENUM(AssertionKind, ASK)

Specifies possible assertion kinds.

ENUM(ElabSystemTaskKind, ELAB)

Specifies possible elaboration system task kinds.

ENUM(RandMode, MODE)

Specifies possible assertion kinds.

ENUM(PrimitivePortDirection, DIRECTION)

Specifies behavior of a primitive port.

auto xxhash(const void* input, size_t len) -> size_t

Hashes the provided input using the xxhash XXH3 algorithm.

template<typename T, typename... Rest>

void hash_combine(size_t& seed, const T& v, Rest... rest)

template<typename T>

auto make_range(T begin, T end) -> iterator_range<T>

Constructs an iterator_range from two provided iterators (inferring the types involved).

template<typename TContainer>

auto make_reverse_range(TContainer&& container) -> auto

auto toStringView(span<char> text) -> string_view

Converts a span of characters into a string_view.

void uintToStr(SmallVector<char>& buffer, uint32_t value)

Converts the provided value into a string, storing it into buffer.

void uintToStr(SmallVector<char>& buffer, uint64_t value)

Converts the provided value into a string, storing it into buffer.

auto strToInt(string_view str, size_t* pos = nullptr, int base = 10) -> optional<int32_t>

auto strToUInt(string_view str, size_t* pos = nullptr, int base = 10) -> optional<uint32_t>

auto strToDouble(string_view str, size_t* pos = nullptr) -> optional<double>

auto editDistance(string_view left, string_view right, bool allowReplacements = true, int maxDistance = 0) -> int

auto widen(string_view str) -> string_view

Widens the provided UTF8 string into UTF16 wchars.

auto narrow(string_view str) -> string_view

Widens the provided UTF16 string into UTF8.

Enum documentation

Typedef documentation

Function documentation