ospaths2.html 123 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/private/ospaths2</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/private/ospaths2</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <ul class="simple nested-toc-section">/
  57. <li><a class="reference" href="#%2F%2Cstring%2Cstring" title="`/`(head, tail: string): string">`/`(head, tail: string): string</a></li>
  58. </ul>
  59. <ul class="simple nested-toc-section">/../
  60. <li><a class="reference" href="#%2F..%2F%2Cstring%2Cstring" title="`/../`(head, tail: string): string">`/../`(head, tail: string): string</a></li>
  61. </ul>
  62. <ul class="simple nested-toc-section">absolutePath
  63. <li><a class="reference" href="#absolutePath%2Cstring" title="absolutePath(path: string; root = when supportedSystem:
  64. getCurrentDir()
  65. else:
  66. &quot;&quot;): string">absolutePath(path: string; root = when supportedSystem:
  67. getCurrentDir()
  68. else:
  69. &quot;&quot;): string</a></li>
  70. </ul>
  71. <ul class="simple nested-toc-section">addFileExt
  72. <li><a class="reference" href="#addFileExt%2Cstring%2Cstring" title="addFileExt(filename, ext: string): string">addFileExt(filename, ext: string): string</a></li>
  73. </ul>
  74. <ul class="simple nested-toc-section">changeFileExt
  75. <li><a class="reference" href="#changeFileExt%2Cstring%2Cstring" title="changeFileExt(filename, ext: string): string">changeFileExt(filename, ext: string): string</a></li>
  76. </ul>
  77. <ul class="simple nested-toc-section">cmpPaths
  78. <li><a class="reference" href="#cmpPaths%2Cstring%2Cstring" title="cmpPaths(pathA, pathB: string): int">cmpPaths(pathA, pathB: string): int</a></li>
  79. </ul>
  80. <ul class="simple nested-toc-section">extractFilename
  81. <li><a class="reference" href="#extractFilename%2Cstring" title="extractFilename(path: string): string">extractFilename(path: string): string</a></li>
  82. </ul>
  83. <ul class="simple nested-toc-section">getCurrentDir
  84. <li><a class="reference" href="#getCurrentDir" title="getCurrentDir(): string">getCurrentDir(): string</a></li>
  85. </ul>
  86. <ul class="simple nested-toc-section">isAbsolute
  87. <li><a class="reference" href="#isAbsolute%2Cstring" title="isAbsolute(path: string): bool">isAbsolute(path: string): bool</a></li>
  88. </ul>
  89. <ul class="simple nested-toc-section">isRelativeTo
  90. <li><a class="reference" href="#isRelativeTo%2Cstring%2Cstring" title="isRelativeTo(path: string; base: string): bool">isRelativeTo(path: string; base: string): bool</a></li>
  91. </ul>
  92. <ul class="simple nested-toc-section">isRootDir
  93. <li><a class="reference" href="#isRootDir%2Cstring" title="isRootDir(path: string): bool">isRootDir(path: string): bool</a></li>
  94. </ul>
  95. <ul class="simple nested-toc-section">joinPath
  96. <li><a class="reference" href="#joinPath%2Cstring%2Cstring" title="joinPath(head, tail: string): string">joinPath(head, tail: string): string</a></li>
  97. <li><a class="reference" href="#joinPath%2Cvarargs%5Bstring%5D" title="joinPath(parts: varargs[string]): string">joinPath(parts: varargs[string]): string</a></li>
  98. </ul>
  99. <ul class="simple nested-toc-section">lastPathPart
  100. <li><a class="reference" href="#lastPathPart%2Cstring" title="lastPathPart(path: string): string">lastPathPart(path: string): string</a></li>
  101. </ul>
  102. <ul class="simple nested-toc-section">normalizedPath
  103. <li><a class="reference" href="#normalizedPath%2Cstring" title="normalizedPath(path: string): string">normalizedPath(path: string): string</a></li>
  104. </ul>
  105. <ul class="simple nested-toc-section">normalizeExe
  106. <li><a class="reference" href="#normalizeExe%2Cstring" title="normalizeExe(file: var string)">normalizeExe(file: var string)</a></li>
  107. </ul>
  108. <ul class="simple nested-toc-section">normalizePath
  109. <li><a class="reference" href="#normalizePath%2Cstring" title="normalizePath(path: var string)">normalizePath(path: var string)</a></li>
  110. </ul>
  111. <ul class="simple nested-toc-section">normalizePathEnd
  112. <li><a class="reference" href="#normalizePathEnd%2Cstring_2" title="normalizePathEnd(path: string; trailingSep = false): string">normalizePathEnd(path: string; trailingSep = false): string</a></li>
  113. <li><a class="reference" href="#normalizePathEnd%2Cstring" title="normalizePathEnd(path: var string; trailingSep = false)">normalizePathEnd(path: var string; trailingSep = false)</a></li>
  114. </ul>
  115. <ul class="simple nested-toc-section">parentDir
  116. <li><a class="reference" href="#parentDir%2Cstring" title="parentDir(path: string): string">parentDir(path: string): string</a></li>
  117. </ul>
  118. <ul class="simple nested-toc-section">relativePath
  119. <li><a class="reference" href="#relativePath%2Cstring%2Cstring" title="relativePath(path, base: string; sep = DirSep): string">relativePath(path, base: string; sep = DirSep): string</a></li>
  120. </ul>
  121. <ul class="simple nested-toc-section">sameFile
  122. <li><a class="reference" href="#sameFile%2Cstring%2Cstring" title="sameFile(path1, path2: string): bool">sameFile(path1, path2: string): bool</a></li>
  123. </ul>
  124. <ul class="simple nested-toc-section">searchExtPos
  125. <li><a class="reference" href="#searchExtPos%2Cstring" title="searchExtPos(path: string): int">searchExtPos(path: string): int</a></li>
  126. </ul>
  127. <ul class="simple nested-toc-section">splitFile
  128. <li><a class="reference" href="#splitFile%2Cstring" title="splitFile(path: string): tuple[dir, name, ext: string]">splitFile(path: string): tuple[dir, name, ext: string]</a></li>
  129. </ul>
  130. <ul class="simple nested-toc-section">splitPath
  131. <li><a class="reference" href="#splitPath%2Cstring" title="splitPath(path: string): tuple[head, tail: string]">splitPath(path: string): tuple[head, tail: string]</a></li>
  132. </ul>
  133. <ul class="simple nested-toc-section">tailDir
  134. <li><a class="reference" href="#tailDir%2Cstring" title="tailDir(path: string): string">tailDir(path: string): string</a></li>
  135. </ul>
  136. <ul class="simple nested-toc-section">unixToNativePath
  137. <li><a class="reference" href="#unixToNativePath%2Cstring%2Cstring" title="unixToNativePath(path: string; drive = &quot;&quot;): string">unixToNativePath(path: string; drive = &quot;&quot;): string</a></li>
  138. </ul>
  139. </ul>
  140. </details>
  141. </li>
  142. <li>
  143. <details open>
  144. <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
  145. <ul class="simple simple-toc-section">
  146. <ul class="simple nested-toc-section">parentDirs
  147. <li><a class="reference" href="#parentDirs.i%2Cstring" title="parentDirs(path: string; fromRoot = false; inclusive = true): string">parentDirs(path: string; fromRoot = false; inclusive = true): string</a></li>
  148. </ul>
  149. </ul>
  150. </details>
  151. </li>
  152. </ul>
  153. </div>
  154. <div class="nine columns" id="content">
  155. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  156. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  157. <div id="tocRoot"></div>
  158. <p class="module-desc"></p>
  159. <div class="section" id="6">
  160. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  161. <dl class="item">
  162. <a class="reference external" href="since.html">since</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="pathnorm.html">pathnorm</a>, <a class="reference external" href="oserrors.html">oserrors</a>, <a class="reference external" href="oscommon.html">oscommon</a>, <a class="reference external" href="syncio.html">syncio</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="widestrs.html">widestrs</a>, <a class="reference external" href="posix.html">posix</a>, <a class="reference external" href="ansi_c.html">ansi_c</a>, <a class="reference external" href="osseps.html">osseps</a>
  163. </dl>
  164. </div>
  165. <div class="section" id="12">
  166. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  167. <dl class="item">
  168. <div id="/-procs-all">
  169. <div id="/,string,string">
  170. <dt><pre><span class="Keyword">proc</span> <a href="#%2F%2Cstring%2Cstring"><span class="Identifier">`/`</span></a><span class="Other">(</span><span class="Identifier">head</span><span class="Other">,</span> <span class="Identifier">tail</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">noSideEffect</span><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>
  171. <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>
  172. <dd>
  173. <p>The same as <a class="reference internal nimdoc" title="proc joinPath(head, tail: string): string" href="#joinPath,string,string">joinPath(head, tail) proc</a>.</p>
  174. <p>See also:</p>
  175. <ul class="simple"><li><a class="reference internal nimdoc" title="proc `/../`(head, tail: string): string" href="#/../,string,string">/../ proc</a></li>
  176. <li><a class="reference internal nimdoc" title="proc joinPath(head, tail: string): string" href="#joinPath,string,string">joinPath(head, tail) proc</a></li>
  177. <li><a class="reference internal nimdoc" title="proc joinPath(parts: varargs[string]): string" href="#joinPath,varargs[string]">joinPath(parts: varargs[string]) proc</a></li>
  178. <li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
  179. <li><a class="reference external" href="uri.html#combine,Uri,Uri">uri.combine proc</a></li>
  180. <li><a class="reference external" href="uri.html#/,Uri,string">uri./ proc</a></li>
  181. </ul>
  182. <p><strong class="examples_text">Example:</strong></p>
  183. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  184. <span class="Identifier">assert</span> <span class="StringLit">&quot;usr&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr&quot;</span>
  185. <span class="Identifier">assert</span> <span class="StringLit">&quot;&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;lib&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;lib&quot;</span>
  186. <span class="Identifier">assert</span> <span class="StringLit">&quot;&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;/lib&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;/lib&quot;</span>
  187. <span class="Identifier">assert</span> <span class="StringLit">&quot;usr/&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;/lib/&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/lib/&quot;</span>
  188. <span class="Identifier">assert</span> <span class="StringLit">&quot;usr&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;lib&quot;</span> <span class="Operator">/</span> <span class="StringLit">&quot;../bin&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/bin&quot;</span></pre>
  189. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L160" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  190. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L160" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  191. </dd>
  192. </div>
  193. </div>
  194. <div id="/../-procs-all">
  195. <div id="/../,string,string">
  196. <dt><pre><span class="Keyword">proc</span> <a href="#%2F..%2F%2Cstring%2Cstring"><span class="Identifier">`/../`</span></a><span class="Other">(</span><span class="Identifier">head</span><span class="Other">,</span> <span class="Identifier">tail</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">noSideEffect</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>
  197. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  198. <dd>
  199. <p>The same as <tt class="docutils literal"><span class="pre">parentDir(head) / tail</span></tt>, unless there is no parent directory. Then <tt class="docutils literal"><span class="pre">head / tail</span></tt> is performed instead.</p>
  200. <p>See also:</p>
  201. <ul class="simple"><li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
  202. <li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
  203. </ul>
  204. <p><strong class="examples_text">Example:</strong></p>
  205. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  206. <span class="Identifier">assert</span> <span class="StringLit">&quot;a/b/c&quot;</span> <span class="Operator">/../</span> <span class="StringLit">&quot;d/e&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;a/b/d/e&quot;</span>
  207. <span class="Identifier">assert</span> <span class="StringLit">&quot;a&quot;</span> <span class="Operator">/../</span> <span class="StringLit">&quot;d/e&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;a/d/e&quot;</span></pre>
  208. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L544" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  209. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L544" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  210. </dd>
  211. </div>
  212. </div>
  213. <div id="absolutePath-procs-all">
  214. <div id="absolutePath,string">
  215. <dt><pre><span class="Keyword">proc</span> <a href="#absolutePath%2Cstring"><span class="Identifier">absolutePath</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">root</span> <span class="Other">=</span> <span class="Keyword">when</span> <span class="Identifier">supportedSystem</span><span class="Other">:</span>
  216. <span class="Identifier">getCurrentDir</span><span class="Other">(</span><span class="Other">)</span>
  217. <span class="Keyword"> else</span><span class="Other">:</span>
  218. <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">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  219. <dd>
  220. <p>Returns the absolute path of <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>, rooted at <tt class="docutils literal"><span class="pre"><span class="Identifier">root</span></span></tt> (which must be absolute; default: current directory). If <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> is absolute, return it, ignoring <tt class="docutils literal"><span class="pre"><span class="Identifier">root</span></span></tt>.</p>
  221. <p>See also:</p>
  222. <ul class="simple"><li><a class="reference internal nimdoc" title="proc normalizedPath(path: string): string" href="#normalizedPath,string">normalizedPath proc</a></li>
  223. <li><a class="reference internal nimdoc" title="proc normalizePath(path: var string)" href="#normalizePath,string">normalizePath proc</a></li>
  224. </ul>
  225. <p><strong class="examples_text">Example:</strong></p>
  226. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">absolutePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">getCurrentDir</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">/</span> <span class="StringLit">&quot;a&quot;</span></pre>
  227. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L890" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  228. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L890" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  229. </dd>
  230. </div>
  231. </div>
  232. <div id="addFileExt-procs-all">
  233. <div id="addFileExt,string,string">
  234. <dt><pre><span class="Keyword">proc</span> <a href="#addFileExt%2Cstring%2Cstring"><span class="Identifier">addFileExt</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">,</span> <span class="Identifier">ext</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">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  235. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  236. <dd>
  237. <p>Adds the file extension <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt>, unless <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> already has an extension.</p>
  238. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">Ext</span></span></tt> should be given without the leading <tt class="docutils literal"><span class="pre"><span class="CharLit">'.'</span></span></tt>, because some filesystems may use a different character. (Although I know of none such beast.)</p>
  239. <p>See also:</p>
  240. <ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
  241. <li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
  242. <li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
  243. <li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
  244. <li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
  245. </ul>
  246. <p><strong class="examples_text">Example:</strong></p>
  247. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">addFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo.bar&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;baz&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo.bar&quot;</span>
  248. <span class="Identifier">assert</span> <span class="Identifier">addFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo.bar&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo.bar&quot;</span>
  249. <span class="Identifier">assert</span> <span class="Identifier">addFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;baz&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo.baz&quot;</span></pre>
  250. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L733" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  251. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L733" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  252. </dd>
  253. </div>
  254. </div>
  255. <div id="changeFileExt-procs-all">
  256. <div id="changeFileExt,string,string">
  257. <dt><pre><span class="Keyword">proc</span> <a href="#changeFileExt%2Cstring%2Cstring"><span class="Identifier">changeFileExt</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">,</span> <span class="Identifier">ext</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">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  258. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  259. <dd>
  260. <p>Changes the file extension to <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt>.</p>
  261. <p>If the <tt class="docutils literal"><span class="pre"><span class="Identifier">filename</span></span></tt> has no extension, <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt> will be added. If <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt> == &quot;&quot; then any extension is removed.</p>
  262. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">Ext</span></span></tt> should be given without the leading <tt class="docutils literal"><span class="pre"><span class="CharLit">'.'</span></span></tt>, because some filesystems may use a different character. (Although I know of none such beast.)</p>
  263. <p>See also:</p>
  264. <ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
  265. <li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
  266. <li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
  267. <li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
  268. <li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
  269. </ul>
  270. <p><strong class="examples_text">Example:</strong></p>
  271. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo.bar&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;baz&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo.baz&quot;</span>
  272. <span class="Identifier">assert</span> <span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo.bar&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo&quot;</span>
  273. <span class="Identifier">assert</span> <span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;baz&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo.baz&quot;</span></pre>
  274. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L707" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  275. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L707" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  276. </dd>
  277. </div>
  278. </div>
  279. <div id="cmpPaths-procs-all">
  280. <div id="cmpPaths,string,string">
  281. <dt><pre><span class="Keyword">proc</span> <a href="#cmpPaths%2Cstring%2Cstring"><span class="Identifier">cmpPaths</span></a><span class="Other">(</span><span class="Identifier">pathA</span><span class="Other">,</span> <span class="Identifier">pathB</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="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  282. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  283. <dd>
  284. <p>Compares two paths.</p>
  285. <p>On a case-sensitive filesystem this is done case-sensitively otherwise case-insensitively. Returns:</p>
  286. <p><tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt> if pathA == pathB<br/><tt class="docutils literal"><span class="pre"><span class="Operator">&lt;</span> <span class="DecNumber">0</span></span></tt> if pathA &lt; pathB<br/><tt class="docutils literal"><span class="pre"><span class="Operator">&gt;</span> <span class="DecNumber">0</span></span></tt> if pathA &gt; pathB<br/></p>
  287. <p><strong class="examples_text">Example:</strong></p>
  288. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">macosx</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  289. <span class="Identifier">assert</span> <span class="Identifier">cmpPaths</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Foo&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
  290. <span class="Keyword">elif</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  291. <span class="Identifier">assert</span> <span class="Identifier">cmpPaths</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;Foo&quot;</span><span class="Punctuation">)</span> <span class="Operator">&gt;</span> <span class="DecNumber">0</span></pre>
  292. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L757" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  293. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L757" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  294. </dd>
  295. </div>
  296. </div>
  297. <div id="extractFilename-procs-all">
  298. <div id="extractFilename,string">
  299. <dt><pre><span class="Keyword">proc</span> <a href="#extractFilename%2Cstring"><span class="Identifier">extractFilename</span></a><span class="Other">(</span><span class="Identifier">path</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">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  300. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  301. <dd>
  302. <p>Extracts the filename of a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
  303. <p>This is the same as <tt class="docutils literal"><span class="pre">name &amp; ext</span></tt> from <a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile(path) proc</a>.</p>
  304. <p>See also:</p>
  305. <ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
  306. <li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
  307. <li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
  308. <li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
  309. <li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
  310. </ul>
  311. <p><strong class="examples_text">Example:</strong></p>
  312. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">extractFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  313. <span class="Identifier">assert</span> <span class="Identifier">extractFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;bar&quot;</span>
  314. <span class="Identifier">assert</span> <span class="Identifier">extractFilename</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar.baz&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;bar.baz&quot;</span></pre>
  315. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L667" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  316. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L667" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  317. </dd>
  318. </div>
  319. </div>
  320. <div id="getCurrentDir-procs-all">
  321. <div id="getCurrentDir">
  322. <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentDir"><span class="Identifier">getCurrentDir</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><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;nos$1&quot;</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>
  323. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</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>
  324. <dd>
  325. <p>Returns the <span id="current-working-directory_1">current working directory</span> i.e. where the built binary is run.</p>
  326. <p>So the path returned by this proc is determined at run time.</p>
  327. <p>See also:</p>
  328. <ul class="simple"><li><a class="reference external" href="./osappdirs.html#getHomeDir">osappdirs: getHomeDir proc</a></li>
  329. <li><a class="reference external" href="./osappdirs.html#getConfigDir">osappdirs: getConfigDir proc</a></li>
  330. <li><a class="reference external" href="./osappdirs.html#getTempDir">osappdirs: getTempDir proc</a></li>
  331. <li><a class="reference external" href="./osdirs.html#setCurrentDir,string">osdirs: setCurrentDir proc</a></li>
  332. <li><a class="reference external" href="system.html#currentSourcePath.t">currentSourcePath template</a></li>
  333. <li><a class="reference external" href="macros.html#getProjectPath">getProjectPath proc</a></li>
  334. </ul>
  335. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L842" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  336. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L842" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  337. </dd>
  338. </div>
  339. </div>
  340. <div id="isAbsolute-procs-all">
  341. <div id="isAbsolute,string">
  342. <dt><pre><span class="Keyword">proc</span> <a href="#isAbsolute%2Cstring"><span class="Identifier">isAbsolute</span></a><span class="Other">(</span><span class="Identifier">path</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#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> </span><span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
  343. <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>
  344. <dd>
  345. <p>Checks whether a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> is absolute.</p>
  346. <p>On Windows, network paths are considered absolute too.</p>
  347. <p><strong class="examples_text">Example:</strong></p>
  348. <pre class="listing"><span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;&quot;</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
  349. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;.&quot;</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
  350. <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  351. <span class="Identifier">assert</span> <span class="StringLit">&quot;/&quot;</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
  352. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">&quot;a/&quot;</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
  353. <span class="Identifier">assert</span> <span class="StringLit">&quot;/a/&quot;</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span></pre>
  354. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L232" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  355. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L232" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  356. </dd>
  357. </div>
  358. </div>
  359. <div id="isRelativeTo-procs-all">
  360. <div id="isRelativeTo,string,string">
  361. <dt><pre><span class="Keyword">proc</span> <a href="#isRelativeTo%2Cstring%2Cstring"><span class="Identifier">isRelativeTo</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">base</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#bool"><span class="Identifier">bool</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">Exception</span><span class="Other">]</span><span class="Other">,</span>
  362. <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>
  363. <dd>
  364. Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> is relative to <tt class="docutils literal"><span class="pre"><span class="Identifier">base</span></span></tt>.
  365. <p><strong class="examples_text">Example:</strong></p>
  366. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">&quot;./foo//bar&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">)</span>
  367. <span class="Identifier">doAssert</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;.&quot;</span><span class="Punctuation">)</span>
  368. <span class="Identifier">doAssert</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">&quot;/foo/bar.nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/foo/bar.nim&quot;</span><span class="Punctuation">)</span>
  369. <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar.nims&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo/bar.nim&quot;</span><span class="Punctuation">)</span></pre>
  370. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L381" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  371. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L381" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  372. </dd>
  373. </div>
  374. </div>
  375. <div id="isRootDir-procs-all">
  376. <div id="isRootDir,string">
  377. <dt><pre><span class="Keyword">proc</span> <a href="#isRootDir%2Cstring"><span class="Identifier">isRootDir</span></a><span class="Other">(</span><span class="Identifier">path</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#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><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;nos$1&quot;</span><span class="Other">,</span>
  378. <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>
  379. <dd>
  380. Checks whether a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> is a root directory.
  381. <p><strong class="examples_text">Example:</strong></p>
  382. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
  383. <span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;.&quot;</span><span class="Punctuation">)</span>
  384. <span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;/&quot;</span><span class="Punctuation">)</span>
  385. <span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">)</span>
  386. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;/a&quot;</span><span class="Punctuation">)</span>
  387. <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;a/b/c&quot;</span><span class="Punctuation">)</span></pre>
  388. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L474" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  389. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L474" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  390. </dd>
  391. </div>
  392. </div>
  393. <div id="joinPath-procs-all">
  394. <div id="joinPath,string,string">
  395. <dt><pre><span class="Keyword">proc</span> <a href="#joinPath%2Cstring%2Cstring"><span class="Identifier">joinPath</span></a><span class="Other">(</span><span class="Identifier">head</span><span class="Other">,</span> <span class="Identifier">tail</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">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  396. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  397. <dd>
  398. <p>Joins two directory names to one.</p>
  399. <p>returns normalized path concatenation of <tt class="docutils literal"><span class="pre"><span class="Identifier">head</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">tail</span></span></tt>, preserving whether or not <tt class="docutils literal"><span class="pre"><span class="Identifier">tail</span></span></tt> has a trailing slash (or, if tail if empty, whether head has one).</p>
  400. <p>See also:</p>
  401. <ul class="simple"><li><a class="reference internal nimdoc" title="proc joinPath(parts: varargs[string]): string" href="#joinPath,varargs[string]">joinPath(parts: varargs[string]) proc</a></li>
  402. <li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
  403. <li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
  404. <li><a class="reference external" href="uri.html#combine,Uri,Uri">uri.combine proc</a></li>
  405. <li><a class="reference external" href="uri.html#/,Uri,string">uri./ proc</a></li>
  406. </ul>
  407. <p><strong class="examples_text">Example:</strong></p>
  408. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  409. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;lib&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/lib&quot;</span>
  410. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;lib/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/lib/&quot;</span>
  411. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr&quot;</span>
  412. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/&quot;</span>
  413. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  414. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;lib&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;lib&quot;</span>
  415. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/lib&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/lib&quot;</span>
  416. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/lib&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/lib&quot;</span>
  417. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/lib&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;../bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/bin&quot;</span></pre>
  418. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L90" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  419. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L90" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  420. </dd>
  421. </div>
  422. <div id="joinPath,varargs[string]">
  423. <dt><pre><span class="Keyword">proc</span> <a href="#joinPath%2Cvarargs%5Bstring%5D"><span class="Identifier">joinPath</span></a><span class="Other">(</span><span class="Identifier">parts</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</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="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  424. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1OpenArray&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>
  425. <dd>
  426. <p>The same as <a class="reference internal nimdoc" title="proc joinPath(head, tail: string): string" href="#joinPath,string,string">joinPath(head, tail) proc</a>, but works with any number of directory parts.</p>
  427. <p>You need to pass at least one element or the proc will assert in debug builds and crash on release builds.</p>
  428. <p>See also:</p>
  429. <ul class="simple"><li><a class="reference internal nimdoc" title="proc joinPath(head, tail: string): string" href="#joinPath,string,string">joinPath(head, tail) proc</a></li>
  430. <li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
  431. <li><a class="reference internal nimdoc" title="proc `/../`(head, tail: string): string" href="#/../,string,string">/../ proc</a></li>
  432. <li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
  433. </ul>
  434. <p><strong class="examples_text">Example:</strong></p>
  435. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  436. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span>
  437. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;a&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;b&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;c&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a/b/c&quot;</span>
  438. <span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/lib&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;../../var&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;log&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;var/log&quot;</span></pre>
  439. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L134" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  440. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L134" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  441. </dd>
  442. </div>
  443. </div>
  444. <div id="lastPathPart-procs-all">
  445. <div id="lastPathPart,string">
  446. <dt><pre><span class="Keyword">proc</span> <a href="#lastPathPart%2Cstring"><span class="Identifier">lastPathPart</span></a><span class="Other">(</span><span class="Identifier">path</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">noSideEffect</span><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;nos$1&quot;</span><span class="Other">,</span>
  447. <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>
  448. <dd>
  449. <p>Like <a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a>, but ignores trailing dir separator; aka: <span id="basename_1">baseName</span> in some other languages.</p>
  450. <p>See also:</p>
  451. <ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
  452. <li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
  453. <li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
  454. <li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
  455. <li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
  456. </ul>
  457. <p><strong class="examples_text">Example:</strong></p>
  458. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">lastPathPart</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;bar&quot;</span>
  459. <span class="Identifier">assert</span> <span class="Identifier">lastPathPart</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;bar&quot;</span></pre>
  460. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L689" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  461. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L689" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  462. </dd>
  463. </div>
  464. </div>
  465. <div id="normalizedPath-procs-all">
  466. <div id="normalizedPath,string">
  467. <dt><pre><span class="Keyword">proc</span> <a href="#normalizedPath%2Cstring"><span class="Identifier">normalizedPath</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</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>
  468. <span class="Identifier">raises</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>
  469. <dd>
  470. <p>Returns a normalized path for the current OS.</p>
  471. <p>See also:</p>
  472. <ul class="simple"><li><a class="reference internal nimdoc" title="proc absolutePath(path: string; root = when supportedSystem:
  473. getCurrentDir()
  474. else:
  475. &quot;&quot;): string" href="#absolutePath,string">absolutePath proc</a></li>
  476. <li><a class="reference internal nimdoc" title="proc normalizePath(path: var string)" href="#normalizePath,string">normalizePath proc</a> for the in-place version</li>
  477. </ul>
  478. <p><strong class="examples_text">Example:</strong></p>
  479. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  480. <span class="Identifier">assert</span> <span class="Identifier">normalizedPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;a///b//..//c///d&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a/c/d&quot;</span></pre>
  481. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L962" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  482. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L962" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  483. </dd>
  484. </div>
  485. </div>
  486. <div id="normalizeExe-procs-all">
  487. <div id="normalizeExe,string">
  488. <dt><pre><span class="Keyword">proc</span> <a href="#normalizeExe%2Cstring"><span class="Identifier">normalizeExe</span></a><span class="Other">(</span><span class="Identifier">file</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><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>
  489. <dd>
  490. on posix, prepends <tt class="docutils literal"><span class="pre"><span class="Operator">./</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">file</span></span></tt> doesn't contain <tt class="docutils literal"><span class="pre"><span class="Operator">/</span></span></tt> and is not <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;.&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;..&quot;</span></span></tt>.
  491. <p><strong class="examples_text">Example:</strong></p>
  492. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
  493. <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  494. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;foo&quot;</span><span class="Operator">.</span><span class="Identifier">dup</span><span class="Punctuation">(</span><span class="Identifier">normalizeExe</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;./foo&quot;</span>
  495. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;foo/../bar&quot;</span><span class="Operator">.</span><span class="Identifier">dup</span><span class="Punctuation">(</span><span class="Identifier">normalizeExe</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo/../bar&quot;</span>
  496. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;&quot;</span><span class="Operator">.</span><span class="Identifier">dup</span><span class="Punctuation">(</span><span class="Identifier">normalizeExe</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span></pre>
  497. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L973" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  498. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L973" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  499. </dd>
  500. </div>
  501. </div>
  502. <div id="normalizePath-procs-all">
  503. <div id="normalizePath,string">
  504. <dt><pre><span class="Keyword">proc</span> <a href="#normalizePath%2Cstring"><span class="Identifier">normalizePath</span></a><span class="Other">(</span><span class="Identifier">path</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><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;nos$1&quot;</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>
  505. <span class="Identifier">raises</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>
  506. <dd>
  507. <p>Normalize a path.</p>
  508. <p>Consecutive directory separators are collapsed, including an initial double slash.</p>
  509. <p>On relative paths, double dot (<tt class="docutils literal"><span class="pre"><span class="Operator">..</span></span></tt>) sequences are collapsed if possible. On absolute paths they are always collapsed.</p>
  510. <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
  511. URL-encoded and Unicode attempts at directory traversal are not detected. Triple dot is not handled.</div>
  512. <p>See also:</p>
  513. <ul class="simple"><li><a class="reference internal nimdoc" title="proc absolutePath(path: string; root = when supportedSystem:
  514. getCurrentDir()
  515. else:
  516. &quot;&quot;): string" href="#absolutePath,string">absolutePath proc</a></li>
  517. <li><a class="reference internal nimdoc" title="proc normalizedPath(path: string): string" href="#normalizedPath,string">normalizedPath proc</a> for outplace version</li>
  518. <li><a class="reference internal nimdoc" title="proc normalizeExe(file: var string)" href="#normalizeExe,string">normalizeExe proc</a></li>
  519. </ul>
  520. <p><strong class="examples_text">Example:</strong></p>
  521. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  522. <span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">&quot;a///b//..//c///d&quot;</span>
  523. <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">normalizePath</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  524. <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="StringLit">&quot;a/c/d&quot;</span></pre>
  525. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L911" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  526. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L911" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  527. </dd>
  528. </div>
  529. </div>
  530. <div id="normalizePathEnd-procs-all">
  531. <div id="normalizePathEnd,string_2">
  532. <dt><pre><span class="Keyword">proc</span> <a href="#normalizePathEnd%2Cstring_2"><span class="Identifier">normalizePathEnd</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">trailingSep</span> <span class="Other">=</span> <span class="Identifier">false</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>
  533. <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>
  534. <dd>
  535. outplace overload
  536. <p><strong class="examples_text">Example:</strong></p>
  537. <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  538. <span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">&quot;/lib//.//&quot;</span><span class="Punctuation">,</span> <span class="Identifier">trailingSep</span> <span class="Operator">=</span> <span class="Identifier">true</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/lib/&quot;</span>
  539. <span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">&quot;lib/./.&quot;</span><span class="Punctuation">,</span> <span class="Identifier">trailingSep</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;lib&quot;</span>
  540. <span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">&quot;.//./.&quot;</span><span class="Punctuation">,</span> <span class="Identifier">trailingSep</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;.&quot;</span>
  541. <span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="Identifier">trailingSep</span> <span class="Operator">=</span> <span class="Identifier">true</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span> <span class="Comment"># not / !</span>
  542. <span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">&quot;/&quot;</span><span class="Punctuation">,</span> <span class="Identifier">trailingSep</span> <span class="Operator">=</span> <span class="Identifier">false</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/&quot;</span> <span class="Comment"># not &quot;&quot; !</span></pre>
  543. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L69" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  544. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L69" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  545. </dd>
  546. </div>
  547. <div id="normalizePathEnd,string">
  548. <dt><pre><span class="Keyword">proc</span> <a href="#normalizePathEnd%2Cstring"><span class="Identifier">normalizePathEnd</span></a><span class="Other">(</span><span class="Identifier">path</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="Identifier">trailingSep</span> <span class="Other">=</span> <span class="Identifier">false</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>
  549. <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. <dd>
  551. Ensures <tt class="docutils literal"><span class="pre">path</span></tt> has exactly 0 or 1 trailing <tt class="docutils literal"><span class="pre"><span class="Identifier">DirSep</span></span></tt>, depending on <tt class="docutils literal"><span class="pre">trailingSep</span></tt>, and taking care of edge cases: it preservers whether a path is absolute or relative, and makes sure trailing sep is <tt class="docutils literal"><span class="pre"><span class="Identifier">DirSep</span></span></tt>, not <tt class="docutils literal"><span class="pre"><span class="Identifier">AltSep</span></span></tt>. Trailing <tt class="docutils literal"><span class="pre"><span class="Operator">/.</span></span></tt> are compressed, see examples.
  552. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L46" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  553. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L46" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  554. </dd>
  555. </div>
  556. </div>
  557. <div id="parentDir-procs-all">
  558. <div id="parentDir,string">
  559. <dt><pre><span class="Keyword">proc</span> <a href="#parentDir%2Cstring"><span class="Identifier">parentDir</span></a><span class="Other">(</span><span class="Identifier">path</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">noSideEffect</span><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;nos$1&quot;</span><span class="Other">,</span>
  560. <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>
  561. <dd>
  562. <p>Returns the parent directory of <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
  563. <p>This is similar to <tt class="docutils literal"><span class="pre">splitPath(path).head</span></tt> when <tt class="docutils literal"><span class="pre">path</span></tt> doesn't end in a dir separator, but also takes care of path normalizations. The remainder can be obtained with <a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart(path) proc</a>.</p>
  564. <p>See also:</p>
  565. <ul class="simple"><li><a class="reference internal nimdoc" title="proc relativePath(path, base: string; sep = DirSep): string" href="#relativePath,string,string">relativePath proc</a></li>
  566. <li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
  567. <li><a class="reference internal nimdoc" title="proc tailDir(path: string): string" href="#tailDir,string">tailDir proc</a></li>
  568. <li><a class="reference internal nimdoc" title="iterator parentDirs(path: string; fromRoot = false; inclusive = true): string" href="#parentDirs.i,string">parentDirs iterator</a></li>
  569. </ul>
  570. <p><strong class="examples_text">Example:</strong></p>
  571. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  572. <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">posix</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  573. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;/usr/local/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/usr/local&quot;</span>
  574. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo/bar//&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo&quot;</span>
  575. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;//foo//bar//.&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/foo&quot;</span>
  576. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;./foo&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;.&quot;</span>
  577. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;/./foo//./&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;/&quot;</span>
  578. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;a//./&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;.&quot;</span>
  579. <span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;a/b/c/..&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;a&quot;</span></pre>
  580. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L400" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  581. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L400" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  582. </dd>
  583. </div>
  584. </div>
  585. <div id="relativePath-procs-all">
  586. <div id="relativePath,string,string">
  587. <dt><pre><span class="Keyword">proc</span> <a href="#relativePath%2Cstring%2Cstring"><span class="Identifier">relativePath</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">,</span> <span class="Identifier">base</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> <span class="Identifier">DirSep</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>
  588. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  589. <dd>
  590. <p>Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> to a path relative to <tt class="docutils literal"><span class="pre"><span class="Identifier">base</span></span></tt>.</p>
  591. <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">sep</span></span></tt> (default: <a class="reference external" href="./osseps.html#DirSep">osseps: DirSep</a>) is used for the path normalizations, this can be useful to ensure the relative path only contains <tt class="docutils literal"><span class="pre"><span class="CharLit">'/'</span></span></tt> so that it can be used for URL constructions.</p>
  592. <p>On Windows, if a root of <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> and a root of <tt class="docutils literal"><span class="pre"><span class="Identifier">base</span></span></tt> are different, returns <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> as is because it is impossible to make a relative path. That means an absolute path can be returned.</p>
  593. <p>See also:</p>
  594. <ul class="simple"><li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
  595. <li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
  596. <li><a class="reference internal nimdoc" title="proc tailDir(path: string): string" href="#tailDir,string">tailDir proc</a></li>
  597. </ul>
  598. <p><strong class="examples_text">Example:</strong></p>
  599. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/Users/me/bar/z.nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/Users/other/bad&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;../../me/bar/z.nim&quot;</span>
  600. <span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/Users/me/bar/z.nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/Users/other&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;../me/bar/z.nim&quot;</span>
  601. <span class="Keyword">when</span> <span class="Keyword">not</span> <span class="Identifier">doslikeFileSystem</span><span class="Punctuation">:</span> <span class="Comment"># On Windows, UNC-paths start with `//`</span>
  602. <span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/Users///me/bar//z.nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;//Users/&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;me/bar/z.nim&quot;</span>
  603. <span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/Users/me/bar/z.nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/Users/me&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;bar/z.nim&quot;</span>
  604. <span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/users/moo&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  605. <span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;.&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;foo&quot;</span>
  606. <span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;.&quot;</span></pre>
  607. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L291" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  608. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L291" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  609. </dd>
  610. </div>
  611. </div>
  612. <div id="sameFile-procs-all">
  613. <div id="sameFile,string,string">
  614. <dt><pre><span class="Keyword">proc</span> <a href="#sameFile%2Cstring%2Cstring"><span class="Identifier">sameFile</span></a><span class="Other">(</span><span class="Identifier">path1</span><span class="Other">,</span> <span class="Identifier">path2</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#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> <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$1&quot;</span><span class="Other">,</span>
  615. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</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>
  616. <dd>
  617. <p>Returns true if both pathname arguments refer to the same physical file or directory.</p>
  618. <p>Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> if any of the files does not exist or information about it can not be obtained.</p>
  619. <p>This proc will return true if given two alternative hard-linked or sym-linked paths to the same file or directory.</p>
  620. <p>See also:</p>
  621. <ul class="simple"><li><a class="reference external" href="./os.html#sameFileContent,string,string">os: sameFileContent proc</a></li>
  622. </ul>
  623. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L986" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  624. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L986" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  625. </dd>
  626. </div>
  627. </div>
  628. <div id="searchExtPos-procs-all">
  629. <div id="searchExtPos,string">
  630. <dt><pre><span class="Keyword">proc</span> <a href="#searchExtPos%2Cstring"><span class="Identifier">searchExtPos</span></a><span class="Other">(</span><span class="Identifier">path</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><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>
  631. <dd>
  632. <p>Returns index of the <tt class="docutils literal"><span class="pre"><span class="CharLit">'.'</span></span></tt> char in <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> if it signifies the beginning of the file extension. Returns -1 otherwise.</p>
  633. <p>See also:</p>
  634. <ul class="simple"><li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
  635. <li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
  636. <li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
  637. <li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
  638. <li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
  639. </ul>
  640. <p><strong class="examples_text">Example:</strong></p>
  641. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;a/b/c&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
  642. <span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;c.nim&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
  643. <span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;a/b/c.nim&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
  644. <span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;a.b.c.nim&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
  645. <span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;.nim&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
  646. <span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;..nim&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
  647. <span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">&quot;a..nim&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
  648. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L570" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  649. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L570" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  650. </dd>
  651. </div>
  652. </div>
  653. <div id="splitFile-procs-all">
  654. <div id="splitFile,string">
  655. <dt><pre><span class="Keyword">proc</span> <a href="#splitFile%2Cstring"><span class="Identifier">splitFile</span></a><span class="Other">(</span><span class="Identifier">path</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">dir</span><span class="Other">,</span> <span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">ext</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span>
  656. <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;nos$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>
  657. <dd>
  658. <p>Splits a filename into <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">extension</span><span class="Punctuation">)</span></span></tt> tuple.</p>
  659. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> does not end in <a class="reference external" href="./osseps.html#DirSep">osseps: DirSep</a> unless it's <tt class="docutils literal"><span class="pre"><span class="Operator">/</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">extension</span></span></tt> includes the leading dot.</p>
  660. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> has no extension, <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt> is the empty string. If <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> has no directory component, <tt class="docutils literal"><span class="pre"><span class="Identifier">dir</span></span></tt> is the empty string. If <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> has no filename component, <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt> are empty strings.</p>
  661. <p>See also:</p>
  662. <ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
  663. <li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
  664. <li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
  665. <li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
  666. <li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
  667. </ul>
  668. <p><strong class="examples_text">Example:</strong></p>
  669. <pre class="listing"><span class="Keyword">var</span> <span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">ext</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">splitFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/local/nimc.html&quot;</span><span class="Punctuation">)</span>
  670. <span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/local&quot;</span>
  671. <span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">&quot;nimc&quot;</span>
  672. <span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">&quot;.html&quot;</span>
  673. <span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">ext</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">splitFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;/usr/local/os&quot;</span><span class="Punctuation">)</span>
  674. <span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">&quot;/usr/local&quot;</span>
  675. <span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">&quot;os&quot;</span>
  676. <span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  677. <span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">ext</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">splitFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;/usr/local/&quot;</span><span class="Punctuation">)</span>
  678. <span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">&quot;/usr/local&quot;</span>
  679. <span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  680. <span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  681. <span class="Punctuation">(</span><span class="Identifier">dir</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">ext</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">splitFile</span><span class="Punctuation">(</span><span class="StringLit">&quot;/tmp.txt&quot;</span><span class="Punctuation">)</span>
  682. <span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">&quot;/&quot;</span>
  683. <span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">&quot;tmp&quot;</span>
  684. <span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">&quot;.txt&quot;</span></pre>
  685. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L608" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  686. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L608" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  687. </dd>
  688. </div>
  689. </div>
  690. <div id="splitPath-procs-all">
  691. <div id="splitPath,string">
  692. <dt><pre><span class="Keyword">proc</span> <a href="#splitPath%2Cstring"><span class="Identifier">splitPath</span></a><span class="Other">(</span><span class="Identifier">path</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">head</span><span class="Other">,</span> <span class="Identifier">tail</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  693. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  694. <dd>
  695. <p>Splits a directory into <tt class="docutils literal"><span class="pre"><span class="Punctuation">(</span><span class="Identifier">head</span><span class="Punctuation">,</span> <span class="Identifier">tail</span><span class="Punctuation">)</span></span></tt> tuple, so that <tt class="docutils literal"><span class="pre">head / tail == path</span></tt> (except for edge cases like &quot;/usr&quot;).</p>
  696. <p>See also:</p>
  697. <ul class="simple"><li><a class="reference internal nimdoc" title="proc joinPath(head, tail: string): string" href="#joinPath,string,string">joinPath(head, tail) proc</a></li>
  698. <li><a class="reference internal nimdoc" title="proc joinPath(parts: varargs[string]): string" href="#joinPath,varargs[string]">joinPath(parts: varargs[string]) proc</a></li>
  699. <li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
  700. <li><a class="reference internal nimdoc" title="proc `/../`(head, tail: string): string" href="#/../,string,string">/../ proc</a></li>
  701. <li><a class="reference internal nimdoc" title="proc relativePath(path, base: string; sep = DirSep): string" href="#relativePath,string,string">relativePath proc</a></li>
  702. </ul>
  703. <p><strong class="examples_text">Example:</strong></p>
  704. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/local/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;usr/local&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bin&quot;</span><span class="Punctuation">)</span>
  705. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/local/bin/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;usr/local/bin&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
  706. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/bin/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;/bin&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
  707. <span class="Keyword">when</span> <span class="Punctuation">(</span><span class="Identifier">NimMajor</span><span class="Punctuation">,</span> <span class="Identifier">NimMinor</span><span class="Punctuation">)</span> <span class="Operator">&lt;=</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  708. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bin&quot;</span><span class="Punctuation">)</span>
  709. <span class="Keyword">else</span><span class="Punctuation">:</span>
  710. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;/&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bin&quot;</span><span class="Punctuation">)</span>
  711. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;bin&quot;</span><span class="Punctuation">)</span>
  712. <span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span></pre>
  713. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L183" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  714. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L183" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  715. </dd>
  716. </div>
  717. </div>
  718. <div id="tailDir-procs-all">
  719. <div id="tailDir,string">
  720. <dt><pre><span class="Keyword">proc</span> <a href="#tailDir%2Cstring"><span class="Identifier">tailDir</span></a><span class="Other">(</span><span class="Identifier">path</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">noSideEffect</span><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;nos$1&quot;</span><span class="Other">,</span>
  721. <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>
  722. <dd>
  723. <p>Returns the tail part of <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
  724. <p>See also:</p>
  725. <ul class="simple"><li><a class="reference internal nimdoc" title="proc relativePath(path, base: string; sep = DirSep): string" href="#relativePath,string,string">relativePath proc</a></li>
  726. <li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
  727. <li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
  728. </ul>
  729. <p><strong class="examples_text">Example:</strong></p>
  730. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;bin&quot;</span>
  731. <span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  732. <span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;bin/&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
  733. <span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;/usr/local/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/local/bin&quot;</span>
  734. <span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;//usr//local//bin//&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr//local//bin//&quot;</span>
  735. <span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;./usr/local/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;usr/local/bin&quot;</span>
  736. <span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">&quot;usr/local/bin&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;local/bin&quot;</span></pre>
  737. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L445" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  738. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L445" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  739. </dd>
  740. </div>
  741. </div>
  742. <div id="unixToNativePath-procs-all">
  743. <div id="unixToNativePath,string,string">
  744. <dt><pre><span class="Keyword">proc</span> <a href="#unixToNativePath%2Cstring%2Cstring"><span class="Identifier">unixToNativePath</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">drive</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 class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
  745. <span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">&quot;nos$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>
  746. <dd>
  747. <p>Converts an UNIX-like path to a native one.</p>
  748. <p>On an UNIX system this does nothing. Else it converts <tt class="docutils literal"><span class="pre"><span class="CharLit">'/'</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="CharLit">'.'</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="CharLit">'..'</span></span></tt> to the appropriate things.</p>
  749. <p>On systems with a concept of &quot;drives&quot;, <tt class="docutils literal"><span class="pre"><span class="Identifier">drive</span></span></tt> is used to determine which drive label to use during absolute path conversion. <tt class="docutils literal"><span class="pre"><span class="Identifier">drive</span></span></tt> defaults to the drive of the current working directory, and is ignored on systems that do not have a concept of &quot;drives&quot;.</p>
  750. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L784" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  751. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L784" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  752. </dd>
  753. </div>
  754. </div>
  755. </dl>
  756. </div>
  757. <div class="section" id="15">
  758. <h1><a class="toc-backref" href="#15">Iterators</a></h1>
  759. <dl class="item">
  760. <div id="parentDirs-iterators-all">
  761. <div id="parentDirs.i,string">
  762. <dt><pre><span class="Keyword">iterator</span> <a href="#parentDirs.i%2Cstring"><span class="Identifier">parentDirs</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">fromRoot</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">inclusive</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
  763. <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>
  764. <dd>
  765. <p>Walks over all parent directories of a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
  766. <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">fromRoot</span></span></tt> is true (default: false), the traversal will start from the file system root directory. If <tt class="docutils literal"><span class="pre"><span class="Identifier">inclusive</span></span></tt> is true (default), the original argument will be included in the traversal.</p>
  767. <p>Relative paths won't be expanded by this iterator. Instead, it will traverse only the directories appearing in the relative path.</p>
  768. <p>See also:</p>
  769. <ul class="simple"><li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
  770. </ul>
  771. <p><strong class="examples_text">Example:</strong></p>
  772. <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">g</span> <span class="Operator">=</span> <span class="StringLit">&quot;a/b/c&quot;</span>
  773. <span class="Keyword">for</span> <span class="Identifier">p</span> <span class="Keyword">in</span> <span class="Identifier">g</span><span class="Operator">.</span><span class="Identifier">parentDirs</span><span class="Punctuation">:</span>
  774. <span class="Identifier">echo</span> <span class="Identifier">p</span>
  775. <span class="Comment"># a/b/c</span>
  776. <span class="Comment"># a/b</span>
  777. <span class="Comment"># a</span>
  778. <span class="Keyword">for</span> <span class="Identifier">p</span> <span class="Keyword">in</span> <span class="Identifier">g</span><span class="Operator">.</span><span class="Identifier">parentDirs</span><span class="Punctuation">(</span><span class="Identifier">fromRoot</span><span class="Operator">=</span><span class="Identifier">true</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  779. <span class="Identifier">echo</span> <span class="Identifier">p</span>
  780. <span class="Comment"># a/</span>
  781. <span class="Comment"># a/b/</span>
  782. <span class="Comment"># a/b/c</span>
  783. <span class="Keyword">for</span> <span class="Identifier">p</span> <span class="Keyword">in</span> <span class="Identifier">g</span><span class="Operator">.</span><span class="Identifier">parentDirs</span><span class="Punctuation">(</span><span class="Identifier">inclusive</span><span class="Operator">=</span><span class="Identifier">false</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  784. <span class="Identifier">echo</span> <span class="Identifier">p</span>
  785. <span class="Comment"># a/b</span>
  786. <span class="Comment"># a</span></pre>
  787. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L490" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  788. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L490" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  789. </dd>
  790. </div>
  791. </div>
  792. </dl>
  793. </div>
  794. </div>
  795. </div>
  796. <div class="twelve-columns footer">
  797. <span class="nim-sprite"></span>
  798. <br>
  799. <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:32 UTC</small>
  800. </div>
  801. </div>
  802. </div>
  803. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  804. </body>
  805. </html>