filepath

TOC »

filepath

Description

The filepath library contains procedures for cross-platform parsing and manipulation of file paths. It supports both Windows and POSIX paths, including Windows share paths.

Library Procedures

Platform Flags

(filepath:posix [BOOL]) => BOOL procedure: If invoked without arguments, this procedure returns whether the library procedures assume POSIX-style paths or not. Invoking the procedure with a boolean argument disables or enables POSIX-style paths. If set to false, the library procedures assume Windows-style paths.

(filepath:is-windows?) => BOOL procedure: Convenience function that returns the inverse of (filepath:posix).

(filepath:is-posix?) => BOOL procedure: Convenience function that returns the result of (filepath:posix).

Path Separators

(filepath:path-separator) => CHAR procedure: The character that separates directories. On platforms where more than one character is possible, this procedure returns the default one.

(filepath:path-separator-set) => CHAR-SET procedure: The set of all possible path separator characters.

(filepath:is-path-separator? CHAR) => BOOL procedure: A predicate that returns whether the given character is a path separator for the current platform.

(filepath:search-path-separator) => CHAR procedure: The character that is used to separate the entries in the PATH environment variable.

(filepath:is-search-path-separator? CHAR) => BOOL procedure: A predicate that returns whether the given character can be used a separator in the PATH environment variable.

(filepath:ext-separator) => CHAR procedure: The character that is used to separate file extensions.

(filepath:is-ext-separator? CHAR) => BOOL procedure: A predicate that returns whether the given character is a file extension separator.

Search Path

(filepath:split-search-path STRING) => LIST procedure: Splits a string on the search path separator character.

(filepath:get-search-path) => STRING procedure: Returns search path from the OS environment.

Extension procedures

(filepath:split-extension PATH) => (NAME EXT) procedure: Splits path on the last extension.

(filepath:take-extension PATH) => EXT procedure: Returns last extension of given path, or empty string.

(filepath:replace-extension PATH EXT) => PATH procedure: Replaces the last path extension with the given extension.

(filepath:drop-extension PATH) => PATH procedure: Removes last extension and extension separator preceding it.

(filepath:add-extension PATH EXT) => PATH procedure: Appends an extension to the given path.

(filepath:has-extension? PATH) => BOOL procedure: Returns true if the given path has an extension.

(filepath:split-all-extensions PATH) => (NAME EXT) procedure: Splits path on the first extension.

(filepath:drop-all-extensions PATH) => PATH procedure: Removes all extensions from the path.

(filepath:take-all-extensions PATH) => EXT procedure: Returns all extensions from the path.

Drive procedures

filepath:split-drive procedure: Splits a path into a Windows drive and a path. When in POSIX mode, / is treated as a drive.

(filepath:join-drive DRIVE PATH) => PATH procedure: Joins a drive and the rest of the path.

(filepath:take-drive PATH) => DRIVE procedure: Returns the drive of a path.

(filepath:has-drive? PATH) => BOOL procedure: Returns whether the given path has a drive.

(filepath:drop-drive PATH) => PATH procedure: Removes the drive from the given path.

(filepath:is-drive? STRING) => BOOL procedure: Returns true if the given string is a drive specification.

Operations on a file path

(filepath:split-file-name PATH) => (DIR FILE) procedure: Splits a path into directory and file.

(filepath:take-file-name PATH) => FILE procedure: Returns the filename component of a path.

(filepath:replace-file-name PATH FILE) => PATH procedure: Replaces the filename component of a path with the given one.

(filepath:drop-file-name PATH) => PATH procedure: Removes the filename component of a path.

(filepath:take-base-name PATH) => STRING procedure: Returns the base file name (no extension) of a path.

(filepath:replace-base-name PATH BASE) => PATH procedure: Replaces the base file name of a path with the given one.

(filepath:take-directory PATH) => DIR procedure: Returns the directory component of a path.

(filepath:replace-directory PATH DIR) => PATH procedure: Replaces the directory component of a path with the given one.

(filepath:combine PATH1 PATH2) => PATH procedure: Combines two paths. If the second path is absolute, then it returns the second.

(filepath:split-path PATH) => LIST procedure: Splits a path by the directory separator.

(filepath:join-path LIST) => PATH procedure: Joins path elements back together.

filepath:split-directories procedure: As split-path, but does not add trailing separators to each element.

Trailing Separators

(filepath:has-trailing-path-separator? PATH) => BOOL procedure

(filepath:add-trailing-path-separator PATH) => PATH procedure

(filepath:drop-trailing-path-separator PATH) => PATH procedure

File Name Normalization and Predicates

(filepath:normalise PATH) => PATH procedure

(filepath:path-equal? PATH1 PATH2) => BOOL procedure

(filepath:make-relative ROOT PATH) => PATH procedure

(filepath:is-relative? PATH) => BOOL procedure

(filepath:is-absolute? PATH) => BOOL procedure

(filepath:is-valid? PATH) => BOOL procedure

(filepath:make-valid PATH) => PATH procedure

Version History

1.5 Fixed a bug in is-relative? (thanks to Christian Kellermann for reporting)
1.3 Ensure that unit test scripts returns proper exit code
1.2.2 Added test as a test dependency
1.2.1 Changed import to require-extension
1.2 Fix in filepath:posix
1.1 Ported to Chicken 4
1.0 Initial Release

License

Based on the Haskell FilePath library by Neil Mitchell.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND THE CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

chickadee » filepath

Identifier search