Web.Willow.DOM

In lieu of a fully-featured DOM implementation ---and even, for that matter, a styled tree--- this module provides bare-bones data structures to temporarily contain the minimal data currently returned by tree parsing. Eventually this will be padded out into a fully-featured DOM implementation, but doing so now would be creating much more work than necessary.

Structure

data Tree

DOM: tree

The core concept underlying HTML and related languages: a nested collection of data and metadata marked up according to several broad categories. Values may be easily instantiated as updates to emptyTree.

Constructors

Tree

Fields

• node :: Node

  The atomic portion of the tree at the current location.

• children :: [Tree]

  All parts of the tree nested below the current location.

Instances

Eq Tree

Defined in Web.Willow.DOM

Methods

(==) :: Tree -> Tree -> Bool

(/=) :: Tree -> Tree -> Bool

Read Tree

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS Tree

readList :: ReadS [Tree]

readPrec :: ReadPrec Tree

readListPrec :: ReadPrec [Tree]

Show Tree

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> Tree -> ShowS

show :: Tree -> String

showList :: [Tree] -> ShowS

emptyTree :: Tree

A sane default collection for easy record initialization; namely, a Document without any children.

data Node

DOM: node

The sum type of all different classes of behaviour a particular point of data may fill.

Constructors

Text Text

DOM: Text

A simple character string to be rendered to the output or to be processed further, according to which Elements enclose it.

Comment Text

DOM: Comment

An author's aside, not intended to be shown to the end user.

DocumentType DocumentTypeParams

DOM: DocumentType

Largely vestigial in HTML5, but used in previous versions and related languages to specify the semantics of Elements used in the document.

Element ElementParams

DOM: Element

Markup instructions directing the behaviour or classifying a portion of the document's content.

Attribute AttributeParams

DOM: Attr

Metadata allowing finer customization and description of the heavier Elements.

DocumentFragment

DOM: DocumentType

As like Document, but requiring less precise structure in its children and generally only containing a small slice of a larger document.

Document QuirksMode

DOM: Document

The root of a Tree, typically imposing a principled structure.

Instances

Eq Node

Defined in Web.Willow.DOM

Methods

(==) :: Node -> Node -> Bool

(/=) :: Node -> Node -> Bool

Read Node

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS Node

readList :: ReadS [Node]

readPrec :: ReadPrec Node

readListPrec :: ReadPrec [Node]

Show Node

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

data NodeType

A simplified view of the Node constructors, for use in testing via nodeType.

Constructors

ElementNode

DOM: ELEMENT_NODE

Element

AttributeNode

DOM: ATTRIBUTE_NODE

Attribute

TextNode

DOM: TEXT_NODE

Text

CDataSectionNode

DOM: CDATA_SECTION_NODE

EntityReferenceNode

Deprecated: historical

DOM: ENTITY_REFERENCE_NODE

EntityNode

Deprecated: historical

DOM: ENTITY_NODE

ProcessingInstructionNode

DOM: PROCESSING_INSTRUCTION_NODE

CommentNode

DOM: COMMENT_NODE

Comment

DocumentNode

DOM: DOCUMENT_NODE

Document

DocumentTypeNode

DOM: DOCUMENT_TYPE_NODE

DocumentType

DocumentFragmentNode

DOM: DOCUMENT_FRAGMENT_NODE

DocumentFragment

NotationNode

Deprecated: historical

DOM: NOTATION_NODE

Instances

Bounded NodeType

Defined in Web.Willow.DOM

Methods

minBound :: NodeType

maxBound :: NodeType

Enum NodeType

Defined in Web.Willow.DOM

Methods

succ :: NodeType -> NodeType

pred :: NodeType -> NodeType

toEnum :: Int -> NodeType

fromEnum :: NodeType -> Int

enumFrom :: NodeType -> [NodeType]

enumFromThen :: NodeType -> NodeType -> [NodeType]

enumFromTo :: NodeType -> NodeType -> [NodeType]

enumFromThenTo :: NodeType -> NodeType -> NodeType -> [NodeType]

Eq NodeType

Defined in Web.Willow.DOM

Methods

(==) :: NodeType -> NodeType -> Bool

(/=) :: NodeType -> NodeType -> Bool

Ord NodeType

Defined in Web.Willow.DOM

Methods

compare :: NodeType -> NodeType -> Ordering

(<) :: NodeType -> NodeType -> Bool

(<=) :: NodeType -> NodeType -> Bool

(>) :: NodeType -> NodeType -> Bool

(>=) :: NodeType -> NodeType -> Bool

max :: NodeType -> NodeType -> NodeType

min :: NodeType -> NodeType -> NodeType

Read NodeType

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS NodeType

readList :: ReadS [NodeType]

readPrec :: ReadPrec NodeType

readListPrec :: ReadPrec [NodeType]

