HaXml-1.13.3: Utilities for manipulating XML documents

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.

Synopsis

A simple symbol table mapping strings (references) to values.

type SymTab a = [(String, a)]Source

Symbol table operations

emptyST :: SymTab aSource

addST :: String -> a -> SymTab a -> SymTab aSource

lookupST :: String -> SymTab a -> Maybe aSource

XML Types

The top-level document container

data Document Source

The symbol table stored in a document holds all its general entity reference definitions.

Constructors

Document Prolog (SymTab EntityDef) Element [Misc] 

The main document content

data Element Source

Constructors

Elem Name [Attribute] [Content] 

Instances

data ElemTag Source

Constructors

ElemTag Name [Attribute]

intermediate for parsing

Instances

data Content Source

Constructors

CElem Element 
CString Bool CharData

bool is whether whitespace is significant

CRef Reference 
CMisc Misc 

Instances

type Attribute = (Name, AttValue)Source

data AttValue Source

Constructors

AttValue [Either String Reference] 

Instances

Administrative parts of the document

data Prolog Source

Constructors

Prolog (Maybe XMLDecl) [Misc] (Maybe DocTypeDecl) [Misc] 

data XMLDecl Source

Constructors

XMLDecl VersionInfo (Maybe EncodingDecl) (Maybe SDDecl) 

data Misc Source

Constructors

Comment Comment 
PI ProcessingInstruction 

type ProcessingInstruction = (PITarget, String)Source

type SDDecl = BoolSource

type VersionInfo = StringSource

type Comment = StringSource

type PITarget = StringSource

The DTD

content model

data DocTypeDecl Source

Constructors

DTD Name (Maybe ExternalID) [MarkupDecl] 

data MarkupDecl Source

Constructors

Element ElementDecl 
AttList AttListDecl 
Entity EntityDecl 
Notation NotationDecl 
MarkupMisc Misc 

data ExtSubset Source

Constructors

ExtSubset (Maybe TextDecl) [ExtSubsetDecl] 

data ExtSubsetDecl Source

Constructors

ExtMarkupDecl MarkupDecl 
ExtConditionalSect ConditionalSect 

data ElementDecl Source

Constructors

ElementDecl Name ContentSpec 

data ContentSpec Source

Constructors

EMPTY 
ANY 
Mixed Mixed 
ContentSpec CP 

data CP Source

Constructors

TagName Name Modifier 
Choice [CP] Modifier 
Seq [CP] Modifier 

Instances

data Modifier Source

Constructors

None

Just One

Query

Zero Or One

Star

Zero Or More

Plus

One Or More

Instances

data Mixed Source

Constructors

PCDATA 
PCDATAplus [Name] 

attribute model

data AttListDecl Source

Constructors

AttListDecl Name [AttDef] 

data AttDef Source

Constructors

AttDef Name AttType DefaultDecl 

data AttType Source

Constructors

StringType 
TokenizedType TokenizedType 
EnumeratedType EnumeratedType 

data TokenizedType Source

Constructors

ID 
IDREF 
IDREFS 
ENTITY 
ENTITIES 
NMTOKEN 
NMTOKENS 

data EnumeratedType Source

Constructors

NotationType NotationType 
Enumeration Enumeration 

type NotationType = [Name]Source

type Enumeration = [NmToken]Source

data DefaultDecl Source

Constructors

REQUIRED 
IMPLIED 
DefaultTo AttValue (Maybe FIXED) 

data FIXED Source

Constructors

FIXED 

conditional sections

data ConditionalSect Source

Constructors

IncludeSect IncludeSect 
IgnoreSect IgnoreSect 

type IncludeSect = [ExtSubsetDecl]Source

type IgnoreSect = [IgnoreSectContents]Source

data Ignore Source

Constructors

Ignore 

data IgnoreSectContents Source

Constructors

IgnoreSectContents Ignore [(IgnoreSectContents, Ignore)] 

References

data Reference Source

Constructors

RefEntity EntityRef 
RefChar CharRef 

Instances

type EntityRef = NameSource

type CharRef = IntSource

type PEReference = NameSource

Entities

data EntityDecl Source

Constructors

EntityGEDecl GEDecl 
EntityPEDecl PEDecl 

data GEDecl Source

Constructors

GEDecl Name EntityDef 

data PEDecl Source

Constructors

PEDecl Name PEDef 

data EntityDef Source

Constructors

DefEntityValue EntityValue 
DefExternalID ExternalID (Maybe NDataDecl) 

data PEDef Source

Constructors

PEDefEntityValue EntityValue 
PEDefExternalID ExternalID 

data ExternalID Source

Constructors

SYSTEM SystemLiteral 
PUBLIC PubidLiteral SystemLiteral 

newtype NDataDecl Source

Constructors

NDATA Name 

data TextDecl Source

Constructors

TextDecl (Maybe VersionInfo) EncodingDecl 

data ExtParsedEnt Source

Constructors

ExtParsedEnt (Maybe TextDecl) Content 

data ExtPE Source

Constructors

ExtPE (Maybe TextDecl) [ExtSubsetDecl] 

data NotationDecl Source

Constructors

NOTATION Name (Either ExternalID PublicID) 

newtype PublicID Source

Constructors

PUBLICID PubidLiteral 

newtype EncodingDecl Source

Constructors

EncodingDecl String 

data EntityValue Source

Constructors

EntityValue [EV] 

data EV Source

Constructors

EVString String 
EVRef Reference 

newtype PubidLiteral Source

Constructors

PubidLiteral String 

newtype SystemLiteral Source

Constructors

SystemLiteral String 

Basic value types

type Name = StringSource

type Names = [Name]Source

type NmToken = StringSource

type NmTokens = [NmToken]Source

type CharData = StringSource

type CDSect = CharDataSource