The configuration.options Reference Manual

This is the configuration.options Reference Manual, version 0.10.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:55:23 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 configuration.options

An extensible configuration system that supports multiple option sources.

Maintainer

Jan Moringen <>

Author

Jan Moringen <>

Home Page

https://github.com/scymtym/configuration.options

Source Control

(GIT https://github.com/scymtym/configuration.options.git)

Bug Tracker

https://github.com/scymtym/configuration.options/issues

License

LLGPLv3

Version

0.10.0

Dependencies
  • alexandria (system).
  • split-sequence (system).
  • let-plus (system)., at least version "0.2"
  • more-conditions (system)., at least version "0.3"
  • utilities.print-items (system)., at least version "0.1"
  • utilities.print-tree (system)., at least version "0.1"
  • cl-hooks (system)., at least version "0.2"
  • architecture.service-provider (system)., at least version "0.1"
  • log4cl (system).
  • esrap (system)., at least version "0.9"
Source

configuration.options.asd.

Child Components

3 Modules

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


3.1 configuration.options/src

Source

configuration.options.asd.

Parent Component

configuration.options (system).

Child Components

3.2 configuration.options/sources

Dependency

src (module).

Source

configuration.options.asd.

Parent Component

configuration.options (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 configuration.options/configuration.options.asd

Source

configuration.options.asd.

Parent Component

configuration.options (system).

ASDF Systems

configuration.options.


4.1.2 configuration.options/src/package.lisp

Source

configuration.options.asd.

Parent Component

src (module).

Packages

configuration.options.


4.1.3 configuration.options/src/types.lisp

Dependency

package.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 configuration.options/src/variables.lisp

Dependency

types.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

*configuration* (special variable).

Internals

+no-value+ (constant).


4.1.5 configuration.options/src/conditions.lisp

Dependency

variables.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 configuration.options/src/protocol.lisp

Dependency

conditions.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

if-name (macro).


4.1.7 configuration.options/src/util.lisp

Dependency

protocol.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Internals

4.1.8 configuration.options/src/mixins.lisp

Dependency

util.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.9 configuration.options/src/name.lisp

Dependency

mixins.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.10 configuration.options/src/schema.lisp

Dependency

name.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.11 configuration.options/src/configuration.lisp

Dependency

schema.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.13 configuration.options/src/synchronizer.lisp

Dependency

value-types.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.14 configuration.options/src/macros.lisp

Dependency

synchronizer.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

4.1.15 configuration.options/src/let-plus.lisp

Dependency

macros.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.16 configuration.options/src/debug.lisp

Dependency

let-plus.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Packages

configuration.options.debug.

Public Interface
Internals

4.1.17 configuration.options/sources/package.lisp

Source

configuration.options.asd.

Parent Component

sources (module).

Packages

configuration.options.sources.


4.1.18 configuration.options/sources/conditions.lisp

Dependency

package.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

4.1.19 configuration.options/sources/protocol.lisp

Dependency

conditions.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

4.1.20 configuration.options/sources/debug.lisp

Dependency

protocol.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Internals

4.1.21 configuration.options/sources/configuration-files.lisp

Dependency

debug.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface
Internals

4.1.22 configuration.options/sources/source-defaults.lisp

Dependency

configuration-files.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface
Internals

4.1.23 configuration.options/sources/source-environment-variables.lisp

Dependency

source-defaults.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface
Internals

4.1.24 configuration.options/sources/source-stream.lisp

Dependency

source-environment-variables.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface
Internals

4.1.25 configuration.options/sources/source-file.lisp

Dependency

source-stream.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface
Internals

4.1.26 configuration.options/sources/source-cascade.lisp

Dependency

source-file.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 configuration.options

Options and option containers which are either parts of a
configuration or of a schema.

The basic structure is as follows:

Concept | Protocol | Class(es) | ——————+—————————-+————————–+ + container-like | container protocol | | + schema | schema protocol | ‘standard-schema’ | + configuration | configuration protocol | ‘standard-configuration’ | + option-like | option protocol | | + schema-item | schema item protocol class | ‘standard-schema-item’ | + option | option value protocol | ‘standard-option’ |

Population of configuration options with actual values is handled
by functions and classes in the ‘configuration.options.sources’ package.

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
  • let-plus.
  • more-conditions.
  • split-sequence.
  • utilities.print-items.
Used By List

configuration.options.sources.

Public Interface
Internals

5.2 configuration.options.sources

This package contains configuration options sources.

Sources such as configuration files, environment variables and commandline options provide option discovery and option value events to sinks (usually a synchronizer) which usually integrate the information into a configuration object.

Source

package.lisp.

Use List
Public Interface
Internals

5.3 configuration.options.debug

Functions for debugging configuration processing.

Source

debug.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Constants

Constant: +config-debug-variable-suffix+

Suffix for the name of the environment variable controlling configuration debugging.

Package

configuration.options.debug.

Source

debug.lisp.


6.1.2 Special variables

Special Variable: *configuration*

When bound to a configuration object, provides the default configuration for the ‘value’ and setf ‘value’ functions.

Package

configuration.options.

Source

variables.lisp.


6.1.3 Macros

Macro: &options (&rest arguments)

Like ‘&options-r/o’ but the bound variables are ‘setf’ able places. Setting the value of such a place sets the value of the corresponding option.

Package

configuration.options.

Source

let-plus.lisp.

Macro: &options-r/o (&rest arguments)

Execute BODY with established bindings of option values from the given ‘configuration’ object.

Bindings are specifications of the form

BINDING ::= VAR-AND-NAME | FULL-BINDING
VAR-AND-NAME ::= VAR | (VAR NAME)
FULL-BINDING ::= (VAR-AND-NAME [DEFAULT-VALUE [VALUE?-VAR]])

VAR is a symbol naming the variable to which the option value should be bound.

NAME is a string naming an option or an option name object. When NAME is not supplied, it is derived from VAR by downcasing the name of the symbol.

When the option named by NAME does not have a value and DEFAULT-VALUE is supplied, VAR is bound to DEFAULT-VALUE.

When VALUE?-VAR is supplied, it is bound to true when the option named by NAME has value and to false otherwise.

Package

configuration.options.

Source

let-plus.lisp.

Macro: &options/synchronizer (&rest arguments)

Similar to ‘&options’ but the value has to be a synchronizer instead of a ‘configuration’. When ‘setf’ is used on a place bound to an option, the synchronizer is used to set the new value.

Package

configuration.options.

Source

let-plus.lisp.

Macro: define-schema (name-and-args &body docstring-and-specs)

Define a parameter (like ‘cl:defparameter’) named according to
NAME-AND-ARGS the initial value of which is a schema as specified
by DOCSTRING-AND-SPECS.

NAME-AND-ARGS can either be a symbol which will be treated as a
name or a list starting with a symbol followed by keyword
arguments.

DOCSTRING-AND-SPECS is a list of schema and option
specifications (optionally preceded by a documentation string)
where each specification is of the form

SPEC ::= SCHEMA-SPEC | SCHEMA-VALUE-SPEC | OPTION-SPEC SCHEMA-SPEC ::= (NAME SPEC*)
SCHEMA-VALUE-SPEC ::= (NAME SCHEMA-VALUE)
OPTION-SPEC ::= (NAME &key type default documentation &allow-other-keys)

where SCHEMA-VALUE is evaluated and has to return a schema object.

The arguments of the type and default keyword parameters are
evaluated in the null lexical environment.

When DOCSTRING-AND-SPECS starts with a documentation string, it is
used as the documentation string of the toplevel schema object.

Example:

(define-schema *my-schema*
"Schema for my configuration"

("section"
("option" :type ’integer))) ; Note: :type argument is evaluated

Package

configuration.options.

Source

macros.lisp.

Macro: with-indent ((amount) &body body)

Execute BODY with debug indentation increased by AMOUNT.

Package

configuration.options.debug.

Source

debug.lisp.

Macro: with-level ((level) &body body)

Execute BODY with debug level LEVEL.

LEVEL can an integer or ‘:next’ to increase the current level by one.

Package

configuration.options.debug.

Source

debug.lisp.


6.1.4 Ordinary functions

Function: call-with-indent (amount thunk)

Call THUNK with debug indentation increased by AMOUNT.

Package

configuration.options.debug.

Source

debug.lisp.

Function: call-with-level (level thunk)

Call THUNK with debug level LEVEL.

LEVEL can an integer or ‘:next’ to increase the current level by one.

Package

configuration.options.debug.

Source

debug.lisp.

Function: config-debug-variable-name (prefix)

Return environment variable name derived from PREFIX.

Package

configuration.options.debug.

Source

debug.lisp.

Function: configuration-file-specs (prefix)

Return a list of configuration file specifications using PREFIX.

Elements of the returned list are either namestrings or the placeholders ‘+config-file-pwd-placeholder+’, ‘+config-file-user-placeholder+’ and ‘+config-file-system-placeholder+’.

PREFIX is used to compute the name of an environment variable PREFIX_CONFIG_FILES the value of which is split at ":" to produce the return value, if the variable is defined.

Otherwise the default list of configuration file specifications, which is the value of ‘*default-configuration-files*’, is returned.

Package

configuration.options.sources.

Source

configuration-files.lisp.

Function: configuration-files (filename &key user-homedir prefix file-specs)

Return a list of configuration file descriptions based on FILENAME.

Each of the returned descriptions is a list of the form

(PATHNAME DESCRIPTION)

To produce the list of descriptions, FILENAME is combined with each of the specifications in FILE-SPECS. Such a specification can be

* file or directory pathnames which are merged with FILENAME

* the value of ‘+config-file-pwd-placeholder+’ (i.e. the string "%pwd") which represents a file named FILENAME in the current directory.

* the value of ‘+config-file-user-placeholder+’ (i.e. the string "%user") which represents a file named FILENAME in the user configuration directory as computed by ‘user-configuration-directory’ applied to USER-HOMEDIR.

* the value of ‘+config-file-system-placeholder+’ (i.e. the string "%system") which represents a file named FILENAME in the system configuration directory as computed by ‘system-configuration-directory’ applied to PREFIX.

Package

configuration.options.sources.

Source

configuration-files.lisp.

Function: enable-debugging (stream)

Enable configuration debugging using stream.

Package

configuration.options.debug.

Source

debug.lisp.

Function: eval-schema-spec (spec &key documentation)

Evaluate SPEC as a schema specification and return the resulting schema object.

If DOCUMENTATION is supplied, it is used as the documentation string of the toplevel schema item in SPEC.

Package

configuration.options.

Source

macros.lisp.

Function: map-schema-spec (function spec)

Call FUNCTION for each specification item in SPEC and return FUNCTION’s return value for the toplevel schema item in SPEC.

FUNCTION should have a lambda-list compatible to the following one

kind name rest &key prefix schema self

where KIND is one of :schema, :wild-schema and :item, NAME is the name of the currently processed item and REST is the
remainder (following the name) of the specification item when KIND is :item.

Package

configuration.options.

Source

macros.lisp.

Function: maybe-enable-debugging (prefix &key stream)

Enable configuration debugging according to environment variable.

PREFIX is used with ‘config-debug-variable-name’ to compute the name of the environment variable.

STREAM is used for debug output if debugging is enabled.

Package

configuration.options.debug.

Source

debug.lisp.

Function: output (format-control &rest format-arguments)

Output FORMAT-CONTROL and FORMAT-ARGUMENTS if debugging.

Package

configuration.options.debug.

Source

debug.lisp.

Function: parse-name (string &key start end junk-allowed wild-allowed wild-inferiors-allowed)

Parse STRING as an option name and return the result.

START and END, when supplied, select a sub-string of STRING for parsing.

WILD-ALLOWED and WILD-INFERIORS-ALLOWED control whether "*" and "**" respectively are accepted as name components in STRING.

Package

configuration.options.

Source

name.lisp.

Function: print-name (stream name &optional colon? at? width)

Print dot-separated components of NAME onto STREAM. If WIDTH is supplied pad output to WIDTH.

If COLON? is non-NIL, print the empty name as "<root>" instead of the empty string.

Package

configuration.options.

Source

name.lisp.

Function: print-option-container-tree (stream object &optional colon? at?)
Package

configuration.options.

Source

mixins.lisp.


6.1.5 Generic functions

Generic Reader: binding-condition-container (condition)
Package

configuration.options.

Methods
Reader Method: binding-condition-container ((condition binding-condition))
Source

conditions.lisp.

Target Slot

container.

Generic Reader: binding-condition-name (condition)
Package

configuration.options.

Methods
Reader Method: binding-condition-name ((condition binding-condition))
Source

conditions.lisp.

Target Slot

name.

Generic Reader: binding-exists-condition-existing (condition)
Package

configuration.options.

Methods
Reader Method: binding-exists-condition-existing ((condition binding-exists-condition))
Source

conditions.lisp.

Target Slot

existing.

Generic Reader: configuration-schema (configuration)

Return the schema object governing CONFIGURATION.

Package

configuration.options.

Source

protocol.lisp.

Methods
Reader Method: configuration-schema ((standard-configuration standard-configuration))

Stores the schema object associated to the configuration object.

Source

configuration.lisp.

Target Slot

schema.

Generic Function: event-hook (object)

Return the event hook, a ‘hooks:object-hook’, for OBJECT.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: event-hook ((object event-hook-mixin))
Source

mixins.lisp.

Generic Function: find-child (name schema &key if-does-not-exist if-exists &allow-other-keys)

Find and return the child schema stored under NAME in SCHEMA.

IF-DOES-NOT-EXIST controls the behavior in case there is no child schema named NAME in SCHEMA:

nil

Return nil.

other value (but not one of the following)

Return IF-DOES-NOT-EXIST.

’warn, #’warn

Signal a ‘child-missing-warning’ indicating that a child named NAME does not exist in SCHEMA and return nil.

’error, #’error

Signal a ‘child-missing-error’ indicating that a child named NAME does not exist in SCHEMA.

a function

Call the function with a ‘child-missing-error’ instance indicating that a child NAME NAME does not exist in SCHEMA.

IF-EXISTS is accepted for parity with ‘(setf find-child)’.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: find-child (name (container standard-schema) &key &allow-other-keys)
Source

schema.lisp.

Method: find-child :around (name schema &key if-does-not-exist &allow-other-keys)
Method: find-child :around ((name sequence) schema &rest args &key &allow-other-keys)
Generic Function: (setf find-child) (name schema &key if-does-not-exist if-exists &allow-other-keys)

Store the child schema NEW-VALUE under the name NAME in SCHEMA.

IF-DOES-NOT-EXIST acts similarly to what is described for ‘find-child’ w.r.t. signaling conditions, but does not influence the return value.

IF-EXISTS controls the behavior in case a child schema name is already stored in SCHEMA:

:supersede

Replace the existing child named NAME in SCHEMA with NEW-VALUE.

:keep

Do not store NEW-VALUE and keep the child currently associated to NAME in SCHEMA.

’warn, #’warn

Signal a ‘child-exists-warning’ indicating that a child named NAME already exists in SCHEMA.

’error, #’error

Signal a ‘child-exists-error’ indicating that a child named NAME already exists in SCHEMA.

a function

Call the function with a ‘child-exists-error’ indicating that a child named NAME already exists in SCHEMA.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: (setf find-child) :after (key (schema standard-schema) &key &allow-other-keys)
Source

schema.lisp.

Method: (setf find-child) ((key sequence) (schema standard-schema) &key &allow-other-keys)
Source

schema.lisp.

Method: (setf find-child) :around (name schema &key if-does-not-exist if-exists)
Method: (setf find-child) :around (name schema &key if-does-not-exist if-exists)
Method: (setf find-child) :around ((name sequence) schema &rest args &key &allow-other-keys)
Generic Function: find-option (name container &key if-does-not-exist if-exists interpret-wildcards? &allow-other-keys)

Find and return the option named NAME in CONTAINER.

IF-DOES-NOT-EXIST controls the behavior in case there is no option named NAME:

nil

Return nil.

other value (but not one of the following)

Return IF-DOES-NOT-EXIST.

’warn, #’warn

Signal a ‘option-missing-warning’ indicating that an option named NAME does not exist in CONTAINER and return nil.

’error, #’error

Signal an ‘option-missing-error’ indicating that an option named NAME does not exist in CONTAINER.

a function

Call the function with an ‘option-missing-error’ instance indicating that an option named NAME does not exist in CONTAINER.

IF-EXISTS is accepted for parity with ‘(setf find-option)’.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: find-option :around (name (container standard-configuration) &key if-does-not-exist &allow-other-keys)
Source

configuration.lisp.

Method: find-option (name (container standard-schema) &key interpret-wildcards? &allow-other-keys)
Source

schema.lisp.

Method: find-option (name (container list-container-mixin) &key &allow-other-keys)
Source

mixins.lisp.

Method: find-option :around (name container &key if-does-not-exist &allow-other-keys)
Method: find-option :around ((name sequence) container &rest args &key &allow-other-keys)
Generic Function: (setf find-option) (name container &key if-does-not-exist if-exists &allow-other-keys)

Store the option NEW-VALUE under the name NAME in container.

IF-DOES-NOT-EXIST acts similarly to what is described for ‘find-option’ w.r.t. signaling conditions, but does not influence the return value.

IF-EXISTS controls the behavior in case an option named NAME is already stored in CONTAINER:

:supersede

Replace the existing option named NAME in container with NEW-VALUE.

:keep

Do not store NEW-VALUE and keep the option currently associated to NAME in CONTAINER.

’warn, #’warn

Signal a ‘option-exists-warning’ indicating that an option named NAME already exists in CONTAINER.

’error, #’error

Signal an ‘option-exists-error’ indicating that an option named NAME already exists in CONTAINER.

a function

Call the function with an ‘option-exists-error’ instance indicating that an option named NAME already exists in CONTAINER.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: (setf find-option) :after (name (container list-container-mixin) &key &allow-other-keys)
Source

mixins.lisp.

Method: (setf find-option) (name (container list-container-mixin) &key &allow-other-keys)
Source

mixins.lisp.

Method: (setf find-option) :before (name (container list-container-mixin) &key &allow-other-keys)
Source

mixins.lisp.

Method: (setf find-option) :around (name container &key if-does-not-exist if-exists)
Method: (setf find-option) :around (name container &key if-does-not-exist if-exists)
Method: (setf find-option) :around ((name sequence) container &rest args &key &allow-other-keys)
Generic Function: find-options (query container &key interpret-wildcards?)

Find and return a sequence of options in CONTAINER matching QUERY which can be a name with wildcard components.

Matching options can appear in any order in the returned sequence.

If CONTAINER has child containers (as can be the case for schema objects), matching options in ancestor containers (i.e. transitive children) are also found and returned.

For a description of INTERPRET-WILDCARDS?, see ‘map-matching-options’.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: find-options (query container &key interpret-wildcards?)
Method: find-options :around ((query sequence) container &key interpret-wildcards?)
Generic Function: initialize (source schema)

Initialize SOURCE with SCHEMA. SOURCE can, for example, examine the options in SCHEMA and create corresponding internal data structures, or user-facing interfaces, help texts, etc.

Package

configuration.options.sources.

Source

protocol.lisp.

Methods
Method: initialize ((source cascade-source) schema)
Source

source-cascade.lisp.

Method: initialize ((source defaults-source) schema)
Source

source-defaults.lisp.

Method: initialize (source schema)
Method: initialize :around (source schema)
Generic Function: make-configuration (schema)

Make and return a configuration object the option objects in which comply to schema.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: make-configuration ((schema standard-schema))
Source

schema.lisp.

Generic Function: make-name (thing)

Return a name corresponding to THING which can be a name string, a sequence of ‘name-component’s or a name.

The second return value is true if something other than THING (i.e. the result of coercing THING to a name) is returned and false if THING is returned.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: make-name ((thing wildcard-name))
Source

name.lisp.

Method: make-name ((thing sequence))
Source

name.lisp.

Method: make-name ((thing string))
Source

name.lisp.

Method: make-name (thing)
Generic Function: make-option (schema-item name &key option-class option-cell-class &allow-other-keys)

Make and return an option object according to SCHEMA-ITEM and NAME.

The new option will be named NAME and point to a new option cell which will in turn point to SCHEMA-ITEM for type, default, documentation, etc.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: make-option ((schema-item standard-schema-item) (name sequence) &key option-class option-cell-class)
Source

schema.lisp.

Method: make-option :around (schema-item (name sequence) &rest args &key &allow-other-keys)
Generic Function: make-source (spec &key &allow-other-keys)

Construct and return an object implementing the source protocol according to SPEC and the remaining keyword arguments.

For example, when SPEC is a symbol naming a provider of the ‘source’ service, the remaining keyword arguments are used as initargs.

Package

configuration.options.sources.

Source

protocol.lisp.

Methods
Method: make-source ((spec symbol) &rest args &key)
Generic Function: make-syntax (spec &key &allow-other-keys)

Construct and return an object implementing the syntax protocol according to SPEC and the remaining keyword arguments.

For example, when SPEC is a symbol naming a provider of the ‘syntax’ service, the remaining keyword arguments are used as initargs.

Package

configuration.options.sources.

Source

protocol.lisp.

Methods
Method: make-syntax ((spec symbol) &rest args &key)
Generic Function: map-matching-options (function query container &key interpret-wildcards? &allow-other-keys)

Call FUNCTION for each option matching QUERY in CONTAINER.

See ‘map-options’ for a description of FUNCTION.

QUERY has to be a (potentially wildcard) name against which options in CONTAINER are matched.

INTERPRET-WILDCARDS? controls whether and how wild components in QUERY and in names of items in CONTAINER should be interpreted. The following values are accepted:

nil

Wildcards in neither QUERY nor CONTAINER are interpreted. That is, names only match if their components, including wildcard components are identical.

:query

Wildcards in QUERY are interpreted, allowing arbitrary name components in corresponding positions in names in CONTAINER to match.

:container

Wildcards in names in CONTAINER are interpreted, allowing arbitrary name components in corresponding positions in QUERY to match.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: map-matching-options ((function function) query container &key interpret-wildcards?)
Method: map-matching-options (function query container &rest args &key interpret-wildcards?)
Method: map-matching-options :around ((function function) (query sequence) container &rest args &key &allow-other-keys)
Generic Function: map-options (function container)

Call FUNCTION for each option in CONTAINER.

FUNCTION is called with at least one argument: the option. Keyword arguments may follow.

If CONTAINER is a schema object, FUNCTION is called with the following keyword arguments:

:prefix

Specifies the option name prefix of the child container in which the current option is contained (the prefix is empty for options contained in CONTAINER itself).

:container

Specifies the container in which the current option
resides (either CONTAINER or child containers thereof).

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: map-options ((function function) (container standard-schema))
Source

schema.lisp.

Method: map-options ((function function) (container list-container-mixin))
Source

mixins.lisp.

Method: map-options (function container)
Generic Function: merge-names (left right)

Construct and return a new name by concatenating the components of LEFT and RIGHT.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: merge-names (left (right wildcard-name))
Source

name.lisp.

Method: merge-names ((left (eql nil)) right)
Method: merge-names (left right)
Generic Function: merge-values (schema-item values)

Merge the sequence of values VALUES into a single value in the appropriate way for the type of SCHEMA-ITEM and return two values: 1) nil or the merged value 2) t if the merge produced a value and nil if the merge did not produce a value.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: merge-values ((schema-item type-based-merging-mixin) (values sequence))
Source

