-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Streaming-friendly XML parsers
--   
--   Cf README file
@package hextream
@version 0.2.0.0


-- | Utilities to handle entity references.
module Data.XML.Parser.Low.Entity

-- | A function that describes how to expand entity references.
newtype EntityDecoder
EntityDecoder :: (Text -> Maybe Text) -> EntityDecoder
[runEntityDecoder] :: EntityDecoder -> Text -> Maybe Text

-- | <a>https://www.w3.org/TR/REC-xml/#sec-predefined-ent</a>
decodePredefinedEntities :: EntityDecoder

-- | <a>https://www.w3.org/TR/xhtml1/dtds.html#h-A2</a>
decodeHtmlEntities :: EntityDecoder
instance GHC.Base.Semigroup Data.XML.Parser.Low.Entity.EntityDecoder
instance GHC.Base.Monoid Data.XML.Parser.Low.Entity.EntityDecoder


-- | All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   </pre>
module Data.XML.Parser.Low.Name

-- | A qualified name.
--   
--   <a>https://www.w3.org/TR/xml-names/#dt-qualname</a>
data QName
QName :: Text -> Text -> QName
[namePrefix] :: QName -> Text
[nameLocal] :: QName -> Text

-- | <a>https://www.w3.org/TR/xml-names/#NT-QName</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenQualifiedName "price"
--   Right (QName {namePrefix = "", nameLocal = "price"})
--   
--   &gt;&gt;&gt; parseOnly tokenQualifiedName "edi:price"
--   Right (QName {namePrefix = "edi", nameLocal = "price"})
--   </pre>
tokenQualifiedName :: CharParsing m => Monad m => m QName

-- | <a>https://www.w3.org/TR/xml-names/#NT-NCName</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenNCName "price"
--   Right "price"
--   
--   &gt;&gt;&gt; parse tokenNCName "edi:price"
--   Done ":price" "edi"
--   </pre>
tokenNCName :: CharParsing m => Monad m => m Text

-- | <a>https://www.w3.org/TR/REC-xml/#NT-Name</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenName "price"
--   Right "price"
--   
--   &gt;&gt;&gt; parseOnly tokenName "edi:price"
--   Right "edi:price"
--   </pre>
tokenName :: CharParsing m => Monad m => m Text
instance GHC.Show.Show Data.XML.Parser.Low.Name.QName
instance GHC.Read.Read Data.XML.Parser.Low.Name.QName
instance GHC.Classes.Ord Data.XML.Parser.Low.Name.QName
instance GHC.Classes.Eq Data.XML.Parser.Low.Name.QName
instance Data.String.IsString Data.XML.Parser.Low.Name.QName


-- | Low-level XML parsers:
--   
--   <ul>
--   <li>parsed tokens are small and may overlap; it is not possible to
--   tokenize XML document in a stateless way</li>
--   <li>parsers are reversible: all formatting details are retained (e.g.
--   whitespacing)</li>
--   </ul>
--   
--   All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   </pre>
module Data.XML.Parser.Low

-- | Entity reference, or character reference.
data Reference
EntityRef :: Text -> Reference
CharRef :: Char -> Reference

-- | Raw text or reference.
data Content
ContentText :: Text -> Content
ContentReference :: Reference -> Content

-- | Expand content reference, if any.
expandContent :: Alternative m => EntityDecoder -> Content -> m Text

-- | Same as <a>expandContent</a>, but on a list. Provided for convenience.
expandContents :: Alternative m => Monad m => EntityDecoder -> [Content] -> m Text

-- | Resolve reference into raw text.
expandReference :: Alternative m => EntityDecoder -> Reference -> m Text

-- | Same as <tt>expandReference decodePredefinedEntities</tt>, provided
--   for convenience.
expandReference' :: Reference -> Maybe Text

-- | <pre>
--   '
--   </pre>
tokenSingleQuote :: CharParsing m => m Char

-- | <pre>
--   "
--   </pre>
tokenDoubleQuote :: CharParsing m => m Char

-- | Single or double quote.
tokenQuote :: CharParsing m => m Char

