Text.HTML.TagSoup

A single HTML element. A whole document is represented by a list of Tag. There is no requirement for TagOpen and TagClose to match.

The row/line of a position, starting at 1

The column of a position, starting at 1

An HTML attribute id="name" generates ("id","name")

These options control how parseTags works. The ParseOptions type is usually generated by one of parseOptions, parseOptionsFast or parseOptionsEntities, then selected fields may be overriden.

The options optTagPosition and optTagWarning specify whether to generate TagPosition or TagWarning elements respectively. Usually these options should be set to False to simplify future stages, unless you rely on position information or want to give malformed HTML messages to the end user.

The options optEntityData and optEntityAttrib control how entities, for example   are handled. Both take a string, and a boolean, where True indicates that the entity ended with a semi-colon ;. Inside normal text optEntityData will be called, and the results will be inserted in the tag stream. Inside a tag attribute optEntityAttrib will be called, and the first component of the result will be used in the attribute, and the second component will be appended after the TagOpen value (usually the second component is []). As an example, to not decode any entities, pass:

parseOptions
    {optEntityData=\(str,b) -> [TagText $ "&" ++ str ++ [';' | b]]
    ,optEntityAttrib\(str,b) -> ("&" ++ str ++ [';' | b], [])

Parse a string to a list of tags, using an HTML 5 compliant parser.

parseTags "<hello>my&amp;</world>" == [TagOpen "hello" [],TagText "my&",TagClose "world"]

Parse a string to a list of tags, using settings supplied by the ParseOptions parameter, eg. to output position information:

parseTagsOptions parseOptions{optTagPosition = True} "<hello>my&amp;</world>" ==
   [TagPosition 1 1,TagOpen "hello" [],TagPosition 1 8,TagText "my&",TagPosition 1 15,TagClose "world"]

The default parse options value, described in ParseOptions. Equivalent to parseOptionsEntities lookupEntity.

A ParseOptions structure optimised for speed, following the fast options.

A ParseOptions structure using a custom function to lookup attributes. Any attribute that is not found will be left intact, and a TagWarning given (if optTagWarning is set).

If you do not want to resolve any entities, simpliy pass const Nothing for the lookup function.

These options control how renderTags works.

The strange quirk of only minimizing <br> tags is due to Internet Explorer treating <br></br> as <br><br>.

Show a list of tags, as they might have been parsed, using the default settings given in RenderOptions.

renderTags [TagOpen "hello" [],TagText "my&",TagClose "world"] == "<hello>my&amp;</world>"

Show a list of tags using settings supplied by the RenderOptions parameter, eg. to avoid escaping any characters one could do:

renderTagsOptions renderOptions{optEscape = id} [TagText "my&"] == "my&"

Replace the four characters &"<> with their HTML entities (escapeXML lifted to StringLike).

The default render options value, described in RenderOptions.

Turns all tag names and attributes to lower case and converts DOCTYPE to upper case.

Test if a Tag is a TagOpen

Test if a Tag is a TagClose

Test if a Tag is a TagText

Test if a Tag is a TagWarning

Test if a Tag is a TagPosition

Returns True if the Tag is TagOpen and matches the given name

Returns True if the Tag is TagClose and matches the given name

Test if a Tag is a TagComment

Extract the string from within TagText, crashes if not a TagText

Extract an attribute, crashes if not a TagOpen. Returns "" if no attribute present.

Warning: does not distinquish between missing attribute and present attribute with value "".

Extract the string from within TagText, otherwise Nothing

Extract the string from within TagWarning, otherwise Nothing

Extract all text content from tags (similar to Verbatim found in HaXml)

This function takes a list, and returns all suffixes whose first item matches the predicate.

This function is similar to sections, but splits the list so no element appears in any two partitions.

Define a class to allow String's or Tag str's to be used as matches

Performs an inexact match, the first item should be the thing to match. If the second item is a blank string, that is considered to match anything. For example:

(TagText "test" ~== TagText ""    ) == True
(TagText "test" ~== TagText "test") == True
(TagText "test" ~== TagText "soup") == False

For TagOpen missing attributes on the right are allowed.

Negation of ~==