]> git.saurik.com Git - apple/icu.git/blob - icuSources/common/unicode/uchar.h
ICU-59117.0.1.tar.gz
[apple/icu.git] / icuSources / common / unicode / uchar.h
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 **********************************************************************
5 * Copyright (C) 1997-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 **********************************************************************
8 *
9 * File UCHAR.H
10 *
11 * Modification History:
12 *
13 * Date Name Description
14 * 04/02/97 aliu Creation.
15 * 03/29/99 helena Updated for C APIs.
16 * 4/15/99 Madhu Updated for C Implementation and Javadoc
17 * 5/20/99 Madhu Added the function u_getVersion()
18 * 8/19/1999 srl Upgraded scripts to Unicode 3.0
19 * 8/27/1999 schererm UCharDirection constants: U_...
20 * 11/11/1999 weiv added u_isalnum(), cleaned comments
21 * 01/11/2000 helena Renamed u_getVersion to u_getUnicodeVersion().
22 ******************************************************************************
23 */
24
25 #ifndef UCHAR_H
26 #define UCHAR_H
27
28 #include "unicode/utypes.h"
29
30 U_CDECL_BEGIN
31
32 /*==========================================================================*/
33 /* Unicode version number */
34 /*==========================================================================*/
35 /**
36 * Unicode version number, default for the current ICU version.
37 * The actual Unicode Character Database (UCD) data is stored in uprops.dat
38 * and may be generated from UCD files from a different Unicode version.
39 * Call u_getUnicodeVersion to get the actual Unicode version of the data.
40 *
41 * @see u_getUnicodeVersion
42 * @stable ICU 2.0
43 */
44 #define U_UNICODE_VERSION "9.0"
45
46 /**
47 * \file
48 * \brief C API: Unicode Properties
49 *
50 * This C API provides low-level access to the Unicode Character Database.
51 * In addition to raw property values, some convenience functions calculate
52 * derived properties, for example for Java-style programming.
53 *
54 * Unicode assigns each code point (not just assigned character) values for
55 * many properties.
56 * Most of them are simple boolean flags, or constants from a small enumerated list.
57 * For some properties, values are strings or other relatively more complex types.
58 *
59 * For more information see
60 * "About the Unicode Character Database" (http://www.unicode.org/ucd/)
61 * and the ICU User Guide chapter on Properties (http://icu-project.org/userguide/properties.html).
62 *
63 * Many functions are designed to match java.lang.Character functions.
64 * See the individual function documentation,
65 * and see the JDK 1.4 java.lang.Character documentation
66 * at http://java.sun.com/j2se/1.4/docs/api/java/lang/Character.html
67 *
68 * There are also functions that provide easy migration from C/POSIX functions
69 * like isblank(). Their use is generally discouraged because the C/POSIX
70 * standards do not define their semantics beyond the ASCII range, which means
71 * that different implementations exhibit very different behavior.
72 * Instead, Unicode properties should be used directly.
73 *
74 * There are also only a few, broad C/POSIX character classes, and they tend
75 * to be used for conflicting purposes. For example, the "isalpha()" class
76 * is sometimes used to determine word boundaries, while a more sophisticated
77 * approach would at least distinguish initial letters from continuation
78 * characters (the latter including combining marks).
79 * (In ICU, BreakIterator is the most sophisticated API for word boundaries.)
80 * Another example: There is no "istitle()" class for titlecase characters.
81 *
82 * ICU 3.4 and later provides API access for all twelve C/POSIX character classes.
83 * ICU implements them according to the Standard Recommendations in
84 * Annex C: Compatibility Properties of UTS #18 Unicode Regular Expressions
85 * (http://www.unicode.org/reports/tr18/#Compatibility_Properties).
86 *
87 * API access for C/POSIX character classes is as follows:
88 * - alpha: u_isUAlphabetic(c) or u_hasBinaryProperty(c, UCHAR_ALPHABETIC)
89 * - lower: u_isULowercase(c) or u_hasBinaryProperty(c, UCHAR_LOWERCASE)
90 * - upper: u_isUUppercase(c) or u_hasBinaryProperty(c, UCHAR_UPPERCASE)
91 * - punct: u_ispunct(c)
92 * - digit: u_isdigit(c) or u_charType(c)==U_DECIMAL_DIGIT_NUMBER
93 * - xdigit: u_isxdigit(c) or u_hasBinaryProperty(c, UCHAR_POSIX_XDIGIT)
94 * - alnum: u_hasBinaryProperty(c, UCHAR_POSIX_ALNUM)
95 * - space: u_isUWhiteSpace(c) or u_hasBinaryProperty(c, UCHAR_WHITE_SPACE)
96 * - blank: u_isblank(c) or u_hasBinaryProperty(c, UCHAR_POSIX_BLANK)
97 * - cntrl: u_charType(c)==U_CONTROL_CHAR
98 * - graph: u_hasBinaryProperty(c, UCHAR_POSIX_GRAPH)
99 * - print: u_hasBinaryProperty(c, UCHAR_POSIX_PRINT)
100 *
101 * Note: Some of the u_isxyz() functions in uchar.h predate, and do not match,
102 * the Standard Recommendations in UTS #18. Instead, they match Java
103 * functions according to their API documentation.
104 *
105 * \htmlonly
106 * The C/POSIX character classes are also available in UnicodeSet patterns,
107 * using patterns like [:graph:] or \p{graph}.
108 * \endhtmlonly
109 *
110 * Note: There are several ICU whitespace functions.
111 * Comparison:
112 * - u_isUWhiteSpace=UCHAR_WHITE_SPACE: Unicode White_Space property;
113 * most of general categories "Z" (separators) + most whitespace ISO controls
114 * (including no-break spaces, but excluding IS1..IS4 and ZWSP)
115 * - u_isWhitespace: Java isWhitespace; Z + whitespace ISO controls but excluding no-break spaces
116 * - u_isJavaSpaceChar: Java isSpaceChar; just Z (including no-break spaces)
117 * - u_isspace: Z + whitespace ISO controls (including no-break spaces)
118 * - u_isblank: "horizontal spaces" = TAB + Zs - ZWSP
119 */
120
121 /**
122 * Constants.
123 */
124
125 /** The lowest Unicode code point value. Code points are non-negative. @stable ICU 2.0 */
126 #define UCHAR_MIN_VALUE 0
127
128 /**
129 * The highest Unicode code point value (scalar value) according to
130 * The Unicode Standard. This is a 21-bit value (20.1 bits, rounded up).
131 * For a single character, UChar32 is a simple type that can hold any code point value.
132 *
133 * @see UChar32
134 * @stable ICU 2.0
135 */
136 #define UCHAR_MAX_VALUE 0x10ffff
137
138 /**
139 * Get a single-bit bit set (a flag) from a bit number 0..31.
140 * @stable ICU 2.1
141 */
142 #define U_MASK(x) ((uint32_t)1<<(x))
143
144 /**
145 * Selection constants for Unicode properties.
146 * These constants are used in functions like u_hasBinaryProperty to select
147 * one of the Unicode properties.
148 *
149 * The properties APIs are intended to reflect Unicode properties as defined
150 * in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).
151 * For details about the properties see http://www.unicode.org/ucd/ .
152 * For names of Unicode properties see the UCD file PropertyAliases.txt.
153 *
154 * Important: If ICU is built with UCD files from Unicode versions below, e.g., 3.2,
155 * then properties marked with "new in Unicode 3.2" are not or not fully available.
156 * Check u_getUnicodeVersion to be sure.
157 *
158 * @see u_hasBinaryProperty
159 * @see u_getIntPropertyValue
160 * @see u_getUnicodeVersion
161 * @stable ICU 2.1
162 */
163 typedef enum UProperty {
164 /*
165 * Note: UProperty constants are parsed by preparseucd.py.
166 * It matches lines like
167 * UCHAR_<Unicode property name>=<integer>,
168 */
169
170 /* Note: Place UCHAR_ALPHABETIC before UCHAR_BINARY_START so that
171 debuggers display UCHAR_ALPHABETIC as the symbolic name for 0,
172 rather than UCHAR_BINARY_START. Likewise for other *_START
173 identifiers. */
174
175 /** Binary property Alphabetic. Same as u_isUAlphabetic, different from u_isalpha.
176 Lu+Ll+Lt+Lm+Lo+Nl+Other_Alphabetic @stable ICU 2.1 */
177 UCHAR_ALPHABETIC=0,
178 /** First constant for binary Unicode properties. @stable ICU 2.1 */
179 UCHAR_BINARY_START=UCHAR_ALPHABETIC,
180 /** Binary property ASCII_Hex_Digit. 0-9 A-F a-f @stable ICU 2.1 */
181 UCHAR_ASCII_HEX_DIGIT=1,
182 /** Binary property Bidi_Control.
183 Format controls which have specific functions
184 in the Bidi Algorithm. @stable ICU 2.1 */
185 UCHAR_BIDI_CONTROL=2,
186 /** Binary property Bidi_Mirrored.
187 Characters that may change display in RTL text.
188 Same as u_isMirrored.
189 See Bidi Algorithm, UTR 9. @stable ICU 2.1 */
190 UCHAR_BIDI_MIRRORED=3,
191 /** Binary property Dash. Variations of dashes. @stable ICU 2.1 */
192 UCHAR_DASH=4,
193 /** Binary property Default_Ignorable_Code_Point (new in Unicode 3.2).
194 Ignorable in most processing.
195 <2060..206F, FFF0..FFFB, E0000..E0FFF>+Other_Default_Ignorable_Code_Point+(Cf+Cc+Cs-White_Space) @stable ICU 2.1 */
196 UCHAR_DEFAULT_IGNORABLE_CODE_POINT=5,
197 /** Binary property Deprecated (new in Unicode 3.2).
198 The usage of deprecated characters is strongly discouraged. @stable ICU 2.1 */
199 UCHAR_DEPRECATED=6,
200 /** Binary property Diacritic. Characters that linguistically modify
201 the meaning of another character to which they apply. @stable ICU 2.1 */
202 UCHAR_DIACRITIC=7,
203 /** Binary property Extender.
204 Extend the value or shape of a preceding alphabetic character,
205 e.g., length and iteration marks. @stable ICU 2.1 */
206 UCHAR_EXTENDER=8,
207 /** Binary property Full_Composition_Exclusion.
208 CompositionExclusions.txt+Singleton Decompositions+
209 Non-Starter Decompositions. @stable ICU 2.1 */
210 UCHAR_FULL_COMPOSITION_EXCLUSION=9,
211 /** Binary property Grapheme_Base (new in Unicode 3.2).
212 For programmatic determination of grapheme cluster boundaries.
213 [0..10FFFF]-Cc-Cf-Cs-Co-Cn-Zl-Zp-Grapheme_Link-Grapheme_Extend-CGJ @stable ICU 2.1 */
214 UCHAR_GRAPHEME_BASE=10,
215 /** Binary property Grapheme_Extend (new in Unicode 3.2).
216 For programmatic determination of grapheme cluster boundaries.
217 Me+Mn+Mc+Other_Grapheme_Extend-Grapheme_Link-CGJ @stable ICU 2.1 */
218 UCHAR_GRAPHEME_EXTEND=11,
219 /** Binary property Grapheme_Link (new in Unicode 3.2).
220 For programmatic determination of grapheme cluster boundaries. @stable ICU 2.1 */
221 UCHAR_GRAPHEME_LINK=12,
222 /** Binary property Hex_Digit.
223 Characters commonly used for hexadecimal numbers. @stable ICU 2.1 */
224 UCHAR_HEX_DIGIT=13,
225 /** Binary property Hyphen. Dashes used to mark connections
226 between pieces of words, plus the Katakana middle dot. @stable ICU 2.1 */
227 UCHAR_HYPHEN=14,
228 /** Binary property ID_Continue.
229 Characters that can continue an identifier.
230 DerivedCoreProperties.txt also says "NOTE: Cf characters should be filtered out."
231 ID_Start+Mn+Mc+Nd+Pc @stable ICU 2.1 */
232 UCHAR_ID_CONTINUE=15,
233 /** Binary property ID_Start.
234 Characters that can start an identifier.
235 Lu+Ll+Lt+Lm+Lo+Nl @stable ICU 2.1 */
236 UCHAR_ID_START=16,
237 /** Binary property Ideographic.
238 CJKV ideographs. @stable ICU 2.1 */
239 UCHAR_IDEOGRAPHIC=17,
240 /** Binary property IDS_Binary_Operator (new in Unicode 3.2).
241 For programmatic determination of
242 Ideographic Description Sequences. @stable ICU 2.1 */
243 UCHAR_IDS_BINARY_OPERATOR=18,
244 /** Binary property IDS_Trinary_Operator (new in Unicode 3.2).
245 For programmatic determination of
246 Ideographic Description Sequences. @stable ICU 2.1 */
247 UCHAR_IDS_TRINARY_OPERATOR=19,
248 /** Binary property Join_Control.
249 Format controls for cursive joining and ligation. @stable ICU 2.1 */
250 UCHAR_JOIN_CONTROL=20,
251 /** Binary property Logical_Order_Exception (new in Unicode 3.2).
252 Characters that do not use logical order and
253 require special handling in most processing. @stable ICU 2.1 */
254 UCHAR_LOGICAL_ORDER_EXCEPTION=21,
255 /** Binary property Lowercase. Same as u_isULowercase, different from u_islower.
256 Ll+Other_Lowercase @stable ICU 2.1 */
257 UCHAR_LOWERCASE=22,
258 /** Binary property Math. Sm+Other_Math @stable ICU 2.1 */
259 UCHAR_MATH=23,
260 /** Binary property Noncharacter_Code_Point.
261 Code points that are explicitly defined as illegal
262 for the encoding of characters. @stable ICU 2.1 */
263 UCHAR_NONCHARACTER_CODE_POINT=24,
264 /** Binary property Quotation_Mark. @stable ICU 2.1 */
265 UCHAR_QUOTATION_MARK=25,
266 /** Binary property Radical (new in Unicode 3.2).
267 For programmatic determination of
268 Ideographic Description Sequences. @stable ICU 2.1 */
269 UCHAR_RADICAL=26,
270 /** Binary property Soft_Dotted (new in Unicode 3.2).
271 Characters with a "soft dot", like i or j.
272 An accent placed on these characters causes
273 the dot to disappear. @stable ICU 2.1 */
274 UCHAR_SOFT_DOTTED=27,
275 /** Binary property Terminal_Punctuation.
276 Punctuation characters that generally mark
277 the end of textual units. @stable ICU 2.1 */
278 UCHAR_TERMINAL_PUNCTUATION=28,
279 /** Binary property Unified_Ideograph (new in Unicode 3.2).
280 For programmatic determination of
281 Ideographic Description Sequences. @stable ICU 2.1 */
282 UCHAR_UNIFIED_IDEOGRAPH=29,
283 /** Binary property Uppercase. Same as u_isUUppercase, different from u_isupper.
284 Lu+Other_Uppercase @stable ICU 2.1 */
285 UCHAR_UPPERCASE=30,
286 /** Binary property White_Space.
287 Same as u_isUWhiteSpace, different from u_isspace and u_isWhitespace.
288 Space characters+TAB+CR+LF-ZWSP-ZWNBSP @stable ICU 2.1 */
289 UCHAR_WHITE_SPACE=31,
290 /** Binary property XID_Continue.
291 ID_Continue modified to allow closure under
292 normalization forms NFKC and NFKD. @stable ICU 2.1 */
293 UCHAR_XID_CONTINUE=32,
294 /** Binary property XID_Start. ID_Start modified to allow
295 closure under normalization forms NFKC and NFKD. @stable ICU 2.1 */
296 UCHAR_XID_START=33,
297 /** Binary property Case_Sensitive. Either the source of a case
298 mapping or _in_ the target of a case mapping. Not the same as
299 the general category Cased_Letter. @stable ICU 2.6 */
300 UCHAR_CASE_SENSITIVE=34,
301 /** Binary property STerm (new in Unicode 4.0.1).
302 Sentence Terminal. Used in UAX #29: Text Boundaries
303 (http://www.unicode.org/reports/tr29/)
304 @stable ICU 3.0 */
305 UCHAR_S_TERM=35,
306 /** Binary property Variation_Selector (new in Unicode 4.0.1).
307 Indicates all those characters that qualify as Variation Selectors.
308 For details on the behavior of these characters,
309 see StandardizedVariants.html and 15.6 Variation Selectors.
310 @stable ICU 3.0 */
311 UCHAR_VARIATION_SELECTOR=36,
312 /** Binary property NFD_Inert.
313 ICU-specific property for characters that are inert under NFD,
314 i.e., they do not interact with adjacent characters.
315 See the documentation for the Normalizer2 class and the
316 Normalizer2::isInert() method.
317 @stable ICU 3.0 */
318 UCHAR_NFD_INERT=37,
319 /** Binary property NFKD_Inert.
320 ICU-specific property for characters that are inert under NFKD,
321 i.e., they do not interact with adjacent characters.
322 See the documentation for the Normalizer2 class and the
323 Normalizer2::isInert() method.
324 @stable ICU 3.0 */
325 UCHAR_NFKD_INERT=38,
326 /** Binary property NFC_Inert.
327 ICU-specific property for characters that are inert under NFC,
328 i.e., they do not interact with adjacent characters.
329 See the documentation for the Normalizer2 class and the
330 Normalizer2::isInert() method.
331 @stable ICU 3.0 */
332 UCHAR_NFC_INERT=39,
333 /** Binary property NFKC_Inert.
334 ICU-specific property for characters that are inert under NFKC,
335 i.e., they do not interact with adjacent characters.
336 See the documentation for the Normalizer2 class and the
337 Normalizer2::isInert() method.
338 @stable ICU 3.0 */
339 UCHAR_NFKC_INERT=40,
340 /** Binary Property Segment_Starter.
341 ICU-specific property for characters that are starters in terms of
342 Unicode normalization and combining character sequences.
343 They have ccc=0 and do not occur in non-initial position of the
344 canonical decomposition of any character
345 (like a-umlaut in NFD and a Jamo T in an NFD(Hangul LVT)).
346 ICU uses this property for segmenting a string for generating a set of
347 canonically equivalent strings, e.g. for canonical closure while
348 processing collation tailoring rules.
349 @stable ICU 3.0 */
350 UCHAR_SEGMENT_STARTER=41,
351 /** Binary property Pattern_Syntax (new in Unicode 4.1).
352 See UAX #31 Identifier and Pattern Syntax
353 (http://www.unicode.org/reports/tr31/)
354 @stable ICU 3.4 */
355 UCHAR_PATTERN_SYNTAX=42,
356 /** Binary property Pattern_White_Space (new in Unicode 4.1).
357 See UAX #31 Identifier and Pattern Syntax
358 (http://www.unicode.org/reports/tr31/)
359 @stable ICU 3.4 */
360 UCHAR_PATTERN_WHITE_SPACE=43,
361 /** Binary property alnum (a C/POSIX character class).
362 Implemented according to the UTS #18 Annex C Standard Recommendation.
363 See the uchar.h file documentation.
364 @stable ICU 3.4 */
365 UCHAR_POSIX_ALNUM=44,
366 /** Binary property blank (a C/POSIX character class).
367 Implemented according to the UTS #18 Annex C Standard Recommendation.
368 See the uchar.h file documentation.
369 @stable ICU 3.4 */
370 UCHAR_POSIX_BLANK=45,
371 /** Binary property graph (a C/POSIX character class).
372 Implemented according to the UTS #18 Annex C Standard Recommendation.
373 See the uchar.h file documentation.
374 @stable ICU 3.4 */
375 UCHAR_POSIX_GRAPH=46,
376 /** Binary property print (a C/POSIX character class).
377 Implemented according to the UTS #18 Annex C Standard Recommendation.
378 See the uchar.h file documentation.
379 @stable ICU 3.4 */
380 UCHAR_POSIX_PRINT=47,
381 /** Binary property xdigit (a C/POSIX character class).
382 Implemented according to the UTS #18 Annex C Standard Recommendation.
383 See the uchar.h file documentation.
384 @stable ICU 3.4 */
385 UCHAR_POSIX_XDIGIT=48,
386 /** Binary property Cased. For Lowercase, Uppercase and Titlecase characters. @stable ICU 4.4 */
387 UCHAR_CASED=49,
388 /** Binary property Case_Ignorable. Used in context-sensitive case mappings. @stable ICU 4.4 */
389 UCHAR_CASE_IGNORABLE=50,
390 /** Binary property Changes_When_Lowercased. @stable ICU 4.4 */
391 UCHAR_CHANGES_WHEN_LOWERCASED=51,
392 /** Binary property Changes_When_Uppercased. @stable ICU 4.4 */
393 UCHAR_CHANGES_WHEN_UPPERCASED=52,
394 /** Binary property Changes_When_Titlecased. @stable ICU 4.4 */
395 UCHAR_CHANGES_WHEN_TITLECASED=53,
396 /** Binary property Changes_When_Casefolded. @stable ICU 4.4 */
397 UCHAR_CHANGES_WHEN_CASEFOLDED=54,
398 /** Binary property Changes_When_Casemapped. @stable ICU 4.4 */
399 UCHAR_CHANGES_WHEN_CASEMAPPED=55,
400 /** Binary property Changes_When_NFKC_Casefolded. @stable ICU 4.4 */
401 UCHAR_CHANGES_WHEN_NFKC_CASEFOLDED=56,
402 /**
403 * Binary property Emoji.
404 * See http://www.unicode.org/reports/tr51/#Emoji_Properties
405 *
406 * @stable ICU 57
407 */
408 UCHAR_EMOJI=57,
409 /**
410 * Binary property Emoji_Presentation.
411 * See http://www.unicode.org/reports/tr51/#Emoji_Properties
412 *
413 * @stable ICU 57
414 */
415 UCHAR_EMOJI_PRESENTATION=58,
416 /**
417 * Binary property Emoji_Modifier.
418 * See http://www.unicode.org/reports/tr51/#Emoji_Properties
419 *
420 * @stable ICU 57
421 */
422 UCHAR_EMOJI_MODIFIER=59,
423 /**
424 * Binary property Emoji_Modifier_Base.
425 * See http://www.unicode.org/reports/tr51/#Emoji_Properties
426 *
427 * @stable ICU 57
428 */
429 UCHAR_EMOJI_MODIFIER_BASE=60,
430 #ifndef U_HIDE_DEPRECATED_API
431 /**
432 * One more than the last constant for binary Unicode properties.
433 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
434 */
435 UCHAR_BINARY_LIMIT=61,
436 #endif // U_HIDE_DEPRECATED_API
437
438 /** Enumerated property Bidi_Class.
439 Same as u_charDirection, returns UCharDirection values. @stable ICU 2.2 */
440 UCHAR_BIDI_CLASS=0x1000,
441 /** First constant for enumerated/integer Unicode properties. @stable ICU 2.2 */
442 UCHAR_INT_START=UCHAR_BIDI_CLASS,
443 /** Enumerated property Block.
444 Same as ublock_getCode, returns UBlockCode values. @stable ICU 2.2 */
445 UCHAR_BLOCK=0x1001,
446 /** Enumerated property Canonical_Combining_Class.
447 Same as u_getCombiningClass, returns 8-bit numeric values. @stable ICU 2.2 */
448 UCHAR_CANONICAL_COMBINING_CLASS=0x1002,
449 /** Enumerated property Decomposition_Type.
450 Returns UDecompositionType values. @stable ICU 2.2 */
451 UCHAR_DECOMPOSITION_TYPE=0x1003,
452 /** Enumerated property East_Asian_Width.
453 See http://www.unicode.org/reports/tr11/
454 Returns UEastAsianWidth values. @stable ICU 2.2 */
455 UCHAR_EAST_ASIAN_WIDTH=0x1004,
456 /** Enumerated property General_Category.
457 Same as u_charType, returns UCharCategory values. @stable ICU 2.2 */
458 UCHAR_GENERAL_CATEGORY=0x1005,
459 /** Enumerated property Joining_Group.
460 Returns UJoiningGroup values. @stable ICU 2.2 */
461 UCHAR_JOINING_GROUP=0x1006,
462 /** Enumerated property Joining_Type.
463 Returns UJoiningType values. @stable ICU 2.2 */
464 UCHAR_JOINING_TYPE=0x1007,
465 /** Enumerated property Line_Break.
466 Returns ULineBreak values. @stable ICU 2.2 */
467 UCHAR_LINE_BREAK=0x1008,
468 /** Enumerated property Numeric_Type.
469 Returns UNumericType values. @stable ICU 2.2 */
470 UCHAR_NUMERIC_TYPE=0x1009,
471 /** Enumerated property Script.
472 Same as uscript_getScript, returns UScriptCode values. @stable ICU 2.2 */
473 UCHAR_SCRIPT=0x100A,
474 /** Enumerated property Hangul_Syllable_Type, new in Unicode 4.
475 Returns UHangulSyllableType values. @stable ICU 2.6 */
476 UCHAR_HANGUL_SYLLABLE_TYPE=0x100B,
477 /** Enumerated property NFD_Quick_Check.
478 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
479 UCHAR_NFD_QUICK_CHECK=0x100C,
480 /** Enumerated property NFKD_Quick_Check.
481 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
482 UCHAR_NFKD_QUICK_CHECK=0x100D,
483 /** Enumerated property NFC_Quick_Check.
484 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
485 UCHAR_NFC_QUICK_CHECK=0x100E,
486 /** Enumerated property NFKC_Quick_Check.
487 Returns UNormalizationCheckResult values. @stable ICU 3.0 */
488 UCHAR_NFKC_QUICK_CHECK=0x100F,
489 /** Enumerated property Lead_Canonical_Combining_Class.
490 ICU-specific property for the ccc of the first code point
491 of the decomposition, or lccc(c)=ccc(NFD(c)[0]).
492 Useful for checking for canonically ordered text;
493 see UNORM_FCD and http://www.unicode.org/notes/tn5/#FCD .
494 Returns 8-bit numeric values like UCHAR_CANONICAL_COMBINING_CLASS. @stable ICU 3.0 */
495 UCHAR_LEAD_CANONICAL_COMBINING_CLASS=0x1010,
496 /** Enumerated property Trail_Canonical_Combining_Class.
497 ICU-specific property for the ccc of the last code point
498 of the decomposition, or tccc(c)=ccc(NFD(c)[last]).
499 Useful for checking for canonically ordered text;
500 see UNORM_FCD and http://www.unicode.org/notes/tn5/#FCD .
501 Returns 8-bit numeric values like UCHAR_CANONICAL_COMBINING_CLASS. @stable ICU 3.0 */
502 UCHAR_TRAIL_CANONICAL_COMBINING_CLASS=0x1011,
503 /** Enumerated property Grapheme_Cluster_Break (new in Unicode 4.1).
504 Used in UAX #29: Text Boundaries
505 (http://www.unicode.org/reports/tr29/)
506 Returns UGraphemeClusterBreak values. @stable ICU 3.4 */
507 UCHAR_GRAPHEME_CLUSTER_BREAK=0x1012,
508 /** Enumerated property Sentence_Break (new in Unicode 4.1).
509 Used in UAX #29: Text Boundaries
510 (http://www.unicode.org/reports/tr29/)
511 Returns USentenceBreak values. @stable ICU 3.4 */
512 UCHAR_SENTENCE_BREAK=0x1013,
513 /** Enumerated property Word_Break (new in Unicode 4.1).
514 Used in UAX #29: Text Boundaries
515 (http://www.unicode.org/reports/tr29/)
516 Returns UWordBreakValues values. @stable ICU 3.4 */
517 UCHAR_WORD_BREAK=0x1014,
518 /** Enumerated property Bidi_Paired_Bracket_Type (new in Unicode 6.3).
519 Used in UAX #9: Unicode Bidirectional Algorithm
520 (http://www.unicode.org/reports/tr9/)
521 Returns UBidiPairedBracketType values. @stable ICU 52 */
522 UCHAR_BIDI_PAIRED_BRACKET_TYPE=0x1015,
523 #ifndef U_HIDE_DEPRECATED_API
524 /**
525 * One more than the last constant for enumerated/integer Unicode properties.
526 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
527 */
528 UCHAR_INT_LIMIT=0x1016,
529 #endif // U_HIDE_DEPRECATED_API
530
531 /** Bitmask property General_Category_Mask.
532 This is the General_Category property returned as a bit mask.
533 When used in u_getIntPropertyValue(c), same as U_MASK(u_charType(c)),
534 returns bit masks for UCharCategory values where exactly one bit is set.
535 When used with u_getPropertyValueName() and u_getPropertyValueEnum(),
536 a multi-bit mask is used for sets of categories like "Letters".
537 Mask values should be cast to uint32_t.
538 @stable ICU 2.4 */
539 UCHAR_GENERAL_CATEGORY_MASK=0x2000,
540 /** First constant for bit-mask Unicode properties. @stable ICU 2.4 */
541 UCHAR_MASK_START=UCHAR_GENERAL_CATEGORY_MASK,
542 #ifndef U_HIDE_DEPRECATED_API
543 /**
544 * One more than the last constant for bit-mask Unicode properties.
545 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
546 */
547 UCHAR_MASK_LIMIT=0x2001,
548 #endif // U_HIDE_DEPRECATED_API
549
550 /** Double property Numeric_Value.
551 Corresponds to u_getNumericValue. @stable ICU 2.4 */
552 UCHAR_NUMERIC_VALUE=0x3000,
553 /** First constant for double Unicode properties. @stable ICU 2.4 */
554 UCHAR_DOUBLE_START=UCHAR_NUMERIC_VALUE,
555 #ifndef U_HIDE_DEPRECATED_API
556 /**
557 * One more than the last constant for double Unicode properties.
558 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
559 */
560 UCHAR_DOUBLE_LIMIT=0x3001,
561 #endif // U_HIDE_DEPRECATED_API
562
563 /** String property Age.
564 Corresponds to u_charAge. @stable ICU 2.4 */
565 UCHAR_AGE=0x4000,
566 /** First constant for string Unicode properties. @stable ICU 2.4 */
567 UCHAR_STRING_START=UCHAR_AGE,
568 /** String property Bidi_Mirroring_Glyph.
569 Corresponds to u_charMirror. @stable ICU 2.4 */
570 UCHAR_BIDI_MIRRORING_GLYPH=0x4001,
571 /** String property Case_Folding.
572 Corresponds to u_strFoldCase in ustring.h. @stable ICU 2.4 */
573 UCHAR_CASE_FOLDING=0x4002,
574 #ifndef U_HIDE_DEPRECATED_API
575 /** Deprecated string property ISO_Comment.
576 Corresponds to u_getISOComment. @deprecated ICU 49 */
577 UCHAR_ISO_COMMENT=0x4003,
578 #endif /* U_HIDE_DEPRECATED_API */
579 /** String property Lowercase_Mapping.
580 Corresponds to u_strToLower in ustring.h. @stable ICU 2.4 */
581 UCHAR_LOWERCASE_MAPPING=0x4004,
582 /** String property Name.
583 Corresponds to u_charName. @stable ICU 2.4 */
584 UCHAR_NAME=0x4005,
585 /** String property Simple_Case_Folding.
586 Corresponds to u_foldCase. @stable ICU 2.4 */
587 UCHAR_SIMPLE_CASE_FOLDING=0x4006,
588 /** String property Simple_Lowercase_Mapping.
589 Corresponds to u_tolower. @stable ICU 2.4 */
590 UCHAR_SIMPLE_LOWERCASE_MAPPING=0x4007,
591 /** String property Simple_Titlecase_Mapping.
592 Corresponds to u_totitle. @stable ICU 2.4 */
593 UCHAR_SIMPLE_TITLECASE_MAPPING=0x4008,
594 /** String property Simple_Uppercase_Mapping.
595 Corresponds to u_toupper. @stable ICU 2.4 */
596 UCHAR_SIMPLE_UPPERCASE_MAPPING=0x4009,
597 /** String property Titlecase_Mapping.
598 Corresponds to u_strToTitle in ustring.h. @stable ICU 2.4 */
599 UCHAR_TITLECASE_MAPPING=0x400A,
600 #ifndef U_HIDE_DEPRECATED_API
601 /** String property Unicode_1_Name.
602 This property is of little practical value.
603 Beginning with ICU 49, ICU APIs return an empty string for this property.
604 Corresponds to u_charName(U_UNICODE_10_CHAR_NAME). @deprecated ICU 49 */
605 UCHAR_UNICODE_1_NAME=0x400B,
606 #endif /* U_HIDE_DEPRECATED_API */
607 /** String property Uppercase_Mapping.
608 Corresponds to u_strToUpper in ustring.h. @stable ICU 2.4 */
609 UCHAR_UPPERCASE_MAPPING=0x400C,
610 /** String property Bidi_Paired_Bracket (new in Unicode 6.3).
611 Corresponds to u_getBidiPairedBracket. @stable ICU 52 */
612 UCHAR_BIDI_PAIRED_BRACKET=0x400D,
613 #ifndef U_HIDE_DEPRECATED_API
614 /**
615 * One more than the last constant for string Unicode properties.
616 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
617 */
618 UCHAR_STRING_LIMIT=0x400E,
619 #endif // U_HIDE_DEPRECATED_API
620
621 /** Miscellaneous property Script_Extensions (new in Unicode 6.0).
622 Some characters are commonly used in multiple scripts.
623 For more information, see UAX #24: http://www.unicode.org/reports/tr24/.
624 Corresponds to uscript_hasScript and uscript_getScriptExtensions in uscript.h.
625 @stable ICU 4.6 */
626 UCHAR_SCRIPT_EXTENSIONS=0x7000,
627 /** First constant for Unicode properties with unusual value types. @stable ICU 4.6 */
628 UCHAR_OTHER_PROPERTY_START=UCHAR_SCRIPT_EXTENSIONS,
629 #ifndef U_HIDE_DEPRECATED_API
630 /**
631 * One more than the last constant for Unicode properties with unusual value types.
632 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
633 */
634 UCHAR_OTHER_PROPERTY_LIMIT=0x7001,
635 #endif // U_HIDE_DEPRECATED_API
636
637 /** Represents a nonexistent or invalid property or property value. @stable ICU 2.4 */
638 UCHAR_INVALID_CODE = -1
639 } UProperty;
640
641 /**
642 * Data for enumerated Unicode general category types.
643 * See http://www.unicode.org/Public/UNIDATA/UnicodeData.html .
644 * @stable ICU 2.0
645 */
646 typedef enum UCharCategory
647 {
648 /*
649 * Note: UCharCategory constants and their API comments are parsed by preparseucd.py.
650 * It matches pairs of lines like
651 * / ** <Unicode 2-letter General_Category value> comment... * /
652 * U_<[A-Z_]+> = <integer>,
653 */
654
655 /** Non-category for unassigned and non-character code points. @stable ICU 2.0 */
656 U_UNASSIGNED = 0,
657 /** Cn "Other, Not Assigned (no characters in [UnicodeData.txt] have this property)" (same as U_UNASSIGNED!) @stable ICU 2.0 */
658 U_GENERAL_OTHER_TYPES = 0,
659 /** Lu @stable ICU 2.0 */
660 U_UPPERCASE_LETTER = 1,
661 /** Ll @stable ICU 2.0 */
662 U_LOWERCASE_LETTER = 2,
663 /** Lt @stable ICU 2.0 */
664 U_TITLECASE_LETTER = 3,
665 /** Lm @stable ICU 2.0 */
666 U_MODIFIER_LETTER = 4,
667 /** Lo @stable ICU 2.0 */
668 U_OTHER_LETTER = 5,
669 /** Mn @stable ICU 2.0 */
670 U_NON_SPACING_MARK = 6,
671 /** Me @stable ICU 2.0 */
672 U_ENCLOSING_MARK = 7,
673 /** Mc @stable ICU 2.0 */
674 U_COMBINING_SPACING_MARK = 8,
675 /** Nd @stable ICU 2.0 */
676 U_DECIMAL_DIGIT_NUMBER = 9,
677 /** Nl @stable ICU 2.0 */
678 U_LETTER_NUMBER = 10,
679 /** No @stable ICU 2.0 */
680 U_OTHER_NUMBER = 11,
681 /** Zs @stable ICU 2.0 */
682 U_SPACE_SEPARATOR = 12,
683 /** Zl @stable ICU 2.0 */
684 U_LINE_SEPARATOR = 13,
685 /** Zp @stable ICU 2.0 */
686 U_PARAGRAPH_SEPARATOR = 14,
687 /** Cc @stable ICU 2.0 */
688 U_CONTROL_CHAR = 15,
689 /** Cf @stable ICU 2.0 */
690 U_FORMAT_CHAR = 16,
691 /** Co @stable ICU 2.0 */
692 U_PRIVATE_USE_CHAR = 17,
693 /** Cs @stable ICU 2.0 */
694 U_SURROGATE = 18,
695 /** Pd @stable ICU 2.0 */
696 U_DASH_PUNCTUATION = 19,
697 /** Ps @stable ICU 2.0 */
698 U_START_PUNCTUATION = 20,
699 /** Pe @stable ICU 2.0 */
700 U_END_PUNCTUATION = 21,
701 /** Pc @stable ICU 2.0 */
702 U_CONNECTOR_PUNCTUATION = 22,
703 /** Po @stable ICU 2.0 */
704 U_OTHER_PUNCTUATION = 23,
705 /** Sm @stable ICU 2.0 */
706 U_MATH_SYMBOL = 24,
707 /** Sc @stable ICU 2.0 */
708 U_CURRENCY_SYMBOL = 25,
709 /** Sk @stable ICU 2.0 */
710 U_MODIFIER_SYMBOL = 26,
711 /** So @stable ICU 2.0 */
712 U_OTHER_SYMBOL = 27,
713 /** Pi @stable ICU 2.0 */
714 U_INITIAL_PUNCTUATION = 28,
715 /** Pf @stable ICU 2.0 */
716 U_FINAL_PUNCTUATION = 29,
717 /**
718 * One higher than the last enum UCharCategory constant.
719 * This numeric value is stable (will not change), see
720 * http://www.unicode.org/policies/stability_policy.html#Property_Value
721 *
722 * @stable ICU 2.0
723 */
724 U_CHAR_CATEGORY_COUNT
725 } UCharCategory;
726
727 /**
728 * U_GC_XX_MASK constants are bit flags corresponding to Unicode
729 * general category values.
730 * For each category, the nth bit is set if the numeric value of the
731 * corresponding UCharCategory constant is n.
732 *
733 * There are also some U_GC_Y_MASK constants for groups of general categories
734 * like L for all letter categories.
735 *
736 * @see u_charType
737 * @see U_GET_GC_MASK
738 * @see UCharCategory
739 * @stable ICU 2.1
740 */
741 #define U_GC_CN_MASK U_MASK(U_GENERAL_OTHER_TYPES)
742
743 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
744 #define U_GC_LU_MASK U_MASK(U_UPPERCASE_LETTER)
745 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
746 #define U_GC_LL_MASK U_MASK(U_LOWERCASE_LETTER)
747 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
748 #define U_GC_LT_MASK U_MASK(U_TITLECASE_LETTER)
749 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
750 #define U_GC_LM_MASK U_MASK(U_MODIFIER_LETTER)
751 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
752 #define U_GC_LO_MASK U_MASK(U_OTHER_LETTER)
753
754 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
755 #define U_GC_MN_MASK U_MASK(U_NON_SPACING_MARK)
756 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
757 #define U_GC_ME_MASK U_MASK(U_ENCLOSING_MARK)
758 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
759 #define U_GC_MC_MASK U_MASK(U_COMBINING_SPACING_MARK)
760
761 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
762 #define U_GC_ND_MASK U_MASK(U_DECIMAL_DIGIT_NUMBER)
763 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
764 #define U_GC_NL_MASK U_MASK(U_LETTER_NUMBER)
765 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
766 #define U_GC_NO_MASK U_MASK(U_OTHER_NUMBER)
767
768 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
769 #define U_GC_ZS_MASK U_MASK(U_SPACE_SEPARATOR)
770 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
771 #define U_GC_ZL_MASK U_MASK(U_LINE_SEPARATOR)
772 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
773 #define U_GC_ZP_MASK U_MASK(U_PARAGRAPH_SEPARATOR)
774
775 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
776 #define U_GC_CC_MASK U_MASK(U_CONTROL_CHAR)
777 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
778 #define U_GC_CF_MASK U_MASK(U_FORMAT_CHAR)
779 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
780 #define U_GC_CO_MASK U_MASK(U_PRIVATE_USE_CHAR)
781 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
782 #define U_GC_CS_MASK U_MASK(U_SURROGATE)
783
784 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
785 #define U_GC_PD_MASK U_MASK(U_DASH_PUNCTUATION)
786 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
787 #define U_GC_PS_MASK U_MASK(U_START_PUNCTUATION)
788 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
789 #define U_GC_PE_MASK U_MASK(U_END_PUNCTUATION)
790 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
791 #define U_GC_PC_MASK U_MASK(U_CONNECTOR_PUNCTUATION)
792 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
793 #define U_GC_PO_MASK U_MASK(U_OTHER_PUNCTUATION)
794
795 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
796 #define U_GC_SM_MASK U_MASK(U_MATH_SYMBOL)
797 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
798 #define U_GC_SC_MASK U_MASK(U_CURRENCY_SYMBOL)
799 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
800 #define U_GC_SK_MASK U_MASK(U_MODIFIER_SYMBOL)
801 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
802 #define U_GC_SO_MASK U_MASK(U_OTHER_SYMBOL)
803
804 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
805 #define U_GC_PI_MASK U_MASK(U_INITIAL_PUNCTUATION)
806 /** Mask constant for a UCharCategory. @stable ICU 2.1 */
807 #define U_GC_PF_MASK U_MASK(U_FINAL_PUNCTUATION)
808
809
810 /** Mask constant for multiple UCharCategory bits (L Letters). @stable ICU 2.1 */
811 #define U_GC_L_MASK \
812 (U_GC_LU_MASK|U_GC_LL_MASK|U_GC_LT_MASK|U_GC_LM_MASK|U_GC_LO_MASK)
813
814 /** Mask constant for multiple UCharCategory bits (LC Cased Letters). @stable ICU 2.1 */
815 #define U_GC_LC_MASK \
816 (U_GC_LU_MASK|U_GC_LL_MASK|U_GC_LT_MASK)
817
818 /** Mask constant for multiple UCharCategory bits (M Marks). @stable ICU 2.1 */
819 #define U_GC_M_MASK (U_GC_MN_MASK|U_GC_ME_MASK|U_GC_MC_MASK)
820
821 /** Mask constant for multiple UCharCategory bits (N Numbers). @stable ICU 2.1 */
822 #define U_GC_N_MASK (U_GC_ND_MASK|U_GC_NL_MASK|U_GC_NO_MASK)
823
824 /** Mask constant for multiple UCharCategory bits (Z Separators). @stable ICU 2.1 */
825 #define U_GC_Z_MASK (U_GC_ZS_MASK|U_GC_ZL_MASK|U_GC_ZP_MASK)
826
827 /** Mask constant for multiple UCharCategory bits (C Others). @stable ICU 2.1 */
828 #define U_GC_C_MASK \
829 (U_GC_CN_MASK|U_GC_CC_MASK|U_GC_CF_MASK|U_GC_CO_MASK|U_GC_CS_MASK)
830
831 /** Mask constant for multiple UCharCategory bits (P Punctuation). @stable ICU 2.1 */
832 #define U_GC_P_MASK \
833 (U_GC_PD_MASK|U_GC_PS_MASK|U_GC_PE_MASK|U_GC_PC_MASK|U_GC_PO_MASK| \
834 U_GC_PI_MASK|U_GC_PF_MASK)
835
836 /** Mask constant for multiple UCharCategory bits (S Symbols). @stable ICU 2.1 */
837 #define U_GC_S_MASK (U_GC_SM_MASK|U_GC_SC_MASK|U_GC_SK_MASK|U_GC_SO_MASK)
838
839 /**
840 * This specifies the language directional property of a character set.
841 * @stable ICU 2.0
842 */
843 typedef enum UCharDirection {
844 /*
845 * Note: UCharDirection constants and their API comments are parsed by preparseucd.py.
846 * It matches pairs of lines like
847 * / ** <Unicode 1..3-letter Bidi_Class value> comment... * /
848 * U_<[A-Z_]+> = <integer>,
849 */
850
851 /** L @stable ICU 2.0 */
852 U_LEFT_TO_RIGHT = 0,
853 /** R @stable ICU 2.0 */
854 U_RIGHT_TO_LEFT = 1,
855 /** EN @stable ICU 2.0 */
856 U_EUROPEAN_NUMBER = 2,
857 /** ES @stable ICU 2.0 */
858 U_EUROPEAN_NUMBER_SEPARATOR = 3,
859 /** ET @stable ICU 2.0 */
860 U_EUROPEAN_NUMBER_TERMINATOR = 4,
861 /** AN @stable ICU 2.0 */
862 U_ARABIC_NUMBER = 5,
863 /** CS @stable ICU 2.0 */
864 U_COMMON_NUMBER_SEPARATOR = 6,
865 /** B @stable ICU 2.0 */
866 U_BLOCK_SEPARATOR = 7,
867 /** S @stable ICU 2.0 */
868 U_SEGMENT_SEPARATOR = 8,
869 /** WS @stable ICU 2.0 */
870 U_WHITE_SPACE_NEUTRAL = 9,
871 /** ON @stable ICU 2.0 */
872 U_OTHER_NEUTRAL = 10,
873 /** LRE @stable ICU 2.0 */
874 U_LEFT_TO_RIGHT_EMBEDDING = 11,
875 /** LRO @stable ICU 2.0 */
876 U_LEFT_TO_RIGHT_OVERRIDE = 12,
877 /** AL @stable ICU 2.0 */
878 U_RIGHT_TO_LEFT_ARABIC = 13,
879 /** RLE @stable ICU 2.0 */
880 U_RIGHT_TO_LEFT_EMBEDDING = 14,
881 /** RLO @stable ICU 2.0 */
882 U_RIGHT_TO_LEFT_OVERRIDE = 15,
883 /** PDF @stable ICU 2.0 */
884 U_POP_DIRECTIONAL_FORMAT = 16,
885 /** NSM @stable ICU 2.0 */
886 U_DIR_NON_SPACING_MARK = 17,
887 /** BN @stable ICU 2.0 */
888 U_BOUNDARY_NEUTRAL = 18,
889 /** FSI @stable ICU 52 */
890 U_FIRST_STRONG_ISOLATE = 19,
891 /** LRI @stable ICU 52 */
892 U_LEFT_TO_RIGHT_ISOLATE = 20,
893 /** RLI @stable ICU 52 */
894 U_RIGHT_TO_LEFT_ISOLATE = 21,
895 /** PDI @stable ICU 52 */
896 U_POP_DIRECTIONAL_ISOLATE = 22,
897 #ifndef U_HIDE_DEPRECATED_API
898 /**
899 * One more than the highest UCharDirection value.
900 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_BIDI_CLASS).
901 *
902 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
903 */
904 U_CHAR_DIRECTION_COUNT
905 #endif // U_HIDE_DEPRECATED_API
906 } UCharDirection;
907
908 /**
909 * Bidi Paired Bracket Type constants.
910 *
911 * @see UCHAR_BIDI_PAIRED_BRACKET_TYPE
912 * @stable ICU 52
913 */
914 typedef enum UBidiPairedBracketType {
915 /*
916 * Note: UBidiPairedBracketType constants are parsed by preparseucd.py.
917 * It matches lines like
918 * U_BPT_<Unicode Bidi_Paired_Bracket_Type value name>
919 */
920
921 /** Not a paired bracket. @stable ICU 52 */
922 U_BPT_NONE,
923 /** Open paired bracket. @stable ICU 52 */
924 U_BPT_OPEN,
925 /** Close paired bracket. @stable ICU 52 */
926 U_BPT_CLOSE,
927 #ifndef U_HIDE_DEPRECATED_API
928 /**
929 * One more than the highest normal UBidiPairedBracketType value.
930 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_BIDI_PAIRED_BRACKET_TYPE).
931 *
932 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
933 */
934 U_BPT_COUNT /* 3 */
935 #endif // U_HIDE_DEPRECATED_API
936 } UBidiPairedBracketType;
937
938 /**
939 * Constants for Unicode blocks, see the Unicode Data file Blocks.txt
940 * @stable ICU 2.0
941 */
942 enum UBlockCode {
943 /*
944 * Note: UBlockCode constants are parsed by preparseucd.py.
945 * It matches lines like
946 * UBLOCK_<Unicode Block value name> = <integer>,
947 */
948
949 /** New No_Block value in Unicode 4. @stable ICU 2.6 */
950 UBLOCK_NO_BLOCK = 0, /*[none]*/ /* Special range indicating No_Block */
951
952 /** @stable ICU 2.0 */
953 UBLOCK_BASIC_LATIN = 1, /*[0000]*/
954
955 /** @stable ICU 2.0 */
956 UBLOCK_LATIN_1_SUPPLEMENT=2, /*[0080]*/
957
958 /** @stable ICU 2.0 */
959 UBLOCK_LATIN_EXTENDED_A =3, /*[0100]*/
960
961 /** @stable ICU 2.0 */
962 UBLOCK_LATIN_EXTENDED_B =4, /*[0180]*/
963
964 /** @stable ICU 2.0 */
965 UBLOCK_IPA_EXTENSIONS =5, /*[0250]*/
966
967 /** @stable ICU 2.0 */
968 UBLOCK_SPACING_MODIFIER_LETTERS =6, /*[02B0]*/
969
970 /** @stable ICU 2.0 */
971 UBLOCK_COMBINING_DIACRITICAL_MARKS =7, /*[0300]*/
972
973 /**
974 * Unicode 3.2 renames this block to "Greek and Coptic".
975 * @stable ICU 2.0
976 */
977 UBLOCK_GREEK =8, /*[0370]*/
978
979 /** @stable ICU 2.0 */
980 UBLOCK_CYRILLIC =9, /*[0400]*/
981
982 /** @stable ICU 2.0 */
983 UBLOCK_ARMENIAN =10, /*[0530]*/
984
985 /** @stable ICU 2.0 */
986 UBLOCK_HEBREW =11, /*[0590]*/
987
988 /** @stable ICU 2.0 */
989 UBLOCK_ARABIC =12, /*[0600]*/
990
991 /** @stable ICU 2.0 */
992 UBLOCK_SYRIAC =13, /*[0700]*/
993
994 /** @stable ICU 2.0 */
995 UBLOCK_THAANA =14, /*[0780]*/
996
997 /** @stable ICU 2.0 */
998 UBLOCK_DEVANAGARI =15, /*[0900]*/
999
1000 /** @stable ICU 2.0 */
1001 UBLOCK_BENGALI =16, /*[0980]*/
1002
1003 /** @stable ICU 2.0 */
1004 UBLOCK_GURMUKHI =17, /*[0A00]*/
1005
1006 /** @stable ICU 2.0 */
1007 UBLOCK_GUJARATI =18, /*[0A80]*/
1008
1009 /** @stable ICU 2.0 */
1010 UBLOCK_ORIYA =19, /*[0B00]*/
1011
1012 /** @stable ICU 2.0 */
1013 UBLOCK_TAMIL =20, /*[0B80]*/
1014
1015 /** @stable ICU 2.0 */
1016 UBLOCK_TELUGU =21, /*[0C00]*/
1017
1018 /** @stable ICU 2.0 */
1019 UBLOCK_KANNADA =22, /*[0C80]*/
1020
1021 /** @stable ICU 2.0 */
1022 UBLOCK_MALAYALAM =23, /*[0D00]*/
1023
1024 /** @stable ICU 2.0 */
1025 UBLOCK_SINHALA =24, /*[0D80]*/
1026
1027 /** @stable ICU 2.0 */
1028 UBLOCK_THAI =25, /*[0E00]*/
1029
1030 /** @stable ICU 2.0 */
1031 UBLOCK_LAO =26, /*[0E80]*/
1032
1033 /** @stable ICU 2.0 */
1034 UBLOCK_TIBETAN =27, /*[0F00]*/
1035
1036 /** @stable ICU 2.0 */
1037 UBLOCK_MYANMAR =28, /*[1000]*/
1038
1039 /** @stable ICU 2.0 */
1040 UBLOCK_GEORGIAN =29, /*[10A0]*/
1041
1042 /** @stable ICU 2.0 */
1043 UBLOCK_HANGUL_JAMO =30, /*[1100]*/
1044
1045 /** @stable ICU 2.0 */
1046 UBLOCK_ETHIOPIC =31, /*[1200]*/
1047
1048 /** @stable ICU 2.0 */
1049 UBLOCK_CHEROKEE =32, /*[13A0]*/
1050
1051 /** @stable ICU 2.0 */
1052 UBLOCK_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS =33, /*[1400]*/
1053
1054 /** @stable ICU 2.0 */
1055 UBLOCK_OGHAM =34, /*[1680]*/
1056
1057 /** @stable ICU 2.0 */
1058 UBLOCK_RUNIC =35, /*[16A0]*/
1059
1060 /** @stable ICU 2.0 */
1061 UBLOCK_KHMER =36, /*[1780]*/
1062
1063 /** @stable ICU 2.0 */
1064 UBLOCK_MONGOLIAN =37, /*[1800]*/
1065
1066 /** @stable ICU 2.0 */
1067 UBLOCK_LATIN_EXTENDED_ADDITIONAL =38, /*[1E00]*/
1068
1069 /** @stable ICU 2.0 */
1070 UBLOCK_GREEK_EXTENDED =39, /*[1F00]*/
1071
1072 /** @stable ICU 2.0 */
1073 UBLOCK_GENERAL_PUNCTUATION =40, /*[2000]*/
1074
1075 /** @stable ICU 2.0 */
1076 UBLOCK_SUPERSCRIPTS_AND_SUBSCRIPTS =41, /*[2070]*/
1077
1078 /** @stable ICU 2.0 */
1079 UBLOCK_CURRENCY_SYMBOLS =42, /*[20A0]*/
1080
1081 /**
1082 * Unicode 3.2 renames this block to "Combining Diacritical Marks for Symbols".
1083 * @stable ICU 2.0
1084 */
1085 UBLOCK_COMBINING_MARKS_FOR_SYMBOLS =43, /*[20D0]*/
1086
1087 /** @stable ICU 2.0 */
1088 UBLOCK_LETTERLIKE_SYMBOLS =44, /*[2100]*/
1089
1090 /** @stable ICU 2.0 */
1091 UBLOCK_NUMBER_FORMS =45, /*[2150]*/
1092
1093 /** @stable ICU 2.0 */
1094 UBLOCK_ARROWS =46, /*[2190]*/
1095
1096 /** @stable ICU 2.0 */
1097 UBLOCK_MATHEMATICAL_OPERATORS =47, /*[2200]*/
1098
1099 /** @stable ICU 2.0 */
1100 UBLOCK_MISCELLANEOUS_TECHNICAL =48, /*[2300]*/
1101
1102 /** @stable ICU 2.0 */
1103 UBLOCK_CONTROL_PICTURES =49, /*[2400]*/
1104
1105 /** @stable ICU 2.0 */
1106 UBLOCK_OPTICAL_CHARACTER_RECOGNITION =50, /*[2440]*/
1107
1108 /** @stable ICU 2.0 */
1109 UBLOCK_ENCLOSED_ALPHANUMERICS =51, /*[2460]*/
1110
1111 /** @stable ICU 2.0 */
1112 UBLOCK_BOX_DRAWING =52, /*[2500]*/
1113
1114 /** @stable ICU 2.0 */
1115 UBLOCK_BLOCK_ELEMENTS =53, /*[2580]*/
1116
1117 /** @stable ICU 2.0 */
1118 UBLOCK_GEOMETRIC_SHAPES =54, /*[25A0]*/
1119
1120 /** @stable ICU 2.0 */
1121 UBLOCK_MISCELLANEOUS_SYMBOLS =55, /*[2600]*/
1122
1123 /** @stable ICU 2.0 */
1124 UBLOCK_DINGBATS =56, /*[2700]*/
1125
1126 /** @stable ICU 2.0 */
1127 UBLOCK_BRAILLE_PATTERNS =57, /*[2800]*/
1128
1129 /** @stable ICU 2.0 */
1130 UBLOCK_CJK_RADICALS_SUPPLEMENT =58, /*[2E80]*/
1131
1132 /** @stable ICU 2.0 */
1133 UBLOCK_KANGXI_RADICALS =59, /*[2F00]*/
1134
1135 /** @stable ICU 2.0 */
1136 UBLOCK_IDEOGRAPHIC_DESCRIPTION_CHARACTERS =60, /*[2FF0]*/
1137
1138 /** @stable ICU 2.0 */
1139 UBLOCK_CJK_SYMBOLS_AND_PUNCTUATION =61, /*[3000]*/
1140
1141 /** @stable ICU 2.0 */
1142 UBLOCK_HIRAGANA =62, /*[3040]*/
1143
1144 /** @stable ICU 2.0 */
1145 UBLOCK_KATAKANA =63, /*[30A0]*/
1146
1147 /** @stable ICU 2.0 */
1148 UBLOCK_BOPOMOFO =64, /*[3100]*/
1149
1150 /** @stable ICU 2.0 */
1151 UBLOCK_HANGUL_COMPATIBILITY_JAMO =65, /*[3130]*/
1152
1153 /** @stable ICU 2.0 */
1154 UBLOCK_KANBUN =66, /*[3190]*/
1155
1156 /** @stable ICU 2.0 */
1157 UBLOCK_BOPOMOFO_EXTENDED =67, /*[31A0]*/
1158
1159 /** @stable ICU 2.0 */
1160 UBLOCK_ENCLOSED_CJK_LETTERS_AND_MONTHS =68, /*[3200]*/
1161
1162 /** @stable ICU 2.0 */
1163 UBLOCK_CJK_COMPATIBILITY =69, /*[3300]*/
1164
1165 /** @stable ICU 2.0 */
1166 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A =70, /*[3400]*/
1167
1168 /** @stable ICU 2.0 */
1169 UBLOCK_CJK_UNIFIED_IDEOGRAPHS =71, /*[4E00]*/
1170
1171 /** @stable ICU 2.0 */
1172 UBLOCK_YI_SYLLABLES =72, /*[A000]*/
1173
1174 /** @stable ICU 2.0 */
1175 UBLOCK_YI_RADICALS =73, /*[A490]*/
1176
1177 /** @stable ICU 2.0 */
1178 UBLOCK_HANGUL_SYLLABLES =74, /*[AC00]*/
1179
1180 /** @stable ICU 2.0 */
1181 UBLOCK_HIGH_SURROGATES =75, /*[D800]*/
1182
1183 /** @stable ICU 2.0 */
1184 UBLOCK_HIGH_PRIVATE_USE_SURROGATES =76, /*[DB80]*/
1185
1186 /** @stable ICU 2.0 */
1187 UBLOCK_LOW_SURROGATES =77, /*[DC00]*/
1188
1189 /**
1190 * Same as UBLOCK_PRIVATE_USE.
1191 * Until Unicode 3.1.1, the corresponding block name was "Private Use",
1192 * and multiple code point ranges had this block.
1193 * Unicode 3.2 renames the block for the BMP PUA to "Private Use Area" and
1194 * adds separate blocks for the supplementary PUAs.
1195 *
1196 * @stable ICU 2.0
1197 */
1198 UBLOCK_PRIVATE_USE_AREA =78, /*[E000]*/
1199 /**
1200 * Same as UBLOCK_PRIVATE_USE_AREA.
1201 * Until Unicode 3.1.1, the corresponding block name was "Private Use",
1202 * and multiple code point ranges had this block.
1203 * Unicode 3.2 renames the block for the BMP PUA to "Private Use Area" and
1204 * adds separate blocks for the supplementary PUAs.
1205 *
1206 * @stable ICU 2.0
1207 */
1208 UBLOCK_PRIVATE_USE = UBLOCK_PRIVATE_USE_AREA,
1209
1210 /** @stable ICU 2.0 */
1211 UBLOCK_CJK_COMPATIBILITY_IDEOGRAPHS =79, /*[F900]*/
1212
1213 /** @stable ICU 2.0 */
1214 UBLOCK_ALPHABETIC_PRESENTATION_FORMS =80, /*[FB00]*/
1215
1216 /** @stable ICU 2.0 */
1217 UBLOCK_ARABIC_PRESENTATION_FORMS_A =81, /*[FB50]*/
1218
1219 /** @stable ICU 2.0 */
1220 UBLOCK_COMBINING_HALF_MARKS =82, /*[FE20]*/
1221
1222 /** @stable ICU 2.0 */
1223 UBLOCK_CJK_COMPATIBILITY_FORMS =83, /*[FE30]*/
1224
1225 /** @stable ICU 2.0 */
1226 UBLOCK_SMALL_FORM_VARIANTS =84, /*[FE50]*/
1227
1228 /** @stable ICU 2.0 */
1229 UBLOCK_ARABIC_PRESENTATION_FORMS_B =85, /*[FE70]*/
1230
1231 /** @stable ICU 2.0 */
1232 UBLOCK_SPECIALS =86, /*[FFF0]*/
1233
1234 /** @stable ICU 2.0 */
1235 UBLOCK_HALFWIDTH_AND_FULLWIDTH_FORMS =87, /*[FF00]*/
1236
1237 /* New blocks in Unicode 3.1 */
1238
1239 /** @stable ICU 2.0 */
1240 UBLOCK_OLD_ITALIC = 88, /*[10300]*/
1241 /** @stable ICU 2.0 */
1242 UBLOCK_GOTHIC = 89, /*[10330]*/
1243 /** @stable ICU 2.0 */
1244 UBLOCK_DESERET = 90, /*[10400]*/
1245 /** @stable ICU 2.0 */
1246 UBLOCK_BYZANTINE_MUSICAL_SYMBOLS = 91, /*[1D000]*/
1247 /** @stable ICU 2.0 */
1248 UBLOCK_MUSICAL_SYMBOLS = 92, /*[1D100]*/
1249 /** @stable ICU 2.0 */
1250 UBLOCK_MATHEMATICAL_ALPHANUMERIC_SYMBOLS = 93, /*[1D400]*/
1251 /** @stable ICU 2.0 */
1252 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B = 94, /*[20000]*/
1253 /** @stable ICU 2.0 */
1254 UBLOCK_CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT = 95, /*[2F800]*/
1255 /** @stable ICU 2.0 */
1256 UBLOCK_TAGS = 96, /*[E0000]*/
1257
1258 /* New blocks in Unicode 3.2 */
1259
1260 /** @stable ICU 3.0 */
1261 UBLOCK_CYRILLIC_SUPPLEMENT = 97, /*[0500]*/
1262 /**
1263 * Unicode 4.0.1 renames the "Cyrillic Supplementary" block to "Cyrillic Supplement".
1264 * @stable ICU 2.2
1265 */
1266 UBLOCK_CYRILLIC_SUPPLEMENTARY = UBLOCK_CYRILLIC_SUPPLEMENT,
1267 /** @stable ICU 2.2 */
1268 UBLOCK_TAGALOG = 98, /*[1700]*/
1269 /** @stable ICU 2.2 */
1270 UBLOCK_HANUNOO = 99, /*[1720]*/
1271 /** @stable ICU 2.2 */
1272 UBLOCK_BUHID = 100, /*[1740]*/
1273 /** @stable ICU 2.2 */
1274 UBLOCK_TAGBANWA = 101, /*[1760]*/
1275 /** @stable ICU 2.2 */
1276 UBLOCK_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A = 102, /*[27C0]*/
1277 /** @stable ICU 2.2 */
1278 UBLOCK_SUPPLEMENTAL_ARROWS_A = 103, /*[27F0]*/
1279 /** @stable ICU 2.2 */
1280 UBLOCK_SUPPLEMENTAL_ARROWS_B = 104, /*[2900]*/
1281 /** @stable ICU 2.2 */
1282 UBLOCK_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B = 105, /*[2980]*/
1283 /** @stable ICU 2.2 */
1284 UBLOCK_SUPPLEMENTAL_MATHEMATICAL_OPERATORS = 106, /*[2A00]*/
1285 /** @stable ICU 2.2 */
1286 UBLOCK_KATAKANA_PHONETIC_EXTENSIONS = 107, /*[31F0]*/
1287 /** @stable ICU 2.2 */
1288 UBLOCK_VARIATION_SELECTORS = 108, /*[FE00]*/
1289 /** @stable ICU 2.2 */
1290 UBLOCK_SUPPLEMENTARY_PRIVATE_USE_AREA_A = 109, /*[F0000]*/
1291 /** @stable ICU 2.2 */
1292 UBLOCK_SUPPLEMENTARY_PRIVATE_USE_AREA_B = 110, /*[100000]*/
1293
1294 /* New blocks in Unicode 4 */
1295
1296 /** @stable ICU 2.6 */
1297 UBLOCK_LIMBU = 111, /*[1900]*/
1298 /** @stable ICU 2.6 */
1299 UBLOCK_TAI_LE = 112, /*[1950]*/
1300 /** @stable ICU 2.6 */
1301 UBLOCK_KHMER_SYMBOLS = 113, /*[19E0]*/
1302 /** @stable ICU 2.6 */
1303 UBLOCK_PHONETIC_EXTENSIONS = 114, /*[1D00]*/
1304 /** @stable ICU 2.6 */
1305 UBLOCK_MISCELLANEOUS_SYMBOLS_AND_ARROWS = 115, /*[2B00]*/
1306 /** @stable ICU 2.6 */
1307 UBLOCK_YIJING_HEXAGRAM_SYMBOLS = 116, /*[4DC0]*/
1308 /** @stable ICU 2.6 */
1309 UBLOCK_LINEAR_B_SYLLABARY = 117, /*[10000]*/
1310 /** @stable ICU 2.6 */
1311 UBLOCK_LINEAR_B_IDEOGRAMS = 118, /*[10080]*/
1312 /** @stable ICU 2.6 */
1313 UBLOCK_AEGEAN_NUMBERS = 119, /*[10100]*/
1314 /** @stable ICU 2.6 */
1315 UBLOCK_UGARITIC = 120, /*[10380]*/
1316 /** @stable ICU 2.6 */
1317 UBLOCK_SHAVIAN = 121, /*[10450]*/
1318 /** @stable ICU 2.6 */
1319 UBLOCK_OSMANYA = 122, /*[10480]*/
1320 /** @stable ICU 2.6 */
1321 UBLOCK_CYPRIOT_SYLLABARY = 123, /*[10800]*/
1322 /** @stable ICU 2.6 */
1323 UBLOCK_TAI_XUAN_JING_SYMBOLS = 124, /*[1D300]*/
1324 /** @stable ICU 2.6 */
1325 UBLOCK_VARIATION_SELECTORS_SUPPLEMENT = 125, /*[E0100]*/
1326
1327 /* New blocks in Unicode 4.1 */
1328
1329 /** @stable ICU 3.4 */
1330 UBLOCK_ANCIENT_GREEK_MUSICAL_NOTATION = 126, /*[1D200]*/
1331 /** @stable ICU 3.4 */
1332 UBLOCK_ANCIENT_GREEK_NUMBERS = 127, /*[10140]*/
1333 /** @stable ICU 3.4 */
1334 UBLOCK_ARABIC_SUPPLEMENT = 128, /*[0750]*/
1335 /** @stable ICU 3.4 */
1336 UBLOCK_BUGINESE = 129, /*[1A00]*/
1337 /** @stable ICU 3.4 */
1338 UBLOCK_CJK_STROKES = 130, /*[31C0]*/
1339 /** @stable ICU 3.4 */
1340 UBLOCK_COMBINING_DIACRITICAL_MARKS_SUPPLEMENT = 131, /*[1DC0]*/
1341 /** @stable ICU 3.4 */
1342 UBLOCK_COPTIC = 132, /*[2C80]*/
1343 /** @stable ICU 3.4 */
1344 UBLOCK_ETHIOPIC_EXTENDED = 133, /*[2D80]*/
1345 /** @stable ICU 3.4 */
1346 UBLOCK_ETHIOPIC_SUPPLEMENT = 134, /*[1380]*/
1347 /** @stable ICU 3.4 */
1348 UBLOCK_GEORGIAN_SUPPLEMENT = 135, /*[2D00]*/
1349 /** @stable ICU 3.4 */
1350 UBLOCK_GLAGOLITIC = 136, /*[2C00]*/
1351 /** @stable ICU 3.4 */
1352 UBLOCK_KHAROSHTHI = 137, /*[10A00]*/
1353 /** @stable ICU 3.4 */
1354 UBLOCK_MODIFIER_TONE_LETTERS = 138, /*[A700]*/
1355 /** @stable ICU 3.4 */
1356 UBLOCK_NEW_TAI_LUE = 139, /*[1980]*/
1357 /** @stable ICU 3.4 */
1358 UBLOCK_OLD_PERSIAN = 140, /*[103A0]*/
1359 /** @stable ICU 3.4 */
1360 UBLOCK_PHONETIC_EXTENSIONS_SUPPLEMENT = 141, /*[1D80]*/
1361 /** @stable ICU 3.4 */
1362 UBLOCK_SUPPLEMENTAL_PUNCTUATION = 142, /*[2E00]*/
1363 /** @stable ICU 3.4 */
1364 UBLOCK_SYLOTI_NAGRI = 143, /*[A800]*/
1365 /** @stable ICU 3.4 */
1366 UBLOCK_TIFINAGH = 144, /*[2D30]*/
1367 /** @stable ICU 3.4 */
1368 UBLOCK_VERTICAL_FORMS = 145, /*[FE10]*/
1369
1370 /* New blocks in Unicode 5.0 */
1371
1372 /** @stable ICU 3.6 */
1373 UBLOCK_NKO = 146, /*[07C0]*/
1374 /** @stable ICU 3.6 */
1375 UBLOCK_BALINESE = 147, /*[1B00]*/
1376 /** @stable ICU 3.6 */
1377 UBLOCK_LATIN_EXTENDED_C = 148, /*[2C60]*/
1378 /** @stable ICU 3.6 */
1379 UBLOCK_LATIN_EXTENDED_D = 149, /*[A720]*/
1380 /** @stable ICU 3.6 */
1381 UBLOCK_PHAGS_PA = 150, /*[A840]*/
1382 /** @stable ICU 3.6 */
1383 UBLOCK_PHOENICIAN = 151, /*[10900]*/
1384 /** @stable ICU 3.6 */
1385 UBLOCK_CUNEIFORM = 152, /*[12000]*/
1386 /** @stable ICU 3.6 */
1387 UBLOCK_CUNEIFORM_NUMBERS_AND_PUNCTUATION = 153, /*[12400]*/
1388 /** @stable ICU 3.6 */
1389 UBLOCK_COUNTING_ROD_NUMERALS = 154, /*[1D360]*/
1390
1391 /* New blocks in Unicode 5.1 */
1392
1393 /** @stable ICU 4.0 */
1394 UBLOCK_SUNDANESE = 155, /*[1B80]*/
1395 /** @stable ICU 4.0 */
1396 UBLOCK_LEPCHA = 156, /*[1C00]*/
1397 /** @stable ICU 4.0 */
1398 UBLOCK_OL_CHIKI = 157, /*[1C50]*/
1399 /** @stable ICU 4.0 */
1400 UBLOCK_CYRILLIC_EXTENDED_A = 158, /*[2DE0]*/
1401 /** @stable ICU 4.0 */
1402 UBLOCK_VAI = 159, /*[A500]*/
1403 /** @stable ICU 4.0 */
1404 UBLOCK_CYRILLIC_EXTENDED_B = 160, /*[A640]*/
1405 /** @stable ICU 4.0 */
1406 UBLOCK_SAURASHTRA = 161, /*[A880]*/
1407 /** @stable ICU 4.0 */
1408 UBLOCK_KAYAH_LI = 162, /*[A900]*/
1409 /** @stable ICU 4.0 */
1410 UBLOCK_REJANG = 163, /*[A930]*/
1411 /** @stable ICU 4.0 */
1412 UBLOCK_CHAM = 164, /*[AA00]*/
1413 /** @stable ICU 4.0 */
1414 UBLOCK_ANCIENT_SYMBOLS = 165, /*[10190]*/
1415 /** @stable ICU 4.0 */
1416 UBLOCK_PHAISTOS_DISC = 166, /*[101D0]*/
1417 /** @stable ICU 4.0 */
1418 UBLOCK_LYCIAN = 167, /*[10280]*/
1419 /** @stable ICU 4.0 */
1420 UBLOCK_CARIAN = 168, /*[102A0]*/
1421 /** @stable ICU 4.0 */
1422 UBLOCK_LYDIAN = 169, /*[10920]*/
1423 /** @stable ICU 4.0 */
1424 UBLOCK_MAHJONG_TILES = 170, /*[1F000]*/
1425 /** @stable ICU 4.0 */
1426 UBLOCK_DOMINO_TILES = 171, /*[1F030]*/
1427
1428 /* New blocks in Unicode 5.2 */
1429
1430 /** @stable ICU 4.4 */
1431 UBLOCK_SAMARITAN = 172, /*[0800]*/
1432 /** @stable ICU 4.4 */
1433 UBLOCK_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS_EXTENDED = 173, /*[18B0]*/
1434 /** @stable ICU 4.4 */
1435 UBLOCK_TAI_THAM = 174, /*[1A20]*/
1436 /** @stable ICU 4.4 */
1437 UBLOCK_VEDIC_EXTENSIONS = 175, /*[1CD0]*/
1438 /** @stable ICU 4.4 */
1439 UBLOCK_LISU = 176, /*[A4D0]*/
1440 /** @stable ICU 4.4 */
1441 UBLOCK_BAMUM = 177, /*[A6A0]*/
1442 /** @stable ICU 4.4 */
1443 UBLOCK_COMMON_INDIC_NUMBER_FORMS = 178, /*[A830]*/
1444 /** @stable ICU 4.4 */
1445 UBLOCK_DEVANAGARI_EXTENDED = 179, /*[A8E0]*/
1446 /** @stable ICU 4.4 */
1447 UBLOCK_HANGUL_JAMO_EXTENDED_A = 180, /*[A960]*/
1448 /** @stable ICU 4.4 */
1449 UBLOCK_JAVANESE = 181, /*[A980]*/
1450 /** @stable ICU 4.4 */
1451 UBLOCK_MYANMAR_EXTENDED_A = 182, /*[AA60]*/
1452 /** @stable ICU 4.4 */
1453 UBLOCK_TAI_VIET = 183, /*[AA80]*/
1454 /** @stable ICU 4.4 */
1455 UBLOCK_MEETEI_MAYEK = 184, /*[ABC0]*/
1456 /** @stable ICU 4.4 */
1457 UBLOCK_HANGUL_JAMO_EXTENDED_B = 185, /*[D7B0]*/
1458 /** @stable ICU 4.4 */
1459 UBLOCK_IMPERIAL_ARAMAIC = 186, /*[10840]*/
1460 /** @stable ICU 4.4 */
1461 UBLOCK_OLD_SOUTH_ARABIAN = 187, /*[10A60]*/
1462 /** @stable ICU 4.4 */
1463 UBLOCK_AVESTAN = 188, /*[10B00]*/
1464 /** @stable ICU 4.4 */
1465 UBLOCK_INSCRIPTIONAL_PARTHIAN = 189, /*[10B40]*/
1466 /** @stable ICU 4.4 */
1467 UBLOCK_INSCRIPTIONAL_PAHLAVI = 190, /*[10B60]*/
1468 /** @stable ICU 4.4 */
1469 UBLOCK_OLD_TURKIC = 191, /*[10C00]*/
1470 /** @stable ICU 4.4 */
1471 UBLOCK_RUMI_NUMERAL_SYMBOLS = 192, /*[10E60]*/
1472 /** @stable ICU 4.4 */
1473 UBLOCK_KAITHI = 193, /*[11080]*/
1474 /** @stable ICU 4.4 */
1475 UBLOCK_EGYPTIAN_HIEROGLYPHS = 194, /*[13000]*/
1476 /** @stable ICU 4.4 */
1477 UBLOCK_ENCLOSED_ALPHANUMERIC_SUPPLEMENT = 195, /*[1F100]*/
1478 /** @stable ICU 4.4 */
1479 UBLOCK_ENCLOSED_IDEOGRAPHIC_SUPPLEMENT = 196, /*[1F200]*/
1480 /** @stable ICU 4.4 */
1481 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_C = 197, /*[2A700]*/
1482
1483 /* New blocks in Unicode 6.0 */
1484
1485 /** @stable ICU 4.6 */
1486 UBLOCK_MANDAIC = 198, /*[0840]*/
1487 /** @stable ICU 4.6 */
1488 UBLOCK_BATAK = 199, /*[1BC0]*/
1489 /** @stable ICU 4.6 */
1490 UBLOCK_ETHIOPIC_EXTENDED_A = 200, /*[AB00]*/
1491 /** @stable ICU 4.6 */
1492 UBLOCK_BRAHMI = 201, /*[11000]*/
1493 /** @stable ICU 4.6 */
1494 UBLOCK_BAMUM_SUPPLEMENT = 202, /*[16800]*/
1495 /** @stable ICU 4.6 */
1496 UBLOCK_KANA_SUPPLEMENT = 203, /*[1B000]*/
1497 /** @stable ICU 4.6 */
1498 UBLOCK_PLAYING_CARDS = 204, /*[1F0A0]*/
1499 /** @stable ICU 4.6 */
1500 UBLOCK_MISCELLANEOUS_SYMBOLS_AND_PICTOGRAPHS = 205, /*[1F300]*/
1501 /** @stable ICU 4.6 */
1502 UBLOCK_EMOTICONS = 206, /*[1F600]*/
1503 /** @stable ICU 4.6 */
1504 UBLOCK_TRANSPORT_AND_MAP_SYMBOLS = 207, /*[1F680]*/
1505 /** @stable ICU 4.6 */
1506 UBLOCK_ALCHEMICAL_SYMBOLS = 208, /*[1F700]*/
1507 /** @stable ICU 4.6 */
1508 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_D = 209, /*[2B740]*/
1509
1510 /* New blocks in Unicode 6.1 */
1511
1512 /** @stable ICU 49 */
1513 UBLOCK_ARABIC_EXTENDED_A = 210, /*[08A0]*/
1514 /** @stable ICU 49 */
1515 UBLOCK_ARABIC_MATHEMATICAL_ALPHABETIC_SYMBOLS = 211, /*[1EE00]*/
1516 /** @stable ICU 49 */
1517 UBLOCK_CHAKMA = 212, /*[11100]*/
1518 /** @stable ICU 49 */
1519 UBLOCK_MEETEI_MAYEK_EXTENSIONS = 213, /*[AAE0]*/
1520 /** @stable ICU 49 */
1521 UBLOCK_MEROITIC_CURSIVE = 214, /*[109A0]*/
1522 /** @stable ICU 49 */
1523 UBLOCK_MEROITIC_HIEROGLYPHS = 215, /*[10980]*/
1524 /** @stable ICU 49 */
1525 UBLOCK_MIAO = 216, /*[16F00]*/
1526 /** @stable ICU 49 */
1527 UBLOCK_SHARADA = 217, /*[11180]*/
1528 /** @stable ICU 49 */
1529 UBLOCK_SORA_SOMPENG = 218, /*[110D0]*/
1530 /** @stable ICU 49 */
1531 UBLOCK_SUNDANESE_SUPPLEMENT = 219, /*[1CC0]*/
1532 /** @stable ICU 49 */
1533 UBLOCK_TAKRI = 220, /*[11680]*/
1534
1535 /* New blocks in Unicode 7.0 */
1536
1537 /** @stable ICU 54 */
1538 UBLOCK_BASSA_VAH = 221, /*[16AD0]*/
1539 /** @stable ICU 54 */
1540 UBLOCK_CAUCASIAN_ALBANIAN = 222, /*[10530]*/
1541 /** @stable ICU 54 */
1542 UBLOCK_COPTIC_EPACT_NUMBERS = 223, /*[102E0]*/
1543 /** @stable ICU 54 */
1544 UBLOCK_COMBINING_DIACRITICAL_MARKS_EXTENDED = 224, /*[1AB0]*/
1545 /** @stable ICU 54 */
1546 UBLOCK_DUPLOYAN = 225, /*[1BC00]*/
1547 /** @stable ICU 54 */
1548 UBLOCK_ELBASAN = 226, /*[10500]*/
1549 /** @stable ICU 54 */
1550 UBLOCK_GEOMETRIC_SHAPES_EXTENDED = 227, /*[1F780]*/
1551 /** @stable ICU 54 */
1552 UBLOCK_GRANTHA = 228, /*[11300]*/
1553 /** @stable ICU 54 */
1554 UBLOCK_KHOJKI = 229, /*[11200]*/
1555 /** @stable ICU 54 */
1556 UBLOCK_KHUDAWADI = 230, /*[112B0]*/
1557 /** @stable ICU 54 */
1558 UBLOCK_LATIN_EXTENDED_E = 231, /*[AB30]*/
1559 /** @stable ICU 54 */
1560 UBLOCK_LINEAR_A = 232, /*[10600]*/
1561 /** @stable ICU 54 */
1562 UBLOCK_MAHAJANI = 233, /*[11150]*/
1563 /** @stable ICU 54 */
1564 UBLOCK_MANICHAEAN = 234, /*[10AC0]*/
1565 /** @stable ICU 54 */
1566 UBLOCK_MENDE_KIKAKUI = 235, /*[1E800]*/
1567 /** @stable ICU 54 */
1568 UBLOCK_MODI = 236, /*[11600]*/
1569 /** @stable ICU 54 */
1570 UBLOCK_MRO = 237, /*[16A40]*/
1571 /** @stable ICU 54 */
1572 UBLOCK_MYANMAR_EXTENDED_B = 238, /*[A9E0]*/
1573 /** @stable ICU 54 */
1574 UBLOCK_NABATAEAN = 239, /*[10880]*/
1575 /** @stable ICU 54 */
1576 UBLOCK_OLD_NORTH_ARABIAN = 240, /*[10A80]*/
1577 /** @stable ICU 54 */
1578 UBLOCK_OLD_PERMIC = 241, /*[10350]*/
1579 /** @stable ICU 54 */
1580 UBLOCK_ORNAMENTAL_DINGBATS = 242, /*[1F650]*/
1581 /** @stable ICU 54 */
1582 UBLOCK_PAHAWH_HMONG = 243, /*[16B00]*/
1583 /** @stable ICU 54 */
1584 UBLOCK_PALMYRENE = 244, /*[10860]*/
1585 /** @stable ICU 54 */
1586 UBLOCK_PAU_CIN_HAU = 245, /*[11AC0]*/
1587 /** @stable ICU 54 */
1588 UBLOCK_PSALTER_PAHLAVI = 246, /*[10B80]*/
1589 /** @stable ICU 54 */
1590 UBLOCK_SHORTHAND_FORMAT_CONTROLS = 247, /*[1BCA0]*/
1591 /** @stable ICU 54 */
1592 UBLOCK_SIDDHAM = 248, /*[11580]*/
1593 /** @stable ICU 54 */
1594 UBLOCK_SINHALA_ARCHAIC_NUMBERS = 249, /*[111E0]*/
1595 /** @stable ICU 54 */
1596 UBLOCK_SUPPLEMENTAL_ARROWS_C = 250, /*[1F800]*/
1597 /** @stable ICU 54 */
1598 UBLOCK_TIRHUTA = 251, /*[11480]*/
1599 /** @stable ICU 54 */
1600 UBLOCK_WARANG_CITI = 252, /*[118A0]*/
1601
1602 /* New blocks in Unicode 8.0 */
1603
1604 /** @stable ICU 56 */
1605 UBLOCK_AHOM = 253, /*[11700]*/
1606 /** @stable ICU 56 */
1607 UBLOCK_ANATOLIAN_HIEROGLYPHS = 254, /*[14400]*/
1608 /** @stable ICU 56 */
1609 UBLOCK_CHEROKEE_SUPPLEMENT = 255, /*[AB70]*/
1610 /** @stable ICU 56 */
1611 UBLOCK_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_E = 256, /*[2B820]*/
1612 /** @stable ICU 56 */
1613 UBLOCK_EARLY_DYNASTIC_CUNEIFORM = 257, /*[12480]*/
1614 /** @stable ICU 56 */
1615 UBLOCK_HATRAN = 258, /*[108E0]*/
1616 /** @stable ICU 56 */
1617 UBLOCK_MULTANI = 259, /*[11280]*/
1618 /** @stable ICU 56 */
1619 UBLOCK_OLD_HUNGARIAN = 260, /*[10C80]*/
1620 /** @stable ICU 56 */
1621 UBLOCK_SUPPLEMENTAL_SYMBOLS_AND_PICTOGRAPHS = 261, /*[1F900]*/
1622 /** @stable ICU 56 */
1623 UBLOCK_SUTTON_SIGNWRITING = 262, /*[1D800]*/
1624
1625 /* New blocks in Unicode 9.0 */
1626
1627 /** @stable ICU 58 */
1628 UBLOCK_ADLAM = 263, /*[1E900]*/
1629 /** @stable ICU 58 */
1630 UBLOCK_BHAIKSUKI = 264, /*[11C00]*/
1631 /** @stable ICU 58 */
1632 UBLOCK_CYRILLIC_EXTENDED_C = 265, /*[1C80]*/
1633 /** @stable ICU 58 */
1634 UBLOCK_GLAGOLITIC_SUPPLEMENT = 266, /*[1E000]*/
1635 /** @stable ICU 58 */
1636 UBLOCK_IDEOGRAPHIC_SYMBOLS_AND_PUNCTUATION = 267, /*[16FE0]*/
1637 /** @stable ICU 58 */
1638 UBLOCK_MARCHEN = 268, /*[11C70]*/
1639 /** @stable ICU 58 */
1640 UBLOCK_MONGOLIAN_SUPPLEMENT = 269, /*[11660]*/
1641 /** @stable ICU 58 */
1642 UBLOCK_NEWA = 270, /*[11400]*/
1643 /** @stable ICU 58 */
1644 UBLOCK_OSAGE = 271, /*[104B0]*/
1645 /** @stable ICU 58 */
1646 UBLOCK_TANGUT = 272, /*[17000]*/
1647 /** @stable ICU 58 */
1648 UBLOCK_TANGUT_COMPONENTS = 273, /*[18800]*/
1649
1650 #ifndef U_HIDE_DEPRECATED_API
1651 /**
1652 * One more than the highest normal UBlockCode value.
1653 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_BLOCK).
1654 *
1655 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1656 */
1657 UBLOCK_COUNT = 274,
1658 #endif // U_HIDE_DEPRECATED_API
1659
1660 /** @stable ICU 2.0 */
1661 UBLOCK_INVALID_CODE=-1
1662 };
1663
1664 /** @stable ICU 2.0 */
1665 typedef enum UBlockCode UBlockCode;
1666
1667 /**
1668 * East Asian Width constants.
1669 *
1670 * @see UCHAR_EAST_ASIAN_WIDTH
1671 * @see u_getIntPropertyValue
1672 * @stable ICU 2.2
1673 */
1674 typedef enum UEastAsianWidth {
1675 /*
1676 * Note: UEastAsianWidth constants are parsed by preparseucd.py.
1677 * It matches lines like
1678 * U_EA_<Unicode East_Asian_Width value name>
1679 */
1680
1681 U_EA_NEUTRAL, /*[N]*/
1682 U_EA_AMBIGUOUS, /*[A]*/
1683 U_EA_HALFWIDTH, /*[H]*/
1684 U_EA_FULLWIDTH, /*[F]*/
1685 U_EA_NARROW, /*[Na]*/
1686 U_EA_WIDE, /*[W]*/
1687 #ifndef U_HIDE_DEPRECATED_API
1688 /**
1689 * One more than the highest normal UEastAsianWidth value.
1690 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_EAST_ASIAN_WIDTH).
1691 *
1692 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1693 */
1694 U_EA_COUNT
1695 #endif // U_HIDE_DEPRECATED_API
1696 } UEastAsianWidth;
1697
1698 /**
1699 * Selector constants for u_charName().
1700 * u_charName() returns the "modern" name of a
1701 * Unicode character; or the name that was defined in
1702 * Unicode version 1.0, before the Unicode standard merged
1703 * with ISO-10646; or an "extended" name that gives each
1704 * Unicode code point a unique name.
1705 *
1706 * @see u_charName
1707 * @stable ICU 2.0
1708 */
1709 typedef enum UCharNameChoice {
1710 /** Unicode character name (Name property). @stable ICU 2.0 */
1711 U_UNICODE_CHAR_NAME,
1712 #ifndef U_HIDE_DEPRECATED_API
1713 /**
1714 * The Unicode_1_Name property value which is of little practical value.
1715 * Beginning with ICU 49, ICU APIs return an empty string for this name choice.
1716 * @deprecated ICU 49
1717 */
1718 U_UNICODE_10_CHAR_NAME,
1719 #endif /* U_HIDE_DEPRECATED_API */
1720 /** Standard or synthetic character name. @stable ICU 2.0 */
1721 U_EXTENDED_CHAR_NAME = U_UNICODE_CHAR_NAME+2,
1722 /** Corrected name from NameAliases.txt. @stable ICU 4.4 */
1723 U_CHAR_NAME_ALIAS,
1724 #ifndef U_HIDE_DEPRECATED_API
1725 /**
1726 * One more than the highest normal UCharNameChoice value.
1727 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1728 */
1729 U_CHAR_NAME_CHOICE_COUNT
1730 #endif // U_HIDE_DEPRECATED_API
1731 } UCharNameChoice;
1732
1733 /**
1734 * Selector constants for u_getPropertyName() and
1735 * u_getPropertyValueName(). These selectors are used to choose which
1736 * name is returned for a given property or value. All properties and
1737 * values have a long name. Most have a short name, but some do not.
1738 * Unicode allows for additional names, beyond the long and short
1739 * name, which would be indicated by U_LONG_PROPERTY_NAME + i, where
1740 * i=1, 2,...
1741 *
1742 * @see u_getPropertyName()
1743 * @see u_getPropertyValueName()
1744 * @stable ICU 2.4
1745 */
1746 typedef enum UPropertyNameChoice {
1747 U_SHORT_PROPERTY_NAME,
1748 U_LONG_PROPERTY_NAME,
1749 #ifndef U_HIDE_DEPRECATED_API
1750 /**
1751 * One more than the highest normal UPropertyNameChoice value.
1752 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1753 */
1754 U_PROPERTY_NAME_CHOICE_COUNT
1755 #endif // U_HIDE_DEPRECATED_API
1756 } UPropertyNameChoice;
1757
1758 /**
1759 * Decomposition Type constants.
1760 *
1761 * @see UCHAR_DECOMPOSITION_TYPE
1762 * @stable ICU 2.2
1763 */
1764 typedef enum UDecompositionType {
1765 /*
1766 * Note: UDecompositionType constants are parsed by preparseucd.py.
1767 * It matches lines like
1768 * U_DT_<Unicode Decomposition_Type value name>
1769 */
1770
1771 U_DT_NONE, /*[none]*/
1772 U_DT_CANONICAL, /*[can]*/
1773 U_DT_COMPAT, /*[com]*/
1774 U_DT_CIRCLE, /*[enc]*/
1775 U_DT_FINAL, /*[fin]*/
1776 U_DT_FONT, /*[font]*/
1777 U_DT_FRACTION, /*[fra]*/
1778 U_DT_INITIAL, /*[init]*/
1779 U_DT_ISOLATED, /*[iso]*/
1780 U_DT_MEDIAL, /*[med]*/
1781 U_DT_NARROW, /*[nar]*/
1782 U_DT_NOBREAK, /*[nb]*/
1783 U_DT_SMALL, /*[sml]*/
1784 U_DT_SQUARE, /*[sqr]*/
1785 U_DT_SUB, /*[sub]*/
1786 U_DT_SUPER, /*[sup]*/
1787 U_DT_VERTICAL, /*[vert]*/
1788 U_DT_WIDE, /*[wide]*/
1789 #ifndef U_HIDE_DEPRECATED_API
1790 /**
1791 * One more than the highest normal UDecompositionType value.
1792 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_DECOMPOSITION_TYPE).
1793 *
1794 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1795 */
1796 U_DT_COUNT /* 18 */
1797 #endif // U_HIDE_DEPRECATED_API
1798 } UDecompositionType;
1799
1800 /**
1801 * Joining Type constants.
1802 *
1803 * @see UCHAR_JOINING_TYPE
1804 * @stable ICU 2.2
1805 */
1806 typedef enum UJoiningType {
1807 /*
1808 * Note: UJoiningType constants are parsed by preparseucd.py.
1809 * It matches lines like
1810 * U_JT_<Unicode Joining_Type value name>
1811 */
1812
1813 U_JT_NON_JOINING, /*[U]*/
1814 U_JT_JOIN_CAUSING, /*[C]*/
1815 U_JT_DUAL_JOINING, /*[D]*/
1816 U_JT_LEFT_JOINING, /*[L]*/
1817 U_JT_RIGHT_JOINING, /*[R]*/
1818 U_JT_TRANSPARENT, /*[T]*/
1819 #ifndef U_HIDE_DEPRECATED_API
1820 /**
1821 * One more than the highest normal UJoiningType value.
1822 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_JOINING_TYPE).
1823 *
1824 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1825 */
1826 U_JT_COUNT /* 6 */
1827 #endif // U_HIDE_DEPRECATED_API
1828 } UJoiningType;
1829
1830 /**
1831 * Joining Group constants.
1832 *
1833 * @see UCHAR_JOINING_GROUP
1834 * @stable ICU 2.2
1835 */
1836 typedef enum UJoiningGroup {
1837 /*
1838 * Note: UJoiningGroup constants are parsed by preparseucd.py.
1839 * It matches lines like
1840 * U_JG_<Unicode Joining_Group value name>
1841 */
1842
1843 U_JG_NO_JOINING_GROUP,
1844 U_JG_AIN,
1845 U_JG_ALAPH,
1846 U_JG_ALEF,
1847 U_JG_BEH,
1848 U_JG_BETH,
1849 U_JG_DAL,
1850 U_JG_DALATH_RISH,
1851 U_JG_E,
1852 U_JG_FEH,
1853 U_JG_FINAL_SEMKATH,
1854 U_JG_GAF,
1855 U_JG_GAMAL,
1856 U_JG_HAH,
1857 U_JG_TEH_MARBUTA_GOAL, /**< @stable ICU 4.6 */
1858 U_JG_HAMZA_ON_HEH_GOAL=U_JG_TEH_MARBUTA_GOAL,
1859 U_JG_HE,
1860 U_JG_HEH,
1861 U_JG_HEH_GOAL,
1862 U_JG_HETH,
1863 U_JG_KAF,
1864 U_JG_KAPH,
1865 U_JG_KNOTTED_HEH,
1866 U_JG_LAM,
1867 U_JG_LAMADH,
1868 U_JG_MEEM,
1869 U_JG_MIM,
1870 U_JG_NOON,
1871 U_JG_NUN,
1872 U_JG_PE,
1873 U_JG_QAF,
1874 U_JG_QAPH,
1875 U_JG_REH,
1876 U_JG_REVERSED_PE,
1877 U_JG_SAD,
1878 U_JG_SADHE,
1879 U_JG_SEEN,
1880 U_JG_SEMKATH,
1881 U_JG_SHIN,
1882 U_JG_SWASH_KAF,
1883 U_JG_SYRIAC_WAW,
1884 U_JG_TAH,
1885 U_JG_TAW,
1886 U_JG_TEH_MARBUTA,
1887 U_JG_TETH,
1888 U_JG_WAW,
1889 U_JG_YEH,
1890 U_JG_YEH_BARREE,
1891 U_JG_YEH_WITH_TAIL,
1892 U_JG_YUDH,
1893 U_JG_YUDH_HE,
1894 U_JG_ZAIN,
1895 U_JG_FE, /**< @stable ICU 2.6 */
1896 U_JG_KHAPH, /**< @stable ICU 2.6 */
1897 U_JG_ZHAIN, /**< @stable ICU 2.6 */
1898 U_JG_BURUSHASKI_YEH_BARREE, /**< @stable ICU 4.0 */
1899 U_JG_FARSI_YEH, /**< @stable ICU 4.4 */
1900 U_JG_NYA, /**< @stable ICU 4.4 */
1901 U_JG_ROHINGYA_YEH, /**< @stable ICU 49 */
1902 U_JG_MANICHAEAN_ALEPH, /**< @stable ICU 54 */
1903 U_JG_MANICHAEAN_AYIN, /**< @stable ICU 54 */
1904 U_JG_MANICHAEAN_BETH, /**< @stable ICU 54 */
1905 U_JG_MANICHAEAN_DALETH, /**< @stable ICU 54 */
1906 U_JG_MANICHAEAN_DHAMEDH, /**< @stable ICU 54 */
1907 U_JG_MANICHAEAN_FIVE, /**< @stable ICU 54 */
1908 U_JG_MANICHAEAN_GIMEL, /**< @stable ICU 54 */
1909 U_JG_MANICHAEAN_HETH, /**< @stable ICU 54 */
1910 U_JG_MANICHAEAN_HUNDRED, /**< @stable ICU 54 */
1911 U_JG_MANICHAEAN_KAPH, /**< @stable ICU 54 */
1912 U_JG_MANICHAEAN_LAMEDH, /**< @stable ICU 54 */
1913 U_JG_MANICHAEAN_MEM, /**< @stable ICU 54 */
1914 U_JG_MANICHAEAN_NUN, /**< @stable ICU 54 */
1915 U_JG_MANICHAEAN_ONE, /**< @stable ICU 54 */
1916 U_JG_MANICHAEAN_PE, /**< @stable ICU 54 */
1917 U_JG_MANICHAEAN_QOPH, /**< @stable ICU 54 */
1918 U_JG_MANICHAEAN_RESH, /**< @stable ICU 54 */
1919 U_JG_MANICHAEAN_SADHE, /**< @stable ICU 54 */
1920 U_JG_MANICHAEAN_SAMEKH, /**< @stable ICU 54 */
1921 U_JG_MANICHAEAN_TAW, /**< @stable ICU 54 */
1922 U_JG_MANICHAEAN_TEN, /**< @stable ICU 54 */
1923 U_JG_MANICHAEAN_TETH, /**< @stable ICU 54 */
1924 U_JG_MANICHAEAN_THAMEDH, /**< @stable ICU 54 */
1925 U_JG_MANICHAEAN_TWENTY, /**< @stable ICU 54 */
1926 U_JG_MANICHAEAN_WAW, /**< @stable ICU 54 */
1927 U_JG_MANICHAEAN_YODH, /**< @stable ICU 54 */
1928 U_JG_MANICHAEAN_ZAYIN, /**< @stable ICU 54 */
1929 U_JG_STRAIGHT_WAW, /**< @stable ICU 54 */
1930 U_JG_AFRICAN_FEH, /**< @stable ICU 58 */
1931 U_JG_AFRICAN_NOON, /**< @stable ICU 58 */
1932 U_JG_AFRICAN_QAF, /**< @stable ICU 58 */
1933 #ifndef U_HIDE_DEPRECATED_API
1934 /**
1935 * One more than the highest normal UJoiningGroup value.
1936 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_JOINING_GROUP).
1937 *
1938 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1939 */
1940 U_JG_COUNT
1941 #endif // U_HIDE_DEPRECATED_API
1942 } UJoiningGroup;
1943
1944 /**
1945 * Grapheme Cluster Break constants.
1946 *
1947 * @see UCHAR_GRAPHEME_CLUSTER_BREAK
1948 * @stable ICU 3.4
1949 */
1950 typedef enum UGraphemeClusterBreak {
1951 /*
1952 * Note: UGraphemeClusterBreak constants are parsed by preparseucd.py.
1953 * It matches lines like
1954 * U_GCB_<Unicode Grapheme_Cluster_Break value name>
1955 */
1956
1957 U_GCB_OTHER = 0, /*[XX]*/
1958 U_GCB_CONTROL = 1, /*[CN]*/
1959 U_GCB_CR = 2, /*[CR]*/
1960 U_GCB_EXTEND = 3, /*[EX]*/
1961 U_GCB_L = 4, /*[L]*/
1962 U_GCB_LF = 5, /*[LF]*/
1963 U_GCB_LV = 6, /*[LV]*/
1964 U_GCB_LVT = 7, /*[LVT]*/
1965 U_GCB_T = 8, /*[T]*/
1966 U_GCB_V = 9, /*[V]*/
1967 /** @stable ICU 4.0 */
1968 U_GCB_SPACING_MARK = 10, /*[SM]*/ /* from here on: new in Unicode 5.1/ICU 4.0 */
1969 /** @stable ICU 4.0 */
1970 U_GCB_PREPEND = 11, /*[PP]*/
1971 /** @stable ICU 50 */
1972 U_GCB_REGIONAL_INDICATOR = 12, /*[RI]*/ /* new in Unicode 6.2/ICU 50 */
1973 /** @stable ICU 58 */
1974 U_GCB_E_BASE = 13, /*[EB]*/ /* from here on: new in Unicode 9.0/ICU 58 */
1975 /** @stable ICU 58 */
1976 U_GCB_E_BASE_GAZ = 14, /*[EBG]*/
1977 /** @stable ICU 58 */
1978 U_GCB_E_MODIFIER = 15, /*[EM]*/
1979 /** @stable ICU 58 */
1980 U_GCB_GLUE_AFTER_ZWJ = 16, /*[GAZ]*/
1981 /** @stable ICU 58 */
1982 U_GCB_ZWJ = 17, /*[ZWJ]*/
1983 #ifndef U_HIDE_DEPRECATED_API
1984 /**
1985 * One more than the highest normal UGraphemeClusterBreak value.
1986 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_GRAPHEME_CLUSTER_BREAK).
1987 *
1988 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
1989 */
1990 U_GCB_COUNT = 18
1991 #endif // U_HIDE_DEPRECATED_API
1992 } UGraphemeClusterBreak;
1993
1994 /**
1995 * Word Break constants.
1996 * (UWordBreak is a pre-existing enum type in ubrk.h for word break status tags.)
1997 *
1998 * @see UCHAR_WORD_BREAK
1999 * @stable ICU 3.4
2000 */
2001 typedef enum UWordBreakValues {
2002 /*
2003 * Note: UWordBreakValues constants are parsed by preparseucd.py.
2004 * It matches lines like
2005 * U_WB_<Unicode Word_Break value name>
2006 */
2007
2008 U_WB_OTHER = 0, /*[XX]*/
2009 U_WB_ALETTER = 1, /*[LE]*/
2010 U_WB_FORMAT = 2, /*[FO]*/
2011 U_WB_KATAKANA = 3, /*[KA]*/
2012 U_WB_MIDLETTER = 4, /*[ML]*/
2013 U_WB_MIDNUM = 5, /*[MN]*/
2014 U_WB_NUMERIC = 6, /*[NU]*/
2015 U_WB_EXTENDNUMLET = 7, /*[EX]*/
2016 /** @stable ICU 4.0 */
2017 U_WB_CR = 8, /*[CR]*/ /* from here on: new in Unicode 5.1/ICU 4.0 */
2018 /** @stable ICU 4.0 */
2019 U_WB_EXTEND = 9, /*[Extend]*/
2020 /** @stable ICU 4.0 */
2021 U_WB_LF = 10, /*[LF]*/
2022 /** @stable ICU 4.0 */
2023 U_WB_MIDNUMLET =11, /*[MB]*/
2024 /** @stable ICU 4.0 */
2025 U_WB_NEWLINE =12, /*[NL]*/
2026 /** @stable ICU 50 */
2027 U_WB_REGIONAL_INDICATOR = 13, /*[RI]*/ /* new in Unicode 6.2/ICU 50 */
2028 /** @stable ICU 52 */
2029 U_WB_HEBREW_LETTER = 14, /*[HL]*/ /* from here on: new in Unicode 6.3/ICU 52 */
2030 /** @stable ICU 52 */
2031 U_WB_SINGLE_QUOTE = 15, /*[SQ]*/
2032 /** @stable ICU 52 */
2033 U_WB_DOUBLE_QUOTE = 16, /*[DQ]*/
2034 /** @stable ICU 58 */
2035 U_WB_E_BASE = 17, /*[EB]*/ /* from here on: new in Unicode 9.0/ICU 58 */
2036 /** @stable ICU 58 */
2037 U_WB_E_BASE_GAZ = 18, /*[EBG]*/
2038 /** @stable ICU 58 */
2039 U_WB_E_MODIFIER = 19, /*[EM]*/
2040 /** @stable ICU 58 */
2041 U_WB_GLUE_AFTER_ZWJ = 20, /*[GAZ]*/
2042 /** @stable ICU 58 */
2043 U_WB_ZWJ = 21, /*[ZWJ]*/
2044 #ifndef U_HIDE_DEPRECATED_API
2045 /**
2046 * One more than the highest normal UWordBreakValues value.
2047 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_WORD_BREAK).
2048 *
2049 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
2050 */
2051 U_WB_COUNT = 22
2052 #endif // U_HIDE_DEPRECATED_API
2053 } UWordBreakValues;
2054
2055 /**
2056 * Sentence Break constants.
2057 *
2058 * @see UCHAR_SENTENCE_BREAK
2059 * @stable ICU 3.4
2060 */
2061 typedef enum USentenceBreak {
2062 /*
2063 * Note: USentenceBreak constants are parsed by preparseucd.py.
2064 * It matches lines like
2065 * U_SB_<Unicode Sentence_Break value name>
2066 */
2067
2068 U_SB_OTHER = 0, /*[XX]*/
2069 U_SB_ATERM = 1, /*[AT]*/
2070 U_SB_CLOSE = 2, /*[CL]*/
2071 U_SB_FORMAT = 3, /*[FO]*/
2072 U_SB_LOWER = 4, /*[LO]*/
2073 U_SB_NUMERIC = 5, /*[NU]*/
2074 U_SB_OLETTER = 6, /*[LE]*/
2075 U_SB_SEP = 7, /*[SE]*/
2076 U_SB_SP = 8, /*[SP]*/
2077 U_SB_STERM = 9, /*[ST]*/
2078 U_SB_UPPER = 10, /*[UP]*/
2079 U_SB_CR = 11, /*[CR]*/ /* from here on: new in Unicode 5.1/ICU 4.0 */
2080 U_SB_EXTEND = 12, /*[EX]*/
2081 U_SB_LF = 13, /*[LF]*/
2082 U_SB_SCONTINUE = 14, /*[SC]*/
2083 #ifndef U_HIDE_DEPRECATED_API
2084 /**
2085 * One more than the highest normal USentenceBreak value.
2086 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_SENTENCE_BREAK).
2087 *
2088 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
2089 */
2090 U_SB_COUNT = 15
2091 #endif // U_HIDE_DEPRECATED_API
2092 } USentenceBreak;
2093
2094 /**
2095 * Line Break constants.
2096 *
2097 * @see UCHAR_LINE_BREAK
2098 * @stable ICU 2.2
2099 */
2100 typedef enum ULineBreak {
2101 /*
2102 * Note: ULineBreak constants are parsed by preparseucd.py.
2103 * It matches lines like
2104 * U_LB_<Unicode Line_Break value name>
2105 */
2106
2107 U_LB_UNKNOWN = 0, /*[XX]*/
2108 U_LB_AMBIGUOUS = 1, /*[AI]*/
2109 U_LB_ALPHABETIC = 2, /*[AL]*/
2110 U_LB_BREAK_BOTH = 3, /*[B2]*/
2111 U_LB_BREAK_AFTER = 4, /*[BA]*/
2112 U_LB_BREAK_BEFORE = 5, /*[BB]*/
2113 U_LB_MANDATORY_BREAK = 6, /*[BK]*/
2114 U_LB_CONTINGENT_BREAK = 7, /*[CB]*/
2115 U_LB_CLOSE_PUNCTUATION = 8, /*[CL]*/
2116 U_LB_COMBINING_MARK = 9, /*[CM]*/
2117 U_LB_CARRIAGE_RETURN = 10, /*[CR]*/
2118 U_LB_EXCLAMATION = 11, /*[EX]*/
2119 U_LB_GLUE = 12, /*[GL]*/
2120 U_LB_HYPHEN = 13, /*[HY]*/
2121 U_LB_IDEOGRAPHIC = 14, /*[ID]*/
2122 /** Renamed from the misspelled "inseperable" in Unicode 4.0.1/ICU 3.0 @stable ICU 3.0 */
2123 U_LB_INSEPARABLE = 15, /*[IN]*/
2124 U_LB_INSEPERABLE = U_LB_INSEPARABLE,
2125 U_LB_INFIX_NUMERIC = 16, /*[IS]*/
2126 U_LB_LINE_FEED = 17, /*[LF]*/
2127 U_LB_NONSTARTER = 18, /*[NS]*/
2128 U_LB_NUMERIC = 19, /*[NU]*/
2129 U_LB_OPEN_PUNCTUATION = 20, /*[OP]*/
2130 U_LB_POSTFIX_NUMERIC = 21, /*[PO]*/
2131 U_LB_PREFIX_NUMERIC = 22, /*[PR]*/
2132 U_LB_QUOTATION = 23, /*[QU]*/
2133 U_LB_COMPLEX_CONTEXT = 24, /*[SA]*/
2134 U_LB_SURROGATE = 25, /*[SG]*/
2135 U_LB_SPACE = 26, /*[SP]*/
2136 U_LB_BREAK_SYMBOLS = 27, /*[SY]*/
2137 U_LB_ZWSPACE = 28, /*[ZW]*/
2138 /** @stable ICU 2.6 */
2139 U_LB_NEXT_LINE = 29, /*[NL]*/ /* from here on: new in Unicode 4/ICU 2.6 */
2140 /** @stable ICU 2.6 */
2141 U_LB_WORD_JOINER = 30, /*[WJ]*/
2142 /** @stable ICU 3.4 */
2143 U_LB_H2 = 31, /*[H2]*/ /* from here on: new in Unicode 4.1/ICU 3.4 */
2144 /** @stable ICU 3.4 */
2145 U_LB_H3 = 32, /*[H3]*/
2146 /** @stable ICU 3.4 */
2147 U_LB_JL = 33, /*[JL]*/
2148 /** @stable ICU 3.4 */
2149 U_LB_JT = 34, /*[JT]*/
2150 /** @stable ICU 3.4 */
2151 U_LB_JV = 35, /*[JV]*/
2152 /** @stable ICU 4.4 */
2153 U_LB_CLOSE_PARENTHESIS = 36, /*[CP]*/ /* new in Unicode 5.2/ICU 4.4 */
2154 /** @stable ICU 49 */
2155 U_LB_CONDITIONAL_JAPANESE_STARTER = 37,/*[CJ]*/ /* new in Unicode 6.1/ICU 49 */
2156 /** @stable ICU 49 */
2157 U_LB_HEBREW_LETTER = 38, /*[HL]*/ /* new in Unicode 6.1/ICU 49 */
2158 /** @stable ICU 50 */
2159 U_LB_REGIONAL_INDICATOR = 39,/*[RI]*/ /* new in Unicode 6.2/ICU 50 */
2160 /** @stable ICU 58 */
2161 U_LB_E_BASE = 40, /*[EB]*/ /* from here on: new in Unicode 9.0/ICU 58 */
2162 /** @stable ICU 58 */
2163 U_LB_E_MODIFIER = 41, /*[EM]*/
2164 /** @stable ICU 58 */
2165 U_LB_ZWJ = 42, /*[ZWJ]*/
2166 #ifndef U_HIDE_DEPRECATED_API
2167 /**
2168 * One more than the highest normal ULineBreak value.
2169 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_LINE_BREAK).
2170 *
2171 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
2172 */
2173 U_LB_COUNT = 43
2174 #endif // U_HIDE_DEPRECATED_API
2175 } ULineBreak;
2176
2177 /**
2178 * Numeric Type constants.
2179 *
2180 * @see UCHAR_NUMERIC_TYPE
2181 * @stable ICU 2.2
2182 */
2183 typedef enum UNumericType {
2184 /*
2185 * Note: UNumericType constants are parsed by preparseucd.py.
2186 * It matches lines like
2187 * U_NT_<Unicode Numeric_Type value name>
2188 */
2189
2190 U_NT_NONE, /*[None]*/
2191 U_NT_DECIMAL, /*[de]*/
2192 U_NT_DIGIT, /*[di]*/
2193 U_NT_NUMERIC, /*[nu]*/
2194 #ifndef U_HIDE_DEPRECATED_API
2195 /**
2196 * One more than the highest normal UNumericType value.
2197 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_NUMERIC_TYPE).
2198 *
2199 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
2200 */
2201 U_NT_COUNT
2202 #endif // U_HIDE_DEPRECATED_API
2203 } UNumericType;
2204
2205 /**
2206 * Hangul Syllable Type constants.
2207 *
2208 * @see UCHAR_HANGUL_SYLLABLE_TYPE
2209 * @stable ICU 2.6
2210 */
2211 typedef enum UHangulSyllableType {
2212 /*
2213 * Note: UHangulSyllableType constants are parsed by preparseucd.py.
2214 * It matches lines like
2215 * U_HST_<Unicode Hangul_Syllable_Type value name>
2216 */
2217
2218 U_HST_NOT_APPLICABLE, /*[NA]*/
2219 U_HST_LEADING_JAMO, /*[L]*/
2220 U_HST_VOWEL_JAMO, /*[V]*/
2221 U_HST_TRAILING_JAMO, /*[T]*/
2222 U_HST_LV_SYLLABLE, /*[LV]*/
2223 U_HST_LVT_SYLLABLE, /*[LVT]*/
2224 #ifndef U_HIDE_DEPRECATED_API
2225 /**
2226 * One more than the highest normal UHangulSyllableType value.
2227 * The highest value is available via u_getIntPropertyMaxValue(UCHAR_HANGUL_SYLLABLE_TYPE).
2228 *
2229 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
2230 */
2231 U_HST_COUNT
2232 #endif // U_HIDE_DEPRECATED_API
2233 } UHangulSyllableType;
2234
2235 /**
2236 * Check a binary Unicode property for a code point.
2237 *
2238 * Unicode, especially in version 3.2, defines many more properties than the
2239 * original set in UnicodeData.txt.
2240 *
2241 * The properties APIs are intended to reflect Unicode properties as defined
2242 * in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).
2243 * For details about the properties see http://www.unicode.org/ucd/ .
2244 * For names of Unicode properties see the UCD file PropertyAliases.txt.
2245 *
2246 * Important: If ICU is built with UCD files from Unicode versions below 3.2,
2247 * then properties marked with "new in Unicode 3.2" are not or not fully available.
2248 *
2249 * @param c Code point to test.
2250 * @param which UProperty selector constant, identifies which binary property to check.
2251 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT.
2252 * @return TRUE or FALSE according to the binary Unicode property value for c.
2253 * Also FALSE if 'which' is out of bounds or if the Unicode version
2254 * does not have data for the property at all, or not for this code point.
2255 *
2256 * @see UProperty
2257 * @see u_getIntPropertyValue
2258 * @see u_getUnicodeVersion
2259 * @stable ICU 2.1
2260 */
2261 U_STABLE UBool U_EXPORT2
2262 u_hasBinaryProperty(UChar32 c, UProperty which);
2263
2264 /**
2265 * Check if a code point has the Alphabetic Unicode property.
2266 * Same as u_hasBinaryProperty(c, UCHAR_ALPHABETIC).
2267 * This is different from u_isalpha!
2268 * @param c Code point to test
2269 * @return true if the code point has the Alphabetic Unicode property, false otherwise
2270 *
2271 * @see UCHAR_ALPHABETIC
2272 * @see u_isalpha
2273 * @see u_hasBinaryProperty
2274 * @stable ICU 2.1
2275 */
2276 U_STABLE UBool U_EXPORT2
2277 u_isUAlphabetic(UChar32 c);
2278
2279 /**
2280 * Check if a code point has the Lowercase Unicode property.
2281 * Same as u_hasBinaryProperty(c, UCHAR_LOWERCASE).
2282 * This is different from u_islower!
2283 * @param c Code point to test
2284 * @return true if the code point has the Lowercase Unicode property, false otherwise
2285 *
2286 * @see UCHAR_LOWERCASE
2287 * @see u_islower
2288 * @see u_hasBinaryProperty
2289 * @stable ICU 2.1
2290 */
2291 U_STABLE UBool U_EXPORT2
2292 u_isULowercase(UChar32 c);
2293
2294 /**
2295 * Check if a code point has the Uppercase Unicode property.
2296 * Same as u_hasBinaryProperty(c, UCHAR_UPPERCASE).
2297 * This is different from u_isupper!
2298 * @param c Code point to test
2299 * @return true if the code point has the Uppercase Unicode property, false otherwise
2300 *
2301 * @see UCHAR_UPPERCASE
2302 * @see u_isupper
2303 * @see u_hasBinaryProperty
2304 * @stable ICU 2.1
2305 */
2306 U_STABLE UBool U_EXPORT2
2307 u_isUUppercase(UChar32 c);
2308
2309 /**
2310 * Check if a code point has the White_Space Unicode property.
2311 * Same as u_hasBinaryProperty(c, UCHAR_WHITE_SPACE).
2312 * This is different from both u_isspace and u_isWhitespace!
2313 *
2314 * Note: There are several ICU whitespace functions; please see the uchar.h
2315 * file documentation for a detailed comparison.
2316 *
2317 * @param c Code point to test
2318 * @return true if the code point has the White_Space Unicode property, false otherwise.
2319 *
2320 * @see UCHAR_WHITE_SPACE
2321 * @see u_isWhitespace
2322 * @see u_isspace
2323 * @see u_isJavaSpaceChar
2324 * @see u_hasBinaryProperty
2325 * @stable ICU 2.1
2326 */
2327 U_STABLE UBool U_EXPORT2
2328 u_isUWhiteSpace(UChar32 c);
2329
2330 /**
2331 * Get the property value for an enumerated or integer Unicode property for a code point.
2332 * Also returns binary and mask property values.
2333 *
2334 * Unicode, especially in version 3.2, defines many more properties than the
2335 * original set in UnicodeData.txt.
2336 *
2337 * The properties APIs are intended to reflect Unicode properties as defined
2338 * in the Unicode Character Database (UCD) and Unicode Technical Reports (UTR).
2339 * For details about the properties see http://www.unicode.org/ .
2340 * For names of Unicode properties see the UCD file PropertyAliases.txt.
2341 *
2342 * Sample usage:
2343 * UEastAsianWidth ea=(UEastAsianWidth)u_getIntPropertyValue(c, UCHAR_EAST_ASIAN_WIDTH);
2344 * UBool b=(UBool)u_getIntPropertyValue(c, UCHAR_IDEOGRAPHIC);
2345 *
2346 * @param c Code point to test.
2347 * @param which UProperty selector constant, identifies which property to check.
2348 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
2349 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT
2350 * or UCHAR_MASK_START<=which<UCHAR_MASK_LIMIT.
2351 * @return Numeric value that is directly the property value or,
2352 * for enumerated properties, corresponds to the numeric value of the enumerated
2353 * constant of the respective property value enumeration type
2354 * (cast to enum type if necessary).
2355 * Returns 0 or 1 (for FALSE/TRUE) for binary Unicode properties.
2356 * Returns a bit-mask for mask properties.
2357 * Returns 0 if 'which' is out of bounds or if the Unicode version
2358 * does not have data for the property at all, or not for this code point.
2359 *
2360 * @see UProperty
2361 * @see u_hasBinaryProperty
2362 * @see u_getIntPropertyMinValue
2363 * @see u_getIntPropertyMaxValue
2364 * @see u_getUnicodeVersion
2365 * @stable ICU 2.2
2366 */
2367 U_STABLE int32_t U_EXPORT2
2368 u_getIntPropertyValue(UChar32 c, UProperty which);
2369
2370 /**
2371 * Get the minimum value for an enumerated/integer/binary Unicode property.
2372 * Can be used together with u_getIntPropertyMaxValue
2373 * to allocate arrays of UnicodeSet or similar.
2374 *
2375 * @param which UProperty selector constant, identifies which binary property to check.
2376 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
2377 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT.
2378 * @return Minimum value returned by u_getIntPropertyValue for a Unicode property.
2379 * 0 if the property selector is out of range.
2380 *
2381 * @see UProperty
2382 * @see u_hasBinaryProperty
2383 * @see u_getUnicodeVersion
2384 * @see u_getIntPropertyMaxValue
2385 * @see u_getIntPropertyValue
2386 * @stable ICU 2.2
2387 */
2388 U_STABLE int32_t U_EXPORT2
2389 u_getIntPropertyMinValue(UProperty which);
2390
2391 /**
2392 * Get the maximum value for an enumerated/integer/binary Unicode property.
2393 * Can be used together with u_getIntPropertyMinValue
2394 * to allocate arrays of UnicodeSet or similar.
2395 *
2396 * Examples for min/max values (for Unicode 3.2):
2397 *
2398 * - UCHAR_BIDI_CLASS: 0/18 (U_LEFT_TO_RIGHT/U_BOUNDARY_NEUTRAL)
2399 * - UCHAR_SCRIPT: 0/45 (USCRIPT_COMMON/USCRIPT_TAGBANWA)
2400 * - UCHAR_IDEOGRAPHIC: 0/1 (FALSE/TRUE)
2401 *
2402 * For undefined UProperty constant values, min/max values will be 0/-1.
2403 *
2404 * @param which UProperty selector constant, identifies which binary property to check.
2405 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
2406 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT.
2407 * @return Maximum value returned by u_getIntPropertyValue for a Unicode property.
2408 * <=0 if the property selector is out of range.
2409 *
2410 * @see UProperty
2411 * @see u_hasBinaryProperty
2412 * @see u_getUnicodeVersion
2413 * @see u_getIntPropertyMaxValue
2414 * @see u_getIntPropertyValue
2415 * @stable ICU 2.2
2416 */
2417 U_STABLE int32_t U_EXPORT2
2418 u_getIntPropertyMaxValue(UProperty which);
2419
2420 /**
2421 * Get the numeric value for a Unicode code point as defined in the
2422 * Unicode Character Database.
2423 *
2424 * A "double" return type is necessary because
2425 * some numeric values are fractions, negative, or too large for int32_t.
2426 *
2427 * For characters without any numeric values in the Unicode Character Database,
2428 * this function will return U_NO_NUMERIC_VALUE.
2429 * Note: This is different from the Unicode Standard which specifies NaN as the default value.
2430 * (NaN is not available on all platforms.)
2431 *
2432 * Similar to java.lang.Character.getNumericValue(), but u_getNumericValue()
2433 * also supports negative values, large values, and fractions,
2434 * while Java's getNumericValue() returns values 10..35 for ASCII letters.
2435 *
2436 * @param c Code point to get the numeric value for.
2437 * @return Numeric value of c, or U_NO_NUMERIC_VALUE if none is defined.
2438 *
2439 * @see U_NO_NUMERIC_VALUE
2440 * @stable ICU 2.2
2441 */
2442 U_STABLE double U_EXPORT2
2443 u_getNumericValue(UChar32 c);
2444
2445 /**
2446 * Special value that is returned by u_getNumericValue when
2447 * no numeric value is defined for a code point.
2448 *
2449 * @see u_getNumericValue
2450 * @stable ICU 2.2
2451 */
2452 #define U_NO_NUMERIC_VALUE ((double)-123456789.)
2453
2454 /**
2455 * Determines whether the specified code point has the general category "Ll"
2456 * (lowercase letter).
2457 *
2458 * Same as java.lang.Character.isLowerCase().
2459 *
2460 * This misses some characters that are also lowercase but
2461 * have a different general category value.
2462 * In order to include those, use UCHAR_LOWERCASE.
2463 *
2464 * In addition to being equivalent to a Java function, this also serves
2465 * as a C/POSIX migration function.
2466 * See the comments about C/POSIX character classification functions in the
2467 * documentation at the top of this header file.
2468 *
2469 * @param c the code point to be tested
2470 * @return TRUE if the code point is an Ll lowercase letter
2471 *
2472 * @see UCHAR_LOWERCASE
2473 * @see u_isupper
2474 * @see u_istitle
2475 * @stable ICU 2.0
2476 */
2477 U_STABLE UBool U_EXPORT2
2478 u_islower(UChar32 c);
2479
2480 /**
2481 * Determines whether the specified code point has the general category "Lu"
2482 * (uppercase letter).
2483 *
2484 * Same as java.lang.Character.isUpperCase().
2485 *
2486 * This misses some characters that are also uppercase but
2487 * have a different general category value.
2488 * In order to include those, use UCHAR_UPPERCASE.
2489 *
2490 * In addition to being equivalent to a Java function, this also serves
2491 * as a C/POSIX migration function.
2492 * See the comments about C/POSIX character classification functions in the
2493 * documentation at the top of this header file.
2494 *
2495 * @param c the code point to be tested
2496 * @return TRUE if the code point is an Lu uppercase letter
2497 *
2498 * @see UCHAR_UPPERCASE
2499 * @see u_islower
2500 * @see u_istitle
2501 * @see u_tolower
2502 * @stable ICU 2.0
2503 */
2504 U_STABLE UBool U_EXPORT2
2505 u_isupper(UChar32 c);
2506
2507 /**
2508 * Determines whether the specified code point is a titlecase letter.
2509 * True for general category "Lt" (titlecase letter).
2510 *
2511 * Same as java.lang.Character.isTitleCase().
2512 *
2513 * @param c the code point to be tested
2514 * @return TRUE if the code point is an Lt titlecase letter
2515 *
2516 * @see u_isupper
2517 * @see u_islower
2518 * @see u_totitle
2519 * @stable ICU 2.0
2520 */
2521 U_STABLE UBool U_EXPORT2
2522 u_istitle(UChar32 c);
2523
2524 /**
2525 * Determines whether the specified code point is a digit character according to Java.
2526 * True for characters with general category "Nd" (decimal digit numbers).
2527 * Beginning with Unicode 4, this is the same as
2528 * testing for the Numeric_Type of Decimal.
2529 *
2530 * Same as java.lang.Character.isDigit().
2531 *
2532 * In addition to being equivalent to a Java function, this also serves
2533 * as a C/POSIX migration function.
2534 * See the comments about C/POSIX character classification functions in the
2535 * documentation at the top of this header file.
2536 *
2537 * @param c the code point to be tested
2538 * @return TRUE if the code point is a digit character according to Character.isDigit()
2539 *
2540 * @stable ICU 2.0
2541 */
2542 U_STABLE UBool U_EXPORT2
2543 u_isdigit(UChar32 c);
2544
2545 /**
2546 * Determines whether the specified code point is a letter character.
2547 * True for general categories "L" (letters).
2548 *
2549 * Same as java.lang.Character.isLetter().
2550 *
2551 * In addition to being equivalent to a Java function, this also serves
2552 * as a C/POSIX migration function.
2553 * See the comments about C/POSIX character classification functions in the
2554 * documentation at the top of this header file.
2555 *
2556 * @param c the code point to be tested
2557 * @return TRUE if the code point is a letter character
2558 *
2559 * @see u_isdigit
2560 * @see u_isalnum
2561 * @stable ICU 2.0
2562 */
2563 U_STABLE UBool U_EXPORT2
2564 u_isalpha(UChar32 c);
2565
2566 /**
2567 * Determines whether the specified code point is an alphanumeric character
2568 * (letter or digit) according to Java.
2569 * True for characters with general categories
2570 * "L" (letters) and "Nd" (decimal digit numbers).
2571 *
2572 * Same as java.lang.Character.isLetterOrDigit().
2573 *
2574 * In addition to being equivalent to a Java function, this also serves
2575 * as a C/POSIX migration function.
2576 * See the comments about C/POSIX character classification functions in the
2577 * documentation at the top of this header file.
2578 *
2579 * @param c the code point to be tested
2580 * @return TRUE if the code point is an alphanumeric character according to Character.isLetterOrDigit()
2581 *
2582 * @stable ICU 2.0
2583 */
2584 U_STABLE UBool U_EXPORT2
2585 u_isalnum(UChar32 c);
2586
2587 /**
2588 * Determines whether the specified code point is a hexadecimal digit.
2589 * This is equivalent to u_digit(c, 16)>=0.
2590 * True for characters with general category "Nd" (decimal digit numbers)
2591 * as well as Latin letters a-f and A-F in both ASCII and Fullwidth ASCII.
2592 * (That is, for letters with code points
2593 * 0041..0046, 0061..0066, FF21..FF26, FF41..FF46.)
2594 *
2595 * In order to narrow the definition of hexadecimal digits to only ASCII
2596 * characters, use (c<=0x7f && u_isxdigit(c)).
2597 *
2598 * This is a C/POSIX migration function.
2599 * See the comments about C/POSIX character classification functions in the
2600 * documentation at the top of this header file.
2601 *
2602 * @param c the code point to be tested
2603 * @return TRUE if the code point is a hexadecimal digit
2604 *
2605 * @stable ICU 2.6
2606 */
2607 U_STABLE UBool U_EXPORT2
2608 u_isxdigit(UChar32 c);
2609
2610 /**
2611 * Determines whether the specified code point is a punctuation character.
2612 * True for characters with general categories "P" (punctuation).
2613 *
2614 * This is a C/POSIX migration function.
2615 * See the comments about C/POSIX character classification functions in the
2616 * documentation at the top of this header file.
2617 *
2618 * @param c the code point to be tested
2619 * @return TRUE if the code point is a punctuation character
2620 *
2621 * @stable ICU 2.6
2622 */
2623 U_STABLE UBool U_EXPORT2
2624 u_ispunct(UChar32 c);
2625
2626 /**
2627 * Determines whether the specified code point is a "graphic" character
2628 * (printable, excluding spaces).
2629 * TRUE for all characters except those with general categories
2630 * "Cc" (control codes), "Cf" (format controls), "Cs" (surrogates),
2631 * "Cn" (unassigned), and "Z" (separators).
2632 *
2633 * This is a C/POSIX migration function.
2634 * See the comments about C/POSIX character classification functions in the
2635 * documentation at the top of this header file.
2636 *
2637 * @param c the code point to be tested
2638 * @return TRUE if the code point is a "graphic" character
2639 *
2640 * @stable ICU 2.6
2641 */
2642 U_STABLE UBool U_EXPORT2
2643 u_isgraph(UChar32 c);
2644
2645 /**
2646 * Determines whether the specified code point is a "blank" or "horizontal space",
2647 * a character that visibly separates words on a line.
2648 * The following are equivalent definitions:
2649 *
2650 * TRUE for Unicode White_Space characters except for "vertical space controls"
2651 * where "vertical space controls" are the following characters:
2652 * U+000A (LF) U+000B (VT) U+000C (FF) U+000D (CR) U+0085 (NEL) U+2028 (LS) U+2029 (PS)
2653 *
2654 * same as
2655 *
2656 * TRUE for U+0009 (TAB) and characters with general category "Zs" (space separators)
2657 * except Zero Width Space (ZWSP, U+200B).
2658 *
2659 * Note: There are several ICU whitespace functions; please see the uchar.h
2660 * file documentation for a detailed comparison.
2661 *
2662 * This is a C/POSIX migration function.
2663 * See the comments about C/POSIX character classification functions in the
2664 * documentation at the top of this header file.
2665 *
2666 * @param c the code point to be tested
2667 * @return TRUE if the code point is a "blank"
2668 *
2669 * @stable ICU 2.6
2670 */
2671 U_STABLE UBool U_EXPORT2
2672 u_isblank(UChar32 c);
2673
2674 /**
2675 * Determines whether the specified code point is "defined",
2676 * which usually means that it is assigned a character.
2677 * True for general categories other than "Cn" (other, not assigned),
2678 * i.e., true for all code points mentioned in UnicodeData.txt.
2679 *
2680 * Note that non-character code points (e.g., U+FDD0) are not "defined"
2681 * (they are Cn), but surrogate code points are "defined" (Cs).
2682 *
2683 * Same as java.lang.Character.isDefined().
2684 *
2685 * @param c the code point to be tested
2686 * @return TRUE if the code point is assigned a character
2687 *
2688 * @see u_isdigit
2689 * @see u_isalpha
2690 * @see u_isalnum
2691 * @see u_isupper
2692 * @see u_islower
2693 * @see u_istitle
2694 * @stable ICU 2.0
2695 */
2696 U_STABLE UBool U_EXPORT2
2697 u_isdefined(UChar32 c);
2698
2699 /**
2700 * Determines if the specified character is a space character or not.
2701 *
2702 * Note: There are several ICU whitespace functions; please see the uchar.h
2703 * file documentation for a detailed comparison.
2704 *
2705 * This is a C/POSIX migration function.
2706 * See the comments about C/POSIX character classification functions in the
2707 * documentation at the top of this header file.
2708 *
2709 * @param c the character to be tested
2710 * @return true if the character is a space character; false otherwise.
2711 *
2712 * @see u_isJavaSpaceChar
2713 * @see u_isWhitespace
2714 * @see u_isUWhiteSpace
2715 * @stable ICU 2.0
2716 */
2717 U_STABLE UBool U_EXPORT2
2718 u_isspace(UChar32 c);
2719
2720 /**
2721 * Determine if the specified code point is a space character according to Java.
2722 * True for characters with general categories "Z" (separators),
2723 * which does not include control codes (e.g., TAB or Line Feed).
2724 *
2725 * Same as java.lang.Character.isSpaceChar().
2726 *
2727 * Note: There are several ICU whitespace functions; please see the uchar.h
2728 * file documentation for a detailed comparison.
2729 *
2730 * @param c the code point to be tested
2731 * @return TRUE if the code point is a space character according to Character.isSpaceChar()
2732 *
2733 * @see u_isspace
2734 * @see u_isWhitespace
2735 * @see u_isUWhiteSpace
2736 * @stable ICU 2.6
2737 */
2738 U_STABLE UBool U_EXPORT2
2739 u_isJavaSpaceChar(UChar32 c);
2740
2741 /**
2742 * Determines if the specified code point is a whitespace character according to Java/ICU.
2743 * A character is considered to be a Java whitespace character if and only
2744 * if it satisfies one of the following criteria:
2745 *
2746 * - It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"), but is not
2747 * also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
2748 * - It is U+0009 HORIZONTAL TABULATION.
2749 * - It is U+000A LINE FEED.
2750 * - It is U+000B VERTICAL TABULATION.
2751 * - It is U+000C FORM FEED.
2752 * - It is U+000D CARRIAGE RETURN.
2753 * - It is U+001C FILE SEPARATOR.
2754 * - It is U+001D GROUP SEPARATOR.
2755 * - It is U+001E RECORD SEPARATOR.
2756 * - It is U+001F UNIT SEPARATOR.
2757 *
2758 * This API tries to sync with the semantics of Java's
2759 * java.lang.Character.isWhitespace(), but it may not return
2760 * the exact same results because of the Unicode version
2761 * difference.
2762 *
2763 * Note: Unicode 4.0.1 changed U+200B ZERO WIDTH SPACE from a Space Separator (Zs)
2764 * to a Format Control (Cf). Since then, isWhitespace(0x200b) returns false.
2765 * See http://www.unicode.org/versions/Unicode4.0.1/
2766 *
2767 * Note: There are several ICU whitespace functions; please see the uchar.h
2768 * file documentation for a detailed comparison.
2769 *
2770 * @param c the code point to be tested
2771 * @return TRUE if the code point is a whitespace character according to Java/ICU
2772 *
2773 * @see u_isspace
2774 * @see u_isJavaSpaceChar
2775 * @see u_isUWhiteSpace
2776 * @stable ICU 2.0
2777 */
2778 U_STABLE UBool U_EXPORT2
2779 u_isWhitespace(UChar32 c);
2780
2781 /**
2782 * Determines whether the specified code point is a control character
2783 * (as defined by this function).
2784 * A control character is one of the following:
2785 * - ISO 8-bit control character (U+0000..U+001f and U+007f..U+009f)
2786 * - U_CONTROL_CHAR (Cc)
2787 * - U_FORMAT_CHAR (Cf)
2788 * - U_LINE_SEPARATOR (Zl)
2789 * - U_PARAGRAPH_SEPARATOR (Zp)
2790 *
2791 * This is a C/POSIX migration function.
2792 * See the comments about C/POSIX character classification functions in the
2793 * documentation at the top of this header file.
2794 *
2795 * @param c the code point to be tested
2796 * @return TRUE if the code point is a control character
2797 *
2798 * @see UCHAR_DEFAULT_IGNORABLE_CODE_POINT
2799 * @see u_isprint
2800 * @stable ICU 2.0
2801 */
2802 U_STABLE UBool U_EXPORT2
2803 u_iscntrl(UChar32 c);
2804
2805 /**
2806 * Determines whether the specified code point is an ISO control code.
2807 * True for U+0000..U+001f and U+007f..U+009f (general category "Cc").
2808 *
2809 * Same as java.lang.Character.isISOControl().
2810 *
2811 * @param c the code point to be tested
2812 * @return TRUE if the code point is an ISO control code
2813 *
2814 * @see u_iscntrl
2815 * @stable ICU 2.6
2816 */
2817 U_STABLE UBool U_EXPORT2
2818 u_isISOControl(UChar32 c);
2819
2820 /**
2821 * Determines whether the specified code point is a printable character.
2822 * True for general categories <em>other</em> than "C" (controls).
2823 *
2824 * This is a C/POSIX migration function.
2825 * See the comments about C/POSIX character classification functions in the
2826 * documentation at the top of this header file.
2827 *
2828 * @param c the code point to be tested
2829 * @return TRUE if the code point is a printable character
2830 *
2831 * @see UCHAR_DEFAULT_IGNORABLE_CODE_POINT
2832 * @see u_iscntrl
2833 * @stable ICU 2.0
2834 */
2835 U_STABLE UBool U_EXPORT2
2836 u_isprint(UChar32 c);
2837
2838 /**
2839 * Determines whether the specified code point is a base character.
2840 * True for general categories "L" (letters), "N" (numbers),
2841 * "Mc" (spacing combining marks), and "Me" (enclosing marks).
2842 *
2843 * Note that this is different from the Unicode definition in
2844 * chapter 3.5, conformance clause D13,
2845 * which defines base characters to be all characters (not Cn)
2846 * that do not graphically combine with preceding characters (M)
2847 * and that are neither control (Cc) or format (Cf) characters.
2848 *
2849 * @param c the code point to be tested
2850 * @return TRUE if the code point is a base character according to this function
2851 *
2852 * @see u_isalpha
2853 * @see u_isdigit
2854 * @stable ICU 2.0
2855 */
2856 U_STABLE UBool U_EXPORT2
2857 u_isbase(UChar32 c);
2858
2859 /**
2860 * Returns the bidirectional category value for the code point,
2861 * which is used in the Unicode bidirectional algorithm
2862 * (UAX #9 http://www.unicode.org/reports/tr9/).
2863 * Note that some <em>unassigned</em> code points have bidi values
2864 * of R or AL because they are in blocks that are reserved
2865 * for Right-To-Left scripts.
2866 *
2867 * Same as java.lang.Character.getDirectionality()
2868 *
2869 * @param c the code point to be tested
2870 * @return the bidirectional category (UCharDirection) value
2871 *
2872 * @see UCharDirection
2873 * @stable ICU 2.0
2874 */
2875 U_STABLE UCharDirection U_EXPORT2
2876 u_charDirection(UChar32 c);
2877
2878 /**
2879 * Determines whether the code point has the Bidi_Mirrored property.
2880 * This property is set for characters that are commonly used in
2881 * Right-To-Left contexts and need to be displayed with a "mirrored"
2882 * glyph.
2883 *
2884 * Same as java.lang.Character.isMirrored().
2885 * Same as UCHAR_BIDI_MIRRORED
2886 *
2887 * @param c the code point to be tested
2888 * @return TRUE if the character has the Bidi_Mirrored property
2889 *
2890 * @see UCHAR_BIDI_MIRRORED
2891 * @stable ICU 2.0
2892 */
2893 U_STABLE UBool U_EXPORT2
2894 u_isMirrored(UChar32 c);
2895
2896 /**
2897 * Maps the specified character to a "mirror-image" character.
2898 * For characters with the Bidi_Mirrored property, implementations
2899 * sometimes need a "poor man's" mapping to another Unicode
2900 * character (code point) such that the default glyph may serve
2901 * as the mirror-image of the default glyph of the specified
2902 * character. This is useful for text conversion to and from
2903 * codepages with visual order, and for displays without glyph
2904 * selection capabilities.
2905 *
2906 * @param c the code point to be mapped
2907 * @return another Unicode code point that may serve as a mirror-image
2908 * substitute, or c itself if there is no such mapping or c
2909 * does not have the Bidi_Mirrored property
2910 *
2911 * @see UCHAR_BIDI_MIRRORED
2912 * @see u_isMirrored
2913 * @stable ICU 2.0
2914 */
2915 U_STABLE UChar32 U_EXPORT2
2916 u_charMirror(UChar32 c);
2917
2918 /**
2919 * Maps the specified character to its paired bracket character.
2920 * For Bidi_Paired_Bracket_Type!=None, this is the same as u_charMirror().
2921 * Otherwise c itself is returned.
2922 * See http://www.unicode.org/reports/tr9/
2923 *
2924 * @param c the code point to be mapped
2925 * @return the paired bracket code point,
2926 * or c itself if there is no such mapping
2927 * (Bidi_Paired_Bracket_Type=None)
2928 *
2929 * @see UCHAR_BIDI_PAIRED_BRACKET
2930 * @see UCHAR_BIDI_PAIRED_BRACKET_TYPE
2931 * @see u_charMirror
2932 * @stable ICU 52
2933 */
2934 U_STABLE UChar32 U_EXPORT2
2935 u_getBidiPairedBracket(UChar32 c);
2936
2937 /**
2938 * Returns the general category value for the code point.
2939 *
2940 * Same as java.lang.Character.getType().
2941 *
2942 * @param c the code point to be tested
2943 * @return the general category (UCharCategory) value
2944 *
2945 * @see UCharCategory
2946 * @stable ICU 2.0
2947 */
2948 U_STABLE int8_t U_EXPORT2
2949 u_charType(UChar32 c);
2950
2951 /**
2952 * Get a single-bit bit set for the general category of a character.
2953 * This bit set can be compared bitwise with U_GC_SM_MASK, U_GC_L_MASK, etc.
2954 * Same as U_MASK(u_charType(c)).
2955 *
2956 * @param c the code point to be tested
2957 * @return a single-bit mask corresponding to the general category (UCharCategory) value
2958 *
2959 * @see u_charType
2960 * @see UCharCategory
2961 * @see U_GC_CN_MASK
2962 * @stable ICU 2.1
2963 */
2964 #define U_GET_GC_MASK(c) U_MASK(u_charType(c))
2965
2966 /**
2967 * Callback from u_enumCharTypes(), is called for each contiguous range
2968 * of code points c (where start<=c<limit)
2969 * with the same Unicode general category ("character type").
2970 *
2971 * The callback function can stop the enumeration by returning FALSE.
2972 *
2973 * @param context an opaque pointer, as passed into utrie_enum()
2974 * @param start the first code point in a contiguous range with value
2975 * @param limit one past the last code point in a contiguous range with value
2976 * @param type the general category for all code points in [start..limit[
2977 * @return FALSE to stop the enumeration
2978 *
2979 * @stable ICU 2.1
2980 * @see UCharCategory
2981 * @see u_enumCharTypes
2982 */
2983 typedef UBool U_CALLCONV
2984 UCharEnumTypeRange(const void *context, UChar32 start, UChar32 limit, UCharCategory type);
2985
2986 /**
2987 * Enumerate efficiently all code points with their Unicode general categories.
2988 *
2989 * This is useful for building data structures (e.g., UnicodeSet's),
2990 * for enumerating all assigned code points (type!=U_UNASSIGNED), etc.
2991 *
2992 * For each contiguous range of code points with a given general category ("character type"),
2993 * the UCharEnumTypeRange function is called.
2994 * Adjacent ranges have different types.
2995 * The Unicode Standard guarantees that the numeric value of the type is 0..31.
2996 *
2997 * @param enumRange a pointer to a function that is called for each contiguous range
2998 * of code points with the same general category
2999 * @param context an opaque pointer that is passed on to the callback function
3000 *
3001 * @stable ICU 2.1
3002 * @see UCharCategory
3003 * @see UCharEnumTypeRange
3004 */
3005 U_STABLE void U_EXPORT2
3006 u_enumCharTypes(UCharEnumTypeRange *enumRange, const void *context);
3007
3008 #if !UCONFIG_NO_NORMALIZATION
3009
3010 /**
3011 * Returns the combining class of the code point as specified in UnicodeData.txt.
3012 *
3013 * @param c the code point of the character
3014 * @return the combining class of the character
3015 * @stable ICU 2.0
3016 */
3017 U_STABLE uint8_t U_EXPORT2
3018 u_getCombiningClass(UChar32 c);
3019
3020 #endif
3021
3022 /**
3023 * Returns the decimal digit value of a decimal digit character.
3024 * Such characters have the general category "Nd" (decimal digit numbers)
3025 * and a Numeric_Type of Decimal.
3026 *
3027 * Unlike ICU releases before 2.6, no digit values are returned for any
3028 * Han characters because Han number characters are often used with a special
3029 * Chinese-style number format (with characters for powers of 10 in between)
3030 * instead of in decimal-positional notation.
3031 * Unicode 4 explicitly assigns Han number characters the Numeric_Type
3032 * Numeric instead of Decimal.
3033 * See Jitterbug 1483 for more details.
3034 *
3035 * Use u_getIntPropertyValue(c, UCHAR_NUMERIC_TYPE) and u_getNumericValue()
3036 * for complete numeric Unicode properties.
3037 *
3038 * @param c the code point for which to get the decimal digit value
3039 * @return the decimal digit value of c,
3040 * or -1 if c is not a decimal digit character
3041 *
3042 * @see u_getNumericValue
3043 * @stable ICU 2.0
3044 */
3045 U_STABLE int32_t U_EXPORT2
3046 u_charDigitValue(UChar32 c);
3047
3048 /**
3049 * Returns the Unicode allocation block that contains the character.
3050 *
3051 * @param c the code point to be tested
3052 * @return the block value (UBlockCode) for c
3053 *
3054 * @see UBlockCode
3055 * @stable ICU 2.0
3056 */
3057 U_STABLE UBlockCode U_EXPORT2
3058 ublock_getCode(UChar32 c);
3059
3060 /**
3061 * Retrieve the name of a Unicode character.
3062 * Depending on <code>nameChoice</code>, the character name written
3063 * into the buffer is the "modern" name or the name that was defined
3064 * in Unicode version 1.0.
3065 * The name contains only "invariant" characters
3066 * like A-Z, 0-9, space, and '-'.
3067 * Unicode 1.0 names are only retrieved if they are different from the modern
3068 * names and if the data file contains the data for them. gennames may or may
3069 * not be called with a command line option to include 1.0 names in unames.dat.
3070 *
3071 * @param code The character (code point) for which to get the name.
3072 * It must be <code>0<=code<=0x10ffff</code>.
3073 * @param nameChoice Selector for which name to get.
3074 * @param buffer Destination address for copying the name.
3075 * The name will always be zero-terminated.
3076 * If there is no name, then the buffer will be set to the empty string.
3077 * @param bufferLength <code>==sizeof(buffer)</code>
3078 * @param pErrorCode Pointer to a UErrorCode variable;
3079 * check for <code>U_SUCCESS()</code> after <code>u_charName()</code>
3080 * returns.
3081 * @return The length of the name, or 0 if there is no name for this character.
3082 * If the bufferLength is less than or equal to the length, then the buffer
3083 * contains the truncated name and the returned length indicates the full
3084 * length of the name.
3085 * The length does not include the zero-termination.
3086 *
3087 * @see UCharNameChoice
3088 * @see u_charFromName
3089 * @see u_enumCharNames
3090 * @stable ICU 2.0
3091 */
3092 U_STABLE int32_t U_EXPORT2
3093 u_charName(UChar32 code, UCharNameChoice nameChoice,
3094 char *buffer, int32_t bufferLength,
3095 UErrorCode *pErrorCode);
3096
3097 #ifndef U_HIDE_DEPRECATED_API
3098 /**
3099 * Returns an empty string.
3100 * Used to return the ISO 10646 comment for a character.
3101 * The Unicode ISO_Comment property is deprecated and has no values.
3102 *
3103 * @param c The character (code point) for which to get the ISO comment.
3104 * It must be <code>0<=c<=0x10ffff</code>.
3105 * @param dest Destination address for copying the comment.
3106 * The comment will be zero-terminated if possible.
3107 * If there is no comment, then the buffer will be set to the empty string.
3108 * @param destCapacity <code>==sizeof(dest)</code>
3109 * @param pErrorCode Pointer to a UErrorCode variable;
3110 * check for <code>U_SUCCESS()</code> after <code>u_getISOComment()</code>
3111 * returns.
3112 * @return 0
3113 *
3114 * @deprecated ICU 49
3115 */
3116 U_DEPRECATED int32_t U_EXPORT2
3117 u_getISOComment(UChar32 c,
3118 char *dest, int32_t destCapacity,
3119 UErrorCode *pErrorCode);
3120 #endif /* U_HIDE_DEPRECATED_API */
3121
3122 /**
3123 * Find a Unicode character by its name and return its code point value.
3124 * The name is matched exactly and completely.
3125 * If the name does not correspond to a code point, <i>pErrorCode</i>
3126 * is set to <code>U_INVALID_CHAR_FOUND</code>.
3127 * A Unicode 1.0 name is matched only if it differs from the modern name.
3128 * Unicode names are all uppercase. Extended names are lowercase followed
3129 * by an uppercase hexadecimal number, and within angle brackets.
3130 *
3131 * @param nameChoice Selector for which name to match.
3132 * @param name The name to match.
3133 * @param pErrorCode Pointer to a UErrorCode variable
3134 * @return The Unicode value of the code point with the given name,
3135 * or an undefined value if there is no such code point.
3136 *
3137 * @see UCharNameChoice
3138 * @see u_charName
3139 * @see u_enumCharNames
3140 * @stable ICU 1.7
3141 */
3142 U_STABLE UChar32 U_EXPORT2
3143 u_charFromName(UCharNameChoice nameChoice,
3144 const char *name,
3145 UErrorCode *pErrorCode);
3146
3147 /**
3148 * Type of a callback function for u_enumCharNames() that gets called
3149 * for each Unicode character with the code point value and
3150 * the character name.
3151 * If such a function returns FALSE, then the enumeration is stopped.
3152 *
3153 * @param context The context pointer that was passed to u_enumCharNames().
3154 * @param code The Unicode code point for the character with this name.
3155 * @param nameChoice Selector for which kind of names is enumerated.
3156 * @param name The character's name, zero-terminated.
3157 * @param length The length of the name.
3158 * @return TRUE if the enumeration should continue, FALSE to stop it.
3159 *
3160 * @see UCharNameChoice
3161 * @see u_enumCharNames
3162 * @stable ICU 1.7
3163 */
3164 typedef UBool U_CALLCONV UEnumCharNamesFn(void *context,
3165 UChar32 code,
3166 UCharNameChoice nameChoice,
3167 const char *name,
3168 int32_t length);
3169
3170 /**
3171 * Enumerate all assigned Unicode characters between the start and limit
3172 * code points (start inclusive, limit exclusive) and call a function
3173 * for each, passing the code point value and the character name.
3174 * For Unicode 1.0 names, only those are enumerated that differ from the
3175 * modern names.
3176 *
3177 * @param start The first code point in the enumeration range.
3178 * @param limit One more than the last code point in the enumeration range
3179 * (the first one after the range).
3180 * @param fn The function that is to be called for each character name.
3181 * @param context An arbitrary pointer that is passed to the function.
3182 * @param nameChoice Selector for which kind of names to enumerate.
3183 * @param pErrorCode Pointer to a UErrorCode variable
3184 *
3185 * @see UCharNameChoice
3186 * @see UEnumCharNamesFn
3187 * @see u_charName
3188 * @see u_charFromName
3189 * @stable ICU 1.7
3190 */
3191 U_STABLE void U_EXPORT2
3192 u_enumCharNames(UChar32 start, UChar32 limit,
3193 UEnumCharNamesFn *fn,
3194 void *context,
3195 UCharNameChoice nameChoice,
3196 UErrorCode *pErrorCode);
3197
3198 /**
3199 * Return the Unicode name for a given property, as given in the
3200 * Unicode database file PropertyAliases.txt.
3201 *
3202 * In addition, this function maps the property
3203 * UCHAR_GENERAL_CATEGORY_MASK to the synthetic names "gcm" /
3204 * "General_Category_Mask". These names are not in
3205 * PropertyAliases.txt.
3206 *
3207 * @param property UProperty selector other than UCHAR_INVALID_CODE.
3208 * If out of range, NULL is returned.
3209 *
3210 * @param nameChoice selector for which name to get. If out of range,
3211 * NULL is returned. All properties have a long name. Most
3212 * have a short name, but some do not. Unicode allows for
3213 * additional names; if present these will be returned by
3214 * U_LONG_PROPERTY_NAME + i, where i=1, 2,...
3215 *
3216 * @return a pointer to the name, or NULL if either the
3217 * property or the nameChoice is out of range. If a given
3218 * nameChoice returns NULL, then all larger values of
3219 * nameChoice will return NULL, with one exception: if NULL is
3220 * returned for U_SHORT_PROPERTY_NAME, then
3221 * U_LONG_PROPERTY_NAME (and higher) may still return a
3222 * non-NULL value. The returned pointer is valid until
3223 * u_cleanup() is called.
3224 *
3225 * @see UProperty
3226 * @see UPropertyNameChoice
3227 * @stable ICU 2.4
3228 */
3229 U_STABLE const char* U_EXPORT2
3230 u_getPropertyName(UProperty property,
3231 UPropertyNameChoice nameChoice);
3232
3233 /**
3234 * Return the UProperty enum for a given property name, as specified
3235 * in the Unicode database file PropertyAliases.txt. Short, long, and
3236 * any other variants are recognized.
3237 *
3238 * In addition, this function maps the synthetic names "gcm" /
3239 * "General_Category_Mask" to the property
3240 * UCHAR_GENERAL_CATEGORY_MASK. These names are not in
3241 * PropertyAliases.txt.
3242 *
3243 * @param alias the property name to be matched. The name is compared
3244 * using "loose matching" as described in PropertyAliases.txt.
3245 *
3246 * @return a UProperty enum, or UCHAR_INVALID_CODE if the given name
3247 * does not match any property.
3248 *
3249 * @see UProperty
3250 * @stable ICU 2.4
3251 */
3252 U_STABLE UProperty U_EXPORT2
3253 u_getPropertyEnum(const char* alias);
3254
3255 /**
3256 * Return the Unicode name for a given property value, as given in the
3257 * Unicode database file PropertyValueAliases.txt.
3258 *
3259 * Note: Some of the names in PropertyValueAliases.txt can only be
3260 * retrieved using UCHAR_GENERAL_CATEGORY_MASK, not
3261 * UCHAR_GENERAL_CATEGORY. These include: "C" / "Other", "L" /
3262 * "Letter", "LC" / "Cased_Letter", "M" / "Mark", "N" / "Number", "P"
3263 * / "Punctuation", "S" / "Symbol", and "Z" / "Separator".
3264 *
3265 * @param property UProperty selector constant.
3266 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
3267 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT
3268 * or UCHAR_MASK_START<=which<UCHAR_MASK_LIMIT.
3269 * If out of range, NULL is returned.
3270 *
3271 * @param value selector for a value for the given property. If out
3272 * of range, NULL is returned. In general, valid values range
3273 * from 0 up to some maximum. There are a few exceptions:
3274 * (1.) UCHAR_BLOCK values begin at the non-zero value
3275 * UBLOCK_BASIC_LATIN. (2.) UCHAR_CANONICAL_COMBINING_CLASS
3276 * values are not contiguous and range from 0..240. (3.)
3277 * UCHAR_GENERAL_CATEGORY_MASK values are not values of
3278 * UCharCategory, but rather mask values produced by
3279 * U_GET_GC_MASK(). This allows grouped categories such as
3280 * [:L:] to be represented. Mask values range
3281 * non-contiguously from 1..U_GC_P_MASK.
3282 *
3283 * @param nameChoice selector for which name to get. If out of range,
3284 * NULL is returned. All values have a long name. Most have
3285 * a short name, but some do not. Unicode allows for
3286 * additional names; if present these will be returned by
3287 * U_LONG_PROPERTY_NAME + i, where i=1, 2,...
3288
3289 * @return a pointer to the name, or NULL if either the
3290 * property or the nameChoice is out of range. If a given
3291 * nameChoice returns NULL, then all larger values of
3292 * nameChoice will return NULL, with one exception: if NULL is
3293 * returned for U_SHORT_PROPERTY_NAME, then
3294 * U_LONG_PROPERTY_NAME (and higher) may still return a
3295 * non-NULL value. The returned pointer is valid until
3296 * u_cleanup() is called.
3297 *
3298 * @see UProperty
3299 * @see UPropertyNameChoice
3300 * @stable ICU 2.4
3301 */
3302 U_STABLE const char* U_EXPORT2
3303 u_getPropertyValueName(UProperty property,
3304 int32_t value,
3305 UPropertyNameChoice nameChoice);
3306
3307 /**
3308 * Return the property value integer for a given value name, as
3309 * specified in the Unicode database file PropertyValueAliases.txt.
3310 * Short, long, and any other variants are recognized.
3311 *
3312 * Note: Some of the names in PropertyValueAliases.txt will only be
3313 * recognized with UCHAR_GENERAL_CATEGORY_MASK, not
3314 * UCHAR_GENERAL_CATEGORY. These include: "C" / "Other", "L" /
3315 * "Letter", "LC" / "Cased_Letter", "M" / "Mark", "N" / "Number", "P"
3316 * / "Punctuation", "S" / "Symbol", and "Z" / "Separator".
3317 *
3318 * @param property UProperty selector constant.
3319 * Must be UCHAR_BINARY_START<=which<UCHAR_BINARY_LIMIT
3320 * or UCHAR_INT_START<=which<UCHAR_INT_LIMIT
3321 * or UCHAR_MASK_START<=which<UCHAR_MASK_LIMIT.
3322 * If out of range, UCHAR_INVALID_CODE is returned.
3323 *
3324 * @param alias the value name to be matched. The name is compared
3325 * using "loose matching" as described in
3326 * PropertyValueAliases.txt.
3327 *
3328 * @return a value integer or UCHAR_INVALID_CODE if the given name
3329 * does not match any value of the given property, or if the
3330 * property is invalid. Note: UCHAR_GENERAL_CATEGORY_MASK values
3331 * are not values of UCharCategory, but rather mask values
3332 * produced by U_GET_GC_MASK(). This allows grouped
3333 * categories such as [:L:] to be represented.
3334 *
3335 * @see UProperty
3336 * @stable ICU 2.4
3337 */
3338 U_STABLE int32_t U_EXPORT2
3339 u_getPropertyValueEnum(UProperty property,
3340 const char* alias);
3341
3342 /**
3343 * Determines if the specified character is permissible as the
3344 * first character in an identifier according to Unicode
3345 * (The Unicode Standard, Version 3.0, chapter 5.16 Identifiers).
3346 * True for characters with general categories "L" (letters) and "Nl" (letter numbers).
3347 *
3348 * Same as java.lang.Character.isUnicodeIdentifierStart().
3349 * Same as UCHAR_ID_START
3350 *
3351 * @param c the code point to be tested
3352 * @return TRUE if the code point may start an identifier
3353 *
3354 * @see UCHAR_ID_START
3355 * @see u_isalpha
3356 * @see u_isIDPart
3357 * @stable ICU 2.0
3358 */
3359 U_STABLE UBool U_EXPORT2
3360 u_isIDStart(UChar32 c);
3361
3362 /**
3363 * Determines if the specified character is permissible
3364 * in an identifier according to Java.
3365 * True for characters with general categories "L" (letters),
3366 * "Nl" (letter numbers), "Nd" (decimal digits),
3367 * "Mc" and "Mn" (combining marks), "Pc" (connecting punctuation), and
3368 * u_isIDIgnorable(c).
3369 *
3370 * Same as java.lang.Character.isUnicodeIdentifierPart().
3371 * Almost the same as Unicode's ID_Continue (UCHAR_ID_CONTINUE)
3372 * except that Unicode recommends to ignore Cf which is less than
3373 * u_isIDIgnorable(c).
3374 *
3375 * @param c the code point to be tested
3376 * @return TRUE if the code point may occur in an identifier according to Java
3377 *
3378 * @see UCHAR_ID_CONTINUE
3379 * @see u_isIDStart
3380 * @see u_isIDIgnorable
3381 * @stable ICU 2.0
3382 */
3383 U_STABLE UBool U_EXPORT2
3384 u_isIDPart(UChar32 c);
3385
3386 /**
3387 * Determines if the specified character should be regarded
3388 * as an ignorable character in an identifier,
3389 * according to Java.
3390 * True for characters with general category "Cf" (format controls) as well as
3391 * non-whitespace ISO controls
3392 * (U+0000..U+0008, U+000E..U+001B, U+007F..U+009F).
3393 *
3394 * Same as java.lang.Character.isIdentifierIgnorable().
3395 *
3396 * Note that Unicode just recommends to ignore Cf (format controls).
3397 *
3398 * @param c the code point to be tested
3399 * @return TRUE if the code point is ignorable in identifiers according to Java
3400 *
3401 * @see UCHAR_DEFAULT_IGNORABLE_CODE_POINT
3402 * @see u_isIDStart
3403 * @see u_isIDPart
3404 * @stable ICU 2.0
3405 */
3406 U_STABLE UBool U_EXPORT2
3407 u_isIDIgnorable(UChar32 c);
3408
3409 /**
3410 * Determines if the specified character is permissible as the
3411 * first character in a Java identifier.
3412 * In addition to u_isIDStart(c), true for characters with
3413 * general categories "Sc" (currency symbols) and "Pc" (connecting punctuation).
3414 *
3415 * Same as java.lang.Character.isJavaIdentifierStart().
3416 *
3417 * @param c the code point to be tested
3418 * @return TRUE if the code point may start a Java identifier
3419 *
3420 * @see u_isJavaIDPart
3421 * @see u_isalpha
3422 * @see u_isIDStart
3423 * @stable ICU 2.0
3424 */
3425 U_STABLE UBool U_EXPORT2
3426 u_isJavaIDStart(UChar32 c);
3427
3428 /**
3429 * Determines if the specified character is permissible
3430 * in a Java identifier.
3431 * In addition to u_isIDPart(c), true for characters with
3432 * general category "Sc" (currency symbols).
3433 *
3434 * Same as java.lang.Character.isJavaIdentifierPart().
3435 *
3436 * @param c the code point to be tested
3437 * @return TRUE if the code point may occur in a Java identifier
3438 *
3439 * @see u_isIDIgnorable
3440 * @see u_isJavaIDStart
3441 * @see u_isalpha
3442 * @see u_isdigit
3443 * @see u_isIDPart
3444 * @stable ICU 2.0
3445 */
3446 U_STABLE UBool U_EXPORT2
3447 u_isJavaIDPart(UChar32 c);
3448
3449 /**
3450 * The given character is mapped to its lowercase equivalent according to
3451 * UnicodeData.txt; if the character has no lowercase equivalent, the character
3452 * itself is returned.
3453 *
3454 * Same as java.lang.Character.toLowerCase().
3455 *
3456 * This function only returns the simple, single-code point case mapping.
3457 * Full case mappings should be used whenever possible because they produce
3458 * better results by working on whole strings.
3459 * They take into account the string context and the language and can map
3460 * to a result string with a different length as appropriate.
3461 * Full case mappings are applied by the string case mapping functions,
3462 * see ustring.h and the UnicodeString class.
3463 * See also the User Guide chapter on C/POSIX migration:
3464 * http://icu-project.org/userguide/posix.html#case_mappings
3465 *
3466 * @param c the code point to be mapped
3467 * @return the Simple_Lowercase_Mapping of the code point, if any;
3468 * otherwise the code point itself.
3469 * @stable ICU 2.0
3470 */
3471 U_STABLE UChar32 U_EXPORT2
3472 u_tolower(UChar32 c);
3473
3474 /**
3475 * The given character is mapped to its uppercase equivalent according to UnicodeData.txt;
3476 * if the character has no uppercase equivalent, the character itself is
3477 * returned.
3478 *
3479 * Same as java.lang.Character.toUpperCase().
3480 *
3481 * This function only returns the simple, single-code point case mapping.
3482 * Full case mappings should be used whenever possible because they produce
3483 * better results by working on whole strings.
3484 * They take into account the string context and the language and can map
3485 * to a result string with a different length as appropriate.
3486 * Full case mappings are applied by the string case mapping functions,
3487 * see ustring.h and the UnicodeString class.
3488 * See also the User Guide chapter on C/POSIX migration:
3489 * http://icu-project.org/userguide/posix.html#case_mappings
3490 *
3491 * @param c the code point to be mapped
3492 * @return the Simple_Uppercase_Mapping of the code point, if any;
3493 * otherwise the code point itself.
3494 * @stable ICU 2.0
3495 */
3496 U_STABLE UChar32 U_EXPORT2
3497 u_toupper(UChar32 c);
3498
3499 /**
3500 * The given character is mapped to its titlecase equivalent
3501 * according to UnicodeData.txt;
3502 * if none is defined, the character itself is returned.
3503 *
3504 * Same as java.lang.Character.toTitleCase().
3505 *
3506 * This function only returns the simple, single-code point case mapping.
3507 * Full case mappings should be used whenever possible because they produce
3508 * better results by working on whole strings.
3509 * They take into account the string context and the language and can map
3510 * to a result string with a different length as appropriate.
3511 * Full case mappings are applied by the string case mapping functions,
3512 * see ustring.h and the UnicodeString class.
3513 * See also the User Guide chapter on C/POSIX migration:
3514 * http://icu-project.org/userguide/posix.html#case_mappings
3515 *
3516 * @param c the code point to be mapped
3517 * @return the Simple_Titlecase_Mapping of the code point, if any;
3518 * otherwise the code point itself.
3519 * @stable ICU 2.0
3520 */
3521 U_STABLE UChar32 U_EXPORT2
3522 u_totitle(UChar32 c);
3523
3524 /** Option value for case folding: use default mappings defined in CaseFolding.txt. @stable ICU 2.0 */
3525 #define U_FOLD_CASE_DEFAULT 0
3526
3527 /**
3528 * Option value for case folding:
3529 *
3530 * Use the modified set of mappings provided in CaseFolding.txt to handle dotted I
3531 * and dotless i appropriately for Turkic languages (tr, az).
3532 *
3533 * Before Unicode 3.2, CaseFolding.txt contains mappings marked with 'I' that
3534 * are to be included for default mappings and
3535 * excluded for the Turkic-specific mappings.
3536 *
3537 * Unicode 3.2 CaseFolding.txt instead contains mappings marked with 'T' that
3538 * are to be excluded for default mappings and
3539 * included for the Turkic-specific mappings.
3540 *
3541 * @stable ICU 2.0
3542 */
3543 #define U_FOLD_CASE_EXCLUDE_SPECIAL_I 1
3544
3545 /**
3546 * The given character is mapped to its case folding equivalent according to
3547 * UnicodeData.txt and CaseFolding.txt;
3548 * if the character has no case folding equivalent, the character
3549 * itself is returned.
3550 *
3551 * This function only returns the simple, single-code point case mapping.
3552 * Full case mappings should be used whenever possible because they produce
3553 * better results by working on whole strings.
3554 * They take into account the string context and the language and can map
3555 * to a result string with a different length as appropriate.
3556 * Full case mappings are applied by the string case mapping functions,
3557 * see ustring.h and the UnicodeString class.
3558 * See also the User Guide chapter on C/POSIX migration:
3559 * http://icu-project.org/userguide/posix.html#case_mappings
3560 *
3561 * @param c the code point to be mapped
3562 * @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
3563 * @return the Simple_Case_Folding of the code point, if any;
3564 * otherwise the code point itself.
3565 * @stable ICU 2.0
3566 */
3567 U_STABLE UChar32 U_EXPORT2
3568 u_foldCase(UChar32 c, uint32_t options);
3569
3570 /**
3571 * Returns the decimal digit value of the code point in the
3572 * specified radix.
3573 *
3574 * If the radix is not in the range <code>2<=radix<=36</code> or if the
3575 * value of <code>c</code> is not a valid digit in the specified
3576 * radix, <code>-1</code> is returned. A character is a valid digit
3577 * if at least one of the following is true:
3578 * <ul>
3579 * <li>The character has a decimal digit value.
3580 * Such characters have the general category "Nd" (decimal digit numbers)
3581 * and a Numeric_Type of Decimal.
3582 * In this case the value is the character's decimal digit value.</li>
3583 * <li>The character is one of the uppercase Latin letters
3584 * <code>'A'</code> through <code>'Z'</code>.
3585 * In this case the value is <code>c-'A'+10</code>.</li>
3586 * <li>The character is one of the lowercase Latin letters
3587 * <code>'a'</code> through <code>'z'</code>.
3588 * In this case the value is <code>ch-'a'+10</code>.</li>
3589 * <li>Latin letters from both the ASCII range (0061..007A, 0041..005A)
3590 * as well as from the Fullwidth ASCII range (FF41..FF5A, FF21..FF3A)
3591 * are recognized.</li>
3592 * </ul>
3593 *
3594 * Same as java.lang.Character.digit().
3595 *
3596 * @param ch the code point to be tested.
3597 * @param radix the radix.
3598 * @return the numeric value represented by the character in the
3599 * specified radix,
3600 * or -1 if there is no value or if the value exceeds the radix.
3601 *
3602 * @see UCHAR_NUMERIC_TYPE
3603 * @see u_forDigit
3604 * @see u_charDigitValue
3605 * @see u_isdigit
3606 * @stable ICU 2.0
3607 */
3608 U_STABLE int32_t U_EXPORT2
3609 u_digit(UChar32 ch, int8_t radix);
3610
3611 /**
3612 * Determines the character representation for a specific digit in
3613 * the specified radix. If the value of <code>radix</code> is not a
3614 * valid radix, or the value of <code>digit</code> is not a valid
3615 * digit in the specified radix, the null character
3616 * (<code>U+0000</code>) is returned.
3617 * <p>
3618 * The <code>radix</code> argument is valid if it is greater than or
3619 * equal to 2 and less than or equal to 36.
3620 * The <code>digit</code> argument is valid if
3621 * <code>0 <= digit < radix</code>.
3622 * <p>
3623 * If the digit is less than 10, then
3624 * <code>'0' + digit</code> is returned. Otherwise, the value
3625 * <code>'a' + digit - 10</code> is returned.
3626 *
3627 * Same as java.lang.Character.forDigit().
3628 *
3629 * @param digit the number to convert to a character.
3630 * @param radix the radix.
3631 * @return the <code>char</code> representation of the specified digit
3632 * in the specified radix.
3633 *
3634 * @see u_digit
3635 * @see u_charDigitValue
3636 * @see u_isdigit
3637 * @stable ICU 2.0
3638 */
3639 U_STABLE UChar32 U_EXPORT2
3640 u_forDigit(int32_t digit, int8_t radix);
3641
3642 /**
3643 * Get the "age" of the code point.
3644 * The "age" is the Unicode version when the code point was first
3645 * designated (as a non-character or for Private Use)
3646 * or assigned a character.
3647 * This can be useful to avoid emitting code points to receiving
3648 * processes that do not accept newer characters.
3649 * The data is from the UCD file DerivedAge.txt.
3650 *
3651 * @param c The code point.
3652 * @param versionArray The Unicode version number array, to be filled in.
3653 *
3654 * @stable ICU 2.1
3655 */
3656 U_STABLE void U_EXPORT2
3657 u_charAge(UChar32 c, UVersionInfo versionArray);
3658
3659 /**
3660 * Gets the Unicode version information.
3661 * The version array is filled in with the version information
3662 * for the Unicode standard that is currently used by ICU.
3663 * For example, Unicode version 3.1.1 is represented as an array with
3664 * the values { 3, 1, 1, 0 }.
3665 *
3666 * @param versionArray an output array that will be filled in with
3667 * the Unicode version number
3668 * @stable ICU 2.0
3669 */
3670 U_STABLE void U_EXPORT2
3671 u_getUnicodeVersion(UVersionInfo versionArray);
3672
3673 #if !UCONFIG_NO_NORMALIZATION
3674 /**
3675 * Get the FC_NFKC_Closure property string for a character.
3676 * See Unicode Standard Annex #15 for details, search for "FC_NFKC_Closure"
3677 * or for "FNC": http://www.unicode.org/reports/tr15/
3678 *
3679 * @param c The character (code point) for which to get the FC_NFKC_Closure string.
3680 * It must be <code>0<=c<=0x10ffff</code>.
3681 * @param dest Destination address for copying the string.
3682 * The string will be zero-terminated if possible.
3683 * If there is no FC_NFKC_Closure string,
3684 * then the buffer will be set to the empty string.
3685 * @param destCapacity <code>==sizeof(dest)</code>
3686 * @param pErrorCode Pointer to a UErrorCode variable.
3687 * @return The length of the string, or 0 if there is no FC_NFKC_Closure string for this character.
3688 * If the destCapacity is less than or equal to the length, then the buffer
3689 * contains the truncated name and the returned length indicates the full
3690 * length of the name.
3691 * The length does not include the zero-termination.
3692 *
3693 * @stable ICU 2.2
3694 */
3695 U_STABLE int32_t U_EXPORT2
3696 u_getFC_NFKC_Closure(UChar32 c, UChar *dest, int32_t destCapacity, UErrorCode *pErrorCode);
3697
3698 #endif
3699
3700
3701 U_CDECL_END
3702
3703 #endif /*_UCHAR*/
3704 /*eof*/