chevrotain

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>VirtualToken | Chevrotain</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script src="../assets/js/modernizr.js"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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">Chevrotain</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-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="../modules/chevrotain.html">chevrotain</a> </li> <li> <a href="chevrotain.virtualtoken.html">VirtualToken</a> </li> </ul> <h1>Class VirtualToken</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>a special kind of Token which does not really exist in the input (hence the 'Virtual' prefix). These type of Tokens can be used as special markers: for example, EOF (end-of-file).</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="chevrotain.token.html" class="tsd-signature-type">Token</a> <ul class="tsd-hierarchy"> <li> <span class="target">VirtualToken</span> <ul class="tsd-hierarchy"> <li> <a href="chevrotain.eof.html" class="tsd-signature-type">EOF</a> </li> </ul> </li> </ul> </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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="chevrotain.virtualtoken.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-inherited"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#endcolumn" class="tsd-kind-icon">end<wbr>Column</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#endline" class="tsd-kind-icon">end<wbr>Line</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#image" class="tsd-kind-icon">image</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#isinsertedinrecovery" class="tsd-kind-icon">is<wbr>Inserted<wbr>InRecovery</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#offset" class="tsd-kind-icon">offset</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#startcolumn" class="tsd-kind-icon">start<wbr>Column</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="chevrotain.virtualtoken.html#startline" class="tsd-kind-icon">start<wbr>Line</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>Virtual<wbr>Token<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="chevrotain.virtualtoken.html" class="tsd-signature-type">VirtualToken</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overwrites <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#constructor">constructor</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L95">scan/tokens_public.ts:95</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="chevrotain.virtualtoken.html" class="tsd-signature-type">VirtualToken</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="endcolumn" class="tsd-anchor"></a> <h3>end<wbr>Column</h3> <div class="tsd-signature tsd-kind-icon">end<wbr>Column<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#endcolumn">endColumn</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L85">scan/tokens_public.ts:85</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>column of the last character of the Token</p> </div> <p>Things to note: "do" {startColumn : 1, endColumn: 2} --> the range is inclusive to exclusive 1...2 (2 chars long). "\n" {startLine : 1, endLine: 1} --> a lineTerminator as the last character does not effect the Token's line numbering. "'hello\tworld\uBBBB'" {image: "'hello\tworld\uBBBB'"} --> a Token's image is the "literal" text (unicode escaping is untouched).</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="endline" class="tsd-anchor"></a> <h3>end<wbr>Line</h3> <div class="tsd-signature tsd-kind-icon">end<wbr>Line<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#endline">endLine</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L84">scan/tokens_public.ts:84</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>line of the last character of the Token</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="image" class="tsd-anchor"></a> <h3>image</h3> <div class="tsd-signature tsd-kind-icon">image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#image">image</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L80">scan/tokens_public.ts:80</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>the textual representation of the Token as it appeared in the text</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="isinsertedinrecovery" class="tsd-anchor"></a> <h3>is<wbr>Inserted<wbr>InRecovery</h3> <div class="tsd-signature tsd-kind-icon">is<wbr>Inserted<wbr>InRecovery<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#isinsertedinrecovery">isInsertedInRecovery</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L64">scan/tokens_public.ts:64</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="offset" class="tsd-anchor"></a> <h3>offset</h3> <div class="tsd-signature tsd-kind-icon">offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#offset">offset</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L81">scan/tokens_public.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>offset of the first character of the Token</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="startcolumn" class="tsd-anchor"></a> <h3>start<wbr>Column</h3> <div class="tsd-signature tsd-kind-icon">start<wbr>Column<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#startcolumn">startColumn</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L83">scan/tokens_public.ts:83</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>column of the first character of the Token</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="startline" class="tsd-anchor"></a> <h3>start<wbr>Line</h3> <div class="tsd-signature tsd-kind-icon">start<wbr>Line<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="chevrotain.token.html">Token</a>.<a href="chevrotain.token.html#startline">startLine</a></p> <ul> <li>Defined in <a href="https://github.com/SAP/chevrotain/blob/HEAD/src/scan/tokens_public.ts#L82">scan/tokens_public.ts:82</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>line of the first character of the Token</p> </div> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-module"> <a href="../modules/chevrotain.html">chevrotain</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module"> <a href="../modules/chevrotain.exceptions.html">chevrotain.exceptions</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module"> <a href="../modules/chevrotain.gast.html">chevrotain.gast</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="chevrotain.eof.html" class="tsd-kind-icon">EOF</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="chevrotain.lexer.html" class="tsd-kind-icon">Lexer</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="chevrotain.parser.html" class="tsd-kind-icon">Parser</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="chevrotain.token.html" class="tsd-kind-icon">Token</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module"> <a href="chevrotain.virtualtoken.html" class="tsd-kind-icon">Virtual<wbr>Token</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="chevrotain.virtualtoken.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#endcolumn" class="tsd-kind-icon">end<wbr>Column</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#endline" class="tsd-kind-icon">end<wbr>Line</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#image" class="tsd-kind-icon">image</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#isinsertedinrecovery" class="tsd-kind-icon">is<wbr>Inserted<wbr>InRecovery</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#offset" class="tsd-kind-icon">offset</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#startcolumn" class="tsd-kind-icon">start<wbr>Column</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="chevrotain.virtualtoken.html#startline" class="tsd-kind-icon">start<wbr>Line</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/chevrotain.ifollowkey.html" class="tsd-kind-icon">IFollow<wbr>Key</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/chevrotain.ilexingerror.html" class="tsd-kind-icon">ILexing<wbr>Error</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/chevrotain.ilexingresult.html" class="tsd-kind-icon">ILexing<wbr>Result</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"> <a href="../interfaces/chevrotain.ioralt.html" class="tsd-kind-icon">IOr<wbr>Alt</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"> <a href="../interfaces/chevrotain.ioraltimplicit.html" class="tsd-kind-icon">IOr<wbr>Alt<wbr>Implicit</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/chevrotain.iparserstate.html" class="tsd-kind-icon">IParser<wbr>State</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/chevrotain.html#grammaraction" class="tsd-kind-icon">Grammar<wbr>Action</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/chevrotain.html#lookaheadfunc" class="tsd-kind-icon">Look<wbr>Ahead<wbr>Func</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/chevrotain.html#tokenconstructor" class="tsd-kind-icon">Token<wbr>Constructor</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/chevrotain.html#eof_follow_key" class="tsd-kind-icon">EOF_<wbr>FOLLOW_<wbr>KEY</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/chevrotain.html#inrulerecoveryexception" class="tsd-kind-icon">In<wbr>Rule<wbr>Recovery<wbr>Exception</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/chevrotain.html#extendtoken" class="tsd-kind-icon">extend<wbr>Token</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/chevrotain.html#tokenname" class="tsd-kind-icon">token<wbr>Name</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>