Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
levovix
/
Nim
zrkadlo https://github.com/nim-lang/Nim
Pridať medzi pozorované 1
Hviezda 0
Fork 1
Súbory Issues 0 Wiki
Branch: gh-pages
Branche Tagy
Nim
/
parseopt.html

parseopt.html 65 KB
Permanentný odkaz História Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509 
  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/parseopt</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/parseopt</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li><a class="reference" id="supported-syntax_toc" href="#supported-syntax">Supported Syntax</a></li>
    55. 

  55. <li><a class="reference" id="parsing_toc" href="#parsing">Parsing</a></li>
    56. 

  56. <li><a class="reference" id="nimshortnoval-and-nimlongnoval_toc" href="#nimshortnoval-and-nimlongnoval"><tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt></a></li>
    57. 

  57. <li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
    58. 

  58. <li>
    59. 

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

  60. </li>
    61. 

  61. <li>
    62. 

  62.   <details open>
    63. 

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

  64.     <ul class="simple simple-toc-section">
    65. 

  65.       <li><a class="reference" href="#CmdLineKind" title="CmdLineKind = enum
    66. 

  66.   cmdEnd,                   ## End of command line reached
    67. 

  67.   cmdArgument,              ## An argument such as a filename
    68. 

  68.   cmdLongOption,            ## A long option such as --option
    69. 

  69.   cmdShortOption             ## A short option such as -c">CmdLineKind</a></li>
    70. 

  70. <li><a class="reference" href="#OptParser" title="OptParser = object of RootObj
    71. 

  71.   kind*: CmdLineKind         ## The detected command line token
    72. 

  72.   key*, val*: string         ## Key and value pair; the key is the option
    73. 

  73.                              ## or the argument, and the value is not &quot;&quot; if
    74. 

  74.                              ## the option was given a value">OptParser</a></li>
    75. 

  75. 

  76.     </ul>
    77. 

  77.   </details>
    78. 

  78. </li>
    79. 

  79. <li>
    80. 

  80.   <details open>
    81. 

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

  82.     <ul class="simple simple-toc-section">
    83. 

  83.       <ul class="simple nested-toc-section">cmdLineRest
    84. 

  84.   <li><a class="reference" href="#cmdLineRest%2COptParser" title="cmdLineRest(p: OptParser): string">cmdLineRest(p: OptParser): string</a></li>
    85. 

  85. 

  86. </ul>
    87. 

  87. <ul class="simple nested-toc-section">initOptParser
    88. 

  88.   <li><a class="reference" href="#initOptParser%2Cstring%2Cset%5Bchar%5D%2Cseq%5Bstring%5D" title="initOptParser(cmdline = &quot;&quot;; shortNoVal: set[char] = {};
    89. 

  89.               longNoVal: seq[string] = @[]; allowWhitespaceAfterColon = true): OptParser">initOptParser(cmdline = &quot;&quot;; shortNoVal: set[char] = {};
    90. 

  90.               longNoVal: seq[string] = @[]; allowWhitespaceAfterColon = true): OptParser</a></li>
    91. 

  91. <li><a class="reference" href="#initOptParser%2Cseq%5Bstring%5D%2Cset%5Bchar%5D%2Cseq%5Bstring%5D" title="initOptParser(cmdline: seq[string]; shortNoVal: set[char] = {};
    92. 

  92.               longNoVal: seq[string] = @[]; allowWhitespaceAfterColon = true): OptParser">initOptParser(cmdline: seq[string]; shortNoVal: set[char] = {};
    93. 

  93.               longNoVal: seq[string] = @[]; allowWhitespaceAfterColon = true): OptParser</a></li>
    94. 

  94. 

  95. </ul>
    96. 

  96. <ul class="simple nested-toc-section">next
    97. 

  97.   <li><a class="reference" href="#next%2COptParser" title="next(p: var OptParser)">next(p: var OptParser)</a></li>
    98. 

  98. 

  99. </ul>
    100. 

  100. <ul class="simple nested-toc-section">remainingArgs
    101. 

  101.   <li><a class="reference" href="#remainingArgs%2COptParser" title="remainingArgs(p: OptParser): seq[string]">remainingArgs(p: OptParser): seq[string]</a></li>
    102. 

  102. 

  103. </ul>
    104. 

  104. 

  105.     </ul>
    106. 

  106.   </details>
    107. 

  107. </li>
    108. 

  108. <li>
    109. 

  109.   <details open>
    110. 

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

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

  112.       <ul class="simple nested-toc-section">getopt
    113. 

  113.   <li><a class="reference" href="#getopt.i%2Cseq%5Bstring%5D%2Cset%5Bchar%5D%2Cseq%5Bstring%5D" title="getopt(cmdline: seq[string] = @[]; shortNoVal: set[char] = {};
    114. 

  114.        longNoVal: seq[string] = @[]): tuple[kind: CmdLineKind, key, val: string]">getopt(cmdline: seq[string] = @[]; shortNoVal: set[char] = {};
    115. 

  115.        longNoVal: seq[string] = @[]): tuple[kind: CmdLineKind, key, val: string]</a></li>
    116. 

  116. <li><a class="reference" href="#getopt.i%2COptParser" title="getopt(p: var OptParser): tuple[kind: CmdLineKind, key, val: string]">getopt(p: var OptParser): tuple[kind: CmdLineKind, key, val: string]</a></li>
    117. 

  117. 

  118. </ul>
    119. 

  119. 

  120.     </ul>
    121. 

  121.   </details>
    122. 

  122. </li>
    123. 

  123. 

  124. </ul>
    125. 

  125. 

  126.   </div>
    127. 

  127.   <div class="nine columns" id="content">
    128. 

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

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

  130. 

  131.     <div id="tocRoot"></div>
    132. 

  132.     
    133. 

  133.     <p class="module-desc">This module provides the standard Nim command line parser. It supports one convenience iterator over all command line options and some lower-level features.
    134. 

  134. <h1><a class="toc-backref" id="supported-syntax" href="#supported-syntax">Supported Syntax</a></h1><p>The following syntax is supported when arguments for the <tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt> parameters, which are <a class="reference external" href="#nimshortnoval-and-nimlongnoval">described later</a>, are not provided:</p>
    135. 

  135. <ol class="simple"><li>Short options: <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">abcd</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">e</span><span class="Punctuation">:</span><span class="DecNumber">5</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">e</span><span class="Operator">=</span><span class="DecNumber">5</span></span></tt></li>
    136. 

  136. <li>Long options: <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">foo</span><span class="Punctuation">:</span><span class="Identifier">bar</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">foo</span><span class="Operator">=</span><span class="Identifier">bar</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">foo</span></span></tt></li>
    137. 

  137. <li>Arguments: everything that does not start with a <tt class="docutils literal"><span class="pre"><span class="Operator">-</span></span></tt></li>
    138. 

  138. </ol>
    139. 

  139. <p>These three kinds of tokens are enumerated in the <a class="reference external" href="#CmdLineKind">CmdLineKind enum</a>.</p>
    140. 

  140. <p>When option values begin with ':' or '=', they need to be doubled up (as in <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">delim</span><span class="Punctuation">:</span><span class="Punctuation">:</span></span></tt>) or alternated (as in <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">delim</span><span class="Operator">=:</span></span></tt>).</p>
    141. 

  141. <p>The <tt class="docutils literal"><span class="pre"><span class="Operator">--</span></span></tt> option, commonly used to denote that every token that follows is an argument, is interpreted as a long option, and its name is the empty string.</p>
    142. 

  142. 

  143. <h1><a class="toc-backref" id="parsing" href="#parsing">Parsing</a></h1><p>Use an <a class="reference external" href="#OptParser">OptParser</a> to parse command line options. It can be created with <a class="reference external" href="#initOptParser,string,set[char],seq[string]">initOptParser</a>, and <a class="reference external" href="#next,OptParser">next</a> advances the parser by one token.</p>
    144. 

  144. <p>For each token, the parser's <tt class="docutils literal"><span class="pre"><span class="Identifier">kind</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>, and <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt> fields give information about that token. If the token is a long or short option, <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> is the option's name, and  <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt> is either the option's value, if provided, or the empty string. For arguments, the <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> field contains the argument itself, and <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt> is unused. To check if the end of the command line has been reached, check if <tt class="docutils literal"><span class="pre"><span class="Identifier">kind</span></span></tt> is equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdEnd</span></span></tt>.</p>
    145. 

  145. <p>Here is an example:</p>
    146. 

  146. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parseopt</span>
    147. 

  147. 

  148. <span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;-ab -e:5 --foo --bar=20 file.txt&quot;</span><span class="Punctuation">)</span>
    149. 

  149. <span class="Keyword">while</span> <span class="Identifier">true</span><span class="Punctuation">:</span>
    150. 

  150.   <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    151. 

  151.   <span class="Keyword">case</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span>
    152. 

  152.   <span class="Keyword">of</span> <span class="Identifier">cmdEnd</span><span class="Punctuation">:</span> <span class="Keyword">break</span>
    153. 

  153.   <span class="Keyword">of</span> <span class="Identifier">cmdShortOption</span><span class="Punctuation">,</span> <span class="Identifier">cmdLongOption</span><span class="Punctuation">:</span>
    154. 

  154.     <span class="Keyword">if</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">val</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">:</span>
    155. 

  155.       <span class="Identifier">echo</span> <span class="StringLit">&quot;Option: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span>
    156. 

  156.     <span class="Keyword">else</span><span class="Punctuation">:</span>
    157. 

  157.       <span class="Identifier">echo</span> <span class="StringLit">&quot;Option and value: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span><span class="Punctuation">,</span> <span class="StringLit">&quot;, &quot;</span><span class="Punctuation">,</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">val</span>
    158. 

  158.   <span class="Keyword">of</span> <span class="Identifier">cmdArgument</span><span class="Punctuation">:</span>
    159. 

  159.     <span class="Identifier">echo</span> <span class="StringLit">&quot;Argument: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span>
    160. 

  160. 

  161. <span class="Comment"># Output:</span>
    162. 

  162. <span class="Comment"># Option: a</span>
    163. 

  163. <span class="Comment"># Option: b</span>
    164. 

  164. <span class="Comment"># Option and value: e, 5</span>
    165. 

  165. <span class="Comment"># Option: foo</span>
    166. 

  166. <span class="Comment"># Option and value: bar, 20</span>
    167. 

  167. <span class="Comment"># Argument: file.txt</span></pre></p>
    168. 

  168. <p>The <a class="reference external" href="#getopt.i,OptParser">getopt iterator</a>, which is provided for convenience, can be used to iterate through all command line options as well.</p>
    169. 

  169. <p>To set a default value for a variable assigned through <tt class="docutils literal"><span class="pre"><span class="Identifier">getopt</span></span></tt> and accept arguments from the cmd line. Assign the default value to a variable before parsing. Then set the variable to the new value while parsing.</p>
    170. 

  170. <p>Here is an example:</p>
    171. 

  171. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parseopt</span>
    172. 

  172. 

  173. <span class="Keyword">var</span> <span class="Identifier">varName</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span> <span class="StringLit">&quot;defaultValue&quot;</span>
    174. 

  174. 

  175. <span class="Keyword">for</span> <span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span> <span class="Keyword">in</span> <span class="Identifier">getopt</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    176. 

  176.   <span class="Keyword">case</span> <span class="Identifier">kind</span>
    177. 

  177.   <span class="Keyword">of</span> <span class="Identifier">cmdArgument</span><span class="Punctuation">:</span>
    178. 

  178.     <span class="Keyword">discard</span>
    179. 

  179.   <span class="Keyword">of</span> <span class="Identifier">cmdLongOption</span><span class="Punctuation">,</span> <span class="Identifier">cmdShortOption</span><span class="Punctuation">:</span>
    180. 

  180.     <span class="Keyword">case</span> <span class="Identifier">key</span><span class="Punctuation">:</span>
    181. 

  181.     <span class="Keyword">of</span> <span class="StringLit">&quot;varName&quot;</span><span class="Punctuation">:</span> <span class="Comment"># --varName:&lt;value&gt; in the console when executing</span>
    182. 

  182.       <span class="Identifier">varName</span> <span class="Operator">=</span> <span class="Identifier">val</span> <span class="Comment"># do input sanitization in production systems</span>
    183. 

  183.   <span class="Keyword">of</span> <span class="Identifier">cmdEnd</span><span class="Punctuation">:</span>
    184. 

  184.     <span class="Keyword">discard</span></pre></p>
    185. 

  185. 

  186. <h1><a class="toc-backref" id="nimshortnoval-and-nimlongnoval" href="#nimshortnoval-and-nimlongnoval"><tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt></a></h1><p>The optional <tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt> parameters present in <a class="reference external" href="#initOptParser,string,set[char],seq[string]">initOptParser</a> are for specifying which short and long options do not accept values.</p>
    187. 

  187. <p>When <tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> is non-empty, users are not required to separate short options and their values with a ':' or '=' since the parser knows which options accept values and which ones do not. This behavior also applies for long options if <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt> is non-empty. For short options, <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">j4</span></span></tt> becomes supported syntax, and for long options, <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">foo</span> <span class="Identifier">bar</span></span></tt> becomes supported. This is in addition to the <a class="reference external" href="#supported-syntax">previously mentioned syntax</a>. Users can still separate options and their values with ':' or '=', but that becomes optional.</p>
    188. 

  188. <p>As more options which do not accept values are added to your program, remember to amend <tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt> accordingly.</p>
    189. 

  189. <p>The following example illustrates the difference between having an empty <tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt>, which is the default, and providing arguments for those two parameters:</p>
    190. 

  190. <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">parseopt</span>
    191. 

  191. 

  192. <span class="Keyword">proc</span> <span class="Identifier">printToken</span><span class="Punctuation">(</span><span class="Identifier">kind</span><span class="Punctuation">:</span> <span class="Identifier">CmdLineKind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">,</span> <span class="Identifier">val</span><span class="Punctuation">:</span> <span class="Identifier">string</span><span class="Punctuation">)</span> <span class="Operator">=</span>
    193. 

  193.   <span class="Keyword">case</span> <span class="Identifier">kind</span>
    194. 

  194.   <span class="Keyword">of</span> <span class="Identifier">cmdEnd</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">false</span><span class="Punctuation">)</span>  <span class="Comment"># Doesn't happen with getopt()</span>
    195. 

  195.   <span class="Keyword">of</span> <span class="Identifier">cmdShortOption</span><span class="Punctuation">,</span> <span class="Identifier">cmdLongOption</span><span class="Punctuation">:</span>
    196. 

  196.     <span class="Keyword">if</span> <span class="Identifier">val</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">:</span>
    197. 

  197.       <span class="Identifier">echo</span> <span class="StringLit">&quot;Option: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">key</span>
    198. 

  198.     <span class="Keyword">else</span><span class="Punctuation">:</span>
    199. 

  199.       <span class="Identifier">echo</span> <span class="StringLit">&quot;Option and value: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="StringLit">&quot;, &quot;</span><span class="Punctuation">,</span> <span class="Identifier">val</span>
    200. 

  200.   <span class="Keyword">of</span> <span class="Identifier">cmdArgument</span><span class="Punctuation">:</span>
    201. 

  201.     <span class="Identifier">echo</span> <span class="StringLit">&quot;Argument: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">key</span>
    202. 

  202. 

  203. <span class="Keyword">let</span> <span class="Identifier">cmdLine</span> <span class="Operator">=</span> <span class="StringLit">&quot;-j4 --first bar&quot;</span>
    204. 

  204. 

  205. <span class="Keyword">var</span> <span class="Identifier">emptyNoVal</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="Identifier">cmdLine</span><span class="Punctuation">)</span>
    206. 

  206. <span class="Keyword">for</span> <span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span> <span class="Keyword">in</span> <span class="Identifier">emptyNoVal</span><span class="Operator">.</span><span class="Identifier">getopt</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    207. 

  207.   <span class="Identifier">printToken</span><span class="Punctuation">(</span><span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span><span class="Punctuation">)</span>
    208. 

  208. 

  209. <span class="Comment"># Output:</span>
    210. 

  210. <span class="Comment"># Option: j</span>
    211. 

  211. <span class="Comment"># Option: 4</span>
    212. 

  212. <span class="Comment"># Option: first</span>
    213. 

  213. <span class="Comment"># Argument: bar</span>
    214. 

  214. 

  215. <span class="Keyword">var</span> <span class="Identifier">withNoVal</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="Identifier">cmdLine</span><span class="Punctuation">,</span> <span class="Identifier">shortNoVal</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">c</span><span class="CharLit">'},</span>
    216. 

  216.                               <span class="Identifier">longNoVal</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;second&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    217. 

  217. <span class="Keyword">for</span> <span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span> <span class="Keyword">in</span> <span class="Identifier">withNoVal</span><span class="Operator">.</span><span class="Identifier">getopt</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    218. 

  218.   <span class="Identifier">printToken</span><span class="Punctuation">(</span><span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span><span class="Punctuation">)</span>
    219. 

  219. 

  220. <span class="Comment"># Output:</span>
    221. 

  221. <span class="Comment"># Option and value: j, 4</span>
    222. 

  222. <span class="Comment"># Option and value: first, bar</span></pre></p>
    223. 

  223. 

  224. <h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="os.html">os module</a> for lower-level command line parsing procs</li>
    225. 

  225. <li><a class="reference external" href="parseutils.html">parseutils module</a> for helpers that parse tokens, numbers, identifiers, etc.</li>
    226. 

  226. <li><a class="reference external" href="strutils.html">strutils module</a> for common string handling operations</li>
    227. 

  227. <li><a class="reference external" href="json.html">json module</a> for a JSON parser</li>
    228. 

  228. <li><a class="reference external" href="parsecfg.html">parsecfg module</a> for a configuration file parser</li>
    229. 

  229. <li><a class="reference external" href="parsecsv.html">parsecsv module</a> for a simple CSV (comma separated value) parser</li>
    230. 

  230. <li><a class="reference external" href="parsexml.html">parsexml module</a> for a XML / HTML parser</li>
    231. 

  231. <li><a class="reference external" href="lib.html#pure-libraries-parsers">other parsers</a> for more parsers</li>
    232. 

  232. </ul>
    233. 

  233. </p>
    234. 

  234.     <div class="section" id="6">
    235. 

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

  236.   <dl class="item">
    237. 

  237.     <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="os.html">os</a>
    238. 

  238.   </dl>
    239. 

  239. </div>
    240. 

  240. <div class="section" id="7">
    241. 

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

  242.   <dl class="item">
    243. 

  243.     <div id="CmdLineKind">
    244. 

  244.   <dt><pre><a href="parseopt.html#CmdLineKind"><span class="Identifier">CmdLineKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    245. 

  245.   <span class="Identifier">cmdEnd</span><span class="Other">,</span>                   <span class="Comment">## End of command line reached</span>
    246. 

  246.   <span class="Identifier">cmdArgument</span><span class="Other">,</span>              <span class="Comment">## An argument such as a filename</span>
    247. 

  247.   <span class="Identifier">cmdLongOption</span><span class="Other">,</span>            <span class="Comment">## A long option such as --option</span>
    248. 

  248.   <span class="Identifier">cmdShortOption</span>             <span class="Comment">## A short option such as -c</span></pre></dt>
    249. 

  249.   <dd>
    250. 

  250.     
    251. 

  251.     The detected command line token.
    252. 

  252.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L183" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    253. 

  253. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L183" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    254. 

  254. 

  255.   </dd>
    256. 

  256. </div>
    257. 

  257. <div id="OptParser">
    258. 

  258.   <dt><pre><a href="parseopt.html#OptParser"><span class="Identifier">OptParser</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>
    259. 

  259.   <span class="Identifier">kind</span><span class="Operator">*</span><span class="Other">:</span> <a href="parseopt.html#CmdLineKind"><span class="Identifier">CmdLineKind</span></a>         <span class="Comment">## The detected command line token</span>
    260. 

  260.   <span class="Identifier">key</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a>         <span class="Comment">## Key and value pair; the key is the option</span>
    261. 

  261.                              <span class="Comment">## or the argument, and the value is not &quot;&quot; if</span>
    262. 

  262.                              <span class="Comment">## the option was given a value</span></pre></dt>
    263. 

  263.   <dd>
    264. 

  264.     
    265. 

  265.     <p>
    266. 

  266. Implementation of the command line parser.</p>
    267. 

  267. <p>To initialize it, use the <a class="reference external" href="#initOptParser,string,set[char],seq[string]">initOptParser proc</a>.</p>
    268. 

  268. 

  269.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L188" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    270. 

  270. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L188" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    271. 

  271. 

  272.   </dd>
    273. 

  273. </div>
    274. 

  274. 

  275.   </dl>
    276. 

  276. </div>
    277. 

  277. <div class="section" id="12">
    278. 

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

  279.   <dl class="item">
    280. 

  280.     <div id="cmdLineRest-procs-all">
    281. 

  281.   <div id="cmdLineRest,OptParser">
    282. 

  282.   <dt><pre><span class="Keyword">proc</span> <a href="#cmdLineRest%2COptParser"><span class="Identifier">cmdLineRest</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="parseopt.html#OptParser"><span class="Identifier">OptParser</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;npo$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>
    283. 

  283.     <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>
    284. 

  284.   <dd>
    285. 

  285.     
    286. 

  286.     <p>Retrieves the rest of the command line that has not been parsed yet.</p>
    287. 

  287. <p>See also:</p>
    288. 

  288. <ul class="simple"><li><a class="reference external" href="#remainingArgs,OptParser">remainingArgs proc</a></li>
    289. 

  289. </ul>
    290. 

  290. <p><strong>Examples:</strong></p>
    291. 

  291. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;--left -r:2 -- foo.txt bar.txt&quot;</span><span class="Punctuation">)</span>
    292. 

  292. <span class="Keyword">while</span> <span class="Identifier">true</span><span class="Punctuation">:</span>
    293. 

  293.   <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    294. 

  294.   <span class="Keyword">if</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">cmdLongOption</span> <span class="Keyword">and</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">:</span>  <span class="Comment"># Look for &quot;--&quot;</span>
    295. 

  295.     <span class="Keyword">break</span>
    296. 

  296. <span class="Identifier">doAssert</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">cmdLineRest</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo.txt bar.txt&quot;</span></pre></p>
    297. 

  297. 

  298.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L396" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    299. 

  299. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L396" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    300. 

  300. 

  301.   </dd>
    302. 

  302. </div>
    303. 

  303. 

  304. </div>
    305. 

  305. <div id="initOptParser-procs-all">
    306. 

  306.   <div id="initOptParser,string,set[char],seq[string]">
    307. 

  307.   <dt><pre><span class="Keyword">proc</span> <a href="#initOptParser%2Cstring%2Cset%5Bchar%5D%2Cseq%5Bstring%5D"><span class="Identifier">initOptParser</span></a><span class="Other">(</span><span class="Identifier">cmdline</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">shortNoVal</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Other">}</span><span class="Other">;</span>
    308. 

  308.                    <span class="Identifier">longNoVal</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</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> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">;</span>
    309. 

  309.                    <span class="Identifier">allowWhitespaceAfterColon</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="parseopt.html#OptParser"><span class="Identifier">OptParser</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>
    310. 

  310.     <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>
    311. 

  311.   <dd>
    312. 

  312.     
    313. 

  313.     <p>Initializes the command line parser.</p>
    314. 

  314. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdline</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span></span></tt>, the real command line as provided by the <tt class="docutils literal"><span class="pre"><span class="Identifier">os</span></span></tt> module is retrieved instead if it is available. If the command line is not available, a <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> will be raised.</p>
    315. 

  315. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt> are used to specify which options do not take values. See the <a class="reference external" href="#nimshortnoval-and-nimlongnoval">documentation about these parameters</a> for more information on how this affects parsing.</p>
    316. 

  316. <p>This does not provide a way of passing default values to arguments.</p>
    317. 

  317. <p>See also:</p>
    318. 

  318. <ul class="simple"><li><a class="reference external" href="#getopt.i,OptParser">getopt iterator</a></li>
    319. 

  319. </ul>
    320. 

  320. 

  321. <p><strong class="examples_text">Example:</strong></p>
    322. 

  322. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    323. 

  323. <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;--left --debug:3 -l -r:2&quot;</span><span class="Punctuation">)</span>
    324. 

  324. <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;--left --debug:3 -l -r:2&quot;</span><span class="Punctuation">,</span>
    325. 

  325.                   <span class="Identifier">shortNoVal</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">l</span><span class="CharLit">'}, longNoVal = @[&quot;left&quot;])</span></pre>
    326. 

  326.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L273" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    327. 

  327. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L273" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    328. 

  328. 

  329.   </dd>
    330. 

  330. </div>
    331. 

  331. <div id="initOptParser,seq[string],set[char],seq[string]">
    332. 

  332.   <dt><pre><span class="Keyword">proc</span> <a href="#initOptParser%2Cseq%5Bstring%5D%2Cset%5Bchar%5D%2Cseq%5Bstring%5D"><span class="Identifier">initOptParser</span></a><span class="Other">(</span><span class="Identifier">cmdline</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</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> <span class="Identifier">shortNoVal</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Other">}</span><span class="Other">;</span>
    333. 

  333.                    <span class="Identifier">longNoVal</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</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> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">;</span>
    334. 

  334.                    <span class="Identifier">allowWhitespaceAfterColon</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="parseopt.html#OptParser"><span class="Identifier">OptParser</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>
    335. 

  335.     <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>
    336. 

  336.   <dd>
    337. 

  337.     
    338. 

  338.     <p>Initializes the command line parser.</p>
    339. 

  339. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdline</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt>, the real command line as provided by the <tt class="docutils literal"><span class="pre"><span class="Identifier">os</span></span></tt> module is retrieved instead if it is available. If the command line is not available, a <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> will be raised. Behavior of the other parameters remains the same as in <a class="reference external" href="#initOptParser,string,set[char],seq[string]">initOptParser(string, ...)</a>.</p>
    340. 

  340. <p>See also:</p>
    341. 

  341. <ul class="simple"><li><a class="reference external" href="#getopt.i,seq[string],set[char],seq[string]">getopt iterator</a></li>
    342. 

  342. </ul>
    343. 

  343. 

  344. <p><strong class="examples_text">Example:</strong></p>
    345. 

  345. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    346. 

  346. <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;--left&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;--debug:3&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-l&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-r:2&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    347. 

  347. <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;--left&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;--debug:3&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-l&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-r:2&quot;</span><span class="Punctuation">]</span><span class="Punctuation">,</span>
    348. 

  348.                   <span class="Identifier">shortNoVal</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="Punctuation">'</span><span class="Identifier">l</span><span class="CharLit">'}, longNoVal = @[&quot;left&quot;])</span></pre>
    349. 

  349.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L221" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    350. 

  350. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L221" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    351. 

  351. 

  352.   </dd>
    353. 

  353. </div>
    354. 

  354. 

  355. </div>
    356. 

  356. <div id="next-procs-all">
    357. 

  357.   <div id="next,OptParser">
    358. 

  358.   <dt><pre><span class="Keyword">proc</span> <a href="#next%2COptParser"><span class="Identifier">next</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parseopt.html#OptParser"><span class="Identifier">OptParser</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;npo$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>
    359. 

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

  360.   <dd>
    361. 

  361.     
    362. 

  362.     <p>Parses the next token.</p>
    363. 

  363. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span></span></tt> describes what kind of token has been parsed. <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">val</span></span></tt> are set accordingly.</p>
    364. 

  364. 

  365. <p><strong class="examples_text">Example:</strong></p>
    366. 

  366. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;--left -r:2 file.txt&quot;</span><span class="Punctuation">)</span>
    367. 

  367. <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    368. 

  368. <span class="Identifier">doAssert</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">cmdLongOption</span> <span class="Keyword">and</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">==</span> <span class="StringLit">&quot;left&quot;</span>
    369. 

  369. <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    370. 

  370. <span class="Identifier">doAssert</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">cmdShortOption</span> <span class="Keyword">and</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">==</span> <span class="StringLit">&quot;r&quot;</span> <span class="Keyword">and</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">val</span> <span class="Operator">==</span> <span class="StringLit">&quot;2&quot;</span>
    371. 

  371. <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    372. 

  372. <span class="Identifier">doAssert</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">cmdArgument</span> <span class="Keyword">and</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">==</span> <span class="StringLit">&quot;file.txt&quot;</span>
    373. 

  373. <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    374. 

  374. <span class="Identifier">doAssert</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">cmdEnd</span></pre>
    375. 

  375.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L325" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    376. 

  376. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L325" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    377. 

  377. 

  378.   </dd>
    379. 

  379. </div>
    380. 

  380. 

  381. </div>
    382. 

  382. <div id="remainingArgs-procs-all">
    383. 

  383.   <div id="remainingArgs,OptParser">
    384. 

  384.   <dt><pre><span class="Keyword">proc</span> <a href="#remainingArgs%2COptParser"><span class="Identifier">remainingArgs</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="parseopt.html#OptParser"><span class="Identifier">OptParser</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><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">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npo$1&quot;</span><span class="Other">,</span>
    385. 

  385.     <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>
    386. 

  386.   <dd>
    387. 

  387.     
    388. 

  388.     <p>Retrieves a sequence of the arguments that have not been parsed yet.</p>
    389. 

  389. <p>See also:</p>
    390. 

  390. <ul class="simple"><li><a class="reference external" href="#cmdLineRest,OptParser">cmdLineRest proc</a></li>
    391. 

  391. </ul>
    392. 

  392. <p><strong>Examples:</strong></p>
    393. 

  393. <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;--left -r:2 -- foo.txt bar.txt&quot;</span><span class="Punctuation">)</span>
    394. 

  394. <span class="Keyword">while</span> <span class="Identifier">true</span><span class="Punctuation">:</span>
    395. 

  395.   <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">next</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    396. 

  396.   <span class="Keyword">if</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">kind</span> <span class="Operator">==</span> <span class="Identifier">cmdLongOption</span> <span class="Keyword">and</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">key</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">:</span>  <span class="Comment"># Look for &quot;--&quot;</span>
    397. 

  397.     <span class="Keyword">break</span>
    398. 

  398. <span class="Identifier">doAssert</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">remainingArgs</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;foo.txt&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bar.txt&quot;</span><span class="Punctuation">]</span></pre></p>
    399. 

  399. 

  400.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L413" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    401. 

  401. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L413" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    402. 

  402. 

  403.   </dd>
    404. 

  404. </div>
    405. 

  405. 

  406. </div>
    407. 

  407. 

  408.   </dl>
    409. 

  409. </div>
    410. 

  410. <div class="section" id="15">
    411. 

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

  412.   <dl class="item">
    413. 

  413.     <div id="getopt-iterators-all">
    414. 

  414.   <div id="getopt.i,seq[string],set[char],seq[string]">
    415. 

  415.   <dt><pre><span class="Keyword">iterator</span> <a href="#getopt.i%2Cseq%5Bstring%5D%2Cset%5Bchar%5D%2Cseq%5Bstring%5D"><span class="Identifier">getopt</span></a><span class="Other">(</span><span class="Identifier">cmdline</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</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> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">shortNoVal</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Other">{</span><span class="Other">}</span><span class="Other">;</span>
    416. 

  416.                 <span class="Identifier">longNoVal</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</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> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">kind</span><span class="Other">:</span> <a href="parseopt.html#CmdLineKind"><span class="Identifier">CmdLineKind</span></a><span class="Other">,</span>
    417. 

  417.     <span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">val</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="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>
    418. 

  418.   <dd>
    419. 

  419.     
    420. 

  420.     <p>Convenience iterator for iterating over command line arguments.</p>
    421. 

  421. <p>This creates a new <a class="reference external" href="#OptParser">OptParser</a>. If no command line arguments are provided, the real command line as provided by the <tt class="docutils literal"><span class="pre"><span class="Identifier">os</span></span></tt> module is retrieved instead.</p>
    422. 

  422. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">shortNoVal</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">longNoVal</span></span></tt> are used to specify which options do not take values. See the <a class="reference external" href="#nimshortnoval-and-nimlongnoval">documentation about these parameters</a> for more information on how this affects parsing.</p>
    423. 

  423. <p>There is no need to check for <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdEnd</span></span></tt> while iterating. If using <tt class="docutils literal"><span class="pre"><span class="Identifier">getopt</span></span></tt> with case switching, checking for <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdEnd</span></span></tt> is required.</p>
    424. 

  424. <p>See also:</p>
    425. 

  425. <ul class="simple"><li><a class="reference external" href="#initOptParser,seq[string],set[char],seq[string]">initOptParser proc</a></li>
    426. 

  426. </ul>
    427. 

  427. <p><strong>Examples:</strong></p>
    428. 

  428. <p><pre class="listing"><span class="Comment"># these are placeholders, of course</span>
    429. 

  429. <span class="Keyword">proc</span> <span class="Identifier">writeHelp</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Keyword">discard</span>
    430. 

  430. <span class="Keyword">proc</span> <span class="Identifier">writeVersion</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Keyword">discard</span>
    431. 

  431. 

  432. <span class="Keyword">var</span> <span class="Identifier">filename</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    433. 

  433. <span class="Keyword">let</span> <span class="Identifier">params</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;--left&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;--debug:3&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-l&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;-r:2&quot;</span><span class="Punctuation">]</span>
    434. 

  434. 

  435. <span class="Keyword">for</span> <span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span> <span class="Keyword">in</span> <span class="Identifier">getopt</span><span class="Punctuation">(</span><span class="Identifier">params</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    436. 

  436.   <span class="Keyword">case</span> <span class="Identifier">kind</span>
    437. 

  437.   <span class="Keyword">of</span> <span class="Identifier">cmdArgument</span><span class="Punctuation">:</span>
    438. 

  438.     <span class="Identifier">filename</span> <span class="Operator">=</span> <span class="Identifier">key</span>
    439. 

  439.   <span class="Keyword">of</span> <span class="Identifier">cmdLongOption</span><span class="Punctuation">,</span> <span class="Identifier">cmdShortOption</span><span class="Punctuation">:</span>
    440. 

  440.     <span class="Keyword">case</span> <span class="Identifier">key</span>
    441. 

  441.     <span class="Keyword">of</span> <span class="StringLit">&quot;help&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;h&quot;</span><span class="Punctuation">:</span> <span class="Identifier">writeHelp</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    442. 

  442.     <span class="Keyword">of</span> <span class="StringLit">&quot;version&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;v&quot;</span><span class="Punctuation">:</span> <span class="Identifier">writeVersion</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    443. 

  443.   <span class="Keyword">of</span> <span class="Identifier">cmdEnd</span><span class="Punctuation">:</span> <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Comment"># cannot happen</span>
    444. 

  444. <span class="Keyword">if</span> <span class="Identifier">filename</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">:</span>
    445. 

  445.   <span class="Comment"># no filename has been written, so we show the help</span>
    446. 

  446.   <span class="Identifier">writeHelp</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    447. 

  447. 

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

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

  450. 

  451.   </dd>
    452. 

  452. </div>
    453. 

  453. <div id="getopt.i,OptParser">
    454. 

  454.   <dt><pre><span class="Keyword">iterator</span> <a href="#getopt.i%2COptParser"><span class="Identifier">getopt</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="parseopt.html#OptParser"><span class="Identifier">OptParser</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">kind</span><span class="Other">:</span> <a href="parseopt.html#CmdLineKind"><span class="Identifier">CmdLineKind</span></a><span class="Other">,</span> <span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.
    455. 

  455.     <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>
    456. 

  456.   <dd>
    457. 

  457.     
    458. 

  458.     <p>Convenience iterator for iterating over the given <a class="reference external" href="#OptParser">OptParser</a>.</p>
    459. 

  459. <p>There is no need to check for <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdEnd</span></span></tt> while iterating. If using <tt class="docutils literal"><span class="pre"><span class="Identifier">getopt</span></span></tt> with case switching, checking for <tt class="docutils literal"><span class="pre"><span class="Identifier">cmdEnd</span></span></tt> is required.</p>
    460. 

  460. <p>See also:</p>
    461. 

  461. <ul class="simple"><li><a class="reference external" href="#initOptParser,string,set[char],seq[string]">initOptParser proc</a></li>
    462. 

  462. </ul>
    463. 

  463. <p><strong>Examples:</strong></p>
    464. 

  464. <p><pre class="listing"><span class="Comment"># these are placeholders, of course</span>
    465. 

  465. <span class="Keyword">proc</span> <span class="Identifier">writeHelp</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Keyword">discard</span>
    466. 

  466. <span class="Keyword">proc</span> <span class="Identifier">writeVersion</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Keyword">discard</span>
    467. 

  467. 

  468. <span class="Keyword">var</span> <span class="Identifier">filename</span><span class="Punctuation">:</span> <span class="Identifier">string</span>
    469. 

  469. <span class="Keyword">var</span> <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">initOptParser</span><span class="Punctuation">(</span><span class="StringLit">&quot;--left --debug:3 -l -r:2&quot;</span><span class="Punctuation">)</span>
    470. 

  470. 

  471. <span class="Keyword">for</span> <span class="Identifier">kind</span><span class="Punctuation">,</span> <span class="Identifier">key</span><span class="Punctuation">,</span> <span class="Identifier">val</span> <span class="Keyword">in</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">getopt</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    472. 

  472.   <span class="Keyword">case</span> <span class="Identifier">kind</span>
    473. 

  473.   <span class="Keyword">of</span> <span class="Identifier">cmdArgument</span><span class="Punctuation">:</span>
    474. 

  474.     <span class="Identifier">filename</span> <span class="Operator">=</span> <span class="Identifier">key</span>
    475. 

  475.   <span class="Keyword">of</span> <span class="Identifier">cmdLongOption</span><span class="Punctuation">,</span> <span class="Identifier">cmdShortOption</span><span class="Punctuation">:</span>
    476. 

  476.     <span class="Keyword">case</span> <span class="Identifier">key</span>
    477. 

  477.     <span class="Keyword">of</span> <span class="StringLit">&quot;help&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;h&quot;</span><span class="Punctuation">:</span> <span class="Identifier">writeHelp</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    478. 

  478.     <span class="Keyword">of</span> <span class="StringLit">&quot;version&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;v&quot;</span><span class="Punctuation">:</span> <span class="Identifier">writeVersion</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    479. 

  479.   <span class="Keyword">of</span> <span class="Identifier">cmdEnd</span><span class="Punctuation">:</span> <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Comment"># cannot happen</span>
    480. 

  480. <span class="Keyword">if</span> <span class="Identifier">filename</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">:</span>
    481. 

  481.   <span class="Comment"># no filename has been given, so we show the help</span>
    482. 

  482.   <span class="Identifier">writeHelp</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    483. 

  483. 

  484.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/parseopt.nim#L431" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    485. 

  485. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/parseopt.nim#L431" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    486. 

  486. 

  487.   </dd>
    488. 

  488. </div>
    489. 

  489. 

  490. </div>
    491. 

  491. 

  492.   </dl>
    493. 

  493. </div>
    494. 

  494. 

  495.   </div>
    496. 

  496. </div>
    497. 

  497. 

  498.       <div class="twelve-columns footer">
    499. 

  499.         <span class="nim-sprite"></span>
    500. 

  500.         <br>
    501. 

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

  502.       </div>
    503. 

  503.     </div>
    504. 

  504.   </div>
    505. 

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

  506.     
    507. 

  507. </body>
    508. 

  508. </html>
    509. 

  509.