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


-- | HTML entity decoding and encoding for Text
--   
--   Fast, attoparsec-powered HTML entity decoding and encoding for Text
@package html-entity
@version 0.1.0.0


-- | Efficient decoding and encoding of HTML entities in text.
module Text.HTMLEntity

-- | Decode HTML entities contained in the given text. Returns <tt>Left
--   decodeError</tt> on failure. The parser will do its best to explain
--   the problem.
--   
--   <pre>
--   &gt;&gt;&gt; mapM_ T.putStrLn $ decode "H&amp;eacute;llo w&amp;oast;rld!"
--   Héllo w⊛rld!
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; decode "&amp;NonExistentEntity;"
--   Left "entity: Failed reading: Unknown entity name NonExistentEntity"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; decode "&amp;#100000000;"
--   Left "entity: Failed reading: 100000000 is out of Char range"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; decode "&amp;#xffffffff;"
--   Left "entity: Failed reading: 4294967295 is out of Char range"
--   </pre>
decode :: Text -> Either String Text

-- | Like <a>decode</a>, except that if a decode error occurs, the original
--   output is returned unmodified. Use if you're certain that your input
--   is well-formed.
--   
--   <pre>
--   &gt;&gt;&gt; T.putStrLn $ decode' "W&amp;esdot;ll-formed inpu&amp;DoubleRightTee;"
--   W≐ll-formed inpu⊨
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; T.putStrLn $ decode' "Utter n&amp;#2322548;ns&amp;CurlyE;nse"
--   Utter n&amp;#2322548;ns&amp;CurlyE;nse
--   </pre>
decode' :: Text -> Text

-- | Encodes the input for use as text in an HTML document.
--   
--   <a>encode</a> will use named entities where possible, except for most
--   symbols in the ASCII block, where it was deemed this would result in
--   unnecessarily bloated output.
--   
--   <pre>
--   &gt;&gt;&gt; T.putStrLn $ encode "Héllo wörld!"
--   H&amp;eacute;llo w&amp;ouml;rld!
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; T.putStrLn $ encode "x ≂̸ y"
--   x &amp;nesim; y
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; T.putStrLn $ encode "\2534\6188"
--   &amp;#2534;&amp;#6188;
--   </pre>
encode :: Text -> Text