The kdl Reference Manual

This is the kdl Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 05:33:16 2023 GMT+0.

Table of Contents


1 Systems

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


1.1 kdl

A reader and printer for KDL documents.

Author

chee <>

License

MIT-0

Version

1.0

Dependencies
  • uiop (system).
  • esrap (system).
  • parse-number (system).
Source

kdl.asd.

Child Components

2 Files

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


2.1 Lisp


2.1.1 kdl/kdl.asd

Source

kdl.asd.

Parent Component

kdl (system).

ASDF Systems

kdl.


2.1.2 kdl/package.lisp

Source

kdl.asd.

Parent Component

kdl (system).

Packages

2.1.3 kdl/api.lisp

Dependency

package.lisp (file).

Source

kdl.asd.

Parent Component

kdl (system).

Public Interface

2.1.4 kdl/read.lisp

Dependency

package.lisp (file).

Source

kdl.asd.

Parent Component

kdl (system).

Internals

2.1.5 kdl/print.lisp

Dependencies
Source

kdl.asd.

Parent Component

kdl (system).

Internals

2.1.6 kdl/io.lisp

Dependencies
Source

kdl.asd.

Parent Component

kdl (system).

Public Interface

3 Packages

Packages are listed by definition order.


3.1 kdl-user

Source

package.lisp.

Use List
  • common-lisp.
  • kdl.

3.2 kdl

Source

package.lisp.

Use List
  • common-lisp.
  • esrap.
Used By List

kdl-user.

Public Interface
Internals

4 Definitions

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


4.1 Public Interface


4.1.1 Ordinary functions

Function: from-file (filespec)
Package

kdl.

Source

io.lisp.

Function: from-stream (&optional stream)

Read the kdl file on STREAM into lisp structures.

Package

kdl.

Source

io.lisp.

Function: from-string (string)
Package

kdl.

Source

io.lisp.

Function: node-child (node n)
Package

kdl.

Source

api.lisp.

Function: node-children (node)
Package

kdl.

Source

api.lisp.

Function: node-name (node)
Package

kdl.

Source

api.lisp.

Function: node-properties (node)
Package

kdl.

Source

api.lisp.

Function: node-type (node)
Package

kdl.

Source

api.lisp.

Function: property-name (property)
Package

kdl.

Source

api.lisp.

Function: property-type (property)
Package

kdl.

Source

api.lisp.

Function: property-value (property)
Package

kdl.

Source

api.lisp.

Function: to-file (document filespec)

Format kdl DOCUMENT into a file.

Package

kdl.

Source

io.lisp.

Function: to-stream (document &optional stream)

Format kdl DOCUMENT to OUTPUT-STREAM.

Package

kdl.

Source

io.lisp.

Function: to-string (document)

Format kdl DOCUMENT as a string.

Package

kdl.

Source

io.lisp.

Function: value (value)
Package

kdl.

Source

api.lisp.

Function: value-type (value)
Package

kdl.

Source

api.lisp.


4.1.2 Generic functions

Generic Function: (setf node-child) (node n)
Package

kdl.

Methods
Method: (setf node-child) (node n)
Source

api.lisp.

Generic Function: (setf node-name) (node)
Package

kdl.

Methods
Method: (setf node-name) (node)
Source

api.lisp.

Generic Function: (setf node-type) (node)
Package

kdl.

Methods
Method: (setf node-type) (node)
Source

api.lisp.

Generic Function: (setf property-name) (property)
Package

kdl.

Methods
Method: (setf property-name) (property)
Source

api.lisp.

Generic Function: (setf property-type) (property)
Package

kdl.

Methods
Method: (setf property-type) (property)
Source

api.lisp.

Generic Function: (setf property-value) (property)
Package

kdl.

Methods
Method: (setf property-value) (property)
Source

api.lisp.

Generic Function: read-document (stream)
Package

kdl.

Methods
Method: read-document ((filespec pathname))

Read kdl document from the file at path FILESPEC.

Source

io.lisp.

Method: read-document ((string string))

Read kdl document from STRING.

Source

io.lisp.

Method: read-document ((stream stream))

Read kdl document from STREAM.

Source

io.lisp.

Generic Function: (setf value) (value)
Package

kdl.

Methods
Method: (setf value) (value)
Source

api.lisp.

Generic Function: (setf value-type) (value)
Package

kdl.

Methods
Method: (setf value-type) (value)
Source

api.lisp.


4.2 Internals


4.2.1 Special variables

Special Variable: *escape-map*
Package

kdl.

Source

read.lisp.

Special Variable: *indent*
Package

kdl.

Source

print.lisp.

Special Variable: *parse-keywords-as-keywords*
Package

kdl.

Source

read.lisp.


4.2.2 Macros

Macro: string=case (keyform &body cases)
Package

kdl.

Source

read.lisp.


4.2.3 Ordinary functions

Function: apply-sign (maybe-sign number)
Package

kdl.

Source

read.lisp.

Function: bare-identifier-p (string)
Package

kdl.

Source

read.lisp.

Function: code-chars (codes)
Package

kdl.

Source

read.lisp.

Function: collect-raw-string-contents (string+ string-start-delimiter)
Package

kdl.

Source

read.lisp.

Function: fledge (nodes)
Package

kdl.

Source

read.lisp.

Function: identifier-char-p (char)
Package

kdl.

Source

read.lisp.

Function: parse-bare-identifier (text position end)
Package

kdl.

Source

read.lisp.

Function: parse-document (document)
Package

kdl.

Source

read.lisp.

Function: parse-initial-char (text position end)
Package

kdl.

Source

read.lisp.

Function: parse-raw-string (text position end)
Package

kdl.

Source

read.lisp.

Function: print-children (children)
Package

kdl.

Source

