The org.tfeb.tools Reference Manual

This is the org.tfeb.tools Reference Manual, version 9.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 15:04:38 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 org.tfeb.tools

TFEB tools

Author

Tim Bradshaw

Home Page

https://github.com/tfeb/tfeb-lisp-tools

License

MIT

Version

9.0.0

Source

org.tfeb.tools.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 org.tfeb.tools/org.tfeb.tools.asd

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

ASDF Systems

org.tfeb.tools.


3.1.2 org.tfeb.tools/require-module.lisp

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

Packages

org.tfeb.tools.require-module.

Public Interface
Internals

3.1.3 org.tfeb.tools/install-providers.lisp

Dependency

require-module.lisp (file).

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

Packages

org.tfeb.tools.install-providers.

Public Interface

install-providers (function).

Internals

3.1.4 org.tfeb.tools/build-modules.lisp

Dependency

require-module.lisp (file).

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

Packages

org.tfeb.tools.build-modules.

Public Interface

compile-installed-modules (function).

Internals

pathname-matches-any-p (function).


3.1.5 org.tfeb.tools/feature-expressions.lisp

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

Packages

org.tfeb.tools.feature-expressions.

Public Interface
Internals

3.1.6 org.tfeb.tools/deprecations.lisp

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

Packages

org.tfeb.tools.deprecations.

Public Interface
Internals

3.1.7 org.tfeb.tools/asdf-module-sysdcls.lisp

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

Packages

org.tfeb.tools.asdf-module-sysdcls.

Public Interface

3.1.8 org.tfeb.tools/tools-cometh.lisp

Dependencies
Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).


4 Packages

Packages are listed by definition order.


4.1 org.tfeb.tools.deprecations

Source

deprecations.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 org.tfeb.tools.install-providers

Source

install-providers.lisp.

Use List
Public Interface

install-providers (function).

Internals

4.3 org.tfeb.tools.require-module

Source

require-module.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

4.4 org.tfeb.tools.build-modules

Source

build-modules.lisp.

Use List
Public Interface

compile-installed-modules (function).

Internals

pathname-matches-any-p (function).


4.5 org.tfeb.tools.feature-expressions

Source

feature-expressions.lisp.

Use List

common-lisp.

Public Interface
Internals

4.6 org.tfeb.tools.asdf-module-sysdcls

Source

asdf-module-sysdcls.lisp.

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

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *inhibit-deprecation-warnings*
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Special Variable: *module-component-rewriter*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *module-component-separators*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *module-fallback-loaders*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *module-path-descriptions*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *module-providers*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.


5.1.2 Macros

Macro: after-require-module (&body forms)

Run FORMS after this module is provided

A block called AFTER-REQUIRE-MODULE is wrapped around them.

Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Macro: define-asdf-module-sysdcls (of (&rest prefacery &key &allow-other-keys) &body modules/descs)
Package

org.tfeb.tools.asdf-module-sysdcls.

Source

asdf-module-sysdcls.lisp.

Macro: define-deprecated-function (name args &body forms)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Macro: define-deprecated-generic-function (name args &body forms)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Macro: define-deprecated-macro (name args &body decls/forms)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Macro: define-deprecated-symbol-macro (name expansion)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Macro: define-module-path-descriptions (host/options &body descs)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Macro: define-require-module-wrapper (name (next module . args) &body decls/forms)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Macro: ensuring-features (&body clauses)
Package

org.tfeb.tools.feature-expressions.

Source

feature-expressions.lisp.

Macro: feature-case (&body clauses)
Package

org.tfeb.tools.feature-expressions.

Source

feature-expressions.lisp.

Macro: needs (&rest module-specifications)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Macro: with-deprecations ((&key inhibit) &body forms)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.


5.1.3 Compiler macros

Compiler Macro: evaluate-feature-expression (expression)
Package

org.tfeb.tools.feature-expressions.

Source

feature-expressions.lisp.


5.1.4 Ordinary functions

Function: add-module-path-descriptions (descs &key after before uniquely test host replace module-path-descriptions)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: clear-deprecations ()
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Function: clear-module-caches ()
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: compile-installed-modules (prefix files &key omit only force verbose pretend)
Package

org.tfeb.tools.build-modules.

Source

build-modules.lisp.

Function: evaluate-feature-expression (expression)
Package

org.tfeb.tools.feature-expressions.

Source

feature-expressions.lisp.

Function: install-providers (root &key providers really clear filter)
Package

org.tfeb.tools.install-providers.

Source

install-providers.lisp.

