The configuration.options Reference Manual

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

• name-component (type).
• non-wild-name-component (type).
• wild-name-component (type).

Internals

• %every-element-name-component? (function).
• %has-wild-component? (function).
• name (type).
• wild-name (type).
• wildcard-interpretation (type).

---

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

• binding-condition (condition).
• binding-condition-container (reader method).
• binding-condition-name (reader method).
• binding-exists-condition (condition).
• binding-exists-condition-existing (reader method).
• binding-missing-condition (condition).
• child-exists-error (condition).
• child-exists-warning (condition).
• child-missing-error (condition).
• child-missing-warning (condition).
• name-parse-error (condition).
• name-parse-error-text (reader method).
• notification-error (condition).
• notification-error-event (reader method).
• notification-error-name (reader method).
• notification-error-sink (reader method).
• notification-error-source (reader method).
• option-condition-option (reader method).
• option-exists-error (condition).
• option-exists-warning (condition).
• option-missing-error (condition).
• option-missing-warning (condition).
• option-syntax-error (condition).
• option-syntax-error-type (reader method).
• option-value-error (condition).
• schema-syntax-error (condition).
• schema-syntax-error-specification (reader method).
• value-condition-value (reader method).
• value-missing-condition (condition).
• value-missing-condition-which (reader method).
• value-missing-error (condition).
• value-missing-warning (condition).

Internals

• option-condition (condition).
• value-condition (condition).

---

4.1.6 configuration.options/src/protocol.lisp

Dependency

conditions.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• configuration-schema (generic reader).
• event-hook (generic function).
• find-child (generic function).
• (setf find-child) (generic function).
• find-option (generic function).
• (setf find-option) (generic function).
• find-options (generic function).
• make-configuration (generic function).
• make-name (generic function).
• make-option (generic function).
• map-matching-options (generic function).
• map-options (generic function).
• merge-names (generic function).
• merge-values (generic function).
• merge-values-using-type (generic function).
• name-components (generic function).
• name-equal (generic function).
• name-matches (generic function).
• name< (generic function).
• notify (generic function).
• option-class (generic reader).
• option-configuration (generic function).
• option-default (generic function).
• option-documentation (generic function).
• option-name (generic reader).
• option-schema-item (generic function).
• option-type (generic function).
• option-value (generic function).
• (setf option-value) (generic function).
• option-values (generic function).
• options (generic reader).
• raw->value (generic function).
• raw->value-using-type (generic function).
• schema-children (generic function).
• sub-configuration (generic function).
• validate-value (generic function).
• validate-value-using-type (generic function).
• value (generic function).
• (setf value) (generic function).
• value->string (generic function).
• value->string-using-type (generic function).

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

• print-documentation (function).
• typexpand-1 (function).
• typexpand-1-unless-builtin (function).

---

4.1.8 configuration.options/src/mixins.lisp

Dependency

util.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• describe-object (method).
• documentation (method).
• event-hook (method).
• find-option (method).
• (setf find-option) (method).
• (setf find-option) (method).
• (setf find-option) (method).
• map-options (method).
• merge-values (method).
• merge-values-using-type (method).
• merge-values-using-type (method).
• merge-values-using-type (method).
• option-documentation (reader method).
• (setf option-documentation) (writer method).
• option-name (reader method).
• options (reader method).
• print-items (method).
• print-items (method).
• print-option-container-tree (function).
• raw->value (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• shared-initialize (method).
• validate-value (method).
• validate-value-using-type (method).
• validate-value-using-type (method).
• validate-value-using-type (method).
• value->string (method).
• value->string-using-type (method).
• value->string-using-type (method).

Internals

• %options (reader method).
• (setf %options) (writer method).
• define-dispatch-methods (macro).
• describe-via-map-options-mixin (class).
• documentation-mixin (class).
• event-hook-mixin (class).
• list-container-mixin (class).
• named-mixin (class).
• (setf option-%name) (writer method).
• type-based-conversion-mixin (class).
• type-based-merging-mixin (class).
• type-based-validation-mixin (class).

---

4.1.9 configuration.options/src/name.lisp

Dependency

mixins.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• (setf elt) (method).
• elt (method).
• length (method).
• make-name (method).
• make-name (method).
• make-name (method).
• make-sequence-like (method).
• merge-names (method).
• name-components (reader method).
• name-matches (method).
• name< (method).
• name< (method).
• parse-name (function).
• print-name (function).
• print-object (method).
• shared-initialize (method).
• subseq (method).
• wildcard-name (class).

Internals

• *parse-wild-allowed* (special variable).
• *parse-wild-inferiors-allowed* (special variable).
• map-query-alignments (function).

---

4.1.10 configuration.options/src/schema.lisp

Dependency

name.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• describe-object (method).
• find-child (method).
• (setf find-child) (method).
• (setf find-child) (method).
• find-option (method).
• make-configuration (method).
• make-option (method).
• map-options (method).
• option-class (reader method).
• option-default (method).
• option-type (reader method).
• print-items (method).
• print-items (method).
• schema-children (method).
• shared-initialize (method).
• standard-schema (class).
• standard-schema-item (class).

Internals

• %children (reader method).
• (setf %children) (writer method).
• option-%default (reader method).
• (setf option-%default) (writer method).
• (setf option-%default) (method).
• (setf option-%default) (method).
• schema-children/alist (reader method).

---

4.1.11 configuration.options/src/configuration.lisp

Dependency

schema.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• configuration-schema (reader method).
• describe-object (method).
• documentation (method).
• documentation (method).
• find-option (method).
• option-default (method).
• option-default (method).
• option-documentation (method).
• option-documentation (method).
• option-documentation (method).
• option-schema-item (method).
• option-schema-item (reader method).
• option-type (method).
• option-type (method).
• option-value (method).
• option-value (method).
• (setf option-value) (method).
• (setf option-value) (method).
• (setf option-value) (method).
• (setf option-value) (method).
• option-values (method).
• option-values (reader method).
• (setf option-values) (method).
• (setf option-values) (writer method).
• print-items (method).
• print-items (method).
• shared-initialize (method).
• standard-configuration (class).
• standard-option (class).

Internals

• option-%cell (reader method).
• option-%value (reader method).
• (setf option-%value) (writer method).
• option-cell (class).

---

4.1.12 configuration.options/src/value-types.lisp

Dependency

configuration.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• directory-pathname (type).
• file-pathname (type).
• merge-values-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• raw->value-using-type (method).
• validate-value-using-type (method).
• validate-value-using-type (method).
• validate-value-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).
• value->string-using-type (method).

