The hu.dwim.asdf Reference Manual

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

The hu.dwim.asdf Reference Manual

This is the hu.dwim.asdf Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:47:04 2022 GMT+0.

Table of Contents


1 Introduction

http://dwim.hu/project/hu.dwim.asdf


2 Systems

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


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

2.1 hu.dwim.asdf

Various ASDF extensions such as attached test and documentation system, explicit development support, etc.

Authors

Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>

License

BSD or Bugroff

Dependencies
  • asdf (system).
  • uiop (system).
Source

hu.dwim.asdf.asd.

Child Component

source (module).


3 Modules

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


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

3.1 hu.dwim.asdf/source

Source

hu.dwim.asdf.asd.

Parent Component

hu.dwim.asdf (system).

Child Components

4 Files

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


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

4.1 Lisp


4.1.1 hu.dwim.asdf/hu.dwim.asdf.asd

Source

hu.dwim.asdf.asd.

Parent Component

hu.dwim.asdf (system).

ASDF Systems

hu.dwim.asdf.


4.1.2 hu.dwim.asdf/source/duplicates.lisp

Dependency

package.lisp (file).

Source

hu.dwim.asdf.asd.

Parent Component

source (module).

Internals

4.1.3 hu.dwim.asdf/source/package.lisp

Source

hu.dwim.asdf.asd.

Parent Component

source (module).

Packages

hu.dwim.asdf.


4.1.4 hu.dwim.asdf/source/production.lisp

Dependency

duplicates.lisp (file).

Source

hu.dwim.asdf.asd.

Parent Component

source (module).

Public Interface

4.1.5 hu.dwim.asdf/source/system.lisp

Dependency

production.lisp (file).

Source

hu.dwim.asdf.asd.

Parent Component