mixins.lisp.

Generic Function: merge-values-using-type (schema-item values type &key inner-type)

Like ‘merge-values’ but may incorporate TYPE into the decision how to merge VALUES.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: merge-values-using-type ((schema-item type-based-merging-mixin) (values sequence) (type (eql list)) &key inner-type)
Source

value-types.lisp.

Method: merge-values-using-type ((schema-item type-based-merging-mixin) (values sequence) type &key inner-type)
Source

mixins.lisp.

Method: merge-values-using-type ((schema-item type-based-merging-mixin) (values sequence) (type symbol) &key inner-type)
Source

mixins.lisp.

Method: merge-values-using-type ((schema-item type-based-merging-mixin) (values sequence) (type cons) &key inner-type)
Source

mixins.lisp.

Generic Function: name-components (name)

Return a sequence of the components of NAME.

Package

configuration.options.

Source

protocol.lisp.

Methods
Reader Method: name-components ((wildcard-name wildcard-name))

Stores the components of the name.

Source

name.lisp.

Target Slot

components.

Method: name-components ((name list))
Generic Function: name-equal (left right &key start1 end1 start2 end2)

Return non-nil when LEFT and RIGHT are equal.

In case LEFT is not equal to RIGHT, return two values: 1) nil 2) the position of the mismatch in LEFT.

START1 and END1, if supplied, select a subseqeuence of LEFT to be used in the equality test.

START2 and END2, if supplied, select a subseqeuence of RIGHT to be used in the equality test.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: name-equal (left right &key start1 end1 start2 end2)
Generic Function: name-matches (query name &key start1 end1 start2 end2)

Return non-nil when QUERY matches NAME.

This can be the case either when QUERY and NAME are equal or when QUERY contains :wild or :wild-inferiors components matching components of NAME.

START1 and END1, if supplied, select a subseqeuence of QUERY to be used in the matching computation.

START2 and END2, if supplied, select a subseqeuence of NAME to be used in the matching computation.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: name-matches ((query wildcard-name) name &key start1 end1 start2 end2)
Source

name.lisp.

Method: name-matches (query name &key start1 end1 start2 end2)
Method: name-matches :around (query name &key start1 end1 start2 end2)
Generic Reader: name-parse-error-text (condition)
Package

configuration.options.

Methods
Reader Method: name-parse-error-text ((condition name-parse-error))
Source

conditions.lisp.

Target Slot

text.

Generic Function: name< (left right)

Return non-nil when LEFT is BEFORE in the following ordering: components induce a lexicographical ordering where :wild-inferiors go before :wild which in turn goes before all other components.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: name< ((left wildcard-name) (right sequence))
Source

name.lisp.

Method: name< ((left sequence) (right wildcard-name))
Source

name.lisp.

Method: name< (left right)
Generic Reader: notification-error-event (condition)
Package

configuration.options.

Methods
Reader Method: notification-error-event ((condition notification-error))
Source

conditions.lisp.

Target Slot

event.

Generic Reader: notification-error-name (condition)
Package

configuration.options.

Methods
Reader Method: notification-error-name ((condition notification-error))
Source

conditions.lisp.

Target Slot

name.

Generic Reader: notification-error-sink (condition)
Package

configuration.options.

Methods
Reader Method: notification-error-sink ((condition notification-error))
Source

conditions.lisp.

Target Slot

sink.

Generic Reader: notification-error-source (condition)
Package

configuration.options.

Methods
Reader Method: notification-error-source ((condition notification-error))
Source

conditions.lisp.

Target Slot

source.

Generic Function: notify (sink event name value &key raw? source index &allow-other-keys)

SINK is notified about some change regarding the option named NAME.

EVENT can be, for example, :added, :removed, :new-value. For these three, the remaining parameters are interpreted as follows:

EVENT NAME VALUE
:added OPTION-NAME SHOULD-BE-IGNORED
:removed OPTION-NAME SHOULD-BE-IGNORED
:new-value OPTION-NAME [RAW-]NEW-VALUE

RAW? indicates whether VALUE is an unparsed string value or whether it has already been parsed.

The value of the keyword parameter SOURCE usually is the source object that produced the event, but may be nil.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: notify ((sink indexed-sink) event name value &rest args &key index &allow-other-keys)
Source

source-cascade.lisp.

Method: notify ((sink standard-synchronizer) (event (eql :new-value)) name value &rest args &key index source raw? &allow-other-keys)
Source

synchronizer.lisp.

Method: notify ((sink standard-synchronizer) (event (eql :removed)) name value &key &allow-other-keys)
Source

synchronizer.lisp.

Method: notify ((sink standard-synchronizer) (event (eql :added)) name value &key index &allow-other-keys)
Source

synchronizer.lisp.

Method: notify :around (sink event name value &key source &allow-other-keys)
Generic Reader: option-class (schema-item)

Return the name of the class for options based on SCHEMA-ITEM.

Package

configuration.options.

Source

protocol.lisp.

Methods
Reader Method: option-class ((standard-schema-item standard-schema-item))

Stores the name of the class that should be used for
making options corresponding to this schema item.

Source

schema.lisp.

Target Slot

option-class.

Generic Reader: option-condition-option (condition)
Package

configuration.options.

Methods
Reader Method: option-condition-option ((condition option-condition))
Source

conditions.lisp.

Target Slot

option.

Generic Function: option-configuration (option)

Return the configuration object containing OPTION.

Package

configuration.options.

Source

protocol.lisp.

Generic Function: option-default (option &key if-does-not-exist)

Return two values describing the default value of OPTION: 1) nil or the default value of OPTION 2) nil if OPTION does not have a default value and t if OPTION has a default value.

IF-DOES-NOT-EXIST controls the behavior in case OPTION does not have default value:

nil

Return the two values nil, nil.

other value (but not one of the following)

Return the two values IF-DOES-NOT-EXIST, nil.

’warn, #’warn

Signal a ‘value-missing-warning’ indicating that OPTION does not have a default value and return the two values nil, nil.

’error, #’error

Signal a ‘value-missing-error’ indicating that OPTION does not have a default value.

a function

Call the function with a ‘value-missing-error’ instance indicating that OPTION does not have a default value.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: option-default ((option standard-option) &key if-does-not-exist)
Source

configuration.lisp.

Method: option-default ((option option-cell) &key if-does-not-exist)
Source

configuration.lisp.

