mirror of
https://github.com/nim-lang/Nim.git
synced 2026-01-03 19:52:36 +00:00
1020 lines
92 KiB
HTML
1020 lines
92 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>sexp</title>
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- Favicon -->
|
|
<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=="/>
|
|
<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=">
|
|
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
|
|
|
|
<!-- JS -->
|
|
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
|
|
</head>
|
|
<body>
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">sexp</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-select-wrapper">
|
|
<label for="theme-select">Theme: </label>
|
|
<select id="theme-select" onchange="setTheme(this.value)">
|
|
<option value="auto">🌗 Match OS</option>
|
|
<option value="dark">🌑 Dark</option>
|
|
<option value="light">🌕 Light</option>
|
|
</select>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple-boot">
|
|
<li><a href="manual.html">Manual</a></li>
|
|
<li><a href="lib.html">Standard library</a></li>
|
|
<li> <a id="indexLink" href="theindex.html">Index</a></li>
|
|
<li><a href="compiler/theindex.html">Compiler docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="search" id="searchInput"
|
|
oninput="search()" />
|
|
</div>
|
|
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#SexpError_2" title="SexpError = enum
|
|
errNone, ## no error
|
|
errInvalidToken, ## invalid token
|
|
errParensRiExpected, ## ``)`` expected
|
|
errQuoteExpected, ## ``"`` expected
|
|
errEofExpected ## EOF expected">SexpError</a></li>
|
|
<li><a class="reference" href="#SexpEventKind" title="SexpEventKind = enum
|
|
sexpError, ## an error occurred during parsing
|
|
sexpEof, ## end of file reached
|
|
sexpString, ## a string literal
|
|
sexpSymbol, ## a symbol
|
|
sexpInt, ## an integer literal
|
|
sexpFloat, ## a float literal
|
|
sexpNil, ## the value ``nil``
|
|
sexpDot, ## the dot to separate car/cdr
|
|
sexpListStart, ## start of a list: the ``(`` token
|
|
sexpListEnd ## end of a list: the ``)`` token">SexpEventKind</a></li>
|
|
<li><a class="reference" href="#SexpNode" title="SexpNode = ref SexpNodeObj">SexpNode</a></li>
|
|
<li><a class="reference" href="#SexpNodeKind" title="SexpNodeKind = enum
|
|
SNil, SInt, SFloat, SString, SSymbol, SList, SCons">SexpNodeKind</a></li>
|
|
<li><a class="reference" href="#SexpNodeObj" title="SexpNodeObj {.acyclic.} = object
|
|
case kind*: SexpNodeKind
|
|
of SString:
|
|
str*: string
|
|
of SSymbol:
|
|
symbol*: string
|
|
of SInt:
|
|
num*: BiggestInt
|
|
of SFloat:
|
|
fnum*: float
|
|
of SList:
|
|
elems*: seq[SexpNode]
|
|
of SCons:
|
|
of SNil:
|
|
nil">SexpNodeObj</a></li>
|
|
<li><a class="reference" href="#SexpParser" title="SexpParser = object of BaseLexer">SexpParser</a></li>
|
|
<li><a class="reference" href="#SexpParsingError" title="SexpParsingError = object of ValueError">SexpParsingError</a></li>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">$
|
|
<li><a class="reference" href="#%24%2CSexpNode" title="`$`(node: SexpNode): string">`$`(node: SexpNode): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">==
|
|
<li><a class="reference" href="#%3D%3D%2CSexpNode%2CSexpNode" title="`==`(a, b: SexpNode): bool">`==`(a, b: SexpNode): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">[]
|
|
<li><a class="reference" href="#%5B%5D%2CSexpNode%2Cint" title="`[]`(node: SexpNode; index: int): SexpNode">`[]`(node: SexpNode; index: int): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">add
|
|
<li><a class="reference" href="#add%2CSexpNode%2CSexpNode" title="add(father, child: SexpNode)">add(father, child: SexpNode)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">close
|
|
<li><a class="reference" href="#close%2CSexpParser" title="close(my: var SexpParser)">close(my: var SexpParser)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">copy
|
|
<li><a class="reference" href="#copy%2CSexpNode" title="copy(p: SexpNode): SexpNode">copy(p: SexpNode): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">errorMsg
|
|
<li><a class="reference" href="#errorMsg%2CSexpParser" title="errorMsg(my: SexpParser): string">errorMsg(my: SexpParser): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">errorMsgExpected
|
|
<li><a class="reference" href="#errorMsgExpected%2CSexpParser%2Cstring" title="errorMsgExpected(my: SexpParser; e: string): string">errorMsgExpected(my: SexpParser; e: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">escapeJson
|
|
<li><a class="reference" href="#escapeJson%2Cstring" title="escapeJson(s: string): string">escapeJson(s: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getColumn
|
|
<li><a class="reference" href="#getColumn%2CSexpParser" title="getColumn(my: SexpParser): int">getColumn(my: SexpParser): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getCons
|
|
<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>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getElems
|
|
<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>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getFloat
|
|
<li><a class="reference" href="#getFloat%2CSexpParser" title="getFloat(my: SexpParser): float">getFloat(my: SexpParser): float</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getFNum
|
|
<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>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getInt
|
|
<li><a class="reference" href="#getInt%2CSexpParser" title="getInt(my: SexpParser): BiggestInt">getInt(my: SexpParser): BiggestInt</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getLine
|
|
<li><a class="reference" href="#getLine%2CSexpParser" title="getLine(my: SexpParser): int">getLine(my: SexpParser): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getNum
|
|
<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>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getStr
|
|
<li><a class="reference" href="#getStr%2CSexpNode%2Cstring" title="getStr(n: SexpNode; default: string = ""): string">getStr(n: SexpNode; default: string = ""): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getSymbol
|
|
<li><a class="reference" href="#getSymbol%2CSexpNode%2Cstring" title="getSymbol(n: SexpNode; default: string = ""): string">getSymbol(n: SexpNode; default: string = ""): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">hash
|
|
<li><a class="reference" href="#hash%2CSexpNode" title="hash(n: SexpNode): Hash">hash(n: SexpNode): Hash</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">kind
|
|
<li><a class="reference" href="#kind%2CSexpParser" title="kind(my: SexpParser): SexpEventKind">kind(my: SexpParser): SexpEventKind</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">len
|
|
<li><a class="reference" href="#len%2CSexpNode" title="len(n: SexpNode): int">len(n: SexpNode): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSCons
|
|
<li><a class="reference" href="#newSCons%2CSexpNode%2CSexpNode" title="newSCons(car, cdr: SexpNode): SexpNode">newSCons(car, cdr: SexpNode): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSFloat
|
|
<li><a class="reference" href="#newSFloat%2Cfloat" title="newSFloat(n: float): SexpNode">newSFloat(n: float): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSInt
|
|
<li><a class="reference" href="#newSInt%2CBiggestInt" title="newSInt(n: BiggestInt): SexpNode">newSInt(n: BiggestInt): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSList
|
|
<li><a class="reference" href="#newSList" title="newSList(): SexpNode">newSList(): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSNil
|
|
<li><a class="reference" href="#newSNil" title="newSNil(): SexpNode">newSNil(): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSString
|
|
<li><a class="reference" href="#newSString%2Cstring" title="newSString(s: string): SexpNode">newSString(s: string): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">newSSymbol
|
|
<li><a class="reference" href="#newSSymbol%2Cstring" title="newSSymbol(s: string): SexpNode">newSSymbol(s: string): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">open
|
|
<li><a class="reference" href="#open%2CSexpParser%2CStream" title="open(my: var SexpParser; input: Stream)">open(my: var SexpParser; input: Stream)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">parseSexp
|
|
<li><a class="reference" href="#parseSexp%2Cstring" title="parseSexp(buffer: string): SexpNode">parseSexp(buffer: string): SexpNode</a></li>
|
|
<li><a class="reference" href="#parseSexp%2CStream" title="parseSexp(s: Stream): SexpNode">parseSexp(s: Stream): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">pretty
|
|
<li><a class="reference" href="#pretty%2CSexpNode%2Cint" title="pretty(node: SexpNode; indent = 2): string">pretty(node: SexpNode; indent = 2): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">raiseParseErr
|
|
<li><a class="reference" href="#raiseParseErr%2CSexpParser%2Cstring" title="raiseParseErr(p: SexpParser; msg: string)">raiseParseErr(p: SexpParser; msg: string)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">sexp
|
|
<li><a class="reference" href="#sexp%2Cbool" title="sexp(b: bool): SexpNode">sexp(b: bool): SexpNode</a></li>
|
|
<li><a class="reference" href="#sexp%2CopenArray%5BSexpNode%5D" title="sexp(elements: openArray[SexpNode]): SexpNode">sexp(elements: openArray[SexpNode]): SexpNode</a></li>
|
|
<li><a class="reference" href="#sexp%2CBiggestInt" title="sexp(n: BiggestInt): SexpNode">sexp(n: BiggestInt): SexpNode</a></li>
|
|
<li><a class="reference" href="#sexp%2Cfloat" title="sexp(n: float): SexpNode">sexp(n: float): SexpNode</a></li>
|
|
<li><a class="reference" href="#sexp%2CSexpNode" title="sexp(s: SexpNode): SexpNode">sexp(s: SexpNode): SexpNode</a></li>
|
|
<li><a class="reference" href="#sexp%2Cstring" title="sexp(s: string): SexpNode">sexp(s: string): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">str
|
|
<li><a class="reference" href="#str%2CSexpParser" title="str(my: SexpParser): string">str(my: SexpParser): string</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">items
|
|
<li><a class="reference" href="#items.i%2CSexpNode" title="items(node: SexpNode): SexpNode">items(node: SexpNode): SexpNode</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">mitems
|
|
<li><a class="reference" href="#mitems.i%2CSexpNode" title="mitems(node: var SexpNode): var SexpNode">mitems(node: var SexpNode): var SexpNode</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">convertSexp
|
|
<li><a class="reference" href="#convertSexp.m%2Cuntyped" title="convertSexp(x: untyped): untyped">convertSexp(x: untyped): untyped</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<div class="nine columns" id="content">
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L1" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
<div id="tocRoot"></div>
|
|
|
|
<p class="module-desc"><strong>Note:</strong> Import <tt class="docutils literal"><span class="pre">nimsuggest/sexp</span></tt> to use this module</p>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="SexpError_2">
|
|
<dt><pre><a href="sexp.html#SexpError"><span class="Identifier">SexpError</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
|
|
<span class="Identifier">errNone</span><span class="Other">,</span> <span class="Comment">## no error</span>
|
|
<span class="Identifier">errInvalidToken</span><span class="Other">,</span> <span class="Comment">## invalid token</span>
|
|
<span class="Identifier">errParensRiExpected</span><span class="Other">,</span> <span class="Comment">## ``)`` expected</span>
|
|
<span class="Identifier">errQuoteExpected</span><span class="Other">,</span> <span class="Comment">## ``"`` expected</span>
|
|
<span class="Identifier">errEofExpected</span> <span class="Comment">## EOF expected</span></pre></dt>
|
|
<dd>
|
|
|
|
enumeration that lists all errors that can occur
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L46" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SexpEventKind">
|
|
<dt><pre><a href="sexp.html#SexpEventKind"><span class="Identifier">SexpEventKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
|
|
<span class="Identifier">sexpError</span><span class="Other">,</span> <span class="Comment">## an error occurred during parsing</span>
|
|
<span class="Identifier">sexpEof</span><span class="Other">,</span> <span class="Comment">## end of file reached</span>
|
|
<span class="Identifier">sexpString</span><span class="Other">,</span> <span class="Comment">## a string literal</span>
|
|
<span class="Identifier">sexpSymbol</span><span class="Other">,</span> <span class="Comment">## a symbol</span>
|
|
<span class="Identifier">sexpInt</span><span class="Other">,</span> <span class="Comment">## an integer literal</span>
|
|
<span class="Identifier">sexpFloat</span><span class="Other">,</span> <span class="Comment">## a float literal</span>
|
|
<span class="Identifier">sexpNil</span><span class="Other">,</span> <span class="Comment">## the value ``nil``</span>
|
|
<span class="Identifier">sexpDot</span><span class="Other">,</span> <span class="Comment">## the dot to separate car/cdr</span>
|
|
<span class="Identifier">sexpListStart</span><span class="Other">,</span> <span class="Comment">## start of a list: the ``(`` token</span>
|
|
<span class="Identifier">sexpListEnd</span> <span class="Comment">## end of a list: the ``)`` token</span></pre></dt>
|
|
<dd>
|
|
|
|
enumeration of all events that may occur when parsing
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L21" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
SEXP node
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L263" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L263" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SexpNodeKind">
|
|
<dt><pre><a href="sexp.html#SexpNodeKind"><span class="Identifier">SexpNodeKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
|
|
<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>
|
|
<dd>
|
|
|
|
possible SEXP node types
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L254" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L254" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SexpNodeObj">
|
|
<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>
|
|
<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>
|
|
<span class="Keyword">of</span> <span class="Identifier">SString</span><span class="Other">:</span>
|
|
<span class="Identifier">str</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
|
|
<span class="Keyword">of</span> <span class="Identifier">SSymbol</span><span class="Other">:</span>
|
|
<span class="Identifier">symbol</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
|
|
<span class="Keyword">of</span> <span class="Identifier">SInt</span><span class="Other">:</span>
|
|
<span class="Identifier">num</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span>
|
|
<span class="Keyword">of</span> <span class="Identifier">SFloat</span><span class="Other">:</span>
|
|
<span class="Identifier">fnum</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
|
|
<span class="Keyword">of</span> <span class="Identifier">SList</span><span class="Other">:</span>
|
|
<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>
|
|
<span class="Keyword">of</span> <span class="Identifier">SCons</span><span class="Other">:</span>
|
|
<span class="Keyword">of</span> <span class="Identifier">SNil</span><span class="Other">:</span>
|
|
<span class="Keyword">nil</span></pre></dt>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L264" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L264" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SexpParser">
|
|
<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>
|
|
<dd>
|
|
|
|
the parser object.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L53" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SexpParsingError">
|
|
<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>
|
|
<dd>
|
|
|
|
is raised for a SEXP error
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L284" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L284" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="$-procs-all">
|
|
<div id="$,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">node</span></span></tt> to its SEXP Representation on one line.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L567" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L567" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="==-procs-all">
|
|
<div id="==,SexpNode,SexpNode">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Check two nodes for equality
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L407" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L407" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="[]-procs-all">
|
|
<div id="[],SexpNode,int">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
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
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L457" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L457" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="add-procs-all">
|
|
<div id="add,SexpNode,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L464" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L464" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="close-procs-all">
|
|
<div id="close,SexpParser">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
closes the parser <tt class="docutils literal"><span class="pre"><span class="Identifier">my</span></span></tt> and its associated input stream.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L79" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="copy-procs-all">
|
|
<div id="copy,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
Performs a deep copy of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L498" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L498" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="errorMsg-procs-all">
|
|
<div id="errorMsg,SexpParser">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
returns a helpful error message for the event <tt class="docutils literal"><span class="pre">sexpError</span></tt>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L111" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L111" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="errorMsgExpected-procs-all">
|
|
<div id="errorMsgExpected,SexpParser,string">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
returns an error message "<tt class="docutils literal"><span class="pre"><span class="Identifier">e</span></span></tt> expected" in the same format as the other error messages
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L116" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L116" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="escapeJson-procs-all">
|
|
<div id="escapeJson,string">
|
|
<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>
|
|
<dd>
|
|
|
|
Converts a string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to its JSON representation.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L481" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L481" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getColumn-procs-all">
|
|
<div id="getColumn,SexpParser">
|
|
<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>
|
|
<dd>
|
|
|
|
get the current column the parser has arrived at.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L103" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L103" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getCons-procs-all">
|
|
<div id="getCons,SexpNode,Cons">
|
|
<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> {.
|
|
<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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L353" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L353" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getElems-procs-all">
|
|
<div id="getElems,SexpNode,seq[SexpNode]">
|
|
<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> {.
|
|
<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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L345" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L345" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getFloat-procs-all">
|
|
<div id="getFloat,SexpParser">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
returns the number for the event: <tt class="docutils literal"><span class="pre">sexpFloat</span></tt>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L94" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L94" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getFNum-procs-all">
|
|
<div id="getFNum,SexpNode,float">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L331" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L331" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getInt-procs-all">
|
|
<div id="getInt,SexpParser">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
returns the number for the event: <tt class="docutils literal"><span class="pre">sexpInt</span></tt>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L89" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L89" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getLine-procs-all">
|
|
<div id="getLine,SexpParser">
|
|
<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>
|
|
<dd>
|
|
|
|
get the current line the parser has arrived at.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L107" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L107" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getNum-procs-all">
|
|
<div id="getNum,SexpNode,BiggestInt">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L324" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L324" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getStr-procs-all">
|
|
<div id="getStr,SexpNode,string">
|
|
<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">""</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L317" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L317" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getSymbol-procs-all">
|
|
<div id="getSymbol,SexpNode,string">
|
|
<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">""</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L338" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L338" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="hash-procs-all">
|
|
<div id="hash,SexpNode">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Compute the hash for a SEXP node
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L431" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L431" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="kind-procs-all">
|
|
<div id="kind,SexpParser">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
returns the current event type for the SEXP parser
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L99" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L99" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="len-procs-all">
|
|
<div id="len,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
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.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L449" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L449" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSCons-procs-all">
|
|
<div id="newSCons,SexpNode,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SCons</span> <span class="Identifier">SexpNode</span></span></tt>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L306" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L306" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSFloat-procs-all">
|
|
<div id="newSFloat,float">
|
|
<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>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SFloat</span> <span class="Identifier">SexpNode</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L298" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L298" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSInt-procs-all">
|
|
<div id="newSInt,BiggestInt">
|
|
<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>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SInt</span> <span class="Identifier">SexpNode</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L294" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L294" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSList-procs-all">
|
|
<div id="newSList">
|
|
<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>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SList</span> <span class="Identifier">SexpNode</span></span></tt>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L310" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L310" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSNil-procs-all">
|
|
<div id="newSNil">
|
|
<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>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SNil</span> <span class="Identifier">SexpNode</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L302" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L302" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSString-procs-all">
|
|
<div id="newSString,string">
|
|
<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>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SString</span> <span class="Identifier">SexpNode</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L290" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L290" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="newSSymbol-procs-all">
|
|
<div id="newSSymbol,string">
|
|
<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>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L314" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L314" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="open-procs-all">
|
|
<div id="open,SexpParser,Stream">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
initializes the parser with an input stream.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L624" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L624" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="parseSexp-procs-all">
|
|
<div id="parseSexp,string">
|
|
<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> {.
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
Parses Sexp from <tt class="docutils literal"><span class="pre"><span class="Identifier">buffer</span></span></tt>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L638" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L638" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="parseSexp,Stream">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L630" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L630" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="pretty-procs-all">
|
|
<div id="pretty,SexpNode,int">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
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.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L561" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L561" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="raiseParseErr-procs-all">
|
|
<div id="raiseParseErr,SexpParser,string">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
raises an <tt class="docutils literal"><span class="pre"><span class="Identifier">ESexpParsingError</span></span></tt> exception.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L286" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L286" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="sexp-procs-all">
|
|
<div id="sexp,bool">
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L373" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L373" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sexp,openArray[SexpNode]">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
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>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L381" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L381" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sexp,BiggestInt">
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L365" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L365" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sexp,float">
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L369" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L369" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sexp,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L387" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L387" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="sexp,string">
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L361" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L361" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="str-procs-all">
|
|
<div id="str,SexpParser">
|
|
<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>
|
|
<dd>
|
|
|
|
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>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L83" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L83" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="15">
|
|
<h1><a class="toc-backref" href="#15">Iterators</a></h1>
|
|
<dl class="item">
|
|
<div id="items-iterators-all">
|
|
<div id="items.i,SexpNode">
|
|
<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>
|
|
<dd>
|
|
|
|
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.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L572" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L572" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="mitems-iterators-all">
|
|
<div id="mitems.i,SexpNode">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
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.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L578" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L578" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="17">
|
|
<h1><a class="toc-backref" href="#17">Macros</a></h1>
|
|
<dl class="item">
|
|
<div id="convertSexp-macros-all">
|
|
<div id="convertSexp.m,untyped">
|
|
<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>
|
|
<dd>
|
|
|
|
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.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/nimsuggest/sexp.nim#L402" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/nimsuggest/sexp.nim#L402" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br>
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2025-09-27 04:02:22 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
|
|
|
|
</body>
|
|
</html>
|