The sexml Reference Manual

Table of Contents

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

The sexml Reference Manual

This is the sexml Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:33:52 2018 GMT+0.

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

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

1 Systems

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

• The sexml system:  

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

1.1 sexml

Maintainer

Aad Versteden <madnificent@gmail.com>

Author

Aad Versteden <madnificent@gmail.com>

License

MIT

Description

s-expressions for xml is a library which provides a sugar-sweet s-expression syntax for spitting out xml documents based on a DTD

Version

0.0.1

Dependencies
Source

sexml.asd (file)

Components

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

2 Files

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

• Lisp files:  

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

2.1 Lisp

• The sexml.asd file:  
• The sexml/packages.lisp file:  
• The sexml/sexml.lisp file:  

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

2.1.1 sexml.asd

Location

sexml.asd

Systems

sexml (system)

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

2.1.2 sexml/packages.lisp

Parent

sexml (system)

Location

packages.lisp

Packages

sexml

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

2.1.3 sexml/sexml.lisp

Dependency

packages.lisp (file)

Parent

sexml (system)

Location

sexml.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.

• The sexml package:  

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

3.1 sexml

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

4 Definitions

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

• Exported definitions:  
• Internal definitions:  

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

4.1 Exported definitions

• Exported macros:  

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

4.1.1 Macros

Macro: support-dtd FILE PACKAGENAME

adds support for the dtd specified in <file> in package <packagename>, the package needn’t exist before.

Package

sexml

Source

sexml.lisp (file)

Macro: with-compiletime-active-layers (&rest LAYERS) &body BODY
Package

sexml

Source

sexml.lisp (file)

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

4.2 Internal definitions

• Internal functions:  
• Internal generic functions:  
• Internal conditions:  
• Internal classes:  

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

4.2.1 Functions

Function: dtd-support-forms ()

returns a list of forms which need to be compiled to support the dtd

Package

sexml

Source

sexml.lisp (file)

Function: entity-definition-forms ()

entity-definition-forms is called with an entity and package object (both defined in sexml). it should return all forms needed to generate the functions.

Package

sexml

Source

sexml.lisp (file)

Function: entity-printer-forms ()

produces the forms which will handle the printing of the tags. <entity> contains the entity which needs to be printed. <attr-var> contains a symbol which will contain a plist of attribute-value pairs, the keyword must constist of a string at runtime, the value is not specified. <body> contains a symbol which will contain a list of content which must be printed within the tag.

Package

sexml

Source

sexml.lisp (file)

Function: format-tag-attr-content STREAM ARG COLONP ATP &rest OPTIONS
Package

sexml

Source

sexml.lisp (file)

Function: format-tag-body-content STREAM ARG COLONP ATP &rest OPTIONS
Package

sexml

Source

sexml.lisp (file)

Function: mk-dtd-object FILE
Package

sexml

Source

sexml.lisp (file)

Function: mk-lisp-symbol ENTITY PACKAGE
Package

sexml

Source

sexml.lisp (file)

Function: mk-package-object NAME

creates a new package object

Package

sexml

Source

sexml.lisp (file)

Function: package-declaration PACKAGE

creates a definition for the package

Package

sexml

Source

sexml.lisp (file)

Function: package-exports-symbol PACKAGE SYMBOL

makes sure package knows it needs to export symbol, and exports it

Package

sexml

Source

sexml.lisp (file)

Function: recursively-flatten &rest ARGS

recursively flattens a list

Package

sexml

Source

sexml.lisp (file)

Function: sequence-starts-with-p TOTAL-SEQUENCE START-SEQUENCE

returns non-nil iff <total-sequence> starts with <start-sequence>

Package

sexml

Source

sexml.lisp (file)

Function: tag-attribute-content ()

prints <content> in a way that it’s a valid value for an attribute

Package

sexml

Source

sexml.lisp (file)

Function: tag-body-content ()

prints <content> in a way appropriate for xml output. output functions should use this in order to create correct output.

Package

sexml

Source

sexml.lisp (file)

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

4.2.2 Generic functions

Generic Function: =layered-function-definer-for-dtd-support-forms= LAYER-ARG0 DTD PACKAGE
Package

sexml

Source

sexml.lisp (file)