Method: option-default ((option standard-schema-item) &key if-does-not-exist)
Source

schema.lisp.

Method: option-default :around (option &key if-does-not-exist)
Generic Function: option-documentation (option)

Return nil or the documentation string of OPTION.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: option-documentation ((option standard-option))
Source

configuration.lisp.

Method: option-documentation ((option option-cell))
Source

configuration.lisp.

Method: option-documentation ((option standard-configuration))
Source

configuration.lisp.

Reader Method: option-documentation ((documentation-mixin documentation-mixin))

Stores nil or the documentation string associated to the option.

Source

mixins.lisp.

Target Slot

documentation.

Generic Writer: (setf option-documentation) (object)
Package

configuration.options.

Methods
Writer Method: (setf option-documentation) ((documentation-mixin documentation-mixin))

Stores nil or the documentation string associated to the option.

Source

mixins.lisp.

Target Slot

documentation.

Generic Reader: option-name (option)

Return the name object naming OPTION.

Package

configuration.options.

Source

protocol.lisp.

Methods
Reader Method: option-name ((named-mixin named-mixin))

Stores the name of the option.

Source

mixins.lisp.

Target Slot

name.

Generic Function: option-schema-item (option)

Return the schema item corresponding to OPTION.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: option-schema-item ((option standard-option))
Source

configuration.lisp.

Reader Method: option-schema-item ((option-cell option-cell))

Stores the associated schema item which in turn
stores the type, default and documentation for the option.

Source

configuration.lisp.

Target Slot

schema-item.

Generic Reader: option-syntax-error-type (condition)
Package

configuration.options.

Methods
Reader Method: option-syntax-error-type ((condition option-syntax-error))
Source

conditions.lisp.

Target Slot

type.

Generic Function: option-type (option)

Return the type of OPTION. The returned type is an expression similar to a CL type.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: option-type ((option standard-option))
Source

configuration.lisp.

Method: option-type ((option option-cell))
Source

configuration.lisp.

Reader Method: option-type ((standard-schema-item standard-schema-item))

Stores the type of the option as an expression similar to a CL type.

Source

schema.lisp.

Target Slot

type.

Generic Function: option-value (option &key if-does-not-exist)

Return up to three values describing the value of OPTION:
1) nil or the value of OPTION
2) nil if OPTION does not have a value and t if OPTION has a value 3) if OPTION has a value and a single source provided it, that source.

IF-DOES-NOT-EXIST controls the behavior in case OPTION does not have value:

nil

Return the two values nil, nil.

other value (but not one of the following)

Return the two values IF-DOES-NOT-EXIST, nil.

’warn, #’warn

Signal a ‘value-missing-warning’ indicating that OPTION does not have a default value and return the two values nil, nil.

’error, #’error

Signal a ‘value-missing-error’ indicating that OPTION does not have a value.

a function

Call the function with a ‘value-missing-error’ instance indicating that OPTION does not have a value.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: option-value ((option standard-option) &key if-does-not-exist)
Source

configuration.lisp.

Method: option-value ((option option-cell) &key if-does-not-exist)
Source

configuration.lisp.

Method: option-value :around (option &key if-does-not-exist)
Generic Function: (setf option-value) (option &key if-does-not-exist if-invalid)

Set the current value of OPTION to NEW-VALUE.

IF-DOES-NOT-EXIST is accepted for parity with ‘option-value’.

IF-INVALID controls the behavior in case NEW-VALUE is not a valid value for OPTION. See the description of the if-invalid keyword parameter of the ‘validate-value’ generic function.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: (setf option-value) ((option standard-option) &key if-does-not-exist if-invalid)
Source

configuration.lisp.

Method: (setf option-value) :after ((option option-cell) &key if-does-not-exist if-invalid)
Source

configuration.lisp.

Method: (setf option-value) ((option option-cell) &key if-does-not-exist if-invalid)
Source

configuration.lisp.

Method: (setf option-value) :around ((option option-cell) &key if-does-not-exist if-invalid)
Source

configuration.lisp.

Generic Function: option-values (option)

Return the (potentially empty) sequence of values from which the effective value of OPTION has been constructed via merging.

Entries are of the form

(VALUE &rest PLIST)

where VALUE is a parsed value and PLIST contains at least the property :source holding the source object from which VALUE originated. Additional properties may describe the origin of VALUE in more detail.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: option-values ((option standard-option))
Source

configuration.lisp.

Reader Method: option-values ((option-cell option-cell))

Stores values and additional information regarding
their origins for the option as provided by sources in order of decreasing priority. Entries are of the form

(VALUE &rest PLIST)

where VALUE is a parsed value PLIST contains at least the property :source holding the source object from which VALUE originated. Additional properties may describe the origin of VALUE in more detail.

Source

configuration.lisp.

Target Slot

values.

Generic Function: (setf option-values) (object)
Package

configuration.options.

Methods
Method: (setf option-values) ((option standard-option))
Source

configuration.lisp.

Writer Method: (setf option-values) ((option-cell option-cell))

Stores values and additional information regarding
their origins for the option as provided by sources in order of decreasing priority. Entries are of the form

(VALUE &rest PLIST)

where VALUE is a parsed value PLIST contains at least the property :source holding the source object from which VALUE originated. Additional properties may describe the origin of VALUE in more detail.

Source

configuration.lisp.

Target Slot

values.

Generic Reader: options (container)

Return a sequence of the options contained in CONTAINER.

Package

configuration.options.

Source

protocol.lisp.

Methods
Reader Method: options ((list-container-mixin list-container-mixin))

Stores a sorted list of named options. The contained options are sorted according to ‘name<’.

Source

mixins.lisp.

Target Slot

options.

Generic Function: process (source sink)

Process the configuration information in SOURCE providing the resulting configuration options to SINK.

Package

configuration.options.sources.

Source

protocol.lisp.

Methods
Method: process ((source cascade-source) sink)
Source

source-cascade.lisp.

Method: process ((source file-source) sink)
Source

source-file.lisp.

Method: process ((source stream-source) sink)
Source

source-stream.lisp.

Method: process ((source environment-variables-source) sink)
Source

source-environment-variables.lisp.

Method: process ((source defaults-source) sink)
Source

source-defaults.lisp.

Method: process :around (source sink)
Generic Function: process-content (syntax source sink)

Process content of SOURCE assuming syntax SYNTAX and provide resulting options to SINK.

Package

configuration.options.sources.

Source

protocol.lisp.

Generic Function: raw->value (schema-item raw)

Parse RAW and return a value object taking into account properties of SCHEMA-ITEM.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: raw->value ((schema-item type-based-conversion-mixin) raw)
Source

mixins.lisp.

Method: raw->value :around (schema-item raw)
Generic Function: raw->value-using-type (schema-item raw type &key inner-type &allow-other-keys)

Like ‘raw->value’ but may incorporate TYPE, besides SCHEMA-ITEM, into the parsing of RAW into a value object.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: raw->value-using-type ((schema-item type-based-conversion-mixin) raw (type (eql and)) &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) raw (type (eql or)) &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql list)) &rest args &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw list) (type (eql list)) &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql configuration.options:directory-pathname)) &key &allow-other-keys)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql configuration.options:file-pathname)) &key &allow-other-keys)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql pathname)) &key &allow-other-keys)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql member)) &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql string)) &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql integer)) &key inner-type)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql boolean)) &key &allow-other-keys)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) (raw string) (type (eql null)) &key &allow-other-keys)
Source

value-types.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) raw (type symbol) &key inner-type)
Source

mixins.lisp.

Method: raw->value-using-type ((schema-item type-based-conversion-mixin) raw (type cons) &key inner-type)
Source

mixins.lisp.

Method: raw->value-using-type :around (schema-item raw type &key inner-type)
Generic Function: schema-children (schema)

Return a sequence of the schema items contained in SCHEMA.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: schema-children ((container standard-schema))
Source

schema.lisp.

Generic Reader: schema-condition-schema (condition)
Package

configuration.options.sources.

Methods
Reader Method: schema-condition-schema ((condition schema-condition))
Source

conditions.lisp.

Target Slot

schema.

Generic Reader: schema-syntax-error-specification (condition)
Package

configuration.options.

Methods
Reader Method: schema-syntax-error-specification ((condition schema-syntax-error))
Source

conditions.lisp.

Target Slot

specification.

Generic Reader: sink-condition-sink (condition)
Package

configuration.options.sources.

Methods
Reader Method: sink-condition-sink ((condition sink-condition))
Source

conditions.lisp.

Target Slot

sink.

Generic Reader: source-condition-source (condition)
Package

configuration.options.sources.

Methods
Reader Method: source-condition-source ((condition source-condition))
Source

conditions.lisp.

Target Slot

source.

Generic Function: source-sources (source)

Return the inferior sources managed by SOURCE.

Package

configuration.options.sources.

Source

protocol.lisp.

Methods
Reader Method: source-sources ((cascade-source cascade-source))

Stores a list of sources in order of priority.

Source

source-cascade.lisp.

Target Slot

sources.

Method: source-sources (source)
Generic Function: sub-configuration (query container)

Return a sub-configuration of CONTAINER using QUERY to select options.

QUERY should generally be a name consisting of non-empty prefix of non-wild components followed by one ‘:wild’ or ‘:wild-inferiors’ components, for example:

foo.bar.**

Queries not following this structure, such as

foo.*.bar.*

are also accepted, but can cause errors due to collisions of names
in CONTAINER after stripping the prefix:

foo.a.bar.baz -> baz
foo.b.bar.baz -> baz

The returned configuration is an instance of the class of
CONTAINER.

Options in CONTAINER matching QUERY are copied and stored in the
returned configuration as follows:

* Copied options are instances of the classes of the respective source options

* The prefix mentioned above is stripped from the names of copied options

* Copied options share the "option cell", i.e. schema link,
value storage and hooks with their respective source options.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: sub-configuration (query container)
Method: sub-configuration :around ((query sequence) container)
Generic Reader: synchronizer-target (object)
Package

configuration.options.

Methods
Reader Method: synchronizer-target ((standard-synchronizer standard-synchronizer))

Stores the object into which the synchronizer should implement changes it receives via ‘notify’ calls.

Source

synchronizer.lisp.

Target Slot

target.

Generic Function: validate-value (schema-item value &key if-invalid)

Determine whether VALUE is valid for SCHEMA-ITEM, signaling an error or if it is invalid.

IF-INVALID controls the behavior in case VALUE is invalid for SCHEMA-ITEM:

nil

Return nil.

’error, #’error

Signal an error which indicates VALUE being invalid.

a function

Call the function with an error object which indicates VALUE being invalid as the sole argument.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: validate-value ((schema-item type-based-validation-mixin) value &key if-invalid)
Source

mixins.lisp.

Method: validate-value :around (schema-item value &key if-invalid)
Generic Function: validate-value-using-type (schema-item value type &key inner-type)

Like ‘validate-value’ but may incorporate TYPE into the decision whether VALUE is valid for SCHEMA-ITEM.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: validate-value-using-type ((schema-item type-based-validation-mixin) value (type (eql and)) &key inner-type)
Source

value-types.lisp.

Method: validate-value-using-type ((schema-item type-based-validation-mixin) value (type (eql or)) &key inner-type)
Source

value-types.lisp.

Method: validate-value-using-type ((schema-item type-based-validation-mixin) value (type (eql list)) &key inner-type)
Source

value-types.lisp.

Method: validate-value-using-type ((schema-item type-based-validation-mixin) value type &key inner-type)
Source

mixins.lisp.

Method: validate-value-using-type ((schema-item type-based-validation-mixin) value (type symbol) &key inner-type)
Source

mixins.lisp.

Method: validate-value-using-type ((schema-item type-based-validation-mixin) value (type cons) &key inner-type)
Source

mixins.lisp.

Generic Function: value (option-or-name &key configuration if-does-not-exist if-no-value)

Return the value of OPTION-OR-NAME in CONFIGURATION.

OPTION-OR-NAME is either an option object or an option name designating an option in CONFIGURATION.

If CONFIGURATION is not supplied, the value of *CONFIGURATION* is used. An error is signaled if CONFIGURATION is null.

IF-DOES-NOT-EXIST controls the behavior in case OPTION-OR-NAME is an option name (not an option object) and does not designate an option in CONFIGURATION. For a description of return values, signaled conditions and IF-DOES-NOT-EXIST, see ‘find-option’.

IF-NO-VALUE controls the behavior in case OPTION-OR-NAME does not have a value. For a description of returns values, signaled conditions and IF-NO-VALUE, see IF-DOES-NOT-EXIST in the description of ‘option-value’.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: value (option-or-name &key configuration if-does-not-exist if-no-value)
Method: value :around ((option-or-name sequence) &key configuration if-does-not-exist if-no-value)
Generic Function: (setf value) (option-or-name &key configuration if-does-not-exist if-no-value)

Set value of OPTION-OR-NAME in CONFIGURATION to NEW-VALUE.

OPTION-OR-NAME is either an option object or an option name designating an option in CONFIGURATION.

If CONFIGURATION is not supplied, the value of *CONFIGURATION* is used. An error is signaled if CONFIGURATION is null.

IF-DOES-NOT-EXIST controls the behavior in case OPTION-OR-NAME is an option name (not an option object) and does not designate an option in CONFIGURATION. For a description of return values, signaled conditions and IF-DOES-NOT-EXIST, see ‘find-option’.

IF-NO-VALUE is accepted for parity with ‘value’.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: (setf value) (option-or-name &key configuration if-does-not-exist if-no-value)
Method: (setf value) :around ((option-or-name sequence) &key configuration if-does-not-exist if-no-value)
Generic Function: value->string (schema-item value)

Return a string representation of VALUE taking into account properties of SCHEMA-ITEM.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: value->string ((schema-item type-based-conversion-mixin) value)
Source

mixins.lisp.

Generic Function: value->string-using-type (schema-item value type &key inner-type &allow-other-keys)

Like ‘value->string’ but may incorporate TYPE, besides SCHEMA-ITEM, into the conversion of VALUE into a string representation.

Package

configuration.options.

Source

protocol.lisp.

Methods
Method: value->string-using-type ((schema-item type-based-conversion-mixin) value (type (eql and)) &key inner-type)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) value (type (eql or)) &key inner-type)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value list) (type (eql list)) &key inner-type)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value pathname) (type (eql configuration.options:directory-pathname)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value pathname) (type (eql configuration.options:file-pathname)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value pathname) (type (eql pathname)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value symbol) (type (eql member)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value string) (type (eql string)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) (value integer) (type (eql integer)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) value (type (eql boolean)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) value (type (eql null)) &key &allow-other-keys)
Source

value-types.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) value (type symbol) &key inner-type)
Source

mixins.lisp.

Method: value->string-using-type ((schema-item type-based-conversion-mixin) value (type cons) &key inner-type)
Source

mixins.lisp.

Generic Reader: value-condition-value (condition)
Package

configuration.options.

