The cl-yaclyaml Reference Manual

3.1.1 cl-yaclyaml/cl-yaclyaml.asd

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

ASDF Systems

cl-yaclyaml.

Packages

cl-yaclyaml-system.

---

3.1.2 cl-yaclyaml/package.lisp

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Packages

cl-yaclyaml.

---

3.1.3 cl-yaclyaml/macro-utils.lisp

Dependency

package.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Internals

crunch-tag-into-properties (macro).

---

3.1.4 cl-yaclyaml/parsing-macro.lisp

Dependency

macro-utils.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

yaclyaml-parse (macro).

Internals

• define-nc-yaclyaml-rule (macro).
• define-yaclyaml-rule (macro).
• mk-yaclyaml-tokenizer (macro).
• register-yaclyaml-context (macro).
• with-yaclyaml-contexts (macro).
• with-yaclyaml-rules (macro).
• yaclyaml-contexts (special variable).
• yaclyaml-parse-stream (macro).
• yaclyaml-parse-token-iter (macro).
• yaclyaml-rules (special variable).

---

3.1.5 cl-yaclyaml/parsing-macro-2.lisp

Dependency

parsing-macro.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

yy-parse (macro).

Internals

• define-alias-rule (macro).
• define-context-forcing-rule (macro).
• define-yy-rule (macro).

---

3.1.6 cl-yaclyaml/parsing.lisp

Dependency

parsing-macro-2.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

hash->assoc (function).

Internals

• autodetect-indent-style-p (function).
• block-in-context-p (function).
• block-key-context-p (function).
• block-out-context-p (function).
• block-scalar-chomping (special variable).
• block-scalar-style (special variable).
• c-printable-p (function).
• clip-block-scalar-chomping-p (function).
• compile-tag-handles (function).
• context (special variable).
• default-local-tagspace (special variable).
• default-yaml-tagspace (special variable).
• determined-indent-style-p (function).
• flow-in-context-p (function).
• flow-key-context-p (function).
• flow-out-context-p (function).
• folded-block-scalar-style-p (function).
• in-flow (function).
• indent-style (special variable).
• keep-block-scalar-chomping-p (function).
• literal-block-scalar-style-p (function).
• n (special variable).
• nb-json-p (function).
• nil-n-p (function).
• resolve-handle (function).
• seq-spaces (function).
• strip-block-scalar-chomping-p (function).
• tag-handles (special variable).
• try-resolve (function).
• vanilla-mapping-tag (special variable).
• vanilla-scalar-tag (special variable).
• vanilla-sequence-tag (special variable).
• whitespace-p (function).
• with-ensured-properties-not-alias (macro).
• yaml-version (special variable).

---

3.1.7 cl-yaclyaml/composing.lisp

Dependency

parsing.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

ncompose-representation-graph (function).

Internals

• alias-p (function).
• anchors (special variable).
• mapping-node-p (function).
• property-node-p (function).

---

3.1.8 cl-yaclyaml/convert.lisp

Dependency

composing.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

• convert-mapping (function).
• convert-mapping-to-hashtable (function).
• convert-node (function).
• convert-scalar (function).
• convert-sequence (function).
• convert-sequence-to-list (function).
• install-mapping-converter (function).
• install-mapping-hashtable-converter (function).
• install-scalar-converter (function).
• install-sequence-converter (function).
• install-sequence-list-converter (function).

Internals

• %depth-first-traverse (function).
• convert-mapping! (function).
• convert-scalar! (function).
• convert-sequence! (function).
• converted-nodes (special variable).
• converted-p (function).
• define-bang-convert (macro).
• initialization-callbacks (special variable).
• mapping-converters (special variable).
• mapping-p (function).
• mark-node-as-visited (function).
• scalar-converters (special variable).
• scalar-p (function).
• sequence-converters (special variable).
• trivial-scalar-converter (function).
• visited-nodes (special variable).
• visited-p (function).

---

3.1.9 cl-yaclyaml/schema.lisp

Dependency

convert.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

• convert-non-specific-scalar (generic function).
• core-schema (class).
• failsafe-schema (class).
• install-converters (generic function).
• json-schema (class).
• register-schema (function).
• yaml-schema (class).
• yaml-schema-unspecific-mixin (class).

Internals

• schemas (special variable).
• with-schema (macro).

---

3.1.10 cl-yaclyaml/constructing.lisp

Dependency

schema.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

• construct (function).
• define-yaml-config (macro).
• yaml-load (function).
• yaml-load-file (function).
• yaml-simple-load (function).

