The defsystem-compatibility Reference Manual

This is the defsystem-compatibility Reference Manual, version 0.1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:16:26 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 defsystem-compatibility

Make many defsystems look the same!

Maintainer

Gary Warren King <>

Author

Gary Warren King <>

License

MIT Style license

Version

0.1.2

Dependency

metatilities-base (system).

Source

defsystem-compatibility.asd.

Child Components

2 Modules

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


2.1 defsystem-compatibility/dev

Source

defsystem-compatibility.asd.

Parent Component

defsystem-compatibility (system).

Child Components

2.2 defsystem-compatibility/website

Source

defsystem-compatibility.asd.

Parent Component

defsystem-compatibility (system).

Child Component

source (module).


2.3 defsystem-compatibility/website/source

Source

defsystem-compatibility.asd.

Parent Component

website (module).

Child 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/defsystem-compatibility.asd

Source

defsystem-compatibility.asd.

Parent Component

defsystem-compatibility (system).

ASDF Systems

defsystem-compatibility.

Packages

defsystem-compatibility-system.


3.1.2 defsystem-compatibility/dev/package.lisp

Source

defsystem-compatibility.asd.

Parent Component

dev (module).

Packages

defsystem-compatibility.


3.1.3 defsystem-compatibility/dev/api.lisp

Dependency

package.lisp (file).

Source

defsystem-compatibility.asd.

Parent Component

dev (module).

Public Interface

map-system-files (generic function).

Internals

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

Dependency

api.lisp (file).

Source

defsystem-compatibility.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.5 defsystem-compatibility/dev/asdf.lisp

Dependency

api.lisp (file).

Source

defsystem-compatibility.asd.

Parent Component

dev (module).

Internals

3.2 Static


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

Source

defsystem-compatibility.asd.

Parent Component

source (module).


4 Packages

Packages are listed by definition order.


4.1 defsystem-compatibility

Source

package.lisp.

Nickname

dsc

Use List

common-lisp.

Public Interface
Internals

4.2 defsystem-compatibility-system

Source

defsystem-compatibility.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary 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.

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.

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.

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.

Function: ensure-system-name (system-name)

Returns the canonical representation of the system’s name.

Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

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.

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.

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.

Function: map-system-dependencies (systems fn)
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

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.

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.

Function: system-dependencies (system-name)

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

Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Function: system-loaded-p (system-name)
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

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.

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.

Function: system-relative-pathname (system pathname)
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Function: system-signature (system-name)
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Function: system-source-directory (system-name)

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

Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

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.

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.

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.


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.

Methods
Method: map-system-files ((system-name string) function &rest args &key &allow-other-keys)
Source

defsystem-compatibility.lisp.

Method: map-system-files ((system-name symbol) function &rest args &key system-closure? include-pathname? include-non-source?)
Source

defsystem-compatibility.lisp.

Method: map-system-files ((system-names list) function &key system-closure? include-pathname? include-non-source?)
Source

defsystem-compatibility.lisp.

Generic Reader: system-name (condition)
Package

defsystem-compatibility.

Methods
Reader Method: system-name ((condition system-definer-not-found-error))
Source

defsystem-compatibility.lisp.

Target Slot

system-name.


5.1.3 Conditions

Condition: system-definer-not-found-error
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Direct superclasses

error.

Direct methods

system-name.

Direct slots
Slot: system-name
Initform

(quote nil)

Initargs

:system-name

Readers

system-name.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *ignore-errors?*
Package

defsystem-compatibility.

Source

asdf.lisp.

Special Variable: *pathname-cache*
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Special Variable: *pathname-separator*
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

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

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Special Variable: *prefered-system-definer*
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Special Variable: *relative-pathname*
Package

defsystem-compatibility.

Source

asdf.lisp.


5.2.2 Ordinary functions

Function: ensure-pathname-separator-defined ()
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Function: ensure-string (x)
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.

Function: handle-file (file function include-pathname?)
Package

defsystem-compatibility.

Source

asdf.lisp.

Function: safe-slot-value (thing name)
Package

defsystem-compatibility.

Source

asdf.lisp.

Function: select-system-definer% (system-name)
Package

