hexpat-0.19.7: XML parser/formatter based on expat

Text.XML.Expat.SAX

Contents

Description

This module provides functions to parse an XML document to a lazy stream of SAX events.

Synopsis

XML primitives

data Encoding Source

Encoding types available for the document encoding.

Constructors

ASCII 
UTF8 
UTF16 
ISO88591 

data XMLParseError Source

Parse error, consisting of message text and error location

data XMLParseLocation Source

Specifies a location of an event within the input text

Constructors

XMLParseLocation 

Fields

xmlLineNumber :: Int64

Line number of the event

xmlColumnNumber :: Int64

Column number of the event

xmlByteIndex :: Int64

Byte index of event from start of document

xmlByteCount :: Int64

The number of bytes in the event

SAX-style parse

data ParseOptions tag text Source

Constructors

ParseOptions 

Fields

overrideEncoding :: Maybe Encoding

The encoding parameter, if provided, overrides the document's encoding declaration.

entityDecoder :: Maybe (tag -> Maybe text)

If provided, entity references (i.e.   and friends) will be decoded into text using the supplied lookup function

data SAXEvent tag text Source

Constructors

XMLDeclaration text (Maybe text) (Maybe Bool) 
StartElement tag [(tag, text)] 
EndElement tag 
CharacterData text 
StartCData 
EndCData 
ProcessingInstruction text text 
Comment text 
FailDocument XMLParseError 

Instances

(Eq tag, Eq text) => Eq (SAXEvent tag text) 
(Show tag, Show text) => Show (SAXEvent tag text) 
(NFData tag, NFData text) => NFData (SAXEvent tag text) 

textFromCString :: GenericXMLString text => CString -> IO textSource

Converts a CString to a GenericXMLString type.

parseSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> ParseOptions tag text

Parse options

-> ByteString

Input text (a lazy ByteString)

-> [SAXEvent tag text] 

Lazily parse XML to SAX events. In the event of an error, FailDocument is the last element of the output list.

parseGSource

Arguments

:: forall tag text l . (GenericXMLString tag, GenericXMLString text, List l) 
=> ParseOptions tag text

Parse options

-> l ByteString

Input text (a lazy ByteString)

-> l (SAXEvent tag text) 

Parse a generalized list of ByteStrings containing XML to SAX events. In the event of an error, FailDocument is the last element of the output list.

parseLocationsSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> ParseOptions tag text

Parse options

-> ByteString

Input text (a lazy ByteString)

-> [(SAXEvent tag text, XMLParseLocation)] 

A variant of parseSAX that gives a document location with each SAX event.

parseLocationsGSource

Arguments

:: forall tag text l . (GenericXMLString tag, GenericXMLString text, List l) 
=> ParseOptions tag text

Parse options

-> l ByteString

Input text (a lazy ByteString)

-> l (SAXEvent tag text, XMLParseLocation) 

Parse a generalized list of ByteStrings containing XML to SAX events. In the event of an error, FailDocument is the last element of the output list.

parseLocationsThrowingSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> ParseOptions tag text

Optional encoding override

-> ByteString

Input text (a lazy ByteString)

-> [(SAXEvent tag text, XMLParseLocation)] 

A variant of parseSAX that gives a document location with each SAX event. In the event of an error, throw XMLParseException.

parseLocationsThrowing can throw an exception from pure code, which is generally a bad way to handle errors, because Haskell's lazy evaluation means it's hard to predict where it will be thrown from. However, it may be acceptable in situations where it's not expected during normal operation, depending on the design of your program.

parseThrowingSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> ParseOptions tag text

Parse options

-> ByteString

input text (a lazy ByteString)

-> [SAXEvent tag text] 

Lazily parse XML to SAX events. In the event of an error, throw XMLParseException.

parseThrowing can throw an exception from pure code, which is generally a bad way to handle errors, because Haskell's lazy evaluation means it's hard to predict where it will be thrown from. However, it may be acceptable in situations where it's not expected during normal operation, depending on the design of your program.

Variants that throw exceptions

data XMLParseException Source

An exception indicating an XML parse error, used by the ..Throwing variants.

Helpers

setEntityDecoderSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> Parser 
-> (tag -> Maybe text)

Entity decoder

-> (ParserPtr -> text -> IO ())

Code to insert character data into the document

-> IO () 

A helper for configuring the hexpat parser to use the specified entity decoder.

Abstraction of string types

class (Monoid s, Eq s) => GenericXMLString s whereSource

An abstraction for any string type you want to use as xml text (that is, attribute values or element text content). If you want to use a new string type with hexpat, you must make it an instance of GenericXMLString.

Deprecated parse functions

parseSAXSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> Maybe Encoding

Optional encoding override

-> ByteString

Input text (a lazy ByteString)

-> [SAXEvent tag text] 

DEPRECATED: Use parse instead.

Lazily parse XML to SAX events. In the event of an error, FailDocument is the last element of the output list. Deprecated in favour of new parse

parseSAXLocationsSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> Maybe Encoding

Optional encoding override

-> ByteString

Input text (a lazy ByteString)

-> [(SAXEvent tag text, XMLParseLocation)] 

DEPRECATED: Use parseLocations instead.

A variant of parseSAX that gives a document location with each SAX event.

parseSAXLocationsThrowingSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> Maybe Encoding

Optional encoding override

-> ByteString

Input text (a lazy ByteString)

-> [(SAXEvent tag text, XMLParseLocation)] 

DEPRECATED: Used parseLocationsThrowing instead.

A variant of parseSAX that gives a document location with each SAX event. In the event of an error, throw XMLParseException.

parseSAXThrowingSource

Arguments

:: (GenericXMLString tag, GenericXMLString text) 
=> Maybe Encoding

Optional encoding override

-> ByteString

Input text (a lazy ByteString)

-> [SAXEvent tag text] 

DEPRECATED: Use parseThrowing instead.

Lazily parse XML to SAX events. In the event of an error, throw XMLParseException.

type ParserOptions tag text = ParseOptions tag textSource

defaultParserOptions :: ParseOptions tag textSource

DEPRECATED. Renamed to defaultParseOptions.