Internals

• yaml-load-file-error (condition).
• yaml-load-file-error-message (reader method).

---

3.1.11 cl-yaclyaml/representing.lisp

Dependency

constructing.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

represent-node (function).

Internals

• %represent-node (function).
• alist-p (function).
• cons-maps-as-maps (special variable).
• lisp-tag-prefix (special variable).
• plist-p (function).
• represent-mapping (function).
• represent-scalar (function).
• represent-sequence (function).
• tag-prefix (special variable).

---

3.1.12 cl-yaclyaml/serializing.lisp

Dependency

representing.lisp (file).

Source

cl-yaclyaml.asd.

Parent Component

cl-yaclyaml (system).

Public Interface

nserialize (function).

Internals

• %nserialize (function).
• alias-count (special variable).
• encountered-nodes (special variable).
• node-aliases (special variable).

---

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.

Macro: yaclyaml-parse (expression text &key start end junk-allowed) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: yy-parse (expression text &key start end junk-allowed) ¶

Package

cl-yaclyaml.

Source

parsing-macro-2.lisp.

---

5.1.2 Ordinary functions

Function: construct (representation-graph &key schema) ¶

Package

cl-yaclyaml.

Source

constructing.lisp.

Function: convert-mapping (content tag) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-mapping-to-hashtable (content) ¶

Convert a raw mapping node to a hash-table of converted values.

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-node (node) ¶

Convert a parsed node into a user object.

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-scalar (content tag) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-sequence (content tag) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-sequence-to-list (nodes) ¶

Convert a raw sequence node to a list of converted values.

Package

cl-yaclyaml.

Source

convert.lisp.

Function: hash->assoc (hash) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

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.

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.

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.

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.

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.

Function: ncompose-representation-graph (representation-tree) ¶

Destructively composes representation graph from representation tree.

Package

cl-yaclyaml.

Source

composing.lisp.

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.

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.

Function: represent-node (x) ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Function: yaml-load (string &key schema) ¶

Package

cl-yaclyaml.

Source

constructing.lisp.

Function: yaml-load-file (path &key schema size-limit on-size-exceed simple) ¶

Package

cl-yaclyaml.

Source

constructing.lisp.

Function: yaml-simple-load (string &key schema) ¶

Package

cl-yaclyaml.

Source

constructing.lisp.

---

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.

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.

Method Combination

progn.

Options

:most-specific-last

Methods

Method: install-converters progn ((schema json-schema)) ¶

Method: install-converters progn ((schema failsafe-schema)) ¶

Method: install-converters progn ((schema yaml-schema-unspecific-mixin)) ¶

---

5.1.4 Classes

Class: core-schema ¶

Implementation of the core schema for yaml.

Package

cl-yaclyaml.

Source

schema.lisp.

Direct superclasses

• json-schema.
• yaml-schema-unspecific-mixin.

Direct methods

convert-non-specific-scalar.

Class: failsafe-schema ¶

Implementation of the failsafe schema for yaml.

Package

cl-yaclyaml.

Source

schema.lisp.

Direct superclasses

yaml-schema.

Direct subclasses

json-schema.

Direct methods

install-converters.

Class: json-schema ¶

Implementation of the json schema for ymal.

Package

cl-yaclyaml.

Source

schema.lisp.

Direct superclasses

• failsafe-schema.
• yaml-schema-unspecific-mixin.

Direct subclasses

core-schema.

Direct methods

• convert-non-specific-scalar.
• install-converters.

Class: yaml-schema ¶

Base class for yaml schemas.

Package

cl-yaclyaml.

Source

schema.lisp.

Direct subclasses

• failsafe-schema.
• yaml-schema-unspecific-mixin.

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.

Direct superclasses

yaml-schema.

Direct subclasses

• core-schema.
• json-schema.

Direct methods

install-converters.

---

5.2.1 Special variables

Special Variable: alias-count ¶

Package

cl-yaclyaml.

Source

serializing.lisp.

Special Variable: anchors ¶

Package

cl-yaclyaml.

Source

composing.lisp.

Special Variable: block-scalar-chomping ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: block-scalar-style ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: cons-maps-as-maps ¶

If T, represent alists and plists as mappings, not as sequences

Package

cl-yaclyaml.

Source

representing.lisp.

Special Variable: context ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: converted-nodes ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Special Variable: default-local-tagspace ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: default-yaml-tagspace ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: encountered-nodes ¶

Package

cl-yaclyaml.

Source

