| Safe Haskell | Safe-Inferred |
|---|
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
- = DefEntityValue EntityValue
- | DefExternalID ExternalID (Maybe NDataDecl)
- 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.
type SymTab a = [(String, a)]
Symbol table operations
XML Types
The top-level document container
data Document i
The symbol table stored in a document holds all its general entity reference definitions.
The main document content
data Element i
data Content i
data AttValue
Administrative parts of the document
data XMLDecl
Constructors
| XMLDecl VersionInfo (Maybe EncodingDecl) (Maybe SDDecl) |
Instances
| Eq XMLDecl |
type ProcessingInstruction = (PITarget, String)
type SDDecl = Bool
type VersionInfo = String
type Comment = String
type PITarget = String
The DTD
content model
data MarkupDecl
Constructors
| Element ElementDecl | |
| AttList AttListDecl | |
| Entity EntityDecl | |
| Notation NotationDecl | |
| MarkupMisc Misc |
Instances
| Eq MarkupDecl |
data ExtSubsetDecl
Constructors
| ExtMarkupDecl MarkupDecl | |
| ExtConditionalSect ConditionalSect |
Instances
data CP
data Modifier
attribute model
data AttType
Constructors
| StringType | |
| TokenizedType TokenizedType | |
| EnumeratedType EnumeratedType |
Instances
| Eq AttType |
data TokenizedType
Instances
type NotationType = [Name]
type Enumeration = [NmToken]
data DefaultDecl
Instances
| Eq DefaultDecl |
conditional sections
type IncludeSect = [ExtSubsetDecl]
type IgnoreSect = [IgnoreSectContents]
data IgnoreSectContents
Constructors
| IgnoreSectContents Ignore [(IgnoreSectContents, Ignore)] |
Instances
References
data Reference
type PEReference = Name
Entities
data EntityDef
Constructors
| DefEntityValue EntityValue | |
| DefExternalID ExternalID (Maybe NDataDecl) |
Instances
| Eq EntityDef |
data PEDef
Constructors
| PEDefEntityValue EntityValue | |
| PEDefExternalID ExternalID |
data ExternalID
Constructors
| SYSTEM SystemLiteral | |
| PUBLIC PubidLiteral SystemLiteral |
Instances
| Eq ExternalID | |
| Show ExternalID |
data ExtParsedEnt i
Constructors
| ExtParsedEnt (Maybe TextDecl) (Content i) |
Instances
| Eq (ExtParsedEnt i) |
Namespaces
data QName
A QName is a (possibly) qualified name, in the sense of XML namespaces.
data Namespace
Namespaces are not defined in the XML spec itself, but at http:www.w3.orgTRxml-names
Basic value types
type Name = String
type NmToken = String
type CharData = String