The illogical-pathnames Reference Manual

This is the illogical-pathnames Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 06:24:49 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 illogical-pathnames

Mostly filesystem-position-independent pathnames.

Author

Robert Smith <>

License

BSD 3-clause (See illogical-pathnames.lisp)

Version

1.0.1

Source

illogical-pathnames.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 illogical-pathnames/illogical-pathnames.asd

Source

illogical-pathnames.asd.

Parent Component

illogical-pathnames (system).

ASDF Systems

illogical-pathnames.


3.2 Static


3.2.1 illogical-pathnames/README.txt

Source

illogical-pathnames.asd.

Parent Component

illogical-pathnames (system).


4 Packages

Packages are listed by definition order.


5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: define-illogical-host (host directory &optional documentation)

Define the illogical host HOST to the absolute directory DIRECTORY.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.


5.1.2 Ordinary functions

Function: disable-illogical-pathname-syntax ()

Disable illogical pathname syntax.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: enable-illogical-pathname-syntax ()

Enable illogical pathname syntax.

#P"..." ; traditional pathname syntax

#P(<illogical-host> (<directory name>*) <filename>?)

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: illogical-host-translation (illogical-host)

Translate the illogical host ILLOGICAL-HOST to its defined absolute directory.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: (setf illogical-host-translation) (illogical-host)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Reader: illogical-pathname-directory (instance)
Writer: (setf illogical-pathname-directory) (instance)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Target Slot

directory.

Reader: illogical-pathname-host (instance)
Writer: (setf illogical-pathname-host) (instance)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Target Slot

host.

Reader: illogical-pathname-name (instance)
Writer: (setf illogical-pathname-name) (instance)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Target Slot

name.

Function: illogical-pathname-p (object)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Reader: illogical-pathname-type (instance)
Writer: (setf illogical-pathname-type) (instance)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Target Slot

type.

Function: make-illogical-pathname (&key host directory name type)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: translate-illogical-pathname (illogical-pathname)

Translate the illogical pathname ILLOGICAL-PATHNAME to its equivalent absolute pathname.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.


5.1.3 Standalone methods

Method: make-load-form ((self illogical-pathname) &optional environment)
Source

illogical-pathnames.lisp.


5.1.4 Structures

Structure: illogical-pathname
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Direct superclasses

structure-object.

Direct methods

make-load-form.

Direct slots
Slot: host
Readers

illogical-pathname-host.

Writers

(setf illogical-pathname-host).

Slot: directory
Package

common-lisp.

Readers

illogical-pathname-directory.

Writers

(setf illogical-pathname-directory).

Slot: name
Readers

illogical-pathname-name.

Writers

(setf illogical-pathname-name).

Slot: type
Package

common-lisp.

Readers

illogical-pathname-type.

Writers

(setf illogical-pathname-type).


5.1.5 Types

Type: illogical-host ()

The type of an illogical host object.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *common-lisp-sharp-p*
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Special Variable: *illogical-hosts*

Association between ILLOGICAL-HOSTs and their pathname translation.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.


5.2.2 Ordinary functions

Function: component-present-p (value)

Helper function for DIRECTORY-PATHNAME-P which checks whether VALUE is neither NIL nor the keyword :UNSPECIFIC.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: copy-illogical-pathname (instance)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: directory-pathname-p (pathspec)

Returns NIL if PATHSPEC (a pathname designator) does not designate a directory, PATHSPEC otherwise. It is irrelevant whether file or directory designated by PATHSPEC does actually exist.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: illogical-#p-reader (stream subchar arg)

Reader for illogical pathnames. Returns an illogical pathname.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: illogical-pathname-relative-pathname (illogical-pathname)

Convert the illogical pathname ILLOGICAL-PATHNAME to its representative relative pathname.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: new-#p-reader (stream subchar arg)
Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: pathname-absolute-p (a)

Returns true if A is an absolute pathname.

This simply tests if A’s directory list starts with :ABSOLUTE

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.

Function: pathname-as-file (pathspec)

Converts the non-wild pathname designator PATHSPEC to file form.

Package

illogical-pathnames.

Source

illogical-pathnames.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   E   F   I   M   N   P   T  
Index Entry  Section

(
(setf illogical-host-translation): Public ordinary functions
(setf illogical-pathname-directory): Public ordinary functions
(setf illogical-pathname-host): Public ordinary functions
(setf illogical-pathname-name): Public ordinary functions
(setf illogical-pathname-type): Public ordinary functions

C
component-present-p: Private ordinary functions
copy-illogical-pathname: Private ordinary functions

D
define-illogical-host: Public macros
directory-pathname-p: Private ordinary functions
disable-illogical-pathname-syntax: Public ordinary functions

E
enable-illogical-pathname-syntax: Public ordinary functions

F
Function, (setf illogical-host-translation): Public ordinary functions
Function, (setf illogical-pathname-directory): Public ordinary functions
Function, (setf illogical-pathname-host): Public ordinary functions
Function, (setf illogical-pathname-name): Public ordinary functions
Function, (setf illogical-pathname-type): Public ordinary functions
Function, component-present-p: Private ordinary functions
Function, copy-illogical-pathname: Private ordinary functions
Function, directory-pathname-p: Private ordinary functions
Function, disable-illogical-pathname-syntax: Public ordinary functions
Function, enable-illogical-pathname-syntax: Public ordinary functions
Function, illogical-#p-reader: Private ordinary functions
Function, illogical-host-translation: Public ordinary functions
Function, illogical-pathname-directory: Public ordinary functions
Function, illogical-pathname-host: Public ordinary functions
Function, illogical-pathname-name: Public ordinary functions
Function, illogical-pathname-p: Public ordinary functions
Function, illogical-pathname-relative-pathname: Private ordinary functions
Function, illogical-pathname-type: Public ordinary functions
Function, make-illogical-pathname: Public ordinary functions
Function, new-#p-reader: Private ordinary functions
Function, pathname-absolute-p: Private ordinary functions
Function, pathname-as-file: Private ordinary functions
Function, translate-illogical-pathname: Public ordinary functions

I
illogical-#p-reader: Private ordinary functions
illogical-host-translation: Public ordinary functions
illogical-pathname-directory: Public ordinary functions
illogical-pathname-host: Public ordinary functions
illogical-pathname-name: Public ordinary functions
illogical-pathname-p: Public ordinary functions
illogical-pathname-relative-pathname: Private ordinary functions
illogical-pathname-type: Public ordinary functions

M
Macro, define-illogical-host: Public macros
make-illogical-pathname: Public ordinary functions
make-load-form: Public standalone methods
Method, make-load-form: Public standalone methods

N
new-#p-reader: Private ordinary functions

P
pathname-absolute-p: Private ordinary functions
pathname-as-file: Private ordinary functions

T
translate-illogical-pathname: Public ordinary functions