The com.gigamonkeys.pathnames Reference Manual

This is the com.gigamonkeys.pathnames Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:33:53 2022 GMT+0.

Table of Contents


1 Systems

The main system appears first, followed by any subsystem dependency.


1.1 com.gigamonkeys.pathnames

Library to smooth over some implementation differences in treatment of pathnames.

Author

Peter Seibel <>

Source

com.gigamonkeys.pathnames.asd.

Child Components

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


2.1 Lisp


2.1.1 com.gigamonkeys.pathnames/com.gigamonkeys.pathnames.asd

Source

com.gigamonkeys.pathnames.asd.

Parent Component

com.gigamonkeys.pathnames (system).

ASDF Systems

com.gigamonkeys.pathnames.


2.1.2 com.gigamonkeys.pathnames/packages.lisp

Source

com.gigamonkeys.pathnames.asd.

Parent Component

com.gigamonkeys.pathnames (system).

Packages

com.gigamonkeys.pathnames.


2.1.3 com.gigamonkeys.pathnames/pathnames.lisp

Dependency

packages.lisp (file).

Source

com.gigamonkeys.pathnames.asd.

Parent Component

com.gigamonkeys.pathnames (system).

Public Interface
Internals

directory-wildcard (function).


3 Packages

Packages are listed by definition order.


3.1 com.gigamonkeys.pathnames

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

directory-wildcard (function).


4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


4.1 Public Interface


4.1.1 Ordinary functions

Function: directory-p (name)

Is ‘name’ the name of an existing directory.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: directory-pathname-p (p)

Is the given pathname the name of a directory? This function can usefully be used to test whether a name returned by LIST-DIRECTORIES or passed to the function in WALK-DIRECTORY is the name of a directory in the file system since they always return names in ‘directory normal form’.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: file-exists-p (pathname)

Similar to CL:PROBE-FILE except it always returns directory names in ‘directory normal form’. Returns truename which will be in ‘directory form’ if file named is, in fact, a directory.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: file-p (name)

Is ‘name’ the name of an existing file, i.e. not a directory.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: file-pathname-p (p)
Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: list-directory (dirname)

Return a list of the contents of the directory named by dirname. Names of subdirectories will be returned in ‘directory normal form’. Unlike CL:DIRECTORY, LIST-DIRECTORY does not accept wildcard pathnames; ‘dirname’ should simply be a pathname that names a directory. It can be in either file or directory form.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: parent-directory (pathname)

Return the pathname of the directory containing pathname.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: pathname-as-directory (name)

Return a pathname reperesenting the given pathname in ‘directory normal form’, i.e. with all the name elements in the directory component and NIL in the name and type components. Can not be used on wild pathnames because there’s not portable way to convert wildcards in the name and type into a single directory component. Returns its argument if name and type are both nil or :unspecific.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: pathname-as-file (name)

Return a pathname reperesenting the given pathname in ‘file form’, i.e. with the name elements in the name and type component. Can’t convert wild pathnames because of problems mapping wild directory component into name and type components. Returns its argument if it is already in file form.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.

Function: walk-directory (dirname fn &key directories test)

Walk a directory invoking ‘fn’ on each pathname found. If ‘test’ is supplied fn is invoked only on pathnames for which ‘test’ returns true. If ‘directories’ is t invokes ‘test’ and ‘fn’ on directory pathnames as well.

Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.


4.2 Internals


4.2.1 Ordinary functions

Function: directory-wildcard (dirname)
Package

com.gigamonkeys.pathnames.

Source

pathnames.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables