Copyright	(c) 2014 Alp Mestanogullari Vikram Verma
License	BSD3
Maintainer	alpmestan@gmail.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Text.Taggy.DOM

Description

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

Documentation

type AttrName = Text #

An attribute name is just a Text value

type AttrValue = Text #

An attribute value is just a Text value

data Element #

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
Fields 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 `Node`s

Instances

Eq Element #
Methods (==) :: Element -> Element -> Bool # (/=) :: Element -> Element -> Bool #
Show Element #
Methods showsPrec :: Int -> Element -> ShowS # show :: Element -> String # showList :: [Element] -> ShowS #
AsMarkup Element #	An `Element` is convertible to `Markup`
Methods toMarkup :: Bool -> Element -> Markup #

data Node #

A Node is either an Element or some raw text.

Constructors

NodeElement Element
NodeContent Text

Instances

Eq Node #
Methods (==) :: Node -> Node -> Bool # (/=) :: Node -> Node -> Bool #
Show Node #
Methods showsPrec :: Int -> Node -> ShowS # show :: Node -> String # showList :: [Node] -> ShowS #
AsMarkup Node #	A `Node` is convertible to `Markup`
Methods toMarkup :: Bool -> Node -> Markup #

nodeChildren :: Node -> [Node] #

Get the children of a node.

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

parseDOM :: Bool -> Text -> [Node] #

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

domify :: [Tag] -> [Node] #

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.

untilClosed :: Text -> ([Node], [Tag]) -> ([Node], [Tag]) #

convertText :: Text -> Node #