<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>vtparse/README.md - fork/wezterm @ termwiz-0.23.0</title>
<meta name="description" content="vtparse/README.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:title" content="vtparse/README.md - fork/wezterm @ termwiz-0.23.0">
<meta property="og:description" content="vtparse/README.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.0" data-tip="958804c8ac16b750954b3bcaaf847e7498cd2205">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="ed5dcd71dad4b9966cd1f8a5c0d7f69ee074bfa9">vtparse: document things</span><span class="snapshot-sha sha" data-commit="ed5dcd71dad4b9966cd1f8a5c0d7f69ee074bfa9">ed5dcd71d</span><time datetime="2019-06-29T18:58:07-07:00" title="2019-06-29 18:58:07 -0700">2019-06-29</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.0</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/vtparse/">vtparse</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>708 B</span><span>20 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/fa01355ffe84d32ef4e718a6d7024343d58388e0/vtparse/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>vtparse</h1>
<p>This is an implementation of a parser for escape and control sequences.
It is based on the <a href="https://vt100.net/emu/dec_ansi_parser">DEC ANSI Parser</a>.</p>
<p>It has been modified slightly to support UTF-8 sequences.</p>
<p><code>vtparse</code> is the lowest level parser; it categorizes the basic
types of sequences but does not ascribe any semantic meaning
to them.</p>
<p>You may wish to look at <code>termwiz::escape::parser::Parser</code> in the
<a href="https://docs.rs/termwiz">termwiz</a> crate if you're looking for semantic
parsing.</p>
<h2>Comparison with the <code>vte</code> crate</h2>
<p><code>vtparse</code> has support for dynamically sized OSC buffers, which makes
it suitable for processing large escape sequences, such as those
used by the <code>iTerm2</code> image protocol.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>vtparse</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">This is an implementation of a parser for escape and control sequences.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">It is based on the [DEC ANSI Parser](https://vt100.net/emu/dec_ansi_parser).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">It has been modified slightly to support UTF-8 sequences.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">`vtparse` is the lowest level parser; it categorizes the basic</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">types of sequences but does not ascribe any semantic meaning</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">to them.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">You may wish to look at `termwiz::escape::parser::Parser` in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">[termwiz](https://docs.rs/termwiz) crate if you&#39;re looking for semantic</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">parsing.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>##</a-p> <a-tt>Comparison with the `vte` crate</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">`vtparse` has support for dynamically sized OSC buffers, which makes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">it suitable for processing large escape sequences, such as those</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">used by the `iTerm2` image protocol.</span></span></pre></div></div>
</main>
</body>
</html>
