Copyright	Suite Solutions Ltd. Israel 2011
Maintainer	Yitzchak Gale <gale@sefer.org>
Portability	portable
Safe Haskell	Safe
Language	Haskell98

Data.XML.DTD.Types

Contents

DTD structure
Entity declarations and references
Element declarations
Attribute declarations
Notation declarations

Description

This module provides types to represent an XML Document Type Declaration (DTD) as defined in W3C specifications (http://www.w3.org/XML/Core/#Publications). It is intended to be compatible with and extend the set of types in Data.XML.Types provided by the xml-types package.

Following the philosophy of Data.XML.Types, the types in this module are not intended to be a strict and complete representation of the model in the W3C specifications; rather, they are intended to be convenient and type-safe for the kinds of processing of DTDs that are commonly done in practice. As such, this model is compatible with both Version 1.0 and Version 1.1 of the XML specification.

Therefore, these types are not suitable for type-level validation of the syntax of a DTD. For example: these types are more lenient than the specs about the characters that are allowed in various locations in a DTD; entities of various kinds only appear as distinct syntactic elements in places where they are commonly needed when processing DTDs; etc.

Conditional sections are not represented in these types. They should be handled directly by parsers and renderers, if needed.

Synopsis

data DTD = DTD {
- dtdTextDecl :: Maybe DTDTextDecl
- dtdComponents :: [DTDComponent]
}
data DTDTextDecl = DTDTextDecl {
- dtdXMLVersion :: Maybe Text
- dtdEncoding :: Text
}
data DTDComponent
- = DTDEntityDecl EntityDecl
- | DTDElementDecl ElementDecl
- | DTDAttList AttList
- | DTDNotation Notation
- | DTDPERef PERef
- | DTDInstruction Instruction
- | DTDComment Text
data EntityDecl
- = InternalGeneralEntityDecl {
  - entityDeclName :: Text
  - entityDeclValue :: [EntityValue]
  }
- | ExternalGeneralEntityDecl {
  - entityDeclName :: Text
  - entityDeclID :: ExternalID
  - entityDeclNotation :: Maybe Text
  }
- | InternalParameterEntityDecl {
  - entityDeclName :: Text
  - entityDeclValue :: [EntityValue]
  }
- | ExternalParameterEntityDecl {
  - entityDeclName :: Text
  - entityDeclID :: ExternalID
  }
data EntityValue
- = EntityText Text
- | EntityPERef PERef
type PERef = Text
data ElementDecl = ElementDecl {
- eltDeclName :: Text
- eltDeclContent :: ContentDecl
}
data ContentDecl
- = ContentEmpty
- | ContentAny
- | ContentElement ContentModel
- | ContentMixed [Text]
data ContentModel
- = CMName Text Repeat
- | CMChoice [ContentModel] Repeat
- | CMSeq [ContentModel] Repeat
data Repeat
- = One
- | ZeroOrOne
- | ZeroOrMore
- | OneOrMore
data AttList = AttList {
- attListElementName :: Text
- attListDecls :: [AttDecl]
}
data AttDecl = AttDecl {
- attDeclName :: Text
- attDeclType :: AttType
- attDeclDefault :: AttDefault
}
data AttType
- = AttStringType
- | AttIDType
- | AttIDRefType
- | AttIDRefsType
- | AttEntityType
- | AttEntitiesType
- | AttNmTokenType
- | AttNmTokensType
- | AttEnumType [Text]
- | AttNotationType [Text]
data AttDefault
- = AttRequired
- | AttImplied
- | AttFixed Text
- | AttDefaultValue Text
data Notation = Notation {
- notationName :: Text
- notationSource :: NotationSource
}
data NotationSource
- = NotationSysID Text
- | NotationPubID Text
- | NotationPubSysID Text Text

DTD structure

data DTD Source #

A DTD is a sequence components in any order.

Constructors

DTD
Fields dtdTextDecl :: Maybe DTDTextDecl dtdComponents :: [DTDComponent]

Instances

Eq DTD Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: DTD -> DTD -> Bool # (/=) :: DTD -> DTD -> Bool #
Show DTD Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> DTD -> ShowS # show :: DTD -> String # showList :: [DTD] -> ShowS #

data DTDTextDecl Source #

The ?xml text declaration at the beginning of a DTD.

Constructors

DTDTextDecl
Fields dtdXMLVersion :: Maybe Text dtdEncoding :: Text

Instances

Eq DTDTextDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: DTDTextDecl -> DTDTextDecl -> Bool # (/=) :: DTDTextDecl -> DTDTextDecl -> Bool #
Show DTDTextDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> DTDTextDecl -> ShowS # show :: DTDTextDecl -> String # showList :: [DTDTextDecl] -> ShowS #

data DTDComponent Source #

The kinds of components that can appear in a DTD.

Constructors

DTDEntityDecl EntityDecl	Entity declaration
DTDElementDecl ElementDecl	Element declaration
DTDAttList AttList	List of attribute declarions for an element
DTDNotation Notation	A notation declaration
DTDPERef PERef	A parameter entity reference in the top-level flow of the DTD
DTDInstruction Instruction	A processing instruction
DTDComment Text	A comment

Instances

Eq DTDComponent Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: DTDComponent -> DTDComponent -> Bool # (/=) :: DTDComponent -> DTDComponent -> Bool #
Show DTDComponent Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> DTDComponent -> ShowS # show :: DTDComponent -> String # showList :: [DTDComponent] -> ShowS #

Entity declarations and references

data EntityDecl Source #

A declaration of an entity. An entity is a textual substitution variable. General entities can be referenced in an XML document conforming to the DTD, and parameter entities can be referenced in the DTD itself. The value of an unparsed entity is not specified in the DTD; it is specified by external syntax declared as a notation elsewhere in the DTD.

Constructors

InternalGeneralEntityDecl
Fields entityDeclName :: Text entityDeclValue :: [EntityValue]
ExternalGeneralEntityDecl	An external general entity is unparsed if a notation is specified.
Fields entityDeclName :: Text entityDeclID :: ExternalID entityDeclNotation :: Maybe Text
InternalParameterEntityDecl
Fields entityDeclName :: Text entityDeclValue :: [EntityValue]
ExternalParameterEntityDecl
Fields entityDeclName :: Text entityDeclID :: ExternalID

Instances

Eq EntityDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: EntityDecl -> EntityDecl -> Bool # (/=) :: EntityDecl -> EntityDecl -> Bool #
Show EntityDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> EntityDecl -> ShowS # show :: EntityDecl -> String # showList :: [EntityDecl] -> ShowS #

data EntityValue Source #

The value of an internal entity may contain references to parameter entities; these references need to be resolved to obtain the actual replacement value of the entity. So we represent the value as a mixture of parameter entity references and free text.

Constructors

EntityText Text
EntityPERef PERef

Instances

Eq EntityValue Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: EntityValue -> EntityValue -> Bool # (/=) :: EntityValue -> EntityValue -> Bool #
Show EntityValue Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> EntityValue -> ShowS # show :: EntityValue -> String # showList :: [EntityValue] -> ShowS #

type PERef = Text Source #

A parameter entity reference. It contains the name of the parameter entity that is being referenced.

Element declarations

data ElementDecl Source #

A declaration of an element.

Constructors

ElementDecl
Fields eltDeclName :: Text eltDeclContent :: ContentDecl

Instances

Eq ElementDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: ElementDecl -> ElementDecl -> Bool # (/=) :: ElementDecl -> ElementDecl -> Bool #
Show ElementDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> ElementDecl -> ShowS # show :: ElementDecl -> String # showList :: [ElementDecl] -> ShowS #

data ContentDecl Source #

The content that can occur in an element.

Constructors

ContentEmpty	No content
ContentAny	Unrestricted content
ContentElement ContentModel	Structured element content
ContentMixed [Text]	A mixture of text and elements

Instances

Eq ContentDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: ContentDecl -> ContentDecl -> Bool # (/=) :: ContentDecl -> ContentDecl -> Bool #
Show ContentDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> ContentDecl -> ShowS # show :: ContentDecl -> String # showList :: [ContentDecl] -> ShowS #

data ContentModel Source #

A model of structured content for an element.

Constructors

CMName Text Repeat	Element name
CMChoice [ContentModel] Repeat	Choice, delimited by `"\|"`
CMSeq [ContentModel] Repeat	Sequence, delimited by `","`

Instances

Eq ContentModel Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: ContentModel -> ContentModel -> Bool # (/=) :: ContentModel -> ContentModel -> Bool #
Show ContentModel Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> ContentModel -> ShowS # show :: ContentModel -> String # showList :: [ContentModel] -> ShowS #

data Repeat Source #

The number of times a production of content model syntax can repeat.

Constructors

One
ZeroOrOne
ZeroOrMore
OneOrMore

Instances

Eq Repeat Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: Repeat -> Repeat -> Bool # (/=) :: Repeat -> Repeat -> Bool #
Show Repeat Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> Repeat -> ShowS # show :: Repeat -> String # showList :: [Repeat] -> ShowS #

Attribute declarations

data AttList Source #

A list of attribute declarations for an element.

Constructors

AttList
Fields attListElementName :: Text The name of the element to which the attribute declarations apply attListDecls :: [AttDecl]

Instances

Eq AttList Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: AttList -> AttList -> Bool # (/=) :: AttList -> AttList -> Bool #
Show AttList Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> AttList -> ShowS # show :: AttList -> String # showList :: [AttList] -> ShowS #

data AttDecl Source #

A declaration of an attribute that can occur in an element.

Constructors

AttDecl
Fields attDeclName :: Text The name of the attribute attDeclType :: AttType The type of the attribute attDeclDefault :: AttDefault The default value specification

Instances

Eq AttDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: AttDecl -> AttDecl -> Bool # (/=) :: AttDecl -> AttDecl -> Bool #
Show AttDecl Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> AttDecl -> ShowS # show :: AttDecl -> String # showList :: [AttDecl] -> ShowS #

data AttType Source #

The type of value that an attribute can take.

Constructors

AttStringType	Any text
AttIDType	A unique ID
AttIDRefType	A reference to an ID
AttIDRefsType	One or more references to IDs
AttEntityType	An unparsed external entity
AttEntitiesType	One or more unparsed external entities
AttNmTokenType	A name-like token
AttNmTokensType	One or more name-like tokens
AttEnumType [Text]	One of the given values
AttNotationType [Text]	Specified by external syntax declared as a notation

Instances

Eq AttType Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: AttType -> AttType -> Bool # (/=) :: AttType -> AttType -> Bool #
Show AttType Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> AttType -> ShowS # show :: AttType -> String # showList :: [AttType] -> ShowS #

data AttDefault Source #

A default value specification for an attribute.

Constructors

AttRequired	No default value; the attribute must always be supplied
AttImplied	No default value; the attribute is optional
AttFixed Text	When supplied, the attribute must have the given value
AttDefaultValue Text	The attribute has the given default value when not supplied

Instances

Eq AttDefault Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: AttDefault -> AttDefault -> Bool # (/=) :: AttDefault -> AttDefault -> Bool #
Show AttDefault Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> AttDefault -> ShowS # show :: AttDefault -> String # showList :: [AttDefault] -> ShowS #

Notation declarations

data Notation Source #

A declaration of a notation.

Constructors

Notation
Fields notationName :: Text notationSource :: NotationSource

Instances

Eq Notation Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: Notation -> Notation -> Bool # (/=) :: Notation -> Notation -> Bool #
Show Notation Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> Notation -> ShowS # show :: Notation -> String # showList :: [Notation] -> ShowS #

data NotationSource Source #

A source for a notation. We do not use the usual ExternalID type here, because for notations it is only optional, not required, for a public ID to be accompanied also by a system ID.

Constructors

NotationSysID Text	A system ID
NotationPubID Text	A public ID
NotationPubSysID Text Text	A public ID with a system ID

Instances

Eq NotationSource Source #
Instance details Defined in Data.XML.DTD.Types Methods (==) :: NotationSource -> NotationSource -> Bool # (/=) :: NotationSource -> NotationSource -> Bool #
Show NotationSource Source #
Instance details Defined in Data.XML.DTD.Types Methods showsPrec :: Int -> NotationSource -> ShowS # show :: NotationSource -> String # showList :: [NotationSource] -> ShowS #