The cl-xmlspam Reference Manual

This is the cl-xmlspam Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:42:04 2020 GMT+0.

1 Systems

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

1.1 `cl-xmlspam`

Maintainer

Roger Peppe

Author

Roger Peppe

Description

Streaming pattern matching for XML

Dependencies

cxml
cl-ppcre

Source

cl-xmlspam.asd (file)

Component

xspam.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 `cl-xmlspam.asd`

Location: cl-xmlspam.asd
Systems: cl-xmlspam (system)
Packages: cl-xmlspam-asd

2.1.2 `cl-xmlspam/xspam.lisp`

Parent

cl-xmlspam (system)

Location

xspam.lisp

Packages

xspam

Exported Definitions

any-element (macro)
attribute (macro)
element (macro)
group (macro)
guard (macro)
guard-not (macro)
make-xspam-source (function)
match (macro)
matches (macro)
matches-not (macro)
one-of (macro)
one-or-more (macro)
optional (macro)
optional-attribute (macro)
text (macro)
with-namespace (macro)
with-xspam-context (macro)
with-xspam-source (macro)
xspam-context (macro)
xspam-source (macro)
zero-or-more (macro)

Internal Definitions

*debug* (special variable)
*names* (special variable)
attribute0 (function)
calcfirst (function)
compile-time-error (macro)
copy-node (function)
copy-xspam-context-holder (function)
current-attributes (function)
current-depth (method)
(setf current-depth) (method)
current-in-set (function)
current-in-set0 (function)
current-info (function)
current-seqno (method)
(setf current-seqno) (method)
debugp (macro)
end-section? (method)
(setf end-section?) (method)
expected (function)
expr (function)
expr0 (function)
finish-section (function)
gather-characters (function)
get-next (function)
let*-ignorable (macro)
let-ignorable (macro)
make-adjustable (function)
make-lname (function)
make-node (function)
make-nodes (function)
make-qname (function)
make-qname0 (function)
make-set (function)
make-xspam-context-holder (function)
name-to-pname (function)
name-to-unique (function)
need-close (method)
(setf need-close) (method)
node (structure)
node-code (function)
(setf node-code) (function)
node-first (function)
(setf node-first) (function)
node-follow (function)
(setf node-follow) (function)
node-left (function)
(setf node-left) (function)
node-name (function)
(setf node-name) (function)
node-p (function)
node-right (function)
(setf node-right) (function)
node-type (function)
(setf node-type) (function)
normalised-symbol-name (function)
parse-enter (function)
parse-leave (function)
parse-stack (method)
(setf parse-stack) (method)
pass-through (macro)
set-add (function)
set-in (function)
set-union (function)
set2s (function)
skip-element (function)
skip-level (method)
(setf skip-level) (method)
skip-to-end (function)
skip-until-first (function)
symbol-to-pname (function)
text-binds (macro)
upstream-source (method)
(setf upstream-source) (method)
xsource (class)
xspam-context-holder (structure)
xspam-context-holder-namespace (function)
(setf xspam-context-holder-namespace) (function)
xspam-context-holder-p (function)
xspam-context-holder-source (function)
(setf xspam-context-holder-source) (function)
xspam-context-holder-text (function)
(setf xspam-context-holder-text) (function)
xspam-context-holder-text-end (function)
(setf xspam-context-holder-text-end) (function)
xspam-context-holder-text-start (function)
(setf xspam-context-holder-text-start) (function)

3 Packages

Packages are listed by definition order.

3.1 `cl-xmlspam-asd`

Source

cl-xmlspam.asd

Use List

asdf/interface
common-lisp

3.2 `xspam`

Source

xspam.lisp (file)

Use List

common-lisp

Exported Definitions

any-element (macro)
attribute (macro)
element (macro)
group (macro)
guard (macro)
guard-not (macro)
make-xspam-source (function)
match (macro)
matches (macro)
matches-not (macro)
one-of (macro)
one-or-more (macro)
optional (macro)
optional-attribute (macro)
text (macro)
with-namespace (macro)
with-xspam-context (macro)
with-xspam-source (macro)
xspam-context (macro)
xspam-source (macro)
zero-or-more (macro)

Internal Definitions

