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


-- | A library for looking up and validating HTML5 entities.
--   
@package html5-entity
@version 0.2.0.3

module Text.Html.Entity.Data
entityMap :: Map Text [Int]
entitySet :: Set Text

module Text.Html.Entity

-- | Given an entity looks up unicode code points that represent it.
--   
--   <pre>
--   &gt;&gt;&gt; entityCodePoints "&amp;mu;"
--   Just [966]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; entityCodePoints "&amp;nano;"
--   Nothing
--   </pre>
entityCodePoints :: Text -> Maybe [Int]

-- | Given an entity returns it's textual representation (if any).
--   
--   <pre>
--   &gt;&gt;&gt; entityChars "&amp;mu;"
--   Just "μ"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; entityChars "&amp;nano;"
--   Nothing
--   </pre>
entityChars :: Text -> Maybe Text

-- | Check if entity is valid (if such entity exists).
--   
--   <pre>
--   &gt;&gt;&gt; isValidEntity "&amp;mu;"
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; isValidEntity "&amp;nano;"
--   False
--   </pre>
isValidEntity :: Text -> Bool

-- | Given a name of entity looks up code points that represent it.
--   
--   <pre>
--   &gt;&gt;&gt; entityNameCodePoints "mu"
--   Just [966]
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; entityNameCodePoints "nano"
--   Nothing
--   </pre>
entityNameCodePoints :: Text -> Maybe [Int]

-- | Given a name of entity returns it's textual representation (if any).
--   
--   <pre>
--   &gt;&gt;&gt; entityNameChars "mu"
--   Just "μ"
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; entityNameChars "nano"
--   Nothing
--   </pre>
entityNameChars :: Text -> Maybe Text

-- | Check if entity name is valid (if corresponding entity exists).
--   
--   <pre>
--   &gt;&gt;&gt; isValidEntityName "mu"
--   True
--   </pre>
--   
--   <pre>
--   &gt;&gt;&gt; isValidEntityName "nano"
--   False
--   </pre>
isValidEntityName :: Text -> Bool