Class FlagSyntax

Namespace

Hi.NcParsers.ParsingSyntaxs

Assembly

HiMech.dll

Syntax of fully Match flag.

public class FlagSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource

Inheritance

object

FlagSyntax

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)

Remarks

The term Flag generally not accomanys with variable value. The term Tag generally accomanys with variable value.

Constructors

FlagSyntax(IEnumerable<string>, IEnumerable<string>)

Creates syntax from in-memory path and flag lists (tests or programmatic setup).

public FlagSyntax(IEnumerable<string> categoryPath, IEnumerable<string> flags)

Parameters

categoryPath IEnumerable<string>

flags IEnumerable<string>

FlagSyntax(XElement)

Loads category path and flag list items from XML.

public FlagSyntax(XElement src)

Parameters

src XElement

Root element named XName.

Properties

CategoryPath

JSON path segments (each Item) under which matched flags are stored.

public List<string> CategoryPath { get; set; }

Property Value

List<string>

FlagList

NC tokens to detect and record as flags (exact match).

public List<string> FlagList { get; set; }

Property Value

List<string>

Name

Syntax kind name (typically the concrete type name).

public string Name { get; }

Property Value

string

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.