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


-- | Unicode characters names and aliases
--   
--   <tt>unicode-data-names</tt> provides Haskell APIs to access the
--   Unicode character <i>names and aliases</i> from the <a>Unicode
--   character database</a> (UCD).
--   
--   The Haskell data structures are generated programmatically from the
--   UCD files. The latest Unicode version supported by this library is
--   <tt><a>15.1.0</a></tt>.
@package unicode-data-names
@version 0.4.0


module Unicode.Internal.Char.Label

-- | Returns the label of a code point if it has no character name,
--   otherwise returns <tt>"UNDEFINED"</tt>.
--   
--   See subsection <a>“Code Point Labels”</a> in section 4.8 “Name” of the
--   Unicode Standard.
label :: Char -> IO CStringLen

-- | Appned the code point of a character using the Unicode Standard
--   convention: hexadecimal codepoint padded with zeros if inferior to 4
--   characters.
--   
--   It is the responsability of the caller to provide a <a>CString</a>
--   that can hold up to 6 characters from the provided index.
addHexCodePoint :: CString -> Int# -> Int# -> Char -> IO Int

-- | Convert an <a>Int#</a> in the range 0..15 to the corresponding single
--   digit <a>CChar</a> in upper case.
--   
--   Undefined for numbers outside the 0..15 range.
intToDigiT :: Int# -> CChar


-- | Unicode character names and name aliases with <a>String</a> API. See
--   Unicode standard 15.0.0, section 4.8.
--   
--   There are also two optional APIs:
--   
--   <ul>
--   <li><tt>ByteString</tt> API, which requires using the package flag
--   <tt>has-bytestring</tt>.</li>
--   <li><tt>Text</tt> API, which requires using the package flag
--   <tt>has-text</tt>.</li>
--   </ul>
module Unicode.Char.General.Names

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

-- | Name of a character, if defined.
name :: Char -> Maybe String

-- | Returns a character’s <a>name</a> if defined, otherwise returns its
--   first name alias if defined.
nameOrAlias :: Char -> Maybe String

-- | Returns a character’s <a>name</a> if defined, otherwise returns its
--   label between angle brackets.
nameOrLabel :: Char -> String

-- | Returns <i>corrected</i> name of a character (see <a>Correction</a>),
--   if defined, otherwise returns its original <a>name</a> if defined.
correctedName :: Char -> Maybe String

-- | Type of name alias. See Unicode Standard 15.0.0, section 4.8.
data NameAliasType

-- | Corrections for serious problems in the character names.
Correction :: NameAliasType

-- | ISO 6429 names for <tt>C0</tt> and <tt>C1</tt> control functions, and
--   other commonly occurring names for control codes.
Control :: NameAliasType

-- | A few widely used alternate names for format characters.
Alternate :: NameAliasType

-- | Several documented labels for <tt>C1</tt> control code points which
--   were never actually approved in any standard.
Figment :: NameAliasType

-- | Commonly occurring abbreviations (or acronyms) for control codes,
--   format characters, spaces, and variation selectors.
Abbreviation :: NameAliasType

-- | All name aliases of a character, if defined. The names are listed in
--   the original order of the UCD.
--   
--   See <a>nameAliasesWithTypes</a> for the detailed list by alias type.
nameAliases :: Char -> [String]

-- | Name aliases of a character for a specific name alias type.
nameAliasesByType :: NameAliasType -> Char -> [String]

-- | Detailed character names aliases. The names are listed in the original
--   order of the UCD.
--   
--   See <a>nameAliases</a> if the alias type is not required.
nameAliasesWithTypes :: Char -> [(NameAliasType, [String])]

-- | Returns the label of a code point if it has no character name,
--   otherwise returns <tt>"UNDEFINED"</tt>.
--   
--   See subsection <a>“Code Point Labels”</a> in section 4.8 “Name” of the
--   Unicode Standard.
--   
--   <pre>
--   &gt;&gt;&gt; label '\0'
--   "control-0000"
--   
--   &gt;&gt;&gt; label 'a'
--   "UNDEFINED"
--   
--   &gt;&gt;&gt; label '\xffff'
--   "noncharacter-FFFF"
--   </pre>
label :: Char -> String