The defsystem-compatibility Reference Manual

Table of Contents

The defsystem-compatibility Reference Manual

This is the defsystem-compatibility Reference Manual, version 0.1.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:53:20 2021 GMT+0.

1 Systems

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

1.1 defsystem-compatibility

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT Style license

Description

Make many defsystems look the same!

Version

0.1.2

Dependency

metatilities-base

Source

defsystem-compatibility.asd (file)

Components

• dev (module)
• website (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 defsystem-compatibility/dev

Parent

defsystem-compatibility (system)

Location

dev/

Components

• package.lisp (file)
• api.lisp (file)
• defsystem-compatibility.lisp (file)
• asdf.lisp (file)

2.2 defsystem-compatibility/website

Parent

defsystem-compatibility (system)

Location

website/

Component

source (module)

2.3 defsystem-compatibility/website/source

Parent

website (module)

Location

website/source/

Component

index.lml (file)

3 Files

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

3.1 Lisp

3.1.1 defsystem-compatibility.asd

Location

defsystem-compatibility.asd

Systems

defsystem-compatibility (system)

Packages

defsystem-compatibility-system

3.1.2 defsystem-compatibility/dev/package.lisp

Parent

dev (module)

Location

dev/package.lisp

Packages

defsystem-compatibility

3.1.3 defsystem-compatibility/dev/api.lisp

Dependency

package.lisp (file)

Parent

dev (module)

Location

dev/api.lisp

Exported Definitions

map-system-files (generic function)

Internal Definitions

• associated-test-system* (generic function)
• available-systems* (generic function)
• ensure-system-name* (generic function)
• filename-looks-like-system-file-p* (generic function)
• find-system* (generic function)
• loaded-systems* (generic function)
• registered-systems* (generic function)
• system-dependencies* (generic function)
• system-loaded-p* (generic function)
• system-name-for-display* (generic function)
• system-property* (generic function)
• system-source-file* (generic function)
• system-sub-systems* (generic function)
• top-level-system-p* (generic function)

3.1.4 defsystem-compatibility/dev/defsystem-compatibility.lisp

Dependency

api.lisp (file)

Parent

dev (module)

Location

dev/defsystem-compatibility.lisp

Exported Definitions

• associated-test-system (function)
• available-systems (function)
• collect-system-dependencies (function)
• collect-system-files (function)
• ensure-system-name (function)
• filename-looks-like-system-file-p (function)
• find-system (function)
• loaded-systems (function)
• map-system-dependencies (function)
• map-system-files (method)
• map-system-files (method)
• map-system-files (method)
• pathname-for-system-file (function)
• registered-systems (function)
• system-definer-not-found-error (condition)
• system-dependencies (function)
• system-loaded-p (function)
• system-name (method)
• system-name-for-display (function)
• system-property (function)
• system-relative-pathname (function)
• system-signature (function)
• system-source-directory (function)
• system-source-file (function)
• system-sub-systems (function)
• top-level-system-p (function)

Internal Definitions

• *pathname-cache* (special variable)
• *pathname-separator* (special variable)
• *prefered-definer-for-systems* (special variable)
• *prefered-system-definer* (special variable)
• ensure-pathname-separator-defined (function)
• ensure-string (function)
• find-system* (method)
• find-system* (method)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer% (function)

3.1.5 defsystem-compatibility/dev/asdf.lisp

Dependency

api.lisp (file)

Parent

dev (module)

Location

dev/asdf.lisp

Internal Definitions

• %map-system-files (method)
• %map-system-files (method)
• %map-system-files (method)
• %map-system-files (method)
• %map-system-files (method)
• *ignore-errors?* (special variable)
• *relative-pathname* (special variable)
• associated-test-system* (method)
• available-systems* (method)
• compute-relative-pathname-extension (method)
• compute-relative-pathname-extension (method)
• compute-relative-pathname-extension (method)
• ensure-system-name* (method)
• ensure-system-name* (method)
• ensure-system-name* (method)
• extend-relative-pathname (method)
• filename-looks-like-system-file-p* (method)
• handle-file (function)
• loaded-systems* (method)
• registered-systems* (method)
• safe-slot-value (function)
• select-system-definer (method)
• system-dependencies* (method)
• system-name-for-display* (method)
• system-property* (method)
• system-source-file* (method)
• system-sub-systems* (method)
• top-level-system-p* (method)

3.2 Static

3.2.1 defsystem-compatibility/website/source/index.lml

Parent

source (module)

Location

website/source/index.lml

4 Packages

Packages are listed by definition order.

4.1 defsystem-compatibility-system

Source

defsystem-compatibility.asd

Use List

• asdf/interface
• common-lisp

4.2 defsystem-compatibility

Source

package.lisp (file)

Nickname

dsc

Use List

common-lisp

Exported Definitions

• associated-test-system (function)
• available-systems (function)
• collect-system-dependencies (function)
• collect-system-files (function)
• ensure-system-name (function)
• filename-looks-like-system-file-p (function)
• find-system (function)
• loaded-systems (function)
• map-system-dependencies (function)
• map-system-files (generic function)
• map-system-files (method)
• map-system-files (method)
• map-system-files (method)
• pathname-for-system-file (function)
• registered-systems (function)
• system-definer-not-found-error (condition)
• system-dependencies (function)
• system-loaded-p (function)
• system-name (generic function)
• system-name (method)
• system-name-for-display (function)
• system-property (function)
• system-relative-pathname (function)
• system-signature (function)
• system-source-directory (function)
• system-source-file (function)
• system-sub-systems (function)
• top-level-system-p (function)

Internal Definitions

• %map-system-files (generic function)
• %map-system-files (method)
• %map-system-files (method)
• %map-system-files (method)
• %map-system-files (method)
• %map-system-files (method)
• *ignore-errors?* (special variable)
• *pathname-cache* (special variable)
• *pathname-separator* (special variable)
• *prefered-definer-for-systems* (special variable)
• *prefered-system-definer* (special variable)
• *relative-pathname* (special variable)
• associated-test-system* (generic function)
• associated-test-system* (method)
• available-systems* (generic function)
• available-systems* (method)
• compute-relative-pathname-extension (generic function)
• compute-relative-pathname-extension (method)
• compute-relative-pathname-extension (method)
• compute-relative-pathname-extension (method)
• ensure-pathname-separator-defined (function)
• ensure-string (function)
• ensure-system-name* (generic function)
• ensure-system-name* (method)
• ensure-system-name* (method)
• ensure-system-name* (method)
• extend-relative-pathname (generic function)
• extend-relative-pathname (method)
• filename-looks-like-system-file-p* (generic function)
• filename-looks-like-system-file-p* (method)
• find-system* (generic function)
• find-system* (method)
• find-system* (method)
• handle-file (function)
• loaded-systems* (generic function)
• loaded-systems* (method)
• registered-systems* (generic function)
• registered-systems* (method)
• safe-slot-value (function)
• select-system-definer (generic function)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer (method)
• select-system-definer% (function)
• system-dependencies* (generic function)
• system-dependencies* (method)
• system-loaded-p* (generic function)
• system-name-for-display* (generic function)
• system-name-for-display* (method)
• system-property* (generic function)
• system-property* (method)
• system-source-file* (generic function)
• system-source-file* (method)
• system-sub-systems* (generic function)
• system-sub-systems* (method)
• top-level-system-p* (generic function)
• top-level-system-p* (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: associated-test-system SYSTEM-NAME

Returns the name of the system that should be used to test system-name or nil if no such system exists.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: available-systems ()

Returns a list of the names of all of the systems that could be found for the default system definer.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: collect-system-dependencies SYSTEMS &key IGNORE-ERRORS?

What’s in a name...? This form attempts to find and load all of the referenced system files starting with any systems in systems. It does not include the systems themselves unless they are syb-systems of some other system in the list.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: collect-system-files SYSTEM/S &key SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE? INCLUDE-FILES? OPTIONS

Returns a list of the files in system/s. See map-system-files for a discussion of the arguments.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: ensure-system-name SYSTEM-NAME

Returns the canonical representation of the system’s name.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: filename-looks-like-system-file-p FILENAME

Returns true if filename looks like a system file for the defaults system-definer. This is based only on the syntax if the file’s name, not on the contents of the file.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: find-system SYSTEM-NAME

Returns the system definition of system-name for its system-definer or nil if no such system exists.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: loaded-systems ()

Returns a list of the names of the systems that are currently loaded for the default system-definer.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: map-system-dependencies SYSTEMS FN

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: pathname-for-system-file SYSTEM FILENAME

Returns the full pathname in system for filename (which is just the name+type).

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: registered-systems ()

Returns a list of every system that has been registered / defined for the default system-definer.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-dependencies SYSTEM-NAME

Returns a list of the systems on which system-name depends directly.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-loaded-p SYSTEM-NAME

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-name-for-display SYSTEM-NAME

Returns a ’nice name’ for system-name. If no such special name is available, then the system-name is used.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-property SYSTEM-NAME PROPERTY-NAME &key NO-ERROR?

Returns the value of the named property-name of system-name. If no-error? is nil, then an error will be signaled if property-name does not exist in the system.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-relative-pathname SYSTEM PATHNAME

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-signature SYSTEM-NAME

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-source-directory SYSTEM-NAME

Returns the pathname of the directory in which system-name lives.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-source-file SYSTEM-NAME

Returns the pathname of the system definition of system-name for its system-definer.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: system-sub-systems SYSTEM-NAME

Returns the complete list of the systems on which system-name depends; compare with system-dependencies.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: top-level-system-p SYSTEM-NAME

Returns true if, metaphorically speaking, system-name is a system unto itself. Usually, this means that there are no systems that depends on the system but it could also be that the system is used by other systems but is also coherent in and of itself.

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

5.1.2 Generic functions

Generic Function: map-system-files SYSTEM-NAME/S FUNCTION &key SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE? &allow-other-keys

Applies function to each of the files named in system-name/s. If system-closure? is true, then function is applied to the files of the systems that this system depends on. If incude-pathname? is true, the the function is applied to complete pathnames; otherwise the function is applied only to the name+type of each file. If include-non-source? is true, then all files are included. If it is nil (the default), then only source files will be included.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: map-system-files (SYSTEM-NAME string) FUNCTION &rest ARGS &key &allow-other-keys

Source

defsystem-compatibility.lisp (file)

Method: map-system-files (SYSTEM-NAME symbol) FUNCTION &rest ARGS &key SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Source

defsystem-compatibility.lisp (file)

Method: map-system-files (SYSTEM-NAMES list) FUNCTION &key SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Source

defsystem-compatibility.lisp (file)

Generic Function: system-name CONDITION

Package

defsystem-compatibility

Methods

Method: system-name (CONDITION system-definer-not-found-error)

Source

defsystem-compatibility.lisp (file)

5.1.3 Conditions

Condition: system-definer-not-found-error ()

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Direct superclasses

error (condition)

Direct methods

system-name (method)

Direct slots

Slot: system-name

Initargs

:system-name

Initform

(quote nil)

Readers

system-name (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *ignore-errors?*

Package

defsystem-compatibility

Source

asdf.lisp (file)

Special Variable: *pathname-cache*

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Special Variable: *pathname-separator*

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Special Variable: *prefered-definer-for-systems*

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Special Variable: *prefered-system-definer*

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Special Variable: *relative-pathname*

Package

defsystem-compatibility

Source

asdf.lisp (file)

5.2.2 Functions

Function: ensure-pathname-separator-defined ()

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: ensure-string X

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

Function: handle-file FILE FUNCTION INCLUDE-PATHNAME?

Package

defsystem-compatibility

Source

asdf.lisp (file)

Function: safe-slot-value THING NAME

Package

defsystem-compatibility

Source

asdf.lisp (file)

Function: select-system-definer% SYSTEM-NAME

Package

defsystem-compatibility

Source

defsystem-compatibility.lisp (file)

5.2.3 Generic functions

Generic Function: %map-system-files THING FUNCTION SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Package

defsystem-compatibility

Methods

Method: %map-system-files (FILE static-file) FUNCTION SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Source

asdf.lisp (file)

Method: %map-system-files (FILE source-file) FUNCTION SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Source

asdf.lisp (file)

Method: %map-system-files (SYSTEM system) FUNCTION SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Source

asdf.lisp (file)

Method: %map-system-files (MODULE module) FUNCTION SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE?

Source

asdf.lisp (file)

Method: %map-system-files (THING component) FUNCTION SYSTEM-CLOSURE? INCLUDE-PATHNAME? INCLUDE-NON-SOURCE? around

Source

asdf.lisp (file)

Generic Function: associated-test-system* SYSTEM-DEFINER SYSTEM-NAME

Returns the name of the system that should be used to test system-name or nil if no such system exists.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: associated-test-system* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Generic Function: available-systems* SYSTEM-DEFINER

Returns a list of systems that are available for the system-definer.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: available-systems* (SYSTEM-DEFINER (eql asdf))

Source

asdf.lisp (file)

Generic Function: compute-relative-pathname-extension THING

Package

defsystem-compatibility

Methods

Method: compute-relative-pathname-extension (THING module)

Source

asdf.lisp (file)

Method: compute-relative-pathname-extension (THING system)

Source

asdf.lisp (file)

Method: compute-relative-pathname-extension (THING component)

Source

asdf.lisp (file)

Generic Function: ensure-system-name* SYSTEM-DEFINER SYSTEM

Returns the canonical representation of the system’s name.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: ensure-system-name* (SYSTEM-DEFINER (eql asdf)) (SYSTEM system)

Source

asdf.lisp (file)

Method: ensure-system-name* (SYSTEM-DEFINER (eql asdf)) (SYSTEM-NAME cons)

Source

asdf.lisp (file)

Method: ensure-system-name* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Generic Function: extend-relative-pathname THING

Package

defsystem-compatibility

Methods

Method: extend-relative-pathname (THING component)

Source

asdf.lisp (file)

Generic Function: filename-looks-like-system-file-p* SYSTEM-DEFINER FILENAME

Returns true if filename looks like a system file for the system-definer. This is based only on the syntax if the file’s name, not on the contents of the file.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: filename-looks-like-system-file-p* (SYSTEM-DEFINER (eql asdf)) FILENAME

Source

asdf.lisp (file)

Generic Function: find-system* SYSTEM-DEFINER SYSTEM-NAME

Returns the system definition of system-name for the system-definer or nil if no such system exists.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: find-system* (SYSTEM-DEFINER (eql glu)) SYSTEM-NAME

Source

defsystem-compatibility.lisp (file)

Method: find-system* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

defsystem-compatibility.lisp (file)

Generic Function: loaded-systems* SYSTEM-DEFINER

Returns a list of the names of the systems that are currently loaded with the system-definer.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: loaded-systems* (SYSTEM-DEFINER (eql asdf))

Source

asdf.lisp (file)

Generic Function: registered-systems* SYSTEM-DEFINER

Returns a list of every system that has been registered / defined for the system-definer.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: registered-systems* (SYSTEM-DEFINER (eql asdf))

Source

asdf.lisp (file)

Generic Function: select-system-definer SYSTEM-NAME

Package

defsystem-compatibility

Methods

Method: select-system-definer (SYSTEM-NAME system)

Source

asdf.lisp (file)

Method: select-system-definer (SYSTEM-NAME (eql nil))

Source

defsystem-compatibility.lisp (file)

Method: select-system-definer (SYSTEM-NAME cons)

Source

defsystem-compatibility.lisp (file)

Method: select-system-definer (SYSTEM-NAME string)

Source

defsystem-compatibility.lisp (file)

Method: select-system-definer (SYSTEM-NAME symbol)

Source

defsystem-compatibility.lisp (file)

Generic Function: system-dependencies* SYSTEM-DEFINER SYSTEM-NAME

Returns a list of the systems on which system-name depends directly.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: system-dependencies* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Generic Function: system-loaded-p* SYSTEM-DEFINER SYSTEM-NAME

Returns true if and only if ‘system-name‘ has been loaded into this Lisp image.

Package

defsystem-compatibility

Source

api.lisp (file)

Generic Function: system-name-for-display* SYSTEM-DEFINER SYSTEM-NAME

Returns a ’nice name’ for system-name. If no such special name is available, then the system-name is used.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: system-name-for-display* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Generic Function: system-property* SYSTEM-DEFINER SYSTEM-NAME PROPERTY-NAME &key NO-ERROR?

Returns the value of the named property-name of system-name. If no-error? is nil, then an error will be signaled if property-name does not exist in the system.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: system-property* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME PROPERTY-NAME &key NO-ERROR?

Source

asdf.lisp (file)

Generic Function: system-source-file* SYSTEM-DEFINER SYSTEM-NAME

Returns the pathname of the system definition of system-name for system-definer.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: system-source-file* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Generic Function: system-sub-systems* SYSTEM-DEFINER SYSTEM-NAME

Returns the complete list of the systems on which system-name depends; compare with system-dependencies*.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: system-sub-systems* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Generic Function: top-level-system-p* SYSTEM-DEFINER SYSTEM-NAME

Returns true if, metaphorically speaking, system-name is a system unto itself. Usually, this means that there are no systems that depends on the system but it could also be that the system is used by other systems but is also coherent in and of itself.

Package

defsystem-compatibility

Source

api.lisp (file)

Methods

Method: top-level-system-p* (SYSTEM-DEFINER (eql asdf)) SYSTEM-NAME

Source

asdf.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types