Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

uchar.h File Reference

C API: Unicode Char. More...

#include "unicode/utypes.h"

Go to the source code of this file.

Defines

#define U_UNICODE_VERSION   "3.0.0"
#define UCHAR_MIN_VALUE   0
 The lowest Unicode code point value. More...

#define UCHAR_MAX_VALUE   0x10ffff
 The highest Unicode code point value (scalar value) according to The Unicode Standard. More...


Typedefs

typedef enum UCharCategory UCharCategory
typedef enum UCharDirection UCharDirection
typedef enum UCharScript UCharScript
typedef enum UCellWidth UCellWidth
typedef enum UCharNameChoice UCharNameChoice

Enumerations

enum  UCharCategory {
  U_UNASSIGNED = 0, U_UPPERCASE_LETTER = 1, U_LOWERCASE_LETTER = 2, U_TITLECASE_LETTER = 3,
  U_MODIFIER_LETTER = 4, U_OTHER_LETTER = 5, U_NON_SPACING_MARK = 6, U_ENCLOSING_MARK = 7,
  U_COMBINING_SPACING_MARK = 8, U_DECIMAL_DIGIT_NUMBER = 9, U_LETTER_NUMBER = 10, U_OTHER_NUMBER = 11,
  U_SPACE_SEPARATOR = 12, U_LINE_SEPARATOR = 13, U_PARAGRAPH_SEPARATOR = 14, U_CONTROL_CHAR = 15,
  U_FORMAT_CHAR = 16, U_PRIVATE_USE_CHAR = 17, U_SURROGATE = 18, U_DASH_PUNCTUATION = 19,
  U_START_PUNCTUATION = 20, U_END_PUNCTUATION = 21, U_CONNECTOR_PUNCTUATION = 22, U_OTHER_PUNCTUATION = 23,
  U_MATH_SYMBOL = 24, U_CURRENCY_SYMBOL = 25, U_MODIFIER_SYMBOL = 26, U_OTHER_SYMBOL = 27,
  U_INITIAL_PUNCTUATION = 28, U_FINAL_PUNCTUATION = 29, U_GENERAL_OTHER_TYPES = 30, U_CHAR_CATEGORY_COUNT
}
 Data for enumerated Unicode general category types. More...

enum  UCharDirection {
  U_LEFT_TO_RIGHT = 0, U_RIGHT_TO_LEFT = 1, U_EUROPEAN_NUMBER = 2, U_EUROPEAN_NUMBER_SEPARATOR = 3,
  U_EUROPEAN_NUMBER_TERMINATOR = 4, U_ARABIC_NUMBER = 5, U_COMMON_NUMBER_SEPARATOR = 6, U_BLOCK_SEPARATOR = 7,
  U_SEGMENT_SEPARATOR = 8, U_WHITE_SPACE_NEUTRAL = 9, U_OTHER_NEUTRAL = 10, U_LEFT_TO_RIGHT_EMBEDDING = 11,
  U_LEFT_TO_RIGHT_OVERRIDE = 12, U_RIGHT_TO_LEFT_ARABIC = 13, U_RIGHT_TO_LEFT_EMBEDDING = 14, U_RIGHT_TO_LEFT_OVERRIDE = 15,
  U_POP_DIRECTIONAL_FORMAT = 16, U_DIR_NON_SPACING_MARK = 17, U_BOUNDARY_NEUTRAL = 18, U_CHAR_DIRECTION_COUNT
}
 This specifies the language directional property of a character set. More...

