1 ;;; -*- show-trailing-whitespace: t; indent-tabs-mode: nil -*-
3 ;;; Copyright (c) 2007,2008 David Lichteblau, Ivan Shvedunov.
4 ;;; All rights reserved.
6 ;;; Redistribution and use in source and binary forms, with or without
7 ;;; modification, are permitted provided that the following conditions
10 ;;; * Redistributions of source code must retain the above copyright
11 ;;; notice, this list of conditions and the following disclaimer.
13 ;;; * Redistributions in binary form must reproduce the above
14 ;;; copyright notice, this list of conditions and the following
15 ;;; disclaimer in the documentation and/or other materials
16 ;;; provided with the distribution.
18 ;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR 'AS IS' AND ANY EXPRESSED
19 ;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 ;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 ;;; ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 ;;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 ;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
24 ;;; GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 ;;; INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 ;;; WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27 ;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 ;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 (in-package :xuriella
)
33 (declaim (optimize (debug 2)))
38 (defmacro define-instruction
(name (args-var env-var
) &body body
)
39 `(setf (get ',name
'xslt-instruction
)
40 (lambda (,args-var
,env-var
)
41 (declare (ignorable ,env-var
))
44 (define-instruction if
(args env
)
45 (destructuring-bind (test then
&optional else
) args
46 (let ((test-thunk (compile-xpath test env
))
47 (then-thunk (compile-instruction then env
))
48 (else-thunk (when else
(compile-instruction else env
))))
51 ((xpath:boolean-value
(funcall test-thunk ctx
))
52 (funcall then-thunk ctx
))
54 (funcall else-thunk ctx
)))))))
56 (define-instruction when
(args env
)
57 (destructuring-bind (test &rest body
) args
58 (compile-instruction `(if ,test
(progn ,@body
)) env
)))
60 (define-instruction unless
(args env
)
61 (destructuring-bind (test &rest body
) args
62 (compile-instruction `(if (:not
,test
) (progn ,@body
)) env
)))
64 (define-instruction cond
(args env
)
66 (destructuring-bind ((test &body body
) &rest clauses
) args
67 (compile-instruction (if (eq test t
)
75 (define-instruction progn
(args env
)
77 (let ((first-thunk (compile-instruction (first args
) env
))
78 (rest-thunk (compile-instruction `(progn ,@(rest args
)) env
)))
80 (funcall first-thunk ctx
)
81 (funcall rest-thunk ctx
)))
84 (defun decode-qname/runtime
(qname namespaces attributep
)
86 (multiple-value-bind (prefix local-name
)
89 (if (or prefix
(not attributep
))
90 (cdr (assoc prefix namespaces
:test
'equal
))
93 (cxml:well-formedness-violation
()
94 (xslt-error "not a qname: ~A" qname
))))
96 (define-instruction xsl
:element
(args env
)
97 (destructuring-bind ((name &key namespace use-attribute-sets
)
100 (declare (ignore use-attribute-sets
)) ;fixme
101 (multiple-value-bind (name-thunk constant-name-p
)
102 (compile-avt name env
)
103 (multiple-value-bind (ns-thunk constant-ns-p
)
105 (compile-avt namespace env
)
107 (let ((body-thunk (compile-instruction `(progn ,@body
) env
)))
108 (if (and constant-name-p constant-ns-p
)
109 (compile-element/constant-name name namespace env body-thunk
)
110 (compile-element/runtime name-thunk ns-thunk body-thunk
)))))))
112 (defun compile-element/constant-name
(qname namespace env body-thunk
)
113 ;; the simple case: compile-time decoding of the QName
114 (multiple-value-bind (local-name uri prefix
)
115 (decode-qname qname env nil
)
117 (setf uri namespace
))
119 (with-element (local-name uri
:suggested-prefix prefix
)
120 (funcall body-thunk ctx
)))))
122 (defun compile-element/runtime
(name-thunk ns-thunk body-thunk
)
123 ;; run-time decoding of the QName, but using the same namespaces
124 ;; that would have been known at compilation time.
125 (let ((namespaces *namespaces
*))
127 (let ((qname (funcall name-thunk ctx
)))
128 (multiple-value-bind (local-name uri prefix
)
129 (decode-qname/runtime qname namespaces nil
)
131 (setf uri
(funcall ns-thunk ctx
)))
134 (with-element (local-name uri
:suggested-prefix prefix
)
135 (funcall body-thunk ctx
)))))))
137 (define-instruction xsl
:use-attribute-sets
(args env
)
138 (destructuring-bind (str) args
139 (let ((sets (mapcar (lambda (qname)
140 (multiple-value-list (decode-qname qname env nil
)))
143 (loop for
(local-name uri nil
) in sets do
144 (dolist (thunk (find-attribute-set local-name uri
))
145 (funcall thunk ctx
)))))))
147 (define-instruction xsl
:attribute
(args env
)
148 (destructuring-bind ((name &key namespace
) &body body
) args
150 (xslt-error "xsl:attribute: name not specified"))
151 (multiple-value-bind (name-thunk constant-name-p
)
152 (compile-avt name env
)
153 (multiple-value-bind (ns-thunk constant-ns-p
)
155 (compile-avt namespace env
)
157 (let ((value-thunk (compile-instruction `(progn ,@body
) env
)))
158 (if (and constant-name-p constant-ns-p
)
159 (compile-attribute/constant-name name namespace env value-thunk
)
160 (compile-attribute/runtime name-thunk ns-thunk value-thunk
)))))))
162 (defun compile-attribute/constant-name
(qname namespace env value-thunk
)
163 ;; the simple case: compile-time decoding of the QName
164 (multiple-value-bind (local-name uri prefix
)
165 (decode-qname qname env nil
)
167 (setf uri namespace
))
169 (write-attribute local-name
171 (with-text-output-sink (s)
173 (funcall value-thunk ctx
)))
174 :suggested-prefix prefix
))))
176 (defun compile-attribute/runtime
(name-thunk ns-thunk value-thunk
)
177 ;; run-time decoding of the QName, but using the same namespaces
178 ;; that would have been known at compilation time.
179 (let ((namespaces *namespaces
*))
181 (let ((qname (funcall name-thunk ctx
)))
182 (multiple-value-bind (local-name uri prefix
)
183 (decode-qname/runtime qname namespaces nil
)
185 (setf uri
(funcall ns-thunk ctx
)))
186 (write-attribute local-name
188 (with-text-output-sink (s)
190 (funcall value-thunk ctx
)))
191 :suggested-prefix prefix
))))))
193 (defun remove-excluded-namespaces
194 (namespaces &optional
(excluded-uris *excluded-namespaces
*))
195 (let ((koerbchen '())
198 for cons in namespaces
199 for
(prefix . uri
) = cons
202 ((find prefix kroepfchen
:test
#'equal
))
203 ((find uri excluded-uris
:test
#'equal
)
204 (push prefix kroepfchen
))
206 (push cons koerbchen
))))
209 (define-instruction xsl
:literal-element
(args env
)
211 ((local-name &optional
(uri "") suggested-prefix
) &body body
)
213 (let ((body-thunk (compile-instruction `(progn ,@body
) env
))
214 (namespaces (remove-excluded-namespaces *namespaces
*)))
216 (with-element (local-name uri
217 :suggested-prefix suggested-prefix
218 :extra-namespaces namespaces
)
219 (funcall body-thunk ctx
))))))
221 (define-instruction xsl
:literal-attribute
(args env
)
222 (destructuring-bind ((local-name &optional uri suggested-prefix
) value
) args
223 (let ((value-thunk (compile-avt value env
)))
225 (write-attribute local-name
227 (funcall value-thunk ctx
)
228 :suggested-prefix suggested-prefix
)))))
230 (define-instruction xsl
:text
(args env
)
231 (destructuring-bind (str) args
233 (declare (ignore ctx
))
236 (define-instruction xsl
:processing-instruction
(args env
)
237 (destructuring-bind (name &rest body
) args
238 (let ((name-thunk (compile-avt name env
))
239 (value-thunk (compile-instruction `(progn ,@body
) env
)))
241 (write-processing-instruction
242 (funcall name-thunk ctx
)
243 (with-text-output-sink (s)
245 (funcall value-thunk ctx
))))))))
247 (define-instruction xsl
:comment
(args env
)
248 (let ((value-thunk (compile-instruction `(progn ,@args
) env
)))
250 (write-comment (with-text-output-sink (s)
252 (funcall value-thunk ctx
)))))))
254 (define-instruction xsl
:value-of
(args env
)
255 (destructuring-bind (xpath) args
256 (let ((thunk (compile-xpath xpath env
)))
259 (write-text (xpath:string-value
(funcall thunk ctx
))))
260 "value-of ~s = ~s" xpath
:result
))))
262 (define-instruction xsl
:unescaped-value-of
(args env
)
263 (destructuring-bind (xpath) args
264 (let ((thunk (compile-xpath xpath env
)))
266 (write-unescaped (xpath:string-value
(funcall thunk ctx
)))))))
268 (define-instruction xsl
:copy-of
(args env
)
269 (destructuring-bind (xpath) args
270 (let ((thunk (compile-xpath xpath env
))
271 ;; FIXME: what was this for? --david
272 #+(or) (v (intern-variable "varName" "")))
275 (let ((result (funcall thunk ctx
)))
277 (xpath:node-set
;; FIXME: variables can contain node sets w/fragments inside. Maybe just fragments would do?
278 (xpath:map-node-set
#'copy-into-result
(xpath:sort-node-set result
)))
279 (result-tree-fragment
280 (copy-into-result result
))
282 (write-text (xpath:string-value result
))))))
283 "copy-of ~s" xpath
))))
285 (defun copy-into-result (node)
287 ((result-tree-fragment-p node
)
288 (stp:do-children
(child (result-tree-fragment-node node
))
289 (copy-into-result child
)))
290 ((xpath-protocol:node-type-p node
:element
)
291 (with-element ((xpath-protocol:local-name node
)
292 (xpath-protocol:namespace-uri node
)
293 :suggested-prefix
(xpath-protocol:namespace-prefix node
)
294 :extra-namespaces
(namespaces-as-alist node
))
295 (map-pipe-eagerly #'copy-into-result
296 (xpath-protocol:attribute-pipe node
))
297 (map-pipe-eagerly #'copy-into-result
298 (xpath-protocol:child-pipe node
))))
299 ((xpath-protocol:node-type-p node
:document
)
300 (map-pipe-eagerly #'copy-into-result
301 (xpath-protocol:child-pipe node
)))
303 (copy-leaf-node node
))))
305 (defun make-sorter (spec env
)
306 (destructuring-bind (&key select lang data-type order case-order
)
308 ;; FIXME: implement case-order
309 (declare (ignore lang case-order
))
310 (let ((select-thunk (compile-xpath (or select
".") env
))
311 (numberp (equal data-type
"number"))
312 (f (if (equal order
"descending") -
1 1)))
314 (let ((i (xpath:string-value
315 (funcall select-thunk
(xpath:make-context a
))))
316 (j (xpath:string-value
317 (funcall select-thunk
(xpath:make-context b
)))))
320 (let ((n-a (xpath:number-value i
))
321 (n-b (xpath:number-value j
)))
322 (cond ((and (xpath::nan-p a
)
323 (not (xpath::nan-p b
)))
325 ((and (not (xpath::nan-p a
))
328 ((xpath::compare-numbers
'< n-a n-b
) -
1)
329 ((xpath::compare-numbers
'> n-a n-b
) 1)
336 (defun compose-sorters (sorters)
338 (let ((this (car sorters
))
339 (next (compose-sorters (rest sorters
))))
341 (let ((d (funcall this a b
)))
347 (defun make-sort-predicate (decls env
)
350 (mapcar (lambda (x) (make-sorter x env
)) decls
))))
352 (minusp (funcall sorter a b
)))))
354 (define-instruction xsl
:for-each
(args env
)
355 (destructuring-bind (select &optional decls
&rest body
) args
356 (unless (and (consp decls
)
357 (eq (car decls
) 'declare
))
360 (let ((select-thunk (compile-xpath select env
))
361 (body-thunk (compile-instruction `(progn ,@body
) env
))
364 (make-sort-predicate (cdr decls
) env
))))
366 (let ((selected (funcall select-thunk ctx
)))
367 (unless (xpath:node-set-p selected
)
368 (xslt-error "for-each select expression should yield a node-set"))
369 (let ((nodes (xpath::force
370 (xpath::sorted-pipe-of selected
))))
372 (setf nodes
(sort (copy-list nodes
) sort-predicate
)))
374 with n
= (length nodes
)
379 (xpath:make-context node
(lambda () n
) i
)))))))))
381 (define-instruction xsl
:with-namespaces
(args env
)
382 (destructuring-bind ((&rest forms
) &rest body
) args
383 (let ((*namespaces
* *namespaces
*))
385 (destructuring-bind (prefix uri
) form
386 (push (cons prefix uri
) *namespaces
*)))
387 (compile-instruction `(progn ,@body
) env
))))
389 (define-instruction xsl
:with-excluded-namespaces
(args env
)
390 (destructuring-bind ((&rest uris
) &rest body
) args
391 (let ((*excluded-namespaces
* (append uris
*excluded-namespaces
*)))
392 (compile-instruction `(progn ,@body
) env
))))
394 ;; XSLT disallows multiple definitions of the same variable within a
395 ;; template. Local variables can shadow global variables though.
396 ;; Since our LET syntax makes it natural to shadow local variables the
397 ;; Lisp way, we check for duplicate variables only where instructed to
398 ;; by the XML syntax parser using WITH-DUPLICATES-CHECK:
399 (defvar *template-variables
* nil
)
401 (define-instruction xsl
:with-duplicates-check
(args env
)
402 (let ((*template-variables
* *template-variables
*))
403 (destructuring-bind ((&rest qnames
) &rest body
) args
404 (dolist (qname qnames
)
405 (multiple-value-bind (local-name uri
)
406 (decode-qname qname env nil
)
407 (let ((key (cons local-name uri
)))
408 (when (find key
*template-variables
* :test
#'equal
)
409 (xslt-error "duplicate variable: ~A, ~A" local-name uri
))
410 (push key
*template-variables
*))))
411 (compile-instruction `(progn ,@body
) env
))))
413 (define-instruction xsl
:with-base-uri
(args env
)
414 (destructuring-bind (uri &rest body
) args
415 (let ((*instruction-base-uri
* uri
))
416 (compile-instruction `(progn ,@body
) env
))))
418 (defstruct (result-tree-fragment
419 (:constructor make-result-tree-fragment
(node)))
422 (define-default-method xpath-protocol
:node-p
423 ((node result-tree-fragment
))
426 (define-default-method xpath-protocol
:node-text
427 ((node result-tree-fragment
))
428 (xpath-protocol:node-text
(result-tree-fragment-node node
)))
430 (defun apply-to-result-tree-fragment (ctx thunk
)
432 (with-xml-output (stp:make-builder
)
433 (with-element ("fragment" "")
434 (funcall thunk ctx
)))))
435 (make-result-tree-fragment (stp:document-element document
))))
437 (define-instruction let
(args env
)
438 (destructuring-bind ((&rest forms
) &rest body
) args
439 (let* ((old-top (length *lexical-variable-declarations
*))
440 (vars-and-names (compile-var-bindings/nointern forms env
))
442 (loop for
((local-name . uri
) thunk
) in vars-and-names
444 (list (push-variable local-name
446 *lexical-variable-declarations
*)
448 (let ((thunk (compile-instruction `(progn ,@body
) env
)))
449 (fill *lexical-variable-declarations
* nil
:start old-top
)
451 (loop for
(index var-thunk
) in vars-and-positions
452 do
(setf (lexical-variable-value index
)
453 (funcall var-thunk ctx
)))
454 (funcall thunk ctx
))))))
456 (define-instruction let
* (args env
)
457 (destructuring-bind ((&rest forms
) &rest body
) args
459 (compile-instruction `(let (,(car forms
))
460 (let* (,@(cdr forms
))
463 (compile-instruction `(progn ,@body
) env
))))
465 (define-instruction xsl
:message
(args env
)
466 (compile-message #'warn args env
))
468 (define-instruction xsl
:terminate
(args env
)
469 (compile-message #'error args env
))
471 (defun namespaces-as-alist (element)
472 (let ((namespaces '()))
473 (do-pipe (ns (xpath-protocol:namespace-pipe element
))
474 (push (cons (xpath-protocol:local-name ns
)
475 (xpath-protocol:namespace-uri ns
))
479 (define-instruction xsl
:copy
(args env
)
480 (let ((body (compile-instruction `(progn ,@args
) env
)))
482 (let ((node (xpath:context-node ctx
)))
484 ((xpath-protocol:node-type-p node
:element
)
486 ((xpath-protocol:local-name node
)
487 (xpath-protocol:namespace-uri node
)
488 :suggested-prefix
(xpath-protocol:namespace-prefix node
)
489 :extra-namespaces
(namespaces-as-alist node
))
491 ((xpath-protocol:node-type-p node
:document
)
494 (copy-leaf-node node
)))))))
496 (defun copy-leaf-node (node)
498 ((xpath-protocol:node-type-p node
:text
)
499 (write-text (xpath-protocol:node-text node
)))
500 ((xpath-protocol:node-type-p node
:comment
)
501 (write-comment (xpath-protocol:node-text node
)))
502 ((xpath-protocol:node-type-p node
:processing-instruction
)
503 (write-processing-instruction
504 (xpath-protocol:processing-instruction-target node
)
505 (xpath-protocol:node-text node
)))
506 ((xpath-protocol:node-type-p node
:attribute
)
508 (xpath-protocol:local-name node
)
509 (xpath-protocol:namespace-uri node
)
510 (xpath-protocol:node-text node
)
511 :suggested-prefix
(xpath-protocol:namespace-prefix node
)))
513 (error "don't know how to copy node ~A" node
))))
515 (defun compile-message (fn args env
)
516 (let ((thunk (compile-instruction `(progn ,@args
) env
)))
519 (with-xml-output (cxml:make-string-sink
)
520 (funcall thunk ctx
))))))
522 (define-instruction xsl
:apply-templates
(args env
)
523 (destructuring-bind ((&key select mode
) &rest param-binding-specs
) args
525 (when (and (consp (car param-binding-specs
))
526 (eq (caar param-binding-specs
) 'declare
))
527 (cdr (pop param-binding-specs
))))
529 (compile-xpath (or select
"child::node()") env
))
531 (compile-var-bindings param-binding-specs env
))
534 (make-sort-predicate decls env
))))
535 (multiple-value-bind (mode-local-name mode-uri
)
536 (and mode
(decode-qname mode env nil
))
538 (let ((*mode
* (if mode
539 (or (find-mode *stylesheet
*
544 (apply-templates/list
546 (xpath::sorted-pipe-of
(funcall select-thunk ctx
)))
547 (loop for
(name nil value-thunk
) in param-bindings
548 collect
(list name
(funcall value-thunk ctx
)))
549 sort-predicate
)))))))
551 (define-instruction xsl
:apply-imports
(args env
)
552 (declare (ignore args env
))
554 (declare (ignore ctx
))
555 (funcall *apply-imports
*)))
557 (define-instruction xsl
:call-template
(args env
)
558 (destructuring-bind (name &rest param-binding-specs
) args
559 (let ((param-bindings
560 (compile-var-bindings param-binding-specs env
)))
561 (multiple-value-bind (local-name uri
)
562 (decode-qname name env nil
)
563 (setf name
(cons local-name uri
)))
565 (call-template ctx name
566 (loop for
(name nil value-thunk
) in param-bindings
567 collect
(list name
(funcall value-thunk ctx
))))))))
569 ;; fixme: incompatible with XSLT 2.0
570 (define-instruction xsl
:document
(args env
)
571 (destructuring-bind ((href &key method indent doctype-public doctype-system
)
574 (declare (ignore doctype-public doctype-system
)) ;fixme
575 (let ((thunk (compile-instruction `(progn ,@body
) env
))
576 (href-thunk (compile-avt href env
)))
580 (puri:merge-uris
(funcall href-thunk ctx
)
581 (xpath-protocol:base-uri
582 (xpath:context-node ctx
))))))
583 (ensure-directories-exist pathname
) ;really?
584 (invoke-with-output-sink
587 (make-output-specification :method
(or method
"XML") :indent indent
)
590 (defun compile-instruction (form env
)
592 (funcall (or (get (car form
) 'xslt-instruction
)
593 (error "undefined instruction: ~A" (car form
)))
596 "instruction ~s" (car form
)))
598 ;;: WTF: "A right curly brace inside a Literal in an expression is not
599 ;;; recognized as terminating the expression."
601 ;;; Da hilft nur tagbody.
602 (defun parse-attribute-value-template (template-string)
603 (with-input-from-string (input template-string
)
604 (let ((ordinary (make-string-output-stream))
605 (xpath (make-string-output-stream))
607 (c (read-char input nil
:eof
)))
609 (let ((o (get-output-stream-string ordinary
)))
610 (when (plusp (length o
))
611 (push (list :data o
) tokens
)))
612 (let ((x (get-output-stream-string xpath
)))
613 (when (plusp (length x
))
614 (push (list :xpath x
) tokens
))))
616 (write-char c ordinary
))
618 (write-char c xpath
)))
619 (macrolet ((goto (target)
621 (setf c
(read-char input nil
:eof
))
642 (goto in-single-quote
))
644 (xslt-error "unexpected end of avt")))
653 (goto in-single-quote
))
656 (goto in-double-quote
))
658 (goto seen-closing-
}))
660 (xslt-error "unexpected end of avt")))
670 (xslt-error "unexpected end of avt")))
672 (goto in-single-quote
)
680 (xslt-error "unexpected end of avt")))
682 (goto in-double-quote
)
703 (xslt-error "unexpected closing brace in avt")
709 (defun compile-avt (template-string env
)
715 (constantly (second x
)))
718 (compile-xpath (second x
) env
))))
719 (parse-attribute-value-template template-string
))))
720 (values (lambda (ctx)
721 (with-output-to-string (s)
723 (write-string (xpath:string-value
(funcall fn ctx
)) s
))))
727 ;;;; Indentation for slime
729 (defmacro define-indentation
(name (&rest args
))
730 (labels ((collect-variables (list)
736 (collect-variables sub
))
738 (if (eql (mismatch "&" (symbol-name sub
)) 1)
741 `(defmacro ,name
(,@args
)
742 (declare (ignorable ,@(collect-variables args
)))
743 (error "XSL indentation helper ~A used literally in lisp code"
746 (define-indentation xsl
:element
747 ((name &key namespace use-attribute-sets
) &body body
))
748 (define-indentation xsl
:literal-element
((name &optional uri
) &body body
))
749 (define-indentation xsl
:attribute
((name &key namespace
) &body body
))
750 (define-indentation xsl
:literal-attribute
((name &optional uri
) &body body
))
751 (define-indentation xsl
:text
(str))
752 (define-indentation xsl
:processing-instruction
(name &body body
))
753 (define-indentation xsl
:comment
(&body body
))
754 (define-indentation xsl
:value-of
(xpath))
755 (define-indentation xsl
:unescaped-value-of
(xpath))
756 (define-indentation xsl
:for-each
(select &body decls-and-body
))
757 (define-indentation xsl
:message
(&body body
))
758 (define-indentation xsl
:terminate
(&body body
))
759 (define-indentation xsl
:apply-templates
((&key select mode
) &body decls-and-body
))
760 (define-indentation xsl
:call-template
(name &rest parameters
))
761 (define-indentation xsl
:copy-of
(xpath))
765 (defun test-instruction (form document
)
766 (let ((thunk (compile-instruction form
(make-instance 'lexical-environment
)))
767 (root (cxml:parse document
(stp:make-builder
))))
768 (with-xml-output (cxml:make-string-sink
)
769 (funcall thunk
(xpath:make-context root
)))))