-- | <a>https://www.w3.org/TR/REC-xml/#NT-S</a>
tokenWhitespace :: CharParsing m => m String

-- | <a>https://www.w3.org/TR/REC-xml/#NT-Eq</a>
tokenEqual :: CharParsing m => Monad m => m ()

-- | <a>https://www.w3.org/TR/REC-xml/#NT-Reference</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenReference "&amp;#x3C;"
--   Right (CharRef '&lt;')
--   
--   &gt;&gt;&gt; parseOnly tokenReference "&amp;docdate;"
--   Right (EntityRef "docdate")
--   </pre>
tokenReference :: CharParsing m => Monad m => m Reference
tokenContent :: CharParsing m => Monad m => String -> m Content

-- | <pre>
--   &lt;!ENTITY
--   </pre>
tokenEntityDeclarationOpen :: CharParsing m => m ()

-- | Return processing instruction name.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenInstructionOpen "&lt;?php"
--   Right "php"
--   </pre>
tokenInstructionOpen :: CharParsing m => Monad m => m Text

-- | <pre>
--   ?&gt;
--   </pre>
tokenInstructionClose :: CharParsing m => m ()

-- | <pre>
--   &lt;![CDATA[
--   </pre>
--   
--   <a>https://www.w3.org/TR/REC-xml/#NT-CDStart</a>
tokenCdataOpen :: CharParsing m => m ()

-- | <pre>
--   ]]&gt;
--   </pre>
--   
--   <a>https://www.w3.org/TR/REC-xml/#NT-CDEnd</a>
tokenCdataClose :: CharParsing m => m ()

-- | <pre>
--   &lt;!--
--   </pre>
tokenCommentOpen :: CharParsing m => m ()

-- | <pre>
--   --&gt;
--   </pre>
tokenCommentClose :: CharParsing m => m ()

-- | <pre>
--   &lt;!DOCTYPE
--   </pre>
tokenDoctypeOpen :: CharParsing m => m ()

-- | <pre>
--   &lt;?xml
--   </pre>
tokenXmlDeclarationOpen :: CharParsing m => m ()

-- | <pre>
--   ?&gt;
--   </pre>
tokenXmlDeclarationClose :: CharParsing m => m ()

-- | <pre>
--   /&gt;
--   </pre>
tokenEmptyElementTagClose :: CharParsing m => m ()

-- | Return tag name.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenStartTagOpen "&lt;foo"
--   Right (QName {namePrefix = "", nameLocal = "foo"})
--   </pre>
tokenStartTagOpen :: CharParsing m => Monad m => m QName

-- | Return tag name.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly tokenEndTagOpen "&lt;/foo"
--   Right (QName {namePrefix = "", nameLocal = "foo"})
--   </pre>
tokenEndTagOpen :: CharParsing m => Monad m => m QName

-- | <pre>
--   &gt;
--   </pre>
tokenElementClose :: CharParsing m => m ()
instance GHC.Show.Show Data.XML.Parser.Low.Content
instance GHC.Read.Read Data.XML.Parser.Low.Content
instance GHC.Classes.Ord Data.XML.Parser.Low.Content
instance GHC.Classes.Eq Data.XML.Parser.Low.Content
instance GHC.Show.Show Data.XML.Parser.Low.Reference
instance GHC.Read.Read Data.XML.Parser.Low.Reference
instance GHC.Classes.Ord Data.XML.Parser.Low.Reference
instance GHC.Classes.Eq Data.XML.Parser.Low.Reference


-- | All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   import Data.XML.Parser.High
--   </pre>
module Data.XML.Parser.High.NameParser

-- | How to parse tag names.
newtype NameParser a
NameParser :: (QName -> Either String a) -> NameParser a
[runNameParser] :: NameParser a -> QName -> Either String a

-- | Match any qualified name.
anyName :: NameParser QName

