Class CsScriptSyntax

Namespace

Hi.NcParsers.ParsingSyntaxs

Assembly

HiMech.dll

Extracts C# script markers from the oral content of a comment. PreMarker marks a script that runs before the NC block; PostMarker marks a script that runs after. The symbols are configurable and serialized to XML.

The previous runners' marker LegacyPreMarker is no alias: ; opens a comment on Siemens and Heidenhain, so reading ;@ as a marker would change what those programs mean. A block whose source text holds it before a statement — a call or an assignment, as in ;@LineSelection(...); or ;@MachiningMotionResolution=FeedPerCycle; — is told once per NC file (CsScript-Marker--Legacy), at its first such block; the text is left to the comment and word syntaxes as before. The files already told are kept on this instance and forgotten at the start of a stream (no block before it: a fresh session pipeline, also on a runner reused across sessions), since this syntax sits inside the Parsing BundleSyntax, out of the runner's session-reset sweep.

public class CsScriptSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource

Inheritance

object

CsScriptSyntax

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)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Examples

#BeforeBuild:

{
  "UnparsedText": "G01 Z-0.2 F1500",
  "Comment": { "Symbol": "()", "Text": "@@BeginSelection(\"p1\", FirstTouch, null);" }
}

#AfterBuild:

{
  "UnparsedText": "G01 Z-0.2 F1500",
  "Comment": { "Symbol": "()", "Text": "" },
  "CsScript": { "BeginScript": "BeginSelection(\"p1\", FirstTouch, null);" }
}

#BeforeBuild:

{
  "UnparsedText": "X10 Y10",
  "Comment": { "Symbol": "()", "Text": "note @@^EndSelection(\"p1\", LineEnd, null);" }
}

#AfterBuild:

{
  "UnparsedText": "X10 Y10",
  "Comment": { "Symbol": "()", "Text": "note " },
  "CsScript": { "EndScript": "EndSelection(\"p1\", LineEnd, null);" }
}

#BeforeBuild:

{
  "UnparsedText": "X10 Y10",
  "Comment": { "Symbol": "()", "Text": "plain comment" }
}

#AfterBuild:

{
  "UnparsedText": "X10 Y10",
  "Comment": { "Symbol": "()", "Text": "plain comment" }
}

The previous runners' marker stays comment text — no alias: #BeforeBuild:

{
  "UnparsedText": "G01 Y16.",
  "Comment": { "Symbol": "()", "Text": ";@LineSelection(\"low1\",FirstTouch,null,LastTouch,null);" }
}

#AfterBuild:

{
  "UnparsedText": "G01 Y16.",
  "Comment": { "Symbol": "()", "Text": ";@LineSelection(\"low1\",FirstTouch,null,LastTouch,null);" }
}

Constructors

CsScriptSyntax()

Creates syntax with DefaultPreMarker and DefaultPostMarker.

public CsScriptSyntax()

CsScriptSyntax(XElement)

Loads pre/post script markers from persisted XML.

public CsScriptSyntax(XElement src)

Parameters

src XElement

Root element named XName.

Fields

DefaultPostMarker

Default end-of-block script delimiter when none is configured in XML.

public const string DefaultPostMarker = "@@^"

Field Value

string

DefaultPreMarker

Default begin-of-block script delimiter when none is configured in XML.

public const string DefaultPreMarker = "@@"

Field Value

string

LegacyPreMarker

The begin-of-block script marker of the runners before SoftNc. Not read as a marker; see the class remarks.

public const string LegacyPreMarker = ";@"

Field Value

string

Properties

Name

Syntax kind name (typically the concrete type name).

public string Name { get; }

Property Value

string

PostMarker

Marker prefix for end-of-block script (runs after the NC block).

public string PostMarker { get; set; }

Property Value

string

PreMarker

Marker prefix for begin-of-block script (runs before the NC block).

public string PreMarker { get; set; }

Property Value

string

XName

XML element name for Generators 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.

Reg(XFactory)

Registers this type's deserializer with the given XFactory (or Default when factory is null). Idempotent.

public static void Reg(XFactory factory = null)

Parameters

factory XFactory