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


-- | Unicode security mechanisms database
--   
--   <tt>unicode-data-security</tt> provides Haskell APIs to access the
--   <a>Unicode security mechanisms</a> <a>database</a>.
--   
--   The Haskell data structures are generated programmatically from the
--   database. The latest Unicode version supported by this library is
--   <tt><a>15.0.0</a></tt>.
@package unicode-data-security
@version 0.3.0


-- | Unicode Security Mechanisms functions based on <a>Unicode Technical
--   Standard #39</a>.
module Unicode.Char.Identifiers.Security

-- | Version of the Unicode standard used by this package: <a>15.0.0</a>.
unicodeVersion :: Version

-- | Returns <a>True</a> if the given character is allowed in an
--   identifier.
--   
--   <ul>
--   <li><i>Restricted</i> characters should be treated with caution when
--   considering possible use in identifiers, and should be disallowed
--   unless there is good reason to allow them in the environment in
--   question.</li>
--   <li><i>Allowed</i> characters are not typically used as is by
--   implementations. Instead, they are applied as filters to the set of
--   supported characters.</li>
--   </ul>
isAllowedInIdentifier :: Char -> Bool

-- | Identifier type
data IdentifierType

-- | Unassigned characters, private use characters, surrogates,
--   non-whitespace control characters.
NotCharacter :: IdentifierType

-- | Characters with the Unicode property <tt>Deprecated=Yes</tt>.
Deprecated :: IdentifierType

-- | Characters with the Unicode property
--   <tt>Default_Ignorable_Code_Point=Yes</tt>.
DefaultIgnorable :: IdentifierType

-- | Characters that cannot occur in strings normalized to NFKC.
NotNFKC :: IdentifierType

-- | Characters that do not qualify as default Unicode identifiers; that
--   is, they do not have the Unicode property XID_Continue=True.
NotXID :: IdentifierType

-- | Characters with <tt>Script_Extensions</tt> values containing a script
--   in <i>Excluded Scripts</i>, and no script from <i>Limited Use
--   Scripts</i> or <i>Recommended Scripts</i>, other than “Common” or
--   “Inherited”.
Exclusion :: IdentifierType

-- | Characters that are no longer in modern use, or that are not commonly
--   used in modern text.
Obsolete :: IdentifierType

-- | Specialized usage: technical, liturgical, etc.
Technical :: IdentifierType

-- | Characters that are uncommon, or are limited in use, or whose usage is
--   uncertain.
UncommonUse :: IdentifierType

-- | Characters from scripts that are in limited use.
LimitedUse :: IdentifierType

-- | Exceptionally allowed characters.
Inclusion :: IdentifierType

-- | Characters from scripts that are in widespread everyday common use.
Recommended :: IdentifierType

-- | Returns the <tt>IdentifierType</tt>s corresponding to a character.
identifierTypes :: Char -> NonEmpty IdentifierType

-- | Return <a>True</a> if the given <a>IdentifierType</a> is allowed.
isIdentifierTypeAllowed :: IdentifierType -> Bool

-- | Returns the <i>prototype</i> of a character if it is
--   <i>unintentionally</i> confusable, else <a>Nothing</a>.
confusablePrototype :: Char -> String

-- | Returns the list of <i>intentional</i> confusables of a character, if
--   any.
intentionalConfusables :: Char -> String

-- | Returns <a>True</a> if the character is <i>intentionally</i>
--   confusable.
isIntentionallyConfusable :: Char -> Bool