The log5 Reference Manual

Table of Contents

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 2.3 "Robert April" on Wed Mar 14 04:16:02 2018 GMT+0.


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

1 Systems

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


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

1.1 log5

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT License (see the fike COPYING for details)

Description

Log5 is a Common Lisp logging library

Version

0.3.2

Source

log5.asd (file)

Component

dev (module)


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

2 Modules

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


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

2.1 log5/dev

Parent

log5 (system)

Location

dev/

Components

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

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 files   [Contents][Index]

3.1.1 log5.asd

Location

log5.asd

Systems

log5 (system)

Packages

log5-system


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

3.1.2 log5/dev/log5.lisp

Parent

dev (module)

Location

dev/log5.lisp

Packages

log5

Exported Definitions
Internal Definitions

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

3.1.3 log5/dev/category-defs.lisp

Dependency

log5.lisp (file)

Parent

dev (module)

Location

dev/category-defs.lisp


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

3.1.4 log5/dev/port.lisp

Dependency

log5.lisp (file)

Parent

dev (module)

Location

dev/port.lisp


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

3.1.5 log5/dev/config.lisp

Dependency

log5.lisp (file)

Parent

dev (module)

Location

dev/config.lisp

Exported Definitions
Internal Definitions

massage-arguments (function)


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

4 Packages

Packages are listed by definition order.


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

4.1 log5-system

Source

log5.asd

Use List

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

4.2 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 (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)

Macro: log-for CATEGORY-SPEC MESSAGE &rest ARGS
Package

log5

Source

log5.lisp (file)

Macro: log-if PREDICATE CATEGORY-SPEC MESSAGE &rest ARGS
Package

log5

Source

log5.lisp (file)

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 (file)

Macro: start-stream-sender NAME LOCATION &key OUTPUT-SPEC CATEGORY-SPEC
Package

log5

Source

log5.lisp (file)

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 (file)

Macro: when-logging CATEGORY-SPEC &body BODY
Package

log5

Source

log5.lisp (file)

Macro: with-context CONTEXT &body BODY
Package

log5

Source

log5.lisp (file)

Macro: with-context-for CATEGORY-SPEC CONTEXT &body BODY
Package

log5

Source

log5.lisp (file)

Macro: with-indent (AMOUNT &rest ARGS &key &allow-other-keys) &body BODY
Package

log5

Source

log5.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: category-specs ()

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

Package

log5

Source

log5.lisp (file)

Function: compile-category-spec ()
Function: (setf compile-category-spec) CATEGORY-SPEC
Package

log5

Source

log5.lisp (file)

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 (file)

Function: configure-from-file PATH &key STOP-SENDERS-FIRST?
Package

log5

Source

config.lisp (file)

Function: debugging &optional CATEGORY-SPEC &key OUTPUT-SPEC RESET?
Package

log5

Source

log5.lisp (file)

Function: id->category ID

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

Package

log5

Source

log5.lisp (file)

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 (file)

Writer

(setf ignore-errors-p) (function)

Function: (setf ignore-errors-p) VALUE

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 (file)

Reader

ignore-errors-p (function)

Function: log-manager ()

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

Package

log5

Source

log5.lisp (file)

Function: output-specs ()

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

Package

log5

Source

log5.lisp (file)

Function: pop-context ()
Package

log5

Source

log5.lisp (file)

Function: pop-indent ()
Package

log5

Source

log5.lisp (file)

Function: push-context CONTEXT
Package

log5

Source

log5.lisp (file)

Function: push-indent AMOUNT &rest ARGS &key &allow-other-keys
Package

log5

Source

log5.lisp (file)

Function: senders ()

Returns a list of the current senders.

Package

log5

Source

log5.lisp (file)

Function: stop-all-senders ()

Stops all logging.

Package

log5

Source

log5.lisp (file)

Function: undebugging &optional CATEGORY-SPEC
Package

log5

Source

log5.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: category-spec OBJECT
Package

log5

