Text.XML.Enumerator.Parse

This module provides both a native Haskell solution for parsing XML documents into a stream of events, and a set of parser combinators for dealing with a stream of events.

The important thing to know about the combinators is that they do not work on the fully-powered Event datatype; rather, this module defines an SEvent datatype which only deals with tags, attributes and content. For most uses, this is sufficient. If you need to parse doctypes, instructions or contents, you will not be able to use the combinators.

As a simple example, if you have the following XML file:

 <?xml version="1.0" encoding="utf-8"?>
 <people>
     <person age="25">Michael</person>
     <person age="2">Eliezer</person>
 </people>

Then this code:

 {-# LANGUAGE OverloadedStrings #-}
 import Text.XML.Enumerator.Parse
 import Data.Text.Lazy (Text, unpack)
 
 data Person = Person { age :: Int, name :: Text }
     deriving Show
 
 parsePerson = tag' "person" (requireAttr "age") $ \age -> do
     name <- content'
     return $ Person (read $ unpack age) name
 
 parsePeople = tag'' "people" $ many parsePerson
 
 main = parseFile_ "people.xml" (const Nothing) $ force "people required" parsePeople

will produce:

 [Person {age = 25, name = "Michael"},Person {age = 2, name = "Eliezer"}]

Parsing XML files

parseBytes :: Monad m => DecodeEntities -> Enumeratee ByteString Event m a

Parses a byte stream into Events. This function is implemented fully in Haskell using attoparsec-text for parsing. The produced error messages do not give line/column information, so you may prefer to stick with the parser provided by libxml-enumerator. However, this has the advantage of not relying on any C libraries.

This relies on detectUtf to determine character encoding, and parseText to do the actual parsing.

parseText :: Monad m => DecodeEntities -> Enumeratee Text Event m a

Parses a character stream into Events. This function is implemented fully in Haskell using attoparsec-text for parsing. The produced error messages do not give line/column information, so you may prefer to stick with the parser provided by libxml-enumerator. However, this has the advantage of not relying on any C libraries.

detectUtf :: Monad m => Enumeratee ByteString Text m a

Automatically determine which UTF variant is being used. This function first checks for BOMs, removing them as necessary, and then check for the equivalent of <?xml for each of UTF-8, UTF-16LEBE, and UTF-32LEBE. It defaults to assuming UTF-8.

parseFile :: FilePath -> DecodeEntities -> Iteratee Event IO a -> IO (Either SomeException a)

A helper function which reads a file from disk using enumFile, detects character encoding using detectUtf, parses the XML using parseBytes, converts to an SEvent stream using simplify and then handing off control to your supplied parser.

parseFile_ :: FilePath -> DecodeEntities -> Iteratee Event IO a -> IO a

The same as parseFile, but throws any exceptions.

parseLBS :: ByteString -> DecodeEntities -> Iteratee Event IO a -> IO (Either SomeException a)

parseLBS_ :: ByteString -> DecodeEntities -> Iteratee Event IO a -> IO a

Entity decoding

type DecodeEntities = Text -> Content

decodeEntities :: DecodeEntities

Default implementation of DecodeEntities: handles numeric entities and the five standard character entities (lt, gt, amp, quot, apos).

Event parsing

tag :: Monad m => (Name -> Maybe a) -> (a -> AttrParser b) -> (b -> Iteratee Event m c) -> Iteratee Event m (Maybe c)

The most generic way to parse a tag. It takes a predicate for checking if this is the correct tag name, an AttrParser for handling attributes, and then a parser for dealing with content.

This function automatically absorbs its balancing closing tag, and will throw an exception if not all of the attributes or child elements are consumed. If you want to allow extra attributes, see ignoreAttrs.

tagName :: Monad m => Name -> AttrParser a -> (a -> Iteratee Event m b) -> Iteratee Event m (Maybe b)

A simplified version of tag which matches for specific tag names instead of taking a predicate function. This is often sufficient, and when combined with OverloadedStrings and the IsString instance of Name, can prove to be very concise.

tagNoAttr :: Monad m => Name -> Iteratee Event m a -> Iteratee Event m (Maybe a)

A further simplified tag parser, which requires that no attributes exist.

content :: Monad m => Iteratee Event m Text

Grabs the next piece of content. If none if available, returns empty.

contentMaybe :: Monad m => Iteratee Event m (Maybe Text)

Grabs the next piece of content if available.

ignoreElem :: Monad m => Iteratee Event m (Maybe ())

Iteratee to skip the next element.

ignoreSiblings :: Monad m => Iteratee Event m ()

Iteratee to skip the siblings element.

Attribute parsing

data AttrParser a

A monad for parsing attributes. By default, it requires you to deal with all attributes present on an element, and will throw an exception if there are unhandled attributes. Use the requireAttr, optionalAttr et al functions for handling an attribute, and ignoreAttrs if you would like to skip the rest of the attributes on an element.

Instances

Monad AttrParser

Functor AttrParser

Applicative AttrParser

requireAttr :: Name -> AttrParser Text

Require that a certain attribute be present and return its value.

optionalAttr :: Name -> AttrParser (Maybe Text)

Return the value for an attribute if present.

requireAttrRaw :: String -> ((Name, [Content]) -> Maybe b) -> AttrParser b

optionalAttrRaw :: ((Name, [Content]) -> Maybe b) -> AttrParser (Maybe b)

ignoreAttrs :: AttrParser ()

Skip the remaining attributes on an element. Since this will clear the list of attributes, you must call this after any calls to requireAttr, optionalAttr, etc.

skipAttrs :: AttrParser a -> AttrParser a

Combinator to skip the attributes.

Combinators

choose :: Monad m => [Iteratee Event m (Maybe a)] -> Iteratee Event m (Maybe a)

Get the value of the first parser which returns Just. If none return Just, returns Nothing.

many :: Monad m => Iteratee Event m (Maybe a) -> Iteratee Event m [a]

Keep parsing elements as long as the parser returns Just.

force

Arguments

:: Monad m

=> String

Error message

-> Iteratee Event m (Maybe a)

-> Iteratee Event m a

Force an optional parser into a required parser. All of the tag functions, choose and many deal with Maybe parsers. Use this when you want to finally force something to happen.

skipTill :: Monad m => Iteratee Event m (Maybe a) -> Iteratee Event m (Maybe a)

Skip the siblings elements until iteratee not right.

skipSiblings :: Monad m => Iteratee Event m a -> Iteratee Event m a

Combinator to skip the siblings element.

Exceptions

data XmlException

Constructors

XmlException

Fields

xmlErrorMessage :: String

xmlBadInput :: Maybe Event

InvalidEndElement Name

InvalidEntity Text

UnparsedAttributes [(Name, [Content])]

Instances

Show XmlException

Typeable XmlException

Exception XmlException