class GrammarBuilder in Tinman.Core.Parsing

Helper class for building Grammar objects.

sealed class

GrammarBuilder

extends

Disposable

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Build

Builds the Grammar object and validates it.

[OwnerReturn, OwnerThis]
public method	Build (Graph<IGrammarRule> dependencyGraph = null)
type	Grammar
params	dependencyGraph		Optional graph that will receive links that describe the grammar rule dependencies (source depends on target).
returns		[not-null]	The Grammar object.

BuildDisposeOnShutdown

Builds the Grammar object and validates it.

[OwnerThis]
public method	BuildDisposeOnShutdown ()
type	Grammar
returns		[not-null]	The Grammar object.

Remarks:

The Grammar object will be disposed automatically during shutdown (see Shutdown).

DefaultRule

Specifies the default rule of the Grammar.

[OwnerReturn, OwnerThis]
public method	DefaultRule (string ruleName)
type	GrammarBuilder
params	ruleName	[not-empty]	The default rule name.
returns		[not-null]	this

Remarks:

If no other default rule is specified, the first grammar rule will become the default one.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

ExternalRule

Specifies an external rule for the Grammar.

[OwnerReturn, OwnerThis]
public method	ExternalRule (IGrammarRule rule)
type	GrammarBuilder
params	rule	[not-null]	The external rule.
returns		[not-null]	this

Psi

Specifies a handler method for creating a program structure information (PSI) node for the given abstract syntax tree (AST) node type.

[OwnerReturn, OwnerThis]
public method	Psi (string tokenType, PsiDelegate psi)
type	GrammarBuilder
params	tokenType	[not-null]	The AST token type.
	psi	[not-null]	The PSI handler method.
returns		[not-null]	this