Methods
Method: =layered-function-definer-for-dtd-support-forms= (LAYER-ARG-0 =layer-class-definer-for-xml-doctype=) DTD PACKAGE around
Method: =layered-function-definer-for-dtd-support-forms= (LAYER-ARG-0 =layer-class-definer-for-ie-conditionals=) DTD PACKAGE around
Method: =layered-function-definer-for-dtd-support-forms= (LAYER-ARG-0 =layer-class-definer-for-xml-comments=) DTD PACKAGE around
Method: =layered-function-definer-for-dtd-support-forms= LAYER-ARG-2 DTD PACKAGE
Generic Function: =layered-function-definer-for-entity-definition-forms= LAYER-ARG0 ENTITY PACKAGE
Package

sexml

Source

sexml.lisp (file)

Methods
Method: =layered-function-definer-for-entity-definition-forms= (LAYER-ARG-0 =layer-class-definer-for-export-function-symbol=) ENTITY PACKAGE around
Method: =layered-function-definer-for-entity-definition-forms= (LAYER-ARG-0 =layer-class-definer-for-sexml-functions=) ENTITY PACKAGE around
Method: =layered-function-definer-for-entity-definition-forms= LAYER-ARG-2 ENTITY PACKAGE
Generic Function: =layered-function-definer-for-entity-printer-forms= LAYER-ARG0 ENTITY ATTR-VAR BODY
Package

sexml

Source

sexml.lisp (file)

Methods
Method: =layered-function-definer-for-entity-printer-forms= (LAYER-ARG-0 =layer-class-definer-for-sexml-xml-producer=) ENTITY ATTR-VAR BODY
Generic Function: =layered-function-definer-for-tag-attribute-content= LAYER-ARG0 CONTENT
Package

sexml

Source

sexml.lisp (file)

Methods
Method: =layered-function-definer-for-tag-attribute-content= LAYER-ARG-2 CONTENT
Generic Function: =layered-function-definer-for-tag-body-content= LAYER-ARG0 CONTENT
Package

sexml

Source

sexml.lisp (file)

Methods
Method: =layered-function-definer-for-tag-body-content= LAYER-ARG-2 CONTENT
Generic Function: add-attribute ELEMENT ATTRIBUTE

registers the existence of <attribute> for <element>.

Package

sexml

Source

sexml.lisp (file)

Methods
Method: add-attribute (ELEMENT element) (ATTRIBUTE attribute)
Generic Function: add-element DTD ELEMENT

adds <element> to the dtd>

Package

sexml

Source

sexml.lisp (file)

Methods
Method: add-element (DTD dtd) (ELEMENT element)
Generic Function: argument-symbol ATTRIBUTE PACKAGE

returns a symbol for the argument which can be given to the attribute, imported in package

Package

sexml

Source

sexml.lisp (file)

Methods
Method: argument-symbol (ATTRIBUTE attribute) PACKAGE
Generic Function: attributes OBJECT
Generic Function: (setf attributes) NEW-VALUE OBJECT
Package

sexml

Methods
Method: attributes (ELEMENT element)

automatically generated reader method

Source

sexml.lisp (file)

Method: (setf attributes) NEW-VALUE (ELEMENT element)

automatically generated writer method

Source

sexml.lisp (file)

Generic Function: dtd OBJECT
Package

sexml

Methods
Method: dtd (DTD-SAX-HANDLER dtd-sax-handler)

automatically generated reader method

Source

sexml.lisp (file)

Generic Function: dtd-elements DTD

returns the elements of the document

Package

sexml

Source

sexml.lisp (file)

Methods
Method: dtd-elements DTD
Generic Function: dtd-elements-hash OBJECT
Generic Function: (setf dtd-elements-hash) NEW-VALUE OBJECT
Package

sexml

Methods
Method: dtd-elements-hash (DTD dtd)

automatically generated reader method

Source

sexml.lisp (file)

Method: (setf dtd-elements-hash) NEW-VALUE (DTD dtd)

automatically generated writer method

Source

sexml.lisp (file)

Generic Function: dtd-path OBJECT
Package

sexml

Methods
Method: dtd-path (DTD dtd)

automatically generated reader method

Source

sexml.lisp (file)

Generic Function: find-element DTD NAME-STRING

searches for the element representing <name-string> in the dtd

Package

sexml

Source

sexml.lisp (file)

