The monkeylib-pathnames Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The monkeylib-pathnames Reference Manual

This is the monkeylib-pathnames Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 15:22:12 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 com.gigamonkeys.pathnames

Author

Peter Seibel <peter@gigamonkeys.com>

Description

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

Source

com.gigamonkeys.pathnames.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 com.gigamonkeys.pathnames.asd

Location

com.gigamonkeys.pathnames.asd

Systems

com.gigamonkeys.pathnames (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 com.gigamonkeys.pathnames/packages.lisp

Parent

com.gigamonkeys.pathnames (system)

Location

packages.lisp

Packages

com.gigamonkeys.pathnames


Previous: , Up: Lisp files   [Contents][Index]

2.1.3 com.gigamonkeys.pathnames/pathnames.lisp

Dependency

packages.lisp (file)

Parent

com.gigamonkeys.pathnames (system)

Location

pathnames.lisp

Exported Definitions
Internal Definitions

directory-wildcard (function)


Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 com.gigamonkeys.pathnames

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

directory-wildcard (function)


Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Functions

Function: directory-p NAME

Is ‘name’ the name of an existing directory.

Package

com.gigamonkeys.pathnames

Source

pathnames.lisp (file)

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 (file)

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 (file)

Function: file-p NAME

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

Package

com.gigamonkeys.pathnames

Source

pathnames.lisp (file)

Function: file-pathname-p P
Package

com.gigamonkeys.pathnames

Source

pathnames.lisp (file)

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 (file)

Function: parent-directory PATHNAME

Return the pathname of the directory containing pathname.

Package

com.gigamonkeys.pathnames

Source

pathnames.lisp (file)

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 (file)

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 (file)

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 (file)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Functions

Function: directory-wildcard DIRNAME
Package

com.gigamonkeys.pathnames

Source

pathnames.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
com.gigamonkeys.pathnames.asd: The com<dot>gigamonkeys<dot>pathnames<dot>asd file
com.gigamonkeys.pathnames/packages.lisp: The com<dot>gigamonkeys<dot>pathnames/packages<dot>lisp file
com.gigamonkeys.pathnames/pathnames.lisp: The com<dot>gigamonkeys<dot>pathnames/pathnames<dot>lisp file

F
File, Lisp, com.gigamonkeys.pathnames.asd: The com<dot>gigamonkeys<dot>pathnames<dot>asd file
File, Lisp, com.gigamonkeys.pathnames/packages.lisp: The com<dot>gigamonkeys<dot>pathnames/packages<dot>lisp file
File, Lisp, com.gigamonkeys.pathnames/pathnames.lisp: The com<dot>gigamonkeys<dot>pathnames/pathnames<dot>lisp file

L
Lisp File, com.gigamonkeys.pathnames.asd: The com<dot>gigamonkeys<dot>pathnames<dot>asd file
Lisp File, com.gigamonkeys.pathnames/packages.lisp: The com<dot>gigamonkeys<dot>pathnames/packages<dot>lisp file
Lisp File, com.gigamonkeys.pathnames/pathnames.lisp: The com<dot>gigamonkeys<dot>pathnames/pathnames<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   D   F   L   P   W  
Index Entry  Section

D
directory-p: Exported functions
directory-pathname-p: Exported functions
directory-wildcard: Internal functions

F
file-exists-p: Exported functions
file-p: Exported functions
file-pathname-p: Exported functions
Function, directory-p: Exported functions
Function, directory-pathname-p: Exported functions
Function, directory-wildcard: Internal functions
Function, file-exists-p: Exported functions
Function, file-p: Exported functions
Function, file-pathname-p: Exported functions
Function, list-directory: Exported functions
Function, parent-directory: Exported functions
Function, pathname-as-directory: Exported functions
Function, pathname-as-file: Exported functions
Function, walk-directory: Exported functions

L
list-directory: Exported functions

P
parent-directory: Exported functions
pathname-as-directory: Exported functions
pathname-as-file: Exported functions

W
walk-directory: Exported functions

Jump to:   D   F   L   P   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
com.gigamonkeys.pathnames: The com<dot>gigamonkeys<dot>pathnames system
com.gigamonkeys.pathnames: The com<dot>gigamonkeys<dot>pathnames package

P
Package, com.gigamonkeys.pathnames: The com<dot>gigamonkeys<dot>pathnames package

S
System, com.gigamonkeys.pathnames: The com<dot>gigamonkeys<dot>pathnames system

Jump to:   C   P   S