Text.XML.PolySoup

Types

type XmlParser s a = Parser (Tag s) a

XML forest parser with result type a.

type TagParser s a = Parser (Tag s) a

data TagPred s a

A tag predicate checks if the tag (HTML element) satisfies some properties and extracts attribute values. You can compose tag predicates using Applicative and Alternative operators: *>, <*, <|> etc.

Instances

Functor (TagPred s)

Applicative (TagPred s)

Alternative (TagPred s)

Tag predicates

satisfyPred :: TagPred s a -> TagParser s a

Make a tag parser from the tag predicate.

true :: TagPred s ()

Predicate which is always satisfied.

getTag :: TagPred s (Tag s)

True predicate which returns the tag itself.

isTagOpen :: TagPred s ()

Check if the HTML element is an open tag.

isTagOpenName :: Eq s => s -> TagPred s ()

Check if the tag is an open tag and matches the given name.

isTagClose :: TagPred s ()

Check if the HTML element is a closing tag.

isTagCloseName :: Eq s => s -> TagPred s ()

Check if the tag is a closing tag and matches the given name.

isTagText :: TagPred s ()

Test if the tag is a text node.

isTagComment :: TagPred s ()

Test if the tag is a text node.

tagOpenName :: TagPred s s

Get name of the open tag.

tagText :: TagPred s s

Get text content of the tag.

tag :: Eq s => s -> TagPred s ()

A shorthand for isTagOpenName.

hasAttr :: (Show s, Eq s, StringLike s) => s -> s -> TagPred s ()

Check if the tag has the given attribute with the given value.

getAttr :: (Show s, Eq s, StringLike s) => s -> TagPred s s

Get attribute value from the open tag.

maybeAttr :: (Show s, Eq s, StringLike s) => s -> TagPred s (Maybe s)

Get attribute value from the open tag or Nothing, if the attribute is not present.

XML parsing combinators

ignore :: Eq s => XmlParser s ()

Ignore any number of XML elements on the current level.

ignoreAny :: Eq s => XmlParser s ()

Ignore XML tree or text element.

ignoreText :: XmlParser s ()

Ignore text element.

ignoreTag :: Eq s => XmlParser s ()

Ignore XML tree.

ignoreAnyM :: (Eq s, Monoid m) => XmlParser s m

Version of the ignoreAny function with a monoid result type.

cut :: Eq s => TagPred s a -> XmlParser s a

Parse XML element using the given tag predicate and ignore contents of the element.

findAll :: Eq s => XmlParser s a -> XmlParser s [a]

Parse a list of XML elements and collect all values retrieved with a given parser.

findIgnore :: Eq s => XmlParser s a -> XmlParser s (Maybe a)

Find first XML element accepted be the given parser and ignore the rest of elements in the collection.

findFirst :: Eq s => XmlParser s a -> XmlParser s a

Find fist XML element accepted by the given parser. TODO: Change type to XmlParser s (Maybe a)?

text :: Eq s => XmlParser s s

Parse text element and retrieve its content.

join :: Eq s => TagPred s a -> (a -> XmlParser s b) -> XmlParser s b

Combine the tag parser with the XML parser which will be used to parse contents of the tag element.

joinP :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s (a, b)

Combine the tag parser with the XML parser which will be used to parse contents of the tag element. Parsing results will be returned in a form of a pair.

joinR :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s b

Combine the tag parser with the XML parser which will be used to parse contents of the tag element. Only results of the XML parser will be returned.

joinL :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s a

Combine the tag parser with the XML parser which will be used to parse contents of the tag element. Only results of the tag parser will be returned.

(>^>) :: Eq s => TagPred s a -> (a -> XmlParser s b) -> XmlParser s b

Infix version of the join combinators.

(<^>) :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s (a, b)

Infix version of the joinP combinators.

(^>) :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s b

Infix version of the joinR combinators.

(<^) :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s a

Infix version of the joinL combinators.

XPath-like combinators

(>/>) :: Eq s => TagPred s a -> (a -> XmlParser s b) -> XmlParser s [b]

Combine the tag parser with the XML parser. The XML parser can depend on the value of tag parser and will be called multiple times for tag children elements.

(</>) :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s (a, [b])

Combine the tag parser with the XML parser. The XML parser will be called multiple times for tag children elements.

(/>) :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s [b]

Combine the tag parser with the XML parser. The XML parser will be called multiple times for tag children elements. Only results of XML parsing will be returned.

(</) :: Eq s => TagPred s a -> XmlParser s b -> XmlParser s a

Combine the tag parser with the XML parser. The XML parser will be called multiple times for tag children elements. Only results of the tag parser will be returned.

(//>) :: Eq s => TagPred s a -> TagParser s b -> TagParser s [b]

Similar to /> combinator but runs the XML parser for all descendant XML elements, not only for its children.

(<#>) :: (Eq s, Monoid m) => TagPred s a -> XmlParser s m -> XmlParser s (a, m)

Combinators with results concatenation.

Similar to </> combinator but additionaly concatenates XML parser results.

(#>) :: (Eq s, Monoid m) => TagPred s a -> XmlParser s m -> XmlParser s m

Similar to /> combinator but additionaly concatenates XML parser results.

(##>) :: (Eq s, Monoid m) => TagPred s a -> TagParser s m -> TagParser s m

Similar to //> combinator but additionaly concatenates XML parser results.

Parsing

parseTags :: StringLike s => s -> [Tag s]

Parser the given string to the list of tags.

tagsParseXml :: StringLike s => XmlParser s b -> [Tag s] -> b

Parser the given tag list with the given XML parser.

parseXml :: StringLike s => XmlParser s b -> s -> b

Parser the given string with the given XML parser.

elemTags :: Eq s => XmlParser s [Tag s]

Collect all tags of the parsed XML element.

collTags :: Eq s => XmlParser s [Tag s]

Retrieve tags related to a collection of XML elements.

Utilities

many_ :: Alternative f => f a -> f ()

Many combinator which ignores parsing results.

escapeXml :: StringLike str => str -> str

Escape XML string.

module Text.ParserCombinators.Poly.Lazy