You are looking at historical revision 12293 of this page. It may differ significantly from its current revision.
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
[procedure] (filepath:posix [BOOL]) => BOOLIf 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.
[procedure] (filepath:is-windows?) => BOOLConvenience function that returns the inverse of (filepath:posix).
[procedure] (filepath:is-posix?) => BOOLConvenience function that returns the result of (filepath:posix).
Path Separators
[procedure] (filepath:path-separator) => CHARThe character that separates directories. On platforms where more than one character is possible, this procedure returns the default one.
[procedure] (filepath:path-separator-set) => CHAR-SETThe set of all possible path separator characters.
[procedure] (filepath:is-path-separator? CHAR) => BOOLA predicate that returns whether the given character is a path separator for the current platform.
[procedure] (filepath:search-path-separator) => CHARThe character that is used to separate the entries in the PATH environment variable.
[procedure] (filepath:is-search-path-separator? CHAR) => BOOLA predicate that returns whether the given character can be used a separator in the PATH environment variable.
[procedure] (filepath:ext-separator) => CHARThe character that is used to separate file extensions.
[procedure] (filepath:is-ext-separator? CHAR) => BOOLA predicate that returns whether the given character is a file extension separator.
Search Path
[procedure] (filepath:split-search-path STRING) => LISTSplits a string on the search path separator character.
[procedure] (filepath:get-search-path) => STRINGReturns search path from the OS environment.
Extension procedures
[procedure] (filepath:split-extension PATH) => (NAME EXT)Splits path on the last extension.
[procedure] (filepath:take-extension PATH) => EXTReturns last extension of given path, or empty string.
[procedure] (filepath:replace-extension PATH EXT) => PATHReplaces the last path extension with the given extension.
[procedure] (filepath:drop-extension PATH) => PATHRemoves last extension and extension separator preceding it.
[procedure] (filepath:add-extension PATH EXT) => PATHAppends an extension to the given path.
[procedure] (filepath:has-extension? PATH) => BOOLReturns true if the given path has an extension.
[procedure] (filepath:split-all-extensions PATH) => (NAME EXT)
Splits path on the first extension.
[procedure] (filepath:drop-all-extensions PATH) => PATHRemoves all extensions from the path.
[procedure] (filepath:take-all-extensions PATH) => EXTReturns all extensions from the path.
Drive procedures
[procedure] filepath:split-drive[procedure] filepath:join-drive
[procedure] filepath:take-drive
[procedure] filepath:has-drive?
[procedure] filepath:drop-drive
[procedure] filepath:is-drive?
Operations on a file path
[procedure] filepath:split-file-name[procedure] filepath:take-file-name
[procedure] filepath:replace-file-name
[procedure] filepath:drop-file-name
[procedure] filepath:take-base-name
[procedure] filepath:replace-base-name
[procedure] filepath:take-directory
[procedure] filepath:replace-directory
[procedure] filepath:combine
[procedure] filepath:split-path
[procedure] filepath:join-path
[procedure] filepath:split-directories
Trailing Separators
[procedure] filepath:has-trailing-path-separator?[procedure] filepath:add-trailing-path-separator
[procedure] filepath:drop-trailing-path-separator
File Name Normalization
[procedure] filepath:normalise[procedure] filepath:path-equal?
[procedure] filepath:make-relative
[procedure] filepath:is-relative?
[procedure] filepath:is-absolute?
[procedure] filepath:is-valid?
[procedure] filepath:make-valid
Requires
Version History
- 1.0 Initial Release
License
Based on the Haskell FilePath library by Neil Mitchell.
Copyright 2008 Ivan Raikov.
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.