-- | Match any qualified name, except for the given value.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' (anyNameExcept "foo") anyAttr anyContent) "&lt;foo&gt;&lt;/foo&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' (anyNameExcept "foo") anyAttr anyContent) "&lt;bar&gt;&lt;/bar&gt;"
--   Right ()
--   </pre>
anyNameExcept :: QName -> NameParser QName
instance GHC.Base.Functor Data.XML.Parser.High.NameParser.NameParser
instance GHC.Base.Applicative Data.XML.Parser.High.NameParser.NameParser
instance GHC.Base.Alternative Data.XML.Parser.High.NameParser.NameParser
instance (a Data.Type.Equality.~ ()) => Data.String.IsString (Data.XML.Parser.High.NameParser.NameParser a)
instance GHC.Base.Monad Data.XML.Parser.High.NameParser.NameParser
instance Control.Monad.Fail.MonadFail Data.XML.Parser.High.NameParser.NameParser


-- | All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   import Data.XML.Parser.High
--   </pre>
module Data.XML.Parser.High.AttrParser

-- | How to parse tag attributes.
newtype AttrParser a
AttrParser :: (Map QName Text -> Either String a) -> AttrParser a
[runAttrParser] :: AttrParser a -> Map QName Text -> Either String a

-- | Parse any set of attributes.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr noContent) "&lt;tag&gt;&lt;/tag&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr noContent) "&lt;tag key='value'&gt;&lt;/tag&gt;"
--   Right ()
--   </pre>
anyAttr :: AttrParser ()

-- | Assert that no attributes exist.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName noAttr noContent) "&lt;tag&gt;&lt;/tag&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName noAttr noContent) "&lt;tag key='value'&gt;&lt;/tag&gt;"
--   Left ...
--   </pre>
noAttr :: AttrParser ()

-- | Parse attribute by name, and return its value.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName (attrValue "foo") noContent) "&lt;tag&gt;&lt;/tag&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName (attrValue "foo") noContent) "&lt;tag foo='bar'&gt;&lt;/tag&gt;"
--   Right ()
--   </pre>
attrValue :: QName -> AttrParser Text

-- | Assert that an attribute exists, with given name and value.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName (hasAttr "foo" "bar") noContent) "&lt;tag&gt;&lt;/tag&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName (hasAttr "foo" "bar") noContent) "&lt;tag foo='baz'&gt;&lt;/tag&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName (hasAttr "foo" "bar") noContent) "&lt;tag foo='bar'&gt;&lt;/tag&gt;"
--   Right ()
--   </pre>
hasAttr :: QName -> Text -> AttrParser ()
instance GHC.Base.Functor Data.XML.Parser.High.AttrParser.AttrParser
instance GHC.Base.Applicative Data.XML.Parser.High.AttrParser.AttrParser
instance GHC.Base.Alternative Data.XML.Parser.High.AttrParser.AttrParser
instance GHC.Base.Monad Data.XML.Parser.High.AttrParser.AttrParser
instance Control.Monad.Fail.MonadFail Data.XML.Parser.High.AttrParser.AttrParser


-- | All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   </pre>
module Data.XML.Parser.Mid.Attribute

-- | <a>https://www.w3.org/TR/REC-xml/#dt-attr</a>
data Attribute
Attribute :: QName -> [Content] -> Attribute

-- | <a>https://www.w3.org/TR/REC-xml/#NT-Attribute</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly attribute "name = 'value'"
--   Right (Attribute (QName {namePrefix = "", nameLocal = "name"}) [ContentText "value"])
--   </pre>
attribute :: CharParsing m => Monad m => m Attribute
instance GHC.Show.Show Data.XML.Parser.Mid.Attribute.Attribute
instance GHC.Read.Read Data.XML.Parser.Mid.Attribute.Attribute
instance GHC.Classes.Ord Data.XML.Parser.Mid.Attribute.Attribute
instance GHC.Classes.Eq Data.XML.Parser.Mid.Attribute.Attribute


-- | Document type declaration parsers.
--   
--   <a>https://www.w3.org/TR/REC-xml/#dt-doctype</a>
--   
--   All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   </pre>
module Data.XML.Parser.Mid.Doctype

