The cl-libyaml Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-libyaml Reference Manual

This is the cl-libyaml Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:09:23 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-libyaml

Build Status Quicklisp

A binding to the libyaml 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.

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

(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))))))))
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

License

Copyright (c) 2015–2016 Fernando Borretti

Licensed under the MIT License


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-libyaml

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/eudoxia0/cl-libyaml

Source Control

(:git "git@github.com:eudoxia0/cl-libyaml.git")

Bug Tracker

https://github.com/eudoxia0/cl-libyaml/issues

License

MIT

Description

A binding to the libyaml library.

Long Description

# cl-libyaml

[![Build Status](https://travis-ci.org/eudoxia0/cl-libyaml.svg?branch=master)](https://travis-ci.org/eudoxia0/cl-libyaml) [![Quicklisp](http://quickdocs.org/badge/cl-libyaml.svg)](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.

Version

0.1

Dependency

cffi

Source

cl-libyaml.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 cl-libyaml/src

Parent

cl-libyaml (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-libyaml.asd

Location

cl-libyaml.asd

Systems

cl-libyaml (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-libyaml/src/library.lisp

Parent

src (module)

Location

src/library.lisp

Packages

libyaml.lib


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-libyaml/src/version.lisp

Dependency

library.lisp (file)

Parent

src (module)

Location

src/version.lisp

Packages

libyaml.version

Exported Definitions
Internal Definitions

version-directive-t-tclass (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-libyaml/src/util.lisp

Dependency

version.lisp (file)

Parent

src (module)

Location

src/util.lisp

Packages

libyaml.util

Internal Definitions

define-size-t (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 cl-libyaml/src/basic-types.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/basic-types.lisp

Packages

libyaml.basic

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-libyaml/src/style.lisp

Dependency

basic-types.lisp (file)

Parent

src (module)

Location

src/style.lisp

Packages

libyaml.style


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 cl-libyaml/src/node.lisp

Dependency

style.lisp (file)

Parent

src (module)

Location

src/node.lisp

Packages

libyaml.node

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 cl-libyaml/src/token.lisp

Dependency

node.lisp (file)

Parent

src (module)

Location

src/token.lisp

Packages

libyaml.token

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 cl-libyaml/src/event.lisp

Dependency

token.lisp (file)

Parent

src (module)

Location

src/event.lisp

Packages

libyaml.event

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 cl-libyaml/src/document.lisp

Dependency

event.lisp (file)

Parent

src (module)

Location

src/document.lisp

Packages

libyaml.document

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 cl-libyaml/src/parser.lisp

Dependency

document.lisp (file)

Parent

src (module)

Location

src/parser.lisp

Packages

libyaml.parser

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 cl-libyaml/src/emitter.lisp

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

libyaml.emitter

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 cl-libyaml/src/write-handler.lisp

Dependency

emitter.lisp (file)

Parent

src (module)

Location

src/write-handler.lisp

Packages

libyaml.write-handler

Exported Definitions
Internal Definitions

strlen (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.14 cl-libyaml/src/macros.lisp

Dependency

write-handler.lisp (file)

Parent

src (module)

Location

src/macros.lisp

Packages

libyaml.macros

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 libyaml.lib

Load the libyaml library.

Source

library.lisp (file)

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 libyaml.version

Stuff for dealing with version information.

Source

version.lisp (file)

Use List
Exported Definitions
Internal Definitions

version-directive-t-tclass (class)


Next: , Previous: , Up: Packages   [Contents][Index]

5.3 libyaml.util

FFI utilities.

Source

util.lisp (file)

Use List
Internal Definitions

define-size-t (macro)


Next: , Previous: , Up: Packages   [Contents][Index]

5.4 libyaml.basic

Basic data types used throughout libyaml.

Source

basic-types.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.5 libyaml.style

Style information for various libyaml structures.

Source

style.lisp (file)

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.6 libyaml.node

LibYAML nodes.

Source

node.lisp (file)

Use List
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.7 libyaml.token

Tokens are produced by parsing.

Source

token.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.8 libyaml.event

Events are produced by parsers, and are an alternative to token-based parsing.

Source

event.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.9 libyaml.document

Bindings to the document data structure.

Source

document.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.10 libyaml.parser

The libyaml parser.

Source

parser.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.11 libyaml.emitter

The libyaml emitter. This package is incomplete.

Source

emitter.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.12 libyaml.write-handler

Source

write-handler.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

strlen (function)


Previous: , Up: Packages   [Contents][Index]

5.13 libyaml.macros

Some macros to simplify managing foreign objects.

Source

macros.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *write-handler-callback*

Function pointer to write-handler

Package

libyaml.write-handler

Source

write-handler.lisp (file)

Special Variable: *write-handler-stream*

Stream that write-handler will output to

Package

libyaml.write-handler

Source

write-handler.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: with-event (EVENT) &rest BODY

Allocate event, execute body, then free it.

Package

libyaml.macros

Source

macros.lisp (file)

Macro: with-parser (PARSER INPUT-STRING) &rest BODY

Create a parser using input-string as the YAML input, execute body, then free the parser.

Package

libyaml.macros

Source

macros.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: allocate-document ()
Package

libyaml.document

Source

document.lisp (file)

Function: allocate-emitter ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Function: allocate-event ()

Return a pointer to an event.

Package

libyaml.event

Source

event.lisp (file)

Function: allocate-parser ()
Package

libyaml.parser

Source

parser.lisp (file)

Function: allocate-token ()

Allocate a token.

Package

libyaml.token

Source

token.lisp (file)

Function: allocate-version-directive ()
Package

libyaml.version

Source

version.lisp (file)

Function: document-delete TOKEN

Delete a YAML document and all its nodes.

Package

libyaml.document

Source

document.lisp (file)

Function: document-end-event-initialize EVENT IMPLICIT

Create the DOCUMENT-END event.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: document-start-event-initialize EVENT VERSION-DIRECTIVE TAG-DIRECTIVE-START TAG-DIRECTIVE-END IMPLICIT

Create the DOCUMENT-START event.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emit EMITTER EVENT

Emit an event.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emitter-close EMITTER

Finish a YAML stream.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emitter-delete EMITTER

Destroy an emitter.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emitter-dump EMITTER DOCUMENT

Exit a YAML document.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emitter-flush EMITTER

Flush the accumulated characters to the output.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emitter-initialize EMITTER

Initialize an emitter.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: emitter-open EMITTER

Start a YAML stream.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: error-column PARSER

Return the column where the error happened.

Package

libyaml.parser

Source

parser.lisp (file)

Function: error-line PARSER

Return the line where the current error happened.

Package

libyaml.parser

Source

parser.lisp (file)

Function: error-message PARSER

Return the current error message.

Package

libyaml.parser

Source

parser.lisp (file)

Function: event-alias-data EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: event-delete TOKEN

Free any memory allocated for an event object.

Package

libyaml.event

Source

event.lisp (file)

Function: event-mapping-start-data EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: event-scalar-data EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: event-sequence-start-data EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: event-type EVENT

The event’s type.

Package

libyaml.event

Source

event.lisp (file)

Function: get-version-string ()

Get the library version as a string.

Package

libyaml.version

Source

version.lisp (file)

Function: initialize PARSER

Initialize a parser.

Package

libyaml.parser

Source

parser.lisp (file)

Function: mapping-end-event-initialize EVENT
Package

libyaml.emitter

Source

emitter.lisp (file)

Function: mapping-start-event-initialize EVENT ANCHOR TAG IMPLICIT STYLE
Package

libyaml.emitter

Source

emitter.lisp (file)

Function: mark-column MARK

The column number of a mark.

Package

libyaml.basic

Source

basic-types.lisp (file)

Function: mark-line MARK

The line number of a mark.

Package

libyaml.basic

Source

basic-types.lisp (file)

Function: parse PARSER EVENT

Parse the input stream and produce the next parsing event.

Package

libyaml.parser

Source

parser.lisp (file)

Function: parser-delete PARSER

Destroy a parser.

Package

libyaml.parser

Source

parser.lisp (file)

Function: parser-error PARSER

Return the current error type.

Package

libyaml.parser

Source

parser.lisp (file)

Function: parser-load PARSER DOCUMENT

Parse the input stream and produce the next YAML document.

Package

libyaml.parser

Source

parser.lisp (file)

Function: scalar-event-initialize EVENT ANCHOR TAG VALUE LENGTH PLAIN-IMPLICIT QUOTED-IMPLICIT STYLE
Package

libyaml.emitter

Source

emitter.lisp (file)

Function: scan PARSER TOKEN

Scan the input stream and produce the next token.

Package

libyaml.parser

Source

parser.lisp (file)

Function: sequence-end-event-initialize EVENT
Package

libyaml.emitter

Source

emitter.lisp (file)

Function: sequence-start-event-initialize EVENT ANCHOR TAG IMPLICIT STYLE
Package

libyaml.emitter

Source

emitter.lisp (file)

Function: set-encoding PARSER ENCODING

Set the source encoding.

Package

libyaml.parser

Source

parser.lisp (file)

Function: set-input PARSER HANDLER DATA

Set a generic input handler.

Package

libyaml.parser

Source

parser.lisp (file)

Function: set-input-file PARSER FILE

Set a file input.

Package

libyaml.parser

Source

parser.lisp (file)

Function: set-input-string PARSER INPUT SIZE

Set a string input.

Package

libyaml.parser

Source

parser.lisp (file)

Function: set-output EMITTER HANDLER DATA

Set a generic output handler.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: set-output-file EMITTER FILE

Set a file output.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: set-output-string EMITTER OUTPUT SIZE SIZE-WRITTEN

Set a string output.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: stream-end-event-initialize EVENT

Create a STREAM-END event.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: stream-start-event-initialize EVENT ENCODING

Create a STREAM-START event.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: token-delete TOKEN

Free any memory allocated for a token object.

Package

libyaml.token

Source

token.lisp (file)

Function: token-type TOKEN

Return the type of the token.

Package

libyaml.token

Source

token.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Macros

Macro: define-size-t ()

Define size_t according to the architecture.

Package

libyaml.util

Source

util.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: alias-event-initialize EVENT ANCHOR

Create an ALIAS event.

Package

libyaml.emitter

Source

emitter.lisp (file)

Function: mapping-start-pointer EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: scalar-pointer EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: sequence-start-pointer EVENT
Package

libyaml.event

Source

event.lisp (file)

Function: strlen S

Calculate the length of a string

Package

libyaml.write-handler

Source

write-handler.lisp (file)

Function: union-pointer EVENT
Package

libyaml.event

Source

event.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Classes

Class: alias-data-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: alias-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: alias-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: aliases-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: anchor-data-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: anchor-info-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: anchor-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: buffer-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: document-end-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: document-start-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: document-t-tclass ()
Package

libyaml.document

Source

document.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: emitter-states-stack-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: emitter-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: event-queue-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: event-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: indent-stack-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: indent-stack-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: item-stack-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: mapping-start-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: mapping-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: mark-t-tclass ()
Package

libyaml.basic

Source

basic-types.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: node-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: nodes-t-tclass ()
Package

libyaml.document

Source

document.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: output-string-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: pair-stack-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: pair-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: parser-buffer-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: parser-input-string-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: parser-marks-stack-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: parser-raw-buffer-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: parser-states-stack-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: parser-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: raw-buffer-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: scalar-data-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: scalar-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: scalar-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: scalar-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sequence-start-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: sequence-t-tclass ()
Package

libyaml.node

Source

node.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: simple-key-stack-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: simple-key-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: stream-start-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: stream-start-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-data-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-directive-t-tclass ()
Package

libyaml.basic

Source

basic-types.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-directive-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-directives-t-tclass ()
Package

libyaml.event

Source

event.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-directives-t-tclass ()
Package

libyaml.document

Source

document.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-directives-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-directives-t-tclass ()
Package

libyaml.emitter

Source

emitter.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: tag-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: token-queue-t-tclass ()
Package

libyaml.parser

Source

parser.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: token-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: version-directive-t-tclass ()
Package

libyaml.version

Source

version.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: version-directive-t-tclass ()
Package

libyaml.basic

Source

basic-types.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: version-directive-t-tclass ()
Package

libyaml.token

Source

token.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-libyaml.asd: The cl-libyaml<dot>asd file
cl-libyaml/src: The cl-libyaml/src module
cl-libyaml/src/basic-types.lisp: The cl-libyaml/src/basic-types<dot>lisp file
cl-libyaml/src/document.lisp: The cl-libyaml/src/document<dot>lisp file
cl-libyaml/src/emitter.lisp: The cl-libyaml/src/emitter<dot>lisp file
cl-libyaml/src/event.lisp: The cl-libyaml/src/event<dot>lisp file
cl-libyaml/src/library.lisp: The cl-libyaml/src/library<dot>lisp file
cl-libyaml/src/macros.lisp: The cl-libyaml/src/macros<dot>lisp file
cl-libyaml/src/node.lisp: The cl-libyaml/src/node<dot>lisp file
cl-libyaml/src/parser.lisp: The cl-libyaml/src/parser<dot>lisp file
cl-libyaml/src/style.lisp: The cl-libyaml/src/style<dot>lisp file
cl-libyaml/src/token.lisp: The cl-libyaml/src/token<dot>lisp file
cl-libyaml/src/util.lisp: The cl-libyaml/src/util<dot>lisp file
cl-libyaml/src/version.lisp: The cl-libyaml/src/version<dot>lisp file
cl-libyaml/src/write-handler.lisp: The cl-libyaml/src/write-handler<dot>lisp file

F
File, Lisp, cl-libyaml.asd: The cl-libyaml<dot>asd file
File, Lisp, cl-libyaml/src/basic-types.lisp: The cl-libyaml/src/basic-types<dot>lisp file
File, Lisp, cl-libyaml/src/document.lisp: The cl-libyaml/src/document<dot>lisp file
File, Lisp, cl-libyaml/src/emitter.lisp: The cl-libyaml/src/emitter<dot>lisp file
File, Lisp, cl-libyaml/src/event.lisp: The cl-libyaml/src/event<dot>lisp file
File, Lisp, cl-libyaml/src/library.lisp: The cl-libyaml/src/library<dot>lisp file
File, Lisp, cl-libyaml/src/macros.lisp: The cl-libyaml/src/macros<dot>lisp file
File, Lisp, cl-libyaml/src/node.lisp: The cl-libyaml/src/node<dot>lisp file
File, Lisp, cl-libyaml/src/parser.lisp: The cl-libyaml/src/parser<dot>lisp file
File, Lisp, cl-libyaml/src/style.lisp: The cl-libyaml/src/style<dot>lisp file
File, Lisp, cl-libyaml/src/token.lisp: The cl-libyaml/src/token<dot>lisp file
File, Lisp, cl-libyaml/src/util.lisp: The cl-libyaml/src/util<dot>lisp file
File, Lisp, cl-libyaml/src/version.lisp: The cl-libyaml/src/version<dot>lisp file
File, Lisp, cl-libyaml/src/write-handler.lisp: The cl-libyaml/src/write-handler<dot>lisp file

L
Lisp File, cl-libyaml.asd: The cl-libyaml<dot>asd file
Lisp File, cl-libyaml/src/basic-types.lisp: The cl-libyaml/src/basic-types<dot>lisp file
Lisp File, cl-libyaml/src/document.lisp: The cl-libyaml/src/document<dot>lisp file
Lisp File, cl-libyaml/src/emitter.lisp: The cl-libyaml/src/emitter<dot>lisp file
Lisp File, cl-libyaml/src/event.lisp: The cl-libyaml/src/event<dot>lisp file
Lisp File, cl-libyaml/src/library.lisp: The cl-libyaml/src/library<dot>lisp file
Lisp File, cl-libyaml/src/macros.lisp: The cl-libyaml/src/macros<dot>lisp file
Lisp File, cl-libyaml/src/node.lisp: The cl-libyaml/src/node<dot>lisp file
Lisp File, cl-libyaml/src/parser.lisp: The cl-libyaml/src/parser<dot>lisp file
Lisp File, cl-libyaml/src/style.lisp: The cl-libyaml/src/style<dot>lisp file
Lisp File, cl-libyaml/src/token.lisp: The cl-libyaml/src/token<dot>lisp file
Lisp File, cl-libyaml/src/util.lisp: The cl-libyaml/src/util<dot>lisp file
Lisp File, cl-libyaml/src/version.lisp: The cl-libyaml/src/version<dot>lisp file
Lisp File, cl-libyaml/src/write-handler.lisp: The cl-libyaml/src/write-handler<dot>lisp file

M
Module, cl-libyaml/src: The cl-libyaml/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   E   F   G   I   M   P   S   T   U   W  
Index Entry  Section

A
alias-event-initialize: Internal functions
allocate-document: Exported functions
allocate-emitter: Exported functions
allocate-event: Exported functions
allocate-parser: Exported functions
allocate-token: Exported functions
allocate-version-directive: Exported functions

D
define-size-t: Internal macros
document-delete: Exported functions
document-end-event-initialize: Exported functions
document-start-event-initialize: Exported functions

E
emit: Exported functions
emitter-close: Exported functions
emitter-delete: Exported functions
emitter-dump: Exported functions
emitter-flush: Exported functions
emitter-initialize: Exported functions
emitter-open: Exported functions
error-column: Exported functions
error-line: Exported functions
error-message: Exported functions
event-alias-data: Exported functions
event-delete: Exported functions
event-mapping-start-data: Exported functions
event-scalar-data: Exported functions
event-sequence-start-data: Exported functions
event-type: Exported functions

F
Function, alias-event-initialize: Internal functions
Function, allocate-document: Exported functions
Function, allocate-emitter: Exported functions
Function, allocate-event: Exported functions
Function, allocate-parser: Exported functions
Function, allocate-token: Exported functions
Function, allocate-version-directive: Exported functions
Function, document-delete: Exported functions
Function, document-end-event-initialize: Exported functions
Function, document-start-event-initialize: Exported functions
Function, emit: Exported functions
Function, emitter-close: Exported functions
Function, emitter-delete: Exported functions
Function, emitter-dump: Exported functions
Function, emitter-flush: Exported functions
Function, emitter-initialize: Exported functions
Function, emitter-open: Exported functions
Function, error-column: Exported functions
Function, error-line: Exported functions
Function, error-message: Exported functions
Function, event-alias-data: Exported functions
Function, event-delete: Exported functions
Function, event-mapping-start-data: Exported functions
Function, event-scalar-data: Exported functions
Function, event-sequence-start-data: Exported functions
Function, event-type: Exported functions
Function, get-version-string: Exported functions
Function, initialize: Exported functions
Function, mapping-end-event-initialize: Exported functions
Function, mapping-start-event-initialize: Exported functions
Function, mapping-start-pointer: Internal functions
Function, mark-column: Exported functions
Function, mark-line: Exported functions
Function, parse: Exported functions
Function, parser-delete: Exported functions
Function, parser-error: Exported functions
Function, parser-load: Exported functions
Function, scalar-event-initialize: Exported functions
Function, scalar-pointer: Internal functions
Function, scan: Exported functions
Function, sequence-end-event-initialize: Exported functions
Function, sequence-start-event-initialize: Exported functions
Function, sequence-start-pointer: Internal functions
Function, set-encoding: Exported functions
Function, set-input: Exported functions
Function, set-input-file: Exported functions
Function, set-input-string: Exported functions
Function, set-output: Exported functions
Function, set-output-file: Exported functions
Function, set-output-string: Exported functions
Function, stream-end-event-initialize: Exported functions
Function, stream-start-event-initialize: Exported functions
Function, strlen: Internal functions
Function, token-delete: Exported functions
Function, token-type: Exported functions
Function, union-pointer: Internal functions

G
get-version-string: Exported functions

I
initialize: Exported functions

M
Macro, define-size-t: Internal macros
Macro, with-event: Exported macros
Macro, with-parser: Exported macros
mapping-end-event-initialize: Exported functions
mapping-start-event-initialize: Exported functions
mapping-start-pointer: Internal functions
mark-column: Exported functions
mark-line: Exported functions

P
parse: Exported functions
parser-delete: Exported functions
parser-error: Exported functions
parser-load: Exported functions

S
scalar-event-initialize: Exported functions
scalar-pointer: Internal functions
scan: Exported functions
sequence-end-event-initialize: Exported functions
sequence-start-event-initialize: Exported functions
sequence-start-pointer: Internal functions
set-encoding: Exported functions
set-input: Exported functions
set-input-file: Exported functions
set-input-string: Exported functions
set-output: Exported functions
set-output-file: Exported functions
set-output-string: Exported functions
stream-end-event-initialize: Exported functions
stream-start-event-initialize: Exported functions
strlen: Internal functions

T
token-delete: Exported functions
token-type: Exported functions

U
union-pointer: Internal functions

W
with-event: Exported macros
with-parser: Exported macros

Jump to:   A   D   E   F   G   I   M   P   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*write-handler-callback*: Exported special variables
*write-handler-stream*: Exported special variables

S
Special Variable, *write-handler-callback*: Exported special variables
Special Variable, *write-handler-stream*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   B   C   D   E   I   L   M   N   O   P   R   S   T   V  
Index Entry  Section

A
alias-data-t-tclass: Internal classes
alias-t-tclass: Internal classes
alias-t-tclass: Internal classes
aliases-t-tclass: Internal classes
anchor-data-t-tclass: Internal classes
anchor-info-t-tclass: Internal classes
anchor-t-tclass: Internal classes

B
buffer-t-tclass: Internal classes

C
cl-libyaml: The cl-libyaml system
Class, alias-data-t-tclass: Internal classes
Class, alias-t-tclass: Internal classes
Class, alias-t-tclass: Internal classes
Class, aliases-t-tclass: Internal classes
Class, anchor-data-t-tclass: Internal classes
Class, anchor-info-t-tclass: Internal classes
Class, anchor-t-tclass: Internal classes
Class, buffer-t-tclass: Internal classes
Class, document-end-t-tclass: Internal classes
Class, document-start-t-tclass: Internal classes
Class, document-t-tclass: Internal classes
Class, emitter-states-stack-t-tclass: Internal classes
Class, emitter-t-tclass: Internal classes
Class, event-queue-t-tclass: Internal classes
Class, event-t-tclass: Internal classes
Class, indent-stack-t-tclass: Internal classes
Class, indent-stack-t-tclass: Internal classes
Class, item-stack-t-tclass: Internal classes
Class, mapping-start-t-tclass: Internal classes
Class, mapping-t-tclass: Internal classes
Class, mark-t-tclass: Internal classes
Class, node-t-tclass: Internal classes
Class, nodes-t-tclass: Internal classes
Class, output-string-t-tclass: Internal classes
Class, pair-stack-t-tclass: Internal classes
Class, pair-t-tclass: Internal classes
Class, parser-buffer-t-tclass: Internal classes
Class, parser-input-string-t-tclass: Internal classes
Class, parser-marks-stack-t-tclass: Internal classes
Class, parser-raw-buffer-t-tclass: Internal classes
Class, parser-states-stack-t-tclass: Internal classes
Class, parser-t-tclass: Internal classes
Class, raw-buffer-t-tclass: Internal classes
Class, scalar-data-t-tclass: Internal classes
Class, scalar-t-tclass: Internal classes
Class, scalar-t-tclass: Internal classes
Class, scalar-t-tclass: Internal classes
Class, sequence-start-t-tclass: Internal classes
Class, sequence-t-tclass: Internal classes
Class, simple-key-stack-t-tclass: Internal classes
Class, simple-key-t-tclass: Internal classes
Class, stream-start-t-tclass: Internal classes
Class, stream-start-t-tclass: Internal classes
Class, tag-data-t-tclass: Internal classes
Class, tag-directive-t-tclass: Internal classes
Class, tag-directive-t-tclass: Internal classes
Class, tag-directives-t-tclass: Internal classes
Class, tag-directives-t-tclass: Internal classes
Class, tag-directives-t-tclass: Internal classes
Class, tag-directives-t-tclass: Internal classes
Class, tag-t-tclass: Internal classes
Class, token-queue-t-tclass: Internal classes
Class, token-t-tclass: Internal classes
Class, version-directive-t-tclass: Internal classes
Class, version-directive-t-tclass: Internal classes
Class, version-directive-t-tclass: Internal classes

D
document-end-t-tclass: Internal classes
document-start-t-tclass: Internal classes
document-t-tclass: Internal classes

E
emitter-states-stack-t-tclass: Internal classes
emitter-t-tclass: Internal classes
event-queue-t-tclass: Internal classes
event-t-tclass: Internal classes

I
indent-stack-t-tclass: Internal classes
indent-stack-t-tclass: Internal classes
item-stack-t-tclass: Internal classes

L
libyaml.basic: The libyaml<dot>basic package
libyaml.document: The libyaml<dot>document package
libyaml.emitter: The libyaml<dot>emitter package
libyaml.event: The libyaml<dot>event package
libyaml.lib: The libyaml<dot>lib package
libyaml.macros: The libyaml<dot>macros package
libyaml.node: The libyaml<dot>node package
libyaml.parser: The libyaml<dot>parser package
libyaml.style: The libyaml<dot>style package
libyaml.token: The libyaml<dot>token package
libyaml.util: The libyaml<dot>util package
libyaml.version: The libyaml<dot>version package
libyaml.write-handler: The libyaml<dot>write-handler package

M
mapping-start-t-tclass: Internal classes
mapping-t-tclass: Internal classes
mark-t-tclass: Internal classes

N
node-t-tclass: Internal classes
nodes-t-tclass: Internal classes

O
output-string-t-tclass: Internal classes

P
Package, libyaml.basic: The libyaml<dot>basic package
Package, libyaml.document: The libyaml<dot>document package
Package, libyaml.emitter: The libyaml<dot>emitter package
Package, libyaml.event: The libyaml<dot>event package
Package, libyaml.lib: The libyaml<dot>lib package
Package, libyaml.macros: The libyaml<dot>macros package
Package, libyaml.node: The libyaml<dot>node package
Package, libyaml.parser: The libyaml<dot>parser package
Package, libyaml.style: The libyaml<dot>style package
Package, libyaml.token: The libyaml<dot>token package
Package, libyaml.util: The libyaml<dot>util package
Package, libyaml.version: The libyaml<dot>version package
Package, libyaml.write-handler: The libyaml<dot>write-handler package
pair-stack-t-tclass: Internal classes
pair-t-tclass: Internal classes
parser-buffer-t-tclass: Internal classes
parser-input-string-t-tclass: Internal classes
parser-marks-stack-t-tclass: Internal classes
parser-raw-buffer-t-tclass: Internal classes
parser-states-stack-t-tclass: Internal classes
parser-t-tclass: Internal classes

R
raw-buffer-t-tclass: Internal classes

S
scalar-data-t-tclass: Internal classes
scalar-t-tclass: Internal classes
scalar-t-tclass: Internal classes
scalar-t-tclass: Internal classes
sequence-start-t-tclass: Internal classes
sequence-t-tclass: Internal classes
simple-key-stack-t-tclass: Internal classes
simple-key-t-tclass: Internal classes
stream-start-t-tclass: Internal classes
stream-start-t-tclass: Internal classes
System, cl-libyaml: The cl-libyaml system

T
tag-data-t-tclass: Internal classes
tag-directive-t-tclass: Internal classes
tag-directive-t-tclass: Internal classes
tag-directives-t-tclass: Internal classes
tag-directives-t-tclass: Internal classes
tag-directives-t-tclass: Internal classes
tag-directives-t-tclass: Internal classes
tag-t-tclass: Internal classes
token-queue-t-tclass: Internal classes
token-t-tclass: Internal classes

V
version-directive-t-tclass: Internal classes
version-directive-t-tclass: Internal classes
version-directive-t-tclass: Internal classes

Jump to:   A   B   C   D   E   I   L   M   N   O   P   R   S   T   V