This document describes version 0.4d1 of Vicare/Expat, a distribution of C and Scheme libraries for Vicare Scheme, an R6RS compliant Scheme implementation; it provides bindings for the Expat C language library, an XML parser library.
The package is distributed under the terms of the GNU General Public License (GPL) and can be downloaded from:
development takes place at:
and as backup at:
Expat is available at:
the XML 1.0 specification is available from:
Copyright © 2012, 2013, 2015, 2017 by Marco Maggi marco.maggi.ipsu@poste.it
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with Invariant Sections being “GNU Free Documentation License” and “GNU General Public License”, no Front–Cover Texts, and no Back–Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
• overview: | Overview of the package. | |
• parsers: | Building and running parsers. | |
• handlers: | Building and registering callbacks. | |
• version: | Expat version informations. | |
Appendices | ||
---|---|---|
• Package License: | GNU General Public License. | |
• Documentation License: | GNU Free Documentation License. | |
• references: | Bibliography and references. | |
Indexes | ||
• concept index: | An entry for each concept. | |
• function index: | An entry for each function. | |
• variable index: | An entry for each variable. | |
• type index: | An entry for each type. |
Vicare Scheme is an R6RS compliant Scheme language implementation in the form of a native compiler for x86 architectures, officially supporting GNU+Linux systems. Vicare/Expat is a distribution of C language and Scheme language libraries for Vicare Scheme; it provides bindings for the Expat C language library, an XML parser library.
Vicare Scheme needs to be compiled with FFI support enabled, because Expat heavily relies on C callbacks.
The last time the author bothered to update this paragraph, he had tested Expat version 2.2.0; the Expat library is available at:
notice that unofficial Expat documentation in Texinfo format is available in the Nimby-Doc project at:
and also online:
the XML 1.0 specification is available from:
Expat must be compiled to handle UTF-8 strings.
The package installs a C language library implementing wrapper C
functions for the C language Expat library; on top of this, the Scheme
library (vicare xml expat)
exports one binding for each Expat
public function, with the exception of:
XML_ParserCreateMM XML_MemMalloc XML_MemRealloc XML_MemFree XML_SetUnknownEncodingHandler XML_SetExternalEntityRefHandlerArg
additionally the library (vicare xml expat constants)
exports
one binding for each constant value defined in the C language header
expat.h.
The following Scheme libraries are installed:
(vicare xml expat)
It exports one binding for each Expat public function. All the Scheme function names are equal to the corresponding the C function names.
(vicare xml expat unsafe-capi)
It exports keyword syntactic bindings for Expat public functions wrapped for Vicare.
These syntaxes expand to a direct call to the C language wrapper functions in the Vicare/Expat library; they are not meant to be called in normal usage of the package.
(vicare xml expat constants)
It exports one binding for each constant value defined in the C language header expat.h.
This document contains only a brief description of the functions: refer to the Expat’s documentation for details.
Here is an example program using the core interface:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (only (vicare ffi) free-c-callback) ffi.)) (define xml-utf8 "<!-- this is a test document -->\ <stuff>\ <thing colour=\"yellow\">\ <alpha>one</alpha>\ <beta>two</beta>\ </thing>\ <thing>\ <alpha>123</alpha>\ <beta>456</beta>\ </thing>\ </stuff>") (define (start-callback data element attributes) (let ((element (cstring->string element)) (attributes (argv->strings attributes))) (pretty-print (list 'start element attributes)))) (define (end-callback data element) (let ((element (cstring->string element))) (pretty-print (list 'end element)))) (define (cdata-callback data buf.ptr buf.len) (let ((text (cstring->string buf.ptr buf.len))) (pretty-print (list 'cdata text)))) (define (comment-callback data cstr) (let ((text (cstring->string cstr))) (pretty-print (list 'comment text)))) (let ((parser (XML_ParserCreate)) (start (XML_StartElementHandler start-callback)) (end (XML_EndElementHandler end-callback)) (cdata (XML_CharacterDataHandler cdata-callback)) (comment (XML_CommentHandler comment-callback))) (XML_SetElementHandler parser start end) (XML_SetCharacterDataHandler parser cdata) (XML_SetCommentHandler parser comment) (XML_Parse parser (string->utf8 xml-utf8) #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (ffi.free-c-callback cdata) (ffi.free-c-callback comment)) (flush-output-port (current-output-port))
which prints:
(comment " this is a test document ") (start "stuff" ()) (start "thing" ("colour" "yellow")) (start "alpha" ()) (cdata "one") (end "alpha") (start "beta" ()) (cdata "two") (end "beta") (end "thing") (start "thing" ()) (start "alpha" ()) (cdata "123") (end "alpha") (start "beta" ()) (cdata "456") (end "beta") (end "thing") (end "stuff")
• parsers create: | Creating parsers. | |
• parsers external: | Creating external entities parsers. | |
• parsers parsing: | Parsing data. | |
• parsers namespaces: | Using namespaces. | |
• parsers stop: | Stopping and resuming. | |
• parsers status: | Parsing status. | |
• parsers report: | Reporting errors. | |
• parsers misc: | Miscellaneous functions. |
Next: parsers external, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_ParserCreate. Build a new parser and return
a pointer object referencing it; if an error occurs return #f
.
Values returned by this function must be finalised with
XML_ParserFree
; this will happen automatically when the pointer
object is garbage collected.
The optional encoding must be #f
or one of the Scheme
symbols: UTF-8
, UTF-16
, ISO-8859-1
,
US-ASCII
; when encoding is not used or it is #f
: the
parser will honour the encoding specification in the document.
See (expat)XML_ParserFree. Release all the resources
associated to the pointer object parser, then mutate parser
to represent the NULL
pointer; return unspecified values. It is
safe to apply this function multiple times to the same parser
object: the first time it will release the resources, subsequent times
nothing will happen.
See (expat)XML_ParserReset. Reset a parser so that it can
be used again; return a boolean value: #t
if success, #f
if
this parser cannot be reset. encoding is as in
XML_ParserCreate
.
See (expat)XML_SetEncoding. Set the encoding to be used while
parsing. encoding is as in XML_ParserCreate
. Return a
fixnum representing a status code.
Next: parsers parsing, Previous: parsers create, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_SetParamEntityParsing. Enable or disable external entity parsing according to code, which must be a fixnum among:
XML_PARAM_ENTITY_PARSING_NEVER XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE XML_PARAM_ENTITY_PARSING_ALWAYS
See (expat)XML_ExternalEntityParserCreate. Build a new
parser to parse an external entity for parser and return a pointer
object referencing it; if an error occurs return #f
. Values
returned by this function must be finalised with XML_ParserFree
;
this will happen automatically when the pointer object is garbage
collected.
parser is a pointer object to the main parser. context must
be a pointer object. encoding is as in XML_ParserCreate
.
See (expat)XML_ExternalEntityRefHandler. Maker and setter for external entity handler.
The following is a skeleton program showing how to parse an external DTD:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define dtd-utf8 (string->utf8 "<!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED>")) (define (ext-callback parser context base system-id public-id) (let* ((parser (XML_ExternalEntityParserCreate parser context 'UTF-8)) (rv (XML_Parse parser dtd-utf8 #f #t))) (pretty-print (list 'external-entity rv (ffi.pointer-null? context) (ffi.pointer-null? base) (ffi.cstring->string system-id) (ffi.pointer-null? public-id))) XML_STATUS_OK)) (define (doit xml-utf8) (let* ((parser (XML_ParserCreate)) (ext (XML_ExternalEntityRefHandler ext-callback))) (XML_SetParamEntityParsing parser XML_PARAM_ENTITY_PARSING_ALWAYS) (XML_SetExternalEntityRefHandler parser ext) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback ext) (flush-output-port (current-output-port)))) (doit (string->utf8 "<!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (external-entity 1 #t #t "http://localhost/toys" #t) (doit (string->utf8 "<!DOCTYPE toys PUBLIC 'The Toys' 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (external-entity 1 #t #t "http://localhost/toys" #f)
Next: parsers namespaces, Previous: parsers external, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library. In all the descriptions: the parser argument must be a
pointer object referencing the parser.
See (expat)XML_Parse. Parse the next portion of the document; return a fixnum representing a status code.
buffer must be a bytevector or a pointer object. buflen
must be #f
or a non–negative exact integer in the range of the
int
C language type. If buffer is a pointer: buflen
must be an integer representing the number of bytes to consume from the
buffer; if buffer is a bytevector: buflen is ignored and the
whole bytevector is consumed.
If final? is true: expect this buffer to contain the end of the
document; final? defaults to #f
.
See (expat)XML_GetBuffer. Allocate an internal buffer
buflen bytes wide and return a pointer object to it; return
#f
if the allocation fails. The returned value is meant to be
filled with the next portion of the document and processed by
XML_ParseBuffer
.
See (expat)XML_ParseBuffer. Parse the next portion of the
document from the internal buffer allocated by a previous call to
XML_GetBuffer
. Return a fixnum representing a status code.
The following skeleton program shows the mechanics of using an internal buffer:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml (string->utf8 "<!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) (let ((parser (XML_ParserCreate 'UTF-8)) (buflen (bytevector-length data)) (buffer (XML_GetBuffer parser buflen))) (ffi.memory-copy buffer 0 data 0 buflen) (XML_ParseBuffer parser buflen #t))
Next: parsers stop, Previous: parsers parsing, Up: parsers [Contents][Index]
The use of namespaces in XML 1.0 is defined in the recommendation at:
and allows to tag XML elements with the same name as belonging to different sets. When first learning about XML namespaces, remember that: namespaces are not for modular DTD composition.
See (expat)XML_ParserCreateNS. Build a new parser, having
namespace processing in effect, and return a pointer object referencing
it; if an error occurs return #f
. Values returned by this
function must be finalised with XML_ParserFree
; this will happen
automatically when the pointer object is garbage collected.
encoding is as in XML_ParserCreate
.
namespace-separator must be a Scheme character in the ASCII
range.
See (expat)XML_SetReturnNSTriplet. If do-nst? is true: turn on returning namespace qualified names as triplets: URI, local name, prefix, rather than the default pairs: URI, local name; if do-nst? is false: turn this off.
The following examples show a simple use of namespace; first let’s take the following as program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (doit xml-utf8) (define (start-callback data element attributes) (pretty-print (list 'start (ffi.cstring->string element) (ffi.argv->strings attributes)))) (define (end-callback data element) (pretty-print (list 'end (ffi.cstring->string element)))) (let ((parser (XML_ParserCreateNS 'UTF-8 #\:)) (start (XML_StartElementHandler start-callback)) (end (XML_EndElementHandler end-callback))) (XML_SetElementHandler parser start end) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (flush-output-port (current-output-port))))
then the following form:
(doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys xmlns:blue='http://localhost/blue' xmlns:red='http://localhost/red'>\ <blue:ball colour='yellow'/>\ <red:ball colour='purple'/>\ </toys>"))
prints the output:
(start "toys" ()) (start "http://localhost/blue:ball" ("colour" "yellow")) (end "http://localhost/blue:ball") (start "http://localhost/red:ball" ("colour" "purple")) (end "http://localhost/red:ball") (end "toys")
the following form shows use of the default namespace:
(doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys xmlns='http://localhost/blue'> <ball colour='yellow'/> <ball colour='purple'/> </toys>"))
the output is:
(start "http://localhost/blue:toys" ()) (start "http://localhost/blue:ball" ("colour" "yellow")) (end "http://localhost/blue:ball") (start "http://localhost/blue:ball" ("colour" "purple")) (end "http://localhost/blue:ball") (end "http://localhost/blue:toys")
now let’s define the following function which makes use of
XML_SetReturnNSTriplet
:
(define (doit-with-triplet xml-utf8) (define (start-callback data element attributes) (pretty-print (list 'start (ffi.cstring->string element) (ffi.argv->strings attributes)))) (define (end-callback data element) (pretty-print (list 'end (ffi.cstring->string element)))) (let ((parser (XML_ParserCreateNS 'UTF-8 #\:)) (start (XML_StartElementHandler start-callback)) (end (XML_EndElementHandler end-callback))) (XML_SetReturnNSTriplet parser #t) (XML_SetElementHandler parser start end) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (flush-output-port (current-output-port))))
the following form:
(doit-with-triplet (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys xmlns:blue='http://localhost/blue' xmlns:red='http://localhost/red'> <blue:ball colour='yellow'/> <red:ball colour='purple'/> </toys>")))
prints the output:
(start "toys" ()) (start "http://localhost/blue:ball:blue" ("colour" "yellow")) (end "http://localhost/blue:ball:blue") (start "http://localhost/red:ball:red" ("colour" "purple")) (end "http://localhost/red:ball:red") (end "toys")
Next: parsers status, Previous: parsers namespaces, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library. In all the descriptions: the parser argument must be a
pointer object referencing the parser.
See (expat)XML_StopParser. Stop parsing causing the parse function to return; return a fixnum representing a status code. If resumable? is true: suspend the parsing for later resumption; if resumable? is false: abort the parsing.
See (expat)XML_ResumeParser. Resume parsing for a suspended
parser. A call to this function is like a call to XML_Parse
or
XML_ParseBuffer
.
The following skeleton program shows the mechanics of aborting parsing:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml-utf8 (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='red'/></toys>")) (define (start-callback parser element attributes) (let ((status (XML_GetParsingStatus parser))) (unless (= XML_STATUS_SUSPENDED (parsing-status-parsing status)) (XML_StopParser parser #f)))) (let ((parser (XML_ParserCreate)) (start (XML_StartElementHandler start-callback))) (XML_SetStartElementHandler parser start) (XML_SetUserData parser parser) (XML_Parse parser xml-utf8 #f #t) ⇒ XML_STATUS_ERROR (ffi.free-c-callback start) (XML_GetErrorCode parser)) ⇒ XML_ERROR_ABORTED
the following skeleton program shows the mechanics of stopping parsing and then resuming:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml-utf8 (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='red'/></toys>")) (define (start-callback-and-suspend parser element attributes) (XML_StopParser parser #t)) (define (start-callback parser element attributes) (void)) (let* ((parser (XML_ParserCreate)) (suspend (XML_StartElementHandler start-callback-and-suspend))) (XML_SetStartElementHandler parser suspend) (XML_SetUserData parser parser) (XML_Parse parser xml-utf8 #f #t) ⇒ XML_STATUS_SUSPENDED (ffi.free-c-callback suspend) (let ((start (XML_StartElementHandler start-callback))) (XML_SetStartElementHandler parser start) (XML_ResumeParser parser) ⇒ XML_STATUS_OK (ffi.free-c-callback start)))
Next: parsers report, Previous: parsers stop, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library. In all the descriptions: the parser argument must be a
pointer object referencing the parser.
See (expat)XML_ParsingStatus. Structure representing the
current parser status as mirror of the C data structure
XML_ParsingStatus
. It has the following fields:
parsing
A fixnum.
final-buffer?
A boolean.
Build and return a new instance of XML_ParsingStatus
.
Return true if obj is an instance of XML_ParsingStatus
.
Accessors for the fields of XML_ParsingStatus
instances.
See (expat)XML_GetParsingStatus. Acquire the current status
of the parser and return an instance of XML_ParsingStatus
.
Next: parsers misc, Previous: parsers status, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library. In all the descriptions: the parser argument must be a
pointer object referencing the parser.
See (expat)XML_GetErrorCode. Return a fixnum representing an error code for the last error while parsing.
See (expat)XML_ErrorString. Return a Scheme string
describing the error associated to code, which must be the return
value of XML_GetErrorCode
.
See (expat)XML_GetCurrentByteIndex. Inspect the current parsing position.
Previous: parsers report, Up: parsers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library. In all the descriptions: the parser argument must be a
pointer object referencing the parser.
See (expat)XML_SetUserData. Setter and getter for custom data pointer used as first argument to many handlers.
See (expat)XML_UseParserAsHandlerArg. Set the parser pointer as first argument to many handlers.
See (expat)XML_SetBase. Set the base to resolve relative
URIs. base can be a bytevector representing a string or
#f
, in which case the base is reset.
See (expat)XML_GetBase. Get the base to resolve relative
URIs and return it as bytevector. If there is no base set: the
return value is #f
.
See (expat)XML_GetSpecifiedAttributeCount. Refer to the original documentation.
See (expat)XML_GetIdAttributeIndex. Refer to the original documentation.
See (expat)XML_UseForeignDTD. If use-dtd? is true:
allow the application to provide an external DTD. Return a fixnum
representing an error code, if successful XML_ERROR_NONE
.
Expat offers a significant number of callbacks to process input from the XML document. If we do not register any handler: the parsing process will proceed successfully producing no side effects in the program.
In the descriptions of this chapters: parser is a pointer of type
XML_Parser
; scheme-callback is a Scheme function used as
callback; c-callback, start-c-callback and
end-c-callback are pointers referencing C language callbacks.
Unless otherwise specified, the Scheme callbacks will be called with Scheme arguments that are the direct conversion of C language arguments: C pointers become pointer objects, C integers become Scheme exact intgers, and so on.
• handlers xml decl: | XML declaration handler. | |
• handlers standalone: | Non-standalone handler. | |
• handlers dtd doctype: | DTD document type declaration. | |
• handlers dtd element: | DTD element declaration. | |
• handlers dtd attlist: | DTD attribute lists declaration. | |
• handlers dtd notation: | DTD notation declaration. | |
• handlers dtd entity: | DTD entity declaration. | |
• handlers element: | Element handlers. | |
• handlers char data: | Character data handlers. | |
• handlers comment: | Comment handlers. | |
• handlers cdata: | Cdata handler. | |
• handlers namespace: | Namespace handlers. | |
• handlers default: | Default handler. | |
• handlers entity: | Special entity handlers. | |
• handlers procinst: | Processing instruction handlers. |
Next: handlers standalone, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_XmlDeclHandler. Maker and setter for XML declaration handlers and text declaration handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (%process-standalone standalone) (case standalone ((-1) 'unspecified) ((0) 'non-standalone) ((1) 'standalone) (else #f))) (define (xml-decl-callback user-data version encoding standalone) (pretty-print (list 'xml-decl (or (ffi.pointer-null? version) (ffi.cstring->string version)) (or (ffi.pointer-null? encoding) (ffi.cstring->string encoding)) (%process-standalone standalone)))) (define (doit xml-utf8) (let ((parser (XML_ParserCreate)) (xml-decl (XML_XmlDeclHandler xml-decl-callback))) (XML_SetXmlDeclHandler parser xml-decl) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback xml-decl) (flush-output-port (current-output-port))))
XML declarations generate the following symbolic expressions:
(doit (string->utf8 "<?xml version='1.0'?> <toys><ball colour='red'/></toys>")) -| (xml-decl "1.0" #t unspecified) (doit (string->utf8 "<?xml version='1.0' encoding='utf-8'?> <toys><ball colour='red'/></toys>")) -| (xml-decl "1.0" "utf-8" unspecified) (doit (string->utf8 "<?xml version='1.0' standalone='yes'?> <toys><ball colour='red'/></toys>")) -| (xml-decl "1.0" #t standalone) (doit (string->utf8 "<?xml version='1.0' standalone='no'?> <toys><ball colour='red'/></toys>")) -| (xml-decl "1.0" #t non-standalone)
Now let’s consider a program preamble in which an external DTD is expected and defined:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (%process-standalone standalone) (case standalone ((-1) 'unspecified) ((0) 'non-standalone) ((1) 'standalone) (else #f))) (define (xml-decl-callback user-data version encoding standalone) (pretty-print (list 'xml-decl (or (ffi.pointer-null? version) (ffi.cstring->string version)) (or (ffi.pointer-null? encoding) (ffi.cstring->string encoding)) (%process-standalone standalone)))) (define dtd-utf8 (string->utf8 "<?xml version='1.0' encoding='utf-8'?> <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED>")) (define (external-entity-callback parser context base system-id public-id) (pretty-print (list 'external-entity (or (ffi.pointer-null? context) (ffi.cstring->string context)) (or (ffi.pointer-null? base) (ffi.cstring->string base)) (ffi.cstring->string system-id) (or (ffi.pointer-null? public-id) (ffi.cstring->string public-id)))) (let* ((parser (XML_ExternalEntityParserCreate parser context 'UTF-8)) (xml-decl (XML_XmlDeclHandler xml-decl-callback))) (XML_SetXmlDeclHandler parser xml-decl) (let ((rv (XML_Parse parser dtd-utf8 #f #t))) (ffi.free-c-callback xml-decl) rv))) (define (doit-with-external-entity xml-utf8) (let* ((parser (XML_ParserCreate)) (xml-decl (XML_XmlDeclHandler xml-decl-callback)) (ext-ent (XML_ExternalEntityRefHandler external-entity-callback))) (XML_SetParamEntityParsing parser XML_PARAM_ENTITY_PARSING_ALWAYS) (XML_SetXmlDeclHandler parser xml-decl) (XML_SetExternalEntityRefHandler parser ext-ent) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback xml-decl) (ffi.free-c-callback ext-ent) (flush-output-port (current-output-port))))
the following form:
(doit-with-external-entity (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='red'/></toys>"))
prints:
(xml-decl "1.0" #t unspecified) (external-entity #t #t "http://localhost/toys" #t) (xml-decl "1.0" "utf-8" unspecified)
showing the XML declaration handler called twice.
Next: handlers dtd doctype, Previous: handlers xml decl, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_NotStandaloneHandler. Maker and setter for non–standalone declaration handler.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (%process-standalone standalone) (case standalone ((-1) 'unspecified) ((0) 'non-standalone) ((1) 'standalone) (else #f))) (define (xml-decl-callback user-data version encoding standalone) (pretty-print (list 'xml-decl (%process-standalone standalone)))) (define (not-stand-callback user-data) (pretty-print '(not-standalone)) XML_STATUS_OK) (define (start-doctype-callback data doctype-name sysid pubid has-internal-subset) (pretty-print (list 'doctype-start has-internal-subset))) (define (end-doctype-callback data) (pretty-print '(doctype-end))) (define (doit xml-utf8) (let ((parser (XML_ParserCreate)) (xml-decl (XML_XmlDeclHandler xml-decl-callback)) (not-stand (XML_NotStandaloneHandler not-stand-callback)) (dt-start (XML_StartDoctypeDeclHandler start-doctype-callback)) (dt-end (XML_EndDoctypeDeclHandler end-doctype-callback))) (XML_SetXmlDeclHandler parser xml-decl) (XML_SetNotStandaloneHandler parser not-stand) (XML_SetStartDoctypeDeclHandler parser dt-start) (XML_SetEndDoctypeDeclHandler parser dt-end) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback xml-decl) (ffi.free-c-callback not-stand) (ffi.free-c-callback dt-start) (ffi.free-c-callback dt-end) (flush-output-port (current-output-port))))
the following forms print symbolic expressions:
(doit (string->utf8 "<?xml version='1.0'?> <toys><ball colour='red'/></toys>")) -| (xml-decl unspecified) (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (xml-decl unspecified) -| (not-standalone) -| (doctype-start 0) -| (doctype-end) (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys PUBLIC 'The Toys' 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (xml-decl unspecified) -| (not-standalone) -| (doctype-start 0) -| (doctype-end) ;;; (doit (string->utf8 "<?xml version='1.0' standalone='no'?> <toys><ball colour='red'/></toys>")) -| (xml-decl non-standalone) (doit (string->utf8 "<?xml version='1.0' standalone='no'?> <!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (xml-decl non-standalone) -| (not-standalone) -| (doctype-start 0) -| (doctype-end) (doit (string->utf8 "<?xml version='1.0' standalone='no'?> <!DOCTYPE toys PUBLIC 'The Toys' 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (xml-decl non-standalone) -| (not-standalone) -| (doctype-start 0) -| (doctype-end) ;;; (doit (string->utf8 "<?xml version='1.0' standalone='yes'?> <toys><ball colour='red'/></toys>")) -| (xml-decl standalone) (doit (string->utf8 "<?xml version='1.0' standalone='yes'?> <!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (xml-decl standalone) -| (doctype-start 0) -| (doctype-end) (doit (string->utf8 "<?xml version='1.0' standalone='yes'?> <!DOCTYPE toys PUBLIC 'The Toys' 'http://localhost/toys'> <toys><ball colour='red'/></toys>")) -| (xml-decl standalone) -| (doctype-start 0) -| (doctype-end)
Next: handlers dtd element, Previous: handlers standalone, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_StartDoctypeDeclHandler. Maker and setter for the start of document type declaration handlers.
See (expat)XML_EndDoctypeDeclHandler. Maker and setter for the end of document type declaration handlers.
See (expat)XML_SetDoctypeDeclHandler. Maker and setter for both the start and end of document type declaration handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (start-callback data doctype-name sysid pubid has-internal-subset) (pretty-print (list 'doctype-start (ffi.cstring->string doctype-name) (or (ffi.pointer-null? sysid) (ffi.cstring->string sysid)) (or (ffi.pointer-null? pubid) (ffi.cstring->string pubid)) has-internal-subset))) (define (end-callback data) (pretty-print '(doctype-end))) (define (doit xml-utf8) (let ((parser (XML_ParserCreate)) (start (XML_StartDoctypeDeclHandler start-callback)) (end (XML_EndDoctypeDeclHandler end-callback))) (XML_SetDoctypeDeclHandler parser start end) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (flush-output-port (current-output-port))))
the following forms print symbolic expressions:
(doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys SYSTEM 'http://localhost/toys'> <toys><ball colour='yellow'/></toys>")) -| (doctype-start "toys" "http://localhost/toys" #t 0) -| (doctype-end) (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys PUBLIC 'The Toys' 'http://localhost/toys'> <toys><ball colour='yellow'/></toys>"))) -| (doctype-start "toys" "http://localhost/toys" "The Toys" 0) -| (doctype-end) (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='yellow'/></toys>"))) -| (doctype-start "toys" #t #t 1) -| (doctype-end)
Next: handlers dtd attlist, Previous: handlers dtd doctype, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_ElementDeclHandler. Maker and setter for the DTD element declaration handlers.
See (expat)XML_FreeContentModel. Release the
model arugment for the XML_ElementDeclHandler
.
Scheme mirror of the C language type XML_Content
. It has the
following fields:
type
One of the XML_CTYPE_
constants.
quant
One of the XML_CQUANT_
constants.
name
For root elements #f
; for children elements: a Scheme string
representing the element’s name.
numchildren
A non–negative fixnum representing the number of children elements.
children
#f
or a vector of XML_Content
structures representing the
children elements.
Maker for structures of type XML_Content
.
Return true if obj is an instance of XML_Content
.
Accessors for the fields of XML_Content
structures.
Given a pointer object referencing a C language XML_Content
structure: build and return a Scheme XML_Content
structure
mirroring it.
Given an instance to XML_Content
return a list holding its fields
in the same order in which they appear in the structure definition.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (doit xml) (let ((xml-utf8 (string->utf8 xml)) (parser (XML_ParserCreate)) (dtd-elm (XML_ElementDeclHandler dtd-elm-callback))) (XML_UseParserAsHandlerArg parser) (XML_SetElementDeclHandler parser dtd-elm) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback dtd-elm) (flush-output-port (current-output-port)))) (define (dtd-elm-callback data name model) (pretty-print (list 'dtd-element (ffi.cstring->string name) (pointer->XML_Content model))) (XML_FreeContentModel data model))
the following forms print symbolic expressions:
(doit "<!DOCTYPE toys [ <!ELEMENT ball EMPTY> ]> <toys><ball/></toys>") -| (dtd-element "ball" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE toys [ <!ELEMENT ball ANY> ]> <toys><ball/></toys>") -| (dtd-element "ball" -| #[expat:XML_Content -| type=XML_CTYPE_ANY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE toys [ <!ELEMENT toys (ball)> <!ELEMENT ball EMPTY> ]> <toys><ball/></toys>") -| (dtd-element "toys" -| #[expat:XML_Content -| type=XML_CTYPE_SEQ quant=XML_CQUANT_NONE -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="ball" numchildren=0 children=#f])]) -| (dtd-element "ball" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE outer [ <!ELEMENT outer (middle)> <!ELEMENT middle (inner)> <!ELEMENT inner EMPTY> ]> <outer><middle><inner/></middle></outer>") -| (dtd-element "outer" -| #[expat:XML_Content -| type=XML_CTYPE_SEQ quant=XML_CQUANT_NONE -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="middle" numchildren=0 children=#f])]) -| (dtd-element "middle" -| #[expat:XML_Content -| type=XML_CTYPE_SEQ quant=XML_CQUANT_NONE -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="inner" numchildren=0 children=#f])]) -| (dtd-element "inner" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE this [ <!ELEMENT this (#PCDATA)> ]> <this>ciao</this>") -| (dtd-element "this" -| #[expat:XML_Content -| type=XML_CTYPE_MIXED quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE this [ <!ELEMENT this (#PCDATA|that)*> <!ELEMENT that EMPTY> ]> <this><that/></this>") -| (dtd-element "this" -| #[expat:XML_Content -| type=XML_CTYPE_MIXED quant=XML_CQUANT_REP -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="that" numchildren=0 children=#f])]) -| (dtd-element "that" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) ;;; quantifiers (doit "<!DOCTYPE toys [ <!ELEMENT toys (ball)*> <!ELEMENT ball EMPTY> ]> <toys><ball/></toys>") -| (dtd-element "toys" -| #[expat:XML_Content -| type=XML_CTYPE_SEQ quant=XML_CQUANT_REP -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="ball" numchildren=0 children=#f])]) -| (dtd-element "ball" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE toys [ <!ELEMENT toys (ball)?> <!ELEMENT ball EMPTY> ]> <toys><ball/></toys>") -| (dtd-element "toys" -| #[expat:XML_Content -| type=XML_CTYPE_SEQ quant=XML_CQUANT_OPT -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="ball" numchildren=0 children=#f])]) -| (dtd-element "ball" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f]) (doit "<!DOCTYPE toys [ <!ELEMENT toys (ball)+> <!ELEMENT ball EMPTY> ]> <toys><ball/></toys>") -| (dtd-element "toys" -| #[expat:XML_Content -| type=XML_CTYPE_SEQ quant=XML_CQUANT_PLUS -| name=#f numchildren=1 -| children=#(#[expat:XML_Content -| type=XML_CTYPE_NAME quant=XML_CQUANT_NONE -| name="ball" numchildren=0 children=#f])]) -| (dtd-element "ball" -| #[expat:XML_Content -| type=XML_CTYPE_EMPTY quant=XML_CQUANT_NONE -| name=#f numchildren=0 children=#f])
Next: handlers dtd notation, Previous: handlers dtd element, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_AttlistDeclHandler. Maker and setter for attributes list DTD declaration handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (doit xml) (let* ((xml-utf8 (string->utf8 xml)) (parser (XML_ParserCreate)) (dtd-attlist (XML_AttlistDeclHandler dtd-attlist-callback)) (elm-start (XML_StartElementHandler elm-start-callback))) (XML_SetAttlistDeclHandler parser dtd-attlist) (XML_SetStartElementHandler parser elm-start) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback dtd-attlist) (ffi.free-c-callback elm-start) (flush-output-port (current-output-port)))) (define (dtd-attlist-callback user-data element-name attribute-name attribute-type default-value required?) (pretty-print (list 'dtd-attlist (ffi.cstring->string element-name) (ffi.cstring->string attribute-name) (ffi.cstring->string attribute-type) (if (ffi.pointer-null? default-value) 'no-value (ffi.cstring->string default-value)) (fxpositive? required?)))) (define (elm-start-callback data element attributes) (pretty-print (list 'element-start (ffi.cstring->string element) (ffi.argv->strings attributes))))
the following forms print symbolic expressions:
(doit "<!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='red' /></toys>") -| (dtd-attlist "ball" "colour" "CDATA" no-value #t) -| (element-start "toys" ()) -| (element-start "ball" ("colour" "red")) (doit "<!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #IMPLIED> ]> <toys><ball colour='red'/></toys>") -| (dtd-attlist "ball" "colour" "CDATA" no-value #f) -| (element-start "toys" ()) -| (element-start "ball" ("colour" "red")) (doit "<!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #FIXED 'red'> ]> <toys><ball/></toys>") -| (dtd-attlist "ball" "colour" "CDATA" "red" #t) -| (element-start "toys" ()) -| (element-start "ball" ("colour" "red")) (doit "<!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour (red|blue|yellow) #REQUIRED> ]> <toys><ball colour='red' /></toys>") -| (dtd-attlist "ball" "colour" "(red|blue|yellow)" -| no-value #t) -| (element-start "toys" ()) -| (element-start "ball" ("colour" "red")) (doit "<!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA 'red'> ]> <toys><ball/></toys>") -| (dtd-attlist "ball" "colour" "CDATA" "red" #f) -| (element-start "toys" ()) -| (element-start "ball" ("colour" "red"))
Next: handlers dtd entity, Previous: handlers dtd attlist, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_NotationDeclHandler. Maker and setter for DTD notation handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (%false-or-string thing) (if (ffi.pointer-null? thing) #f (ffi.cstring->string thing))) (define (notation-callback data notation-name base system-id public-id) (pretty-print (list 'notation (%false-or-string notation-name) (%false-or-string base) (%false-or-string system-id) (%false-or-string public-id)))) (define (doit xml-utf8) (let* ((parser (XML_ParserCreate)) (notation (XML_NotationDeclHandler notation-callback))) (XML_SetNotationDeclHandler parser notation) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback notation) (flush-output-port (current-output-port))))
the following forms print symbolic expressions:
(doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!NOTATION bouncing SYSTEM 'http://localhost/bouncer'> <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='red' /></toys>")) -| (notation "bouncing" #f "http://localhost/bouncer" #f) (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!NOTATION bouncing PUBLIC 'The Bouncer'> <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='red' /></toys>")) -| (notation "bouncing" #f #f "The Bouncer") (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!NOTATION bouncing PUBLIC 'The Bouncer' 'http://localhost/bouncer'> <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys><ball colour='red' /></toys>")) -| (notation "bouncing" #f "http://localhost/bouncer" "The Bouncer")
Next: handlers element, Previous: handlers dtd notation, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_EntityDeclHandler. Maker and setter for the entity DTD declaration handler.
See (expat)XML_UnparsedEntityDeclHandler. Maker and setter for unparsed entity DTD declaration handler. Usage of these bindings is deprecated.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (%false-or-string thing) (if (ffi.pointer-null? thing) #f (ffi.cstring->string thing))) (define (doit xml) (let* ((xml-utf8 (string->utf8 xml)) (parser (XML_ParserCreate)) (dtd-entity (XML_EntityDeclHandler dtd-entity-callback)) (elm-start (XML_StartElementHandler elm-start-callback))) (XML_SetBase parser (string->utf8 "http://localhost/")) (XML_SetParamEntityParsing parser XML_PARAM_ENTITY_PARSING_ALWAYS) (XML_SetEntityDeclHandler parser dtd-entity) (XML_SetStartElementHandler parser elm-start) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback dtd-entity) (ffi.free-c-callback elm-start) (flush-output-port (current-output-port)))) (define (dtd-entity-callback data entity-name is-parameter-entity value value-length base system-id public-id notation-name) (pretty-print (list 'dtd-entity (%false-or-string entity-name) (fxpositive? is-parameter-entity) (if (ffi.pointer-null? value) #f (ffi.cstring->string value value-length)) (%false-or-string base) (%false-or-string system-id) (%false-or-string public-id) (%false-or-string notation-name)))) (define (elm-start-callback data element attributes) (pretty-print (list 'element-start (ffi.cstring->string element) (ffi.argv->strings attributes))))
the following forms print symbolic expressions:
;; general internal entity (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!ATTLIST thing frob (a|b|c) #REQUIRED> <!ENTITY stuff 'a'> ]> <thing frob='&stuff;'/>") -| (dtd-entity "stuff" #f "a" "http://localhost/" #f #f #f) -| (element-start "thing" ("frob" "a")) ;; general external entity, SYSTEM (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!ENTITY stuff SYSTEM 'http://localhost/stuff'> ]> <thing/>") -| (dtd-entity "stuff" #f #f "http://localhost/" -| "http://localhost/stuff" #f #f) -| (element-start "thing" ()) ;; general external entity, PUBLIC (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!ENTITY stuff PUBLIC 'The Stuff' 'http://localhost/stuff'> ]> <thing/>") -| (dtd-entity "stuff" #f #f "http://localhost/" -| "http://localhost/stuff" "The Stuff" #f) -| (element-start "thing" ()) ;; general external entity, SYSTEM with notation (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!NOTATION stuffer SYSTEM 'http://localhost/stuffer'> <!ENTITY stuff SYSTEM 'http://localhost/stuff' NDATA stuffer> ]> <thing/>") -| (dtd-entity "stuff" #f #f "http://localhost/" -| "http://localhost/stuff" #f "stuffer") -| (element-start "thing" ()) ;; general external entity, PUBLIC with notation (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!NOTATION stuffer SYSTEM 'http://localhost/stuffer'> <!ENTITY stuff PUBLIC 'The Stuff' 'http://localhost/stuff' NDATA stuffer> ]> <thing/>") -| (dtd-entity "stuff" #f #f "http://localhost/" -| "http://localhost/stuff" "The Stuff" "stuffer") -| (element-start "thing" ()) ;;; ;; parameter internal entity (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ENTITY % stuff 'a'> <!ELEMENT thing EMPTY> <!ATTLIST thing> ]> <thing/>") -| (dtd-entity "stuff" #t "a" "http://localhost/" #f #f #f) -| (element-start "thing" ()) ;; parameter external entity, SYSTEM (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!ENTITY % stuff SYSTEM 'http://localhost/stuff'> ]> <thing/>") -| (dtd-entity "stuff" #t #f "http://localhost/" -| "http://localhost/stuff" #f #f) -| (element-start "thing" ()) ;; parameter external entity, PUBLIC (doit "<?xml version='1.0'?> <!DOCTYPE thing [ <!ELEMENT thing EMPTY> <!ENTITY % stuff PUBLIC 'The Stuff' 'http://localhost/stuff'> ]> <thing/>") -| (dtd-entity "stuff" #t #f "http://localhost/" -| "http://localhost/stuff" "The Stuff" #f) -| (element-start "thing" ())
Next: handlers char data, Previous: handlers dtd entity, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_StartElementHandler. Maker and setter for the element start handler.
See (expat)XML_EndElementHandler. Maker and setter for the element end handler.
See (expat)XML_SetElementHandler. Setter for both the element start and end handlers.
The following program:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml-utf8 (string->utf8 "<!-- this is a test document -->\ <stuff>\ <thing colour=\"yellow\">\ <alpha>one</alpha>\ <beta>two</beta>\ </thing>\ <thing>\ <alpha>123</alpha>\ <beta>456</beta>\ </thing>\ </stuff>")) (define (start-callback data element attributes) (pretty-print (list 'start (ffi.cstring->string element) (ffi.argv->strings attributes)))) (define (end-callback data element) (pretty-print (list 'end (ffi.cstring->string element)))) (let ((parser (XML_ParserCreate)) (start (XML_StartElementHandler start-callback)) (end (XML_EndElementHandler end-callback))) (XML_SetElementHandler parser start end) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (flush-output-port (current-output-port)))
prints:
(start "stuff" ()) (start "thing" ("colour" "yellow")) (start "alpha" ()) (end "alpha") (start "beta" ()) (end "beta") (end "thing") (start "thing" ()) (start "alpha" ()) (end "alpha") (start "beta" ()) (end "beta") (end "thing") (end "stuff")
Next: handlers comment, Previous: handlers element, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_CharacterDataHandler. Maker and setter for the character data handler. Such handlers may be called multiple times to process a single character data string.
The following program:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml-utf8 (string->utf8 "<!-- this is a test document -->\ <stuff>\ <thing colour=\"yellow\">\ <alpha>one</alpha>\ <beta>two</beta>\ </thing>\ <thing>\ <alpha>123</alpha>\ <beta>456</beta>\ </thing>\ </stuff>")) (define (text-callback data buf.ptr buf.len) (pretty-print (list 'text (ffi.cstring->string buf.ptr buf.len)))) (let ((parser (XML_ParserCreate)) (text (XML_CharacterDataHandler text-callback))) (XML_SetCharacterDataHandler parser text) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback text) (flush-output-port (current-output-port)))
prints:
(text "one") (text "two") (text "123") (text "456")
Next: handlers cdata, Previous: handlers char data, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_CommentHandler. Maker and setter for the comment handler.
The following program:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml-utf8 (string->utf8 "<!-- this is a test document -->\ <stuff>\ <thing colour=\"yellow\">\ <alpha>one</alpha>\ <beta>two</beta>\ </thing>\ <thing>\ <alpha>123</alpha>\ <beta>456</beta>\ </thing>\ </stuff>")) (define (comment-callback data cstr) (pretty-print (list 'comment (ffi.cstring->string cstr)))) (let ((parser (XML_ParserCreate)) (comment (XML_CommentHandler comment-callback))) (XML_SetCommentHandler parser comment) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback comment) (flush-output-port (current-output-port)))
prints:
(comment " this is a test document ")
Next: handlers namespace, Previous: handlers comment, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_StartCdataSectionHandler. Maker and setter for the cdata start handler.
See (expat)XML_EndCdataSectionHandler. Maker and setter for the cdata end handler.
See (expat)XML_SetCdataSectionHandler. Setter for both the cdata start and end handlers.
The following program:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define xml-utf8 (string->utf8 "<stuff><![CDATA[ <stuff> ]]></stuff>")) (define (start-cdata-callback data) (pretty-print '(start-cdata))) (define (end-cdata-callback data) (pretty-print '(end-cdata))) (define (text-callback data buf.ptr buf.len) (pretty-print (list 'text (ffi.cstring->string buf.ptr buf.len)))) (let ((parser (XML_ParserCreate)) (start (XML_StartCdataSectionHandler start-cdata-callback)) (end (XML_EndCdataSectionHandler end-cdata-callback)) (text (XML_CharacterDataHandler text-callback))) (XML_SetCdataSectionHandler parser start end) (XML_SetCharacterDataHandler parser text) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (ffi.free-c-callback text) (flush-output-port (current-output-port)))
prints:
(start-cdata) (text " <stuff> ") (end-cdata)
Next: handlers default, Previous: handlers cdata, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_StartNamespaceDeclHandler. Maker and setter for the start–of–namespace handler.
See (expat)XML_EndNamespaceDeclHandler. Maker and setter for the end–of–namespace handler.
See (expat)XML_SetNamespaceDeclHandler. Setter for both the start and end of namespace handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (start-element-callback data element attributes) (pretty-print (list 'element-start (ffi.cstring->string element) (ffi.argv->strings attributes)))) (define (end-element-callback data element) (pretty-print (list 'element-end (ffi.cstring->string element)))) (define (start-xmlns-callback data prefix uri) (pretty-print (list 'xmlns-start (or (ffi.pointer-null? prefix) (ffi.cstring->string prefix)) (or (ffi.pointer-null? uri) (ffi.cstring->string uri))))) (define (end-xmlns-callback data prefix) (pretty-print (list 'xmlns-end (or (ffi.pointer-null? prefix) (ffi.cstring->string prefix))))) (define (doit xml-utf8) (let ((parser (XML_ParserCreateNS 'UTF-8 #\:)) (start-elm (XML_StartElementHandler start-element-callback)) (end-elm (XML_EndElementHandler end-element-callback)) (start-ns (XML_StartNamespaceDeclHandler start-xmlns-callback)) (end-ns (XML_EndNamespaceDeclHandler end-xmlns-callback))) (XML_SetElementHandler parser start-elm end-elm) (XML_SetNamespaceDeclHandler parser start-ns end-ns) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start-elm) (ffi.free-c-callback end-elm) (ffi.free-c-callback start-ns) (ffi.free-c-callback end-ns) (flush-output-port (current-output-port))))
the following forms print symbolic expressions:
;; some namespaces (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys xmlns:blue='http://localhost/blue' xmlns:red='http://localhost/red'>\ <blue:ball colour='yellow'/>\ <red:ball colour='purple'/>\ </toys>")) -| (xmlns-start "blue" "http://localhost/blue") -| (xmlns-start "red" "http://localhost/red") -| (element-start "toys" ()) -| (element-start "http://localhost/blue:ball" -| ("colour" "yellow")) -| (element-end "http://localhost/blue:ball") -| (element-start "http://localhost/red:ball" -| ("colour" "purple")) -| (element-end "http://localhost/red:ball") -| (element-end "toys") -| (xmlns-end "red") -| (xmlns-end "blue") ;; default namespace (doit (string->utf8 "<?xml version='1.0'?> <!DOCTYPE toys [ <!ELEMENT ball EMPTY> <!ATTLIST ball colour CDATA #REQUIRED> ]> <toys xmlns='http://localhost/blue'> <ball colour='yellow'/> <ball colour='purple'/> </toys>")) -| (xmlns-start #t "http://localhost/blue") -| (element-start "http://localhost/blue:toys" ()) -| (element-start "http://localhost/blue:ball" -| ("colour" "yellow")) -| (element-end "http://localhost/blue:ball") -| (element-start "http://localhost/blue:ball" -| ("colour" "purple")) -| (element-end "http://localhost/blue:ball") -| (element-end "http://localhost/blue:toys") -| (xmlns-end #t)
Next: handlers entity, Previous: handlers namespace, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_DefaultHandler. Maker and setter for the default handler.
See (expat)XML_SetDefaultHandlerExpand. Alternative setter for the default handler which does not inhibit the expansion of internal entity references.
See (expat)XML_DefaultCurrent. This function can
be called within a handler for a start element, end element, processing
instruction or character data. It causes the corresponding markup to be
passed to the default handler set by XML_SetDefaultHandler()
or
XML_SetDefaultHandlerExpand()
. It does nothing if there is not a
default handler.
Given the following program opening:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (doit xml-utf8) (define (start-callback data element attributes) (XML_DefaultCurrent data)) (define (end-callback data element) (XML_DefaultCurrent data)) (define (default-callback user-data buf.ptr buf.len) (pretty-print (list 'default (ffi.cstring->string buf.ptr buf.len)))) (let ((parser (XML_ParserCreateNS 'UTF-8 #\:)) (start (XML_StartElementHandler start-callback)) (end (XML_EndElementHandler end-callback)) (default (XML_DefaultHandler default-callback))) (XML_UseParserAsHandlerArg parser) (XML_SetElementHandler parser start end) (XML_SetDefaultHandler parser default) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback start) (ffi.free-c-callback end) (ffi.free-c-callback default) (flush-output-port (current-output-port))))
the following form:
(doit (string->utf8 "<toys><ball colour='yellow'/></toys>"))
prints:
(default "<toys>") (default "<ball colour='yellow'/>") (default "") (default "</toys>")
where the symbolic expression with the empty string is generated by a
call to the end–element handler for the standalone <ball/>
element.
Next: handlers procinst, Previous: handlers default, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_SkippedEntityHandler. Maker and setter for the skipped entity handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (doit xml) (let ((xml-utf8 (string->utf8 xml)) (parser (XML_ParserCreate)) (skip-ent (XML_SkippedEntityHandler skipped-entity-callback))) (XML_SetSkippedEntityHandler parser skip-ent) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback skip-ent) (flush-output-port (current-output-port)))) (define (skipped-entity-callback data entity-name is-parameter-entity) (pretty-print (list 'skipped-entity (ffi.cstring->string entity-name) (fxpositive? is-parameter-entity))))
the following forms print symbolic expressions:
(doit "<?xml version='1.0' standalone='no'?> <!DOCTYPE thing SYSTEM 'http://localhost/thing'> <thing>&ciao;</thing>") -| (skipped-entity "ciao" #f)
Previous: handlers entity, Up: handlers [Contents][Index]
All the following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_ProcessingInstructionHandler. Maker and setter for processing instruction handlers.
Given the following program preamble:
#!r6rs (import (vicare) (vicare xml expat) (vicare xml expat constants) (prefix (vicare ffi) ffi.)) (define (doit xml) (let ((xml-utf8 (string->utf8 xml)) (parser (XML_ParserCreate)) (proc-inst (XML_ProcessingInstructionHandler processing-instruction-callback))) (XML_SetProcessingInstructionHandler parser proc-inst) (XML_Parse parser xml-utf8 #f #t) (ffi.free-c-callback proc-inst) (flush-output-port (current-output-port)))) (define (processing-instruction-callback user-data target data) (pretty-print (list 'processing-instruction (ffi.cstring->string target) (ffi.cstring->string data))))
the following forms print symbolic expressions:
(doit "<?xml version='1.0' standalone='no'?> <!DOCTYPE thing SYSTEM 'http://localhost/thing'> <thing><?scheme (display 123) ?></thing>") -| (processing-instruction "scheme" "(display 123) ")
Next: Package License, Previous: handlers, Up: Top [Contents][Index]
The following bindings are exported by the (vicare xml expat)
library.
See (expat)XML_ExpatVersion. Return a Scheme string representing the Expat version number.
See (expat)XML_ExpatVersionInfo. Return a Scheme vector holding exact integers representing the Expat version numbers: major, minor, micro.
See (expat)XML_GetFeatureList. Return a vector of vectors representing the features of the running version of Expat. Example:
(XML_GetFeatureList) ⇒ #(#(6 "sizeof(XML_Char)" 1) #(7 "sizeof(XML_LChar)" 1) #(3 "XML_DTD" #f) #(4 "XML_CONTEXT_BYTES" 1024) #(8 "XML_NS" #f))
Next: Documentation License, Previous: version, Up: Top [Contents][Index]
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program's name and a brief idea of what it does. Copyright (C) year name of author This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
program Copyright (C) year name of author This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.
Next: references, Previous: Package License, Up: Top [Contents][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with the Front-Cover Texts being list, and with the Back-Cover Texts being list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Next: concept index, Previous: Documentation License, Up: Top [Contents][Index]
The documentation of Vicare/Expat is available online:
the latest version of this package can be downloaded from:
development takes place at:
and as backup at:
the home page of the Vicare project is at:
Expat can be found here:
the XML 1.0 specification is available from:
the recommendation on Namespaces in XML 1.0 is available from:
Next: function index, Previous: references, Up: Top [Contents][Index]
Jump to: | (
F L |
---|
Jump to: | (
F L |
---|
Next: variable index, Previous: concept index, Up: Top [Contents][Index]
Jump to: | M P X |
---|
Jump to: | M P X |
---|
Next: type index, Previous: function index, Up: Top [Contents][Index]
Previous: variable index, Up: Top [Contents][Index]
Jump to: | X |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
X | |||
XML_Content : | handlers dtd element | ||
XML_ParsingStatus : | parsers status | ||
|
Jump to: | X |
---|