The org.tfeb.tools Reference Manual

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

• *module-component-rewriter* (special variable).
• *module-component-separators* (special variable).
• *module-fallback-loaders* (special variable).
• *module-path-descriptions* (special variable).
• *module-providers* (special variable).
• add-module-path-descriptions (function).
• after-require-module (macro).
• clear-module-caches (function).
• define-module-path-descriptions (macro).
• define-require-module-wrapper (macro).
• locate-module (function).
• module-path-descriptions-for-function (function).
• needs (macro).
• provide-module (function).
• provides (function).
• remove-require-module-wrapper (function).
• require-module (function).
• require-module-error (function).
• require-module-error (condition).
• require-modules (function).
• requires (function).

Internals

• *after-require-module-hooks* (special variable).
• *ambient-arguments* (special variable).
• *ambient-modules* (special variable).
• *in-require-module* (special variable).
• *module-descendants* (special variable).
• *require-module-wrappers* (special variable).
• *write-date-cache* (special variable).
• ensure-pathname (function).
• maybe-use-module-package (function).

---

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

• copy-file (function).
• module->directory-components (function).

---

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

• ensuring-features (macro).
• evaluate-feature-expression (compiler macro).
• evaluate-feature-expression (function).
• feature-case (macro).

Internals

• feature-error (condition).
• feature-error-feature (reader method).
• feature-error-time (reader method).
• featurep (function).

---

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

• *inhibit-deprecation-warnings* (special variable).
• clear-deprecations (function).
• define-deprecated-function (macro).
• define-deprecated-generic-function (macro).
• define-deprecated-macro (macro).
• define-deprecated-symbol-macro (macro).
• deprecation-warning (condition).
• deprecation-warning-location (reader method).
• deprecation-warning-notice (reader method).
• deprecation-warning-thing (reader method).
• deprecation-warning-what (reader method).
• map-deprecations (function).
• report-deprecations (function).
• with-deprecations (macro).

Internals

• *deprecation-locations* (special variable).
• make-deprecated-functiony-form (function).
• note-deprecated (function).
• pretty-what (function).

---

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

• define-asdf-module-sysdcls (macro).
• write-asdf-module-sysdcl (function).

---

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

Dependencies

• require-module.lisp (file).
• install-providers.lisp (file).
• build-modules.lisp (file).
• feature-expressions.lisp (file).
• deprecations.lisp (file).
• asdf-module-sysdcls.lisp (file).

Source

org.tfeb.tools.asd.

Parent Component

org.tfeb.tools (system).

---

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

• deprecation-warning-location.
• deprecation-warning-notice.
• deprecation-warning-thing.
• deprecation-warning-what.

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

• feature-error-feature.
• feature-error-time.

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.

---