Data.XML.DTD.Parse

This module provides a Data.Attoparsec.Text parser for XML Document Type Declaration (DTD) documents. A higher-level interface that implements parameter entity resolution is also provided.

Parsing a DTD

dtd :: Parser DTD

Parse a DTD. Parameter entity substitution is not supported by this parser, so parameter entities cannot appear in places where a valid DTD syntax production cannot be determined without resolving them.

parseDTD :: Text -> DTD

Parse a DTD from lazy Text while fully resolving the values of all parameter entities whose values are provided internally in the DTD. If the syntax of the DTD is invalid, all declarations up to the first invalid one are returned.

parseDTDWithExtern :: SymTable -> Text -> DTD

Parse a DTD from lazy Text while fully resolving the values of parameter entities. The given table of values is used to resolve external parameter entities.

If you need information from the DTD itself to look up the external entities, such as system and public IDs, you might be able to get the information by applying parseDTD to the DTD or part of it for an initial parse.

type SymTable = Map Text Text

A symbol table for external parameter entity resolution. The symbol table maps strict Text names to lazy Text values. Typically, the values will have been retrieved from an external resource such as a file or URL.

Top-level DTD structure

textDecl :: Parser DTDTextDecl

Parse an ?xml text declaration at the beginning of a DTD.

dtdComponent :: Parser DTDComponent

Parse a single component of a DTD. Conditional sections are currently not supported.

Entity declarations and references

entityDecl :: Parser EntityDecl

Parse an entity declaration.

entityValue :: Parser [EntityValue]

Parse an entity value. An entity value is a quoted string possibly containing parameter entity references.

pERef :: Parser PERef

Parse a parameter entity reference

notation :: Parser Notation

Parse a declaration of a notation.

notationSrc :: Parser NotationSource

Parse a source for a notation.

Element declarations

elementDecl :: Parser ElementDecl

Parse the declaration of an element.

contentDecl :: Parser ContentDecl

Parse the content that can occur in an element.

contentModel :: Parser Text ContentModel

Parse the model of structured content for an element.

repeatChar :: Parser Repeat

Parse a repetition character.

Attribute declarations

attList :: Parser AttList

Parse a list of attribute declarations for an element.

attDecl :: Parser AttDecl

Parse the three-part declaration of an attribute.

attType :: Parser AttType

Parse the type of an attribute.

attDefault :: Parser AttDefault

Parse a default value specification for an attribute.

Declarations of comments and processing instructions

instruction :: Parser Instruction

Parse a processing instruction.

comment :: Parser Text

Parse a comment

Parsing combinators for general DTD syntax

externalID :: Parser ExternalID

Parse an external ID.

name :: Parser Text

Parse a DTD name. We are much more liberal than the spec: we allow any characters that will not interfere with other DTD syntax. This parser subsumes both Name and NmToken in the spec, and more.

nameSS :: Parser Text

Parse a DTD name followed by optional white space.

quoted :: Parser Text

A single-quoted or double-quoted string. The quotation marks are dropped.