The quickutil Reference Manual

This is the quickutil Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:01:42 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 quickutil

The Quickutil client.

Author

Robert Smith <>

License

BSD 3-clause. See LICENSE file.

Dependency

quickutil-client (system).

Source

quickutil.asd.

Child Component

clean-up-quickutil.lisp (file).


2.2 quickutil-client

The Quickutil client for loading utility code.

Author

Robert Smith <>

License

BSD 3-clause. See LICENSE file.

Defsystem Dependency

quickutil-client-management (system).

Dependencies
  • cl-fad (system).
  • quickutil-utilities (system).
Source

quickutil-client.asd.

Child Components

2.3 quickutil-client-management

The Quickutil client manager.

Author

Robert Smith <>

License

BSD 3-clause. See LICENSE file.

Dependency

trivial-garbage (system).

Source

quickutil-client-management.asd.

Child Component

management.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 quickutil/quickutil.asd

Source

quickutil.asd.

Parent Component

quickutil (system).

ASDF Systems

quickutil.


3.1.2 quickutil-client/quickutil-client.asd

Source

quickutil-client.asd.

Parent Component

quickutil-client (system).

ASDF Systems

quickutil-client.


3.1.3 quickutil-client-management/quickutil-client-management.asd

Source

quickutil-client-management.asd.

Parent Component

quickutil-client-management (system).

ASDF Systems

quickutil-client-management.


3.1.4 quickutil/clean-up-quickutil.lisp

Source

quickutil.asd.

Parent Component

quickutil (system).


3.1.5 quickutil-client/package.lisp

Source

quickutil-client.asd.

Parent Component

quickutil-client (system).

Packages

3.1.6 quickutil-client/bookkeeping.lisp

Dependency

package.lisp (file).

Source

quickutil-client.asd.

Parent Component

quickutil-client (system).

Public Interface

*utilities* (special variable).


3.1.7 quickutil-client/conditions.lisp

Dependency

bookkeeping.lisp (file).

Source

quickutil-client.asd.

Parent Component

quickutil-client (system).

Public Interface
Internals

utility-not-found-error-names (reader method).


3.1.8 quickutil-client/quickutil-client.lisp

Dependency

conditions.lisp (file).

Source

quickutil-client.asd.

Parent Component

quickutil-client (system).

Public Interface
Internals

3.1.9 quickutil-client/autoload.lisp

Dependency

quickutil-client.lisp (file).

Source

quickutil-client.asd.

Parent Component

quickutil-client (system).

Public Interface

enable-autoload-syntax (function).

Internals

#?-reader (function).


3.1.10 quickutil-client-management/management.lisp

Source

quickutil-client-management.asd.

Parent Component

quickutil-client-management (system).

Packages

quickutil-client-management.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 quickutil-client

Contains client-side code for acquiring, compiling, loading, and saving utilties.

Source

package.lisp.

Nickname

qtlc

Use List

common-lisp.

Public Interface
Internals

4.2 quickutil-client-management

Source

management.lisp.

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

4.3 quickutil

Package that contains the actual utility functions.

Source

package.lisp.

Nickname

qtl

Use List

common-lisp.

Public Interface

*utilities* (special variable).


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: *utilities*

A list of the loaded utilities.

Package

quickutil.

Source

bookkeeping.lisp.

Special Variable: *verbose*

Dictates whether loading should be verbose.

Package

quickutil-client-management.

Source

management.lisp.


5.1.2 Macros

Macro: with-quickutil-utilities (&body body)

Load Quickutil utilities, execute BODY, and unload them, returning the last result of BODY.

Package

quickutil-client-management.

Source

management.lisp.


5.1.3 Ordinary functions

Function: enable-autoload-syntax ()

Enable the use of #?SYMBOL, which automatically loads the symbol SYMBOL from Quickutil.

Package

quickutil-client.

Source

autoload.lisp.

Function: load-quickutil-utilities (&key verbose)
Package

quickutil-client-management.

Source

management.lisp.

Function: save-utils-as (filename &key utilities categories symbols package package-nickname ensure-package)

