mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-28 17:04:41 +00:00
964 lines
124 KiB
HTML
964 lines
124 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>std/private/ospaths2</title>
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- Favicon -->
|
|
<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=="/>
|
|
<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=">
|
|
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
|
|
|
|
<!-- JS -->
|
|
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
|
|
</head>
|
|
<body>
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">std/private/ospaths2</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-select-wrapper">
|
|
<label for="theme-select">Theme: </label>
|
|
<select id="theme-select" onchange="setTheme(this.value)">
|
|
<option value="auto">🌗 Match OS</option>
|
|
<option value="dark">🌑 Dark</option>
|
|
<option value="light">🌕 Light</option>
|
|
</select>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple-boot">
|
|
<li><a href="manual.html">Manual</a></li>
|
|
<li><a href="lib.html">Standard library</a></li>
|
|
<li> <a id="indexLink" href="theindex.html">Index</a></li>
|
|
<li><a href="compiler/theindex.html">Compiler docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="search" id="searchInput"
|
|
oninput="search()" />
|
|
</div>
|
|
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">/
|
|
<li><a class="reference" href="#%2F%2Cstring%2Cstring" title="`/`(head, tail: string): string">`/`(head, tail: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">/../
|
|
<li><a class="reference" href="#%2F..%2F%2Cstring%2Cstring" title="`/../`(head, tail: string): string">`/../`(head, tail: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">absolutePath
|
|
<li><a class="reference" href="#absolutePath%2Cstring" title="absolutePath(path: string; root = when supportedSystem:
|
|
getCurrentDir()
|
|
else:
|
|
""): string">absolutePath(path: string; root = when supportedSystem:
|
|
getCurrentDir()
|
|
else:
|
|
""): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">addFileExt
|
|
<li><a class="reference" href="#addFileExt%2Cstring%2Cstring" title="addFileExt(filename, ext: string): string">addFileExt(filename, ext: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">changeFileExt
|
|
<li><a class="reference" href="#changeFileExt%2Cstring%2Cstring" title="changeFileExt(filename, ext: string): string">changeFileExt(filename, ext: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">cmpPaths
|
|
<li><a class="reference" href="#cmpPaths%2Cstring%2Cstring" title="cmpPaths(pathA, pathB: string): int">cmpPaths(pathA, pathB: string): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">extractFilename
|
|
<li><a class="reference" href="#extractFilename%2Cstring" title="extractFilename(path: string): string">extractFilename(path: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getCurrentDir
|
|
<li><a class="reference" href="#getCurrentDir" title="getCurrentDir(): string">getCurrentDir(): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">isAbsolute
|
|
<li><a class="reference" href="#isAbsolute%2Cstring" title="isAbsolute(path: string): bool">isAbsolute(path: string): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">isRelativeTo
|
|
<li><a class="reference" href="#isRelativeTo%2Cstring%2Cstring" title="isRelativeTo(path: string; base: string): bool">isRelativeTo(path: string; base: string): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">isRootDir
|
|
<li><a class="reference" href="#isRootDir%2Cstring" title="isRootDir(path: string): bool">isRootDir(path: string): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">joinPath
|
|
<li><a class="reference" href="#joinPath%2Cstring%2Cstring" title="joinPath(head, tail: string): string">joinPath(head, tail: string): string</a></li>
|
|
<li><a class="reference" href="#joinPath%2Cvarargs%5Bstring%5D" title="joinPath(parts: varargs[string]): string">joinPath(parts: varargs[string]): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">lastPathPart
|
|
<li><a class="reference" href="#lastPathPart%2Cstring" title="lastPathPart(path: string): string">lastPathPart(path: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">normalizedPath
|
|
<li><a class="reference" href="#normalizedPath%2Cstring" title="normalizedPath(path: string): string">normalizedPath(path: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">normalizeExe
|
|
<li><a class="reference" href="#normalizeExe%2Cstring" title="normalizeExe(file: var string)">normalizeExe(file: var string)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">normalizePath
|
|
<li><a class="reference" href="#normalizePath%2Cstring" title="normalizePath(path: var string)">normalizePath(path: var string)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">normalizePathEnd
|
|
<li><a class="reference" href="#normalizePathEnd%2Cstring_2" title="normalizePathEnd(path: string; trailingSep = false): string">normalizePathEnd(path: string; trailingSep = false): string</a></li>
|
|
<li><a class="reference" href="#normalizePathEnd%2Cstring" title="normalizePathEnd(path: var string; trailingSep = false)">normalizePathEnd(path: var string; trailingSep = false)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">parentDir
|
|
<li><a class="reference" href="#parentDir%2Cstring" title="parentDir(path: string): string">parentDir(path: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">relativePath
|
|
<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>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">sameFile
|
|
<li><a class="reference" href="#sameFile%2Cstring%2Cstring" title="sameFile(path1, path2: string): bool">sameFile(path1, path2: string): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">searchExtPos
|
|
<li><a class="reference" href="#searchExtPos%2Cstring" title="searchExtPos(path: string): int">searchExtPos(path: string): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">splitFile
|
|
<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>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">splitPath
|
|
<li><a class="reference" href="#splitPath%2Cstring" title="splitPath(path: string): tuple[head, tail: string]">splitPath(path: string): tuple[head, tail: string]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">tailDir
|
|
<li><a class="reference" href="#tailDir%2Cstring" title="tailDir(path: string): string">tailDir(path: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">unixToNativePath
|
|
<li><a class="reference" href="#unixToNativePath%2Cstring%2Cstring" title="unixToNativePath(path: string; drive = ""): string">unixToNativePath(path: string; drive = ""): string</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">parentDirs
|
|
<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>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<div class="nine columns" id="content">
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L1" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
<div id="tocRoot"></div>
|
|
|
|
<p class="module-desc"></p>
|
|
<div class="section" id="6">
|
|
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
|
<dl class="item">
|
|
<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>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="/-procs-all">
|
|
<div id="/,string,string">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc `/../`(head, tail: string): string" href="#/../,string,string">/../ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc joinPath(head, tail: string): string" href="#joinPath,string,string">joinPath(head, tail) proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc joinPath(parts: varargs[string]): string" href="#joinPath,varargs[string]">joinPath(parts: varargs[string]) proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
|
|
<li><a class="reference external" href="uri.html#combine,Uri,Uri">uri.combine proc</a></li>
|
|
<li><a class="reference external" href="uri.html#/,Uri,string">uri./ proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"usr"</span> <span class="Operator">/</span> <span class="StringLit">""</span> <span class="Operator">==</span> <span class="StringLit">"usr"</span>
|
|
<span class="Identifier">assert</span> <span class="StringLit">""</span> <span class="Operator">/</span> <span class="StringLit">"lib"</span> <span class="Operator">==</span> <span class="StringLit">"lib"</span>
|
|
<span class="Identifier">assert</span> <span class="StringLit">""</span> <span class="Operator">/</span> <span class="StringLit">"/lib"</span> <span class="Operator">==</span> <span class="StringLit">"/lib"</span>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"usr/"</span> <span class="Operator">/</span> <span class="StringLit">"/lib/"</span> <span class="Operator">==</span> <span class="StringLit">"usr/lib/"</span>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"usr"</span> <span class="Operator">/</span> <span class="StringLit">"lib"</span> <span class="Operator">/</span> <span class="StringLit">"../bin"</span> <span class="Operator">==</span> <span class="StringLit">"usr/bin"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L160" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L160" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="/../-procs-all">
|
|
<div id="/../,string,string">
|
|
<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>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"a/b/c"</span> <span class="Operator">/../</span> <span class="StringLit">"d/e"</span> <span class="Operator">==</span> <span class="StringLit">"a/b/d/e"</span>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"a"</span> <span class="Operator">/../</span> <span class="StringLit">"d/e"</span> <span class="Operator">==</span> <span class="StringLit">"a/d/e"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L544" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L544" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="absolutePath-procs-all">
|
|
<div id="absolutePath,string">
|
|
<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>
|
|
<span class="Identifier">getCurrentDir</span><span class="Other">(</span><span class="Other">)</span>
|
|
<span class="Keyword">else</span><span class="Other">:</span>
|
|
<span class="StringLit">""</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc normalizedPath(path: string): string" href="#normalizedPath,string">normalizedPath proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc normalizePath(path: var string)" href="#normalizePath,string">normalizePath proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">absolutePath</span><span class="Punctuation">(</span><span class="StringLit">"a"</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">"a"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L890" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L890" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="addFileExt-procs-all">
|
|
<div id="addFileExt,string,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">addFileExt</span><span class="Punctuation">(</span><span class="StringLit">"foo.bar"</span><span class="Punctuation">,</span> <span class="StringLit">"baz"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo.bar"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">addFileExt</span><span class="Punctuation">(</span><span class="StringLit">"foo.bar"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo.bar"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">addFileExt</span><span class="Punctuation">(</span><span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="StringLit">"baz"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo.baz"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L733" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L733" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="changeFileExt-procs-all">
|
|
<div id="changeFileExt,string,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Changes the file extension to <tt class="docutils literal"><span class="pre"><span class="Identifier">ext</span></span></tt>.</p>
|
|
<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> == "" then any extension is removed.</p>
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">"foo.bar"</span><span class="Punctuation">,</span> <span class="StringLit">"baz"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo.baz"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">"foo.bar"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">changeFileExt</span><span class="Punctuation">(</span><span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="StringLit">"baz"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo.baz"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L707" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L707" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="cmpPaths-procs-all">
|
|
<div id="cmpPaths,string,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Compares two paths.</p>
|
|
<p>On a case-sensitive filesystem this is done case-sensitively otherwise case-insensitively. Returns:</p>
|
|
<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"><</span> <span class="DecNumber">0</span></span></tt> if pathA < pathB<br/><tt class="docutils literal"><span class="pre"><span class="Operator">></span> <span class="DecNumber">0</span></span></tt> if pathA > pathB<br/></p>
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">cmpPaths</span><span class="Punctuation">(</span><span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="StringLit">"Foo"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">cmpPaths</span><span class="Punctuation">(</span><span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="StringLit">"Foo"</span><span class="Punctuation">)</span> <span class="Operator">></span> <span class="DecNumber">0</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L757" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L757" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="extractFilename-procs-all">
|
|
<div id="extractFilename,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Extracts the filename of a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
|
|
<p>This is the same as <tt class="docutils literal"><span class="pre">name & 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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">extractFilename</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar/"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">extractFilename</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"bar"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">extractFilename</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar.baz"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"bar.baz"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L667" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L667" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getCurrentDir-procs-all">
|
|
<div id="getCurrentDir">
|
|
<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">"nos$1"</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">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>
|
|
<dd>
|
|
|
|
<p>Returns the <span id="current-working-directory_1">current working directory</span> i.e. where the built binary is run.</p>
|
|
<p>So the path returned by this proc is determined at run time.</p>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference external" href="./osappdirs.html#getHomeDir">osappdirs: getHomeDir proc</a></li>
|
|
<li><a class="reference external" href="./osappdirs.html#getConfigDir">osappdirs: getConfigDir proc</a></li>
|
|
<li><a class="reference external" href="./osappdirs.html#getTempDir">osappdirs: getTempDir proc</a></li>
|
|
<li><a class="reference external" href="./osdirs.html#setCurrentDir,string">osdirs: setCurrentDir proc</a></li>
|
|
<li><a class="reference external" href="system.html#currentSourcePath.t">currentSourcePath template</a></li>
|
|
<li><a class="reference external" href="macros.html#getProjectPath">getProjectPath proc</a></li>
|
|
</ul>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L842" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L842" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="isAbsolute-procs-all">
|
|
<div id="isAbsolute,string">
|
|
<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">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Checks whether a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> is absolute.</p>
|
|
<p>On Windows, network paths are considered absolute too.</p>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">""</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
|
|
<span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">"."</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"/"</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
|
|
<span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="StringLit">"a/"</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span>
|
|
<span class="Identifier">assert</span> <span class="StringLit">"/a/"</span><span class="Operator">.</span><span class="Identifier">isAbsolute</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L232" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L232" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="isRelativeTo-procs-all">
|
|
<div id="isRelativeTo,string,string">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
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>.
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">"./foo//bar"</span><span class="Punctuation">,</span> <span class="StringLit">"foo"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar"</span><span class="Punctuation">,</span> <span class="StringLit">"."</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">"/foo/bar.nim"</span><span class="Punctuation">,</span> <span class="StringLit">"/foo/bar.nim"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">isRelativeTo</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar.nims"</span><span class="Punctuation">,</span> <span class="StringLit">"foo/bar.nim"</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L381" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L381" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="isRootDir-procs-all">
|
|
<div id="isRootDir,string">
|
|
<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">"nos$1"</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>
|
|
<dd>
|
|
|
|
Checks whether a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt> is a root directory.
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">"."</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">"/"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">"a"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">"/a"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">isRootDir</span><span class="Punctuation">(</span><span class="StringLit">"a/b/c"</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L474" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L474" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="joinPath-procs-all">
|
|
<div id="joinPath,string,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Joins two directory names to one.</p>
|
|
<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>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
|
|
<li><a class="reference external" href="uri.html#combine,Uri,Uri">uri.combine proc</a></li>
|
|
<li><a class="reference external" href="uri.html#/,Uri,string">uri./ proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr"</span><span class="Punctuation">,</span> <span class="StringLit">"lib"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/lib"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr"</span><span class="Punctuation">,</span> <span class="StringLit">"lib/"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/lib/"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr/"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">"lib"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"lib"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">"/lib"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"/lib"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr/"</span><span class="Punctuation">,</span> <span class="StringLit">"/lib"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/lib"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr/lib"</span><span class="Punctuation">,</span> <span class="StringLit">"../bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/bin"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L90" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="joinPath,varargs[string]">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1OpenArray"</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<p>You need to pass at least one element or the proc will assert in debug builds and crash on release builds.</p>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc `/../`(head, tail: string): string" href="#/../,string,string">/../ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"a"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"a"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"a"</span><span class="Punctuation">,</span> <span class="StringLit">"b"</span><span class="Punctuation">,</span> <span class="StringLit">"c"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"a/b/c"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">joinPath</span><span class="Punctuation">(</span><span class="StringLit">"usr/lib"</span><span class="Punctuation">,</span> <span class="StringLit">"../../var"</span><span class="Punctuation">,</span> <span class="StringLit">"log"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"var/log"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L134" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="lastPathPart-procs-all">
|
|
<div id="lastPathPart,string">
|
|
<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">"nos$1"</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc splitFile(path: string): tuple[dir, name, ext: string]" href="#splitFile,string">splitFile proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">lastPathPart</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar/"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"bar"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">lastPathPart</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"bar"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L689" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L689" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="normalizedPath-procs-all">
|
|
<div id="normalizedPath,string">
|
|
<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">"nos$1"</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">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>
|
|
<dd>
|
|
|
|
<p>Returns a normalized path for the current OS.</p>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc absolutePath(path: string; root = when supportedSystem:
|
|
getCurrentDir()
|
|
else:
|
|
""): string" href="#absolutePath,string">absolutePath proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc normalizePath(path: var string)" href="#normalizePath,string">normalizePath proc</a> for the in-place version</li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">normalizedPath</span><span class="Punctuation">(</span><span class="StringLit">"a///b//..//c///d"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"a/c/d"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L962" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L962" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="normalizeExe-procs-all">
|
|
<div id="normalizeExe,string">
|
|
<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>
|
|
<dd>
|
|
|
|
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">""</span><span class="Punctuation">,</span> <span class="StringLit">"."</span><span class="Punctuation">,</span> <span class="StringLit">".."</span></span></tt>.
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
|
|
<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>
|
|
<span class="Identifier">doAssert</span> <span class="StringLit">"foo"</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">"./foo"</span>
|
|
<span class="Identifier">doAssert</span> <span class="StringLit">"foo/../bar"</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">"foo/../bar"</span>
|
|
<span class="Identifier">doAssert</span> <span class="StringLit">""</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">""</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L973" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L973" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="normalizePath-procs-all">
|
|
<div id="normalizePath,string">
|
|
<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">"nos$1"</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">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>
|
|
<dd>
|
|
|
|
<p>Normalize a path.</p>
|
|
<p>Consecutive directory separators are collapsed, including an initial double slash.</p>
|
|
<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>
|
|
<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
|
|
URL-encoded and Unicode attempts at directory traversal are not detected. Triple dot is not handled.</div>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc absolutePath(path: string; root = when supportedSystem:
|
|
getCurrentDir()
|
|
else:
|
|
""): string" href="#absolutePath,string">absolutePath proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc normalizedPath(path: string): string" href="#normalizedPath,string">normalizedPath proc</a> for outplace version</li>
|
|
<li><a class="reference internal nimdoc" title="proc normalizeExe(file: var string)" href="#normalizeExe,string">normalizeExe proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"a///b//..//c///d"</span>
|
|
<span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">normalizePath</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="StringLit">"a/c/d"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L911" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L911" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="normalizePathEnd-procs-all">
|
|
<div id="normalizePathEnd,string_2">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
outplace overload
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">"/lib//.//"</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">"/lib/"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">"lib/./."</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">"lib"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">".//./."</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">"."</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">""</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">""</span> <span class="Comment"># not / !</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">normalizePathEnd</span><span class="Punctuation">(</span><span class="StringLit">"/"</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">"/"</span> <span class="Comment"># not "" !</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L69" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L69" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="normalizePathEnd,string">
|
|
<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>
|
|
<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>
|
|
<dd>
|
|
|
|
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.
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L46" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="parentDir-procs-all">
|
|
<div id="parentDir,string">
|
|
<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">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Returns the parent directory of <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
|
|
<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>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc tailDir(path: string): string" href="#tailDir,string">tailDir proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="iterator parentDirs(path: string; fromRoot = false; inclusive = true): string" href="#parentDirs.i,string">parentDirs iterator</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"/usr/local/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"/usr/local"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"foo/bar//"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"//foo//bar//."</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"/foo"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"./foo"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"."</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"/./foo//./"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"/"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"a//./"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"."</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="StringLit">"a/b/c/.."</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"a"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L400" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L400" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="relativePath-procs-all">
|
|
<div id="relativePath,string,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc tailDir(path: string): string" href="#tailDir,string">tailDir proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">"/Users/me/bar/z.nim"</span><span class="Punctuation">,</span> <span class="StringLit">"/Users/other/bad"</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"../../me/bar/z.nim"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">"/Users/me/bar/z.nim"</span><span class="Punctuation">,</span> <span class="StringLit">"/Users/other"</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"../me/bar/z.nim"</span>
|
|
<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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">"/Users///me/bar//z.nim"</span><span class="Punctuation">,</span> <span class="StringLit">"//Users/"</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"me/bar/z.nim"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">"/Users/me/bar/z.nim"</span><span class="Punctuation">,</span> <span class="StringLit">"/Users/me"</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"bar/z.nim"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">"/users/moo"</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="StringLit">"."</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"foo"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">relativePath</span><span class="Punctuation">(</span><span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="StringLit">"foo"</span><span class="Punctuation">,</span> <span class="CharLit">'/'</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"."</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L291" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L291" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="sameFile-procs-all">
|
|
<div id="sameFile,string,string">
|
|
<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">"nos$1"</span><span class="Other">,</span>
|
|
<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>
|
|
<dd>
|
|
|
|
<p>Returns true if both pathname arguments refer to the same physical file or directory.</p>
|
|
<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>
|
|
<p>This proc will return true if given two alternative hard-linked or sym-linked paths to the same file or directory.</p>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference external" href="./os.html#sameFileContent,string,string">os: sameFileContent proc</a></li>
|
|
</ul>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L986" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L986" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="searchExtPos-procs-all">
|
|
<div id="searchExtPos,string">
|
|
<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>
|
|
<dd>
|
|
|
|
<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>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">"a/b/c"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">"c.nim"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">"a/b/c.nim"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">"a.b.c.nim"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">".nim"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">"..nim"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">searchExtPos</span><span class="Punctuation">(</span><span class="StringLit">"a..nim"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L570" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L570" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="splitFile-procs-all">
|
|
<div id="splitFile,string">
|
|
<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>
|
|
<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">"nos$1"</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>
|
|
<dd>
|
|
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc searchExtPos(path: string): int" href="#searchExtPos,string">searchExtPos proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc extractFilename(path: string): string" href="#extractFilename,string">extractFilename proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc lastPathPart(path: string): string" href="#lastPathPart,string">lastPathPart proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc changeFileExt(filename, ext: string): string" href="#changeFileExt,string,string">changeFileExt proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc addFileExt(filename, ext: string): string" href="#addFileExt,string,string">addFileExt proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<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">"usr/local/nimc.html"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">"usr/local"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">"nimc"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">".html"</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">"/usr/local/os"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">"/usr/local"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">"os"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">""</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">"/usr/local/"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">"/usr/local"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">""</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">"/tmp.txt"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">dir</span> <span class="Operator">==</span> <span class="StringLit">"/"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">name</span> <span class="Operator">==</span> <span class="StringLit">"tmp"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">ext</span> <span class="Operator">==</span> <span class="StringLit">".txt"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L608" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L608" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="splitPath-procs-all">
|
|
<div id="splitPath,string">
|
|
<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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<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 "/usr").</p>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc joinPath(parts: varargs[string]): string" href="#joinPath,varargs[string]">joinPath(parts: varargs[string]) proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc `/`(head, tail: string): string" href="#/,string,string">/ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc `/../`(head, tail: string): string" href="#/../,string,string">/../ proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc relativePath(path, base: string; sep = DirSep): string" href="#relativePath,string,string">relativePath proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">"usr/local/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">"usr/local"</span><span class="Punctuation">,</span> <span class="StringLit">"bin"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">"usr/local/bin/"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">"usr/local/bin"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">"/bin/"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">"/bin"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
|
|
<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"><=</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>
|
|
<span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">"/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">"bin"</span><span class="Punctuation">)</span>
|
|
<span class="Keyword">else</span><span class="Punctuation">:</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">"/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">"/"</span><span class="Punctuation">,</span> <span class="StringLit">"bin"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">"bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">"bin"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">splitPath</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L183" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L183" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="tailDir-procs-all">
|
|
<div id="tailDir,string">
|
|
<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">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Returns the tail part of <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
|
|
<p>See also:</p>
|
|
<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>
|
|
<li><a class="reference internal nimdoc" title="proc splitPath(path: string): tuple[head, tail: string]" href="#splitPath,string">splitPath proc</a></li>
|
|
<li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"bin"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"bin/"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">""</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"/usr/local/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/local/bin"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"//usr//local//bin//"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr//local//bin//"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"./usr/local/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"usr/local/bin"</span>
|
|
<span class="Identifier">assert</span> <span class="Identifier">tailDir</span><span class="Punctuation">(</span><span class="StringLit">"usr/local/bin"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"local/bin"</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L445" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L445" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="unixToNativePath-procs-all">
|
|
<div id="unixToNativePath,string,string">
|
|
<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">""</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>
|
|
<span class="Identifier">extern</span><span class="Other">:</span> <span class="StringLit">"nos$1"</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>
|
|
<dd>
|
|
|
|
<p>Converts an UNIX-like path to a native one.</p>
|
|
<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>
|
|
<p>On systems with a concept of "drives", <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 "drives".</p>
|
|
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L784" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L784" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="15">
|
|
<h1><a class="toc-backref" href="#15">Iterators</a></h1>
|
|
<dl class="item">
|
|
<div id="parentDirs-iterators-all">
|
|
<div id="parentDirs.i,string">
|
|
<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> {.
|
|
<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>
|
|
<dd>
|
|
|
|
<p>Walks over all parent directories of a given <tt class="docutils literal"><span class="pre"><span class="Identifier">path</span></span></tt>.</p>
|
|
<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>
|
|
<p>Relative paths won't be expanded by this iterator. Instead, it will traverse only the directories appearing in the relative path.</p>
|
|
<p>See also:</p>
|
|
<ul class="simple"><li><a class="reference internal nimdoc" title="proc parentDir(path: string): string" href="#parentDir,string">parentDir proc</a></li>
|
|
</ul>
|
|
|
|
<p><strong class="examples_text">Example:</strong></p>
|
|
<pre class="listing"><span class="Keyword">let</span> <span class="Identifier">g</span> <span class="Operator">=</span> <span class="StringLit">"a/b/c"</span>
|
|
|
|
<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">echo</span> <span class="Identifier">p</span>
|
|
<span class="Comment"># a/b/c</span>
|
|
<span class="Comment"># a/b</span>
|
|
<span class="Comment"># a</span>
|
|
|
|
<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>
|
|
<span class="Identifier">echo</span> <span class="Identifier">p</span>
|
|
<span class="Comment"># a/</span>
|
|
<span class="Comment"># a/b/</span>
|
|
<span class="Comment"># a/b/c</span>
|
|
|
|
<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>
|
|
<span class="Identifier">echo</span> <span class="Identifier">p</span>
|
|
<span class="Comment"># a/b</span>
|
|
<span class="Comment"># a</span></pre>
|
|
<a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/private/ospaths2.nim#L490" class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/private/ospaths2.nim#L490" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="19">
|
|
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
|
<dl class="item">
|
|
<a href="oscommon.html#ReadDirEffect"><span class="Identifier">ReadDirEffect</span></a>, <a href="oscommon.html#WriteDirEffect"><span class="Identifier">WriteDirEffect</span></a>, <a href="osseps.html#ExtSep"><span class="Identifier">ExtSep</span></a>, <a href="osseps.html#FileSystemCaseSensitive"><span class="Identifier">FileSystemCaseSensitive</span></a>, <a href="osseps.html#DynlibFormat"><span class="Identifier">DynlibFormat</span></a>, <a href="osseps.html#DirSep"><span class="Identifier">DirSep</span></a>, <a href="osseps.html#AltSep"><span class="Identifier">AltSep</span></a>, <a href="osseps.html#PathSep"><span class="Identifier">PathSep</span></a>, <a href="osseps.html#ScriptExt"><span class="Identifier">ScriptExt</span></a>, <a href="osseps.html#doslikeFileSystem"><span class="Identifier">doslikeFileSystem</span></a>, <a href="osseps.html#ExeExt"><span class="Identifier">ExeExt</span></a>, <a href="osseps.html#CurDir"><span class="Identifier">CurDir</span></a>, <a href="osseps.html#ParDir"><span class="Identifier">ParDir</span></a>
|
|
</dl>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br>
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-25 20:14:01 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
|
|
|
|
</body>
|
|
</html>
|