*debug* (special variable)
*names* (special variable)
attribute0 (function)
calcfirst (function)
compile-time-error (macro)
copy-node (function)
copy-xspam-context-holder (function)
current-attributes (function)
current-depth (generic function)
current-depth (method)
(setf current-depth) (method)
(setf current-depth) (generic function)
current-in-set (function)
current-in-set0 (function)
current-info (function)
current-seqno (generic function)
current-seqno (method)
(setf current-seqno) (method)
(setf current-seqno) (generic function)
debugp (macro)
end-section? (generic function)
end-section? (method)
(setf end-section?) (method)
(setf end-section?) (generic function)
expected (function)
expr (function)
expr0 (function)
finish-section (function)
gather-characters (function)
get-next (function)
let*-ignorable (macro)
let-ignorable (macro)
make-adjustable (function)
make-lname (function)
make-node (function)
make-nodes (function)
make-qname (function)
make-qname0 (function)
make-set (function)
make-xspam-context-holder (function)
name-to-pname (function)
name-to-unique (function)
need-close (generic function)
need-close (method)
(setf need-close) (method)
(setf need-close) (generic function)
node (structure)
node-code (function)
(setf node-code) (function)
node-first (function)
(setf node-first) (function)
node-follow (function)
(setf node-follow) (function)
node-left (function)
(setf node-left) (function)
node-name (function)
(setf node-name) (function)
node-p (function)
node-right (function)
(setf node-right) (function)
node-type (function)
(setf node-type) (function)
normalised-symbol-name (function)
parse-enter (function)
parse-leave (function)
parse-stack (generic function)
parse-stack (method)
(setf parse-stack) (method)
(setf parse-stack) (generic function)
pass-through (macro)
set-add (function)
set-in (function)
set-union (function)
set2s (function)
skip-element (function)
skip-level (generic function)
skip-level (method)
(setf skip-level) (method)
(setf skip-level) (generic function)
skip-to-end (function)
skip-until-first (function)
symbol-to-pname (function)
text-binds (macro)
upstream-source (generic function)
upstream-source (method)
(setf upstream-source) (method)
(setf upstream-source) (generic function)
xsource (class)
xspam-context-holder (structure)
xspam-context-holder-namespace (function)
(setf xspam-context-holder-namespace) (function)
xspam-context-holder-p (function)
xspam-context-holder-source (function)
(setf xspam-context-holder-source) (function)
xspam-context-holder-text (function)
(setf xspam-context-holder-text) (function)
xspam-context-holder-text-end (function)
(setf xspam-context-holder-text-end) (function)
xspam-context-holder-text-start (function)
(setf xspam-context-holder-text-start) (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: any-element &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: attribute NAME &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: element NAME &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: group &rest NODES

Package: xspam
Source: xspam.lisp (file)

Macro: guard REGEX &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: guard-not REGEX &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: match REGEX &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: matches REGEX &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: matches-not REGEX &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: one-of &rest NODES

Package: xspam
Source: xspam.lisp (file)

Macro: one-or-more NODE

Package: xspam
Source: xspam.lisp (file)

Macro: optional NODE

Package: xspam
Source: xspam.lisp (file)

Macro: optional-attribute NAME &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: text &rest NODES

Package: xspam
Source: xspam.lisp (file)

Macro: with-namespace NAMES &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: with-xspam-context (VAR &rest KINDS) &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: with-xspam-source SRC &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: xspam-context &rest KINDS

Package: xspam
Source: xspam.lisp (file)

Macro: xspam-source ()

Package: xspam
Source: xspam.lisp (file)

Macro: zero-or-more NODE

Package: xspam
Source: xspam.lisp (file)

4.1.2 Functions

Function: make-xspam-source SRC &rest ARGS

Package: xspam
Source: xspam.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *debug*

Package: xspam
Source: xspam.lisp (file)

Special Variable: *names*

Package: xspam
Source: xspam.lisp (file)

4.2.2 Macros

Macro: compile-time-error &rest ARGS

Package: xspam
Source: xspam.lisp (file)

Macro: debugp &rest ARGS

Package: xspam
Source: xspam.lisp (file)

Macro: let*-ignorable DECL &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: let-ignorable DECL &body BODY

Package: xspam
Source: xspam.lisp (file)

Macro: pass-through &rest MS

Package: xspam
Source: xspam.lisp (file)

Macro: text-binds WITH-MATCHES &body BODY

Package: xspam
Source: xspam.lisp (file)

4.2.3 Functions

Function: attribute0 NAME BODY OPTIONAL

Package: xspam
Source: xspam.lisp (file)

Function: calcfirst N FOLLOW

Package: xspam
Source: xspam.lisp (file)

Function: copy-node INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: copy-xspam-context-holder INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: current-attributes SOURCE NAMESPACE

Package: xspam
Source: xspam.lisp (file)

Function: current-in-set SRC S NAMESPACE

Package: xspam
Source: xspam.lisp (file)

Function: current-in-set0 SRC S NAMESPACE

Package: xspam
Source: xspam.lisp (file)

Function: current-info SRC

Package: xspam
Source: xspam.lisp (file)

Function: expected SRC S

Package: xspam
Source: xspam.lisp (file)

Function: expr FORM ENV

Package: xspam
Source: xspam.lisp (file)

Function: expr0 N

Package: xspam
Source: xspam.lisp (file)

Function: finish-section SRC

Package: xspam
Source: xspam.lisp (file)

Function: gather-characters SRC

Package: xspam
Source: xspam.lisp (file)

Function: get-next SRC

Package: xspam
Source: xspam.lisp (file)

Function: make-adjustable S

Package: xspam
Source: xspam.lisp (file)

Function: make-lname SPEC ELEMENT?

Package: xspam
Source: xspam.lisp (file)

Function: make-node &key (TYPE TYPE) (FIRST FIRST) (FOLLOW FOLLOW) (LEFT LEFT) (RIGHT RIGHT) (NAME NAME) (CODE CODE)

Package: xspam
Source: xspam.lisp (file)

Function: make-nodes FORM ENV

Package: xspam
Source: xspam.lisp (file)

Function: make-qname URI NAME NAMESPACE

Package: xspam
Source: xspam.lisp (file)

Function: make-qname0 URI NAME NAMESPACE

Package: xspam
Source: xspam.lisp (file)

Function: make-set &rest VALS

Package: xspam
Source: xspam.lisp (file)

Function: make-xspam-context-holder &key (SOURCE SOURCE) (TEXT TEXT) (TEXT-START TEXT-START) (TEXT-END TEXT-END) (NAMESPACE NAMESPACE)

Package: xspam
Source: xspam.lisp (file)

Function: name-to-pname SPEC

Package: xspam
Source: xspam.lisp (file)

Function: name-to-unique PNAME

Package: xspam
Source: xspam.lisp (file)

Function: node-code INSTANCE

Function: (setf node-code) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: node-first INSTANCE

Function: (setf node-first) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: node-follow INSTANCE

Function: (setf node-follow) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: node-left INSTANCE

Function: (setf node-left) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: node-name INSTANCE

Function: (setf node-name) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: node-p OBJECT

Package: xspam
Source: xspam.lisp (file)

Function: node-right INSTANCE

Function: (setf node-right) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: node-type INSTANCE

Function: (setf node-type) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: normalised-symbol-name SYM

Package: xspam
Source: xspam.lisp (file)

Function: parse-enter SRC

Package: xspam
Source: xspam.lisp (file)

Function: parse-leave SRC

Package: xspam
Source: xspam.lisp (file)

Function: set-add V S

Package: xspam
Source: xspam.lisp (file)

Function: set-in V S

Package: xspam
Source: xspam.lisp (file)

Function: set-union S1 S2

Package: xspam
Source: xspam.lisp (file)

Function: set2s S

Package: xspam
Source: xspam.lisp (file)

Function: skip-element SRC

Package: xspam
Source: xspam.lisp (file)

Function: skip-to-end SRC

Package: xspam
Source: xspam.lisp (file)

Function: skip-until-first SRC FIRST NAMESPACE

Package: xspam
Source: xspam.lisp (file)

Function: symbol-to-pname SYM ELEMENT?

symbol -> (string . string)

Package: xspam
Source: xspam.lisp (file)

Function: xspam-context-holder-namespace INSTANCE

Function: (setf xspam-context-holder-namespace) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: xspam-context-holder-p OBJECT

Package: xspam
Source: xspam.lisp (file)

Function: xspam-context-holder-source INSTANCE

Function: (setf xspam-context-holder-source) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: xspam-context-holder-text INSTANCE

Function: (setf xspam-context-holder-text) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: xspam-context-holder-text-end INSTANCE

Function: (setf xspam-context-holder-text-end) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

Function: xspam-context-holder-text-start INSTANCE

Function: (setf xspam-context-holder-text-start) VALUE INSTANCE

Package: xspam
Source: xspam.lisp (file)

4.2.4 Generic functions

Generic Function: current-depth OBJECT

Generic Function: (setf current-depth) NEW-VALUE OBJECT

Package

xspam

Methods

Method: current-depth (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf current-depth) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

Generic Function: current-seqno OBJECT

Generic Function: (setf current-seqno) NEW-VALUE OBJECT

Package

xspam

Methods

Method: current-seqno (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf current-seqno) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

Generic Function: end-section? OBJECT

Generic Function: (setf end-section?) NEW-VALUE OBJECT

Package

xspam

Methods

Method: end-section? (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf end-section?) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

Generic Function: need-close OBJECT

Generic Function: (setf need-close) NEW-VALUE OBJECT

Package

xspam

Methods

Method: need-close (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf need-close) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

Generic Function: parse-stack OBJECT

Generic Function: (setf parse-stack) NEW-VALUE OBJECT

Package

xspam

Methods

Method: parse-stack (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf parse-stack) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

Generic Function: skip-level OBJECT

Generic Function: (setf skip-level) NEW-VALUE OBJECT

Package

xspam

Methods

Method: skip-level (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf skip-level) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

Generic Function: upstream-source OBJECT

Generic Function: (setf upstream-source) NEW-VALUE OBJECT

Package

xspam

Methods

Method: upstream-source (XSOURCE xsource)

automatically generated reader method

Source: xspam.lisp (file)

Method: (setf upstream-source) NEW-VALUE (XSOURCE xsource)

automatically generated writer method

Source: xspam.lisp (file)

4.2.5 Structures

Structure: node ()

Package

xspam

Source

xspam.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: type

Readers: node-type (function)
Writers: (setf node-type) (function)

Slot: first

Readers: node-first (function)
Writers: (setf node-first) (function)

Slot: follow

Readers: node-follow (function)
Writers: (setf node-follow) (function)

Slot: left

Readers: node-left (function)
Writers: (setf node-left) (function)

Slot: right

Readers: node-right (function)
Writers: (setf node-right) (function)

Slot: name

Readers: node-name (function)
Writers: (setf node-name) (function)

Slot: code

Readers: node-code (function)
Writers: (setf node-code) (function)

Structure: xspam-context-holder ()

Package

xspam

Source

xspam.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: source

Readers: xspam-context-holder-source (function)
Writers: (setf xspam-context-holder-source) (function)

Slot: text

Readers: xspam-context-holder-text (function)
Writers: (setf xspam-context-holder-text) (function)

Slot: text-start

Readers: xspam-context-holder-text-start (function)
Writers: (setf xspam-context-holder-text-start) (function)

Slot: text-end

Readers: xspam-context-holder-text-end (function)
Writers: (setf xspam-context-holder-text-end) (function)

Slot: namespace

Readers: xspam-context-holder-namespace (function)
Writers: (setf xspam-context-holder-namespace) (function)

4.2.6 Classes

Class: xsource ()

Package

xspam

Source

xspam.lisp (file)

Direct superclasses

source (class)

Direct methods

consume (method)
peek-next (method)
map-current-namespace-declarations (method)
map-attributes (method)
find-namespace-binding (method)
decode-qname (method)
peek-value (method)
peek (method)
current-cdata-section-p (method)
current-xml-base (method)
current-system-id (method)
current-column-number (method)
current-line-number (method)
list-attributes (method)
close-source (method)
need-close (method)
need-close (method)
current-seqno (method)
current-seqno (method)
skip-level (method)
skip-level (method)
end-section? (method)
end-section? (method)
current-depth (method)
current-depth (method)
parse-stack (method)
parse-stack (method)
upstream-source (method)
upstream-source (method)

Direct slots

Slot: src

Initargs: :src
Readers: upstream-source (generic function)
Writers: (setf upstream-source) (generic function)

Slot: parse-stack

Initform: (list 0)
Readers: parse-stack (generic function)
Writers: (setf parse-stack) (generic function)

Slot: current-depth

Initform: 0
Readers: current-depth (generic function)
Writers: (setf current-depth) (generic function)

Slot: end-section?

Readers: end-section? (generic function)
Writers: (setf end-section?) (generic function)

Slot: skip-level

Readers: skip-level (generic function)
Writers: (setf skip-level) (generic function)

Slot: seqno

Initform: 0
Readers: current-seqno (generic function)
Writers: (setf current-seqno) (generic function)

Slot: need-close

Initargs: :need-close
Readers: need-close (generic function)
Writers: (setf need-close) (generic function)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L

	Index Entry	Section

C
	`cl-xmlspam.asd`:	The cl-xmlspam․asd file
	`cl-xmlspam/xspam.lisp`:	The cl-xmlspam/xspam․lisp file

F
	File, Lisp, `cl-xmlspam.asd`:	The cl-xmlspam․asd file
	File, Lisp, `cl-xmlspam/xspam.lisp`:	The cl-xmlspam/xspam․lisp file

L
	Lisp File, `cl-xmlspam.asd`:	The cl-xmlspam․asd file
	Lisp File, `cl-xmlspam/xspam.lisp`:	The cl-xmlspam/xspam․lisp file

Jump to:	C F L

A.2 Functions

Jump to:	( A C D E F G L M N O P S T U W X Z

	Index Entry	Section

(
	`(setf current-depth)`:	Internal generic functions
	`(setf current-depth)`:	Internal generic functions
	`(setf current-seqno)`:	Internal generic functions
	`(setf current-seqno)`:	Internal generic functions
	`(setf end-section?)`:	Internal generic functions
	`(setf end-section?)`:	Internal generic functions
	`(setf need-close)`:	Internal generic functions
	`(setf need-close)`:	Internal generic functions
	`(setf node-code)`:	Internal functions
	`(setf node-first)`:	Internal functions
	`(setf node-follow)`:	Internal functions
	`(setf node-left)`:	Internal functions
	`(setf node-name)`:	Internal functions
	`(setf node-right)`:	Internal functions
	`(setf node-type)`:	Internal functions
	`(setf parse-stack)`:	Internal generic functions
	`(setf parse-stack)`:	Internal generic functions
	`(setf skip-level)`:	Internal generic functions
	`(setf skip-level)`:	Internal generic functions
	`(setf upstream-source)`:	Internal generic functions
	`(setf upstream-source)`:	Internal generic functions
	`(setf xspam-context-holder-namespace)`:	Internal functions
	`(setf xspam-context-holder-source)`:	Internal functions
	`(setf xspam-context-holder-text)`:	Internal functions
	`(setf xspam-context-holder-text-end)`:	Internal functions
	`(setf xspam-context-holder-text-start)`:	Internal functions

A
	`any-element`:	Exported macros
	`attribute`:	Exported macros
	`attribute0`:	Internal functions

C
	`calcfirst`:	Internal functions
	`compile-time-error`:	Internal macros
	`copy-node`:	Internal functions
	`copy-xspam-context-holder`:	Internal functions
	`current-attributes`:	Internal functions
	`current-depth`:	Internal generic functions
	`current-depth`:	Internal generic functions
	`current-in-set`:	Internal functions
	`current-in-set0`:	Internal functions
	`current-info`:	Internal functions
	`current-seqno`:	Internal generic functions
	`current-seqno`:	Internal generic functions

D
	`debugp`:	Internal macros

E
	`element`:	Exported macros
	`end-section?`:	Internal generic functions
	`end-section?`:	Internal generic functions
	`expected`:	Internal functions
	`expr`:	Internal functions
	`expr0`:	Internal functions

F
	`finish-section`:	Internal functions
	`Function, (setf node-code)`:	Internal functions
	`Function, (setf node-first)`:	Internal functions
	`Function, (setf node-follow)`:	Internal functions
	`Function, (setf node-left)`:	Internal functions
	`Function, (setf node-name)`:	Internal functions
	`Function, (setf node-right)`:	Internal functions
	`Function, (setf node-type)`:	Internal functions
	`Function, (setf xspam-context-holder-namespace)`:	Internal functions
	`Function, (setf xspam-context-holder-source)`:	Internal functions
	`Function, (setf xspam-context-holder-text)`:	Internal functions
	`Function, (setf xspam-context-holder-text-end)`:	Internal functions
	`Function, (setf xspam-context-holder-text-start)`:	Internal functions
	`Function, attribute0`:	Internal functions
	`Function, calcfirst`:	Internal functions
	`Function, copy-node`:	Internal functions
	`Function, copy-xspam-context-holder`:	Internal functions
	`Function, current-attributes`:	Internal functions
	`Function, current-in-set`:	Internal functions
	`Function, current-in-set0`:	Internal functions
	`Function, current-info`:	Internal functions
	`Function, expected`:	Internal functions
	`Function, expr`:	Internal functions
	`Function, expr0`:	Internal functions
	`Function, finish-section`:	Internal functions
	`Function, gather-characters`:	Internal functions
	`Function, get-next`:	Internal functions
	`Function, make-adjustable`:	Internal functions
	`Function, make-lname`:	Internal functions
	`Function, make-node`:	Internal functions
	`Function, make-nodes`:	Internal functions
	`Function, make-qname`:	Internal functions
	`Function, make-qname0`:	Internal functions
	`Function, make-set`:	Internal functions
	`Function, make-xspam-context-holder`:	Internal functions
	`Function, make-xspam-source`:	Exported functions
	`Function, name-to-pname`:	Internal functions
	`Function, name-to-unique`:	Internal functions
	`Function, node-code`:	Internal functions
	`Function, node-first`:	Internal functions
	`Function, node-follow`:	Internal functions
	`Function, node-left`:	Internal functions
	`Function, node-name`:	Internal functions
	`Function, node-p`:	Internal functions
	`Function, node-right`:	Internal functions
	`Function, node-type`:	Internal functions
	`Function, normalised-symbol-name`:	Internal functions
	`Function, parse-enter`:	Internal functions
	`Function, parse-leave`:	Internal functions
	`Function, set-add`:	Internal functions
	`Function, set-in`:	Internal functions
	`Function, set-union`:	Internal functions
	`Function, set2s`:	Internal functions
	`Function, skip-element`:	Internal functions
	`Function, skip-to-end`:	Internal functions
	`Function, skip-until-first`:	Internal functions
	`Function, symbol-to-pname`:	Internal functions
	`Function, xspam-context-holder-namespace`:	Internal functions
	`Function, xspam-context-holder-p`:	Internal functions
	`Function, xspam-context-holder-source`:	Internal functions
	`Function, xspam-context-holder-text`:	Internal functions
	`Function, xspam-context-holder-text-end`:	Internal functions
	`Function, xspam-context-holder-text-start`:	Internal functions

G
	`gather-characters`:	Internal functions
	`Generic Function, (setf current-depth)`:	Internal generic functions
	`Generic Function, (setf current-seqno)`:	Internal generic functions
	`Generic Function, (setf end-section?)`:	Internal generic functions
	`Generic Function, (setf need-close)`:	Internal generic functions
	`Generic Function, (setf parse-stack)`:	Internal generic functions
	`Generic Function, (setf skip-level)`:	Internal generic functions
	`Generic Function, (setf upstream-source)`:	Internal generic functions
	`Generic Function, current-depth`:	Internal generic functions
	`Generic Function, current-seqno`:	Internal generic functions
	`Generic Function, end-section?`:	Internal generic functions
	`Generic Function, need-close`:	Internal generic functions
	`Generic Function, parse-stack`:	Internal generic functions
	`Generic Function, skip-level`:	Internal generic functions
	`Generic Function, upstream-source`:	Internal generic functions
	`get-next`:	Internal functions
	`group`:	Exported macros
	`guard`:	Exported macros
	`guard-not`:	Exported macros

L
	`let*-ignorable`:	Internal macros
	`let-ignorable`:	Internal macros

M
	`Macro, any-element`:	Exported macros
	`Macro, attribute`:	Exported macros
	`Macro, compile-time-error`:	Internal macros
	`Macro, debugp`:	Internal macros
	`Macro, element`:	Exported macros
	`Macro, group`:	Exported macros
	`Macro, guard`:	Exported macros
	`Macro, guard-not`:	Exported macros
	`Macro, let*-ignorable`:	Internal macros
	`Macro, let-ignorable`:	Internal macros
	`Macro, match`:	Exported macros
	`Macro, matches`:	Exported macros
	`Macro, matches-not`:	Exported macros
	`Macro, one-of`:	Exported macros
	`Macro, one-or-more`:	Exported macros
	`Macro, optional`:	Exported macros
	`Macro, optional-attribute`:	Exported macros
	`Macro, pass-through`:	Internal macros
	`Macro, text`:	Exported macros
	`Macro, text-binds`:	Internal macros
	`Macro, with-namespace`:	Exported macros
	`Macro, with-xspam-context`:	Exported macros
	`Macro, with-xspam-source`:	Exported macros
	`Macro, xspam-context`:	Exported macros
	`Macro, xspam-source`:	Exported macros
	`Macro, zero-or-more`:	Exported macros
	`make-adjustable`:	Internal functions
	`make-lname`:	Internal functions
	`make-node`:	Internal functions
	`make-nodes`:	Internal functions
	`make-qname`:	Internal functions
	`make-qname0`:	Internal functions
	`make-set`:	Internal functions
	`make-xspam-context-holder`:	Internal functions
	`make-xspam-source`:	Exported functions
	`match`:	Exported macros
	`matches`:	Exported macros
	`matches-not`:	Exported macros
	`Method, (setf current-depth)`:	Internal generic functions
	`Method, (setf current-seqno)`:	Internal generic functions
	`Method, (setf end-section?)`:	Internal generic functions
	`Method, (setf need-close)`:	Internal generic functions
	`Method, (setf parse-stack)`:	Internal generic functions
	`Method, (setf skip-level)`:	Internal generic functions
	`Method, (setf upstream-source)`:	Internal generic functions
	`Method, current-depth`:	Internal generic functions
	`Method, current-seqno`:	Internal generic functions
	`Method, end-section?`:	Internal generic functions
	`Method, need-close`:	Internal generic functions
	`Method, parse-stack`:	Internal generic functions
	`Method, skip-level`:	Internal generic functions
	`Method, upstream-source`:	Internal generic functions

N
	`name-to-pname`:	Internal functions
	`name-to-unique`:	Internal functions
	`need-close`:	Internal generic functions
	`need-close`:	Internal generic functions
	`node-code`:	Internal functions
	`node-first`:	Internal functions
	`node-follow`:	Internal functions
	`node-left`:	Internal functions
	`node-name`:	Internal functions
	`node-p`:	Internal functions
	`node-right`:	Internal functions
	`node-type`:	Internal functions
	`normalised-symbol-name`:	Internal functions

O
	`one-of`:	Exported macros
	`one-or-more`:	Exported macros
	`optional`:	Exported macros
	`optional-attribute`:	Exported macros

P
	`parse-enter`:	Internal functions
	`parse-leave`:	Internal functions
	`parse-stack`:	Internal generic functions
	`parse-stack`:	Internal generic functions
	`pass-through`:	Internal macros

S
	`set-add`:	Internal functions
	`set-in`:	Internal functions
	`set-union`:	Internal functions
	`set2s`:	Internal functions
	`skip-element`:	Internal functions
	`skip-level`:	Internal generic functions
	`skip-level`:	Internal generic functions
	`skip-to-end`:	Internal functions
	`skip-until-first`:	Internal functions
	`symbol-to-pname`:	Internal functions

T
	`text`:	Exported macros
	`text-binds`:	Internal macros

U
	`upstream-source`:	Internal generic functions
	`upstream-source`:	Internal generic functions

W
	`with-namespace`:	Exported macros
	`with-xspam-context`:	Exported macros
	`with-xspam-source`:	Exported macros

X
	`xspam-context`:	Exported macros
	`xspam-context-holder-namespace`:	Internal functions
	`xspam-context-holder-p`:	Internal functions
	`xspam-context-holder-source`:	Internal functions
	`xspam-context-holder-text`:	Internal functions
	`xspam-context-holder-text-end`:	Internal functions
	`xspam-context-holder-text-start`:	Internal functions
	`xspam-source`:	Exported macros

Z
	`zero-or-more`:	Exported macros

Jump to:	( A C D E F G L M N O P S T U W X Z

A.3 Variables

Jump to:	* C E F L N P R S T

	Index Entry	Section

*
	`debug`:	Internal special variables
	`names`:	Internal special variables

C
	`code`:	Internal structures
	`current-depth`:	Internal classes

E
	`end-section?`:	Internal classes

F
	`first`:	Internal structures
	`follow`:	Internal structures

L
	`left`:	Internal structures

N
	`name`:	Internal structures
	`namespace`:	Internal structures
	`need-close`:	Internal classes

P
	`parse-stack`:	Internal classes

R
	`right`:	Internal structures

S
	`seqno`:	Internal classes
	`skip-level`:	Internal classes
	`Slot, code`:	Internal structures
	`Slot, current-depth`:	Internal classes
	`Slot, end-section?`:	Internal classes
	`Slot, first`:	Internal structures
	`Slot, follow`:	Internal structures
	`Slot, left`:	Internal structures
	`Slot, name`:	Internal structures
	`Slot, namespace`:	Internal structures
	`Slot, need-close`:	Internal classes
	`Slot, parse-stack`:	Internal classes
	`Slot, right`:	Internal structures
	`Slot, seqno`:	Internal classes
	`Slot, skip-level`:	Internal classes
	`Slot, source`:	Internal structures
	`Slot, src`:	Internal classes
	`Slot, text`:	Internal structures
	`Slot, text-end`:	Internal structures
	`Slot, text-start`:	Internal structures
	`Slot, type`:	Internal structures
	`source`:	Internal structures
	`Special Variable, debug`:	Internal special variables
	`Special Variable, names`:	Internal special variables
	`src`:	Internal classes

T
	`text`:	Internal structures
	`text-end`:	Internal structures
	`text-start`:	Internal structures
	`type`:	Internal structures

Jump to:	* C E F L N P R S T

A.4 Data types

Jump to:	C N P S X

	Index Entry	Section

C
	`cl-xmlspam`:	The cl-xmlspam system
	`cl-xmlspam-asd`:	The cl-xmlspam-asd package
	`Class, xsource`:	Internal classes

N
	`node`:	Internal structures

P
	`Package, cl-xmlspam-asd`:	The cl-xmlspam-asd package
	`Package, xspam`:	The xspam package

S
	`Structure, node`:	Internal structures
	`Structure, xspam-context-holder`:	Internal structures
	`System, cl-xmlspam`:	The cl-xmlspam system

X
	`xsource`:	Internal classes
	`xspam`:	The xspam package
	`xspam-context-holder`:	Internal structures

Jump to:	C N P S X

• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Internal special variables
• Internal macros
• Internal functions
• Internal generic functions
• Internal structures
• Internal classes

• Concept index
• Function index
• Variable index
• Data type index

• The cl-xmlspam.asd file
• The cl-xmlspam/xspam.lisp file

The cl-xmlspam Reference Manual

Table of Contents

The cl-xmlspam Reference Manual

1 Systems

1.1 cl-xmlspam

2 Files

2.1 Lisp

2.1.1 cl-xmlspam.asd

2.1.2 cl-xmlspam/xspam.lisp

3 Packages

3.1 cl-xmlspam-asd

3.2 xspam

4 Definitions

4.1 Exported definitions

4.1.1 Macros

4.1.2 Functions

4.2 Internal definitions

4.2.1 Special variables

4.2.2 Macros

4.2.3 Functions

4.2.4 Generic functions

4.2.5 Structures

4.2.6 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `cl-xmlspam`

2.1.1 `cl-xmlspam.asd`

2.1.2 `cl-xmlspam/xspam.lisp`

3.1 `cl-xmlspam-asd`

3.2 `xspam`