Save all of the utilities specified by the lists UTILITIES, CATEGORIES, and SYMBOLS to the file named FILENAME.

The utilities will be put in the package named PACKAGE. If ENSURE-PACKAGE is true, then the package will be created if it has not already. If it has not been created, the package will be given the nickname PACKAGE-NICKNAME. If the nickname is NIL, then no nickname will be created.

Package

quickutil-client.

Source

quickutil-client.lisp.

Function: unload-quickutil-utilities (&key verbose)
Package

quickutil-client-management.

Source

management.lisp.

Function: utility-not-found-error (util-names)

Error when a utilities named UTIL-NAMES are not found.

Package

quickutil-client.

Source

conditions.lisp.

Function: utilize (&key utilities categories symbols)
Package

quickutil-client.

Source

quickutil-client.lisp.

Function: utilize-categories (categories)

Load the utilities in the categories CATEGORIES.

Package

quickutil-client.

Source

quickutil-client.lisp.

Function: utilize-symbols (symbols)

Load the utilities which provide the symbols SYMBOLS.

Package

quickutil-client.

Source

quickutil-client.lisp.

Function: utilize-utilities (utilities)

Load the utilities UTILITIES and their dependencies.

Package

quickutil-client.

Source

quickutil-client.lisp.

Function: who-provides (symbol)

Which utility provides the symbol SYMBOL?

Package

quickutil-client.

Source

quickutil-client.lisp.


5.1.4 Conditions

Condition: utility-not-found-error

Error to be invoked when a utility is not found.

Package

quickutil-client.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

utility-not-found-error-names.

Direct slots
Slot: name
Initargs

:names

Readers

utility-not-found-error-names.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Macros

Macro: funcall-qtl-utl (function &rest args)
Package

quickutil-client.

Source

quickutil-client.lisp.

Macro: with-temp-file (stream-var file-var &body body)
Package

quickutil-client.

Source

quickutil-client.lisp.


5.2.2 Ordinary functions

Function: #?-reader (stream subchar n)
Package

quickutil-client.

Source

autoload.lisp.

Function: clean-and-delete-package (package-designator)

Clean up the package designated by PACKAGE-DESIGNATOR (unbind all of the bound symbols), and delete the package, if it exists.

Package

quickutil-client-management.

Source

management.lisp.

Function: ensure-keyword-list (list)

Ensure that LIST is a list of keywords.

Package

quickutil-client.

Source

quickutil-client.lisp.

Function: print-lines (stream &rest strings)

Print the lines denoted by the strings STRINGS to the stream STREAM.

Package

quickutil-client.

Source

quickutil-client.lisp.

Function: qtl-utl (symbol)
Package

quickutil-client.

Source

quickutil-client.lisp.

Function: symbol-accessible-from-package (symbol package)

Is the symbol SYMBOL accessible from the package PACKAGE?

Package

quickutil-client-management.

Source

management.lisp.

Function: unbind-symbol (symbol)

Ensure the symbol denoting a variable, function, or macro is unbound.

A continuable error will be signaled if it is a symbol in the CL package.

Package

quickutil-client-management.

Source

management.lisp.

Function: utility-source-code (&key utilities categories symbols emit-in-package-form)
Package

quickutil-client.

Source

quickutil-client.lisp.


5.2.3 Generic functions

Generic Reader: utility-not-found-error-names (condition)
Package

quickutil-client.

Methods
Reader Method: utility-not-found-error-names ((condition utility-not-found-error))
Source

conditions.lisp.

Target Slot

name.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   #  
C   E   F   G   L   M   P   Q   S   U   W  
Index Entry  Section

#
#?-reader: Private ordinary functions

C
clean-and-delete-package: Private ordinary functions

E
enable-autoload-syntax: Public ordinary functions
ensure-keyword-list: Private ordinary functions