Methods
Reader Method: value-condition-value ((condition value-condition))
Source

conditions.lisp.

Target Slot

value.

Generic Reader: value-missing-condition-which (condition)
Package

configuration.options.

Methods
Reader Method: value-missing-condition-which ((condition value-missing-condition))
Source

conditions.lisp.

Target Slot

which.


6.1.6 Standalone methods

Method: describe-object ((object standard-option) stream)
Source

configuration.lisp.

Method: describe-object ((object standard-schema-item) stream)
Source

schema.lisp.

Method: describe-object ((object describe-via-map-options-mixin) stream)
Source

mixins.lisp.

Method: documentation ((object standard-option) (type (eql t)))
Source

configuration.lisp.

Method: documentation ((object standard-configuration) (type (eql t)))
Source

configuration.lisp.

Method: documentation ((option documentation-mixin) (type (eql t)))
Source

mixins.lisp.

Method: (setf elt) ((sequence wildcard-name) (index integer))
Package

sb-sequence.

Source

name.lisp.

Method: elt ((sequence wildcard-name) (index integer))
Package

sb-sequence.

Source

name.lisp.

Method: length ((sequence wildcard-name))
Package

sb-sequence.

Source

name.lisp.

Method: make-sequence-like ((sequence wildcard-name) (length integer) &key initial-element initial-contents)
Package

sb-sequence.

Source

name.lisp.

Method: print-items append ((object standard-option))
Package

utilities.print-items.

Source

configuration.lisp.

Method: print-items append ((object standard-schema-item))
Package

utilities.print-items.

Source

schema.lisp.

Method: print-items append ((object standard-schema))
Package

utilities.print-items.

Source

schema.lisp.

Method: print-items append ((object list-container-mixin))
Package

utilities.print-items.

Source

mixins.lisp.

Method: print-items append ((object option-cell))
Package

utilities.print-items.

Source

configuration.lisp.

Method: print-items append ((object named-mixin))
Package

utilities.print-items.

Source

mixins.lisp.

Method: print-items append ((object environment-variables-source))
Package

utilities.print-items.

Source

source-environment-variables.lisp.

Method: print-items append ((object stream-source))
Package

utilities.print-items.

Source

source-stream.lisp.

Method: print-items append ((object config-file-cascade-source))
Package

utilities.print-items.

Source

source-cascade.lisp.

Method: print-items append ((object file-source))
Package

utilities.print-items.

Source

source-file.lisp.

Method: print-items append ((object cascade-source))
Package

utilities.print-items.

Source

source-cascade.lisp.

Method: print-items append ((object directory-source))
Package

utilities.print-items.

Source

source-cascade.lisp.

Method: print-object ((object wildcard-name) stream)
Source

name.lisp.

Method: shared-initialize :after ((instance standard-schema-item) slot-names &key default)
Source

schema.lisp.

Method: shared-initialize :before ((instance wildcard-name) slot-names &key components)
Source

name.lisp.

Method: shared-initialize :after ((instance option-cell) slot-names &key value)
Source

configuration.lisp.

Method: shared-initialize :after ((instance synchronizer-handler) slot-names &key option)
Source

synchronizer.lisp.

Method: shared-initialize :after ((instance named-mixin) slot-names &key name)
Source

mixins.lisp.

Method: shared-initialize :after ((instance environment-variables-source) slot-names &key prefix name-mapping)
Source

source-environment-variables.lisp.

Method: shared-initialize :before ((instance environment-variables-source) slot-names &key prefix name-mapping)
Source

source-environment-variables.lisp.

Method: shared-initialize :after ((instance stream-source) slot-names &key syntax)
Source

source-stream.lisp.

Method: shared-initialize :around ((instance config-file-cascade-source) slot-names &rest args &key config-file prefix paths sources &allow-other-keys)
Source

source-cascade.lisp.

Method: shared-initialize :around ((instance common-cascade-source) slot-names &rest args &key sources basename type paths prefix/commandline prefix/environment-variables &allow-other-keys)
Source

source-cascade.lisp.

Method: shared-initialize :after ((instance file-source) slot-names &key pathname)
Source

source-file.lisp.

Method: shared-initialize :after ((instance cascade-source) slot-names &key sources)
Source

source-cascade.lisp.

Method: shared-initialize :around ((instance directory-source) slot-names &rest args &key pattern ignore compare &allow-other-keys)
Source

source-cascade.lisp.

Method: subseq ((sequence wildcard-name) (start integer) &optional end)
Package

sb-sequence.

Source

name.lisp.


6.1.7 Conditions

Condition: binding-condition

Instance of subclasses of this condition class are signaled in situations involving a named binding in a container.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:container(missing-required-initarg (quote binding-condition) container)
:name(missing-required-initarg (quote binding-condition) name)
Direct slots
Slot: name

Stores the name of the item which could not be found.

Initargs

:name

Readers

binding-condition-name.

Writers

This slot is read-only.

Slot: container

Stores the container object in which the requested item could not be found.

Initargs

:container

Readers

binding-condition-container.

Writers

This slot is read-only.

Condition: binding-exists-condition

Instances of subclasses of this condition class are signaled when an attempt is made to store an item in a container under a name for which an item is already stored.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

binding-condition.

Direct subclasses
Direct methods

binding-exists-condition-existing.

Direct Default Initargs
InitargValue
:existing(missing-required-initarg (quote binding-exists-condition) existing)
Direct slots
Slot: existing

Stores the object already stored under the name in question.

Initargs

:existing

Readers

binding-exists-condition-existing.

Writers

This slot is read-only.

Condition: binding-missing-condition

Instances of subclasses of this condition class are signaled when a requested item object cannot be found in a container.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

binding-condition.

Direct subclasses
Condition: child-exists-error

This error is signaled when an attempt is made to store a child in a container under a name for which a child is already stored.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: child-exists-warning

This warning is signaled when an attempt is made to store a child in a container under a name for which a child is already stored.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: child-missing-error

This error is signaled when a requested child cannot be found in a container.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: child-missing-warning

This warning is signaled when a requested child cannot be found in a container.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: initialization-error

This error is signaled when initializing a configuration source fails.

Package

configuration.options.sources.

Source

conditions.lisp.

Direct superclasses
Condition: name-parse-error

This error is signaled when a given string cannot be parsed as an option name.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

parse-error.

Direct methods

name-parse-error-text.

Direct slots
Slot: text

Stores the string which could not be parsed as an option name.

Initargs

:text

Readers

name-parse-error-text.

Writers

This slot is read-only.

Condition: notification-error

This error is signaled when an error is encountered during notification of a sink of an event originating from a source.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: sink

Stores the sink which was being notified when the error was encountered.

Initargs

:sink

Readers

notification-error-sink.

Writers

This slot is read-only.

Slot: event

Stores the event of which the was being notified when the error was encountered

Initargs

:event

Readers

notification-error-event.

Writers

This slot is read-only.

Slot: name

Stores the name of the option that was the subject of the notification during which the error was encountered.

Initargs

:name

Readers

notification-error-name.

Writers

This slot is read-only.

Slot: source

Stores the source from which the notification originated.

Initargs

:source

Readers

notification-error-source.

Writers

This slot is read-only.

Condition: option-exists-error

This error is signaled when an attempt is made to store a option in a container under a name for which a option is already stored.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: option-exists-warning

This warning is signaled when an attempt is made to store a option in a container under a name for which a option is already stored.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: option-missing-error

This error is signaled when a requested option cannot be found in a container.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: option-missing-warning

This warning is signaled when a requested option cannot be found in a container.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: option-syntax-error

This error is signaled when a given string cannot be parsed as a value of a particular option.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

option-value-error.

Direct methods

option-syntax-error-type.

Direct slots
Slot: type

Stores the type that was used in the failed parsing attempt.

Package

common-lisp.

Initform

(quote nil)

Initargs

:type

Readers

option-syntax-error-type.

Writers

This slot is read-only.

Condition: option-value-error

This error and its subclasses is signaled when an error regarding an option value is encountered.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Direct subclasses

option-syntax-error.

Condition: processing-error

This error is signaled when processing a source in order to provide options to a sink fails.

Package

configuration.options.sources.

Source

conditions.lisp.

Direct superclasses
Condition: schema-condition

Instances of subclasses of this condition are signaled when an unexpected condition is encountered during an operation involving a schema.

Package

configuration.options.sources.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses

initialization-error.

Direct methods

schema-condition-schema.

Direct Default Initargs
InitargValue
:schema(missing-required-initarg (quote schema-condition) schema)
Direct slots
Slot: schema

Stores the schema involved in the operation for which the condition is signaled.

Initargs

:schema

Readers

schema-condition-schema.

Writers

This slot is read-only.

Condition: schema-syntax-error

This error is signaled when a schema specification is syntactically incorrect.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

schema-syntax-error-specification.

Direct Default Initargs
InitargValue
:specification(missing-required-initarg (quote schema-syntax-error) specification)
Direct slots
Slot: specification

Stores the offending specification.

Initargs

:specification

Readers

schema-syntax-error-specification.

Writers

This slot is read-only.

Condition: sink-condition

Instances of subclasses of this condition are signaled when an unexpected condition is encountered during an operation involving a sink.

Package

configuration.options.sources.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses

processing-error.

Direct methods

sink-condition-sink.

Direct Default Initargs
InitargValue
:sink(missing-required-initarg (quote sink-condition) sink)
Direct slots
Slot: sink

Stores the sink involved in the operation for which the condition is signaled.

Initargs

:sink

Readers

sink-condition-sink.

Writers

This slot is read-only.

Condition: source-condition

Instances of subclasses of this condition are signaled when an unexpected condition is encountered during an operation involving a source.

Package

configuration.options.sources.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods

source-condition-source.

Direct Default Initargs
InitargValue
:source(missing-required-initarg (quote source-condition) source)
Direct slots
Slot: source

Stores the source involved in the operation for which the condition is signaled.

Initargs

:source

Readers

source-condition-source.

Writers

This slot is read-only.

Condition: value-missing-condition

Instances of subclasses of this condition class are signaled when an option value is requested which does not exist.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

option-condition.

Direct subclasses
Direct methods

value-missing-condition-which.

Direct slots
Slot: which

Stores a symbol describing the option value which was requested but did not exist.

Initform

(quote :value)

Initargs

:which

Readers

value-missing-condition-which.

Writers

This slot is read-only.

Condition: value-missing-error
Package

configuration.options.

Source

conditions.lisp.

Direct superclasses
Condition: value-missing-warning
Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

6.1.8 Classes

Class: standard-configuration

Instances of this class store collections of named options.

Package

configuration.options.

Source

configuration.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:schema(missing-required-initarg (quote standard-configuration) schema)
Direct slots
Slot: schema

Stores the schema object associated to the configuration object.

Initargs

:schema

Readers

configuration-schema.

Writers

This slot is read-only.

Class: standard-option

Instances of this class associate an option name to an schema item and potentially an option value.

Package

configuration.options.

Source

configuration.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:cell(missing-required-initarg (quote standard-option) cell)
Direct slots
Slot: cell

Stores the cell which in turn stores the associated schema item and can store the actual value of the option.

Initargs

:cell

Readers

option-%cell.

Writers

This slot is read-only.

Class: standard-schema

Instances of this class store named schema items which describe option names, option types and other properties. In addition, schema instances can contain child schemas.

Package

configuration.options.

Source

schema.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: children

Stores named child schemas. Elements are of the form

(NAME . CHILD-SCHEMA)

where NAME is a wild name.

Type

list

Initform

(quote nil)

Readers
Writers

(setf %children).

Class: standard-schema-item

Instances of this class associate an name or name pattern to a type and optionally a default value.

Package

configuration.options.

Source

schema.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:type(missing-required-initarg (quote standard-schema-item) (quote type))
:option-class(quote standard-option)
Direct slots
Slot: type

Stores the type of the option as an expression similar to a CL type.

Package

common-lisp.

Initargs

:type

Readers

option-type.

Writers

This slot is read-only.

Slot: default

Stores a function returning the default value of the
schema item.

Is unbound when the schema item does not have a default value.

Type

function

Readers

option-%default.

Writers

(setf option-%default).

Slot: option-class

Stores the name of the class that should be used for
making options corresponding to this schema item.

Type

symbol

Initargs

:option-class

Readers

option-class.

Writers

This slot is read-only.

Class: standard-synchronizer

Instances of this class are notified of configuration changes via calls of ‘notify’ generic function and implement these changes in "target" objects such as ‘standard-configuration’ instances.

Note: this synchronizer is not thread-safe.

Package

configuration.options.

Source

synchronizer.lisp.

Direct methods
Direct Default Initargs
InitargValue
:target(missing-required-initarg (quote standard-synchronizer) target)
Direct slots
Slot: target

Stores the object into which the synchronizer should implement changes it receives via ‘notify’ calls.

Initargs

:target

Readers

synchronizer-target.

Writers

This slot is read-only.

Class: wildcard-name

Instances of this class represent names which contain at least one wild component.

Package

configuration.options.

Source

name.lisp.

Direct superclasses

sequence.

Direct methods
Direct Default Initargs
InitargValue
:components(missing-required-initarg (quote wildcard-name) components)
Direct slots
Slot: components

Stores the components of the name.

Type

list

Initargs

:components

Readers

name-components.

Writers

This slot is read-only.


6.1.9 Types

Type: directory-pathname ()

A pathname syntactically suitable for designating a directory.

The pathname must have a directory but no name or type component. Such pathnames are commonly written as "foo/bar/", i.e. with a trailing "/".

Package

configuration.options.

Source

value-types.lisp.

Type: file-pathname ()

A pathname syntactically suitable for designating a file.

For example, a pathname without a name component, commonly written as "foo/bar/", i.e. with a trailing "/", cannot designate a file.

Package

configuration.options.

Source

value-types.lisp.

Type: name-component ()

Valid components of an option name.

Package

configuration.options.

Source

types.lisp.

Type: non-wild-name-component ()

Valid components of a non-wild option name.

Package

configuration.options.

Source

types.lisp.

Type: wild-name-component ()

Wild components of an option name (like in pathnames).

Package

configuration.options.

Source

types.lisp.


6.2 Internals


6.2.1 Constants

Constant: +config-file-pwd-placeholder+
Package

configuration.options.sources.

Source

configuration-files.lisp.

Constant: +config-file-system-placeholder+
Package

configuration.options.sources.

Source

configuration-files.lisp.

Constant: +config-file-user-placeholder+
Package

configuration.options.sources.

Source

configuration-files.lisp.

Constant: +config-files-variable-suffix+
Package

configuration.options.sources.

Source

configuration-files.lisp.

Constant: +no-value+

This object is used to indicate that a value cell is not occupied.

Package

configuration.options.

Source

variables.lisp.


6.2.2 Special variables

Special Variable: *debug-index*
Package

configuration.options.sources.

Source

debug.lisp.

Special Variable: *default-configuration-files*

