The xml-emitter Reference Manual

Table of Contents

The xml-emitter Reference Manual

This is the xml-emitter Reference Manual, version 1.0.5, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 11:41:37 2019 GMT+0.

1 Introduction

Update:
    This project has been taken over from Peter Scott
    HomePage: https://github.com/VitoVan/xml-emitter
    Check README.md for new changes

Original:

xml-emitter: An XML emitter
===========================

Often, programs have to generate XML output. This is fairly easy, but
not quite trivial. You need to do escaping, and indentation can be a
little tricky to keep track of. One approach you could use is to get
an XML parser/unparser like XMLS, build your XML data structure in
memory, then dump the whole thing. This is fairly easy, but not as
easy as it could be, and it requires holding the whole structure in
memory. Oh, and XMLS doesn't handle indentation for you.

So, I wrote xml-emitter. xml-emitter simply emits XML, with some
complexity for handling indentation. It can be used to produce all
sorts of useful XML output; it has an RSS 2.0 emitter built in.

There is no real home page, but you can download it from the
asdf-packaging project:

http://common-lisp.net/project/asdf-packaging/

If you have comments, questions, or bug reports, email them to Peter
Scott .

Installation
------------

There are two ways to install xml-emitter. Via asdf-install:

(asdf-install:install :xml-emitter)

Or you can download the latest version at:

http://common-lisp.net/project/asdf-packaging/xml-emitter-latest.tar.gz

Usage
-----

The WITH-XML-OUTPUT macro wraps all XML output to a stream.

The WITH-TAG macro places the XML produced by its body inside a
tag. Its output cannot be on just one line, since it puts starting and
closing tags on their own lines.

The WITH-SIMPLE-TAG macro is like WITH-TAG, but starting and closing
tags don't get their own lines.

XML-OUT prints its argument to the XML output stream, escaped.

XML-AS-IS prints its argument to the XML output stream, unescaped.

SIMPLE-TAG prints a simple value tag. It's a shortened
version of a typical use of WITH-SIMPLE-TAG and XML-OUT.

EMIT-SIMPLE-TAGS takes a plist of tag names and tag values. For every
tag with a non-NIL value, it prints the tag with SIMPLE-TAG. Tag names
given as keyword symbols (like :this) are downcased.

Example:

