Главная Обзор Помощь
Вход
levovix
/
Nim
зеркало из https://github.com/nim-lang/Nim
Следить 1
В избранное 0
Ответвить 1
Файлы Обсуждения 0 Вики
Ветка: gh-pages
Ветки Метки
Nim
/
rst.html

rst.html 73 KB
Постоянная ссылка История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741 
  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>packages/docutils/rst</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">packages/docutils/rst</h1>
    28. 

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

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

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

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

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

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

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

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

  36.       </select>
    37. 

  37.     </div>
    38. 

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

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

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

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

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

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

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

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

  46.       </ul>
    47. 

  47.     </div>
    48. 

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

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

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

  51.     </div>
    52. 

  52.     
    53. 

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

  54.   <li>
    55. 

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

  56. </li>
    57. 

  57. <li>
    58. 

  58.   <details open>
    59. 

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

  60.     <ul class="simple simple-toc-section">
    61. 

  61.       <li><a class="reference" href="#EParseError" title="EParseError = object of ValueError">EParseError</a></li>
    62. 

  62. <li><a class="reference" href="#FindFileHandler" title="FindFileHandler = proc (filename: string): string {.closure, gcsafe.}">FindFileHandler</a></li>
    63. 

  63. <li><a class="reference" href="#FindRefFileHandler" title="FindRefFileHandler = proc (targetRelPath: string): tuple[targetPath: string,
    64. 

  64.     linkRelPath: string] {.closure, gcsafe.}">FindRefFileHandler</a></li>
    65. 

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

  66.   mcHint = &quot;Hint&quot;, mcWarning = &quot;Warning&quot;, mcError = &quot;Error&quot;">MsgClass</a></li>
    67. 

  67. <li><a class="reference" href="#MsgHandler" title="MsgHandler = proc (filename: string; line, col: int; msgKind: MsgKind;
    68. 

  68.                    arg: string) {.closure, gcsafe.}">MsgHandler</a></li>
    69. 

  69. <li><a class="reference" href="#MsgKind" title="MsgKind = enum
    70. 

  70.   meCannotOpenFile = &quot;cannot open \'$1\'&quot;, meExpected = &quot;\'$1\' expected&quot;,
    71. 

  71.   meMissingClosing = &quot;$1&quot;,
    72. 

  72.   meGridTableNotImplemented = &quot;grid table is not implemented&quot;,
    73. 

  73.   meMarkdownIllformedTable = &quot;illformed delimiter row of a Markdown table&quot;,
    74. 

  74.   meIllformedTable = &quot;Illformed table: $1&quot;,
    75. 

  75.   meNewSectionExpected = &quot;new section expected $1&quot;,
    76. 

  76.   meGeneralParseError = &quot;general parse error&quot;,
    77. 

  77.   meInvalidDirective = &quot;invalid directive: \'$1\'&quot;,
    78. 

  78.   meInvalidField = &quot;invalid field: $1&quot;,
    79. 

  79.   meFootnoteMismatch = &quot;mismatch in number of footnotes and their refs: $1&quot;,
    80. 

  80.   mwRedefinitionOfLabel = &quot;redefinition of label \'$1\'&quot;,
    81. 

  81.   mwUnknownSubstitution = &quot;unknown substitution \'$1\'&quot;,
    82. 

  82.   mwAmbiguousLink = &quot;ambiguous doc link $1&quot;,
    83. 

  83.   mwBrokenLink = &quot;broken link \'$1\'&quot;,
    84. 

  84.   mwUnsupportedLanguage = &quot;language \'$1\' not supported&quot;,
    85. 

  85.   mwUnsupportedField = &quot;field \'$1\' not supported&quot;,
    86. 

  86.   mwRstStyle = &quot;RST style: $1&quot;,
    87. 

  87.   mwUnusedImportdoc = &quot;importdoc for \'$1\' is not used&quot;,
    88. 

  88.   meSandboxedDirective = &quot;disabled directive: \'$1\'&quot;">MsgKind</a></li>
    89. 

  89. <li><a class="reference" href="#PRstSharedState" title="PRstSharedState = ref RstSharedState">PRstSharedState</a></li>
    90. 

  90. <li><a class="reference" href="#RstFileTable" title="RstFileTable = object
    91. 

  91.   filenameToIdx*: Table[string, FileIndex]
    92. 

  92.   idxToFilename*: seq[string]">RstFileTable</a></li>
    93. 

  93. <li><a class="reference" href="#RstParseOption" title="RstParseOption = enum
    94. 

  94.   roSupportSmilies,         ## make the RST parser support smilies like ``:)``
    95. 

  95.   roSupportRawDirective,    ## support the ``raw`` directive (don't support
    96. 

  96.                              ## it for sandboxing)
    97. 

  97.   roSupportMarkdown,        ## support additional features of Markdown
    98. 

  98.   roPreferMarkdown,         ## parse as Markdown (keeping RST as &quot;extension&quot;
    99. 

  99.                              ## to Markdown) -- implies `roSupportMarkdown`
    100. 

  100.   roNimFile,                ## set for Nim files where default interpreted
    101. 

  101.                              ## text role should be :nim:
    102. 

  102.   roSandboxDisabled          ## this option enables certain options
    103. 

  103.                              ## (e.g. raw, include, importdoc)
    104. 

  104.                              ## which are disabled by default as they can
    105. 

  105.                              ## enable users to read arbitrary data and
    106. 

  106.                              ## perform XSS if the parser is used in a web
    107. 

  107.                              ## app.">RstParseOption</a></li>
    108. 

  108. <li><a class="reference" href="#RstParseOptions" title="RstParseOptions = set[RstParseOption]">RstParseOptions</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="#ColRstInit" title="ColRstInit = 0">ColRstInit</a></li>
    118. 

  118. <li><a class="reference" href="#ColRstOffset" title="ColRstOffset = 1">ColRstOffset</a></li>
    119. 

  119. <li><a class="reference" href="#LineRstInit" title="LineRstInit = 1">LineRstInit</a></li>
    120. 

  120. 

  121.     </ul>
    122. 

  122.   </details>
    123. 

  123. </li>
    124. 

  124. <li>
    125. 

  125.   <details open>
    126. 

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

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

  128.       <ul class="simple nested-toc-section">addAnchorNim
    129. 

  129.   <li><a class="reference" href="#addAnchorNim%2CPRstSharedState%2Cbool%2Cstring%2Cstring%2CLangSymbol%2Cint%2CTLineInfo%2CFileIndex" title="addAnchorNim(s: var PRstSharedState; external: bool; refn: string;
    130. 

  130.              tooltip: string; langSym: LangSymbol; priority: int;
    131. 

  131.              info: TLineInfo; module: FileIndex)">addAnchorNim(s: var PRstSharedState; external: bool; refn: string;
    132. 

  132.              tooltip: string; langSym: LangSymbol; priority: int;
    133. 

  133.              info: TLineInfo; module: FileIndex)</a></li>
    134. 

  134. 

  135. </ul>
    136. 

  136. <ul class="simple nested-toc-section">addFilename
    137. 

  137.   <li><a class="reference" href="#addFilename%2CPRstSharedState%2Cstring" title="addFilename(s: PRstSharedState; file1: string): FileIndex">addFilename(s: PRstSharedState; file1: string): FileIndex</a></li>
    138. 

  138. 

  139. </ul>
    140. 

  140. <ul class="simple nested-toc-section">addNodes
    141. 

  141.   <li><a class="reference" href="#addNodes%2CPRstNode" title="addNodes(n: PRstNode): string">addNodes(n: PRstNode): string</a></li>
    142. 

  142. 

  143. </ul>
    144. 

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

  145.   <li><a class="reference" href="#completePass2%2CPRstSharedState" title="completePass2(s: PRstSharedState)">completePass2(s: PRstSharedState)</a></li>
    146. 

  146. 

  147. </ul>
    148. 

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

  149.   <li><a class="reference" href="#defaultFindFile%2Cstring" title="defaultFindFile(filename: string): string">defaultFindFile(filename: string): string</a></li>
    150. 

  150. 

  151. </ul>
    152. 

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

  153.   <li><a class="reference" href="#defaultFindRefFile%2Cstring" title="defaultFindRefFile(filename: string): (string, string)">defaultFindRefFile(filename: string): (string, string)</a></li>
    154. 

  154. 

  155. </ul>
    156. 

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

  157.   <li><a class="reference" href="#defaultMsgHandler%2Cstring%2Cint%2Cint%2CMsgKind%2Cstring" title="defaultMsgHandler(filename: string; line, col: int; msgkind: MsgKind;
    158. 

  158.                   arg: string)">defaultMsgHandler(filename: string; line, col: int; msgkind: MsgKind;
    159. 

  159.                   arg: string)</a></li>
    160. 

  160. 

  161. </ul>
    162. 

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

  163.   <li><a class="reference" href="#getArgument%2CPRstNode" title="getArgument(n: PRstNode): string">getArgument(n: PRstNode): string</a></li>
    164. 

  164. 

  165. </ul>
    166. 

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

  167.   <li><a class="reference" href="#getFieldValue%2CPRstNode" title="getFieldValue(n: PRstNode): string">getFieldValue(n: PRstNode): string</a></li>
    168. 

  168. <li><a class="reference" href="#getFieldValue%2CPRstNode%2Cstring" title="getFieldValue(n: PRstNode; fieldname: string): string">getFieldValue(n: PRstNode; fieldname: string): string</a></li>
    169. 

  169. 

  170. </ul>
    171. 

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

  172.   <li><a class="reference" href="#newRstSharedState%2CRstParseOptions%2Cstring%2CFindFileHandler%2CFindRefFileHandler%2CMsgHandler%2Cbool" title="newRstSharedState(options: RstParseOptions; filename: string;
    173. 

  173.                   findFile: FindFileHandler; findRefFile: FindRefFileHandler;
    174. 

  174.                   msgHandler: MsgHandler; hasToc: bool): PRstSharedState">newRstSharedState(options: RstParseOptions; filename: string;
    175. 

  175.                   findFile: FindFileHandler; findRefFile: FindRefFileHandler;
    176. 

  176.                   msgHandler: MsgHandler; hasToc: bool): PRstSharedState</a></li>
    177. 

  177. 

  178. </ul>
    179. 

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

  180.   <li><a class="reference" href="#preparePass2%2CPRstSharedState%2CPRstNode" title="preparePass2(s: var PRstSharedState; mainNode: PRstNode; importdoc = true)">preparePass2(s: var PRstSharedState; mainNode: PRstNode; importdoc = true)</a></li>
    181. 

  181. 

  182. </ul>
    183. 

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

  184.   <li><a class="reference" href="#resolveSubs%2CPRstSharedState%2CPRstNode" title="resolveSubs(s: PRstSharedState; n: PRstNode): PRstNode">resolveSubs(s: PRstSharedState; n: PRstNode): PRstNode</a></li>
    185. 

  185. 

  186. </ul>
    187. 

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

  188.   <li><a class="reference" href="#rstMessage%2CRstFileTable%2CMsgHandler%2CTLineInfo%2CMsgKind%2Cstring" title="rstMessage(filenames: RstFileTable; f: MsgHandler; info: TLineInfo;
    189. 

  189.            msgKind: MsgKind; arg: string)">rstMessage(filenames: RstFileTable; f: MsgHandler; info: TLineInfo;
    190. 

  190.            msgKind: MsgKind; arg: string)</a></li>
    191. 

  191. 

  192. </ul>
    193. 

  193. <ul class="simple nested-toc-section">rstnodeToRefname
    194. 

  194.   <li><a class="reference" href="#rstnodeToRefname%2CPRstNode" title="rstnodeToRefname(n: PRstNode): string">rstnodeToRefname(n: PRstNode): string</a></li>
    195. 

  195. 

  196. </ul>
    197. 

  197. <ul class="simple nested-toc-section">rstParse
    198. 

  198.   <li><a class="reference" href="#rstParse%2Cstring%2Cstring%2Cint%2Cint%2CRstParseOptions%2CFindFileHandler%2CFindRefFileHandler%2CMsgHandler" title="rstParse(text, filename: string; line, column: int; options: RstParseOptions;
    199. 

  199.          findFile: FindFileHandler = nil; findRefFile: FindRefFileHandler = nil;
    200. 

  200.          msgHandler: MsgHandler = nil): tuple[node: PRstNode,
    201. 

  201.     filenames: RstFileTable, hasToc: bool]">rstParse(text, filename: string; line, column: int; options: RstParseOptions;
    202. 

  202.          findFile: FindFileHandler = nil; findRefFile: FindRefFileHandler = nil;
    203. 

  203.          msgHandler: MsgHandler = nil): tuple[node: PRstNode,
    204. 

  204.     filenames: RstFileTable, hasToc: bool]</a></li>
    205. 

  205. 

  206. </ul>
    207. 

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

  208.   <li><a class="reference" href="#rstParsePass1%2Cstring%2Cint%2Cint%2CPRstSharedState" title="rstParsePass1(fragment: string; line, column: int; sharedState: PRstSharedState): PRstNode">rstParsePass1(fragment: string; line, column: int; sharedState: PRstSharedState): PRstNode</a></li>
    209. 

  209. 

  210. </ul>
    211. 

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

  212.   <li><a class="reference" href="#safeProtocol%2Cstring" title="safeProtocol(linkStr: var string): string">safeProtocol(linkStr: var string): string</a></li>
    213. 

  213. 

  214. </ul>
    215. 

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

  216.   <li><a class="reference" href="#setCurrFilename%2CPRstSharedState%2Cstring" title="setCurrFilename(s: PRstSharedState; file1: string)">setCurrFilename(s: PRstSharedState; file1: string)</a></li>
    217. 

  217. 

  218. </ul>
    219. 

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

  220.   <li><a class="reference" href="#whichMsgClass%2CMsgKind" title="whichMsgClass(k: MsgKind): MsgClass">whichMsgClass(k: MsgKind): MsgClass</a></li>
    221. 

  221. 

  222. </ul>
    223. 

  223. 

  224.     </ul>
    225. 

  225.   </details>
    226. 

  226. </li>
    227. 

  227. 

  228. </ul>
    229. 

  229. 

  230.   </div>
    231. 

  231.   <div class="nine columns" id="content">
    232. 

  232.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    233. 

  233. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    234. 

  234. 

  235.     <div id="tocRoot"></div>
    236. 

  236.     
    237. 

  237.     <p class="module-desc">This module implements a <span id="restructuredtext_1">reStructuredText</span> (RST) and <span id="markdown_1">Markdown</span> parser. User's manual on supported markup syntax and command line usage can be found in <a class="reference external" href="markdown_rst.html">Nim-flavored Markdown and reStructuredText</a>.<ul class="simple"><li>See also <a class="reference external" href="docgen.html">Nim DocGen Tools Guide</a> for handling of <tt class="docutils literal"><span class="pre">.nim</span></tt> files.</li>
    238. 

  238. <li>See also <a class="reference external" href="rstgen.html">packages/docutils/rstgen module</a> to know how to generate HTML or Latex strings (for embedding them into custom documents).</li>
    239. 

  239. </ul>
    240. 

  240. <p>Choice between Markdown and RST as well as optional additional features are turned on by passing <tt class="docutils literal"><span class="pre">options:</span></tt> <a class="reference internal nimdoc" title="type RstParseOptions" href="#RstParseOptions">RstParseOptions</a> to <a class="reference internal nimdoc" title="proc rstParse(text, filename: string; line, column: int; options: RstParseOptions;
    241. 

  241.          findFile: FindFileHandler = nil; findRefFile: FindRefFileHandler = nil;
    242. 

  242.          msgHandler: MsgHandler = nil): tuple[node: PRstNode,
    243. 

  243.     filenames: RstFileTable, hasToc: bool]" href="#rstParse,string,string,int,int,RstParseOptions,FindFileHandler,FindRefFileHandler,MsgHandler">proc rstParse</a>.</p>
    244. 

  244. </p>
    245. 

  245.     <div class="section" id="6">
    246. 

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

  247.   <dl class="item">
    248. 

  248.     <a class="reference external" href="os.html">os</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="enumutils.html">enumutils</a>, <a class="reference external" href="algorithm.html">algorithm</a>, <a class="reference external" href="lists.html">lists</a>, <a class="reference external" href="sequtils.html">sequtils</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="strscans.html">strscans</a>, <a class="reference external" href="dochelpers.html">dochelpers</a>, <a class="reference external" href="rstidx.html">rstidx</a>, <a class="reference external" href="rstast.html">rstast</a>, <a class="reference external" href="miscdollars.html">miscdollars</a>, <a class="reference external" href="highlite.html">highlite</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="syncio.html">syncio</a>
    249. 

  249.   </dl>
    250. 

  250. </div>
    251. 

  251. <div class="section" id="7">
    252. 

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

  253.   <dl class="item">
    254. 

  254.     <div id="EParseError">
    255. 

  255.   <dt><pre><a href="rst.html#EParseError"><span class="Identifier">EParseError</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>
    256. 

  256.   <dd>
    257. 

  257.     
    258. 

  258.     
    259. 

  259.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L446" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    260. 

  260. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L446" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    261. 

  261. 

  262.   </dd>
    263. 

  263. </div>
    264. 

  264. <div id="FindFileHandler">
    265. 

  265.   <dt><pre><a href="rst.html#FindFileHandler"><span class="Identifier">FindFileHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
    266. 

  266.   <dd>
    267. 

  267.     
    268. 

  268.     
    269. 

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

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

  271. 

  272.   </dd>
    273. 

  273. </div>
    274. 

  274. <div id="FindRefFileHandler">
    275. 

  275.   <dt><pre><a href="rst.html#FindRefFileHandler"><span class="Identifier">FindRefFileHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">targetRelPath</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="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">targetPath</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span>
    276. 

  276.     <span class="Identifier">linkRelPath</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
    277. 

  277.   <dd>
    278. 

  278.     
    279. 

  279.     returns where .html or .idx file should be found by its relative path; <tt class="docutils literal"><span class="pre"><span class="Identifier">linkRelPath</span></span></tt> is a prefix to be added before a link anchor from such file
    280. 

  280.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L84" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    281. 

  281. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L84" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    282. 

  282. 

  283.   </dd>
    284. 

  284. </div>
    285. 

  285. <div id="MsgClass">
    286. 

  286.   <dt><pre><a href="rst.html#MsgClass"><span class="Identifier">MsgClass</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    287. 

  287.   <span class="Identifier">mcHint</span> <span class="Other">=</span> <span class="StringLit">&quot;Hint&quot;</span><span class="Other">,</span> <span class="Identifier">mcWarning</span> <span class="Other">=</span> <span class="StringLit">&quot;Warning&quot;</span><span class="Other">,</span> <span class="Identifier">mcError</span> <span class="Other">=</span> <span class="StringLit">&quot;Error&quot;</span></pre></dt>
    288. 

  288.   <dd>
    289. 

  289.     
    290. 

  290.     
    291. 

  291.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L53" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    292. 

  292. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L53" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    293. 

  293. 

  294.   </dd>
    295. 

  295. </div>
    296. 

  296. <div id="MsgHandler">
    297. 

  297.   <dt><pre><a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">,</span> <span class="Identifier">col</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">msgKind</span><span class="Other">:</span> <a href="rst.html#MsgKind"><span class="Identifier">MsgKind</span></a><span class="Other">;</span>
    298. 

  298.                    <span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
    299. 

  299.   <dd>
    300. 

  300.     
    301. 

  301.     what to do in case of an error
    302. 

  302.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L81" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    303. 

  303. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L81" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    304. 

  304. 

  305.   </dd>
    306. 

  306. </div>
    307. 

  307. <div id="MsgKind">
    308. 

  308.   <dt><pre><a href="rst.html#MsgKind"><span class="Identifier">MsgKind</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    309. 

  309.   <span class="Identifier">meCannotOpenFile</span> <span class="Other">=</span> <span class="StringLit">&quot;cannot open \'$1\'&quot;</span><span class="Other">,</span> <span class="Identifier">meExpected</span> <span class="Other">=</span> <span class="StringLit">&quot;\'$1\' expected&quot;</span><span class="Other">,</span>
    310. 

  310.   <span class="Identifier">meMissingClosing</span> <span class="Other">=</span> <span class="StringLit">&quot;$1&quot;</span><span class="Other">,</span>
    311. 

  311.   <span class="Identifier">meGridTableNotImplemented</span> <span class="Other">=</span> <span class="StringLit">&quot;grid table is not implemented&quot;</span><span class="Other">,</span>
    312. 

  312.   <span class="Identifier">meMarkdownIllformedTable</span> <span class="Other">=</span> <span class="StringLit">&quot;illformed delimiter row of a Markdown table&quot;</span><span class="Other">,</span>
    313. 

  313.   <span class="Identifier">meIllformedTable</span> <span class="Other">=</span> <span class="StringLit">&quot;Illformed table: $1&quot;</span><span class="Other">,</span>
    314. 

  314.   <span class="Identifier">meNewSectionExpected</span> <span class="Other">=</span> <span class="StringLit">&quot;new section expected $1&quot;</span><span class="Other">,</span>
    315. 

  315.   <span class="Identifier">meGeneralParseError</span> <span class="Other">=</span> <span class="StringLit">&quot;general parse error&quot;</span><span class="Other">,</span>
    316. 

  316.   <span class="Identifier">meInvalidDirective</span> <span class="Other">=</span> <span class="StringLit">&quot;invalid directive: \'$1\'&quot;</span><span class="Other">,</span>
    317. 

  317.   <span class="Identifier">meInvalidField</span> <span class="Other">=</span> <span class="StringLit">&quot;invalid field: $1&quot;</span><span class="Other">,</span>
    318. 

  318.   <span class="Identifier">meFootnoteMismatch</span> <span class="Other">=</span> <span class="StringLit">&quot;mismatch in number of footnotes and their refs: $1&quot;</span><span class="Other">,</span>
    319. 

  319.   <span class="Identifier">mwRedefinitionOfLabel</span> <span class="Other">=</span> <span class="StringLit">&quot;redefinition of label \'$1\'&quot;</span><span class="Other">,</span>
    320. 

  320.   <span class="Identifier">mwUnknownSubstitution</span> <span class="Other">=</span> <span class="StringLit">&quot;unknown substitution \'$1\'&quot;</span><span class="Other">,</span>
    321. 

  321.   <span class="Identifier">mwAmbiguousLink</span> <span class="Other">=</span> <span class="StringLit">&quot;ambiguous doc link $1&quot;</span><span class="Other">,</span>
    322. 

  322.   <span class="Identifier">mwBrokenLink</span> <span class="Other">=</span> <span class="StringLit">&quot;broken link \'$1\'&quot;</span><span class="Other">,</span>
    323. 

  323.   <span class="Identifier">mwUnsupportedLanguage</span> <span class="Other">=</span> <span class="StringLit">&quot;language \'$1\' not supported&quot;</span><span class="Other">,</span>
    324. 

  324.   <span class="Identifier">mwUnsupportedField</span> <span class="Other">=</span> <span class="StringLit">&quot;field \'$1\' not supported&quot;</span><span class="Other">,</span>
    325. 

  325.   <span class="Identifier">mwRstStyle</span> <span class="Other">=</span> <span class="StringLit">&quot;RST style: $1&quot;</span><span class="Other">,</span>
    326. 

  326.   <span class="Identifier">mwUnusedImportdoc</span> <span class="Other">=</span> <span class="StringLit">&quot;importdoc for \'$1\' is not used&quot;</span><span class="Other">,</span>
    327. 

  327.   <span class="Identifier">meSandboxedDirective</span> <span class="Other">=</span> <span class="StringLit">&quot;disabled directive: \'$1\'&quot;</span></pre></dt>
    328. 

  328.   <dd>
    329. 

  329.     
    330. 

  330.     the possible messages
    331. 

  331.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L59" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    332. 

  332. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L59" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    333. 

  333. 

  334.   </dd>
    335. 

  335. </div>
    336. 

  336. <div id="PRstSharedState">
    337. 

  337.   <dt><pre><a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">RstSharedState</span></pre></dt>
    338. 

  338.   <dd>
    339. 

  339.     
    340. 

  340.     
    341. 

  341.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L428" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    342. 

  342. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L428" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    343. 

  343. 

  344.   </dd>
    345. 

  345. </div>
    346. 

  346. <div id="RstFileTable">
    347. 

  347.   <dt><pre><a href="rst.html#RstFileTable"><span class="Identifier">RstFileTable</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
    348. 

  348.   <span class="Identifier">filenameToIdx</span><span class="Operator">*</span><span class="Other">:</span> <a href="tables.html#Table"><span class="Identifier">Table</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="rstast.html#FileIndex"><span class="Identifier">FileIndex</span></a><span class="Other">]</span>
    349. 

  349.   <span class="Identifier">idxToFilename</span><span class="Operator">*</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></pre></dt>
    350. 

  350.   <dd>
    351. 

  351.     
    352. 

  352.     
    353. 

  353.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L386" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    354. 

  354. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L386" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    355. 

  355. 

  356.   </dd>
    357. 

  357. </div>
    358. 

  358. <div id="RstParseOption">
    359. 

  359.   <dt><pre><a href="rst.html#RstParseOption"><span class="Identifier">RstParseOption</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
    360. 

  360.   <span class="Identifier">roSupportSmilies</span><span class="Other">,</span>         <span class="Comment">## make the RST parser support smilies like ``:)``</span>
    361. 

  361.   <span class="Identifier">roSupportRawDirective</span><span class="Other">,</span>    <span class="Comment">## support the ``raw`` directive (don't support</span>
    362. 

  362.                              <span class="Comment">## it for sandboxing)</span>
    363. 

  363.   <span class="Identifier">roSupportMarkdown</span><span class="Other">,</span>        <span class="Comment">## support additional features of Markdown</span>
    364. 

  364.   <span class="Identifier">roPreferMarkdown</span><span class="Other">,</span>         <span class="Comment">## parse as Markdown (keeping RST as &quot;extension&quot;</span>
    365. 

  365.                              <span class="Comment">## to Markdown) -- implies `roSupportMarkdown`</span>
    366. 

  366.   <span class="Identifier">roNimFile</span><span class="Other">,</span>                <span class="Comment">## set for Nim files where default interpreted</span>
    367. 

  367.                              <span class="Comment">## text role should be :nim:</span>
    368. 

  368.   <span class="Identifier">roSandboxDisabled</span>          <span class="Comment">## this option enables certain options</span>
    369. 

  369.                              <span class="Comment">## (e.g. raw, include, importdoc)</span>
    370. 

  370.                              <span class="Comment">## which are disabled by default as they can</span>
    371. 

  371.                              <span class="Comment">## enable users to read arbitrary data and</span>
    372. 

  372.                              <span class="Comment">## perform XSS if the parser is used in a web</span>
    373. 

  373.                              <span class="Comment">## app.</span></pre></dt>
    374. 

  374.   <dd>
    375. 

  375.     
    376. 

  376.     options for the RST parser
    377. 

  377.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L35" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    378. 

  378. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L35" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    379. 

  379. 

  380.   </dd>
    381. 

  381. </div>
    382. 

  382. <div id="RstParseOptions">
    383. 

  383.   <dt><pre><a href="rst.html#RstParseOptions"><span class="Identifier">RstParseOptions</span></a> <span class="Other">=</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><a href="rst.html#RstParseOption"><span class="Identifier">RstParseOption</span></a><span class="Other">]</span></pre></dt>
    384. 

  384.   <dd>
    385. 

  385.     
    386. 

  386.     
    387. 

  387.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L51" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    388. 

  388. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L51" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    389. 

  389. 

  390.   </dd>
    391. 

  391. </div>
    392. 

  392. 

  393.   </dl>
    394. 

  394. </div>
    395. 

  395. <div class="section" id="10">
    396. 

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

  397.   <dl class="item">
    398. 

  398.     <div id="ColRstInit">
    399. 

  399.   <dt><pre><a href="rst.html#ColRstInit"><span class="Identifier">ColRstInit</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
    400. 

  400.   <dd>
    401. 

  401.     
    402. 

  402.     Initial column number for standalone RST text (Nim global reporting adds ColOffset=1)
    403. 

  403.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L451" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    404. 

  404. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L451" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    405. 

  405. 

  406.   </dd>
    407. 

  407. </div>
    408. 

  408. <div id="ColRstOffset">
    409. 

  409.   <dt><pre><a href="rst.html#ColRstOffset"><span class="Identifier">ColRstOffset</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
    410. 

  410.   <dd>
    411. 

  411.     
    412. 

  412.     1: a replica of ColOffset for internal use
    413. 

  413.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L453" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    414. 

  414. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L453" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    415. 

  415. 

  416.   </dd>
    417. 

  417. </div>
    418. 

  418. <div id="LineRstInit">
    419. 

  419.   <dt><pre><a href="rst.html#LineRstInit"><span class="Identifier">LineRstInit</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
    420. 

  420.   <dd>
    421. 

  421.     
    422. 

  422.     Initial line number for standalone RST text
    423. 

  423.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L450" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    424. 

  424. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L450" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    425. 

  425. 

  426.   </dd>
    427. 

  427. </div>
    428. 

  428. 

  429.   </dl>
    430. 

  430. </div>
    431. 

  431. <div class="section" id="12">
    432. 

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

  433.   <dl class="item">
    434. 

  434.     <div id="addAnchorNim-procs-all">
    435. 

  435.   <div id="addAnchorNim,PRstSharedState,bool,string,string,LangSymbol,int,TLineInfo,FileIndex">
    436. 

  436.   <dt><pre><span class="Keyword">proc</span> <a href="#addAnchorNim%2CPRstSharedState%2Cbool%2Cstring%2Cstring%2CLangSymbol%2Cint%2CTLineInfo%2CFileIndex"><span class="Identifier">addAnchorNim</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">;</span> <span class="Identifier">external</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">;</span> <span class="Identifier">refn</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    437. 

  437.                   <span class="Identifier">tooltip</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">langSym</span><span class="Other">:</span> <a href="dochelpers.html#LangSymbol"><span class="Identifier">LangSymbol</span></a><span class="Other">;</span> <span class="Identifier">priority</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span>
    438. 

  438.                   <span class="Identifier">info</span><span class="Other">:</span> <a href="rstast.html#TLineInfo"><span class="Identifier">TLineInfo</span></a><span class="Other">;</span> <span class="Identifier">module</span><span class="Other">:</span> <a href="rstast.html#FileIndex"><span class="Identifier">FileIndex</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>
    439. 

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

  440.   <dd>
    441. 

  441.     
    442. 

  442.     Adds an anchor <tt class="docutils literal"><span class="pre"><span class="Identifier">refn</span></span></tt>, which follows the rule <tt class="docutils literal"><span class="pre"><span class="Identifier">arNim</span></span></tt> (i.e. a symbol in <tt class="docutils literal"><span class="pre">*.nim</span></tt> file)
    443. 

  443.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L863" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    444. 

  444. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L863" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    445. 

  445. 

  446.   </dd>
    447. 

  447. </div>
    448. 

  448. 

  449. </div>
    450. 

  450. <div id="addFilename-procs-all">
    451. 

  451.   <div id="addFilename,PRstSharedState,string">
    452. 

  452.   <dt><pre><span class="Keyword">proc</span> <a href="#addFilename%2CPRstSharedState%2Cstring"><span class="Identifier">addFilename</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">;</span> <span class="Identifier">file1</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="rstast.html#FileIndex"><span class="Identifier">FileIndex</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>
    453. 

  453.     <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>
    454. 

  454.   <dd>
    455. 

  455.     
    456. 

  456.     Returns index of filename, adding it if it has not been used before
    457. 

  457.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L507" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    458. 

  458. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L507" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    459. 

  459. 

  460.   </dd>
    461. 

  461. </div>
    462. 

  462. 

  463. </div>
    464. 

  464. <div id="addNodes-procs-all">
    465. 

  465.   <div id="addNodes,PRstNode">
    466. 

  466.   <dt><pre><span class="Keyword">proc</span> <a href="#addNodes%2CPRstNode"><span class="Identifier">addNodes</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</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>
    467. 

  467.   <dd>
    468. 

  468.     
    469. 

  469.     
    470. 

  470.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L91" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    471. 

  471. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L91" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    472. 

  472. 

  473.   </dd>
    474. 

  474. </div>
    475. 

  475. 

  476. </div>
    477. 

  477. <div id="completePass2-procs-all">
    478. 

  478.   <div id="completePass2,PRstSharedState">
    479. 

  479.   <dt><pre><span class="Keyword">proc</span> <a href="#completePass2%2CPRstSharedState"><span class="Identifier">completePass2</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    480. 

  480.     <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>
    481. 

  481.   <dd>
    482. 

  482.     
    483. 

  483.     
    484. 

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

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

  486. 

  487.   </dd>
    488. 

  488. </div>
    489. 

  489. 

  490. </div>
    491. 

  491. <div id="defaultFindFile-procs-all">
    492. 

  492.   <div id="defaultFindFile,string">
    493. 

  493.   <dt><pre><span class="Keyword">proc</span> <a href="#defaultFindFile%2Cstring"><span class="Identifier">defaultFindFile</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="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>
    494. 

  494.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadDirEffect</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>
    495. 

  495.   <dd>
    496. 

  496.     
    497. 

  497.     
    498. 

  498.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L477" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    499. 

  499. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L477" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    500. 

  500. 

  501.   </dd>
    502. 

  502. </div>
    503. 

  503. 

  504. </div>
    505. 

  505. <div id="defaultFindRefFile-procs-all">
    506. 

  506.   <div id="defaultFindRefFile,string">
    507. 

  507.   <dt><pre><span class="Keyword">proc</span> <a href="#defaultFindRefFile%2Cstring"><span class="Identifier">defaultFindRefFile</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Other">(</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><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>
    508. 

  508.     <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>
    509. 

  509.   <dd>
    510. 

  510.     
    511. 

  511.     
    512. 

  512.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L481" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    513. 

  513. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L481" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    514. 

  514. 

  515.   </dd>
    516. 

  516. </div>
    517. 

  517. 

  518. </div>
    519. 

  519. <div id="defaultMsgHandler-procs-all">
    520. 

  520.   <div id="defaultMsgHandler,string,int,int,MsgKind,string">
    521. 

  521.   <dt><pre><span class="Keyword">proc</span> <a href="#defaultMsgHandler%2Cstring%2Cint%2Cint%2CMsgKind%2Cstring"><span class="Identifier">defaultMsgHandler</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">line</span><span class="Other">,</span> <span class="Identifier">col</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">msgkind</span><span class="Other">:</span> <a href="rst.html#MsgKind"><span class="Identifier">MsgKind</span></a><span class="Other">;</span>
    522. 

  522.                        <span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">EParseError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    523. 

  523.                                       <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    524. 

  524.   <dd>
    525. 

  525.     
    526. 

  526.     
    527. 

  527.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L467" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    528. 

  528. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L467" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    529. 

  529. 

  530.   </dd>
    531. 

  531. </div>
    532. 

  532. 

  533. </div>
    534. 

  534. <div id="getArgument-procs-all">
    535. 

  535.   <div id="getArgument,PRstNode">
    536. 

  536.   <dt><pre><span class="Keyword">proc</span> <a href="#getArgument%2CPRstNode"><span class="Identifier">getArgument</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</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>
    537. 

  537.   <dd>
    538. 

  538.     
    539. 

  539.     
    540. 

  540.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L93" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    541. 

  541. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L93" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    542. 

  542. 

  543.   </dd>
    544. 

  544. </div>
    545. 

  545. 

  546. </div>
    547. 

  547. <div id="getFieldValue-procs-all">
    548. 

  548.   <div id="getFieldValue,PRstNode">
    549. 

  549.   <dt><pre><span class="Keyword">proc</span> <a href="#getFieldValue%2CPRstNode"><span class="Identifier">getFieldValue</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</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>
    550. 

  550.   <dd>
    551. 

  551.     
    552. 

  552.     <p>Returns the value of a specific <tt class="docutils literal"><span class="pre">rnField</span></tt> node.</p>
    553. 

  553. <p>This proc will assert if the node is not of the expected type. The empty string will be returned as a minimum. Any value in the rst will be stripped form leading/trailing whitespace.</p>
    554. 

  554. 

  555.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L2076" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    556. 

  556. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L2076" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    557. 

  557. 

  558.   </dd>
    559. 

  559. </div>
    560. 

  560. <div id="getFieldValue,PRstNode,string">
    561. 

  561.   <dt><pre><span class="Keyword">proc</span> <a href="#getFieldValue%2CPRstNode%2Cstring"><span class="Identifier">getFieldValue</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">;</span> <span class="Identifier">fieldname</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    562. 

  562.     <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>
    563. 

  563.   <dd>
    564. 

  564.     
    565. 

  565.     
    566. 

  566.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L92" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    567. 

  567. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L92" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    568. 

  568. 

  569.   </dd>
    570. 

  570. </div>
    571. 

  571. 

  572. </div>
    573. 

  573. <div id="newRstSharedState-procs-all">
    574. 

  574.   <div id="newRstSharedState,RstParseOptions,string,FindFileHandler,FindRefFileHandler,MsgHandler,bool">
    575. 

  575.   <dt><pre><span class="Keyword">proc</span> <a href="#newRstSharedState%2CRstParseOptions%2Cstring%2CFindFileHandler%2CFindRefFileHandler%2CMsgHandler%2Cbool"><span class="Identifier">newRstSharedState</span></a><span class="Other">(</span><span class="Identifier">options</span><span class="Other">:</span> <a href="rst.html#RstParseOptions"><span class="Identifier">RstParseOptions</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
    576. 

  576.                        <span class="Identifier">findFile</span><span class="Other">:</span> <a href="rst.html#FindFileHandler"><span class="Identifier">FindFileHandler</span></a><span class="Other">;</span>
    577. 

  577.                        <span class="Identifier">findRefFile</span><span class="Other">:</span> <a href="rst.html#FindRefFileHandler"><span class="Identifier">FindRefFileHandler</span></a><span class="Other">;</span> <span class="Identifier">msgHandler</span><span class="Other">:</span> <a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a><span class="Other">;</span>
    578. 

  578.                        <span class="Identifier">hasToc</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</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>
    579. 

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

  580.   <dd>
    581. 

  581.     
    582. 

  582.     
    583. 

  583.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L533" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    584. 

  584. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L533" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    585. 

  585. 

  586.   </dd>
    587. 

  587. </div>
    588. 

  588. 

  589. </div>
    590. 

  590. <div id="preparePass2-procs-all">
    591. 

  591.   <div id="preparePass2,PRstSharedState,PRstNode">
    592. 

  592.   <dt><pre><span class="Keyword">proc</span> <a href="#preparePass2%2CPRstSharedState%2CPRstNode"><span class="Identifier">preparePass2</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">;</span> <span class="Identifier">mainNode</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">;</span> <span class="Identifier">importdoc</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span> {.
    593. 

  593.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">]</span><span class="Other">,</span>
    594. 

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

  595.   <dd>
    596. 

  596.     
    597. 

  597.     Records titles in node <tt class="docutils literal"><span class="pre"><span class="Identifier">mainNode</span></span></tt> and orders footnotes.
    598. 

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

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

  600. 

  601.   </dd>
    602. 

  602. </div>
    603. 

  603. 

  604. </div>
    605. 

  605. <div id="resolveSubs-procs-all">
    606. 

  606.   <div id="resolveSubs,PRstSharedState,PRstNode">
    607. 

  607.   <dt><pre><span class="Keyword">proc</span> <a href="#resolveSubs%2CPRstSharedState%2CPRstNode"><span class="Identifier">resolveSubs</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">;</span> <span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a> {.
    608. 

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

  609.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadEnvEffect</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>
    610. 

  610.   <dd>
    611. 

  611.     
    612. 

  612.     Makes pass 2 of RST parsing. Resolves substitutions and anchor aliases, groups footnotes. Takes input node <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span></span></tt> and returns the same node with recursive substitutions in <tt class="docutils literal"><span class="pre"><span class="Identifier">n</span><span class="Operator">.</span><span class="Identifier">sons</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">result</span></span></tt>.
    613. 

  613.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L3767" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    614. 

  614. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L3767" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    615. 

  615. 

  616.   </dd>
    617. 

  617. </div>
    618. 

  618. 

  619. </div>
    620. 

  620. <div id="rstMessage-procs-all">
    621. 

  621.   <div id="rstMessage,RstFileTable,MsgHandler,TLineInfo,MsgKind,string">
    622. 

  622.   <dt><pre><span class="Keyword">proc</span> <a href="#rstMessage%2CRstFileTable%2CMsgHandler%2CTLineInfo%2CMsgKind%2Cstring"><span class="Identifier">rstMessage</span></a><span class="Other">(</span><span class="Identifier">filenames</span><span class="Other">:</span> <a href="rst.html#RstFileTable"><span class="Identifier">RstFileTable</span></a><span class="Other">;</span> <span class="Identifier">f</span><span class="Other">:</span> <a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a><span class="Other">;</span> <span class="Identifier">info</span><span class="Other">:</span> <a href="rstast.html#TLineInfo"><span class="Identifier">TLineInfo</span></a><span class="Other">;</span>
    623. 

  623.                 <span class="Identifier">msgKind</span><span class="Other">:</span> <a href="rst.html#MsgKind"><span class="Identifier">MsgKind</span></a><span class="Other">;</span> <span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
    624. 

  624.     <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">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    625. 

  625.   <dd>
    626. 

  626.     
    627. 

  627.     Print warnings using <tt class="docutils literal"><span class="pre"><span class="Identifier">info</span></span></tt>, i.e. in 2nd-pass warnings for footnotes/substitutions/references or from <tt class="docutils literal"><span class="pre">rstgen.nim</span></tt>.
    628. 

  628.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L575" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    629. 

  629. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L575" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    630. 

  630. 

  631.   </dd>
    632. 

  632. </div>
    633. 

  633. 

  634. </div>
    635. 

  635. <div id="rstnodeToRefname-procs-all">
    636. 

  636.   <div id="rstnodeToRefname,PRstNode">
    637. 

  637.   <dt><pre><span class="Keyword">proc</span> <a href="#rstnodeToRefname%2CPRstNode"><span class="Identifier">rstnodeToRefname</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</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>
    638. 

  638.   <dd>
    639. 

  639.     
    640. 

  640.     
    641. 

  641.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L90" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    642. 

  642. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L90" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    643. 

  643. 

  644.   </dd>
    645. 

  645. </div>
    646. 

  646. 

  647. </div>
    648. 

  648. <div id="rstParse-procs-all">
    649. 

  649.   <div id="rstParse,string,string,int,int,RstParseOptions,FindFileHandler,FindRefFileHandler,MsgHandler">
    650. 

  650.   <dt><pre><span class="Keyword">proc</span> <a href="#rstParse%2Cstring%2Cstring%2Cint%2Cint%2CRstParseOptions%2CFindFileHandler%2CFindRefFileHandler%2CMsgHandler"><span class="Identifier">rstParse</span></a><span class="Other">(</span><span class="Identifier">text</span><span class="Other">,</span> <span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">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>
    651. 

  651.               <span class="Identifier">options</span><span class="Other">:</span> <a href="rst.html#RstParseOptions"><span class="Identifier">RstParseOptions</span></a><span class="Other">;</span> <span class="Identifier">findFile</span><span class="Other">:</span> <a href="rst.html#FindFileHandler"><span class="Identifier">FindFileHandler</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    652. 

  652.               <span class="Identifier">findRefFile</span><span class="Other">:</span> <a href="rst.html#FindRefFileHandler"><span class="Identifier">FindRefFileHandler</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">;</span>
    653. 

  653.               <span class="Identifier">msgHandler</span><span class="Other">:</span> <a href="rst.html#MsgHandler"><span class="Identifier">MsgHandler</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">node</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a><span class="Other">,</span>
    654. 

  654.     <span class="Identifier">filenames</span><span class="Other">:</span> <a href="rst.html#RstFileTable"><span class="Identifier">RstFileTable</span></a><span class="Other">,</span> <span class="Identifier">hasToc</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">]</span> {.
    655. 

  655.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">]</span><span class="Other">,</span>
    656. 

  656.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</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>
    657. 

  657.   <dd>
    658. 

  658.     
    659. 

  659.     Parses the whole <tt class="docutils literal"><span class="pre"><span class="Identifier">text</span></span></tt>. The result is ready for <tt class="docutils literal"><span class="pre"><span class="Identifier">rstgen</span><span class="Operator">.</span><span class="Identifier">renderRstToOut</span></span></tt>, note that 2nd tuple element should be fed to <tt class="docutils literal"><span class="pre"><span class="Identifier">initRstGenerator</span></span></tt> argument <tt class="docutils literal"><span class="pre"><span class="Identifier">filenames</span></span></tt> (it is being filled here at least with <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> and possibly with other files from RST <tt class="docutils literal"><span class="pre">.. include::</span></tt> statement).
    660. 

  660.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L3868" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    661. 

  661. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L3868" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    662. 

  662. 

  663.   </dd>
    664. 

  664. </div>
    665. 

  665. 

  666. </div>
    667. 

  667. <div id="rstParsePass1-procs-all">
    668. 

  668.   <div id="rstParsePass1,string,int,int,PRstSharedState">
    669. 

  669.   <dt><pre><span class="Keyword">proc</span> <a href="#rstParsePass1%2Cstring%2Cint%2Cint%2CPRstSharedState"><span class="Identifier">rstParsePass1</span></a><span class="Other">(</span><span class="Identifier">fragment</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>
    670. 

  670.                    <span class="Identifier">sharedState</span><span class="Other">:</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">)</span><span class="Other">:</span> <a href="rstast.html#PRstNode"><span class="Identifier">PRstNode</span></a> {.
    671. 

  671.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="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>
    672. 

  672.   <dd>
    673. 

  673.     
    674. 

  674.     Parses an RST <tt class="docutils literal"><span class="pre"><span class="Identifier">fragment</span></span></tt>. The result should be further processed by <a class="reference internal nimdoc" title="proc preparePass2(s: var PRstSharedState; mainNode: PRstNode; importdoc = true)" href="#preparePass2,PRstSharedState,PRstNode">preparePass2</a> and <a class="reference internal nimdoc" title="proc resolveSubs(s: PRstSharedState; n: PRstNode): PRstNode" href="#resolveSubs,PRstSharedState,PRstNode">resolveSubs</a> (which is pass 2).
    675. 

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

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

  677. 

  678.   </dd>
    679. 

  679. </div>
    680. 

  680. 

  681. </div>
    682. 

  682. <div id="safeProtocol-procs-all">
    683. 

  683.   <div id="safeProtocol,string">
    684. 

  684.   <dt><pre><span class="Keyword">proc</span> <a href="#safeProtocol%2Cstring"><span class="Identifier">safeProtocol</span></a><span class="Other">(</span><span class="Identifier">linkStr</span><span class="Other">:</span> <span class="Keyword">var</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>
    685. 

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

  686.   <dd>
    687. 

  687.     
    688. 

  688.     
    689. 

  689.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L1254" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    690. 

  690. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L1254" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    691. 

  691. 

  692.   </dd>
    693. 

  693. </div>
    694. 

  694. 

  695. </div>
    696. 

  696. <div id="setCurrFilename-procs-all">
    697. 

  697.   <div id="setCurrFilename,PRstSharedState,string">
    698. 

  698.   <dt><pre><span class="Keyword">proc</span> <a href="#setCurrFilename%2CPRstSharedState%2Cstring"><span class="Identifier">setCurrFilename</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="rst.html#PRstSharedState"><span class="Identifier">PRstSharedState</span></a><span class="Other">;</span> <span class="Identifier">file1</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    699. 

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

  700.   <dd>
    701. 

  701.     
    702. 

  702.     
    703. 

  703.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L515" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    704. 

  704. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L515" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    705. 

  705. 

  706.   </dd>
    707. 

  707. </div>
    708. 

  708. 

  709. </div>
    710. 

  710. <div id="whichMsgClass-procs-all">
    711. 

  711.   <div id="whichMsgClass,MsgKind">
    712. 

  712.   <dt><pre><span class="Keyword">proc</span> <a href="#whichMsgClass%2CMsgKind"><span class="Identifier">whichMsgClass</span></a><span class="Other">(</span><span class="Identifier">k</span><span class="Other">:</span> <a href="rst.html#MsgKind"><span class="Identifier">MsgKind</span></a><span class="Other">)</span><span class="Other">:</span> <a href="rst.html#MsgClass"><span class="Identifier">MsgClass</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>
    713. 

  713.   <dd>
    714. 

  714.     
    715. 

  715.     returns which message class <tt class="docutils literal"><span class="pre"><span class="Identifier">k</span></span></tt> belongs to.
    716. 

  716.     <a href="https://github.com/nim-lang/Nim/tree/devel/lib/packages/docutils/rst.nim#L459" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
    717. 

  717. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/packages/docutils/rst.nim#L459" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
    718. 

  718. 

  719.   </dd>
    720. 

  720. </div>
    721. 

  721. 

  722. </div>
    723. 

  723. 

  724.   </dl>
    725. 

  725. </div>
    726. 

  726. 

  727.   </div>
    728. 

  728. </div>
    729. 

  729. 

  730.       <div class="twelve-columns footer">
    731. 

  731.         <span class="nim-sprite"></span>
    732. 

  732.         <br>
    733. 

  733.         <small style="color: var(--hint);">Made with Nim. Generated: 2024-12-25 08:35:52 UTC</small>
    734. 

  734.       </div>
    735. 

  735.     </div>
    736. 

  736.   </div>
    737. 

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

  738.     
    739. 

  739. </body>
    740. 

  740. </html>
    741. 

  741.