This is the modularize Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:22:18 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
modularizeA modularization framework
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/modularize.git)
zlib
1.0.0
documentation-utils (system).
trivial-package-local-nicknames (system).
package.lisp (file).
package-toolkit.lisp (file).
hooks.lisp (file).
module.lisp (file).
options.lisp (file).
asdf.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
modularize/modularize.asdmodularize/package.lispmodularize/package-toolkit.lispmodularize/hooks.lispmodularize/module.lispmodularize/options.lispmodularize/asdf.lispmodularize/documentation.lispmodularize/package-toolkit.lisppackage.lisp (file).
modularize (system).
add-package-nickname (function).
collect-symbols-from (function).
ensure-package (function).
extend-package (function).
unbind-and-delete-package (function).
with-package (macro).
modularize/hooks.lisppackage-toolkit.lisp (file).
modularize (system).
call-delete-hooks (function).
call-modularize-hooks (function).
define-delete-hook (macro).
define-modularize-hook (macro).
delete-hook (function).
(setf delete-hook) (function).
modularize-hook (function).
(setf modularize-hook) (function).
remove-delete-hook (function).
remove-modularize-hook (function).
*delete-hooks* (special variable).
*modularize-hooks* (special variable).
modularize/module.lisphooks.lisp (file).
modularize (system).
current-module (macro).
define-module (macro).
define-module-extension (macro).
define-option-expander (macro).
delete-module (function).
demodularize (function).
expand-option (generic function).
list-modules (function).
map-modules (function).
modularize (function).
module (function).
module-identifier (function).
module-name (function).
module-not-found (condition).
module-p (function).
module-packages (function).
(setf module-packages) (function).
module-storage (function).
(setf module-storage) (function).
module-storage-remove (function).
not-a-module (condition).
with-module (macro).
*module-deferrals* (special variable).
*module-storages* (special variable).
expand-module (function).
extract-name (function).
make-identifier (function).
requested (reader method).
requested (reader method).
resolve-module (function).
modularize/options.lispmodule.lisp (file).
modularize (system).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
expand-option (method).
modularize/asdf.lispoptions.lisp (file).
modularize (system).
initialize-instance (method).
load-module (function).
module (class).
register-virtual-module (function).
reinitialize-instance (method).
remove-virtual-module (method).
remove-virtual-module (method).
resolve-dependency-combination (method).
virtual-module (method).
virtual-module (method).
(setf virtual-module) (method).
(setf virtual-module) (method).
virtual-module (class).
virtual-module-name (reader method).
(setf virtual-module-name) (writer method).
virtual-module-not-found (condition).
*virtual-module-map* (special variable).
requested (reader method).
modularize/documentation.lispasdf.lisp (file).
modularize (system).
Packages are listed by definition order.
org.shirakumo.radiance.lib.modularize.usermodularize-user
common-lisp.
modularize.
modularizeorg.shirakumo.radiance.lib.modularize
radiance-modularize
common-lisp.
call-delete-hooks (function).
call-modularize-hooks (function).
current-module (macro).
define-delete-hook (macro).
define-modularize-hook (macro).
define-module (macro).
define-module-extension (macro).
define-option-expander (macro).
delete-hook (function).
(setf delete-hook) (function).
delete-module (function).
demodularize (function).
expand-option (generic function).
list-modules (function).
load-module (function).
map-modules (function).
modularize (function).
modularize-hook (function).
(setf modularize-hook) (function).
module (function).
module (class).
module-identifier (function).
module-name (function).
module-not-found (condition).
module-p (function).
module-packages (function).
(setf module-packages) (function).
module-storage (function).
(setf module-storage) (function).
module-storage-remove (function).
not-a-module (condition).
register-virtual-module (function).
remove-delete-hook (function).
remove-modularize-hook (function).
remove-virtual-module (generic function).
virtual-module (generic function).
(setf virtual-module) (generic function).
virtual-module (class).
virtual-module-name (generic reader).
(setf virtual-module-name) (generic writer).
virtual-module-not-found (condition).
with-module (macro).
*delete-hooks* (special variable).
*modularize-hooks* (special variable).
*module-deferrals* (special variable).
*module-storages* (special variable).
*virtual-module-map* (special variable).
add-package-nickname (function).
collect-symbols-from (function).
ensure-package (function).
expand-module (function).
extend-package (function).
extract-name (function).
make-identifier (function).
requested (generic reader).
resolve-module (function).
unbind-and-delete-package (function).
with-package (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Macro that expands to the module in the current package. Useful to establish a module context.
Defines a new deletion hook.
The identifier is defaulted to a keyword representation of the current package name.
Defines a new modularization hook.
The identifier is defaulted to a keyword representation of the current package name.
Defines a new module.
This essentially defines a new package with the given name, calls MODULARIZE on it and then expands all options to extend the package/module.
Defines a module extension.
This gives the existing module new nicknames and expands the given options on it to add functionality.
Defines a new option expander that is called whenever the option is used in the module definition.
This should run whatever is necessary to accomplish the
desired option effect. The expanders are run AFTER the
modularize call, so you can use the module storage in
your expansions.
Binds the resolved MODULE to VAR.
Calls all deletion hooks on the package.
Calls all modularization hooks on the package.
Accesses the deletion hook function associated with the identifier.
Attempts to completely delete the given module.
This first calls the delete hooks, then demodularizes the package, unbinds all symbols in the package from values and functions, and finally deletes the package.
Removes the module from the module storage table.
This essentially returning it back to a normal package. Any additional effects by module options or modularization hooks can of course not be undone by this.
Returns a list of all modules in no particular order.
Attempts to find the module named by identifier and load its ASDF system.
Calls the function once with each module in no particular order.
Turns the given package into one that is identified as a module.
What this does is register the package on the module
storage table, add the name and identifiers to it,
and then call the modularize hooks.
Accessor to the modularization hook function associated with the identifier.
Attempts to return the matching module package.
If not possible, a condition of type MODULE-NOT-FOUND is signalled.
You may pass a STRING, SYMBOL or PACKAGE as the identifier.
If NIL is passed, the current *PACKAGE* is used instead.
Returns the identifier of the module.
Returns the name of the module.
Returns non-NIL if the passed object is or resolves to a module package, otherwise NIL.
Accesses the packages that are sub-packages under the module.
The list may contain package objects or package-names.
You can only add packages that are not already registered as sub-packages to a module, and are not themselves a module.
Accesses the module storage table of the module or a field from it if a key is passed.
Removes a key from the module storage table.
Registers the given module in the virtual module map.
Removes the deletion hook named by the identifier.
Removes the modularization hook named by the identifier.
Called to expand module options into forms.
(eql :packages)) module args0) ¶(eql :local-nicknames)) package args0) ¶(eql :size)) package args0) ¶(eql :intern)) package args0) ¶(eql :export)) package args0) ¶(eql :import-from)) package args0) ¶(eql :shadowing-import-from)) package args0) ¶(eql :shadow)) package args0) ¶(eql :use)) package args0) ¶(eql :documentation)) package args0) ¶(eql :nicknames)) package args0) ¶Removes the association of the name with a virtual module.
Accesses the virtual module instance associated with the identifier if one was found, otherwise NIL.
Returns the module name associated with this virtual module.
virtual-module)) ¶virtual-module)) ¶automatically generated writer method
virtual-module) &key) ¶virtual-module) &key) ¶virtual-module) (combinator (eql :module)) args) ¶asdf/find-component.
Condition signalled when a module is requested but not found.
error.
Condition signalled when a module is requested but only a package of the requested name exists.
error.
Condition signalled when a virtual module was requested but could not be found.
error.
ASDF System subclass that serves as the class for virtual modules.
Deprecated– use VIRTUAL-MODULE instead.
ASDF System subclass that serves as the class for virtual modules.
system.
:module-name
Table mapping the deletion hook names to their functions.
Table mapping the modularization hook names to their functions.
Table mapping packages to their modules.
Table mapping module packages to their storage tables.
Map of virtual module names to the asdf system instances of the virtual modules.
Shortcut macro to bind the ENSURE-PACKAGE value of PACKAGE to VAR.
Adds the nickname onto the package’s nicknames list.
Collects all given symbols from the package.
Ensures that THING is a package-object, or errors if it cannot resolve it to a package.
Expands the module options into their proper forms using EXPAND-OPTION for each.
Extends the package with the package definition options.
Any option except for the SIZE option is allowed. Note that this only ADDS onto the package and does not remove any options defined prior. As in, nicknames are only added on, but not removed.
Extracts the name from an identifier, which is to say the string after the last dot.
Turns a name into an identifier by prepending MODULARIZE.MOD. to it.
Resolves the object to the proper module package, if any.
Unbinds all symbols in the package from their functions and values and finally deletes the package.
virtual-module-not-found)) ¶not-a-module)) ¶module-not-found)) ¶| Jump to: | (
A C D E F G I L M R U V W |
|---|
| Jump to: | (
A C D E F G I L M R U V W |
|---|
| Jump to: | %
*
M S |
|---|
| Jump to: | %
*
M S |
|---|
| Jump to: | A C D F H M N O P S V |
|---|
| Jump to: | A C D F H M N O P S V |
|---|