defsystem-compatibility.

Source

defsystem-compatibility.lisp.


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.

Method: %map-system-files ((file source-file) function system-closure? include-pathname? include-non-source?)
Source

asdf.lisp.

Method: %map-system-files ((system system) function system-closure? include-pathname? include-non-source?)
Source

asdf.lisp.

Method: %map-system-files ((module module) function system-closure? include-pathname? include-non-source?)
Source

asdf.lisp.

Method: %map-system-files :around ((thing component) function system-closure? include-pathname? include-non-source?)
Source

asdf.lisp.

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.

Methods
Method: associated-test-system* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.

Generic Function: available-systems* (system-definer)

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

Package

defsystem-compatibility.

Source

api.lisp.

Methods
Method: available-systems* ((system-definer (eql :asdf)))
Source

asdf.lisp.

Generic Function: compute-relative-pathname-extension (thing)
Package

defsystem-compatibility.

Methods
Method: compute-relative-pathname-extension ((thing module))
Source

asdf.lisp.

Method: compute-relative-pathname-extension ((thing system))
Source

asdf.lisp.

Method: compute-relative-pathname-extension ((thing component))
Source

asdf.lisp.

Generic Function: ensure-system-name* (system-definer system)

Returns the canonical representation of the system’s name.

Package

defsystem-compatibility.

Source

api.lisp.

Methods
Method: ensure-system-name* ((system-definer (eql :asdf)) (system system))
Source

asdf.lisp.

Method: ensure-system-name* ((system-definer (eql :asdf)) (system-name cons))
Source

asdf.lisp.

Method: ensure-system-name* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.

Generic Function: extend-relative-pathname (thing)
Package

defsystem-compatibility.

Methods
Method: extend-relative-pathname ((thing component))
Source

asdf.lisp.

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.

Methods
Method: filename-looks-like-system-file-p* ((system-definer (eql :asdf)) filename)
Source

asdf.lisp.

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.

Methods
Method: find-system* ((system-definer (eql :glu)) system-name)
Source

defsystem-compatibility.lisp.

Method: find-system* ((system-definer (eql :asdf)) system-name)
Source

defsystem-compatibility.lisp.

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.

Methods
Method: loaded-systems* ((system-definer (eql :asdf)))
Source

asdf.lisp.

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.

Methods
Method: registered-systems* ((system-definer (eql :asdf)))
Source

asdf.lisp.

Generic Function: select-system-definer (system-name)
Package

defsystem-compatibility.

Methods
Method: select-system-definer ((system-name system))
Source

asdf.lisp.

Method: select-system-definer ((system-name (eql nil)))
Source

defsystem-compatibility.lisp.

Method: select-system-definer ((system-name cons))
Source

defsystem-compatibility.lisp.

Method: select-system-definer ((system-name string))
Source

defsystem-compatibility.lisp.

Method: select-system-definer ((system-name symbol))
Source

defsystem-compatibility.lisp.

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.

Methods
Method: system-dependencies* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.

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.

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.

Methods
Method: system-name-for-display* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.

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.

Methods
Method: system-property* ((system-definer (eql :asdf)) system-name property-name &key no-error?)
Source

asdf.lisp.

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.

Methods
Method: system-source-file* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.

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.

Methods
Method: system-sub-systems* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.

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.

Methods
Method: top-level-system-p* ((system-definer (eql :asdf)) system-name)
Source

asdf.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
A   C   E   F   G   H   L   M   P   R   S   T  
Index Entry  Section

%
%map-system-files: Private generic functions
%map-system-files: Private generic functions
%map-system-files: Private generic functions
%map-system-files: Private generic functions
%map-system-files: Private generic functions
%map-system-files: Private generic functions

A
associated-test-system: Public ordinary functions
associated-test-system*: Private generic functions
associated-test-system*: Private generic functions
available-systems: Public ordinary functions
available-systems*: Private generic functions
available-systems*: Private generic functions

C
collect-system-dependencies: Public ordinary functions
collect-system-files: Public ordinary functions
compute-relative-pathname-extension: Private generic functions
compute-relative-pathname-extension: Private generic functions
compute-relative-pathname-extension: Private generic functions
compute-relative-pathname-extension: Private generic functions