enum  UCharScript {
  U_BASIC_LATIN, U_LATIN_1_SUPPLEMENT, U_LATIN_EXTENDED_A, U_LATIN_EXTENDED_B,
  U_IPA_EXTENSIONS, U_SPACING_MODIFIER_LETTERS, U_COMBINING_DIACRITICAL_MARKS, U_GREEK,
  U_CYRILLIC, U_ARMENIAN, U_HEBREW, U_ARABIC,
  U_SYRIAC, U_THAANA, U_DEVANAGARI, U_BENGALI,
  U_GURMUKHI, U_GUJARATI, U_ORIYA, U_TAMIL,
  U_TELUGU, U_KANNADA, U_MALAYALAM, U_SINHALA,
  U_THAI, U_LAO, U_TIBETAN, U_MYANMAR,
  U_GEORGIAN, U_HANGUL_JAMO, U_ETHIOPIC, U_CHEROKEE,
  U_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS, U_OGHAM, U_RUNIC, U_KHMER,
  U_MONGOLIAN, U_LATIN_EXTENDED_ADDITIONAL, U_GREEK_EXTENDED, U_GENERAL_PUNCTUATION,
  U_SUPERSCRIPTS_AND_SUBSCRIPTS, U_CURRENCY_SYMBOLS, U_COMBINING_MARKS_FOR_SYMBOLS, U_LETTERLIKE_SYMBOLS,
  U_NUMBER_FORMS, U_ARROWS, U_MATHEMATICAL_OPERATORS, U_MISCELLANEOUS_TECHNICAL,
  U_CONTROL_PICTURES, U_OPTICAL_CHARACTER_RECOGNITION, U_ENCLOSED_ALPHANUMERICS, U_BOX_DRAWING,
  U_BLOCK_ELEMENTS, U_GEOMETRIC_SHAPES, U_MISCELLANEOUS_SYMBOLS, U_DINGBATS,
  U_BRAILLE_PATTERNS, U_CJK_RADICALS_SUPPLEMENT, U_KANGXI_RADICALS, U_IDEOGRAPHIC_DESCRIPTION_CHARACTERS,
  U_CJK_SYMBOLS_AND_PUNCTUATION, U_HIRAGANA, U_KATAKANA, U_BOPOMOFO,
  U_HANGUL_COMPATIBILITY_JAMO, U_KANBUN, U_BOPOMOFO_EXTENDED, U_ENCLOSED_CJK_LETTERS_AND_MONTHS,
  U_CJK_COMPATIBILITY, U_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A, U_CJK_UNIFIED_IDEOGRAPHS, U_YI_SYLLABLES,
  U_YI_RADICALS, U_HANGUL_SYLLABLES, U_HIGH_SURROGATES, U_HIGH_PRIVATE_USE_SURROGATES,
  U_LOW_SURROGATES, U_PRIVATE_USE_AREA, U_CJK_COMPATIBILITY_IDEOGRAPHS, U_ALPHABETIC_PRESENTATION_FORMS,
  U_ARABIC_PRESENTATION_FORMS_A, U_COMBINING_HALF_MARKS, U_CJK_COMPATIBILITY_FORMS, U_SMALL_FORM_VARIANTS,
  U_ARABIC_PRESENTATION_FORMS_B, U_SPECIALS, U_HALFWIDTH_AND_FULLWIDTH_FORMS, U_CHAR_SCRIPT_COUNT,
  U_NO_SCRIPT = U_CHAR_SCRIPT_COUNT
}
 Generated from Unicode Data files These are the same values as Unicode::EUnicodeScript. More...

enum  UCellWidth {
  U_ZERO_WIDTH = 0, U_HALF_WIDTH = 1, U_FULL_WIDTH = 2, U_NEUTRAL_WIDTH = 3,
  U_CELL_WIDTH_COUNT
}
 Values returned by the u_getCellWidth() function. More...

enum  UCharNameChoice { U_UNICODE_CHAR_NAME, U_UNICODE_10_CHAR_NAME, U_CHAR_NAME_CHOICE_COUNT }
 Selector constants for u_charName(). More...


Functions

U_CAPI UBool U_EXPORT2 u_islower (UChar32 c)
 Determines whether the specified UChar is a lowercase character according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isupper (UChar32 c)
 Determines whether the specified character is an uppercase character according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_istitle (UChar32 c)
 Determines whether the specified character is a titlecase character according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isdigit (UChar32 c)
 Determines whether the specified character is a digit according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isalnum (UChar32 c)
 Determines whether the specified character is an alphanumeric character (letter or digit)according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isdefined (UChar32 c)
 Determines whether the specified numeric value is actually a defined character according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isalpha (UChar32 c)
 Determines whether the specified character is a letter according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isspace (UChar32 c)
 Determines if the specified character is a space character or not. More...

U_CAPI UBool U_EXPORT2 u_isWhitespace (UChar32 c)
 Determines if the specified character is white space according to ICU. More...

U_CAPI UBool U_EXPORT2 u_iscntrl (UChar32 c)
 Determines whether the specified character is a control character or not. More...

U_CAPI UBool U_EXPORT2 u_isprint (UChar32 c)
 Determines whether the specified character is a printable character according to Unicode 2.1.2. More...

U_CAPI UBool U_EXPORT2 u_isbase (UChar32 c)
 Determines whether the specified character is of the base form according to Unicode 2.1.2. More...

U_CAPI UCharDirection U_EXPORT2 u_charDirection (UChar32 c)
 Returns the linguistic direction property of a character. More...

U_CAPI UBool U_EXPORT2 u_isMirrored (UChar32 c)
 Determines whether the character has the "mirrored" property. More...

U_CAPI UChar32 U_EXPORT2 u_charMirror (UChar32 c)
 Maps the specified character to a "mirror-image" character. More...

