The log5 Reference Manual

Parent Component

log5 (system).

Child Components

log5.lisp (file).
category-defs.lisp (file).
port.lisp (file).
config.lisp (file).

3 Files

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

Lisp

3.1.1 `log5/log5.asd`

Source: log5.asd.
Parent Component: log5 (system).
ASDF Systems: log5.
Packages: log5-system.

3.1.2 `log5/dev/log5.lisp`

Source

Parent Component

dev (module).

Packages

Public Interface

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

Internals

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

3.1.3 `log5/dev/category-defs.lisp`

Dependency: log5.lisp (file).
Source: log5.asd.
Parent Component: dev (module).

3.1.4 `log5/dev/port.lisp`

Dependency: log5.lisp (file).
Source: log5.asd.
Parent Component: dev (module).

3.1.5 `log5/dev/config.lisp`

Dependency

log5.lisp (file).

Source

Parent Component

dev (module).

Public Interface

configuration-file (function).
configure-from-file (function).

Internals

massage-arguments (function).

4 Packages

Packages are listed by definition order.

log5
log5-system

4.1 `log5`

A Common Lisp logging library; CLLL? No, it’s log5. Log5 is organized around 5 things:

* Categories,
* Senders,
* Outputs,
* Messages, and
* the Context

Source

Use List

common-lisp.

Public Interface

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

Internals

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

4.2 `log5-system`

Source

Use List

asdf/interface.
common-lisp.

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Standalone methods
Structures
Classes

5.1.1 Macros

Macro: defcategory (name &optional category-spec documentation) ¶

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.

Package: log5.
Source: log5.lisp.

Macro: defoutput (name form &key format static?) ¶

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

Package: log5.
Source: log5.lisp.

Macro: log-for (category-spec message &rest args) ¶

Package: log5.
Source: log5.lisp.

Macro: log-if (predicate category-spec message &rest args) ¶

Package: log5.
Source: log5.lisp.

Macro: start-sender (name (sender-type &rest args) &key category-spec output-spec) ¶

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

Package: log5.
Source: log5.lisp.

Macro: start-stream-sender (name location &key output-spec category-spec) ¶

Package: log5.
Source: log5.lisp.

Macro: stop-sender (name &key warn-if-not-found-p) ¶

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.

Package: log5.
Source: log5.lisp.

Macro: when-logging (category-spec &body body) ¶

Package: log5.
Source: log5.lisp.

Macro: with-context (context &body body) ¶

Package: log5.
Source: log5.lisp.

Macro: with-context-for (category-spec context &body body) ¶

Package: log5.
Source: log5.lisp.

Macro: with-indent ((amount &rest args &key &allow-other-keys) &body body) ¶

Package: log5.
Source: log5.lisp.

5.1.2 Ordinary functions

Function: category-specs () ¶

Returns a list of the defined category specs in alphatetical order.

Package: log5.
Source: log5.lisp.

Function: compile-category-spec () ¶

Package: log5.
Source: log5.lisp.

Function: (setf compile-category-spec) () ¶

Package: log5.
Source: log5.lisp.

Function: configuration-file (&key name type prefer-current-directory-p) ¶

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.

Package: log5.
Source: config.lisp.

Function: configure-from-file (path &key stop-senders-first?) ¶

Package: log5.
Source: config.lisp.

Function: debugging (&optional category-spec &key output-spec reset?) ¶

Package: log5.
Source: log5.lisp.

Function: id->category (id) ¶

Returns the category whose id is id (a number).

Package: log5.
Source: log5.lisp.

Function: ignore-errors-p () ¶

If true, then log5 will ignore any errors that occur during logging actions. If false, log5 will enter the debugging. This is setfable.

Package: log5.
Source: log5.lisp.

Function: (setf ignore-errors-p) () ¶

If true, then log5 will ignore any errors that occur during logging actions. If false, log5 will enter the debugger. This is setfable.

Package: log5.
Source: log5.lisp.

Function: log-manager () ¶

Returns the component that handles all of log5’s bookkeeping.

Package: log5.
Source: log5.lisp.

Function: output-specs () ¶

Returns a list of the current output specs in alphatetical order.

Package: log5.
Source: log5.lisp.

Function: pop-context () ¶

Package: log5.
Source: log5.lisp.

Function: pop-indent () ¶

Package: log5.
Source: log5.lisp.

Function: push-context (context) ¶

Package: log5.
Source: log5.lisp.

Function: push-indent (amount &rest args &key &allow-other-keys) ¶