E
ensure-pathname-separator-defined: Private ordinary functions
ensure-string: Private ordinary functions
ensure-system-name: Public ordinary functions
ensure-system-name*: Private generic functions
ensure-system-name*: Private generic functions
ensure-system-name*: Private generic functions
ensure-system-name*: Private generic functions
extend-relative-pathname: Private generic functions
extend-relative-pathname: Private generic functions

F
filename-looks-like-system-file-p: Public ordinary functions
filename-looks-like-system-file-p*: Private generic functions
filename-looks-like-system-file-p*: Private generic functions
find-system: Public ordinary functions
find-system*: Private generic functions
find-system*: Private generic functions
find-system*: Private generic functions
Function, associated-test-system: Public ordinary functions
Function, available-systems: Public ordinary functions
Function, collect-system-dependencies: Public ordinary functions
Function, collect-system-files: Public ordinary functions
Function, ensure-pathname-separator-defined: Private ordinary functions
Function, ensure-string: Private ordinary functions
Function, ensure-system-name: Public ordinary functions
Function, filename-looks-like-system-file-p: Public ordinary functions
Function, find-system: Public ordinary functions
Function, handle-file: Private ordinary functions
Function, loaded-systems: Public ordinary functions
Function, map-system-dependencies: Public ordinary functions
Function, pathname-for-system-file: Public ordinary functions
Function, registered-systems: Public ordinary functions
Function, safe-slot-value: Private ordinary functions
Function, select-system-definer%: Private ordinary functions
Function, system-dependencies: Public ordinary functions
Function, system-loaded-p: Public ordinary functions
Function, system-name-for-display: Public ordinary functions
Function, system-property: Public ordinary functions
Function, system-relative-pathname: Public ordinary functions
Function, system-signature: Public ordinary functions
Function, system-source-directory: Public ordinary functions
Function, system-source-file: Public ordinary functions
Function, system-sub-systems: Public ordinary functions
Function, top-level-system-p: Public ordinary functions

G
Generic Function, %map-system-files: Private generic functions
Generic Function, associated-test-system*: Private generic functions
Generic Function, available-systems*: Private generic functions
Generic Function, compute-relative-pathname-extension: Private generic functions
Generic Function, ensure-system-name*: Private generic functions
Generic Function, extend-relative-pathname: Private generic functions
Generic Function, filename-looks-like-system-file-p*: Private generic functions
Generic Function, find-system*: Private generic functions
Generic Function, loaded-systems*: Private generic functions
Generic Function, map-system-files: Public generic functions
Generic Function, registered-systems*: Private generic functions
Generic Function, select-system-definer: Private generic functions
Generic Function, system-dependencies*: Private generic functions
Generic Function, system-loaded-p*: Private generic functions
Generic Function, system-name: Public generic functions
Generic Function, system-name-for-display*: Private generic functions
Generic Function, system-property*: Private generic functions
Generic Function, system-source-file*: Private generic functions
Generic Function, system-sub-systems*: Private generic functions
Generic Function, top-level-system-p*: Private generic functions

H
handle-file: Private ordinary functions

L
loaded-systems: Public ordinary functions
loaded-systems*: Private generic functions
loaded-systems*: Private generic functions

M
map-system-dependencies: Public ordinary functions
map-system-files: Public generic functions
map-system-files: Public generic functions
map-system-files: Public generic functions
map-system-files: Public generic functions
Method, %map-system-files: Private generic functions
Method, %map-system-files: Private generic functions
Method, %map-system-files: Private generic functions
Method, %map-system-files: Private generic functions
Method, %map-system-files: Private generic functions
Method, associated-test-system*: Private generic functions
Method, available-systems*: Private generic functions
Method, compute-relative-pathname-extension: Private generic functions
Method, compute-relative-pathname-extension: Private generic functions
Method, compute-relative-pathname-extension: Private generic functions
Method, ensure-system-name*: Private generic functions
Method, ensure-system-name*: Private generic functions
Method, ensure-system-name*: Private generic functions
Method, extend-relative-pathname: Private generic functions
Method, filename-looks-like-system-file-p*: Private generic functions
Method, find-system*: Private generic functions
Method, find-system*: Private generic functions
Method, loaded-systems*: Private generic functions
Method, map-system-files: Public generic functions
Method, map-system-files: Public generic functions
Method, map-system-files: Public generic functions
Method, registered-systems*: Private generic functions
Method, select-system-definer: Private generic functions
Method, select-system-definer: Private generic functions
Method, select-system-definer: Private generic functions
Method, select-system-definer: Private generic functions
Method, select-system-definer: Private generic functions
Method, system-dependencies*: Private generic functions
Method, system-name: Public generic functions
Method, system-name-for-display*: Private generic functions
Method, system-property*: Private generic functions
Method, system-source-file*: Private generic functions
Method, system-sub-systems*: Private generic functions
Method, top-level-system-p*: Private generic functions

