lexbase.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/lexbase</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  14. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/lexbase</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <li><a class="reference" href="#BaseLexer" title="BaseLexer = object of RootObj
  57. bufpos*: int ## the current position within the buffer
  58. buf*: string ## the buffer itself
  59. ## the input stream
  60. lineNumber*: int ## the current line number
  61. offsetBase*: int">BaseLexer</a></li>
  62. </ul>
  63. </details>
  64. </li>
  65. <li>
  66. <details open>
  67. <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
  68. <ul class="simple simple-toc-section">
  69. <li><a class="reference" href="#EndOfFile" title="EndOfFile = '\x00'">EndOfFile</a></li>
  70. <li><a class="reference" href="#NewLines" title="NewLines = {'\r', '\n'}">NewLines</a></li>
  71. </ul>
  72. </details>
  73. </li>
  74. <li>
  75. <details open>
  76. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  77. <ul class="simple simple-toc-section">
  78. <ul class="simple nested-toc-section">close
  79. <li><a class="reference" href="#close%2CBaseLexer" title="close(L: var BaseLexer)">close(L: var BaseLexer)</a></li>
  80. </ul>
  81. <ul class="simple nested-toc-section">getColNumber
  82. <li><a class="reference" href="#getColNumber%2CBaseLexer%2Cint" title="getColNumber(L: BaseLexer; pos: int): int">getColNumber(L: BaseLexer; pos: int): int</a></li>
  83. </ul>
  84. <ul class="simple nested-toc-section">getCurrentLine
  85. <li><a class="reference" href="#getCurrentLine%2CBaseLexer%2Cbool" title="getCurrentLine(L: BaseLexer; marker: bool = true): string">getCurrentLine(L: BaseLexer; marker: bool = true): string</a></li>
  86. </ul>
  87. <ul class="simple nested-toc-section">handleCR
  88. <li><a class="reference" href="#handleCR%2CBaseLexer%2Cint" title="handleCR(L: var BaseLexer; pos: int): int">handleCR(L: var BaseLexer; pos: int): int</a></li>
  89. </ul>
  90. <ul class="simple nested-toc-section">handleLF
  91. <li><a class="reference" href="#handleLF%2CBaseLexer%2Cint" title="handleLF(L: var BaseLexer; pos: int): int">handleLF(L: var BaseLexer; pos: int): int</a></li>
  92. </ul>
  93. <ul class="simple nested-toc-section">handleRefillChar
  94. <li><a class="reference" href="#handleRefillChar%2CBaseLexer%2Cint" title="handleRefillChar(L: var BaseLexer; pos: int): int">handleRefillChar(L: var BaseLexer; pos: int): int</a></li>
  95. </ul>
  96. <ul class="simple nested-toc-section">open
  97. <li><a class="reference" href="#open%2CBaseLexer%2CStream%2Cint%2Cset%5Bchar%5D" title="open(L: var BaseLexer; input: Stream; bufLen: int = 8192;
  98. refillChars: set[char] = NewLines)">open(L: var BaseLexer; input: Stream; bufLen: int = 8192;
  99. refillChars: set[char] = NewLines)</a></li>
  100. </ul>
  101. </ul>
  102. </details>
  103. </li>
  104. </ul>
  105. </div>
  106. <div class="nine columns" id="content">
  107. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  108. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  109. <div id="tocRoot"></div>
  110. <p class="module-desc">This module implements a base object of a lexer with efficient buffer handling. Only at line endings checks are necessary if the buffer needs refilling.</p>
  111. <div class="section" id="6">
  112. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  113. <dl class="item">
  114. <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="assertions.html">assertions</a>
  115. </dl>
  116. </div>
  117. <div class="section" id="7">
  118. <h1><a class="toc-backref" href="#7">Types</a></h1>
  119. <dl class="item">
  120. <div id="BaseLexer">
  121. <dt><pre><a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a>
  122. <span class="Identifier">bufpos</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## the current position within the buffer</span>
  123. <span class="Identifier">buf</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## the buffer itself</span>
  124. <span class="Comment">## the input stream</span>
  125. <span class="Identifier">lineNumber</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## the current line number</span>
  126. <span class="Identifier">offsetBase</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
  127. <dd>
  128. the base lexer. Inherit your lexer from this object.
  129. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L31" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  130. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L31" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  131. </dd>
  132. </div>
  133. </dl>
  134. </div>
  135. <div class="section" id="10">
  136. <h1><a class="toc-backref" href="#10">Consts</a></h1>
  137. <dl class="item">
  138. <div id="EndOfFile">
  139. <dt><pre><a href="lexbase.html#EndOfFile"><span class="Identifier">EndOfFile</span></a> <span class="Other">=</span> <span class="CharLit">'\x00'</span></pre></dt>
  140. <dd>
  141. end of file marker
  142. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L21" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  143. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L21" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  144. </dd>
  145. </div>
  146. <div id="NewLines">
  147. <dt><pre><a href="lexbase.html#NewLines"><span class="Identifier">NewLines</span></a> <span class="Other">=</span> <span class="Other">{</span><span class="CharLit">'\r'</span><span class="Other">,</span> <span class="CharLit">'\n'</span><span class="Other">}</span></pre></dt>
  148. <dd>
  149. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L22" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  150. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L22" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  151. </dd>
  152. </div>
  153. </dl>
  154. </div>
  155. <div class="section" id="12">
  156. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  157. <dl class="item">
  158. <div id="close-procs-all">
  159. <div id="close,BaseLexer">
  160. <dt><pre><span class="Keyword">proc</span> <a href="#close%2CBaseLexer"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  161. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  162. <dd>
  163. closes the base lexer. This closes <tt class="docutils literal"><span class="pre"><span class="Identifier">L</span></span></tt>'s associated stream too.
  164. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L42" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  165. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L42" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  166. </dd>
  167. </div>
  168. </div>
  169. <div id="getColNumber-procs-all">
  170. <div id="getColNumber,BaseLexer,int">
  171. <dt><pre><span class="Keyword">proc</span> <a href="#getColNumber%2CBaseLexer%2Cint"><span class="Identifier">getColNumber</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  172. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  173. <dd>
  174. retrieves the current column.
  175. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  176. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  177. </dd>
  178. </div>
  179. </div>
  180. <div id="getCurrentLine-procs-all">
  181. <div id="getCurrentLine,BaseLexer,bool">
  182. <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentLine%2CBaseLexer%2Cbool"><span class="Identifier">getCurrentLine</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">;</span> <span class="Identifier">marker</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  183. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  184. <dd>
  185. retrieves the current line.
  186. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L157" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  187. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L157" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  188. </dd>
  189. </div>
  190. </div>
  191. <div id="handleCR-procs-all">
  192. <div id="handleCR,BaseLexer,int">
  193. <dt><pre><span class="Keyword">proc</span> <a href="#handleCR%2CBaseLexer%2Cint"><span class="Identifier">handleCR</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  194. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  195. <dd>
  196. Call this if you scanned over <tt class="docutils literal"><span class="pre"><span class="CharLit">'\c'</span></span></tt> in the buffer; it returns the position to continue the scanning from. <tt class="docutils literal"><span class="pre"><span class="Identifier">pos</span></span></tt> must be the position of the <tt class="docutils literal"><span class="pre"><span class="CharLit">'\c'</span></span></tt>.
  197. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L106" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  198. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L106" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  199. </dd>
  200. </div>
  201. </div>
  202. <div id="handleLF-procs-all">
  203. <div id="handleLF,BaseLexer,int">
  204. <dt><pre><span class="Keyword">proc</span> <a href="#handleLF%2CBaseLexer%2Cint"><span class="Identifier">handleLF</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  205. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  206. <dd>
  207. Call this if you scanned over <tt class="docutils literal"><span class="pre"><span class="CharLit">'\L'</span></span></tt> in the buffer; it returns the position to continue the scanning from. <tt class="docutils literal"><span class="pre"><span class="Identifier">pos</span></span></tt> must be the position of the <tt class="docutils literal"><span class="pre"><span class="CharLit">'\L'</span></span></tt>.
  208. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L117" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  209. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L117" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  210. </dd>
  211. </div>
  212. </div>
  213. <div id="handleRefillChar-procs-all">
  214. <div id="handleRefillChar,BaseLexer,int">
  215. <dt><pre><span class="Keyword">proc</span> <a href="#handleRefillChar%2CBaseLexer%2Cint"><span class="Identifier">handleRefillChar</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
  216. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  217. <dd>
  218. Call this if a terminator character other than a new line is scanned at <tt class="docutils literal"><span class="pre"><span class="Identifier">pos</span></span></tt>; it returns the position to continue the scanning from.
  219. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L126" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  220. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L126" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  221. </dd>
  222. </div>
  223. </div>
  224. <div id="open-procs-all">
  225. <div id="open,BaseLexer,Stream,int,set[char]">
  226. <dt><pre><span class="Keyword">proc</span> <a href="#open%2CBaseLexer%2CStream%2Cint%2Cset%5Bchar%5D"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">L</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a><span class="Other">;</span> <span class="Identifier">input</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">bufLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">8192</span><span class="Other">;</span>
  227. <span class="Identifier">refillChars</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">NewLines</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
  228. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  229. <dd>
  230. inits the BaseLexer with a stream to read from.
  231. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/lexbase.nim#L137" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  232. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/lexbase.nim#L137" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  233. </dd>
  234. </div>
  235. </div>
  236. </dl>
  237. </div>
  238. </div>
  239. </div>
  240. <div class="twelve-columns footer">
  241. <span class="nim-sprite"></span>
  242. <br>
  243. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:29 UTC</small>
  244. </div>
  245. </div>
  246. </div>
  247. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  248. </body>
  249. </html>