(with-xml-output (*standard-output*)
  (with-tag ("person" '(("age" "19")))
    (with-simple-tag ("firstName")
      (xml-out "Peter"))
    (simple-tag "lastName" "Scott")
    (emit-simple-tags :age 17
		      :school "Iowa State Univeristy"
		      "mixedCaseTag" "Check out the mixed case!"
		      "notShown" nil)))

The RSS 2.0 emitter
-------------------

The WITH-RSS2 macro wraps up all output of RSS.

RSS-CHANNEL-HEADER outputs the RSS channel information.

RSS-ITEM outputs information about one RSS item.

Example:

(with-rss2 (*standard-output*)
  (rss-channel-header "Peter's Blog" "http://peter.blogspot.com/"
		      :description "A place where I sometimes post stuff"
		      :image "myhead.jpg"
		      :image-title "My glorious visage")
  (rss-item "Breaking news!"
	    :link "http://google.com/"
	    :description "The biggest problem with the DO-ODD macro above is that it puts BODY
into LOOP. Code from the user of the macro should never be run in the
environment established by the LOOP macro. LOOP does a number of
things behind your back, and it's hard to disable them. For example,
what happens here?"
	    :author "Peter Scott"
	    :category "Lisp"
	    :pubDate "Sun, 29 Sep 2002 19:59:01 GMT")
  (rss-item "RSS emitter created"
	    :description "An RSS emitter has been released! Hahahahaha!"
	    :author "Peter Scott"
	    :link "http://gmail.google.com/"))

There is also a complete example of how you might use the RSS emitter
in mailbox.lisp

License
-------

I, Peter Scott, place this code in the public domain. You can do
whatever you like with it.

-Peter Scott, 

2 Systems

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

2.1 xml-emitter

Author

Peter Scott / Vito Van / Philipp Marek / Matteo Landi

License

Public Domain / 0-clause MIT

Description

xml-emitter simply emits XML, with some
complexity for handling indentation. It can be used to produce all sorts of useful XML output; it has an RSS 2.0 emitter built in.

Version

1.0.5

Dependency

cl-utilities

Source

xml-emitter.asd (file)

Components

• licence (file)
• package.lisp (file)
• xml.lisp (file)
• rss2.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 xml-emitter.asd

Location

xml-emitter.asd

Systems

xml-emitter (system)

Packages

xml-emitter-system

3.1.2 xml-emitter/package.lisp

Dependency

licence (file)

Parent

xml-emitter (system)

Location

package.lisp

Packages

xml-emitter

3.1.3 xml-emitter/xml.lisp

Dependency

package.lisp (file)

Parent

xml-emitter (system)

Location

xml.lisp

Exported Definitions

• emit-simple-tags (function)
• empty-tag (function)
• simple-tag (function)
• with-simple-tag (macro)
• with-tag (macro)
• with-xml-output (macro)
• xml-as-is (function)
• xml-out (function)

Internal Definitions

• *char-escapes* (special variable)
• *entities* (special variable)
• *indent* (special variable)
• *whitespace* (special variable)
• *xml-output-stream* (special variable)
• end-tag (function)
• indent (function)
• start-tag (function)
• with-indent (macro)
• write-escaped (function)

3.1.4 xml-emitter/rss2.lisp

Dependency

xml.lisp (file)

Parent

xml-emitter (system)

Location

rss2.lisp

Exported Definitions

• rss-channel-header (function)
• rss-item (function)
• with-rss-channel-header (macro)
• with-rss-item (macro)
• with-rss2 (macro)

3.2 Static

3.2.1 xml-emitter/LICENCE

Parent

xml-emitter (system)

Location

LICENCE

4 Packages

Packages are listed by definition order.

4.1 xml-emitter-system

Source

xml-emitter.asd

Use List

• asdf/interface
• common-lisp

4.2 xml-emitter

Source

package.lisp (file)

Use List

• cl-utilities
• common-lisp

Exported Definitions

• emit-simple-tags (function)
• empty-tag (function)
• rss-channel-header (function)
• rss-item (function)
• simple-tag (function)
• with-rss-channel-header (macro)
• with-rss-item (macro)
• with-rss2 (macro)
• with-simple-tag (macro)
• with-tag (macro)
• with-xml-output (macro)
• xml-as-is (function)
• xml-out (function)

Internal Definitions

• *char-escapes* (special variable)
• *entities* (special variable)
• *indent* (special variable)
• *whitespace* (special variable)
• *xml-output-stream* (special variable)
• end-tag (function)
• indent (function)
• start-tag (function)
• with-indent (macro)
• write-escaped (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-rss-channel-header (TITLE LINK &key DESCRIPTION GENERATOR LANGUAGE IMAGE IMAGE-TITLE IMAGE-LINK) &body BODY

Package

xml-emitter

Source

rss2.lisp (file)

Macro: with-rss-item (TITLE &key LINK DESCRIPTION AUTHOR CATEGORY COMMENTS GUID PUBDATE SOURCE) &body BODY

Package

xml-emitter

Source

rss2.lisp (file)

Macro: with-rss2 (STREAM &key ENCODING ATTRS) &body BODY

Package

xml-emitter

Source

rss2.lisp (file)

Macro: with-simple-tag (NAME &optional ATTRS NAMESPACE) &body BODY

Like WITH-TAG, but without the linebreaks.

Package

xml-emitter

Source

xml.lisp (file)

Macro: with-tag (NAME &optional ATTRS NAMESPACE) &body BODY

Wrap BODY in a tag. BODY is indented, and linebreaks are added.

Package

xml-emitter

Source

xml.lisp (file)

Macro: with-xml-output (STREAM &key ENCODING STANDALONE) &body BODY

Wrap XML output on STREAM with the necessary XML heading information

Package

xml-emitter

Source

xml.lisp (file)

5.1.2 Functions

Function: emit-simple-tags &rest TAGS-PLIST

Given a plist mapping tag names to values (or nil), emit tags in the order given, skipping ones with nil values. Tag names are downcased unless they’re passed as strings.

Package

xml-emitter

Source

xml.lisp (file)

Function: empty-tag NAME &optional ATTRS NAMESPACE

Package

xml-emitter

Source

xml.lisp (file)

Function: rss-channel-header TITLE LINK &key DESCRIPTION GENERATOR LANGUAGE IMAGE IMAGE-TITLE IMAGE-LINK

Package

xml-emitter

Source

rss2.lisp (file)

Function: rss-item TITLE &key LINK DESCRIPTION AUTHOR CATEGORY COMMENTS GUID PUBDATE SOURCE

Package

xml-emitter

Source

rss2.lisp (file)

Function: simple-tag NAME CONTENT &optional ATTRS NAMESPACE

Emit a simple tag with given content

Package

xml-emitter

Source

xml.lisp (file)

Function: xml-as-is X &key INDENT

Write X to XML output, unescaped and optionally indented

Package

xml-emitter

Source

xml.lisp (file)

Function: xml-out X &key INDENT

Write X to XML output, escaped and optionally indented

Package

xml-emitter

Source

xml.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *char-escapes*

Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *entities*

Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *indent*

Number of spaces to indent each line of XML output

Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *whitespace*

Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *xml-output-stream*

The stream to write XML to

Package

xml-emitter

Source

xml.lisp (file)

5.2.2 Macros

Macro: with-indent (&optional SPACES) &body BODY

Increase the indentation level in BODY by SPACES

Package

xml-emitter

Source

xml.lisp (file)

5.2.3 Functions

Function: end-tag NAME

Write en ending tag to XML output

Package

xml-emitter

Source

xml.lisp (file)

Function: indent &optional SPACES

Indent a given number of spaces

Package

xml-emitter

Source

xml.lisp (file)

Function: start-tag NAME &optional ATTRS NAMESPACE END-IT

Write a start tag to XML output

Package

xml-emitter

Source

xml.lisp (file)

Function: write-escaped STRING STREAM

Writes string to stream with all character entities escaped.

Package

xml-emitter

Source

xml.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types