P
pathname-for-system-file: Public ordinary functions

R
registered-systems: Public ordinary functions
registered-systems*: Private generic functions
registered-systems*: Private generic functions

S
safe-slot-value: Private ordinary functions
select-system-definer: Private generic functions
select-system-definer: Private generic functions
select-system-definer: Private generic functions
select-system-definer: Private generic functions
select-system-definer: Private generic functions
select-system-definer: Private generic functions
select-system-definer%: Private ordinary functions
system-dependencies: Public ordinary functions
system-dependencies*: Private generic functions
system-dependencies*: Private generic functions
system-loaded-p: Public ordinary functions
system-loaded-p*: Private generic functions
system-name: Public generic functions
system-name: Public generic functions
system-name-for-display: Public ordinary functions
system-name-for-display*: Private generic functions
system-name-for-display*: Private generic functions
system-property: Public ordinary functions
system-property*: Private generic functions
system-property*: Private generic functions
system-relative-pathname: Public ordinary functions
system-signature: Public ordinary functions
system-source-directory: Public ordinary functions
system-source-file: Public ordinary functions
system-source-file*: Private generic functions
system-source-file*: Private generic functions
system-sub-systems: Public ordinary functions
system-sub-systems*: Private generic functions
system-sub-systems*: Private generic functions

T
top-level-system-p: Public ordinary functions
top-level-system-p*: Private generic functions
top-level-system-p*: Private generic functions


A.4 Data types

Jump to:   A   C   D   F   I   M   P   S   W  
Index Entry  Section

A
api.lisp: The defsystem-compatibility/dev/api․lisp file
asdf.lisp: The defsystem-compatibility/dev/asdf․lisp file

C
Condition, system-definer-not-found-error: Public conditions

D
defsystem-compatibility: The defsystem-compatibility system
defsystem-compatibility: The defsystem-compatibility package
defsystem-compatibility-system: The defsystem-compatibility-system package
defsystem-compatibility.asd: The defsystem-compatibility/defsystem-compatibility․asd file
defsystem-compatibility.lisp: The defsystem-compatibility/dev/defsystem-compatibility․lisp file
dev: The defsystem-compatibility/dev module

F
File, api.lisp: The defsystem-compatibility/dev/api․lisp file
File, asdf.lisp: The defsystem-compatibility/dev/asdf․lisp file
File, defsystem-compatibility.asd: The defsystem-compatibility/defsystem-compatibility․asd file
File, defsystem-compatibility.lisp: The defsystem-compatibility/dev/defsystem-compatibility․lisp file
File, index.lml: The defsystem-compatibility/website/source/index․lml file
File, package.lisp: The defsystem-compatibility/dev/package․lisp file

I
index.lml: The defsystem-compatibility/website/source/index․lml file

M
Module, dev: The defsystem-compatibility/dev module
Module, source: The defsystem-compatibility/website/source module
Module, website: The defsystem-compatibility/website module

P
Package, defsystem-compatibility: The defsystem-compatibility package
Package, defsystem-compatibility-system: The defsystem-compatibility-system package
package.lisp: The defsystem-compatibility/dev/package․lisp file

S
source: The defsystem-compatibility/website/source module
System, defsystem-compatibility: The defsystem-compatibility system
system-definer-not-found-error: Public conditions

W
website: The defsystem-compatibility/website module