This is the cl-libyaml Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:19:16 2025 GMT+0.
cl-libyaml/cl-libyaml.asdcl-libyaml/src/library.lispcl-libyaml/src/version.lispcl-libyaml/src/util.lispcl-libyaml/src/basic-types.lispcl-libyaml/src/style.lispcl-libyaml/src/node.lispcl-libyaml/src/token.lispcl-libyaml/src/event.lispcl-libyaml/src/document.lispcl-libyaml/src/parser.lispcl-libyaml/src/emitter.lispcl-libyaml/src/write-handler.lispcl-libyaml/src/macros.lispThe main system appears first, followed by any subsystem dependency.
cl-libyamlA binding to the libyaml library.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:eudoxia0/cl-libyaml.git)
MIT
# cl-libyaml
[](https://travis-ci.org/eudoxia0/cl-libyaml)
[](http://quickdocs.org/cl-libyaml/)
A binding to the [libyaml][lyaml] library.
# Overview
This is a home-spun binding to the libyaml library. It’s not meant as a full
library for YAML, just a bare binding with a couple of utility macros. For a
YAML parser and emitter using this, check out [cl-yaml][cl-yaml].
## Naming Convention
The naming convention is what you’d expect: Function and type names have dashes
instead of underscoes, the ‘yaml_‘ prefix on every symbol has been removed, and
instead you have package prefixes, but the trailing ‘_t‘ after every type
definition has been kept, to make it easier to tell symbols that denote types
from symbols that denote structure fields or functions.
For example, ‘yaml_event_t‘ is ‘libyaml.event:event-t‘, and ‘yaml_parser_parse‘
is ‘libyaml.parser:parser-parse‘.
Enum values like ‘YAML_PARSE_FLOW_NODE_STATE‘ are keywords with the ‘YAML_‘
prefix removed, as in ‘:parse-flow-node-state‘.
# Usage
“‘lisp
(defpackage yaml-example
(:use :cl)
(:import-from :libyaml.macros
:with-parser
:with-event)
(:import-from :libyaml.event
:event-type))
(in-package :yaml-example)
(defun parse (string)
(with-parser (parser string)
(with-event (event)
(loop do
(when (libyaml.parser:parse parser event)
(let ((type (event-type event)))
(print type)
(when (eql type :stream-end-event)
(return-from parse nil))))))))
“‘
“‘lisp
YAML-EXAMPLE> (parse "[1,2,3]")
:STREAM-START-EVENT
:DOCUMENT-START-EVENT
:SEQUENCE-START-EVENT
:SCALAR-EVENT
:SCALAR-EVENT
:SCALAR-EVENT
:SEQUENCE-END-EVENT
:DOCUMENT-END-EVENT
:STREAM-END-EVENT
NIL
“‘
[lyaml]: http://pyyaml.org/wiki/LibYAML
[cl-yaml]: https://github.com/eudoxia0/cl-yaml
# License
Copyright (c) 2015–2016 Fernando Borretti
Licensed under the MIT License.
0.1
cffi (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-libyaml/srccl-libyaml (system).
library.lisp (file).
version.lisp (file).
util.lisp (file).
basic-types.lisp (file).
style.lisp (file).
node.lisp (file).
token.lisp (file).
event.lisp (file).
document.lisp (file).
parser.lisp (file).
emitter.lisp (file).
write-handler.lisp (file).
macros.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-libyaml/cl-libyaml.asdcl-libyaml/src/library.lispcl-libyaml/src/version.lispcl-libyaml/src/util.lispcl-libyaml/src/basic-types.lispcl-libyaml/src/style.lispcl-libyaml/src/node.lispcl-libyaml/src/token.lispcl-libyaml/src/event.lispcl-libyaml/src/document.lispcl-libyaml/src/parser.lispcl-libyaml/src/emitter.lispcl-libyaml/src/write-handler.lispcl-libyaml/src/macros.lispcl-libyaml/src/version.lisplibrary.lisp (file).
src (module).
allocate-version-directive (function).
get-version-string (function).
version-directive-t-tclass (class).
cl-libyaml/src/util.lispversion.lisp (file).
src (module).
define-size-t (macro).
cl-libyaml/src/basic-types.lisputil.lisp (file).
src (module).
mark-column (function).
mark-line (function).
mark-t-tclass (class).
tag-directive-t-tclass (class).
version-directive-t-tclass (class).
cl-libyaml/src/style.lispbasic-types.lisp (file).
src (module).
cl-libyaml/src/node.lispstyle.lisp (file).
src (module).
item-stack-t-tclass (class).
mapping-t-tclass (class).
node-t-tclass (class).
pair-stack-t-tclass (class).
pair-t-tclass (class).
scalar-t-tclass (class).
sequence-t-tclass (class).
cl-libyaml/src/token.lispnode.lisp (file).
src (module).
allocate-token (function).
token-delete (function).
token-type (function).
alias-t-tclass (class).
anchor-t-tclass (class).
scalar-t-tclass (class).
stream-start-t-tclass (class).
tag-directive-t-tclass (class).
tag-t-tclass (class).
token-t-tclass (class).
version-directive-t-tclass (class).
cl-libyaml/src/event.lisptoken.lisp (file).
src (module).
allocate-event (function).
event-alias-data (function).
event-delete (function).
event-mapping-start-data (function).
event-scalar-data (function).
event-sequence-start-data (function).
event-type (function).
alias-t-tclass (class).
document-end-t-tclass (class).
document-start-t-tclass (class).
event-t-tclass (class).
mapping-start-pointer (function).
mapping-start-t-tclass (class).
scalar-pointer (function).
scalar-t-tclass (class).
sequence-start-pointer (function).
sequence-start-t-tclass (class).
stream-start-t-tclass (class).
tag-directives-t-tclass (class).
union-pointer (function).
cl-libyaml/src/document.lispevent.lisp (file).
src (module).
allocate-document (function).
document-delete (function).
document-t-tclass (class).
nodes-t-tclass (class).
tag-directives-t-tclass (class).
cl-libyaml/src/parser.lispdocument.lisp (file).
src (module).
allocate-parser (function).
error-column (function).
error-line (function).
error-message (function).
initialize (function).
parse (function).
parser-delete (function).
parser-error (function).
parser-load (function).
scan (function).
set-encoding (function).
set-input (function).
set-input-file (function).
set-input-string (function).
alias-data-t-tclass (class).
aliases-t-tclass (class).
indent-stack-t-tclass (class).
parser-buffer-t-tclass (class).
parser-input-string-t-tclass (class).
parser-marks-stack-t-tclass (class).
parser-raw-buffer-t-tclass (class).
parser-states-stack-t-tclass (class).
parser-t-tclass (class).
simple-key-stack-t-tclass (class).
simple-key-t-tclass (class).
tag-directives-t-tclass (class).
token-queue-t-tclass (class).
cl-libyaml/src/emitter.lispparser.lisp (file).
src (module).
allocate-emitter (function).
document-end-event-initialize (function).
document-start-event-initialize (function).
emit (function).
emitter-close (function).
emitter-delete (function).
emitter-dump (function).
emitter-flush (function).
emitter-initialize (function).
emitter-open (function).
mapping-end-event-initialize (function).
mapping-start-event-initialize (function).
scalar-event-initialize (function).
sequence-end-event-initialize (function).
sequence-start-event-initialize (function).
set-output (function).
set-output-file (function).
set-output-string (function).
stream-end-event-initialize (function).
stream-start-event-initialize (function).
alias-event-initialize (function).
anchor-data-t-tclass (class).
anchor-info-t-tclass (class).
buffer-t-tclass (class).
emitter-states-stack-t-tclass (class).
emitter-t-tclass (class).
event-queue-t-tclass (class).
indent-stack-t-tclass (class).
output-string-t-tclass (class).
raw-buffer-t-tclass (class).
scalar-data-t-tclass (class).
tag-data-t-tclass (class).
tag-directives-t-tclass (class).
cl-libyaml/src/write-handler.lispemitter.lisp (file).
src (module).
*write-handler-callback* (special variable).
*write-handler-stream* (special variable).
strlen (function).
cl-libyaml/src/macros.lispwrite-handler.lisp (file).
src (module).
with-event (macro).
with-parser (macro).
Packages are listed by definition order.
libyaml.macroslibyaml.stylelibyaml.emitterlibyaml.nodelibyaml.documentlibyaml.parserlibyaml.versionlibyaml.liblibyaml.eventlibyaml.write-handlerlibyaml.tokenlibyaml.basiclibyaml.utillibyaml.macrosSome macros to simplify managing foreign objects.
common-lisp.
with-event (macro).
with-parser (macro).
libyaml.styleStyle information for various libyaml structures.
cffi.
common-lisp.
libyaml.emitterThe libyaml emitter. This package is incomplete.
cffi.
common-lisp.
allocate-emitter (function).
document-end-event-initialize (function).
document-start-event-initialize (function).
emit (function).
emitter-close (function).
emitter-delete (function).
emitter-dump (function).
emitter-flush (function).
emitter-initialize (function).
emitter-open (function).
mapping-end-event-initialize (function).
mapping-start-event-initialize (function).
scalar-event-initialize (function).
sequence-end-event-initialize (function).
sequence-start-event-initialize (function).
set-output (function).
set-output-file (function).
set-output-string (function).
stream-end-event-initialize (function).
stream-start-event-initialize (function).
alias-event-initialize (function).
anchor-data-t-tclass (class).
anchor-info-t-tclass (class).
buffer-t-tclass (class).
emitter-states-stack-t-tclass (class).
emitter-t-tclass (class).
event-queue-t-tclass (class).
indent-stack-t-tclass (class).
output-string-t-tclass (class).
raw-buffer-t-tclass (class).
scalar-data-t-tclass (class).
tag-data-t-tclass (class).
tag-directives-t-tclass (class).
libyaml.nodeLibYAML nodes.
cffi.
common-lisp.
item-stack-t-tclass (class).
mapping-t-tclass (class).
node-t-tclass (class).
pair-stack-t-tclass (class).
pair-t-tclass (class).
scalar-t-tclass (class).
sequence-t-tclass (class).
libyaml.documentBindings to the document data structure.
cffi.
common-lisp.
allocate-document (function).
document-delete (function).
document-t-tclass (class).
nodes-t-tclass (class).
tag-directives-t-tclass (class).
libyaml.parserThe libyaml parser.
cffi.
common-lisp.
allocate-parser (function).
error-column (function).
error-line (function).
error-message (function).
initialize (function).
parse (function).
parser-delete (function).
parser-error (function).
parser-load (function).
scan (function).
set-encoding (function).
set-input (function).
set-input-file (function).
set-input-string (function).
alias-data-t-tclass (class).
aliases-t-tclass (class).
indent-stack-t-tclass (class).
parser-buffer-t-tclass (class).
parser-input-string-t-tclass (class).
parser-marks-stack-t-tclass (class).
parser-raw-buffer-t-tclass (class).
parser-states-stack-t-tclass (class).
parser-t-tclass (class).
simple-key-stack-t-tclass (class).
simple-key-t-tclass (class).
tag-directives-t-tclass (class).
token-queue-t-tclass (class).
libyaml.versionStuff for dealing with version information.
cffi.
common-lisp.
allocate-version-directive (function).
get-version-string (function).
version-directive-t-tclass (class).
libyaml.eventEvents are produced by parsers, and are an alternative to token-based parsing.
cffi.
common-lisp.
allocate-event (function).
event-alias-data (function).
event-delete (function).
event-mapping-start-data (function).
event-scalar-data (function).
event-sequence-start-data (function).
event-type (function).
alias-t-tclass (class).
document-end-t-tclass (class).
document-start-t-tclass (class).
event-t-tclass (class).
mapping-start-pointer (function).
mapping-start-t-tclass (class).
scalar-pointer (function).
scalar-t-tclass (class).
sequence-start-pointer (function).
sequence-start-t-tclass (class).
stream-start-t-tclass (class).
tag-directives-t-tclass (class).
union-pointer (function).
libyaml.write-handlercommon-lisp.
*write-handler-callback* (special variable).
*write-handler-stream* (special variable).
strlen (function).
libyaml.tokenTokens are produced by parsing.
cffi.
common-lisp.
allocate-token (function).
token-delete (function).
token-type (function).
alias-t-tclass (class).
anchor-t-tclass (class).
scalar-t-tclass (class).
stream-start-t-tclass (class).
tag-directive-t-tclass (class).
tag-t-tclass (class).
token-t-tclass (class).
version-directive-t-tclass (class).
libyaml.basicBasic data types used throughout libyaml.
cffi.
common-lisp.
mark-column (function).
mark-line (function).
mark-t-tclass (class).
tag-directive-t-tclass (class).
version-directive-t-tclass (class).
libyaml.utilFFI utilities.
cffi.
common-lisp.
define-size-t (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Function pointer to write-handler
Stream that write-handler will output to
Allocate event, execute body, then free it.
Create a parser using input-string as the YAML input, execute body, then free the parser.
Return a pointer to an event.
Allocate a token.
Delete a YAML document and all its nodes.
Create the DOCUMENT-END event.
Create the DOCUMENT-START event.
Emit an event.
Finish a YAML stream.
Destroy an emitter.
Exit a YAML document.
Flush the accumulated characters to the output.
Initialize an emitter.
Start a YAML stream.
Return the column where the error happened.
Return the line where the current error happened.
Return the current error message.
Free any memory allocated for an event object.
The event’s type.
Get the library version as a string.
Initialize a parser.
The column number of a mark.
The line number of a mark.
Parse the input stream and produce the next parsing event.
Destroy a parser.
Return the current error type.
Parse the input stream and produce the next YAML document.
Scan the input stream and produce the next token.
Set the source encoding.
Set a generic input handler.
Set a file input.
Set a string input.
Set a generic output handler.
Set a file output.
Set a string output.
Create a STREAM-END event.
Create a STREAM-START event.
Free any memory allocated for a token object.
Return the type of the token.
Create an ALIAS event.
Calculate the length of a string
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | A D E F G I M P S T U W |
|---|
| Jump to: | A D E F G I M P S T U W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | A B C D E F I L M N O P R S T U V W |
|---|
| Jump to: | A B C D E F I L M N O P R S T U V W |
|---|