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


-- | Streaming HTML parser
--   
@package list-t-html-parser
@version 0.2.2.0

module ListT.HTMLParser

-- | A backtracking HTML-tokens stream parser.
data Parser m a

-- | A possibly detailed parser error. When <a>mzero</a> or <a>empty</a> is
--   used, an error value of <a>Nothing</a> is produced.
type Error = Maybe ErrorDetails
data ErrorDetails

-- | A text message
ErrorDetails_Message :: Text -> ErrorDetails

-- | Unexpected token
ErrorDetails_UnexpectedToken :: ErrorDetails

-- | End of input
ErrorDetails_EOI :: ErrorDetails

-- | Run a parser on a stream of HTML tokens, consuming only as many as
--   needed.
run :: Monad m => Parser m a -> ListT m Token -> m (Either Error a)

-- | End of input.
eoi :: Monad m => Parser m ()

-- | Any HTML token.
token :: Monad m => Parser m Token

-- | An opening tag.
openingTag :: Monad m => Parser m OpeningTag

-- | A closing tag.
closingTag :: Monad m => Parser m ClosingTag

-- | A text between tags with HTML-entities decoded.
text :: Monad m => Parser m Text

-- | Contents of a comment.
comment :: Monad m => Parser m Text

-- | The textual HTML representation of a proper HTML tree node.
--   
--   Useful for consuming HTML-formatted snippets.
html :: Monad m => Parser m Builder

-- | Apply a parser at least one time.
many1 :: Monad m => Parser m a -> Parser m [a]

-- | Apply a parser multiple times until another parser is satisfied.
--   Returns results of both parsers.
manyTill :: Monad m => Parser m a -> Parser m b -> Parser m ([a], b)

-- | Skip any tokens until the provided parser is satisfied.
skipTill :: Monad m => Parser m a -> Parser m a

-- | Greedily consume all the input until the end, while running the
--   provided parser. Same as:
--   
--   <pre>
--   theParser &lt;* eoi
--   </pre>
total :: Monad m => Parser m a -> Parser m a
instance Show ErrorDetails
instance Eq ErrorDetails
instance Monad m => Functor (Parser m)
instance Monad m => Applicative (Parser m)
instance Monad m => MonadError Error (Parser m)
instance Monad m => MonadPlus (Parser m)
instance Monad m => Alternative (Parser m)
instance Monad m => Monad (Parser m)