-- | External entity identifier
--   
--   <a>https://www.w3.org/TR/REC-xml/#dt-extent</a>
data ExternalID
PublicID :: Text -> Text -> ExternalID
SystemID :: Text -> ExternalID

-- | <a>https://www.w3.org/TR/REC-xml/#NT-ExternalID</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly externalID "PUBLIC '-//Textuality//TEXT Standard open-hatch boilerplate//EN' 'http://www.textuality.com/boilerplate/OpenHatch.xml'"
--   Right (PublicID "-//Textuality//TEXT Standard open-hatch boilerplate//EN" "http://www.textuality.com/boilerplate/OpenHatch.xml")
--   
--   &gt;&gt;&gt; parseOnly externalID "SYSTEM '../grafix/OpenHatch.gif'"
--   Right (SystemID "../grafix/OpenHatch.gif")
--   </pre>
externalID :: CharParsing m => Monad m => m ExternalID

-- | <a>https://www.w3.org/TR/REC-xml/#gen-entity</a>
data GeneralEntityDeclaration
GeneralEntityDeclaration :: Text -> [Content] -> GeneralEntityDeclaration

-- | <a>https://www.w3.org/TR/REC-xml/#NT-GEDecl</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly generalEntityDeclaration "&lt;!ENTITY d '&amp;#xD;'&gt;"
--   Right (GeneralEntityDeclaration "d" [ContentReference (CharRef '\r')])
--   
--   &gt;&gt;&gt; parseOnly generalEntityDeclaration "&lt;!ENTITY da '&amp;#xD;&amp;#xA;'&gt;"
--   Right (GeneralEntityDeclaration "da" [ContentReference (CharRef '\r'),ContentReference (CharRef '\n')])
--   
--   &gt;&gt;&gt; parseOnly generalEntityDeclaration "&lt;!ENTITY Pub-Status 'This is a pre-release of the specification.'&gt;"
--   Right (GeneralEntityDeclaration "Pub-Status" [ContentText "This is a pre-release of the specification."])
--   </pre>
generalEntityDeclaration :: CharParsing m => Monad m => m GeneralEntityDeclaration

-- | <a>https://www.w3.org/TR/REC-xml/#dt-doctype</a>
data Doctype
Doctype :: Text -> Maybe ExternalID -> [GeneralEntityDeclaration] -> Doctype

-- | <a>https://www.w3.org/TR/REC-xml/#NT-doctypedecl</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly doctype "&lt;!DOCTYPE greeting SYSTEM 'hello.dtd'&gt;"
--   Right (Doctype "greeting" (Just (SystemID "hello.dtd")) [])
--   
--   &gt;&gt;&gt; parseOnly doctype "&lt;!DOCTYPE foo [ &lt;!ENTITY x '&amp;lt;'&gt; ]&gt;"
--   Right (Doctype "foo" Nothing [GeneralEntityDeclaration "x" [ContentReference (EntityRef "lt")]])
--   </pre>
doctype :: CharParsing m => Monad m => m Doctype
instance GHC.Show.Show Data.XML.Parser.Mid.Doctype.Doctype
instance GHC.Read.Read Data.XML.Parser.Mid.Doctype.Doctype
instance GHC.Classes.Ord Data.XML.Parser.Mid.Doctype.Doctype
instance GHC.Classes.Eq Data.XML.Parser.Mid.Doctype.Doctype
instance GHC.Show.Show Data.XML.Parser.Mid.Doctype.GeneralEntityDeclaration
instance GHC.Read.Read Data.XML.Parser.Mid.Doctype.GeneralEntityDeclaration
instance GHC.Classes.Ord Data.XML.Parser.Mid.Doctype.GeneralEntityDeclaration
instance GHC.Classes.Eq Data.XML.Parser.Mid.Doctype.GeneralEntityDeclaration
instance GHC.Show.Show Data.XML.Parser.Mid.Doctype.ExternalID
instance GHC.Read.Read Data.XML.Parser.Mid.Doctype.ExternalID
instance GHC.Classes.Ord Data.XML.Parser.Mid.Doctype.ExternalID
instance GHC.Classes.Eq Data.XML.Parser.Mid.Doctype.ExternalID


