| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell98 |
Text.XML.HaXml.Types
Contents
Description
This module defines an internal (generic) representation for XML documents including their DTDs.
History: The original module was derived by hand from the XML specification, following the grammar precisely. Then we simplified the types, removing layers of indirection and redundancy, and generally making things easier to work with. Then we allowed PEReferences to be ubiquitous, by removing them from the types and resolving all PE references at parse-time. Finally, we added a per-document symbol table for GEReferences, and a whitespace-significance flag for plaintext.
- type SymTab a = [(String, a)]
- emptyST :: SymTab a
- addST :: String -> a -> SymTab a -> SymTab a
- lookupST :: String -> SymTab a -> Maybe a
- data Document i = Document Prolog (SymTab EntityDef) (Element i) [Misc]
- data Element i = Elem QName [Attribute] [Content i]
- data ElemTag = ElemTag QName [Attribute]
- data Content i
- type Attribute = (QName, AttValue)
- data AttValue = AttValue [Either String Reference]
- info :: Content t -> t
- data Prolog = Prolog (Maybe XMLDecl) [Misc] (Maybe DocTypeDecl) [Misc]
- data XMLDecl = XMLDecl VersionInfo (Maybe EncodingDecl) (Maybe SDDecl)
- data Misc
- type ProcessingInstruction = (PITarget, String)
- type SDDecl = Bool
- type VersionInfo = String
- type Comment = String
- type PITarget = String
- data DocTypeDecl = DTD QName (Maybe ExternalID) [MarkupDecl]
- data MarkupDecl
- data ExtSubset = ExtSubset (Maybe TextDecl) [ExtSubsetDecl]
- data ExtSubsetDecl
- data ElementDecl = ElementDecl QName ContentSpec
- data ContentSpec
- data CP
- data Modifier
- data Mixed
- = PCDATA
- | PCDATAplus [QName]
- data AttListDecl = AttListDecl QName [AttDef]
- data AttDef = AttDef QName AttType DefaultDecl
- data AttType
- data TokenizedType
- data EnumeratedType
- type NotationType = [Name]
- type Enumeration = [NmToken]
- data DefaultDecl
- data FIXED = FIXED
- data ConditionalSect
- type IncludeSect = [ExtSubsetDecl]
- type IgnoreSect = [IgnoreSectContents]
- data Ignore = Ignore
- data IgnoreSectContents = IgnoreSectContents Ignore [(IgnoreSectContents, Ignore)]
- data Reference
- type EntityRef = Name
- type CharRef = Int
- type PEReference = Name
- data EntityDecl
- data GEDecl = GEDecl Name EntityDef
- data PEDecl = PEDecl Name PEDef
- data EntityDef
- data PEDef
- data ExternalID
- newtype NDataDecl = NDATA Name
- data TextDecl = TextDecl (Maybe VersionInfo) EncodingDecl
- data ExtParsedEnt i = ExtParsedEnt (Maybe TextDecl) (Content i)
- data ExtPE = ExtPE (Maybe TextDecl) [ExtSubsetDecl]
- data NotationDecl = NOTATION Name (Either ExternalID PublicID)
- newtype PublicID = PUBLICID PubidLiteral
- newtype EncodingDecl = EncodingDecl String
- data EntityValue = EntityValue [EV]
- data EV
- newtype PubidLiteral = PubidLiteral String
- newtype SystemLiteral = SystemLiteral String
- data QName
- data Namespace = Namespace {}
- type Name = String
- type Names = [Name]
- type NmToken = String
- type NmTokens = [NmToken]
- type CharData = String
- type CDSect = CharData
A simple symbol table mapping strings (references) to values.
Symbol table operations
XML Types
The top-level document container
The symbol table stored in a document holds all its general entity reference definitions.
The main document content
Administrative parts of the document
Constructors
| XMLDecl VersionInfo (Maybe EncodingDecl) (Maybe SDDecl) |
type ProcessingInstruction = (PITarget, String) Source
type VersionInfo = String Source
The DTD
content model
data MarkupDecl Source
Constructors
| Element ElementDecl | |
| AttList AttListDecl | |
| Entity EntityDecl | |
| Notation NotationDecl | |
| MarkupMisc Misc |
Instances
Constructors
| ExtSubset (Maybe TextDecl) [ExtSubsetDecl] |
data ExtSubsetDecl Source
Constructors
| ExtMarkupDecl MarkupDecl | |
| ExtConditionalSect ConditionalSect |
Instances
data ContentSpec Source
Instances
attribute model
Constructors
| StringType | |
| TokenizedType TokenizedType | |
| EnumeratedType EnumeratedType |
data TokenizedType Source
Instances
type NotationType = [Name] Source
type Enumeration = [NmToken] Source
data DefaultDecl Source
Instances
conditional sections
type IncludeSect = [ExtSubsetDecl] Source
type IgnoreSect = [IgnoreSectContents] Source
data IgnoreSectContents Source
Constructors
| IgnoreSectContents Ignore [(IgnoreSectContents, Ignore)] |
Instances
References
type PEReference = Name Source
Entities
Constructors
| DefEntityValue EntityValue | |
| DefExternalID ExternalID (Maybe NDataDecl) |
Constructors
| PEDefEntityValue EntityValue | |
| PEDefExternalID ExternalID |
Constructors
| TextDecl (Maybe VersionInfo) EncodingDecl |
data ExtParsedEnt i Source
Constructors
| ExtParsedEnt (Maybe TextDecl) (Content i) |
Instances
| Eq (ExtParsedEnt i) | |
| Show i => Show (ExtParsedEnt i) |
Namespaces
A QName is a (possibly) qualified name, in the sense of XML namespaces.
Namespaces are not defined in the XML spec itself, but at http:/www.w3.orgTR/xml-names