This is the universal-config Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:11:55 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
universal-configLibrary to provide a universal configuration layer.
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
Artistic
1.0.0
cl-ppcre (system).
parse-float (system).
package.lisp (file).
access.lisp (file).
transform.lisp (file).
output.lisp (file).
outputs (module).
Modules are listed depth-first from the system components tree.
universal-config/outputsoutput.lisp (file).
universal-config (system).
Files are sorted by type and then listed depth-first from the systems components trees.
universal-config/universal-config.asduniversal-config/package.lispuniversal-config/access.lispuniversal-config/transform.lispuniversal-config/output.lispuniversal-config/outputs/lisp.lispuniversal-config/outputs/json.lispuniversal-config/universal-config.asduniversal-config (system).
universal-config/access.lisppackage.lisp (file).
universal-config (system).
*augment-missing-places* (special variable).
*config* (special variable).
access (generic function).
(setf access) (generic function).
accessor (reader method).
accessor (reader method).
(setf accessor) (writer method).
(setf accessor) (writer method).
augmenting-place (condition).
config-tree (function).
(setf config-tree) (function).
inexistent-place (condition).
make-container (generic function).
object (reader method).
object (reader method).
(setf object) (writer method).
(setf object) (writer method).
set-config-tree (function).
with-configuration (macro).
universal-config/transform.lispaccess.lisp (file).
universal-config (system).
*fallback-deserializer* (special variable).
*fallback-serializer* (special variable).
*serialize-hash-tables* (special variable).
*serialize-lists* (special variable).
*serialize-numbers* (special variable).
*serialize-symbols* (special variable).
define-class-de/serializer (macro).
define-deserializer (macro).
define-serializer (macro).
define-string-deserializer (macro).
define-string-serializer (macro).
deserialize (generic function).
escape (function).
serialize (generic function).
split-escaped (function).
unescape (function).
deserialize-object (generic function).
deserialize-string (generic function).
universal-config/output.lisptransform.lisp (file).
universal-config (system).
*output-format* (special variable).
define-load-format (macro).
define-save-format (macro).
load-configuration (function).
save-configuration (function).
universal-config/outputs/lisp.lispoutputs (module).
%load (method).
%save (method).
+ignore+ (special variable).
+stop+ (special variable).
hash-table-printer (function).
hash-table-reader (function).
make-return (function).
with-hash-table-syntax (macro).
universal-config/outputs/json.lispoutputs (module).
%load (method).
%save (method).
*level* (special variable).
*tab-size* (special variable).
+ignore+ (special variable).
+stop+ (special variable).
hash-table-printer (function).
hash-table-reader (function).
indent (function).
make-return (function).
string-printer (function).
symbol-printer (function).
vector-printer (function).
vector-reader (function).
with-json-syntax (macro).
Packages are listed by definition order.
universal-config-lisporg.tymoonnext.universal-config.lisp
uc-lisp
common-lisp.
universal-config.
+ignore+ (special variable).
+stop+ (special variable).
hash-table-printer (function).
hash-table-reader (function).
make-return (function).
with-hash-table-syntax (macro).
universal-configorg.tymoonnext.universal-config
uc
common-lisp.
parse-float.
*augment-missing-places* (special variable).
*config* (special variable).
*fallback-deserializer* (special variable).
*fallback-serializer* (special variable).
*output-format* (special variable).
*serialize-hash-tables* (special variable).
*serialize-lists* (special variable).
*serialize-numbers* (special variable).
*serialize-symbols* (special variable).
access (generic function).
(setf access) (generic function).
accessor (generic reader).
(setf accessor) (generic writer).
augmenting-place (condition).
config-tree (function).
(setf config-tree) (function).
define-class-de/serializer (macro).
define-deserializer (macro).
define-load-format (macro).
define-save-format (macro).
define-serializer (macro).
define-string-deserializer (macro).
define-string-serializer (macro).
deserialize (generic function).
escape (function).
inexistent-place (condition).
load-configuration (function).
make-container (generic function).
object (generic reader).
(setf object) (generic writer).
save-configuration (function).
serialize (generic function).
set-config-tree (function).
split-escaped (function).
unescape (function).
with-configuration (macro).
%load (generic function).
%save (generic function).
deserialize-object (generic function).
deserialize-string (generic function).
universal-config-jsonorg.tymoonnext.universal-config.json
uc-json
common-lisp.
universal-config.
*level* (special variable).
*tab-size* (special variable).
+ignore+ (special variable).
+stop+ (special variable).
hash-table-printer (function).
hash-table-reader (function).
indent (function).
make-return (function).
string-printer (function).
symbol-printer (function).
vector-printer (function).
vector-reader (function).
with-json-syntax (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If set to non-NIL, (SETF (CONFIG-TREE ..) ..) will attempt to augment missing places.
The global configuration storage variable.
Fallback function used when no deserializer method matched.
Useful for applying deserializers specific to the input format.
Fallback function used when no serializer method matched.
Useful for applying serializers specific to the output format.
The default output format to use.
Whether to serialize hash-tables into a vector and a hash-table.
This is necessary for most output formats as there is no differentiation made between hash-table tests. Serializing them will ensure that the proper test can be restored upon deserializing.
Whether to serialize lists into vector representation.
This is necessary for most output formats as there are no two representations of list- or vector-like structures.
Whether to serialize numbers into string representation.
This is necessary for many output formats as they do not support the variety of number types lisp provides (ratios, floats, complex numbers).
Whether symbols should be serialized into string representation.
Note that symbol plists are not serialized into strings.
Shorthand macro to define de/serializer methods for a class and the specified slots.
CLASS — A class type.
SLOTDEFS ::= SLOTDEF*
SLOTDEF ::= SLOT-SYMBOL | (SLOT-SYMBOL INITARG-SYMBOL)
Define a new OBJECT-TYPE to deserialize into a usable representation.
If EXPECT-VECTOR is non-NIL, the bound OBJECT-VAR will be of type VECTOR.
Define a format of NAME to load an object from a stream.
Define a format of NAME to save an object to a stream.
Define an OBJECT-TYPE to be serialized. The expected value of this function should be one of HASH-TABLE, VECTOR, STRING or NUMBER.
If RETURN-VECTOR is non-NIL, the object returned should be of type VECTOR.
Define a new IDENT-CHAR handler to deserialize a STRING with.
Defines an OBJECT-TYPE to be serialized to a string.
To discern string serialized objects, an IDENT-CHAR is needed.
Establishes a configuration context.
Retrieve a value from the configuration.
Set a value in the configuration.
If *AUGMENT-MISSING-PLACES* is non-NIL, missing path parts will be attempted to be augmented. The container object is chosen through MAKE-CONTAINER.
Escape all instances of CHAR in the string that match CHAR with a backslash.
Load the configuration from PATH with the given FORMAT.
Save the configuration OBJECT to PATH using the given FORMAT.
Sets the place indicated by the ACCESSORS list to VALUE if possible. See (SETF CONFIG-TREE)
Split the string by CHAR minding backslash escaped instances.
Unescape all backslash escaped instances of CHAR.
Universal object accessor.
Returns two values, the first being the accessed value or the supplied default,
the second being T if the requested place was found or NIL if the default is returned.
list) (pos fixnum) &optional default) ¶hash-table) accessor &optional default) ¶sequence) (pos fixnum) &optional default) ¶array) (pos fixnum) &optional default) ¶array) (scr list) &optional default) ¶standard-object) (slot symbol) &optional default) ¶null) accessor &optional default) ¶Universal object setter.
list) (pos fixnum)) ¶hash-table) accessor) ¶sequence) (pos fixnum)) ¶array) (pos fixnum)) ¶array) (scr list)) ¶standard-object) (slot symbol)) ¶null) accessor) ¶augmenting-place)) ¶augmenting-place)) ¶inexistent-place)) ¶inexistent-place)) ¶Deserialize an OBJECT into a usable configuration object.
Attempts to create a fitting container for an accessor.
augmenting-place)) ¶augmenting-place)) ¶inexistent-place)) ¶inexistent-place)) ¶Serialize the given object recursively into a format that is ready for outputting.
pathname)) ¶number)) ¶symbol)) ¶hash-table)) ¶list)) ¶vector)) ¶string)) ¶Warning condition signalled when a place is augmented automatically.
Error condition signalled when attempting to set an inexistent place.
Deserialize an OBJECT of TYPE into its usable representation.
OBJECT itself will be one of HASH-TABLE, VECTOR, STRING or NUMBER.
Deserialize a STRING according to the IDENT-CHAR.
(eql #\p)) string) ¶(eql #\c)) string) ¶(eql #\f)) string) ¶(eql #\r)) string) ¶(eql #\i)) string) ¶(eql #\+)) string) ¶(eql #\-)) string) ¶| Jump to: | %
(
A C D E F G H I L M O S U V W |
|---|
| Jump to: | %
(
A C D E F G H I L M O S U V W |
|---|
| Jump to: | %
*
+
S |
|---|
| Jump to: | %
*
+
S |
|---|
| Jump to: | A C F I J L M O P S T U |
|---|
| Jump to: | A C F I J L M O P S T U |
|---|