This repository has been archived on 2026-10-11. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.Syntaxs.NcSyntaxUtil.html
T
2026-09-09 17:35:23 +08:00

484 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class NcSyntaxUtil | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class NcSyntaxUtil | HiAPI-C# 2025 ">
<meta name="description" content="JSON serialization settings and grab/set helpers for NC block trees.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil">
<h1 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil" class="text-break">
Class NcSyntaxUtil
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.NcParsers.html">NcParsers</a>.<a class="xref" href="Hi.NcParsers.Syntaxs.html">Syntaxs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>JSON serialization settings and grab/set helpers for NC block <a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html#Hi_NcParsers_Syntaxs_SyntaxPiece_JsonObject">JsonObject</a> trees.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class NcSyntaxUtil</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">NcSyntaxUtil</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_RepeatedWordsKey" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.RepeatedWordsKey">
RepeatedWordsKey
</h3>
<div class="markdown level1 summary"><p>Key under a Parsing category collecting the values of a word that
occurs more than once on the block, in text order after the first
(<code>T10 T2 M06</code> → <code>{ &ldquo;T&rdquo;: 10, &ldquo;RepeatedWords&rdquo;: { &ldquo;T&rdquo;: [2] } }</code>).
The scalar slot keeps the FIRST occurrence — HardNc parity, whose
word grabs are first-match (<code>HardNcUtil.GrabInt</code>). A consumer
that gives a repeat a meaning (the dual tool word:
<a class="xref" href="Hi.NcParsers.LogicSyntaxs.ToolChangeSyntax.html">ToolChangeSyntax</a>) reads and removes it
here; anything left surfaces as <code>Parsing&ndash;Unconsumed</code> instead
of silently overwriting the first word.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string RepeatedWordsKey = &quot;RepeatedWords&quot;</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_AxisTagList_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.AxisTagList*"></a>
<h3 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_AxisTagList" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.AxisTagList">
AxisTagList
</h3>
<div class="markdown level1 summary"><p>tag list for the motion axis tags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;string&gt; AxisTagList { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_AxisTagList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Must be initialized before MixedNcSyntaxList to avoid static initialization cycle.</p>
</div>
<a id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_FloatTagList_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.FloatTagList*"></a>
<h3 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_FloatTagList" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.FloatTagList">
FloatTagList
</h3>
<div class="markdown level1 summary"><p>tag list for the float number tags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;string&gt; FloatTagList { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_FloatTagList_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Must be initialized before MixedNcSyntaxList to avoid static initialization cycle.</p>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagAssignment_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.GrabTagAssignment*"></a>
<h3 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagAssignment_System_String__System_Collections_Generic_IEnumerable_System_String__System_String_System_Collections_Generic_IEnumerable_System_String__Hi_NcParsers_Syntaxs_ExpressionPrefixParser_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.GrabTagAssignment(System.String@,System.Collections.Generic.IEnumerable{System.String},System.String,System.Collections.Generic.IEnumerable{System.String},Hi.NcParsers.Syntaxs.ExpressionPrefixParser)">
GrabTagAssignment(ref string, IEnumerable&lt;string&gt;, string, IEnumerable&lt;string&gt;, ExpressionPrefixParser)
</h3>
<div class="markdown level1 summary"><p>Get Tag Assignments with = sign.
ex.
Siemens: R1=100.5, Z=V1+V2, Z=V1 - V3 * V2 F200
Heidenhain: Q1 = Q2 + 100
Fanuc: #1=#2+#3</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;TagValue&gt; GrabTagAssignment(ref string unparsedText, IEnumerable&lt;string&gt; targetTags, string varPrefix, IEnumerable&lt;string&gt; terminateWords = null, ExpressionPrefixParser rhsPrefixParser = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>unparsedText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The NC text to parse and modify.</p>
</dd>
<dt><code>targetTags</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>candidate target tags to extract values for</p>
</dd>
<dt><code>varPrefix</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>variable index code prefix.</p>
</dd>
<dt><code>terminateWords</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>words that terminate expression (e.g., F, G, M, S).
These are different from varPrefix - they signal end of expression, not variables.</p>
</dd>
<dt><code>rhsPrefixParser</code> <a class="xref" href="Hi.NcParsers.Syntaxs.ExpressionPrefixParser.html">ExpressionPrefixParser</a></dt>
<dd><p>Optional longest-valid-prefix expression
parser (see <a class="xref" href="Hi.NcParsers.Syntaxs.ExpressionPrefixParser.html">ExpressionPrefixParser</a>). When provided and a
prefix parses, it supersedes both the lexical boundary and the
<code class="paramref">terminateWords</code> cut for that match — the grammar
itself ends the RHS (<code>R26=R64-14/2 R23=2</code>,
<code>Z=R63 + 150 X100</code>); the lexical machinery remains the per-match
fallback when no prefix parses.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Syntaxs.TagValue.html">TagValue</a>&gt;</dt>
<dd><p>List of extracted tag assignments.</p>
</dd>
</dl>
<a id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagEqualsValue_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.GrabTagEqualsValue*"></a>
<h3 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagEqualsValue_System_String__System_Collections_Generic_IEnumerable_System_String__Hi_NcParsers_Syntaxs_ExpressionPrefixParser_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.GrabTagEqualsValue(System.String@,System.Collections.Generic.IEnumerable{System.String},Hi.NcParsers.Syntaxs.ExpressionPrefixParser)">
GrabTagEqualsValue(ref string, IEnumerable&lt;string&gt;, ExpressionPrefixParser)
</h3>
<div class="markdown level1 summary"><p>Get tag values written in the Siemens address=value form
(an explicit <code>=</code> between a single-letter tag and its value).
ex.
Siemens: X=100, Z=R63+150, C=R61, F=R103, Z=_Z_HOME</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;TagValue&gt; GrabTagEqualsValue(ref string unparsedText, IEnumerable&lt;string&gt; targetTags, ExpressionPrefixParser rhsPrefixParser = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>unparsedText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The NC text to parse and modify.</p>
</dd>
<dt><code>targetTags</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>candidate target tags to extract values for</p>
</dd>
<dt><code>rhsPrefixParser</code> <a class="xref" href="Hi.NcParsers.Syntaxs.ExpressionPrefixParser.html">ExpressionPrefixParser</a></dt>
<dd><p>Optional longest-valid-prefix expression
parser delimiting each RHS (see <a class="xref" href="Hi.NcParsers.Syntaxs.ExpressionPrefixParser.html">ExpressionPrefixParser</a>).</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Syntaxs.TagValue.html">TagValue</a>&gt;</dt>
<dd><p>List of extracted tag values.</p>
</dd>
</dl>
<h4 class="section" id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagEqualsValue_System_String__System_Collections_Generic_IEnumerable_System_String__Hi_NcParsers_Syntaxs_ExpressionPrefixParser__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Without <code class="paramref">rhsPrefixParser</code>, the value is captured as
the following non-whitespace run, so arithmetic expressions without
embedded spaces (<code>R63+150</code>) and named-variable references
(<code>_Z_HOME</code>) survive as strings for the evaluation stage; numeric
literals are typed later by the caller's converter
(e.g. <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.FloatTagValueSyntax.html#Hi_NcParsers_ParsingSyntaxs_FloatTagValueSyntax_ToFloat_System_String_">ToFloat(string)</a>).
With <code class="paramref">rhsPrefixParser</code> (parser-delimited capture),
the value is the longest valid expression prefix after the <code>=</code> —
spaced arithmetic (<code>R63 + 150</code>), balanced call parentheses
(<code>DC(47.296)</code>) and glued following words (<code>X=100Y50</code>) all
delimit correctly; the lexical <code>\S+</code> run stays as the per-match
fallback when no prefix parses.</p>
</div>
<a id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagValue_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.GrabTagValue*"></a>
<h3 id="Hi_NcParsers_Syntaxs_NcSyntaxUtil_GrabTagValue_System_String__System_Collections_Generic_IEnumerable_System_String__System_String_System_Boolean_" data-uid="Hi.NcParsers.Syntaxs.NcSyntaxUtil.GrabTagValue(System.String@,System.Collections.Generic.IEnumerable{System.String},System.String,System.Boolean)">
GrabTagValue(ref string, IEnumerable&lt;string&gt;, string, bool)
</h3>
<div class="markdown level1 summary"><p>Get tag values.
Concatenated tag-value syntax (no = sign), glued by default:
the value must follow the tag immediately. Pass
<code class="paramref">allowSpacedValue</code> to also accept whitespace
between tag and value (the Heidenhain detached feed word).
ex.
Heidenhain: L X+10 Y33.4 FQ1
Heidenhain (allowSpacedValue): L Z-22.5 F 20000
ISO: X100.3Y3.3
Fanuc Macro: X[#1+#2] Y[#1*2+100]</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;TagValue&gt; GrabTagValue(ref string unparsedText, IEnumerable&lt;string&gt; targetTags, string varPrefix, bool allowSpacedValue = false)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>unparsedText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The NC text to parse and modify.</p>
</dd>
<dt><code>targetTags</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd><p>candidate target tags to extract values for</p>
</dd>
<dt><code>varPrefix</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>variable index code prefix. ex. Fanuc # for #123; Heidenhain Q for Q123.</p>
</dd>
<dt><code>allowSpacedValue</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>when true, whitespace may separate a
tag from its value (<code>F 20000</code>); the value grammar must still
match right after the run, so <code>F MAX</code> or <code>F X+10</code> stay
unclaimed. Default false keeps the glued-only grammar every other
brand pins.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Syntaxs.TagValue.html">TagValue</a>&gt;</dt>
<dd><p>List of extracted tag values.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>