This is the log5 Reference Manual, version 0.3.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:12:40 2018 GMT+0.
| • Systems: | The systems documentation | |
| • Modules: | The modules documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
| • The log5 system: |
Gary Warren King <gwking@metabang.com>
Gary Warren King <gwking@metabang.com>
MIT License (see the fike COPYING for details)
Log5 is a Common Lisp logging library
0.3.2
log5.asd (file)
dev (module)
Modules are listed depth-first from the system components tree.
| • The log5/dev module: |
log5 (system)
dev/
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The log5.asd file: | ||
| • The log5/dev/log5.lisp file: | ||
| • The log5/dev/category-defs.lisp file: | ||
| • The log5/dev/port.lisp file: | ||
| • The log5/dev/config.lisp file: |
Next: The log5/dev/log5<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
log5.asd
log5 (system)
Next: The log5/dev/category-defs<dot>lisp file, Previous: The log5<dot>asd file, Up: Lisp files [Contents][Index]
dev (module)
dev/log5.lisp
Next: The log5/dev/port<dot>lisp file, Previous: The log5/dev/log5<dot>lisp file, Up: Lisp files [Contents][Index]
Next: The log5/dev/config<dot>lisp file, Previous: The log5/dev/category-defs<dot>lisp file, Up: Lisp files [Contents][Index]
Previous: The log5/dev/port<dot>lisp file, Up: Lisp files [Contents][Index]
log5.lisp (file)
dev (module)
dev/config.lisp
massage-arguments (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The log5-system package: | ||
| • The log5 package: |
Next: The log5 package, Previous: Packages, Up: Packages [Contents][Index]
log5.asd
Previous: The log5-system package, Up: Packages [Contents][Index]
A Common Lisp logging library; CLLL? No, it’s log5. Log5 is organized around 5 things:
* Categories,
* Senders,
* Outputs,
* Messages, and
* the Context
log5.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros: | ||
| • Exported functions: | ||
| • Exported generic functions: | ||
| • Exported structures: | ||
| • Exported classes: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
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.
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
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.
config.lisp (file)
config.lisp (file)
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.
log5.lisp (file)
(setf ignore-errors-p) (function)
If true, then log5 will ignore any errors that occur during logging actions. If false, log5 will enter the debugger. This is setfable.
log5.lisp (file)
ignore-errors-p (function)
Returns the component that handles all of log5’s bookkeeping.
Returns a list of the current output specs in alphatetical order.
Next: Exported structures, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
log5.lisp (file)
log5.lisp (file)
log5.lisp (file)
log5.lisp (file)
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
log5.lisp (file)
structure-object (structure)
log5-senders (function)
(setf log5-senders) (function)
log5-context (function)
(setf log5-context) (function)
log5-ignore-errors? (function)
(setf log5-ignore-errors?) (function)
log5-compile-category-spec (function)
(setf log5-compile-category-spec) (function)
log5-expanded-compile-category-spec (function)
(setf log5-expanded-compile-category-spec) (function)
log5-debug-console (function)
(setf log5-debug-console) (function)
log5-indents (function)
(setf log5-indents) (function)
Previous: Exported structures, Up: Exported definitions [Contents][Index]
The root sender class from which all senders ~ should descend.
log5.lisp (file)
standard-object (class)
lock (generic function)
:name
name (generic function)
:output-spec
output-spec (generic function)
handle-message-fn (generic function)
log5::basic-message-creator
message-creator (generic function)
%set-message-creator (generic function)
(log5::make-category-array 0)
active-categories (generic function)
A sender that responds only to certain log categories.
log5.lisp (file)
basic-sender (class)
stream-sender (class)
:category-spec
category-spec (generic function)
expanded-specification (generic function)
log5.lisp (file)
debug-console-sender (class)
log5.lisp (file)
basic-sender (class)
stream-sender (class)
output-stream (generic function)
close-stream? (generic function)
:location
location (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal macros: | ||
| • Internal functions: | ||
| • Internal generic functions: | ||
| • Internal conditions: | ||
| • Internal structures: | ||
| • Internal classes: |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
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.
config.lisp (file)
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.
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Print information about sender to stream
Next: Internal structures, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
log5.lisp (file)
warning (condition)
sender-name (method)
:sender-name
(quote nil)
sender-name (generic function)
Next: Internal classes, Previous: Internal conditions, Up: Internal definitions [Contents][Index]
log5.lisp (file)
structure-object (structure)
print-object (method)
category-name (function)
(setf category-name) (function)
category-specification (function)
(setf category-specification) (function)
category-documentation (function)
(setf category-documentation) (function)
category-id (function)
(setf category-id) (function)
category-expanded-specification (function)
(setf category-expanded-specification) (function)
category-variables (function)
(setf category-variables) (function)
category-negated-variables (function)
(setf category-negated-variables) (function)
log5.lisp (file)
structure-object (structure)
output-name (function)
(setf output-name) (function)
output-form (function)
(setf output-form) (function)
"~a"
output-format (function)
(setf output-format) (function)
output-static? (function)
(setf output-static?) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
log5.lisp (file)
standard-object (class)
create-message-for-sender (method)
log5.lisp (file)
stream-sender (class)
specs (generic function)
(setf specs) (generic function)
| Initarg | Value |
|---|---|
| :location | *debug-io* |
| :name | (quote log5::debug-console) |
| :output-spec | nil |
| :category-spec | nil |
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L M |
|---|
| Jump to: | F L M |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| 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 |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| 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 |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | B C D L O P S |
|---|
| Jump to: | B C D L O P S |
|---|