HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html

603 lines
25 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SnapshotSyntax | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SnapshotSyntax | HiAPI-C# 2025 ">
<meta name="description" content="Debug-time JsonObject capture: deep-clones every key on the current (except the envelope itself) into json[][], leaving the rest of the block untouched. Insertable at any position in — placement determines what stage the dump captures (e.g. drop after the Parsing bundle for &quot;after-parsing&quot;, drop after the Logic bundle for &quot;after-logic&quot;). Two instances with different values can coexist on the same pipeline and their dumps end up under sibling keys of the same envelope, so a single cache file shows the data at every captured stage in one place. Excluding the envelope from the clone keeps each captured section flat: it reflects &quot;everything else on the block at that stage&quot;, and re-running through additional instances never nests past one level. Set = false to keep the configuration in place but skip the capture (no JSON mutation, no allocation) — convenient for toggling a debug pipeline without removing the entries.">
<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.InspectionSyntaxs.SnapshotSyntax">
<h1 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax" class="text-break">
Class SnapshotSyntax
</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.InspectionSyntaxs.html">InspectionSyntaxs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Debug-time JsonObject capture: deep-clones every key on the current
<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html#Hi_NcParsers_Syntaxs_SyntaxPiece_JsonObject">JsonObject</a> (except the
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope itself) into
<code>json[<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a>][<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a>]</code>,
leaving the rest of the block untouched.</p>
<p>
Insertable at any position in <a class="xref" href="Hi.NcParsers.SoftNcRunner.html#Hi_NcParsers_SoftNcRunner_NcSyntaxList">NcSyntaxList</a> —
placement determines what stage the dump captures (e.g. drop after
the Parsing bundle for "after-parsing", drop after the Logic bundle
for "after-logic"). Two instances with different
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a> values can coexist on the same pipeline and
their dumps end up under sibling keys of the same
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope, so a single cache file shows the
data at every captured stage in one place.
</p>
<p>
Excluding the <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope from the clone keeps
each captured section flat: it reflects "everything else on the block
at that stage", and re-running through additional
<a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> instances never nests past one level.
</p>
<p>
Set <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_IsEnabled">IsEnabled</a> = <code>false</code> to keep the configuration
in place but skip the capture (no JSON mutation, no allocation) —
convenient for toggling a debug pipeline without removing the entries.
</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SnapshotSyntax : ISituNcSyntax, INcSyntax, IMakeXmlSource</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">SnapshotSyntax</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.NcParsers.Syntaxs.ISituNcSyntax.html">ISituNcSyntax</a></div>
<div><a class="xref" href="Hi.NcParsers.Syntaxs.INcSyntax.html">INcSyntax</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></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>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax__ctor_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax__ctor" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.#ctor">
SnapshotSyntax()
</h3>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> with no <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a> set yet.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SnapshotSyntax()</code></pre>
</div>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax__ctor_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax__ctor_System_String_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.#ctor(System.String)">
SnapshotSyntax(string)
</h3>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> with the given <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SnapshotSyntax(string sectionName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>sectionName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Sub-key under <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> for this instance's capture.</p>
</dd>
</dl>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax__ctor_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.#ctor*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax__ctor_System_Xml_Linq_XElement_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.#ctor(System.Xml.Linq.XElement)">
SnapshotSyntax(XElement)
</h3>
<div class="markdown level1 summary"><p>Reconstructs a <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> from a project XML element
previously produced by <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_MakeXmlSource_System_String_System_String_System_Boolean_">MakeXmlSource(string, string, bool)</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SnapshotSyntax(XElement src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>XML element carrying <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a> and <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_IsEnabled">IsEnabled</a>; null is treated as defaults.</p>
</dd>
</dl>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.SnapshotKey">
SnapshotKey
</h3>
<div class="markdown level1 summary"><p>Top-level JSON envelope key under which captured sections are
stored. Each <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html">SnapshotSyntax</a> instance writes a
sibling key (named by <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a>) inside this
envelope.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string SnapshotKey = &quot;Snapshot&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_InspectionSyntaxs_SnapshotSyntax_IsEnabled_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.IsEnabled*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_IsEnabled" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.IsEnabled">
IsEnabled
</h3>
<div class="markdown level1 summary"><p>When <code>false</code>, <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_">Build(LazyLinkedListNode&lt;SyntaxPiece&gt;, List&lt;INcDependency&gt;, NcDiagnosticProgress)</a> is a no-op — keeps the
entry in the syntax list for easy toggling without re-editing
the project.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsEnabled { 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.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_Name_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.Name*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_Name" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.Name">
Name
</h3>
<div class="markdown level1 summary"><p>Syntax kind name (typically the concrete type name).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.SectionName*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.SectionName">
SectionName
</h3>
<div class="markdown level1 summary"><p>Sub-key inside the <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SnapshotKey">SnapshotKey</a> envelope under which
this instance writes its capture. Two instances configured with
the same <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_SectionName">SectionName</a> are last-writer-wins on a
given block. Required: <a class="xref" href="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.html#Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_">Build(LazyLinkedListNode&lt;SyntaxPiece&gt;, List&lt;INcDependency&gt;, NcDiagnosticProgress)</a> throws
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a> when this is null or
empty (a misconfiguration the user should see, not a silent
skip).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string SectionName { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_XName_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.XName*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_XName" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.XName">
XName
</h3>
<div class="markdown level1 summary"><p>XML element name for <a class="xref" href="Hi.Common.XmlUtils.XFactory.html#Hi_Common_XmlUtils_XFactory_Generators">Generators</a> registration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { get; }</code></pre>
</div>
<h4 class="section">Property 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="methods">Methods
</h2>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_Build_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.Build*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_Build_Hi_Common_Collections_LazyLinkedListNode_Hi_NcParsers_Syntaxs_SyntaxPiece__System_Collections_Generic_List_Hi_NcParsers_Dependencys_INcDependency__Hi_NcParsers_NcDiagnosticProgress_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.Build(Hi.Common.Collections.LazyLinkedListNode{Hi.NcParsers.Syntaxs.SyntaxPiece},System.Collections.Generic.List{Hi.NcParsers.Dependencys.INcDependency},Hi.NcParsers.NcDiagnosticProgress)">
Build(LazyLinkedListNode&lt;SyntaxPiece&gt;, List&lt;INcDependency&gt;, NcDiagnosticProgress)
</h3>
<div class="markdown level1 summary"><p>Build syntax arrangement into the
<code class="paramref">syntaxPieceNode</code> in-place.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Build(LazyLinkedListNode&lt;SyntaxPiece&gt; syntaxPieceNode, List&lt;INcDependency&gt; ncDependencyList, NcDiagnosticProgress ncDiagnosticProgress)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>syntaxPieceNode</code> <a class="xref" href="Hi.Common.Collections.LazyLinkedListNode-1.html">LazyLinkedListNode</a>&lt;<a class="xref" href="Hi.NcParsers.Syntaxs.SyntaxPiece.html">SyntaxPiece</a>&gt;</dt>
<dd></dd>
<dt><code>ncDependencyList</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.NcParsers.Dependencys.INcDependency.html">INcDependency</a>&gt;</dt>
<dd></dd>
<dt><code>ncDiagnosticProgress</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a></dt>
<dd></dd>
</dl>
<a id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_MakeXmlSource_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.MakeXmlSource*"></a>
<h3 id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.NcParsers.InspectionSyntaxs.SnapshotSyntax.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
</dd>
</dl>
<h4 class="section" id="Hi_NcParsers_InspectionSyntaxs_SnapshotSyntax_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink