Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c734c582d4 | |||
| 03aab46ab5 | |||
| 4bf3e1c7c1 | |||
| 2d62dee4d0 | |||
| 3eb542bdfd | |||
| 5b87d0bf9a |
@@ -5,7 +5,7 @@ is a simple file path library for Carp.
|
||||
## Installation
|
||||
|
||||
```clojure
|
||||
(load "https://veitheller.de/git/carpentry/path@0.0.2")
|
||||
(load "git@git.veitheller.de:carpentry/path.git@0.0.4")
|
||||
```
|
||||
|
||||
### Usage
|
||||
@@ -16,7 +16,7 @@ has some functions to work with the `PATH` environment variable.
|
||||
|
||||
It assumes either Windows or POSIX-style separators.
|
||||
|
||||
Look at [the documentation](https://veitheller.de/path) for more information.
|
||||
Look at [the documentation](https://carpentry.dev/path) for more information.
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
886
docs/Path.html
886
docs/Path.html
@@ -9,8 +9,8 @@
|
||||
<body>
|
||||
<div class="content">
|
||||
<div class="logo">
|
||||
<a href="http://github.com/carp-lang/Carp">
|
||||
<img src="logo.png">
|
||||
<a href="">
|
||||
<img src="">
|
||||
</a>
|
||||
<div class="title">
|
||||
path
|
||||
@@ -25,13 +25,14 @@
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<h1>
|
||||
Path
|
||||
</h1>
|
||||
<div class="module-description">
|
||||
<p>is a simple file path library for Carp.</p>
|
||||
<div class="module">
|
||||
<h1>
|
||||
Path
|
||||
</h1>
|
||||
<div class="module-description">
|
||||
<p>is a simple file path library for Carp.</p>
|
||||
<h2>Installation</h2>
|
||||
<pre><code class="language-clojure">(load "https://veitheller.de/git/carpentry/path@0.0.2")
|
||||
<pre><code class="language-clojure">(load "git@git.veitheller.de:carpentry/path.git@0.0.4")
|
||||
</code></pre>
|
||||
<h3>Usage</h3>
|
||||
<p>The <code>Path</code> module mostly operates on <code>String</code> arguments. It allows you to
|
||||
@@ -39,473 +40,473 @@ split, join, and merge paths and extensions in a lot of different ways. It also
|
||||
has some functions to work with the <code>PATH</code> environment variable.</p>
|
||||
<p>It assumes either Windows or POSIX-style separators.</p>
|
||||
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#</>">
|
||||
<h3 id="</>">
|
||||
</>
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [a, b] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(</> before after)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>joins <code>before</code> and <code>after</code> using the default path separator.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#</>">
|
||||
<h3 id="</>">
|
||||
</>
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [a, b] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(</> before after)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>joins <code>before</code> and <code>after</code> using the default path separator.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#absolute">
|
||||
<h3 id="absolute">
|
||||
absolute
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(absolute p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>makes an absolute path from <code>p</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#absolute">
|
||||
<h3 id="absolute">
|
||||
absolute
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(absolute p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>makes an absolute path from <code>p</code>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#absolute?">
|
||||
<h3 id="absolute?">
|
||||
absolute?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(absolute? p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether a path is absolute.</p>
|
||||
<p>As such, it is the inverse to <a href="#relative">relative</a>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#absolute?">
|
||||
<h3 id="absolute?">
|
||||
absolute?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(absolute? p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether a path is absolute.</p>
|
||||
<p>As such, it is the inverse to <a href="#relative?">relative?</a>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#add-extension">
|
||||
<h3 id="add-extension">
|
||||
add-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a), (Ref String b)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(add-extension p ext)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>adds an extension <code>ext</code> to a path <code>p</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#add-extension">
|
||||
<h3 id="add-extension">
|
||||
add-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a), (Ref String b)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(add-extension p ext)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>adds an extension <code>ext</code> to a path <code>p</code>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#basename">
|
||||
<h3 id="basename">
|
||||
basename
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(basename p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the basename of the path <code>p</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#basename">
|
||||
<h3 id="basename">
|
||||
basename
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(basename p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the basename of the path <code>p</code>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#cwd">
|
||||
<h3 id="cwd">
|
||||
cwd
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(cwd)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>returns the current working directory as a <code>Maybe</code>. The ways in
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#cwd">
|
||||
<h3 id="cwd">
|
||||
cwd
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(cwd)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>returns the current working directory as a <code>Maybe</code>. The ways in
|
||||
which it can fail are OS-dependent, but it should happen relatively rare.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#drop-extension">
|
||||
<h3 id="drop-extension">
|
||||
drop-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(drop-extension p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>drops the extension of a path <code>p</code>. Does nothing if there
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#drop-extension">
|
||||
<h3 id="drop-extension">
|
||||
drop-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(drop-extension p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>drops the extension of a path <code>p</code>. Does nothing if there
|
||||
is none.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#extension">
|
||||
<h3 id="extension">
|
||||
extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(extension p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the extension of a file as a <code>Maybe</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#extension">
|
||||
<h3 id="extension">
|
||||
extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(extension p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the extension of a file as a <code>Maybe</code>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#filename">
|
||||
<h3 id="filename">
|
||||
filename
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(filename p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the filename of the path <code>p</code> as a <code>(Maybe String)</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#filename">
|
||||
<h3 id="filename">
|
||||
filename
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] (Maybe String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(filename p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the filename of the path <code>p</code> as a <code>(Maybe String)</code>.</p>
|
||||
<p>It will return <code>Nothing</code> if an empty string is passed.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#get-search-path">
|
||||
<h3 id="get-search-path">
|
||||
get-search-path
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [] (Maybe (Array String)))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(get-search-path)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the <code>PATH</code> environment variable and splits it.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#get-search-path">
|
||||
<h3 id="get-search-path">
|
||||
get-search-path
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [] (Maybe (Array String)))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(get-search-path)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>gets the <code>PATH</code> environment variable and splits it.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#has-extension?">
|
||||
<h3 id="has-extension?">
|
||||
has-extension?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(has-extension? p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>cheks whether the path <code>p</code> has an extension.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#has-extension?">
|
||||
<h3 id="has-extension?">
|
||||
has-extension?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(has-extension? p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>cheks whether the path <code>p</code> has an extension.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#is-extension?">
|
||||
<h3 id="is-extension?">
|
||||
is-extension?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a), (Ref String b)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(is-extension? p ext)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether the path <code>p</code> has the extension <code>ext</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#is-extension?">
|
||||
<h3 id="is-extension?">
|
||||
is-extension?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a), (Ref String b)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(is-extension? p ext)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether the path <code>p</code> has the extension <code>ext</code>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#join">
|
||||
<h3 id="join">
|
||||
join
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref (Array String) a)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(join ps)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>joins the path components <code>ps</code> into a path.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#join">
|
||||
<h3 id="join">
|
||||
join
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref (Array String) a)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(join ps)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>joins the path components <code>ps</code> into a path.</p>
|
||||
<p>As such, it is the inverse to <a href="#split">split</a>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#path-max">
|
||||
<h3 id="path-max">
|
||||
path-max
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
external
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
Int
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>defines the maximum path length on this OS.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#path-max">
|
||||
<h3 id="path-max">
|
||||
path-max
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
external
|
||||
</div>
|
||||
<p class="sig">
|
||||
Int
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>defines the maximum path length on this OS.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#relative?">
|
||||
<h3 id="relative?">
|
||||
relative?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(relative? p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether a path is relative.</p>
|
||||
<p>As such, it is the inverse to <a href="#absolute">absolute</a>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#relative?">
|
||||
<h3 id="relative?">
|
||||
relative?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(relative? p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether a path is relative.</p>
|
||||
<p>As such, it is the inverse to <a href="#absolute?">absolute?</a>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#replace-extension">
|
||||
<h3 id="replace-extension">
|
||||
replace-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a), (Ref String b)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(replace-extension p ext)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>replaces the extension of a path <code>p</code> with <code>ext</code>. Adds
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#replace-extension">
|
||||
<h3 id="replace-extension">
|
||||
replace-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a), (Ref String b)] String)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(replace-extension p ext)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>replaces the extension of a path <code>p</code> with <code>ext</code>. Adds
|
||||
an extension if there previously was none.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#search-path-separator">
|
||||
<h3 id="search-path-separator">
|
||||
search-path-separator
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
def
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
Char
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>is the separator for the <code>PATH</code> environment
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#search-path-separator">
|
||||
<h3 id="search-path-separator">
|
||||
search-path-separator
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
def
|
||||
</div>
|
||||
<p class="sig">
|
||||
Char
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>is the separator for the <code>PATH</code> environment
|
||||
variable we use on this OS.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#search-path-separator?">
|
||||
<h3 id="search-path-separator?">
|
||||
search-path-separator?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [Char] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(search-path-separator? c)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#separator">
|
||||
<h3 id="separator">
|
||||
separator
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
def
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#search-path-separator?">
|
||||
<h3 id="search-path-separator?">
|
||||
search-path-separator?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [Char] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(search-path-separator? c)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
Char
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>is the default separator we use on this OS.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#separator">
|
||||
<h3 id="separator">
|
||||
separator
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
def
|
||||
</div>
|
||||
<p class="sig">
|
||||
Char
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>is the default separator we use on this OS.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#separator?">
|
||||
<h3 id="separator?">
|
||||
separator?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref Char StaticLifetime)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(separator? c)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether the character <code>c</code> is a separator for the
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#separator?">
|
||||
<h3 id="separator?">
|
||||
separator?
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref Char StaticLifetime)] Bool)
|
||||
</p>
|
||||
<pre class="args">
|
||||
(separator? c)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>checks whether the character <code>c</code> is a separator for the
|
||||
<code>PATH</code> environment variable on this OS.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#separators">
|
||||
<h3 id="separators">
|
||||
separators
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
def
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Array Char)
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>is the possible separators we could use on this OS.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#separators">
|
||||
<h3 id="separators">
|
||||
separators
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
def
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Array Char)
|
||||
</p>
|
||||
<span>
|
||||
|
||||
</span>
|
||||
<p class="doc">
|
||||
<p>is the possible separators we could use on this OS.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#split">
|
||||
<h3 id="split">
|
||||
split
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] (Array String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(split p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>splits the path <code>p</code> into its components.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#split">
|
||||
<h3 id="split">
|
||||
split
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] (Array String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(split p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>splits the path <code>p</code> into its components.</p>
|
||||
<p>As such, it is the inverse to <a href="#join">join</a>.</p>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#split-extension">
|
||||
<h3 id="split-extension">
|
||||
split-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] (Maybe (Pair String String)))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(split-extension p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>splits the path <code>p</code> on its extension.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#split-extension">
|
||||
<h3 id="split-extension">
|
||||
split-extension
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] (Maybe (Pair String String)))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(split-extension p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>splits the path <code>p</code> on its extension.</p>
|
||||
<p>It will return a <code>(Maybe (Pair String String))</code>. <code>Maybe</code> because there might not
|
||||
be an extension, and <code>Pair</code> because it will return the part before and after
|
||||
the extension.</p>
|
||||
@@ -524,27 +525,28 @@ the extension.</p>
|
||||
; => (Maybe.Just (Pair "file/path.txt.bob" "fred"))
|
||||
</code></pre>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#split-search-path">
|
||||
<h3 id="split-search-path">
|
||||
split-search-path
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</p>
|
||||
</div>
|
||||
<p class="sig">
|
||||
(λ [(Ref String a)] (Array String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(split-search-path p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>splits a <code>PATH</code> environment variable <code>p</code>.</p>
|
||||
<div class="binder">
|
||||
<a class="anchor" href="#split-search-path">
|
||||
<h3 id="split-search-path">
|
||||
split-search-path
|
||||
</h3>
|
||||
</a>
|
||||
<div class="description">
|
||||
defn
|
||||
</div>
|
||||
<p class="sig">
|
||||
(Fn [(Ref String a)] (Array String))
|
||||
</p>
|
||||
<pre class="args">
|
||||
(split-search-path p)
|
||||
</pre>
|
||||
<p class="doc">
|
||||
<p>splits a <code>PATH</code> environment variable <code>p</code>.</p>
|
||||
|
||||
</p>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
15
gendocs.carp
15
gendocs.carp
@@ -1,13 +1,10 @@
|
||||
(load "path.carp")
|
||||
|
||||
(defndynamic gendocs []
|
||||
(do
|
||||
(Project.config "title" "path")
|
||||
(Project.config "docs-directory" "./docs/")
|
||||
(Project.config "docs-logo" "")
|
||||
(Project.config "docs-styling" "style.css")
|
||||
(Project.config "docs-generate-index" false)
|
||||
(save-docs Path)))
|
||||
(Project.config "title" "path")
|
||||
(Project.config "docs-directory" "./docs/")
|
||||
(Project.config "docs-logo" "")
|
||||
(Project.config "docs-styling" "style.css")
|
||||
(Project.config "docs-generate-index" false)
|
||||
(save-docs Path)
|
||||
|
||||
(gendocs)
|
||||
(quit)
|
||||
|
||||
16
path.carp
16
path.carp
@@ -3,7 +3,7 @@
|
||||
## Installation
|
||||
|
||||
```clojure
|
||||
(load \"https://veitheller.de/git/carpentry/path@0.0.2\")
|
||||
(load \"git@git.veitheller.de:carpentry/path.git@0.0.4\")
|
||||
```
|
||||
|
||||
### Usage
|
||||
@@ -16,7 +16,7 @@ It assumes either Windows or POSIX-style separators.")
|
||||
(defmodule Path
|
||||
(doc absolute? "checks whether a path is absolute.
|
||||
|
||||
As such, it is the inverse to [relative](#relative).")
|
||||
As such, it is the inverse to [relative?](#relative?).")
|
||||
(doc separator "is the default separator we use on this OS.")
|
||||
(doc separators "is the possible separators we could use on this OS.")
|
||||
(doc search-path-separator "is the separator for the `PATH` environment
|
||||
@@ -32,7 +32,7 @@ variable we use on this OS.")
|
||||
(def search-path-separator \;)
|
||||
(def extension-pat #"\.[^\\/\.]*$")
|
||||
(def sep-string "\\"))
|
||||
(not-on-windows
|
||||
(posix-only
|
||||
(defn absolute? [p] (String.starts-with? p "/"))
|
||||
(def separator \/)
|
||||
(def separators [\/])
|
||||
@@ -42,7 +42,7 @@ variable we use on this OS.")
|
||||
|
||||
(doc relative? "checks whether a path is relative.
|
||||
|
||||
As such, it is the inverse to [absolute](#absolute).")
|
||||
As such, it is the inverse to [absolute?](#absolute?).")
|
||||
(defn relative? [p] (not (absolute? p)))
|
||||
|
||||
(doc separator? "checks whether the character `c` is a path separator on this
|
||||
@@ -127,9 +127,9 @@ Examples on POSIX:
|
||||
(doc drop-extension "drops the extension of a path `p`. Does nothing if there
|
||||
is none.")
|
||||
(defn drop-extension [p]
|
||||
@(match (split-extension p)
|
||||
(Maybe.Nothing) p
|
||||
(Maybe.Just pair) (Pair.a &pair)))
|
||||
(match (split-extension p)
|
||||
(Maybe.Nothing) @p
|
||||
(Maybe.Just pair) @(Pair.a &pair)))
|
||||
|
||||
(doc add-extension "adds an extension `ext` to a path `p`.")
|
||||
(defn add-extension [p ext] (String.concat &[@p @"." @ext]))
|
||||
@@ -148,5 +148,5 @@ an extension if there previously was none.")
|
||||
(defn split-search-path [p] (String.split-by p &[search-path-separator]))
|
||||
(doc get-search-path "gets the `PATH` environment variable and splits it.")
|
||||
(defn get-search-path []
|
||||
(Maybe.apply (IO.getenv @"PATH") &(fn [p] (split-search-path &p))))
|
||||
(Maybe.apply (IO.getenv "PATH") &(fn [p] (split-search-path &p))))
|
||||
)
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
(use-all Path Test)
|
||||
|
||||
(if (not (Dynamic.or (= "windows" (os)) (= "mingw32" (os))))
|
||||
(posix-only
|
||||
(deftest test
|
||||
(assert-equal test
|
||||
"path/joined"
|
||||
@@ -41,11 +41,11 @@
|
||||
"cwd works"
|
||||
)
|
||||
; TODO why does this test not work?
|
||||
;(assert-equal test
|
||||
; "file"
|
||||
; &(drop-extension "file.txt")
|
||||
; "drop-extension works if there is an extension"
|
||||
;)
|
||||
(assert-equal test
|
||||
"file"
|
||||
&(drop-extension "file.txt")
|
||||
"drop-extension works if there is an extension"
|
||||
)
|
||||
(assert-equal test
|
||||
"file"
|
||||
&(drop-extension "file")
|
||||
@@ -87,7 +87,7 @@
|
||||
)
|
||||
)
|
||||
())
|
||||
(if (Dynamic.or (= "windows" (os)) (= "mingw32" (os)))
|
||||
(windows-only
|
||||
(deftest test
|
||||
(assert-true test
|
||||
false
|
||||
|
||||
Reference in New Issue
Block a user