HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.ParsingSyntaxs.html

239 lines
13 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace Hi.NcParsers.ParsingSyntaxs | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace Hi.NcParsers.ParsingSyntaxs | HiAPI-C# 2025 ">
<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.ParsingSyntaxs">
<h1 id="Hi_NcParsers_ParsingSyntaxs" data-uid="Hi.NcParsers.ParsingSyntaxs" class="text-break">Namespace Hi.NcParsers.ParsingSyntaxs</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.BlockSkipSyntax.html">BlockSkipSyntax</a></dt>
<dd><p>Parses the ISO 6983 / Fanuc Block Delete (a.k.a. Block Skip) prefix
<code>/</code> or <code>/N</code> (N = 1..9) at the head of an NC block.</p>
<p>
Behaviour:
<ul><li>No leading <code>/</code> → no-op, no <a class="xref" href="Hi.NcParsers.Keywords.BlockSkip.html">BlockSkip</a> section
is written.</li><li><code>/</code> with <a class="xref" href="Hi.NcParsers.Dependencys.IBlockSkipConfig.html">IBlockSkipConfig</a> layer OFF (or the
dependency absent) → prefix is consumed, <a class="xref" href="Hi.NcParsers.Keywords.BlockSkip.html">BlockSkip</a>
<a class="xref" href="Hi.NcParsers.Keywords.BlockSkip.html#Hi_NcParsers_Keywords_BlockSkip_Symbol">Symbol</a>/<a class="xref" href="Hi.NcParsers.Keywords.BlockSkip.html#Hi_NcParsers_Keywords_BlockSkip_Layer">Layer</a> recorded
for audit, <a class="xref" href="Hi.NcParsers.Keywords.BlockSkip.html#Hi_NcParsers_Keywords_BlockSkip_Body">Body</a> stays null; the rest of the
block stays in <code>UnparsedText</code> and parses normally.</li><li><code>/</code> with layer ON → the remaining block text is moved
from <code>UnparsedText</code> into <a class="xref" href="Hi.NcParsers.Keywords.BlockSkip.html#Hi_NcParsers_Keywords_BlockSkip_Body">Body</a> and
<code>UnparsedText</code> is cleared. Downstream parsing syntaxes see no
NC text so they emit nothing; semantics therefore produce no act.
Must run <i>after</i> comment / CsScript syntaxes so that comments
(and CsScript embedded in comments) continue to take effect
regardless of the skip switch.</li></ul>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.CsScriptSyntax.html">CsScriptSyntax</a></dt>
<dd><p>Extracts C# script markers from the oral content of a comment.
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.CsScriptSyntax.html#Hi_NcParsers_ParsingSyntaxs_CsScriptSyntax_PreMarker">PreMarker</a> marks a script that runs before the NC block;
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.CsScriptSyntax.html#Hi_NcParsers_ParsingSyntaxs_CsScriptSyntax_PostMarker">PostMarker</a> marks a script that runs after.
The symbols are configurable and serialized to XML.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.FlagSyntax.html">FlagSyntax</a></dt>
<dd><p>Syntax of fully Match flag.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.FloatTagValueSyntax.html">FloatTagValueSyntax</a></dt>
<dd><p><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html">TagValueSyntax</a> that parses numeric literal values to <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>.
Variable text (e.g. Q2, #1, [#1+#2]) remains as <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.HeadIndexSyntax.html">HeadIndexSyntax</a></dt>
<dd><p>Parses a leading block index (e.g. Heidenhain line numbers) after an optional <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.HeadIndexSyntax.html#Hi_NcParsers_ParsingSyntaxs_HeadIndexSyntax_HeadSymbol">HeadSymbol</a> prefix.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.IntegerTagValueSyntax.html">IntegerTagValueSyntax</a></dt>
<dd><p><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html">TagValueSyntax</a> that parses numeric literal values to <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>.
Variable text (e.g. Q2, #1, [#1+#2]) remains as <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NamedVarAssignmentSyntax.html">NamedVarAssignmentSyntax</a></dt>
<dd><p>Assignment syntax for named (identifier-style) variables with = sign.
Handles variables that are multi-character identifiers
rather than {prefix}{digits}.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a></dt>
<dd><p>Syntax for numbered flags (prefix + number) with optional decimal support.
<a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> often should place after something like <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a>.
Since <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> is easy to eat those kind of flags.</p>
<p>
Single-digit integer codes are zero-padded to canonical 2-digit form
(e.g. <code>M6</code><code>M06</code>, <code>G0</code><code>G00</code>, <code>M3</code><code>M03</code>)
so that downstream logic syntaxes comparing against
<a class="xref" href="Hi.NcParsers.Keywords.Generic.IsoKeywords.html">IsoKeywords</a> constants (which are always
2-digit form like <a class="xref" href="Hi.NcParsers.Keywords.Generic.IsoKeywords.html#Hi_NcParsers_Keywords_Generic_IsoKeywords_M06">M06</a>) can
match Fanuc-style omitted-leading-zero codes. Two-digit and decimal
codes are kept as-is.
</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a></dt>
<dd><p>Syntax for flags with attached parameters (e.g., G54.1P1, G10L2P1).
This is essentially a combination of main flag matching (like <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a>)
plus scoped <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html">TagValueSyntax</a> for the parameters after the main flag.
Note that the <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a> often should be applied before <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> since <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.NumberedFlagSyntax.html">NumberedFlagSyntax</a> may eat the text that <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ParameterizedFlagSyntax.html">ParameterizedFlagSyntax</a> should handle.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ProgramBoundarySyntax.html">ProgramBoundarySyntax</a></dt>
<dd><p>Detects program boundary markers: leading <code>%</code> tape header or <code>O</code> program number after a prior boundary,
and records them under <a class="xref" href="Hi.NcParsers.Keywords.ProgramBoundary.html">ProgramBoundary</a> on the block JSON.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.ShrinkIfNoDecimalPointSyntax.html">ShrinkIfNoDecimalPointSyntax</a></dt>
<dd><p>Applies the &ldquo;conventional type&rdquo; decimal-point interpretation to coordinate
values in <a class="xref" href="Hi.NcParsers.Keywords.IUnparsedTextDef.html#Hi_NcParsers_Keywords_IUnparsedTextDef_UnparsedText">UnparsedText</a>.
When a tag value has no decimal point (e.g. <code>Y20</code>), it is shrunk by
the implied decimal places: <code>Y20</code><code>Y0.020</code> (3 decimal places).
Values that already contain a decimal point are left unchanged.</p>
<p>
Place inside <a class="xref" href="Hi.NcParsers.Syntaxs.BundleSyntax.html">BundleSyntax</a> before <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.FloatTagValueSyntax.html">FloatTagValueSyntax</a>
so the modified text is parsed correctly by subsequent syntaxes.
</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagAssignmentSyntax.html">TagAssignmentSyntax</a></dt>
<dd><p>Assignment syntax with = sign.
Unlike <a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html">TagValueSyntax</a> which handles concatenated tag-value pairs (no = sign),
this class handles explicit assignment statements.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcParsers.ParsingSyntaxs.TagValueSyntax.html">TagValueSyntax</a></dt>
<dd><p>Concatenated tag-value syntax (no = sign).
ex.
Heidenhain: L X Q2 Y33.4 FQ1
ISO: X100.3Y3.3</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>