-- | Mid-level XML parsers, built on top of <a>Data.XML.Parser.Low</a>:
--   
--   <ul>
--   <li>some formatting details are abstracted away (e.g. quoting,
--   whitespacing), therefore parsers are not reversible</li>
--   <li>entities delimited by an opening and closing sequence are
--   recognized, except for tags which need a more complex, recursive
--   logic</li>
--   <li>token parsers do not overlap, therefore XML document can be
--   tokenized in a stateless way</li>
--   </ul>
--   
--   All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   </pre>
module Data.XML.Parser.Mid

-- | Processing instruction.
--   
--   <a>https://www.w3.org/TR/REC-xml/#dt-pi</a>
data Instruction
Instruction :: Text -> Text -> Instruction

-- | <a>https://www.w3.org/TR/REC-xml/#dt-xmldecl</a>
data XMLDeclaration
XMLDeclaration :: Text -> Maybe Text -> Maybe Bool -> XMLDeclaration

-- | <a>https://www.w3.org/TR/REC-xml/#dt-stag</a>
data StartTag
StartTag :: QName -> [Attribute] -> StartTag

-- | <a>https://www.w3.org/TR/REC-xml/#dt-eetag</a>
data EmptyElementTag
EmptyElementTag :: QName -> [Attribute] -> EmptyElementTag
data Token
TokenXMLDeclaration :: XMLDeclaration -> Token
TokenDoctype :: Doctype -> Token
TokenInstruction :: Instruction -> Token
TokenStartTag :: StartTag -> Token
TokenEndTag :: QName -> Token
TokenEmptyElementTag :: EmptyElementTag -> Token
TokenData :: [Content] -> Token
TokenComment :: Text -> Token
TokenCDATA :: Text -> Token

-- | A parser that consumes whole <a>Token</a>s.
data TokenParser m a
runTokenParser :: TokenParser m a -> m a

-- | <a>https://www.w3.org/TR/REC-xml/#dt-pi</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenInstruction) "&lt;?xml-stylesheet type='text/xsl' href='style.xsl'?&gt;"
--   Right (Instruction "xml-stylesheet" "type='text/xsl' href='style.xsl'")
--   </pre>
tokenInstruction :: CharParsing m => Monad m => TokenParser m Instruction

-- | <a>https://www.w3.org/TR/REC-xml/#NT-Comment</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenComment) "&lt;!-- declarations for &lt;head&gt; &amp; &lt;body&gt; --&gt;"
--   Right " declarations for &lt;head&gt; &amp; &lt;body&gt; "
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenComment) "&lt;!-- B+, B, or B---&gt;"
--   Right " B+, B, or B-"
--   </pre>
tokenComment :: CharParsing m => Monad m => TokenParser m Text

-- | <a>https://www.w3.org/TR/REC-xml/#dt-cdsection</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenCdata) "&lt;![CDATA[&lt;greeting&gt;Hello, world!&lt;/greeting&gt;]]&gt;"
--   Right "&lt;greeting&gt;Hello, world!&lt;/greeting&gt;"
--   </pre>
tokenCdata :: CharParsing m => Monad m => TokenParser m Text

-- | <a>https://www.w3.org/TR/REC-xml/#NT-doctypedecl</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenDoctype) "&lt;!DOCTYPE greeting SYSTEM 'hello.dtd'&gt;"
--   Right (Doctype "greeting" (Just (SystemID "hello.dtd")) [])
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenDoctype) "&lt;!DOCTYPE foo [ &lt;!ENTITY x '&amp;lt;'&gt; ]&gt;"
--   Right (Doctype "foo" Nothing [GeneralEntityDeclaration "x" [ContentReference (EntityRef "lt")]])
--   </pre>
tokenDoctype :: CharParsing m => Monad m => TokenParser m Doctype

