The cl-yaclyaml Reference Manual
Table of Contents
The cl-yaclyaml Reference Manual
This is the cl-yaclyaml Reference Manual, version 1.1,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 12:58:34 2020 GMT+0.
1 Introduction
cl-yaclyaml
Yet Another Common Lisp YaML processor (so far, only loader, but not dumper)
Now completely implementation-independent!
Tries to adhere to YAML 1.2 specification (see www.yaml.org)
High-level interface is provided by exported YAML-LOAD function.
CL-USER> (ql:quickload 'cl-yaclyaml)
CL-USER> (ql:quickload 'cl-interpol)
CL-USER> (cl-interpol:enable-interpol-syntax)
CL-USER> (cl-yy:yaml-load #?"- foo\n- bar\n- baz\n")
((:DOCUMENT ("foo" "bar" "baz")))
If you are sure, that your stream contains only one YAML document, use can also use
CL-USER> (cl-yy:yaml-simple-load #?"- foo\n- bar\n- baz\n")
("foo" "bar" "baz")
Loader supports optional SCHEMA keyword parameter, which can now be :FAILSAFE :JSON and :CORE (default)
and affects tag implication and resolution.
Technically, process of loading is done in three stages: parsing of raw-text, composing of representation graph
and construction of native language structures.
Also, (mainly for loading of config files) there is YAML-LOAD-FILE function
CL-USER> (cl-yy::yaml-load-file "~/.my-config.yml" :size-limit 100 :on-size-exceed :warn)
where SIZE-LIMIT (default 1024) is the critical size of file in bytes,
above which parsing will not be performed
(so as not to be DDoS'ed).
ON-SIZE-EXCEED can be either :ERROR (default), or :WARN or NIL. In case of :ERROR YAML-LOAD-FILE-ERROR
is signalled, in case of :WARN warning is printed and NIL is returned, as if config file was absent,
and in case of NIL, NIL is silently returned with no warning whatsoever.
TODO:
- :LISP tag-resolution schema, which would support lisp-specific data types, such as symbols, arrays, alists and so on.
- user-friendly errors, when parsing fails
- (done, thanks to upgrade of ESRAP-LIQUID) parsing not only of strings, but also of streams
- YAML-DUMP, the complement of YAML-LOAD
- UTF-16 and UTF-32 support (Yaml processor should support them, ouch)
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-yaclyaml
- Author
Alexander Popolitov <popolit@itep.ru>
- License
GPL
- Description
Yet Another Common Lisp YaML processor.
- Version
1.1
- Dependencies
- iterate
- rutils
- cl-test-more
- cl-interpol
- esrap-liquid
- alexandria
- cl-ppcre
- parse-number
- Source
cl-yaclyaml.asd (file)
- Components
-
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 cl-yaclyaml.asd
- Location
cl-yaclyaml.asd
- Systems
cl-yaclyaml (system)
- Packages
cl-yaclyaml-system
3.1.2 cl-yaclyaml/package.lisp
- Parent
cl-yaclyaml (system)
- Location
package.lisp
- Packages
cl-yaclyaml
3.1.3 cl-yaclyaml/macro-utils.lisp
- Dependency
package.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
macro-utils.lisp
- Internal Definitions
crunch-tag-into-properties (macro)
3.1.4 cl-yaclyaml/parsing-macro.lisp
- Dependency
macro-utils.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
parsing-macro.lisp
- Exported Definitions
yaclyaml-parse (macro)
- Internal Definitions
-
3.1.5 cl-yaclyaml/parsing-macro-2.lisp
- Dependency
parsing-macro.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
parsing-macro-2.lisp
- Exported Definitions
yy-parse (macro)
- Internal Definitions
-
3.1.6 cl-yaclyaml/parsing.lisp
- Dependency
parsing-macro-2.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
parsing.lisp
- Exported Definitions
hash->assoc (function)
- Internal Definitions
-
3.1.7 cl-yaclyaml/composing.lisp
- Dependency
parsing.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
composing.lisp
- Exported Definitions
ncompose-representation-graph (function)
- Internal Definitions
-
3.1.8 cl-yaclyaml/convert.lisp
- Dependency
composing.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
convert.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.9 cl-yaclyaml/schema.lisp
- Dependency
convert.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
schema.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.10 cl-yaclyaml/constructing.lisp
- Dependency
schema.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
constructing.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.11 cl-yaclyaml/representing.lisp
- Dependency
constructing.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
representing.lisp
- Exported Definitions
represent-node (function)
- Internal Definitions
-
3.1.12 cl-yaclyaml/serializing.lisp
- Dependency
representing.lisp (file)
- Parent
cl-yaclyaml (system)
- Location
serializing.lisp
- Exported Definitions
nserialize (function)
- Internal Definitions
-
4 Packages
Packages are listed by definition order.
4.1 cl-yaclyaml-system
- Source
cl-yaclyaml.asd
- Use List
- asdf/interface
- common-lisp
4.2 cl-yaclyaml
- Source
package.lisp (file)
- Nickname
cl-yy
- Use List
- cl-ppcre
- org.mapcar.parse-number
- esrap-liquid
- rutils.string
- iterate
- common-lisp
- Exported Definitions
-
- Internal Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Exported definitions
5.1.1 Macros
- Macro: define-yaml-config READER-NAME (PATH VAR &key SCHEMA SIZE-LIMIT ON-SIZE-EXCEED) &rest VARIABLE-SPECS
-
- Package
cl-yaclyaml
- Source
constructing.lisp (file)
- Macro: yaclyaml-parse EXPRESSION TEXT &key START END JUNK-ALLOWED
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: yy-parse EXPRESSION TEXT &key START END JUNK-ALLOWED
-
- Package
cl-yaclyaml
- Source
parsing-macro-2.lisp (file)
5.1.2 Functions
- Function: construct REPRESENTATION-GRAPH &key SCHEMA
-
- Package
cl-yaclyaml
- Source
constructing.lisp (file)
- Function: convert-mapping CONTENT TAG
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-mapping-to-hashtable CONTENT
-
Convert a raw mapping node to a hash-table of converted values.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-node NODE
-
Convert a parsed node into a user object.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-scalar CONTENT TAG
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-sequence CONTENT TAG
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-sequence-to-list NODES
-
Convert a raw sequence node to a list of converted values.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: hash->assoc HASH
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: install-mapping-converter TAG CONVERTER
-
Install a mapping converter in the current scheme.
Should be called from an INSTALL-CONVERTERS method.
TAG is a string containing the yaml tag for the content.
CONVERTER is a function which takes a raw mapping node
as input and returns the converted value.
The content is a list where the CAR is the keyword :MAPPING
and the CDR is an alist of key-value pairs, where both the key and
value are raw nodes.
The converter function should convert the sub-nodes, either with
CONVERT-SEQUENCE-TO-LIST, or CONVERT-NODE on each node.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: install-mapping-hashtable-converter TAG CONVERTER
-
Install a mapping converter in the current scheme.
Should be called from an INSTALL-CONVERTERS method.
TAG is a string containing the yaml tag for the content.
CONVERTER is a function that takes a hash-table of converted values
and returns the converted value from the list.
This is probably preferable to INSTALL-MAPPING-CONVERTER in user code.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: install-scalar-converter TAG CONVERTER
-
Install a scalar converter in the current scheme.
Should be called from an INSTALL-CONVERTERS method.
TAG is a string containing the yaml tag for the content.
CONVERTER is a function which takes a string containing the scalar
input and returns the converted value.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: install-sequence-converter TAG CONVERTER
-
Install a sequence converter in the current scheme.
Should be called from an INSTALL-CONVERTERS method.
TAG is a string containing the yaml tag for the content.
CONVERTER is a function which takes a list of raw nodes
as input and returns the converted value.
The converter function should convert the nodes, either with
CONVERT-SEQUENCE-TO-LIST, or CONVERT-NODE on each node.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: install-sequence-list-converter TAG CONVERTER
-
Install a sequence converter in the current scheme.
Should be called from an INSTALL-CONVERTERS method.
TAG is a string containing the yaml tag for the content.
CONVERTER is a function that takes a list of converted values
and returns the converted value from the list.
This is probably preferable to INSTALL-SEQUENCE-CONVERTER in user code.
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: ncompose-representation-graph REPRESENTATION-TREE
-
Destructively composes representation graph from representation tree.
- Package
cl-yaclyaml
- Source
composing.lisp (file)
- Function: nserialize REPRESENTATION-GRAPH
-
Destructively convert representation graph (which may contain loops) to representation tree,
where all shared-ness is represented via alias-nodes.
- Package
cl-yaclyaml
- Source
serializing.lisp (file)
- Function: register-schema NAME CLASS-NAME &rest INIT-ARGS
-
Register a schema with a symbol. After registering, the symbol can be passed
as the SCHEMA argument to the parsing functions.
This function creates a new instance of CLASS-NAME with the arguments passed as
INIT-ARGS and registers it with the symbol NAME.
NAME: The symbol for the schema to be registered.
CLASS-NAME: The symbol for the name of the class of the schema to create and register.
INIT-ARGS: Additional arguments to pass to MAKE-INSTANCE.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Function: represent-node X
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: yaml-load STRING &key SCHEMA
-
- Package
cl-yaclyaml
- Source
constructing.lisp (file)
- Function: yaml-load-file PATH &key SCHEMA SIZE-LIMIT ON-SIZE-EXCEED SIMPLE
-
- Package
cl-yaclyaml
- Source
constructing.lisp (file)
- Function: yaml-simple-load STRING &key SCHEMA
-
- Package
cl-yaclyaml
- Source
constructing.lisp (file)
5.1.3 Generic functions
- Generic Function: convert-non-specific-scalar SCHEMA CONTENT
-
Convert the content of a non-specific scalar node based
on the schema. Default implementation just calls CONVERT-SCALAR with the str tag.
Implementations should call CALL-NEXT-METHOD for contents it doesn’t know how to process.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Methods
- Method: convert-non-specific-scalar (SCHEMA core-schema) CONTENT
-
- Method: convert-non-specific-scalar (SCHEMA json-schema) CONTENT
-
- Method: convert-non-specific-scalar SCHEMA CONTENT
-
- Generic Function: install-converters SCHEMA
-
Install converters for a schema before parsing.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Method Combination
progn (short method combination)
Options: :most-specific-last
- Methods
- Method: install-converters (SCHEMA json-schema) progn
-
- Method: install-converters (SCHEMA failsafe-schema) progn
-
- Method: install-converters (SCHEMA yaml-schema-unspecific-mixin) progn
-
5.1.4 Classes
- Class: core-schema ()
-
Implementation of the core schema for yaml.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Direct superclasses
-
- Direct methods
convert-non-specific-scalar (method)
- Class: failsafe-schema ()
-
Implementation of the failsafe schema for yaml.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Direct superclasses
yaml-schema (class)
- Direct subclasses
json-schema (class)
- Direct methods
install-converters (method)
- Class: json-schema ()
-
Implementation of the json schema for ymal.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Direct superclasses
-
- Direct subclasses
core-schema (class)
- Direct methods
-
- Class: yaml-schema ()
-
Base class for yaml schemas.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Direct superclasses
standard-object (class)
- Direct subclasses
-
- Class: yaml-schema-unspecific-mixin ()
-
Mixin to add a scalar-converter for :non-specific that
calls CONVERT-NON-SPECIFIC-SCALAR with the schema and the content.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Direct superclasses
yaml-schema (class)
- Direct subclasses
-
- Direct methods
install-converters (method)
5.2 Internal definitions
5.2.1 Special variables
- Special Variable: alias-count
-
- Package
cl-yaclyaml
- Source
serializing.lisp (file)
- Special Variable: anchors
-
- Package
cl-yaclyaml
- Source
composing.lisp (file)
- Special Variable: block-scalar-chomping
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: block-scalar-style
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: cons-maps-as-maps
-
If T, represent alists and plists as mappings, not as sequences
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Special Variable: context
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: converted-nodes
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Special Variable: default-local-tagspace
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: default-yaml-tagspace
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: encountered-nodes
-
- Package
cl-yaclyaml
- Source
serializing.lisp (file)
- Special Variable: indent-style
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: initialization-callbacks
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Special Variable: lisp-tag-prefix
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Special Variable: mapping-converters
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Special Variable: n
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: node-aliases
-
- Package
cl-yaclyaml
- Source
serializing.lisp (file)
- Special Variable: scalar-converters
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Special Variable: schemas
-
Hash table of available schemas. The keys are symbols and the
values are instances of YAML-SCHEMA.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Special Variable: sequence-converters
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Special Variable: tag-handles
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: tag-prefix
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Special Variable: vanilla-mapping-tag
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: vanilla-scalar-tag
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: vanilla-sequence-tag
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Special Variable: visited-nodes
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Special Variable: yaclyaml-contexts
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Special Variable: yaclyaml-rules
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Special Variable: yaml-version
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
5.2.2 Macros
- Macro: crunch-tag-into-properties PROPS-VAR CRUNCH-IF-ABSENT CRUNCH-IF-VANILLA
-
- Package
cl-yaclyaml
- Source
macro-utils.lisp (file)
- Macro: define-alias-rule ALIAS RULE
-
- Package
cl-yaclyaml
- Source
parsing-macro-2.lisp (file)
- Macro: define-bang-convert NAME CONVERTER-NAME
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Macro: define-context-forcing-rule CONTEXT-NAME FORSEE-NAME &optional EXPRESSION
-
- Package
cl-yaclyaml
- Source
parsing-macro-2.lisp (file)
- Macro: define-nc-yaclyaml-rule SYMBOL ARGS &body BODY
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: define-yaclyaml-rule SYMBOL ARGS &body BODY
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: define-yy-rule SYMBOL ARGS &body BODY
-
- Package
cl-yaclyaml
- Source
parsing-macro-2.lisp (file)
- Macro: mk-yaclyaml-tokenizer EXPRESSION TOKEN-ITER &key JUNK-ALLOWED
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: register-yaclyaml-context CONTEXT-VAR &rest PLAUSIBLE-CONTEXTS
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: with-ensured-properties-not-alias VAR &body BODY
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Macro: with-schema SCHEMA &body BODY
-
Execute BODY in a context where SCALAR-CONVERTERS, SEQUENCE-CONVERTERS, and
MAPPING-CONVERTERS have been bound to new hash tables with converters
installed by the schema.
- Package
cl-yaclyaml
- Source
schema.lisp (file)
- Macro: with-yaclyaml-contexts &body BODY
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: with-yaclyaml-rules &body BODY
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: yaclyaml-parse-stream EXPRESSION STREAM &key JUNK-ALLOWED
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
- Macro: yaclyaml-parse-token-iter EXPRESSION TOKEN-ITER &key JUNK-ALLOWED
-
- Package
cl-yaclyaml
- Source
parsing-macro.lisp (file)
5.2.3 Functions
- Function: %depth-first-traverse CUR-LEVEL &optional LEVEL
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: %nserialize NODE
-
- Package
cl-yaclyaml
- Source
serializing.lisp (file)
- Function: %represent-node X
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: alias-p NODE
-
- Package
cl-yaclyaml
- Source
composing.lisp (file)
- Function: alist-p X
-
Returns T if X is an association list in a narrow sense - all CAR’s of assocs are non-duplicating symbols.
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: autodetect-indent-style-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: block-in-context-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: block-key-context-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: block-out-context-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: c-printable-p CHAR
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: clip-block-scalar-chomping-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: compile-tag-handles ()
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: convert-mapping! NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-scalar! NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: convert-sequence! NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: converted-p NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: determined-indent-style-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: flow-in-context-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: flow-key-context-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: flow-out-context-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: folded-block-scalar-style-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: in-flow CONTEXT
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: keep-block-scalar-chomping-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: literal-block-scalar-style-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: mapping-node-p NODE
-
- Package
cl-yaclyaml
- Source
composing.lisp (file)
- Function: mapping-p NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: mark-node-as-visited NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: nb-json-p CHAR
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: nil-n-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: plist-p X
-
Returns T if X is a property list in a narrow sense - all odd elements are non-duplicating symbols.
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: property-node-p NODE
-
- Package
cl-yaclyaml
- Source
composing.lisp (file)
- Function: represent-mapping X
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: represent-scalar X
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: represent-sequence X
-
- Package
cl-yaclyaml
- Source
representing.lisp (file)
- Function: resolve-handle HANDLE
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: scalar-p NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: seq-spaces N
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: strip-block-scalar-chomping-p X
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: trivial-scalar-converter CONTENT
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: try-resolve HANDLE
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
- Function: visited-p NODE
-
- Package
cl-yaclyaml
- Source
convert.lisp (file)
- Function: whitespace-p TEXT
-
- Package
cl-yaclyaml
- Source
parsing.lisp (file)
5.2.4 Generic functions
- Generic Function: yaml-load-file-error-message CONDITION
-
- Package
cl-yaclyaml
- Methods
- Method: yaml-load-file-error-message (CONDITION yaml-load-file-error)
-
- Source
constructing.lisp (file)
5.2.5 Conditions
- Condition: yaml-load-file-error ()
-
- Package
cl-yaclyaml
- Source
constructing.lisp (file)
- Direct superclasses
simple-error (condition)
- Direct methods
yaml-load-file-error-message (method)
- Direct slots
- Slot: message
-
- Initargs
:message
- Readers
yaml-load-file-error-message (generic function)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
C | | |
| cl-yaclyaml.asd: | | The cl-yaclyaml․asd file |
| cl-yaclyaml/composing.lisp: | | The cl-yaclyaml/composing․lisp file |
| cl-yaclyaml/constructing.lisp: | | The cl-yaclyaml/constructing․lisp file |
| cl-yaclyaml/convert.lisp: | | The cl-yaclyaml/convert․lisp file |
| cl-yaclyaml/macro-utils.lisp: | | The cl-yaclyaml/macro-utils․lisp file |
| cl-yaclyaml/package.lisp: | | The cl-yaclyaml/package․lisp file |
| cl-yaclyaml/parsing-macro-2.lisp: | | The cl-yaclyaml/parsing-macro-2․lisp file |
| cl-yaclyaml/parsing-macro.lisp: | | The cl-yaclyaml/parsing-macro․lisp file |
| cl-yaclyaml/parsing.lisp: | | The cl-yaclyaml/parsing․lisp file |
| cl-yaclyaml/representing.lisp: | | The cl-yaclyaml/representing․lisp file |
| cl-yaclyaml/schema.lisp: | | The cl-yaclyaml/schema․lisp file |
| cl-yaclyaml/serializing.lisp: | | The cl-yaclyaml/serializing․lisp file |
|
F | | |
| File, Lisp, cl-yaclyaml.asd: | | The cl-yaclyaml․asd file |
| File, Lisp, cl-yaclyaml/composing.lisp: | | The cl-yaclyaml/composing․lisp file |
| File, Lisp, cl-yaclyaml/constructing.lisp: | | The cl-yaclyaml/constructing․lisp file |
| File, Lisp, cl-yaclyaml/convert.lisp: | | The cl-yaclyaml/convert․lisp file |
| File, Lisp, cl-yaclyaml/macro-utils.lisp: | | The cl-yaclyaml/macro-utils․lisp file |
| File, Lisp, cl-yaclyaml/package.lisp: | | The cl-yaclyaml/package․lisp file |
| File, Lisp, cl-yaclyaml/parsing-macro-2.lisp: | | The cl-yaclyaml/parsing-macro-2․lisp file |
| File, Lisp, cl-yaclyaml/parsing-macro.lisp: | | The cl-yaclyaml/parsing-macro․lisp file |
| File, Lisp, cl-yaclyaml/parsing.lisp: | | The cl-yaclyaml/parsing․lisp file |
| File, Lisp, cl-yaclyaml/representing.lisp: | | The cl-yaclyaml/representing․lisp file |
| File, Lisp, cl-yaclyaml/schema.lisp: | | The cl-yaclyaml/schema․lisp file |
| File, Lisp, cl-yaclyaml/serializing.lisp: | | The cl-yaclyaml/serializing․lisp file |
|
L | | |
| Lisp File, cl-yaclyaml.asd: | | The cl-yaclyaml․asd file |
| Lisp File, cl-yaclyaml/composing.lisp: | | The cl-yaclyaml/composing․lisp file |
| Lisp File, cl-yaclyaml/constructing.lisp: | | The cl-yaclyaml/constructing․lisp file |
| Lisp File, cl-yaclyaml/convert.lisp: | | The cl-yaclyaml/convert․lisp file |
| Lisp File, cl-yaclyaml/macro-utils.lisp: | | The cl-yaclyaml/macro-utils․lisp file |
| Lisp File, cl-yaclyaml/package.lisp: | | The cl-yaclyaml/package․lisp file |
| Lisp File, cl-yaclyaml/parsing-macro-2.lisp: | | The cl-yaclyaml/parsing-macro-2․lisp file |
| Lisp File, cl-yaclyaml/parsing-macro.lisp: | | The cl-yaclyaml/parsing-macro․lisp file |
| Lisp File, cl-yaclyaml/parsing.lisp: | | The cl-yaclyaml/parsing․lisp file |
| Lisp File, cl-yaclyaml/representing.lisp: | | The cl-yaclyaml/representing․lisp file |
| Lisp File, cl-yaclyaml/schema.lisp: | | The cl-yaclyaml/schema․lisp file |
| Lisp File, cl-yaclyaml/serializing.lisp: | | The cl-yaclyaml/serializing․lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
% | | |
| %depth-first-traverse : | | Internal functions |
| %nserialize : | | Internal functions |
| %represent-node : | | Internal functions |
|
A | | |
| alias-p : | | Internal functions |
| alist-p : | | Internal functions |
| autodetect-indent-style-p : | | Internal functions |
|
B | | |
| block-in-context-p : | | Internal functions |
| block-key-context-p : | | Internal functions |
| block-out-context-p : | | Internal functions |
|
C | | |
| c-printable-p : | | Internal functions |
| clip-block-scalar-chomping-p : | | Internal functions |
| compile-tag-handles : | | Internal functions |
| construct : | | Exported functions |
| convert-mapping : | | Exported functions |
| convert-mapping! : | | Internal functions |
| convert-mapping-to-hashtable : | | Exported functions |
| convert-node : | | Exported functions |
| convert-non-specific-scalar : | | Exported generic functions |
| convert-non-specific-scalar : | | Exported generic functions |
| convert-non-specific-scalar : | | Exported generic functions |
| convert-non-specific-scalar : | | Exported generic functions |
| convert-scalar : | | Exported functions |
| convert-scalar! : | | Internal functions |
| convert-sequence : | | Exported functions |
| convert-sequence! : | | Internal functions |
| convert-sequence-to-list : | | Exported functions |
| converted-p : | | Internal functions |
| crunch-tag-into-properties : | | Internal macros |
|
D | | |
| define-alias-rule : | | Internal macros |
| define-bang-convert : | | Internal macros |
| define-context-forcing-rule : | | Internal macros |
| define-nc-yaclyaml-rule : | | Internal macros |
| define-yaclyaml-rule : | | Internal macros |
| define-yaml-config : | | Exported macros |
| define-yy-rule : | | Internal macros |
| determined-indent-style-p : | | Internal functions |
|
F | | |
| flow-in-context-p : | | Internal functions |
| flow-key-context-p : | | Internal functions |
| flow-out-context-p : | | Internal functions |
| folded-block-scalar-style-p : | | Internal functions |
| Function, %depth-first-traverse : | | Internal functions |
| Function, %nserialize : | | Internal functions |
| Function, %represent-node : | | Internal functions |
| Function, alias-p : | | Internal functions |
| Function, alist-p : | | Internal functions |
| Function, autodetect-indent-style-p : | | Internal functions |
| Function, block-in-context-p : | | Internal functions |
| Function, block-key-context-p : | | Internal functions |
| Function, block-out-context-p : | | Internal functions |
| Function, c-printable-p : | | Internal functions |
| Function, clip-block-scalar-chomping-p : | | Internal functions |
| Function, compile-tag-handles : | | Internal functions |
| Function, construct : | | Exported functions |
| Function, convert-mapping : | | Exported functions |
| Function, convert-mapping! : | | Internal functions |
| Function, convert-mapping-to-hashtable : | | Exported functions |
| Function, convert-node : | | Exported functions |
| Function, convert-scalar : | | Exported functions |
| Function, convert-scalar! : | | Internal functions |
| Function, convert-sequence : | | Exported functions |
| Function, convert-sequence! : | | Internal functions |
| Function, convert-sequence-to-list : | | Exported functions |
| Function, converted-p : | | Internal functions |
| Function, determined-indent-style-p : | | Internal functions |
| Function, flow-in-context-p : | | Internal functions |
| Function, flow-key-context-p : | | Internal functions |
| Function, flow-out-context-p : | | Internal functions |
| Function, folded-block-scalar-style-p : | | Internal functions |
| Function, hash->assoc : | | Exported functions |
| Function, in-flow : | | Internal functions |
| Function, install-mapping-converter : | | Exported functions |
| Function, install-mapping-hashtable-converter : | | Exported functions |
| Function, install-scalar-converter : | | Exported functions |
| Function, install-sequence-converter : | | Exported functions |
| Function, install-sequence-list-converter : | | Exported functions |
| Function, keep-block-scalar-chomping-p : | | Internal functions |
| Function, literal-block-scalar-style-p : | | Internal functions |
| Function, mapping-node-p : | | Internal functions |
| Function, mapping-p : | | Internal functions |
| Function, mark-node-as-visited : | | Internal functions |
| Function, nb-json-p : | | Internal functions |
| Function, ncompose-representation-graph : | | Exported functions |
| Function, nil-n-p : | | Internal functions |
| Function, nserialize : | | Exported functions |
| Function, plist-p : | | Internal functions |
| Function, property-node-p : | | Internal functions |
| Function, register-schema : | | Exported functions |
| Function, represent-mapping : | | Internal functions |
| Function, represent-node : | | Exported functions |
| Function, represent-scalar : | | Internal functions |
| Function, represent-sequence : | | Internal functions |
| Function, resolve-handle : | | Internal functions |
| Function, scalar-p : | | Internal functions |
| Function, seq-spaces : | | Internal functions |
| Function, strip-block-scalar-chomping-p : | | Internal functions |
| Function, trivial-scalar-converter : | | Internal functions |
| Function, try-resolve : | | Internal functions |
| Function, visited-p : | | Internal functions |
| Function, whitespace-p : | | Internal functions |
| Function, yaml-load : | | Exported functions |
| Function, yaml-load-file : | | Exported functions |
| Function, yaml-simple-load : | | Exported functions |
|
G | | |
| Generic Function, convert-non-specific-scalar : | | Exported generic functions |
| Generic Function, install-converters : | | Exported generic functions |
| Generic Function, yaml-load-file-error-message : | | Internal generic functions |
|
H | | |
| hash->assoc : | | Exported functions |
|
I | | |
| in-flow : | | Internal functions |
| install-converters : | | Exported generic functions |
| install-converters : | | Exported generic functions |
| install-converters : | | Exported generic functions |
| install-converters : | | Exported generic functions |
| install-mapping-converter : | | Exported functions |
| install-mapping-hashtable-converter : | | Exported functions |
| install-scalar-converter : | | Exported functions |
| install-sequence-converter : | | Exported functions |
| install-sequence-list-converter : | | Exported functions |
|
K | | |
| keep-block-scalar-chomping-p : | | Internal functions |
|
L | | |
| literal-block-scalar-style-p : | | Internal functions |
|
M | | |
| Macro, crunch-tag-into-properties : | | Internal macros |
| Macro, define-alias-rule : | | Internal macros |
| Macro, define-bang-convert : | | Internal macros |
| Macro, define-context-forcing-rule : | | Internal macros |
| Macro, define-nc-yaclyaml-rule : | | Internal macros |
| Macro, define-yaclyaml-rule : | | Internal macros |
| Macro, define-yaml-config : | | Exported macros |
| Macro, define-yy-rule : | | Internal macros |
| Macro, mk-yaclyaml-tokenizer : | | Internal macros |
| Macro, register-yaclyaml-context : | | Internal macros |
| Macro, with-ensured-properties-not-alias : | | Internal macros |
| Macro, with-schema : | | Internal macros |
| Macro, with-yaclyaml-contexts : | | Internal macros |
| Macro, with-yaclyaml-rules : | | Internal macros |
| Macro, yaclyaml-parse : | | Exported macros |
| Macro, yaclyaml-parse-stream : | | Internal macros |
| Macro, yaclyaml-parse-token-iter : | | Internal macros |
| Macro, yy-parse : | | Exported macros |
| mapping-node-p : | | Internal functions |
| mapping-p : | | Internal functions |
| mark-node-as-visited : | | Internal functions |
| Method, convert-non-specific-scalar : | | Exported generic functions |
| Method, convert-non-specific-scalar : | | Exported generic functions |
| Method, convert-non-specific-scalar : | | Exported generic functions |
| Method, install-converters : | | Exported generic functions |
| Method, install-converters : | | Exported generic functions |
| Method, install-converters : | | Exported generic functions |
| Method, yaml-load-file-error-message : | | Internal generic functions |
| mk-yaclyaml-tokenizer : | | Internal macros |
|
N | | |
| nb-json-p : | | Internal functions |
| ncompose-representation-graph : | | Exported functions |
| nil-n-p : | | Internal functions |
| nserialize : | | Exported functions |
|
P | | |
| plist-p : | | Internal functions |
| property-node-p : | | Internal functions |
|
R | | |
| register-schema : | | Exported functions |
| register-yaclyaml-context : | | Internal macros |
| represent-mapping : | | Internal functions |
| represent-node : | | Exported functions |
| represent-scalar : | | Internal functions |
| represent-sequence : | | Internal functions |
| resolve-handle : | | Internal functions |
|
S | | |
| scalar-p : | | Internal functions |
| seq-spaces : | | Internal functions |
| strip-block-scalar-chomping-p : | | Internal functions |
|
T | | |
| trivial-scalar-converter : | | Internal functions |
| try-resolve : | | Internal functions |
|
V | | |
| visited-p : | | Internal functions |
|
W | | |
| whitespace-p : | | Internal functions |
| with-ensured-properties-not-alias : | | Internal macros |
| with-schema : | | Internal macros |
| with-yaclyaml-contexts : | | Internal macros |
| with-yaclyaml-rules : | | Internal macros |
|
Y | | |
| yaclyaml-parse : | | Exported macros |
| yaclyaml-parse-stream : | | Internal macros |
| yaclyaml-parse-token-iter : | | Internal macros |
| yaml-load : | | Exported functions |
| yaml-load-file : | | Exported functions |
| yaml-load-file-error-message : | | Internal generic functions |
| yaml-load-file-error-message : | | Internal generic functions |
| yaml-simple-load : | | Exported functions |
| yy-parse : | | Exported macros |
|
A.3 Variables
| Index Entry | | Section |
|
A | | |
| alias-count : | | Internal special variables |
| anchors : | | Internal special variables |
|
B | | |
| block-scalar-chomping : | | Internal special variables |
| block-scalar-style : | | Internal special variables |
|
C | | |
| cons-maps-as-maps : | | Internal special variables |
| context : | | Internal special variables |
| converted-nodes : | | Internal special variables |
|
D | | |
| default-local-tagspace : | | Internal special variables |
| default-yaml-tagspace : | | Internal special variables |
|
E | | |
| encountered-nodes : | | Internal special variables |
|
I | | |
| indent-style : | | Internal special variables |
| initialization-callbacks : | | Internal special variables |
|
L | | |
| lisp-tag-prefix : | | Internal special variables |
|
M | | |
| mapping-converters : | | Internal special variables |
| message : | | Internal conditions |
|
N | | |
| n : | | Internal special variables |
| node-aliases : | | Internal special variables |
|
S | | |
| scalar-converters : | | Internal special variables |
| schemas : | | Internal special variables |
| sequence-converters : | | Internal special variables |
| Slot, message : | | Internal conditions |
| Special Variable, alias-count : | | Internal special variables |
| Special Variable, anchors : | | Internal special variables |
| Special Variable, block-scalar-chomping : | | Internal special variables |
| Special Variable, block-scalar-style : | | Internal special variables |
| Special Variable, cons-maps-as-maps : | | Internal special variables |
| Special Variable, context : | | Internal special variables |
| Special Variable, converted-nodes : | | Internal special variables |
| Special Variable, default-local-tagspace : | | Internal special variables |
| Special Variable, default-yaml-tagspace : | | Internal special variables |
| Special Variable, encountered-nodes : | | Internal special variables |
| Special Variable, indent-style : | | Internal special variables |
| Special Variable, initialization-callbacks : | | Internal special variables |
| Special Variable, lisp-tag-prefix : | | Internal special variables |
| Special Variable, mapping-converters : | | Internal special variables |
| Special Variable, n : | | Internal special variables |
| Special Variable, node-aliases : | | Internal special variables |
| Special Variable, scalar-converters : | | Internal special variables |
| Special Variable, schemas : | | Internal special variables |
| Special Variable, sequence-converters : | | Internal special variables |
| Special Variable, tag-handles : | | Internal special variables |
| Special Variable, tag-prefix : | | Internal special variables |
| Special Variable, vanilla-mapping-tag : | | Internal special variables |
| Special Variable, vanilla-scalar-tag : | | Internal special variables |
| Special Variable, vanilla-sequence-tag : | | Internal special variables |
| Special Variable, visited-nodes : | | Internal special variables |
| Special Variable, yaclyaml-contexts : | | Internal special variables |
| Special Variable, yaclyaml-rules : | | Internal special variables |
| Special Variable, yaml-version : | | Internal special variables |
|
T | | |
| tag-handles : | | Internal special variables |
| tag-prefix : | | Internal special variables |
|
V | | |
| vanilla-mapping-tag : | | Internal special variables |
| vanilla-scalar-tag : | | Internal special variables |
| vanilla-sequence-tag : | | Internal special variables |
| visited-nodes : | | Internal special variables |
|
Y | | |
| yaclyaml-contexts : | | Internal special variables |
| yaclyaml-rules : | | Internal special variables |
| yaml-version : | | Internal special variables |
|
A.4 Data types