Class BundleSyntax

Namespace

Hi.NcParsers.Syntaxs

Assembly

HiMech.dll

Depth-First Sequential Syntaxes management. It saves space by save the LazyLinkedLists from each syntax to only one LazyLinkedLists in SoftNcRunner to get better performance. If the INcSyntax only edit the current node itself, those self-editing INcSyntax without looks-forward is suitable to put into the BundleSyntax.

public class BundleSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource

Inheritance

object

BundleSyntax

Implements

ISituNcSyntax

INcSyntax

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

BundleSyntax()

Creates an empty bundle (name defaults to the type name BundleSyntax).

public BundleSyntax()

BundleSyntax(IEnumerable<ISituNcSyntax>)

Creates a bundle with default Name from an ordered syntax list.

public BundleSyntax(IEnumerable<ISituNcSyntax> syntaxes)

Parameters

syntaxes IEnumerable<ISituNcSyntax>

BundleSyntax(string, IEnumerable<ISituNcSyntax>)

Creates a named bundle wrapping the given syntax list.

public BundleSyntax(string name, IEnumerable<ISituNcSyntax> syntaxes)

Parameters

name string

syntaxes IEnumerable<ISituNcSyntax>

BundleSyntax(XElement, string, string, IProgress<object>)

Loads nested in-situ syntax elements from XML under Name.

public BundleSyntax(XElement src, string baseDirectory, string relFile, IProgress<object> progress)

Parameters

src XElement

baseDirectory string

relFile string

progress IProgress<object>

Properties

Name

Syntax kind name (typically the concrete type name).

public string Name { get; set; }

Property Value

string

SyntaxList

Child syntaxes executed in registration order within this bundle.

public List<ISituNcSyntax> SyntaxList { get; }

Property Value

List<ISituNcSyntax>

XName

XML element name for Regs registration.

public static string XName { get; }

Property Value

string

Methods

Build(LazyLinkedListNode<SyntaxPiece>, List<INcDependency>, NcDiagnosticProgress)

Build syntax arrangement into the syntaxPieceNode in-place.

public void Build(LazyLinkedListNode<SyntaxPiece> syntaxPieceNode, List<INcDependency> ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)

Parameters

syntaxPieceNode LazyLinkedListNode<SyntaxPiece>

ncDependencyList List<INcDependency>

ncDiagnosticProgress NcDiagnosticProgress

MakeXmlSource(string, string, bool)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.