Function: locate-module (module-name &key module-path-descriptions hints module-component-separators module-component-rewriter verbose debug)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: map-deprecations (f)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Function: module-path-descriptions-for-function (function pathname-specs)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: provide-module (module &optional provider)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: provides (&rest module-names)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: remove-require-module-wrapper (name)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: report-deprecations (&key stream clear)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Function: require-module (m &rest arguments &key verbose trace debug quiet test pretend force once cache reload compile use fallback error module-path-descriptions hints module-component-separators module-component-rewriter wrapper-arguments)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: require-module-error (format-control &rest format-arguments)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: require-modules (module-specifications &rest keywords &key &allow-other-keys)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: requires (&rest module-specifications)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: write-asdf-module-sysdcl (module/desc of &key preface default-pathname)
Package

org.tfeb.tools.asdf-module-sysdcls.

Source

asdf-module-sysdcls.lisp.


5.1.5 Generic functions

Generic Reader: deprecation-warning-location (condition)
Package

org.tfeb.tools.deprecations.

Methods
Reader Method: deprecation-warning-location ((condition deprecation-warning))
Source

deprecations.lisp.

Target Slot

location.

Generic Reader: deprecation-warning-notice (condition)
Package

org.tfeb.tools.deprecations.

Methods
Reader Method: deprecation-warning-notice ((condition deprecation-warning))
Source

deprecations.lisp.

Target Slot

notice.

Generic Reader: deprecation-warning-thing (condition)
Package

org.tfeb.tools.deprecations.

Methods
Reader Method: deprecation-warning-thing ((condition deprecation-warning))
Source

deprecations.lisp.

Target Slot

thing.

Generic Reader: deprecation-warning-what (condition)
Package

org.tfeb.tools.deprecations.

Methods
Reader Method: deprecation-warning-what ((condition deprecation-warning))
Source

deprecations.lisp.

Target Slot

what.


5.1.6 Conditions

Condition: deprecation-warning
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Direct superclasses

style-warning.

Direct methods
Direct slots
Slot: thing
Initform

(quote (error "must specify thing"))

Initargs

:thing

Readers

deprecation-warning-thing.

Writers

This slot is read-only.

Slot: what
Initform

(quote (error "must specify what"))

Initargs

:what

Readers

deprecation-warning-what.

Writers

This slot is read-only.

Slot: notice
Initform

(quote nil)

Initargs

:notice

Readers

deprecation-warning-notice.

Writers

This slot is read-only.

Slot: location
Initform

(quote *compile-file-truename*)

Initargs

:location

Readers

deprecation-warning-location.

Writers

This slot is read-only.

Condition: require-module-error
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Direct superclasses

simple-error.


5.2 Internals


5.2.1 Special variables

Special Variable: *after-require-module-hooks*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *ambient-arguments*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *ambient-modules*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *deprecation-locations*
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Special Variable: *in-require-module*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *module-descendants*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *require-module-wrappers*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Special Variable: *write-date-cache*
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.


5.2.2 Ordinary functions

Function: copy-file (from to)
Package

org.tfeb.tools.install-providers.

Source

install-providers.lisp.

Function: ensure-pathname (d)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: featurep (thing)
Package

org.tfeb.tools.feature-expressions.

Source

feature-expressions.lisp.

Function: make-deprecated-functiony-form (definer name arglist forms)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Function: maybe-use-module-package (m &key use verbose quiet)
Package

org.tfeb.tools.require-module.

Source

require-module.lisp.

Function: module->directory-components (m &key case)
Package

org.tfeb.tools.install-providers.

Source

install-providers.lisp.

Function: note-deprecated (thing what &key notice location)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.

Function: pathname-matches-any-p (pathname wilds)
Package

org.tfeb.tools.build-modules.

Source

build-modules.lisp.

Function: pretty-what (what)
Package

org.tfeb.tools.deprecations.

Source

deprecations.lisp.


5.2.3 Generic functions

Generic Reader: feature-error-feature (condition)
Package

org.tfeb.tools.feature-expressions.

Methods
Reader Method: feature-error-feature ((condition feature-error))
Source

feature-expressions.lisp.

Target Slot

feature.

Generic Reader: feature-error-time (condition)
Package

org.tfeb.tools.feature-expressions.

Methods
Reader Method: feature-error-time ((condition feature-error))
Source

feature-expressions.lisp.

Target Slot

time.


5.2.4 Conditions

Condition: feature-error
Package

org.tfeb.tools.feature-expressions.

Source

feature-expressions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: feature
Initargs

:feature

Readers

feature-error-feature.

Writers

This slot is read-only.

Slot: time
Package

common-lisp.

Initargs

:time

Readers

feature-error-time.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   I   L   M   N   P   R   W  
Index Entry  Section

A
add-module-path-descriptions: Public ordinary functions
after-require-module: Public macros

