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


-- | Utility functions for working with html-parse
--   
--   See README.md <a>here</a>
@package html-parse-util
@version 0.2.3


-- | Utility functions to make working with <tt>html-parse</tt> as easy as
--   working with TagSoup! Most functions are one-to-one replacements for
--   their respective TagSoup analogues and work the same way.
module Text.HTML.Parser.Util

-- | Like <a>toTokenDefault</a>, but with a supplied default value.
--   
--   <pre>
--   &gt;&gt;&gt; toToken "text"
--   ContentText "text"
--   </pre>
toToken :: Text -> Token

-- | Convert <a>Text</a> to <a>Token</a>, with a default in case of a parse
--   failure.
toTokenDefault :: Token -> Text -> Token

-- | Test if a <a>Token</a> is a <a>TagOpen</a>.
isTagOpen :: Token -> Bool

-- | Test if a <a>Token</a> is a <a>TagClose</a>.
isTagClose :: Token -> Bool

-- | Test if a <a>Token</a> is a <a>TagSelfClose</a>.
isTagSelfClose :: Token -> Bool

-- | Test if a <a>Token</a> is a <a>ContentText</a>.
isContentText :: Token -> Bool

-- | Test if a <a>Token</a> is a <a>ContentChar</a>.
isContentChar :: Token -> Bool

-- | Test if a <a>Token</a> is a <a>Comment</a>.
isComment :: Token -> Bool

-- | Test if a <a>Token</a> is a <a>Doctype</a>.
isDoctype :: Token -> Bool

-- | Returns True if the <a>Token</a> is <a>TagOpen</a> and matches the
--   given name.
isTagOpenName :: Text -> Token -> Bool

-- | Returns True if the <a>Token</a> is <a>TagClose</a> and matches the
--   given name.
isTagCloseName :: Text -> Token -> Bool

-- | Extract the string from within <a>ContentText</a>, crashes if not a
--   <a>ContentText</a>.
fromContentText :: Token -> Text

-- | Extract the string from within <a>ContentText</a>, otherwise return
--   <a>Nothing</a>.
maybeContentText :: Token -> Maybe Text

-- | Extract an attribute; crashes if not a <a>TagOpen</a>. Returns
--   <tt>Attr "" ""</tt> if no attribute present.
--   
--   Warning: does not distinguish between missing attribute and present
--   attribute with values <tt>""</tt>.
fromAttrib :: Attr -> Token -> Attr

-- | Extract an attribute; crashes if not a <a>TagOpen</a>. Returns
--   <a>Nothing</a> if no attribute present.
maybeAttrib :: Attr -> Token -> Maybe Attr

-- | Extract all text content from a list of Tokens (similar to Verbatim
--   found in HaXml).
innerText :: [Token] -> Text

-- | Get the first <a>ContentText</a> element from a list of <a>Token</a>s.
--   If no tag could be found, return an empty string.
toHeadContentText :: [Token] -> Text

-- | Get all <a>Token</a>s between <tt>start</tt> and <tt>end</tt>.
between :: Token -> Token -> [Token] -> [Token]

-- | Drop an HTML header (i.e. the header tags and everything in between),
--   as well as everything before it, from a list of <a>Token</a>s.
dropHeader :: [Attr] -> [Token] -> [Token]

-- | Get all <a>ContentText</a> entries from a list of <a>Token</a>s and
--   extract their content.
allContentText :: [Token] -> [Text]

-- | This function takes a list, and returns all suffixes whose first item
--   matches the predicate.
--   
--   <pre>
--   &gt;&gt;&gt; sections (== 'c') "abc cba ccb"
--   ["c cba ccb","cba ccb","ccb","cb"]
--   </pre>
sections :: (a -> Bool) -> [a] -> [[a]]

-- | Like <a>sections</a>, but return the head element. Returns an empty
--   list if no head element is present.
--   
--   <pre>
--   &gt;&gt;&gt; section (== 'c') "abc cba ccb"
--   "c cba ccb"
--   </pre>
section :: (a -> Bool) -> [a] -> [a]

-- | This function is similar to <a>sections</a>, but splits the list so no
--   element appears in any two partitions.
--   
--   <pre>
--   &gt;&gt;&gt; partitions (== 'c') "abc cba ccb"
--   ["c ","cba ","c","cb"]
--   </pre>
partitions :: (a -> Bool) -> [a] -> [[a]]

-- | Performs an inexact match, the first item should be the thing to
--   match.
--   
--   <pre>
--   &gt;&gt;&gt; ContentText "test" ~== ContentText ""
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; TagOpen "div" [Attr "class" "division ", Attr "id" "dd"] ~== TagOpen "div" [Attr "class" "division "]
--   True
--   </pre>
(~==) :: Token -> Token -> Bool
infixl 9 ~==

-- | Negation of <a>(~==)</a>.
(~/=) :: Token -> Token -> Bool
infixl 9 ~/=