List of configuration file names in order of decreasing priority.

Package

configuration.options.sources.

Source

configuration-files.lisp.

Special Variable: *level*
Package

configuration.options.debug.

Source

debug.lisp.

Special Variable: *parse-wild-allowed*

Controls whether "*" is accepted and interpreted as :wild component when parsing names.

Package

configuration.options.

Source

name.lisp.

Special Variable: *parse-wild-inferiors-allowed*

Controls whether "**" is accepted and interpreted as :wild-inferiors component when parsing names.

Package

configuration.options.

Source

name.lisp.

Special Variable: *stream*
Package

configuration.options.debug.

Source

debug.lisp.


6.2.3 Macros

Macro: define-dispatch-methods (name (class value-parameter value-specializer))
Package

configuration.options.

Source

mixins.lisp.

Macro: if-name (var then else)
Package

configuration.options.

Source

protocol.lisp.

Macro: with-source-debug ((format-control &rest format-arguments) &body forms)
Package

configuration.options.sources.

Source

debug.lisp.


6.2.4 Ordinary functions

Function: %every-element-name-component? (thing)
Package

configuration.options.

Source

types.lisp.

Function: %has-wild-component? (thing)
Package

configuration.options.

Source

types.lisp.

Function: %make-option-value (option &optional if-does-not-exist)
Package

configuration.options.

Source

let-plus.lisp.

Function: %maybe-check-detailed-type (value type inner-type format-control)
Package

configuration.options.

Source

value-types.lisp.

Function: %parse-value-binding (spec)
Package

configuration.options.

Source

let-plus.lisp.

Function: %update-value (option schema-item values)
Package

configuration.options.

Source

synchronizer.lisp.

Function: call-with-source-debug (thunk format-control format-arguments)
Package

configuration.options.sources.

Source

debug.lisp.

Function: config-files-variable-name (prefix)
Package

configuration.options.sources.

Source

configuration-files.lisp.

Function: config-files-variable-value (prefix)
Package

configuration.options.sources.

Source

configuration-files.lisp.

Function: copy-indexed-sink (instance)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Function: environment-variable-namify (string)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Function: handler-of (synchronizer)
Package

configuration.options.

Source

synchronizer.lisp.

Function: ignore-meta-configuration-variables (function)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Reader: indexed-sink-index (instance)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Target Slot

index.

Function: indexed-sink-p (object)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Reader: indexed-sink-sink (instance)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Target Slot

sink.

Function: make-environment-variable-name->option-name (&key prefix)
Package

configuration.options.sources.

Source

source-environment-variables.lisp.

Function: make-indexed-sink (index sink)
Package

configuration.options.sources.

Source

source-cascade.lisp.

Function: map-query-alignments (function query start1 end1 name start2 end2)
Package

configuration.options.

Source

name.lisp.

Function: print-documentation (stream documentation &optional colon? at?)

‘pprint-fill’ the words in DOCUMENTATION onto STREAM.

Package

configuration.options.

Source

util.lisp.

Function: system-configuration-directory (&key prefix)
Package

configuration.options.sources.

Source

configuration-files.lisp.

Function: typexpand-1 (type-specifier)
Package

configuration.options.

Source

util.lisp.

Function: typexpand-1-unless-builtin (type-specifier)
Package

configuration.options.

Source

util.lisp.

Function: user-configuration-directory (&key user-homedir)
Package

configuration.options.sources.

Source

configuration-files.lisp.


6.2.5 Generic functions

Generic Reader: %children (object)
Generic Writer: (setf %children) (object)
Package

configuration.options.

Methods
Reader Method: %children ((standard-schema standard-schema))
Writer Method: (setf %children) ((standard-schema standard-schema))

Stores named child schemas. Elements are of the form

(NAME . CHILD-SCHEMA)

where NAME is a wild name.

Source

schema.lisp.

Target Slot

children.

Generic Reader: %options (object)
Generic Writer: (setf %options) (object)
Package

configuration.options.

Methods
Reader Method: %options ((list-container-mixin list-container-mixin))
Writer Method: (setf %options) ((list-container-mixin list-container-mixin))

Stores a sorted list of named options. The contained options are sorted according to ‘name<’.

Source

mixins.lisp.

Target Slot

options.

Generic Reader: option-%cell (object)
Package

configuration.options.

Methods
Reader Method: option-%cell ((standard-option standard-option))

Stores the cell which in turn stores the associated schema item and can store the actual value of the option.

Source

configuration.lisp.

Target Slot

cell.

Generic Reader: option-%default (object)
Package

configuration.options.

Methods
Reader Method: option-%default ((standard-schema-item standard-schema-item))

Stores a function returning the default value of the
schema item.

Is unbound when the schema item does not have a default value.

Source

schema.lisp.

Target Slot

default.

Generic Function: (setf option-%default) (object)
Package

configuration.options.

Methods
Writer Method: (setf option-%default) :before ((option standard-schema-item))
Source

schema.lisp.

Target Slot

default.

Method: (setf option-%default) :around ((option standard-schema-item))
Source

schema.lisp.

Method: (setf option-%default) ((standard-schema-item standard-schema-item))

Stores a function returning the default value of the
schema item.

Is unbound when the schema item does not have a default value.

Source

schema.lisp.

Generic Writer: (setf option-%name) (object)
Package

configuration.options.

Methods
Writer Method: (setf option-%name) ((named-mixin named-mixin))

Stores the name of the option.

Source

mixins.lisp.

Target Slot

name.

Generic Reader: option-%value (object)
Generic Writer: (setf option-%value) (object)
Package

configuration.options.

Methods
Reader Method: option-%value ((option-cell option-cell))
Writer Method: (setf option-%value) ((option-cell option-cell))

Stores the value of the option cell.

Is unbound when the option cell does not have a value.

Source

configuration.lisp.

Target Slot

value.

Generic Reader: schema-children/alist (object)
Package

configuration.options.

Methods
Reader Method: schema-children/alist ((standard-schema standard-schema))

Stores named child schemas. Elements are of the form

(NAME . CHILD-SCHEMA)

where NAME is a wild name.

Source

schema.lisp.

Target Slot

children.

Generic Reader: source-%name-mapping (object)
Generic Writer: (setf source-%name-mapping) (object)
Package

configuration.options.sources.

Methods
Reader Method: source-%name-mapping ((environment-variables-source environment-variables-source))
Writer Method: (setf source-%name-mapping) ((environment-variables-source environment-variables-source))

Stores a function that maps environment variable names to option names.

Source

source-environment-variables.lisp.

Target Slot

name-mapping.

Generic Reader: source-%pathname (object)
Generic Writer: (setf source-%pathname) (object)
Package

configuration.options.sources.

Methods
Reader Method: source-%pathname ((file-source file-source))
Writer Method: (setf source-%pathname) ((file-source file-source))

Stores the pathname of the file from which
configuration options should be read.

Source

source-file.lisp.

Target Slot

pathname.

Generic Reader: source-%schema (object)
Package

configuration.options.sources.

Methods
Reader Method: source-%schema ((defaults-source defaults-source))

automatically generated reader method

Source

source-defaults.lisp.

Target Slot

schema.

Generic Writer: (setf source-%schema) (object)
Package

configuration.options.sources.

Methods
Writer Method: (setf source-%schema) ((defaults-source defaults-source))

automatically generated writer method

Source

source-defaults.lisp.

Target Slot

schema.

Generic Reader: source-%sources (object)
Generic Writer: (setf source-%sources) (object)
Package

configuration.options.sources.

Methods
Reader Method: source-%sources ((cascade-source cascade-source))
Writer Method: (setf source-%sources) ((cascade-source cascade-source))

Stores a list of sources in order of priority.

Source

source-cascade.lisp.

Target Slot

sources.

Generic Reader: source-%stream (object)
Generic Writer: (setf source-%stream) (object)
Package

configuration.options.sources.

Methods
Reader Method: source-%stream ((stream-source stream-source))
Writer Method: (setf source-%stream) ((stream-source stream-source))

Stores the stream from which the source reads when processing.

Source

source-stream.lisp.

Target Slot

stream.

Generic Reader: source-%syntax (object)
Generic Writer: (setf source-%syntax) (object)
Package

configuration.options.sources.

Methods
Reader Method: source-%syntax ((stream-source stream-source))
Writer Method: (setf source-%syntax) ((stream-source stream-source))

Stores the syntax object which should be used to parse the contents of the processed stream.

Source

source-stream.lisp.

Target Slot

syntax.

Generic Reader: source-description (object)
Package

configuration.options.sources.

Methods
Reader Method: source-description ((file-source file-source))

A description of the role the file source plays in the configuration scheme.

Source

source-file.lisp.

Target Slot

description.

Generic Reader: source-element-type (object)
Package

configuration.options.sources.

Methods
Reader Method: source-element-type ((file-source file-source))

Stores the desired element-type of the stream created for the source.

Source

source-file.lisp.

Target Slot

element-type.

Generic Reader: source-if-does-not-exist (object)
Package

configuration.options.sources.

Methods
Reader Method: source-if-does-not-exist ((file-source file-source))

Stores the behavior in case the specified file does not exist.

Source

source-file.lisp.

Target Slot

if-does-not-exist.

Generic Reader: source-name-mapping (object)
Package

configuration.options.sources.

Methods
Reader Method: source-name-mapping ((environment-variables-source environment-variables-source))

Stores a function that maps environment variable names to option names.

Source

source-environment-variables.lisp.

Target Slot

name-mapping.

Generic Reader: source-pathname (object)
Package

configuration.options.sources.

Methods
Reader Method: source-pathname ((file-source file-source))

Stores the pathname of the file from which
configuration options should be read.

Source

source-file.lisp.

Target Slot

pathname.

Generic Reader: source-pattern (object)
Package

configuration.options.sources.

Methods
Reader Method: source-pattern ((directory-source directory-source))

A (wild) pathname or pathname designator which will be used to collect files for the source.

Source

source-cascade.lisp.

Target Slot

pattern.

Generic Reader: source-stream (object)
Package

configuration.options.sources.

Methods
Reader Method: source-stream ((stream-source stream-source))

Stores the stream from which the source reads when processing.

Source

source-stream.lisp.

Target Slot

stream.

Generic Reader: source-syntax (object)
Package

configuration.options.sources.

Methods
Reader Method: source-syntax ((stream-source stream-source))

Stores the syntax object which should be used to parse the contents of the processed stream.

Source

source-stream.lisp.

Target Slot

syntax.

Generic Reader: synchronizer-handler-synchronizer (object)
Package

configuration.options.

Methods
Reader Method: synchronizer-handler-synchronizer ((synchronizer-handler synchronizer-handler))

Stores the synchronizer which created this handler.

Source

synchronizer.lisp.

Target Slot

synchronizer.


6.2.6 Conditions

Condition: option-condition

Subclasses of this condition class are signaled when a problem involving an option is encountered.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods

option-condition-option.

Direct Default Initargs
InitargValue
:option(missing-required-initarg (quote option-condition) option)
Direct slots
Slot: option

Stores the involved option or its name.

Initargs

:option

Readers

option-condition-option.

Writers

This slot is read-only.

Condition: value-condition

Subclasses of this condition class are signaled when a problem regarding an option value is encountered.

Package

configuration.options.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses
Direct methods

value-condition-value.

Direct Default Initargs
InitargValue
:value(missing-required-initarg (quote value-condition) value)
Direct slots
Slot: value

Stores the problematic option value.

Initargs

:value

Readers

value-condition-value.

Writers

This slot is read-only.


6.2.7 Structures

Structure: indexed-sink
Package

configuration.options.sources.

Source

source-cascade.lisp.

Direct superclasses

structure-object.

Direct methods

notify.

Direct slots
Slot: index
Type

alexandria:non-negative-integer

Initform

(more-conditions:missing-required-initarg (quote configuration.options.sources::indexed-sink) :index)

Readers

indexed-sink-index.

Writers

This slot is read-only.

Slot: sink
Initform

(more-conditions:missing-required-initarg (quote configuration.options.sources::indexed-sink) :sink)

Readers

indexed-sink-sink.

Writers

This slot is read-only.


6.2.8 Classes

Class: cascade-source

This source organizes a set of sources into a prioritized cascade.

Option values from sources with higher priority are shadow or are combined with option values from sources with lower priority.

When subordinate sources are themselves cascades, their priorities are integrated into the priorities of the containing cascade.

Package

configuration.options.sources.

Source

source-cascade.lisp.

Direct superclasses

print-items-mixin.

Direct subclasses
Direct methods
Direct slots
Slot: sources

Stores a list of sources in order of priority.

Type

list

Initform

(quote nil)

Initargs

:sources

Readers
Writers

(setf source-%sources).

Class: common-cascade-source

This source implements a typical cascade for commandline programs.

The cascade consists of the following sources:
1. Commandline options
2. Environment variables
3. Configuration files
1. ./BASENAME.TYPE
2. ~/.config/BASENAME.TYPE
3. PREFIX/etc/BASENAME.TYPE
4. Default values

where TYPE defaults to "conf" and PREFIX defaults to "/".

Package

configuration.options.sources.

Source

source-cascade.lisp.

Direct superclasses

cascade-source.

Direct methods

shared-initialize.

Direct Default Initargs
InitargValue
:basename(missing-required-initarg (quote common-cascade-source) basename)
Class: config-file-cascade-source

This source implements a cascade of file-based sources.

Names of configuration files are derived from a given base name.

The following initargs are accepted:

:prefix PREFIX

"/etc/" and CONFIG-FILE are appended to this prefix to form the name of the system-wide (actually prefix-wide) configuration file. Defaults to "/". Incompatible with :paths.

:paths PATHS

A list of directories containing configuration files, each of which is merged with the value of CONFIG-FILE to produce a configuration file name. Incompatible with :prefix.

:config-file CONFIG-FILE

A configuration file basename (without directory) with is merged with each element of PATHS to produce configuration file names.

:sources SOURCES

This initarg is accepted to maintain the protocol of the ‘cascade-source’ superclass, but is incompatible with all other initargs.

Package

configuration.options.sources.

Source

source-cascade.lisp.

Direct superclasses

cascade-source.

Direct methods
Class: defaults-source

This source assigns default values to options.

Package

configuration.options.sources.

Source

source-defaults.lisp.

Direct methods
Direct slots
Slot: schema
Readers

source-%schema.

Writers

(setf source-%schema).

Class: describe-via-map-options-mixin

This class is intended to be mixed into option container classes that need a method on ‘describe-opbject’.

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses
Direct methods

describe-object.

Class: directory-source

Collects config files and creates corresponding subordinate sources.

The following initargs are accepted:

:pattern PATTERN

A (wild) pathname or pathname designator which will be used to collect files for the source.

:ignore FUNCTION-OF-ONE-ARGUMENT

A function or function designator that should be called on collected candidate files to decide whether they should be used or ignored.

:compare FUNCTION-OF-TWO-ARGUMENTS

