Moduletaggy-0.2.1Haskell2010

Text.Taggy.DOM

This module will help you represent an HTML or XML document as a tree and let you traverse it in whatever way you like.

This is especially useful when used in conjunction with taggy-lens

Synopsis

type AttrName
type AttrValue
data Element
data Node
value nodeChildren
value parseDOM
value domify
value untilClosed
value convertText

Packagetaggy-0.2.1
Exports9
LanguageHaskell2010
LicenceBSD-3-Clause
SourceDOM.hs

typetype AttrName = Text

Source#

An attribute name is just a Text value

typetype AttrValue = Text

Source#

An attribute value is just a Text value

datadata Element

Source#

An Element here refers to a tag name, the attributes specified withing that tag, and all the children nodes of that element. An Element is basically anything but "raw" content.

Constructors

Element
- eltName :: !Text
  name of the element. e.g "a" for a
- eltAttrs :: !HashMap AttrName AttrValue
  a (hash)map from attribute names to attribute values
- eltChildren :: [Node]
  children Nodes

Instances3Eq, Show, AsMarkup

Eq ElementDefined in taggy-0.2.1 · Text.Taggy.DOM
Show ElementDefined in taggy-0.2.1 · Text.Taggy.DOM
AsMarkup ElementDefined in taggy-0.2.1 · Text.Taggy.Renderer
An Element is convertible to Markup

datadata Node

Source#

A Node is either an Element or some raw text.

Constructors

NodeElement Element
NodeContent Text

Instances3Eq, Show, AsMarkup

Eq NodeDefined in taggy-0.2.1 · Text.Taggy.DOM
Show NodeDefined in taggy-0.2.1 · Text.Taggy.DOM
AsMarkup NodeDefined in taggy-0.2.1 · Text.Taggy.Renderer
A Node is convertible to Markup

valuenodeChildren :: Node -> [Node]

Source#

Get the children of a node.

If called on some raw text, this function returns [].

valueparseDOM :: Bool -> Text -> [Node]

Source#

Parse an HTML or XML document as a DOM tree.

The Bool argument lets you specify whether you want to convert HTML entities to their corresponding unicode characters, just like in Text.Taggy.Parser.

parseDOM convertEntities = domify . taggyWith cventities

valuedomify :: [Tag] -> [Node]

Source#

Transform a list of tags (produced with taggyWith) into a list of toplevel nodes. If the document you're working on is valid, there should only be one toplevel node, but let's not assume we're living in an ideal world.

valueuntilClosed :: Text -> ([Node], [Tag]) -> ([Node], [Tag])

valueconvertText :: Text -> Node