Internals

%maybe-check-detailed-type (function).

---

4.1.13 configuration.options/src/synchronizer.lisp

Dependency

value-types.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• notify (method).
• notify (method).
• notify (method).
• shared-initialize (method).
• standard-synchronizer (class).
• synchronizer-target (reader method).

Internals

• %update-value (function).
• handler-of (function).
• synchronizer-handler (class).
• synchronizer-handler-synchronizer (reader method).

---

4.1.14 configuration.options/src/macros.lisp

Dependency

synchronizer.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• define-schema (macro).
• eval-schema-spec (function).
• map-schema-spec (function).

---

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

Dependency

macros.lisp (file).

Source

configuration.options.asd.

Parent Component

src (module).

Public Interface

• &options (macro).
• &options-r/o (macro).
• &options/synchronizer (macro).

Internals

• %make-option-value (function).
• %parse-value-binding (function).

---

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

• +config-debug-variable-suffix+ (constant).
• call-with-indent (function).
• call-with-level (function).
• config-debug-variable-name (function).
• enable-debugging (function).
• maybe-enable-debugging (function).
• output (function).
• with-indent (macro).
• with-level (macro).

Internals

• *level* (special variable).
• *stream* (special variable).

---

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

• initialization-error (condition).
• processing-error (condition).
• schema-condition (condition).
• schema-condition-schema (reader method).
• sink-condition (condition).
• sink-condition-sink (reader method).
• source-condition (condition).
• source-condition-source (reader method).

---

4.1.19 configuration.options/sources/protocol.lisp

Dependency

conditions.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

• initialize (generic function).
• make-source (generic function).
• make-syntax (generic function).
• process (generic function).
• process-content (generic function).
• source-sources (generic function).

---

4.1.20 configuration.options/sources/debug.lisp

Dependency

protocol.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Internals

• *debug-index* (special variable).
• call-with-source-debug (function).
• with-source-debug (macro).

---

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

Dependency

debug.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

• configuration-file-specs (function).
• configuration-files (function).

Internals

• *default-configuration-files* (special variable).
• +config-file-pwd-placeholder+ (constant).
• +config-file-system-placeholder+ (constant).
• +config-file-user-placeholder+ (constant).
• +config-files-variable-suffix+ (constant).
• config-files-variable-name (function).
• config-files-variable-value (function).
• system-configuration-directory (function).
• user-configuration-directory (function).

---

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

Dependency

configuration-files.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

• initialize (method).
• process (method).

Internals

• defaults-source (class).
• source-%schema (reader method).
• (setf source-%schema) (writer method).

---

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

• print-items (method).
• process (method).
• shared-initialize (method).
• shared-initialize (method).

Internals

• environment-variables-source (class).
• make-environment-variable-name->option-name (function).
• source-%name-mapping (reader method).
• (setf source-%name-mapping) (writer method).
• source-name-mapping (reader method).

---

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

• print-items (method).
• process (method).
• shared-initialize (method).

Internals

• source-%stream (reader method).
• (setf source-%stream) (writer method).
• source-%syntax (reader method).
• (setf source-%syntax) (writer method).
• source-stream (reader method).
• source-syntax (reader method).
• stream-source (class).

---

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

Dependency

source-stream.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

• print-items (method).
• process (method).
• shared-initialize (method).

Internals

• file-source (class).
• source-%pathname (reader method).
• (setf source-%pathname) (writer method).
• source-description (reader method).
• source-element-type (reader method).
• source-if-does-not-exist (reader method).
• source-pathname (reader method).

---

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

Dependency

source-file.lisp (file).

Source

configuration.options.asd.

Parent Component

sources (module).

Public Interface

• initialize (method).
• notify (method).
• print-items (method).
• print-items (method).
• print-items (method).
• process (method).
• shared-initialize (method).
• shared-initialize (method).
• shared-initialize (method).
• shared-initialize (method).
• source-sources (reader method).

Internals

• cascade-source (class).
• common-cascade-source (class).
• config-file-cascade-source (class).
• copy-indexed-sink (function).
• directory-source (class).
• environment-variable-namify (function).
• ignore-meta-configuration-variables (function).
• indexed-sink (structure).
• indexed-sink-index (reader).
• indexed-sink-p (function).
• indexed-sink-sink (reader).
• make-indexed-sink (function).
• source-%sources (reader method).
• (setf source-%sources) (writer method).
• source-pattern (reader method).

---

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.

---