ホーム エクスプローラ ヘルプ
サインイン
levovix
/
Nim
同期ミラー https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
ファイル 課題 0 Wiki
ブランチ: gh-pages
ブランチ タグ
Nim
/
parsecfg.html

parsecfg.html 77 KB
パーマリンク 履歴 Raw

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

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

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

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

  5. <head>
    6. 

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

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

  8. <title>std/parsecfg</title>
    9. 

  9. 

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

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

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

  13. 

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

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

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

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

  20. 

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

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

  23. </head>
    24. 

  24. <body>
    25. 

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

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

  27.       <h1 class="title">std/parsecfg</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <ul class="simple"><li><a class="reference" id="configuration-file-example_toc" href="#configuration-file-example">Configuration file example</a></li>
    55. 

  55. <li><a class="reference" id="creating-a-configuration-file_toc" href="#creating-a-configuration-file">Creating a configuration file</a></li>
    56. 

  56. <li><a class="reference" id="reading-a-configuration-file_toc" href="#reading-a-configuration-file">Reading a configuration file</a></li>
    57. 

  57. <li><a class="reference" id="modifying-a-configuration-file_toc" href="#modifying-a-configuration-file">Modifying a configuration file</a></li>
    58. 

  58. <li><a class="reference" id="deleting-a-section-key-in-a-configuration-file_toc" href="#deleting-a-section-key-in-a-configuration-file">Deleting a section key in a configuration file</a></li>
    59. 

  59. <li><a class="reference" id="supported-ini-file-structure_toc" href="#supported-ini-file-structure">Supported INI File structure</a></li>
    60. 

  60. </ul><li>
    61. 

  61.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    62. 

  62. </li>
    63. 

  63. <li>
    64. 

  64.   <details open>
    65. 

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

  66.     <ul class="simple simple-toc-section">
    67. 

  67.       <li><a class="reference" href="#CfgEvent" title="CfgEvent = object of RootObj
    68. 

  68.   case kind*: CfgEventKind   ## the kind of the event
    69. 

  69.   of cfgEof:
    70. 

  70.     nil
    71. 

  71.   of cfgSectionStart:
    72. 

  72.     section*: string         ## `section` contains the name of the
    73. 

  73.                              ## parsed section start (syntax: `[section]`)
    74. 

  74.   of cfgKeyValuePair, cfgOption:
    75. 

  75.     key*, value*: string     ## contains the (key, value) pair if an option
    76. 

  76.                              ## of the form `--key: value` or an ordinary
    77. 

  77.                              ## `key= value` pair has been parsed.
    78. 

  78.                              ## `value==&quot;&quot;` if it was not specified in the
    79. 

  79.                              ## configuration file.
    80. 

  80.   of cfgError:              ## the parser encountered an error: `msg`
    81. 

  81.     msg*: string             ## contains the error message. No exceptions
    82. 

  82.                              ## are thrown if a parse error occurs.">CfgEvent</a></li>
    83. 

  83. <li><a class="reference" href="#CfgEventKind" title="CfgEventKind = enum
    84. 

  84.   cfgEof,                   ## end of file reached
    85. 

  85.   cfgSectionStart,          ## a `[section]` has been parsed
    86. 

  86.   cfgKeyValuePair,          ## a `key=value` pair has been detected
    87. 

  87.   cfgOption,                ## a `--key=value` command line option
    88. 

  88.   cfgError                   ## an error occurred during parsing">CfgEventKind</a></li>
    89. 

  89. <li><a class="reference" href="#CfgParser" title="CfgParser = object of BaseLexer">CfgParser</a></li>
    90. 

  90. <li><a class="reference" href="#Config" title="Config = OrderedTableRef[string, OrderedTableRef[string, string]]">Config</a></li>
    91. 

  91. 

  92.     </ul>
    93. 

  93.   </details>
    94. 

  94. </li>
    95. 

  95. <li>
    96. 

  96.   <details open>
    97. 

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

  98.     <ul class="simple simple-toc-section">
    99. 

  99.       <ul class="simple nested-toc-section">$
    100. 

  100.   <li><a class="reference" href="#%24%2CConfig" title="`$`(dict: Config): string">`$`(dict: Config): string</a></li>
    101. 

  101. 

  102. </ul>
    103. 

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

  104.   <li><a class="reference" href="#close%2CCfgParser" title="close(c: var CfgParser)">close(c: var CfgParser)</a></li>
    105. 

  105. 

  106. </ul>
    107. 

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

  108.   <li><a class="reference" href="#delSection%2CConfig%2Cstring" title="delSection(dict: var Config; section: string)">delSection(dict: var Config; section: string)</a></li>
    109. 

  109. 

  110. </ul>
    111. 

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

  112.   <li><a class="reference" href="#delSectionKey%2CConfig%2Cstring%2Cstring" title="delSectionKey(dict: var Config; section, key: string)">delSectionKey(dict: var Config; section, key: string)</a></li>
    113. 

  113. 

  114. </ul>
    115. 

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

  116.   <li><a class="reference" href="#errorStr%2CCfgParser%2Cstring" title="errorStr(c: CfgParser; msg: string): string">errorStr(c: CfgParser; msg: string): string</a></li>
    117. 

  117. 

  118. </ul>
    119. 

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

  120.   <li><a class="reference" href="#getColumn%2CCfgParser" title="getColumn(c: CfgParser): int">getColumn(c: CfgParser): int</a></li>
    121. 

  121. 

  122. </ul>
    123. 

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

  124.   <li><a class="reference" href="#getFilename%2CCfgParser" title="getFilename(c: CfgParser): string">getFilename(c: CfgParser): string</a></li>
    125. 

  125. 

  126. </ul>
    127. 

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

  128.   <li><a class="reference" href="#getLine%2CCfgParser" title="getLine(c: CfgParser): int">getLine(c: CfgParser): int</a></li>
    129. 

  129. 

  130. </ul>
    131. 

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

  132.   <li><a class="reference" href="#getSectionValue%2CConfig%2Cstring%2Cstring%2Cstring" title="getSectionValue(dict: Config; section, key: string; defaultVal = &quot;&quot;): string">getSectionValue(dict: Config; section, key: string; defaultVal = &quot;&quot;): string</a></li>
    133. 

  133. 

  134. </ul>
    135. 

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

  136.   <li><a class="reference" href="#ignoreMsg%2CCfgParser%2CCfgEvent" title="ignoreMsg(c: CfgParser; e: CfgEvent): string">ignoreMsg(c: CfgParser; e: CfgEvent): string</a></li>
    137. 

  137. 

  138. </ul>
    139. 

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

  140.   <li><a class="reference" href="#loadConfig%2Cstring" title="loadConfig(filename: string): Config">loadConfig(filename: string): Config</a></li>
    141. 

  141. <li><a class="reference" href="#loadConfig%2CStream%2Cstring" title="loadConfig(stream: Stream; filename: string = &quot;[stream]&quot;): Config">loadConfig(stream: Stream; filename: string = &quot;[stream]&quot;): Config</a></li>
    142. 

  142. 

  143. </ul>
    144. 

  144. <ul class="simple nested-toc-section">newConfig
    145. 

  145.   <li><a class="reference" href="#newConfig" title="newConfig(): Config">newConfig(): Config</a></li>
    146. 

  146. 

  147. </ul>
    148. 

  148. <ul class="simple nested-toc-section">next
    149. 

  149.   <li><a class="reference" href="#next%2CCfgParser" title="next(c: var CfgParser): CfgEvent">next(c: var CfgParser): CfgEvent</a></li>
    150. 

  150. 

  151. </ul>
    152. 

  152. <ul class="simple nested-toc-section">open
    153. 

  153.   <li><a class="reference" href="#open%2CCfgParser%2CStream%2Cstring%2Cint" title="open(c: var CfgParser; input: Stream; filename: string; lineOffset = 0)">open(c: var CfgParser; input: Stream; filename: string; lineOffset = 0)</a></li>
    154. 

  154. 

  155. </ul>
    156. 

  156. <ul class="simple nested-toc-section">setSectionKey
    157. 

  157.   <li><a class="reference" href="#setSectionKey%2CConfig%2Cstring%2Cstring%2Cstring" title="setSectionKey(dict: var Config; section, key, value: string)">setSectionKey(dict: var Config; section, key, value: string)</a></li>
    158. 

  158. 

  159. </ul>
    160. 

  160. <ul class="simple nested-toc-section">warningStr
    161. 

  161.   <li><a class="reference" href="#warningStr%2CCfgParser%2Cstring" title="warningStr(c: CfgParser; msg: string): string">warningStr(c: CfgParser; msg: string): string</a></li>
    162. 

  162. 

  163. </ul>
    164. 

  164. <ul class="simple nested-toc-section">writeConfig
    165. 

  165.   <li><a class="reference" href="#writeConfig%2CConfig%2Cstring" title="writeConfig(dict: Config; filename: string)">writeConfig(dict: Config; filename: string)</a></li>
    166. 

  166. <li><a class="reference" href="#writeConfig%2CConfig%2CStream" title="writeConfig(dict: Config; stream: Stream)">writeConfig(dict: Config; stream: Stream)</a></li>
    167. 

  167. 

  168. </ul>
    169. 

  169. 

  170.     </ul>
    171. 

  171.   </details>
    172. 

  172. </li>
    173. 

  173. <li>
    174. 

  174.   <details open>
    175. 

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

  176.     <ul class="simple simple-toc-section">
    177. 

  177.       <ul class="simple nested-toc-section">sections
    178. 

  178.   <li><a class="reference" href="#sections.i%2CConfig" title="sections(dict: Config): lent string">sections(dict: Config): lent string</a></li>
    179. 

  179. 

  180. </ul>
    181. 

  181. 

  182.     </ul>
    183. 

  183.   </details>
    184. 

  184. </li>
    185. 

  185. 

  186. </ul>
    187. 

  187. 

  188.   </div>
    189. 

  189.   <div class="nine columns" id="content">
    190. 

  190.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    191. 

  191. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    192. 

  192. 

  193.     <div id="tocRoot"></div>
    194. 

  194.     
    195. 

  195.     <p class="module-desc"><p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">parsecfg</span></span></tt> module implements a high performance configuration file parser. The configuration file's syntax is similar to the Windows <tt class="docutils literal"><span class="pre"><span class="Operator">.</span><span class="Identifier">ini</span></span></tt> format, but much more powerful, as it is not a line based parser. String literals, raw string literals and triple quoted string literals are supported as in the Nim programming language.</p>
    196. 

  196. <p>Example of how a configuration file may look like:</p>
    197. 

  197. <pre># This is a comment.
    198. 

  198. ; this too.
    199. 

  199. 

  200. [Common]
    201. 

  201. cc=gcc     # '=' and ':' are the same
    202. 

  202. --foo=&quot;bar&quot;   # '--cc' and 'cc' are the same, 'bar' and '&quot;bar&quot;' are the same (except for '#')
    203. 

  203. macrosym: &quot;#&quot;  # Note that '#' is interpreted as a comment without the quotation
    204. 

  204. --verbose
    205. 

  205. 

  206. [Windows]
    207. 

  207. isConsoleApplication=False ; another comment
    208. 

  208. 

  209. [Posix]
    210. 

  210. isConsoleApplication=True
    211. 

  211. 

  212. key1: &quot;in this string backslash escapes are interpreted\n&quot;
    213. 

  213. key2: r&quot;in this string not&quot;
    214. 

  214. key3: &quot;&quot;&quot;triple quotes strings
    215. 

  215. are also supported. They may span
    216. 

  216. multiple lines.&quot;&quot;&quot;
    217. 

  217. 

  218. --&quot;long option with spaces&quot;: r&quot;c:\myfiles\test.txt&quot; 
    219. 

  219. </pre>
    220. 

  220. <p>Here is an example of how to use the configuration file parser:</p>
    221. 

  221. 

  222. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    223. 

  223. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecfg</span>
    224. 

  224. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Punctuation">[</span><span class="Identifier">strutils</span><span class="Punctuation">,</span> <span class="Identifier">streams</span><span class="Punctuation">]</span>
    225. 

  225. 

  226. <span class="Keyword">let</span> <span class="Identifier">configFile</span> <span class="Operator">=</span> <span class="StringLit">&quot;example.ini&quot;</span>
    227. 

  227. <span class="Keyword">var</span> <span class="Identifier">f</span> <span class="Operator">=</span> <span class="Identifier">newFileStream</span><span class="Punctuation">(</span><span class="Identifier">configFile</span><span class="Punctuation">,</span> <span class="Identifier">fmRead</span><span class="Punctuation">)</span>
    228. 

  228. <span class="Identifier">assert</span> <span class="Identifier">f</span> <span class="Operator">!=</span> <span class="Keyword">nil</span><span class="Punctuation">,</span> <span class="StringLit">&quot;cannot open &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">configFile</span>
    229. 

  229. <span class="Keyword">var</span> <span class="Identifier">p</span><span class="Punctuation">:</span> <span class="Identifier">CfgParser</span>
    230. 

  230. <span class="Identifier">open</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">,</span> <span class="Identifier">f</span><span class="Punctuation">,</span> <span class="Identifier">configFile</span><span class="Punctuation">)</span>
    231. 

  231. <span class="Keyword">while</span> <span class="Identifier">true</span><span class="Punctuation">:</span>
    232. 

  232.   <span class="Keyword">var</span> <span class="Identifier">e</span> <span class="Operator">=</span> <span class="Identifier">next</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span>
    233. 

  233.   <span class="Keyword">case</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">kind</span>
    234. 

  234.   <span class="Keyword">of</span> <span class="Identifier">cfgEof</span><span class="Punctuation">:</span> <span class="Keyword">break</span>
    235. 

  235.   <span class="Keyword">of</span> <span class="Identifier">cfgSectionStart</span><span class="Punctuation">:</span>   <span class="Comment">## a `[section]` has been parsed</span>
    236. 

  236.     <span class="Identifier">echo</span> <span class="StringLit">&quot;new section: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">section</span>
    237. 

  237.   <span class="Keyword">of</span> <span class="Identifier">cfgKeyValuePair</span><span class="Punctuation">:</span>
    238. 

  238.     <span class="Identifier">echo</span> <span class="StringLit">&quot;key-value-pair: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">value</span>
    239. 

  239.   <span class="Keyword">of</span> <span class="Identifier">cfgOption</span><span class="Punctuation">:</span>
    240. 

  240.     <span class="Identifier">echo</span> <span class="StringLit">&quot;command: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;: &quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">value</span>
    241. 

  241.   <span class="Keyword">of</span> <span class="Identifier">cfgError</span><span class="Punctuation">:</span>
    242. 

  242.     <span class="Identifier">echo</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">msg</span>
    243. 

  243. <span class="Identifier">close</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></pre>
    244. 

  244. <h2><a class="toc-backref" id="configuration-file-example" href="#configuration-file-example">Configuration file example</a></h2><pre class="listing">charset = &quot;utf-8&quot;
    245. 

  245. [Package]
    246. 

  246. name = &quot;hello&quot;
    247. 

  247. --threads:on
    248. 

  248. [Author]
    249. 

  249. name = &quot;nim-lang&quot;
    250. 

  250. website = &quot;nim-lang.org&quot;</pre>
    251. 

  251. <h2><a class="toc-backref" id="creating-a-configuration-file" href="#creating-a-configuration-file">Creating a configuration file</a></h2>
    252. 

  252. <p><strong class="examples_text">Example:</strong></p>
    253. 

  253. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecfg</span>
    254. 

  254. <span class="Keyword">var</span> <span class="Identifier">dict</span> <span class="Operator">=</span> <span class="Identifier">newConfig</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    255. 

  255. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">setSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span><span class="StringLit">&quot;charset&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;utf-8&quot;</span><span class="Punctuation">)</span>
    256. 

  256. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">setSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;Package&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;hello&quot;</span><span class="Punctuation">)</span>
    257. 

  257. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">setSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;Package&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;--threads&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;on&quot;</span><span class="Punctuation">)</span>
    258. 

  258. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">setSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;Author&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nim-lang&quot;</span><span class="Punctuation">)</span>
    259. 

  259. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">setSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;Author&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;website&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nim-lang.org&quot;</span><span class="Punctuation">)</span>
    260. 

  260. <span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">dict</span> <span class="Operator">==</span> <span class="LongStringLit">&quot;&quot;&quot;
    261. 

  261. charset=utf-8
    262. 

  262. [Package]
    263. 

  263. name=hello
    264. 

  264. --threads:on
    265. 

  265. [Author]
    266. 

  266. name=nim-lang
    267. 

  267. website=nim-lang.org
    268. 

  268. &quot;&quot;&quot;</span></pre>
    269. 

  269. <h2><a class="toc-backref" id="reading-a-configuration-file" href="#reading-a-configuration-file">Reading a configuration file</a></h2>
    270. 

  270. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    271. 

  271. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecfg</span>
    272. 

  272. <span class="Keyword">let</span> <span class="Identifier">dict</span> <span class="Operator">=</span> <span class="Identifier">loadConfig</span><span class="Punctuation">(</span><span class="StringLit">&quot;config.ini&quot;</span><span class="Punctuation">)</span>
    273. 

  273. <span class="Keyword">let</span> <span class="Identifier">charset</span> <span class="Operator">=</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span><span class="StringLit">&quot;charset&quot;</span><span class="Punctuation">)</span>
    274. 

  274. <span class="Keyword">let</span> <span class="Identifier">threads</span> <span class="Operator">=</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="StringLit">&quot;Package&quot;</span><span class="Punctuation">,</span><span class="StringLit">&quot;--threads&quot;</span><span class="Punctuation">)</span>
    275. 

  275. <span class="Keyword">let</span> <span class="Identifier">pname</span> <span class="Operator">=</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="StringLit">&quot;Package&quot;</span><span class="Punctuation">,</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">)</span>
    276. 

  276. <span class="Keyword">let</span> <span class="Identifier">name</span> <span class="Operator">=</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="StringLit">&quot;Author&quot;</span><span class="Punctuation">,</span><span class="StringLit">&quot;name&quot;</span><span class="Punctuation">)</span>
    277. 

  277. <span class="Keyword">let</span> <span class="Identifier">website</span> <span class="Operator">=</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="StringLit">&quot;Author&quot;</span><span class="Punctuation">,</span><span class="StringLit">&quot;website&quot;</span><span class="Punctuation">)</span>
    278. 

  278. <span class="Identifier">echo</span> <span class="Identifier">pname</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">name</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;</span><span class="EscapeSequence">\n</span><span class="StringLit">&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">website</span></pre>
    279. 

  279. <h2><a class="toc-backref" id="modifying-a-configuration-file" href="#modifying-a-configuration-file">Modifying a configuration file</a></h2>
    280. 

  280. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    281. 

  281. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecfg</span>
    282. 

  282. <span class="Keyword">var</span> <span class="Identifier">dict</span> <span class="Operator">=</span> <span class="Identifier">loadConfig</span><span class="Punctuation">(</span><span class="StringLit">&quot;config.ini&quot;</span><span class="Punctuation">)</span>
    283. 

  283. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">setSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;Author&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;name&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nim-lang&quot;</span><span class="Punctuation">)</span>
    284. 

  284. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">writeConfig</span><span class="Punctuation">(</span><span class="StringLit">&quot;config.ini&quot;</span><span class="Punctuation">)</span></pre>
    285. 

  285. <h2><a class="toc-backref" id="deleting-a-section-key-in-a-configuration-file" href="#deleting-a-section-key-in-a-configuration-file">Deleting a section key in a configuration file</a></h2>
    286. 

  286. <p><strong class="examples_text">Example: cmd: -r:off</strong></p>
    287. 

  287. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecfg</span>
    288. 

  288. <span class="Keyword">var</span> <span class="Identifier">dict</span> <span class="Operator">=</span> <span class="Identifier">loadConfig</span><span class="Punctuation">(</span><span class="StringLit">&quot;config.ini&quot;</span><span class="Punctuation">)</span>
    289. 

  289. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">delSectionKey</span><span class="Punctuation">(</span><span class="StringLit">&quot;Author&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;website&quot;</span><span class="Punctuation">)</span>
    290. 

  290. <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">writeConfig</span><span class="Punctuation">(</span><span class="StringLit">&quot;config.ini&quot;</span><span class="Punctuation">)</span></pre>
    291. 

  291. <h2><a class="toc-backref" id="supported-ini-file-structure" href="#supported-ini-file-structure">Supported INI File structure</a></h2>
    292. 

  292. <p><strong class="examples_text">Example:</strong></p>
    293. 

  293. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parsecfg</span>
    294. 

  294. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">streams</span>
    295. 

  295. 

  296. <span class="Keyword">var</span> <span class="Identifier">dict</span> <span class="Operator">=</span> <span class="Identifier">loadConfig</span><span class="Punctuation">(</span><span class="Identifier">newStringStream</span><span class="Punctuation">(</span><span class="LongStringLit">&quot;&quot;&quot;[Simple Values]
    297. 

  297.     key=value
    298. 

  298.     spaces in keys=allowed
    299. 

  299.     spaces in values=allowed as well
    300. 

  300.     spaces around the delimiter = obviously
    301. 

  301.     you can also use : to delimit keys from values
    302. 

  302.     [All Values Are Strings]
    303. 

  303.     values like this: 19990429
    304. 

  304.     or this: 3.14159265359
    305. 

  305.     are they treated as numbers : no
    306. 

  306.     integers floats and booleans are held as: strings
    307. 

  307.     can use the API to get converted values directly: true
    308. 

  308.     [No Values]
    309. 

  309.     key_without_value
    310. 

  310.     # empty string value is not allowed =
    311. 

  311.     [ Seletion A   ]
    312. 

  312.     space around section name will be ignored
    313. 

  313.     [You can use comments]
    314. 

  314.     # like this
    315. 

  315.     ; or this
    316. 

  316.     # By default only in an empty line.
    317. 

  317.     # Inline comments can be harmful because they prevent users
    318. 

  318.     # from using the delimiting characters as parts of values.
    319. 

  319.     # That being said, this can be customized.
    320. 

  320.         [Sections Can Be Indented]
    321. 

  321.             can_values_be_as_well = True
    322. 

  322.             does_that_mean_anything_special = False
    323. 

  323.             purpose = formatting for readability
    324. 

  324.             # Did I mention we can indent comments, too?
    325. 

  325.     &quot;&quot;&quot;</span><span class="Punctuation">)</span>
    326. 

  326. <span class="Punctuation">)</span>
    327. 

  327. 

  328. <span class="Keyword">let</span> <span class="Identifier">section1</span> <span class="Operator">=</span> <span class="StringLit">&quot;Simple Values&quot;</span>
    329. 

  329. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;key&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;value&quot;</span>
    330. 

  330. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;spaces in keys&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;allowed&quot;</span>
    331. 

  331. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;spaces in values&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;allowed as well&quot;</span>
    332. 

  332. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;spaces around the delimiter&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;obviously&quot;</span>
    333. 

  333. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;you can also use&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;to delimit keys from values&quot;</span>
    334. 

  334. 

  335. <span class="Keyword">let</span> <span class="Identifier">section2</span> <span class="Operator">=</span> <span class="StringLit">&quot;All Values Are Strings&quot;</span>
    336. 

  336. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section2</span><span class="Punctuation">,</span> <span class="StringLit">&quot;values like this&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;19990429&quot;</span>
    337. 

  337. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section2</span><span class="Punctuation">,</span> <span class="StringLit">&quot;or this&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;3.14159265359&quot;</span>
    338. 

  338. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section2</span><span class="Punctuation">,</span> <span class="StringLit">&quot;are they treated as numbers&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;no&quot;</span>
    339. 

  339. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section2</span><span class="Punctuation">,</span> <span class="StringLit">&quot;integers floats and booleans are held as&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;strings&quot;</span>
    340. 

  340. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section2</span><span class="Punctuation">,</span> <span class="StringLit">&quot;can use the API to get converted values directly&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;true&quot;</span>
    341. 

  341. 

  342. <span class="Keyword">let</span> <span class="Identifier">section3</span> <span class="Operator">=</span> <span class="StringLit">&quot;Seletion A&quot;</span>
    343. 

  343. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section3</span><span class="Punctuation">,</span> 
    344. 

  344.   <span class="StringLit">&quot;space around section name will be ignored&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;not an empty value&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
    345. 

  345. 

  346. <span class="Keyword">let</span> <span class="Identifier">section4</span> <span class="Operator">=</span> <span class="StringLit">&quot;Sections Can Be Indented&quot;</span>
    347. 

  347. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section4</span><span class="Punctuation">,</span> <span class="StringLit">&quot;can_values_be_as_well&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;True&quot;</span>
    348. 

  348. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section4</span><span class="Punctuation">,</span> <span class="StringLit">&quot;does_that_mean_anything_special&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;False&quot;</span>
    349. 

  349. <span class="Identifier">assert</span> <span class="Identifier">dict</span><span class="Operator">.</span><span class="Identifier">getSectionValue</span><span class="Punctuation">(</span><span class="Identifier">section4</span><span class="Punctuation">,</span> <span class="StringLit">&quot;purpose&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;formatting for readability&quot;</span></pre></p>
    350. 

  350.     <div class="section" id="6">
    351. 

  351.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    352. 

  352.   <dl class="item">
    353. 

  353.     <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="lexbase.html">lexbase</a>, <a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="decode_helpers.html">decode_helpers</a>, <a class="reference external" href="since.html">since</a>, <a class="reference external" href="syncio.html">syncio</a>
    354. 

  354.   </dl>
    355. 

  355. </div>
    356. 

  356. <div class="section" id="7">
    357. 

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

  358.   <dl class="item">
    359. 

  359.     <div id="CfgEvent">
    360. 

  360.   <dt><pre><a href="parsecfg.html#CfgEvent"><span class="Identifier">CfgEvent</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a>
    361. 

  361.   <span class="Keyword">case</span> <span class="Identifier">kind</span><span class="Operator">*</span><span class="Other">:</span> <a href="parsecfg.html#CfgEventKind"><span class="Identifier">CfgEventKind</span></a>   <span class="Comment">## the kind of the event</span>
    362. 

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

  363.     <span class="Keyword">nil</span>
    364. 

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

  365.     <span class="Identifier">section</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>         <span class="Comment">## `section` contains the name of the</span>
    366. 

  366.                              <span class="Comment">## parsed section start (syntax: `[section]`)</span>
    367. 

  367.   <span class="Keyword">of</span> <span class="Identifier">cfgKeyValuePair</span><span class="Other">,</span> <span class="Identifier">cfgOption</span><span class="Other">:</span>
    368. 

  368.     <span class="Identifier">key</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>     <span class="Comment">## contains the (key, value) pair if an option</span>
    369. 

  369.                              <span class="Comment">## of the form `--key: value` or an ordinary</span>
    370. 

  370.                              <span class="Comment">## `key= value` pair has been parsed.</span>
    371. 

  371.                              <span class="Comment">## `value==&quot;&quot;` if it was not specified in the</span>
    372. 

  372.                              <span class="Comment">## configuration file.</span>
    373. 

  373.   <span class="Keyword">of</span> <span class="Identifier">cfgError</span><span class="Other">:</span>              <span class="Comment">## the parser encountered an error: `msg`</span>
    374. 

  374.     <span class="Identifier">msg</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>             <span class="Comment">## contains the error message. No exceptions</span>
    375. 

  375.                              <span class="Comment">## are thrown if a parse error occurs.</span></pre></dt>
    376. 

  376.   <dd>
    377. 

  377.     
    378. 

  378.     describes a parsing event
    379. 

  379.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L191" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    380. 

  380. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L191" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    381. 

  381. 

  382.   </dd>
    383. 

  383. </div>
    384. 

  384. <div id="CfgEventKind">
    385. 

  385.   <dt><pre><a href="parsecfg.html#CfgEventKind"><span class="Identifier">CfgEventKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    386. 

  386.   <span class="Identifier">cfgEof</span><span class="Other">,</span>                   <span class="Comment">## end of file reached</span>
    387. 

  387.   <span class="Identifier">cfgSectionStart</span><span class="Other">,</span>          <span class="Comment">## a `[section]` has been parsed</span>
    388. 

  388.   <span class="Identifier">cfgKeyValuePair</span><span class="Other">,</span>          <span class="Comment">## a `key=value` pair has been detected</span>
    389. 

  389.   <span class="Identifier">cfgOption</span><span class="Other">,</span>                <span class="Comment">## a `--key=value` command line option</span>
    390. 

  390.   <span class="Identifier">cfgError</span>                   <span class="Comment">## an error occurred during parsing</span></pre></dt>
    391. 

  391.   <dd>
    392. 

  392.     
    393. 

  393.     enumeration of all events that may occur when parsing
    394. 

  394.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L184" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    395. 

  395. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L184" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    396. 

  396. 

  397.   </dd>
    398. 

  398. </div>
    399. 

  399. <div id="CfgParser">
    400. 

  400.   <dt><pre><a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="lexbase.html#BaseLexer"><span class="Identifier">BaseLexer</span></a></pre></dt>
    401. 

  401.   <dd>
    402. 

  402.     
    403. 

  403.     the parser object.
    404. 

  404.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L214" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    405. 

  405. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L214" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    406. 

  406. 

  407.   </dd>
    408. 

  408. </div>
    409. 

  409. <div id="Config">
    410. 

  410.   <dt><pre><a href="parsecfg.html#Config"><span class="Identifier">Config</span></a> <span class="Other">=</span> <a href="tables.html#OrderedTableRef"><span class="Identifier">OrderedTableRef</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="tables.html#OrderedTableRef"><span class="Identifier">OrderedTableRef</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">]</span></pre></dt>
    411. 

  411.   <dd>
    412. 

  412.     
    413. 

  413.     
    414. 

  414.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L501" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    415. 

  415. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L501" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    416. 

  416. 

  417.   </dd>
    418. 

  418. </div>
    419. 

  419. 

  420.   </dl>
    421. 

  421. </div>
    422. 

  422. <div class="section" id="12">
    423. 

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

  424.   <dl class="item">
    425. 

  425.     <div id="$-procs-all">
    426. 

  426.   <div id="$,Config">
    427. 

  427.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CConfig"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    428. 

  428.                                  <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>
    429. 

  429.   <dd>
    430. 

  430.     
    431. 

  431.     Writes the contents of the table to string.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    432. 

  432. Comment statement will be ignored.</div>
    433. 

  433. 

  434.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L606" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    435. 

  435. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L606" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    436. 

  436. 

  437.   </dd>
    438. 

  438. </div>
    439. 

  439. 

  440. </div>
    441. 

  441. <div id="close-procs-all">
    442. 

  442.   <div id="close,CfgParser">
    443. 

  443.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CCfgParser"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span>
    444. 

  444.                                <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>
    445. 

  445.                                <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>
    446. 

  446.   <dd>
    447. 

  447.     
    448. 

  448.     Closes the parser <tt class="docutils literal"><span class="pre"><span class="Identifier">c</span></span></tt> and its associated input stream.
    449. 

  449.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L237" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    450. 

  450. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L237" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    451. 

  451. 

  452.   </dd>
    453. 

  453. </div>
    454. 

  454. 

  455. </div>
    456. 

  456. <div id="delSection-procs-all">
    457. 

  457.   <div id="delSection,Config,string">
    458. 

  458.   <dt><pre><span class="Keyword">proc</span> <a href="#delSection%2CConfig%2Cstring"><span class="Identifier">delSection</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">;</span> <span class="Identifier">section</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</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>
    459. 

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

  460.   <dd>
    461. 

  461.     
    462. 

  462.     Deletes the specified section and all of its sub keys.
    463. 

  463.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L643" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    464. 

  464. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L643" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    465. 

  465. 

  466.   </dd>
    467. 

  467. </div>
    468. 

  468. 

  469. </div>
    470. 

  470. <div id="delSectionKey-procs-all">
    471. 

  471.   <div id="delSectionKey,Config,string,string">
    472. 

  472.   <dt><pre><span class="Keyword">proc</span> <a href="#delSectionKey%2CConfig%2Cstring%2Cstring"><span class="Identifier">delSectionKey</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">;</span> <span class="Identifier">section</span><span class="Other">,</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    473. 

  473.     <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>
    474. 

  474.   <dd>
    475. 

  475.     
    476. 

  476.     Deletes the key of the specified section.
    477. 

  477.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L647" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    478. 

  478. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L647" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    479. 

  479. 

  480.   </dd>
    481. 

  481. </div>
    482. 

  482. 

  483. </div>
    484. 

  484. <div id="errorStr-procs-all">
    485. 

  485.   <div id="errorStr,CfgParser,string">
    486. 

  486.   <dt><pre><span class="Keyword">proc</span> <a href="#errorStr%2CCfgParser%2Cstring"><span class="Identifier">errorStr</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span>
    487. 

  487.     <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>
    488. 

  488.   <dd>
    489. 

  489.     
    490. 

  490.     Returns a properly formatted error message containing current line and column information.
    491. 

  491.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L428" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    492. 

  492. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L428" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    493. 

  493. 

  494.   </dd>
    495. 

  495. </div>
    496. 

  496. 

  497. </div>
    498. 

  498. <div id="getColumn-procs-all">
    499. 

  499.   <div id="getColumn,CfgParser">
    500. 

  500.   <dt><pre><span class="Keyword">proc</span> <a href="#getColumn%2CCfgParser"><span class="Identifier">getColumn</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    501. 

  501.                                     <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>
    502. 

  502.   <dd>
    503. 

  503.     
    504. 

  504.     Gets the current column the parser has arrived at.
    505. 

  505.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L241" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    506. 

  506. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L241" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    507. 

  507. 

  508.   </dd>
    509. 

  509. </div>
    510. 

  510. 

  511. </div>
    512. 

  512. <div id="getFilename-procs-all">
    513. 

  513.   <div id="getFilename,CfgParser">
    514. 

  514.   <dt><pre><span class="Keyword">proc</span> <a href="#getFilename%2CCfgParser"><span class="Identifier">getFilename</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    515. 

  515.     <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>
    516. 

  516.   <dd>
    517. 

  517.     
    518. 

  518.     Gets the filename of the file that the parser processes.
    519. 

  519.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L249" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    520. 

  520. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L249" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    521. 

  521. 

  522.   </dd>
    523. 

  523. </div>
    524. 

  524. 

  525. </div>
    526. 

  526. <div id="getLine-procs-all">
    527. 

  527.   <div id="getLine,CfgParser">
    528. 

  528.   <dt><pre><span class="Keyword">proc</span> <a href="#getLine%2CCfgParser"><span class="Identifier">getLine</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span> <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>
    529. 

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

  530.   <dd>
    531. 

  531.     
    532. 

  532.     Gets the current line the parser has arrived at.
    533. 

  533.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L245" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    534. 

  534. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L245" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    535. 

  535. 

  536.   </dd>
    537. 

  537. </div>
    538. 

  538. 

  539. </div>
    540. 

  540. <div id="getSectionValue-procs-all">
    541. 

  541.   <div id="getSectionValue,Config,string,string,string">
    542. 

  542.   <dt><pre><span class="Keyword">proc</span> <a href="#getSectionValue%2CConfig%2Cstring%2Cstring%2Cstring"><span class="Identifier">getSectionValue</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">;</span> <span class="Identifier">section</span><span class="Other">,</span> <span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">defaultVal</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    543. 

  543.     <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">KeyError</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>
    544. 

  544.   <dd>
    545. 

  545.     
    546. 

  546.     Gets the key value of the specified Section. Returns the specified default value if the specified key does not exist.
    547. 

  547.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L624" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    548. 

  548. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L624" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    549. 

  549. 

  550.   </dd>
    551. 

  551. </div>
    552. 

  552. 

  553. </div>
    554. 

  554. <div id="ignoreMsg-procs-all">
    555. 

  555.   <div id="ignoreMsg,CfgParser,CfgEvent">
    556. 

  556.   <dt><pre><span class="Keyword">proc</span> <a href="#ignoreMsg%2CCfgParser%2CCfgEvent"><span class="Identifier">ignoreMsg</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">;</span> <span class="Identifier">e</span><span class="Other">:</span> <a href="parsecfg.html#CfgEvent"><span class="Identifier">CfgEvent</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span>
    557. 

  557.     <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>
    558. 

  558.   <dd>
    559. 

  559.     
    560. 

  560.     Returns a properly formatted warning message containing that an entry is ignored.
    561. 

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

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

  563. 

  564.   </dd>
    565. 

  565. </div>
    566. 

  566. 

  567. </div>
    568. 

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

  569.   <div id="loadConfig,string">
    570. 

  570.   <dt><pre><span class="Keyword">proc</span> <a href="#loadConfig%2Cstring"><span class="Identifier">loadConfig</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a> {.
    571. 

  571.     <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">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    572. 

  572.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</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>
    573. 

  573.   <dd>
    574. 

  574.     
    575. 

  575.     Loads the specified configuration file into a new Config instance.
    576. 

  576.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L541" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    577. 

  577. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L541" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    578. 

  578. 

  579.   </dd>
    580. 

  580. </div>
    581. 

  581. <div id="loadConfig,Stream,string">
    582. 

  582.   <dt><pre><span class="Keyword">proc</span> <a href="#loadConfig%2CStream%2Cstring"><span class="Identifier">loadConfig</span></a><span class="Other">(</span><span class="Identifier">stream</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">&quot;[stream]&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a> {.
    583. 

  583.     <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">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    584. 

  584.     <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">RootEffect</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>
    585. 

  585.   <dd>
    586. 

  586.     
    587. 

  587.     Loads the specified configuration from stream into a new Config instance. <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> parameter is only used for nicer error messages.
    588. 

  588.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L508" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    589. 

  589. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L508" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    590. 

  590. 

  591.   </dd>
    592. 

  592. </div>
    593. 

  593. 

  594. </div>
    595. 

  595. <div id="newConfig-procs-all">
    596. 

  596.   <div id="newConfig">
    597. 

  597.   <dt><pre><span class="Keyword">proc</span> <a href="#newConfig"><span class="Identifier">newConfig</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</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>
    598. 

  598.   <dd>
    599. 

  599.     
    600. 

  600.     Creates a new configuration table. Useful when wanting to create a configuration file.
    601. 

  601.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L503" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    602. 

  602. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L503" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    603. 

  603. 

  604.   </dd>
    605. 

  605. </div>
    606. 

  606. 

  607. </div>
    608. 

  608. <div id="next-procs-all">
    609. 

  609.   <div id="next,CfgParser">
    610. 

  610.   <dt><pre><span class="Keyword">proc</span> <a href="#next%2CCfgParser"><span class="Identifier">next</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="parsecfg.html#CfgEvent"><span class="Identifier">CfgEvent</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span>
    611. 

  611.                                         <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="Other">,</span>
    612. 

  612.                                         <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>
    613. 

  613.   <dd>
    614. 

  614.     
    615. 

  615.     Retrieves the first/next event. This controls the parser.
    616. 

  616.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L471" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    617. 

  617. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L471" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    618. 

  618. 

  619.   </dd>
    620. 

  620. </div>
    621. 

  621. 

  622. </div>
    623. 

  623. <div id="open-procs-all">
    624. 

  624.   <div id="open,CfgParser,Stream,string,int">
    625. 

  625.   <dt><pre><span class="Keyword">proc</span> <a href="#open%2CCfgParser%2CStream%2Cstring%2Cint"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">;</span> <span class="Identifier">input</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">lineOffset</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span> {.
    626. 

  626.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span> <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">Exception</span><span class="Other">]</span><span class="Other">,</span>
    627. 

  627.     <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">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>
    628. 

  628.   <dd>
    629. 

  629.     
    630. 

  630.     Initializes the parser with an input stream. <tt class="docutils literal"><span class="pre"><span class="Identifier">Filename</span></span></tt> is only used for nice error messages. <tt class="docutils literal"><span class="pre"><span class="Identifier">lineOffset</span></span></tt> can be used to influence the line number information in the generated error messages.
    631. 

  631.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L225" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    632. 

  632. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L225" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    633. 

  633. 

  634.   </dd>
    635. 

  635. </div>
    636. 

  636. 

  637. </div>
    638. 

  638. <div id="setSectionKey-procs-all">
    639. 

  639.   <div id="setSectionKey,Config,string,string,string">
    640. 

  640.   <dt><pre><span class="Keyword">proc</span> <a href="#setSectionKey%2CConfig%2Cstring%2Cstring%2Cstring"><span class="Identifier">setSectionKey</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">;</span> <span class="Identifier">section</span><span class="Other">,</span> <span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    641. 

  641.     <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">KeyError</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>
    642. 

  642.   <dd>
    643. 

  643.     
    644. 

  644.     Sets the Key value of the specified Section.
    645. 

  645.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L635" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    646. 

  646. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L635" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    647. 

  647. 

  648.   </dd>
    649. 

  649. </div>
    650. 

  650. 

  651. </div>
    652. 

  652. <div id="warningStr-procs-all">
    653. 

  653.   <div id="warningStr,CfgParser,string">
    654. 

  654.   <dt><pre><span class="Keyword">proc</span> <a href="#warningStr%2CCfgParser%2Cstring"><span class="Identifier">warningStr</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="parsecfg.html#CfgParser"><span class="Identifier">CfgParser</span></a><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npc$1&quot;</span><span class="Other">,</span>
    655. 

  655.     <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>
    656. 

  656.   <dd>
    657. 

  657.     
    658. 

  658.     Returns a properly formatted warning message containing current line and column information.
    659. 

  659.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L434" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    660. 

  660. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L434" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    661. 

  661. 

  662.   </dd>
    663. 

  663. </div>
    664. 

  664. 

  665. </div>
    666. 

  666. <div id="writeConfig-procs-all">
    667. 

  667.   <div id="writeConfig,Config,string">
    668. 

  668.   <dt><pre><span class="Keyword">proc</span> <a href="#writeConfig%2CConfig%2Cstring"><span class="Identifier">writeConfig</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    669. 

  669.     <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>
    670. 

  670.   <dd>
    671. 

  671.     
    672. 

  672.     Writes the contents of the table to the specified configuration file.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    673. 

  673. Comment statement will be ignored.</div>
    674. 

  674. 

  675.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L615" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    676. 

  676. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L615" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    677. 

  677. 

  678.   </dd>
    679. 

  679. </div>
    680. 

  680. <div id="writeConfig,Config,Stream">
    681. 

  681.   <dt><pre><span class="Keyword">proc</span> <a href="#writeConfig%2CConfig%2CStream"><span class="Identifier">writeConfig</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">;</span> <span class="Identifier">stream</span><span class="Other">:</span> <a href="streams.html#Stream"><span class="Identifier">Stream</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    682. 

  682.     <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>
    683. 

  683.   <dd>
    684. 

  684.     
    685. 

  685.     Writes the contents of the table to the specified stream.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    686. 

  686. Comment statement will be ignored.</div>
    687. 

  687. 

  688.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parsecfg.nim#L566" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    689. 

  689. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parsecfg.nim#L566" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    690. 

  690. 

  691.   </dd>
    692. 

  692. </div>
    693. 

  693. 

  694. </div>
    695. 

  695. 

  696.   </dl>
    697. 

  697. </div>
    698. 

  698. <div class="section" id="15">
    699. 

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

  700.   <dl class="item">
    701. 

  701.     <div id="sections-iterators-all">
    702. 

  702.   <div id="sections.i,Config">
    703. 

  703.   <dt><pre><span class="Keyword">iterator</span> <a href="#sections.i%2CConfig"><span class="Identifier">sections</span></a><span class="Other">(</span><span class="Identifier">dict</span><span class="Other">:</span> <a href="parsecfg.html#Config"><span class="Identifier">Config</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#lent"><span class="Identifier">lent</span></a> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    704. 

  704.   <dd>
    705. 

  705.     
    706. 

  706.     Iterates through the sections in the <tt class="docutils literal"><span class="pre"><span class="Identifier">dict</span></span></tt>.
    707. 

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

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

  709. 

  710.   </dd>
    711. 

  711. </div>
    712. 

  712. 

  713. </div>
    714. 

  714. 

  715.   </dl>
    716. 

  716. </div>
    717. 

  717. 

  718.   </div>
    719. 

  719. </div>
    720. 

  720. 

  721.       <div class="twelve-columns footer">
    722. 

  722.         <span class="nim-sprite"></span>
    723. 

  723.         <br>
    724. 

  724.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:06 UTC</small>
    725. 

  725.       </div>
    726. 

  726.     </div>
    727. 

  727.   </div>
    728. 

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

  729.     
    730. 

  730. </body>
    731. 

  731. </html>
    732. 

  732.