-- | <a>https://www.w3.org/TR/REC-xml/#NT-XMLDecl</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenXmlDeclaration) "&lt;?xml version='1.0' encoding='UTF-8' standalone='yes'?&gt;"
--   Right (XMLDeclaration "1.0" (Just "UTF-8") (Just True))
--   </pre>
tokenXmlDeclaration :: CharParsing m => Monad m => TokenParser m XMLDeclaration

-- | <a>https://www.w3.org/TR/REC-xml/#NT-STag</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenStartTag) "&lt;termdef id='dt-dog' term='dog'&gt;"
--   Right (StartTag (QName {namePrefix = "", nameLocal = "termdef"}) [Attribute (QName {namePrefix = "", nameLocal = "id"}) [ContentText "dt-dog"],Attribute (QName {namePrefix = "", nameLocal = "term"}) [ContentText "dog"]])
--   
--   &gt;&gt;&gt; parse (runTokenParser tokenStartTag) "&lt;updated&gt;2003-12-13T18:30:02Z&lt;/updated&gt;"
--   Done "2003-12-13T18:30:02Z&lt;/updated&gt;" (StartTag (QName {namePrefix = "", nameLocal = "updated"}) [])
--   </pre>
tokenStartTag :: CharParsing m => Monad m => TokenParser m StartTag

-- | <a>https://www.w3.org/TR/REC-xml/#NT-ETag</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenEndTag) "&lt;/termdef&gt;"
--   Right (QName {namePrefix = "", nameLocal = "termdef"})
--   </pre>
tokenEndTag :: CharParsing m => Monad m => TokenParser m QName

-- | <a>https://www.w3.org/TR/REC-xml/#NT-EmptyElemTag</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenEmptyElementTag) "&lt;IMG align='left' src='http://www.w3.org/Icons/WWW/w3c_home' /&gt;"
--   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"]])
--   </pre>
tokenEmptyElementTag :: CharParsing m => Monad m => TokenParser m EmptyElementTag

-- | <a>https://www.w3.org/TR/REC-xml/#NT-CharData</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser tokenData) "Rock &amp;amp; roll"
--   Right [ContentText "Rock ",ContentReference (EntityRef "amp"),ContentText " roll"]
--   </pre>
tokenData :: CharParsing m => Monad m => TokenParser m [Content]

-- | Parse any <a>Token</a>.
anyToken :: CharParsing m => Monad m => TokenParser m Token
instance GHC.Show.Show Data.XML.Parser.Mid.Token
instance GHC.Classes.Ord Data.XML.Parser.Mid.Token
instance GHC.Classes.Eq Data.XML.Parser.Mid.Token
instance GHC.Show.Show Data.XML.Parser.Mid.EmptyElementTag
instance GHC.Read.Read Data.XML.Parser.Mid.EmptyElementTag
instance GHC.Classes.Ord Data.XML.Parser.Mid.EmptyElementTag
instance GHC.Classes.Eq Data.XML.Parser.Mid.EmptyElementTag
instance GHC.Show.Show Data.XML.Parser.Mid.StartTag
instance GHC.Read.Read Data.XML.Parser.Mid.StartTag
instance GHC.Classes.Ord Data.XML.Parser.Mid.StartTag
instance GHC.Classes.Eq Data.XML.Parser.Mid.StartTag
instance GHC.Show.Show Data.XML.Parser.Mid.XMLDeclaration
instance GHC.Read.Read Data.XML.Parser.Mid.XMLDeclaration
instance GHC.Classes.Ord Data.XML.Parser.Mid.XMLDeclaration
instance GHC.Classes.Eq Data.XML.Parser.Mid.XMLDeclaration
instance GHC.Show.Show Data.XML.Parser.Mid.Instruction
instance GHC.Read.Read Data.XML.Parser.Mid.Instruction
instance GHC.Classes.Ord Data.XML.Parser.Mid.Instruction
instance GHC.Classes.Eq Data.XML.Parser.Mid.Instruction
instance GHC.Base.Functor m => GHC.Base.Functor (Data.XML.Parser.Mid.TokenParser m)
instance GHC.Base.Applicative m => GHC.Base.Applicative (Data.XML.Parser.Mid.TokenParser m)
instance GHC.Base.Alternative m => GHC.Base.Alternative (Data.XML.Parser.Mid.TokenParser m)
instance GHC.Base.Monad m => GHC.Base.Monad (Data.XML.Parser.Mid.TokenParser m)
instance (Text.Parser.Combinators.Parsing m, GHC.Base.Monad m) => Control.Monad.Fail.MonadFail (Data.XML.Parser.Mid.TokenParser m)


