SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 23:13:02 +01:00
Code Issues Projects Releases Packages Activity
monaco-editor/api/interfaces/monaco.languages.IEncodedLineTokens.html
Henning Dieterichs a0eed4888d Publish website
2023-02-10 12:26:04 +00:00

30 lines
No EOL
9.9 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IEncodedLineTokens | Monaco Editor API</title><meta name="description" content="Documentation for Monaco Editor API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Monaco Editor API</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">Monaco Editor API</a></li><li><a href="../modules/monaco.html">monaco</a></li><li><a href="../modules/monaco.languages.html">languages</a></li><li><a href="monaco.languages.IEncodedLineTokens.html">IEncodedLineTokens</a></li></ul><h1>Interface IEncodedLineTokens</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>The result of a line tokenization.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IEncodedLineTokens</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.IEncodedLineTokens.html#endState" class="tsd-kind-icon">end<wbr/>State</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.IEncodedLineTokens.html#tokens" class="tsd-kind-icon">tokens</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="endState" class="tsd-anchor"></a><h3 class="tsd-anchor-link">end<wbr/>State<a href="#endState" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">end<wbr/>State<span class="tsd-signature-symbol">:</span> <a href="monaco.languages.IState.html" class="tsd-signature-type" data-tsd-kind="Interface">IState</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L5929">website/typedoc/monaco.d.ts:5929</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The tokenization end state.
A pointer will be held to this and the object should not be modified by the tokenizer after the pointer is returned.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tokens<a href="#tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tokens<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint32Array</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L5924">website/typedoc/monaco.d.ts:5924</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The tokens on the line in a binary, encoded format. Each token occupies two array indices. For token i:</p>
<ul>
<li>at offset 2*i =&gt; startIndex</li>
<li>at offset 2*i + 1 =&gt; metadata
Meta data is in binary format:</li>
</ul>
<hr>
<pre><code><span class="hl-0">3322</span><span class="hl-1"> </span><span class="hl-0">2222</span><span class="hl-1"> </span><span class="hl-0">2222</span><span class="hl-1"> </span><span class="hl-0">1111</span><span class="hl-1"> </span><span class="hl-0">1111</span><span class="hl-1"> </span><span class="hl-0">1100</span><span class="hl-1"> </span><span class="hl-0">0000</span><span class="hl-1"> </span><span class="hl-0">0000</span><br/><span class="hl-0">1098</span><span class="hl-1"> </span><span class="hl-0">7654</span><span class="hl-1"> </span><span class="hl-0">3210</span><span class="hl-1"> </span><span class="hl-0">9876</span><span class="hl-1"> </span><span class="hl-0">5432</span><span class="hl-1"> </span><span class="hl-0">1098</span><span class="hl-1"> </span><span class="hl-0">7654</span><span class="hl-1"> </span><span class="hl-0">3210</span>
</code></pre>
<hr>
<pre><code><span class="hl-2">bbbb</span><span class="hl-1"> </span><span class="hl-2">bbbb</span><span class="hl-1"> </span><span class="hl-2">bfff</span><span class="hl-1"> </span><span class="hl-2">ffff</span><span class="hl-1"> </span><span class="hl-2">ffFF</span><span class="hl-1"> </span><span class="hl-3">FFTT</span><span class="hl-1"> </span><span class="hl-3">LLLL</span><span class="hl-1"> </span><span class="hl-3">LLLL</span>
</code></pre>
<hr>
<ul>
<li>L = EncodedLanguageId (8 bits): Use <code>getEncodedLanguageId</code> to get the encoded ID of a language.</li>
<li>T = StandardTokenType (2 bits): Other = 0, Comment = 1, String = 2, RegEx = 3.</li>
<li>F = FontStyle (4 bits): None = 0, Italic = 1, Bold = 2, Underline = 4, Strikethrough = 8.</li>
<li>f = foreground ColorId (9 bits)</li>
<li>b = background ColorId (9 bits)</li>
<li>The color value for each colorId is defined in IStandaloneThemeData.customTokenColors:
e.g. colorId = 1 is stored in IStandaloneThemeData.customTokenColors[1]. Color id = 0 means no color,
id = 1 is for the default foreground color, id = 2 for the default background.</li>
</ul>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/monaco.html">monaco</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.editor.html">editor</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.html">languages</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.css.html">css</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.html.html">html</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.json.html">json</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.typescript.html">typescript</a></li></ul></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.worker.html">worker</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="monaco.languages.IEncodedLineTokens.html" class="tsd-kind-icon">IEncoded<wbr/>Line<wbr/>Tokens</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.IEncodedLineTokens.html#endState" class="tsd-kind-icon">end<wbr/>State</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.languages.IEncodedLineTokens.html#tokens" class="tsd-kind-icon">tokens</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
View git blame Copy permalink