A function or function designator that should be used to sort collected files and thereby determine a processing order.

Package

configuration.options.sources.

Source

source-cascade.lisp.

Direct superclasses

cascade-source.

Direct methods
Direct Default Initargs
InitargValue
:pattern(missing-required-initarg (quote directory-source) pattern)
:ignore(load-time-value (curry (function starts-with) .) t)
:compare(load-time-value (lambda (x y) (string< (pathname-name x) (pathname-name y))) t)
Direct slots
Slot: pattern

A (wild) pathname or pathname designator which will be used to collect files for the source.

Type

(or string pathname)

Initargs

:pattern

Readers

source-pattern.

Writers

This slot is read-only.

Class: documentation-mixin

This class is intended to be mixed into all classes instances of which can have an associated documentation string.

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: documentation

Stores nil or the documentation string associated to the option.

Package

common-lisp.

Type

(or null string)

Initargs

:documentation

Readers

option-documentation.

Writers

(setf option-documentation).

Class: environment-variables-source

This source reads values of environment variables.

Package

configuration.options.sources.

Source

source-environment-variables.lisp.

Direct superclasses

print-items-mixin.

Direct methods
Direct slots
Slot: name-mapping

Stores a function that maps environment variable names to option names.

Type

function

Initform

(configuration.options.sources::make-environment-variable-name->option-name)

Initargs

:name-mapping

Readers
Writers

(setf source-%name-mapping).

Class: event-hook-mixin

This class is intended to be mixed into classes which have to emit or relay events using the event hooks mechanism.

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses
Direct methods

event-hook.

Direct slots
Slot: event-hook

Stores the handlers of the event hook of the object.

Type

list

Initform

(quote nil)

Class: file-source

This source reads configuration data from files.

Package

configuration.options.sources.

Source

source-file.lisp.

Direct superclasses

stream-source.

Direct methods
Direct Default Initargs
InitargValue
:stream(load-time-value (make-string-input-stream ) t)
:pathname(missing-required-initarg (quote file-source) pathname)
Direct slots
Slot: pathname

Stores the pathname of the file from which
configuration options should be read.

Package

common-lisp.

Type

pathname

Readers
Writers

(setf source-%pathname).

Slot: element-type

Stores the desired element-type of the stream created for the source.

Initform

(quote character)

Initargs

:element-type

Readers

source-element-type.

Writers

This slot is read-only.

Slot: if-does-not-exist

Stores the behavior in case the specified file does not exist.

Initform

:error

Initargs

:if-does-not-exist

Readers

source-if-does-not-exist.

Writers

This slot is read-only.

Slot: description

A description of the role the file source plays in the configuration scheme.

Type

(or null string)

Initargs

:description

Readers

source-description.

Writers

This slot is read-only.

Class: list-container-mixin

This class is intended to be mixed into classes which act as a container of options.

Package

configuration.options.

Source

mixins.lisp.

Direct superclasses

event-hook-mixin.

Direct subclasses
Direct methods
Direct slots
Slot: options

Stores a sorted list of named options. The contained options are sorted according to ‘name<’.

Type

list

Readers
Writers

(setf %options).

Class: named-mixin

This class is intended to be mixed into classes instances of which have an associated name.

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:name(missing-required-initarg (quote named-mixin) name)
Direct slots
Slot: name

Stores the name of the option.

Readers

option-name.

Writers

(setf option-%name).

Class: option-cell

Instances of this class represent all aspects of options but their name.

Options point to cells for value storage and, transitively, the associated schema-item. Multiple options can point to one ‘option-cell’ instance.

Package

configuration.options.

Source

configuration.lisp.

Direct superclasses
Direct methods
Direct Default Initargs
InitargValue
:schema-item(missing-required-initarg (quote option-cell) schema-item)
Direct slots
Slot: schema-item

Stores the associated schema item which in turn
stores the type, default and documentation for the option.

Initargs

:schema-item

Readers

option-schema-item.

Writers

This slot is read-only.

Slot: value

Stores the value of the option cell.

Is unbound when the option cell does not have a value.

Readers

option-%value.

Writers

(setf option-%value).

Slot: values

Stores values and additional information regarding
their origins for the option as provided by sources in order of decreasing priority. Entries are of the form

(VALUE &rest PLIST)

where VALUE is a parsed value PLIST contains at least the property :source holding the source object from which VALUE originated. Additional properties may describe the origin of VALUE in more detail.

Package

common-lisp.

Type

vector

Initform

(make-array 0)

Readers

option-values.

Writers

(setf option-values).

Class: stream-source

This source reads and configuration data from streams.

Supplied streams are not closed after processing.

Package

configuration.options.sources.

Source

source-stream.lisp.

Direct superclasses

print-items-mixin.

Direct subclasses

file-source.

Direct methods
Direct Default Initargs
InitargValue
:stream(missing-required-initarg (quote stream-source) stream)
:syntax(missing-required-initarg (quote stream-source) syntax)
Direct slots
Slot: stream

Stores the stream from which the source reads when processing.

Package

common-lisp.

Type

stream

Initargs

:stream

Readers
Writers

(setf source-%stream).

Slot: syntax

Stores the syntax object which should be used to parse the contents of the processed stream.

Readers
Writers

(setf source-%syntax).

Class: synchronizer-handler

Instances of this class are attached to event hooks of ‘option-cell’s by synchronizers in order to forward events to the event hooks of options.

Package

configuration.options.

Source

synchronizer.lisp.

Direct superclasses

funcallable-standard-object.

Direct methods
Direct Default Initargs
InitargValue
:synchronizer(missing-required-initarg (quote synchronizer-handler) synchronizer)
:option(missing-required-initarg (quote synchronizer-handler) option)
Direct slots
Slot: synchronizer

Stores the synchronizer which created this handler.

Initargs

:synchronizer

Readers

synchronizer-handler-synchronizer.

Writers

This slot is read-only.

Class: type-based-conversion-mixin

This mixin class is intended to be mixed into schema item classes which have to perform parsing and unparsing of values based their types.

This behavior is implemented by a methods on ‘value->string’ and ‘raw->value’ which call ‘value->string-using-type’ and ‘raw->value-using-type’ respectively with the ‘option-type’ of the schema item.

Default behavior is provided for some types:

* boolean
* integer
* string
* member
* pathname
* (list ELEMENT-TYPE [:inherit? INHERIT])
* (or ...)
* (and ...)

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses

standard-schema-item.

Direct methods
Class: type-based-merging-mixin

This mixin class is intended to be mixed into schema item classes which have to perform merging of values based their types.

This behavior is implemented by a method on ‘merges-values’ which calls ‘merge-value-using-type’ with the ‘option-type’ of the schema item.

Default behavior is provided for some types:

* t: use the value with the highest priority; ignore other values

* (list [ELEMENT-TYPE [:inherit? INHERIT]]): depending on INHERIT either use the value with highest priority or look for :inherit markers in values and concatenate values appropriately.

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses

standard-schema-item.

Direct methods
Class: type-based-validation-mixin

This mixin class is intended to be mixed into schema item classes which have to perform validation of values based their types.

This behavior is implemented by a method on ‘validate-value’ which calls ‘validate-value-using-type’ with the ‘option-type’ of the schema item.

Default behavior is provided for types of the forms

* (integer ...)
* (list [ELEMENT-TYPE [:inherit? INHERIT]])
* (and ...)
* (or ...)

Package

configuration.options.

Source

mixins.lisp.

Direct subclasses

standard-schema-item.

Direct methods

6.2.9 Types

Type: name ()

A sequence of name components some of which may be wild.

Package

configuration.options.

Source

types.lisp.

Type: wild-name ()

A ‘name’ which has at least one wild component.

Package

configuration.options.

Source

types.lisp.

Type: wildcard-interpretation ()
Package

configuration.options.

Source

types.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

%
%children: Private generic functions
%children: Private generic functions
%every-element-name-component?: Private ordinary functions
%has-wild-component?: Private ordinary functions
%make-option-value: Private ordinary functions
%maybe-check-detailed-type: Private ordinary functions
%options: Private generic functions
%options: Private generic functions
%parse-value-binding: Private ordinary functions
%update-value: Private ordinary functions

&
&options: Public macros
&options-r/o: Public macros
&options/synchronizer: Public macros