print.lisp.

Function: print-identifier (identifier)
Package

kdl.

Source

print.lisp.

Function: print-indent ()
Package

kdl.

Source

print.lisp.

Function: print-node (node)
Package

kdl.

Source

print.lisp.

Function: print-property (property)
Package

kdl.

Source

print.lisp.

Function: print-type (type)
Package

kdl.

Source

print.lisp.

Function: print-value (value)
Package

kdl.

Source

print.lisp.

Function: range (min max)
Package

kdl.

Source

read.lisp.

Function: reduce-number (number-list)
Package

kdl.

Source

read.lisp.

Function: replace-escapes (string)
Package

kdl.

Source

print.lisp.

Function: sign-function (maybe-sign)
Package

kdl.

Source

read.lisp.

Function: subseq-recklessly (sequence start end)
Package

kdl.

Source

read.lisp.

Function: underscorep (char)
Package

kdl.

Source

read.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   F   G   I   M   N   P   R   S   T   U   V  
Index Entry  Section

(
(setf node-child): Public generic functions
(setf node-child): Public generic functions
(setf node-name): Public generic functions
(setf node-name): Public generic functions
(setf node-type): Public generic functions
(setf node-type): Public generic functions
(setf property-name): Public generic functions
(setf property-name): Public generic functions
(setf property-type): Public generic functions
(setf property-type): Public generic functions
(setf property-value): Public generic functions
(setf property-value): Public generic functions
(setf value): Public generic functions
(setf value): Public generic functions
(setf value-type): Public generic functions
(setf value-type): Public generic functions

A
apply-sign: Private ordinary functions

B
bare-identifier-p: Private ordinary functions

C
code-chars: Private ordinary functions
collect-raw-string-contents: Private ordinary functions

F
fledge: Private ordinary functions
from-file: Public ordinary functions
from-stream: Public ordinary functions
from-string: Public ordinary functions
Function, apply-sign: Private ordinary functions
Function, bare-identifier-p: Private ordinary functions
Function, code-chars: Private ordinary functions
Function, collect-raw-string-contents: Private ordinary functions
Function, fledge: Private ordinary functions
Function, from-file: Public ordinary functions
Function, from-stream: Public ordinary functions
Function, from-string: Public ordinary functions
Function, identifier-char-p: Private ordinary functions
Function, node-child: Public ordinary functions
Function, node-children: Public ordinary functions
Function, node-name: Public ordinary functions
Function, node-properties: Public ordinary functions
Function, node-type: Public ordinary functions
Function, parse-bare-identifier: Private ordinary functions
Function, parse-document: Private ordinary functions
Function, parse-initial-char: Private ordinary functions
Function, parse-raw-string: Private ordinary functions
Function, print-children: Private ordinary functions
Function, print-identifier: Private ordinary functions
Function, print-indent: Private ordinary functions
Function, print-node: Private ordinary functions
Function, print-property: Private ordinary functions
Function, print-type: Private ordinary functions
Function, print-value: Private ordinary functions
Function, property-name: Public ordinary functions
Function, property-type: Public ordinary functions
Function, property-value: Public ordinary functions
Function, range: Private ordinary functions
Function, reduce-number: Private ordinary functions
Function, replace-escapes: Private ordinary functions
Function, sign-function: Private ordinary functions
Function, subseq-recklessly: Private ordinary functions
Function, to-file: Public ordinary functions
Function, to-stream: Public ordinary functions
Function, to-string: Public ordinary functions
Function, underscorep: Private ordinary functions
Function, value: Public ordinary functions
Function, value-type: Public ordinary functions

G
Generic Function, (setf node-child): Public generic functions
Generic Function, (setf node-name): Public generic functions
Generic Function, (setf node-type): Public generic functions
Generic Function, (setf property-name): Public generic functions
Generic Function, (setf property-type): Public generic functions
Generic Function, (setf property-value): Public generic functions
Generic Function, (setf value): Public generic functions
Generic Function, (setf value-type): Public generic functions
Generic Function, read-document: Public generic functions

I
identifier-char-p: Private ordinary functions

M
Macro, string=case: Private macros
Method, (setf node-child): Public generic functions
Method, (setf node-name): Public generic functions
Method, (setf node-type): Public generic functions
Method, (setf property-name): Public generic functions
Method, (setf property-type): Public generic functions
Method, (setf property-value): Public generic functions
Method, (setf value): Public generic functions
Method, (setf value-type): Public generic functions
Method, read-document: Public generic functions
Method, read-document: Public generic functions
Method, read-document: Public generic functions

N
node-child: Public ordinary functions
node-children: Public ordinary functions
node-name: Public ordinary functions
node-properties: Public ordinary functions
node-type: Public ordinary functions

P
parse-bare-identifier: Private ordinary functions
parse-document: Private ordinary functions
parse-initial-char: Private ordinary functions
parse-raw-string: Private ordinary functions
print-children: Private ordinary functions
print-identifier: Private ordinary functions
print-indent: Private ordinary functions
print-node: Private ordinary functions
print-property: Private ordinary functions
print-type: Private ordinary functions
print-value: Private ordinary functions
property-name: Public ordinary functions
property-type: Public ordinary functions
property-value: Public ordinary functions

R
range: Private ordinary functions
read-document: Public generic functions
read-document: Public generic functions
read-document: Public generic functions
read-document: Public generic functions
reduce-number: Private ordinary functions
replace-escapes: Private ordinary functions

S
sign-function: Private ordinary functions
string=case: Private macros
subseq-recklessly: Private ordinary functions

T
to-file: Public ordinary functions
to-stream: Public ordinary functions
to-string: Public ordinary functions

U
underscorep: Private ordinary functions

V
value: Public ordinary functions
value-type: Public ordinary functions