-- | High-level XML parsers, built on top of <a>Data.XML.Parser.Mid</a>:
--   
--   <ul>
--   <li>entity references are expanded</li>
--   <li>CDATAs are abstracted away</li>
--   <li>comments are ignored</li>
--   <li>whitespace between tokens is ignored</li>
--   <li>duplicate attributes are ignored</li>
--   </ul>
--   
--   All documentation examples assume the following setup:
--   
--   <pre>
--   :set -XOverloadedStrings
--   import Data.Attoparsec.ByteString
--   </pre>
module Data.XML.Parser.High

-- | XML document prolog.
data Prolog
Prolog :: Maybe XMLDeclaration -> [Instruction] -> Maybe Doctype -> Prolog
[prologXmlDeclaration] :: Prolog -> Maybe XMLDeclaration
[prologInstructions] :: Prolog -> [Instruction]
[prologDoctype] :: Prolog -> Maybe Doctype
data Token
TokenProlog :: Prolog -> Token
TokenInstruction :: Instruction -> Token
TokenTag :: QName -> Map QName Text -> [Token] -> Token
TokenTextContent :: Text -> Token

-- | A parser that consumes whole <a>Token</a>s.
data TokenParser m a

-- | How to parse tag content.
data ContentParser m a

-- | Assert that content is empty.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr noContent) "&lt;tag key='value'&gt;body&lt;/tag&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr noContent) "&lt;tag key='value'&gt;&lt;/tag&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr noContent) "&lt;tag key='value'/&gt;"
--   Right ()
--   </pre>
noContent :: Applicative m => ContentParser m ()

-- | Assert that content is not empty, and parse it using given token
--   parser.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr (withContent textContent')) "&lt;tag key='value'&gt;body&lt;/tag&gt;"
--   Right "body"
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr (withContent textContent')) "&lt;tag key='value'&gt;&lt;/tag&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr (withContent textContent')) "&lt;tag key='value'/&gt;"
--   Left ...
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr (withContent $ pure ())) "&lt;tag key='value'/&gt;"
--   Left ...
--   </pre>
withContent :: TokenParser m a -> ContentParser m a

-- | Accept any content, including empty content.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr anyContent) "&lt;tag key='value'&gt;body&lt;/tag&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr anyContent) "&lt;tag key='value'&gt;&lt;/tag&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr anyContent) "&lt;tag key='value'/&gt;"
--   Right ()
--   </pre>
anyContent :: CharParsing m => Monad m => ContentParser m ()
runTokenParser :: TokenParser m a -> m a

-- | <a>https://www.w3.org/TR/REC-xml/#NT-prolog</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser prolog) "&lt;?xml version='1.0'?&gt;&lt;!DOCTYPE greeting&gt;"
--   Right (Prolog {prologXmlDeclaration = Just (XMLDeclaration "1.0" ...), prologInstructions = [], prologDoctype = Just (Doctype "greeting" ...)})
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser prolog) "&lt;?xml version='1.0'?&gt;  &lt;!-- comments and whitespace are ignored --&gt;&lt;!DOCTYPE greeting&gt;"
--   Right (Prolog {prologXmlDeclaration = Just (XMLDeclaration "1.0" ...), prologInstructions = [], prologDoctype = Just (Doctype "greeting" ...)})
--   </pre>
prolog :: CharParsing m => Monad m => TokenParser m Prolog