serializing.lisp.

Special Variable: indent-style ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: initialization-callbacks ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Special Variable: lisp-tag-prefix ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Special Variable: mapping-converters ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Special Variable: n ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: node-aliases ¶

Package

cl-yaclyaml.

Source

serializing.lisp.

Special Variable: scalar-converters ¶

Package

cl-yaclyaml.

Source

convert.lisp.

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.

Special Variable: sequence-converters ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Special Variable: tag-handles ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: tag-prefix ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Special Variable: vanilla-mapping-tag ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: vanilla-scalar-tag ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: vanilla-sequence-tag ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Special Variable: visited-nodes ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Special Variable: yaclyaml-contexts ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Special Variable: yaclyaml-rules ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Special Variable: yaml-version ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

---

5.2.2 Macros

Macro: crunch-tag-into-properties (props-var crunch-if-absent crunch-if-vanilla) ¶

Package

cl-yaclyaml.

Source

macro-utils.lisp.

Macro: define-alias-rule (alias rule) ¶

Package

cl-yaclyaml.

Source

parsing-macro-2.lisp.

Macro: define-bang-convert (name converter-name) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Macro: define-context-forcing-rule (context-name forsee-name &optional expression) ¶

Package

cl-yaclyaml.

Source

parsing-macro-2.lisp.

Macro: define-nc-yaclyaml-rule (symbol args &body body) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: define-yaclyaml-rule (symbol args &body body) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: define-yy-rule (symbol args &body body) ¶

Package

cl-yaclyaml.

Source

parsing-macro-2.lisp.

Macro: mk-yaclyaml-tokenizer (expression token-iter &key junk-allowed) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: register-yaclyaml-context (context-var &rest plausible-contexts) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: with-ensured-properties-not-alias (var &body body) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

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.

Macro: with-yaclyaml-contexts (&body body) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: with-yaclyaml-rules (&body body) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: yaclyaml-parse-stream (expression stream &key junk-allowed) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

Macro: yaclyaml-parse-token-iter (expression token-iter &key junk-allowed) ¶

Package

cl-yaclyaml.

Source

parsing-macro.lisp.

---

5.2.3 Ordinary functions

Function: %depth-first-traverse (cur-level &optional level) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: %nserialize (node) ¶

Package

cl-yaclyaml.

Source

serializing.lisp.

Function: %represent-node (x) ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Function: alias-p (node) ¶

Package

cl-yaclyaml.

Source

composing.lisp.

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.

Function: autodetect-indent-style-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: block-in-context-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: block-key-context-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: block-out-context-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: c-printable-p (char) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: clip-block-scalar-chomping-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: compile-tag-handles () ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: convert-mapping! (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-scalar! (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: convert-sequence! (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: converted-p (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: determined-indent-style-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: flow-in-context-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: flow-key-context-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: flow-out-context-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: folded-block-scalar-style-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: in-flow (context) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: keep-block-scalar-chomping-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: literal-block-scalar-style-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: mapping-node-p (node) ¶

Package

cl-yaclyaml.

Source

composing.lisp.

Function: mapping-p (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: mark-node-as-visited (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: nb-json-p (char) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: nil-n-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

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.

Function: property-node-p (node) ¶

Package

cl-yaclyaml.

Source

composing.lisp.

Function: represent-mapping (x) ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Function: represent-scalar (x) ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Function: represent-sequence (x) ¶

Package

cl-yaclyaml.

Source

representing.lisp.

Function: resolve-handle (handle) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: scalar-p (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: seq-spaces (n) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: strip-block-scalar-chomping-p (x) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: trivial-scalar-converter (content) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: try-resolve (handle) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

Function: visited-p (node) ¶

Package

cl-yaclyaml.

Source

convert.lisp.

Function: whitespace-p (text) ¶

Package

cl-yaclyaml.

Source

parsing.lisp.

---

5.2.4 Generic functions

Generic Reader: yaml-load-file-error-message (condition) ¶

Package

cl-yaclyaml.

Methods

Reader Method: yaml-load-file-error-message ((condition yaml-load-file-error)) ¶

Source

constructing.lisp.

Target Slot

message.

---

5.2.5 Conditions

Condition: yaml-load-file-error ¶

Package

cl-yaclyaml.

Source

constructing.lisp.

Direct superclasses

simple-error.

Direct methods

yaml-load-file-error-message.

Direct slots

Slot: message ¶

Initargs

:message

Readers

yaml-load-file-error-message.

Writers

This slot is read-only.

---