This is the log5 Reference Manual, version 0.3.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:57:51 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
log5Log5 is a Common Lisp logging library
Gary Warren King <gwking@metabang.com>
Gary Warren King <gwking@metabang.com>
MIT License (see the fike COPYING for details)
0.3.2
dev (module).
Modules are listed depth-first from the system components tree.
log5/devlog5 (system).
log5.lisp (file).
category-defs.lisp (file).
port.lisp (file).
config.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
log5/log5.asdlog5/dev/log5.lisplog5/dev/category-defs.lisplog5/dev/port.lisplog5/dev/config.lisplog5/dev/log5.lispdev (module).
log5.
basic-sender (class).
category-spec (reader method).
category-specs (function).
close-sender (generic function).
close-stream? (reader method).
compile-category-spec (function).
(setf compile-category-spec) (function).
create-handle-message-context (generic function).
debugging (function).
defcategory (macro).
defoutput (macro).
finish-handling (generic function).
id->category (function).
ignore-errors-p (function).
(setf ignore-errors-p) (function).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
location (reader method).
log-for (macro).
log-if (macro).
log-manager (function).
log-manager (structure).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
output-spec (reader method).
output-specs (function).
output-stream (reader method).
pop-context (function).
pop-indent (function).
print-object (method).
print-object (method).
push-context (function).
push-indent (function).
sender-with-categories (class).
senders (function).
start-handling (generic function).
start-sender (macro).
start-stream-sender (macro).
stop-all-senders (function).
stop-sender (macro).
stream-sender (class).
stream-sender-mixin (class).
undebugging (function).
when-logging (macro).
with-context (macro).
with-context-for (macro).
with-indent (macro).
%handle-message (function).
%log-p (function).
%set-message-creator (writer method).
%with-vars (macro).
*category-specs* (special variable).
*default-logical-connective* (special variable).
*id->category* (special variable).
*log-manager* (special variable).
*name->category* (special variable).
*output-specs* (special variable).
active-categories (reader method).
active-category-p (function).
bad-category-type-error (condition).
basic-message-creator (class).
build-handle-message-fn (function).
built-in-output-specs (function).
canonize-category-name (function).
canonize-category-specification (function).
category-documentation (reader).
(setf category-documentation) (writer).
category-expanded-specification (reader).
(setf category-expanded-specification) (writer).
category-id (reader).
(setf category-id) (writer).
category-name (reader).
(setf category-name) (writer).
category-negated-variables (reader).
(setf category-negated-variables) (writer).
category-specification (reader).
(setf category-specification) (writer).
category-variables (reader).
(setf category-variables) (writer).
collect-key-value (function).
compile-handle-message-fn (function).
copy-log-category (function).
copy-log-manager (function).
copy-log-output (function).
create-message-for-sender (generic function).
debug-console-sender (class).
determine-category-variables (function).
dotted-pair-p (function).
ensure-stream-open (function).
expand-category (function).
expanded-specification (reader method).
find-or-create-debug-console (function).
flatten (function).
handle-message (macro).
handle-message-fn (reader method).
handle-output (generic function).
initialize-category-spec (function).
lock (reader method).
log-category (structure).
log-category-p (function).
log-manager-p (function).
log-output (structure).
log-output-p (function).
log5-compile-category-spec (reader).
(setf log5-compile-category-spec) (writer).
log5-context (reader).
(setf log5-context) (writer).
log5-debug-console (reader).
(setf log5-debug-console) (writer).
log5-expanded-compile-category-spec (reader).
(setf log5-expanded-compile-category-spec) (writer).
log5-ignore-errors? (reader).
(setf log5-ignore-errors?) (writer).
log5-indents (reader).
(setf log5-indents) (writer).
log5-senders (reader).
(setf log5-senders) (writer).
logical-connective-p (function).
make-active-category-array (function).
make-category-array (function).
make-indent-space (function).
make-log-category (function).
make-log-manager (function).
make-log-output (function).
message-creator (reader method).
message-creator-class (function).
name->category (function).
output-form (reader).
(setf output-form) (writer).
output-format (reader).
(setf output-format) (writer).
output-name (reader).
(setf output-name) (writer).
output-not-found-error (condition).
output-static? (reader).
(setf output-static?) (writer).
predefined-output-p (function).
print-category (function).
print-sender (generic function).
reset-categories! (function).
reset-output-specs! (function).
sender-name (reader method).
sender-not-found-warning (condition).
sender-responds-to-category-p (function).
separate-properties (generic function).
simple-category-not-found-error (condition).
specs (reader method).
(setf specs) (writer method).
start-sender-fn (function).
stop-sender-fn (function).
update-active-categories (generic function).
update-category-spec (function).
update-output-spec (function).
valid-output-p (function).
log5/dev/config.lisplog5.lisp (file).
dev (module).
configuration-file (function).
configure-from-file (function).
massage-arguments (function).
Packages are listed by definition order.
log5A Common Lisp logging library; CLLL? No, it’s log5. Log5 is organized around 5 things:
* Categories,
* Senders,
* Outputs,
* Messages, and
* the Context
common-lisp.
basic-sender (class).
category-spec (generic reader).
category-specs (function).
close-sender (generic function).
close-stream? (generic reader).
compile-category-spec (function).
(setf compile-category-spec) (function).
configuration-file (function).
configure-from-file (function).
create-handle-message-context (generic function).
debugging (function).
defcategory (macro).
defoutput (macro).
finish-handling (generic function).
id->category (function).
ignore-errors-p (function).
(setf ignore-errors-p) (function).
location (generic reader).
log-for (macro).
log-if (macro).
log-manager (function).
log-manager (structure).
name (generic reader).
output-spec (generic reader).
output-specs (function).
output-stream (generic reader).
pop-context (function).
pop-indent (function).
push-context (function).
push-indent (function).
sender-with-categories (class).
senders (function).
start-handling (generic function).
start-sender (macro).
start-stream-sender (macro).
stop-all-senders (function).
stop-sender (macro).
stream-sender (class).
stream-sender-mixin (class).
undebugging (function).
when-logging (macro).
with-context (macro).
with-context-for (macro).
with-indent (macro).
%handle-message (function).
%log-p (function).
%set-message-creator (generic writer).
%with-vars (macro).
*category-specs* (special variable).
*default-logical-connective* (special variable).
*id->category* (special variable).
*log-manager* (special variable).
*name->category* (special variable).
*output-specs* (special variable).
active-categories (generic reader).
active-category-p (function).
bad-category-type-error (condition).
basic-message-creator (class).
build-handle-message-fn (function).
built-in-output-specs (function).
canonize-category-name (function).
canonize-category-specification (function).
category-documentation (reader).
(setf category-documentation) (writer).
category-expanded-specification (reader).
(setf category-expanded-specification) (writer).
category-id (reader).
(setf category-id) (writer).
category-name (reader).
(setf category-name) (writer).
category-negated-variables (reader).
(setf category-negated-variables) (writer).
category-specification (reader).
(setf category-specification) (writer).
category-variables (reader).
(setf category-variables) (writer).
collect-key-value (function).
compile-handle-message-fn (function).
copy-log-category (function).
copy-log-manager (function).
copy-log-output (function).
create-message-for-sender (generic function).
debug-console-sender (class).
determine-category-variables (function).
dotted-pair-p (function).
ensure-stream-open (function).
expand-category (function).
expanded-specification (generic reader).
find-or-create-debug-console (function).
flatten (function).
handle-message (macro).
handle-message-fn (generic reader).
handle-output (generic function).
initialize-category-spec (function).
lock (generic reader).
log-category (structure).
log-category-p (function).
log-manager-p (function).
log-output (structure).
log-output-p (function).
log5-compile-category-spec (reader).
(setf log5-compile-category-spec) (writer).
log5-context (reader).
(setf log5-context) (writer).
log5-debug-console (reader).
(setf log5-debug-console) (writer).
log5-expanded-compile-category-spec (reader).
(setf log5-expanded-compile-category-spec) (writer).
log5-ignore-errors? (reader).
(setf log5-ignore-errors?) (writer).
log5-indents (reader).
(setf log5-indents) (writer).
log5-senders (reader).
(setf log5-senders) (writer).
logical-connective-p (function).
make-active-category-array (function).
make-category-array (function).
make-indent-space (function).
make-log-category (function).
make-log-manager (function).
make-log-output (function).
massage-arguments (function).
message-creator (generic reader).
message-creator-class (function).
name->category (function).
output-form (reader).
(setf output-form) (writer).
output-format (reader).
(setf output-format) (writer).
output-name (reader).
(setf output-name) (writer).
output-not-found-error (condition).
output-static? (reader).
(setf output-static?) (writer).
predefined-output-p (function).
print-category (function).
print-sender (generic function).
reset-categories! (function).
reset-output-specs! (function).
sender-name (generic reader).
sender-not-found-warning (condition).
sender-responds-to-category-p (function).
separate-properties (generic function).
simple-category-not-found-error (condition).
specs (generic reader).
(setf specs) (generic writer).
start-sender-fn (function).
stop-sender-fn (function).
update-active-categories (generic function).
update-category-spec (function).
update-output-spec (function).
valid-output-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a category named ‘name‘. This can be a simple category like
(defcategory :error)
(defcategory prize-allocation)
of a complex category like
(defcategory :bad-thing (or :error :warning :fatal))
(defcategory non-file-foo (and (or foo bar biz) (not file-access)))
Specifically, a simple category is just a name whereas a complex category is a boolean combination of other categories (either simple or complex). See ‘category-specs‘ if you want a list of defined categories.
Define an output specification: a link between a ‘name‘ and a ‘form‘ that will be called during logging to put something in the log file.
You can specify a ‘format‘ string (as in a call to ‘format‘) with the
:format keyword argument. You can use the keyword :static? to indicate
that the form’s value will not change (e.g., the time of day is _not_
static but the process id of the current Lisp is).
Create a log-message sender and add it to the list of active
senders. Each sender has a ‘name‘, a category-spec, an output-spec and
a class (with optional initialization arguments). The ‘name‘ should be
symbol and only one sender of any particular name can exist at a time.
The category-spec is a boolean combination of categories (see ‘defcategory‘).
A sender will send any message whose message-category satisfies the sender’s
category-spec.
The output-spec is a list of outputs defined with ‘defoutput‘. You can also
include strings and the special, predefined, outputs:
* message - the text of the current log message
* context - the contents of the current context (as a list)
* category - the value of the category of the current message
Find the sender named ‘name‘ and stop it. If the sender is not active, then a ‘sender-not-found-warning‘ will be signaled unless ‘warn-if-not-found-p‘ is set to nil.
Returns a list of the defined category specs in alphatetical order.
Returns the path to the standard log5 configuration file. This is used by ‘configure-from-file‘ to setup logging activitiy. ‘Configuration-file looks in the
user’s home directory (using ‘user-homedir-pathname‘) and the directory specified by ‘*default-pathname-defaults*‘. The default is to use a file named "logging.config" but you can use the ‘:name‘ and ‘:type‘ parameters to customize this. If files exist in both directories, the ‘configuration-file‘ will use the one in the home directory unless ‘:prefer-current-directory-p‘ is true.
log5.
Returns the category whose id is id (a number).
If true, then log5 will ignore any errors that occur during logging actions. If false, log5 will enter the debugging. This is setfable.
If true, then log5 will ignore any errors that occur during logging actions. If false, log5 will enter the debugger. This is setfable.
Returns the component that handles all of log5’s bookkeeping.
Returns a list of the current output specs in alphatetical order.
log5.
sender-with-categories)) ¶automatically generated reader method
log5.
stream-sender-mixin)) ¶log5.
stream-sender-mixin)) ¶automatically generated reader method
log5.
stream-sender-mixin)) ¶basic-sender)) ¶log5.
stream-sender-mixin)) ¶basic-sender)) ¶log5.
stream-sender-mixin)) ¶automatically generated reader method
log5.
basic-sender)) ¶automatically generated reader method
output-not-found-error)) ¶simple-category-not-found-error)) ¶bad-category-type-error)) ¶log5.
basic-sender)) ¶automatically generated reader method
log5.
stream-sender-mixin)) ¶automatically generated reader method
log5.
stream-sender-mixin)) ¶basic-sender)) ¶basic-sender) &key message-creator message-creator-class) ¶stream-sender-mixin) &key) ¶sender-with-categories) &key) ¶basic-sender) stream) ¶log-category) stream) ¶log5.
structure-object.
The root sender class from which all senders ~ should descend.
log5.
:output-spec
This slot is read-only.
This slot is read-only.
log5::basic-message-creator
(log5::make-category-array 0)
This slot is read-only.
A sender that responds only to certain log categories.
log5.
log5.
log5.
log5.
Returns true if and only if ‘putative-pair‘ is a dotted-list. I.e., if ‘putative-pair‘ is a cons cell with a non-nil cdr.
Flattens LIST. Does not handle circular lists but does handle dotted lists.
log5.
log5.
log5.
log5.
Returns the category whose name (assumed to be properly **canonized**) is name.
Remove all category definitions; In general, it’s not a good idea to use this but it can be handy if you need a clean slate.
Remove all output-specs; In general, it’s not a good idea to use this but it can be handy if you need a clean slate.
log5.
basic-sender) basic-sender) ¶automatically generated writer method
log5.
basic-sender)) ¶automatically generated reader method
log5.
basic-message-creator) message args) ¶basic-sender) message args) ¶log5.
sender-with-categories)) ¶automatically generated reader method
log5.
basic-sender)) ¶automatically generated reader method
log5.
stream-sender-mixin) output) ¶log5.
basic-sender)) ¶automatically generated reader method
log5.
basic-sender)) ¶automatically generated reader method
Print information about sender to stream
log5.
basic-sender) stream) ¶log5.
sender-not-found-warning)) ¶log5.
stream-sender-mixin)) ¶basic-sender)) ¶log5.
debug-console-sender)) ¶automatically generated reader method
log5.
debug-console-sender)) ¶automatically generated writer method
log5.
sender-with-categories) max-id) ¶basic-sender) max-id) ¶log5.
structure-object.
common-lisp.
| Jump to: | %
(
A B C D E F G H I L M N O P R S U V W |
|---|
| Jump to: | %
(
A B C D E F G H I L M N O P R S U V W |
|---|
| Jump to: | *
A C D E F H I L M N O S V |
|---|
| Jump to: | *
A C D E F H I L M N O S V |
|---|
| Jump to: | B C D F L M O P S |
|---|
| Jump to: | B C D F L M O P S |
|---|