aboutsummaryrefslogtreecommitdiff
path: root/src/clojure/contrib/lazy_xml.clj
diff options
context:
space:
mode:
authorscgilardi <scgilardi@gmail.com>2008-11-13 19:07:22 +0000
committerscgilardi <scgilardi@gmail.com>2008-11-13 19:07:22 +0000
commit195ed359dc9cbff26531900208c77ee27c7b7edc (patch)
treeaa76c0cb76b239c9a040d4766301eca77c44f856 /src/clojure/contrib/lazy_xml.clj
parent04eb37e3ebb622e2799f1a6be48dd8054495620f (diff)
minimual update to Clojure SVN 1094 of lazy-xml with-pull command-line (they load)
Diffstat (limited to 'src/clojure/contrib/lazy_xml.clj')
-rw-r--r--src/clojure/contrib/lazy_xml.clj180
1 files changed, 180 insertions, 0 deletions
diff --git a/src/clojure/contrib/lazy_xml.clj b/src/clojure/contrib/lazy_xml.clj
new file mode 100644
index 00000000..64469065
--- /dev/null
+++ b/src/clojure/contrib/lazy_xml.clj
@@ -0,0 +1,180 @@
+(ns clojure.contrib.lazy-xml
+ (:require [clojure.xml :as xml])
+ (:use [clojure.contrib.fcase :only (case)])
+ (:import (org.xml.sax Attributes InputSource)
+ (org.xml.sax.helpers DefaultHandler)
+ (javax.xml.parsers SAXParserFactory)
+ (java.util.concurrent LinkedBlockingQueue TimeUnit)
+ (java.lang.ref WeakReference)
+ (java.io Reader)))
+
+(defstruct node :type :name :attrs :str)
+
+; http://www.extreme.indiana.edu/xgws/xsoap/xpp/
+(def has-pull false)
+(defn- parse-seq-pull [& _])
+(try (load "with_pull.clj")
+ (catch Exception e))
+
+(defn startparse-sax [s ch]
+ (.. SAXParserFactory newInstance newSAXParser (parse s ch)))
+
+(defn parse-seq
+ "Parses the source s, which can be a File, InputStream or String
+ naming a URI. Returns a lazy sequence of maps with two or more of
+ the keys :type, :name, :attrs, and :str. Other SAX-compatible
+ parsers can be supplied by passing startparse, a fn taking a source
+ and a ContentHandler and returning a parser. If a parser is
+ specified, it will be run in a separate thread and be allowed to get
+ ahead by queue-size items, which defaults to maxing. If no parser
+ is specified and org.xmlpull.v1.XmlPullParser is in the classpath,
+ this superior pull parser will be used."
+ ([s] (if has-pull
+ (parse-seq-pull s)
+ (parse-seq s startparse-sax)))
+ ([s startparse] (parse-seq s startparse Integer/MAX_VALUE))
+ ([s startparse queue-size]
+ (let [q (LinkedBlockingQueue. queue-size)
+ NIL (Object.) ;nil sentinel since LBQ doesn't support nils
+ agt (agent nil)
+ s (if (instance? Reader s) (InputSource. s) s)
+ step (fn step []
+ (if-let [x (.take q)]
+ (lazy-cons x (step))
+ @agt)) ;will be nil, touch agent just to propagate errors
+ keep-alive (WeakReference. step)
+ enqueue (fn [x]
+ (if (.get keep-alive)
+ (when-not (.offer q x 1 TimeUnit/SECONDS)
+ (recur x))
+ (throw (Exception. "abandoned"))))]
+ (send-off agt
+ (fn [_]
+ (try
+ (startparse s (proxy [DefaultHandler] []
+ (startElement [uri local-name q-name #^Attributes atts]
+ ;(prn :start-element q-name)(flush)
+ (let [attrs (into {} (for [i (range (.getLength atts))]
+ [(keyword (.getQName atts i))
+ (.getValue atts i)]))]
+ (enqueue (struct node :start-element (keyword q-name) attrs))))
+ (endElement [uri local-name q-name]
+ ;(prn :end-element q-name)(flush)
+ (enqueue (struct node :end-element (keyword q-name))))
+ (characters [ch start length]
+ ;(prn :characters)(flush)
+ (let [st (String. ch start length)]
+ (when (seq (.trim st))
+ (enqueue (struct node :characters nil nil st)))))))
+ (finally
+ (.put q false)))))
+ (step))))
+
+
+(defstruct element :tag :attrs :content)
+(def mktree)
+
+(defn- siblings
+ [[event & rst :as s]]
+ (case (:type event)
+ :characters (lazy-cons (:str event) (siblings rst))
+ :start-element (let [t (mktree s)]
+ (lazy-cons (first t) (siblings (rest t))))
+ :end-element [rst]))
+
+(defn- mktree
+ [[elem & events]]
+ (let [sibs (siblings events)]
+ (lazy-cons
+ (struct element (:name elem) (:attrs elem) (drop-last sibs))
+ (last sibs))))
+
+(defn parse-trim
+ "Parses the source s, which can be a File, InputStream or String
+ naming a URI. Returns a lazy tree of the clojure.xml/element
+ struct-map, which has the keys :tag, :attrs, and :content and
+ accessor fns tag, attrs, and content, with the whitespace trimmed
+ from around each content string. This format is compatible with what
+ clojure.xml/parse produces, except :content is a lazy seq instead of
+ a vector. Other SAX-compatible parsers can be supplied by passing
+ startparse, a fn taking a source and a ContentHandler and returning
+ a parser. If a parser is specified, it will be run in a separate
+ thread and be allowed to get ahead by queue-size items, which
+ defaults to maxing. If no parser is specified and
+ org.xmlpull.v1.XmlPullParser is in the classpath, this superior pull
+ parser will be used."
+ ([s] (first (mktree (parse-seq s))))
+ ([s startparse queue-size]
+ (first (mktree (parse-seq s startparse queue-size)))))
+
+(defn emit-element
+ "Recursively prints as XML text the element struct e. To have it
+ print extra whitespace like clojure.xml/emit, use the :pad true
+ option."
+ [e & opts]
+ (let [opts (apply hash-set opts)
+ pad (if (:pad opts) "\n" "")]
+ (if (instance? String e)
+ (print (str e pad))
+ (do
+ (print (str "<" (name (:tag e))))
+ (when (:attrs e)
+ (doseq [attr (:attrs e)]
+ (print (str " " (name (key attr)) "='" (val attr) "'"))))
+ (if (:content e)
+ (do
+ (print (str ">" pad))
+ (doseq [c (:content e)]
+ (emit-element c))
+ (print (str "</" (name (:tag e)) ">" pad)))
+ (print (str "/>" pad)))))))
+
+(defn emit
+ "Prints an <?xml?> declaration line, and then calls emit-element"
+ [x & opts]
+ (println "<?xml version='1.0' encoding='UTF-8'?>")
+ (apply emit-element x opts)
+ (println))
+
+(comment
+
+(def atomstr "<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns='http://www.w3.org/2005/Atom'>
+ <id>tag:blogger.com,1999:blog-28403206</id>
+ <updated>2008-02-14T08:00:58.567-08:00</updated>
+ <title type='text'>n01senet</title>
+ <link rel='alternate' type='text/html' href='http://n01senet.blogspot.com/'/>
+ <entry xmlns:foo='http://foo' xmlns:bar='http://bar'>
+ <id>1</id>
+ <published>2008-02-13</published>
+ <title type='text'>clojure is the best lisp yet</title>
+ <author><name>Chouser</name></author>
+ </entry>
+ <entry>
+ <id>2</id>
+ <published>2008-02-07</published>
+ <title type='text'>experimenting with vnc</title>
+ <author><name>agriffis</name></author>
+ </entry>
+</feed>
+")
+
+(def tree (parse-trim (java.io.StringReader. atomstr)
+ startparse-sax
+ 1))
+(println "\nsax")
+(emit tree)
+
+(def tree (parse-trim (java.io.StringReader. atomstr)))
+(println "\ndefault")
+(emit tree)
+
+(def tree (xml/parse (org.xml.sax.InputSource. (java.io.StringReader. atomstr))))
+(println "\norig")
+(emit tree)
+
+; When used with zip and zip-filter, you can get do queries like this
+; without parsing more than the first few tags:
+; (zip/node (first (xml-> x :id)))
+
+)