This is the path-string Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:19:07 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
path-string
A path utility library
Cayman Nava
MIT
# path-string
[![Build Status](https://travis-ci.org/wemeetagain/path-string.svg?branch=master)](https://travis-ci.org/wemeetagain/path-string)
[![Coverage Status](https://coveralls.io/repos/wemeetagain/path-string/badge.svg?branch=master&service=github)](https://coveralls.io/github/wemeetagain/path-string?branch=master)
Path string utility library based on nodejs’ [path](https://nodejs.org/api/path.html).
> This module contains utilities for handling and transforming file paths. Almost all these methods perform only string transformations. The file system is not consulted to check whether paths are valid.
The windows-compatible version has yet to be implemented.
## Examples
“‘lisp
(path-string:normalize "/foo/bar//baz/asdf/quux/..")
;; => "/foo/bar/baz/asdf"
(path-string:join "/foo" "bar" "baz/asdf" "quux" "..")
;; => "/foo/bar/baz/asdf"
(path-string:resolve "foo/bar" "/tmp/file/" ".." "a/../subfile")
;; => "/tmp/subfile"
(path-string:absolute-p "/tmp/file")
;; => #P"/tmp/file"
(path-string:relative "/data/orandea/test/aaa" "/data/orandea/impl/bbb")
;; => "../../impl/bbb"
(path-string:dirname "/foo/bar/baz/asdf/quux")
;; => "/foo/bar/baz/asdf"
(path-string:basename "/foo/bar/baz/asdf/quux.html")
;; => "quux.html"
(path-string:extname "index.html")
;; => ".html"
(path-string:parse "/home/user/dir/file.txt")
;; => "/"
;; "/home/user/dir"
;; "file.txt"
;; ".txt"
;; "file"
“‘
## License
MIT
0.1.0
cl-ppcre
(system).
split-sequence
(system).
uiop
(system).
src
(module).
Modules are listed depth-first from the system components tree.
path-string/src
path-string
(system).
util.lisp
(file).
posix.lisp
(file).
path-string.lisp
(file).
documentation.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
path-string/path-string.asd
path-string/src/util.lisp
path-string/src/posix.lisp
path-string/src/path-string.lisp
path-string/src/documentation.lisp
path-string/src/util.lisp
src
(module).
*posix-split-path-re*
(special variable).
normalize-list
(function).
posix-format-path
(function).
posix-join-components
(function).
posix-split-path
(function).
trim-list
(function).
path-string/src/posix.lisp
path-string/src/path-string.lisp
posix.lisp
(file).
src
(module).
path-string/src/documentation.lisp
path-string.lisp
(file).
src
(module).
Packages are listed by definition order.
path-string.util
common-lisp
.
*posix-split-path-re*
(special variable).
normalize-list
(function).
posix-format-path
(function).
posix-join-components
(function).
posix-split-path
(function).
trim-list
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The platform-specific path delimiter, ’;’ or ’;’.
The platform-specific file separator, ’\’ or ’/’.
Determines whether the path is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
Return the last portion of a path. Similar to the Unix baseline command.
Return the directory name of a path. Similar to the Unix dirname command.
Return the extension of the path, from the last ’.’ to the end of the
string in the last portion of the path. If there is no ’.’ in the last
portion of the path or the first character of it is ’.’, then then return
an empty string.
Join all arguments together and normalize the resulting path.
Normalize a path string, taking care of ’..’ and ’.’ parts.
Returns a list of path pieces (ROOT DIR BASE EXT NAME) from a path string.
Solve the relative path from FROM to TO.
Resolves the last argument to an absolute path
Jump to: | A B D E F J N P R T |
---|
Jump to: | A B D E F J N P R T |
---|
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Jump to: | D F M P S U |
---|
Jump to: | D F M P S U |
---|