-- | Parse a processing instruction.
--   
--   <a>https://www.w3.org/TR/REC-xml/#dt-pi</a>
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser instruction) "&lt;?php echo 'Hello World!'; ?&gt;"
--   Right (Instruction "php" "echo 'Hello World!'; ")
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser instruction) "&lt;!-- comments and whitespace are ignored --&gt;  &lt;?php echo 'Hello World!'; ?&gt;"
--   Right (Instruction "php" "echo 'Hello World!'; ")
--   </pre>
instruction :: CharParsing m => Monad m => TokenParser m Instruction

-- | Parse textual content of a tag, including CDATA.
textContent :: CharParsing m => Monad m => EntityDecoder -> TokenParser m Text

-- | Same as <tt>textContent (decodePredefinedEntities &lt;&gt;
--   decodeHtmlEntities)</tt>, provided for convenience.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser $ tag' anyName anyAttr (withContent textContent')) "&lt;tag&gt;body&lt;!-- Ignored comment --&gt;&lt;![CDATA[&lt;innertag&gt;innerbody&lt;/innertag&gt;]]&gt;&lt;/tag&gt;"
--   Right "body&lt;innertag&gt;innerbody&lt;/innertag&gt;"
--   </pre>
textContent' :: CharParsing m => Monad m => TokenParser m Text

-- | Generic tag parser.
tag :: CharParsing m => Monad m => EntityDecoder -> NameParser a -> (a -> AttrParser b) -> (b -> ContentParser m c) -> TokenParser m c

-- | Simplified version of <a>tag</a>:
--   
--   <ul>
--   <li>no state forwarding between name, attributes and content
--   parsers</li>
--   <li>uses <tt>decodePredefinedEntities &lt;&gt; decodeHtmlEntities</tt>
--   to expand entity references</li>
--   </ul>
tag' :: CharParsing m => Monad m => NameParser a -> AttrParser b -> ContentParser m c -> TokenParser m c

-- | Parse a tag with any name, any attributes and any content.
--   
--   <pre>
--   &gt;&gt;&gt; parseOnly (runTokenParser anyTag) "&lt;tag key='value'&gt;body&lt;/tag&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser anyTag) "&lt;tag key='value'/&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser anyTag) "&lt;!-- ignored comment --&gt;&lt;tag key='value'/&gt;"
--   Right ()
--   
--   &gt;&gt;&gt; parseOnly (runTokenParser anyTag) "&lt;tag key='value'&gt;body&lt;!-- ignored comment --&gt;&lt;/tag&gt;"
--   Right ()
--   </pre>
anyTag :: CharParsing m => Monad m => TokenParser m ()

-- | Parse any <a>Token</a>.
anyToken :: CharParsing m => Monad m => EntityDecoder -> TokenParser m Token

-- | Same as <tt>anyToken (decodePredefinedEntities &lt;&gt;
--   decodeHtmlEntities)</tt>, provided for convenience.
anyToken' :: CharParsing m => Monad m => TokenParser m Token
instance GHC.Show.Show Data.XML.Parser.High.Token
instance GHC.Read.Read Data.XML.Parser.High.Token
instance GHC.Classes.Ord Data.XML.Parser.High.Token
instance GHC.Classes.Eq Data.XML.Parser.High.Token
instance GHC.Show.Show Data.XML.Parser.High.Prolog
instance GHC.Read.Read Data.XML.Parser.High.Prolog
instance GHC.Classes.Ord Data.XML.Parser.High.Prolog
instance GHC.Classes.Eq Data.XML.Parser.High.Prolog
instance GHC.Base.Functor m => GHC.Base.Functor (Data.XML.Parser.High.TokenParser m)
instance GHC.Base.Applicative m => GHC.Base.Applicative (Data.XML.Parser.High.TokenParser m)
instance GHC.Base.Alternative m => GHC.Base.Alternative (Data.XML.Parser.High.TokenParser m)
instance GHC.Base.Monad m => GHC.Base.Monad (Data.XML.Parser.High.TokenParser m)
instance GHC.Base.Functor m => GHC.Base.Functor (Data.XML.Parser.High.ContentParser m)
instance (Text.Parser.Combinators.Parsing m, GHC.Base.Monad m) => Control.Monad.Fail.MonadFail (Data.XML.Parser.High.TokenParser m)