Data.XML.Parser.Mid

Mid-level XML parsers, built on top of Data.XML.Parser.Low:

• some formatting details are abstracted away (e.g. quoting, whitespacing), therefore parsers are not reversible
• entities delimited by an opening and closing sequence are recognized, except for tags which need a more complex, recursive logic
• token parsers do not overlap, therefore XML document can be tokenized in a stateless way

All documentation examples assume the following setup:

:set -XOverloadedStrings
import Data.Attoparsec.ByteString

Documentation

module Data.XML.Parser.Mid.Attribute

module Data.XML.Parser.Mid.Doctype

data Instruction

Processing instruction.

https://www.w3.org/TR/REC-xml/#dt-pi

Constructors

Instruction Text Text

Instances

Eq Instruction

Defined in Data.XML.Parser.Mid

Methods

(==) :: Instruction -> Instruction -> Bool

(/=) :: Instruction -> Instruction -> Bool

Ord Instruction

Defined in Data.XML.Parser.Mid

Methods

compare :: Instruction -> Instruction -> Ordering

(<) :: Instruction -> Instruction -> Bool

(<=) :: Instruction -> Instruction -> Bool

(>) :: Instruction -> Instruction -> Bool

(>=) :: Instruction -> Instruction -> Bool

max :: Instruction -> Instruction -> Instruction

min :: Instruction -> Instruction -> Instruction

Read Instruction

Defined in Data.XML.Parser.Mid

Methods

readsPrec :: Int -> ReadS Instruction

readList :: ReadS [Instruction]

readPrec :: ReadPrec Instruction

readListPrec :: ReadPrec [Instruction]

Show Instruction

Defined in Data.XML.Parser.Mid

Methods

showsPrec :: Int -> Instruction -> ShowS

show :: Instruction -> String

showList :: [Instruction] -> ShowS

data XMLDeclaration

https://www.w3.org/TR/REC-xml/#dt-xmldecl

Constructors

XMLDeclaration Text (Maybe Text) (Maybe Bool)

Instances

Eq XMLDeclaration

Defined in Data.XML.Parser.Mid

Methods

(==) :: XMLDeclaration -> XMLDeclaration -> Bool

(/=) :: XMLDeclaration -> XMLDeclaration -> Bool

Ord XMLDeclaration

Defined in Data.XML.Parser.Mid

Methods

compare :: XMLDeclaration -> XMLDeclaration -> Ordering

(<) :: XMLDeclaration -> XMLDeclaration -> Bool

(<=) :: XMLDeclaration -> XMLDeclaration -> Bool

(>) :: XMLDeclaration -> XMLDeclaration -> Bool

(>=) :: XMLDeclaration -> XMLDeclaration -> Bool

max :: XMLDeclaration -> XMLDeclaration -> XMLDeclaration

min :: XMLDeclaration -> XMLDeclaration -> XMLDeclaration

Read XMLDeclaration

Defined in Data.XML.Parser.Mid

Methods

readsPrec :: Int -> ReadS XMLDeclaration

readList :: ReadS [XMLDeclaration]

readPrec :: ReadPrec XMLDeclaration

readListPrec :: ReadPrec [XMLDeclaration]

Show XMLDeclaration

Defined in Data.XML.Parser.Mid

Methods

showsPrec :: Int -> XMLDeclaration -> ShowS

show :: XMLDeclaration -> String

showList :: [XMLDeclaration] -> ShowS

data StartTag

https://www.w3.org/TR/REC-xml/#dt-stag

Constructors

StartTag QName [Attribute]

Instances

Eq StartTag

Defined in Data.XML.Parser.Mid

Methods

(==) :: StartTag -> StartTag -> Bool

(/=) :: StartTag -> StartTag -> Bool

Ord StartTag

Defined in Data.XML.Parser.Mid

Methods

compare :: StartTag -> StartTag -> Ordering

(<) :: StartTag -> StartTag -> Bool

(<=) :: StartTag -> StartTag -> Bool

(>) :: StartTag -> StartTag -> Bool

(>=) :: StartTag -> StartTag -> Bool

max :: StartTag -> StartTag -> StartTag

min :: StartTag -> StartTag -> StartTag

Read StartTag

Defined in Data.XML.Parser.Mid

Methods

readsPrec :: Int -> ReadS StartTag

readList :: ReadS [StartTag]

