Copyright	Copyright (C) 2011 Uwe Schmidt
License	MIT
Maintainer	Uwe Schmidt (uwe@fh-wedel.de)
Stability	stable
Portability	portable
Safe Haskell	None
Language	Haskell98

Text.XML.HXT.Arrow.Edit

Description

common edit arrows

Synopsis

Documentation

canonicalizeAllNodes :: ArrowList a => a XmlTree XmlTree Source

Applies some "Canonical XML" rules to a document tree.

The rule differ slightly for canonical XML and XPath in handling of comments

Note: This is not the whole canonicalization as it is specified by the W3C Recommendation. Adding attribute defaults or sorting attributes in lexicographic order is done by the transform function of module Text.XML.HXT.Validator.Validation. Replacing entities or line feed normalization is done by the parser.

Rules: remove DTD parts, processing instructions, comments and substitute char refs in attribute values and text

Not implemented yet:

Whitespace within start and end tags is normalized
Special characters in attribute values and character content are replaced by character references

canonicalizeForXPath :: ArrowList a => a XmlTree XmlTree Source

Canonicalize a tree for XPath Like canonicalizeAllNodes but comment nodes are not removed

see canonicalizeAllNodes

canonicalizeContents :: ArrowList a => a XmlTree XmlTree Source

Canonicalize the contents of a document

substitutes all char refs in text and attribute values, removes CDATA section and combines all sequences of resulting text nodes into a single text node

see canonicalizeAllNodes

collapseAllXText :: ArrowList a => a XmlTree XmlTree Source

Applies collapseXText recursively.

see also : collapseXText

collapseXText :: ArrowList a => a XmlTree XmlTree Source

Collects sequences of text nodes in the list of children of a node into one single text node. This is useful, e.g. after char and entity reference substitution

xshowEscapeXml :: ArrowXml a => a n XmlTree -> a n String Source

apply an arrow to the input and convert the resulting XML trees into an XML escaped string

This is a save variant for converting a tree into an XML string representation that is parsable with ReadDocument. It is implemented with xshow, but xshow does no XML escaping. The XML escaping is done with escapeXmlDoc before xshow is applied.

So the following law holds

xshowEscapeXml f >>> xread == f

escapeXmlRefs :: (Char -> String -> String, Char -> String -> String) Source

escapeHtmlRefs :: (Char -> String -> String, Char -> String -> String) Source

haskellRepOfXmlDoc :: ArrowList a => a XmlTree XmlTree Source

convert a document into a Haskell representation (with show).

Useful for debugging and trace output. see also : treeRepOfXmlDoc, numberLinesInXmlDoc

treeRepOfXmlDoc :: ArrowList a => a XmlTree XmlTree Source

convert a document into a text representation in tree form.

Useful for debugging and trace output. see also : haskellRepOfXmlDoc, numberLinesInXmlDoc

addHeadlineToXmlDoc :: ArrowXml a => a XmlTree XmlTree Source

indentDoc :: ArrowXml a => a XmlTree XmlTree Source

filter for indenting a document tree for pretty printing.

the tree is traversed for inserting whitespace for tag indentation.

whitespace is only inserted or changed at places, where it isn't significant, is's not inserted between tags and text containing non whitespace chars.

whitespace is only inserted or changed at places, where it's not significant. preserving whitespace may be controlled in a document tree by a tag attribute xml:space

allowed values for this attribute are default | preserve.

input is a complete document tree or a document fragment result is the semantically equivalent formatted tree.