hxt-9.2.2: A collection of tools for processing XML with Haskell.

Portability | portable
Stability | experimental
Maintainer | Uwe Schmidt (uwe@fh-wedel.de)
Safe Haskell | Safe-Infered

Text.XML.HXT.Arrow.XmlRegex

Description

Regular Expression Matcher working on lists of XmlTrees

It's intendet to import this module with an explicit import declaration for not spoiling the namespace with these somewhat special arrows

Synopsis

- data XmlRegex
- mkZero :: String -> XmlRegex
- mkUnit :: XmlRegex
- mkPrim :: (XmlTree -> Bool) -> XmlRegex
- mkPrimA :: LA XmlTree XmlTree -> XmlRegex
- mkDot :: XmlRegex
- mkStar :: XmlRegex -> XmlRegex
- mkAlt :: XmlRegex -> XmlRegex -> XmlRegex
- mkAlts :: [XmlRegex] -> XmlRegex
- mkSeq :: XmlRegex -> XmlRegex -> XmlRegex
- mkSeqs :: [XmlRegex] -> XmlRegex
- mkRep :: Int -> XmlRegex -> XmlRegex
- mkRng :: Int -> Int -> XmlRegex -> XmlRegex
- mkOpt :: XmlRegex -> XmlRegex
- nullable :: XmlRegex -> Bool
- delta :: XmlRegex -> XmlTree -> XmlRegex
- matchXmlRegex :: XmlRegex -> XmlTrees -> Maybe String
- splitXmlRegex :: XmlRegex -> XmlTrees -> Maybe (XmlTrees, XmlTrees)
- scanXmlRegex :: XmlRegex -> XmlTrees -> Maybe [XmlTrees]
- matchRegexA :: XmlRegex -> LA XmlTree XmlTree -> LA XmlTree XmlTrees
- splitRegexA :: XmlRegex -> LA XmlTree XmlTree -> LA XmlTree (XmlTrees, XmlTrees)
- scanRegexA :: XmlRegex -> LA XmlTree XmlTree -> LA XmlTree XmlTrees

# Documentation

data XmlRegex

Instances

Show XmlRegex |

mkZero :: String -> XmlRegex

mkUnit :: XmlRegex

mkPrim :: (XmlTree -> Bool) -> XmlRegex

mkPrimA :: LA XmlTree XmlTree -> XmlRegex

mkDot :: XmlRegex

mkStar :: XmlRegex -> XmlRegex

mkAlt :: XmlRegex -> XmlRegex -> XmlRegex

mkAlts :: [XmlRegex] -> XmlRegex

mkSeq :: XmlRegex -> XmlRegex -> XmlRegex

mkSeqs :: [XmlRegex] -> XmlRegex

mkRep :: Int -> XmlRegex -> XmlRegex

mkRng :: Int -> Int -> XmlRegex -> XmlRegex

mkOpt :: XmlRegex -> XmlRegex

nullable :: XmlRegex -> Bool

delta :: XmlRegex -> XmlTree -> XmlRegex

matchXmlRegex :: XmlRegex -> XmlTrees -> Maybe String

match a sequence of XML trees with a regular expression over trees

If the input matches, the result is Nothing, else Just an error message is returned

splitXmlRegex :: XmlRegex -> XmlTrees -> Maybe (XmlTrees, XmlTrees)

split a sequence of XML trees into a pair of a a matching prefix and a rest

If there is no matching prefix, Nothing is returned

scanXmlRegex :: XmlRegex -> XmlTrees -> Maybe [XmlTrees]

scan a sequence of XML trees and split it into parts matching the given regex

If the parts cannot be split because of a missing match, or because of the empty sequence as match, Nothing is returned

matchRegexA :: XmlRegex -> LA XmlTree XmlTree -> LA XmlTree XmlTrees

check whether a sequence of XmlTrees match an Xml regular expression

The arrow for `matchXmlRegex`.

The expession is build up from simple arrows acting as predicate (`mkPrimA`) for an XmlTree and of the usual cobinators for sequence (`mkSeq`), repetition (`mkStar`, mkRep', `mkRng`) and choice (`mkAlt`, `mkOpt`)

splitRegexA :: XmlRegex -> LA XmlTree XmlTree -> LA XmlTree (XmlTrees, XmlTrees)

split the sequence of trees computed by the filter a into

The arrow for `splitXmlRegex`.

a first part matching the regex and a rest, if a prefix of the input sequence does not match the regex, the arrow fails else the pair containing the result lists is returned

scanRegexA :: XmlRegex -> LA XmlTree XmlTree -> LA XmlTree XmlTrees

scan the input sequence with a regex and give the result as a list of lists of trees back the regex must at least match one input tree, so the empty sequence should not match the regex

The arrow for `scanXmlRegex`.