Files
CXML/xml/unparse.lisp
2005-12-29 00:37:57 +00:00

575 lines
19 KiB
Common Lisp
Raw Blame History

;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CXML; readtable: runes; Encoding: utf-8; -*-
;;; ---------------------------------------------------------------------------
;;; Title: Unparse XML
;;; Title: (including support for canonic XML according to J.Clark)
;;; Created: 1999-09-09
;;; Author: Gilbert Baumann <unk6@rz.uni-karlsruhe.de>
;;; Author: David Lichteblau <david@lichteblau.com>
;;; License: Lisp-LGPL (See file COPYING for details).
;;; ---------------------------------------------------------------------------
;;; <20>Â<EFBFBD>© copyright 1999 by Gilbert Baumann
;;; <20>Â<EFBFBD>© copyright 2004 by knowledgeTools Int. GmbH
;;; <20>Â<EFBFBD>© copyright 2004 by David Lichteblau (for headcraft.de)
;;; This library is free software; you can redistribute it and/or
;;; modify it under the terms of the GNU Library General Public
;;; License as published by the Free Software Foundation; either
;;; version 2 of the License, or (at your option) any later version.
;;;
;;; This library 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
;;; Library General Public License for more details.
;;;
;;; You should have received a copy of the GNU Library General Public
;;; License along with this library; if not, write to the
;;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;;; Boston, MA 02111-1307 USA.
(in-package :cxml)
;;
;; | Canonical XML
;; | =============
;; |
;; | This document defines a subset of XML called canonical XML. The
;; | intended use of canonical XML is in testing XML processors, as a
;; | representation of the result of parsing an XML document.
;; |
;; | Every well-formed XML document has a unique structurally equivalent
;; | canonical XML document. Two structurally equivalent XML documents have
;; | a byte-for-byte identical canonical XML document. Canonicalizing an
;; | XML document requires only information that an XML processor is
;; | required to make available to an application.
;; |
;; | A canonical XML document conforms to the following grammar:
;; |
;; | CanonXML ::= Pi* element Pi*
;; | element ::= Stag (Datachar | Pi | element)* Etag
;; | Stag ::= '<' Name Atts '>'
;; | Etag ::= '</' Name '>'
;; | Pi ::= '<?' Name ' ' (((Char - S) Char*)? - (Char* '?>' Char*)) '?>'
;; | Atts ::= (' ' Name '=' '"' Datachar* '"')*
;; | Datachar ::= '&amp;' | '&lt;' | '&gt;' | '&quot;'
;; | | '&#9;'| '&#10;'| '&#13;'
;; | | (Char - ('&' | '<' | '>' | '"' | #x9 | #xA | #xD))
;; | Name ::= (see XML spec)
;; | Char ::= (see XML spec)
;; | S ::= (see XML spec)
;; |
;; | Attributes are in lexicographical order (in Unicode bit order).
;; |
;; | A canonical XML document is encoded in UTF-8.
;; |
;; | Ignorable white space is considered significant and is treated
;; | equivalently to data.
;;
;; -- James Clark (jjc@jclark.com)
;;;; SINK: an xml output sink
(defclass sink ()
((ystream :initarg :ystream :accessor sink-ystream)
(width :initform 79 :initarg :width :accessor width)
(canonical :initform t :initarg :canonical :accessor canonical)
(indentation :initform nil :initarg :indentation :accessor indentation)
(current-indentation :initform 0 :accessor current-indentation)
(notations :initform (make-buffer :element-type t) :accessor notations)
(name-for-dtd :accessor name-for-dtd)
(previous-notation :initform nil :accessor previous-notation)
(have-doctype :initform nil :accessor have-doctype)
(stack :initform nil :accessor stack)))
(defmethod initialize-instance :after ((instance sink) &key)
(when (eq (canonical instance) t)
(setf (canonical instance) 1))
(unless (member (canonical instance) '(nil 1 2))
(error "Invalid canonical form: ~A" (canonical instance)))
(when (and (canonical instance) (indentation instance))
(error "Cannot indent XML in canonical mode")))
(defun make-buffer (&key (element-type '(unsigned-byte 8)))
(make-array 1
:element-type element-type
:adjustable t
:fill-pointer 0))
;; total haesslich, aber die ystreams will ich im moment eigentlich nicht
;; dokumentieren
(macrolet ((define-maker (make-sink make-ystream &rest args)
`(defun ,make-sink (,@args &rest initargs)
(apply #'make-instance
'sink
:ystream (,make-ystream ,@args)
initargs))))
(define-maker make-octet-vector-sink make-octet-vector-ystream)
(define-maker make-octet-stream-sink make-octet-stream-ystream stream)
(define-maker make-rod-sink make-rod-ystream)
#+rune-is-character
(define-maker make-character-stream-sink make-character-stream-ystream stream)
#-rune-is-character
(define-maker make-string-sink/utf8 make-string-ystream/utf8)
#-rune-is-character
(define-maker make-character-stream-sink/utf8
make-character-stream-ystream/utf8
stream))
#+rune-is-character
(defun make-string-sink (&rest args) (apply #'make-rod-sink args))
(defmethod sax:end-document ((sink sink))
(close-ystream (sink-ystream sink)))
;;;; doctype and notations
(defmethod sax:start-document ((sink sink))
(unless (canonical sink)
(%write-rod #"<?xml version=\"1.0\" encoding=\"UTF-8\"?>" sink)
(%write-rune #/U+000A sink)))
(defmethod sax:start-dtd ((sink sink) name public-id system-id)
(setf (name-for-dtd sink) name)
(unless (canonical sink)
(ensure-doctype sink public-id system-id)))
(defun ensure-doctype (sink &optional public-id system-id)
(unless (have-doctype sink)
(setf (have-doctype sink) t)
(%write-rod #"<!DOCTYPE " sink)
(%write-rod (name-for-dtd sink) sink)
(cond
(public-id
(%write-rod #" PUBLIC \"" sink)
(unparse-string public-id sink)
(%write-rod #"\" \"" sink)
(unparse-string system-id sink)
(%write-rod #"\"" sink))
(system-id
(%write-rod #" SYSTEM \"" sink)
(unparse-string public-id sink)
(%write-rod #"\"" sink)))))
(defmethod sax:start-internal-subset ((sink sink))
(ensure-doctype sink)
(%write-rod #" [" sink)
(%write-rune #/U+000A sink))
(defmethod sax:end-internal-subset ((sink sink))
(ensure-doctype sink)
(%write-rod #"]" sink))
(defmethod sax:notation-declaration ((sink sink) name public-id system-id)
(let ((prev (previous-notation sink)))
(when (and (and (canonical sink) (>= (canonical sink) 2))
prev
(not (rod< prev name)))
(error "misordered notations; cannot unparse canonically"))
(setf (previous-notation sink) name))
(%write-rod #"<!NOTATION " sink)
(%write-rod name sink)
(cond
((zerop (length public-id))
(%write-rod #" SYSTEM '" sink)
(%write-rod system-id sink)
(%write-rune #/' sink))
((zerop (length system-id))
(%write-rod #" PUBLIC '" sink)
(%write-rod public-id sink)
(%write-rune #/' sink))
(t
(%write-rod #" PUBLIC '" sink)
(%write-rod public-id sink)
(%write-rod #"' '" sink)
(%write-rod system-id sink)
(%write-rune #/' sink)))
(%write-rune #/> sink)
(%write-rune #/U+000A sink))
(defmethod sax:unparsed-entity-declaration
((sink sink) name public-id system-id notation-name)
(unless (and (canonical sink) (< (canonical sink) 3))
(%write-rod #"<!ENTITY " sink)
(%write-rod name sink)
(cond
((zerop (length public-id))
(%write-rod #" SYSTEM '" sink)
(%write-rod system-id sink)
(%write-rune #/' sink))
((zerop (length system-id))
(%write-rod #" PUBLIC '" sink)
(%write-rod public-id sink)
(%write-rune #/' sink))
(t
(%write-rod #" PUBLIC '" sink)
(%write-rod public-id sink)
(%write-rod #"' '" sink)
(%write-rod system-id sink)
(%write-rune #/' sink)))
(%write-rod #" NDATA " sink)
(%write-rod notation-name sink)
(%write-rune #/> sink)
(%write-rune #/U+000A sink)))
(defmethod sax:external-entity-declaration
((sink sink) kind name public-id system-id)
(when (canonical sink)
(error "cannot serialize parsed entities in canonical mode"))
(%write-rod #"<!ENTITY " sink)
(when (eq kind :parameter)
(%write-rod #" % " sink))
(%write-rod name sink)
(cond
((zerop (length public-id))
(%write-rod #" SYSTEM '" sink)
(%write-rod system-id sink)
(%write-rune #/' sink))
((zerop (length system-id))
(%write-rod #" PUBLIC '" sink)
(%write-rod public-id sink)
(%write-rune #/' sink))
(t
(%write-rod #" PUBLIC '" sink)
(%write-rod public-id sink)
(%write-rod #"' '" sink)
(%write-rod system-id sink)
(%write-rune #/' sink)))
(%write-rune #/> sink)
(%write-rune #/U+000A sink))
(defmethod sax:internal-entity-declaration ((sink sink) kind name value)
(when (canonical sink)
(error "cannot serialize parsed entities in canonical mode"))
(%write-rod #"<!ENTITY " sink)
(when (eq kind :parameter)
(%write-rod #" % " sink))
(%write-rod name sink)
(%write-rune #/U+0020 sink)
(%write-rune #/\" sink)
(unparse-string value sink)
(%write-rune #/\" sink)
(%write-rune #/> sink)
(%write-rune #/U+000A sink))
(defmethod sax:element-declaration ((sink sink) name model)
(when (canonical sink)
(error "cannot serialize element type declarations in canonical mode"))
(%write-rod #"<!ELEMENT " sink)
(%write-rod name sink)
(%write-rune #/U+0020 sink)
(labels ((walk (m)
(cond
((eq m :EMPTY)
(%write-rod "EMPTY" sink))
((eq m :PCDATA)
(%write-rod "#PCDATA" sink))
((atom m)
(unparse-string m sink))
(t
(ecase (car m)
(and
(%write-rune #/\( sink)
(loop for (n . rest) on (cdr m) do
(walk n)
(when rest
(%write-rune #\, sink)))
(%write-rune #/\) sink))
(or
(%write-rune #/\( sink)
(loop for (n . rest) on (cdr m) do
(walk n)
(when rest
(%write-rune #\| sink)))
(%write-rune #/\) sink))
(*
(walk (second m))
(%write-rod #/* sink))
(+
(walk (second m))
(%write-rod #/+ sink))
(?
(walk (second m))
(%write-rod #/? sink)))))))
(walk model))
(%write-rune #/> sink)
(%write-rune #/U+000A sink))
(defmethod sax:attribute-declaration ((sink sink) ename aname type default)
(when (canonical sink)
(error "cannot serialize attribute type declarations in canonical mode"))
(%write-rod #"<!ATTLIST " sink)
(%write-rod ename sink)
(%write-rune #/U+0020 sink)
(%write-rod aname sink)
(%write-rune #/U+0020 sink)
(cond
((atom type)
(%write-rod (rod (string-upcase (symbol-name type))) sink))
(t
(when (eq :NOTATION (car type))
(%write-rod #"NOTATION " sink))
(%write-rune #/\( sink)
(loop for (n . rest) on (cdr type) do
(%write-rod n sink)
(when rest
(%write-rune #\| sink)))
(%write-rune #/\) sink)))
(cond
((atom default)
(%write-rune #/# sink)
(%write-rod (rod (string-upcase (symbol-name default))) sink))
(t
(when (eq :FIXED (car default))
(%write-rod #"#FIXED " sink))
(%write-rune #/\" sink)
(unparse-string (second default) sink)
(%write-rune #/\" sink)))
(%write-rune #/> sink)
(%write-rune #/U+000A sink))
(defmethod sax:end-dtd ((sink sink))
(when (have-doctype sink)
(%write-rod #">" sink)
(%write-rune #/U+000A sink)))
;;;; elements
(defstruct (tag (:constructor make-tag (name)))
name
(n-children 0)
(have-gt nil))
(defun sink-fresh-line (sink)
(unless (zerop (ystream-column (sink-ystream sink)))
(%write-rune 10 sink)
(indent sink)))
(defun maybe-close-tag (sink)
(let ((tag (car (stack sink))))
(when (and (tag-p tag) (not (tag-have-gt tag)))
(setf (tag-have-gt tag) t)
(%write-rune #/> sink))))
(defmethod sax:start-element
((sink sink) namespace-uri local-name qname attributes)
(declare (ignore namespace-uri local-name))
(maybe-close-tag sink)
(when (stack sink)
(incf (tag-n-children (first (stack sink)))))
(push (make-tag qname) (stack sink))
(when (indentation sink)
(sink-fresh-line sink)
(start-indentation-block sink))
(%write-rune #/< sink)
(%write-rod qname sink)
(let ((atts (sort (copy-list attributes) #'rod< :key #'sax:attribute-qname)))
(dolist (a atts)
(%write-rune #/space sink)
(%write-rod (sax:attribute-qname a) sink)
(%write-rune #/= sink)
(%write-rune #/\" sink)
(unparse-string (sax:attribute-value a) sink)
(%write-rune #/\" sink)))
(when (canonical sink)
(maybe-close-tag sink)))
(defmethod sax:end-element
((sink sink) namespace-uri local-name qname)
(declare (ignore namespace-uri local-name))
(let ((tag (pop (stack sink))))
(unless (tag-p tag)
(error "output does not nest: not in an element"))
(unless (rod= (tag-name tag) qname)
(error "output does not nest: expected ~A but got ~A"
(rod qname) (rod (tag-name tag))))
(when (indentation sink)
(end-indentation-block sink)
(unless (zerop (tag-n-children tag))
(sink-fresh-line sink)))
(cond
((tag-have-gt tag)
(%write-rod '#.(string-rod "</") sink)
(%write-rod qname sink)
(%write-rod '#.(string-rod ">") sink))
(t
(%write-rod #"/>" sink)))))
(defmethod sax:processing-instruction ((sink sink) target data)
(maybe-close-tag sink)
(unless (rod-equal target '#.(string-rod "xml"))
(%write-rod '#.(string-rod "<?") sink)
(%write-rod target sink)
(when data
(%write-rune #/space sink)
(%write-rod data sink))
(%write-rod '#.(string-rod "?>") sink)))
(defmethod sax:start-cdata ((sink sink))
(maybe-close-tag sink)
(push :cdata (stack sink)))
(defmethod sax:characters ((sink sink) data)
(maybe-close-tag sink)
(cond
((and (eq (car (stack sink)) :cdata)
(not (canonical sink))
(not (search #"]]" data)))
(when (indentation sink)
(sink-fresh-line sink))
(%write-rod #"<![CDATA[" sink)
;; XXX signal error if body is unprintable?
(map nil (lambda (c) (%write-rune c sink)) data)
(%write-rod #"]]>" sink))
(t
(if (indentation sink)
(unparse-indented-text data sink)
(let ((y (sink-ystream sink)))
(if (canonical sink)
(loop for c across data do (unparse-datachar c y))
(loop for c across data do (unparse-datachar-readable c y))))))))
(defmethod sax:end-cdata ((sink sink))
(unless (eq (pop (stack sink)) :cdata)
(error "output does not nest: not in a cdata section")))
(defun indent (sink)
(dotimes (x (current-indentation sink))
(%write-rune 32 sink)))
(defun start-indentation-block (sink)
(incf (current-indentation sink) (indentation sink)))
(defun end-indentation-block (sink)
(decf (current-indentation sink) (indentation sink)))
(defun unparse-indented-text (data sink)
(flet ((whitespacep (x)
(or (rune= x #/U+000A) (rune= x #/U+0020))))
(let* ((n (length data))
(pos (position-if-not #'whitespacep data))
(need-whitespace-p nil))
(cond
((zerop n))
(pos
(sink-fresh-line sink)
(while (< pos n)
(let* ((w (or (position-if #'whitespacep data :start (1+ pos)) n))
(next (or (position-if-not #'whitespacep data :start w) n)))
(when need-whitespace-p
(if (< (+ (ystream-column (sink-ystream sink)) w (- pos))
(width sink))
(%write-rune 32 sink)
(sink-fresh-line sink)))
(loop
with y = (sink-ystream sink)
for i from pos below w do
(unparse-datachar-readable (elt data i) y))
(setf need-whitespace-p (< w n))
(setf pos next))))
(t
(%write-rune 32 sink))))))
(defun unparse-string (str sink)
(let ((y (sink-ystream sink)))
(loop for rune across str do (unparse-datachar rune y))))
(defun unparse-datachar (c ystream)
(cond ((rune= c #/&) (write-rod '#.(string-rod "&amp;") ystream))
((rune= c #/<) (write-rod '#.(string-rod "&lt;") ystream))
((rune= c #/>) (write-rod '#.(string-rod "&gt;") ystream))
((rune= c #/\") (write-rod '#.(string-rod "&quot;") ystream))
((rune= c #/U+0009) (write-rod '#.(string-rod "&#9;") ystream))
((rune= c #/U+000A) (write-rod '#.(string-rod "&#10;") ystream))
((rune= c #/U+000D) (write-rod '#.(string-rod "&#13;") ystream))
(t
(write-rune c ystream))))
(defun unparse-datachar-readable (c ystream)
(cond ((rune= c #/&) (write-rod '#.(string-rod "&amp;") ystream))
((rune= c #/<) (write-rod '#.(string-rod "&lt;") ystream))
((rune= c #/>) (write-rod '#.(string-rod "&gt;") ystream))
((rune= c #/\") (write-rod '#.(string-rod "&quot;") ystream))
(t
(write-rune c ystream))))
(defun %write-rune (c sink)
(write-rune c (sink-ystream sink)))
(defun %write-rod (r sink)
(write-rod r (sink-ystream sink)))
;;;; convenience functions for DOMless XML serialization
(defvar *current-element*)
(defvar *sink*)
(defmacro with-xml-output (sink &body body)
`(invoke-with-xml-output (lambda () ,@body) ,sink))
(defun invoke-with-xml-output (fn sink)
(let ((*sink* sink)
(*current-element* nil))
(sax:start-document *sink*)
(funcall fn)
(sax:end-document *sink*)))
(defmacro with-element (qname &body body)
;; XXX Statt qname soll man in zukunft auch mal (lname prefix) angeben
;; koennen. Hat aber Zeit bis DOM 2.
(when (listp qname)
(destructuring-bind (n) qname
(setf qname n)))
`(invoke-with-element (lambda () ,@body) ,qname))
(defun maybe-emit-start-tag ()
(when *current-element*
;; starting child node, need to emit opening tag of parent first:
(destructuring-bind (qname &rest attributes) *current-element*
(sax:start-element *sink* nil nil qname (reverse attributes)))
(setf *current-element* nil)))
(defun invoke-with-element (fn qname)
(setf qname (rod qname))
(maybe-emit-start-tag)
(let ((*current-element* (list qname)))
(multiple-value-prog1
(funcall fn)
(maybe-emit-start-tag)
(sax:end-element *sink* nil nil qname))))
(defun attribute (name value)
(push (sax:make-attribute :qname (rod name) :value (rod value))
(cdr *current-element*))
value)
(defun cdata (data)
(sax:start-cdata *sink*)
(sax:characters *sink* (rod data))
(sax:end-cdata *sink*)
data)
(defun text (data)
(maybe-emit-start-tag)
(sax:characters *sink* (rod data))
data)
(defun rod-to-utf8-string (rod)
(let ((out (make-buffer :element-type 'character)))
(runes-to-utf8/adjustable-string out rod (length rod))
out))
(defun utf8-string-to-rod (str)
(let* ((bytes (map '(vector (unsigned-byte 8)) #'char-code str))
(buffer (make-array (length bytes) :element-type '(unsigned-byte 16)))
(n (decode-sequence :utf-8 bytes 0 (length bytes) buffer 0 0 nil))
(result (make-array n :element-type 'rune)))
(map-into result #'code-rune buffer)
result))