Methods
Method: find-element (DTD dtd) NAME-STRING
Generic Function: function-symbol ELEMENT PACKAGE

returns a symbol for the function of element in package

Package

sexml

Source

sexml.lisp (file)

Methods
Method: function-symbol (ELEMENT element) PACKAGE
Generic Function: name OBJECT
Package

sexml

Methods
Method: name (ATTRIBUTE attribute)

automatically generated reader method

Source

sexml.lisp (file)

Method: name (ELEMENT element)

automatically generated reader method

Source

sexml.lisp (file)

Generic Function: subelements-p OBJECT
Generic Function: (setf subelements-p) NEW-VALUE OBJECT
Package

sexml

Methods
Method: subelements-p (ELEMENT element)

automatically generated reader method

Source

sexml.lisp (file)

Method: (setf subelements-p) NEW-VALUE (ELEMENT element)

automatically generated writer method

Source

sexml.lisp (file)

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

4.2.3 Conditions

Condition: unknown-key ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

warning (condition)

Direct slots
Slot: key
Initargs

:key

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

4.2.4 Classes

Class: =layer-class-definer-for-export-function-symbol= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-layer-object (class)

Direct subclasses

=layer-class-definer-for-standard-sexml= (class)

Direct methods

=layered-function-definer-for-entity-definition-forms= (method)

Class: =layer-class-definer-for-ie-conditionals= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-layer-object (class)

Direct methods

=layered-function-definer-for-dtd-support-forms= (method)

Class: =layer-class-definer-for-sexml-functions= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-layer-object (class)

Direct subclasses

=layer-class-definer-for-standard-sexml= (class)

Direct methods

=layered-function-definer-for-entity-definition-forms= (method)

Class: =layer-class-definer-for-sexml-xml-producer= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-layer-object (class)

Direct subclasses

=layer-class-definer-for-standard-sexml= (class)

Direct methods

=layered-function-definer-for-entity-printer-forms= (method)

Class: =layer-class-definer-for-standard-sexml= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses
Class: =layer-class-definer-for-xml-comments= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-layer-object (class)

Direct subclasses

=layer-class-definer-for-standard-sexml= (class)

Direct methods

=layered-function-definer-for-dtd-support-forms= (method)

Class: =layer-class-definer-for-xml-doctype= ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-layer-object (class)

Direct methods

=layered-function-definer-for-dtd-support-forms= (method)

Class: attribute ()

represents a possible attribute for an element

Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Class: dtd ()

Datastructure which contains all information of a DTD.

Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: path
Initargs

:path

Readers

dtd-path (generic function)

Slot: elements-hash
Initform

(make-hash-table :test (quote equal))

Readers

dtd-elements-hash (generic function)

Writers

(setf dtd-elements-hash) (generic function)

Class: dtd-sax-handler ()

sax handler which calls the correct methods on its DTD

Package

sexml

Source

sexml.lisp (file)

Direct superclasses

default-handler (class)

Direct methods
  • attribute-declaration (method)
  • element-declaration (method)
  • dtd (method)
Direct slots
Slot: dtd
Initargs

:dtd

Readers

dtd (generic function)

Class: element ()
Package

sexml

Source

sexml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Slot: attributes
Readers

attributes (generic function)

Writers

(setf attributes) (generic function)

Slot: subelements-p
Initargs

:subelements-p

Readers

subelements-p (generic function)

Writers

(setf subelements-p) (generic function)

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

Appendix A Indexes

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

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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section
F
File, Lisp, sexml.asd: The sexml<dot>asd file
File, Lisp, sexml/packages.lisp: The sexml/packages<dot>lisp file
File, Lisp, sexml/sexml.lisp: The sexml/sexml<dot>lisp file
L
Lisp File, sexml.asd: The sexml<dot>asd file
Lisp File, sexml/packages.lisp: The sexml/packages<dot>lisp file
Lisp File, sexml/sexml.lisp: The sexml/sexml<dot>lisp file
S
sexml.asd: The sexml<dot>asd file
sexml/packages.lisp: The sexml/packages<dot>lisp file
sexml/sexml.lisp: The sexml/sexml<dot>lisp file
Jump to:   F   L   S  

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

A.2 Functions