readPrec :: ReadPrec StartTag

readListPrec :: ReadPrec [StartTag]

Show StartTag

Defined in Data.XML.Parser.Mid

Methods

showsPrec :: Int -> StartTag -> ShowS

show :: StartTag -> String

showList :: [StartTag] -> ShowS

data EmptyElementTag

https://www.w3.org/TR/REC-xml/#dt-eetag

Constructors

EmptyElementTag QName [Attribute]

Instances

Eq EmptyElementTag

Defined in Data.XML.Parser.Mid

Methods

(==) :: EmptyElementTag -> EmptyElementTag -> Bool

(/=) :: EmptyElementTag -> EmptyElementTag -> Bool

Ord EmptyElementTag

Defined in Data.XML.Parser.Mid

Methods

compare :: EmptyElementTag -> EmptyElementTag -> Ordering

(<) :: EmptyElementTag -> EmptyElementTag -> Bool

(<=) :: EmptyElementTag -> EmptyElementTag -> Bool

(>) :: EmptyElementTag -> EmptyElementTag -> Bool

(>=) :: EmptyElementTag -> EmptyElementTag -> Bool

max :: EmptyElementTag -> EmptyElementTag -> EmptyElementTag

min :: EmptyElementTag -> EmptyElementTag -> EmptyElementTag

Read EmptyElementTag

Defined in Data.XML.Parser.Mid

Methods

readsPrec :: Int -> ReadS EmptyElementTag

readList :: ReadS [EmptyElementTag]

readPrec :: ReadPrec EmptyElementTag

readListPrec :: ReadPrec [EmptyElementTag]

Show EmptyElementTag

Defined in Data.XML.Parser.Mid

Methods

showsPrec :: Int -> EmptyElementTag -> ShowS

show :: EmptyElementTag -> String

showList :: [EmptyElementTag] -> ShowS

data Token

Constructors

TokenXMLDeclaration XMLDeclaration

TokenDoctype Doctype

TokenInstruction Instruction

TokenStartTag StartTag

TokenEndTag QName

TokenEmptyElementTag EmptyElementTag

TokenData [Content]

TokenComment Text

TokenCDATA Text

Instances

Eq Token

Defined in Data.XML.Parser.Mid

Methods

(==) :: Token -> Token -> Bool

(/=) :: Token -> Token -> Bool

Ord Token

Defined in Data.XML.Parser.Mid

Methods

compare :: Token -> Token -> Ordering

(<) :: Token -> Token -> Bool

(<=) :: Token -> Token -> Bool

(>) :: Token -> Token -> Bool

(>=) :: Token -> Token -> Bool

max :: Token -> Token -> Token

min :: Token -> Token -> Token

Show Token

Defined in Data.XML.Parser.Mid

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

data TokenParser m a

A parser that consumes whole Tokens.

Instances

Monad m => Monad (TokenParser m)

Defined in Data.XML.Parser.Mid

Methods

(>>=) :: TokenParser m a -> (a -> TokenParser m b) -> TokenParser m b

(>>) :: TokenParser m a -> TokenParser m b -> TokenParser m b

return :: a -> TokenParser m a

fail :: String -> TokenParser m a

Functor m => Functor (TokenParser m)

Defined in Data.XML.Parser.Mid

Methods

fmap :: (a -> b) -> TokenParser m a -> TokenParser m b

(<$) :: a -> TokenParser m b -> TokenParser m a

(Parsing m, Monad m) => MonadFail (TokenParser m)

Defined in Data.XML.Parser.Mid

Methods

fail :: String -> TokenParser m a

Applicative m => Applicative (TokenParser m)

Defined in Data.XML.Parser.Mid

Methods

pure :: a -> TokenParser m a

(<*>) :: TokenParser m (a -> b) -> TokenParser m a -> TokenParser m b

liftA2 :: (a -> b -> c) -> TokenParser m a -> TokenParser m b -> TokenParser m c

(*>) :: TokenParser m a -> TokenParser m b -> TokenParser m b

(<*) :: TokenParser m a -> TokenParser m b -> TokenParser m a

Alternative m => Alternative (TokenParser m)

Defined in Data.XML.Parser.Mid

Methods

empty :: TokenParser m a

(<|>) :: TokenParser m a -> TokenParser m a -> TokenParser m a

some :: TokenParser m a -> TokenParser m [a]

many :: TokenParser m a -> TokenParser m [a]