Show NodeType

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> NodeType -> ShowS

show :: NodeType -> String

showList :: [NodeType] -> ShowS

nodeType :: Node -> Maybe NodeType

DOM: nodeType

Simplify the algebraic data type to a one-dimensional Enum to allow equality testing rather than requiring pattern matching.

Data

Document

data QuirksMode

Through the long history of HTML browsers, many unique and/or buggy behaviours have become enshrined due to the simple fact that website authors used them. As the standards and the parse engines have continued to develop, three separated degrees of emulation have emerged for that backwards compatibility.

Constructors

NoQuirks

DOM: no-quirks mode

Fully compliant with the modern standard.

LimitedQuirks

DOM: limited-quirks mode

Largely compliant with the standard, except for a couple height calculations.

FullQuirks

DOM: quirks mode

Backwards compatibility with 1990's-era technology.

Instances

Bounded QuirksMode

Defined in Web.Willow.DOM

Methods

minBound :: QuirksMode

maxBound :: QuirksMode

Enum QuirksMode

Defined in Web.Willow.DOM

Methods

succ :: QuirksMode -> QuirksMode

pred :: QuirksMode -> QuirksMode

toEnum :: Int -> QuirksMode

fromEnum :: QuirksMode -> Int

enumFrom :: QuirksMode -> [QuirksMode]

enumFromThen :: QuirksMode -> QuirksMode -> [QuirksMode]

enumFromTo :: QuirksMode -> QuirksMode -> [QuirksMode]

enumFromThenTo :: QuirksMode -> QuirksMode -> QuirksMode -> [QuirksMode]

Eq QuirksMode

Defined in Web.Willow.DOM

Methods

(==) :: QuirksMode -> QuirksMode -> Bool

(/=) :: QuirksMode -> QuirksMode -> Bool

Ord QuirksMode

Defined in Web.Willow.DOM

Methods

compare :: QuirksMode -> QuirksMode -> Ordering

(<) :: QuirksMode -> QuirksMode -> Bool

(<=) :: QuirksMode -> QuirksMode -> Bool

(>) :: QuirksMode -> QuirksMode -> Bool

(>=) :: QuirksMode -> QuirksMode -> Bool

max :: QuirksMode -> QuirksMode -> QuirksMode

min :: QuirksMode -> QuirksMode -> QuirksMode

Read QuirksMode

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS QuirksMode

readList :: ReadS [QuirksMode]

readPrec :: ReadPrec QuirksMode

readListPrec :: ReadPrec [QuirksMode]

Show QuirksMode

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> QuirksMode -> ShowS

show :: QuirksMode -> String

showList :: [QuirksMode] -> ShowS

Elements

data ElementParams

DOM: Element

The collection of metadata identifying and describing a markup tag used to associate text or other data with its broader role in the document, or to indicate a preferred rendering. Values may be easily instantiated as updates to emptyElementParams.

Constructors

ElementParams

Fields

• elementPrefix :: Maybe ElementPrefix

  The variable fragment used to represent the elementNamespace in the original source.

• elementName :: ElementName

  The key defining what role the markup tag is meant to represent, as defined by the elementNamespace.

• elementNamespace :: Maybe Namespace

  The scope defining the language by which the elementibute participates in the document.

• elementAttributes :: AttributeMap

  The points of metadata further describing rendering behaviour or adding other information.

Instances

Eq ElementParams

Defined in Web.Willow.DOM

Methods

(==) :: ElementParams -> ElementParams -> Bool

(/=) :: ElementParams -> ElementParams -> Bool

Read ElementParams

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS ElementParams

readList :: ReadS [ElementParams]

readPrec :: ReadPrec ElementParams

readListPrec :: ReadPrec [ElementParams]

Show ElementParams

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> ElementParams -> ShowS

show :: ElementParams -> String

showList :: [ElementParams] -> ShowS

emptyElementParams :: ElementParams

A sane default collection for easy record initialization.

type ElementName = Text

Type-level clarification for the name of a markup tag.

type ElementPrefix = Text

Type-level clarification for the short namespace reference classifying a markup tag.

Attribute list

type AttributeMap = HashMap (Maybe Namespace, AttributeName) (Maybe AttributePrefix, AttributeValue)

DOM: NamedNodeMap

Type-level clarification for the collection of key-value points of supplemental metadata attached to an Element. Note that, while an Attribute's prefix is used to determine the associated namespace (and needs to be tracked for round-trip serialization), it doesn't factor into testing equality or in lookups.

fromAttrList :: [AttributeParams] -> AttributeMap

Pack a list of key-value metadata pairs into a form better optimized for random lookup.

toAttrList :: AttributeMap -> [AttributeParams]

Extract the key-value metadata pairs from a indexed collection into an iterable form. The order of elements is unspecified.

insertAttribute :: AttributeParams -> AttributeMap -> AttributeMap

