Почетна Преглед Помоћ
Пријавите се
levovix
/
Nim
огледало од https://github.com/nim-lang/Nim
Прати 1
Волим 0
Креирај огранак 1
Датотеке Дискусије 0 Вики
Грана: gh-pages
Гране Ознаке
Nim
/
sexp.html

sexp.html 92 KB
Пермалинк Историја Датотека

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>sexp</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <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=="/>
    16. 

  16. <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=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">sexp</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <details open>
    56. 

  56.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    57. 

  57.     <ul class="simple simple-toc-section">
    58. 

  58.       <li><a class="reference" href="#SexpError_2" title="SexpError = enum
    59. 

  59.   errNone,                  ## no error
    60. 

  60.   errInvalidToken,          ## invalid token
    61. 

  61.   errParensRiExpected,      ## ``)`` expected
    62. 

  62.   errQuoteExpected,         ## ``&quot;`` expected
    63. 

  63.   errEofExpected             ## EOF expected">SexpError</a></li>
    64. 

  64. <li><a class="reference" href="#SexpEventKind" title="SexpEventKind = enum
    65. 

  65.   sexpError,                ## an error occurred during parsing
    66. 

  66.   sexpEof,                  ## end of file reached
    67. 

  67.   sexpString,               ## a string literal
    68. 

  68.   sexpSymbol,               ## a symbol
    69. 

  69.   sexpInt,                  ## an integer literal
    70. 

  70.   sexpFloat,                ## a float literal
    71. 

  71.   sexpNil,                  ## the value ``nil``
    72. 

  72.   sexpDot,                  ## the dot to separate car/cdr
    73. 

  73.   sexpListStart,            ## start of a list: the ``(`` token
    74. 

  74.   sexpListEnd                ## end of a list: the ``)`` token">SexpEventKind</a></li>
    75. 

  75. <li><a class="reference" href="#SexpNode" title="SexpNode = ref SexpNodeObj">SexpNode</a></li>
    76. 

  76. <li><a class="reference" href="#SexpNodeKind" title="SexpNodeKind = enum
    77. 

  77.   SNil, SInt, SFloat, SString, SSymbol, SList, SCons">SexpNodeKind</a></li>
    78. 

  78. <li><a class="reference" href="#SexpNodeObj" title="SexpNodeObj {.acyclic.} = object
    79. 

  79.   case kind*: SexpNodeKind
    80. 

  80.   of SString:
    81. 

  81.     str*: string
    82. 

  82.   of SSymbol:
    83. 

  83.     symbol*: string
    84. 

  84.   of SInt:
    85. 

  85.     num*: BiggestInt
    86. 

  86.   of SFloat:
    87. 

  87.     fnum*: float
    88. 

  88.   of SList:
    89. 

  89.     elems*: seq[SexpNode]
    90. 

  90.   of SCons:
    91. 

  91.   of SNil:
    92. 

  92.     nil">SexpNodeObj</a></li>
    93. 

  93. <li><a class="reference" href="#SexpParser" title="SexpParser = object of BaseLexer">SexpParser</a></li>
    94. 

  94. <li><a class="reference" href="#SexpParsingError" title="SexpParsingError = object of ValueError">SexpParsingError</a></li>
    95. 

  95. 

  96.     </ul>
    97. 

  97.   </details>
    98. 

  98. </li>
    99. 

  99. <li>
    100. 

  100.   <details open>
    101. 

  101.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    102. 

  102.     <ul class="simple simple-toc-section">
    103. 

  103.       <ul class="simple nested-toc-section">$
    104. 

  104.   <li><a class="reference" href="#%24%2CSexpNode" title="`$`(node: SexpNode): string">`$`(node: SexpNode): string</a></li>
    105. 

  105. 

  106. </ul>
    107. 

  107. <ul class="simple nested-toc-section">==
    108. 

  108.   <li><a class="reference" href="#%3D%3D%2CSexpNode%2CSexpNode" title="`==`(a, b: SexpNode): bool">`==`(a, b: SexpNode): bool</a></li>
    109. 

  109. 

  110. </ul>
    111. 

  111. <ul class="simple nested-toc-section">[]
    112. 

  112.   <li><a class="reference" href="#%5B%5D%2CSexpNode%2Cint" title="`[]`(node: SexpNode; index: int): SexpNode">`[]`(node: SexpNode; index: int): SexpNode</a></li>
    113. 

  113. 

  114. </ul>
    115. 

  115. <ul class="simple nested-toc-section">add
    116. 

  116.   <li><a class="reference" href="#add%2CSexpNode%2CSexpNode" title="add(father, child: SexpNode)">add(father, child: SexpNode)</a></li>
    117. 

  117. 

  118. </ul>
    119. 

  119. <ul class="simple nested-toc-section">close
    120. 

  120.   <li><a class="reference" href="#close%2CSexpParser" title="close(my: var SexpParser)">close(my: var SexpParser)</a></li>
    121. 

  121. 

  122. </ul>
    123. 

  123. <ul class="simple nested-toc-section">copy
    124. 

  124.   <li><a class="reference" href="#copy%2CSexpNode" title="copy(p: SexpNode): SexpNode">copy(p: SexpNode): SexpNode</a></li>
    125. 

  125. 

  126. </ul>
    127. 

  127. <ul class="simple nested-toc-section">errorMsg
    128. 

  128.   <li><a class="reference" href="#errorMsg%2CSexpParser" title="errorMsg(my: SexpParser): string">errorMsg(my: SexpParser): string</a></li>
    129. 

  129. 

  130. </ul>
    131. 

  131. <ul class="simple nested-toc-section">errorMsgExpected
    132. 

  132.   <li><a class="reference" href="#errorMsgExpected%2CSexpParser%2Cstring" title="errorMsgExpected(my: SexpParser; e: string): string">errorMsgExpected(my: SexpParser; e: string): string</a></li>
    133. 

  133. 

  134. </ul>
    135. 

  135. <ul class="simple nested-toc-section">escapeJson
    136. 

  136.   <li><a class="reference" href="#escapeJson%2Cstring" title="escapeJson(s: string): string">escapeJson(s: string): string</a></li>
    137. 

  137. 

  138. </ul>
    139. 

  139. <ul class="simple nested-toc-section">getColumn
    140. 

  140.   <li><a class="reference" href="#getColumn%2CSexpParser" title="getColumn(my: SexpParser): int">getColumn(my: SexpParser): int</a></li>
    141. 

  141. 

  142. </ul>
    143. 

  143. <ul class="simple nested-toc-section">getCons
    144. 

  144.   <li><a class="reference" href="#getCons%2CSexpNode%2CCons" title="getCons(n: SexpNode; defaults: Cons = (newSNil(), newSNil())): Cons">getCons(n: SexpNode; defaults: Cons = (newSNil(), newSNil())): Cons</a></li>
    145. 

  145. 

  146. </ul>
    147. 

  147. <ul class="simple nested-toc-section">getElems
    148. 

  148.   <li><a class="reference" href="#getElems%2CSexpNode%2Cseq%5BSexpNode%5D" title="getElems(n: SexpNode; default: seq[SexpNode] = @[]): seq[SexpNode]">getElems(n: SexpNode; default: seq[SexpNode] = @[]): seq[SexpNode]</a></li>
    149. 

  149. 

  150. </ul>
    151. 

  151. <ul class="simple nested-toc-section">getFloat
    152. 

  152.   <li><a class="reference" href="#getFloat%2CSexpParser" title="getFloat(my: SexpParser): float">getFloat(my: SexpParser): float</a></li>
    153. 

  153. 

  154. </ul>
    155. 

  155. <ul class="simple nested-toc-section">getFNum
    156. 

  156.   <li><a class="reference" href="#getFNum%2CSexpNode%2Cfloat" title="getFNum(n: SexpNode; default: float = 0.0): float">getFNum(n: SexpNode; default: float = 0.0): float</a></li>
    157. 

  157. 

  158. </ul>
    159. 

  159. <ul class="simple nested-toc-section">getInt
    160. 

  160.   <li><a class="reference" href="#getInt%2CSexpParser" title="getInt(my: SexpParser): BiggestInt">getInt(my: SexpParser): BiggestInt</a></li>
    161. 

  161. 

  162. </ul>
    163. 

  163. <ul class="simple nested-toc-section">getLine
    164. 

  164.   <li><a class="reference" href="#getLine%2CSexpParser" title="getLine(my: SexpParser): int">getLine(my: SexpParser): int</a></li>
    165. 

  165. 

  166. </ul>
    167. 

  167. <ul class="simple nested-toc-section">getNum
    168. 

  168.   <li><a class="reference" href="#getNum%2CSexpNode%2CBiggestInt" title="getNum(n: SexpNode; default: BiggestInt = 0): BiggestInt">getNum(n: SexpNode; default: BiggestInt = 0): BiggestInt</a></li>
    169. 

  169. 

  170. </ul>
    171. 

  171. <ul class="simple nested-toc-section">getStr
    172. 

  172.   <li><a class="reference" href="#getStr%2CSexpNode%2Cstring" title="getStr(n: SexpNode; default: string = &quot;&quot;): string">getStr(n: SexpNode; default: string = &quot;&quot;): string</a></li>
    173. 

  173. 

  174. </ul>
    175. 

  175. <ul class="simple nested-toc-section">getSymbol
    176. 

  176.   <li><a class="reference" href="#getSymbol%2CSexpNode%2Cstring" title="getSymbol(n: SexpNode; default: string = &quot;&quot;): string">getSymbol(n: SexpNode; default: string = &quot;&quot;): string</a></li>
    177. 

  177. 

  178. </ul>
    179. 

  179. <ul class="simple nested-toc-section">hash
    180. 

  180.   <li><a class="reference" href="#hash%2CSexpNode" title="hash(n: SexpNode): Hash">hash(n: SexpNode): Hash</a></li>
    181. 

  181. 

  182. </ul>
    183. 

  183. <ul class="simple nested-toc-section">kind
    184. 

  184.   <li><a class="reference" href="#kind%2CSexpParser" title="kind(my: SexpParser): SexpEventKind">kind(my: SexpParser): SexpEventKind</a></li>
    185. 

  185. 

  186. </ul>
    187. 

  187. <ul class="simple nested-toc-section">len
    188. 

  188.   <li><a class="reference" href="#len%2CSexpNode" title="len(n: SexpNode): int">len(n: SexpNode): int</a></li>
    189. 

  189. 

  190. </ul>
    191. 

  191. <ul class="simple nested-toc-section">newSCons
    192. 

  192.   <li><a class="reference" href="#newSCons%2CSexpNode%2CSexpNode" title="newSCons(car, cdr: SexpNode): SexpNode">newSCons(car, cdr: SexpNode): SexpNode</a></li>
    193. 

  193. 

  194. </ul>
    195. 

  195. <ul class="simple nested-toc-section">newSFloat
    196. 

  196.   <li><a class="reference" href="#newSFloat%2Cfloat" title="newSFloat(n: float): SexpNode">newSFloat(n: float): SexpNode</a></li>
    197. 

  197. 

  198. </ul>
    199. 

  199. <ul class="simple nested-toc-section">newSInt
    200. 

  200.   <li><a class="reference" href="#newSInt%2CBiggestInt" title="newSInt(n: BiggestInt): SexpNode">newSInt(n: BiggestInt): SexpNode</a></li>
    201. 

  201. 

  202. </ul>
    203. 

  203. <ul class="simple nested-toc-section">newSList
    204. 

  204.   <li><a class="reference" href="#newSList" title="newSList(): SexpNode">newSList(): SexpNode</a></li>
    205. 

  205. 

  206. </ul>
    207. 

  207. <ul class="simple nested-toc-section">newSNil
    208. 

  208.   <li><a class="reference" href="#newSNil" title="newSNil(): SexpNode">newSNil(): SexpNode</a></li>
    209. 

  209. 

  210. </ul>
    211. 

  211. <ul class="simple nested-toc-section">newSString
    212. 

  212.   <li><a class="reference" href="#newSString%2Cstring" title="newSString(s: string): SexpNode">newSString(s: string): SexpNode</a></li>
    213. 

  213. 

  214. </ul>
    215. 

  215. <ul class="simple nested-toc-section">newSSymbol
    216. 

  216.   <li><a class="reference" href="#newSSymbol%2Cstring" title="newSSymbol(s: string): SexpNode">newSSymbol(s: string): SexpNode</a></li>
    217. 

  217. 

  218. </ul>
    219. 

  219. <ul class="simple nested-toc-section">open
    220. 

  220.   <li><a class="reference" href="#open%2CSexpParser%2CStream" title="open(my: var SexpParser; input: Stream)">open(my: var SexpParser; input: Stream)</a></li>
    221. 

  221. 

  222. </ul>
    223. 

  223. <ul class="simple nested-toc-section">parseSexp
    224. 

  224.   <li><a class="reference" href="#parseSexp%2Cstring" title="parseSexp(buffer: string): SexpNode">parseSexp(buffer: string): SexpNode</a></li>
    225. 

  225. <li><a class="reference" href="#parseSexp%2CStream" title="parseSexp(s: Stream): SexpNode">parseSexp(s: Stream): SexpNode</a></li>
    226. 

  226. 

  227. </ul>
    228. 

  228. <ul class="simple nested-toc-section">pretty
    229. 

  229.   <li><a class="reference" href="#pretty%2CSexpNode%2Cint" title="pretty(node: SexpNode; indent = 2): string">pretty(node: SexpNode; indent = 2): string</a></li>
    230. 

  230. 

  231. </ul>
    232. 

  232. <ul class="simple nested-toc-section">raiseParseErr
    233. 

  233.   <li><a class="reference" href="#raiseParseErr%2CSexpParser%2Cstring" title="raiseParseErr(p: SexpParser; msg: string)">raiseParseErr(p: SexpParser; msg: string)</a></li>
    234. 

  234. 

  235. </ul>
    236. 

  236. <ul class="simple nested-toc-section">sexp
    237. 

  237.   <li><a class="reference" href="#sexp%2Cbool" title="sexp(b: bool): SexpNode">sexp(b: bool): SexpNode</a></li>
    238. 

  238. <li><a class="reference" href="#sexp%2CopenArray%5BSexpNode%5D" title="sexp(elements: openArray[SexpNode]): SexpNode">sexp(elements: openArray[SexpNode]): SexpNode</a></li>
    239. 

  239. <li><a class="reference" href="#sexp%2CBiggestInt" title="sexp(n: BiggestInt): SexpNode">sexp(n: BiggestInt): SexpNode</a></li>
    240. 

  240. <li><a class="reference" href="#sexp%2Cfloat" title="sexp(n: float): SexpNode">sexp(n: float): SexpNode</a></li>
    241. 

  241. <li><a class="reference" href="#sexp%2CSexpNode" title="sexp(s: SexpNode): SexpNode">sexp(s: SexpNode): SexpNode</a></li>
    242. 

  242. <li><a class="reference" href="#sexp%2Cstring" title="sexp(s: string): SexpNode">sexp(s: string): SexpNode</a></li>
    243. 

  243. 

  244. </ul>
    245. 

  245. <ul class="simple nested-toc-section">str
    246. 

  246.   <li><a class="reference" href="#str%2CSexpParser" title="str(my: SexpParser): string">str(my: SexpParser): string</a></li>
    247. 

  247. 

  248. </ul>
    249. 

  249. 

  250.     </ul>
    251. 

  251.   </details>
    252. 

  252. </li>
    253. 

  253. <li>
    254. 

  254.   <details open>
    255. 

  255.     <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    256. 

  256.     <ul class="simple simple-toc-section">
    257. 

  257.       <ul class="simple nested-toc-section">items
    258. 

  258.   <li><a class="reference" href="#items.i%2CSexpNode" title="items(node: SexpNode): SexpNode">items(node: SexpNode): SexpNode</a></li>
    259. 

  259. 

  260. </ul>
    261. 

  261. <ul class="simple nested-toc-section">mitems
    262. 

  262.   <li><a class="reference" href="#mitems.i%2CSexpNode" title="mitems(node: var SexpNode): var SexpNode">mitems(node: var SexpNode): var SexpNode</a></li>
    263. 

  263. 

  264. </ul>
    265. 

  265. 

  266.     </ul>
    267. 

  267.   </details>
    268. 

  268. </li>
    269. 

  269. <li>
    270. 

  270.   <details open>
    271. 

  271.     <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
    272. 

  272.     <ul class="simple simple-toc-section">
    273. 

  273.       <ul class="simple nested-toc-section">convertSexp
    274. 

  274.   <li><a class="reference" href="#convertSexp.m%2Cuntyped" title="convertSexp(x: untyped): untyped">convertSexp(x: untyped): untyped</a></li>
    275. 

  275. 

  276. </ul>
    277. 

  277. 

  278.     </ul>
    279. 

  279.   </details>
    280. 

  280. </li>
    281. 

  281. 

  282. </ul>
    283. 

  283. 

  284.   </div>
    285. 

  285.   <div class="nine columns" id="content">
    286. 

  286.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    287. 

  287. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    288. 

  288. 

  289.     <div id="tocRoot"></div>
    290. 

  290.     
    291. 

  291.     <p class="module-desc"><strong>Note:</strong> Import <tt class="docutils literal"><span class="pre">nimsuggest/sexp</span></tt> to use this module</p>
    292. 

  292.     <div class="section" id="7">
    293. 

  293.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    294. 

  294.   <dl class="item">
    295. 

  295.     <div id="SexpError_2">
    296. 

  296.   <dt><pre><a href="sexp.html#SexpError"><span class="Identifier">SexpError</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    297. 

  297.   <span class="Identifier">errNone</span><span class="Other">,</span>                  <span class="Comment">## no error</span>
    298. 

  298.   <span class="Identifier">errInvalidToken</span><span class="Other">,</span>          <span class="Comment">## invalid token</span>
    299. 

  299.   <span class="Identifier">errParensRiExpected</span><span class="Other">,</span>      <span class="Comment">## ``)`` expected</span>
    300. 

  300.   <span class="Identifier">errQuoteExpected</span><span class="Other">,</span>         <span class="Comment">## ``&quot;`` expected</span>
    301. 

  301.   <span class="Identifier">errEofExpected</span>             <span class="Comment">## EOF expected</span></pre></dt>
    302. 

  302.   <dd>
    303. 

  303.     
    304. 

  304.     enumeration that lists all errors that can occur
    305. 

  305.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L46" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    306. 

  306. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L46" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    307. 

  307. 

  308.   </dd>
    309. 

  309. </div>
    310. 

  310. <div id="SexpEventKind">
    311. 

  311.   <dt><pre><a href="sexp.html#SexpEventKind"><span class="Identifier">SexpEventKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    312. 

  312.   <span class="Identifier">sexpError</span><span class="Other">,</span>                <span class="Comment">## an error occurred during parsing</span>
    313. 

  313.   <span class="Identifier">sexpEof</span><span class="Other">,</span>                  <span class="Comment">## end of file reached</span>
    314. 

  314.   <span class="Identifier">sexpString</span><span class="Other">,</span>               <span class="Comment">## a string literal</span>
    315. 

  315.   <span class="Identifier">sexpSymbol</span><span class="Other">,</span>               <span class="Comment">## a symbol</span>
    316. 

  316.   <span class="Identifier">sexpInt</span><span class="Other">,</span>                  <span class="Comment">## an integer literal</span>
    317. 

  317.   <span class="Identifier">sexpFloat</span><span class="Other">,</span>                <span class="Comment">## a float literal</span>
    318. 

  318.   <span class="Identifier">sexpNil</span><span class="Other">,</span>                  <span class="Comment">## the value ``nil``</span>
    319. 

  319.   <span class="Identifier">sexpDot</span><span class="Other">,</span>                  <span class="Comment">## the dot to separate car/cdr</span>
    320. 

  320.   <span class="Identifier">sexpListStart</span><span class="Other">,</span>            <span class="Comment">## start of a list: the ``(`` token</span>
    321. 

  321.   <span class="Identifier">sexpListEnd</span>                <span class="Comment">## end of a list: the ``)`` token</span></pre></dt>
    322. 

  322.   <dd>
    323. 

  323.     
    324. 

  324.     enumeration of all events that may occur when parsing
    325. 

  325.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L21" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    326. 

  326. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L21" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    327. 

  327. 

  328.   </dd>
    329. 

  329. </div>
    330. 

  330. <div id="SexpNode">
    331. 

  331.   <dt><pre><a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="sexp.html#SexpNodeObj"><span class="Identifier">SexpNodeObj</span></a></pre></dt>
    332. 

  332.   <dd>
    333. 

  333.     
    334. 

  334.     SEXP node
    335. 

  335.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L263" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    336. 

  336. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L263" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    337. 

  337. 

  338.   </dd>
    339. 

  339. </div>
    340. 

  340. <div id="SexpNodeKind">
    341. 

  341.   <dt><pre><a href="sexp.html#SexpNodeKind"><span class="Identifier">SexpNodeKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    342. 

  342.   <span class="Identifier">SNil</span><span class="Other">,</span> <span class="Identifier">SInt</span><span class="Other">,</span> <span class="Identifier">SFloat</span><span class="Other">,</span> <span class="Identifier">SString</span><span class="Other">,</span> <span class="Identifier">SSymbol</span><span class="Other">,</span> <span class="Identifier">SList</span><span class="Other">,</span> <span class="Identifier">SCons</span></pre></dt>
    343. 

  343.   <dd>
    344. 

  344.     
    345. 

  345.     possible SEXP node types
    346. 

  346.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L254" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    347. 

  347. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L254" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    348. 

  348. 

  349.   </dd>
    350. 

  350. </div>
    351. 

  351. <div id="SexpNodeObj">
    352. 

  352.   <dt><pre><a href="sexp.html#SexpNodeObj"><span class="Identifier">SexpNodeObj</span></a> {.<span class="Identifier">acyclic</span>.} <span class="Other">=</span> <span class="Keyword">object</span>
    353. 

  353.   <span class="Keyword">case</span> <span class="Identifier">kind</span><span class="Operator">*</span><span class="Other">:</span> <a href="sexp.html#SexpNodeKind"><span class="Identifier">SexpNodeKind</span></a>
    354. 

  354.   <span class="Keyword">of</span> <span class="Identifier">SString</span><span class="Other">:</span>
    355. 

  355.     <span class="Identifier">str</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
    356. 

  356.   <span class="Keyword">of</span> <span class="Identifier">SSymbol</span><span class="Other">:</span>
    357. 

  357.     <span class="Identifier">symbol</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
    358. 

  358.   <span class="Keyword">of</span> <span class="Identifier">SInt</span><span class="Other">:</span>
    359. 

  359.     <span class="Identifier">num</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span>
    360. 

  360.   <span class="Keyword">of</span> <span class="Identifier">SFloat</span><span class="Other">:</span>
    361. 

  361.     <span class="Identifier">fnum</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
    362. 

  362.   <span class="Keyword">of</span> <span class="Identifier">SList</span><span class="Other">:</span>
    363. 

  363.     <span class="Identifier">elems</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">]</span>
    364. 

  364.   <span class="Keyword">of</span> <span class="Identifier">SCons</span><span class="Other">:</span>
    365. 

  365.   <span class="Keyword">of</span> <span class="Identifier">SNil</span><span class="Other">:</span>
    366. 

  366.     <span class="Keyword">nil</span></pre></dt>
    367. 

  367.   <dd>
    368. 

  368.     
    369. 

  369.     
    370. 

  370.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L264" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    371. 

  371. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L264" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    372. 

  372. 

  373.   </dd>
    374. 

  374. </div>
    375. 

  375. <div id="SexpParser">
    376. 

  376.   <dt><pre><a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">BaseLexer</span></pre></dt>
    377. 

  377.   <dd>
    378. 

  378.     
    379. 

  379.     the parser object.
    380. 

  380.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L53" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    381. 

  381. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L53" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    382. 

  382. 

  383.   </dd>
    384. 

  384. </div>
    385. 

  385. <div id="SexpParsingError">
    386. 

  386.   <dt><pre><a href="sexp.html#SexpParsingError"><span class="Identifier">SexpParsingError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">ValueError</span></pre></dt>
    387. 

  387.   <dd>
    388. 

  388.     
    389. 

  389.     is raised for a SEXP error
    390. 

  390.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L284" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    391. 

  391. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L284" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    392. 

  392. 

  393.   </dd>
    394. 

  394. </div>
    395. 

  395. 

  396.   </dl>
    397. 

  397. </div>
    398. 

  398. <div class="section" id="12">
    399. 

  399.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    400. 

  400.   <dl class="item">
    401. 

  401.     <div id="$-procs-all">
    402. 

  402.   <div id="$,SexpNode">
    403. 

  403.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CSexpNode"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">node</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    404. 

  404.   <dd>
    405. 

  405.     
    406. 

  406.     Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt> to its SEXP Representation on one line.
    407. 

  407.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L567" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    408. 

  408. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L567" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    409. 

  409. 

  410.   </dd>
    411. 

  411. </div>
    412. 

  412. 

  413. </div>
    414. 

  414. <div id="==-procs-all">
    415. 

  415.   <div id="==,SexpNode,SexpNode">
    416. 

  416.   <dt><pre><span class="Keyword">func</span> <a href="#%3D%3D%2CSexpNode%2CSexpNode"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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">Exception</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">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    417. 

  417.                                   <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    418. 

  418.   <dd>
    419. 

  419.     
    420. 

  420.     Check two nodes for equality
    421. 

  421.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L407" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    422. 

  422. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L407" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    423. 

  423. 

  424.   </dd>
    425. 

  425. </div>
    426. 

  426. 

  427. </div>
    428. 

  428. <div id="[]-procs-all">
    429. 

  429.   <div id="[],SexpNode,int">
    430. 

  430.   <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CSexpNode%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">node</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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>
    431. 

  431.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    432. 

  432.   <dd>
    433. 

  433.     
    434. 

  434.     Gets the node at <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt> in a List. Result is undefined if <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt> is out of bounds
    435. 

  435.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L457" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    436. 

  436. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L457" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    437. 

  437. 

  438.   </dd>
    439. 

  439. </div>
    440. 

  440. 

  441. </div>
    442. 

  442. <div id="add-procs-all">
    443. 

  443.   <div id="add,SexpNode,SexpNode">
    444. 

  444.   <dt><pre><span class="Keyword">proc</span> <a href="#add%2CSexpNode%2CSexpNode"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">father</span><span class="Other">,</span> <span class="Identifier">child</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    445. 

  445.   <dd>
    446. 

  446.     
    447. 

  447.     Adds <tt class="docutils literal"><span class="pre"><span class="Identifier">child</span></span></tt> to a SList node <tt class="docutils literal"><span class="pre"><span class="Identifier">father</span></span></tt>.
    448. 

  448.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L464" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    449. 

  449. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L464" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    450. 

  450. 

  451.   </dd>
    452. 

  452. </div>
    453. 

  453. 

  454. </div>
    455. 

  455. <div id="close-procs-all">
    456. 

  456.   <div id="close,SexpParser">
    457. 

  457.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CSexpParser"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span> {.<span class="Identifier">inline</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>
    458. 

  458.                                  <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>
    459. 

  459.   <dd>
    460. 

  460.     
    461. 

  461.     closes the parser <tt class="docutils literal"><span class="pre"><span class="Identifier">my</span></span></tt> and its associated input stream.
    462. 

  462.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L79" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    463. 

  463. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L79" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    464. 

  464. 

  465.   </dd>
    466. 

  466. </div>
    467. 

  467. 

  468. </div>
    469. 

  469. <div id="copy-procs-all">
    470. 

  470.   <div id="copy,SexpNode">
    471. 

  471.   <dt><pre><span class="Keyword">proc</span> <a href="#copy%2CSexpNode"><span class="Identifier">copy</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    472. 

  472.   <dd>
    473. 

  473.     
    474. 

  474.     Performs a deep copy of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
    475. 

  475.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L498" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    476. 

  476. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L498" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    477. 

  477. 

  478.   </dd>
    479. 

  479. </div>
    480. 

  480. 

  481. </div>
    482. 

  482. <div id="errorMsg-procs-all">
    483. 

  483.   <div id="errorMsg,SexpParser">
    484. 

  484.   <dt><pre><span class="Keyword">proc</span> <a href="#errorMsg%2CSexpParser"><span class="Identifier">errorMsg</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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">ValueError</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>
    485. 

  485.                                         <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    486. 

  486.   <dd>
    487. 

  487.     
    488. 

  488.     returns a helpful error message for the event <tt class="docutils literal"><span class="pre">sexpError</span></tt>
    489. 

  489.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L111" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    490. 

  490. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L111" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    491. 

  491. 

  492.   </dd>
    493. 

  493. </div>
    494. 

  494. 

  495. </div>
    496. 

  496. <div id="errorMsgExpected-procs-all">
    497. 

  497.   <div id="errorMsgExpected,SexpParser,string">
    498. 

  498.   <dt><pre><span class="Keyword">proc</span> <a href="#errorMsgExpected%2CSexpParser%2Cstring"><span class="Identifier">errorMsgExpected</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">;</span> <span class="Identifier">e</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    499. 

  499.     <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>
    500. 

  500.   <dd>
    501. 

  501.     
    502. 

  502.     returns an error message &quot;<tt class="docutils literal"><span class="pre"><span class="Identifier">e</span></span></tt> expected&quot; in the same format as the other error messages
    503. 

  503.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L116" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    504. 

  504. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L116" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    505. 

  505. 

  506.   </dd>
    507. 

  507. </div>
    508. 

  508. 

  509. </div>
    510. 

  510. <div id="escapeJson-procs-all">
    511. 

  511.   <div id="escapeJson,string">
    512. 

  512.   <dt><pre><span class="Keyword">proc</span> <a href="#escapeJson%2Cstring"><span class="Identifier">escapeJson</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    513. 

  513.   <dd>
    514. 

  514.     
    515. 

  515.     Converts a string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to its JSON representation.
    516. 

  516.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L481" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    517. 

  517. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L481" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    518. 

  518. 

  519.   </dd>
    520. 

  520. </div>
    521. 

  521. 

  522. </div>
    523. 

  523. <div id="getColumn-procs-all">
    524. 

  524.   <div id="getColumn,SexpParser">
    525. 

  525.   <dt><pre><span class="Keyword">proc</span> <a href="#getColumn%2CSexpParser"><span class="Identifier">getColumn</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">inline</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    526. 

  526.   <dd>
    527. 

  527.     
    528. 

  528.     get the current column the parser has arrived at.
    529. 

  529.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L103" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    530. 

  530. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L103" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    531. 

  531. 

  532.   </dd>
    533. 

  533. </div>
    534. 

  534. 

  535. </div>
    536. 

  536. <div id="getCons-procs-all">
    537. 

  537.   <div id="getCons,SexpNode,Cons">
    538. 

  538.   <dt><pre><span class="Keyword">proc</span> <a href="#getCons%2CSexpNode%2CCons"><span class="Identifier">getCons</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">defaults</span><span class="Other">:</span> <span class="Identifier">Cons</span> <span class="Other">=</span> <span class="Other">(</span><span class="Identifier">newSNil</span><span class="Other">(</span><span class="Other">)</span><span class="Other">,</span> <span class="Identifier">newSNil</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Cons</span> {.
    539. 

  539.     <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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    540. 

  540.   <dd>
    541. 

  541.     
    542. 

  542.     <p>Retrieves the cons value of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span> <span class="Identifier">SexpNode</span></span></tt>.</p>
    543. 

  543. <p>Returns <tt class="docutils literal"><span class="pre">default</span></tt> if <tt class="docutils literal"><span class="pre">n</span></tt> is not a <tt class="docutils literal"><span class="pre">SList</span></tt>.</p>
    544. 

  544. 

  545.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L353" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    546. 

  546. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L353" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    547. 

  547. 

  548.   </dd>
    549. 

  549. </div>
    550. 

  550. 

  551. </div>
    552. 

  552. <div id="getElems-procs-all">
    553. 

  553.   <div id="getElems,SexpNode,seq[SexpNode]">
    554. 

  554.   <dt><pre><span class="Keyword">proc</span> <a href="#getElems%2CSexpNode%2Cseq%5BSexpNode%5D"><span class="Identifier">getElems</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">]</span> {.
    555. 

  555.     <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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    556. 

  556.   <dd>
    557. 

  557.     
    558. 

  558.     <p>Retrieves the int value of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span> <span class="Identifier">SexpNode</span></span></tt>.</p>
    559. 

  559. <p>Returns <tt class="docutils literal"><span class="pre">default</span></tt> if <tt class="docutils literal"><span class="pre">n</span></tt> is not a <tt class="docutils literal"><span class="pre">SList</span></tt>.</p>
    560. 

  560. 

  561.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L345" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    562. 

  562. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L345" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    563. 

  563. 

  564.   </dd>
    565. 

  565. </div>
    566. 

  566. 

  567. </div>
    568. 

  568. <div id="getFloat-procs-all">
    569. 

  569.   <div id="getFloat,SexpParser">
    570. 

  570.   <dt><pre><span class="Keyword">proc</span> <a href="#getFloat%2CSexpParser"><span class="Identifier">getFloat</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</span> {.<span class="Identifier">inline</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">ValueError</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>
    571. 

  571.                                        <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    572. 

  572.   <dd>
    573. 

  573.     
    574. 

  574.     returns the number for the event: <tt class="docutils literal"><span class="pre">sexpFloat</span></tt>
    575. 

  575.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L94" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    576. 

  576. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L94" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    577. 

  577. 

  578.   </dd>
    579. 

  579. </div>
    580. 

  580. 

  581. </div>
    582. 

  582. <div id="getFNum-procs-all">
    583. 

  583.   <div id="getFNum,SexpNode,float">
    584. 

  584.   <dt><pre><span class="Keyword">proc</span> <a href="#getFNum%2CSexpNode%2Cfloat"><span class="Identifier">getFNum</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">=</span> <span class="FloatNumber">0.0</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</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="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>
    585. 

  585.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    586. 

  586.   <dd>
    587. 

  587.     
    588. 

  588.     <p>Retrieves the float value of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SFloat</span> <span class="Identifier">SexpNode</span></span></tt>.</p>
    589. 

  589. <p>Returns <tt class="docutils literal"><span class="pre">default</span></tt> if <tt class="docutils literal"><span class="pre">n</span></tt> is not a <tt class="docutils literal"><span class="pre">SFloat</span></tt>.</p>
    590. 

  590. 

  591.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L331" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    592. 

  592. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L331" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    593. 

  593. 

  594.   </dd>
    595. 

  595. </div>
    596. 

  596. 

  597. </div>
    598. 

  598. <div id="getInt-procs-all">
    599. 

  599.   <div id="getInt,SexpParser">
    600. 

  600.   <dt><pre><span class="Keyword">proc</span> <a href="#getInt%2CSexpParser"><span class="Identifier">getInt</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span> {.<span class="Identifier">inline</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">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    601. 

  601.     <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>
    602. 

  602.   <dd>
    603. 

  603.     
    604. 

  604.     returns the number for the event: <tt class="docutils literal"><span class="pre">sexpInt</span></tt>
    605. 

  605.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L89" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    606. 

  606. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L89" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    607. 

  607. 

  608.   </dd>
    609. 

  609. </div>
    610. 

  610. 

  611. </div>
    612. 

  612. <div id="getLine-procs-all">
    613. 

  613.   <div id="getLine,SexpParser">
    614. 

  614.   <dt><pre><span class="Keyword">proc</span> <a href="#getLine%2CSexpParser"><span class="Identifier">getLine</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">inline</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    615. 

  615.   <dd>
    616. 

  616.     
    617. 

  617.     get the current line the parser has arrived at.
    618. 

  618.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    619. 

  619. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    620. 

  620. 

  621.   </dd>
    622. 

  622. </div>
    623. 

  623. 

  624. </div>
    625. 

  625. <div id="getNum-procs-all">
    626. 

  626.   <div id="getNum,SexpNode,BiggestInt">
    627. 

  627.   <dt><pre><span class="Keyword">proc</span> <a href="#getNum%2CSexpNode%2CBiggestInt"><span class="Identifier">getNum</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">BiggestInt</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="Other">]</span><span class="Other">,</span>
    628. 

  628.     <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>
    629. 

  629.   <dd>
    630. 

  630.     
    631. 

  631.     <p>Retrieves the int value of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SInt</span> <span class="Identifier">SexpNode</span></span></tt>.</p>
    632. 

  632. <p>Returns <tt class="docutils literal"><span class="pre">default</span></tt> if <tt class="docutils literal"><span class="pre">n</span></tt> is not a <tt class="docutils literal"><span class="pre">SInt</span></tt>.</p>
    633. 

  633. 

  634.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L324" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    635. 

  635. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L324" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    636. 

  636. 

  637.   </dd>
    638. 

  638. </div>
    639. 

  639. 

  640. </div>
    641. 

  641. <div id="getStr-procs-all">
    642. 

  642.   <div id="getStr,SexpNode,string">
    643. 

  643.   <dt><pre><span class="Keyword">proc</span> <a href="#getStr%2CSexpNode%2Cstring"><span class="Identifier">getStr</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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="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>
    644. 

  644.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    645. 

  645.   <dd>
    646. 

  646.     
    647. 

  647.     <p>Retrieves the string value of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SString</span> <span class="Identifier">SexpNode</span></span></tt>.</p>
    648. 

  648. <p>Returns <tt class="docutils literal"><span class="pre">default</span></tt> if <tt class="docutils literal"><span class="pre">n</span></tt> is not a <tt class="docutils literal"><span class="pre">SString</span></tt>.</p>
    649. 

  649. 

  650.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L317" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    651. 

  651. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L317" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    652. 

  652. 

  653.   </dd>
    654. 

  654. </div>
    655. 

  655. 

  656. </div>
    657. 

  657. <div id="getSymbol-procs-all">
    658. 

  658.   <div id="getSymbol,SexpNode,string">
    659. 

  659.   <dt><pre><span class="Keyword">proc</span> <a href="#getSymbol%2CSexpNode%2Cstring"><span class="Identifier">getSymbol</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">default</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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="Other">]</span><span class="Other">,</span>
    660. 

  660.     <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>
    661. 

  661.   <dd>
    662. 

  662.     
    663. 

  663.     <p>Retrieves the int value of a <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span> <span class="Identifier">SexpNode</span></span></tt>.</p>
    664. 

  664. <p>Returns <tt class="docutils literal"><span class="pre">default</span></tt> if <tt class="docutils literal"><span class="pre">n</span></tt> is not a <tt class="docutils literal"><span class="pre">SList</span></tt>.</p>
    665. 

  665. 

  666.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L338" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    667. 

  667. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L338" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    668. 

  668. 

  669.   </dd>
    670. 

  670. </div>
    671. 

  671. 

  672. </div>
    673. 

  673. <div id="hash-procs-all">
    674. 

  674.   <div id="hash,SexpNode">
    675. 

  675.   <dt><pre><span class="Keyword">proc</span> <a href="#hash%2CSexpNode"><span class="Identifier">hash</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Hash</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">Exception</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">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    676. 

  676.                                <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    677. 

  677.   <dd>
    678. 

  678.     
    679. 

  679.     Compute the hash for a SEXP node
    680. 

  680.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L431" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    681. 

  681. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L431" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    682. 

  682. 

  683.   </dd>
    684. 

  684. </div>
    685. 

  685. 

  686. </div>
    687. 

  687. <div id="kind-procs-all">
    688. 

  688.   <div id="kind,SexpParser">
    689. 

  689.   <dt><pre><span class="Keyword">proc</span> <a href="#kind%2CSexpParser"><span class="Identifier">kind</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpEventKind"><span class="Identifier">SexpEventKind</span></a> {.<span class="Identifier">inline</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="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>
    690. 

  690.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    691. 

  691.   <dd>
    692. 

  692.     
    693. 

  693.     returns the current event type for the SEXP parser
    694. 

  694.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L99" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    695. 

  695. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L99" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    696. 

  696. 

  697.   </dd>
    698. 

  698. </div>
    699. 

  699. 

  700. </div>
    701. 

  701. <div id="len-procs-all">
    702. 

  702.   <div id="len,SexpNode">
    703. 

  703.   <dt><pre><span class="Keyword">proc</span> <a href="#len%2CSexpNode"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    704. 

  704.   <dd>
    705. 

  705.     
    706. 

  706.     If <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> is a <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span></span></tt>, it returns the number of elements. If <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> is a <tt class="docutils literal"><span class="pre"><span class="Identifier">JObject</span></span></tt>, it returns the number of pairs. Else it returns 0.
    707. 

  707.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L449" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    708. 

  708. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L449" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    709. 

  709. 

  710.   </dd>
    711. 

  711. </div>
    712. 

  712. 

  713. </div>
    714. 

  714. <div id="newSCons-procs-all">
    715. 

  715.   <div id="newSCons,SexpNode,SexpNode">
    716. 

  716.   <dt><pre><span class="Keyword">proc</span> <a href="#newSCons%2CSexpNode%2CSexpNode"><span class="Identifier">newSCons</span></a><span class="Other">(</span><span class="Identifier">car</span><span class="Other">,</span> <span class="Identifier">cdr</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    717. 

  717.   <dd>
    718. 

  718.     
    719. 

  719.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SCons</span> <span class="Identifier">SexpNode</span></span></tt>
    720. 

  720.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L306" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    721. 

  721. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L306" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    722. 

  722. 

  723.   </dd>
    724. 

  724. </div>
    725. 

  725. 

  726. </div>
    727. 

  727. <div id="newSFloat-procs-all">
    728. 

  728.   <div id="newSFloat,float">
    729. 

  729.   <dt><pre><span class="Keyword">proc</span> <a href="#newSFloat%2Cfloat"><span class="Identifier">newSFloat</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    730. 

  730.   <dd>
    731. 

  731.     
    732. 

  732.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SFloat</span> <span class="Identifier">SexpNode</span></span></tt>.
    733. 

  733.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L298" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    734. 

  734. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L298" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    735. 

  735. 

  736.   </dd>
    737. 

  737. </div>
    738. 

  738. 

  739. </div>
    740. 

  740. <div id="newSInt-procs-all">
    741. 

  741.   <div id="newSInt,BiggestInt">
    742. 

  742.   <dt><pre><span class="Keyword">proc</span> <a href="#newSInt%2CBiggestInt"><span class="Identifier">newSInt</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    743. 

  743.   <dd>
    744. 

  744.     
    745. 

  745.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SInt</span> <span class="Identifier">SexpNode</span></span></tt>.
    746. 

  746.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L294" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    747. 

  747. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L294" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    748. 

  748. 

  749.   </dd>
    750. 

  750. </div>
    751. 

  751. 

  752. </div>
    753. 

  753. <div id="newSList-procs-all">
    754. 

  754.   <div id="newSList">
    755. 

  755.   <dt><pre><span class="Keyword">proc</span> <a href="#newSList"><span class="Identifier">newSList</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    756. 

  756.   <dd>
    757. 

  757.     
    758. 

  758.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span> <span class="Identifier">SexpNode</span></span></tt>
    759. 

  759.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L310" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    760. 

  760. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L310" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    761. 

  761. 

  762.   </dd>
    763. 

  763. </div>
    764. 

  764. 

  765. </div>
    766. 

  766. <div id="newSNil-procs-all">
    767. 

  767.   <div id="newSNil">
    768. 

  768.   <dt><pre><span class="Keyword">proc</span> <a href="#newSNil"><span class="Identifier">newSNil</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    769. 

  769.   <dd>
    770. 

  770.     
    771. 

  771.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SNil</span> <span class="Identifier">SexpNode</span></span></tt>.
    772. 

  772.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L302" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    773. 

  773. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L302" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    774. 

  774. 

  775.   </dd>
    776. 

  776. </div>
    777. 

  777. 

  778. </div>
    779. 

  779. <div id="newSString-procs-all">
    780. 

  780.   <div id="newSString,string">
    781. 

  781.   <dt><pre><span class="Keyword">proc</span> <a href="#newSString%2Cstring"><span class="Identifier">newSString</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    782. 

  782.   <dd>
    783. 

  783.     
    784. 

  784.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SString</span> <span class="Identifier">SexpNode</span></span></tt>.
    785. 

  785.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L290" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    786. 

  786. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L290" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    787. 

  787. 

  788.   </dd>
    789. 

  789. </div>
    790. 

  790. 

  791. </div>
    792. 

  792. <div id="newSSymbol-procs-all">
    793. 

  793.   <div id="newSSymbol,string">
    794. 

  794.   <dt><pre><span class="Keyword">proc</span> <a href="#newSSymbol%2Cstring"><span class="Identifier">newSSymbol</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    795. 

  795.   <dd>
    796. 

  796.     
    797. 

  797.     
    798. 

  798.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L314" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    799. 

  799. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L314" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    800. 

  800. 

  801.   </dd>
    802. 

  802. </div>
    803. 

  803. 

  804. </div>
    805. 

  805. <div id="open-procs-all">
    806. 

  806.   <div id="open,SexpParser,Stream">
    807. 

  807.   <dt><pre><span class="Keyword">proc</span> <a href="#open%2CSexpParser%2CStream"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">;</span> <span class="Identifier">input</span><span class="Other">:</span> <span class="Identifier">Stream</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>
    808. 

  808.     <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>
    809. 

  809.   <dd>
    810. 

  810.     
    811. 

  811.     initializes the parser with an input stream.
    812. 

  812.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L624" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    813. 

  813. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L624" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    814. 

  814. 

  815.   </dd>
    816. 

  816. </div>
    817. 

  817. 

  818. </div>
    819. 

  819. <div id="parseSexp-procs-all">
    820. 

  820.   <div id="parseSexp,string">
    821. 

  821.   <dt><pre><span class="Keyword">proc</span> <a href="#parseSexp%2Cstring"><span class="Identifier">parseSexp</span></a><span class="Other">(</span><span class="Identifier">buffer</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a> {.
    822. 

  822.     <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="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">SexpParsingError</span><span class="Other">]</span><span class="Other">,</span>
    823. 

  823.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</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>
    824. 

  824.   <dd>
    825. 

  825.     
    826. 

  826.     Parses Sexp from <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt>.
    827. 

  827.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L638" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    828. 

  828. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L638" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    829. 

  829. 

  830.   </dd>
    831. 

  831. </div>
    832. 

  832. <div id="parseSexp,Stream">
    833. 

  833.   <dt><pre><span class="Keyword">proc</span> <a href="#parseSexp%2CStream"><span class="Identifier">parseSexp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">Stream</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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="Identifier">ValueError</span><span class="Other">,</span>
    834. 

  834.     <span class="Identifier">SexpParsingError</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="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>
    835. 

  835.   <dd>
    836. 

  836.     
    837. 

  837.     Parses from a buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into a <tt class="docutils literal"><span class="pre"><span class="Identifier">SexpNode</span></span></tt>.
    838. 

  838.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L630" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    839. 

  839. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L630" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    840. 

  840. 

  841.   </dd>
    842. 

  842. </div>
    843. 

  843. 

  844. </div>
    845. 

  845. <div id="pretty-procs-all">
    846. 

  846.   <div id="pretty,SexpNode,int">
    847. 

  847.   <dt><pre><span class="Keyword">proc</span> <a href="#pretty%2CSexpNode%2Cint"><span class="Identifier">pretty</span></a><span class="Other">(</span><span class="Identifier">node</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">;</span> <span class="Identifier">indent</span> <span class="Other">=</span> <span class="DecNumber">2</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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="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>
    848. 

  848.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    849. 

  849.   <dd>
    850. 

  850.     
    851. 

  851.     Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt> to its Sexp Representation, with indentation and on multiple lines.
    852. 

  852.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L561" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    853. 

  853. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L561" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    854. 

  854. 

  855.   </dd>
    856. 

  856. </div>
    857. 

  857. 

  858. </div>
    859. 

  859. <div id="raiseParseErr-procs-all">
    860. 

  860.   <div id="raiseParseErr,SexpParser,string">
    861. 

  861.   <dt><pre><span class="Keyword">proc</span> <a href="#raiseParseErr%2CSexpParser%2Cstring"><span class="Identifier">raiseParseErr</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.<span class="Identifier">noinline</span><span class="Other">,</span> <span class="Identifier">noreturn</span><span class="Other">,</span>
    862. 

  862.     <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">SexpParsingError</span><span class="Other">,</span> <span class="Identifier">ValueError</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    863. 

  863.   <dd>
    864. 

  864.     
    865. 

  865.     raises an <tt class="docutils literal"><span class="pre"><span class="Identifier">ESexpParsingError</span></span></tt> exception.
    866. 

  866.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L286" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    867. 

  867. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L286" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    868. 

  868. 

  869.   </dd>
    870. 

  870. </div>
    871. 

  871. 

  872. </div>
    873. 

  873. <div id="sexp-procs-all">
    874. 

  874.   <div id="sexp,bool">
    875. 

  875.   <dt><pre><span class="Keyword">proc</span> <a href="#sexp%2Cbool"><span class="Identifier">sexp</span></a><span class="Other">(</span><span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    876. 

  876.   <dd>
    877. 

  877.     
    878. 

  878.     Generic constructor for SEXP data. Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SSymbol</span> <span class="Identifier">SexpNode</span></span></tt> with value t or <tt class="docutils literal"><span class="pre"><span class="Identifier">SNil</span> <span class="Identifier">SexpNode</span></span></tt>.
    879. 

  879.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L373" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    880. 

  880. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L373" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    881. 

  881. 

  882.   </dd>
    883. 

  883. </div>
    884. 

  884. <div id="sexp,openArray[SexpNode]">
    885. 

  885.   <dt><pre><span class="Keyword">proc</span> <a href="#sexp%2CopenArray%5BSexpNode%5D"><span class="Identifier">sexp</span></a><span class="Other">(</span><span class="Identifier">elements</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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>
    886. 

  886.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    887. 

  887.   <dd>
    888. 

  888.     
    889. 

  889.     Generic constructor for SEXP data. Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span> <span class="Identifier">SexpNode</span></span></tt>
    890. 

  890.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L381" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    891. 

  891. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L381" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    892. 

  892. 

  893.   </dd>
    894. 

  894. </div>
    895. 

  895. <div id="sexp,BiggestInt">
    896. 

  896.   <dt><pre><span class="Keyword">proc</span> <a href="#sexp%2CBiggestInt"><span class="Identifier">sexp</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    897. 

  897.   <dd>
    898. 

  898.     
    899. 

  899.     Generic constructor for SEXP data. Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SInt</span> <span class="Identifier">SexpNode</span></span></tt>.
    900. 

  900.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L365" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    901. 

  901. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L365" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    902. 

  902. 

  903.   </dd>
    904. 

  904. </div>
    905. 

  905. <div id="sexp,float">
    906. 

  906.   <dt><pre><span class="Keyword">proc</span> <a href="#sexp%2Cfloat"><span class="Identifier">sexp</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    907. 

  907.   <dd>
    908. 

  908.     
    909. 

  909.     Generic constructor for SEXP data. Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SFloat</span> <span class="Identifier">SexpNode</span></span></tt>.
    910. 

  910.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L369" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    911. 

  911. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L369" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    912. 

  912. 

  913.   </dd>
    914. 

  914. </div>
    915. 

  915. <div id="sexp,SexpNode">
    916. 

  916.   <dt><pre><span class="Keyword">proc</span> <a href="#sexp%2CSexpNode"><span class="Identifier">sexp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    917. 

  917.   <dd>
    918. 

  918.     
    919. 

  919.     
    920. 

  920.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L387" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    921. 

  921. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L387" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    922. 

  922. 

  923.   </dd>
    924. 

  924. </div>
    925. 

  925. <div id="sexp,string">
    926. 

  926.   <dt><pre><span class="Keyword">proc</span> <a href="#sexp%2Cstring"><span class="Identifier">sexp</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    927. 

  927.   <dd>
    928. 

  928.     
    929. 

  929.     Generic constructor for SEXP data. Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SString</span> <span class="Identifier">SexpNode</span></span></tt>.
    930. 

  930.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L361" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    931. 

  931. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L361" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    932. 

  932. 

  933.   </dd>
    934. 

  934. </div>
    935. 

  935. 

  936. </div>
    937. 

  937. <div id="str-procs-all">
    938. 

  938.   <div id="str,SexpParser">
    939. 

  939.   <dt><pre><span class="Keyword">proc</span> <a href="#str%2CSexpParser"><span class="Identifier">str</span></a><span class="Other">(</span><span class="Identifier">my</span><span class="Other">:</span> <a href="sexp.html#SexpParser"><span class="Identifier">SexpParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span class="Identifier">inline</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="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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    940. 

  940.   <dd>
    941. 

  941.     
    942. 

  942.     returns the character data for the events: <tt class="docutils literal"><span class="pre">sexpInt</span></tt>, <tt class="docutils literal"><span class="pre">sexpFloat</span></tt>, <tt class="docutils literal"><span class="pre">sexpString</span></tt>
    943. 

  943.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L83" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    944. 

  944. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L83" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    945. 

  945. 

  946.   </dd>
    947. 

  947. </div>
    948. 

  948. 

  949. </div>
    950. 

  950. 

  951.   </dl>
    952. 

  952. </div>
    953. 

  953. <div class="section" id="15">
    954. 

  954.   <h1><a class="toc-backref" href="#15">Iterators</a></h1>
    955. 

  955.   <dl class="item">
    956. 

  956.     <div id="items-iterators-all">
    957. 

  957.   <div id="items.i,SexpNode">
    958. 

  958.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CSexpNode"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">node</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    959. 

  959.   <dd>
    960. 

  960.     
    961. 

  961.     Iterator for the items of <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt> has to be a SList.
    962. 

  962.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L572" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    963. 

  963. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L572" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    964. 

  964. 

  965.   </dd>
    966. 

  966. </div>
    967. 

  967. 

  968. </div>
    969. 

  969. <div id="mitems-iterators-all">
    970. 

  970.   <div id="mitems.i,SexpNode">
    971. 

  971.   <dt><pre><span class="Keyword">iterator</span> <a href="#mitems.i%2CSexpNode"><span class="Identifier">mitems</span></a><span class="Other">(</span><span class="Identifier">node</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sexp.html#SexpNode"><span class="Identifier">SexpNode</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>
    972. 

  972.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    973. 

  973.   <dd>
    974. 

  974.     
    975. 

  975.     Iterator for the items of <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt> has to be a SList. Items can be modified.
    976. 

  976.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L578" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    977. 

  977. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L578" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    978. 

  978. 

  979.   </dd>
    980. 

  980. </div>
    981. 

  981. 

  982. </div>
    983. 

  983. 

  984.   </dl>
    985. 

  985. </div>
    986. 

  986. <div class="section" id="17">
    987. 

  987.   <h1><a class="toc-backref" href="#17">Macros</a></h1>
    988. 

  988.   <dl class="item">
    989. 

  989.     <div id="convertSexp-macros-all">
    990. 

  990.   <div id="convertSexp.m,untyped">
    991. 

  991.   <dt><pre><span class="Keyword">macro</span> <a href="#convertSexp.m%2Cuntyped"><span class="Identifier">convertSexp</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
    992. 

  992.   <dd>
    993. 

  993.     
    994. 

  994.     Convert an expression to a SexpNode directly, without having to specify <tt class="docutils literal"><span class="pre"><span class="Operator">%</span></span></tt> for every element.
    995. 

  995.     <a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L402" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    996. 

  996. <a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L402" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    997. 

  997. 

  998.   </dd>
    999. 

  999. </div>
    1000. 

  1000. 

  1001. </div>
    1002. 

  1002. 

  1003.   </dl>
    1004. 

  1004. </div>
    1005. 

  1005. 

  1006.   </div>
    1007. 

  1007. </div>
    1008. 

  1008. 

  1009.       <div class="twelve-columns footer">
    1010. 

  1010.         <span class="nim-sprite"></span>
    1011. 

  1011.         <br>
    1012. 

  1012.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-12 16:40:01 UTC</small>
    1013. 

  1013.       </div>
    1014. 

  1014.     </div>
    1015. 

  1015.   </div>
    1016. 

  1016.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1017. 

  1017.     
    1018. 

  1018. </body>
    1019. 

  1019. </html>
    1020. 

  1020.