Package: log5.
Source: log5.lisp.

Function: senders () ¶

Returns a list of the current senders.

Package: log5.
Source: log5.lisp.

Function: stop-all-senders () ¶

Stops all logging.

Package: log5.
Source: log5.lisp.

Function: undebugging (&optional category-spec) ¶

Package: log5.
Source: log5.lisp.

5.1.3 Generic functions

Generic Reader: category-spec (object) ¶

Package

Methods

Reader Method: category-spec ((sender-with-categories sender-with-categories)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: category-spec.

Generic Function: close-sender (sender) ¶

Package

Source

Methods

Method: close-sender ((sender stream-sender-mixin)) ¶

Method: close-sender (sender) ¶

Generic Reader: close-stream? (object) ¶

Package

Methods

Reader Method: close-stream? ((stream-sender-mixin stream-sender-mixin)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: close-stream?.

Generic Function: create-handle-message-context (sender) ¶

Package

Source

Methods

Method: create-handle-message-context ((sender stream-sender-mixin)) ¶

Method: create-handle-message-context ((sender basic-sender)) ¶

Generic Function: finish-handling (sender) ¶

Package

Source

Methods

Method: finish-handling ((sender stream-sender-mixin)) ¶

Method: finish-handling ((sender basic-sender)) ¶

Generic Reader: location (object) ¶

Package

Methods

Reader Method: location ((stream-sender-mixin stream-sender-mixin)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: location.

Generic Reader: name (condition) ¶

Package

Methods

Reader Method: name ((basic-sender basic-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: name.

Reader Method: name ((condition output-not-found-error)) ¶

Source: log5.lisp.
Target Slot: name.

Reader Method: name ((condition simple-category-not-found-error)) ¶

Source: log5.lisp.
Target Slot: name.

Reader Method: name ((condition bad-category-type-error)) ¶

Source: log5.lisp.
Target Slot: name.

Generic Reader: output-spec (object) ¶

Package

Methods

Reader Method: output-spec ((basic-sender basic-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: output-spec.

Generic Reader: output-stream (object) ¶

Package

Methods

Reader Method: output-stream ((stream-sender-mixin stream-sender-mixin)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: output-stream.

Generic Function: start-handling (sender) ¶

Package

Source

Methods

Method: start-handling ((sender stream-sender-mixin)) ¶

Method: start-handling ((sender basic-sender)) ¶

5.1.4 Standalone methods

Method: initialize-instance :after ((object basic-sender) &key message-creator message-creator-class) ¶

Source: log5.lisp.

Method: initialize-instance :after ((object sender-with-categories) &key) ¶

Source: log5.lisp.

Method: initialize-instance :after ((object stream-sender-mixin) &key) ¶

Source: log5.lisp.

Method: print-object ((sender basic-sender) stream) ¶

Source: log5.lisp.

Method: print-object ((object log-category) stream) ¶

Source: log5.lisp.

5.1.5 Structures

Structure: log-manager ¶

Package

Source

Direct superclasses

structure-object.

Direct slots

Slot: senders ¶

Readers: log5-senders.
Writers: (setf log5-senders).

Slot: context ¶

Readers: log5-context.
Writers: (setf log5-context).

Slot: ignore-errors? ¶

Readers: log5-ignore-errors?.
Writers: (setf log5-ignore-errors?).

Slot: compile-category-spec ¶

Readers: log5-compile-category-spec.
Writers: (setf log5-compile-category-spec).

Slot: expanded-compile-category-spec ¶

Readers: log5-expanded-compile-category-spec.
Writers: (setf log5-expanded-compile-category-spec).

Slot: debug-console ¶

Readers: log5-debug-console.
Writers: (setf log5-debug-console).

Slot: indents ¶

Readers: log5-indents.
Writers: (setf log5-indents).

5.1.6 Classes

Class: basic-sender ¶

The root sender class from which all senders ~ should descend.

Package

Source

Direct subclasses

sender-with-categories.
stream-sender-mixin.

Direct methods

%set-message-creator.
active-categories.
create-handle-message-context.
create-message-for-sender.
finish-handling.
handle-message-fn.
initialize-instance.
lock.
message-creator.
name.
output-spec.
print-object.
print-sender.
separate-properties.
start-handling.
update-active-categories.

Direct slots

Slot: lock ¶

Readers: lock.
Writers: This slot is read-only.

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Slot: output-spec ¶

Initargs: :output-spec
Readers: output-spec.
Writers: This slot is read-only.

Slot: handle-message-fn ¶

Readers: handle-message-fn.
Writers: This slot is read-only.

Slot: message-creator ¶

Initargs: log5::basic-message-creator
Readers: message-creator.
Writers: %set-message-creator.

Slot: active-categories ¶

Initform: (log5::make-category-array 0)
Readers: active-categories.
Writers: This slot is read-only.

Class: sender-with-categories ¶

A sender that responds only to certain log categories.

Package

Source

Direct superclasses

basic-sender.

Direct subclasses

stream-sender.

Direct methods

category-spec.
expanded-specification.
initialize-instance.
update-active-categories.

Direct slots

Slot: category-spec ¶

Initargs: :category-spec
Readers: category-spec.
Writers: This slot is read-only.

Slot: expanded-specification ¶

Readers: expanded-specification.
Writers: This slot is read-only.

Class: stream-sender ¶

Package

Source

Direct superclasses

sender-with-categories.
stream-sender-mixin.

Direct subclasses

debug-console-sender.

Class: stream-sender-mixin ¶

Package

Source

Direct superclasses

basic-sender.

Direct subclasses

stream-sender.

Direct methods

close-sender.
close-stream?.
create-handle-message-context.
finish-handling.
handle-output.
initialize-instance.
location.
output-stream.
separate-properties.
start-handling.

Direct slots

Slot: output-stream ¶

Readers: output-stream.
Writers: This slot is read-only.

Slot: close-stream? ¶

Readers: close-stream?.
Writers: This slot is read-only.

Slot: location ¶

Initargs: :location
Readers: location.
Writers: This slot is read-only.

5.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Conditions
Structures
Classes

5.2.1 Special variables

Special Variable: *category-specs* ¶

Package: log5.
Source: log5.lisp.

Special Variable: *default-logical-connective* ¶

Package: log5.
Source: log5.lisp.

Special Variable: *id->category* ¶

Package: log5.
Source: log5.lisp.

Special Variable: *log-manager* ¶

Package: log5.
Source: log5.lisp.

Special Variable: *name->category* ¶

Package: log5.
Source: log5.lisp.

Special Variable: *output-specs* ¶

Package: log5.
Source: log5.lisp.

5.2.2 Macros

Macro: %with-vars (vars default &body body) ¶

Package: log5.
Source: log5.lisp.

Macro: handle-message (id message &rest args) ¶

Package: log5.
Source: log5.lisp.

5.2.3 Ordinary functions

Function: %handle-message (id message arg-thunk) ¶

Package: log5.
Source: log5.lisp.

Function: %log-p (category-spec) ¶

Package: log5.
Source: log5.lisp.

Function: active-category-p (id) ¶

Package: log5.
Source: log5.lisp.

Function: build-handle-message-fn (sender) ¶

Package: log5.
Source: log5.lisp.

Function: built-in-output-specs () ¶

Package: log5.
Source: log5.lisp.

Function: canonize-category-name (name &key simple?) ¶

Package: log5.
Source: log5.lisp.

Function: canonize-category-specification (specification) ¶

Package: log5.
Source: log5.lisp.

Reader: category-documentation (instance) ¶

Writer: (setf category-documentation) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: documentation.

Reader: category-expanded-specification (instance) ¶

Writer: (setf category-expanded-specification) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: expanded-specification.

Reader: category-id (instance) ¶

Writer: (setf category-id) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: id.

Reader: category-name (instance) ¶

Writer: (setf category-name) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: name.

Reader: category-negated-variables (instance) ¶

Writer: (setf category-negated-variables) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: negated-variables.

Reader: category-specification (instance) ¶

Writer: (setf category-specification) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: specification.

Reader: category-variables (instance) ¶

Writer: (setf category-variables) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: variables.

Function: collect-key-value (ht &key transform) ¶

Package: log5.
Source: log5.lisp.

Function: compile-handle-message-fn (fn) ¶

Package: log5.
Source: log5.lisp.

Function: copy-log-category (instance) ¶

Package: log5.
Source: log5.lisp.

Function: copy-log-manager (instance) ¶

Package: log5.
Source: log5.lisp.

Function: copy-log-output (instance) ¶

Package: log5.
Source: log5.lisp.

Function: determine-category-variables (spec) ¶

Package: log5.
Source: log5.lisp.

Function: dotted-pair-p (putative-pair) ¶

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.

Package: log5.
Source: log5.lisp.

Function: ensure-stream-open (stream-sender) ¶

Package: log5.
Source: log5.lisp.

Function: expand-category (name) ¶

Package: log5.
Source: log5.lisp.

Function: find-or-create-debug-console (&optional output-spec) ¶

Package: log5.
Source: log5.lisp.

Function: flatten (list) ¶

Flattens LIST. Does not handle circular lists but does handle dotted lists.

Package: log5.
Source: log5.lisp.

Function: initialize-category-spec (sender) ¶

Package: log5.
Source: log5.lisp.

Function: log-category-p (object) ¶

Package: log5.
Source: log5.lisp.

Function: log-manager-p (object) ¶

Package: log5.
Source: log5.lisp.

Function: log-output-p (object) ¶

Package: log5.
Source: log5.lisp.

Reader: log5-compile-category-spec (instance) ¶

Writer: (setf log5-compile-category-spec) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: compile-category-spec.

Reader: log5-context (instance) ¶

Writer: (setf log5-context) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: context.

Reader: log5-debug-console (instance) ¶

Writer: (setf log5-debug-console) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: debug-console.

Reader: log5-expanded-compile-category-spec (instance) ¶

Writer: (setf log5-expanded-compile-category-spec) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: expanded-compile-category-spec.

Reader: log5-ignore-errors? (instance) ¶

Writer: (setf log5-ignore-errors?) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: ignore-errors?.

Reader: log5-indents (instance) ¶

Writer: (setf log5-indents) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: indents.

Reader: log5-senders (instance) ¶

Writer: (setf log5-senders) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: senders.

Function: logical-connective-p (x) ¶

Package: log5.
Source: log5.lisp.

Function: make-active-category-array (sender) ¶

Package: log5.
Source: log5.lisp.

Function: make-category-array (size) ¶

Package: log5.
Source: log5.lisp.

Function: make-indent-space () ¶

Package: log5.
Source: log5.lisp.

Function: make-log-category (&key name specification documentation id expanded-specification variables negated-variables) ¶

Package: log5.
Source: log5.lisp.

Function: make-log-manager (&key senders context ignore-errors? compile-category-spec expanded-compile-category-spec debug-console indents) ¶

Package: log5.
Source: log5.lisp.

Function: make-log-output (&key name form format static?) ¶

Package: log5.
Source: log5.lisp.

Function: massage-arguments (args) ¶

Package: log5.
Source: config.lisp.

Function: message-creator-class (sender) ¶

Package: log5.
Source: log5.lisp.

Function: name->category (name) ¶

Returns the category whose name (assumed to be properly **canonized**) is name.

Package: log5.
Source: log5.lisp.

Reader: output-form (instance) ¶

Writer: (setf output-form) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: form.

Reader: output-format (instance) ¶

Writer: (setf output-format) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: format.

Reader: output-name (instance) ¶

Writer: (setf output-name) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: name.

Reader: output-static? (instance) ¶

Writer: (setf output-static?) (instance) ¶

Package: log5.
Source: log5.lisp.
Target Slot: static?.

Function: predefined-output-p (name) ¶

Package: log5.
Source: log5.lisp.

Function: print-category (category stream) ¶

Package: log5.
Source: log5.lisp.

Function: reset-categories! () ¶

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.

Package: log5.
Source: log5.lisp.

Function: reset-output-specs! () ¶

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.

Package: log5.
Source: log5.lisp.

Function: sender-responds-to-category-p (sender-spec category) ¶

Package: log5.
Source: log5.lisp.

Function: start-sender-fn (name category-spec output-spec sender-type &rest args) ¶

Package: log5.
Source: log5.lisp.

Function: stop-sender-fn (name &key warn-if-not-found-p) ¶

Package: log5.
Source: log5.lisp.

Function: update-category-spec (name specification &key documentation) ¶

Package: log5.
Source: log5.lisp.

Function: update-output-spec (name form &key format static?) ¶

Package: log5.
Source: log5.lisp.

Function: valid-output-p (name) ¶

Package: log5.
Source: log5.lisp.

5.2.4 Generic functions

Generic Writer: %set-message-creator (new-value object) ¶

Package

Methods

Writer Method: %set-message-creator ((new-value basic-sender) basic-sender) ¶

automatically generated writer method

Source: log5.lisp.
Target Slot: message-creator.

Generic Reader: active-categories (object) ¶

Package

Methods

Reader Method: active-categories ((basic-sender basic-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: active-categories.

Generic Function: create-message-for-sender (message-creator message args) ¶

Package

Source

Methods

Method: create-message-for-sender ((creator basic-message-creator) message args) ¶

Method: create-message-for-sender ((sender basic-sender) message args) ¶

Generic Reader: expanded-specification (object) ¶

Package

Methods

Reader Method: expanded-specification ((sender-with-categories sender-with-categories)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: expanded-specification.

Generic Reader: handle-message-fn (object) ¶

Package

Methods

Reader Method: handle-message-fn ((basic-sender basic-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: handle-message-fn.

Generic Function: handle-output (sender output) ¶

Package

Source

Methods

Method: handle-output ((sender stream-sender-mixin) output) ¶

Generic Reader: lock (object) ¶

Package

Methods

Reader Method: lock ((basic-sender basic-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: lock.

Generic Reader: message-creator (object) ¶

Package

Methods

Reader Method: message-creator ((basic-sender basic-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: message-creator.

Generic Function: print-sender (sender stream) ¶

Print information about sender to stream

Package

Source

Methods

Method: print-sender ((sender basic-sender) stream) ¶

Generic Reader: sender-name (condition) ¶

Package

Methods

Reader Method: sender-name ((condition sender-not-found-warning)) ¶

Source: log5.lisp.
Target Slot: sender-name.

Generic Function: separate-properties (sender) ¶

Package

Source

Methods

Method: separate-properties ((sender stream-sender-mixin)) ¶

Method: separate-properties ((sender basic-sender)) ¶

Generic Reader: specs (object) ¶

Package

Methods

Reader Method: specs ((debug-console-sender debug-console-sender)) ¶

automatically generated reader method

Source: log5.lisp.
Target Slot: specs.

Generic Writer: (setf specs) (object) ¶

Package

Methods

Writer Method: (setf specs) ((debug-console-sender debug-console-sender)) ¶

automatically generated writer method

Source: log5.lisp.
Target Slot: specs.

Generic Function: update-active-categories (sender maximum-id) ¶

Package

Source

Methods

Method: update-active-categories ((sender sender-with-categories) max-id) ¶

Method: update-active-categories ((sender basic-sender) max-id) ¶

5.2.5 Conditions

Condition: bad-category-type-error ¶

Package

Source

Direct superclasses

error.

Direct methods

name.

Direct slots

Slot: name ¶

Initform: (quote nil)
Initargs: :name
Readers: name.
Writers: This slot is read-only.

Condition: output-not-found-error ¶

Package

Source

Direct superclasses

error.

Direct methods

name.

Direct slots

Slot: name ¶

Initform: (quote nil)
Initargs: :name
Readers: name.
Writers: This slot is read-only.

Condition: sender-not-found-warning ¶

Package

Source

Direct superclasses

warning.

Direct methods

sender-name.

Direct slots

Slot: sender-name ¶

Initform: (quote nil)
Initargs: :sender-name
Readers: sender-name.
Writers: This slot is read-only.

Condition: simple-category-not-found-error ¶

Package

Source

Direct superclasses

error.

Direct methods

name.

Direct slots

Slot: name ¶

Initform: (quote nil)
Initargs: :name
Readers: name.
Writers: This slot is read-only.

5.2.6 Structures

Structure: log-category ¶

Package

Source

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: name ¶

Readers: category-name.
Writers: (setf category-name).

Slot: specification ¶

Readers: category-specification.
Writers: (setf category-specification).

Slot: documentation ¶

Package: common-lisp.
Readers: category-documentation.
Writers: (setf category-documentation).

Slot: id ¶

Readers: category-id.
Writers: (setf category-id).

Slot: expanded-specification ¶

Readers: category-expanded-specification.
Writers: (setf category-expanded-specification).

Slot: variables ¶

Readers: category-variables.
Writers: (setf category-variables).

Slot: negated-variables ¶

Readers: category-negated-variables.
Writers: (setf category-negated-variables).

Structure: log-output ¶

Package

Source

Direct superclasses

structure-object.

Direct slots

Slot: name ¶

Readers: output-name.
Writers: (setf output-name).

Slot: form ¶

Readers: output-form.
Writers: (setf output-form).

Slot: format ¶

Package: common-lisp.
Initform: "~a"
Readers: output-format.
Writers: (setf output-format).

Slot: static? ¶

Readers: output-static?.
Writers: (setf output-static?).

5.2.7 Classes

Class: basic-message-creator ¶

Package: log5.
Source: log5.lisp.
Direct methods: create-message-for-sender.

Class: debug-console-sender ¶

Package

Source