C
clear-deprecations: Public ordinary functions
clear-module-caches: Public ordinary functions
compile-installed-modules: Public ordinary functions
Compiler Macro, evaluate-feature-expression: Public compiler macros
copy-file: Private ordinary functions

D
define-asdf-module-sysdcls: Public macros
define-deprecated-function: Public macros
define-deprecated-generic-function: Public macros
define-deprecated-macro: Public macros
define-deprecated-symbol-macro: Public macros
define-module-path-descriptions: Public macros
define-require-module-wrapper: Public macros
deprecation-warning-location: Public generic functions
deprecation-warning-location: Public generic functions
deprecation-warning-notice: Public generic functions
deprecation-warning-notice: Public generic functions
deprecation-warning-thing: Public generic functions
deprecation-warning-thing: Public generic functions
deprecation-warning-what: Public generic functions
deprecation-warning-what: Public generic functions

E
ensure-pathname: Private ordinary functions
ensuring-features: Public macros
evaluate-feature-expression: Public compiler macros
evaluate-feature-expression: Public ordinary functions

F
feature-case: Public macros
feature-error-feature: Private generic functions
feature-error-feature: Private generic functions
feature-error-time: Private generic functions
feature-error-time: Private generic functions
featurep: Private ordinary functions
Function, add-module-path-descriptions: Public ordinary functions
Function, clear-deprecations: Public ordinary functions
Function, clear-module-caches: Public ordinary functions
Function, compile-installed-modules: Public ordinary functions
Function, copy-file: Private ordinary functions
Function, ensure-pathname: Private ordinary functions
Function, evaluate-feature-expression: Public ordinary functions
Function, featurep: Private ordinary functions
Function, install-providers: Public ordinary functions
Function, locate-module: Public ordinary functions
Function, make-deprecated-functiony-form: Private ordinary functions
Function, map-deprecations: Public ordinary functions
Function, maybe-use-module-package: Private ordinary functions
Function, module->directory-components: Private ordinary functions
Function, module-path-descriptions-for-function: Public ordinary functions
Function, note-deprecated: Private ordinary functions
Function, pathname-matches-any-p: Private ordinary functions
Function, pretty-what: Private ordinary functions
Function, provide-module: Public ordinary functions
Function, provides: Public ordinary functions
Function, remove-require-module-wrapper: Public ordinary functions
Function, report-deprecations: Public ordinary functions
Function, require-module: Public ordinary functions
Function, require-module-error: Public ordinary functions
Function, require-modules: Public ordinary functions
Function, requires: Public ordinary functions
Function, write-asdf-module-sysdcl: Public ordinary functions

G
Generic Function, deprecation-warning-location: Public generic functions
Generic Function, deprecation-warning-notice: Public generic functions
Generic Function, deprecation-warning-thing: Public generic functions
Generic Function, deprecation-warning-what: Public generic functions
Generic Function, feature-error-feature: Private generic functions
Generic Function, feature-error-time: Private generic functions

I
install-providers: Public ordinary functions

L
locate-module: Public ordinary functions

M
Macro, after-require-module: Public macros
Macro, define-asdf-module-sysdcls: Public macros
Macro, define-deprecated-function: Public macros
Macro, define-deprecated-generic-function: Public macros
Macro, define-deprecated-macro: Public macros
Macro, define-deprecated-symbol-macro: Public macros
Macro, define-module-path-descriptions: Public macros
Macro, define-require-module-wrapper: Public macros
Macro, ensuring-features: Public macros
Macro, feature-case: Public macros
Macro, needs: Public macros
Macro, with-deprecations: Public macros
make-deprecated-functiony-form: Private ordinary functions
map-deprecations: Public ordinary functions
maybe-use-module-package: Private ordinary functions
Method, deprecation-warning-location: Public generic functions
Method, deprecation-warning-notice: Public generic functions
Method, deprecation-warning-thing: Public generic functions
Method, deprecation-warning-what: Public generic functions
Method, feature-error-feature: Private generic functions
Method, feature-error-time: Private generic functions
module->directory-components: Private ordinary functions
module-path-descriptions-for-function: Public ordinary functions

N
needs: Public macros
note-deprecated: Private ordinary functions

P
pathname-matches-any-p: Private ordinary functions
pretty-what: Private ordinary functions
provide-module: Public ordinary functions
provides: Public ordinary functions

R
remove-require-module-wrapper: Public ordinary functions
report-deprecations: Public ordinary functions
require-module: Public ordinary functions
require-module-error: Public ordinary functions
require-modules: Public ordinary functions
requires: Public ordinary functions

W
with-deprecations: Public macros
write-asdf-module-sysdcl: Public ordinary functions


A.3 Variables

Jump to:   *  
F   L   N   S   T   W  
Index Entry  Section

