2 **********************************************************************
3 * Copyright (C) 1997-2011, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 **********************************************************************
9 * Modification History:
11 * Date Name Description
12 * 04/02/97 aliu Creation.
13 * 03/29/99 helena Updated for C APIs.
14 * 4/15/99 Madhu Updated for C Implementation and Javadoc
15 * 5/20/99 Madhu Added the function u_getVersion()
16 * 8/19/1999 srl Upgraded scripts to Unicode 3.0
17 * 8/27/1999 schererm UCharDirection constants: U_...
18 * 11/11/1999 weiv added u_isalnum(), cleaned comments
19 * 01/11/2000 helena Renamed u_getVersion to u_getUnicodeVersion().
20 ******************************************************************************
26 #include "unicode/utypes.h"
30 /*==========================================================================*/
31 /* Unicode version number */
32 /*==========================================================================*/
34 * Unicode version number, default for the current ICU version.
35 * The actual Unicode Character Database (UCD) data is stored in uprops.dat
36 * and may be generated from UCD files from a different Unicode version.
37 * Call u_getUnicodeVersion to get the actual Unicode version of the data.
39 * @see u_getUnicodeVersion
42 #define U_UNICODE_VERSION "6.1"
46 * \brief C API: Unicode Properties
48 * This C API provides low-level access to the Unicode Character Database.
49 * In addition to raw property values, some convenience functions calculate
50 * derived properties, for example for Java-style programming.
52 * Unicode assigns each code point (not just assigned character) values for
54 * Most of them are simple boolean flags, or constants from a small enumerated list.
55 * For some properties, values are strings or other relatively more complex types.
57 * For more information see
58 * "About the Unicode Character Database" (http://www.unicode.org/ucd/)
59 * and the ICU User Guide chapter on Properties (http://icu-project.org/userguide/properties.html).
61 * Many functions are designed to match java.lang.Character functions.
62 * See the individual function documentation,
63 * and see the JDK 1.4 java.lang.Character documentation
64 * at http://java.sun.com/j2se/1.4/docs/api/java/lang/Character.html
66 * There are also functions that provide easy migration from C/POSIX functions
67 * like isblank(). Their use is generally discouraged because the C/POSIX
68 * standards do not define their semantics beyond the ASCII range, which means
69 * that different implementations exhibit very different behavior.
70 * Instead, Unicode properties should be used directly.
72 * There are also only a few, broad C/POSIX character classes, and they tend
73 * to be used for conflicting purposes. For example, the "isalpha()" class
74 * is sometimes used to determine word boundaries, while a more sophisticated
75 * approach would at least distinguish initial letters from continuation
76 * characters (the latter including combining marks).
77 * (In ICU, BreakIterator is the most sophisticated API for word boundaries.)
78 * Another example: There is no "istitle()" class for titlecase characters.
80 * ICU 3.4 and later provides API access for all twelve C/POSIX character classes.
81 * ICU implements them according to the Standard Recommendations in
82 * Annex C: Compatibility Properties of UTS #18 Unicode Regular Expressions
83 * (http://www.unicode.org/reports/tr18/#Compatibility_Properties).
85 * API access for C/POSIX character classes is as follows:
86 * - alpha: u_isUAlphabetic(c) or u_hasBinaryProperty(c, UCHAR_ALPHABETIC)
87 * - lower: u_isULowercase(c) or u_hasBinaryProperty(c, UCHAR_LOWERCASE)
88 * - upper: u_isUUppercase(c) or u_hasBinaryProperty(c, UCHAR_UPPERCASE)
89 * - punct: u_ispunct(c)
90 * - digit: u_isdigit(c) or u_charType(c)==U_DECIMAL_DIGIT_NUMBER
91 * - xdigit: u_isxdigit(c) or u_hasBinaryProperty(c, UCHAR_POSIX_XDIGIT)
92 * - alnum: u_hasBinaryProperty(c, UCHAR_POSIX_ALNUM)
93 * - space: u_isUWhiteSpace(c) or u_hasBinaryProperty(c, UCHAR_WHITE_SPACE)
94 * - blank: u_isblank(c) or u_hasBinaryProperty(c, UCHAR_POSIX_BLANK)
95 * - cntrl: u_charType(c)==U_CONTROL_CHAR
96 * - graph: u_hasBinaryProperty(c, UCHAR_POSIX_GRAPH)
97 * - print: u_hasBinaryProperty(c, UCHAR_POSIX_PRINT)
99 * Note: Some of the u_isxyz() functions in uchar.h predate, and do not match,
100 * the Standard Recommendations in UTS #18. Instead, they match Java
101 * functions according to their API documentation.
104 * The C/POSIX character classes are also available in UnicodeSet patterns,
105 * using patterns like [:graph:] or \p{graph}.
108 * Note: There are several ICU whitespace functions.
110 * - u_isUWhiteSpace=UCHAR_WHITE_SPACE: Unicode White_Space property;
111 * most of general categories "Z" (separators) + most whitespace ISO controls
112 * (including no-break spaces, but excluding IS1..IS4 and ZWSP)
113 * - u_isWhitespace: Java isWhitespace; Z + whitespace ISO controls but excluding no-break spaces
114 * - u_isJavaSpaceChar: Java isSpaceChar; just Z (including no-break spaces)
115 * - u_isspace: Z + whitespace ISO controls (including no-break spaces)
116 * - u_isblank: "horizontal spaces" = TAB + Zs - ZWSP
123 /** The lowest Unicode code point value. Code points are non-negative. @stable ICU 2.0 */
124 #define UCHAR_MIN_VALUE 0
127 * The highest Unicode code point value (scalar value) according to
128 * The Unicode Standard. This is a 21-bit value (20.1 bits, rounded up).
129 * For a single character, UChar32 is a simple type that can hold any code point value.
134 #define UCHAR_MAX_VALUE 0x10ffff
137 * Get a single-bit bit set (a flag) from a bit number 0..31.
140 #define U_MASK(x) ((uint32_t)1<<(x))
143 * Selection constants for Unicode properties.
144 * These constants are used in functions like u_hasBinaryProperty to select
145 * one of the Unicode properties.
147 * The properties APIs are intended to reflect Unicode properties as defined
148 * in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).
149 * For details about the properties see http://www.unicode.org/ucd/ .
150 * For names of Unicode properties see the UCD file PropertyAliases.txt.
152 * Important: If ICU is built with UCD files from Unicode versions below, e.g., 3.2,
153 * then properties marked with "new in Unicode 3.2" are not or not fully available.
154 * Check u_getUnicodeVersion to be sure.
156 * @see u_hasBinaryProperty
157 * @see u_getIntPropertyValue
158 * @see u_getUnicodeVersion
161 typedef enum UProperty
{
163 * Note: UProperty constants are parsed by preparseucd.py.
164 * It matches lines like
165 * UCHAR_<Unicode property name>=<integer>,
168 /* Note: Place UCHAR_ALPHABETIC before UCHAR_BINARY_START so that
169 debuggers display UCHAR_ALPHABETIC as the symbolic name for 0,
170 rather than UCHAR_BINARY_START. Likewise for other *_START
173 /** Binary property Alphabetic. Same as u_isUAlphabetic, different from u_isalpha.
174 Lu+Ll+Lt+Lm+Lo+Nl+Other_Alphabetic @stable ICU 2.1 */
176 /** First constant for binary Unicode properties. @stable ICU 2.1 */
177 UCHAR_BINARY_START
=UCHAR_ALPHABETIC
,
178 /** Binary property ASCII_Hex_Digit. 0-9 A-F a-f @stable ICU 2.1 */
179 UCHAR_ASCII_HEX_DIGIT
=1,
180 /** Binary property Bidi_Control.
181 Format controls which have specific functions
182 in the Bidi Algorithm. @stable ICU 2.1 */
183 UCHAR_BIDI_CONTROL
=2,
184 /** Binary property Bidi_Mirrored.
185 Characters that may change display in RTL text.
186 Same as u_isMirrored.
187 See Bidi Algorithm, UTR 9. @stable ICU 2.1 */
188 UCHAR_BIDI_MIRRORED
=3,
189 /** Binary property Dash. Variations of dashes. @stable ICU 2.1 */
191 /** Binary property Default_Ignorable_Code_Point (new in Unicode 3.2).
192 Ignorable in most processing.
193 <2060..206F, FFF0..FFFB, E0000..E0FFF>+Other_Default_Ignorable_Code_Point+(Cf+Cc+Cs-White_Space) @stable ICU 2.1 */
194 UCHAR_DEFAULT_IGNORABLE_CODE_POINT
=5,
195 /** Binary property Deprecated (new in Unicode 3.2).
196 The usage of deprecated characters is strongly discouraged. @stable ICU 2.1 */
198 /** Binary property Diacritic. Characters that linguistically modify
199 the meaning of another character to which they apply. @stable ICU 2.1 */
201 /** Binary property Extender.
202 Extend the value or shape of a preceding alphabetic character,
203 e.g., length and iteration marks. @stable ICU 2.1 */
205 /** Binary property Full_Composition_Exclusion.
206 CompositionExclusions.txt+Singleton Decompositions+
207 Non-Starter Decompositions. @stable ICU 2.1 */
208 UCHAR_FULL_COMPOSITION_EXCLUSION
=9,
209 /** Binary property Grapheme_Base (new in Unicode 3.2).
210 For programmatic determination of grapheme cluster boundaries.
211 [0..10FFFF]-Cc-Cf-Cs-Co-Cn-Zl-Zp-Grapheme_Link-Grapheme_Extend-CGJ @stable ICU 2.1 */
212 UCHAR_GRAPHEME_BASE
=10,
213 /** Binary property Grapheme_Extend (new in Unicode 3.2).
214 For programmatic determination of grapheme cluster boundaries.
215 Me+Mn+Mc+Other_Grapheme_Extend-Grapheme_Link-CGJ @stable ICU 2.1 */
216 UCHAR_GRAPHEME_EXTEND
=11,
217 /** Binary property Grapheme_Link (new in Unicode 3.2).
218 For programmatic determination of grapheme cluster boundaries. @stable ICU 2.1 */
219 UCHAR_GRAPHEME_LINK
=12,
220 /** Binary property Hex_Digit.
221 Characters commonly used for hexadecimal numbers. @stable ICU 2.1 */
223 /** Binary property Hyphen. Dashes used to mark connections
224 between pieces of words, plus the Katakana middle dot. @stable ICU 2.1 */
226 /** Binary property ID_Continue.
227 Characters that can continue an identifier.
228 DerivedCoreProperties.txt also says "NOTE: Cf characters should be filtered out."
229 ID_Start+Mn+Mc+Nd+Pc @stable ICU 2.1 */
230 UCHAR_ID_CONTINUE
=15,
231 /** Binary property ID_Start.
232 Characters that can start an identifier.
233 Lu+Ll+Lt+Lm+Lo+Nl @stable ICU 2.1 */
235 /** Binary property Ideographic.
236 CJKV ideographs. @stable ICU 2.1 */
237 UCHAR_IDEOGRAPHIC
=17,
238 /** Binary property IDS_Binary_Operator (new in Unicode 3.2).
239 For programmatic determination of
240 Ideographic Description Sequences. @stable ICU 2.1 */
241 UCHAR_IDS_BINARY_OPERATOR
=18,
242 /** Binary property IDS_Trinary_Operator (new in Unicode 3.2).
243 For programmatic determination of
244 Ideographic Description Sequences. @stable ICU 2.1 */
245 UCHAR_IDS_TRINARY_OPERATOR
=19,
246 /** Binary property Join_Control.
247 Format controls for cursive joining and ligation. @stable ICU 2.1 */
248 UCHAR_JOIN_CONTROL
=20,
249 /** Binary property Logical_Order_Exception (new in Unicode 3.2).
250 Characters that do not use logical order and
251 require special handling in most processing. @stable ICU 2.1 */
252 UCHAR_LOGICAL_ORDER_EXCEPTION
=21,
253 /** Binary property Lowercase. Same as u_isULowercase, different from u_islower.
254 Ll+Other_Lowercase @stable ICU 2.1 */
256 /** Binary property Math. Sm+Other_Math @stable ICU 2.1 */
258 /** Binary property Noncharacter_Code_Point.
259 Code points that are explicitly defined as illegal
260 for the encoding of characters. @stable ICU 2.1 */
261 UCHAR_NONCHARACTER_CODE_POINT
=24,
262 /** Binary property Quotation_Mark. @stable ICU 2.1 */
263 UCHAR_QUOTATION_MARK
=25,
264 /** Binary property Radical (new in Unicode 3.2).
265 For programmatic determination of
266 Ideographic Description Sequences. @stable ICU 2.1 */
268 /** Binary property Soft_Dotted (new in Unicode 3.2).
269 Characters with a "soft dot", like i or j.
270 An accent placed on these characters causes
271 the dot to disappear. @stable ICU 2.1 */
272 UCHAR_SOFT_DOTTED
=27,
273 /** Binary property Terminal_Punctuation.
274 Punctuation characters that generally mark
275 the end of textual units. @stable ICU 2.1 */
276 UCHAR_TERMINAL_PUNCTUATION
=28,
277 /** Binary property Unified_Ideograph (new in Unicode 3.2).
278 For programmatic determination of
279 Ideographic Description Sequences. @stable ICU 2.1 */
280 UCHAR_UNIFIED_IDEOGRAPH
=29,
281 /** Binary property Uppercase. Same as u_isUUppercase, different from u_isupper.
282 Lu+Other_Uppercase @stable ICU 2.1 */
284 /** Binary property White_Space.
285 Same as u_isUWhiteSpace, different from u_isspace and u_isWhitespace.
286 Space characters+TAB+CR+LF-ZWSP-ZWNBSP @stable ICU 2.1 */
287 UCHAR_WHITE_SPACE
=31,
288 /** Binary property XID_Continue.
289 ID_Continue modified to allow closure under
290 normalization forms NFKC and NFKD. @stable ICU 2.1 */
291 UCHAR_XID_CONTINUE
=32,
292 /** Binary property XID_Start. ID_Start modified to allow
293 closure under normalization forms NFKC and NFKD. @stable ICU 2.1 */
295 /** Binary property Case_Sensitive. Either the source of a case
296 mapping or _in_ the target of a case mapping. Not the same as
297 the general category Cased_Letter. @stable ICU 2.6 */
298 UCHAR_CASE_SENSITIVE
=34,
299 /** Binary property STerm (new in Unicode 4.0.1).
300 Sentence Terminal. Used in UAX #29: Text Boundaries
301 (http://www.unicode.org/reports/tr29/)
304 /** Binary property Variation_Selector (new in Unicode 4.0.1).
305 Indicates all those characters that qualify as Variation Selectors.
306 For details on the behavior of these characters,
307 see StandardizedVariants.html and 15.6 Variation Selectors.
309 UCHAR_VARIATION_SELECTOR
=36,
310 /** Binary property NFD_Inert.
311 ICU-specific property for characters that are inert under NFD,
312 i.e., they do not interact with adjacent characters.
313 See the documentation for the Normalizer2 class and the
314 Normalizer2::isInert() method.
317 /** Binary property NFKD_Inert.
318 ICU-specific property for characters that are inert under NFKD,
319 i.e., they do not interact with adjacent characters.
320 See the documentation for the Normalizer2 class and the
321 Normalizer2::isInert() method.
324 /** Binary property NFC_Inert.
325 ICU-specific property for characters that are inert under NFC,
326 i.e., they do not interact with adjacent characters.
327 See the documentation for the Normalizer2 class and the
328 Normalizer2::isInert() method.
331 /** Binary property NFKC_Inert.
332 ICU-specific property for characters that are inert under NFKC,
333 i.e., they do not interact with adjacent characters.
334 See the documentation for the Normalizer2 class and the
335 Normalizer2::isInert() method.
338 /** Binary Property Segment_Starter.
339 ICU-specific property for characters that are starters in terms of
340 Unicode normalization and combining character sequences.
341 They have ccc=0 and do not occur in non-initial position of the
342 canonical decomposition of any character
343 (like a-umlaut in NFD and a Jamo T in an NFD(Hangul LVT)).
344 ICU uses this property for segmenting a string for generating a set of
345 canonically equivalent strings, e.g. for canonical closure while
346 processing collation tailoring rules.
348 UCHAR_SEGMENT_STARTER
=41,
349 /** Binary property Pattern_Syntax (new in Unicode 4.1).
350 See UAX #31 Identifier and Pattern Syntax
351 (http://www.unicode.org/reports/tr31/)
353 UCHAR_PATTERN_SYNTAX
=42,
354 /** Binary property Pattern_White_Space (new in Unicode 4.1).
355 See UAX #31 Identifier and Pattern Syntax
356 (http://www.unicode.org/reports/tr31/)
358 UCHAR_PATTERN_WHITE_SPACE
=43,
359 /** Binary property alnum (a C/POSIX character class).
360 Implemented according to the UTS #18 Annex C Standard Recommendation.
361 See the uchar.h file documentation.
363 UCHAR_POSIX_ALNUM
=44,
364 /** Binary property blank (a C/POSIX character class).
365 Implemented according to the UTS #18 Annex C Standard Recommendation.
366 See the uchar.h file documentation.
368 UCHAR_POSIX_BLANK
=45,
369 /** Binary property graph (a C/POSIX character class).
370 Implemented according to the UTS #18 Annex C Standard Recommendation.
371 See the uchar.h file documentation.
373 UCHAR_POSIX_GRAPH
=46,
374 /** Binary property print (a C/POSIX character class).
375 Implemented according to the UTS #18 Annex C Standard Recommendation.
376 See the uchar.h file documentation.
378 UCHAR_POSIX_PRINT
=47,
379 /** Binary property xdigit (a C/POSIX character class).
380 Implemented according to the UTS #18 Annex C Standard Recommendation.
381 See the uchar.h file documentation.
383 UCHAR_POSIX_XDIGIT
=48,
384 /** Binary property Cased. For Lowercase, Uppercase and Titlecase characters. @stable ICU 4.4 */
386 /** Binary property Case_Ignorable. Used in context-sensitive case mappings. @stable ICU 4.4 */
387 UCHAR_CASE_IGNORABLE
=50,
388 /** Binary property Changes_When_Lowercased. @stable ICU 4.4 */
389 UCHAR_CHANGES_WHEN_LOWERCASED
=51,
390 /** Binary property Changes_When_Uppercased. @stable ICU 4.4 */
391 UCHAR_CHANGES_WHEN_UPPERCASED
=52,
392 /** Binary property Changes_When_Titlecased. @stable ICU 4.4 */
393 UCHAR_CHANGES_WHEN_TITLECASED
=53,
394 /** Binary property Changes_When_Casefolded. @stable ICU 4.4 */
395 UCHAR_CHANGES_WHEN_CASEFOLDED
=54,
396 /** Binary property Changes_When_Casemapped. @stable ICU 4.4 */
397 UCHAR_CHANGES_WHEN_CASEMAPPED
=55,
398 /** Binary property Changes_When_NFKC_Casefolded. @stable ICU 4.4 */
399 UCHAR_CHANGES_WHEN_NFKC_CASEFOLDED
=56,
400 /** One more than the last constant for binary Unicode properties. @stable ICU 2.1 */
401 UCHAR_BINARY_LIMIT
=57,
403 /** Enumerated property Bidi_Class.
404 Same as u_charDirection, returns UCharDirection values. @stable ICU 2.2 */
405 UCHAR_BIDI_CLASS
=0x1000,
406 /** First constant for enumerated/integer Unicode properties. @stable ICU 2.2 */
407 UCHAR_INT_START
=UCHAR_BIDI_CLASS
,
408 /** Enumerated property Block.
409 Same as ublock_getCode, returns UBlockCode values. @stable ICU 2.2 */
411 /** Enumerated property Canonical_Combining_Class.
412 Same as u_getCombiningClass, returns 8-bit numeric values. @stable ICU 2.2 */
413 UCHAR_CANONICAL_COMBINING_CLASS
=0x1002,
414 /** Enumerated property Decomposition_Type.
415 Returns UDecompositionType values. @stable ICU 2.2 */
416 UCHAR_DECOMPOSITION_TYPE
=0x1003,
417 /** Enumerated property East_Asian_Width.
418 See http://www.unicode.org/reports/tr11/
419 Returns UEastAsianWidth values. @stable ICU 2.2 */
420 UCHAR_EAST_ASIAN_WIDTH
=0x1004,
421 /** Enumerated property General_Category.
422 Same as u_charType, returns UCharCategory values. @stable ICU 2.2 */
423 UCHAR_GENERAL_CATEGORY
=0x1005,
424 /** Enumerated property Joining_Group.
425 Returns UJoiningGroup values. @stable ICU 2.2 */
426 UCHAR_JOINING_GROUP
=0x1006,
427 /** Enumerated property Joining_Type.
428 Returns UJoiningType values. @stable ICU 2.2 */
429 UCHAR_JOINING_TYPE
=0x1007,
430 /** Enumerated property Line_Break.
431 Returns ULineBreak values. @stable ICU 2.2 */
432 UCHAR_LINE_BREAK
=0x1008,
433 /** Enumerated property Numeric_Type.
434 Returns UNumericType values. @stable ICU 2.2 */
435 UCHAR_NUMERIC_TYPE
=0x1009,
436 /** Enumerated property Script.
437 Same as uscript_getScript, returns UScriptCode values. @stable ICU 2.2 */
439 /** Enumerated property Hangul_Syllable_Type, new in Unicode 4.
440 Returns UHangulSyllableType values. @stable ICU 2.6 */
441 UCHAR_HANGUL_SYLLABLE_TYPE
=0x100B,
442 /** Enumerated property NFD_Quick_Check.
443 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
444 UCHAR_NFD_QUICK_CHECK
=0x100C,
445 /** Enumerated property NFKD_Quick_Check.
446 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
447 UCHAR_NFKD_QUICK_CHECK
=0x100D,
448 /** Enumerated property NFC_Quick_Check.
449 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
450 UCHAR_NFC_QUICK_CHECK
=0x100E,
451 /** Enumerated property NFKC_Quick_Check.
452 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
453 UCHAR_NFKC_QUICK_CHECK
=0x100F,
454 /** Enumerated property Lead_Canonical_Combining_Class.
455 ICU-specific property for the ccc of the first code point
456 of the decomposition, or lccc(c)=ccc(NFD(c)[0]).
457 Useful for checking for canonically ordered text;
458 see UNORM_FCD and http://www.unicode.org/notes/tn5/#FCD .
459 Returns 8-bit numeric values like UCHAR_CANONICAL_COMBINING_CLASS. @stable ICU 3.0 */
460 UCHAR_LEAD_CANONICAL_COMBINING_CLASS
=0x1010,
461 /** Enumerated property Trail_Canonical_Combining_Class.
462 ICU-specific property for the ccc of the last code point
463 of the decomposition, or tccc(c)=ccc(NFD(c)[last]).
464 Useful for checking for canonically ordered text;
465 see UNORM_FCD and http://www.unicode.org/notes/tn5/#FCD .
466 Returns 8-bit numeric values like UCHAR_CANONICAL_COMBINING_CLASS. @stable ICU 3.0 */
467 UCHAR_TRAIL_CANONICAL_COMBINING_CLASS
=0x1011,
468 /** Enumerated property Grapheme_Cluster_Break (new in Unicode 4.1).
469 Used in UAX #29: Text Boundaries
470 (http://www.unicode.org/reports/tr29/)
471 Returns UGraphemeClusterBreak values. @stable ICU 3.4 */
472 UCHAR_GRAPHEME_CLUSTER_BREAK
=0x1012,
473 /** Enumerated property Sentence_Break (new in Unicode 4.1).
474 Used in UAX #29: Text Boundaries
475 (http://www.unicode.org/reports/tr29/)
476 Returns USentenceBreak values. @stable ICU 3.4 */
477 UCHAR_SENTENCE_BREAK
=0x1013,
478 /** Enumerated property Word_Break (new in Unicode 4.1).
479 Used in UAX #29: Text Boundaries
480 (http://www.unicode.org/reports/tr29/)
481 Returns UWordBreakValues values. @stable ICU 3.4 */
482 UCHAR_WORD_BREAK
=0x1014,
483 /** One more than the last constant for enumerated/integer Unicode properties. @stable ICU 2.2 */
484 UCHAR_INT_LIMIT
=0x1015,
486 /** Bitmask property General_Category_Mask.
487 This is the General_Category property returned as a bit mask.
488 When used in u_getIntPropertyValue(c), same as U_MASK(u_charType(c)),
489 returns bit masks for UCharCategory values where exactly one bit is set.
490 When used with u_getPropertyValueName() and u_getPropertyValueEnum(),
491 a multi-bit mask is used for sets of categories like "Letters".
492 Mask values should be cast to uint32_t.
494 UCHAR_GENERAL_CATEGORY_MASK
=0x2000,
495 /** First constant for bit-mask Unicode properties. @stable ICU 2.4 */
496 UCHAR_MASK_START
=UCHAR_GENERAL_CATEGORY_MASK
,
497 /** One more than the last constant for bit-mask Unicode properties. @stable ICU 2.4 */
498 UCHAR_MASK_LIMIT
=0x2001,
500 /** Double property Numeric_Value.
501 Corresponds to u_getNumericValue. @stable ICU 2.4 */
502 UCHAR_NUMERIC_VALUE
=0x3000,
503 /** First constant for double Unicode properties. @stable ICU 2.4 */
504 UCHAR_DOUBLE_START
=UCHAR_NUMERIC_VALUE
,
505 /** One more than the last constant for double Unicode properties. @stable ICU 2.4 */
506 UCHAR_DOUBLE_LIMIT
=0x3001,
508 /** String property Age.
509 Corresponds to u_charAge. @stable ICU 2.4 */
511 /** First constant for string Unicode properties. @stable ICU 2.4 */
512 UCHAR_STRING_START
=UCHAR_AGE
,
513 /** String property Bidi_Mirroring_Glyph.
514 Corresponds to u_charMirror. @stable ICU 2.4 */
515 UCHAR_BIDI_MIRRORING_GLYPH
=0x4001,
516 /** String property Case_Folding.
517 Corresponds to u_strFoldCase in ustring.h. @stable ICU 2.4 */
518 UCHAR_CASE_FOLDING
=0x4002,
519 /** Deprecated string property ISO_Comment.
520 Corresponds to u_getISOComment. @deprecated ICU 49 */
521 UCHAR_ISO_COMMENT
=0x4003,
522 /** String property Lowercase_Mapping.
523 Corresponds to u_strToLower in ustring.h. @stable ICU 2.4 */
524 UCHAR_LOWERCASE_MAPPING
=0x4004,
525 /** String property Name.
526 Corresponds to u_charName. @stable ICU 2.4 */
528 /** String property Simple_Case_Folding.
529 Corresponds to u_foldCase. @stable ICU 2.4 */
530 UCHAR_SIMPLE_CASE_FOLDING
=0x4006,
531 /** String property Simple_Lowercase_Mapping.
532 Corresponds to u_tolower. @stable ICU 2.4 */
533 UCHAR_SIMPLE_LOWERCASE_MAPPING
=0x4007,
534 /** String property Simple_Titlecase_Mapping.
535 Corresponds to u_totitle. @stable ICU 2.4 */
536 UCHAR_SIMPLE_TITLECASE_MAPPING
=0x4008,
537 /** String property Simple_Uppercase_Mapping.
538 Corresponds to u_toupper. @stable ICU 2.4 */
539 UCHAR_SIMPLE_UPPERCASE_MAPPING
=0x4009,
540 /** String property Titlecase_Mapping.
541 Corresponds to u_strToTitle in ustring.h. @stable ICU 2.4 */
542 UCHAR_TITLECASE_MAPPING
=0x400A,
543 /** String property Unicode_1_Name.
544 This property is of little practical value.
545 Beginning with ICU 49, ICU APIs return an empty string for this property.
546 Corresponds to u_charName(U_UNICODE_10_CHAR_NAME). @deprecated ICU 49 */
547 UCHAR_UNICODE_1_NAME
=0x400B,
548 /** String property Uppercase_Mapping.
549 Corresponds to u_strToUpper in ustring.h. @stable ICU 2.4 */
550 UCHAR_UPPERCASE_MAPPING
=0x400C,
551 /** One more than the last constant for string Unicode properties. @stable ICU 2.4 */
552 UCHAR_STRING_LIMIT
=0x400D,
554 #ifndef U_HIDE_DRAFT_API
555 /** Provisional property Script_Extensions (new in Unicode 6.0).
556 As a provisional property, it may be modified or removed
557 in future versions of the Unicode Standard, and thus in ICU.
558 Some characters are commonly used in multiple scripts.
559 For more information, see UAX #24: http://www.unicode.org/reports/tr24/.
560 Corresponds to uscript_hasScript and uscript_getScriptExtensions in uscript.h.
562 UCHAR_SCRIPT_EXTENSIONS
=0x7000,
563 /** First constant for Unicode properties with unusual value types. @draft ICU 4.6 */
564 UCHAR_OTHER_PROPERTY_START
=UCHAR_SCRIPT_EXTENSIONS
,
565 /** One more than the last constant for Unicode properties with unusual value types.
567 UCHAR_OTHER_PROPERTY_LIMIT
=0x7001,
568 #endif /* U_HIDE_DRAFT_API */
570 /** Represents a nonexistent or invalid property or property value. @stable ICU 2.4 */
571 UCHAR_INVALID_CODE
= -1
575 * Data for enumerated Unicode general category types.
576 * See http://www.unicode.org/Public/UNIDATA/UnicodeData.html .
579 typedef enum UCharCategory
582 * Note: UCharCategory constants and their API comments are parsed by preparseucd.py.
583 * It matches pairs of lines like
584 * / ** <Unicode 2-letter General_Category value> comment... * /
585 * U_<[A-Z_]+> = <integer>,
588 /** Non-category for unassigned and non-character code points. @stable ICU 2.0 */
590 /** Cn "Other, Not Assigned (no characters in [UnicodeData.txt] have this property)" (same as U_UNASSIGNED!) @stable ICU 2.0 */
591 U_GENERAL_OTHER_TYPES
= 0,
592 /** Lu @stable ICU 2.0 */
593 U_UPPERCASE_LETTER
= 1,
594 /** Ll @stable ICU 2.0 */
595 U_LOWERCASE_LETTER
= 2,
596 /** Lt @stable ICU 2.0 */
597 U_TITLECASE_LETTER
= 3,
598 /** Lm @stable ICU 2.0 */
599 U_MODIFIER_LETTER
= 4,
600 /** Lo @stable ICU 2.0 */
602 /** Mn @stable ICU 2.0 */
603 U_NON_SPACING_MARK
= 6,
604 /** Me @stable ICU 2.0 */
605 U_ENCLOSING_MARK
= 7,
606 /** Mc @stable ICU 2.0 */
607 U_COMBINING_SPACING_MARK
= 8,
608 /** Nd @stable ICU 2.0 */
609 U_DECIMAL_DIGIT_NUMBER
= 9,
610 /** Nl @stable ICU 2.0 */
611 U_LETTER_NUMBER
= 10,
612 /** No @stable ICU 2.0 */
614 /** Zs @stable ICU 2.0 */
615 U_SPACE_SEPARATOR
= 12,
616 /** Zl @stable ICU 2.0 */
617 U_LINE_SEPARATOR
= 13,
618 /** Zp @stable ICU 2.0 */
619 U_PARAGRAPH_SEPARATOR
= 14,
620 /** Cc @stable ICU 2.0 */
622 /** Cf @stable ICU 2.0 */
624 /** Co @stable ICU 2.0 */
625 U_PRIVATE_USE_CHAR
= 17,
626 /** Cs @stable ICU 2.0 */
628 /** Pd @stable ICU 2.0 */
629 U_DASH_PUNCTUATION
= 19,
630 /** Ps @stable ICU 2.0 */
631 U_START_PUNCTUATION
= 20,
632 /** Pe @stable ICU 2.0 */
633 U_END_PUNCTUATION
= 21,
634 /** Pc @stable ICU 2.0 */
635 U_CONNECTOR_PUNCTUATION
= 22,
636 /** Po @stable ICU 2.0 */
637 U_OTHER_PUNCTUATION
= 23,
638 /** Sm @stable ICU 2.0 */
640 /** Sc @stable ICU 2.0 */
641 U_CURRENCY_SYMBOL
= 25,
642 /** Sk @stable ICU 2.0 */
643 U_MODIFIER_SYMBOL
= 26,
644 /** So @stable ICU 2.0 */
646 /** Pi @stable ICU 2.0 */
647 U_INITIAL_PUNCTUATION
= 28,
648 /** Pf @stable ICU 2.0 */
649 U_FINAL_PUNCTUATION
= 29,
650 /** One higher than the last enum UCharCategory constant. @stable ICU 2.0 */
651 U_CHAR_CATEGORY_COUNT
655 * U_GC_XX_MASK constants are bit flags corresponding to Unicode
656 * general category values.
657 * For each category, the nth bit is set if the numeric value of the
658 * corresponding UCharCategory constant is n.
660 * There are also some U_GC_Y_MASK constants for groups of general categories
661 * like L for all letter categories.
668 #define U_GC_CN_MASK U_MASK(U_GENERAL_OTHER_TYPES)
670 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
671 #define U_GC_LU_MASK U_MASK(U_UPPERCASE_LETTER)
672 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
673 #define U_GC_LL_MASK U_MASK(U_LOWERCASE_LETTER)
674 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
675 #define U_GC_LT_MASK U_MASK(U_TITLECASE_LETTER)
676 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
677 #define U_GC_LM_MASK U_MASK(U_MODIFIER_LETTER)
678 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
679 #define U_GC_LO_MASK U_MASK(U_OTHER_LETTER)
681 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
682 #define U_GC_MN_MASK U_MASK(U_NON_SPACING_MARK)
683 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
684 #define U_GC_ME_MASK U_MASK(U_ENCLOSING_MARK)
685 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
686 #define U_GC_MC_MASK U_MASK(U_COMBINING_SPACING_MARK)
688 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
689 #define U_GC_ND_MASK U_MASK(U_DECIMAL_DIGIT_NUMBER)
690 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
691 #define U_GC_NL_MASK U_MASK(U_LETTER_NUMBER)
692 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
693 #define U_GC_NO_MASK U_MASK(U_OTHER_NUMBER)
695 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
696 #define U_GC_ZS_MASK U_MASK(U_SPACE_SEPARATOR)
697 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
698 #define U_GC_ZL_MASK U_MASK(U_LINE_SEPARATOR)
699 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
700 #define U_GC_ZP_MASK U_MASK(U_PARAGRAPH_SEPARATOR)
702 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
703 #define U_GC_CC_MASK U_MASK(U_CONTROL_CHAR)
704 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
705 #define U_GC_CF_MASK U_MASK(U_FORMAT_CHAR)
706 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
707 #define U_GC_CO_MASK U_MASK(U_PRIVATE_USE_CHAR)
708 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
709 #define U_GC_CS_MASK U_MASK(U_SURROGATE)
711 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
712 #define U_GC_PD_MASK U_MASK(U_DASH_PUNCTUATION)
713 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
714 #define U_GC_PS_MASK U_MASK(U_START_PUNCTUATION)
715 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
716 #define U_GC_PE_MASK U_MASK(U_END_PUNCTUATION)
717 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
718 #define U_GC_PC_MASK U_MASK(U_CONNECTOR_PUNCTUATION)
719 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
720 #define U_GC_PO_MASK U_MASK(U_OTHER_PUNCTUATION)
722 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
723 #define U_GC_SM_MASK U_MASK(U_MATH_SYMBOL)
724 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
725 #define U_GC_SC_MASK U_MASK(U_CURRENCY_SYMBOL)
726 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
727 #define U_GC_SK_MASK U_MASK(U_MODIFIER_SYMBOL)
728 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
729 #define U_GC_SO_MASK U_MASK(U_OTHER_SYMBOL)
731 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
732 #define U_GC_PI_MASK U_MASK(U_INITIAL_PUNCTUATION)
733 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
734 #define U_GC_PF_MASK U_MASK(U_FINAL_PUNCTUATION)
737 /** Mask constant for multiple UCharCategory bits (L Letters). @stable ICU 2.1 */
738 #define U_GC_L_MASK \
739 (U_GC_LU_MASK|U_GC_LL_MASK|U_GC_LT_MASK|U_GC_LM_MASK|U_GC_LO_MASK)
741 /** Mask constant for multiple UCharCategory bits (LC Cased Letters). @stable ICU 2.1 */
742 #define U_GC_LC_MASK \
743 (U_GC_LU_MASK|U_GC_LL_MASK|U_GC_LT_MASK)
745 /** Mask constant for multiple UCharCategory bits (M Marks). @stable ICU 2.1 */
746 #define U_GC_M_MASK (U_GC_MN_MASK|U_GC_ME_MASK|U_GC_MC_MASK)
748 /** Mask constant for multiple UCharCategory bits (N Numbers). @stable ICU 2.1 */
749 #define U_GC_N_MASK (U_GC_ND_MASK|U_GC_NL_MASK|U_GC_NO_MASK)
751 /** Mask constant for multiple UCharCategory bits (Z Separators). @stable ICU 2.1 */
752 #define U_GC_Z_MASK (U_GC_ZS_MASK|U_GC_ZL_MASK|U_GC_ZP_MASK)
754 /** Mask constant for multiple UCharCategory bits (C Others). @stable ICU 2.1 */
755 #define U_GC_C_MASK \
756 (U_GC_CN_MASK|U_GC_CC_MASK|U_GC_CF_MASK|U_GC_CO_MASK|U_GC_CS_MASK)
758 /** Mask constant for multiple UCharCategory bits (P Punctuation). @stable ICU 2.1 */
759 #define U_GC_P_MASK \
760 (U_GC_PD_MASK|U_GC_PS_MASK|U_GC_PE_MASK|U_GC_PC_MASK|U_GC_PO_MASK| \
761 U_GC_PI_MASK|U_GC_PF_MASK)
763 /** Mask constant for multiple UCharCategory bits (S Symbols). @stable ICU 2.1 */
764 #define U_GC_S_MASK (U_GC_SM_MASK|U_GC_SC_MASK|U_GC_SK_MASK|U_GC_SO_MASK)
767 * This specifies the language directional property of a character set.
770 typedef enum UCharDirection
{
772 * Note: UCharDirection constants and their API comments are parsed by preparseucd.py.
773 * It matches pairs of lines like
774 * / ** <Unicode 1..3-letter Bidi_Class value> comment... * /
775 * U_<[A-Z_]+> = <integer>,
778 /** L @stable ICU 2.0 */
780 /** R @stable ICU 2.0 */
782 /** EN @stable ICU 2.0 */
783 U_EUROPEAN_NUMBER
= 2,
784 /** ES @stable ICU 2.0 */
785 U_EUROPEAN_NUMBER_SEPARATOR
= 3,
786 /** ET @stable ICU 2.0 */
787 U_EUROPEAN_NUMBER_TERMINATOR
= 4,
788 /** AN @stable ICU 2.0 */
790 /** CS @stable ICU 2.0 */
791 U_COMMON_NUMBER_SEPARATOR
= 6,
792 /** B @stable ICU 2.0 */
793 U_BLOCK_SEPARATOR
= 7,
794 /** S @stable ICU 2.0 */
795 U_SEGMENT_SEPARATOR
= 8,
796 /** WS @stable ICU 2.0 */
797 U_WHITE_SPACE_NEUTRAL
= 9,
798 /** ON @stable ICU 2.0 */
799 U_OTHER_NEUTRAL
= 10,
800 /** LRE @stable ICU 2.0 */
801 U_LEFT_TO_RIGHT_EMBEDDING
= 11,
802 /** LRO @stable ICU 2.0 */
803 U_LEFT_TO_RIGHT_OVERRIDE
= 12,
804 /** AL @stable ICU 2.0 */
805 U_RIGHT_TO_LEFT_ARABIC
= 13,
806 /** RLE @stable ICU 2.0 */
807 U_RIGHT_TO_LEFT_EMBEDDING
= 14,
808 /** RLO @stable ICU 2.0 */
809 U_RIGHT_TO_LEFT_OVERRIDE
= 15,
810 /** PDF @stable ICU 2.0 */
811 U_POP_DIRECTIONAL_FORMAT
= 16,
812 /** NSM @stable ICU 2.0 */
813 U_DIR_NON_SPACING_MARK
= 17,
814 /** BN @stable ICU 2.0 */
815 U_BOUNDARY_NEUTRAL
= 18,
816 /** @stable ICU 2.0 */
817 U_CHAR_DIRECTION_COUNT
821 * Constants for Unicode blocks, see the Unicode Data file Blocks.txt
826 * Note: UBlockCode constants are parsed by preparseucd.py.
827 * It matches lines like
828 * UBLOCK_<Unicode Block value name> = <integer>,
831 /** New No_Block value in Unicode 4. @stable ICU 2.6 */
832 UBLOCK_NO_BLOCK
= 0, /*[none]*/ /* Special range indicating No_Block */
834 /** @stable ICU 2.0 */
835 UBLOCK_BASIC_LATIN
= 1, /*[0000]*/
837 /** @stable ICU 2.0 */
838 UBLOCK_LATIN_1_SUPPLEMENT
=2, /*[0080]*/
840 /** @stable ICU 2.0 */
841 UBLOCK_LATIN_EXTENDED_A
=3, /*[0100]*/
843 /** @stable ICU 2.0 */
844 UBLOCK_LATIN_EXTENDED_B
=4, /*[0180]*/
846 /** @stable ICU 2.0 */
847 UBLOCK_IPA_EXTENSIONS
=5, /*[0250]*/
849 /** @stable ICU 2.0 */
850 UBLOCK_SPACING_MODIFIER_LETTERS
=6, /*[02B0]*/
852 /** @stable ICU 2.0 */
853 UBLOCK_COMBINING_DIACRITICAL_MARKS
=7, /*[0300]*/
856 * Unicode 3.2 renames this block to "Greek and Coptic".
859 UBLOCK_GREEK
=8, /*[0370]*/
861 /** @stable ICU 2.0 */
862 UBLOCK_CYRILLIC
=9, /*[0400]*/
864 /** @stable ICU 2.0 */
865 UBLOCK_ARMENIAN
=10, /*[0530]*/
867 /** @stable ICU 2.0 */
868 UBLOCK_HEBREW
=11, /*[0590]*/
870 /** @stable ICU 2.0 */
871 UBLOCK_ARABIC
=12, /*[0600]*/
873 /** @stable ICU 2.0 */
874 UBLOCK_SYRIAC
=13, /*[0700]*/
876 /** @stable ICU 2.0 */
877 UBLOCK_THAANA
=14, /*[0780]*/
879 /** @stable ICU 2.0 */
880 UBLOCK_DEVANAGARI
=15, /*[0900]*/
882 /** @stable ICU 2.0 */
883 UBLOCK_BENGALI
=16, /*[0980]*/
885 /** @stable ICU 2.0 */
886 UBLOCK_GURMUKHI
=17, /*[0A00]*/
888 /** @stable ICU 2.0 */
889 UBLOCK_GUJARATI
=18, /*[0A80]*/
891 /** @stable ICU 2.0 */
892 UBLOCK_ORIYA
=19, /*[0B00]*/
894 /** @stable ICU 2.0 */
895 UBLOCK_TAMIL
=20, /*[0B80]*/
897 /** @stable ICU 2.0 */
898 UBLOCK_TELUGU
=21, /*[0C00]*/
900 /** @stable ICU 2.0 */
901 UBLOCK_KANNADA
=22, /*[0C80]*/
903 /** @stable ICU 2.0 */
904 UBLOCK_MALAYALAM
=23, /*[0D00]*/
906 /** @stable ICU 2.0 */
907 UBLOCK_SINHALA
=24, /*[0D80]*/
909 /** @stable ICU 2.0 */
910 UBLOCK_THAI
=25, /*[0E00]*/
912 /** @stable ICU 2.0 */
913 UBLOCK_LAO
=26, /*[0E80]*/
915 /** @stable ICU 2.0 */
916 UBLOCK_TIBETAN
=27, /*[0F00]*/
918 /** @stable ICU 2.0 */
919 UBLOCK_MYANMAR
=28, /*[1000]*/
921 /** @stable ICU 2.0 */
922 UBLOCK_GEORGIAN
=29, /*[10A0]*/
924 /** @stable ICU 2.0 */
925 UBLOCK_HANGUL_JAMO
=30, /*[1100]*/
927 /** @stable ICU 2.0 */
928 UBLOCK_ETHIOPIC
=31, /*[1200]*/
930 /** @stable ICU 2.0 */
931 UBLOCK_CHEROKEE
=32, /*[13A0]*/
933 /** @stable ICU 2.0 */
934 UBLOCK_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS
=33, /*[1400]*/
936 /** @stable ICU 2.0 */
937 UBLOCK_OGHAM
=34, /*[1680]*/
939 /** @stable ICU 2.0 */
940 UBLOCK_RUNIC
=35, /*[16A0]*/
942 /** @stable ICU 2.0 */
943 UBLOCK_KHMER
=36, /*[1780]*/
945 /** @stable ICU 2.0 */
946 UBLOCK_MONGOLIAN
=37, /*[1800]*/
948 /** @stable ICU 2.0 */
949 UBLOCK_LATIN_EXTENDED_ADDITIONAL
=38, /*[1E00]*/
951 /** @stable ICU 2.0 */
952 UBLOCK_GREEK_EXTENDED
=39, /*[1F00]*/
954 /** @stable ICU 2.0 */
955 UBLOCK_GENERAL_PUNCTUATION
=40, /*[2000]*/
957 /** @stable ICU 2.0 */
958 UBLOCK_SUPERSCRIPTS_AND_SUBSCRIPTS
=41, /*[2070]*/
960 /** @stable ICU 2.0 */
961 UBLOCK_CURRENCY_SYMBOLS
=42, /*[20A0]*/
964 * Unicode 3.2 renames this block to "Combining Diacritical Marks for Symbols".
967 UBLOCK_COMBINING_MARKS_FOR_SYMBOLS
=43, /*[20D0]*/
969 /** @stable ICU 2.0 */
970 UBLOCK_LETTERLIKE_SYMBOLS
=44, /*[2100]*/
972 /** @stable ICU 2.0 */
973 UBLOCK_NUMBER_FORMS
=45, /*[2150]*/
975 /** @stable ICU 2.0 */
976 UBLOCK_ARROWS
=46, /*[2190]*/
978 /** @stable ICU 2.0 */
979 UBLOCK_MATHEMATICAL_OPERATORS
=47, /*[2200]*/
981 /** @stable ICU 2.0 */
982 UBLOCK_MISCELLANEOUS_TECHNICAL
=48, /*[2300]*/
984 /** @stable ICU 2.0 */
985 UBLOCK_CONTROL_PICTURES
=49, /*[2400]*/
987 /** @stable ICU 2.0 */
988 UBLOCK_OPTICAL_CHARACTER_RECOGNITION
=50, /*[2440]*/
990 /** @stable ICU 2.0 */
991 UBLOCK_ENCLOSED_ALPHANUMERICS
=51, /*[2460]*/
993 /** @stable ICU 2.0 */
994 UBLOCK_BOX_DRAWING
=52, /*[2500]*/
996 /** @stable ICU 2.0 */
997 UBLOCK_BLOCK_ELEMENTS
=53, /*[2580]*/
999 /** @stable ICU 2.0 */
1000 UBLOCK_GEOMETRIC_SHAPES
=54, /*[25A0]*/
1002 /** @stable ICU 2.0 */
1003 UBLOCK_MISCELLANEOUS_SYMBOLS
=55, /*[2600]*/
1005 /** @stable ICU 2.0 */
1006 UBLOCK_DINGBATS
=56, /*[2700]*/
1008 /** @stable ICU 2.0 */
1009 UBLOCK_BRAILLE_PATTERNS
=57, /*[2800]*/
1011 /** @stable ICU 2.0 */
1012 UBLOCK_CJK_RADICALS_SUPPLEMENT
=58, /*[2E80]*/
1014 /** @stable ICU 2.0 */
1015 UBLOCK_KANGXI_RADICALS
=59, /*[2F00]*/
1017 /** @stable ICU 2.0 */
1018 UBLOCK_IDEOGRAPHIC_DESCRIPTION_CHARACTERS
=60, /*[2FF0]*/
1020 /** @stable ICU 2.0 */
1021 UBLOCK_CJK_SYMBOLS_AND_PUNCTUATION
=61, /*[3000]*/
1023 /** @stable ICU 2.0 */
1024 UBLOCK_HIRAGANA
=62, /*[3040]*/
1026 /** @stable ICU 2.0 */
1027 UBLOCK_KATAKANA
=63, /*[30A0]*/
1029 /** @stable ICU 2.0 */
1030 UBLOCK_BOPOMOFO
=64, /*[3100]*/
1032 /** @stable ICU 2.0 */
1033 UBLOCK_HANGUL_COMPATIBILITY_JAMO
=65, /*[3130]*/
1035 /** @stable ICU 2.0 */
1036 UBLOCK_KANBUN
=66, /*[3190]*/
1038 /** @stable ICU 2.0 */
1039 UBLOCK_BOPOMOFO_EXTENDED
=67, /*[31A0]*/
1041 /** @stable ICU 2.0 */
1042 UBLOCK_ENCLOSED_CJK_LETTERS_AND_MONTHS
=68, /*[3200]*/
1044 /** @stable ICU 2.0 */
1045 UBLOCK_CJK_COMPATIBILITY
=69, /*[3300]*/
1047 /** @stable ICU 2.0 */
1048 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A
=70, /*[3400]*/
1050 /** @stable ICU 2.0 */
1051 UBLOCK_CJK_UNIFIED_IDEOGRAPHS
=71, /*[4E00]*/
1053 /** @stable ICU 2.0 */
1054 UBLOCK_YI_SYLLABLES
=72, /*[A000]*/
1056 /** @stable ICU 2.0 */
1057 UBLOCK_YI_RADICALS
=73, /*[A490]*/
1059 /** @stable ICU 2.0 */
1060 UBLOCK_HANGUL_SYLLABLES
=74, /*[AC00]*/
1062 /** @stable ICU 2.0 */
1063 UBLOCK_HIGH_SURROGATES
=75, /*[D800]*/
1065 /** @stable ICU 2.0 */
1066 UBLOCK_HIGH_PRIVATE_USE_SURROGATES
=76, /*[DB80]*/
1068 /** @stable ICU 2.0 */
1069 UBLOCK_LOW_SURROGATES
=77, /*[DC00]*/
1072 * Same as UBLOCK_PRIVATE_USE.
1073 * Until Unicode 3.1.1, the corresponding block name was "Private Use",
1074 * and multiple code point ranges had this block.
1075 * Unicode 3.2 renames the block for the BMP PUA to "Private Use Area" and
1076 * adds separate blocks for the supplementary PUAs.
1080 UBLOCK_PRIVATE_USE_AREA
=78, /*[E000]*/
1082 * Same as UBLOCK_PRIVATE_USE_AREA.
1083 * Until Unicode 3.1.1, the corresponding block name was "Private Use",
1084 * and multiple code point ranges had this block.
1085 * Unicode 3.2 renames the block for the BMP PUA to "Private Use Area" and
1086 * adds separate blocks for the supplementary PUAs.
1090 UBLOCK_PRIVATE_USE
= UBLOCK_PRIVATE_USE_AREA
,
1092 /** @stable ICU 2.0 */
1093 UBLOCK_CJK_COMPATIBILITY_IDEOGRAPHS
=79, /*[F900]*/
1095 /** @stable ICU 2.0 */
1096 UBLOCK_ALPHABETIC_PRESENTATION_FORMS
=80, /*[FB00]*/
1098 /** @stable ICU 2.0 */
1099 UBLOCK_ARABIC_PRESENTATION_FORMS_A
=81, /*[FB50]*/
1101 /** @stable ICU 2.0 */
1102 UBLOCK_COMBINING_HALF_MARKS
=82, /*[FE20]*/
1104 /** @stable ICU 2.0 */
1105 UBLOCK_CJK_COMPATIBILITY_FORMS
=83, /*[FE30]*/
1107 /** @stable ICU 2.0 */
1108 UBLOCK_SMALL_FORM_VARIANTS
=84, /*[FE50]*/
1110 /** @stable ICU 2.0 */
1111 UBLOCK_ARABIC_PRESENTATION_FORMS_B
=85, /*[FE70]*/
1113 /** @stable ICU 2.0 */
1114 UBLOCK_SPECIALS
=86, /*[FFF0]*/
1116 /** @stable ICU 2.0 */
1117 UBLOCK_HALFWIDTH_AND_FULLWIDTH_FORMS
=87, /*[FF00]*/
1119 /* New blocks in Unicode 3.1 */
1121 /** @stable ICU 2.0 */
1122 UBLOCK_OLD_ITALIC
= 88, /*[10300]*/
1123 /** @stable ICU 2.0 */
1124 UBLOCK_GOTHIC
= 89, /*[10330]*/
1125 /** @stable ICU 2.0 */
1126 UBLOCK_DESERET
= 90, /*[10400]*/
1127 /** @stable ICU 2.0 */
1128 UBLOCK_BYZANTINE_MUSICAL_SYMBOLS
= 91, /*[1D000]*/
1129 /** @stable ICU 2.0 */
1130 UBLOCK_MUSICAL_SYMBOLS
= 92, /*[1D100]*/
1131 /** @stable ICU 2.0 */
1132 UBLOCK_MATHEMATICAL_ALPHANUMERIC_SYMBOLS
= 93, /*[1D400]*/
1133 /** @stable ICU 2.0 */
1134 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B
= 94, /*[20000]*/
1135 /** @stable ICU 2.0 */
1136 UBLOCK_CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT
= 95, /*[2F800]*/
1137 /** @stable ICU 2.0 */
1138 UBLOCK_TAGS
= 96, /*[E0000]*/
1140 /* New blocks in Unicode 3.2 */
1142 /** @stable ICU 3.0 */
1143 UBLOCK_CYRILLIC_SUPPLEMENT
= 97, /*[0500]*/
1145 * Unicode 4.0.1 renames the "Cyrillic Supplementary" block to "Cyrillic Supplement".
1148 UBLOCK_CYRILLIC_SUPPLEMENTARY
= UBLOCK_CYRILLIC_SUPPLEMENT
,
1149 /** @stable ICU 2.2 */
1150 UBLOCK_TAGALOG
= 98, /*[1700]*/
1151 /** @stable ICU 2.2 */
1152 UBLOCK_HANUNOO
= 99, /*[1720]*/
1153 /** @stable ICU 2.2 */
1154 UBLOCK_BUHID
= 100, /*[1740]*/
1155 /** @stable ICU 2.2 */
1156 UBLOCK_TAGBANWA
= 101, /*[1760]*/
1157 /** @stable ICU 2.2 */
1158 UBLOCK_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A
= 102, /*[27C0]*/
1159 /** @stable ICU 2.2 */
1160 UBLOCK_SUPPLEMENTAL_ARROWS_A
= 103, /*[27F0]*/
1161 /** @stable ICU 2.2 */
1162 UBLOCK_SUPPLEMENTAL_ARROWS_B
= 104, /*[2900]*/
1163 /** @stable ICU 2.2 */
1164 UBLOCK_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B
= 105, /*[2980]*/
1165 /** @stable ICU 2.2 */
1166 UBLOCK_SUPPLEMENTAL_MATHEMATICAL_OPERATORS
= 106, /*[2A00]*/
1167 /** @stable ICU 2.2 */
1168 UBLOCK_KATAKANA_PHONETIC_EXTENSIONS
= 107, /*[31F0]*/
1169 /** @stable ICU 2.2 */
1170 UBLOCK_VARIATION_SELECTORS
= 108, /*[FE00]*/
1171 /** @stable ICU 2.2 */
1172 UBLOCK_SUPPLEMENTARY_PRIVATE_USE_AREA_A
= 109, /*[F0000]*/
1173 /** @stable ICU 2.2 */
1174 UBLOCK_SUPPLEMENTARY_PRIVATE_USE_AREA_B
= 110, /*[100000]*/
1176 /* New blocks in Unicode 4 */
1178 /** @stable ICU 2.6 */
1179 UBLOCK_LIMBU
= 111, /*[1900]*/
1180 /** @stable ICU 2.6 */
1181 UBLOCK_TAI_LE
= 112, /*[1950]*/
1182 /** @stable ICU 2.6 */
1183 UBLOCK_KHMER_SYMBOLS
= 113, /*[19E0]*/
1184 /** @stable ICU 2.6 */
1185 UBLOCK_PHONETIC_EXTENSIONS
= 114, /*[1D00]*/
1186 /** @stable ICU 2.6 */
1187 UBLOCK_MISCELLANEOUS_SYMBOLS_AND_ARROWS
= 115, /*[2B00]*/
1188 /** @stable ICU 2.6 */
1189 UBLOCK_YIJING_HEXAGRAM_SYMBOLS
= 116, /*[4DC0]*/
1190 /** @stable ICU 2.6 */
1191 UBLOCK_LINEAR_B_SYLLABARY
= 117, /*[10000]*/
1192 /** @stable ICU 2.6 */
1193 UBLOCK_LINEAR_B_IDEOGRAMS
= 118, /*[10080]*/
1194 /** @stable ICU 2.6 */
1195 UBLOCK_AEGEAN_NUMBERS
= 119, /*[10100]*/
1196 /** @stable ICU 2.6 */
1197 UBLOCK_UGARITIC
= 120, /*[10380]*/
1198 /** @stable ICU 2.6 */
1199 UBLOCK_SHAVIAN
= 121, /*[10450]*/
1200 /** @stable ICU 2.6 */
1201 UBLOCK_OSMANYA
= 122, /*[10480]*/
1202 /** @stable ICU 2.6 */
1203 UBLOCK_CYPRIOT_SYLLABARY
= 123, /*[10800]*/
1204 /** @stable ICU 2.6 */
1205 UBLOCK_TAI_XUAN_JING_SYMBOLS
= 124, /*[1D300]*/
1206 /** @stable ICU 2.6 */
1207 UBLOCK_VARIATION_SELECTORS_SUPPLEMENT
= 125, /*[E0100]*/
1209 /* New blocks in Unicode 4.1 */
1211 /** @stable ICU 3.4 */
1212 UBLOCK_ANCIENT_GREEK_MUSICAL_NOTATION
= 126, /*[1D200]*/
1213 /** @stable ICU 3.4 */
1214 UBLOCK_ANCIENT_GREEK_NUMBERS
= 127, /*[10140]*/
1215 /** @stable ICU 3.4 */
1216 UBLOCK_ARABIC_SUPPLEMENT
= 128, /*[0750]*/
1217 /** @stable ICU 3.4 */
1218 UBLOCK_BUGINESE
= 129, /*[1A00]*/
1219 /** @stable ICU 3.4 */
1220 UBLOCK_CJK_STROKES
= 130, /*[31C0]*/
1221 /** @stable ICU 3.4 */
1222 UBLOCK_COMBINING_DIACRITICAL_MARKS_SUPPLEMENT
= 131, /*[1DC0]*/
1223 /** @stable ICU 3.4 */
1224 UBLOCK_COPTIC
= 132, /*[2C80]*/
1225 /** @stable ICU 3.4 */
1226 UBLOCK_ETHIOPIC_EXTENDED
= 133, /*[2D80]*/
1227 /** @stable ICU 3.4 */
1228 UBLOCK_ETHIOPIC_SUPPLEMENT
= 134, /*[1380]*/
1229 /** @stable ICU 3.4 */
1230 UBLOCK_GEORGIAN_SUPPLEMENT
= 135, /*[2D00]*/
1231 /** @stable ICU 3.4 */
1232 UBLOCK_GLAGOLITIC
= 136, /*[2C00]*/
1233 /** @stable ICU 3.4 */
1234 UBLOCK_KHAROSHTHI
= 137, /*[10A00]*/
1235 /** @stable ICU 3.4 */
1236 UBLOCK_MODIFIER_TONE_LETTERS
= 138, /*[A700]*/
1237 /** @stable ICU 3.4 */
1238 UBLOCK_NEW_TAI_LUE
= 139, /*[1980]*/
1239 /** @stable ICU 3.4 */
1240 UBLOCK_OLD_PERSIAN
= 140, /*[103A0]*/
1241 /** @stable ICU 3.4 */
1242 UBLOCK_PHONETIC_EXTENSIONS_SUPPLEMENT
= 141, /*[1D80]*/
1243 /** @stable ICU 3.4 */
1244 UBLOCK_SUPPLEMENTAL_PUNCTUATION
= 142, /*[2E00]*/
1245 /** @stable ICU 3.4 */
1246 UBLOCK_SYLOTI_NAGRI
= 143, /*[A800]*/
1247 /** @stable ICU 3.4 */
1248 UBLOCK_TIFINAGH
= 144, /*[2D30]*/
1249 /** @stable ICU 3.4 */
1250 UBLOCK_VERTICAL_FORMS
= 145, /*[FE10]*/
1252 /* New blocks in Unicode 5.0 */
1254 /** @stable ICU 3.6 */
1255 UBLOCK_NKO
= 146, /*[07C0]*/
1256 /** @stable ICU 3.6 */
1257 UBLOCK_BALINESE
= 147, /*[1B00]*/
1258 /** @stable ICU 3.6 */
1259 UBLOCK_LATIN_EXTENDED_C
= 148, /*[2C60]*/
1260 /** @stable ICU 3.6 */
1261 UBLOCK_LATIN_EXTENDED_D
= 149, /*[A720]*/
1262 /** @stable ICU 3.6 */
1263 UBLOCK_PHAGS_PA
= 150, /*[A840]*/
1264 /** @stable ICU 3.6 */
1265 UBLOCK_PHOENICIAN
= 151, /*[10900]*/
1266 /** @stable ICU 3.6 */
1267 UBLOCK_CUNEIFORM
= 152, /*[12000]*/
1268 /** @stable ICU 3.6 */
1269 UBLOCK_CUNEIFORM_NUMBERS_AND_PUNCTUATION
= 153, /*[12400]*/
1270 /** @stable ICU 3.6 */
1271 UBLOCK_COUNTING_ROD_NUMERALS
= 154, /*[1D360]*/
1273 /* New blocks in Unicode 5.1 */
1275 /** @stable ICU 4.0 */
1276 UBLOCK_SUNDANESE
= 155, /*[1B80]*/
1277 /** @stable ICU 4.0 */
1278 UBLOCK_LEPCHA
= 156, /*[1C00]*/
1279 /** @stable ICU 4.0 */
1280 UBLOCK_OL_CHIKI
= 157, /*[1C50]*/
1281 /** @stable ICU 4.0 */
1282 UBLOCK_CYRILLIC_EXTENDED_A
= 158, /*[2DE0]*/
1283 /** @stable ICU 4.0 */
1284 UBLOCK_VAI
= 159, /*[A500]*/
1285 /** @stable ICU 4.0 */
1286 UBLOCK_CYRILLIC_EXTENDED_B
= 160, /*[A640]*/
1287 /** @stable ICU 4.0 */
1288 UBLOCK_SAURASHTRA
= 161, /*[A880]*/
1289 /** @stable ICU 4.0 */
1290 UBLOCK_KAYAH_LI
= 162, /*[A900]*/
1291 /** @stable ICU 4.0 */
1292 UBLOCK_REJANG
= 163, /*[A930]*/
1293 /** @stable ICU 4.0 */
1294 UBLOCK_CHAM
= 164, /*[AA00]*/
1295 /** @stable ICU 4.0 */
1296 UBLOCK_ANCIENT_SYMBOLS
= 165, /*[10190]*/
1297 /** @stable ICU 4.0 */
1298 UBLOCK_PHAISTOS_DISC
= 166, /*[101D0]*/
1299 /** @stable ICU 4.0 */
1300 UBLOCK_LYCIAN
= 167, /*[10280]*/
1301 /** @stable ICU 4.0 */
1302 UBLOCK_CARIAN
= 168, /*[102A0]*/
1303 /** @stable ICU 4.0 */
1304 UBLOCK_LYDIAN
= 169, /*[10920]*/
1305 /** @stable ICU 4.0 */
1306 UBLOCK_MAHJONG_TILES
= 170, /*[1F000]*/
1307 /** @stable ICU 4.0 */
1308 UBLOCK_DOMINO_TILES
= 171, /*[1F030]*/
1310 /* New blocks in Unicode 5.2 */
1312 /** @stable ICU 4.4 */
1313 UBLOCK_SAMARITAN
= 172, /*[0800]*/
1314 /** @stable ICU 4.4 */
1315 UBLOCK_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS_EXTENDED
= 173, /*[18B0]*/
1316 /** @stable ICU 4.4 */
1317 UBLOCK_TAI_THAM
= 174, /*[1A20]*/
1318 /** @stable ICU 4.4 */
1319 UBLOCK_VEDIC_EXTENSIONS
= 175, /*[1CD0]*/
1320 /** @stable ICU 4.4 */
1321 UBLOCK_LISU
= 176, /*[A4D0]*/
1322 /** @stable ICU 4.4 */
1323 UBLOCK_BAMUM
= 177, /*[A6A0]*/
1324 /** @stable ICU 4.4 */
1325 UBLOCK_COMMON_INDIC_NUMBER_FORMS
= 178, /*[A830]*/
1326 /** @stable ICU 4.4 */
1327 UBLOCK_DEVANAGARI_EXTENDED
= 179, /*[A8E0]*/
1328 /** @stable ICU 4.4 */
1329 UBLOCK_HANGUL_JAMO_EXTENDED_A
= 180, /*[A960]*/
1330 /** @stable ICU 4.4 */
1331 UBLOCK_JAVANESE
= 181, /*[A980]*/
1332 /** @stable ICU 4.4 */
1333 UBLOCK_MYANMAR_EXTENDED_A
= 182, /*[AA60]*/
1334 /** @stable ICU 4.4 */
1335 UBLOCK_TAI_VIET
= 183, /*[AA80]*/
1336 /** @stable ICU 4.4 */
1337 UBLOCK_MEETEI_MAYEK
= 184, /*[ABC0]*/
1338 /** @stable ICU 4.4 */
1339 UBLOCK_HANGUL_JAMO_EXTENDED_B
= 185, /*[D7B0]*/
1340 /** @stable ICU 4.4 */
1341 UBLOCK_IMPERIAL_ARAMAIC
= 186, /*[10840]*/
1342 /** @stable ICU 4.4 */
1343 UBLOCK_OLD_SOUTH_ARABIAN
= 187, /*[10A60]*/
1344 /** @stable ICU 4.4 */
1345 UBLOCK_AVESTAN
= 188, /*[10B00]*/
1346 /** @stable ICU 4.4 */
1347 UBLOCK_INSCRIPTIONAL_PARTHIAN
= 189, /*[10B40]*/
1348 /** @stable ICU 4.4 */
1349 UBLOCK_INSCRIPTIONAL_PAHLAVI
= 190, /*[10B60]*/
1350 /** @stable ICU 4.4 */
1351 UBLOCK_OLD_TURKIC
= 191, /*[10C00]*/
1352 /** @stable ICU 4.4 */
1353 UBLOCK_RUMI_NUMERAL_SYMBOLS
= 192, /*[10E60]*/
1354 /** @stable ICU 4.4 */
1355 UBLOCK_KAITHI
= 193, /*[11080]*/
1356 /** @stable ICU 4.4 */
1357 UBLOCK_EGYPTIAN_HIEROGLYPHS
= 194, /*[13000]*/
1358 /** @stable ICU 4.4 */
1359 UBLOCK_ENCLOSED_ALPHANUMERIC_SUPPLEMENT
= 195, /*[1F100]*/
1360 /** @stable ICU 4.4 */
1361 UBLOCK_ENCLOSED_IDEOGRAPHIC_SUPPLEMENT
= 196, /*[1F200]*/
1362 /** @stable ICU 4.4 */
1363 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_C
= 197, /*[2A700]*/
1365 /* New blocks in Unicode 6.0 */
1367 /** @stable ICU 4.6 */
1368 UBLOCK_MANDAIC
= 198, /*[0840]*/
1369 /** @stable ICU 4.6 */
1370 UBLOCK_BATAK
= 199, /*[1BC0]*/
1371 /** @stable ICU 4.6 */
1372 UBLOCK_ETHIOPIC_EXTENDED_A
= 200, /*[AB00]*/
1373 /** @stable ICU 4.6 */
1374 UBLOCK_BRAHMI
= 201, /*[11000]*/
1375 /** @stable ICU 4.6 */
1376 UBLOCK_BAMUM_SUPPLEMENT
= 202, /*[16800]*/
1377 /** @stable ICU 4.6 */
1378 UBLOCK_KANA_SUPPLEMENT
= 203, /*[1B000]*/
1379 /** @stable ICU 4.6 */
1380 UBLOCK_PLAYING_CARDS
= 204, /*[1F0A0]*/
1381 /** @stable ICU 4.6 */
1382 UBLOCK_MISCELLANEOUS_SYMBOLS_AND_PICTOGRAPHS
= 205, /*[1F300]*/
1383 /** @stable ICU 4.6 */
1384 UBLOCK_EMOTICONS
= 206, /*[1F600]*/
1385 /** @stable ICU 4.6 */
1386 UBLOCK_TRANSPORT_AND_MAP_SYMBOLS
= 207, /*[1F680]*/
1387 /** @stable ICU 4.6 */
1388 UBLOCK_ALCHEMICAL_SYMBOLS
= 208, /*[1F700]*/
1389 /** @stable ICU 4.6 */
1390 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_D
= 209, /*[2B740]*/
1392 /* New blocks in Unicode 6.1 */
1394 /** @stable ICU 49 */
1395 UBLOCK_ARABIC_EXTENDED_A
= 210, /*[08A0]*/
1396 /** @stable ICU 49 */
1397 UBLOCK_ARABIC_MATHEMATICAL_ALPHABETIC_SYMBOLS
= 211, /*[1EE00]*/
1398 /** @stable ICU 49 */
1399 UBLOCK_CHAKMA
= 212, /*[11100]*/
1400 /** @stable ICU 49 */
1401 UBLOCK_MEETEI_MAYEK_EXTENSIONS
= 213, /*[AAE0]*/
1402 /** @stable ICU 49 */
1403 UBLOCK_MEROITIC_CURSIVE
= 214, /*[109A0]*/
1404 /** @stable ICU 49 */
1405 UBLOCK_MEROITIC_HIEROGLYPHS
= 215, /*[10980]*/
1406 /** @stable ICU 49 */
1407 UBLOCK_MIAO
= 216, /*[16F00]*/
1408 /** @stable ICU 49 */
1409 UBLOCK_SHARADA
= 217, /*[11180]*/
1410 /** @stable ICU 49 */
1411 UBLOCK_SORA_SOMPENG
= 218, /*[110D0]*/
1412 /** @stable ICU 49 */
1413 UBLOCK_SUNDANESE_SUPPLEMENT
= 219, /*[1CC0]*/
1414 /** @stable ICU 49 */
1415 UBLOCK_TAKRI
= 220, /*[11680]*/
1417 /** @stable ICU 2.0 */
1420 /** @stable ICU 2.0 */
1421 UBLOCK_INVALID_CODE
=-1
1424 /** @stable ICU 2.0 */
1425 typedef enum UBlockCode UBlockCode
;
1428 * East Asian Width constants.
1430 * @see UCHAR_EAST_ASIAN_WIDTH
1431 * @see u_getIntPropertyValue
1434 typedef enum UEastAsianWidth
{
1436 * Note: UEastAsianWidth constants are parsed by preparseucd.py.
1437 * It matches lines like
1438 * U_EA_<Unicode East_Asian_Width value name>
1441 U_EA_NEUTRAL
, /*[N]*/
1442 U_EA_AMBIGUOUS
, /*[A]*/
1443 U_EA_HALFWIDTH
, /*[H]*/
1444 U_EA_FULLWIDTH
, /*[F]*/
1445 U_EA_NARROW
, /*[Na]*/
1451 * Selector constants for u_charName().
1452 * u_charName() returns the "modern" name of a
1453 * Unicode character; or the name that was defined in
1454 * Unicode version 1.0, before the Unicode standard merged
1455 * with ISO-10646; or an "extended" name that gives each
1456 * Unicode code point a unique name.
1461 typedef enum UCharNameChoice
{
1462 /** Unicode character name (Name property). @stable ICU 2.0 */
1463 U_UNICODE_CHAR_NAME
,
1465 * The Unicode_1_Name property value which is of little practical value.
1466 * Beginning with ICU 49, ICU APIs return an empty string for this name choice.
1467 * @deprecated ICU 49
1469 U_UNICODE_10_CHAR_NAME
,
1470 /** Standard or synthetic character name. @stable ICU 2.0 */
1471 U_EXTENDED_CHAR_NAME
,
1472 /** Corrected name from NameAliases.txt. @stable ICU 4.4 */
1474 /** @stable ICU 2.0 */
1475 U_CHAR_NAME_CHOICE_COUNT
1479 * Selector constants for u_getPropertyName() and
1480 * u_getPropertyValueName(). These selectors are used to choose which
1481 * name is returned for a given property or value. All properties and
1482 * values have a long name. Most have a short name, but some do not.
1483 * Unicode allows for additional names, beyond the long and short
1484 * name, which would be indicated by U_LONG_PROPERTY_NAME + i, where
1487 * @see u_getPropertyName()
1488 * @see u_getPropertyValueName()
1491 typedef enum UPropertyNameChoice
{
1492 U_SHORT_PROPERTY_NAME
,
1493 U_LONG_PROPERTY_NAME
,
1494 U_PROPERTY_NAME_CHOICE_COUNT
1495 } UPropertyNameChoice
;
1498 * Decomposition Type constants.
1500 * @see UCHAR_DECOMPOSITION_TYPE
1503 typedef enum UDecompositionType
{
1505 * Note: UDecompositionType constants are parsed by preparseucd.py.
1506 * It matches lines like
1507 * U_DT_<Unicode Decomposition_Type value name>
1510 U_DT_NONE
, /*[none]*/
1511 U_DT_CANONICAL
, /*[can]*/
1512 U_DT_COMPAT
, /*[com]*/
1513 U_DT_CIRCLE
, /*[enc]*/
1514 U_DT_FINAL
, /*[fin]*/
1515 U_DT_FONT
, /*[font]*/
1516 U_DT_FRACTION
, /*[fra]*/
1517 U_DT_INITIAL
, /*[init]*/
1518 U_DT_ISOLATED
, /*[iso]*/
1519 U_DT_MEDIAL
, /*[med]*/
1520 U_DT_NARROW
, /*[nar]*/
1521 U_DT_NOBREAK
, /*[nb]*/
1522 U_DT_SMALL
, /*[sml]*/
1523 U_DT_SQUARE
, /*[sqr]*/
1525 U_DT_SUPER
, /*[sup]*/
1526 U_DT_VERTICAL
, /*[vert]*/
1527 U_DT_WIDE
, /*[wide]*/
1529 } UDecompositionType
;
1532 * Joining Type constants.
1534 * @see UCHAR_JOINING_TYPE
1537 typedef enum UJoiningType
{
1539 * Note: UJoiningType constants are parsed by preparseucd.py.
1540 * It matches lines like
1541 * U_JT_<Unicode Joining_Type value name>
1544 U_JT_NON_JOINING
, /*[U]*/
1545 U_JT_JOIN_CAUSING
, /*[C]*/
1546 U_JT_DUAL_JOINING
, /*[D]*/
1547 U_JT_LEFT_JOINING
, /*[L]*/
1548 U_JT_RIGHT_JOINING
, /*[R]*/
1549 U_JT_TRANSPARENT
, /*[T]*/
1554 * Joining Group constants.
1556 * @see UCHAR_JOINING_GROUP
1559 typedef enum UJoiningGroup
{
1561 * Note: UJoiningGroup constants are parsed by preparseucd.py.
1562 * It matches lines like
1563 * U_JG_<Unicode Joining_Group value name>
1566 U_JG_NO_JOINING_GROUP
,
1580 U_JG_TEH_MARBUTA_GOAL
, /**< @stable ICU 4.6 */
1581 U_JG_HAMZA_ON_HEH_GOAL
=U_JG_TEH_MARBUTA_GOAL
,
1618 U_JG_FE
, /**< @stable ICU 2.6 */
1619 U_JG_KHAPH
, /**< @stable ICU 2.6 */
1620 U_JG_ZHAIN
, /**< @stable ICU 2.6 */
1621 U_JG_BURUSHASKI_YEH_BARREE
, /**< @stable ICU 4.0 */
1622 U_JG_FARSI_YEH
, /**< @stable ICU 4.4 */
1623 U_JG_NYA
, /**< @stable ICU 4.4 */
1624 U_JG_ROHINGYA_YEH
, /**< @stable ICU 49 */
1629 * Grapheme Cluster Break constants.
1631 * @see UCHAR_GRAPHEME_CLUSTER_BREAK
1634 typedef enum UGraphemeClusterBreak
{
1636 * Note: UGraphemeClusterBreak constants are parsed by preparseucd.py.
1637 * It matches lines like
1638 * U_GCB_<Unicode Grapheme_Cluster_Break value name>
1641 U_GCB_OTHER
= 0, /*[XX]*/
1642 U_GCB_CONTROL
= 1, /*[CN]*/
1643 U_GCB_CR
= 2, /*[CR]*/
1644 U_GCB_EXTEND
= 3, /*[EX]*/
1645 U_GCB_L
= 4, /*[L]*/
1646 U_GCB_LF
= 5, /*[LF]*/
1647 U_GCB_LV
= 6, /*[LV]*/
1648 U_GCB_LVT
= 7, /*[LVT]*/
1649 U_GCB_T
= 8, /*[T]*/
1650 U_GCB_V
= 9, /*[V]*/
1651 U_GCB_SPACING_MARK
= 10, /*[SM]*/ /* from here on: new in Unicode 5.1/ICU 4.0 */
1652 U_GCB_PREPEND
= 11, /*[PP]*/
1654 } UGraphemeClusterBreak
;
1657 * Word Break constants.
1658 * (UWordBreak is a pre-existing enum type in ubrk.h for word break status tags.)
1660 * @see UCHAR_WORD_BREAK
1663 typedef enum UWordBreakValues
{
1665 * Note: UWordBreakValues constants are parsed by preparseucd.py.
1666 * It matches lines like
1667 * U_WB_<Unicode Word_Break value name>
1670 U_WB_OTHER
= 0, /*[XX]*/
1671 U_WB_ALETTER
= 1, /*[LE]*/
1672 U_WB_FORMAT
= 2, /*[FO]*/
1673 U_WB_KATAKANA
= 3, /*[KA]*/
1674 U_WB_MIDLETTER
= 4, /*[ML]*/
1675 U_WB_MIDNUM
= 5, /*[MN]*/
1676 U_WB_NUMERIC
= 6, /*[NU]*/
1677 U_WB_EXTENDNUMLET
= 7, /*[EX]*/
1678 U_WB_CR
= 8, /*[CR]*/ /* from here on: new in Unicode 5.1/ICU 4.0 */
1679 U_WB_EXTEND
= 9, /*[Extend]*/
1680 U_WB_LF
= 10, /*[LF]*/
1681 U_WB_MIDNUMLET
=11, /*[MB]*/
1682 U_WB_NEWLINE
=12, /*[NL]*/
1687 * Sentence Break constants.
1689 * @see UCHAR_SENTENCE_BREAK
1692 typedef enum USentenceBreak
{
1694 * Note: USentenceBreak constants are parsed by preparseucd.py.
1695 * It matches lines like
1696 * U_SB_<Unicode Sentence_Break value name>
1699 U_SB_OTHER
= 0, /*[XX]*/
1700 U_SB_ATERM
= 1, /*[AT]*/
1701 U_SB_CLOSE
= 2, /*[CL]*/
1702 U_SB_FORMAT
= 3, /*[FO]*/
1703 U_SB_LOWER
= 4, /*[LO]*/
1704 U_SB_NUMERIC
= 5, /*[NU]*/
1705 U_SB_OLETTER
= 6, /*[LE]*/
1706 U_SB_SEP
= 7, /*[SE]*/
1707 U_SB_SP
= 8, /*[SP]*/
1708 U_SB_STERM
= 9, /*[ST]*/
1709 U_SB_UPPER
= 10, /*[UP]*/
1710 U_SB_CR
= 11, /*[CR]*/ /* from here on: new in Unicode 5.1/ICU 4.0 */
1711 U_SB_EXTEND
= 12, /*[EX]*/
1712 U_SB_LF
= 13, /*[LF]*/
1713 U_SB_SCONTINUE
= 14, /*[SC]*/
1718 * Line Break constants.
1720 * @see UCHAR_LINE_BREAK
1723 typedef enum ULineBreak
{
1725 * Note: ULineBreak constants are parsed by preparseucd.py.
1726 * It matches lines like
1727 * U_LB_<Unicode Line_Break value name>
1730 U_LB_UNKNOWN
= 0, /*[XX]*/
1731 U_LB_AMBIGUOUS
= 1, /*[AI]*/
1732 U_LB_ALPHABETIC
= 2, /*[AL]*/
1733 U_LB_BREAK_BOTH
= 3, /*[B2]*/
1734 U_LB_BREAK_AFTER
= 4, /*[BA]*/
1735 U_LB_BREAK_BEFORE
= 5, /*[BB]*/
1736 U_LB_MANDATORY_BREAK
= 6, /*[BK]*/
1737 U_LB_CONTINGENT_BREAK
= 7, /*[CB]*/
1738 U_LB_CLOSE_PUNCTUATION
= 8, /*[CL]*/
1739 U_LB_COMBINING_MARK
= 9, /*[CM]*/
1740 U_LB_CARRIAGE_RETURN
= 10, /*[CR]*/
1741 U_LB_EXCLAMATION
= 11, /*[EX]*/
1742 U_LB_GLUE
= 12, /*[GL]*/
1743 U_LB_HYPHEN
= 13, /*[HY]*/
1744 U_LB_IDEOGRAPHIC
= 14, /*[ID]*/
1745 /** Renamed from the misspelled "inseperable" in Unicode 4.0.1/ICU 3.0 @stable ICU 3.0 */
1746 U_LB_INSEPARABLE
= 15, /*[IN]*/
1747 U_LB_INSEPERABLE
= U_LB_INSEPARABLE
,
1748 U_LB_INFIX_NUMERIC
= 16, /*[IS]*/
1749 U_LB_LINE_FEED
= 17, /*[LF]*/
1750 U_LB_NONSTARTER
= 18, /*[NS]*/
1751 U_LB_NUMERIC
= 19, /*[NU]*/
1752 U_LB_OPEN_PUNCTUATION
= 20, /*[OP]*/
1753 U_LB_POSTFIX_NUMERIC
= 21, /*[PO]*/
1754 U_LB_PREFIX_NUMERIC
= 22, /*[PR]*/
1755 U_LB_QUOTATION
= 23, /*[QU]*/
1756 U_LB_COMPLEX_CONTEXT
= 24, /*[SA]*/
1757 U_LB_SURROGATE
= 25, /*[SG]*/
1758 U_LB_SPACE
= 26, /*[SP]*/
1759 U_LB_BREAK_SYMBOLS
= 27, /*[SY]*/
1760 U_LB_ZWSPACE
= 28, /*[ZW]*/
1761 U_LB_NEXT_LINE
= 29, /*[NL]*/ /* from here on: new in Unicode 4/ICU 2.6 */
1762 U_LB_WORD_JOINER
= 30, /*[WJ]*/
1763 U_LB_H2
= 31, /*[H2]*/ /* from here on: new in Unicode 4.1/ICU 3.4 */
1764 U_LB_H3
= 32, /*[H3]*/
1765 U_LB_JL
= 33, /*[JL]*/
1766 U_LB_JT
= 34, /*[JT]*/
1767 U_LB_JV
= 35, /*[JV]*/
1768 U_LB_CLOSE_PARENTHESIS
= 36, /*[CP]*/ /* new in Unicode 5.2/ICU 4.4 */
1769 U_LB_CONDITIONAL_JAPANESE_STARTER
= 37,/*[CJ]*/ /* new in Unicode 6.1/ICU 49 */
1770 U_LB_HEBREW_LETTER
= 38, /*[HL]*/ /* new in Unicode 6.1/ICU 49 */
1775 * Numeric Type constants.
1777 * @see UCHAR_NUMERIC_TYPE
1780 typedef enum UNumericType
{
1782 * Note: UNumericType constants are parsed by preparseucd.py.
1783 * It matches lines like
1784 * U_NT_<Unicode Numeric_Type value name>
1787 U_NT_NONE
, /*[None]*/
1788 U_NT_DECIMAL
, /*[de]*/
1789 U_NT_DIGIT
, /*[di]*/
1790 U_NT_NUMERIC
, /*[nu]*/
1795 * Hangul Syllable Type constants.
1797 * @see UCHAR_HANGUL_SYLLABLE_TYPE
1800 typedef enum UHangulSyllableType
{
1802 * Note: UHangulSyllableType constants are parsed by preparseucd.py.
1803 * It matches lines like
1804 * U_HST_<Unicode Hangul_Syllable_Type value name>
1807 U_HST_NOT_APPLICABLE
, /*[NA]*/
1808 U_HST_LEADING_JAMO
, /*[L]*/
1809 U_HST_VOWEL_JAMO
, /*[V]*/
1810 U_HST_TRAILING_JAMO
, /*[T]*/
1811 U_HST_LV_SYLLABLE
, /*[LV]*/
1812 U_HST_LVT_SYLLABLE
, /*[LVT]*/
1814 } UHangulSyllableType
;
1817 * Check a binary Unicode property for a code point.
1819 * Unicode, especially in version 3.2, defines many more properties than the
1820 * original set in UnicodeData.txt.
1822 * The properties APIs are intended to reflect Unicode properties as defined
1823 * in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).
1824 * For details about the properties see http://www.unicode.org/ucd/ .
1825 * For names of Unicode properties see the UCD file PropertyAliases.txt.
1827 * Important: If ICU is built with UCD files from Unicode versions below 3.2,
1828 * then properties marked with "new in Unicode 3.2" are not or not fully available.
1830 * @param c Code point to test.
1831 * @param which UProperty selector constant, identifies which binary property to check.
1832 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT.
1833 * @return TRUE or FALSE according to the binary Unicode property value for c.
1834 * Also FALSE if 'which' is out of bounds or if the Unicode version
1835 * does not have data for the property at all, or not for this code point.
1838 * @see u_getIntPropertyValue
1839 * @see u_getUnicodeVersion
1842 U_STABLE UBool U_EXPORT2
1843 u_hasBinaryProperty(UChar32 c
, UProperty which
);
1846 * Check if a code point has the Alphabetic Unicode property.
1847 * Same as u_hasBinaryProperty(c, UCHAR_ALPHABETIC).
1848 * This is different from u_isalpha!
1849 * @param c Code point to test
1850 * @return true if the code point has the Alphabetic Unicode property, false otherwise
1852 * @see UCHAR_ALPHABETIC
1854 * @see u_hasBinaryProperty
1857 U_STABLE UBool U_EXPORT2
1858 u_isUAlphabetic(UChar32 c
);
1861 * Check if a code point has the Lowercase Unicode property.
1862 * Same as u_hasBinaryProperty(c, UCHAR_LOWERCASE).
1863 * This is different from u_islower!
1864 * @param c Code point to test
1865 * @return true if the code point has the Lowercase Unicode property, false otherwise
1867 * @see UCHAR_LOWERCASE
1869 * @see u_hasBinaryProperty
1872 U_STABLE UBool U_EXPORT2
1873 u_isULowercase(UChar32 c
);
1876 * Check if a code point has the Uppercase Unicode property.
1877 * Same as u_hasBinaryProperty(c, UCHAR_UPPERCASE).
1878 * This is different from u_isupper!
1879 * @param c Code point to test
1880 * @return true if the code point has the Uppercase Unicode property, false otherwise
1882 * @see UCHAR_UPPERCASE
1884 * @see u_hasBinaryProperty
1887 U_STABLE UBool U_EXPORT2
1888 u_isUUppercase(UChar32 c
);
1891 * Check if a code point has the White_Space Unicode property.
1892 * Same as u_hasBinaryProperty(c, UCHAR_WHITE_SPACE).
1893 * This is different from both u_isspace and u_isWhitespace!
1895 * Note: There are several ICU whitespace functions; please see the uchar.h
1896 * file documentation for a detailed comparison.
1898 * @param c Code point to test
1899 * @return true if the code point has the White_Space Unicode property, false otherwise.
1901 * @see UCHAR_WHITE_SPACE
1902 * @see u_isWhitespace
1904 * @see u_isJavaSpaceChar
1905 * @see u_hasBinaryProperty
1908 U_STABLE UBool U_EXPORT2
1909 u_isUWhiteSpace(UChar32 c
);
1912 * Get the property value for an enumerated or integer Unicode property for a code point.
1913 * Also returns binary and mask property values.
1915 * Unicode, especially in version 3.2, defines many more properties than the
1916 * original set in UnicodeData.txt.
1918 * The properties APIs are intended to reflect Unicode properties as defined
1919 * in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).
1920 * For details about the properties see http://www.unicode.org/ .
1921 * For names of Unicode properties see the UCD file PropertyAliases.txt.
1924 * UEastAsianWidth ea=(UEastAsianWidth)u_getIntPropertyValue(c, UCHAR_EAST_ASIAN_WIDTH);
1925 * UBool b=(UBool)u_getIntPropertyValue(c, UCHAR_IDEOGRAPHIC);
1927 * @param c Code point to test.
1928 * @param which UProperty selector constant, identifies which property to check.
1929 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
1930 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT
1931 * or UCHAR_MASK_START<=which<UCHAR_MASK_LIMIT.
1932 * @return Numeric value that is directly the property value or,
1933 * for enumerated properties, corresponds to the numeric value of the enumerated
1934 * constant of the respective property value enumeration type
1935 * (cast to enum type if necessary).
1936 * Returns 0 or 1 (for FALSE/TRUE) for binary Unicode properties.
1937 * Returns a bit-mask for mask properties.
1938 * Returns 0 if 'which' is out of bounds or if the Unicode version
1939 * does not have data for the property at all, or not for this code point.
1942 * @see u_hasBinaryProperty
1943 * @see u_getIntPropertyMinValue
1944 * @see u_getIntPropertyMaxValue
1945 * @see u_getUnicodeVersion
1948 U_STABLE
int32_t U_EXPORT2
1949 u_getIntPropertyValue(UChar32 c
, UProperty which
);
1952 * Get the minimum value for an enumerated/integer/binary Unicode property.
1953 * Can be used together with u_getIntPropertyMaxValue
1954 * to allocate arrays of UnicodeSet or similar.
1956 * @param which UProperty selector constant, identifies which binary property to check.
1957 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
1958 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT.
1959 * @return Minimum value returned by u_getIntPropertyValue for a Unicode property.
1960 * 0 if the property selector is out of range.
1963 * @see u_hasBinaryProperty
1964 * @see u_getUnicodeVersion
1965 * @see u_getIntPropertyMaxValue
1966 * @see u_getIntPropertyValue
1969 U_STABLE
int32_t U_EXPORT2
1970 u_getIntPropertyMinValue(UProperty which
);
1973 * Get the maximum value for an enumerated/integer/binary Unicode property.
1974 * Can be used together with u_getIntPropertyMinValue
1975 * to allocate arrays of UnicodeSet or similar.
1977 * Examples for min/max values (for Unicode 3.2):
1979 * - UCHAR_BIDI_CLASS: 0/18 (U_LEFT_TO_RIGHT/U_BOUNDARY_NEUTRAL)
1980 * - UCHAR_SCRIPT: 0/45 (USCRIPT_COMMON/USCRIPT_TAGBANWA)
1981 * - UCHAR_IDEOGRAPHIC: 0/1 (FALSE/TRUE)
1983 * For undefined UProperty constant values, min/max values will be 0/-1.
1985 * @param which UProperty selector constant, identifies which binary property to check.
1986 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
1987 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT.
1988 * @return Maximum value returned by u_getIntPropertyValue for a Unicode property.
1989 * <=0 if the property selector is out of range.
1992 * @see u_hasBinaryProperty
1993 * @see u_getUnicodeVersion
1994 * @see u_getIntPropertyMaxValue
1995 * @see u_getIntPropertyValue
1998 U_STABLE
int32_t U_EXPORT2
1999 u_getIntPropertyMaxValue(UProperty which
);
2002 * Get the numeric value for a Unicode code point as defined in the
2003 * Unicode Character Database.
2005 * A "double" return type is necessary because
2006 * some numeric values are fractions, negative, or too large for int32_t.
2008 * For characters without any numeric values in the Unicode Character Database,
2009 * this function will return U_NO_NUMERIC_VALUE.
2010 * Note: This is different from the Unicode Standard which specifies NaN as the default value.
2011 * (NaN is not available on all platforms.)
2013 * Similar to java.lang.Character.getNumericValue(), but u_getNumericValue()
2014 * also supports negative values, large values, and fractions,
2015 * while Java's getNumericValue() returns values 10..35 for ASCII letters.
2017 * @param c Code point to get the numeric value for.
2018 * @return Numeric value of c, or U_NO_NUMERIC_VALUE if none is defined.
2020 * @see U_NO_NUMERIC_VALUE
2023 U_STABLE
double U_EXPORT2
2024 u_getNumericValue(UChar32 c
);
2027 * Special value that is returned by u_getNumericValue when
2028 * no numeric value is defined for a code point.
2030 * @see u_getNumericValue
2033 #define U_NO_NUMERIC_VALUE ((double)-123456789.)
2036 * Determines whether the specified code point has the general category "Ll"
2037 * (lowercase letter).
2039 * Same as java.lang.Character.isLowerCase().
2041 * This misses some characters that are also lowercase but
2042 * have a different general category value.
2043 * In order to include those, use UCHAR_LOWERCASE.
2045 * In addition to being equivalent to a Java function, this also serves
2046 * as a C/POSIX migration function.
2047 * See the comments about C/POSIX character classification functions in the
2048 * documentation at the top of this header file.
2050 * @param c the code point to be tested
2051 * @return TRUE if the code point is an Ll lowercase letter
2053 * @see UCHAR_LOWERCASE
2058 U_STABLE UBool U_EXPORT2
2059 u_islower(UChar32 c
);
2062 * Determines whether the specified code point has the general category "Lu"
2063 * (uppercase letter).
2065 * Same as java.lang.Character.isUpperCase().
2067 * This misses some characters that are also uppercase but
2068 * have a different general category value.
2069 * In order to include those, use UCHAR_UPPERCASE.
2071 * In addition to being equivalent to a Java function, this also serves
2072 * as a C/POSIX migration function.
2073 * See the comments about C/POSIX character classification functions in the
2074 * documentation at the top of this header file.
2076 * @param c the code point to be tested
2077 * @return TRUE if the code point is an Lu uppercase letter
2079 * @see UCHAR_UPPERCASE
2085 U_STABLE UBool U_EXPORT2
2086 u_isupper(UChar32 c
);
2089 * Determines whether the specified code point is a titlecase letter.
2090 * True for general category "Lt" (titlecase letter).
2092 * Same as java.lang.Character.isTitleCase().
2094 * @param c the code point to be tested
2095 * @return TRUE if the code point is an Lt titlecase letter
2102 U_STABLE UBool U_EXPORT2
2103 u_istitle(UChar32 c
);
2106 * Determines whether the specified code point is a digit character according to Java.
2107 * True for characters with general category "Nd" (decimal digit numbers).
2108 * Beginning with Unicode 4, this is the same as
2109 * testing for the Numeric_Type of Decimal.
2111 * Same as java.lang.Character.isDigit().
2113 * In addition to being equivalent to a Java function, this also serves
2114 * as a C/POSIX migration function.
2115 * See the comments about C/POSIX character classification functions in the
2116 * documentation at the top of this header file.
2118 * @param c the code point to be tested
2119 * @return TRUE if the code point is a digit character according to Character.isDigit()
2123 U_STABLE UBool U_EXPORT2
2124 u_isdigit(UChar32 c
);
2127 * Determines whether the specified code point is a letter character.
2128 * True for general categories "L" (letters).
2130 * Same as java.lang.Character.isLetter().
2132 * In addition to being equivalent to a Java function, this also serves
2133 * as a C/POSIX migration function.
2134 * See the comments about C/POSIX character classification functions in the
2135 * documentation at the top of this header file.
2137 * @param c the code point to be tested
2138 * @return TRUE if the code point is a letter character
2144 U_STABLE UBool U_EXPORT2
2145 u_isalpha(UChar32 c
);
2148 * Determines whether the specified code point is an alphanumeric character
2149 * (letter or digit) according to Java.
2150 * True for characters with general categories
2151 * "L" (letters) and "Nd" (decimal digit numbers).
2153 * Same as java.lang.Character.isLetterOrDigit().
2155 * In addition to being equivalent to a Java function, this also serves
2156 * as a C/POSIX migration function.
2157 * See the comments about C/POSIX character classification functions in the
2158 * documentation at the top of this header file.
2160 * @param c the code point to be tested
2161 * @return TRUE if the code point is an alphanumeric character according to Character.isLetterOrDigit()
2165 U_STABLE UBool U_EXPORT2
2166 u_isalnum(UChar32 c
);
2169 * Determines whether the specified code point is a hexadecimal digit.
2170 * This is equivalent to u_digit(c, 16)>=0.
2171 * True for characters with general category "Nd" (decimal digit numbers)
2172 * as well as Latin letters a-f and A-F in both ASCII and Fullwidth ASCII.
2173 * (That is, for letters with code points
2174 * 0041..0046, 0061..0066, FF21..FF26, FF41..FF46.)
2176 * In order to narrow the definition of hexadecimal digits to only ASCII
2177 * characters, use (c<=0x7f && u_isxdigit(c)).
2179 * This is a C/POSIX migration function.
2180 * See the comments about C/POSIX character classification functions in the
2181 * documentation at the top of this header file.
2183 * @param c the code point to be tested
2184 * @return TRUE if the code point is a hexadecimal digit
2188 U_STABLE UBool U_EXPORT2
2189 u_isxdigit(UChar32 c
);
2192 * Determines whether the specified code point is a punctuation character.
2193 * True for characters with general categories "P" (punctuation).
2195 * This is a C/POSIX migration function.
2196 * See the comments about C/POSIX character classification functions in the
2197 * documentation at the top of this header file.
2199 * @param c the code point to be tested
2200 * @return TRUE if the code point is a punctuation character
2204 U_STABLE UBool U_EXPORT2
2205 u_ispunct(UChar32 c
);
2208 * Determines whether the specified code point is a "graphic" character
2209 * (printable, excluding spaces).
2210 * TRUE for all characters except those with general categories
2211 * "Cc" (control codes), "Cf" (format controls), "Cs" (surrogates),
2212 * "Cn" (unassigned), and "Z" (separators).
2214 * This is a C/POSIX migration function.
2215 * See the comments about C/POSIX character classification functions in the
2216 * documentation at the top of this header file.
2218 * @param c the code point to be tested
2219 * @return TRUE if the code point is a "graphic" character
2223 U_STABLE UBool U_EXPORT2
2224 u_isgraph(UChar32 c
);
2227 * Determines whether the specified code point is a "blank" or "horizontal space",
2228 * a character that visibly separates words on a line.
2229 * The following are equivalent definitions:
2231 * TRUE for Unicode White_Space characters except for "vertical space controls"
2232 * where "vertical space controls" are the following characters:
2233 * U+000A (LF) U+000B (VT) U+000C (FF) U+000D (CR) U+0085 (NEL) U+2028 (LS) U+2029 (PS)
2237 * TRUE for U+0009 (TAB) and characters with general category "Zs" (space separators)
2238 * except Zero Width Space (ZWSP, U+200B).
2240 * Note: There are several ICU whitespace functions; please see the uchar.h
2241 * file documentation for a detailed comparison.
2243 * This is a C/POSIX migration function.
2244 * See the comments about C/POSIX character classification functions in the
2245 * documentation at the top of this header file.
2247 * @param c the code point to be tested
2248 * @return TRUE if the code point is a "blank"
2252 U_STABLE UBool U_EXPORT2
2253 u_isblank(UChar32 c
);
2256 * Determines whether the specified code point is "defined",
2257 * which usually means that it is assigned a character.
2258 * True for general categories other than "Cn" (other, not assigned),
2259 * i.e., true for all code points mentioned in UnicodeData.txt.
2261 * Note that non-character code points (e.g., U+FDD0) are not "defined"
2262 * (they are Cn), but surrogate code points are "defined" (Cs).
2264 * Same as java.lang.Character.isDefined().
2266 * @param c the code point to be tested
2267 * @return TRUE if the code point is assigned a character
2277 U_STABLE UBool U_EXPORT2
2278 u_isdefined(UChar32 c
);
2281 * Determines if the specified character is a space character or not.
2283 * Note: There are several ICU whitespace functions; please see the uchar.h
2284 * file documentation for a detailed comparison.
2286 * This is a C/POSIX migration function.
2287 * See the comments about C/POSIX character classification functions in the
2288 * documentation at the top of this header file.
2290 * @param c the character to be tested
2291 * @return true if the character is a space character; false otherwise.
2293 * @see u_isJavaSpaceChar
2294 * @see u_isWhitespace
2295 * @see u_isUWhiteSpace
2298 U_STABLE UBool U_EXPORT2
2299 u_isspace(UChar32 c
);
2302 * Determine if the specified code point is a space character according to Java.
2303 * True for characters with general categories "Z" (separators),
2304 * which does not include control codes (e.g., TAB or Line Feed).
2306 * Same as java.lang.Character.isSpaceChar().
2308 * Note: There are several ICU whitespace functions; please see the uchar.h
2309 * file documentation for a detailed comparison.
2311 * @param c the code point to be tested
2312 * @return TRUE if the code point is a space character according to Character.isSpaceChar()
2315 * @see u_isWhitespace
2316 * @see u_isUWhiteSpace
2319 U_STABLE UBool U_EXPORT2
2320 u_isJavaSpaceChar(UChar32 c
);
2323 * Determines if the specified code point is a whitespace character according to Java/ICU.
2324 * A character is considered to be a Java whitespace character if and only
2325 * if it satisfies one of the following criteria:
2327 * - It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"), but is not
2328 * also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
2329 * - It is U+0009 HORIZONTAL TABULATION.
2330 * - It is U+000A LINE FEED.
2331 * - It is U+000B VERTICAL TABULATION.
2332 * - It is U+000C FORM FEED.
2333 * - It is U+000D CARRIAGE RETURN.
2334 * - It is U+001C FILE SEPARATOR.
2335 * - It is U+001D GROUP SEPARATOR.
2336 * - It is U+001E RECORD SEPARATOR.
2337 * - It is U+001F UNIT SEPARATOR.
2339 * This API tries to sync with the semantics of Java's
2340 * java.lang.Character.isWhitespace(), but it may not return
2341 * the exact same results because of the Unicode version
2344 * Note: Unicode 4.0.1 changed U+200B ZERO WIDTH SPACE from a Space Separator (Zs)
2345 * to a Format Control (Cf). Since then, isWhitespace(0x200b) returns false.
2346 * See http://www.unicode.org/versions/Unicode4.0.1/
2348 * Note: There are several ICU whitespace functions; please see the uchar.h
2349 * file documentation for a detailed comparison.
2351 * @param c the code point to be tested
2352 * @return TRUE if the code point is a whitespace character according to Java/ICU
2355 * @see u_isJavaSpaceChar
2356 * @see u_isUWhiteSpace
2359 U_STABLE UBool U_EXPORT2
2360 u_isWhitespace(UChar32 c
);
2363 * Determines whether the specified code point is a control character
2364 * (as defined by this function).
2365 * A control character is one of the following:
2366 * - ISO 8-bit control character (U+0000..U+001f and U+007f..U+009f)
2367 * - U_CONTROL_CHAR (Cc)
2368 * - U_FORMAT_CHAR (Cf)
2369 * - U_LINE_SEPARATOR (Zl)
2370 * - U_PARAGRAPH_SEPARATOR (Zp)
2372 * This is a C/POSIX migration function.
2373 * See the comments about C/POSIX character classification functions in the
2374 * documentation at the top of this header file.
2376 * @param c the code point to be tested
2377 * @return TRUE if the code point is a control character
2379 * @see UCHAR_DEFAULT_IGNORABLE_CODE_POINT
2383 U_STABLE UBool U_EXPORT2
2384 u_iscntrl(UChar32 c
);
2387 * Determines whether the specified code point is an ISO control code.
2388 * True for U+0000..U+001f and U+007f..U+009f (general category "Cc").
2390 * Same as java.lang.Character.isISOControl().
2392 * @param c the code point to be tested
2393 * @return TRUE if the code point is an ISO control code
2398 U_STABLE UBool U_EXPORT2
2399 u_isISOControl(UChar32 c
);
2402 * Determines whether the specified code point is a printable character.
2403 * True for general categories <em>other</em> than "C" (controls).
2405 * This is a C/POSIX migration function.
2406 * See the comments about C/POSIX character classification functions in the
2407 * documentation at the top of this header file.
2409 * @param c the code point to be tested
2410 * @return TRUE if the code point is a printable character
2412 * @see UCHAR_DEFAULT_IGNORABLE_CODE_POINT
2416 U_STABLE UBool U_EXPORT2
2417 u_isprint(UChar32 c
);
2420 * Determines whether the specified code point is a base character.
2421 * True for general categories "L" (letters), "N" (numbers),
2422 * "Mc" (spacing combining marks), and "Me" (enclosing marks).
2424 * Note that this is different from the Unicode definition in
2425 * chapter 3.5, conformance clause D13,
2426 * which defines base characters to be all characters (not Cn)
2427 * that do not graphically combine with preceding characters (M)
2428 * and that are neither control (Cc) or format (Cf) characters.
2430 * @param c the code point to be tested
2431 * @return TRUE if the code point is a base character according to this function
2437 U_STABLE UBool U_EXPORT2
2438 u_isbase(UChar32 c
);
2441 * Returns the bidirectional category value for the code point,
2442 * which is used in the Unicode bidirectional algorithm
2443 * (UAX #9 http://www.unicode.org/reports/tr9/).
2444 * Note that some <em>unassigned</em> code points have bidi values
2445 * of R or AL because they are in blocks that are reserved
2446 * for Right-To-Left scripts.
2448 * Same as java.lang.Character.getDirectionality()
2450 * @param c the code point to be tested
2451 * @return the bidirectional category (UCharDirection) value
2453 * @see UCharDirection
2456 U_STABLE UCharDirection U_EXPORT2
2457 u_charDirection(UChar32 c
);
2460 * Determines whether the code point has the Bidi_Mirrored property.
2461 * This property is set for characters that are commonly used in
2462 * Right-To-Left contexts and need to be displayed with a "mirrored"
2465 * Same as java.lang.Character.isMirrored().
2466 * Same as UCHAR_BIDI_MIRRORED
2468 * @param c the code point to be tested
2469 * @return TRUE if the character has the Bidi_Mirrored property
2471 * @see UCHAR_BIDI_MIRRORED
2474 U_STABLE UBool U_EXPORT2
2475 u_isMirrored(UChar32 c
);
2478 * Maps the specified character to a "mirror-image" character.
2479 * For characters with the Bidi_Mirrored property, implementations
2480 * sometimes need a "poor man's" mapping to another Unicode
2481 * character (code point) such that the default glyph may serve
2482 * as the mirror-image of the default glyph of the specified
2483 * character. This is useful for text conversion to and from
2484 * codepages with visual order, and for displays without glyph
2485 * selecetion capabilities.
2487 * @param c the code point to be mapped
2488 * @return another Unicode code point that may serve as a mirror-image
2489 * substitute, or c itself if there is no such mapping or c
2490 * does not have the Bidi_Mirrored property
2492 * @see UCHAR_BIDI_MIRRORED
2496 U_STABLE UChar32 U_EXPORT2
2497 u_charMirror(UChar32 c
);
2500 * Returns the general category value for the code point.
2502 * Same as java.lang.Character.getType().
2504 * @param c the code point to be tested
2505 * @return the general category (UCharCategory) value
2507 * @see UCharCategory
2510 U_STABLE
int8_t U_EXPORT2
2511 u_charType(UChar32 c
);
2514 * Get a single-bit bit set for the general category of a character.
2515 * This bit set can be compared bitwise with U_GC_SM_MASK, U_GC_L_MASK, etc.
2516 * Same as U_MASK(u_charType(c)).
2518 * @param c the code point to be tested
2519 * @return a single-bit mask corresponding to the general category (UCharCategory) value
2522 * @see UCharCategory
2526 #define U_GET_GC_MASK(c) U_MASK(u_charType(c))
2529 * Callback from u_enumCharTypes(), is called for each contiguous range
2530 * of code points c (where start<=c<limit)
2531 * with the same Unicode general category ("character type").
2533 * The callback function can stop the enumeration by returning FALSE.
2535 * @param context an opaque pointer, as passed into utrie_enum()
2536 * @param start the first code point in a contiguous range with value
2537 * @param limit one past the last code point in a contiguous range with value
2538 * @param type the general category for all code points in [start..limit[
2539 * @return FALSE to stop the enumeration
2542 * @see UCharCategory
2543 * @see u_enumCharTypes
2545 typedef UBool U_CALLCONV
2546 UCharEnumTypeRange(const void *context
, UChar32 start
, UChar32 limit
, UCharCategory type
);
2549 * Enumerate efficiently all code points with their Unicode general categories.
2551 * This is useful for building data structures (e.g., UnicodeSet's),
2552 * for enumerating all assigned code points (type!=U_UNASSIGNED), etc.
2554 * For each contiguous range of code points with a given general category ("character type"),
2555 * the UCharEnumTypeRange function is called.
2556 * Adjacent ranges have different types.
2557 * The Unicode Standard guarantees that the numeric value of the type is 0..31.
2559 * @param enumRange a pointer to a function that is called for each contiguous range
2560 * of code points with the same general category
2561 * @param context an opaque pointer that is passed on to the callback function
2564 * @see UCharCategory
2565 * @see UCharEnumTypeRange
2567 U_STABLE
void U_EXPORT2
2568 u_enumCharTypes(UCharEnumTypeRange
*enumRange
, const void *context
);
2570 #if !UCONFIG_NO_NORMALIZATION
2573 * Returns the combining class of the code point as specified in UnicodeData.txt.
2575 * @param c the code point of the character
2576 * @return the combining class of the character
2579 U_STABLE
uint8_t U_EXPORT2
2580 u_getCombiningClass(UChar32 c
);
2585 * Returns the decimal digit value of a decimal digit character.
2586 * Such characters have the general category "Nd" (decimal digit numbers)
2587 * and a Numeric_Type of Decimal.
2589 * Unlike ICU releases before 2.6, no digit values are returned for any
2590 * Han characters because Han number characters are often used with a special
2591 * Chinese-style number format (with characters for powers of 10 in between)
2592 * instead of in decimal-positional notation.
2593 * Unicode 4 explicitly assigns Han number characters the Numeric_Type
2594 * Numeric instead of Decimal.
2595 * See Jitterbug 1483 for more details.
2597 * Use u_getIntPropertyValue(c, UCHAR_NUMERIC_TYPE) and u_getNumericValue()
2598 * for complete numeric Unicode properties.
2600 * @param c the code point for which to get the decimal digit value
2601 * @return the decimal digit value of c,
2602 * or -1 if c is not a decimal digit character
2604 * @see u_getNumericValue
2607 U_STABLE
int32_t U_EXPORT2
2608 u_charDigitValue(UChar32 c
);
2611 * Returns the Unicode allocation block that contains the character.
2613 * @param c the code point to be tested
2614 * @return the block value (UBlockCode) for c
2619 U_STABLE UBlockCode U_EXPORT2
2620 ublock_getCode(UChar32 c
);
2623 * Retrieve the name of a Unicode character.
2624 * Depending on <code>nameChoice</code>, the character name written
2625 * into the buffer is the "modern" name or the name that was defined
2626 * in Unicode version 1.0.
2627 * The name contains only "invariant" characters
2628 * like A-Z, 0-9, space, and '-'.
2629 * Unicode 1.0 names are only retrieved if they are different from the modern
2630 * names and if the data file contains the data for them. gennames may or may
2631 * not be called with a command line option to include 1.0 names in unames.dat.
2633 * @param code The character (code point) for which to get the name.
2634 * It must be <code>0<=code<=0x10ffff</code>.
2635 * @param nameChoice Selector for which name to get.
2636 * @param buffer Destination address for copying the name.
2637 * The name will always be zero-terminated.
2638 * If there is no name, then the buffer will be set to the empty string.
2639 * @param bufferLength <code>==sizeof(buffer)</code>
2640 * @param pErrorCode Pointer to a UErrorCode variable;
2641 * check for <code>U_SUCCESS()</code> after <code>u_charName()</code>
2643 * @return The length of the name, or 0 if there is no name for this character.
2644 * If the bufferLength is less than or equal to the length, then the buffer
2645 * contains the truncated name and the returned length indicates the full
2646 * length of the name.
2647 * The length does not include the zero-termination.
2649 * @see UCharNameChoice
2650 * @see u_charFromName
2651 * @see u_enumCharNames
2654 U_STABLE
int32_t U_EXPORT2
2655 u_charName(UChar32 code
, UCharNameChoice nameChoice
,
2656 char *buffer
, int32_t bufferLength
,
2657 UErrorCode
*pErrorCode
);
2660 * Returns an empty string.
2661 * Used to return the ISO 10646 comment for a character.
2662 * The Unicode ISO_Comment property is deprecated and has no values.
2664 * @param c The character (code point) for which to get the ISO comment.
2665 * It must be <code>0<=c<=0x10ffff</code>.
2666 * @param dest Destination address for copying the comment.
2667 * The comment will be zero-terminated if possible.
2668 * If there is no comment, then the buffer will be set to the empty string.
2669 * @param destCapacity <code>==sizeof(dest)</code>
2670 * @param pErrorCode Pointer to a UErrorCode variable;
2671 * check for <code>U_SUCCESS()</code> after <code>u_getISOComment()</code>
2675 * @deprecated ICU 49
2677 U_STABLE
int32_t U_EXPORT2
2678 u_getISOComment(UChar32 c
,
2679 char *dest
, int32_t destCapacity
,
2680 UErrorCode
*pErrorCode
);
2683 * Find a Unicode character by its name and return its code point value.
2684 * The name is matched exactly and completely.
2685 * If the name does not correspond to a code point, <i>pErrorCode</i>
2686 * is set to <code>U_INVALID_CHAR_FOUND</code>.
2687 * A Unicode 1.0 name is matched only if it differs from the modern name.
2688 * Unicode names are all uppercase. Extended names are lowercase followed
2689 * by an uppercase hexadecimal number, and within angle brackets.
2691 * @param nameChoice Selector for which name to match.
2692 * @param name The name to match.
2693 * @param pErrorCode Pointer to a UErrorCode variable
2694 * @return The Unicode value of the code point with the given name,
2695 * or an undefined value if there is no such code point.
2697 * @see UCharNameChoice
2699 * @see u_enumCharNames
2702 U_STABLE UChar32 U_EXPORT2
2703 u_charFromName(UCharNameChoice nameChoice
,
2705 UErrorCode
*pErrorCode
);
2708 * Type of a callback function for u_enumCharNames() that gets called
2709 * for each Unicode character with the code point value and
2710 * the character name.
2711 * If such a function returns FALSE, then the enumeration is stopped.
2713 * @param context The context pointer that was passed to u_enumCharNames().
2714 * @param code The Unicode code point for the character with this name.
2715 * @param nameChoice Selector for which kind of names is enumerated.
2716 * @param name The character's name, zero-terminated.
2717 * @param length The length of the name.
2718 * @return TRUE if the enumeration should continue, FALSE to stop it.
2720 * @see UCharNameChoice
2721 * @see u_enumCharNames
2724 typedef UBool U_CALLCONV
UEnumCharNamesFn(void *context
,
2726 UCharNameChoice nameChoice
,
2731 * Enumerate all assigned Unicode characters between the start and limit
2732 * code points (start inclusive, limit exclusive) and call a function
2733 * for each, passing the code point value and the character name.
2734 * For Unicode 1.0 names, only those are enumerated that differ from the
2737 * @param start The first code point in the enumeration range.
2738 * @param limit One more than the last code point in the enumeration range
2739 * (the first one after the range).
2740 * @param fn The function that is to be called for each character name.
2741 * @param context An arbitrary pointer that is passed to the function.
2742 * @param nameChoice Selector for which kind of names to enumerate.
2743 * @param pErrorCode Pointer to a UErrorCode variable
2745 * @see UCharNameChoice
2746 * @see UEnumCharNamesFn
2748 * @see u_charFromName
2751 U_STABLE
void U_EXPORT2
2752 u_enumCharNames(UChar32 start
, UChar32 limit
,
2753 UEnumCharNamesFn
*fn
,
2755 UCharNameChoice nameChoice
,
2756 UErrorCode
*pErrorCode
);
2759 * Return the Unicode name for a given property, as given in the
2760 * Unicode database file PropertyAliases.txt.
2762 * In addition, this function maps the property
2763 * UCHAR_GENERAL_CATEGORY_MASK to the synthetic names "gcm" /
2764 * "General_Category_Mask". These names are not in
2765 * PropertyAliases.txt.
2767 * @param property UProperty selector other than UCHAR_INVALID_CODE.
2768 * If out of range, NULL is returned.
2770 * @param nameChoice selector for which name to get. If out of range,
2771 * NULL is returned. All properties have a long name. Most
2772 * have a short name, but some do not. Unicode allows for
2773 * additional names; if present these will be returned by
2774 * U_LONG_PROPERTY_NAME + i, where i=1, 2,...
2776 * @return a pointer to the name, or NULL if either the
2777 * property or the nameChoice is out of range. If a given
2778 * nameChoice returns NULL, then all larger values of
2779 * nameChoice will return NULL, with one exception: if NULL is
2780 * returned for U_SHORT_PROPERTY_NAME, then
2781 * U_LONG_PROPERTY_NAME (and higher) may still return a
2782 * non-NULL value. The returned pointer is valid until
2783 * u_cleanup() is called.
2786 * @see UPropertyNameChoice
2789 U_STABLE
const char* U_EXPORT2
2790 u_getPropertyName(UProperty property
,
2791 UPropertyNameChoice nameChoice
);
2794 * Return the UProperty enum for a given property name, as specified
2795 * in the Unicode database file PropertyAliases.txt. Short, long, and
2796 * any other variants are recognized.
2798 * In addition, this function maps the synthetic names "gcm" /
2799 * "General_Category_Mask" to the property
2800 * UCHAR_GENERAL_CATEGORY_MASK. These names are not in
2801 * PropertyAliases.txt.
2803 * @param alias the property name to be matched. The name is compared
2804 * using "loose matching" as described in PropertyAliases.txt.
2806 * @return a UProperty enum, or UCHAR_INVALID_CODE if the given name
2807 * does not match any property.
2812 U_STABLE UProperty U_EXPORT2
2813 u_getPropertyEnum(const char* alias
);
2816 * Return the Unicode name for a given property value, as given in the
2817 * Unicode database file PropertyValueAliases.txt.
2819 * Note: Some of the names in PropertyValueAliases.txt can only be
2820 * retrieved using UCHAR_GENERAL_CATEGORY_MASK, not
2821 * UCHAR_GENERAL_CATEGORY. These include: "C" / "Other", "L" /
2822 * "Letter", "LC" / "Cased_Letter", "M" / "Mark", "N" / "Number", "P"
2823 * / "Punctuation", "S" / "Symbol", and "Z" / "Separator".
2825 * @param property UProperty selector constant.
2826 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
2827 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT
2828 * or UCHAR_MASK_START<=which<UCHAR_MASK_LIMIT.
2829 * If out of range, NULL is returned.
2831 * @param value selector for a value for the given property. If out
2832 * of range, NULL is returned. In general, valid values range
2833 * from 0 up to some maximum. There are a few exceptions:
2834 * (1.) UCHAR_BLOCK values begin at the non-zero value
2835 * UBLOCK_BASIC_LATIN. (2.) UCHAR_CANONICAL_COMBINING_CLASS
2836 * values are not contiguous and range from 0..240. (3.)
2837 * UCHAR_GENERAL_CATEGORY_MASK values are not values of
2838 * UCharCategory, but rather mask values produced by
2839 * U_GET_GC_MASK(). This allows grouped categories such as
2840 * [:L:] to be represented. Mask values range
2841 * non-contiguously from 1..U_GC_P_MASK.
2843 * @param nameChoice selector for which name to get. If out of range,
2844 * NULL is returned. All values have a long name. Most have
2845 * a short name, but some do not. Unicode allows for
2846 * additional names; if present these will be returned by
2847 * U_LONG_PROPERTY_NAME + i, where i=1, 2,...
2849 * @return a pointer to the name, or NULL if either the
2850 * property or the nameChoice is out of range. If a given
2851 * nameChoice returns NULL, then all larger values of
2852 * nameChoice will return NULL, with one exception: if NULL is
2853 * returned for U_SHORT_PROPERTY_NAME, then
2854 * U_LONG_PROPERTY_NAME (and higher) may still return a
2855 * non-NULL value. The returned pointer is valid until
2856 * u_cleanup() is called.
2859 * @see UPropertyNameChoice
2862 U_STABLE
const char* U_EXPORT2
2863 u_getPropertyValueName(UProperty property
,
2865 UPropertyNameChoice nameChoice
);
2868 * Return the property value integer for a given value name, as
2869 * specified in the Unicode database file PropertyValueAliases.txt.
2870 * Short, long, and any other variants are recognized.
2872 * Note: Some of the names in PropertyValueAliases.txt will only be
2873 * recognized with UCHAR_GENERAL_CATEGORY_MASK, not
2874 * UCHAR_GENERAL_CATEGORY. These include: "C" / "Other", "L" /
2875 * "Letter", "LC" / "Cased_Letter", "M" / "Mark", "N" / "Number", "P"
2876 * / "Punctuation", "S" / "Symbol", and "Z" / "Separator".
2878 * @param property UProperty selector constant.
2879 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
2880 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT
2881 * or UCHAR_MASK_START<=which<UCHAR_MASK_LIMIT.
2882 * If out of range, UCHAR_INVALID_CODE is returned.
2884 * @param alias the value name to be matched. The name is compared
2885 * using "loose matching" as described in
2886 * PropertyValueAliases.txt.
2888 * @return a value integer or UCHAR_INVALID_CODE if the given name
2889 * does not match any value of the given property, or if the
2890 * property is invalid. Note: UCHAR_GENERAL_CATEGORY_MASK values
2891 * are not values of UCharCategory, but rather mask values
2892 * produced by U_GET_GC_MASK(). This allows grouped
2893 * categories such as [:L:] to be represented.
2898 U_STABLE
int32_t U_EXPORT2
2899 u_getPropertyValueEnum(UProperty property
,
2903 * Determines if the specified character is permissible as the
2904 * first character in an identifier according to Unicode
2905 * (The Unicode Standard, Version 3.0, chapter 5.16 Identifiers).
2906 * True for characters with general categories "L" (letters) and "Nl" (letter numbers).
2908 * Same as java.lang.Character.isUnicodeIdentifierStart().
2909 * Same as UCHAR_ID_START
2911 * @param c the code point to be tested
2912 * @return TRUE if the code point may start an identifier
2914 * @see UCHAR_ID_START
2919 U_STABLE UBool U_EXPORT2
2920 u_isIDStart(UChar32 c
);
2923 * Determines if the specified character is permissible
2924 * in an identifier according to Java.
2925 * True for characters with general categories "L" (letters),
2926 * "Nl" (letter numbers), "Nd" (decimal digits),
2927 * "Mc" and "Mn" (combining marks), "Pc" (connecting punctuation), and
2928 * u_isIDIgnorable(c).
2930 * Same as java.lang.Character.isUnicodeIdentifierPart().
2931 * Almost the same as Unicode's ID_Continue (UCHAR_ID_CONTINUE)
2932 * except that Unicode recommends to ignore Cf which is less than
2933 * u_isIDIgnorable(c).
2935 * @param c the code point to be tested
2936 * @return TRUE if the code point may occur in an identifier according to Java
2938 * @see UCHAR_ID_CONTINUE
2940 * @see u_isIDIgnorable
2943 U_STABLE UBool U_EXPORT2
2944 u_isIDPart(UChar32 c
);
2947 * Determines if the specified character should be regarded
2948 * as an ignorable character in an identifier,
2949 * according to Java.
2950 * True for characters with general category "Cf" (format controls) as well as
2951 * non-whitespace ISO controls
2952 * (U+0000..U+0008, U+000E..U+001B, U+007F..U+009F).
2954 * Same as java.lang.Character.isIdentifierIgnorable().
2956 * Note that Unicode just recommends to ignore Cf (format controls).
2958 * @param c the code point to be tested
2959 * @return TRUE if the code point is ignorable in identifiers according to Java
2961 * @see UCHAR_DEFAULT_IGNORABLE_CODE_POINT
2966 U_STABLE UBool U_EXPORT2
2967 u_isIDIgnorable(UChar32 c
);
2970 * Determines if the specified character is permissible as the
2971 * first character in a Java identifier.
2972 * In addition to u_isIDStart(c), true for characters with
2973 * general categories "Sc" (currency symbols) and "Pc" (connecting punctuation).
2975 * Same as java.lang.Character.isJavaIdentifierStart().
2977 * @param c the code point to be tested
2978 * @return TRUE if the code point may start a Java identifier
2980 * @see u_isJavaIDPart
2985 U_STABLE UBool U_EXPORT2
2986 u_isJavaIDStart(UChar32 c
);
2989 * Determines if the specified character is permissible
2990 * in a Java identifier.
2991 * In addition to u_isIDPart(c), true for characters with
2992 * general category "Sc" (currency symbols).
2994 * Same as java.lang.Character.isJavaIdentifierPart().
2996 * @param c the code point to be tested
2997 * @return TRUE if the code point may occur in a Java identifier
2999 * @see u_isIDIgnorable
3000 * @see u_isJavaIDStart
3006 U_STABLE UBool U_EXPORT2
3007 u_isJavaIDPart(UChar32 c
);
3010 * The given character is mapped to its lowercase equivalent according to
3011 * UnicodeData.txt; if the character has no lowercase equivalent, the character
3012 * itself is returned.
3014 * Same as java.lang.Character.toLowerCase().
3016 * This function only returns the simple, single-code point case mapping.
3017 * Full case mappings should be used whenever possible because they produce
3018 * better results by working on whole strings.
3019 * They take into account the string context and the language and can map
3020 * to a result string with a different length as appropriate.
3021 * Full case mappings are applied by the string case mapping functions,
3022 * see ustring.h and the UnicodeString class.
3023 * See also the User Guide chapter on C/POSIX migration:
3024 * http://icu-project.org/userguide/posix.html#case_mappings
3026 * @param c the code point to be mapped
3027 * @return the Simple_Lowercase_Mapping of the code point, if any;
3028 * otherwise the code point itself.
3031 U_STABLE UChar32 U_EXPORT2
3032 u_tolower(UChar32 c
);
3035 * The given character is mapped to its uppercase equivalent according to UnicodeData.txt;
3036 * if the character has no uppercase equivalent, the character itself is
3039 * Same as java.lang.Character.toUpperCase().
3041 * This function only returns the simple, single-code point case mapping.
3042 * Full case mappings should be used whenever possible because they produce
3043 * better results by working on whole strings.
3044 * They take into account the string context and the language and can map
3045 * to a result string with a different length as appropriate.
3046 * Full case mappings are applied by the string case mapping functions,
3047 * see ustring.h and the UnicodeString class.
3048 * See also the User Guide chapter on C/POSIX migration:
3049 * http://icu-project.org/userguide/posix.html#case_mappings
3051 * @param c the code point to be mapped
3052 * @return the Simple_Uppercase_Mapping of the code point, if any;
3053 * otherwise the code point itself.
3056 U_STABLE UChar32 U_EXPORT2
3057 u_toupper(UChar32 c
);
3060 * The given character is mapped to its titlecase equivalent
3061 * according to UnicodeData.txt;
3062 * if none is defined, the character itself is returned.
3064 * Same as java.lang.Character.toTitleCase().
3066 * This function only returns the simple, single-code point case mapping.
3067 * Full case mappings should be used whenever possible because they produce
3068 * better results by working on whole strings.
3069 * They take into account the string context and the language and can map
3070 * to a result string with a different length as appropriate.
3071 * Full case mappings are applied by the string case mapping functions,
3072 * see ustring.h and the UnicodeString class.
3073 * See also the User Guide chapter on C/POSIX migration:
3074 * http://icu-project.org/userguide/posix.html#case_mappings
3076 * @param c the code point to be mapped
3077 * @return the Simple_Titlecase_Mapping of the code point, if any;
3078 * otherwise the code point itself.
3081 U_STABLE UChar32 U_EXPORT2
3082 u_totitle(UChar32 c
);
3084 /** Option value for case folding: use default mappings defined in CaseFolding.txt. @stable ICU 2.0 */
3085 #define U_FOLD_CASE_DEFAULT 0
3088 * Option value for case folding:
3090 * Use the modified set of mappings provided in CaseFolding.txt to handle dotted I
3091 * and dotless i appropriately for Turkic languages (tr, az).
3093 * Before Unicode 3.2, CaseFolding.txt contains mappings marked with 'I' that
3094 * are to be included for default mappings and
3095 * excluded for the Turkic-specific mappings.
3097 * Unicode 3.2 CaseFolding.txt instead contains mappings marked with 'T' that
3098 * are to be excluded for default mappings and
3099 * included for the Turkic-specific mappings.
3103 #define U_FOLD_CASE_EXCLUDE_SPECIAL_I 1
3106 * The given character is mapped to its case folding equivalent according to
3107 * UnicodeData.txt and CaseFolding.txt;
3108 * if the character has no case folding equivalent, the character
3109 * itself is returned.
3111 * This function only returns the simple, single-code point case mapping.
3112 * Full case mappings should be used whenever possible because they produce
3113 * better results by working on whole strings.
3114 * They take into account the string context and the language and can map
3115 * to a result string with a different length as appropriate.
3116 * Full case mappings are applied by the string case mapping functions,
3117 * see ustring.h and the UnicodeString class.
3118 * See also the User Guide chapter on C/POSIX migration:
3119 * http://icu-project.org/userguide/posix.html#case_mappings
3121 * @param c the code point to be mapped
3122 * @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
3123 * @return the Simple_Case_Folding of the code point, if any;
3124 * otherwise the code point itself.
3127 U_STABLE UChar32 U_EXPORT2
3128 u_foldCase(UChar32 c
, uint32_t options
);
3131 * Returns the decimal digit value of the code point in the
3134 * If the radix is not in the range <code>2<=radix<=36</code> or if the
3135 * value of <code>c</code> is not a valid digit in the specified
3136 * radix, <code>-1</code> is returned. A character is a valid digit
3137 * if at least one of the following is true:
3139 * <li>The character has a decimal digit value.
3140 * Such characters have the general category "Nd" (decimal digit numbers)
3141 * and a Numeric_Type of Decimal.
3142 * In this case the value is the character's decimal digit value.</li>
3143 * <li>The character is one of the uppercase Latin letters
3144 * <code>'A'</code> through <code>'Z'</code>.
3145 * In this case the value is <code>c-'A'+10</code>.</li>
3146 * <li>The character is one of the lowercase Latin letters
3147 * <code>'a'</code> through <code>'z'</code>.
3148 * In this case the value is <code>ch-'a'+10</code>.</li>
3149 * <li>Latin letters from both the ASCII range (0061..007A, 0041..005A)
3150 * as well as from the Fullwidth ASCII range (FF41..FF5A, FF21..FF3A)
3151 * are recognized.</li>
3154 * Same as java.lang.Character.digit().
3156 * @param ch the code point to be tested.
3157 * @param radix the radix.
3158 * @return the numeric value represented by the character in the
3160 * or -1 if there is no value or if the value exceeds the radix.
3162 * @see UCHAR_NUMERIC_TYPE
3164 * @see u_charDigitValue
3168 U_STABLE
int32_t U_EXPORT2
3169 u_digit(UChar32 ch
, int8_t radix
);
3172 * Determines the character representation for a specific digit in
3173 * the specified radix. If the value of <code>radix</code> is not a
3174 * valid radix, or the value of <code>digit</code> is not a valid
3175 * digit in the specified radix, the null character
3176 * (<code>U+0000</code>) is returned.
3178 * The <code>radix</code> argument is valid if it is greater than or
3179 * equal to 2 and less than or equal to 36.
3180 * The <code>digit</code> argument is valid if
3181 * <code>0 <= digit < radix</code>.
3183 * If the digit is less than 10, then
3184 * <code>'0' + digit</code> is returned. Otherwise, the value
3185 * <code>'a' + digit - 10</code> is returned.
3187 * Same as java.lang.Character.forDigit().
3189 * @param digit the number to convert to a character.
3190 * @param radix the radix.
3191 * @return the <code>char</code> representation of the specified digit
3192 * in the specified radix.
3195 * @see u_charDigitValue
3199 U_STABLE UChar32 U_EXPORT2
3200 u_forDigit(int32_t digit
, int8_t radix
);
3203 * Get the "age" of the code point.
3204 * The "age" is the Unicode version when the code point was first
3205 * designated (as a non-character or for Private Use)
3206 * or assigned a character.
3207 * This can be useful to avoid emitting code points to receiving
3208 * processes that do not accept newer characters.
3209 * The data is from the UCD file DerivedAge.txt.
3211 * @param c The code point.
3212 * @param versionArray The Unicode version number array, to be filled in.
3216 U_STABLE
void U_EXPORT2
3217 u_charAge(UChar32 c
, UVersionInfo versionArray
);
3220 * Gets the Unicode version information.
3221 * The version array is filled in with the version information
3222 * for the Unicode standard that is currently used by ICU.
3223 * For example, Unicode version 3.1.1 is represented as an array with
3224 * the values { 3, 1, 1, 0 }.
3226 * @param versionArray an output array that will be filled in with
3227 * the Unicode version number
3230 U_STABLE
void U_EXPORT2
3231 u_getUnicodeVersion(UVersionInfo versionArray
);
3233 #if !UCONFIG_NO_NORMALIZATION
3235 * Get the FC_NFKC_Closure property string for a character.
3236 * See Unicode Standard Annex #15 for details, search for "FC_NFKC_Closure"
3237 * or for "FNC": http://www.unicode.org/reports/tr15/
3239 * @param c The character (code point) for which to get the FC_NFKC_Closure string.
3240 * It must be <code>0<=c<=0x10ffff</code>.
3241 * @param dest Destination address for copying the string.
3242 * The string will be zero-terminated if possible.
3243 * If there is no FC_NFKC_Closure string,
3244 * then the buffer will be set to the empty string.
3245 * @param destCapacity <code>==sizeof(dest)</code>
3246 * @param pErrorCode Pointer to a UErrorCode variable.
3247 * @return The length of the string, or 0 if there is no FC_NFKC_Closure string for this character.
3248 * If the destCapacity is less than or equal to the length, then the buffer
3249 * contains the truncated name and the returned length indicates the full
3250 * length of the name.
3251 * The length does not include the zero-termination.
3255 U_STABLE
int32_t U_EXPORT2
3256 u_getFC_NFKC_Closure(UChar32 c
, UChar
*dest
, int32_t destCapacity
, UErrorCode
*pErrorCode
);