Methods
Method: category-spec (SENDER-WITH-CATEGORIES sender-with-categories)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: close-sender SENDER
Package

log5

Source

log5.lisp (file)

Methods
Method: close-sender (SENDER stream-sender-mixin)
Method: close-sender SENDER
Generic Function: close-stream? OBJECT
Package

log5

Methods
Method: close-stream? (STREAM-SENDER-MIXIN stream-sender-mixin)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: create-handle-message-context SENDER
Package

log5

Source

log5.lisp (file)

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 (file)

Methods
Method: finish-handling (SENDER stream-sender-mixin)
Method: finish-handling (SENDER basic-sender)
Generic Function: location OBJECT
Package

log5

Methods
Method: location (STREAM-SENDER-MIXIN stream-sender-mixin)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: name CONDITION
Package

log5

Methods
Method: name (BASIC-SENDER basic-sender)

automatically generated reader method

Source

log5.lisp (file)

Method: name (CONDITION output-not-found-error)
Source

log5.lisp (file)

Method: name (CONDITION simple-category-not-found-error)
Source

log5.lisp (file)

Method: name (CONDITION bad-category-type-error)
Source

log5.lisp (file)

Generic Function: output-spec OBJECT
Package

log5

Methods
Method: output-spec (BASIC-SENDER basic-sender)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: output-stream OBJECT
Package

log5

Methods
Method: output-stream (STREAM-SENDER-MIXIN stream-sender-mixin)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: start-handling SENDER
Package

log5

Source

log5.lisp (file)

Methods
Method: start-handling (SENDER stream-sender-mixin)
Method: start-handling (SENDER basic-sender)

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Structures

Structure: log-manager ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: senders
Readers

log5-senders (function)

Writers

(setf log5-senders) (function)

Slot: context
Readers

log5-context (function)

Writers

(setf log5-context) (function)

Slot: ignore-errors?
Readers

log5-ignore-errors? (function)

Writers

(setf log5-ignore-errors?) (function)

Slot: compile-category-spec
Readers

log5-compile-category-spec (function)

Writers

(setf log5-compile-category-spec) (function)

Slot: expanded-compile-category-spec
Readers

log5-expanded-compile-category-spec (function)

Writers

(setf log5-expanded-compile-category-spec) (function)

Slot: debug-console
Readers

log5-debug-console (function)

Writers

(setf log5-debug-console) (function)

Slot: indents
Readers

log5-indents (function)

Writers