*
*after-require-module-hooks*: Private special variables
*ambient-arguments*: Private special variables
*ambient-modules*: Private special variables
*deprecation-locations*: Private special variables
*in-require-module*: Private special variables
*inhibit-deprecation-warnings*: Public special variables
*module-component-rewriter*: Public special variables
*module-component-separators*: Public special variables
*module-descendants*: Private special variables
*module-fallback-loaders*: Public special variables
*module-path-descriptions*: Public special variables
*module-providers*: Public special variables
*require-module-wrappers*: Private special variables
*write-date-cache*: Private special variables

F
feature: Private conditions

L
location: Public conditions

N
notice: Public conditions

S
Slot, feature: Private conditions
Slot, location: Public conditions
Slot, notice: Public conditions
Slot, thing: Public conditions
Slot, time: Private conditions
Slot, what: Public conditions
Special Variable, *after-require-module-hooks*: Private special variables
Special Variable, *ambient-arguments*: Private special variables
Special Variable, *ambient-modules*: Private special variables
Special Variable, *deprecation-locations*: Private special variables
Special Variable, *in-require-module*: Private special variables
Special Variable, *inhibit-deprecation-warnings*: Public special variables
Special Variable, *module-component-rewriter*: Public special variables
Special Variable, *module-component-separators*: Public special variables
Special Variable, *module-descendants*: Private special variables
Special Variable, *module-fallback-loaders*: Public special variables
Special Variable, *module-path-descriptions*: Public special variables
Special Variable, *module-providers*: Public special variables
Special Variable, *require-module-wrappers*: Private special variables
Special Variable, *write-date-cache*: Private special variables

T
thing: Public conditions
time: Private conditions

W
what: Public conditions


A.4 Data types

Jump to:   A   B   C   D   F   I   O   P   R   S   T  
Index Entry  Section

A
asdf-module-sysdcls.lisp: The org․tfeb․tools/asdf-module-sysdcls․lisp file

B
build-modules.lisp: The org․tfeb․tools/build-modules․lisp file

C
Condition, deprecation-warning: Public conditions
Condition, feature-error: Private conditions
Condition, require-module-error: Public conditions

D
deprecation-warning: Public conditions
deprecations.lisp: The org․tfeb․tools/deprecations․lisp file

F
feature-error: Private conditions
feature-expressions.lisp: The org․tfeb․tools/feature-expressions․lisp file
File, asdf-module-sysdcls.lisp: The org․tfeb․tools/asdf-module-sysdcls․lisp file
File, build-modules.lisp: The org․tfeb․tools/build-modules․lisp file
File, deprecations.lisp: The org․tfeb․tools/deprecations․lisp file
File, feature-expressions.lisp: The org․tfeb․tools/feature-expressions․lisp file
File, install-providers.lisp: The org․tfeb․tools/install-providers․lisp file
File, org.tfeb.tools.asd: The org․tfeb․tools/org․tfeb․tools․asd file
File, require-module.lisp: The org․tfeb․tools/require-module․lisp file
File, tools-cometh.lisp: The org․tfeb․tools/tools-cometh․lisp file

I
install-providers.lisp: The org․tfeb․tools/install-providers․lisp file

O
org.tfeb.tools: The org․tfeb․tools system
org.tfeb.tools.asd: The org․tfeb․tools/org․tfeb․tools․asd file
org.tfeb.tools.asdf-module-sysdcls: The org․tfeb․tools․asdf-module-sysdcls package
org.tfeb.tools.build-modules: The org․tfeb․tools․build-modules package
org.tfeb.tools.deprecations: The org․tfeb․tools․deprecations package
org.tfeb.tools.feature-expressions: The org․tfeb․tools․feature-expressions package
org.tfeb.tools.install-providers: The org․tfeb․tools․install-providers package
org.tfeb.tools.require-module: The org․tfeb․tools․require-module package

P
Package, org.tfeb.tools.asdf-module-sysdcls: The org․tfeb․tools․asdf-module-sysdcls package
Package, org.tfeb.tools.build-modules: The org․tfeb․tools․build-modules package
Package, org.tfeb.tools.deprecations: The org․tfeb․tools․deprecations package
Package, org.tfeb.tools.feature-expressions: The org․tfeb․tools․feature-expressions package
Package, org.tfeb.tools.install-providers: The org․tfeb․tools․install-providers package
Package, org.tfeb.tools.require-module: The org․tfeb․tools․require-module package

R
require-module-error: Public conditions
require-module.lisp: The org․tfeb․tools/require-module․lisp file

S
System, org.tfeb.tools: The org․tfeb․tools system

T
tools-cometh.lisp: The org․tfeb․tools/tools-cometh․lisp file