The log5 Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The log5 Reference Manual

This is the log5 Reference Manual, version 0.3.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:30:49 2022 GMT+0.

Table of Contents


1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 log5

Log5 is a Common Lisp logging library

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT License (see the fike COPYING for details)

Version

0.3.2

Source

log5.asd.

Child Component

dev (module).


Next: , Previous: , Up: The log5 Reference Manual   [Contents][Index]

2 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

2.1 log5/dev

Source

log5.asd.

Parent Component

log5 (system).

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

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

log5.asd.

Parent Component

dev (module).

Packages

log5.

Public Interface
Internals

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


Previous: , Up: Lisp   [Contents][Index]

3.1.5 log5/dev/config.lisp

Dependency

log5.lisp (file).

Source

log5.asd.

Parent Component

dev (module).

Public Interface
Internals

massage-arguments (function).


4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

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

log5.lisp.

Use List

common-lisp.

Public Interface
Internals

Previous: , Up: Packages   [Contents][Index]

4.2 log5-system

Source

log5.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


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

log5.

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

log5.

Source

log5.lisp.

Methods
Method: close-sender ((sender stream-sender-mixin))
Method: close-sender (sender)
Generic Reader: close-stream? (object)
Package

log5.

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

log5.

Source

log5.lisp.

Methods
Method: create-handle-message-context ((sender stream-sender-mixin))
Method: create-handle-message-context ((sender basic-sender))
Generic Function: finish-handling (sender)
Package

log5.

Source

log5.lisp.

Methods
Method: finish-handling ((sender stream-sender-mixin))
Method: finish-handling ((sender basic-sender))
Generic Reader: location (object)
Package

log5.

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

log5.

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

log5.

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

log5.

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

log5.

Source

log5.lisp.

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

log5.

Source

log5.lisp.

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


Previous: , Up: Public Interface   [Contents][Index]

5.1.6 Classes

Class: basic-sender

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

Package

log5.

Source

log5.lisp.

Direct subclasses
Direct methods
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

log5.

Source

log5.lisp.

Direct superclasses

basic-sender.

Direct subclasses

stream-sender.

Direct methods
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

log5.

Source

log5.lisp.

Direct superclasses
Direct subclasses

debug-console-sender.

Class: stream-sender-mixin
Package

log5.

Source

log5.lisp.

Direct superclasses

basic-sender.

Direct subclasses

stream-sender.

Direct methods
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


Next: , Previous: , Up: Internals   [Contents][Index]

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.


Next: , Previous: , Up: Internals   [Contents][Index]

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.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.4 Generic functions

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

log5.

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

log5.

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

log5.

Source

log5.lisp.

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

log5.

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

log5.

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

log5.

Source

log5.lisp.

Methods
Method: handle-output ((sender stream-sender-mixin) output)
Generic Reader: lock (object)
Package

log5.

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

automatically generated reader method

Source

log5.lisp.

Target Slot

lock.

Generic Reader: message-creator (object)
Package

log5.

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

log5.

Source

log5.lisp.

Methods
Method: print-sender ((sender basic-sender) stream)
Generic Reader: sender-name (condition)
Package

log5.

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

log5.lisp.

Target Slot

sender-name.

Generic Function: separate-properties (sender)
Package

log5.

Source

log5.lisp.

Methods
Method: separate-properties ((sender stream-sender-mixin))
Method: separate-properties ((sender basic-sender))
Generic Reader: specs (object)
Package

log5.

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

log5.

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

log5.

Source

log5.lisp.

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

Next: , Previous: , Up: Internals   [Contents][Index]

5.2.5 Conditions

Condition: bad-category-type-error
Package

log5.

Source

log5.lisp.

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

log5.

Source

log5.lisp.

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

log5.

Source

log5.lisp.

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

log5.

Source

log5.lisp.

Direct superclasses

error.

Direct methods

name.

Direct slots
Slot: name
Initform

(quote nil)

Initargs

:name

Readers

name.

Writers

This slot is read-only.


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.6 Structures

Structure: log-category
Package

log5.

Source

log5.lisp.

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

log5.

Source

log5.lisp.

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


Previous: , Up: Internals   [Contents][Index]

5.2.7 Classes

Class: basic-message-creator
Package

log5.

Source

log5.lisp.

Direct methods

create-message-for-sender.

Class: debug-console-sender
Package

log5.

Source

log5.lisp.

Direct superclasses

stream-sender.

Direct methods
Direct Default Initargs
InitargValue
:location*debug-io*
:name(quote debug-console)
:output-specnil
:category-specnil
Direct slots
Slot: specs
Readers

