صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
levovix
/
Nim
mirrorاز https://github.com/nim-lang/Nim
دنبال کردن 1
ستاره دار 0
انشعاب 1
پرونده‌ها مشکلات 0 ویکی
شاخه: gh-pages
شاخه‌ها تگ‌ها
Nim
/
pegs.html

pegs.html 204 KB
لینک دائمی تاريخچه خام

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879 
  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/pegs</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/pegs</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="peg-syntax-and-semantics_toc" href="#peg-syntax-and-semantics">PEG syntax and semantics</a></li>
    55. 

  55. <ul class="simple"><li><a class="reference" id="peg-syntax-and-semantics-builtminusin-macros_toc" href="#peg-syntax-and-semantics-builtminusin-macros">Built-in macros</a></li>
    56. 

  56. <li><a class="reference" id="peg-syntax-and-semantics-supported-peg-grammar_toc" href="#peg-syntax-and-semantics-supported-peg-grammar">Supported PEG grammar</a></li>
    57. 

  57. <li><a class="reference" id="peg-syntax-and-semantics-examples_toc" href="#peg-syntax-and-semantics-examples">Examples</a></li>
    58. 

  58. <li><a class="reference" id="peg-syntax-and-semantics-peg-vs-regular-expression_toc" href="#peg-syntax-and-semantics-peg-vs-regular-expression">PEG vs regular expression</a></li>
    59. 

  59. <li><a class="reference" id="peg-syntax-and-semantics-peg-construction_toc" href="#peg-syntax-and-semantics-peg-construction">PEG construction</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="#Captures" title="Captures = object">Captures</a></li>
    68. 

  68. <li><a class="reference" href="#EInvalidPeg" title="EInvalidPeg = object of ValueError">EInvalidPeg</a></li>
    69. 

  69. <li><a class="reference" href="#NonTerminal" title="NonTerminal = ref NonTerminalObj">NonTerminal</a></li>
    70. 

  70. <li><a class="reference" href="#NonTerminalFlag" title="NonTerminalFlag = enum
    71. 

  71.   ntDeclared, ntUsed">NonTerminalFlag</a></li>
    72. 

  72. <li><a class="reference" href="#Peg" title="Peg {.shallow.} = object
    73. 

  73.   case
    74. 

  74.   of pkEmpty .. pkWhitespace:
    75. 

  75.     nil
    76. 

  76.   of pkTerminal, pkTerminalIgnoreCase, pkTerminalIgnoreStyle:
    77. 

  77.   of pkChar, pkGreedyRepChar:
    78. 

  78.   of pkCharChoice, pkGreedyRepSet:
    79. 

  79.   of pkNonTerminal:
    80. 

  80.   of pkBackRef .. pkBackRefIgnoreStyle:
    81. 

  81.   else:">Peg</a></li>
    82. 

  82. <li><a class="reference" href="#PegKind" title="PegKind = enum
    83. 

  83.   pkEmpty, pkAny,           ## any character (.)
    84. 

  84.   pkAnyRune,                ## any Unicode character (_)
    85. 

  85.   pkNewLine,                ## CR-LF, LF, CR
    86. 

  86.   pkLetter,                 ## Unicode letter
    87. 

  87.   pkLower,                  ## Unicode lower case letter
    88. 

  88.   pkUpper,                  ## Unicode upper case letter
    89. 

  89.   pkTitle,                  ## Unicode title character
    90. 

  90.   pkWhitespace,             ## Unicode whitespace character
    91. 

  91.   pkTerminal, pkTerminalIgnoreCase, pkTerminalIgnoreStyle, pkChar, ## single character to match
    92. 

  92.   pkCharChoice, pkNonTerminal, pkSequence, ## a b c ... --&gt; Internal DSL: peg(a, b, c)
    93. 

  93.   pkOrderedChoice,          ## a / b / ... --&gt; Internal DSL: a / b or /[a, b, c]
    94. 

  94.   pkGreedyRep,              ## a*     --&gt; Internal DSL: *a
    95. 

  95.                              ## a+     --&gt; (a a*)
    96. 

  96.   pkGreedyRepChar,          ## x* where x is a single character (superop)
    97. 

  97.   pkGreedyRepSet,           ## [set]* (superop)
    98. 

  98.   pkGreedyAny,              ## .* or _* (superop)
    99. 

  99.   pkOption,                 ## a?     --&gt; Internal DSL: ?a
    100. 

  100.   pkAndPredicate,           ## &amp;a     --&gt; Internal DSL: &amp;a
    101. 

  101.   pkNotPredicate,           ## !a     --&gt; Internal DSL: !a
    102. 

  102.   pkCapture,                ## {a}    --&gt; Internal DSL: capture(a)
    103. 

  103.   pkBackRef,                ## $i     --&gt; Internal DSL: backref(i)
    104. 

  104.   pkBackRefIgnoreCase, pkBackRefIgnoreStyle, pkSearch, ## @a     --&gt; Internal DSL: !*a
    105. 

  105.   pkCapturedSearch,         ## {@} a  --&gt; Internal DSL: !*\a
    106. 

  106.   pkRule,                   ## a &lt;- b
    107. 

  107.   pkList,                   ## a, b
    108. 

  108.   pkStartAnchor              ## ^      --&gt; Internal DSL: startAnchor()">PegKind</a></li>
    109. 

  109. 

  110.     </ul>
    111. 

  111.   </details>
    112. 

  112. </li>
    113. 

  113. <li>
    114. 

  114.   <details open>
    115. 

  115.     <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
    116. 

  116.     <ul class="simple simple-toc-section">
    117. 

  117.       <li><a class="reference" href="#MaxSubpatterns" title="MaxSubpatterns = 20">MaxSubpatterns</a></li>
    118. 

  118. 

  119.     </ul>
    120. 

  120.   </details>
    121. 

  121. </li>
    122. 

  122. <li>
    123. 

  123.   <details open>
    124. 

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

  125.     <ul class="simple simple-toc-section">
    126. 

  126.       <ul class="simple nested-toc-section">!
    127. 

  127.   <li><a class="reference" href="#%21%2CPeg" title="`!`(a: Peg): Peg">`!`(a: Peg): Peg</a></li>
    128. 

  128. 

  129. </ul>
    130. 

  130. <ul class="simple nested-toc-section">!*
    131. 

  131.   <li><a class="reference" href="#%21%2A%2CPeg" title="`!*`(a: Peg): Peg">`!*`(a: Peg): Peg</a></li>
    132. 

  132. 

  133. </ul>
    134. 

  134. <ul class="simple nested-toc-section">!*\
    135. 

  135.   <li><a class="reference" href="#%21%2A%5C%2CPeg" title="`!*\`(a: Peg): Peg">`!*\`(a: Peg): Peg</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">$
    139. 

  139.   <li><a class="reference" href="#%24%2CPeg" title="`$`(r: Peg): string">`$`(r: Peg): string</a></li>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">&
    143. 

  143.   <li><a class="reference" href="#%26%2CPeg" title="`&amp;`(a: Peg): Peg">`&amp;`(a: Peg): Peg</a></li>
    144. 

  144. 

  145. </ul>
    146. 

  146. <ul class="simple nested-toc-section">*
    147. 

  147.   <li><a class="reference" href="#%2A%2CPeg" title="`*`(a: Peg): Peg">`*`(a: Peg): Peg</a></li>
    148. 

  148. 

  149. </ul>
    150. 

  150. <ul class="simple nested-toc-section">+
    151. 

  151.   <li><a class="reference" href="#%2B%2CPeg" title="`+`(a: Peg): Peg">`+`(a: Peg): Peg</a></li>
    152. 

  152. 

  153. </ul>
    154. 

  154. <ul class="simple nested-toc-section">/
    155. 

  155.   <li><a class="reference" href="#%2F%2Cvarargs%5BPeg%5D" title="`/`(a: varargs[Peg]): Peg">`/`(a: varargs[Peg]): Peg</a></li>
    156. 

  156. 

  157. </ul>
    158. 

  158. <ul class="simple nested-toc-section">?
    159. 

  159.   <li><a class="reference" href="#%3F%2CPeg" title="`?`(a: Peg): Peg">`?`(a: Peg): Peg</a></li>
    160. 

  160. 

  161. </ul>
    162. 

  162. <ul class="simple nested-toc-section">any
    163. 

  163.   <li><a class="reference" href="#any" title="any(): Peg">any(): Peg</a></li>
    164. 

  164. 

  165. </ul>
    166. 

  166. <ul class="simple nested-toc-section">anyRune
    167. 

  167.   <li><a class="reference" href="#anyRune" title="anyRune(): Peg">anyRune(): Peg</a></li>
    168. 

  168. 

  169. </ul>
    170. 

  170. <ul class="simple nested-toc-section">backref
    171. 

  171.   <li><a class="reference" href="#backref%2Crange%5B%5D%2Cbool" title="backref(index: range[1 .. MaxSubpatterns]; reverse: bool = false): Peg">backref(index: range[1 .. MaxSubpatterns]; reverse: bool = false): Peg</a></li>
    172. 

  172. 

  173. </ul>
    174. 

  174. <ul class="simple nested-toc-section">backrefIgnoreCase
    175. 

  175.   <li><a class="reference" href="#backrefIgnoreCase%2Crange%5B%5D%2Cbool" title="backrefIgnoreCase(index: range[1 .. MaxSubpatterns]; reverse: bool = false): Peg">backrefIgnoreCase(index: range[1 .. MaxSubpatterns]; reverse: bool = false): Peg</a></li>
    176. 

  176. 

  177. </ul>
    178. 

  178. <ul class="simple nested-toc-section">backrefIgnoreStyle
    179. 

  179.   <li><a class="reference" href="#backrefIgnoreStyle%2Crange%5B%5D%2Cbool" title="backrefIgnoreStyle(index: range[1 .. MaxSubpatterns]; reverse: bool = false): Peg">backrefIgnoreStyle(index: range[1 .. MaxSubpatterns]; reverse: bool = false): Peg</a></li>
    180. 

  180. 

  181. </ul>
    182. 

  182. <ul class="simple nested-toc-section">bounds
    183. 

  183.   <li><a class="reference" href="#bounds%2CCaptures%2Crange%5B%5D" title="bounds(c: Captures; i: range[0 .. 20 - 1]): tuple[first, last: int]">bounds(c: Captures; i: range[0 .. 20 - 1]): tuple[first, last: int]</a></li>
    184. 

  184. 

  185. </ul>
    186. 

  186. <ul class="simple nested-toc-section">capture
    187. 

  187.   <li><a class="reference" href="#capture%2CPeg" title="capture(a: Peg = Peg(kind: pkEmpty)): Peg">capture(a: Peg = Peg(kind: pkEmpty)): Peg</a></li>
    188. 

  188. 

  189. </ul>
    190. 

  190. <ul class="simple nested-toc-section">ch
    191. 

  191.   <li><a class="reference" href="#ch%2CPeg" title="ch(p: Peg): char">ch(p: Peg): char</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. <ul class="simple nested-toc-section">charChoice
    195. 

  195.   <li><a class="reference" href="#charChoice%2CPeg" title="charChoice(p: Peg): ref set[char]">charChoice(p: Peg): ref set[char]</a></li>
    196. 

  196. 

  197. </ul>
    198. 

  198. <ul class="simple nested-toc-section">charSet
    199. 

  199.   <li><a class="reference" href="#charSet%2Cset%5Bchar%5D" title="charSet(s: set[char]): Peg">charSet(s: set[char]): Peg</a></li>
    200. 

  200. 

  201. </ul>
    202. 

  202. <ul class="simple nested-toc-section">col
    203. 

  203.   <li><a class="reference" href="#col%2CNonTerminal" title="col(nt: NonTerminal): int">col(nt: NonTerminal): int</a></li>
    204. 

  204. 

  205. </ul>
    206. 

  206. <ul class="simple nested-toc-section">contains
    207. 

  207.   <li><a class="reference" href="#contains%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint" title="contains(s: string; pattern: Peg; matches: var openArray[string]; start = 0): bool">contains(s: string; pattern: Peg; matches: var openArray[string]; start = 0): bool</a></li>
    208. 

  208. <li><a class="reference" href="#contains%2Cstring%2CPeg%2Cint" title="contains(s: string; pattern: Peg; start = 0): bool">contains(s: string; pattern: Peg; start = 0): bool</a></li>
    209. 

  209. 

  210. </ul>
    211. 

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

  212.   <li><a class="reference" href="#endAnchor" title="endAnchor(): Peg">endAnchor(): Peg</a></li>
    213. 

  213. 

  214. </ul>
    215. 

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

  216.   <li><a class="reference" href="#endsWith%2Cstring%2CPeg%2Cint" title="endsWith(s: string; suffix: Peg; start = 0): bool">endsWith(s: string; suffix: Peg; start = 0): bool</a></li>
    217. 

  217. 

  218. </ul>
    219. 

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

  220.   <li><a class="reference" href="#escapePeg%2Cstring" title="escapePeg(s: string): string">escapePeg(s: string): string</a></li>
    221. 

  221. 

  222. </ul>
    223. 

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

  224.   <li><a class="reference" href="#find%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint" title="find(s: string; pattern: Peg; matches: var openArray[string]; start = 0): int">find(s: string; pattern: Peg; matches: var openArray[string]; start = 0): int</a></li>
    225. 

  225. <li><a class="reference" href="#find%2Cstring%2CPeg%2Cint" title="find(s: string; pattern: Peg; start = 0): int">find(s: string; pattern: Peg; start = 0): int</a></li>
    226. 

  226. 

  227. </ul>
    228. 

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

  229.   <li><a class="reference" href="#findAll%2Cstring%2CPeg%2Cint" title="findAll(s: string; pattern: Peg; start = 0): seq[string]">findAll(s: string; pattern: Peg; start = 0): seq[string]</a></li>
    230. 

  230. 

  231. </ul>
    232. 

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

  233.   <li><a class="reference" href="#findBounds%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint" title="findBounds(s: string; pattern: Peg; matches: var openArray[string]; start = 0): tuple[
    234. 

  234.     first, last: int]">findBounds(s: string; pattern: Peg; matches: var openArray[string]; start = 0): tuple[
    235. 

  235.     first, last: int]</a></li>
    236. 

  236. 

  237. </ul>
    238. 

  238. <ul class="simple nested-toc-section">flags
    239. 

  239.   <li><a class="reference" href="#flags%2CNonTerminal" title="flags(nt: NonTerminal): set[NonTerminalFlag]">flags(nt: NonTerminal): set[NonTerminalFlag]</a></li>
    240. 

  240. 

  241. </ul>
    242. 

  242. <ul class="simple nested-toc-section">index
    243. 

  243.   <li><a class="reference" href="#index%2CPeg" title="index(p: Peg): range[-20 .. 20 - 1]">index(p: Peg): range[-20 .. 20 - 1]</a></li>
    244. 

  244. 

  245. </ul>
    246. 

  246. <ul class="simple nested-toc-section">kind
    247. 

  247.   <li><a class="reference" href="#kind%2CPeg" title="kind(p: Peg): PegKind">kind(p: Peg): PegKind</a></li>
    248. 

  248. 

  249. </ul>
    250. 

  250. <ul class="simple nested-toc-section">line
    251. 

  251.   <li><a class="reference" href="#line%2CNonTerminal" title="line(nt: NonTerminal): int">line(nt: NonTerminal): int</a></li>
    252. 

  252. 

  253. </ul>
    254. 

  254. <ul class="simple nested-toc-section">match
    255. 

  255.   <li><a class="reference" href="#match%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint" title="match(s: string; pattern: Peg; matches: var openArray[string]; start = 0): bool">match(s: string; pattern: Peg; matches: var openArray[string]; start = 0): bool</a></li>
    256. 

  256. <li><a class="reference" href="#match%2Cstring%2CPeg%2Cint" title="match(s: string; pattern: Peg; start = 0): bool">match(s: string; pattern: Peg; start = 0): bool</a></li>
    257. 

  257. 

  258. </ul>
    259. 

  259. <ul class="simple nested-toc-section">matchLen
    260. 

  260.   <li><a class="reference" href="#matchLen%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint" title="matchLen(s: string; pattern: Peg; matches: var openArray[string]; start = 0): int">matchLen(s: string; pattern: Peg; matches: var openArray[string]; start = 0): int</a></li>
    261. 

  261. <li><a class="reference" href="#matchLen%2Cstring%2CPeg%2Cint" title="matchLen(s: string; pattern: Peg; start = 0): int">matchLen(s: string; pattern: Peg; start = 0): int</a></li>
    262. 

  262. 

  263. </ul>
    264. 

  264. <ul class="simple nested-toc-section">name
    265. 

  265.   <li><a class="reference" href="#name%2CNonTerminal" title="name(nt: NonTerminal): string">name(nt: NonTerminal): string</a></li>
    266. 

  266. 

  267. </ul>
    268. 

  268. <ul class="simple nested-toc-section">newLine
    269. 

  269.   <li><a class="reference" href="#newLine" title="newLine(): Peg">newLine(): Peg</a></li>
    270. 

  270. 

  271. </ul>
    272. 

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

  273.   <li><a class="reference" href="#newNonTerminal%2Cstring%2Cint%2Cint" title="newNonTerminal(name: string; line, column: int): NonTerminal">newNonTerminal(name: string; line, column: int): NonTerminal</a></li>
    274. 

  274. 

  275. </ul>
    276. 

  276. <ul class="simple nested-toc-section">nonterminal
    277. 

  277.   <li><a class="reference" href="#nonterminal%2CNonTerminal" title="nonterminal(n: NonTerminal): Peg">nonterminal(n: NonTerminal): Peg</a></li>
    278. 

  278. 

  279. </ul>
    280. 

  280. <ul class="simple nested-toc-section">nt
    281. 

  281.   <li><a class="reference" href="#nt%2CPeg" title="nt(p: Peg): NonTerminal">nt(p: Peg): NonTerminal</a></li>
    282. 

  282. 

  283. </ul>
    284. 

  284. <ul class="simple nested-toc-section">parallelReplace
    285. 

  285.   <li><a class="reference" href="#parallelReplace%2Cstring%2Cvarargs%5Btuple%5BPeg%2Cstring%5D%5D" title="parallelReplace(s: string; subs: varargs[tuple[pattern: Peg, repl: string]]): string">parallelReplace(s: string; subs: varargs[tuple[pattern: Peg, repl: string]]): string</a></li>
    286. 

  286. 

  287. </ul>
    288. 

  288. <ul class="simple nested-toc-section">parsePeg
    289. 

  289.   <li><a class="reference" href="#parsePeg%2Cstring%2Cstring%2Cint%2Cint" title="parsePeg(pattern: string; filename = &quot;pattern&quot;; line = 1; col = 0): Peg">parsePeg(pattern: string; filename = &quot;pattern&quot;; line = 1; col = 0): Peg</a></li>
    290. 

  290. 

  291. </ul>
    292. 

  292. <ul class="simple nested-toc-section">peg
    293. 

  293.   <li><a class="reference" href="#peg%2Cstring" title="peg(pattern: string): Peg">peg(pattern: string): Peg</a></li>
    294. 

  294. 

  295. </ul>
    296. 

  296. <ul class="simple nested-toc-section">rawMatch
    297. 

  297.   <li><a class="reference" href="#rawMatch%2Cstring%2CPeg%2Cint%2CCaptures" title="rawMatch(s: string; p: Peg; start: int; c: var Captures): int">rawMatch(s: string; p: Peg; start: int; c: var Captures): int</a></li>
    298. 

  298. 

  299. </ul>
    300. 

  300. <ul class="simple nested-toc-section">replace
    301. 

  301.   <li><a class="reference" href="#replace%2Cstring%2CPeg%2Cproc%28int%2Cint%2CopenArray%5Bstring%5D%29" title="replace(s: string; sub: Peg;
    302. 

  302.         cb: proc (match: int; cnt: int; caps: openArray[string]): string): string">replace(s: string; sub: Peg;
    303. 

  303.         cb: proc (match: int; cnt: int; caps: openArray[string]): string): string</a></li>
    304. 

  304. <li><a class="reference" href="#replace%2Cstring%2CPeg%2Cstring" title="replace(s: string; sub: Peg; by = &quot;&quot;): string">replace(s: string; sub: Peg; by = &quot;&quot;): string</a></li>
    305. 

  305. 

  306. </ul>
    307. 

  307. <ul class="simple nested-toc-section">replacef
    308. 

  308.   <li><a class="reference" href="#replacef%2Cstring%2CPeg%2Cstring" title="replacef(s: string; sub: Peg; by: string): string">replacef(s: string; sub: Peg; by: string): string</a></li>
    309. 

  309. 

  310. </ul>
    311. 

  311. <ul class="simple nested-toc-section">rule
    312. 

  312.   <li><a class="reference" href="#rule%2CNonTerminal" title="rule(nt: NonTerminal): Peg">rule(nt: NonTerminal): Peg</a></li>
    313. 

  313. 

  314. </ul>
    315. 

  315. <ul class="simple nested-toc-section">sequence
    316. 

  316.   <li><a class="reference" href="#sequence%2Cvarargs%5BPeg%5D" title="sequence(a: varargs[Peg]): Peg">sequence(a: varargs[Peg]): Peg</a></li>
    317. 

  317. 

  318. </ul>
    319. 

  319. <ul class="simple nested-toc-section">split
    320. 

  320.   <li><a class="reference" href="#split%2Cstring%2CPeg" title="split(s: string; sep: Peg): seq[string]">split(s: string; sep: Peg): seq[string]</a></li>
    321. 

  321. 

  322. </ul>
    323. 

  323. <ul class="simple nested-toc-section">startAnchor
    324. 

  324.   <li><a class="reference" href="#startAnchor" title="startAnchor(): Peg">startAnchor(): Peg</a></li>
    325. 

  325. 

  326. </ul>
    327. 

  327. <ul class="simple nested-toc-section">startsWith
    328. 

  328.   <li><a class="reference" href="#startsWith%2Cstring%2CPeg%2Cint" title="startsWith(s: string; prefix: Peg; start = 0): bool">startsWith(s: string; prefix: Peg; start = 0): bool</a></li>
    329. 

  329. 

  330. </ul>
    331. 

  331. <ul class="simple nested-toc-section">term
    332. 

  332.   <li><a class="reference" href="#term%2CPeg" title="term(p: Peg): string">term(p: Peg): string</a></li>
    333. 

  333. <li><a class="reference" href="#term%2Cchar" title="term(t: char): Peg">term(t: char): Peg</a></li>
    334. 

  334. <li><a class="reference" href="#term%2Cstring" title="term(t: string): Peg">term(t: string): Peg</a></li>
    335. 

  335. 

  336. </ul>
    337. 

  337. <ul class="simple nested-toc-section">termIgnoreCase
    338. 

  338.   <li><a class="reference" href="#termIgnoreCase%2Cstring" title="termIgnoreCase(t: string): Peg">termIgnoreCase(t: string): Peg</a></li>
    339. 

  339. 

  340. </ul>
    341. 

  341. <ul class="simple nested-toc-section">termIgnoreStyle
    342. 

  342.   <li><a class="reference" href="#termIgnoreStyle%2Cstring" title="termIgnoreStyle(t: string): Peg">termIgnoreStyle(t: string): Peg</a></li>
    343. 

  343. 

  344. </ul>
    345. 

  345. <ul class="simple nested-toc-section">transformFile
    346. 

  346.   <li><a class="reference" href="#transformFile%2Cstring%2Cstring%2Cvarargs%5Btuple%5BPeg%2Cstring%5D%5D" title="transformFile(infile, outfile: string;
    347. 

  347.               subs: varargs[tuple[pattern: Peg, repl: string]])">transformFile(infile, outfile: string;
    348. 

  348.               subs: varargs[tuple[pattern: Peg, repl: string]])</a></li>
    349. 

  349. 

  350. </ul>
    351. 

  351. <ul class="simple nested-toc-section">unicodeLetter
    352. 

  352.   <li><a class="reference" href="#unicodeLetter" title="unicodeLetter(): Peg">unicodeLetter(): Peg</a></li>
    353. 

  353. 

  354. </ul>
    355. 

  355. <ul class="simple nested-toc-section">unicodeLower
    356. 

  356.   <li><a class="reference" href="#unicodeLower" title="unicodeLower(): Peg">unicodeLower(): Peg</a></li>
    357. 

  357. 

  358. </ul>
    359. 

  359. <ul class="simple nested-toc-section">unicodeTitle
    360. 

  360.   <li><a class="reference" href="#unicodeTitle" title="unicodeTitle(): Peg">unicodeTitle(): Peg</a></li>
    361. 

  361. 

  362. </ul>
    363. 

  363. <ul class="simple nested-toc-section">unicodeUpper
    364. 

  364.   <li><a class="reference" href="#unicodeUpper" title="unicodeUpper(): Peg">unicodeUpper(): Peg</a></li>
    365. 

  365. 

  366. </ul>
    367. 

  367. <ul class="simple nested-toc-section">unicodeWhitespace
    368. 

  368.   <li><a class="reference" href="#unicodeWhitespace" title="unicodeWhitespace(): Peg">unicodeWhitespace(): Peg</a></li>
    369. 

  369. 

  370. </ul>
    371. 

  371. 

  372.     </ul>
    373. 

  373.   </details>
    374. 

  374. </li>
    375. 

  375. <li>
    376. 

  376.   <details open>
    377. 

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

  378.     <ul class="simple simple-toc-section">
    379. 

  379.       <ul class="simple nested-toc-section">findAll
    380. 

  380.   <li><a class="reference" href="#findAll.i%2Cstring%2CPeg%2Cint" title="findAll(s: string; pattern: Peg; start = 0): string">findAll(s: string; pattern: Peg; start = 0): string</a></li>
    381. 

  381. 

  382. </ul>
    383. 

  383. <ul class="simple nested-toc-section">items
    384. 

  384.   <li><a class="reference" href="#items.i%2CPeg" title="items(p: Peg): Peg">items(p: Peg): Peg</a></li>
    385. 

  385. 

  386. </ul>
    387. 

  387. <ul class="simple nested-toc-section">pairs
    388. 

  388.   <li><a class="reference" href="#pairs.i%2CPeg" title="pairs(p: Peg): (int, Peg)">pairs(p: Peg): (int, Peg)</a></li>
    389. 

  389. 

  390. </ul>
    391. 

  391. <ul class="simple nested-toc-section">split
    392. 

  392.   <li><a class="reference" href="#split.i%2Cstring%2CPeg" title="split(s: string; sep: Peg): string">split(s: string; sep: Peg): string</a></li>
    393. 

  393. 

  394. </ul>
    395. 

  395. 

  396.     </ul>
    397. 

  397.   </details>
    398. 

  398. </li>
    399. 

  399. <li>
    400. 

  400.   <details open>
    401. 

  401.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    402. 

  402.     <ul class="simple simple-toc-section">
    403. 

  403.       <ul class="simple nested-toc-section">=~
    404. 

  404.   <li><a class="reference" href="#%3D~.t%2Cstring%2CPeg" title="`=~`(s: string; pattern: Peg): bool">`=~`(s: string; pattern: Peg): bool</a></li>
    405. 

  405. 

  406. </ul>
    407. 

  407. <ul class="simple nested-toc-section">digits
    408. 

  408.   <li><a class="reference" href="#digits.t" title="digits(): Peg">digits(): Peg</a></li>
    409. 

  409. 

  410. </ul>
    411. 

  411. <ul class="simple nested-toc-section">eventParser
    412. 

  412.   <li><a class="reference" href="#eventParser.t%2Cuntyped%2Cuntyped" title="eventParser(pegAst, handlers: untyped): (proc (s: string): int)">eventParser(pegAst, handlers: untyped): (proc (s: string): int)</a></li>
    413. 

  413. 

  414. </ul>
    415. 

  415. <ul class="simple nested-toc-section">ident
    416. 

  416.   <li><a class="reference" href="#ident.t" title="ident(): Peg">ident(): Peg</a></li>
    417. 

  417. 

  418. </ul>
    419. 

  419. <ul class="simple nested-toc-section">identChars
    420. 

  420.   <li><a class="reference" href="#identChars.t" title="identChars(): Peg">identChars(): Peg</a></li>
    421. 

  421. 

  422. </ul>
    423. 

  423. <ul class="simple nested-toc-section">identStartChars
    424. 

  424.   <li><a class="reference" href="#identStartChars.t" title="identStartChars(): Peg">identStartChars(): Peg</a></li>
    425. 

  425. 

  426. </ul>
    427. 

  427. <ul class="simple nested-toc-section">letters
    428. 

  428.   <li><a class="reference" href="#letters.t" title="letters(): Peg">letters(): Peg</a></li>
    429. 

  429. 

  430. </ul>
    431. 

  431. <ul class="simple nested-toc-section">natural
    432. 

  432.   <li><a class="reference" href="#natural.t" title="natural(): Peg">natural(): Peg</a></li>
    433. 

  433. 

  434. </ul>
    435. 

  435. <ul class="simple nested-toc-section">whitespace
    436. 

  436.   <li><a class="reference" href="#whitespace.t" title="whitespace(): Peg">whitespace(): Peg</a></li>
    437. 

  437. 

  438. </ul>
    439. 

  439. 

  440.     </ul>
    441. 

  441.   </details>
    442. 

  442. </li>
    443. 

  443. 

  444. </ul>
    445. 

  445. 

  446.   </div>
    447. 

  447.   <div class="nine columns" id="content">
    448. 

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

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

  450. 

  451.     <div id="tocRoot"></div>
    452. 

  452.     
    453. 

  453.     <p class="module-desc">Simple PEG (Parsing expression grammar) matching. Uses no memorization, but uses superoperators and symbol inlining to improve performance. Note: Matching performance is hopefully competitive with optimized regular expression engines.
    454. 

  454. <h1><a class="toc-backref" id="peg-syntax-and-semantics" href="#peg-syntax-and-semantics">PEG syntax and semantics</a></h1><p>A PEG (Parsing expression grammar) is a simple deterministic grammar, that can be directly used for parsing. The current implementation has been designed as a more powerful replacement for regular expressions. UTF-8 is supported.</p>
    455. 

  455. <p>The notation used for a PEG is similar to that of EBNF:</p>
    456. 

  456. <table border="1" class="docutils"><tr><th>notation</th><th>meaning</th></tr>
    457. 

  457. <tr><td><tt class="docutils literal"><span class="pre">A / ... / Z</span></tt></td><td>Ordered choice: Apply expressions <tt class="docutils literal"><span class="pre"><span class="Identifier">A</span></span></tt>, ..., <tt class="docutils literal"><span class="pre"><span class="Identifier">Z</span></span></tt>, in this order, to the text ahead, until one of them succeeds and possibly consumes some text. Indicate success if one of expressions succeeded. Otherwise, do not consume any text and indicate failure.</td></tr>
    458. 

  458. <tr><td><tt class="docutils literal"><span class="pre">A ... Z</span></tt></td><td>Sequence: Apply expressions <tt class="docutils literal"><span class="pre"><span class="Identifier">A</span></span></tt>, ..., <tt class="docutils literal"><span class="pre"><span class="Identifier">Z</span></span></tt>, in this order, to consume consecutive portions of the text ahead, as long as they succeed. Indicate success if all succeeded. Otherwise, do not consume any text and indicate failure. The sequence's precedence is higher than that of ordered choice: <tt class="docutils literal"><span class="pre">A B / C</span></tt> means <tt class="docutils literal"><span class="pre">(A B) / Z</span></tt> and not <tt class="docutils literal"><span class="pre">A (B / Z)</span></tt>.</td></tr>
    459. 

  459. <tr><td><tt class="docutils literal"><span class="pre">(E)</span></tt></td><td>Grouping: Parenthesis can be used to change operator priority.</td></tr>
    460. 

  460. <tr><td><tt class="docutils literal"><span class="pre">{E}</span></tt></td><td>Capture: Apply expression <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> and store the substring that matched <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> into a <em>capture</em> that can be accessed after the matching process.</td></tr>
    461. 

  461. <tr><td><tt class="docutils literal"><span class="pre">{}</span></tt></td><td>Empty capture: Delete the last capture. No character is consumed.</td></tr>
    462. 

  462. <tr><td><tt class="docutils literal"><span class="pre">$i</span></tt></td><td>Back reference to the <tt class="docutils literal"><span class="pre">i</span></tt>th capture. <tt class="docutils literal"><span class="pre">i</span></tt> counts forwards from 1 or backwards (last capture to first) from ^1.</td></tr>
    463. 

  463. <tr><td><tt class="docutils literal"><span class="pre">$</span></tt></td><td>Anchor: Matches at the end of the input. No character is consumed. Same as <tt class="docutils literal"><span class="pre">!.</span></tt>.</td></tr>
    464. 

  464. <tr><td><tt class="docutils literal"><span class="pre">^</span></tt></td><td>Anchor: Matches at the start of the input. No character is consumed.</td></tr>
    465. 

  465. <tr><td><tt class="docutils literal"><span class="pre">&amp;E</span></tt></td><td>And predicate: Indicate success if expression <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> matches the text ahead; otherwise indicate failure. Do not consume any text.</td></tr>
    466. 

  466. <tr><td><tt class="docutils literal"><span class="pre">!E</span></tt></td><td>Not predicate: Indicate failure if expression E matches the text ahead; otherwise indicate success. Do not consume any text.</td></tr>
    467. 

  467. <tr><td><tt class="docutils literal"><span class="pre">E+</span></tt></td><td>One or more: Apply expression <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> repeatedly to match the text ahead, as long as it succeeds. Consume the matched text (if any) and indicate success if there was at least one match. Otherwise, indicate failure.</td></tr>
    468. 

  468. <tr><td><tt class="docutils literal"><span class="pre">E*</span></tt></td><td>Zero or more: Apply expression <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> repeatedly to match the text ahead, as long as it succeeds. Consume the matched text (if any). Always indicate success.</td></tr>
    469. 

  469. <tr><td><tt class="docutils literal"><span class="pre">E?</span></tt></td><td>Zero or one: If expression <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> matches the text ahead, consume it. Always indicate success.</td></tr>
    470. 

  470. <tr><td><tt class="docutils literal"><span class="pre">[s]</span></tt></td><td>Character class: If the character ahead appears in the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>, consume it and indicate success. Otherwise, indicate failure.</td></tr>
    471. 

  471. <tr><td><tt class="docutils literal"><span class="pre">[a-b]</span></tt></td><td>Character range: If the character ahead is one from the range <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> through <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>, consume it and indicate success. Otherwise, indicate failure.</td></tr>
    472. 

  472. <tr><td><tt class="docutils literal"><span class="pre">'s'</span></tt></td><td>String: If the text ahead is the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>, consume it and indicate success. Otherwise, indicate failure.</td></tr>
    473. 

  473. <tr><td><tt class="docutils literal"><span class="pre">i's'</span></tt></td><td>String match ignoring case.</td></tr>
    474. 

  474. <tr><td><tt class="docutils literal"><span class="pre">y's'</span></tt></td><td>String match ignoring style.</td></tr>
    475. 

  475. <tr><td><tt class="docutils literal"><span class="pre">v's'</span></tt></td><td>Verbatim string match: Use this to override a global <tt class="docutils literal"><span class="pre">\i</span></tt> or <tt class="docutils literal"><span class="pre">\y</span></tt> modifier.</td></tr>
    476. 

  476. <tr><td><tt class="docutils literal"><span class="pre">i$j</span></tt></td><td>String match ignoring case for back reference.</td></tr>
    477. 

  477. <tr><td><tt class="docutils literal"><span class="pre">y$j</span></tt></td><td>String match ignoring style for back reference.</td></tr>
    478. 

  478. <tr><td><tt class="docutils literal"><span class="pre">v$j</span></tt></td><td>Verbatim string match for back reference.</td></tr>
    479. 

  479. <tr><td><tt class="docutils literal"><span class="pre">.</span></tt></td><td>Any character: If there is a character ahead, consume it and indicate success. Otherwise, (that is, at the end of input) indicate failure.</td></tr>
    480. 

  480. <tr><td><tt class="docutils literal"><span class="pre">_</span></tt></td><td>Any Unicode character: If there is a UTF-8 character ahead, consume it and indicate success. Otherwise, indicate failure.</td></tr>
    481. 

  481. <tr><td><tt class="docutils literal"><span class="pre">@E</span></tt></td><td>Search: Shorthand for <tt class="docutils literal"><span class="pre">(!E .)* E</span></tt>. (Search loop for the pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt>.)</td></tr>
    482. 

  482. <tr><td><tt class="docutils literal"><span class="pre">{@} E</span></tt></td><td>Captured Search: Shorthand for <tt class="docutils literal"><span class="pre">{(!E .)*} E</span></tt>. (Search loop for the pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt>.) Everything until and excluding <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> is captured.</td></tr>
    483. 

  483. <tr><td><tt class="docutils literal"><span class="pre">@@ E</span></tt></td><td>Same as <tt class="docutils literal"><span class="pre">{@} E</span></tt>.</td></tr>
    484. 

  484. <tr><td><tt class="docutils literal"><span class="pre">A &lt;- E</span></tt></td><td>Rule: Bind the expression <tt class="docutils literal"><span class="pre"><span class="Identifier">E</span></span></tt> to the <em>nonterminal symbol</em> <tt class="docutils literal"><span class="pre"><span class="Identifier">A</span></span></tt>. <strong>Left recursive rules are not possible and crash the matching engine.</strong></td></tr>
    485. 

  485. <tr><td><tt class="docutils literal"><span class="pre">\identifier</span></tt></td><td>Built-in macro for a longer expression.</td></tr>
    486. 

  486. <tr><td><tt class="docutils literal"><span class="pre">\ddd</span></tt></td><td>Character with decimal code <em>ddd</em>.</td></tr>
    487. 

  487. <tr><td><tt class="docutils literal"><span class="pre">\&quot;</span></tt>, etc.</td><td>Literal <tt class="docutils literal"><span class="pre">&quot;</span></tt>, etc.</td></tr>
    488. 

  488. </table>
    489. 

  489. <h2><a class="toc-backref" id="peg-syntax-and-semantics-builtminusin-macros" href="#peg-syntax-and-semantics-builtminusin-macros">Built-in macros</a></h2><table border="1" class="docutils"><tr><th>macro</th><th>meaning</th></tr>
    490. 

  490. <tr><td><tt class="docutils literal"><span class="pre">\d</span></tt></td><td>any decimal digit: <tt class="docutils literal"><span class="pre">[0-9]</span></tt></td></tr>
    491. 

  491. <tr><td><tt class="docutils literal"><span class="pre">\D</span></tt></td><td>any character that is not a decimal digit: <tt class="docutils literal"><span class="pre">[^0-9]</span></tt></td></tr>
    492. 

  492. <tr><td><tt class="docutils literal"><span class="pre">\s</span></tt></td><td>any whitespace character: <tt class="docutils literal"><span class="pre">[ \9-\13]</span></tt></td></tr>
    493. 

  493. <tr><td><tt class="docutils literal"><span class="pre">\S</span></tt></td><td>any character that is not a whitespace character: <tt class="docutils literal"><span class="pre">[^ \9-\13]</span></tt></td></tr>
    494. 

  494. <tr><td><tt class="docutils literal"><span class="pre">\w</span></tt></td><td>any &quot;word&quot; character: <tt class="docutils literal"><span class="pre">[a-zA-Z0-9_]</span></tt></td></tr>
    495. 

  495. <tr><td><tt class="docutils literal"><span class="pre">\W</span></tt></td><td>any &quot;non-word&quot; character: <tt class="docutils literal"><span class="pre">[^a-zA-Z0-9_]</span></tt></td></tr>
    496. 

  496. <tr><td><tt class="docutils literal"><span class="pre">\a</span></tt></td><td>same as <tt class="docutils literal"><span class="pre">[a-zA-Z]</span></tt></td></tr>
    497. 

  497. <tr><td><tt class="docutils literal"><span class="pre">\A</span></tt></td><td>same as <tt class="docutils literal"><span class="pre">[^a-zA-Z]</span></tt></td></tr>
    498. 

  498. <tr><td><tt class="docutils literal"><span class="pre">\n</span></tt></td><td>any newline combination: <tt class="docutils literal"><span class="pre">\10 / \13\10 / \13</span></tt></td></tr>
    499. 

  499. <tr><td><tt class="docutils literal"><span class="pre">\i</span></tt></td><td>ignore case for matching; use this at the start of the PEG</td></tr>
    500. 

  500. <tr><td><tt class="docutils literal"><span class="pre">\y</span></tt></td><td>ignore style for matching; use this at the start of the PEG</td></tr>
    501. 

  501. <tr><td><tt class="docutils literal"><span class="pre">\skip</span></tt> pat</td><td>skip pattern <em>pat</em> before trying to match other tokens; this is useful for whitespace skipping, for example: <tt class="docutils literal"><span class="pre">\skip(\s*) {\ident} ':' {\ident}</span></tt> matches key value pairs ignoring whitespace around the <tt class="docutils literal"><span class="pre">':'</span></tt>.</td></tr>
    502. 

  502. <tr><td><tt class="docutils literal"><span class="pre">\ident</span></tt></td><td>a standard ASCII identifier: <tt class="docutils literal"><span class="pre">[a-zA-Z_][a-zA-Z_0-9]*</span></tt></td></tr>
    503. 

  503. <tr><td><tt class="docutils literal"><span class="pre">\letter</span></tt></td><td>any Unicode letter</td></tr>
    504. 

  504. <tr><td><tt class="docutils literal"><span class="pre">\upper</span></tt></td><td>any Unicode uppercase letter</td></tr>
    505. 

  505. <tr><td><tt class="docutils literal"><span class="pre">\lower</span></tt></td><td>any Unicode lowercase letter</td></tr>
    506. 

  506. <tr><td><tt class="docutils literal"><span class="pre">\title</span></tt></td><td>any Unicode title letter</td></tr>
    507. 

  507. <tr><td><tt class="docutils literal"><span class="pre">\white</span></tt></td><td>any Unicode whitespace character</td></tr>
    508. 

  508. </table><p>A backslash followed by a letter is a built-in macro, otherwise it is used for ordinary escaping:</p>
    509. 

  509. <table border="1" class="docutils"><tr><th>notation</th><th>meaning</th></tr>
    510. 

  510. <tr><td><tt class="docutils literal"><span class="pre">\\</span></tt></td><td>a single backslash</td></tr>
    511. 

  511. <tr><td><tt class="docutils literal"><span class="pre">\*</span></tt></td><td>same as <tt class="docutils literal"><span class="pre">'*'</span></tt></td></tr>
    512. 

  512. <tr><td><tt class="docutils literal"><span class="pre">\t</span></tt></td><td>not a tabulator, but an (unknown) built-in</td></tr>
    513. 

  513. </table>
    514. 

  514. <h2><a class="toc-backref" id="peg-syntax-and-semantics-supported-peg-grammar" href="#peg-syntax-and-semantics-supported-peg-grammar">Supported PEG grammar</a></h2><p>The PEG parser implements this grammar (written in PEG syntax):</p>
    515. 

  515. <pre># Example grammar of PEG in PEG syntax.
    516. 

  516. # Comments start with '#'.
    517. 

  517. # First symbol is the start symbol.
    518. 

  518. 

  519. grammar &lt;- rule* / expr
    520. 

  520. 

  521. identifier &lt;- [A-Za-z][A-Za-z0-9_]*
    522. 

  522. charsetchar &lt;- &quot;\\&quot; . / [^\]]
    523. 

  523. charset &lt;- &quot;[&quot; &quot;^&quot;? (charsetchar (&quot;-&quot; charsetchar)?)+ &quot;]&quot;
    524. 

  524. stringlit &lt;- identifier? (&quot;\&quot;&quot; (&quot;\\&quot; . / [^&quot;])* &quot;\&quot;&quot; /
    525. 

  525.                           &quot;'&quot; (&quot;\\&quot; . / [^'])* &quot;'&quot;)
    526. 

  526. builtin &lt;- &quot;\\&quot; identifier / [^\13\10]
    527. 

  527. 

  528. comment &lt;- '#' @ \n
    529. 

  529. ig &lt;- (\s / comment)* # things to ignore
    530. 

  530. 

  531. rule &lt;- identifier \s* &quot;&lt;-&quot; expr ig
    532. 

  532. identNoArrow &lt;- identifier !(\s* &quot;&lt;-&quot;)
    533. 

  533. prefixOpr &lt;- ig '&amp;' / ig '!' / ig '@' / ig '{@}' / ig '@@'
    534. 

  534. literal &lt;- ig identifier? '$' '^'? [0-9]+ / '$' / '^' /
    535. 

  535.            ig identNoArrow /
    536. 

  536.            ig charset /
    537. 

  537.            ig stringlit /
    538. 

  538.            ig builtin /
    539. 

  539.            ig '.' /
    540. 

  540.            ig '_' /
    541. 

  541.            (ig &quot;(&quot; expr ig &quot;)&quot;) /
    542. 

  542.            (ig &quot;{&quot; expr? ig &quot;}&quot;)
    543. 

  543. postfixOpr &lt;- ig '?' / ig '*' / ig '+'
    544. 

  544. primary &lt;- prefixOpr* (literal postfixOpr*)
    545. 

  545. 

  546. # Concatenation has higher priority than choice:
    547. 

  547. # ``a b / c`` means ``(a b) / c``
    548. 

  548. 

  549. seqExpr &lt;- primary+
    550. 

  550. expr &lt;- seqExpr (ig &quot;/&quot; expr)*</pre>
    551. 

  551. <p><strong>Note</strong>: As a special syntactic extension if the whole PEG is only a single expression, identifiers are not interpreted as non-terminals, but are interpreted as verbatim string:</p>
    552. 

  552. <p><pre class="listing"><span class="Identifier">abc</span> <span class="Operator">=~</span> <span class="RawData">peg&quot;abc&quot;</span> <span class="Comment"># is true</span></pre></p>
    553. 

  553. <p>So it is not necessary to write <tt class="docutils literal"><span class="pre">peg&quot; 'abc' &quot;</span></tt> in the above example.</p>
    554. 

  554. 

  555. <h2><a class="toc-backref" id="peg-syntax-and-semantics-examples" href="#peg-syntax-and-semantics-examples">Examples</a></h2><p>Check if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> matches Nim's &quot;while&quot; keyword:</p>
    556. 

  556. <p><pre class="listing"><span class="Identifier">s</span> <span class="Operator">=~</span> <span class="RawData">peg&quot; y'while'&quot;</span></pre></p>
    557. 

  557. <p>Exchange (key, val)-pairs:</p>
    558. 

  558. <p><pre class="listing"><span class="StringLit">&quot;key: val; key2: val2&quot;</span><span class="Operator">.</span><span class="Identifier">replacef</span><span class="Punctuation">(</span><span class="RawData">peg&quot;{\ident} \s* ':' \s* {\ident}&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;$2: $1&quot;</span><span class="Punctuation">)</span></pre></p>
    559. 

  559. <p>Determine the <tt class="docutils literal"><span class="pre">#include</span></tt>'ed files of a C file:</p>
    560. 

  560. <p><pre class="listing"><span class="Keyword">for</span> <span class="Identifier">line</span> <span class="Keyword">in</span> <span class="Identifier">lines</span><span class="Punctuation">(</span><span class="StringLit">&quot;myfile.c&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    561. 

  561.   <span class="Keyword">if</span> <span class="Identifier">line</span> <span class="Operator">=~</span> <span class="LongStringLit">peg&quot;&quot;&quot;s &lt;- ws '#include' ws '&quot;' {[^&quot;]+} '&quot;' ws
    562. 

  562.                    comment &lt;- '/*' @ '*/' / '//' .*
    563. 

  563.                    ws &lt;- (comment / \s+)* &quot;&quot;&quot;</span><span class="Punctuation">:</span>
    564. 

  564.     <span class="Identifier">echo</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span></pre></p>
    565. 

  565. 

  566. <h2><a class="toc-backref" id="peg-syntax-and-semantics-peg-vs-regular-expression" href="#peg-syntax-and-semantics-peg-vs-regular-expression">PEG vs regular expression</a></h2><p>As a regular expression <tt class="docutils literal"><span class="pre">\[.*\]</span></tt> matches the longest possible text between <tt class="docutils literal"><span class="pre">'['</span></tt> and <tt class="docutils literal"><span class="pre">']'</span></tt>. As a PEG it never matches anything, because a PEG is deterministic: <tt class="docutils literal"><span class="pre">.*</span></tt> consumes the rest of the input, so <tt class="docutils literal"><span class="pre">\]</span></tt> never matches. As a PEG this needs to be written as: <tt class="docutils literal"><span class="pre">\[ ( !\] . )* \]</span></tt> (or <tt class="docutils literal"><span class="pre">\[ @ \]</span></tt>).</p>
    567. 

  567. <p>Note that the regular expression does not behave as intended either: in the example <tt class="docutils literal"><span class="pre">*</span></tt> should not be greedy, so <tt class="docutils literal"><span class="pre">\[.*?\]</span></tt> should be used instead.</p>
    568. 

  568. 

  569. <h2><a class="toc-backref" id="peg-syntax-and-semantics-peg-construction" href="#peg-syntax-and-semantics-peg-construction">PEG construction</a></h2><p>There are two ways to construct a PEG in Nim code:</p>
    570. 

  570. <ol class="simple"><li>Parsing a string into an AST which consists of <tt class="docutils literal"><span class="pre"><span class="Identifier">Peg</span></span></tt> nodes with the <tt class="docutils literal"><span class="pre"><span class="Identifier">peg</span></span></tt> proc.</li>
    571. 

  571. <li>Constructing the AST directly with proc calls. This method does not support constructing rules, only simple expressions and is not as convenient. Its only advantage is that it does not pull in the whole PEG parser into your executable.</li>
    572. 

  572. </ol>
    573. 

  573. </p>
    574. 

  574.     <div class="section" id="6">
    575. 

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

  576.   <dl class="item">
    577. 

  577.     <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="macros.html">macros</a>, <a class="reference external" href="decode_helpers.html">decode_helpers</a>, <a class="reference external" href="unicode.html">unicode</a>
    578. 

  578.   </dl>
    579. 

  579. </div>
    580. 

  580. <div class="section" id="7">
    581. 

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

  582.   <dl class="item">
    583. 

  583.     <div id="Captures">
    584. 

  584.   <dt><pre><a href="pegs.html#Captures"><span class="Identifier">Captures</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
    585. 

  585.   <dd>
    586. 

  586.     
    587. 

  587.     contains the captured substrings.
    588. 

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

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

  590. 

  591.   </dd>
    592. 

  592. </div>
    593. 

  593. <div id="EInvalidPeg">
    594. 

  594.   <dt><pre><a href="pegs.html#EInvalidPeg"><span class="Identifier">EInvalidPeg</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#ValueError"><span class="Identifier">ValueError</span></a></pre></dt>
    595. 

  595.   <dd>
    596. 

  596.     
    597. 

  597.     raised if an invalid PEG has been detected
    598. 

  598.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1815" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    599. 

  599. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1815" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    600. 

  600. 

  601.   </dd>
    602. 

  602. </div>
    603. 

  603. <div id="NonTerminal">
    604. 

  604.   <dt><pre><a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">NonTerminalObj</span></pre></dt>
    605. 

  605.   <dd>
    606. 

  606.     
    607. 

  607.     
    608. 

  608.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L90" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    609. 

  609. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L90" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    610. 

  610. 

  611.   </dd>
    612. 

  612. </div>
    613. 

  613. <div id="NonTerminalFlag">
    614. 

  614.   <dt><pre><a href="pegs.html#NonTerminalFlag"><span class="Identifier">NonTerminalFlag</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    615. 

  615.   <span class="Identifier">ntDeclared</span><span class="Other">,</span> <span class="Identifier">ntUsed</span></pre></dt>
    616. 

  616.   <dd>
    617. 

  617.     
    618. 

  618.     
    619. 

  619.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L73" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    620. 

  620. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L73" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    621. 

  621. 

  622.   </dd>
    623. 

  623. </div>
    624. 

  624. <div id="Peg">
    625. 

  625.   <dt><pre><a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">shallow</span>.} <span class="Other">=</span> <span class="Keyword">object</span>
    626. 

  626.   <span class="Keyword">case</span>
    627. 

  627.   <span class="Keyword">of</span> <span class="Identifier">pkEmpty</span> <span class="Operator">..</span> <span class="Identifier">pkWhitespace</span><span class="Other">:</span>
    628. 

  628.     <span class="Keyword">nil</span>
    629. 

  629.   <span class="Keyword">of</span> <span class="Identifier">pkTerminal</span><span class="Other">,</span> <span class="Identifier">pkTerminalIgnoreCase</span><span class="Other">,</span> <span class="Identifier">pkTerminalIgnoreStyle</span><span class="Other">:</span>
    630. 

  630.   <span class="Keyword">of</span> <span class="Identifier">pkChar</span><span class="Other">,</span> <span class="Identifier">pkGreedyRepChar</span><span class="Other">:</span>
    631. 

  631.   <span class="Keyword">of</span> <span class="Identifier">pkCharChoice</span><span class="Other">,</span> <span class="Identifier">pkGreedyRepSet</span><span class="Other">:</span>
    632. 

  632.   <span class="Keyword">of</span> <span class="Identifier">pkNonTerminal</span><span class="Other">:</span>
    633. 

  633.   <span class="Keyword">of</span> <span class="Identifier">pkBackRef</span> <span class="Operator">..</span> <span class="Identifier">pkBackRefIgnoreStyle</span><span class="Other">:</span>
    634. 

  634.   <span class="Keyword">else</span><span class="Other">:</span></pre></dt>
    635. 

  635.   <dd>
    636. 

  636.     
    637. 

  637.     type that represents a PEG
    638. 

  638.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L81" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    639. 

  639. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L81" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    640. 

  640. 

  641.   </dd>
    642. 

  642. </div>
    643. 

  643. <div id="PegKind">
    644. 

  644.   <dt><pre><a href="pegs.html#PegKind"><span class="Identifier">PegKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    645. 

  645.   <span class="Identifier">pkEmpty</span><span class="Other">,</span> <span class="Identifier">pkAny</span><span class="Other">,</span>           <span class="Comment">## any character (.)</span>
    646. 

  646.   <span class="Identifier">pkAnyRune</span><span class="Other">,</span>                <span class="Comment">## any Unicode character (_)</span>
    647. 

  647.   <span class="Identifier">pkNewLine</span><span class="Other">,</span>                <span class="Comment">## CR-LF, LF, CR</span>
    648. 

  648.   <span class="Identifier">pkLetter</span><span class="Other">,</span>                 <span class="Comment">## Unicode letter</span>
    649. 

  649.   <span class="Identifier">pkLower</span><span class="Other">,</span>                  <span class="Comment">## Unicode lower case letter</span>
    650. 

  650.   <span class="Identifier">pkUpper</span><span class="Other">,</span>                  <span class="Comment">## Unicode upper case letter</span>
    651. 

  651.   <span class="Identifier">pkTitle</span><span class="Other">,</span>                  <span class="Comment">## Unicode title character</span>
    652. 

  652.   <span class="Identifier">pkWhitespace</span><span class="Other">,</span>             <span class="Comment">## Unicode whitespace character</span>
    653. 

  653.   <span class="Identifier">pkTerminal</span><span class="Other">,</span> <span class="Identifier">pkTerminalIgnoreCase</span><span class="Other">,</span> <span class="Identifier">pkTerminalIgnoreStyle</span><span class="Other">,</span> <span class="Identifier">pkChar</span><span class="Other">,</span> <span class="Comment">## single character to match</span>
    654. 

  654.   <span class="Identifier">pkCharChoice</span><span class="Other">,</span> <span class="Identifier">pkNonTerminal</span><span class="Other">,</span> <span class="Identifier">pkSequence</span><span class="Other">,</span> <span class="Comment">## a b c ... --&gt; Internal DSL: peg(a, b, c)</span>
    655. 

  655.   <span class="Identifier">pkOrderedChoice</span><span class="Other">,</span>          <span class="Comment">## a / b / ... --&gt; Internal DSL: a / b or /[a, b, c]</span>
    656. 

  656.   <span class="Identifier">pkGreedyRep</span><span class="Other">,</span>              <span class="Comment">## a*     --&gt; Internal DSL: *a</span>
    657. 

  657.                              <span class="Comment">## a+     --&gt; (a a*)</span>
    658. 

  658.   <span class="Identifier">pkGreedyRepChar</span><span class="Other">,</span>          <span class="Comment">## x* where x is a single character (superop)</span>
    659. 

  659.   <span class="Identifier">pkGreedyRepSet</span><span class="Other">,</span>           <span class="Comment">## [set]* (superop)</span>
    660. 

  660.   <span class="Identifier">pkGreedyAny</span><span class="Other">,</span>              <span class="Comment">## .* or _* (superop)</span>
    661. 

  661.   <span class="Identifier">pkOption</span><span class="Other">,</span>                 <span class="Comment">## a?     --&gt; Internal DSL: ?a</span>
    662. 

  662.   <span class="Identifier">pkAndPredicate</span><span class="Other">,</span>           <span class="Comment">## &amp;a     --&gt; Internal DSL: &amp;a</span>
    663. 

  663.   <span class="Identifier">pkNotPredicate</span><span class="Other">,</span>           <span class="Comment">## !a     --&gt; Internal DSL: !a</span>
    664. 

  664.   <span class="Identifier">pkCapture</span><span class="Other">,</span>                <span class="Comment">## {a}    --&gt; Internal DSL: capture(a)</span>
    665. 

  665.   <span class="Identifier">pkBackRef</span><span class="Other">,</span>                <span class="Comment">## $i     --&gt; Internal DSL: backref(i)</span>
    666. 

  666.   <span class="Identifier">pkBackRefIgnoreCase</span><span class="Other">,</span> <span class="Identifier">pkBackRefIgnoreStyle</span><span class="Other">,</span> <span class="Identifier">pkSearch</span><span class="Other">,</span> <span class="Comment">## @a     --&gt; Internal DSL: !*a</span>
    667. 

  667.   <span class="Identifier">pkCapturedSearch</span><span class="Other">,</span>         <span class="Comment">## {@} a  --&gt; Internal DSL: !*\a</span>
    668. 

  668.   <span class="Identifier">pkRule</span><span class="Other">,</span>                   <span class="Comment">## a &lt;- b</span>
    669. 

  669.   <span class="Identifier">pkList</span><span class="Other">,</span>                   <span class="Comment">## a, b</span>
    670. 

  670.   <span class="Identifier">pkStartAnchor</span>              <span class="Comment">## ^      --&gt; Internal DSL: startAnchor()</span></pre></dt>
    671. 

  671.   <dd>
    672. 

  672.     
    673. 

  673.     
    674. 

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

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

  676. 

  677.   </dd>
    678. 

  678. </div>
    679. 

  679. 

  680.   </dl>
    681. 

  681. </div>
    682. 

  682. <div class="section" id="10">
    683. 

  683.   <h1><a class="toc-backref" href="#10">Consts</a></h1>
    684. 

  684.   <dl class="item">
    685. 

  685.     <div id="MaxSubpatterns">
    686. 

  686.   <dt><pre><a href="pegs.html#MaxSubpatterns"><span class="Identifier">MaxSubpatterns</span></a> <span class="Other">=</span> <span class="DecNumber">20</span></pre></dt>
    687. 

  687.   <dd>
    688. 

  688.     
    689. 

  689.     defines the maximum number of subpatterns that can be captured. More subpatterns cannot be captured!
    690. 

  690.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L34" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    691. 

  691. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L34" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    692. 

  692. 

  693.   </dd>
    694. 

  694. </div>
    695. 

  695. 

  696.   </dl>
    697. 

  697. </div>
    698. 

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

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

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

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

  702.   <div id="!,Peg">
    703. 

  703.   <dt><pre><span class="Keyword">func</span> <a href="#%21%2CPeg"><span class="Identifier">`!`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsNotPredicate&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>
    704. 

  704.                         <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>
    705. 

  705.   <dd>
    706. 

  706.     
    707. 

  707.     constructs a &quot;not predicate&quot; with the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    708. 

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

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

  710. 

  711.   </dd>
    712. 

  712. </div>
    713. 

  713. 

  714. </div>
    715. 

  715. <div id="!*-procs-all">
    716. 

  716.   <div id="!*,Peg">
    717. 

  717.   <dt><pre><span class="Keyword">func</span> <a href="#%21%2A%2CPeg"><span class="Identifier">`!*`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsSearch&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>
    718. 

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

  719.   <dd>
    720. 

  720.     
    721. 

  721.     constructs a &quot;search&quot; for the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    722. 

  722.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L247" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    723. 

  723. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L247" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    724. 

  724. 

  725.   </dd>
    726. 

  726. </div>
    727. 

  727. 

  728. </div>
    729. 

  729. <div id="!*\-procs-all">
    730. 

  730.   <div id="!*\,Peg">
    731. 

  731.   <dt><pre><span class="Keyword">func</span> <a href="#%21%2A%5C%2CPeg"><span class="Identifier">`!*\`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npgegsCapturedSearch&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>
    732. 

  732.                           <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>
    733. 

  733.   <dd>
    734. 

  734.     
    735. 

  735.     constructs a &quot;captured search&quot; for the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    736. 

  736.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L251" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    737. 

  737. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L251" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    738. 

  738. 

  739.   </dd>
    740. 

  740. </div>
    741. 

  741. 

  742. </div>
    743. 

  743. <div id="$-procs-all">
    744. 

  744.   <div id="$,Peg">
    745. 

  745.   <dt><pre><span class="Keyword">func</span> <a href="#%24%2CPeg"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsToString&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>
    746. 

  746.                            <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>
    747. 

  747.   <dd>
    748. 

  748.     
    749. 

  749.     converts a PEG to its string representation
    750. 

  750.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L528" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    751. 

  751. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L528" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    752. 

  752. 

  753.   </dd>
    754. 

  754. </div>
    755. 

  755. 

  756. </div>
    757. 

  757. <div id="&amp;-procs-all">
    758. 

  758.   <div id="&,Peg">
    759. 

  759.   <dt><pre><span class="Keyword">func</span> <a href="#%26%2CPeg"><span class="Identifier">`&amp;`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsAndPredicate&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>
    760. 

  760.                         <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>
    761. 

  761.   <dd>
    762. 

  762.     
    763. 

  763.     constructs an &quot;and predicate&quot; with the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    764. 

  764.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L260" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    765. 

  765. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L260" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    766. 

  766. 

  767.   </dd>
    768. 

  768. </div>
    769. 

  769. 

  770. </div>
    771. 

  771. <div id="*-procs-all">
    772. 

  772.   <div id="*,Peg">
    773. 

  773.   <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CPeg"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsGreedyRep&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>
    774. 

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

  775.   <dd>
    776. 

  776.     
    777. 

  777.     constructs a &quot;greedy repetition&quot; for the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    778. 

  778.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L233" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    779. 

  779. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L233" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    780. 

  780. 

  781.   </dd>
    782. 

  782. </div>
    783. 

  783. 

  784. </div>
    785. 

  785. <div id="+-procs-all">
    786. 

  786.   <div id="+,Peg">
    787. 

  787.   <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CPeg"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsGreedyPosRep&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>
    788. 

  788.                         <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>
    789. 

  789.   <dd>
    790. 

  790.     
    791. 

  791.     constructs a &quot;greedy positive repetition&quot; with the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    792. 

  792.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L256" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    793. 

  793. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L256" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    794. 

  794. 

  795.   </dd>
    796. 

  796. </div>
    797. 

  797. 

  798. </div>
    799. 

  799. <div id="/-procs-all">
    800. 

  800.   <div id="/,varargs[Peg]">
    801. 

  801.   <dt><pre><span class="Keyword">func</span> <a href="#%2F%2Cvarargs%5BPeg%5D"><span class="Identifier">`/`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsOrderedChoice&quot;</span><span class="Other">,</span>
    802. 

  802.                                  <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>
    803. 

  803.   <dd>
    804. 

  804.     
    805. 

  805.     constructs an ordered choice with the PEGs in <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    806. 

  806.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L201" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    807. 

  807. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L201" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    808. 

  808. 

  809.   </dd>
    810. 

  810. </div>
    811. 

  811. 

  812. </div>
    813. 

  813. <div id="?-procs-all">
    814. 

  814.   <div id="?,Peg">
    815. 

  815.   <dt><pre><span class="Keyword">func</span> <a href="#%3F%2CPeg"><span class="Identifier">`?`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsOptional&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>
    816. 

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

  817.   <dd>
    818. 

  818.     
    819. 

  819.     constructs an optional for the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    820. 

  820.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L223" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    821. 

  821. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L223" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    822. 

  822. 

  823.   </dd>
    824. 

  824. </div>
    825. 

  825. 

  826. </div>
    827. 

  827. <div id="any-procs-all">
    828. 

  828.   <div id="any">
    829. 

  829.   <dt><pre><span class="Keyword">func</span> <a href="#any"><span class="Identifier">any</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    830. 

  830.   <dd>
    831. 

  831.     
    832. 

  832.     constructs the PEG <span id="any-character_1">any character</span> (<tt class="docutils literal"><span class="pre">.</span></tt>)
    833. 

  833.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L268" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    834. 

  834. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L268" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    835. 

  835. 

  836.   </dd>
    837. 

  837. </div>
    838. 

  838. 

  839. </div>
    840. 

  840. <div id="anyRune-procs-all">
    841. 

  841.   <div id="anyRune">
    842. 

  842.   <dt><pre><span class="Keyword">func</span> <a href="#anyRune"><span class="Identifier">anyRune</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    843. 

  843.   <dd>
    844. 

  844.     
    845. 

  845.     constructs the PEG <span id="any-rune_1">any rune</span> (<tt class="docutils literal"><span class="pre">_</span></tt>)
    846. 

  846.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L272" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    847. 

  847. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L272" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    848. 

  848. 

  849.   </dd>
    850. 

  850. </div>
    851. 

  851. 

  852. </div>
    853. 

  853. <div id="backref-procs-all">
    854. 

  854.   <div id="backref,range[],bool">
    855. 

  855.   <dt><pre><span class="Keyword">func</span> <a href="#backref%2Crange%5B%5D%2Cbool"><span class="Identifier">backref</span></a><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="Identifier">MaxSubpatterns</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">reverse</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.
    856. 

  856.     <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;npegs$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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    857. 

  857.   <dd>
    858. 

  858.     
    859. 

  859.     constructs a back reference of the given <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt> starts counting from 1. <tt class="docutils literal"><span class="pre"><span class="Identifier">reverse</span></span></tt> specifies whether indexing starts from the end of the capture list.
    860. 

  860.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L313" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    861. 

  861. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L313" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    862. 

  862. 

  863.   </dd>
    864. 

  864. </div>
    865. 

  865. 

  866. </div>
    867. 

  867. <div id="backrefIgnoreCase-procs-all">
    868. 

  868.   <div id="backrefIgnoreCase,range[],bool">
    869. 

  869.   <dt><pre><span class="Keyword">func</span> <a href="#backrefIgnoreCase%2Crange%5B%5D%2Cbool"><span class="Identifier">backrefIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="Identifier">MaxSubpatterns</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">reverse</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.
    870. 

  870.     <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;npegs$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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    871. 

  871.   <dd>
    872. 

  872.     
    873. 

  873.     constructs a back reference of the given <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt> starts counting from 1. <tt class="docutils literal"><span class="pre"><span class="Identifier">reverse</span></span></tt> specifies whether indexing starts from the end of the capture list. Ignores case for matching.
    874. 

  874.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L320" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    875. 

  875. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L320" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    876. 

  876. 

  877.   </dd>
    878. 

  878. </div>
    879. 

  879. 

  880. </div>
    881. 

  881. <div id="backrefIgnoreStyle-procs-all">
    882. 

  882.   <div id="backrefIgnoreStyle,range[],bool">
    883. 

  883.   <dt><pre><span class="Keyword">func</span> <a href="#backrefIgnoreStyle%2Crange%5B%5D%2Cbool"><span class="Identifier">backrefIgnoreStyle</span></a><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="Identifier">MaxSubpatterns</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">reverse</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.
    884. 

  884.     <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;npegs$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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    885. 

  885.   <dd>
    886. 

  886.     
    887. 

  887.     constructs a back reference of the given <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">index</span></span></tt> starts counting from 1. <tt class="docutils literal"><span class="pre"><span class="Identifier">reverse</span></span></tt> specifies whether indexing starts from the end of the capture list. Ignores style for matching.
    888. 

  888.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L327" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    889. 

  889. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L327" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    890. 

  890. 

  891.   </dd>
    892. 

  892. </div>
    893. 

  893. 

  894. </div>
    895. 

  895. <div id="bounds-procs-all">
    896. 

  896.   <div id="bounds,Captures,range[]">
    897. 

  897.   <dt><pre><span class="Keyword">func</span> <a href="#bounds%2CCaptures%2Crange%5B%5D"><span class="Identifier">bounds</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <a href="pegs.html#Captures"><span class="Identifier">Captures</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">20</span> <span class="Operator">-</span> <span class="DecNumber">1</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">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.
    898. 

  898.     <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>
    899. 

  899.   <dd>
    900. 

  900.     
    901. 

  901.     returns the bounds <tt class="docutils literal"><span class="pre">[first..last]</span></tt> of the <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt>'th capture.
    902. 

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

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

  904. 

  905.   </dd>
    906. 

  906. </div>
    907. 

  907. 

  908. </div>
    909. 

  909. <div id="capture-procs-all">
    910. 

  910.   <div id="capture,Peg">
    911. 

  911.   <dt><pre><span class="Keyword">func</span> <a href="#capture%2CPeg"><span class="Identifier">capture</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> <span class="Other">=</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">(</span><span class="Identifier">kind</span><span class="Other">:</span> <span class="DecNumber">pkEmpty</span><span class="Other">)</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegsCapture&quot;</span><span class="Other">,</span>
    912. 

  912.     <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>
    913. 

  913.   <dd>
    914. 

  914.     
    915. 

  915.     constructs a capture with the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    916. 

  916.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    917. 

  917. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    918. 

  918. 

  919.   </dd>
    920. 

  920. </div>
    921. 

  921. 

  922. </div>
    923. 

  923. <div id="ch-procs-all">
    924. 

  924.   <div id="ch,Peg">
    925. 

  925.   <dt><pre><span class="Keyword">func</span> <a href="#ch%2CPeg"><span class="Identifier">ch</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</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>
    926. 

  926.   <dd>
    927. 

  927.     
    928. 

  928.     Returns the <em>char</em> representation of a given <em>Peg</em> variant object where present.
    929. 

  929.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L99" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    930. 

  930. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L99" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    931. 

  931. 

  932.   </dd>
    933. 

  933. </div>
    934. 

  934. 

  935. </div>
    936. 

  936. <div id="charChoice-procs-all">
    937. 

  937.   <div id="charChoice,Peg">
    938. 

  938.   <dt><pre><span class="Keyword">func</span> <a href="#charChoice%2CPeg"><span class="Identifier">charChoice</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</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><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>
    939. 

  939.   <dd>
    940. 

  940.     
    941. 

  941.     Returns the <em>charChoice</em> field of a given <em>Peg</em> variant object where present.
    942. 

  942.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L103" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    943. 

  943. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L103" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    944. 

  944. 

  945.   </dd>
    946. 

  946. </div>
    947. 

  947. 

  948. </div>
    949. 

  949. <div id="charSet-procs-all">
    950. 

  950.   <div id="charSet,set[char]">
    951. 

  951.   <dt><pre><span class="Keyword">func</span> <a href="#charSet%2Cset%5Bchar%5D"><span class="Identifier">charSet</span></a><span class="Other">(</span><span class="Identifier">s</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> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$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>
    952. 

  952.                                   <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>
    953. 

  953.   <dd>
    954. 

  954.     
    955. 

  955.     constructs a PEG from a character set <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>
    956. 

  956.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L167" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    957. 

  957. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L167" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    958. 

  958. 

  959.   </dd>
    960. 

  960. </div>
    961. 

  961. 

  962. </div>
    963. 

  963. <div id="col-procs-all">
    964. 

  964.   <div id="col,NonTerminal">
    965. 

  965.   <dt><pre><span class="Keyword">func</span> <a href="#col%2CNonTerminal"><span class="Identifier">col</span></a><span class="Other">(</span><span class="Identifier">nt</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    966. 

  966.   <dd>
    967. 

  967.     
    968. 

  968.     Gets the column number of the definition of the parent <em>Peg</em> object variant of a given <em>NonTerminal</em>.
    969. 

  969.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L133" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    970. 

  970. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L133" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    971. 

  971. 

  972.   </dd>
    973. 

  973. </div>
    974. 

  974. 

  975. </div>
    976. 

  976. <div id="contains-procs-all">
    977. 

  977.   <div id="contains,string,Peg,openArray[string],int">
    978. 

  978.   <dt><pre><span class="Keyword">func</span> <a href="#contains%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</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">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    979. 

  979.     <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;npegs$1Capture&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="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    980. 

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

  981.   <dd>
    982. 

  982.     
    983. 

  983.     same as <tt class="docutils literal"><span class="pre">find(s, pattern, matches, start) &gt;= 0</span></tt>
    984. 

  984.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1207" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    985. 

  985. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1207" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    986. 

  986. 

  987.   </dd>
    988. 

  988. </div>
    989. 

  989. <div id="contains,string,Peg,int">
    990. 

  990.   <dt><pre><span class="Keyword">func</span> <a href="#contains%2Cstring%2CPeg%2Cint"><span class="Identifier">contains</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    991. 

  991.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    992. 

  992.   <dd>
    993. 

  993.     
    994. 

  994.     same as <tt class="docutils literal"><span class="pre">find(s, pattern, start) &gt;= 0</span></tt>
    995. 

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

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

  997. 

  998.   </dd>
    999. 

  999. </div>
    1000. 

  1000. 

  1001. </div>
    1002. 

  1002. <div id="endAnchor-procs-all">
    1003. 

  1003.   <div id="endAnchor">
    1004. 

  1004.   <dt><pre><span class="Keyword">func</span> <a href="#endAnchor"><span class="Identifier">endAnchor</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1005. 

  1005.   <dd>
    1006. 

  1006.     
    1007. 

  1007.     constructs the PEG <tt class="docutils literal"><span class="pre">$</span></tt> which matches the end of the input.
    1008. 

  1008.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L305" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1009. 

  1009. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L305" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1010. 

  1010. 

  1011.   </dd>
    1012. 

  1012. </div>
    1013. 

  1013. 

  1014. </div>
    1015. 

  1015. <div id="endsWith-procs-all">
    1016. 

  1016.   <div id="endsWith,string,Peg,int">
    1017. 

  1017.   <dt><pre><span class="Keyword">func</span> <a href="#endsWith%2Cstring%2CPeg%2Cint"><span class="Identifier">endsWith</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">suffix</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1018. 

  1018.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    1019. 

  1019.   <dd>
    1020. 

  1020.     
    1021. 

  1021.     returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> ends with the pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">suffix</span></span></tt>
    1022. 

  1022.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1217" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1023. 

  1023. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1217" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1024. 

  1024. 

  1025.   </dd>
    1026. 

  1026. </div>
    1027. 

  1027. 

  1028. </div>
    1029. 

  1029. <div id="escapePeg-procs-all">
    1030. 

  1030.   <div id="escapePeg,string">
    1031. 

  1031.   <dt><pre><span class="Keyword">func</span> <a href="#escapePeg%2Cstring"><span class="Identifier">escapePeg</span></a><span class="Other">(</span><span class="Identifier">s</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">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>
    1032. 

  1032.   <dd>
    1033. 

  1033.     
    1034. 

  1034.     escapes <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> so that it is matched verbatim when used as a peg.
    1035. 

  1035.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L2067" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1036. 

  1036. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L2067" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1037. 

  1037. 

  1038.   </dd>
    1039. 

  1039. </div>
    1040. 

  1040. 

  1041. </div>
    1042. 

  1042. <div id="find-procs-all">
    1043. 

  1043.   <div id="find,string,Peg,openArray[string],int">
    1044. 

  1044.   <dt><pre><span class="Keyword">func</span> <a href="#find%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">find</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</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">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1045. 

  1045.     <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;npegs$1Capture&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="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1046. 

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

  1047.   <dd>
    1048. 

  1048.     
    1049. 

  1049.     returns the starting position of <tt class="docutils literal"><span class="pre">pattern</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre">matches</span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre">matches</span></tt> and -1 is returned.
    1050. 

  1050.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1119" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1051. 

  1051. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1119" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1052. 

  1052. 

  1053.   </dd>
    1054. 

  1054. </div>
    1055. 

  1055. <div id="find,string,Peg,int">
    1056. 

  1056.   <dt><pre><span class="Keyword">func</span> <a href="#find%2Cstring%2CPeg%2Cint"><span class="Identifier">find</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><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;npegs$1&quot;</span><span class="Other">,</span>
    1057. 

  1057.     <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">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>
    1058. 

  1058.   <dd>
    1059. 

  1059.     
    1060. 

  1060.     returns the starting position of <tt class="docutils literal"><span class="pre">pattern</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt>. If it does not match, -1 is returned.
    1061. 

  1061.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1149" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1062. 

  1062. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1149" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1063. 

  1063. 

  1064.   </dd>
    1065. 

  1065. </div>
    1066. 

  1066. 

  1067. </div>
    1068. 

  1068. <div id="findAll-procs-all">
    1069. 

  1069.   <div id="findAll,string,Peg,int">
    1070. 

  1070.   <dt><pre><span class="Keyword">func</span> <a href="#findAll%2Cstring%2CPeg%2Cint"><span class="Identifier">findAll</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><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>
    1071. 

  1071.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    1072. 

  1072.   <dd>
    1073. 

  1073.     
    1074. 

  1074.     returns all matching <em>substrings</em> of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> that match <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>. If it does not match, <tt class="docutils literal"><span class="pre"><span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt> is returned.
    1075. 

  1075.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1171" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1076. 

  1076. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1171" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1077. 

  1077. 

  1078.   </dd>
    1079. 

  1079. </div>
    1080. 

  1080. 

  1081. </div>
    1082. 

  1082. <div id="findBounds-procs-all">
    1083. 

  1083.   <div id="findBounds,string,Peg,openArray[string],int">
    1084. 

  1084.   <dt><pre><span class="Keyword">func</span> <a href="#findBounds%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">findBounds</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</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>
    1085. 

  1085.                 <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</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>
    1086. 

  1086.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$1Capture&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="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>
    1087. 

  1087.   <dd>
    1088. 

  1088.     
    1089. 

  1089.     returns the starting position and end position of <tt class="docutils literal"><span class="pre">pattern</span></tt> in <tt class="docutils literal"><span class="pre">s</span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre">matches</span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre">matches</span></tt> and (-1,0) is returned.
    1090. 

  1090.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1133" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1091. 

  1091. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1133" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1092. 

  1092. 

  1093.   </dd>
    1094. 

  1094. </div>
    1095. 

  1095. 

  1096. </div>
    1097. 

  1097. <div id="flags-procs-all">
    1098. 

  1098.   <div id="flags,NonTerminal">
    1099. 

  1099.   <dt><pre><span class="Keyword">func</span> <a href="#flags%2CNonTerminal"><span class="Identifier">flags</span></a><span class="Other">(</span><span class="Identifier">nt</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="pegs.html#NonTerminalFlag"><span class="Identifier">NonTerminalFlag</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>
    1100. 

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

  1101.   <dd>
    1102. 

  1102.     
    1103. 

  1103.     Gets the <em>NonTerminalFlag</em>-typed flags field of the parent <em>Peg</em> variant object of a given <em>NonTerminal</em>.
    1104. 

  1104.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L137" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1105. 

  1105. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L137" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1106. 

  1106. 

  1107.   </dd>
    1108. 

  1108. </div>
    1109. 

  1109. 

  1110. </div>
    1111. 

  1111. <div id="index-procs-all">
    1112. 

  1112.   <div id="index,Peg">
    1113. 

  1113.   <dt><pre><span class="Keyword">func</span> <a href="#index%2CPeg"><span class="Identifier">index</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="Operator">-</span><span class="DecNumber">20</span> <span class="Operator">..</span> <span class="DecNumber">20</span> <span class="Operator">-</span> <span class="DecNumber">1</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1114. 

  1114.   <dd>
    1115. 

  1115.     
    1116. 

  1116.     Returns the back-reference index of a captured sub-pattern in the <em>Captures</em> object for a given <em>Peg</em> variant object where present.
    1117. 

  1117.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L111" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1118. 

  1118. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L111" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1119. 

  1119. 

  1120.   </dd>
    1121. 

  1121. </div>
    1122. 

  1122. 

  1123. </div>
    1124. 

  1124. <div id="kind-procs-all">
    1125. 

  1125.   <div id="kind,Peg">
    1126. 

  1126.   <dt><pre><span class="Keyword">func</span> <a href="#kind%2CPeg"><span class="Identifier">kind</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#PegKind"><span class="Identifier">PegKind</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>
    1127. 

  1127.   <dd>
    1128. 

  1128.     
    1129. 

  1129.     Returns the <em>PegKind</em> of a given <em>Peg</em> object.
    1130. 

  1130.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L92" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1131. 

  1131. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L92" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1132. 

  1132. 

  1133.   </dd>
    1134. 

  1134. </div>
    1135. 

  1135. 

  1136. </div>
    1137. 

  1137. <div id="line-procs-all">
    1138. 

  1138.   <div id="line,NonTerminal">
    1139. 

  1139.   <dt><pre><span class="Keyword">func</span> <a href="#line%2CNonTerminal"><span class="Identifier">line</span></a><span class="Other">(</span><span class="Identifier">nt</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1140. 

  1140.   <dd>
    1141. 

  1141.     
    1142. 

  1142.     Gets the line number of the definition of the parent <em>Peg</em> object variant of a given <em>NonTerminal</em>.
    1143. 

  1143.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L129" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1144. 

  1144. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L129" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1145. 

  1145. 

  1146.   </dd>
    1147. 

  1147. </div>
    1148. 

  1148. 

  1149. </div>
    1150. 

  1150. <div id="match-procs-all">
    1151. 

  1151.   <div id="match,string,Peg,openArray[string],int">
    1152. 

  1152.   <dt><pre><span class="Keyword">func</span> <a href="#match%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">match</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</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">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.
    1153. 

  1153.     <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;npegs$1Capture&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="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1154. 

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

  1155.   <dd>
    1156. 

  1156.     
    1157. 

  1157.     returns <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">s[start..]</span></tt> matches the <tt class="docutils literal"><span class="pre">pattern</span></tt> and the captured substrings in the array <tt class="docutils literal"><span class="pre">matches</span></tt>. If it does not match, nothing is written into <tt class="docutils literal"><span class="pre">matches</span></tt> and <tt class="docutils literal"><span class="pre">false</span></tt> is returned.
    1158. 

  1158.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1105" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1159. 

  1159. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1105" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1160. 

  1160. 

  1161.   </dd>
    1162. 

  1162. </div>
    1163. 

  1163. <div id="match,string,Peg,int">
    1164. 

  1164.   <dt><pre><span class="Keyword">func</span> <a href="#match%2Cstring%2CPeg%2Cint"><span class="Identifier">match</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1165. 

  1165.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    1166. 

  1166.   <dd>
    1167. 

  1167.     
    1168. 

  1168.     returns <tt class="docutils literal"><span class="pre">true</span></tt> if <tt class="docutils literal"><span class="pre">s</span></tt> matches the <tt class="docutils literal"><span class="pre">pattern</span></tt> beginning from <tt class="docutils literal"><span class="pre">start</span></tt>.
    1169. 

  1169.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1113" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1170. 

  1170. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1113" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1171. 

  1171. 

  1172.   </dd>
    1173. 

  1173. </div>
    1174. 

  1174. 

  1175. </div>
    1176. 

  1176. <div id="matchLen-procs-all">
    1177. 

  1177.   <div id="matchLen,string,Peg,openArray[string],int">
    1178. 

  1178.   <dt><pre><span class="Keyword">func</span> <a href="#matchLen%2Cstring%2CPeg%2CopenArray%5Bstring%5D%2Cint"><span class="Identifier">matchLen</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">matches</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</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">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
    1179. 

  1179.     <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;npegs$1Capture&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="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1180. 

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

  1181.   <dd>
    1182. 

  1182.     
    1183. 

  1183.     the same as <tt class="docutils literal"><span class="pre">match</span></tt>, but it returns the length of the match, if there is no match, -1 is returned. Note that a match length of zero can happen. It's possible that a suffix of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> remains that does not belong to the match.
    1184. 

  1184.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1086" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1185. 

  1185. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1086" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1186. 

  1186. 

  1187.   </dd>
    1188. 

  1188. </div>
    1189. 

  1189. <div id="matchLen,string,Peg,int">
    1190. 

  1190.   <dt><pre><span class="Keyword">func</span> <a href="#matchLen%2Cstring%2CPeg%2Cint"><span class="Identifier">matchLen</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><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>
    1191. 

  1191.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    1192. 

  1192.   <dd>
    1193. 

  1193.     
    1194. 

  1194.     the same as <tt class="docutils literal"><span class="pre">match</span></tt>, but it returns the length of the match, if there is no match, -1 is returned. Note that a match length of zero can happen. It's possible that a suffix of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> remains that does not belong to the match.
    1195. 

  1195.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1096" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1196. 

  1196. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1096" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1197. 

  1197. 

  1198.   </dd>
    1199. 

  1199. </div>
    1200. 

  1200. 

  1201. </div>
    1202. 

  1202. <div id="name-procs-all">
    1203. 

  1203.   <div id="name,NonTerminal">
    1204. 

  1204.   <dt><pre><span class="Keyword">func</span> <a href="#name%2CNonTerminal"><span class="Identifier">name</span></a><span class="Other">(</span><span class="Identifier">nt</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</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="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>
    1205. 

  1205.   <dd>
    1206. 

  1206.     
    1207. 

  1207.     Gets the name of the symbol represented by the parent <em>Peg</em> object variant of a given <em>NonTerminal</em>.
    1208. 

  1208.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L125" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1209. 

  1209. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L125" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1210. 

  1210. 

  1211.   </dd>
    1212. 

  1212. </div>
    1213. 

  1213. 

  1214. </div>
    1215. 

  1215. <div id="newLine-procs-all">
    1216. 

  1216.   <div id="newLine">
    1217. 

  1217.   <dt><pre><span class="Keyword">func</span> <a href="#newLine"><span class="Identifier">newLine</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1218. 

  1218.   <dd>
    1219. 

  1219.     
    1220. 

  1220.     constructs the PEG <span id="newline_1">newline</span> (<tt class="docutils literal"><span class="pre">\n</span></tt>)
    1221. 

  1221.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L276" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1222. 

  1222. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L276" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1223. 

  1223. 

  1224.   </dd>
    1225. 

  1225. </div>
    1226. 

  1226. 

  1227. </div>
    1228. 

  1228. <div id="newNonTerminal-procs-all">
    1229. 

  1229.   <div id="newNonTerminal,string,int,int">
    1230. 

  1230.   <dt><pre><span class="Keyword">func</span> <a href="#newNonTerminal%2Cstring%2Cint%2Cint"><span class="Identifier">newNonTerminal</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">,</span> <span class="Identifier">column</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1231. 

  1231.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1232. 

  1232.   <dd>
    1233. 

  1233.     
    1234. 

  1234.     constructs a nonterminal symbol
    1235. 

  1235.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L360" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1236. 

  1236. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L360" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1237. 

  1237. 

  1238.   </dd>
    1239. 

  1239. </div>
    1240. 

  1240. 

  1241. </div>
    1242. 

  1242. <div id="nonterminal-procs-all">
    1243. 

  1243.   <div id="nonterminal,NonTerminal">
    1244. 

  1244.   <dt><pre><span class="Keyword">func</span> <a href="#nonterminal%2CNonTerminal"><span class="Identifier">nonterminal</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$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>
    1245. 

  1245.                                         <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>
    1246. 

  1246.   <dd>
    1247. 

  1247.     
    1248. 

  1248.     constructs a PEG that consists of the nonterminal symbol
    1249. 

  1249.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L350" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1250. 

  1250. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L350" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1251. 

  1251. 

  1252.   </dd>
    1253. 

  1253. </div>
    1254. 

  1254. 

  1255. </div>
    1256. 

  1256. <div id="nt-procs-all">
    1257. 

  1257.   <div id="nt,Peg">
    1258. 

  1258.   <dt><pre><span class="Keyword">func</span> <a href="#nt%2CPeg"><span class="Identifier">nt</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</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>
    1259. 

  1259.   <dd>
    1260. 

  1260.     
    1261. 

  1261.     Returns the <em>NonTerminal</em> object of a given <em>Peg</em> variant object where present.
    1262. 

  1262.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L107" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1263. 

  1263. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L107" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1264. 

  1264. 

  1265.   </dd>
    1266. 

  1266. </div>
    1267. 

  1267. 

  1268. </div>
    1269. 

  1269. <div id="parallelReplace-procs-all">
    1270. 

  1270.   <div id="parallelReplace,string,varargs[tuple[Peg,string]]">
    1271. 

  1271.   <dt><pre><span class="Keyword">func</span> <a href="#parallelReplace%2Cstring%2Cvarargs%5Btuple%5BPeg%2Cstring%5D%5D"><span class="Identifier">parallelReplace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">subs</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">,</span> <span class="Identifier">repl</span><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="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
    1272. 

  1272.     <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;npegs$1&quot;</span><span class="Other">,</span> <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="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1273. 

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

  1274.   <dd>
    1275. 

  1275.     
    1276. 

  1276.     Returns a modified copy of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> with the substitutions in <tt class="docutils literal"><span class="pre"><span class="Identifier">subs</span></span></tt> applied in parallel.
    1277. 

  1277.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1272" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1278. 

  1278. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1272" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1279. 

  1279. 

  1280.   </dd>
    1281. 

  1281. </div>
    1282. 

  1282. 

  1283. </div>
    1284. 

  1284. <div id="parsePeg-procs-all">
    1285. 

  1285.   <div id="parsePeg,string,string,int,int">
    1286. 

  1286.   <dt><pre><span class="Keyword">func</span> <a href="#parsePeg%2Cstring%2Cstring%2Cint%2Cint"><span class="Identifier">parsePeg</span></a><span class="Other">(</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">filename</span> <span class="Other">=</span> <span class="StringLit">&quot;pattern&quot;</span><span class="Other">;</span> <span class="Identifier">line</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">;</span> <span class="Identifier">col</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.
    1287. 

  1287.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">EInvalidPeg</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1288. 

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

  1289.   <dd>
    1290. 

  1290.     
    1291. 

  1291.     constructs a Peg object from <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">line</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">col</span></span></tt> are used for error messages, but they only provide start offsets. <tt class="docutils literal"><span class="pre"><span class="Identifier">parsePeg</span></span></tt> keeps track of line and column numbers within <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>.
    1292. 

  1292.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L2045" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1293. 

  1293. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L2045" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1294. 

  1294. 

  1295.   </dd>
    1296. 

  1296. </div>
    1297. 

  1297. 

  1298. </div>
    1299. 

  1299. <div id="peg-procs-all">
    1300. 

  1300.   <div id="peg,string">
    1301. 

  1301.   <dt><pre><span class="Keyword">func</span> <a href="#peg%2Cstring"><span class="Identifier">peg</span></a><span class="Other">(</span><span class="Identifier">pattern</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="pegs.html#Peg"><span class="Identifier">Peg</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">ValueError</span><span class="Other">,</span> <span class="Identifier">EInvalidPeg</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    1302. 

  1302.                                  <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1303. 

  1303.   <dd>
    1304. 

  1304.     
    1305. 

  1305.     constructs a Peg object from the <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>. The short name has been chosen to encourage its use as a raw string modifier:<pre>peg&quot;{\ident} \s* '=' \s* {.*}&quot;</pre>
    1306. 

  1306. 

  1307.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L2060" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1308. 

  1308. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L2060" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1309. 

  1309. 

  1310.   </dd>
    1311. 

  1311. </div>
    1312. 

  1312. 

  1313. </div>
    1314. 

  1314. <div id="rawMatch-procs-all">
    1315. 

  1315.   <div id="rawMatch,string,Peg,int,Captures">
    1316. 

  1316.   <dt><pre><span class="Keyword">func</span> <a href="#rawMatch%2Cstring%2CPeg%2Cint%2CCaptures"><span class="Identifier">rawMatch</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">c</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="pegs.html#Captures"><span class="Identifier">Captures</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>
    1317. 

  1317.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    1318. 

  1318.   <dd>
    1319. 

  1319.     
    1320. 

  1320.     low-level matching proc that implements the PEG interpreter. Use this for maximum efficiency (every other PEG operation ends up calling this proc). Returns -1 if it does not match, else the length of the match
    1321. 

  1321.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L871" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1322. 

  1322. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L871" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1323. 

  1323. 

  1324.   </dd>
    1325. 

  1325. </div>
    1326. 

  1326. 

  1327. </div>
    1328. 

  1328. <div id="replace-procs-all">
    1329. 

  1329.   <div id="replace,string,Peg,proc(int,int,openArray[string])">
    1330. 

  1330.   <dt><pre><span class="Keyword">func</span> <a href="#replace%2Cstring%2CPeg%2Cproc%28int%2Cint%2CopenArray%5Bstring%5D%29"><span class="Identifier">replace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sub</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span>
    1331. 

  1331.              <span class="Identifier">cb</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">match</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">cnt</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">caps</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</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="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> {.
    1332. 

  1332.     <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;npegs$1cb&quot;</span><span class="Other">,</span> </span><span class="Identifier">effectsOf</span><span class="Other">:</span> <span class="Identifier">cb</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1333. 

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

  1334.   <dd>
    1335. 

  1335.     
    1336. 

  1336.     <p>Replaces <tt class="docutils literal"><span class="pre"><span class="Identifier">sub</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> by the resulting strings from the callback. The callback proc receives the index of the current match (starting with 0), the count of captures and an open array with the captures of each match. Examples:</p>
    1337. 

  1337. <p><pre class="listing"><span class="Keyword">func</span> <span class="Identifier">handleMatches</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">m</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">n</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">c</span><span class="Punctuation">:</span> <span class="Identifier">openArray</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span>
    1338. 

  1338.   <span class="Identifier">result</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    1339. 

  1339.   <span class="Keyword">if</span> <span class="Identifier">m</span> <span class="Operator">&gt;</span> <span class="DecNumber">0</span><span class="Punctuation">:</span>
    1340. 

  1340.     <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="StringLit">&quot;, &quot;</span>
    1341. 

  1341.   <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Keyword">case</span> <span class="Identifier">n</span><span class="Punctuation">:</span>
    1342. 

  1342.     <span class="Keyword">of</span> <span class="DecNumber">2</span><span class="Punctuation">:</span> <span class="Identifier">c</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toLower</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;: '&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">c</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;'&quot;</span>
    1343. 

  1343.     <span class="Keyword">of</span> <span class="DecNumber">1</span><span class="Punctuation">:</span> <span class="Identifier">c</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">toLower</span> <span class="Operator">&amp;</span> <span class="StringLit">&quot;: ''&quot;</span>
    1344. 

  1344.     <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="StringLit">&quot;&quot;</span>
    1345. 

  1345. 

  1346. <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">&quot;Var1=key1;var2=Key2;   VAR3&quot;</span>
    1347. 

  1347. <span class="Identifier">echo</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">replace</span><span class="Punctuation">(</span><span class="RawData">peg&quot;{\ident}('='{\ident})* ';'* \s*&quot;</span><span class="Punctuation">,</span> <span class="Identifier">handleMatches</span><span class="Punctuation">)</span></pre></p>
    1348. 

  1348. <p>Results in:</p>
    1349. 

  1349. <p><pre class="listing"><span class="StringLit">&quot;var1: 'key1', var2: 'Key2', var3: ''&quot;</span></pre></p>
    1350. 

  1350. 

  1351.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1299" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1352. 

  1352. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1299" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1353. 

  1353. 

  1354.   </dd>
    1355. 

  1355. </div>
    1356. 

  1356. <div id="replace,string,Peg,string">
    1357. 

  1357.   <dt><pre><span class="Keyword">func</span> <a href="#replace%2Cstring%2CPeg%2Cstring"><span class="Identifier">replace</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sub</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">by</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> {.<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;npegs$1&quot;</span><span class="Other">,</span>
    1358. 

  1358.     <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">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>
    1359. 

  1359.   <dd>
    1360. 

  1360.     
    1361. 

  1361.     Replaces <tt class="docutils literal"><span class="pre"><span class="Identifier">sub</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> by the string <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt>. Captures cannot be accessed in <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt>.
    1362. 

  1362.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1255" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1363. 

  1363. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1255" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1364. 

  1364. 

  1365.   </dd>
    1366. 

  1366. </div>
    1367. 

  1367. 

  1368. </div>
    1369. 

  1369. <div id="replacef-procs-all">
    1370. 

  1370.   <div id="replacef,string,Peg,string">
    1371. 

  1371.   <dt><pre><span class="Keyword">func</span> <a href="#replacef%2Cstring%2CPeg%2Cstring"><span class="Identifier">replacef</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sub</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">by</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>
    1372. 

  1372.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$1&quot;</span><span class="Other">,</span> <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="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>
    1373. 

  1373.   <dd>
    1374. 

  1374.     
    1375. 

  1375.     <p>Replaces <tt class="docutils literal"><span class="pre"><span class="Identifier">sub</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> by the string <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt>. Captures can be accessed in <tt class="docutils literal"><span class="pre"><span class="Identifier">by</span></span></tt> with the notation <tt class="docutils literal"><span class="pre">$i</span></tt> and <tt class="docutils literal"><span class="pre">$#</span></tt> (see strutils.<tt class="docutils literal"><span class="pre"><span class="Operator">%</span></span></tt>). Examples:</p>
    1376. 

  1376. <p><pre class="listing"><span class="StringLit">&quot;var1=key; var2=key2&quot;</span><span class="Operator">.</span><span class="Identifier">replacef</span><span class="Punctuation">(</span><span class="RawData">peg&quot;{\ident}'='{\ident}&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;$1&lt;-$2$2&quot;</span><span class="Punctuation">)</span></pre></p>
    1377. 

  1377. <p>Results in:</p>
    1378. 

  1378. <p><pre class="listing"><span class="StringLit">&quot;var1&lt;-keykey; val2&lt;-key2key2&quot;</span></pre></p>
    1379. 

  1379. 

  1380.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1225" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1381. 

  1381. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1225" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1382. 

  1382. 

  1383.   </dd>
    1384. 

  1384. </div>
    1385. 

  1385. 

  1386. </div>
    1387. 

  1387. <div id="rule-procs-all">
    1388. 

  1388.   <div id="rule,NonTerminal">
    1389. 

  1389.   <dt><pre><span class="Keyword">func</span> <a href="#rule%2CNonTerminal"><span class="Identifier">rule</span></a><span class="Other">(</span><span class="Identifier">nt</span><span class="Other">:</span> <a href="pegs.html#NonTerminal"><span class="Identifier">NonTerminal</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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>
    1390. 

  1390.   <dd>
    1391. 

  1391.     
    1392. 

  1392.     Gets the <em>Peg</em> object representing the rule definition of the parent <em>Peg</em> object variant of a given <em>NonTerminal</em>.
    1393. 

  1393.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L141" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1394. 

  1394. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L141" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1395. 

  1395. 

  1396.   </dd>
    1397. 

  1397. </div>
    1398. 

  1398. 

  1399. </div>
    1400. 

  1400. <div id="sequence-procs-all">
    1401. 

  1401.   <div id="sequence,varargs[Peg]">
    1402. 

  1402.   <dt><pre><span class="Keyword">func</span> <a href="#sequence%2Cvarargs%5BPeg%5D"><span class="Identifier">sequence</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$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>
    1403. 

  1403.                                       <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>
    1404. 

  1404.   <dd>
    1405. 

  1405.     
    1406. 

  1406.     constructs a sequence with all the PEGs from <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>
    1407. 

  1407.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1408. 

  1408. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1409. 

  1409. 

  1410.   </dd>
    1411. 

  1411. </div>
    1412. 

  1412. 

  1413. </div>
    1414. 

  1414. <div id="split-procs-all">
    1415. 

  1415.   <div id="split,string,Peg">
    1416. 

  1416.   <dt><pre><span class="Keyword">func</span> <a href="#split%2Cstring%2CPeg"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sep</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$1&quot;</span><span class="Other">,</span>
    1417. 

  1417.     <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">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>
    1418. 

  1418.   <dd>
    1419. 

  1419.     
    1420. 

  1420.     Splits the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into substrings.
    1421. 

  1421.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1392" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1422. 

  1422. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1392" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1423. 

  1423. 

  1424.   </dd>
    1425. 

  1425. </div>
    1426. 

  1426. 

  1427. </div>
    1428. 

  1428. <div id="startAnchor-procs-all">
    1429. 

  1429.   <div id="startAnchor">
    1430. 

  1430.   <dt><pre><span class="Keyword">func</span> <a href="#startAnchor"><span class="Identifier">startAnchor</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1431. 

  1431.   <dd>
    1432. 

  1432.     
    1433. 

  1433.     constructs the PEG <tt class="docutils literal"><span class="pre">^</span></tt> which matches the start of the input.
    1434. 

  1434.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L301" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1435. 

  1435. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L301" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1436. 

  1436. 

  1437.   </dd>
    1438. 

  1438. </div>
    1439. 

  1439. 

  1440. </div>
    1441. 

  1441. <div id="startsWith-procs-all">
    1442. 

  1442.   <div id="startsWith,string,Peg,int">
    1443. 

  1443.   <dt><pre><span class="Keyword">func</span> <a href="#startsWith%2Cstring%2CPeg%2Cint"><span class="Identifier">startsWith</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">prefix</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1444. 

  1444.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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="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>
    1445. 

  1445.   <dd>
    1446. 

  1446.     
    1447. 

  1447.     returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> starts with the pattern <tt class="docutils literal"><span class="pre"><span class="Identifier">prefix</span></span></tt>
    1448. 

  1448.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1212" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1449. 

  1449. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1212" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1450. 

  1450. 

  1451.   </dd>
    1452. 

  1452. </div>
    1453. 

  1453. 

  1454. </div>
    1455. 

  1455. <div id="term-procs-all">
    1456. 

  1456.   <div id="term,Peg">
    1457. 

  1457.   <dt><pre><span class="Keyword">func</span> <a href="#term%2CPeg"><span class="Identifier">term</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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="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>
    1458. 

  1458.   <dd>
    1459. 

  1459.     
    1460. 

  1460.     Returns the <em>string</em> representation of a given <em>Peg</em> variant object where present.
    1461. 

  1461.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L95" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1462. 

  1462. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L95" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1463. 

  1463. 

  1464.   </dd>
    1465. 

  1465. </div>
    1466. 

  1466. <div id="term,char">
    1467. 

  1467.   <dt><pre><span class="Keyword">func</span> <a href="#term%2Cchar"><span class="Identifier">term</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$1Char&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>
    1468. 

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

  1469.   <dd>
    1470. 

  1470.     
    1471. 

  1471.     constructs a PEG from a terminal char
    1472. 

  1472.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L162" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1473. 

  1473. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L162" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1474. 

  1474. 

  1475.   </dd>
    1476. 

  1476. </div>
    1477. 

  1477. <div id="term,string">
    1478. 

  1478.   <dt><pre><span class="Keyword">func</span> <a href="#term%2Cstring"><span class="Identifier">term</span></a><span class="Other">(</span><span class="Identifier">t</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="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$1Str&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>
    1479. 

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

  1480.   <dd>
    1481. 

  1481.     
    1482. 

  1482.     constructs a PEG from a terminal string
    1483. 

  1483.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L145" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1484. 

  1484. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L145" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1485. 

  1485. 

  1486.   </dd>
    1487. 

  1487. </div>
    1488. 

  1488. 

  1489. </div>
    1490. 

  1490. <div id="termIgnoreCase-procs-all">
    1491. 

  1491.   <div id="termIgnoreCase,string">
    1492. 

  1492.   <dt><pre><span class="Keyword">func</span> <a href="#termIgnoreCase%2Cstring"><span class="Identifier">termIgnoreCase</span></a><span class="Other">(</span><span class="Identifier">t</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="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$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>
    1493. 

  1493.                                       <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>
    1494. 

  1494.   <dd>
    1495. 

  1495.     
    1496. 

  1496.     constructs a PEG from a terminal string; ignore case for matching
    1497. 

  1497.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L152" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1498. 

  1498. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L152" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1499. 

  1499. 

  1500.   </dd>
    1501. 

  1501. </div>
    1502. 

  1502. 

  1503. </div>
    1504. 

  1504. <div id="termIgnoreStyle-procs-all">
    1505. 

  1505.   <div id="termIgnoreStyle,string">
    1506. 

  1506.   <dt><pre><span class="Keyword">func</span> <a href="#termIgnoreStyle%2Cstring"><span class="Identifier">termIgnoreStyle</span></a><span class="Other">(</span><span class="Identifier">t</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="pegs.html#Peg"><span class="Identifier">Peg</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;npegs$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>
    1507. 

  1507.                                        <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>
    1508. 

  1508.   <dd>
    1509. 

  1509.     
    1510. 

  1510.     constructs a PEG from a terminal string; ignore style for matching
    1511. 

  1511.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L157" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1512. 

  1512. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L157" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1513. 

  1513. 

  1514.   </dd>
    1515. 

  1515. </div>
    1516. 

  1516. 

  1517. </div>
    1518. 

  1518. <div id="transformFile-procs-all">
    1519. 

  1519.   <div id="transformFile,string,string,varargs[tuple[Peg,string]]">
    1520. 

  1520.   <dt><pre><span class="Keyword">proc</span> <a href="#transformFile%2Cstring%2Cstring%2Cvarargs%5Btuple%5BPeg%2Cstring%5D%5D"><span class="Identifier">transformFile</span></a><span class="Other">(</span><span class="Identifier">infile</span><span class="Other">,</span> <span class="Identifier">outfile</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    1521. 

  1521.                    <span class="Identifier">subs</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">,</span> <span class="Identifier">repl</span><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="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
    1522. 

  1522.     <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;npegs$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">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    1523. 

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

  1524.   <dd>
    1525. 

  1525.     
    1526. 

  1526.     <p>reads in the file <tt class="docutils literal"><span class="pre"><span class="Identifier">infile</span></span></tt>, performs a parallel replacement (calls <tt class="docutils literal"><span class="pre"><span class="Identifier">parallelReplace</span></span></tt>) and writes back to <tt class="docutils literal"><span class="pre"><span class="Identifier">outfile</span></span></tt>. Raises <tt class="docutils literal"><span class="pre">IOError</span></tt> if an error occurs. This is supposed to be used for quick scripting.</p>
    1527. 

  1527. <p><strong>Note</strong>: this proc does not exist while using the JS backend.</p>
    1528. 

  1528. 

  1529.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1344" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1530. 

  1530. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1344" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1531. 

  1531. 

  1532.   </dd>
    1533. 

  1533. </div>
    1534. 

  1534. 

  1535. </div>
    1536. 

  1536. <div id="unicodeLetter-procs-all">
    1537. 

  1537.   <div id="unicodeLetter">
    1538. 

  1538.   <dt><pre><span class="Keyword">func</span> <a href="#unicodeLetter"><span class="Identifier">unicodeLetter</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1539. 

  1539.   <dd>
    1540. 

  1540.     
    1541. 

  1541.     constructs the PEG <tt class="docutils literal"><span class="pre">\letter</span></tt> which matches any Unicode letter.
    1542. 

  1542.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L280" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1543. 

  1543. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L280" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1544. 

  1544. 

  1545.   </dd>
    1546. 

  1546. </div>
    1547. 

  1547. 

  1548. </div>
    1549. 

  1549. <div id="unicodeLower-procs-all">
    1550. 

  1550.   <div id="unicodeLower">
    1551. 

  1551.   <dt><pre><span class="Keyword">func</span> <a href="#unicodeLower"><span class="Identifier">unicodeLower</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1552. 

  1552.   <dd>
    1553. 

  1553.     
    1554. 

  1554.     constructs the PEG <tt class="docutils literal"><span class="pre">\lower</span></tt> which matches any Unicode lowercase letter.
    1555. 

  1555.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L284" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1556. 

  1556. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L284" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1557. 

  1557. 

  1558.   </dd>
    1559. 

  1559. </div>
    1560. 

  1560. 

  1561. </div>
    1562. 

  1562. <div id="unicodeTitle-procs-all">
    1563. 

  1563.   <div id="unicodeTitle">
    1564. 

  1564.   <dt><pre><span class="Keyword">func</span> <a href="#unicodeTitle"><span class="Identifier">unicodeTitle</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1565. 

  1565.   <dd>
    1566. 

  1566.     
    1567. 

  1567.     constructs the PEG <tt class="docutils literal"><span class="pre">\title</span></tt> which matches any Unicode title letter.
    1568. 

  1568.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L292" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1569. 

  1569. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L292" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1570. 

  1570. 

  1571.   </dd>
    1572. 

  1572. </div>
    1573. 

  1573. 

  1574. </div>
    1575. 

  1575. <div id="unicodeUpper-procs-all">
    1576. 

  1576.   <div id="unicodeUpper">
    1577. 

  1577.   <dt><pre><span class="Keyword">func</span> <a href="#unicodeUpper"><span class="Identifier">unicodeUpper</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1578. 

  1578.   <dd>
    1579. 

  1579.     
    1580. 

  1580.     constructs the PEG <tt class="docutils literal"><span class="pre">\upper</span></tt> which matches any Unicode uppercase letter.
    1581. 

  1581.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L288" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1582. 

  1582. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L288" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1583. 

  1583. 

  1584.   </dd>
    1585. 

  1585. </div>
    1586. 

  1586. 

  1587. </div>
    1588. 

  1588. <div id="unicodeWhitespace-procs-all">
    1589. 

  1589.   <div id="unicodeWhitespace">
    1590. 

  1590.   <dt><pre><span class="Keyword">func</span> <a href="#unicodeWhitespace"><span class="Identifier">unicodeWhitespace</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1591. 

  1591.   <dd>
    1592. 

  1592.     
    1593. 

  1593.     constructs the PEG <tt class="docutils literal"><span class="pre">\white</span></tt> which matches any Unicode whitespace character.
    1594. 

  1594.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L296" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1595. 

  1595. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L296" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1596. 

  1596. 

  1597.   </dd>
    1598. 

  1598. </div>
    1599. 

  1599. 

  1600. </div>
    1601. 

  1601. 

  1602.   </dl>
    1603. 

  1603. </div>
    1604. 

  1604. <div class="section" id="15">
    1605. 

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

  1606.   <dl class="item">
    1607. 

  1607.     <div id="findAll-iterators-all">
    1608. 

  1608.   <div id="findAll.i,string,Peg,int">
    1609. 

  1609.   <dt><pre><span class="Keyword">iterator</span> <a href="#findAll.i%2Cstring%2CPeg%2Cint"><span class="Identifier">findAll</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">;</span> <span class="Identifier">start</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    1610. 

  1610.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1611. 

  1611.   <dd>
    1612. 

  1612.     
    1613. 

  1613.     yields all matching <em>substrings</em> of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> that match <tt class="docutils literal"><span class="pre"><span class="Identifier">pattern</span></span></tt>.
    1614. 

  1614.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1158" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1615. 

  1615. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1158" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1616. 

  1616. 

  1617.   </dd>
    1618. 

  1618. </div>
    1619. 

  1619. 

  1620. </div>
    1621. 

  1621. <div id="items-iterators-all">
    1622. 

  1622.   <div id="items.i,Peg">
    1623. 

  1623.   <dt><pre><span class="Keyword">iterator</span> <a href="#items.i%2CPeg"><span class="Identifier">items</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    1624. 

  1624.   <dd>
    1625. 

  1625.     
    1626. 

  1626.     Yields the child nodes of a <em>Peg</em> variant object where present.
    1627. 

  1627.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L115" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1628. 

  1628. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L115" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1629. 

  1629. 

  1630.   </dd>
    1631. 

  1631. </div>
    1632. 

  1632. 

  1633. </div>
    1634. 

  1634. <div id="pairs-iterators-all">
    1635. 

  1635.   <div id="pairs.i,Peg">
    1636. 

  1636.   <dt><pre><span class="Keyword">iterator</span> <a href="#pairs.i%2CPeg"><span class="Identifier">pairs</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="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>
    1637. 

  1637.   <dd>
    1638. 

  1638.     
    1639. 

  1639.     Yields the indices and child nodes of a <em>Peg</em> variant object where present.
    1640. 

  1640.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L120" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1641. 

  1641. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L120" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1642. 

  1642. 

  1643.   </dd>
    1644. 

  1644. </div>
    1645. 

  1645. 

  1646. </div>
    1647. 

  1647. <div id="split-iterators-all">
    1648. 

  1648.   <div id="split.i,string,Peg">
    1649. 

  1649.   <dt><pre><span class="Keyword">iterator</span> <a href="#split.i%2Cstring%2CPeg"><span class="Identifier">split</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">sep</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</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="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    1650. 

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

  1651.   <dd>
    1652. 

  1652.     
    1653. 

  1653.     <p>Splits the string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into substrings.</p>
    1654. 

  1654. <p>Substrings are separated by the PEG <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt>. Examples:</p>
    1655. 

  1655. <p><pre class="listing"><span class="Keyword">for</span> <span class="Identifier">word</span> <span class="Keyword">in</span> <span class="Identifier">split</span><span class="Punctuation">(</span><span class="StringLit">&quot;00232this02939is39an22example111&quot;</span><span class="Punctuation">,</span> <span class="RawData">peg&quot;\d+&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    1656. 

  1656.   <span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="Identifier">word</span><span class="Punctuation">)</span></pre></p>
    1657. 

  1657. <p>Results in:</p>
    1658. 

  1658. <p><pre class="listing"><span class="StringLit">&quot;this&quot;</span>
    1659. 

  1659. <span class="StringLit">&quot;is&quot;</span>
    1660. 

  1660. <span class="StringLit">&quot;an&quot;</span>
    1661. 

  1661. <span class="StringLit">&quot;example&quot;</span></pre></p>
    1662. 

  1662. 

  1663.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1356" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1664. 

  1664. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1356" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1665. 

  1665. 

  1666.   </dd>
    1667. 

  1667. </div>
    1668. 

  1668. 

  1669. </div>
    1670. 

  1670. 

  1671.   </dl>
    1672. 

  1672. </div>
    1673. 

  1673. <div class="section" id="18">
    1674. 

  1674.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    1675. 

  1675.   <dl class="item">
    1676. 

  1676.     <div id="=~-templates-all">
    1677. 

  1677.   <div id="=~.t,string,Peg">
    1678. 

  1678.   <dt><pre><span class="Keyword">template</span> <a href="#%3D~.t%2Cstring%2CPeg"><span class="Identifier">`=~`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">pattern</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
    1679. 

  1679.   <dd>
    1680. 

  1680.     
    1681. 

  1681.     <p>This calls <tt class="docutils literal"><span class="pre">match</span></tt> with an implicit declared <tt class="docutils literal"><span class="pre">matches</span></tt> array that can be used in the scope of the <tt class="docutils literal"><span class="pre">=~</span></tt> call:</p>
    1682. 

  1682. <p><pre class="listing"><span class="Keyword">if</span> <span class="Identifier">line</span> <span class="Operator">=~</span> <span class="RawData">peg&quot;\s* {\w+} \s* '=' \s* {\w+}&quot;</span><span class="Punctuation">:</span>
    1683. 

  1683.   <span class="Comment"># matches a key=value pair:</span>
    1684. 

  1684.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Key: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1685. 

  1685.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Value: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1686. 

  1686. <span class="Keyword">elif</span> <span class="Identifier">line</span> <span class="Operator">=~</span> <span class="RawData">peg&quot;\s*{'#'.*}&quot;</span><span class="Punctuation">:</span>
    1687. 

  1687.   <span class="Comment"># matches a comment</span>
    1688. 

  1688.   <span class="Comment"># note that the implicit ``matches`` array is different from the</span>
    1689. 

  1689.   <span class="Comment"># ``matches`` array of the first branch</span>
    1690. 

  1690.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;comment: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">matches</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    1691. 

  1691. <span class="Keyword">else</span><span class="Punctuation">:</span>
    1692. 

  1692.   <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;syntax error&quot;</span><span class="Punctuation">)</span></pre></p>
    1693. 

  1693. 

  1694.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L1178" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1695. 

  1695. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L1178" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1696. 

  1696. 

  1697.   </dd>
    1698. 

  1698. </div>
    1699. 

  1699. 

  1700. </div>
    1701. 

  1701. <div id="digits-templates-all">
    1702. 

  1702.   <div id="digits.t">
    1703. 

  1703.   <dt><pre><span class="Keyword">template</span> <a href="#digits.t"><span class="Identifier">digits</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1704. 

  1704.   <dd>
    1705. 

  1705.     
    1706. 

  1706.     expands to <tt class="docutils literal"><span class="pre">charset({'0'..'9'})</span></tt>
    1707. 

  1707.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L369" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1708. 

  1708. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L369" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1709. 

  1709. 

  1710.   </dd>
    1711. 

  1711. </div>
    1712. 

  1712. 

  1713. </div>
    1714. 

  1714. <div id="eventParser-templates-all">
    1715. 

  1715.   <div id="eventParser.t,untyped,untyped">
    1716. 

  1716.   <dt><pre><span class="Keyword">template</span> <a href="#eventParser.t%2Cuntyped%2Cuntyped"><span class="Identifier">eventParser</span></a><span class="Other">(</span><span class="Identifier">pegAst</span><span class="Other">,</span> <span class="Identifier">handlers</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">s</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#int"><span class="Identifier">int</span></a><span class="Other">)</span></pre></dt>
    1717. 

  1717.   <dd>
    1718. 

  1718.     
    1719. 

  1719.     <p>Generates an interpreting event parser <em>proc</em> according to the specified PEG AST and handler code blocks. The <em>proc</em> can be called with a string to be parsed and will execute the handler code blocks whenever their associated grammar element is matched. It returns -1 if the string does not match, else the length of the total match. The following example code evaluates an arithmetic expression defined by a simple PEG:</p>
    1720. 

  1720. <p><pre class="listing"><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">pegs</span><span class="Punctuation">]</span>
    1721. 

  1721. 

  1722. <span class="Keyword">let</span>
    1723. 

  1723.   <span class="Identifier">pegAst</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;
    1724. 

  1724. Expr    &lt;- Sum
    1725. 

  1725. Sum     &lt;- Product (('+' / '-')Product)*
    1726. 

  1726. Product &lt;- Value (('*' / '/')Value)*
    1727. 

  1727. Value   &lt;- [0-9]+ / '(' Expr ')'
    1728. 

  1728.   &quot;&quot;&quot;</span><span class="Operator">.</span><span class="Identifier">peg</span>
    1729. 

  1729.   <span class="Identifier">txt</span> <span class="Operator">=</span> <span class="StringLit">&quot;(5+3)/2-7*22&quot;</span>
    1730. 

  1730. 

  1731. <span class="Keyword">var</span>
    1732. 

  1732.   <span class="Identifier">pStack</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
    1733. 

  1733.   <span class="Identifier">valStack</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">float</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
    1734. 

  1734.   <span class="Identifier">opStack</span> <span class="Operator">=</span> <span class="StringLit">&quot;&quot;</span>
    1735. 

  1735. <span class="Keyword">let</span>
    1736. 

  1736.   <span class="Identifier">parseArithExpr</span> <span class="Operator">=</span> <span class="Identifier">pegAst</span><span class="Operator">.</span><span class="Identifier">eventParser</span><span class="Punctuation">:</span>
    1737. 

  1737.     <span class="Identifier">pkNonTerminal</span><span class="Punctuation">:</span>
    1738. 

  1738.       <span class="Identifier">enter</span><span class="Punctuation">:</span>
    1739. 

  1739.         <span class="Identifier">pStack</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">nt</span><span class="Operator">.</span><span class="Identifier">name</span>
    1740. 

  1740.       <span class="Identifier">leave</span><span class="Punctuation">:</span>
    1741. 

  1741.         <span class="Identifier">pStack</span><span class="Operator">.</span><span class="Identifier">setLen</span> <span class="Identifier">pStack</span><span class="Operator">.</span><span class="Identifier">high</span>
    1742. 

  1742.         <span class="Keyword">if</span> <span class="Identifier">length</span> <span class="Operator">&gt;</span> <span class="DecNumber">0</span><span class="Punctuation">:</span>
    1743. 

  1743.           <span class="Keyword">let</span> <span class="Identifier">matchStr</span> <span class="Operator">=</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="Identifier">start</span><span class="Punctuation">,</span> <span class="Identifier">start</span><span class="Operator">+</span><span class="Identifier">length</span><span class="Operator">-</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
    1744. 

  1744.           <span class="Keyword">case</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">nt</span><span class="Operator">.</span><span class="Identifier">name</span>
    1745. 

  1745.           <span class="Keyword">of</span> <span class="StringLit">&quot;Value&quot;</span><span class="Punctuation">:</span>
    1746. 

  1746.             <span class="Keyword">try</span><span class="Punctuation">:</span>
    1747. 

  1747.               <span class="Identifier">valStack</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Identifier">matchStr</span><span class="Operator">.</span><span class="Identifier">parseFloat</span>
    1748. 

  1748.               <span class="Identifier">echo</span> <span class="Identifier">valStack</span>
    1749. 

  1749.             <span class="Keyword">except</span> <span class="Identifier">ValueError</span><span class="Punctuation">:</span>
    1750. 

  1750.               <span class="Keyword">discard</span>
    1751. 

  1751.           <span class="Keyword">of</span> <span class="StringLit">&quot;Sum&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Product&quot;</span><span class="Punctuation">:</span>
    1752. 

  1752.             <span class="Keyword">try</span><span class="Punctuation">:</span>
    1753. 

  1753.               <span class="Keyword">let</span> <span class="Identifier">val</span> <span class="Operator">=</span> <span class="Identifier">matchStr</span><span class="Operator">.</span><span class="Identifier">parseFloat</span>
    1754. 

  1754.             <span class="Keyword">except</span> <span class="Identifier">ValueError</span><span class="Punctuation">:</span>
    1755. 

  1755.               <span class="Keyword">if</span> <span class="Identifier">valStack</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">&gt;</span> <span class="DecNumber">1</span> <span class="Keyword">and</span> <span class="Identifier">opStack</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">&gt;</span> <span class="DecNumber">0</span><span class="Punctuation">:</span>
    1756. 

  1756.                 <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Keyword">case</span> <span class="Identifier">opStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    1757. 

  1757.                 <span class="Keyword">of</span> <span class="CharLit">'+'</span><span class="Punctuation">:</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">+</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    1758. 

  1758.                 <span class="Keyword">of</span> <span class="CharLit">'-'</span><span class="Punctuation">:</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">-</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    1759. 

  1759.                 <span class="Keyword">of</span> <span class="CharLit">'*'</span><span class="Punctuation">:</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">*</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    1760. 

  1760.                 <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">/</span> <span class="Identifier">valStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    1761. 

  1761.                 <span class="Identifier">valStack</span><span class="Operator">.</span><span class="Identifier">setLen</span> <span class="Identifier">valStack</span><span class="Operator">.</span><span class="Identifier">high</span>
    1762. 

  1762.                 <span class="Identifier">echo</span> <span class="Identifier">valStack</span>
    1763. 

  1763.                 <span class="Identifier">opStack</span><span class="Operator">.</span><span class="Identifier">setLen</span> <span class="Identifier">opStack</span><span class="Operator">.</span><span class="Identifier">high</span>
    1764. 

  1764.                 <span class="Identifier">echo</span> <span class="Identifier">opStack</span>
    1765. 

  1765.     <span class="Identifier">pkChar</span><span class="Punctuation">:</span>
    1766. 

  1766.       <span class="Identifier">leave</span><span class="Punctuation">:</span>
    1767. 

  1767.         <span class="Keyword">if</span> <span class="Identifier">length</span> <span class="Operator">==</span> <span class="DecNumber">1</span> <span class="Keyword">and</span> <span class="StringLit">&quot;Value&quot;</span> <span class="Operator">!=</span> <span class="Identifier">pStack</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Punctuation">:</span>
    1768. 

  1768.           <span class="Keyword">let</span> <span class="Identifier">matchChar</span> <span class="Operator">=</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">start</span><span class="Punctuation">]</span>
    1769. 

  1769.           <span class="Identifier">opStack</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="Identifier">matchChar</span>
    1770. 

  1770.           <span class="Identifier">echo</span> <span class="Identifier">opStack</span>
    1771. 

  1771. 

  1772. <span class="Keyword">let</span> <span class="Identifier">pLen</span> <span class="Operator">=</span> <span class="Identifier">parseArithExpr</span><span class="Punctuation">(</span><span class="Identifier">txt</span><span class="Punctuation">)</span></pre></p>
    1773. 

  1773. <p>The <em>handlers</em> parameter consists of code blocks for <em>PegKinds</em>, which define the grammar elements of interest. Each block can contain handler code to be executed when the parser enters and leaves text matching the grammar element. An <em>enter</em> handler can access the specific PEG AST node being matched as <em>p</em>, the entire parsed string as <em>s</em> and the position of the matched text segment in <em>s</em> as <em>start</em>. A <em>leave</em> handler can access <em>p</em>, <em>s</em>, <em>start</em> and also the length of the matched text segment as <em>length</em>. For an unsuccessful match, the <em>enter</em> and <em>leave</em> handlers will be executed, with <em>length</em> set to -1.</p>
    1774. 

  1774. <p>Symbols  declared in an <em>enter</em> handler can be made visible in the corresponding <em>leave</em> handler by annotating them with an <em>inject</em> pragma.</p>
    1775. 

  1775. 

  1776.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L957" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1777. 

  1777. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L957" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1778. 

  1778. 

  1779.   </dd>
    1780. 

  1780. </div>
    1781. 

  1781. 

  1782. </div>
    1783. 

  1783. <div id="ident-templates-all">
    1784. 

  1784.   <div id="ident.t">
    1785. 

  1785.   <dt><pre><span class="Keyword">template</span> <a href="#ident.t"><span class="Identifier">ident</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1786. 

  1786.   <dd>
    1787. 

  1787.     
    1788. 

  1788.     same as <tt class="docutils literal"><span class="pre">[a-zA-Z_][a-zA-z_0-9]*</span></tt>; standard identifier
    1789. 

  1789.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L385" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1790. 

  1790. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L385" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1791. 

  1791. 

  1792.   </dd>
    1793. 

  1793. </div>
    1794. 

  1794. 

  1795. </div>
    1796. 

  1796. <div id="identChars-templates-all">
    1797. 

  1797.   <div id="identChars.t">
    1798. 

  1798.   <dt><pre><span class="Keyword">template</span> <a href="#identChars.t"><span class="Identifier">identChars</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1799. 

  1799.   <dd>
    1800. 

  1800.     
    1801. 

  1801.     expands to <tt class="docutils literal"><span class="pre">charset({'a'..'z', 'A'..'Z', '0'..'9', '_'})</span></tt>
    1802. 

  1802.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L377" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1803. 

  1803. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L377" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1804. 

  1804. 

  1805.   </dd>
    1806. 

  1806. </div>
    1807. 

  1807. 

  1808. </div>
    1809. 

  1809. <div id="identStartChars-templates-all">
    1810. 

  1810.   <div id="identStartChars.t">
    1811. 

  1811.   <dt><pre><span class="Keyword">template</span> <a href="#identStartChars.t"><span class="Identifier">identStartChars</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1812. 

  1812.   <dd>
    1813. 

  1813.     
    1814. 

  1814.     expands to <tt class="docutils literal"><span class="pre">charset({'A'..'Z', 'a'..'z', '_'})</span></tt>
    1815. 

  1815.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L381" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1816. 

  1816. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L381" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1817. 

  1817. 

  1818.   </dd>
    1819. 

  1819. </div>
    1820. 

  1820. 

  1821. </div>
    1822. 

  1822. <div id="letters-templates-all">
    1823. 

  1823.   <div id="letters.t">
    1824. 

  1824.   <dt><pre><span class="Keyword">template</span> <a href="#letters.t"><span class="Identifier">letters</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1825. 

  1825.   <dd>
    1826. 

  1826.     
    1827. 

  1827.     expands to <tt class="docutils literal"><span class="pre">charset({'A'..'Z', 'a'..'z'})</span></tt>
    1828. 

  1828.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L365" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1829. 

  1829. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L365" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1830. 

  1830. 

  1831.   </dd>
    1832. 

  1832. </div>
    1833. 

  1833. 

  1834. </div>
    1835. 

  1835. <div id="natural-templates-all">
    1836. 

  1836.   <div id="natural.t">
    1837. 

  1837.   <dt><pre><span class="Keyword">template</span> <a href="#natural.t"><span class="Identifier">natural</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1838. 

  1838.   <dd>
    1839. 

  1839.     
    1840. 

  1840.     same as <tt class="docutils literal"><span class="pre">\d+</span></tt>
    1841. 

  1841.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L390" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1842. 

  1842. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L390" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1843. 

  1843. 

  1844.   </dd>
    1845. 

  1845. </div>
    1846. 

  1846. 

  1847. </div>
    1848. 

  1848. <div id="whitespace-templates-all">
    1849. 

  1849.   <div id="whitespace.t">
    1850. 

  1850.   <dt><pre><span class="Keyword">template</span> <a href="#whitespace.t"><span class="Identifier">whitespace</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="pegs.html#Peg"><span class="Identifier">Peg</span></a></pre></dt>
    1851. 

  1851.   <dd>
    1852. 

  1852.     
    1853. 

  1853.     expands to <tt class="docutils literal"><span class="pre">charset({' ', '\9'..'\13'})</span></tt>
    1854. 

  1854.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/pegs.nim#L373" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    1855. 

  1855. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/pegs.nim#L373" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    1856. 

  1856. 

  1857.   </dd>
    1858. 

  1858. </div>
    1859. 

  1859. 

  1860. </div>
    1861. 

  1861. 

  1862.   </dl>
    1863. 

  1863. </div>
    1864. 

  1864. 

  1865.   </div>
    1866. 

  1866. </div>
    1867. 

  1867. 

  1868.       <div class="twelve-columns footer">
    1869. 

  1869.         <span class="nim-sprite"></span>
    1870. 

  1870.         <br>
    1871. 

  1871.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:02 UTC</small>
    1872. 

  1872.       </div>
    1873. 

  1873.     </div>
    1874. 

  1874.   </div>
    1875. 

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

  1876.     
    1877. 

  1877. </body>
    1878. 

  1878. </html>
    1879. 

  1879.