(setf log5-indents) (function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: basic-sender ()

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

Package

log5

Source

log5.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: lock
Readers

lock (generic function)

Slot: name
Initargs

:name

Readers

name (generic function)

Slot: output-spec
Initargs

:output-spec

Readers

output-spec (generic function)

Slot: handle-message-fn
Readers

handle-message-fn (generic function)

Slot: message-creator
Initargs

log5::basic-message-creator

Readers

message-creator (generic function)

Writers

%set-message-creator (generic function)

Slot: active-categories
Initform

(log5::make-category-array 0)

Readers

active-categories (generic function)

Class: sender-with-categories ()

A sender that responds only to certain log categories.

Package

log5

Source

log5.lisp (file)

Direct superclasses

basic-sender (class)

Direct subclasses

stream-sender (class)

Direct methods
Direct slots
Slot: category-spec
Initargs

:category-spec

Readers

category-spec (generic function)

Slot: expanded-specification
Readers

expanded-specification (generic function)

Class: stream-sender ()
Package

log5

Source

log5.lisp (file)

Direct superclasses
Direct subclasses

debug-console-sender (class)

Class: stream-sender-mixin ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

basic-sender (class)

Direct subclasses

stream-sender (class)

Direct methods
Direct slots
Slot: output-stream
Readers

output-stream (generic function)

Slot: close-stream?
Readers

close-stream? (generic function)

Slot: location
Initargs

:location

Readers

location (generic function)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *category-specs*
Package

log5

Source

log5.lisp (file)

Special Variable: *default-logical-connective*
Package

log5

Source

log5.lisp (file)

Special Variable: *id->category*
Package

log5

Source

log5.lisp (file)

Special Variable: *log-manager*
Package

log5

Source

log5.lisp (file)

Special Variable: *name->category*
Package

log5

Source

log5.lisp (file)

Special Variable: *output-specs*
Package

log5

Source

log5.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: %with-vars VARS DEFAULT &body BODY
Package

log5

Source

log5.lisp (file)

Macro: handle-message ID MESSAGE &rest ARGS
Package

log5

Source

log5.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: %handle-message ID MESSAGE ARG-THUNK
Package

log5

Source

log5.lisp (file)

Function: %log-p CATEGORY-SPEC
Package

log5

Source

log5.lisp (file)

Function: active-category-p ID
Package

log5

Source

log5.lisp (file)

Function: build-handle-message-fn SENDER
Package

log5

Source

log5.lisp (file)

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

log5

Source

log5.lisp (file)

Function: canonize-category-name NAME &key SIMPLE?
Package

log5

Source

log5.lisp (file)

Function: canonize-category-specification SPECIFICATION
Package

log5

Source

log5.lisp (file)

Function: category-documentation INSTANCE
Function: (setf category-documentation) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: category-expanded-specification INSTANCE
Function: (setf category-expanded-specification) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: category-id INSTANCE
Function: (setf category-id) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: category-name INSTANCE
Function: (setf category-name) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: category-negated-variables INSTANCE
Function: (setf category-negated-variables) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: category-specification INSTANCE
Function: (setf category-specification) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: category-variables INSTANCE
Function: (setf category-variables) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: collect-key-value HT &key TRANSFORM
Package

log5

Source

log5.lisp (file)

Function: compile-handle-message-fn FN
Package

log5

Source

log5.lisp (file)

Function: copy-log-category INSTANCE
Package

log5

Source

log5.lisp (file)

Function: copy-log-manager INSTANCE
Package

log5

Source

log5.lisp (file)

Function: copy-log-output INSTANCE
Package

log5

Source

log5.lisp (file)

Function: determine-category-variables SPEC
Package

log5

Source

log5.lisp (file)

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 (file)

Function: ensure-stream-open STREAM-SENDER
Package

log5

Source

log5.lisp (file)

Function: expand-category NAME
Package

log5

Source

log5.lisp (file)

Function: find-or-create-debug-console &optional OUTPUT-SPEC
Package

log5

Source

log5.lisp (file)

Function: flatten LIST

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

Package

log5

Source

log5.lisp (file)

Function: initialize-category-spec SENDER
Package

log5

Source

log5.lisp (file)

Function: log-category-p OBJECT
Package

log5

Source

log5.lisp (file)

Function: log-manager-p OBJECT
Package

log5

Source

log5.lisp (file)

Function: log-output-p OBJECT
Package

log5

Source

log5.lisp (file)

Function: log5-compile-category-spec INSTANCE
Function: (setf log5-compile-category-spec) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: log5-context INSTANCE
Function: (setf log5-context) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: log5-debug-console INSTANCE
Function: (setf log5-debug-console) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: log5-expanded-compile-category-spec INSTANCE
Function: (setf log5-expanded-compile-category-spec) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: log5-ignore-errors? INSTANCE
Function: (setf log5-ignore-errors?) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: log5-indents INSTANCE
Function: (setf log5-indents) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: log5-senders INSTANCE
Function: (setf log5-senders) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: logical-connective-p X
Package

log5

Source

log5.lisp (file)

Function: make-active-category-array SENDER
Package

log5

Source

log5.lisp (file)

Function: make-category-array SIZE
Package

log5

Source

log5.lisp (file)

Function: make-indent-space ()
Package

log5

Source

log5.lisp (file)

Function: make-log-category &key (NAME NAME) (SPECIFICATION SPECIFICATION) (DOCUMENTATION DOCUMENTATION) (ID ID) (EXPANDED-SPECIFICATION EXPANDED-SPECIFICATION) (VARIABLES VARIABLES) (NEGATED-VARIABLES NEGATED-VARIABLES)
Package

log5

Source

log5.lisp (file)

Function: make-log-manager &key (SENDERS SENDERS) (CONTEXT CONTEXT) (IGNORE-ERRORS? IGNORE-ERRORS?) (COMPILE-CATEGORY-SPEC COMPILE-CATEGORY-SPEC) (EXPANDED-COMPILE-CATEGORY-SPEC EXPANDED-COMPILE-CATEGORY-SPEC) (DEBUG-CONSOLE DEBUG-CONSOLE) (INDENTS INDENTS)
Package

log5

Source

log5.lisp (file)

Function: make-log-output &key (NAME NAME) (FORM FORM) (FORMAT FORMAT) (STATIC? STATIC?)
Package

log5

Source

log5.lisp (file)

Function: massage-arguments ARGS
Package

log5

Source

config.lisp (file)

Function: message-creator-class SENDER
Package

log5

Source

log5.lisp (file)

Function: name->category NAME

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

Package

log5

Source

log5.lisp (file)

Function: output-form INSTANCE
Function: (setf output-form) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: output-format INSTANCE
Function: (setf output-format) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: output-name INSTANCE
Function: (setf output-name) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: output-static? INSTANCE
Function: (setf output-static?) VALUE INSTANCE
Package

log5

Source

log5.lisp (file)

Function: predefined-output-p NAME
Package

log5

Source

log5.lisp (file)

Function: print-category CATEGORY STREAM
Package

log5

Source

log5.lisp (file)

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 (file)

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 (file)

Function: sender-responds-to-category-p SENDER-SPEC CATEGORY
Package

log5

Source

log5.lisp (file)

Function: start-sender-fn NAME CATEGORY-SPEC OUTPUT-SPEC SENDER-TYPE &rest ARGS
Package

log5

Source

log5.lisp (file)

Function: stop-sender-fn NAME &key WARN-IF-NOT-FOUND-P
Package

log5

Source

log5.lisp (file)

Function: update-category-spec NAME SPECIFICATION &key DOCUMENTATION
Package

log5

Source

log5.lisp (file)

Function: update-output-spec NAME FORM &key FORMAT STATIC?
Package

log5

Source

log5.lisp (file)

Function: valid-output-p NAME
Package

log5

Source

log5.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: %set-message-creator NEW-VALUE OBJECT
Package

log5

Methods
Method: %set-message-creator NEW-VALUE (BASIC-SENDER basic-sender)

automatically generated writer method

Source

log5.lisp (file)

Generic Function: active-categories OBJECT
Package

log5

Methods
Method: active-categories (BASIC-SENDER basic-sender)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: create-message-for-sender MESSAGE-CREATOR MESSAGE ARGS
Package

log5

Source

log5.lisp (file)

Methods
Method: create-message-for-sender (CREATOR basic-message-creator) MESSAGE ARGS
Method: create-message-for-sender (SENDER basic-sender) MESSAGE ARGS
Generic Function: expanded-specification OBJECT
Package

log5

Methods
Method: expanded-specification (SENDER-WITH-CATEGORIES sender-with-categories)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: handle-message-fn OBJECT
Package

log5

Methods
Method: handle-message-fn (BASIC-SENDER basic-sender)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: handle-output SENDER OUTPUT
Package

log5

Source

log5.lisp (file)

Methods
Method: handle-output (SENDER stream-sender-mixin) OUTPUT
Generic Function: lock OBJECT
Package

log5

Methods
Method: lock (BASIC-SENDER basic-sender)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: message-creator OBJECT
Package

log5

Methods
Method: message-creator (BASIC-SENDER basic-sender)

automatically generated reader method

Source

log5.lisp (file)

Generic Function: print-sender SENDER STREAM

Print information about sender to stream

Package

log5

Source

log5.lisp (file)

Methods
Method: print-sender (SENDER basic-sender) STREAM
Generic Function: sender-name CONDITION
Package

log5

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

log5.lisp (file)

Generic Function: separate-properties SENDER
Package

log5

Source

log5.lisp (file)

Methods
Method: separate-properties (SENDER stream-sender-mixin)
Method: separate-properties (SENDER basic-sender)
Generic Function: specs OBJECT
Generic Function: (setf specs) NEW-VALUE OBJECT
Package

log5

Methods
Method: specs (DEBUG-CONSOLE-SENDER debug-console-sender)

automatically generated reader method

Source

log5.lisp (file)

Method: (setf specs) NEW-VALUE (DEBUG-CONSOLE-SENDER debug-console-sender)

automatically generated writer method

Source

log5.lisp (file)

Generic Function: update-active-categories SENDER MAXIMUM-ID
Package

log5

Source

log5.lisp (file)

Methods
Method: update-active-categories (SENDER sender-with-categories) MAX-ID
Method: update-active-categories (SENDER basic-sender) MAX-ID

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Conditions

Condition: bad-category-type-error ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

error (condition)

Direct methods

name (method)

Direct slots
Slot: name
Initargs

:name

Initform

(quote nil)

Readers

name (generic function)

Condition: output-not-found-error ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

error (condition)

Direct methods

name (method)

Direct slots
Slot: name
Initargs

:name

Initform

(quote nil)

Readers

name (generic function)

Condition: sender-not-found-warning ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

warning (condition)

Direct methods

sender-name (method)

Direct slots
Slot: sender-name
Initargs

:sender-name

Initform

(quote nil)

Readers

sender-name (generic function)

Condition: simple-category-not-found-error ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

error (condition)

Direct methods

name (method)

Direct slots
Slot: name
Initargs

:name

Initform

(quote nil)

Readers

name (generic function)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Structures

Structure: log-category ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: name
Readers

category-name (function)

Writers

(setf category-name) (function)

Slot: specification
Readers

category-specification (function)

Writers

(setf category-specification) (function)

Slot: documentation
Readers

category-documentation (function)

Writers

(setf category-documentation) (function)

Slot: id
Readers

category-id (function)

Writers

(setf category-id) (function)

Slot: expanded-specification
Readers

category-expanded-specification (function)

Writers

(setf category-expanded-specification) (function)

Slot: variables
Readers

category-variables (function)

Writers

(setf category-variables) (function)

Slot: negated-variables
Readers

category-negated-variables (function)

Writers

(setf category-negated-variables) (function)

Structure: log-output ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Readers

output-name (function)

Writers

(setf output-name) (function)

Slot: form
Readers

output-form (function)

Writers

(setf output-form) (function)

Slot: format
Initform

"~a"

Readers

output-format (function)

Writers

(setf output-format) (function)

Slot: static?
Readers

output-static? (function)

Writers

(setf output-static?) (function)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.7 Classes

Class: basic-message-creator ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

create-message-for-sender (method)

Class: debug-console-sender ()
Package

log5

Source

log5.lisp (file)

Direct superclasses

stream-sender (class)

Direct methods
  • specs (method)
  • specs (method)
Direct slots
Slot: specs
Readers

specs (generic function)

Writers

(setf specs) (generic function)

Direct Default Initargs
InitargValue
:location*debug-io*
:name(quote log5::debug-console)
:output-specnil
:category-specnil

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, log5.asd: The log5<dot>asd file
File, Lisp, log5/dev/category-defs.lisp: The log5/dev/category-defs<dot>lisp file
File, Lisp, log5/dev/config.lisp: The log5/dev/config<dot>lisp file
File, Lisp, log5/dev/log5.lisp: The log5/dev/log5<dot>lisp file
File, Lisp, log5/dev/port.lisp: The log5/dev/port<dot>lisp file

L
Lisp File, log5.asd: The log5<dot>asd file
Lisp File, log5/dev/category-defs.lisp: The log5/dev/category-defs<dot>lisp file
Lisp File, log5/dev/config.lisp: The log5/dev/config<dot>lisp file
Lisp File, log5/dev/log5.lisp: The log5/dev/log5<dot>lisp file
Lisp File, log5/dev/port.lisp: The log5/dev/port<dot>lisp file
log5.asd: The log5<dot>asd file
log5/dev: The log5/dev module
log5/dev/category-defs.lisp: The log5/dev/category-defs<dot>lisp file
log5/dev/config.lisp: The log5/dev/config<dot>lisp file
log5/dev/log5.lisp: The log5/dev/log5<dot>lisp file
log5/dev/port.lisp: The log5/dev/port<dot>lisp file

M
Module, log5/dev: The log5/dev module

Jump to:   F   L   M  

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: Internal functions
%log-p: Internal functions
%set-message-creator: Internal generic functions
%set-message-creator: Internal generic functions
%with-vars: Internal macros

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

A
active-categories: Internal generic functions
active-categories: Internal generic functions
active-category-p: Internal functions

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

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

D
debugging: Exported functions
defcategory: Exported macros
defoutput: Exported macros
determine-category-variables: Internal functions
dotted-pair-p: Internal functions

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

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

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

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

I
id->category: Exported functions
ignore-errors-p: Exported functions
initialize-category-spec: Internal functions

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

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

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name->category: Internal functions

O
output-form: Internal functions
output-format: Internal functions
output-name: Internal functions
output-spec: Exported generic functions
output-spec: Exported generic functions
output-specs: Exported functions
output-static?: Internal functions
output-stream: Exported generic functions
output-stream: Exported generic functions

P
pop-context: Exported functions
pop-indent: Exported functions
predefined-output-p: Internal functions
print-category: Internal functions
print-sender: Internal generic functions
print-sender: Internal generic functions
push-context: Exported functions
push-indent: Exported functions

R
reset-categories!: Internal functions
reset-output-specs!: Internal functions

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

U
undebugging: Exported functions
update-active-categories: Internal generic functions
update-active-categories: Internal generic functions
update-active-categories: Internal generic functions
update-category-spec: Internal functions
update-output-spec: Internal functions

V
valid-output-p: Internal functions

W
when-logging: Exported macros
with-context: Exported macros
with-context-for: Exported macros
with-indent: Exported 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*: Internal special variables
*default-logical-connective*: Internal special variables
*id->category*: Internal special variables
*log-manager*: Internal special variables
*name->category*: Internal special variables
*output-specs*: Internal special variables

A
active-categories: Exported classes

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

D
debug-console: Exported structures
documentation: Internal structures

E
expanded-compile-category-spec: Exported structures
expanded-specification: Exported classes
expanded-specification: Internal structures

F
form: Internal structures
format: Internal structures

H
handle-message-fn: Exported classes

I
id: Internal structures
ignore-errors?: Exported structures
indents: Exported structures

L
location: Exported classes
lock: Exported classes

M
message-creator: Exported classes

N
name: Exported classes
name: Internal conditions
name: Internal conditions
name: Internal conditions
name: Internal structures
name: Internal structures
negated-variables: Internal structures

O
output-spec: Exported classes
output-stream: Exported classes

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

V
variables: Internal 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   L   O   P   S  
Index Entry  Section

B
bad-category-type-error: Internal conditions
basic-message-creator: Internal classes
basic-sender: Exported classes

C
Class, basic-message-creator: Internal classes
Class, basic-sender: Exported classes
Class, debug-console-sender: Internal classes
Class, sender-with-categories: Exported classes
Class, stream-sender: Exported classes
Class, stream-sender-mixin: Exported classes
Condition, bad-category-type-error: Internal conditions
Condition, output-not-found-error: Internal conditions
Condition, sender-not-found-warning: Internal conditions
Condition, simple-category-not-found-error: Internal conditions

D
debug-console-sender: Internal classes

L
log-category: Internal structures
log-manager: Exported structures
log-output: Internal structures
log5: The log5 system
log5: The log5 package
log5-system: The log5-system package

O
output-not-found-error: Internal conditions

P
Package, log5: The log5 package
Package, log5-system: The log5-system package

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

Jump to:   B   C   D   L   O   P   S