aggregate-xmlns

Usage: (aggregate-xmlns xml)

Put all occurring xmlns into the root

alias-uri

Usage: (alias-uri & {:as alias-nss})

Define a Clojure namespace aliases for xmlns uris.

This sets up the current namespace for reading qnames denoted with
Clojure's ::alias/keywords reader feature.


## Example
(alias-uri :D "DAV:")
                         ; similar in effect to
;; (require '[xmlns.DAV%3A :as D])
                         ; but required namespace is auto-created
                         ; henceforth, shorthand keywords can be used
{:tag ::D/propfind}
                         ; ::D/propfind will be expanded to :xmlns.DAV%3A/propfind
                         ; in the current namespace by the reader

## Clojurescript support
Currently, namespaces can't be auto-created in Clojurescript.
Dummy files for aliased uris have to exist. Have a look at `uri-file` and `print-uri-file-command!` to create those.

cdata

Usage: (cdata content)

Create a CData node

element

Usage: (element tag)
       (element tag attrs)
       (element tag attrs & content)

Create an xml Element from content varargs

element*

Usage: (element* tag attrs content meta)
       (element* tag attrs content)

Create an xml element from a content collection and optional metadata

element-nss

Usage: (element-nss {:keys [attrs], :as element})

Get xmlns environment from element

emit

Usage: (emit e writer & {:as opts})

Prints the given Element tree as XML text to stream.
Options:
 :encoding <str>          Character encoding to use
 :doctype  <str>          Document type (DOCTYPE) declaration to use

emit-str

Usage: (emit-str e & opts)

Emits the Element to String and returns it.
Options:
 :encoding <str>          Character encoding to use
 :doctype  <str>          Document type (DOCTYPE) declaration to use

event-seq

Usage: (event-seq source {:keys [include-node? location-info coalescing supporting-external-entities allocator namespace-aware replacing-entity-references validating reporter resolver support-dtd], :or {include-node? #{:characters :element}, location-info true, coalescing true, supporting-external-entities false}})

Parses an XML input source into a lazy sequence of pull events.

Input source can be a java.io.InputStream or java.io.Reader

Options:

  :include-node? subset of #{:element :characters :comment}, default #{:element :characters}
  :location-info pass false to skip generating location meta data, default true

See https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLInputFactory.html
for documentation on xml options. These are the defaults:

  {:allocator                    nil      ; XMLInputFactory/ALLOCATOR
   :coalescing                   true     ; XMLInputFactory/IS_COALESCING
   :namespace-aware              true     ; XMLInputFactory/IS_NAMESPACE_AWARE
   :replacing-entity-references  true     ; XMLInputFactory/IS_REPLACING_ENTITY_REFERENCES
   :supporting-external-entities false    ; XMLInputFactory/IS_SUPPORTING_EXTERNAL_ENTITIES
   :validating                   false    ; XMLInputFactory/IS_VALIDATING
   :reporter                     nil      ; XMLInputFactory/REPORTER
   :resolver                     nil      ; XMLInputFactory/RESOLVER
   :support-dtd                  true     ; XMLInputFactory/SUPPORT_DTD
   }

find-xmlns

Usage: (find-xmlns xml)

Find all xmlns occuring in a root

indent

Usage: (indent e writer & opts)

Emits the XML and indents the result.  WARNING: this is slow
it will emit the XML and read it in again to indent it.  Intended for
debugging/testing only.

indent-str

Usage: (indent-str e & opts)

Emits the XML and indents the result.  Writes the results to a String and returns it

parse

Usage: (parse source & {:keys [include-node? location-info coalescing supporting-external-entities allocator namespace-aware replacing-entity-references validating reporter resolver support-dtd], :or {include-node? #{:characters :element}, location-info true, coalescing true, supporting-external-entities false}})

Parses an XML input source into a a tree of Element records.
The element tree is realized lazily, so huge XML files can be streamed through a depth-first tree walk.

Input source can be a java.io.InputStream or java.io.Reader

Options:

  :include-node? subset of #{:element :characters :comment}, default #{:element :characters}
  :location-info pass false to skip generating location meta data, default true

See https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLInputFactory.html
for documentation on xml options. These are the defaults:

  {:allocator                    nil      ; XMLInputFactory/ALLOCATOR
   :coalescing                   true     ; XMLInputFactory/IS_COALESCING
   :namespace-aware              true     ; XMLInputFactory/IS_NAMESPACE_AWARE
   :replacing-entity-references  true     ; XMLInputFactory/IS_REPLACING_ENTITY_REFERENCES
   :supporting-external-entities false    ; XMLInputFactory/IS_SUPPORTING_EXTERNAL_ENTITIES
   :validating                   false    ; XMLInputFactory/IS_VALIDATING
   :reporter                     nil      ; XMLInputFactory/REPORTER
   :resolver                     nil      ; XMLInputFactory/RESOLVER
   :support-dtd                  true     ; XMLInputFactory/SUPPORT_DTD
   }

parse-str

Usage: (parse-str string & {:keys [include-node? location-info coalescing supporting-external-entities allocator namespace-aware replacing-entity-references validating reporter resolver support-dtd], :or {include-node? #{:characters :element}, location-info true, coalescing true, supporting-external-entities false}})

Parses an XML String into a a tree of Element records.

Options:

  :include-node? subset of #{:element :characters :comment}, default #{:element :characters}
  :location-info pass false to skip generating location meta data, default true

See https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLInputFactory.html
for documentation on xml options. These are the defaults:

  {:allocator                    nil      ; XMLInputFactory/ALLOCATOR
   :coalescing                   true     ; XMLInputFactory/IS_COALESCING
   :namespace-aware              true     ; XMLInputFactory/IS_NAMESPACE_AWARE
   :replacing-entity-references  true     ; XMLInputFactory/IS_REPLACING_ENTITY_REFERENCES
   :supporting-external-entities false    ; XMLInputFactory/IS_SUPPORTING_EXTERNAL_ENTITIES
   :validating                   false    ; XMLInputFactory/IS_VALIDATING
   :reporter                     nil      ; XMLInputFactory/REPORTER
   :resolver                     nil      ; XMLInputFactory/RESOLVER
   :support-dtd                  true     ; XMLInputFactory/SUPPORT_DTD
   }

print-uri-file-command!

Usage: (print-uri-file-command! uri)

Shell command to create a dummy file for xmlns. Execute from a source root.

qname-local

Usage: (qname-local v)

Get the name for this qname

qname-uri

Usage: (qname-uri v)

Get the namespace uri for this qname

sexp-as-element

Usage: (sexp-as-element sexp)

Convert a single sexp into an Element

sexps-as-fragment

Usage: (sexps-as-fragment)
       (sexps-as-fragment sexp)
       (sexps-as-fragment sexp & sexps)

Convert a compact prxml/hiccup-style data structure into the more formal
tag/attrs/content format. A seq of elements will be returned, which may
not be suitable for immediate use as there is no root element. See also
sexp-as-element.

The format is [:tag-name attr-map? content*]. Each vector opens a new tag;
seqs do not open new tags, and are just used for inserting groups of elements
into the parent tag. A bare keyword not in a vector creates an empty element.

To provide XML conversion for your own data types, extend the AsElements
protocol to them.

uri-file

Usage: (uri-file uri)

Dummy file name for :require'ing xmlns uri

xml-comment

Usage: (xml-comment content)

Create a Comment node

CDataEvent

CharsEvent

CommentEvent

EmptyElementEvent

EndElementEvent

QNameEvent

StartElementEvent

->CDataEvent

Usage: (->CDataEvent str)

Positional factory function for class clojure.data.xml.event.CDataEvent.

->CharsEvent

Usage: (->CharsEvent str)

Positional factory function for class clojure.data.xml.event.CharsEvent.

->CommentEvent

Usage: (->CommentEvent str)

Positional factory function for class clojure.data.xml.event.CommentEvent.

->EmptyElementEvent

Usage: (->EmptyElementEvent tag attrs nss location-info)

Positional factory function for class clojure.data.xml.event.EmptyElementEvent.

->QNameEvent

Usage: (->QNameEvent qn)

Positional factory function for class clojure.data.xml.event.QNameEvent.

->StartElementEvent

Usage: (->StartElementEvent tag attrs nss location-info)

Positional factory function for class clojure.data.xml.event.StartElementEvent.

element-nss

Usage: (element-nss {:keys [attrs], :as element})

Get xmlns environment from element

map->CDataEvent

Usage: (map->CDataEvent m#)

Factory function for class clojure.data.xml.event.CDataEvent, taking a map of keywords to field values.

map->CharsEvent

Usage: (map->CharsEvent m#)

Factory function for class clojure.data.xml.event.CharsEvent, taking a map of keywords to field values.

map->CommentEvent

Usage: (map->CommentEvent m#)

Factory function for class clojure.data.xml.event.CommentEvent, taking a map of keywords to field values.

map->EmptyElementEvent

Usage: (map->EmptyElementEvent m#)

Factory function for class clojure.data.xml.event.EmptyElementEvent, taking a map of keywords to field values.

map->QNameEvent

Usage: (map->QNameEvent m#)

Factory function for class clojure.data.xml.event.QNameEvent, taking a map of keywords to field values.

map->StartElementEvent

Usage: (map->StartElementEvent m#)

Factory function for class clojure.data.xml.event.StartElementEvent, taking a map of keywords to field values.

compile-if

Usage: (compile-if exp then else)

Evaluate `exp` and if it returns logical true and doesn't error, expand to
`then`.  Else expand to `else`.

see clojure.core.reducers

export-api

Usage: (export-api & names)

This creates vars, that take their (local) name, value and metadata from another var

extend-protocol-fns

Usage: (extend-protocol-fns proto & types+mmaps)

Helper to many types to a protocol with a method map, similar to extend

static-case

Usage: (static-case val & cases)

Variant of case where keys are evaluated at compile-time

write-document

Usage: (write-document swriter events opts)

Writes the given event seq as XML text to writer.
Options:
 :encoding <str>          Character encoding to use
 :doctype  <str>          Document type (DOCTYPE) declaration to use

pull-seq

Usage: (pull-seq sreader {:keys [include-node? location-info skip-whitespace namespace-aware], :as opts} ns-envs)

Creates a seq of events.  The XMLStreamConstants/SPACE clause below doesn't seem to
be triggered by the JDK StAX parser, but is by others.  Leaving in to be more complete.

*gen-prefix-counter*

Thread local counter for a single document

alias-uri

Usage: (alias-uri & {:as alias-nss})

Define a Clojure namespace aliases for xmlns uris.

This sets up the current namespace for reading qnames denoted with
Clojure's ::alias/keywords reader feature.


## Example
(alias-uri :D "DAV:")
                         ; similar in effect to
;; (require '[xmlns.DAV%3A :as D])
                         ; but required namespace is auto-created
                         ; henceforth, shorthand keywords can be used
{:tag ::D/propfind}
                         ; ::D/propfind will be expanded to :xmlns.DAV%3A/propfind
                         ; in the current namespace by the reader

## Clojurescript support
Currently, namespaces can't be auto-created in Clojurescript.
Dummy files for aliased uris have to exist. Have a look at `uri-file` and `print-uri-file-command!` to create those.

gen-prefix

Usage: (gen-prefix)
       (gen-prefix n)

Generates an xml prefix.
Zero-arity can only be called, when *gen-prefix-counter* is bound and will increment it.

print-uri-file-command!

Usage: (print-uri-file-command! uri)

Shell command to create a dummy file for xmlns. Execute from a source root.

qname-local

Usage: (qname-local v)

Get the name for this qname

qname-uri

Usage: (qname-uri v)

Get the namespace uri for this qname

separate-xmlns

Usage: (separate-xmlns attrs cont)

Call cont with two args: attributes and xmlns attributes

uri-file

Usage: (uri-file uri)

Dummy file name for :require'ing xmlns uri

xmlns-attr?

Usage: (xmlns-attr? qn)

Is this qname an xmlns declaration?

CData

Comment

Element

ElementIterator

->CData

Usage: (->CData content)

Positional factory function for class clojure.data.xml.node.CData.

->Comment

Usage: (->Comment content)

Positional factory function for class clojure.data.xml.node.Comment.

->Element

Usage: (->Element tag attrs content meta)

Positional factory function for class clojure.data.xml.node.Element.

->ElementIterator

Usage: (->ElementIterator el fields)

Positional factory function for class clojure.data.xml.node.ElementIterator.

cdata

Usage: (cdata content)

Create a CData node

element

Usage: (element tag)
       (element tag attrs)
       (element tag attrs & content)

Create an xml Element from content varargs

element*

Usage: (element* tag attrs content meta)
       (element* tag attrs content)

Create an xml element from a content collection and optional metadata

map->CData

Usage: (map->CData m#)

Factory function for class clojure.data.xml.node.CData, taking a map of keywords to field values.

map->Comment

Usage: (map->Comment m#)

Factory function for class clojure.data.xml.node.Comment, taking a map of keywords to field values.

xml-comment

Usage: (xml-comment content)

Create a Comment node

aggregate-xmlns

Usage: (aggregate-xmlns xml)

Put all occurring xmlns into the root

find-xmlns

Usage: (find-xmlns xml)

Find all xmlns occuring in a root

AsElements

Usage: (as-elements expr)

Return a seq of elements represented by an expression.

AsQName

Usage: (qname-local qname)

Get the name for this qname

Usage: (qname-uri qname)

Get the namespace uri for this qname

AsXmlString

Usage: (xml-str node)

Serialize atribute value or content node

EventGeneration

Protocol for generating new events based on element type

Usage: (gen-event item)

Function to generate an event for e.

Usage: (next-events item next-items)

Returns the next set of events that should occur after e.  next-events are the
events that should be generated after this one is complete.

sexp-as-element

Usage: (sexp-as-element sexp)

Convert a single sexp into an Element

sexps-as-fragment

Usage: (sexps-as-fragment)
       (sexps-as-fragment sexp)
       (sexps-as-fragment sexp & sexps)

Convert a compact prxml/hiccup-style data structure into the more formal
tag/attrs/content format. A seq of elements will be returned, which may
not be suitable for immediate use as there is no root element. See also
sexp-as-element.

The format is [:tag-name attr-map? content*]. Each vector opens a new tag;
seqs do not open new tags, and are just used for inserting groups of elements
into the parent tag. A bare keyword not in a vector creates an empty element.

To provide XML conversion for your own data types, extend the AsElements
protocol to them.

merge

Usage: (merge pu {:keys [:p->u]})

Merge two pu-maps, left to right

merge-prefix-map

Usage: (merge-prefix-map pu pm)

Merge a prefix map into pu-map

reduce-diff

Usage: (reduce-diff f s {ppu :p->u} {pu :p->u})

A high-performance diffing operation, that reduces f over changed and removed prefixes

event-tree

Usage: (event-tree events)

Returns a lazy tree of Element objects for the given seq of Event
objects. See source-seq and parse.

flatten-elements

Usage: (flatten-elements elements)

Flatten a collection of elements to an event seq

seq-tree

Usage: (seq-tree parent exit? node coll)

Takes a seq of events that logically represents
a tree by each event being one of: enter-sub-tree event,
exit-sub-tree event, or node event.

Returns a lazy sequence whose first element is a sequence of
sub-trees and whose remaining elements are events that are not
siblings or descendants of the initial event.

The given exit? function must return true for any exit-sub-tree
event.  parent must be a function of two arguments: the first is an
event, the second a sequence of nodes or subtrees that are children
of the event.  parent must return nil or false if the event is not
an enter-sub-tree event.  Any other return value will become
a sub-tree of the output tree and should normally contain in some
way the children passed as the second arg.  The node function is
called with a single event arg on every event that is neither parent
nor exit, and its return value will become a node of the output tree.

(seq-tree #(when (= %1 :<) (vector %2)) #{:>} str
          [1 2 :< 3 :< 4 :> :> 5 :> 6])
;=> (("1" "2" [("3" [("4")])] "5") 6)