F
funcall-qtl-utl: Private macros
Function, #?-reader: Private ordinary functions
Function, clean-and-delete-package: Private ordinary functions
Function, enable-autoload-syntax: Public ordinary functions
Function, ensure-keyword-list: Private ordinary functions
Function, load-quickutil-utilities: Public ordinary functions
Function, print-lines: Private ordinary functions
Function, qtl-utl: Private ordinary functions
Function, save-utils-as: Public ordinary functions
Function, symbol-accessible-from-package: Private ordinary functions
Function, unbind-symbol: Private ordinary functions
Function, unload-quickutil-utilities: Public ordinary functions
Function, utility-not-found-error: Public ordinary functions
Function, utility-source-code: Private ordinary functions
Function, utilize: Public ordinary functions
Function, utilize-categories: Public ordinary functions
Function, utilize-symbols: Public ordinary functions
Function, utilize-utilities: Public ordinary functions
Function, who-provides: Public ordinary functions

G
Generic Function, utility-not-found-error-names: Private generic functions

L
load-quickutil-utilities: Public ordinary functions

M
Macro, funcall-qtl-utl: Private macros
Macro, with-quickutil-utilities: Public macros
Macro, with-temp-file: Private macros
Method, utility-not-found-error-names: Private generic functions

P
print-lines: Private ordinary functions

Q
qtl-utl: Private ordinary functions

S
save-utils-as: Public ordinary functions
symbol-accessible-from-package: Private ordinary functions

U
unbind-symbol: Private ordinary functions
unload-quickutil-utilities: Public ordinary functions
utility-not-found-error: Public ordinary functions
utility-not-found-error-names: Private generic functions
utility-not-found-error-names: Private generic functions
utility-source-code: Private ordinary functions
utilize: Public ordinary functions
utilize-categories: Public ordinary functions
utilize-symbols: Public ordinary functions
utilize-utilities: Public ordinary functions

W
who-provides: Public ordinary functions
with-quickutil-utilities: Public macros
with-temp-file: Private macros


A.4 Data types

Jump to:   A   B   C   F   M   P   Q   S   U  
Index Entry  Section

A
autoload.lisp: The quickutil-client/autoload․lisp file

B
bookkeeping.lisp: The quickutil-client/bookkeeping․lisp file

C
clean-up-quickutil.lisp: The quickutil/clean-up-quickutil․lisp file
Condition, utility-not-found-error: Public conditions
conditions.lisp: The quickutil-client/conditions․lisp file

F
File, autoload.lisp: The quickutil-client/autoload․lisp file
File, bookkeeping.lisp: The quickutil-client/bookkeeping․lisp file
File, clean-up-quickutil.lisp: The quickutil/clean-up-quickutil․lisp file
File, conditions.lisp: The quickutil-client/conditions․lisp file
File, management.lisp: The quickutil-client-management/management․lisp file
File, package.lisp: The quickutil-client/package․lisp file
File, quickutil-client-management.asd: The quickutil-client-management/quickutil-client-management․asd file
File, quickutil-client.asd: The quickutil-client/quickutil-client․asd file
File, quickutil-client.lisp: The quickutil-client/quickutil-client․lisp file
File, quickutil.asd: The quickutil/quickutil․asd file

M
management.lisp: The quickutil-client-management/management․lisp file

P
Package, quickutil: The quickutil package
Package, quickutil-client: The quickutil-client package
Package, quickutil-client-management: The quickutil-client-management package
package.lisp: The quickutil-client/package․lisp file

Q
quickutil: The quickutil system
quickutil: The quickutil package
quickutil-client: The quickutil-client system
quickutil-client: The quickutil-client package
quickutil-client-management: The quickutil-client-management system
quickutil-client-management: The quickutil-client-management package
quickutil-client-management.asd: The quickutil-client-management/quickutil-client-management․asd file
quickutil-client.asd: The quickutil-client/quickutil-client․asd file
quickutil-client.lisp: The quickutil-client/quickutil-client․lisp file
quickutil.asd: The quickutil/quickutil․asd file

S
System, quickutil: The quickutil system
System, quickutil-client: The quickutil-client system
System, quickutil-client-management: The quickutil-client-management system

U
utility-not-found-error: Public conditions