Jump to:   (   =  
A   D   E   F   G   M   N   P   R   S   T   W  
Index Entry  Section
(
(setf attributes): Internal generic functions
(setf attributes): Internal generic functions
(setf dtd-elements-hash): Internal generic functions
(setf dtd-elements-hash): Internal generic functions
(setf subelements-p): Internal generic functions
(setf subelements-p): Internal generic functions
=
=layered-function-definer-for-dtd-support-forms=: Internal generic functions
=layered-function-definer-for-dtd-support-forms=: Internal generic functions
=layered-function-definer-for-dtd-support-forms=: Internal generic functions
=layered-function-definer-for-dtd-support-forms=: Internal generic functions
=layered-function-definer-for-dtd-support-forms=: Internal generic functions
=layered-function-definer-for-entity-definition-forms=: Internal generic functions
=layered-function-definer-for-entity-definition-forms=: Internal generic functions
=layered-function-definer-for-entity-definition-forms=: Internal generic functions
=layered-function-definer-for-entity-definition-forms=: Internal generic functions
=layered-function-definer-for-entity-printer-forms=: Internal generic functions
=layered-function-definer-for-entity-printer-forms=: Internal generic functions
=layered-function-definer-for-tag-attribute-content=: Internal generic functions
=layered-function-definer-for-tag-attribute-content=: Internal generic functions
=layered-function-definer-for-tag-body-content=: Internal generic functions
=layered-function-definer-for-tag-body-content=: Internal generic functions
A
add-attribute: Internal generic functions
add-attribute: Internal generic functions
add-element: Internal generic functions
add-element: Internal generic functions
argument-symbol: Internal generic functions
argument-symbol: Internal generic functions
attributes: Internal generic functions
attributes: Internal generic functions
D
dtd: Internal generic functions
dtd: Internal generic functions
dtd-elements: Internal generic functions
dtd-elements: Internal generic functions
dtd-elements-hash: Internal generic functions
dtd-elements-hash: Internal generic functions
dtd-path: Internal generic functions
dtd-path: Internal generic functions
dtd-support-forms: Internal functions
E
entity-definition-forms: Internal functions
entity-printer-forms: Internal functions
F
find-element: Internal generic functions
find-element: Internal generic functions
format-tag-attr-content: Internal functions
format-tag-body-content: Internal functions
Function, dtd-support-forms: Internal functions
Function, entity-definition-forms: Internal functions
Function, entity-printer-forms: Internal functions
Function, format-tag-attr-content: Internal functions
Function, format-tag-body-content: Internal functions
Function, mk-dtd-object: Internal functions
Function, mk-lisp-symbol: Internal functions
Function, mk-package-object: Internal functions
Function, package-declaration: Internal functions
Function, package-exports-symbol: Internal functions
Function, recursively-flatten: Internal functions
Function, sequence-starts-with-p: Internal functions
Function, tag-attribute-content: Internal functions
Function, tag-body-content: Internal functions
function-symbol: Internal generic functions
function-symbol: Internal generic functions
G
Generic Function, (setf attributes): Internal generic functions
Generic Function, (setf dtd-elements-hash): Internal generic functions
Generic Function, (setf subelements-p): Internal generic functions
Generic Function, =layered-function-definer-for-dtd-support-forms=: Internal generic functions
Generic Function, =layered-function-definer-for-entity-definition-forms=: Internal generic functions
Generic Function, =layered-function-definer-for-entity-printer-forms=: Internal generic functions
Generic Function, =layered-function-definer-for-tag-attribute-content=: Internal generic functions
Generic Function, =layered-function-definer-for-tag-body-content=: Internal generic functions
Generic Function, add-attribute: Internal generic functions
Generic Function, add-element: Internal generic functions
Generic Function, argument-symbol: Internal generic functions
Generic Function, attributes: Internal generic functions
Generic Function, dtd: Internal generic functions
Generic Function, dtd-elements: Internal generic functions
Generic Function, dtd-elements-hash: Internal generic functions
Generic Function, dtd-path: Internal generic functions
Generic Function, find-element: Internal generic functions
Generic Function, function-symbol: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, subelements-p: Internal generic functions
M
Macro, support-dtd: Exported macros
Macro, with-compiletime-active-layers: Exported macros
Method, (setf attributes): Internal generic functions
Method, (setf dtd-elements-hash): Internal generic functions
Method, (setf subelements-p): Internal generic functions
Method, =layered-function-definer-for-dtd-support-forms=: Internal generic functions
Method, =layered-function-definer-for-dtd-support-forms=: Internal generic functions
Method, =layered-function-definer-for-dtd-support-forms=: Internal generic functions
Method, =layered-function-definer-for-dtd-support-forms=: Internal generic functions
Method, =layered-function-definer-for-entity-definition-forms=: Internal generic functions
Method, =layered-function-definer-for-entity-definition-forms=: Internal generic functions
Method, =layered-function-definer-for-entity-definition-forms=: Internal generic functions
Method, =layered-function-definer-for-entity-printer-forms=: Internal generic functions
Method, =layered-function-definer-for-tag-attribute-content=: Internal generic functions
Method, =layered-function-definer-for-tag-body-content=: Internal generic functions
Method, add-attribute: Internal generic functions
Method, add-element: Internal generic functions
Method, argument-symbol: Internal generic functions
Method, attributes: Internal generic functions
Method, dtd: Internal generic functions
Method, dtd-elements: Internal generic functions
Method, dtd-elements-hash: Internal generic functions
Method, dtd-path: Internal generic functions
Method, find-element: Internal generic functions
Method, function-symbol: Internal generic functions
Method, name: Internal generic functions
Method, name: Internal generic functions
Method, subelements-p: Internal generic functions
mk-dtd-object: Internal functions
mk-lisp-symbol: Internal functions
mk-package-object: Internal functions
N
name: Internal generic functions
name: Internal generic functions
name: Internal generic functions
P
package-declaration: Internal functions
package-exports-symbol: Internal functions
R
recursively-flatten: Internal functions
S
sequence-starts-with-p: Internal functions
subelements-p: Internal generic functions
subelements-p: Internal generic functions
support-dtd: Exported macros
T
tag-attribute-content: Internal functions
tag-body-content: Internal functions
W
with-compiletime-active-layers: Exported macros
Jump to:   (   =  
A   D   E   F   G   M   N   P   R   S   T   W  

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

A.3 Variables

Jump to:   A   D   E   K   N   P   S  
Index Entry  Section
A
attributes: Internal classes
D
dtd: Internal classes
E
elements-hash: Internal classes
K
key: Internal conditions
N
name: Internal classes
name: Internal classes
P
path: Internal classes
S
Slot, attributes: Internal classes
Slot, dtd: Internal classes
Slot, elements-hash: Internal classes
Slot, key: Internal conditions
Slot, name: Internal classes
Slot, name: Internal classes
Slot, path: Internal classes
Slot, subelements-p: Internal classes
subelements-p: Internal classes
Jump to:   A   D   E   K   N   P   S  

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

A.4 Data types

Jump to:   =  
A   C   D   E   P   S   U  
Index Entry  Section
=
=layer-class-definer-for-export-function-symbol=: Internal classes
=layer-class-definer-for-ie-conditionals=: Internal classes
=layer-class-definer-for-sexml-functions=: Internal classes
=layer-class-definer-for-sexml-xml-producer=: Internal classes
=layer-class-definer-for-standard-sexml=: Internal classes
=layer-class-definer-for-xml-comments=: Internal classes
=layer-class-definer-for-xml-doctype=: Internal classes
A
attribute: Internal classes
C
Class, =layer-class-definer-for-export-function-symbol=: Internal classes
Class, =layer-class-definer-for-ie-conditionals=: Internal classes
Class, =layer-class-definer-for-sexml-functions=: Internal classes
Class, =layer-class-definer-for-sexml-xml-producer=: Internal classes
Class, =layer-class-definer-for-standard-sexml=: Internal classes
Class, =layer-class-definer-for-xml-comments=: Internal classes
Class, =layer-class-definer-for-xml-doctype=: Internal classes
Class, attribute: Internal classes
Class, dtd: Internal classes
Class, dtd-sax-handler: Internal classes
Class, element: Internal classes
Condition, unknown-key: Internal conditions
D
dtd: Internal classes
dtd-sax-handler: Internal classes
E
element: Internal classes
P
Package, sexml: The sexml package
S
sexml: The sexml system
sexml: The sexml package
System, sexml: The sexml system
U
unknown-key: Internal conditions
Jump to:   =  
A   C   D   E   P   S   U