| Portability | portable |
|---|---|
| Maintainer | [email protected] |
Data.XML.Types
Contents
Description
Basic types for representing XML.
The idea is to have a full set of appropriate types, which various XML libraries can share. Instead of having equivalent-but-incompatible types for every binding, parser, or client, they all share the same types can can thus interoperate easily.
This library contains complete types for most parts of an XML document, including the prologue, node tree, and doctype. Some basic combinators are included for common tasks, including traversing the node tree and filtering children.
- data Document = Document {}
- data Prologue = Prologue {}
- data Instruction = Instruction {}
- data Miscellaneous
- data Node
- data Element = Element {
- elementName :: Name
- elementAttributes :: Map Name [Content]
- elementNodes :: [Node]
- data Content
- data Name = Name {}
- data Doctype = Doctype {}
- data ExternalID
- data DoctypeNode
- data Declaration
- data Event
- isElement :: Node -> [Element]
- isInstruction :: Node -> [Instruction]
- isContent :: Node -> [Content]
- isComment :: Node -> [Text]
- isNamed :: Name -> Element -> [Element]
- elementChildren :: Element -> [Element]
- elementContent :: Element -> [Content]
- elementText :: Element -> [Text]
- nodeChildren :: Node -> [Node]
- nodeContent :: Node -> [Content]
- nodeText :: Node -> [Text]
- hasAttribute :: Name -> Element -> [Element]
- hasAttributeText :: Name -> (Text -> Bool) -> Element -> [Element]
- attributeContent :: Name -> Element -> Maybe [Content]
- attributeText :: Name -> Element -> Maybe Text
Types
Document prologue
Constructors
| Document | |
Fields | |
Constructors
| Prologue | |
Fields | |
Document body
Constructors
| Element | |
Fields
| |
Constructors
| ContentText Text | |
| ContentEntity Text | For pass-through parsing |
A fully qualified name.
Prefixes are not semantically important; they are included only to
simplify pass-through parsing. When comparing names with Eq or Ord
methods, prefixes are ignored.
The IsString instance supports Clark notation; see
http://www.jclark.com/xml/xmlns.htm and
http://infohost.nmt.edu/tcc/help/pubs/pylxml/etree-QName.html. Use
the OverloadedStrings language extension for very simple Name
construction:
myname :: Name
myname = "{http://example.com/ns/my-namespace}my-name"
Constructors
| Name | |
Fields
| |
Doctypes
Constructors
| Doctype | |
Fields | |
data ExternalID Source
Instances
data DoctypeNode Source
Instances
data Declaration Source
Internal doctype declarations are still largely unimplemented. This
type will be populated and published in a later version of xml-types.
Instances
Incremental processing
Some XML processing tools are incremental, and work in terms of events
rather than node trees. The Event type allows a document to be fully
specified as a sequence of events.
Event-based XML libraries include:
Combinators
Filters
isInstruction :: Node -> [Instruction]Source
Element traversal
elementChildren :: Element -> [Element]Source
elementContent :: Element -> [Content]Source
elementText :: Element -> [Text]Source
Node traversal
nodeChildren :: Node -> [Node]Source
nodeContent :: Node -> [Content]Source
Attributes
hasAttribute :: Name -> Element -> [Element]Source