-- 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.0.0</a></tt>.
@package unicode-data-names
@version 0.2.0


-- | Unicode character names and name aliases. See Unicode standard 15.0.0,
--   section 4.8.
module Unicode.Char.General.Names

-- | 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 <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])]