runTokenParser :: TokenParser m a -> m a

tokenInstruction :: CharParsing m => Monad m => TokenParser m Instruction

https://www.w3.org/TR/REC-xml/#dt-pi

>>> parseOnly (runTokenParser tokenInstruction) "<?xml-stylesheet type='text/xsl' href='style.xsl'?>"
Right (Instruction "xml-stylesheet" "type='text/xsl' href='style.xsl'")

tokenComment :: CharParsing m => Monad m => TokenParser m Text

https://www.w3.org/TR/REC-xml/#NT-Comment

>>> parseOnly (runTokenParser tokenComment) "<!-- declarations for <head> & <body> -->"
Right " declarations for <head> & <body> "
>>> parseOnly (runTokenParser tokenComment) "<!-- B+, B, or B--->"
Right " B+, B, or B-"

tokenCdata :: CharParsing m => Monad m => TokenParser m Text

https://www.w3.org/TR/REC-xml/#dt-cdsection

>>> parseOnly (runTokenParser tokenCdata) "<![CDATA[<greeting>Hello, world!</greeting>]]>"
Right "<greeting>Hello, world!</greeting>"

tokenDoctype :: CharParsing m => Monad m => TokenParser m Doctype

https://www.w3.org/TR/REC-xml/#NT-doctypedecl

>>> parseOnly (runTokenParser tokenDoctype) "<!DOCTYPE greeting SYSTEM 'hello.dtd'>"
Right (Doctype "greeting" (Just (SystemID "hello.dtd")) [])
>>> parseOnly (runTokenParser tokenDoctype) "<!DOCTYPE foo [ <!ENTITY x '&lt;'> ]>"
Right (Doctype "foo" Nothing [GeneralEntityDeclaration "x" [ContentReference (EntityRef "lt")]])

tokenXmlDeclaration :: CharParsing m => Monad m => TokenParser m XMLDeclaration

https://www.w3.org/TR/REC-xml/#NT-XMLDecl

>>> parseOnly (runTokenParser tokenXmlDeclaration) "<?xml version='1.0' encoding='UTF-8' standalone='yes'?>"
Right (XMLDeclaration "1.0" (Just "UTF-8") (Just True))

tokenStartTag :: CharParsing m => Monad m => TokenParser m StartTag

https://www.w3.org/TR/REC-xml/#NT-STag

>>> parseOnly (runTokenParser tokenStartTag) "<termdef id='dt-dog' term='dog'>"
Right (StartTag (QName {namePrefix = "", nameLocal = "termdef"}) [Attribute (QName {namePrefix = "", nameLocal = "id"}) [ContentText "dt-dog"],Attribute (QName {namePrefix = "", nameLocal = "term"}) [ContentText "dog"]])
>>> parse (runTokenParser tokenStartTag) "<updated>2003-12-13T18:30:02Z</updated>"
Done "2003-12-13T18:30:02Z</updated>" (StartTag (QName {namePrefix = "", nameLocal = "updated"}) [])

tokenEndTag :: CharParsing m => Monad m => TokenParser m QName

https://www.w3.org/TR/REC-xml/#NT-ETag

>>> parseOnly (runTokenParser tokenEndTag) "</termdef>"
Right (QName {namePrefix = "", nameLocal = "termdef"})

tokenEmptyElementTag :: CharParsing m => Monad m => TokenParser m EmptyElementTag

https://www.w3.org/TR/REC-xml/#NT-EmptyElemTag

>>> parseOnly (runTokenParser tokenEmptyElementTag) "<IMG align='left' src='http://www.w3.org/Icons/WWW/w3c_home' />"
Right (EmptyElementTag (QName {namePrefix = "", nameLocal = "IMG"}) [Attribute (QName {namePrefix = "", nameLocal = "align"}) [ContentText "left"],Attribute (QName {namePrefix = "", nameLocal = "src"}) [ContentText "http://www.w3.org/Icons/WWW/w3c_home"]])

tokenData :: CharParsing m => Monad m => TokenParser m [Content]

https://www.w3.org/TR/REC-xml/#NT-CharData

>>> parseOnly (runTokenParser tokenData) "Rock & roll"
Right [ContentText "Rock ",ContentReference (EntityRef "amp"),ContentText " roll"]

anyToken :: CharParsing m => Monad m => TokenParser m Token

Parse any Token.