As insert, performing the required data reordering for the less-comfortable internal type representation.

Attributes

type BasicAttribute = (AttributeName, AttributeValue)

A simple key-value representation of an attribute on an HTML tag, before any namespace processing.

data AttributeParams

DOM: Attr

A more complete representation of an attribute, including extensions beyond the BasicAttribute to support more structured (XML-like) markup languages. Values may be easily instantiated as updates to emptyAttributeParams.

Constructors

AttributeParams

Fields

• attrPrefix :: Maybe AttributePrefix

  The variable fragment used to represent the attrNamespace in the original source.

• attrName :: AttributeName

  The key defining what role the metadata value point at attrValue is meant to represent, as defined by the attrNamespace.

• attrNamespace :: Maybe Namespace

  The scope defining the language by which the attribute participates in the document.

• attrValue :: AttributeValue

  A point of metadata further describing rendering behaviour or adding other information.

Instances

Eq AttributeParams

Defined in Web.Willow.DOM

Methods

(==) :: AttributeParams -> AttributeParams -> Bool

(/=) :: AttributeParams -> AttributeParams -> Bool

Read AttributeParams

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS AttributeParams

readList :: ReadS [AttributeParams]

readPrec :: ReadPrec AttributeParams

readListPrec :: ReadPrec [AttributeParams]

Show AttributeParams

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> AttributeParams -> ShowS

show :: AttributeParams -> String

showList :: [AttributeParams] -> ShowS

emptyAttributeParams :: AttributeParams

A sane default collection for easy record initialization; namely, Nothings and emptys.

type AttributeName = Text

Type-level clarification for the key of a supplemental point of metadata.

type AttributeValue = Text

Type-level clarification for the value of a supplemental point of metadata.

type AttributePrefix = Text

Type-level clarification for the short namespace reference classifying a supplemental point of metadata.

Document type declarations

data DocumentTypeParams

DOM: DocumentType

The collection of metadata representing a document type declaration describing the markup language used in a document; of vestigal use in HTML, but important for related languages. Values may be easily instantiated as updates to emptyDocumentTypeParams.

Constructors

DocumentTypeParams

Fields

• documentTypeName :: DoctypeName

  The root element of the document, which may also identify the primary language used.

• documentTypePublicId :: DoctypePublicId

  A globally-unique reference to the definition of the language.

• documentTypeSystemId :: DoctypeSystemId

  A system-dependant (but perhaps easier to access) reference to the definition of the language.

Instances

Eq DocumentTypeParams

Defined in Web.Willow.DOM

Methods

(==) :: DocumentTypeParams -> DocumentTypeParams -> Bool

(/=) :: DocumentTypeParams -> DocumentTypeParams -> Bool

Read DocumentTypeParams

Defined in Web.Willow.DOM

Methods

readsPrec :: Int -> ReadS DocumentTypeParams

readList :: ReadS [DocumentTypeParams]

readPrec :: ReadPrec DocumentTypeParams

readListPrec :: ReadPrec [DocumentTypeParams]

Show DocumentTypeParams

Defined in Web.Willow.DOM

Methods

showsPrec :: Int -> DocumentTypeParams -> ShowS

show :: DocumentTypeParams -> String

showList :: [DocumentTypeParams] -> ShowS

emptyDocumentTypeParams :: DocumentTypeParams

A sane default collection for easy record initialization; namely, emptys.

type DoctypeName = Text

Type-level clarification for the language used in the document or, equivalently, the name of the root node.

type DoctypePublicId = Text

Type-level clarification for a registered or otherwise globally-unique reference to a description of the language used in the document.

type DoctypeSystemId = Text

Type-level clarification for a reference to the description of the language used in the document, dependant on the state of the system (and/or the internet).

Namespaces

type Namespace = Text

XML-NAMES: XML namespace

An identifier (theoretically) pointing to a reference defining a particular element or attribute ---though not necessarily in machine-readable form--- and so providing a scope for differentiating multiple elements with the same local name but different semantics.

htmlNamespace :: Namespace

Infra: HTML namespace

The canonical scope value for elements and attributes defined by the HTML standard when used in XML or XML-compatible documents.

mathMLNamespace :: Namespace

Infra: MathML namespace

The canonical scope value for elements and attributes defined by the MathML standard.

svgNamespace :: Namespace

Infra: SVG namespace

The canonical scope value for elements and attributes defined by the SVG standard.

xlinkNamespace :: Namespace

Infra: XLink namespace

The canonical scope value for elements and attributes defined by the XLink standard.

xmlNamespace :: Namespace

Infra: XML namespace

The canonical scope value for elements and attributes defined by the XML standard.

xmlnsNamespace :: Namespace

Infra: XMLNS namespace

The canonical scope value for elements and attributes defined by the XMLNS standard.