Safe Haskell | None |
---|---|
Language | Haskell98 |
Text.XML
Contents
Description
DOM-based parsing and rendering.
This module requires that all entities be resolved at parsing. If you need to interact with unresolved entities, please use Text.XML.Unresolved. This is the recommended module for most uses cases.
While many of the datatypes in this module are simply re-exported from
Data.XML.Types
, Document
, Node
and Element
are all redefined here to
disallow the possibility of unresolved entities. Conversion functions are
provided to switch between the two sets of datatypes.
For simpler, bidirectional traversal of the DOM tree, see the Text.XML.Cursor module.
- data Document = Document {}
- data Prologue :: * = Prologue {}
- data Instruction :: * = Instruction {
- instructionTarget :: Text
- instructionData :: Text
- data Miscellaneous :: *
- = MiscInstruction Instruction
- | MiscComment Text
- data Node
- = NodeElement Element
- | NodeInstruction Instruction
- | NodeContent Text
- | NodeComment Text
- data Element = Element {
- elementName :: Name
- elementAttributes :: Map Name Text
- elementNodes :: [Node]
- data Name :: * = Name {
- nameLocalName :: Text
- nameNamespace :: Maybe Text
- namePrefix :: Maybe Text
- data Doctype :: * = Doctype {
- doctypeName :: Text
- doctypeID :: Maybe ExternalID
- data ExternalID :: *
- readFile :: ParseSettings -> FilePath -> IO Document
- parseLBS :: ParseSettings -> ByteString -> Either SomeException Document
- parseLBS_ :: ParseSettings -> ByteString -> Document
- sinkDoc :: MonadThrow m => ParseSettings -> Consumer ByteString m Document
- parseText :: ParseSettings -> Text -> Either SomeException Document
- parseText_ :: ParseSettings -> Text -> Document
- sinkTextDoc :: MonadThrow m => ParseSettings -> Consumer Text m Document
- fromEvents :: MonadThrow m => Consumer EventPos m Document
- data UnresolvedEntityException = UnresolvedEntityException (Set Text)
- data XMLException = InvalidXMLFile FilePath SomeException
- writeFile :: RenderSettings -> FilePath -> Document -> IO ()
- renderLBS :: RenderSettings -> Document -> ByteString
- renderText :: RenderSettings -> Document -> Text
- renderBytes :: (PrimMonad base, MonadBase base m) => RenderSettings -> Document -> ConduitM a ByteString m ()
- def :: Default a => a
- data ParseSettings
- psDecodeEntities :: ParseSettings -> DecodeEntities
- psRetainNamespaces :: ParseSettings -> Bool
- decodeXmlEntities :: DecodeEntities
- decodeHtmlEntities :: DecodeEntities
- data RenderSettings
- rsPretty :: RenderSettings -> Bool
- rsNamespaces :: RenderSettings -> [(Text, Text)]
- rsAttrOrder :: RenderSettings -> Name -> Map Name Text -> [(Name, Text)]
- rsUseCDATA :: RenderSettings -> Content -> Bool
- orderAttrs :: [(Name, [Name])] -> Name -> Map Name Text -> [(Name, Text)]
- toXMLDocument :: Document -> Document
- fromXMLDocument :: Document -> Either (Set Text) Document
- toXMLNode :: Node -> Node
- fromXMLNode :: Node -> Either (Set Text) Node
- toXMLElement :: Element -> Element
- fromXMLElement :: Element -> Either (Set Text) Element
Data types
Constructors
Document | |
Fields |
Constructors
Prologue | |
Fields |
data Instruction :: * #
Constructors
Instruction | |
Fields
|
Instances
data Miscellaneous :: * #
Constructors
MiscInstruction Instruction | |
MiscComment Text |
Constructors
NodeElement Element | |
NodeInstruction Instruction | |
NodeContent Text | |
NodeComment Text |
Constructors
Element | |
Fields
|
Constructors
Name | |
Fields
|
Constructors
Doctype | |
Fields
|
data ExternalID :: * #
Instances
Parsing
Files
Bytes
parseLBS :: ParseSettings -> ByteString -> Either SomeException Document #
parseLBS_ :: ParseSettings -> ByteString -> Document #
sinkDoc :: MonadThrow m => ParseSettings -> Consumer ByteString m Document #
Text
parseText :: ParseSettings -> Text -> Either SomeException Document #
parseText_ :: ParseSettings -> Text -> Document #
sinkTextDoc :: MonadThrow m => ParseSettings -> Consumer Text m Document #
Other
fromEvents :: MonadThrow m => Consumer EventPos m Document #
data UnresolvedEntityException #
Constructors
UnresolvedEntityException (Set Text) |
Rendering
renderLBS :: RenderSettings -> Document -> ByteString #
renderText :: RenderSettings -> Document -> Text #
renderBytes :: (PrimMonad base, MonadBase base m) => RenderSettings -> Document -> ConduitM a ByteString m () #
Settings
Parsing
data ParseSettings #
Instances
Default ParseSettings # | |
psRetainNamespaces :: ParseSettings -> Bool #
Whether the original xmlns attributes should be retained in the parsed values. For more information on motivation, see:
https://github.com/snoyberg/xml/issues/38
Default: False
Since 1.2.1
Entity decoding
decodeXmlEntities :: DecodeEntities #
Default implementation of DecodeEntities
: handles numeric entities and
the five standard character entities (lt, gt, amp, quot, apos).
decodeHtmlEntities :: DecodeEntities #
HTML4-compliant entity decoder. Handles numerics, the five standard character entities, and the additional 248 entities defined by HTML 4 and XHTML 1.
Note that HTML 5 introduces a drastically larger number of entities, and this code does not recognize most of them.
Rendering
data RenderSettings #
Instances
Default RenderSettings # | |
rsPretty :: RenderSettings -> Bool #
rsNamespaces :: RenderSettings -> [(Text, Text)] #
Defines some top level namespace definitions to be used, in the form of (prefix, namespace). This has absolutely no impact on the meaning of your documents, but can increase readability by moving commonly used namespace declarations to the top level.
rsAttrOrder :: RenderSettings -> Name -> Map Name Text -> [(Name, Text)] #
Specify how to turn the unordered attributes used by the Text.XML module into an ordered list.
rsUseCDATA :: RenderSettings -> Content -> Bool #
Determines if for a given text content the renderer should use a CDATA node.
Default: False
Since: 1.3.3
orderAttrs :: [(Name, [Name])] -> Name -> Map Name Text -> [(Name, Text)] #
Convenience function to create an ordering function suitable for
use as the value of rsAttrOrder
. The ordering function is created
from an explicit ordering of the attributes, specified as a list of
tuples, as follows: In each tuple, the first component is the
Name
of an element, and the second component is a list of
attributes names. When the given element is rendered, the
attributes listed, when present, appear first in the given order,
followed by any other attributes in arbitrary order. If an element
does not appear, all of its attributes are rendered in arbitrary
order.
Conversion
toXMLDocument :: Document -> Document #
fromXMLDocument :: Document -> Either (Set Text) Document #
fromXMLNode :: Node -> Either (Set Text) Node #
toXMLElement :: Element -> Element #
fromXMLElement :: Element -> Either (Set Text) Element #