(
(setf %children): Private generic functions
(setf %children): Private generic functions
(setf %options): Private generic functions
(setf %options): Private generic functions
(setf elt): Public standalone methods
(setf find-child): Public generic functions
(setf find-child): Public generic functions
(setf find-child): Public generic functions
(setf find-child): Public generic functions
(setf find-child): Public generic functions
(setf find-child): Public generic functions
(setf find-option): Public generic functions
(setf find-option): Public generic functions
(setf find-option): Public generic functions
(setf find-option): Public generic functions
(setf find-option): Public generic functions
(setf find-option): Public generic functions
(setf find-option): Public generic functions
(setf option-%default): Private generic functions
(setf option-%default): Private generic functions
(setf option-%default): Private generic functions
(setf option-%default): Private generic functions
(setf option-%name): Private generic functions
(setf option-%name): Private generic functions
(setf option-%value): Private generic functions
(setf option-%value): Private generic functions
(setf option-documentation): Public generic functions
(setf option-documentation): Public generic functions
(setf option-value): Public generic functions
(setf option-value): Public generic functions
(setf option-value): Public generic functions
(setf option-value): Public generic functions
(setf option-value): Public generic functions
(setf option-values): Public generic functions
(setf option-values): Public generic functions
(setf option-values): Public generic functions
(setf source-%name-mapping): Private generic functions
(setf source-%name-mapping): Private generic functions
(setf source-%pathname): Private generic functions
(setf source-%pathname): Private generic functions
(setf source-%schema): Private generic functions
(setf source-%schema): Private generic functions
(setf source-%sources): Private generic functions
(setf source-%sources): Private generic functions
(setf source-%stream): Private generic functions
(setf source-%stream): Private generic functions
(setf source-%syntax): Private generic functions
(setf source-%syntax): Private generic functions
(setf value): Public generic functions
(setf value): Public generic functions
(setf value): Public generic functions

B
binding-condition-container: Public generic functions
binding-condition-container: Public generic functions
binding-condition-name: Public generic functions
binding-condition-name: Public generic functions
binding-exists-condition-existing: Public generic functions
binding-exists-condition-existing: Public generic functions

C
call-with-indent: Public ordinary functions
call-with-level: Public ordinary functions
call-with-source-debug: Private ordinary functions
config-debug-variable-name: Public ordinary functions
config-files-variable-name: Private ordinary functions
config-files-variable-value: Private ordinary functions
configuration-file-specs: Public ordinary functions
configuration-files: Public ordinary functions
configuration-schema: Public generic functions
configuration-schema: Public generic functions
copy-indexed-sink: Private ordinary functions

D
define-dispatch-methods: Private macros
define-schema: Public macros
describe-object: Public standalone methods
describe-object: Public standalone methods
describe-object: Public standalone methods
documentation: Public standalone methods
documentation: Public standalone methods
documentation: Public standalone methods

E
elt: Public standalone methods
enable-debugging: Public ordinary functions
environment-variable-namify: Private ordinary functions
eval-schema-spec: Public ordinary functions
event-hook: Public generic functions
event-hook: Public generic functions

F
find-child: Public generic functions
find-child: Public generic functions
find-child: Public generic functions
find-child: Public generic functions
find-option: Public generic functions
find-option: Public generic functions
find-option: Public generic functions
find-option: Public generic functions
find-option: Public generic functions
find-option: Public generic functions
find-options: Public generic functions
find-options: Public generic functions
find-options: Public generic functions
Function, %every-element-name-component?: Private ordinary functions
Function, %has-wild-component?: Private ordinary functions
Function, %make-option-value: Private ordinary functions
Function, %maybe-check-detailed-type: Private ordinary functions
Function, %parse-value-binding: Private ordinary functions
Function, %update-value: Private ordinary functions
Function, call-with-indent: Public ordinary functions
Function, call-with-level: Public ordinary functions
Function, call-with-source-debug: Private ordinary functions
Function, config-debug-variable-name: Public ordinary functions
Function, config-files-variable-name: Private ordinary functions
Function, config-files-variable-value: Private ordinary functions
Function, configuration-file-specs: Public ordinary functions
Function, configuration-files: Public ordinary functions
Function, copy-indexed-sink: Private ordinary functions
Function, enable-debugging: Public ordinary functions
Function, environment-variable-namify: Private ordinary functions
Function, eval-schema-spec: Public ordinary functions
Function, handler-of: Private ordinary functions
Function, ignore-meta-configuration-variables: Private ordinary functions
Function, indexed-sink-index: Private ordinary functions
Function, indexed-sink-p: Private ordinary functions
Function, indexed-sink-sink: Private ordinary functions
Function, make-environment-variable-name->option-name: Private ordinary functions
Function, make-indexed-sink: Private ordinary functions
Function, map-query-alignments: Private ordinary functions
Function, map-schema-spec: Public ordinary functions
Function, maybe-enable-debugging: Public ordinary functions
Function, output: Public ordinary functions
Function, parse-name: Public ordinary functions
Function, print-documentation: Private ordinary functions
Function, print-name: Public ordinary functions
Function, print-option-container-tree: Public ordinary functions
Function, system-configuration-directory: Private ordinary functions
Function, typexpand-1: Private ordinary functions
Function, typexpand-1-unless-builtin: Private ordinary functions
Function, user-configuration-directory: Private ordinary functions

G
Generic Function, %children: Private generic functions
Generic Function, %options: Private generic functions
Generic Function, (setf %children): Private generic functions
Generic Function, (setf %options): Private generic functions
Generic Function, (setf find-child): Public generic functions
Generic Function, (setf find-option): Public generic functions
Generic Function, (setf option-%default): Private generic functions
Generic Function, (setf option-%name): Private generic functions
Generic Function, (setf option-%value): Private generic functions
Generic Function, (setf option-documentation): Public generic functions
Generic Function, (setf option-value): Public generic functions
Generic Function, (setf option-values): Public generic functions
Generic Function, (setf source-%name-mapping): Private generic functions
Generic Function, (setf source-%pathname): Private generic functions
Generic Function, (setf source-%schema): Private generic functions
Generic Function, (setf source-%sources): Private generic functions
Generic Function, (setf source-%stream): Private generic functions
Generic Function, (setf source-%syntax): Private generic functions
Generic Function, (setf value): Public generic functions
Generic Function, binding-condition-container: Public generic functions
Generic Function, binding-condition-name: Public generic functions
Generic Function, binding-exists-condition-existing: Public generic functions
Generic Function, configuration-schema: Public generic functions
Generic Function, event-hook: Public generic functions
Generic Function, find-child: Public generic functions
Generic Function, find-option: Public generic functions
Generic Function, find-options: Public generic functions
Generic Function, initialize: Public generic functions
Generic Function, make-configuration: Public generic functions
Generic Function, make-name: Public generic functions
Generic Function, make-option: Public generic functions
Generic Function, make-source: Public generic functions
Generic Function, make-syntax: Public generic functions
Generic Function, map-matching-options: Public generic functions
Generic Function, map-options: Public generic functions
Generic Function, merge-names: Public generic functions
Generic Function, merge-values: Public generic functions
Generic Function, merge-values-using-type: Public generic functions
Generic Function, name-components: Public generic functions
Generic Function, name-equal: Public generic functions
Generic Function, name-matches: Public generic functions
Generic Function, name-parse-error-text: Public generic functions
Generic Function, name<: Public generic functions
Generic Function, notification-error-event: Public generic functions
Generic Function, notification-error-name: Public generic functions
Generic Function, notification-error-sink: Public generic functions
Generic Function, notification-error-source: Public generic functions
Generic Function, notify: Public generic functions
Generic Function, option-%cell: Private generic functions
Generic Function, option-%default: Private generic functions
Generic Function, option-%value: Private generic functions
Generic Function, option-class: Public generic functions
Generic Function, option-condition-option: Public generic functions
Generic Function, option-configuration: Public generic functions
Generic Function, option-default: Public generic functions
Generic Function, option-documentation: Public generic functions
Generic Function, option-name: Public generic functions
Generic Function, option-schema-item: Public generic functions
Generic Function, option-syntax-error-type: Public generic functions
Generic Function, option-type: Public generic functions
Generic Function, option-value: Public generic functions
Generic Function, option-values: Public generic functions
Generic Function, options: Public generic functions
Generic Function, process: Public generic functions
Generic Function, process-content: Public generic functions
Generic Function, raw->value: Public generic functions
Generic Function, raw->value-using-type: Public generic functions
Generic Function, schema-children: Public generic functions
Generic Function, schema-children/alist: Private generic functions
Generic Function, schema-condition-schema: Public generic functions
Generic Function, schema-syntax-error-specification: Public generic functions
Generic Function, sink-condition-sink: Public generic functions
Generic Function, source-%name-mapping: Private generic functions
Generic Function, source-%pathname: Private generic functions
Generic Function, source-%schema: Private generic functions
Generic Function, source-%sources: Private generic functions
Generic Function, source-%stream: Private generic functions
Generic Function, source-%syntax: Private generic functions
Generic Function, source-condition-source: Public generic functions
Generic Function, source-description: Private generic functions
Generic Function, source-element-type: Private generic functions
Generic Function, source-if-does-not-exist: Private generic functions
Generic Function, source-name-mapping: Private generic functions
Generic Function, source-pathname: Private generic functions
Generic Function, source-pattern: Private generic functions
Generic Function, source-sources: Public generic functions
Generic Function, source-stream: Private generic functions
Generic Function, source-syntax: Private generic functions
Generic Function, sub-configuration: Public generic functions
Generic Function, synchronizer-handler-synchronizer: Private generic functions
Generic Function, synchronizer-target: Public generic functions
Generic Function, validate-value: Public generic functions
Generic Function, validate-value-using-type: Public generic functions
Generic Function, value: Public generic functions
Generic Function, value->string: Public generic functions
Generic Function, value->string-using-type: Public generic functions
Generic Function, value-condition-value: Public generic functions
Generic Function, value-missing-condition-which: Public generic functions

H
handler-of: Private ordinary functions

I
if-name: Private macros
ignore-meta-configuration-variables: Private ordinary functions
indexed-sink-index: Private ordinary functions
indexed-sink-p: Private ordinary functions
indexed-sink-sink: Private ordinary functions
initialize: Public generic functions
initialize: Public generic functions
initialize: Public generic functions
initialize: Public generic functions
initialize: Public generic functions

L
length: Public standalone methods

M
Macro, &options: Public macros
Macro, &options-r/o: Public macros
Macro, &options/synchronizer: Public macros
Macro, define-dispatch-methods: Private macros
Macro, define-schema: Public macros
Macro, if-name: Private macros
Macro, with-indent: Public macros
Macro, with-level: Public macros
Macro, with-source-debug: Private macros
make-configuration: Public generic functions
make-configuration: Public generic functions
make-environment-variable-name->option-name: Private ordinary functions
make-indexed-sink: Private ordinary functions
make-name: Public generic functions
make-name: Public generic functions
make-name: Public generic functions
make-name: Public generic functions
make-name: Public generic functions
make-option: Public generic functions
make-option: Public generic functions
make-option: Public generic functions
make-sequence-like: Public standalone methods
make-source: Public generic functions
make-source: Public generic functions
make-syntax: Public generic functions
make-syntax: Public generic functions
map-matching-options: Public generic functions
map-matching-options: Public generic functions
map-matching-options: Public generic functions
map-matching-options: Public generic functions
map-options: Public generic functions
map-options: Public generic functions
map-options: Public generic functions
map-options: Public generic functions
map-query-alignments: Private ordinary functions
map-schema-spec: Public ordinary functions
maybe-enable-debugging: Public ordinary functions
merge-names: Public generic functions
merge-names: Public generic functions
merge-names: Public generic functions
merge-names: Public generic functions
merge-values: Public generic functions
merge-values: Public generic functions
merge-values-using-type: Public generic functions
merge-values-using-type: Public generic functions
merge-values-using-type: Public generic functions
merge-values-using-type: Public generic functions
merge-values-using-type: Public generic functions
Method, %children: Private generic functions
Method, %options: Private generic functions
Method, (setf %children): Private generic functions
Method, (setf %options): Private generic functions
Method, (setf elt): Public standalone methods
Method, (setf find-child): Public generic functions
Method, (setf find-child): Public generic functions
Method, (setf find-child): Public generic functions
Method, (setf find-child): Public generic functions
Method, (setf find-child): Public generic functions
Method, (setf find-option): Public generic functions
Method, (setf find-option): Public generic functions
Method, (setf find-option): Public generic functions
Method, (setf find-option): Public generic functions
Method, (setf find-option): Public generic functions
Method, (setf find-option): Public generic functions
Method, (setf option-%default): Private generic functions
Method, (setf option-%default): Private generic functions
Method, (setf option-%default): Private generic functions
Method, (setf option-%name): Private generic functions
Method, (setf option-%value): Private generic functions
Method, (setf option-documentation): Public generic functions
Method, (setf option-value): Public generic functions
Method, (setf option-value): Public generic functions
Method, (setf option-value): Public generic functions
Method, (setf option-value): Public generic functions
Method, (setf option-values): Public generic functions
Method, (setf option-values): Public generic functions
Method, (setf source-%name-mapping): Private generic functions
Method, (setf source-%pathname): Private generic functions
Method, (setf source-%schema): Private generic functions
Method, (setf source-%sources): Private generic functions
Method, (setf source-%stream): Private generic functions
Method, (setf source-%syntax): Private generic functions
Method, (setf value): Public generic functions
Method, (setf value): Public generic functions
Method, binding-condition-container: Public generic functions
Method, binding-condition-name: Public generic functions
Method, binding-exists-condition-existing: Public generic functions
Method, configuration-schema: Public generic functions
Method, describe-object: Public standalone methods
Method, describe-object: Public standalone methods
Method, describe-object: Public standalone methods
Method, documentation: Public standalone methods
Method, documentation: Public standalone methods
Method, documentation: Public standalone methods
Method, elt: Public standalone methods
Method, event-hook: Public generic functions
Method, find-child: Public generic functions
Method, find-child: Public generic functions
Method, find-child: Public generic functions
Method, find-option: Public generic functions
Method, find-option: Public generic functions
Method, find-option: Public generic functions
Method, find-option: Public generic functions
Method, find-option: Public generic functions
Method, find-options: Public generic functions
Method, find-options: Public generic functions
Method, initialize: Public generic functions
Method, initialize: Public generic functions
Method, initialize: Public generic functions
Method, initialize: Public generic functions
Method, length: Public standalone methods
Method, make-configuration: Public generic functions
Method, make-name: Public generic functions
Method, make-name: Public generic functions
Method, make-name: Public generic functions
Method, make-name: Public generic functions
Method, make-option: Public generic functions
Method, make-option: Public generic functions
Method, make-sequence-like: Public standalone methods
Method, make-source: Public generic functions
Method, make-syntax: Public generic functions
Method, map-matching-options: Public generic functions
Method, map-matching-options: Public generic functions
Method, map-matching-options: Public generic functions
Method, map-options: Public generic functions
Method, map-options: Public generic functions
Method, map-options: Public generic functions
Method, merge-names: Public generic functions
Method, merge-names: Public generic functions
Method, merge-names: Public generic functions
Method, merge-values: Public generic functions
Method, merge-values-using-type: Public generic functions
Method, merge-values-using-type: Public generic functions
Method, merge-values-using-type: Public generic functions
Method, merge-values-using-type: Public generic functions
Method, name-components: Public generic functions
Method, name-components: Public generic functions
Method, name-equal: Public generic functions
Method, name-matches: Public generic functions
Method, name-matches: Public generic functions
Method, name-matches: Public generic functions
Method, name-parse-error-text: Public generic functions
Method, name<: Public generic functions
Method, name<: Public generic functions
Method, name<: Public generic functions
Method, notification-error-event: Public generic functions
Method, notification-error-name: Public generic functions
Method, notification-error-sink: Public generic functions
Method, notification-error-source: Public generic functions
Method, notify: Public generic functions
Method, notify: Public generic functions
Method, notify: Public generic functions
Method, notify: Public generic functions
Method, notify: Public generic functions
Method, option-%cell: Private generic functions
Method, option-%default: Private generic functions
Method, option-%value: Private generic functions
Method, option-class: Public generic functions
Method, option-condition-option: Public generic functions
Method, option-default: Public generic functions
Method, option-default: Public generic functions
Method, option-default: Public generic functions
Method, option-default: Public generic functions
Method, option-documentation: Public generic functions
Method, option-documentation: Public generic functions
Method, option-documentation: Public generic functions
Method, option-documentation: Public generic functions
Method, option-name: Public generic functions
Method, option-schema-item: Public generic functions
Method, option-schema-item: Public generic functions
Method, option-syntax-error-type: Public generic functions
Method, option-type: Public generic functions
Method, option-type: Public generic functions
Method, option-type: Public generic functions
Method, option-value: Public generic functions
Method, option-value: Public generic functions
Method, option-value: Public generic functions
Method, option-values: Public generic functions
Method, option-values: Public generic functions
Method, options: Public generic functions
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-items: Public standalone methods
Method, print-object: Public standalone methods
Method, process: Public generic functions
Method, process: Public generic functions
Method, process: Public generic functions
Method, process: Public generic functions
Method, process: Public generic functions
Method, process: Public generic functions
Method, raw->value: Public generic functions
Method, raw->value: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, raw->value-using-type: Public generic functions
Method, schema-children: Public generic functions
Method, schema-children/alist: Private generic functions
Method, schema-condition-schema: Public generic functions
Method, schema-syntax-error-specification: Public generic functions
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, shared-initialize: Public standalone methods
Method, sink-condition-sink: Public generic functions
Method, source-%name-mapping: Private generic functions
Method, source-%pathname: Private generic functions
Method, source-%schema: Private generic functions
Method, source-%sources: Private generic functions
Method, source-%stream: Private generic functions
Method, source-%syntax: Private generic functions
Method, source-condition-source: Public generic functions
Method, source-description: Private generic functions
Method, source-element-type: Private generic functions
Method, source-if-does-not-exist: Private generic functions
Method, source-name-mapping: Private generic functions
Method, source-pathname: Private generic functions
Method, source-pattern: Private generic functions
Method, source-sources: Public generic functions
Method, source-sources: Public generic functions
Method, source-stream: Private generic functions
Method, source-syntax: Private generic functions
Method, sub-configuration: Public generic functions
Method, sub-configuration: Public generic functions
Method, subseq: Public standalone methods
Method, synchronizer-handler-synchronizer: Private generic functions
Method, synchronizer-target: Public generic functions
Method, validate-value: Public generic functions
Method, validate-value: Public generic functions
Method, validate-value-using-type: Public generic functions
Method, validate-value-using-type: Public generic functions
Method, validate-value-using-type: Public generic functions
Method, validate-value-using-type: Public generic functions
Method, validate-value-using-type: Public generic functions
Method, validate-value-using-type: Public generic functions
Method, value: Public generic functions
Method, value: Public generic functions
Method, value->string: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value->string-using-type: Public generic functions
Method, value-condition-value: Public generic functions
Method, value-missing-condition-which: Public generic functions

N
name-components: Public generic functions
name-components: Public generic functions
name-components: Public generic functions
name-equal: Public generic functions
name-equal: Public generic functions
name-matches: Public generic functions
name-matches: Public generic functions
name-matches: Public generic functions
name-matches: Public generic functions
name-parse-error-text: Public generic functions
name-parse-error-text: Public generic functions
name<: Public generic functions
name<: Public generic functions
name<: Public generic functions
name<: Public generic functions
notification-error-event: Public generic functions
notification-error-event: Public generic functions
notification-error-name: Public generic functions
notification-error-name: Public generic functions
notification-error-sink: Public generic functions
notification-error-sink: Public generic functions
notification-error-source: Public generic functions
notification-error-source: Public generic functions
notify: Public generic functions
notify: Public generic functions
notify: Public generic functions
notify: Public generic functions
notify: Public generic functions
notify: Public generic functions

O
option-%cell: Private generic functions
option-%cell: Private generic functions
option-%default: Private generic functions
option-%default: Private generic functions
option-%value: Private generic functions
option-%value: Private generic functions
option-class: Public generic functions
option-class: Public generic functions
option-condition-option: Public generic functions
option-condition-option: Public generic functions
option-configuration: Public generic functions
option-default: Public generic functions
option-default: Public generic functions
option-default: Public generic functions
option-default: Public generic functions
option-default: Public generic functions
option-documentation: Public generic functions
option-documentation: Public generic functions
option-documentation: Public generic functions
option-documentation: Public generic functions
option-documentation: Public generic functions
option-name: Public generic functions
option-name: Public generic functions
option-schema-item: Public generic functions
option-schema-item: Public generic functions
option-schema-item: Public generic functions
option-syntax-error-type: Public generic functions
option-syntax-error-type: Public generic functions
option-type: Public generic functions
option-type: Public generic functions
option-type: Public generic functions
option-type: Public generic functions
option-value: Public generic functions
option-value: Public generic functions
option-value: Public generic functions
option-value: Public generic functions
option-values: Public generic functions
option-values: Public generic functions
option-values: Public generic functions
options: Public generic functions
options: Public generic functions
output: Public ordinary functions

P
parse-name: Public ordinary functions
print-documentation: Private ordinary functions
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-items: Public standalone methods
print-name: Public ordinary functions
print-object: Public standalone methods
print-option-container-tree: Public ordinary functions
process: Public generic functions
process: Public generic functions
process: Public generic functions
process: Public generic functions
process: Public generic functions
process: Public generic functions
process: Public generic functions
process-content: Public generic functions

R
raw->value: Public generic functions
raw->value: Public generic functions
raw->value: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions
raw->value-using-type: Public generic functions

S
schema-children: Public generic functions
schema-children: Public generic functions
schema-children/alist: Private generic functions
schema-children/alist: Private generic functions
schema-condition-schema: Public generic functions
schema-condition-schema: Public generic functions
schema-syntax-error-specification: Public generic functions
schema-syntax-error-specification: Public generic functions
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
shared-initialize: Public standalone methods
sink-condition-sink: Public generic functions
sink-condition-sink: Public generic functions
source-%name-mapping: Private generic functions
source-%name-mapping: Private generic functions
source-%pathname: Private generic functions
source-%pathname: Private generic functions
source-%schema: Private generic functions
source-%schema: Private generic functions
source-%sources: Private generic functions
source-%sources: Private generic functions
source-%stream: Private generic functions
source-%stream: Private generic functions
source-%syntax: Private generic functions
source-%syntax: Private generic functions
source-condition-source: Public generic functions
source-condition-source: Public generic functions
source-description: Private generic functions
source-description: Private generic functions
source-element-type: Private generic functions
source-element-type: Private generic functions
source-if-does-not-exist: Private generic functions
source-if-does-not-exist: Private generic functions
source-name-mapping: Private generic functions
source-name-mapping: Private generic functions
source-pathname: Private generic functions
source-pathname: Private generic functions
source-pattern: Private generic functions
source-pattern: Private generic functions
source-sources: Public generic functions
source-sources: Public generic functions
source-sources: Public generic functions
source-stream: Private generic functions
source-stream: Private generic functions
source-syntax: Private generic functions
source-syntax: Private generic functions
sub-configuration: Public generic functions
sub-configuration: Public generic functions
sub-configuration: Public generic functions
subseq: Public standalone methods
synchronizer-handler-synchronizer: Private generic functions
synchronizer-handler-synchronizer: Private generic functions
synchronizer-target: Public generic functions
synchronizer-target: Public generic functions
system-configuration-directory: Private ordinary functions

T
typexpand-1: Private ordinary functions
typexpand-1-unless-builtin: Private ordinary functions

U
user-configuration-directory: Private ordinary functions

V
validate-value: Public generic functions
validate-value: Public generic functions
validate-value: Public generic functions
validate-value-using-type: Public generic functions
validate-value-using-type: Public generic functions
validate-value-using-type: Public generic functions
validate-value-using-type: Public generic functions
validate-value-using-type: Public generic functions
validate-value-using-type: Public generic functions
validate-value-using-type: Public generic functions
value: Public generic functions
value: Public generic functions
value: Public generic functions
value->string: Public generic functions
value->string: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value->string-using-type: Public generic functions
value-condition-value: Public generic functions
value-condition-value: Public generic functions
value-missing-condition-which: Public generic functions
value-missing-condition-which: Public generic functions

W
with-indent: Public macros
with-level: Public macros
with-source-debug: Private macros


A.3 Variables

Jump to:   *   +  
C   D   E   I   N   O   P   S   T   V   W  
Index Entry  Section

*
*configuration*: Public special variables
*debug-index*: Private special variables
*default-configuration-files*: Private special variables
*level*: Private special variables
*parse-wild-allowed*: Private special variables
*parse-wild-inferiors-allowed*: Private special variables
*stream*: Private special variables

+
+config-debug-variable-suffix+: Public constants
+config-file-pwd-placeholder+: Private constants
+config-file-system-placeholder+: Private constants
+config-file-user-placeholder+: Private constants
+config-files-variable-suffix+: Private constants
+no-value+: Private constants

C
cell: Public classes
children: Public classes
components: Public classes
Constant, +config-debug-variable-suffix+: Public constants
Constant, +config-file-pwd-placeholder+: Private constants
Constant, +config-file-system-placeholder+: Private constants
Constant, +config-file-user-placeholder+: Private constants
Constant, +config-files-variable-suffix+: Private constants
Constant, +no-value+: Private constants
container: Public conditions

D
default: Public classes
description: Private classes
documentation: Private classes

E
element-type: Private classes
event: Public conditions
event-hook: Private classes
existing: Public conditions

I
if-does-not-exist: Private classes
index: Private structures

N
name: Public conditions
name: Public conditions
name: Private classes
name-mapping: Private classes

O
option: Private conditions
option-class: Public classes
options: Private classes

P
pathname: Private classes
pattern: Private classes

S
schema: Public conditions
schema: Public classes
schema: Private classes
schema-item: Private classes
sink: Public conditions
sink: Public conditions
sink: Private structures
Slot, cell: Public classes
Slot, children: Public classes
Slot, components: Public classes
Slot, container: Public conditions
Slot, default: Public classes
Slot, description: Private classes
Slot, documentation: Private classes
Slot, element-type: Private classes
Slot, event: Public conditions
Slot, event-hook: Private classes
Slot, existing: Public conditions
Slot, if-does-not-exist: Private classes
Slot, index: Private structures
Slot, name: Public conditions
Slot, name: Public conditions
Slot, name: Private classes
Slot, name-mapping: Private classes
Slot, option: Private conditions
Slot, option-class: Public classes
Slot, options: Private classes
Slot, pathname: Private classes
Slot, pattern: Private classes
Slot, schema: Public conditions
Slot, schema: Public classes
Slot, schema: Private classes
Slot, schema-item: Private classes
Slot, sink: Public conditions
Slot, sink: Public conditions
Slot, sink: Private structures
Slot, source: Public conditions
Slot, source: Public conditions
Slot, sources: Private classes
Slot, specification: Public conditions
Slot, stream: Private classes
Slot, synchronizer: Private classes
Slot, syntax: Private classes
Slot, target: Public classes
Slot, text: Public conditions
Slot, type: Public conditions
Slot, type: Public classes
Slot, value: Private conditions
Slot, value: Private classes
Slot, values: Private classes
Slot, which: Public conditions
source: Public conditions
source: Public conditions
sources: Private classes
Special Variable, *configuration*: Public special variables
Special Variable, *debug-index*: Private special variables
Special Variable, *default-configuration-files*: Private special variables
Special Variable, *level*: Private special variables
Special Variable, *parse-wild-allowed*: Private special variables
Special Variable, *parse-wild-inferiors-allowed*: Private special variables
Special Variable, *stream*: Private special variables
specification: Public conditions
stream: Private classes
synchronizer: Private classes
syntax: Private classes

T
target: Public classes
text: Public conditions
type: Public conditions
type: Public classes

V
value: Private conditions
value: Private classes
values: Private classes

W
which: Public conditions


A.4 Data types

Jump to:   B   C   D   E   F   I   L   M   N   O   P   S   T   U   V   W  
Index Entry  Section

B
binding-condition: Public conditions
binding-exists-condition: Public conditions
binding-missing-condition: Public conditions

C
cascade-source: Private classes
child-exists-error: Public conditions
child-exists-warning: Public conditions
child-missing-error: Public conditions
child-missing-warning: Public conditions
Class, cascade-source: Private classes
Class, common-cascade-source: Private classes
Class, config-file-cascade-source: Private classes
Class, defaults-source: Private classes
Class, describe-via-map-options-mixin: Private classes
Class, directory-source: Private classes
Class, documentation-mixin: Private classes
Class, environment-variables-source: Private classes
Class, event-hook-mixin: Private classes
Class, file-source: Private classes
Class, list-container-mixin: Private classes
Class, named-mixin: Private classes
Class, option-cell: Private classes
Class, standard-configuration: Public classes
Class, standard-option: Public classes
Class, standard-schema: Public classes
Class, standard-schema-item: Public classes
Class, standard-synchronizer: Public classes
Class, stream-source: Private classes
Class, synchronizer-handler: Private classes
Class, type-based-conversion-mixin: Private classes
Class, type-based-merging-mixin: Private classes
Class, type-based-validation-mixin: Private classes
Class, wildcard-name: Public classes
common-cascade-source: Private classes
Condition, binding-condition: Public conditions
Condition, binding-exists-condition: Public conditions
Condition, binding-missing-condition: Public conditions
Condition, child-exists-error: Public conditions
Condition, child-exists-warning: Public conditions
Condition, child-missing-error: Public conditions
Condition, child-missing-warning: Public conditions
Condition, initialization-error: Public conditions
Condition, name-parse-error: Public conditions
Condition, notification-error: Public conditions
Condition, option-condition: Private conditions
Condition, option-exists-error: Public conditions
Condition, option-exists-warning: Public conditions
Condition, option-missing-error: Public conditions
Condition, option-missing-warning: Public conditions
Condition, option-syntax-error: Public conditions
Condition, option-value-error: Public conditions
Condition, processing-error: Public conditions
Condition, schema-condition: Public conditions
Condition, schema-syntax-error: Public conditions
Condition, sink-condition: Public conditions
Condition, source-condition: Public conditions
Condition, value-condition: Private conditions
Condition, value-missing-condition: Public conditions
Condition, value-missing-error: Public conditions
Condition, value-missing-warning: Public conditions
conditions.lisp: The configuration․options/src/conditions․lisp file
conditions.lisp: The configuration․options/sources/conditions․lisp file
config-file-cascade-source: Private classes
configuration-files.lisp: The configuration․options/sources/configuration-files․lisp file
configuration.lisp: The configuration․options/src/configuration․lisp file
configuration.options: The configuration․options system
configuration.options: The configuration․options package
configuration.options.asd: The configuration․options/configuration․options․asd file
configuration.options.debug: The configuration․options․debug package
configuration.options.sources: The configuration․options․sources package

D
debug.lisp: The configuration․options/src/debug․lisp file
debug.lisp: The configuration․options/sources/debug․lisp file
defaults-source: Private classes
describe-via-map-options-mixin: Private classes
directory-pathname: Public types
directory-source: Private classes
documentation-mixin: Private classes

E
environment-variables-source: Private classes
event-hook-mixin: Private classes

F
File, conditions.lisp: The configuration․options/src/conditions․lisp file
File, conditions.lisp: The configuration․options/sources/conditions․lisp file
File, configuration-files.lisp: The configuration․options/sources/configuration-files․lisp file
File, configuration.lisp: The configuration․options/src/configuration․lisp file
File, configuration.options.asd: The configuration․options/configuration․options․asd file
File, debug.lisp: The configuration․options/src/debug․lisp file
File, debug.lisp: The configuration․options/sources/debug․lisp file
File, let-plus.lisp: The configuration․options/src/let-plus․lisp file
File, macros.lisp: The configuration․options/src/macros․lisp file
File, mixins.lisp: The configuration․options/src/mixins․lisp file
File, name.lisp: The configuration․options/src/name․lisp file
File, package.lisp: The configuration․options/src/package․lisp file
File, package.lisp: The configuration․options/sources/package․lisp file
File, protocol.lisp: The configuration․options/src/protocol․lisp file
File, protocol.lisp: The configuration․options/sources/protocol․lisp file
File, schema.lisp: The configuration․options/src/schema․lisp file
File, source-cascade.lisp: The configuration․options/sources/source-cascade․lisp file
File, source-defaults.lisp: The configuration․options/sources/source-defaults․lisp file
File, source-environment-variables.lisp: The configuration․options/sources/source-environment-variables․lisp file
File, source-file.lisp: The configuration․options/sources/source-file․lisp file
File, source-stream.lisp: The configuration․options/sources/source-stream․lisp file
File, synchronizer.lisp: The configuration․options/src/synchronizer․lisp file
File, types.lisp: The configuration․options/src/types․lisp file
File, util.lisp: The configuration․options/src/util․lisp file
File, value-types.lisp: The configuration․options/src/value-types․lisp file
File, variables.lisp: The configuration․options/src/variables․lisp file
file-pathname: Public types
file-source: Private classes

I
indexed-sink: Private structures
initialization-error: Public conditions

L
let-plus.lisp: The configuration․options/src/let-plus․lisp file
list-container-mixin: Private classes

M
macros.lisp: The configuration․options/src/macros․lisp file
mixins.lisp: The configuration․options/src/mixins․lisp file
Module, sources: The configuration․options/sources module
Module, src: The configuration․options/src module

N
name: Private types
name-component: Public types
name-parse-error: Public conditions
name.lisp: The configuration․options/src/name․lisp file
named-mixin: Private classes
non-wild-name-component: Public types
notification-error: Public conditions

O
option-cell: Private classes
option-condition: Private conditions
option-exists-error: Public conditions
option-exists-warning: Public conditions
option-missing-error: Public conditions
option-missing-warning: Public conditions
option-syntax-error: Public conditions
option-value-error: Public conditions

P
Package, configuration.options: The configuration․options package
Package, configuration.options.debug: The configuration․options․debug package
Package, configuration.options.sources: The configuration․options․sources package
package.lisp: The configuration․options/src/package․lisp file
package.lisp: The configuration․options/sources/package․lisp file
processing-error: Public conditions
protocol.lisp: The configuration․options/src/protocol․lisp file
protocol.lisp: The configuration․options/sources/protocol․lisp file

S
schema-condition: Public conditions
schema-syntax-error: Public conditions
schema.lisp: The configuration․options/src/schema․lisp file
sink-condition: Public conditions
source-cascade.lisp: The configuration․options/sources/source-cascade․lisp file
source-condition: Public conditions
source-defaults.lisp: The configuration․options/sources/source-defaults․lisp file
source-environment-variables.lisp: The configuration․options/sources/source-environment-variables․lisp file
source-file.lisp: The configuration․options/sources/source-file․lisp file
source-stream.lisp: The configuration․options/sources/source-stream․lisp file
sources: The configuration․options/sources module
src: The configuration․options/src module
standard-configuration: Public classes
standard-option: Public classes
standard-schema: Public classes
standard-schema-item: Public classes
standard-synchronizer: Public classes
stream-source: Private classes
Structure, indexed-sink: Private structures
synchronizer-handler: Private classes
synchronizer.lisp: The configuration․options/src/synchronizer․lisp file
System, configuration.options: The configuration․options system

T
Type, directory-pathname: Public types
Type, file-pathname: Public types
Type, name: Private types
Type, name-component: Public types
Type, non-wild-name-component: Public types
Type, wild-name: Private types
Type, wild-name-component: Public types
Type, wildcard-interpretation: Private types
type-based-conversion-mixin: Private classes
type-based-merging-mixin: Private classes
type-based-validation-mixin: Private classes
types.lisp: The configuration․options/src/types․lisp file

U
util.lisp: The configuration․options/src/util․lisp file

V
value-condition: Private conditions
value-missing-condition: Public conditions
value-missing-error: Public conditions
value-missing-warning: Public conditions
value-types.lisp: The configuration․options/src/value-types․lisp file
variables.lisp: The configuration․options/src/variables․lisp file

W
wild-name: Private types
wild-name-component: Public types
wildcard-interpretation: Private types
wildcard-name: Public classes