Unicode.Char.General.Names

Unicode character names and name aliases with String API. See Unicode standard 15.0.0, section 4.8.

There are also two optional APIs:

• ByteString API, which requires using the package flag has-bytestring.
• Text API, which requires using the package flag has-text.

Since: 0.1.0

Unicode version

unicodeVersion :: Version

Version of the Unicode standard used by this package: 15.1.0.

Since: 0.3.0

Name

name :: Char -> Maybe String

Name of a character, if defined.

Since: 0.1.0

nameOrAlias :: Char -> Maybe String

Returns a character’s name if defined, otherwise returns its first name alias if defined.

Since: 0.1.0

nameOrLabel :: Char -> String

Returns a character’s name if defined, otherwise returns its label between angle brackets.

Since: 0.4.0

correctedName :: Char -> Maybe String

Returns corrected name of a character (see Correction), if defined, otherwise returns its original name if defined.

Since: 0.1.0

Name Aliases

data NameAliasType

Type of name alias. See Unicode Standard 15.0.0, section 4.8.

Since: 0.1.0

Constructors

Correction

Corrections for serious problems in the character names.

Control

ISO 6429 names for C0 and C1 control functions, and other commonly occurring names for control codes.

Alternate

A few widely used alternate names for format characters.

Figment

Several documented labels for C1 control code points which were never actually approved in any standard.

Abbreviation

Commonly occurring abbreviations (or acronyms) for control codes, format characters, spaces, and variation selectors.

Instances

Bounded NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Methods

minBound :: NameAliasType

maxBound :: NameAliasType

Enum NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Methods

succ :: NameAliasType -> NameAliasType

pred :: NameAliasType -> NameAliasType

toEnum :: Int -> NameAliasType

fromEnum :: NameAliasType -> Int

enumFrom :: NameAliasType -> [NameAliasType]

enumFromThen :: NameAliasType -> NameAliasType -> [NameAliasType]

enumFromTo :: NameAliasType -> NameAliasType -> [NameAliasType]

enumFromThenTo :: NameAliasType -> NameAliasType -> NameAliasType -> [NameAliasType]

Generic NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Associated Types

type Rep NameAliasType :: Type -> Type

Methods

from :: NameAliasType -> Rep NameAliasType x

to :: Rep NameAliasType x -> NameAliasType

Ix NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Methods

range :: (NameAliasType, NameAliasType) -> [NameAliasType]

index :: (NameAliasType, NameAliasType) -> NameAliasType -> Int

unsafeIndex :: (NameAliasType, NameAliasType) -> NameAliasType -> Int

inRange :: (NameAliasType, NameAliasType) -> NameAliasType -> Bool

rangeSize :: (NameAliasType, NameAliasType) -> Int

unsafeRangeSize :: (NameAliasType, NameAliasType) -> Int

Show NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Methods

showsPrec :: Int -> NameAliasType -> ShowS

show :: NameAliasType -> String

showList :: [NameAliasType] -> ShowS

Eq NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Methods

(==) :: NameAliasType -> NameAliasType -> Bool

(/=) :: NameAliasType -> NameAliasType -> Bool

Ord NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

Methods

compare :: NameAliasType -> NameAliasType -> Ordering

(<) :: NameAliasType -> NameAliasType -> Bool

(<=) :: NameAliasType -> NameAliasType -> Bool

(>) :: NameAliasType -> NameAliasType -> Bool

(>=) :: NameAliasType -> NameAliasType -> Bool

max :: NameAliasType -> NameAliasType -> NameAliasType

min :: NameAliasType -> NameAliasType -> NameAliasType

type Rep NameAliasType

Defined in Unicode.Internal.Char.UnicodeData.NameAliases

type Rep NameAliasType = D1 ('MetaData "NameAliasType" "Unicode.Internal.Char.UnicodeData.NameAliases" "unicode-data-names-0.4.0-ETIVw38SDJC3ZuU0wIINH4" 'False) ((C1 ('MetaCons "Correction" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Control" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Alternate" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Figment" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Abbreviation" 'PrefixI 'False) (U1 :: Type -> Type))))

nameAliases :: Char -> [String]

All name aliases of a character, if defined. The names are listed in the original order of the UCD.

See nameAliasesWithTypes for the detailed list by alias type.

Since: 0.1.0

nameAliasesByType :: NameAliasType -> Char -> [String]

Name aliases of a character for a specific name alias type.

Since: 0.1.0

nameAliasesWithTypes :: Char -> [(NameAliasType, [String])]

Detailed character names aliases. The names are listed in the original order of the UCD.

See nameAliases if the alias type is not required.

Since: 0.1.0

Label

label :: Char -> String

Returns the label of a code point if it has no character name, otherwise returns "UNDEFINED".

See subsection “Code Point Labels” in section 4.8 “Name” of the Unicode Standard.

>>> label '\0'
"control-0000"
>>> label 'a'
"UNDEFINED"
>>> label '\xffff'
"noncharacter-FFFF"

Since: 0.4.0