Class CompiledGrammar

Namespace

Utils.Parser.Runtime

Assembly

Utils.Parser.dll

A ready-to-use grammar instance that encapsulates the full parse pipeline: LexerEngine tokenization followed by ParserEngine parsing.

Obtain an instance from a resolved ParserDefinition via the constructor, or compile directly from an ANTLR4 grammar source string via Antlr4GrammarConverter.Compile(grammarText).

public sealed class CompiledGrammar

Inheritance

object

CompiledGrammar

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DataUtils.ToDbValue(object?)

MathEx.Clamp<T>(T, T, T, IComparer<T>)

FluentExtensions.Failure<T>(T)

FluentExtensions.IsEqualTo<T, CT>(T, CT)

FluentExtensions.IsGreaterOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsGreaterThan<T, CT>(T, CT)

FluentExtensions.IsIn<T>(T, params T[])

FluentExtensions.IsLowerOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsLowerThan<T, CT>(T, CT)

FluentExtensions.IsNotIn<T>(T, params T[])

FluentExtensions.IsNotNull<T>(T)

FluentExtensions.IsNull<T>(T)

FluentExtensions.Success<T>(T)

FluentExtensions.Test<T>(T, Func<T, bool>)

ObjectUtils.Between<T>(T, IComparer<T>, T, T)

ObjectUtils.Between<T>(T, IComparer<T>, T, T, bool, bool)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Func<Task<Result>>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Result)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.In<T>(T, params T[])

ObjectUtils.NotIn<T>(T, params T[])

Validations.ArgMustBe<T>(T, Func<T, bool>, string, string)

Validations.ArgMustNotBe<T>(T, Func<T, bool>, string, string)

Validations.Arg<T>(T, string)

Validations.ValueMustNotBeNull<T>(T, string)

Validations.Variable<T>(T, string)

Constructors

CompiledGrammar(ParserDefinition)

Initialises a CompiledGrammar from a fully resolved ParserDefinition (i.e. the output of RuleResolver.Resolve).

public CompiledGrammar(ParserDefinition definition)

Parameters

definition ParserDefinition

A resolved grammar definition.

CompiledGrammar(ParserDefinition, ParserRuntimeFeaturePolicy)

Initialises a CompiledGrammar from a fully resolved ParserDefinition with an explicit runtime feature policy.

public CompiledGrammar(ParserDefinition definition, ParserRuntimeFeaturePolicy runtimeFeaturePolicy)

Parameters

definition ParserDefinition

A resolved grammar definition.

runtimeFeaturePolicy ParserRuntimeFeaturePolicy

Runtime feature policy applied to parser execution.

Properties

Definition

The resolved ParserDefinition backing this grammar.

public ParserDefinition Definition { get; }

Property Value

ParserDefinition

Methods

Parse(string)

Runs the full parse pipeline on input: tokenizes the text with the embedded LexerEngine and then builds a parse tree with the ParserEngine.

public ParseNode Parse(string input)

Parameters

input string

Source text to parse.

Returns

ParseNode

The root ParseNode. Returns an ErrorNode when the input does not conform to the grammar rather than throwing an exception.

Tokenize(string)

Tokenizes input and returns all tokens produced by the lexer, in source order. Skipped tokens (e.g. whitespace with -> skip) are already excluded from the stream at this stage.

public IReadOnlyList<Token> Tokenize(string input)

Parameters

input string

Source text to tokenize.

Returns

IReadOnlyList<Token>

Read-only list of tokens.