S-XML.html 1 <html><head><title>S-XML</title></head><body><h3>API for package S-XML</h3>
2 <blockquote>A simple XML parser with an efficient, purely functional, event-based interface as well as a DOM interface</blockquote>
3 <p>(<b>echo-xml</b> in out) <i>function</i></p>
4 <blockquote>Parse a toplevel XML element from stream in, echoing and pretty printing the result to stream out</blockquote>
5 <p>(<b>first-xml-element-child</b> xml-element) <i>function</i></p>
6 <blockquote>Get the first child of an xml-element</blockquote>
7 <p>(<b>get-entities</b> xml-parser-state) <i>generic-function</i></p>
8 <blockquote>Get the entities hashtable of an XML parser state</blockquote>
9 <p>(setf (<b>get-entities</b> xml-parser-state) value) <i>generic-function</i></p>
10 <blockquote>Set the entities hashtable of an XML parser state</blockquote>
11 <p>(<b>get-finish-element-hook</b> xml-parser-state) <i>generic-function</i></p>
12 <blockquote>Get the finish element hook of an XML parser state</blockquote>
13 <p>(setf (<b>get-finish-element-hook</b> xml-parser-state) value) <i>generic-function</i></p>
14 <blockquote>Set the finish element hook of an XML parser state</blockquote>
15 <p>(<b>get-new-element-hook</b> xml-parser-state) <i>generic-function</i></p>
16 <blockquote>Get the new element hook of an XML parser state</blockquote>
17 <p>(setf (<b>get-new-element-hook</b> xml-parser-state) value) <i>generic-function</i></p>
18 <blockquote>Set the new element hook of an XML parser state</blockquote>
19 <p>(<b>get-seed</b> xml-parser-state) <i>generic-function</i></p>
20 <blockquote>Get the initial user seed of an XML parser state</blockquote>
21 <p>(setf (<b>get-seed</b> xml-parser-state) value) <i>generic-function</i></p>
22 <blockquote>Set the initial user seed of an XML parser state</blockquote>
23 <p>(<b>get-text-hook</b> xml-parser-state) <i>generic-function</i></p>
24 <blockquote>Get the text hook of an XML parser state</blockquote>
25 <p>(setf (<b>get-text-hook</b> xml-parser-state) value) <i>generic-function</i></p>
26 <blockquote>Set the text hook of an XML parser state</blockquote>
27 <p>(<b>make-xml-element</b> &key name attributes children) <i>function</i></p>
28 <blockquote>Make and return a new xml-element struct</blockquote>
29 <p>(<b>new-xml-element</b> name &rest children) <i>function</i></p>
30 <blockquote>Make a new xml-element with name and children</blockquote>
31 <p>(<b>parse-xml</b> stream &key (output-type :lxml)) <i>function</i></p>
32 <blockquote>Parse a character stream as XML and generate a DOM of output-type, defaulting to :lxml</blockquote>
33 <p>(<b>parse-xml-dom</b> stream output-type) <i>generic-function</i></p>
34 <blockquote>Parse a character stream as XML and generate a DOM of output-type</blockquote>
35 <p>(<b>parse-xml-file</b> filename &key (output-type :lxml)) <i>function</i></p>
36 <blockquote>Parse a character file as XML and generate a DOM of output-type, defaulting to :lxml</blockquote>
37 <p>(<b>parse-xml-string</b> string &key (output-type :lxml)) <i>function</i></p>
38 <blockquote>Parse a string as XML and generate a DOM of output-type, defaulting to :lxml</blockquote>
39 <p>(<b>print-string-xml</b> string stream) <i>function</i></p>
40 <blockquote>Write the characters of string to stream using basic XML conventions</blockquote>
41 <p>(<b>print-xml</b> dom &key (stream t) pretty (input-type :lxml) (header)) <i>function</i></p>
42 <blockquote>Generate XML output on a character stream (t by default) from a DOM of input-type (:lxml by default), optionally pretty printing (off by default), or adding a header (none by default)</blockquote>
43 <p>(<b>print-xml-dom</b> dom input-type stream pretty level) <i>generic-function</i></p>
44 <blockquote>Generate XML output on a character stream from a DOM of input-type, optionally pretty printing using level</blockquote>
45 <p>(<b>print-xml-string</b> dom &key pretty (input-type :lxml)) <i>function</i></p>
46 <blockquote>Generate XML output to a string from a DOM of input-type (:lxml by default), optionally pretty printing (off by default)</blockquote>
47 <p>(<b>start-parse-xml</b> stream &optional (state (make-instance (quote xml-parser-state)))) <i>function</i></p>
48 <blockquote>Parse and return a toplevel XML element from stream, using parser state</blockquote>
49 <p>(<b>xml-element-attribute</b> xml-element key) <i>function</i></p>
50 <blockquote>Return the string value of the attribute with name the keyword :key
51 of xml-element if any, return null if not found</blockquote>
52 <p>(setf (<b>xml-element-attribute</b> xml-element key) value) <i>function</i></p>
53 <blockquote>Set the string value of the attribute with name the keyword :key of
54 xml-element, creating a new attribute if necessary or overwriting an
55 existing one, returning the value</blockquote>
56 <p>(<b>xml-element-attributes</b> object) <i>function</i></p>
57 <blockquote>Return the alist of attribute names and values dotted pairs from an xml-element struct</blockquote>
58 <p>(<b>xml-element-children</b> object) <i>function</i></p>
59 <blockquote>Return the list of children from an xml-element struct</blockquote>
60 <p>(<b>xml-element-name</b> object) <i>function</i></p>
61 <blockquote>Return the name from an xml-element struct</blockquote>
62 <p>(<b>xml-element-p</b> object) <i>function</i></p>
63 <blockquote>Return T when the argument is an xml-element struct</blockquote>
64 <p><b>xml-parser-error</b> <i>condition</i></p>
65 <blockquote>Thrown by the XML parser to indicate errorneous input</blockquote>
66 <blockquote>Class precedence list: <tt> xml-parser-error error serious-condition condition standard-object t</tt></blockquote>
67 <blockquote>Class init args: <tt> :stream :args :message</tt></blockquote>
68 <p>(<b>xml-parser-error-args</b> xml-parser-error) <i>generic-function</i></p>
69 <blockquote>Get the error arguments from an XML parser error</blockquote>
70 <p>(<b>xml-parser-error-message</b> xml-parser-error) <i>generic-function</i></p>
71 <blockquote>Get the message from an XML parser error</blockquote>
72 <p>(<b>xml-parser-error-stream</b> xml-parser-error) <i>generic-function</i></p>
73 <blockquote>Get the stream from an XML parser error</blockquote>
74 <p><b>xml-parser-state</b> <i>class</i></p>
75 <blockquote>The XML parser state passed along all code making up the parser</blockquote>
76 <blockquote>Class precedence list: <tt> xml-parser-state standard-object t</tt></blockquote>
77 <blockquote>Class init args: <tt> :text-hook :finish-element-hook :new-element-hook :seed :entities</tt></blockquote>
78 <font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on LispWorks</p></font></body></html>