source (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 hu.dwim.asdf

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.1 Special variables

Special Variable: *load-as-production?*

When T, load the lisp files so that it will be used in a production system. This means that debug-only blocks are dropped, some hot functions are optimized, compile time and runtime log levels and various other variables are initialized accordingly.

Package

hu.dwim.asdf.

Source

production.lisp.


6.1.2 Macros

Macro: debug-only (&body body)
Package

hu.dwim.asdf.

Source

production.lisp.

Macro: debug-only* (&body body)
Package

hu.dwim.asdf.

Source

production.lisp.

Macro: do-system-dependencies ((variable-name system-name &key transitive) &body body)
Package

hu.dwim.asdf.

Source

system.lisp.

Macro: production-only (&body body)
Package

hu.dwim.asdf.

Source

production.lisp.

Macro: production-only* (&body body)
Package

hu.dwim.asdf.

Source

production.lisp.


6.1.3 Ordinary functions

Function: collect-system-dependencies (system &key transitive)
Package

hu.dwim.asdf.

Source

system.lisp.

Function: develop-system (system &rest args &key force verbose version)

Shorthand for ‘(operate ’asdf:develop-op system)‘. See [operate][] for details.

Package

hu.dwim.asdf.

Source

system.lisp.

Function: find-and-load-swank-integration-systems ()
Package

hu.dwim.asdf.

Source

system.lisp.

Function: iterate-system-dependencies (function system &key transitive)
Package

hu.dwim.asdf.

Source

system.lisp.

Function: map-asdf-source-registry-directories (visitor)
Package

hu.dwim.asdf.

Source

system.lisp.

Function: map-system-dependencies (function system &key transitive)
Package

hu.dwim.asdf.

Source

system.lisp.

Function: optimize-declaration ()
Package

hu.dwim.asdf.

Source

production.lisp.

Function: system-directory (name)
Package

hu.dwim.asdf.

Source

system.lisp.

Function: system-pathname (name)
Package

hu.dwim.asdf.

Source

system.lisp.


6.1.4 Generic functions

Generic Function: run-test-suite (system)
Package

hu.dwim.asdf.

Source

system.lisp.

Methods
Method: run-test-suite ((system system))
Method: run-test-suite :around ((system hu.dwim.test-system))
Method: run-test-suite ((system hu.dwim.test-system))
Generic Reader: system-compile-output (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-compile-output ((system-with-output system-with-output))

automatically generated reader method

Source

system.lisp.

Target Slot

compile-output.

Generic Writer: (setf system-compile-output) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-compile-output) ((system-with-output system-with-output))

automatically generated writer method

Source

system.lisp.

Target Slot

compile-output.

Generic Reader: system-documentation-system-name (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-documentation-system-name ((hu.dwim.system hu.dwim.system))

automatically generated reader method

Source

system.lisp.

Target Slot

documentation-system-name.

Generic Writer: (setf system-documentation-system-name) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-documentation-system-name) ((hu.dwim.system hu.dwim.system))

automatically generated writer method

Source

system.lisp.

Target Slot

documentation-system-name.

Generic Reader: system-load-output (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-load-output ((system-with-output system-with-output))

automatically generated reader method

Source

system.lisp.

Target Slot

load-output.

Generic Writer: (setf system-load-output) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-load-output) ((system-with-output system-with-output))

automatically generated writer method

Source

system.lisp.

Target Slot

load-output.

Generic Reader: system-package-name (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-package-name ((system-with-package system-with-package))

automatically generated reader method

Source

system.lisp.

Target Slot

package-name.

Generic Writer: (setf system-package-name) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-package-name) ((system-with-package system-with-package))

automatically generated writer method

Source

system.lisp.

Target Slot

package-name.

Generic Reader: system-test-name (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-test-name ((hu.dwim.test-system hu.dwim.test-system))

automatically generated reader method

Source

system.lisp.

Target Slot

test-name.

Generic Writer: (setf system-test-name) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-test-name) ((hu.dwim.test-system hu.dwim.test-system))

automatically generated writer method

Source

system.lisp.

Target Slot

test-name.

Generic Reader: system-test-output (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-test-output ((hu.dwim.test-system hu.dwim.test-system))

automatically generated reader method

Source

system.lisp.

Target Slot

test-output.

Generic Writer: (setf system-test-output) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-test-output) ((hu.dwim.test-system hu.dwim.test-system))

automatically generated writer method

Source

system.lisp.

Target Slot

test-output.

Generic Reader: system-test-result (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-test-result ((hu.dwim.test-system hu.dwim.test-system))

automatically generated reader method

Source

system.lisp.

Target Slot

test-result.

Generic Writer: (setf system-test-result) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-test-result) ((hu.dwim.test-system hu.dwim.test-system))

automatically generated writer method

Source

system.lisp.

Target Slot

test-result.

Generic Reader: system-test-system-name (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-test-system-name ((hu.dwim.system hu.dwim.system))

automatically generated reader method

Source

system.lisp.

Target Slot

test-system-name.

Generic Writer: (setf system-test-system-name) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-test-system-name) ((hu.dwim.system hu.dwim.system))

automatically generated writer method

Source

system.lisp.

Target Slot

test-system-name.


6.1.5 Standalone methods

Method: module-default-component-class ((class hu.dwim.test-system))
Package

asdf/component.

Source

system.lisp.

Method: module-default-component-class ((class hu.dwim.system))
Package

asdf/component.

Source

system.lisp.

Method: operation-done-p ((operation develop-op) (component component))
Package

asdf/action.

Source

system.lisp.

Method: perform ((operation develop-op) (system system))
Package

asdf/action.

Source

system.lisp.

Method: perform :after ((operation develop-op) (system system))
Package

asdf/action.

Source

system.lisp.

Method: perform :before ((operation develop-op) (system system))
Package

asdf/action.

Source

system.lisp.

Method: perform ((operation develop-op) (component component))
Package

asdf/action.

Source

system.lisp.

Method: perform ((op test-op) (system hu.dwim.system))
Package

asdf/action.

Source

system.lisp.

Method: perform :around ((op load-op) (component hu.dwim.cl-source-file))
Package

asdf/action.

Source

system.lisp.

Method: perform :around ((op compile-op) (component hu.dwim.cl-source-file))
Package

asdf/action.

Source

system.lisp.

Method: perform :around ((op operation) (component hu.dwim.cl-source-file))
Package

asdf/action.

Source

system.lisp.

Method: reinitialize-instance :after ((system hu.dwim.system) &rest args &key &allow-other-keys)
Source

system.lisp.

Method: reinitialize-instance :after ((system system-with-target) &rest args &key &allow-other-keys)
Source

system.lisp.

Method: reinitialize-instance :after ((system system-with-package) &rest args &key &allow-other-keys)
Source

system.lisp.

Method: shared-initialize :around ((system hu.dwim.documentation-system) slot-names &rest initargs)
Source

system.lisp.

Method: shared-initialize :around ((system hu.dwim.test-system) slot-names &rest initargs)
Source

system.lisp.

Method: shared-initialize :around ((system hu.dwim.base-system) slot-names &rest initargs)
Source

system.lisp.


6.1.6 Classes

Class: develop-op
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses

non-propagating-operation.

Direct methods
Class: hu.dwim.documentation-system
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses
Direct methods

shared-initialize.

Class: hu.dwim.system
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses

hu.dwim.base-system.

Direct methods
Direct slots
Slot: test-system-name
Initargs

:test-system-name

Readers

system-test-system-name.

Writers

(setf system-test-system-name).

Slot: documentation-system-name
Initargs

:documentation-system-name

Readers

system-documentation-system-name.

Writers

(setf system-documentation-system-name).

Class: hu.dwim.test-system
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: test-name
Initform

"test"

Initargs

:test-name

Readers

system-test-name.

Writers

(setf system-test-name).

Slot: test-result
Initargs

:test-result

Readers

system-test-result.

Writers

(setf system-test-result).

Slot: test-output
Initargs

:test-output

Readers

system-test-output.

Writers

(setf system-test-output).


6.2 Internals


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

6.2.1 Special variables

Special Variable: *development-package*
Package

hu.dwim.asdf.

Source

system.lisp.

Special Variable: *muffle-optimization-warnings*
Package

hu.dwim.asdf.

Source

system.lisp.


6.2.2 Macros

Macro: with-capturing-output (place &body forms)
Package

hu.dwim.asdf.

Source

system.lisp.

Macro: with-muffled-boring-compiler-warnings (&body body)
Package

hu.dwim.asdf.

Source

duplicates.lisp.


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

6.2.3 Ordinary functions

Function: %iterate-system-dependencies-1 (function system)
Package

hu.dwim.asdf.

Source

system.lisp.

Function: call-with-muffled-boring-compiler-warnings (thunk)
Package

hu.dwim.asdf.

Source

duplicates.lisp.

Function: if-symbol-exists (package name)
Package

hu.dwim.asdf.

Source

duplicates.lisp.

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

hu.dwim.asdf.

Source

system.lisp.


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

6.2.4 Generic functions

Generic Function: call-in-system-environment (operation system function)
Package

hu.dwim.asdf.

Source

system.lisp.

Methods
Method: call-in-system-environment ((op operation) (system system) function)
Generic Reader: system-target-system-name (object)
Package

hu.dwim.asdf.

Methods
Reader Method: system-target-system-name ((system-with-target system-with-target))

automatically generated reader method

Source

system.lisp.

Target Slot

target-system-name.

Generic Writer: (setf system-target-system-name) (object)
Package

hu.dwim.asdf.

Methods
Writer Method: (setf system-target-system-name) ((system-with-target system-with-target))

automatically generated writer method

Source

system.lisp.

Target Slot

target-system-name.


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

6.2.5 Classes

Class: hu.dwim.base-system
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses
Direct subclasses
Direct methods

shared-initialize.

Class: hu.dwim.cl-source-file
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses

cl-source-file.

Direct methods
Class: system-with-output
Package

hu.dwim.asdf.

Source

system.lisp.

Direct subclasses

hu.dwim.base-system.

Direct methods
Direct slots
Slot: compile-output
Initargs

:compile-output

Readers

system-compile-output.

Writers

(setf system-compile-output).

Slot: load-output
Initargs

:load-output

Readers

system-load-output.

Writers

(setf system-load-output).

Class: system-with-package
Package

hu.dwim.asdf.

Source

system.lisp.

Direct superclasses

system.

Direct subclasses

hu.dwim.base-system.

Direct methods
Direct slots
Slot: package-name
Package

common-lisp.

Initargs

:package-name

Readers

system-package-name.

Writers

(setf system-package-name).

Class: system-with-target
Package

hu.dwim.asdf.

Source

system.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: target-system-name
Initargs

:target-system-name

Readers

system-target-system-name.

Writers

(setf system-target-system-name).


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   %   (  
C   D   F   G   I   M   O   P   R   S   W  
Index Entry  Section

%
%iterate-system-dependencies-1: Private ordinary functions

(
(setf system-compile-output): Public generic functions
(setf system-compile-output): Public generic functions
(setf system-documentation-system-name): Public generic functions
(setf system-documentation-system-name): Public generic functions
(setf system-load-output): Public generic functions
(setf system-load-output): Public generic functions
(setf system-package-name): Public generic functions
(setf system-package-name): Public generic functions
(setf system-target-system-name): Private generic functions
(setf system-target-system-name): Private generic functions
(setf system-test-name): Public generic functions
(setf system-test-name): Public generic functions
(setf system-test-output): Public generic functions
(setf system-test-output): Public generic functions
(setf system-test-result): Public generic functions
(setf system-test-result): Public generic functions
(setf system-test-system-name): Public generic functions
(setf system-test-system-name): Public generic functions

C
call-in-system-environment: Private generic functions
call-in-system-environment: Private generic functions
call-with-muffled-boring-compiler-warnings: Private ordinary functions
collect-system-dependencies: Public ordinary functions

D
debug-only: Public macros
debug-only*: Public macros
develop-system: Public ordinary functions
do-system-dependencies: Public macros

F
find-and-load-swank-integration-systems: Public ordinary functions
Function, %iterate-system-dependencies-1: Private ordinary functions
Function, call-with-muffled-boring-compiler-warnings: Private ordinary functions
Function, collect-system-dependencies: Public ordinary functions
Function, develop-system: Public ordinary functions
Function, find-and-load-swank-integration-systems: Public ordinary functions
Function, if-symbol-exists: Private ordinary functions
Function, iterate-system-dependencies: Public ordinary functions
Function, map-asdf-source-registry-directories: Public ordinary functions
Function, map-system-dependencies: Public ordinary functions
Function, optimize-declaration: Public ordinary functions
Function, system-directory: Public ordinary functions
Function, system-loaded-p: Private ordinary functions
Function, system-pathname: Public ordinary functions

G
Generic Function, (setf system-compile-output): Public generic functions
Generic Function, (setf system-documentation-system-name): Public generic functions
Generic Function, (setf system-load-output): Public generic functions
Generic Function, (setf system-package-name): Public generic functions
Generic Function, (setf system-target-system-name): Private generic functions
Generic Function, (setf system-test-name): Public generic functions
Generic Function, (setf system-test-output): Public generic functions
Generic Function, (setf system-test-result): Public generic functions
Generic Function, (setf system-test-system-name): Public generic functions
Generic Function, call-in-system-environment: Private generic functions
Generic Function, run-test-suite: Public generic functions
Generic Function, system-compile-output: Public generic functions
Generic Function, system-documentation-system-name: Public generic functions
Generic Function, system-load-output: Public generic functions
Generic Function, system-package-name: Public generic functions
Generic Function, system-target-system-name: Private generic functions
Generic Function, system-test-name: Public generic functions
Generic Function, system-test-output: Public generic functions
Generic Function, system-test-result: Public generic functions
Generic Function, system-test-system-name: Public generic functions

I
if-symbol-exists: Private ordinary functions
iterate-system-dependencies: Public ordinary functions

M
Macro, debug-only: Public macros
Macro, debug-only*: Public macros
Macro, do-system-dependencies: Public macros
Macro, production-only: Public macros
Macro, production-only*: Public macros
Macro, with-capturing-output: Private macros
Macro, with-muffled-boring-compiler-warnings: Private macros
map-asdf-source-registry-directories: Public ordinary functions
map-system-dependencies: Public ordinary functions
Method, (setf system-compile-output): Public generic functions
Method, (setf system-documentation-system-name): Public generic functions
Method, (setf system-load-output): Public generic functions
Method, (setf system-package-name): Public generic functions
Method, (setf system-target-system-name): Private generic functions
Method, (setf system-test-name): Public generic functions
Method, (setf system-test-output): Public generic functions
Method, (setf system-test-result): Public generic functions
Method, (setf system-test-system-name): Public generic functions
Method, call-in-system-environment: Private generic functions
Method, module-default-component-class: Public standalone methods
Method, module-default-component-class: Public standalone methods
Method, operation-done-p: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, reinitialize-instance: Public standalone methods
Method, run-test-suite: Public generic functions
Method, run-test-suite: Public generic functions
Method, run-test-suite: Public generic functions
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, system-compile-output: Public generic functions
Method, system-documentation-system-name: Public generic functions
Method, system-load-output: Public generic functions
Method, system-package-name: Public generic functions
Method, system-target-system-name: Private generic functions
Method, system-test-name: Public generic functions
Method, system-test-output: Public generic functions
Method, system-test-result: Public generic functions
Method, system-test-system-name: Public generic functions
module-default-component-class: Public standalone methods
module-default-component-class: Public standalone methods

O
operation-done-p: Public standalone methods
optimize-declaration: Public ordinary functions

P
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
production-only: Public macros
production-only*: Public macros

R
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
reinitialize-instance: Public standalone methods
run-test-suite: Public generic functions
run-test-suite: Public generic functions
run-test-suite: Public generic functions
run-test-suite: Public generic functions

S
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
system-compile-output: Public generic functions
system-compile-output: Public generic functions
system-directory: Public ordinary functions
system-documentation-system-name: Public generic functions
system-documentation-system-name: Public generic functions
system-load-output: Public generic functions
system-load-output: Public generic functions
system-loaded-p: Private ordinary functions
system-package-name: Public generic functions
system-package-name: Public generic functions
system-pathname: Public ordinary functions
system-target-system-name: Private generic functions
system-target-system-name: Private generic functions
system-test-name: Public generic functions
system-test-name: Public generic functions
system-test-output: Public generic functions
system-test-output: Public generic functions
system-test-result: Public generic functions
system-test-result: Public generic functions
system-test-system-name: Public generic functions
system-test-system-name: Public generic functions

W
with-capturing-output: Private macros
with-muffled-boring-compiler-warnings: Private macros

Jump to:   %   (  
C   D   F   G   I   M   O   P   R   S   W  

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

A.4 Data types

Jump to:   C   D   F   H   M   P   S  
Index Entry  Section

C
Class, develop-op: Public classes
Class, hu.dwim.base-system: Private classes
Class, hu.dwim.cl-source-file: Private classes
Class, hu.dwim.documentation-system: Public classes
Class, hu.dwim.system: Public classes
Class, hu.dwim.test-system: Public classes
Class, system-with-output: Private classes
Class, system-with-package: Private classes
Class, system-with-target: Private classes

D
develop-op: Public classes
duplicates.lisp: The hu․dwim․asdf/source/duplicates․lisp file

F
File, duplicates.lisp: The hu․dwim․asdf/source/duplicates․lisp file
File, hu.dwim.asdf.asd: The hu․dwim․asdf/hu․dwim․asdf․asd file
File, package.lisp: The hu․dwim․asdf/source/package․lisp file
File, production.lisp: The hu․dwim․asdf/source/production․lisp file
File, system.lisp: The hu․dwim․asdf/source/system․lisp file

H
hu.dwim.asdf: The hu․dwim․asdf system
hu.dwim.asdf: The hu․dwim․asdf package
hu.dwim.asdf.asd: The hu․dwim․asdf/hu․dwim․asdf․asd file
hu.dwim.base-system: Private classes
hu.dwim.cl-source-file: Private classes
hu.dwim.documentation-system: Public classes
hu.dwim.system: Public classes
hu.dwim.test-system: Public classes

M
Module, source: The hu․dwim․asdf/source module

P
Package, hu.dwim.asdf: The hu․dwim․asdf package
package.lisp: The hu․dwim․asdf/source/package․lisp file
production.lisp: The hu․dwim․asdf/source/production․lisp file

S
source: The hu․dwim․asdf/source module
System, hu.dwim.asdf: The hu․dwim․asdf system
system-with-output: Private classes
system-with-package: Private classes
system-with-target: Private classes
system.lisp: The hu․dwim․asdf/source/system․lisp file

Jump to:   C   D   F   H   M   P   S