Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

118 lines (86 sloc) 4.233 kb
;;; xml.clj -- a pretty print dispatch version of prxml.clj -- a compact syntax for generating XML
;; by Tom Faulhaber, based on the original by Stuart Sierra,
;; May 13, 2009
;; Copyright (c) 2009 Tom Faulhaber/Stuart Sierra. All rights reserved. The use and
;; distribution terms for this software are covered by the Eclipse
;; Public License 1.0 (
;; which can be found in the file epl-v10.html at the root of this
;; distribution. By using this software in any fashion, you are
;; agreeing to be bound by the terms of this license. You must not
;; remove this notice, or any other, from this software.
;; See function "prxml" at the bottom of this file for documentation.
#^{:author "Tom Faulhaber, based on the original by Stuart Sierra",
:doc "A version of prxml that uses a pretty print dispatch function."}
(:use [clojure.contrib.lazy-xml :only (escape-xml)]
[ :only (as-str)]
[clojure.contrib.pprint :only (formatter-out write)]
[clojure.contrib.pprint.utilities :only (prlabel)]))
#^{:doc "If true, empty tags will have a space before the closing />"}
*html-compatible* false)
#^{:doc "The number of spaces to indent sub-tags."}
*prxml-indent* 2)
(defmulti #^{:private true} print-xml-tag (fn [tag attrs content] tag))
(defmethod print-xml-tag :raw! [tag attrs contents]
(doseq [c contents] (print c)))
(defmethod print-xml-tag :comment! [tag attrs contents]
(print "<!-- ")
(doseq [c contents] (print c))
(print " -->"))
(defmethod print-xml-tag :decl! [tag attrs contents]
(let [attrs (merge {:version "1.0" :encoding "UTF-8"}
;; Must enforce ordering of pseudo-attributes:
((formatter-out "<?xml version=\"~a\" encoding=\"~a\"~@[ standalone=\"~a\"~]?>")
(:version attrs) (:encoding attrs) (:standalone attrs))))
(defmethod print-xml-tag :cdata! [tag attrs contents]
((formatter-out "<[!CDATA[~{~a~}]]>") contents))
(defmethod print-xml-tag :doctype! [tag attrs contents]
((formatter-out "<[!DOCTYPE [~{~a~}]]>") contents))
(defmethod print-xml-tag :default [tag attrs contents]
(let [tag-name (as-str tag)
xlated-attrs (map #(vector (as-str (key %)) (as-str (val %))) attrs)]
(if (seq contents)
((formatter-out "~<~<<~a~1:i~{ ~:_~{~a=\"~a\"~}~}>~:>~vi~{~_~w~}~0i~_</~a>~:>")
[[tag-name xlated-attrs] *prxml-indent* contents tag-name])
((formatter-out "~<<~a~1:i~{~:_ ~{~a=\"~a\"~}~}/>~:>") [tag-name xlated-attrs]))))
(defmulti xml-dispatch class)
(defmethod xml-dispatch clojure.lang.IPersistentVector [x]
(let [[tag & contents] x
[attrs content] (if (map? (first contents))
[(first contents) (rest contents)]
[{} contents])]
(print-xml-tag tag attrs content)))
(defmethod xml-dispatch clojure.lang.ISeq [x]
;; Recurse into sequences, so we can use (map ...) inside prxml.
(doseq [c x] (xml-dispatch c)))
(defmethod xml-dispatch clojure.lang.Keyword [x]
(print-xml-tag x {} nil))
(defmethod xml-dispatch String [x]
(print (escape-xml x)))
(defmethod xml-dispatch nil [x])
(defmethod xml-dispatch :default [x]
(print x))
(defn prxml
"Print XML to *out*. Vectors become XML tags: the first item is the
tag name; optional second item is a map of attributes.
Sequences are processed recursively, so you can use map and other
sequence functions inside prxml.
(prxml [:p {:class \"greet\"} [:i \"Ladies & gentlemen\"]])
; => <p class=\"greet\"><i>Ladies &amp; gentlemen</i></p>
PSEUDO-TAGS: some keywords have special meaning:
:raw! do not XML-escape contents
:comment! create an XML comment
:decl! create an XML declaration, with attributes
:cdata! create a CDATA section
:doctype! create a DOCTYPE!
(prxml [:p [:raw! \"<i>here & gone</i>\"]])
; => <p><i>here & gone</i></p>
(prxml [:decl! {:version \"1.1\"}])
; => <?xml version=\"1.1\" encoding=\"UTF-8\"?>"
[& args]
(doseq [arg args] (write arg :dispatch xml-dispatch))
(when (pos? (count args)) (newline)))
Jump to Line
Something went wrong with that request. Please try again.