U_CAPI uint16_t U_EXPORT2 u_charCellWidth (UChar32 c)
 Returns a value indicating the display-cell width of the character when used in Asian text, according to the Unicode standard (see p. More...

U_CAPI int8_t U_EXPORT2 u_charType (UChar32 c)
 Returns a value indicating a character category according to Unicode 2.1.2. More...

U_CAPI int32_t U_EXPORT2 u_charDigitValue (UChar32 c)
 Retrives the decimal numeric value of a digit character. More...

U_CAPI UCharScript U_EXPORT2 u_charScript (UChar32 ch)
 Returns the script associated with a character. More...

U_CAPI UTextOffset U_EXPORT2 u_charName (UChar32 code, UCharNameChoice nameChoice, char *buffer, UTextOffset bufferLength, UErrorCode *pErrorCode)
 Retrieve the name of a Unicode character. More...

U_CAPI UChar32 U_EXPORT2 u_charFromName (UCharNameChoice nameChoice, const char *name, UErrorCode *pErrorCode)
 Find a Unicode character by its name and return its code point value. More...

U_CDECL_BEGIN typedef UBool UEnumCharNamesFn (void *context, UChar32 code, UCharNameChoice nameChoice, const char *name, UTextOffset length)
 Type of a callback function for u_enumCharNames() that gets called for each Unicode character with the code point value and the character name. More...

U_CDECL_END U_CAPI void U_EXPORT2 u_enumCharNames (UChar32 start, UChar32 limit, UEnumCharNamesFn *fn, void *context, UCharNameChoice nameChoice, UErrorCode *pErrorCode)
 Enumerate all assigned Unicode characters between the start and limit code points (start inclusive, limit exclusive) and call a function for each, passing the code point value and the character name. More...

U_CAPI UBool U_EXPORT2 u_isIDStart (UChar32 c)
 A convenience method for determining if a Unicode character is allowed to start in a Unicode identifier. More...

U_CAPI UBool U_EXPORT2 u_isIDPart (UChar32 c)
 A convenience method for determining if a Unicode character may be part of a Unicode identifier other than the starting character. More...

U_CAPI UBool U_EXPORT2 u_isIDIgnorable (UChar32 c)
 A convenience method for determining if a Unicode character should be regarded as an ignorable character in a Unicode identifier. More...

U_CAPI UBool U_EXPORT2 u_isJavaIDStart (UChar32 c)
 A convenience method for determining if a Unicode character is allowed as the first character in a Java identifier. More...

U_CAPI UBool U_EXPORT2 u_isJavaIDPart (UChar32 c)
 A convenience method for determining if a Unicode character may be part of a Java identifier other than the starting character. More...

U_CAPI UChar32 U_EXPORT2 u_tolower (UChar32 c)
 The given character is mapped to its lowercase equivalent according to Unicode 2.1.2; if the character has no lowercase equivalent, the character itself is returned. More...

U_CAPI UChar32 U_EXPORT2 u_toupper (UChar32 c)
 The given character is mapped to its uppercase equivalent according to Unicode 2.1.2; if the character has no uppercase equivalent, the character itself is returned. More...

U_CAPI UChar32 U_EXPORT2 u_totitle (UChar32 c)
 The given character is mapped to its titlecase equivalent according to Unicode 2.1.2. More...

U_CAPI void U_EXPORT2 u_getUnicodeVersion (UVersionInfo info)
 Gets the Unicode version information. More...


Detailed Description

C API: Unicode Char.

Unicode C API

The Unicode C API allows you to query the properties associated with individual Unicode character values.

The Unicode character information, provided implicitly by the Unicode character encoding standard, includes information about the script (for example, symbols or control characters) to which the character belongs, as well as semantic information such as whether a character is a digit or uppercase, lowercase, or uncased.

Definition in file uchar.h.


Define Documentation

#define UCHAR_MAX_VALUE   0x10ffff
 

The highest Unicode code point value (scalar value) according to The Unicode Standard.

This is a 21-bit value (20.1 bits, rounded up). For a single character, UChar32 is a simple type that can hold any code point value.

Definition at line 60 of file uchar.h.

#define UCHAR_MIN_VALUE   0
 

The lowest Unicode code point value.

Code points are non-negative.

Definition at line 53 of file uchar.h.

#define U_UNICODE_VERSION   "3.0.0"
 

Definition at line 30 of file uchar.h.


Typedef Documentation

typedef enum UCellWidth UCellWidth
 

Definition at line 393 of file uchar.h.

typedef enum UCharCategory UCharCategory
 

Definition at line 134 of file uchar.h.

typedef enum UCharDirection UCharDirection
 

Definition at line 181 of file uchar.h.

typedef enum UCharNameChoice UCharNameChoice
 

Definition at line 410 of file uchar.h.

typedef enum UCharScript UCharScript
 

Definition at line 373 of file uchar.h.


Enumeration Type Documentation

enum UCellWidth
 

Values returned by the u_getCellWidth() function.

Draft:
Enumeration values:
U_ZERO_WIDTH  
U_HALF_WIDTH  
U_FULL_WIDTH  
U_NEUTRAL_WIDTH  
U_CELL_WIDTH_COUNT  

Definition at line 379 of file uchar.h.

enum UCharCategory
 

Data for enumerated Unicode general category types.

Draft:
Enumeration values:
U_UNASSIGNED  
U_UPPERCASE_LETTER  
U_LOWERCASE_LETTER  
U_TITLECASE_LETTER  
U_MODIFIER_LETTER  
U_OTHER_LETTER  
U_NON_SPACING_MARK  
U_ENCLOSING_MARK  
U_COMBINING_SPACING_MARK  
U_DECIMAL_DIGIT_NUMBER  
U_LETTER_NUMBER  
U_OTHER_NUMBER  
U_SPACE_SEPARATOR  
U_LINE_SEPARATOR  
U_PARAGRAPH_SEPARATOR  
U_CONTROL_CHAR  
U_FORMAT_CHAR  
U_PRIVATE_USE_CHAR  
U_SURROGATE  
U_DASH_PUNCTUATION  
U_START_PUNCTUATION  
U_END_PUNCTUATION  
U_CONNECTOR_PUNCTUATION  
U_OTHER_PUNCTUATION  
U_MATH_SYMBOL  
U_CURRENCY_SYMBOL  
U_MODIFIER_SYMBOL  
U_OTHER_SYMBOL  
U_INITIAL_PUNCTUATION  
U_FINAL_PUNCTUATION  
U_GENERAL_OTHER_TYPES  
U_CHAR_CATEGORY_COUNT  

Definition at line 66 of file uchar.h.

enum UCharDirection
 

This specifies the language directional property of a character set.

Enumeration values:
U_LEFT_TO_RIGHT  
U_RIGHT_TO_LEFT  
U_EUROPEAN_NUMBER  
U_EUROPEAN_NUMBER_SEPARATOR  
U_EUROPEAN_NUMBER_TERMINATOR  
U_ARABIC_NUMBER  
U_COMMON_NUMBER_SEPARATOR  
U_BLOCK_SEPARATOR  
U_SEGMENT_SEPARATOR  
U_WHITE_SPACE_NEUTRAL  
U_OTHER_NEUTRAL  
U_LEFT_TO_RIGHT_EMBEDDING  
U_LEFT_TO_RIGHT_OVERRIDE  
U_RIGHT_TO_LEFT_ARABIC  
U_RIGHT_TO_LEFT_EMBEDDING  
U_RIGHT_TO_LEFT_OVERRIDE  
U_POP_DIRECTIONAL_FORMAT  
U_DIR_NON_SPACING_MARK  
U_BOUNDARY_NEUTRAL  
U_CHAR_DIRECTION_COUNT  

Definition at line 138 of file uchar.h.

enum UCharNameChoice
 

Selector constants for u_charName().

u_charName() returns either the "modern" name of a Unicode character or the name that was defined in Unicode version 1.0, before the Unicode standard merged with ISO-10646.

See also:
u_charName()
Enumeration values:
U_UNICODE_CHAR_NAME  
U_UNICODE_10_CHAR_NAME  
U_CHAR_NAME_CHOICE_COUNT  

Definition at line 404 of file uchar.h.

enum UCharScript
 

Generated from Unicode Data files These are the same values as Unicode::EUnicodeScript.

Draft:
Enumeration values:
U_BASIC_LATIN  
U_LATIN_1_SUPPLEMENT  
U_LATIN_EXTENDED_A  
U_LATIN_EXTENDED_B  
U_IPA_EXTENSIONS  
U_SPACING_MODIFIER_LETTERS  
U_COMBINING_DIACRITICAL_MARKS  
U_GREEK  
U_CYRILLIC  
U_ARMENIAN  
U_HEBREW  
U_ARABIC  
U_SYRIAC  
U_THAANA  
U_DEVANAGARI  
U_BENGALI  
U_GURMUKHI  
U_GUJARATI  
U_ORIYA  
U_TAMIL  
U_TELUGU  
U_KANNADA  
U_MALAYALAM  
U_SINHALA  
U_THAI  
U_LAO  
U_TIBETAN  
U_MYANMAR  
U_GEORGIAN  
U_HANGUL_JAMO  
U_ETHIOPIC  
U_CHEROKEE  
U_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS  
U_OGHAM  
U_RUNIC  
U_KHMER  
U_MONGOLIAN  
U_LATIN_EXTENDED_ADDITIONAL  
U_GREEK_EXTENDED  
U_GENERAL_PUNCTUATION  
U_SUPERSCRIPTS_AND_SUBSCRIPTS  
U_CURRENCY_SYMBOLS  
U_COMBINING_MARKS_FOR_SYMBOLS  
U_LETTERLIKE_SYMBOLS  
U_NUMBER_FORMS  
U_ARROWS  
U_MATHEMATICAL_OPERATORS  
U_MISCELLANEOUS_TECHNICAL  
U_CONTROL_PICTURES  
U_OPTICAL_CHARACTER_RECOGNITION  
U_ENCLOSED_ALPHANUMERICS  
U_BOX_DRAWING  
U_BLOCK_ELEMENTS  
U_GEOMETRIC_SHAPES  
U_MISCELLANEOUS_SYMBOLS  
U_DINGBATS  
U_BRAILLE_PATTERNS  
U_CJK_RADICALS_SUPPLEMENT  
U_KANGXI_RADICALS  
U_IDEOGRAPHIC_DESCRIPTION_CHARACTERS  
U_CJK_SYMBOLS_AND_PUNCTUATION  
U_HIRAGANA  
U_KATAKANA  
U_BOPOMOFO  
U_HANGUL_COMPATIBILITY_JAMO  
U_KANBUN  
U_BOPOMOFO_EXTENDED  
U_ENCLOSED_CJK_LETTERS_AND_MONTHS  
U_CJK_COMPATIBILITY  
U_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A  
U_CJK_UNIFIED_IDEOGRAPHS  
U_YI_SYLLABLES  
U_YI_RADICALS  
U_HANGUL_SYLLABLES  
U_HIGH_SURROGATES  
U_HIGH_PRIVATE_USE_SURROGATES  
U_LOW_SURROGATES  
U_PRIVATE_USE_AREA  
U_CJK_COMPATIBILITY_IDEOGRAPHS  
U_ALPHABETIC_PRESENTATION_FORMS  
U_ARABIC_PRESENTATION_FORMS_A  
U_COMBINING_HALF_MARKS  
U_CJK_COMPATIBILITY_FORMS  
U_SMALL_FORM_VARIANTS  
U_ARABIC_PRESENTATION_FORMS_B  
U_SPECIALS  
U_HALFWIDTH_AND_FULLWIDTH_FORMS  
U_CHAR_SCRIPT_COUNT  
U_NO_SCRIPT  

Definition at line 192 of file uchar.h.


Function Documentation

U_CDECL_BEGIN typedef UBool UEnumCharNamesFn ( void * context,
UChar32 code,
UCharNameChoice nameChoice,
const char * name,
UTextOffset length )
 

Type of a callback function for u_enumCharNames() that gets called for each Unicode character with the code point value and the character name.

If such a function returns FALSE, then the enumeration is stopped.

Parameters:
context   The context pointer that was passed to u_enumCharNames().
code   The Unicode code point for the character with this name.
nameChoice   Selector for which kind of names is enumerated.
name   The character's name, zero-terminated.
length   The length of the name.
Returns:
TRUE if the enumeration should continue, FALSE to stop it.

See also:
UCharNameChoice , u_enumCharNames

U_CAPI uint16_t U_EXPORT2 u_charCellWidth ( UChar32 c )
 

Returns a value indicating the display-cell width of the character when used in Asian text, according to the Unicode standard (see p.

6-130 of The Unicode Standard, Version 2.0). The results for various characters are as follows:

ZERO_WIDTH: Characters which are considered to take up no display-cell space: control characters format characters line and paragraph separators non-spacing marks combining Hangul jungseong combining Hangul jongseong unassigned Unicode values

HALF_WIDTH: Characters which take up half a cell in standard Asian text: all characters in the General Scripts Area except combining Hangul choseong and the characters called out specifically above as ZERO_WIDTH alphabetic and Arabic presentation forms halfwidth CJK punctuation halfwidth Katakana halfwidth Hangul Jamo halfwidth forms, arrows, and shapes

FULL_WIDTH: Characters which take up a full cell in standard Asian text: combining Hangul choseong all characters in the CJK Phonetics and Symbols Area all characters in the CJK Ideographs Area all characters in the Hangul Syllables Area CJK compatibility ideographs CJK compatibility forms small form variants fullwidth ASCII fullwidth punctuation and currency signs

NEUTRAL: Characters whose cell width is context-dependent: all characters in the Symbols Area, except those specifically called out above all characters in the Surrogates Area all charcaters in the Private Use Area

For Korean text, this algorithm should work properly with properly normalized Korean text. Precomposed Hangul syllables and non-combining jamo are all considered full- width characters. For combining jamo, we treat we treat choseong (initial consonants) as double-width characters and junseong (vowels) and jongseong (final consonants) as non-spacing marks. This will work right in text that uses the precomposed choseong characters instead of teo choseong characters in a row, and which uses the choseong filler character at the beginning of syllables that don't have an initial consonant. The results may be slightly off with Korean text following different conventions.

Draft:

Referenced by Unicode::getCellWidth().

U_CAPI int32_t U_EXPORT2 u_charDigitValue ( UChar32 c )
 

Retrives the decimal numeric value of a digit character.

Parameters:
c   the digit character for which to get the numeric value
Returns:
the numeric value of ch in decimal radix. This method returns -1 if ch is not a valid digit character.
Draft:

Referenced by Unicode::digit(), and Unicode::digitValue().

U_CAPI UCharDirection U_EXPORT2 u_charDirection ( UChar32 c )
 

Returns the linguistic direction property of a character.

Returns the linguistic direction property of a character. For example, 0x0041 (letter A) has the LEFT_TO_RIGHT directional property.

See also:
UCharDirection
Draft:

Referenced by Unicode::characterDirection().

U_CAPI UChar32 U_EXPORT2 u_charFromName ( UCharNameChoice nameChoice,
const char * name,
UErrorCode * pErrorCode )
 

Find a Unicode character by its name and return its code point value.

The name is matched exactly and completely. A Unicode 1.0 name is matched only if it differs from the modern name. Unicode names are all uppercase.

Parameters:
nameChoice   Selector for which name to match.
name   The name to match.
pErrorCode   Pointer to a UErrorCode variable
Returns:
The Unicode code point value of the character with the given name, or 0xffff if there is no such character.

See also:
UCharNameChoice , u_charName , u_enumCharNames

U_CAPI UChar32 U_EXPORT2 u_charMirror ( UChar32 c )
 

Maps the specified character to a "mirror-image" character.

For characters with the "mirrored" property, implementations sometimes need a "poor man's" mapping to another Unicode character (code point) such that the default glyph may serve as the mirror-image of the default glyph of the specified character. This is useful for text conversion to and from codepages with visual order, and for displays without glyph selecetion capabilities.

Parameters:
c   the character (code point, Unicode scalar value) to be mapped
Returns:
another Unicode code point that may serve as a mirror-image substitute, or c itself if there is no such mapping or c does not have the "mirrored" property

Referenced by Unicode::charMirror().

U_CAPI UTextOffset U_EXPORT2 u_charName ( UChar32 code,
UCharNameChoice nameChoice,
char * buffer,
UTextOffset bufferLength,
UErrorCode * pErrorCode )
 

Retrieve the name of a Unicode character.

Depending on nameChoice, the character name written into the buffer is the "modern" name or the name that was defined in Unicode version 1.0. The name contains only "invariant" characters like A-Z, 0-9, space, and '-'. Unicode 1.0 names are only retrieved if they are different from the modern names and if the data file contains the data for them. gennames may or may not be called with a command line option to include 1.0 names in unames.dat.

Parameters:
code   The character (code point) for which to get the name. It must be 0<=code<0x10ffff.
nameChoice   Selector for which name to get.
buffer   Destination address for copying the name. The name will always be zero-terminated. If there is no name, then the buffer will be set to the empty string.
bufferLength   ==sizeof(buffer)
pErrorCode   Pointer to a UErrorCode variable; check for U_SUCCESS() after u_charName() returns.
Returns:
The length of the name, or 0 if there is no name for this character. If the bufferLength is less than or equal to the length, then the buffer contains the truncated name and the returned length indicates the full length of the name. The length does not include the zero-termination.

See also:
UCharNameChoice , u_charFromName , u_enumCharNames
Draft:

Referenced by Unicode::getCharName().

U_CAPI UCharScript U_EXPORT2 u_charScript ( UChar32 ch )
 

Returns the script associated with a character.

See also:
UCharScript
Draft:

Referenced by Unicode::getScript().

U_CAPI int8_t U_EXPORT2 u_charType ( UChar32 c )
 

Returns a value indicating a character category according to Unicode 2.1.2.

Parameters:
c   the character to be tested
Returns:
a value of type int, the character category.
See also:
UCharCategory
Draft:

Referenced by Unicode::getType().

U_CDECL_END U_CAPI void U_EXPORT2 u_enumCharNames ( UChar32 start,
UChar32 limit,
UEnumCharNamesFn * fn,
void * context,
UCharNameChoice nameChoice,
UErrorCode * pErrorCode )
 

Enumerate all assigned Unicode characters between the start and limit code points (start inclusive, limit exclusive) and call a function for each, passing the code point value and the character name.

For Unicode 1.0 names, only those are enumerated that differ from the modern names.

Parameters:
start   The first code point in the enumeration range.
limit   One more than the last code point in the enumeration range (the first one after the range).
fn   The function that is to be called for each character name.
context   An arbitrary pointer that is passed to the function.
nameChoice   Selector for which kind of names to enumerate.
pErrorCode   Pointer to a UErrorCode variable

See also:
UCharNameChoice , UEnumCharNamesFn , u_charName , u_charFromName

U_CAPI void U_EXPORT2 u_getUnicodeVersion ( UVersionInfo info )
 

Gets the Unicode version information.

The version array stores the version information for the Unicode standard that is currently used by ICU. For example, release "1.3.31.2" is then represented as 0x01031F02.

Parameters:
versionArray   the version # information, the result will be filled in
Stable:

Referenced by Unicode::getUnicodeVersion().

U_CAPI UBool U_EXPORT2 u_isIDIgnorable ( UChar32 c )
 

A convenience method for determining if a Unicode character should be regarded as an ignorable character in a Unicode identifier.

The following Unicode characters are ignorable in a Unicode identifier:
0x0000 through 0x0008, ISO control characters that
0x000E through 0x001B, are not whitespace
and 0x007F through 0x009F
0x200C through 0x200F join controls
0x200A through 0x200E bidirectional controls
0x206A through 0x206F format controls
0xFEFF zero-width no-break space

Parameters:
c   the Unicode character.
Returns:
TRUE if the character may be part of a Unicode identifier; FALSE otherwise.
See also:
u_isIDPart
Draft:

Referenced by Unicode::isIdentifierIgnorable().

U_CAPI UBool U_EXPORT2 u_isIDPart ( UChar32 c )
 

A convenience method for determining if a Unicode character may be part of a Unicode identifier other than the starting character.

A character may be part of a Unicode identifier if and only if it is one of the following:

  • a letter
  • a connecting punctuation character (such as "_").
  • a digit
  • a numeric letter (such as a Roman numeral character)
  • a combining mark
  • a non-spacing mark
  • an ignorable control character
Parameters:
c   the Unicode character.
Returns:
TRUE if the character may be part of a Unicode identifier; FALSE otherwise.
See also:
u_isIDIgnorable , u_isIDStart
Draft:

Referenced by Unicode::isUnicodeIdentifierPart().

U_CAPI UBool U_EXPORT2 u_isIDStart ( UChar32 c )
 

A convenience method for determining if a Unicode character is allowed to start in a Unicode identifier.

A character may start a Unicode identifier if and only if it is a letter.

Parameters:
c   the Unicode character.
Returns:
TRUE if the character may start a Unicode identifier; FALSE otherwise.
See also:
u_isalpha , u_isIDPart
Draft:

Referenced by Unicode::isUnicodeIdentifierStart().

U_CAPI UBool U_EXPORT2 u_isJavaIDPart ( UChar32 c )
 

A convenience method for determining if a Unicode character may be part of a Java identifier other than the starting character.

A character may be part of a Java identifier if and only if it is one of the following:

  • a letter
  • a currency symbol (such as "$")
  • a connecting punctuation character (such as "_").
  • a digit
  • a numeric letter (such as a Roman numeral character)
  • a combining mark
  • a non-spacing mark
  • an ignorable control character
Parameters:
c   the Unicode character.
Returns:
TRUE if the character may be part of a Unicode identifier; FALSE otherwise.
See also:
u_isIDIgnorable , u_isJavaIDStart , u_isalpha , u_isdigit , u_isIDPart
Draft:

Referenced by Unicode::isJavaIdentifierPart().

U_CAPI UBool U_EXPORT2 u_isJavaIDStart ( UChar32 c )
 

A convenience method for determining if a Unicode character is allowed as the first character in a Java identifier.

A character may start a Java identifier if and only if it is one of the following:

  • a letter
  • a currency symbol (such as "$")
  • a connecting punctuation symbol (such as "_").
Parameters:
c   the Unicode character.
Returns:
TRUE if the character may start a Java identifier; FALSE otherwise.
See also:
u_isJavaIDPart , u_isalpha , u_isIDStart
Draft:

Referenced by Unicode::isJavaIdentifierStart().

U_CAPI UBool U_EXPORT2 u_isMirrored ( UChar32 c )
 

Determines whether the character has the "mirrored" property.

This property is set for characters that are commonly used in Right-To-Left contexts and need to be displayed with a "mirrored" glyph.

Parameters:
c   the character (code point, Unicode scalar value) to be tested
Returns:
TRUE if the character has the "mirrored" property

Referenced by Unicode::isMirrored().

U_CAPI UBool U_EXPORT2 u_isWhitespace ( UChar32 c )
 

Determines if the specified character is white space according to ICU.

A character is considered to be an ICU whitespace character if and only if it satisfies one of the following criteria:

  • It is a Unicode space separator (category "Zs"), but is not a no-break space (&#92;u00A0 or &#92;uFEFF).
  • It is a Unicode line separator (category "Zl").
  • It is a Unicode paragraph separator (category "Zp").
  • It is &#92;u0009, HORIZONTAL TABULATION.
  • It is &#92;u000A, LINE FEED.
  • It is &#92;u000B, VERTICAL TABULATION.
  • It is &#92;u000C, FORM FEED.
  • It is &#92;u000D, CARRIAGE RETURN.
  • It is &#92;u001C, FILE SEPARATOR.
  • It is &#92;u001D, GROUP SEPARATOR.
  • It is &#92;u001E, RECORD SEPARATOR.
  • It is &#92;u001F, UNIT SEPARATOR.
Note: This method corresponds to the Java method java.lang.Character.isWhitespace().
Parameters:
ch   the character to be tested.
Returns:
true if the character is an ICU whitespace character; false otherwise.
See also:
isspace
Draft:

Referenced by Unicode::isWhitespace().

U_CAPI UBool U_EXPORT2 u_isalnum ( UChar32 c )
 

Determines whether the specified character is an alphanumeric character (letter or digit)according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character is a letter or a digit; false otherwise.
Draft:

U_CAPI UBool U_EXPORT2 u_isalpha ( UChar32 c )
 

Determines whether the specified character is a letter according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character is a letter; false otherwise.

See also:
u_isdigit() , u_isalnum()
Draft:

Referenced by Unicode::isLetter().

U_CAPI UBool U_EXPORT2 u_isbase ( UChar32 c )
 

Determines whether the specified character is of the base form according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the Unicode character is of the base form; false otherwise.

See also:
u_isalpha() , u_isdigit()
Draft:

Referenced by Unicode::isBaseForm().

U_CAPI UBool U_EXPORT2 u_iscntrl ( UChar32 c )
 

Determines whether the specified character is a control character or not.

Parameters:
ch   the character to be tested
Returns:
true if the Unicode character is a control character; false otherwise.

See also:
u_isprint()
Draft:

Referenced by Unicode::isControl().

U_CAPI UBool U_EXPORT2 u_isdefined ( UChar32 c )
 

Determines whether the specified numeric value is actually a defined character according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character has a defined Unicode meaning; false otherwise.

See also:
u_isdigit() , u_isalpha() , u_isalnum() , u_isupper() , u_islower() , u_istitle()
Draft:

Referenced by Unicode::isDefined().

U_CAPI UBool U_EXPORT2 u_isdigit ( UChar32 c )
 

Determines whether the specified character is a digit according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character is a digit; false otherwise.
Draft:

Referenced by Unicode::isDigit().

U_CAPI UBool U_EXPORT2 u_islower ( UChar32 c )
 

Determines whether the specified UChar is a lowercase character according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character is lowercase; false otherwise.
See also:
UNICODE_VERSION , u_isupper() , u_istitle() , u_islower()
Draft:

Referenced by Unicode::isLowerCase().

U_CAPI UBool U_EXPORT2 u_isprint ( UChar32 c )
 

Determines whether the specified character is a printable character according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the Unicode character is a printable character; false otherwise.

See also:
u_iscntrl()
Draft:

Referenced by Unicode::isPrintable().

U_CAPI UBool U_EXPORT2 u_isspace ( UChar32 c )
 

Determines if the specified character is a space character or not.

Parameters:
ch   the character to be tested
Returns:
true if the character is a space character; false otherwise.
Draft:

Referenced by Unicode::isSpaceChar().

U_CAPI UBool U_EXPORT2 u_istitle ( UChar32 c )
 

Determines whether the specified character is a titlecase character according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character is titlecase; false otherwise.
See also:
u_isupper() , u_islower() , u_totitle()
Draft:

Referenced by Unicode::isTitleCase().

U_CAPI UBool U_EXPORT2 u_isupper ( UChar32 c )
 

Determines whether the specified character is an uppercase character according to Unicode 2.1.2.

Parameters:
ch   the character to be tested
Returns:
true if the character is uppercase; false otherwise.
See also:
u_islower() , u_istitle , u_tolower()
Draft:

Referenced by Unicode::isUpperCase().

U_CAPI UChar32 U_EXPORT2 u_tolower ( UChar32 c )
 

The given character is mapped to its lowercase equivalent according to Unicode 2.1.2; if the character has no lowercase equivalent, the character itself is returned.

A character has a lowercase equivalent if and only if a lowercase mapping is specified for the character in the Unicode 2.1.2 attribute table.

u_tolower() only deals with the general letter case conversion. For language specific case conversion behavior, use ustrToUpper(). For example, the case conversion for dot-less i and dotted I in Turkish, or for final sigma in Greek.

Parameters:
ch   the character to be converted
Returns:
the lowercase equivalent of the character, if any; otherwise the character itself.
Draft:

Referenced by Unicode::toLowerCase().

U_CAPI UChar32 U_EXPORT2 u_totitle ( UChar32 c )
 

The given character is mapped to its titlecase equivalent according to Unicode 2.1.2.

There are only four Unicode characters that are truly titlecase forms that are distinct from uppercase forms. As a rule, if a character has no true titlecase equivalent, its uppercase equivalent is returned.

A character has a titlecase equivalent if and only if a titlecase mapping is specified for the character in the Unicode 2.1.2 data.

Parameters:
ch   the character to be converted
Returns:
the titlecase equivalent of the character, if any; otherwise the character itself.
Draft:

Referenced by Unicode::toTitleCase().

U_CAPI UChar32 U_EXPORT2 u_toupper ( UChar32 c )
 

The given character is mapped to its uppercase equivalent according to Unicode 2.1.2; if the character has no uppercase equivalent, the character itself is returned.

u_toupper() only deals with the general letter case conversion. For language specific case conversion behavior, use ustrToUpper(). For example, the case conversion for dot-less i and dotted I in Turkish, or ess-zed (i.e., "sharp S") in German.

Parameters:
ch   the character to be converted
Returns:
the uppercase equivalent of the character, if any; otherwise the character itself.
Draft:

Referenced by Unicode::toUpperCase().


Generated at Fri Dec 15 12:12:46 2000 for ICU 1.7 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000