specs.

Writers

(setf specs).


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S   U   V   W  
Index Entry  Section

%
%handle-message: Private ordinary functions
%log-p: Private ordinary functions
%set-message-creator: Private generic functions
%set-message-creator: Private generic functions
%with-vars: Private macros

(
(setf category-documentation): Private ordinary functions
(setf category-expanded-specification): Private ordinary functions
(setf category-id): Private ordinary functions
(setf category-name): Private ordinary functions
(setf category-negated-variables): Private ordinary functions
(setf category-specification): Private ordinary functions
(setf category-variables): Private ordinary functions
(setf compile-category-spec): Public ordinary functions
(setf ignore-errors-p): Public ordinary functions
(setf log5-compile-category-spec): Private ordinary functions
(setf log5-context): Private ordinary functions
(setf log5-debug-console): Private ordinary functions
(setf log5-expanded-compile-category-spec): Private ordinary functions
(setf log5-ignore-errors?): Private ordinary functions
(setf log5-indents): Private ordinary functions
(setf log5-senders): Private ordinary functions
(setf output-form): Private ordinary functions
(setf output-format): Private ordinary functions
(setf output-name): Private ordinary functions
(setf output-static?): Private ordinary functions
(setf specs): Private generic functions
(setf specs): Private generic functions

A
active-categories: Private generic functions
active-categories: Private generic functions
active-category-p: Private ordinary functions

B
build-handle-message-fn: Private ordinary functions
built-in-output-specs: Private ordinary functions

C
canonize-category-name: Private ordinary functions
canonize-category-specification: Private ordinary functions
category-documentation: Private ordinary functions
category-expanded-specification: Private ordinary functions
category-id: Private ordinary functions
category-name: Private ordinary functions
category-negated-variables: Private ordinary functions
category-spec: Public generic functions
category-spec: Public generic functions
category-specification: Private ordinary functions
category-specs: Public ordinary functions
category-variables: Private ordinary functions
close-sender: Public generic functions
close-sender: Public generic functions
close-sender: Public generic functions
close-stream?: Public generic functions
close-stream?: Public generic functions
collect-key-value: Private ordinary functions
compile-category-spec: Public ordinary functions
compile-handle-message-fn: Private ordinary functions
configuration-file: Public ordinary functions
configure-from-file: Public ordinary functions
copy-log-category: Private ordinary functions
copy-log-manager: Private ordinary functions
copy-log-output: Private ordinary functions
create-handle-message-context: Public generic functions
create-handle-message-context: Public generic functions
create-handle-message-context: Public generic functions
create-message-for-sender: Private generic functions
create-message-for-sender: Private generic functions
create-message-for-sender: Private generic functions

D
debugging: Public ordinary functions
defcategory: Public macros
defoutput: Public macros
determine-category-variables: Private ordinary functions
dotted-pair-p: Private ordinary functions

E
ensure-stream-open: Private ordinary functions
expand-category: Private ordinary functions
expanded-specification: Private generic functions
expanded-specification: Private generic functions

F
find-or-create-debug-console: Private ordinary functions
finish-handling: Public generic functions
finish-handling: Public generic functions
finish-handling: Public generic functions
flatten: Private ordinary functions
Function, %handle-message: Private ordinary functions
Function, %log-p: Private ordinary functions
Function, (setf category-documentation): Private ordinary functions
Function, (setf category-expanded-specification): Private ordinary functions
Function, (setf category-id): Private ordinary functions
Function, (setf category-name): Private ordinary functions
Function, (setf category-negated-variables): Private ordinary functions
Function, (setf category-specification): Private ordinary functions
Function, (setf category-variables): Private ordinary functions
Function, (setf compile-category-spec): Public ordinary functions
Function, (setf ignore-errors-p): Public ordinary functions
Function, (setf log5-compile-category-spec): Private ordinary functions
Function, (setf log5-context): Private ordinary functions
Function, (setf log5-debug-console): Private ordinary functions
Function, (setf log5-expanded-compile-category-spec): Private ordinary functions
Function, (setf log5-ignore-errors?): Private ordinary functions
Function, (setf log5-indents): Private ordinary functions
Function, (setf log5-senders): Private ordinary functions
Function, (setf output-form): Private ordinary functions
Function, (setf output-format): Private ordinary functions
Function, (setf output-name): Private ordinary functions
Function, (setf output-static?): Private ordinary functions
Function, active-category-p: Private ordinary functions
Function, build-handle-message-fn: Private ordinary functions
Function, built-in-output-specs: Private ordinary functions
Function, canonize-category-name: Private ordinary functions
Function, canonize-category-specification: Private ordinary functions
Function, category-documentation: Private ordinary functions
Function, category-expanded-specification: Private ordinary functions
Function, category-id: Private ordinary functions
Function, category-name: Private ordinary functions
Function, category-negated-variables: Private ordinary functions
Function, category-specification: Private ordinary functions
Function, category-specs: Public ordinary functions
Function, category-variables: Private ordinary functions
Function, collect-key-value: Private ordinary functions
Function, compile-category-spec: Public ordinary functions
Function, compile-handle-message-fn: Private ordinary functions
Function, configuration-file: Public ordinary functions
Function, configure-from-file: Public ordinary functions
Function, copy-log-category: Private ordinary functions
Function, copy-log-manager: Private ordinary functions
Function, copy-log-output: Private ordinary functions
Function, debugging: Public ordinary functions
Function, determine-category-variables: Private ordinary functions
Function, dotted-pair-p: Private ordinary functions
Function, ensure-stream-open: Private ordinary functions
Function, expand-category: Private ordinary functions
Function, find-or-create-debug-console: Private ordinary functions
Function, flatten: Private ordinary functions
Function, id->category: Public ordinary functions
Function, ignore-errors-p: Public ordinary functions
Function, initialize-category-spec: Private ordinary functions
Function, log-category-p: Private ordinary functions
Function, log-manager: Public ordinary functions
Function, log-manager-p: Private ordinary functions
Function, log-output-p: Private ordinary functions
Function, log5-compile-category-spec: Private ordinary functions
Function, log5-context: Private ordinary functions
Function, log5-debug-console: Private ordinary functions
Function, log5-expanded-compile-category-spec: Private ordinary functions
Function, log5-ignore-errors?: Private ordinary functions
Function, log5-indents: Private ordinary functions
Function, log5-senders: Private ordinary functions
Function, logical-connective-p: Private ordinary functions
Function, make-active-category-array: Private ordinary functions
Function, make-category-array: Private ordinary functions
Function, make-indent-space: Private ordinary functions
Function, make-log-category: Private ordinary functions
Function, make-log-manager: Private ordinary functions
Function, make-log-output: Private ordinary functions
Function, massage-arguments: Private ordinary functions
Function, message-creator-class: Private ordinary functions
Function, name->category: Private ordinary functions
Function, output-form: Private ordinary functions
Function, output-format: Private ordinary functions
Function, output-name: Private ordinary functions
Function, output-specs: Public ordinary functions
Function, output-static?: Private ordinary functions
Function, pop-context: Public ordinary functions
Function, pop-indent: Public ordinary functions
Function, predefined-output-p: Private ordinary functions
Function, print-category: Private ordinary functions
Function, push-context: Public ordinary functions
Function, push-indent: Public ordinary functions
Function, reset-categories!: Private ordinary functions
Function, reset-output-specs!: Private ordinary functions
Function, sender-responds-to-category-p: Private ordinary functions
Function, senders: Public ordinary functions
Function, start-sender-fn: Private ordinary functions
Function, stop-all-senders: Public ordinary functions
Function, stop-sender-fn: Private ordinary functions
Function, undebugging: Public ordinary functions
Function, update-category-spec: Private ordinary functions
Function, update-output-spec: Private ordinary functions
Function, valid-output-p: Private ordinary functions

G
Generic Function, %set-message-creator: Private generic functions
Generic Function, (setf specs): Private generic functions
Generic Function, active-categories: Private generic functions
Generic Function, category-spec: Public generic functions
Generic Function, close-sender: Public generic functions
Generic Function, close-stream?: Public generic functions
Generic Function, create-handle-message-context: Public generic functions
Generic Function, create-message-for-sender: Private generic functions
Generic Function, expanded-specification: Private generic functions
Generic Function, finish-handling: Public generic functions
Generic Function, handle-message-fn: Private generic functions
Generic Function, handle-output: Private generic functions
Generic Function, location: Public generic functions
Generic Function, lock: Private generic functions
Generic Function, message-creator: Private generic functions
Generic Function, name: Public generic functions
Generic Function, output-spec: Public generic functions
Generic Function, output-stream: Public generic functions
Generic Function, print-sender: Private generic functions
Generic Function, sender-name: Private generic functions
Generic Function, separate-properties: Private generic functions
Generic Function, specs: Private generic functions
Generic Function, start-handling: Public generic functions
Generic Function, update-active-categories: Private generic functions

H
handle-message: Private macros
handle-message-fn: Private generic functions
handle-message-fn: Private generic functions
handle-output: Private generic functions
handle-output: Private generic functions

I
id->category: Public ordinary functions
ignore-errors-p: Public ordinary functions
initialize-category-spec: Private ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

L
location: Public generic functions
location: Public generic functions
lock: Private generic functions
lock: Private generic functions
log-category-p: Private ordinary functions
log-for: Public macros
log-if: Public macros
log-manager: Public ordinary functions
log-manager-p: Private ordinary functions
log-output-p: Private ordinary functions
log5-compile-category-spec: Private ordinary functions
log5-context: Private ordinary functions
log5-debug-console: Private ordinary functions
log5-expanded-compile-category-spec: Private ordinary functions
log5-ignore-errors?: Private ordinary functions
log5-indents: Private ordinary functions
log5-senders: Private ordinary functions
logical-connective-p: Private ordinary functions

M
Macro, %with-vars: Private macros
Macro, defcategory: Public macros
Macro, defoutput: Public macros
Macro, handle-message: Private macros
Macro, log-for: Public macros
Macro, log-if: Public macros
Macro, start-sender: Public macros
Macro, start-stream-sender: Public macros
Macro, stop-sender: Public macros
Macro, when-logging: Public macros
Macro, with-context: Public macros
Macro, with-context-for: Public macros
Macro, with-indent: Public macros
make-active-category-array: Private ordinary functions
make-category-array: Private ordinary functions
make-indent-space: Private ordinary functions
make-log-category: Private ordinary functions
make-log-manager: Private ordinary functions
make-log-output: Private ordinary functions
massage-arguments: Private ordinary functions
message-creator: Private generic functions
message-creator: Private generic functions
message-creator-class: Private ordinary functions
Method, %set-message-creator: Private generic functions
Method, (setf specs): Private generic functions
Method, active-categories: Private generic functions
Method, category-spec: Public generic functions
Method, close-sender: Public generic functions
Method, close-sender: Public generic functions
Method, close-stream?: Public generic functions
Method, create-handle-message-context: Public generic functions
Method, create-handle-message-context: Public generic functions
Method, create-message-for-sender: Private generic functions
Method, create-message-for-sender: Private generic functions
Method, expanded-specification: Private generic functions
Method, finish-handling: Public generic functions
Method, finish-handling: Public generic functions
Method, handle-message-fn: Private generic functions
Method, handle-output: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, location: Public generic functions
Method, lock: Private generic functions
Method, message-creator: Private generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, output-spec: Public generic functions
Method, output-stream: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-sender: Private generic functions
Method, sender-name: Private generic functions
Method, separate-properties: Private generic functions
Method, separate-properties: Private generic functions
Method, specs: Private generic functions
Method, start-handling: Public generic functions
Method, start-handling: Public generic functions
Method, update-active-categories: Private generic functions
Method, update-active-categories: Private generic functions

N
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name->category: Private ordinary functions

O
output-form: Private ordinary functions
output-format: Private ordinary functions
output-name: Private ordinary functions
output-spec: Public generic functions
output-spec: Public generic functions
output-specs: Public ordinary functions
output-static?: Private ordinary functions
output-stream: Public generic functions
output-stream: Public generic functions

P
pop-context: Public ordinary functions
pop-indent: Public ordinary functions
predefined-output-p: Private ordinary functions
print-category: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-sender: Private generic functions
print-sender: Private generic functions
push-context: Public ordinary functions
push-indent: Public ordinary functions

R
reset-categories!: Private ordinary functions
reset-output-specs!: Private ordinary functions

S
sender-name: Private generic functions
sender-name: Private generic functions
sender-responds-to-category-p: Private ordinary functions
senders: Public ordinary functions
separate-properties: Private generic functions
separate-properties: Private generic functions
separate-properties: Private generic functions
specs: Private generic functions
specs: Private generic functions
start-handling: Public generic functions
start-handling: Public generic functions
start-handling: Public generic functions
start-sender: Public macros
start-sender-fn: Private ordinary functions
start-stream-sender: Public macros
stop-all-senders: Public ordinary functions
stop-sender: Public macros
stop-sender-fn: Private ordinary functions

U
undebugging: Public ordinary functions
update-active-categories: Private generic functions
update-active-categories: Private generic functions
update-active-categories: Private generic functions
update-category-spec: Private ordinary functions
update-output-spec: Private ordinary functions

V
valid-output-p: Private ordinary functions

W
when-logging: Public macros
with-context: Public macros
with-context-for: Public macros
with-indent: Public macros

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   C   D   E   F   H   I   L   M   N   O   S   V  
Index Entry  Section

*
*category-specs*: Private special variables
*default-logical-connective*: Private special variables
*id->category*: Private special variables
*log-manager*: Private special variables
*name->category*: Private special variables
*output-specs*: Private special variables

A
active-categories: Public classes

C
category-spec: Public classes
close-stream?: Public classes
compile-category-spec: Public structures
context: Public structures

D
debug-console: Public structures
documentation: Private structures

E
expanded-compile-category-spec: Public structures
expanded-specification: Public classes
expanded-specification: Private structures

F
form: Private structures
format: Private structures

H
handle-message-fn: Public classes

I
id: Private structures
ignore-errors?: Public structures
indents: Public structures

L
location: Public classes
lock: Public classes

M
message-creator: Public classes

N
name: Public classes
name: Private conditions
name: Private conditions
name: Private conditions
name: Private structures
name: Private structures
negated-variables: Private structures

O
output-spec: Public classes
output-stream: Public classes

S
sender-name: Private conditions
senders: Public structures
Slot, active-categories: Public classes
Slot, category-spec: Public classes
Slot, close-stream?: Public classes
Slot, compile-category-spec: Public structures
Slot, context: Public structures
Slot, debug-console: Public structures
Slot, documentation: Private structures
Slot, expanded-compile-category-spec: Public structures
Slot, expanded-specification: Public classes
Slot, expanded-specification: Private structures
Slot, form: Private structures
Slot, format: Private structures
Slot, handle-message-fn: Public classes
Slot, id: Private structures
Slot, ignore-errors?: Public structures
Slot, indents: Public structures
Slot, location: Public classes
Slot, lock: Public classes
Slot, message-creator: Public classes
Slot, name: Public classes
Slot, name: Private conditions
Slot, name: Private conditions
Slot, name: Private conditions
Slot, name: Private structures
Slot, name: Private structures
Slot, negated-variables: Private structures
Slot, output-spec: Public classes
Slot, output-stream: Public classes
Slot, sender-name: Private conditions
Slot, senders: Public structures
Slot, specification: Private structures
Slot, specs: Private classes
Slot, static?: Private structures
Slot, variables: Private structures
Special Variable, *category-specs*: Private special variables
Special Variable, *default-logical-connective*: Private special variables
Special Variable, *id->category*: Private special variables
Special Variable, *log-manager*: Private special variables
Special Variable, *name->category*: Private special variables
Special Variable, *output-specs*: Private special variables
specification: Private structures
specs: Private classes
static?: Private structures

V
variables: Private structures

Jump to:   *  
A   C   D   E   F   H   I   L   M   N   O   S   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   D   F   L   M   O   P   S  
Index Entry  Section

B
bad-category-type-error: Private conditions
basic-message-creator: Private classes
basic-sender: Public classes

C
category-defs.lisp: The log5/dev/category-defs․lisp file
Class, basic-message-creator: Private classes
Class, basic-sender: Public classes
Class, debug-console-sender: Private classes
Class, sender-with-categories: Public classes
Class, stream-sender: Public classes
Class, stream-sender-mixin: Public classes
Condition, bad-category-type-error: Private conditions
Condition, output-not-found-error: Private conditions
Condition, sender-not-found-warning: Private conditions
Condition, simple-category-not-found-error: Private conditions
config.lisp: The log5/dev/config․lisp file

D
debug-console-sender: Private classes
dev: The log5/dev module

F
File, category-defs.lisp: The log5/dev/category-defs․lisp file
File, config.lisp: The log5/dev/config․lisp file
File, log5.asd: The log5/log5․asd file
File, log5.lisp: The log5/dev/log5․lisp file
File, port.lisp: The log5/dev/port․lisp file

L
log-category: Private structures
log-manager: Public structures
log-output: Private structures
log5: The log5 system
log5: The log5 package
log5-system: The log5-system package
log5.asd: The log5/log5․asd file
log5.lisp: The log5/dev/log5․lisp file

M
Module, dev: The log5/dev module

O
output-not-found-error: Private conditions

P
Package, log5: The log5 package
Package, log5-system: The log5-system package
port.lisp: The log5/dev/port․lisp file

S
sender-not-found-warning: Private conditions
sender-with-categories: Public classes
simple-category-not-found-error: Private conditions
stream-sender: Public classes
stream-sender-mixin: Public classes
Structure, log-category: Private structures
Structure, log-manager: Public structures
Structure, log-output: Private structures
System, log5: The log5 system

Jump to:   B   C   D   F   L   M   O   P   S