1 /* Unicode character classification and properties.
2 Copyright (C) 2002, 2005-2011 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify it
5 under the terms of the GNU Lesser General Public License as published
6 by the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
32 /* ========================================================================= */
34 /* Field 1 of Unicode Character Database: Character name.
37 /* ========================================================================= */
39 /* Field 2 of Unicode Character Database: General category. */
41 /* Data type denoting a General category value. This is not just a bitmask,
42 but rather a bitmask and a pointer to the lookup table, so that programs
43 that use only the predefined bitmasks (i.e. don't combine bitmasks with &
44 and |) don't have a link-time dependency towards the big general table. */
47 uint32_t bitmask : 31;
48 /*bool*/ unsigned int generic : 1;
51 const void *table; /* when generic is 0 */
52 bool (*lookup_fn) (ucs4_t uc, uint32_t bitmask); /* when generic is 1 */
55 uc_general_category_t;
57 /* Bits and bit masks denoting General category values. UnicodeData-3.2.0.html
58 says a 32-bit integer will always suffice to represent them.
59 These bit masks can only be used with the uc_is_general_category_withtable
63 UC_CATEGORY_MASK_L = 0x0000001f,
64 UC_CATEGORY_MASK_LC = 0x00000007,
65 UC_CATEGORY_MASK_Lu = 0x00000001,
66 UC_CATEGORY_MASK_Ll = 0x00000002,
67 UC_CATEGORY_MASK_Lt = 0x00000004,
68 UC_CATEGORY_MASK_Lm = 0x00000008,
69 UC_CATEGORY_MASK_Lo = 0x00000010,
70 UC_CATEGORY_MASK_M = 0x000000e0,
71 UC_CATEGORY_MASK_Mn = 0x00000020,
72 UC_CATEGORY_MASK_Mc = 0x00000040,
73 UC_CATEGORY_MASK_Me = 0x00000080,
74 UC_CATEGORY_MASK_N = 0x00000700,
75 UC_CATEGORY_MASK_Nd = 0x00000100,
76 UC_CATEGORY_MASK_Nl = 0x00000200,
77 UC_CATEGORY_MASK_No = 0x00000400,
78 UC_CATEGORY_MASK_P = 0x0003f800,
79 UC_CATEGORY_MASK_Pc = 0x00000800,
80 UC_CATEGORY_MASK_Pd = 0x00001000,
81 UC_CATEGORY_MASK_Ps = 0x00002000,
82 UC_CATEGORY_MASK_Pe = 0x00004000,
83 UC_CATEGORY_MASK_Pi = 0x00008000,
84 UC_CATEGORY_MASK_Pf = 0x00010000,
85 UC_CATEGORY_MASK_Po = 0x00020000,
86 UC_CATEGORY_MASK_S = 0x003c0000,
87 UC_CATEGORY_MASK_Sm = 0x00040000,
88 UC_CATEGORY_MASK_Sc = 0x00080000,
89 UC_CATEGORY_MASK_Sk = 0x00100000,
90 UC_CATEGORY_MASK_So = 0x00200000,
91 UC_CATEGORY_MASK_Z = 0x01c00000,
92 UC_CATEGORY_MASK_Zs = 0x00400000,
93 UC_CATEGORY_MASK_Zl = 0x00800000,
94 UC_CATEGORY_MASK_Zp = 0x01000000,
95 UC_CATEGORY_MASK_C = 0x3e000000,
96 UC_CATEGORY_MASK_Cc = 0x02000000,
97 UC_CATEGORY_MASK_Cf = 0x04000000,
98 UC_CATEGORY_MASK_Cs = 0x08000000,
99 UC_CATEGORY_MASK_Co = 0x10000000,
100 UC_CATEGORY_MASK_Cn = 0x20000000
103 /* Predefined General category values. */
104 extern const uc_general_category_t UC_CATEGORY_L;
105 extern const uc_general_category_t UC_CATEGORY_LC;
106 extern const uc_general_category_t UC_CATEGORY_Lu;
107 extern const uc_general_category_t UC_CATEGORY_Ll;
108 extern const uc_general_category_t UC_CATEGORY_Lt;
109 extern const uc_general_category_t UC_CATEGORY_Lm;
110 extern const uc_general_category_t UC_CATEGORY_Lo;
111 extern const uc_general_category_t UC_CATEGORY_M;
112 extern const uc_general_category_t UC_CATEGORY_Mn;
113 extern const uc_general_category_t UC_CATEGORY_Mc;
114 extern const uc_general_category_t UC_CATEGORY_Me;
115 extern const uc_general_category_t UC_CATEGORY_N;
116 extern const uc_general_category_t UC_CATEGORY_Nd;
117 extern const uc_general_category_t UC_CATEGORY_Nl;
118 extern const uc_general_category_t UC_CATEGORY_No;
119 extern const uc_general_category_t UC_CATEGORY_P;
120 extern const uc_general_category_t UC_CATEGORY_Pc;
121 extern const uc_general_category_t UC_CATEGORY_Pd;
122 extern const uc_general_category_t UC_CATEGORY_Ps;
123 extern const uc_general_category_t UC_CATEGORY_Pe;
124 extern const uc_general_category_t UC_CATEGORY_Pi;
125 extern const uc_general_category_t UC_CATEGORY_Pf;
126 extern const uc_general_category_t UC_CATEGORY_Po;
127 extern const uc_general_category_t UC_CATEGORY_S;
128 extern const uc_general_category_t UC_CATEGORY_Sm;
129 extern const uc_general_category_t UC_CATEGORY_Sc;
130 extern const uc_general_category_t UC_CATEGORY_Sk;
131 extern const uc_general_category_t UC_CATEGORY_So;
132 extern const uc_general_category_t UC_CATEGORY_Z;
133 extern const uc_general_category_t UC_CATEGORY_Zs;
134 extern const uc_general_category_t UC_CATEGORY_Zl;
135 extern const uc_general_category_t UC_CATEGORY_Zp;
136 extern const uc_general_category_t UC_CATEGORY_C;
137 extern const uc_general_category_t UC_CATEGORY_Cc;
138 extern const uc_general_category_t UC_CATEGORY_Cf;
139 extern const uc_general_category_t UC_CATEGORY_Cs;
140 extern const uc_general_category_t UC_CATEGORY_Co;
141 extern const uc_general_category_t UC_CATEGORY_Cn;
143 extern const uc_general_category_t _UC_CATEGORY_NONE;
145 /* Alias names for predefined General category values. */
146 #define UC_LETTER UC_CATEGORY_L
147 #define UC_CASED_LETTER UC_CATEGORY_LC
148 #define UC_UPPERCASE_LETTER UC_CATEGORY_Lu
149 #define UC_LOWERCASE_LETTER UC_CATEGORY_Ll
150 #define UC_TITLECASE_LETTER UC_CATEGORY_Lt
151 #define UC_MODIFIER_LETTER UC_CATEGORY_Lm
152 #define UC_OTHER_LETTER UC_CATEGORY_Lo
153 #define UC_MARK UC_CATEGORY_M
154 #define UC_NON_SPACING_MARK UC_CATEGORY_Mn
155 #define UC_COMBINING_SPACING_MARK UC_CATEGORY_Mc
156 #define UC_ENCLOSING_MARK UC_CATEGORY_Me
157 #define UC_NUMBER UC_CATEGORY_N
158 #define UC_DECIMAL_DIGIT_NUMBER UC_CATEGORY_Nd
159 #define UC_LETTER_NUMBER UC_CATEGORY_Nl
160 #define UC_OTHER_NUMBER UC_CATEGORY_No
161 #define UC_PUNCTUATION UC_CATEGORY_P
162 #define UC_CONNECTOR_PUNCTUATION UC_CATEGORY_Pc
163 #define UC_DASH_PUNCTUATION UC_CATEGORY_Pd
164 #define UC_OPEN_PUNCTUATION UC_CATEGORY_Ps /* a.k.a. UC_START_PUNCTUATION */
165 #define UC_CLOSE_PUNCTUATION UC_CATEGORY_Pe /* a.k.a. UC_END_PUNCTUATION */
166 #define UC_INITIAL_QUOTE_PUNCTUATION UC_CATEGORY_Pi
167 #define UC_FINAL_QUOTE_PUNCTUATION UC_CATEGORY_Pf
168 #define UC_OTHER_PUNCTUATION UC_CATEGORY_Po
169 #define UC_SYMBOL UC_CATEGORY_S
170 #define UC_MATH_SYMBOL UC_CATEGORY_Sm
171 #define UC_CURRENCY_SYMBOL UC_CATEGORY_Sc
172 #define UC_MODIFIER_SYMBOL UC_CATEGORY_Sk
173 #define UC_OTHER_SYMBOL UC_CATEGORY_So
174 #define UC_SEPARATOR UC_CATEGORY_Z
175 #define UC_SPACE_SEPARATOR UC_CATEGORY_Zs
176 #define UC_LINE_SEPARATOR UC_CATEGORY_Zl
177 #define UC_PARAGRAPH_SEPARATOR UC_CATEGORY_Zp
178 #define UC_OTHER UC_CATEGORY_C
179 #define UC_CONTROL UC_CATEGORY_Cc
180 #define UC_FORMAT UC_CATEGORY_Cf
181 #define UC_SURROGATE UC_CATEGORY_Cs /* all of them are invalid characters */
182 #define UC_PRIVATE_USE UC_CATEGORY_Co
183 #define UC_UNASSIGNED UC_CATEGORY_Cn /* some of them are invalid characters */
185 /* Return the union of two general categories.
186 This corresponds to the unions of the two sets of characters. */
187 extern uc_general_category_t
188 uc_general_category_or (uc_general_category_t category1,
189 uc_general_category_t category2);
191 /* Return the intersection of two general categories as bit masks.
192 This *does*not* correspond to the intersection of the two sets of
194 extern uc_general_category_t
195 uc_general_category_and (uc_general_category_t category1,
196 uc_general_category_t category2);
198 /* Return the intersection of a general category with the complement of a
199 second general category, as bit masks.
200 This *does*not* correspond to the intersection with complement, when
201 viewing the categories as sets of characters. */
202 extern uc_general_category_t
203 uc_general_category_and_not (uc_general_category_t category1,
204 uc_general_category_t category2);
206 /* Return the name of a general category. */
208 uc_general_category_name (uc_general_category_t category);
210 /* Return the long name of a general category. */
212 uc_general_category_long_name (uc_general_category_t category);
214 /* Return the general category given by name, e.g. "Lu". */
215 extern uc_general_category_t
216 uc_general_category_byname (const char *category_name);
218 /* Return the general category of a Unicode character. */
219 extern uc_general_category_t
220 uc_general_category (ucs4_t uc);
222 /* Test whether a Unicode character belongs to a given category.
223 The CATEGORY argument can be the combination of several predefined
224 general categories. */
226 uc_is_general_category (ucs4_t uc, uc_general_category_t category);
227 /* Likewise. This function uses a big table comprising all categories. */
229 uc_is_general_category_withtable (ucs4_t uc, uint32_t bitmask);
231 /* ========================================================================= */
233 /* Field 3 of Unicode Character Database: Canonical combining class. */
235 /* The possible results of uc_combining_class (0..255) are described in
236 UCD.html. The list here is not definitive; more values can be added
237 in future versions. */
240 UC_CCC_NR = 0, /* Not Reordered */
241 UC_CCC_OV = 1, /* Overlay */
242 UC_CCC_NK = 7, /* Nukta */
243 UC_CCC_KV = 8, /* Kana Voicing */
244 UC_CCC_VR = 9, /* Virama */
245 UC_CCC_ATBL = 200, /* Attached Below Left */
246 UC_CCC_ATB = 202, /* Attached Below */
247 UC_CCC_ATAR = 216, /* Attached Above Right */
248 UC_CCC_BL = 218, /* Below Left */
249 UC_CCC_B = 220, /* Below */
250 UC_CCC_BR = 222, /* Below Right */
251 UC_CCC_L = 224, /* Left */
252 UC_CCC_R = 226, /* Right */
253 UC_CCC_AL = 228, /* Above Left */
254 UC_CCC_A = 230, /* Above */
255 UC_CCC_AR = 232, /* Above Right */
256 UC_CCC_DB = 233, /* Double Below */
257 UC_CCC_DA = 234, /* Double Above */
258 UC_CCC_IS = 240 /* Iota Subscript */
261 /* Return the canonical combining class of a Unicode character. */
263 uc_combining_class (ucs4_t uc);
265 /* ========================================================================= */
267 /* Field 4 of Unicode Character Database: Bidi class.
268 Before Unicode 4.0, this field was called "Bidirectional category". */
272 UC_BIDI_L, /* Left-to-Right */
273 UC_BIDI_LRE, /* Left-to-Right Embedding */
274 UC_BIDI_LRO, /* Left-to-Right Override */
275 UC_BIDI_R, /* Right-to-Left */
276 UC_BIDI_AL, /* Right-to-Left Arabic */
277 UC_BIDI_RLE, /* Right-to-Left Embedding */
278 UC_BIDI_RLO, /* Right-to-Left Override */
279 UC_BIDI_PDF, /* Pop Directional Format */
280 UC_BIDI_EN, /* European Number */
281 UC_BIDI_ES, /* European Number Separator */
282 UC_BIDI_ET, /* European Number Terminator */
283 UC_BIDI_AN, /* Arabic Number */
284 UC_BIDI_CS, /* Common Number Separator */
285 UC_BIDI_NSM, /* Non-Spacing Mark */
286 UC_BIDI_BN, /* Boundary Neutral */
287 UC_BIDI_B, /* Paragraph Separator */
288 UC_BIDI_S, /* Segment Separator */
289 UC_BIDI_WS, /* Whitespace */
290 UC_BIDI_ON /* Other Neutral */
293 /* Return the name of a bidi class. */
295 uc_bidi_class_name (int bidi_class);
296 /* Same; obsolete function name. */
298 uc_bidi_category_name (int category);
300 /* Return the bidi class given by name, e.g. "LRE". */
302 uc_bidi_class_byname (const char *bidi_class_name);
303 /* Same; obsolete function name. */
305 uc_bidi_category_byname (const char *category_name);
307 /* Return the bidi class of a Unicode character. */
309 uc_bidi_class (ucs4_t uc);
310 /* Same; obsolete function name. */
312 uc_bidi_category (ucs4_t uc);
314 /* Test whether a Unicode character belongs to a given bidi class. */
316 uc_is_bidi_class (ucs4_t uc, int bidi_class);
317 /* Same; obsolete function name. */
319 uc_is_bidi_category (ucs4_t uc, int category);
321 /* ========================================================================= */
323 /* Field 5 of Unicode Character Database: Character decomposition mapping.
326 /* ========================================================================= */
328 /* Field 6 of Unicode Character Database: Decimal digit value. */
330 /* Return the decimal digit value of a Unicode character. */
332 uc_decimal_value (ucs4_t uc);
334 /* ========================================================================= */
336 /* Field 7 of Unicode Character Database: Digit value. */
338 /* Return the digit value of a Unicode character. */
340 uc_digit_value (ucs4_t uc);
342 /* ========================================================================= */
344 /* Field 8 of Unicode Character Database: Numeric value. */
346 /* Return the numeric value of a Unicode character. */
354 uc_numeric_value (ucs4_t uc);
356 /* ========================================================================= */
358 /* Field 9 of Unicode Character Database: Mirrored. */
360 /* Return the mirrored character of a Unicode character UC in *PUC. */
362 uc_mirror_char (ucs4_t uc, ucs4_t *puc);
364 /* ========================================================================= */
366 /* Field 10 of Unicode Character Database: Unicode 1.0 Name.
367 Not available in this library. */
369 /* ========================================================================= */
371 /* Field 11 of Unicode Character Database: ISO 10646 comment.
372 Not available in this library. */
374 /* ========================================================================= */
376 /* Field 12, 13, 14 of Unicode Character Database: Uppercase mapping,
377 lowercase mapping, titlecase mapping. See "unicase.h". */
379 /* ========================================================================= */
381 /* Field 2 of the file ArabicShaping.txt in the Unicode Character Database. */
383 /* Possible joining types. */
386 UC_JOINING_TYPE_U, /* Non_Joining */
387 UC_JOINING_TYPE_T, /* Transparent */
388 UC_JOINING_TYPE_C, /* Join_Causing */
389 UC_JOINING_TYPE_L, /* Left_Joining */
390 UC_JOINING_TYPE_R, /* Right_Joining */
391 UC_JOINING_TYPE_D /* Dual_Joining */
394 /* Return the name of a joining type. */
396 uc_joining_type_name (int joining_type);
398 /* Return the joining type given by name, e.g. "D". */
400 uc_joining_type_byname (const char *joining_type_name);
402 /* Return the joining type of a Unicode character. */
404 uc_joining_type (ucs4_t uc);
406 /* ========================================================================= */
408 /* Field 3 of the file ArabicShaping.txt in the Unicode Character Database. */
410 /* Possible joining groups.
411 This enumeration may be extended in the future. */
414 UC_JOINING_GROUP_NONE, /* No_Joining_Group */
415 UC_JOINING_GROUP_AIN, /* Ain */
416 UC_JOINING_GROUP_ALAPH, /* Alaph */
417 UC_JOINING_GROUP_ALEF, /* Alef */
418 UC_JOINING_GROUP_BEH, /* Beh */
419 UC_JOINING_GROUP_BETH, /* Beth */
420 UC_JOINING_GROUP_BURUSHASKI_YEH_BARREE, /* Burushaski_Yeh_Barree */
421 UC_JOINING_GROUP_DAL, /* Dal */
422 UC_JOINING_GROUP_DALATH_RISH, /* Dalath_Rish */
423 UC_JOINING_GROUP_E, /* E */
424 UC_JOINING_GROUP_FARSI_YEH, /* Farsi_Yeh */
425 UC_JOINING_GROUP_FE, /* Fe */
426 UC_JOINING_GROUP_FEH, /* Feh */
427 UC_JOINING_GROUP_FINAL_SEMKATH, /* Final_Semkath */
428 UC_JOINING_GROUP_GAF, /* Gaf */
429 UC_JOINING_GROUP_GAMAL, /* Gamal */
430 UC_JOINING_GROUP_HAH, /* Hah */
431 UC_JOINING_GROUP_HE, /* He */
432 UC_JOINING_GROUP_HEH, /* Heh */
433 UC_JOINING_GROUP_HEH_GOAL, /* Heh_Goal */
434 UC_JOINING_GROUP_HETH, /* Heth */
435 UC_JOINING_GROUP_KAF, /* Kaf */
436 UC_JOINING_GROUP_KAPH, /* Kaph */
437 UC_JOINING_GROUP_KHAPH, /* Khaph */
438 UC_JOINING_GROUP_KNOTTED_HEH, /* Knotted_Heh */
439 UC_JOINING_GROUP_LAM, /* Lam */
440 UC_JOINING_GROUP_LAMADH, /* Lamadh */
441 UC_JOINING_GROUP_MEEM, /* Meem */
442 UC_JOINING_GROUP_MIM, /* Mim */
443 UC_JOINING_GROUP_NOON, /* Noon */
444 UC_JOINING_GROUP_NUN, /* Nun */
445 UC_JOINING_GROUP_NYA, /* Nya */
446 UC_JOINING_GROUP_PE, /* Pe */
447 UC_JOINING_GROUP_QAF, /* Qaf */
448 UC_JOINING_GROUP_QAPH, /* Qaph */
449 UC_JOINING_GROUP_REH, /* Reh */
450 UC_JOINING_GROUP_REVERSED_PE, /* Reversed_Pe */
451 UC_JOINING_GROUP_SAD, /* Sad */
452 UC_JOINING_GROUP_SADHE, /* Sadhe */
453 UC_JOINING_GROUP_SEEN, /* Seen */
454 UC_JOINING_GROUP_SEMKATH, /* Semkath */
455 UC_JOINING_GROUP_SHIN, /* Shin */
456 UC_JOINING_GROUP_SWASH_KAF, /* Swash_Kaf */
457 UC_JOINING_GROUP_SYRIAC_WAW, /* Syriac_Waw */
458 UC_JOINING_GROUP_TAH, /* Tah */
459 UC_JOINING_GROUP_TAW, /* Taw */
460 UC_JOINING_GROUP_TEH_MARBUTA, /* Teh_Marbuta */
461 UC_JOINING_GROUP_TEH_MARBUTA_GOAL, /* Teh_Marbuta_Goal */
462 UC_JOINING_GROUP_TETH, /* Teth */
463 UC_JOINING_GROUP_WAW, /* Waw */
464 UC_JOINING_GROUP_YEH, /* Yeh */
465 UC_JOINING_GROUP_YEH_BARREE, /* Yeh_Barree */
466 UC_JOINING_GROUP_YEH_WITH_TAIL, /* Yeh_With_Tail */
467 UC_JOINING_GROUP_YUDH, /* Yudh */
468 UC_JOINING_GROUP_YUDH_HE, /* Yudh_He */
469 UC_JOINING_GROUP_ZAIN, /* Zain */
470 UC_JOINING_GROUP_ZHAIN /* Zhain */
473 /* Return the name of a joining group. */
475 uc_joining_group_name (int joining_group);
477 /* Return the joining group given by name, e.g. "Teh_Marbuta". */
479 uc_joining_group_byname (const char *joining_group_name);
481 /* Return the joining group of a Unicode character. */
483 uc_joining_group (ucs4_t uc);
485 /* ========================================================================= */
487 /* Common API for properties. */
489 /* Data type denoting a property. This is not just a number, but rather a
490 pointer to the test functions, so that programs that use only few of the
491 properties don't have a link-time dependency towards all the tables. */
494 bool (*test_fn) (ucs4_t uc);
498 /* Predefined properties. */
500 extern const uc_property_t UC_PROPERTY_WHITE_SPACE;
501 extern const uc_property_t UC_PROPERTY_ALPHABETIC;
502 extern const uc_property_t UC_PROPERTY_OTHER_ALPHABETIC;
503 extern const uc_property_t UC_PROPERTY_NOT_A_CHARACTER;
504 extern const uc_property_t UC_PROPERTY_DEFAULT_IGNORABLE_CODE_POINT;
505 extern const uc_property_t UC_PROPERTY_OTHER_DEFAULT_IGNORABLE_CODE_POINT;
506 extern const uc_property_t UC_PROPERTY_DEPRECATED;
507 extern const uc_property_t UC_PROPERTY_LOGICAL_ORDER_EXCEPTION;
508 extern const uc_property_t UC_PROPERTY_VARIATION_SELECTOR;
509 extern const uc_property_t UC_PROPERTY_PRIVATE_USE;
510 extern const uc_property_t UC_PROPERTY_UNASSIGNED_CODE_VALUE;
512 extern const uc_property_t UC_PROPERTY_UPPERCASE;
513 extern const uc_property_t UC_PROPERTY_OTHER_UPPERCASE;
514 extern const uc_property_t UC_PROPERTY_LOWERCASE;
515 extern const uc_property_t UC_PROPERTY_OTHER_LOWERCASE;
516 extern const uc_property_t UC_PROPERTY_TITLECASE;
517 extern const uc_property_t UC_PROPERTY_CASED;
518 extern const uc_property_t UC_PROPERTY_CASE_IGNORABLE;
519 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_LOWERCASED;
520 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_UPPERCASED;
521 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_TITLECASED;
522 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_CASEFOLDED;
523 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_CASEMAPPED;
524 extern const uc_property_t UC_PROPERTY_SOFT_DOTTED;
526 extern const uc_property_t UC_PROPERTY_ID_START;
527 extern const uc_property_t UC_PROPERTY_OTHER_ID_START;
528 extern const uc_property_t UC_PROPERTY_ID_CONTINUE;
529 extern const uc_property_t UC_PROPERTY_OTHER_ID_CONTINUE;
530 extern const uc_property_t UC_PROPERTY_XID_START;
531 extern const uc_property_t UC_PROPERTY_XID_CONTINUE;
532 extern const uc_property_t UC_PROPERTY_PATTERN_WHITE_SPACE;
533 extern const uc_property_t UC_PROPERTY_PATTERN_SYNTAX;
534 /* Shaping and rendering. */
535 extern const uc_property_t UC_PROPERTY_JOIN_CONTROL;
536 extern const uc_property_t UC_PROPERTY_GRAPHEME_BASE;
537 extern const uc_property_t UC_PROPERTY_GRAPHEME_EXTEND;
538 extern const uc_property_t UC_PROPERTY_OTHER_GRAPHEME_EXTEND;
539 extern const uc_property_t UC_PROPERTY_GRAPHEME_LINK;
541 extern const uc_property_t UC_PROPERTY_BIDI_CONTROL;
542 extern const uc_property_t UC_PROPERTY_BIDI_LEFT_TO_RIGHT;
543 extern const uc_property_t UC_PROPERTY_BIDI_HEBREW_RIGHT_TO_LEFT;
544 extern const uc_property_t UC_PROPERTY_BIDI_ARABIC_RIGHT_TO_LEFT;
545 extern const uc_property_t UC_PROPERTY_BIDI_EUROPEAN_DIGIT;
546 extern const uc_property_t UC_PROPERTY_BIDI_EUR_NUM_SEPARATOR;
547 extern const uc_property_t UC_PROPERTY_BIDI_EUR_NUM_TERMINATOR;
548 extern const uc_property_t UC_PROPERTY_BIDI_ARABIC_DIGIT;
549 extern const uc_property_t UC_PROPERTY_BIDI_COMMON_SEPARATOR;
550 extern const uc_property_t UC_PROPERTY_BIDI_BLOCK_SEPARATOR;
551 extern const uc_property_t UC_PROPERTY_BIDI_SEGMENT_SEPARATOR;
552 extern const uc_property_t UC_PROPERTY_BIDI_WHITESPACE;
553 extern const uc_property_t UC_PROPERTY_BIDI_NON_SPACING_MARK;
554 extern const uc_property_t UC_PROPERTY_BIDI_BOUNDARY_NEUTRAL;
555 extern const uc_property_t UC_PROPERTY_BIDI_PDF;
556 extern const uc_property_t UC_PROPERTY_BIDI_EMBEDDING_OR_OVERRIDE;
557 extern const uc_property_t UC_PROPERTY_BIDI_OTHER_NEUTRAL;
559 extern const uc_property_t UC_PROPERTY_HEX_DIGIT;
560 extern const uc_property_t UC_PROPERTY_ASCII_HEX_DIGIT;
562 extern const uc_property_t UC_PROPERTY_IDEOGRAPHIC;
563 extern const uc_property_t UC_PROPERTY_UNIFIED_IDEOGRAPH;
564 extern const uc_property_t UC_PROPERTY_RADICAL;
565 extern const uc_property_t UC_PROPERTY_IDS_BINARY_OPERATOR;
566 extern const uc_property_t UC_PROPERTY_IDS_TRINARY_OPERATOR;
568 extern const uc_property_t UC_PROPERTY_ZERO_WIDTH;
569 extern const uc_property_t UC_PROPERTY_SPACE;
570 extern const uc_property_t UC_PROPERTY_NON_BREAK;
571 extern const uc_property_t UC_PROPERTY_ISO_CONTROL;
572 extern const uc_property_t UC_PROPERTY_FORMAT_CONTROL;
573 extern const uc_property_t UC_PROPERTY_DASH;
574 extern const uc_property_t UC_PROPERTY_HYPHEN;
575 extern const uc_property_t UC_PROPERTY_PUNCTUATION;
576 extern const uc_property_t UC_PROPERTY_LINE_SEPARATOR;
577 extern const uc_property_t UC_PROPERTY_PARAGRAPH_SEPARATOR;
578 extern const uc_property_t UC_PROPERTY_QUOTATION_MARK;
579 extern const uc_property_t UC_PROPERTY_SENTENCE_TERMINAL;
580 extern const uc_property_t UC_PROPERTY_TERMINAL_PUNCTUATION;
581 extern const uc_property_t UC_PROPERTY_CURRENCY_SYMBOL;
582 extern const uc_property_t UC_PROPERTY_MATH;
583 extern const uc_property_t UC_PROPERTY_OTHER_MATH;
584 extern const uc_property_t UC_PROPERTY_PAIRED_PUNCTUATION;
585 extern const uc_property_t UC_PROPERTY_LEFT_OF_PAIR;
586 extern const uc_property_t UC_PROPERTY_COMBINING;
587 extern const uc_property_t UC_PROPERTY_COMPOSITE;
588 extern const uc_property_t UC_PROPERTY_DECIMAL_DIGIT;
589 extern const uc_property_t UC_PROPERTY_NUMERIC;
590 extern const uc_property_t UC_PROPERTY_DIACRITIC;
591 extern const uc_property_t UC_PROPERTY_EXTENDER;
592 extern const uc_property_t UC_PROPERTY_IGNORABLE_CONTROL;
594 /* Return the property given by name, e.g. "White space". */
596 uc_property_byname (const char *property_name);
598 /* Test whether a property is valid. */
599 #define uc_property_is_valid(property) ((property).test_fn != NULL)
601 /* Test whether a Unicode character has a given property. */
603 uc_is_property (ucs4_t uc, uc_property_t property);
604 extern bool uc_is_property_white_space (ucs4_t uc);
605 extern bool uc_is_property_alphabetic (ucs4_t uc);
606 extern bool uc_is_property_other_alphabetic (ucs4_t uc);
607 extern bool uc_is_property_not_a_character (ucs4_t uc);
608 extern bool uc_is_property_default_ignorable_code_point (ucs4_t uc);
609 extern bool uc_is_property_other_default_ignorable_code_point (ucs4_t uc);
610 extern bool uc_is_property_deprecated (ucs4_t uc);
611 extern bool uc_is_property_logical_order_exception (ucs4_t uc);
612 extern bool uc_is_property_variation_selector (ucs4_t uc);
613 extern bool uc_is_property_private_use (ucs4_t uc);
614 extern bool uc_is_property_unassigned_code_value (ucs4_t uc);
615 extern bool uc_is_property_uppercase (ucs4_t uc);
616 extern bool uc_is_property_other_uppercase (ucs4_t uc);
617 extern bool uc_is_property_lowercase (ucs4_t uc);
618 extern bool uc_is_property_other_lowercase (ucs4_t uc);
619 extern bool uc_is_property_titlecase (ucs4_t uc);
620 extern bool uc_is_property_cased (ucs4_t uc);
621 extern bool uc_is_property_case_ignorable (ucs4_t uc);
622 extern bool uc_is_property_changes_when_lowercased (ucs4_t uc);
623 extern bool uc_is_property_changes_when_uppercased (ucs4_t uc);
624 extern bool uc_is_property_changes_when_titlecased (ucs4_t uc);
625 extern bool uc_is_property_changes_when_casefolded (ucs4_t uc);
626 extern bool uc_is_property_changes_when_casemapped (ucs4_t uc);
627 extern bool uc_is_property_soft_dotted (ucs4_t uc);
628 extern bool uc_is_property_id_start (ucs4_t uc);
629 extern bool uc_is_property_other_id_start (ucs4_t uc);
630 extern bool uc_is_property_id_continue (ucs4_t uc);
631 extern bool uc_is_property_other_id_continue (ucs4_t uc);
632 extern bool uc_is_property_xid_start (ucs4_t uc);
633 extern bool uc_is_property_xid_continue (ucs4_t uc);
634 extern bool uc_is_property_pattern_white_space (ucs4_t uc);
635 extern bool uc_is_property_pattern_syntax (ucs4_t uc);
636 extern bool uc_is_property_join_control (ucs4_t uc);
637 extern bool uc_is_property_grapheme_base (ucs4_t uc);
638 extern bool uc_is_property_grapheme_extend (ucs4_t uc);
639 extern bool uc_is_property_other_grapheme_extend (ucs4_t uc);
640 extern bool uc_is_property_grapheme_link (ucs4_t uc);
641 extern bool uc_is_property_bidi_control (ucs4_t uc);
642 extern bool uc_is_property_bidi_left_to_right (ucs4_t uc);
643 extern bool uc_is_property_bidi_hebrew_right_to_left (ucs4_t uc);
644 extern bool uc_is_property_bidi_arabic_right_to_left (ucs4_t uc);
645 extern bool uc_is_property_bidi_european_digit (ucs4_t uc);
646 extern bool uc_is_property_bidi_eur_num_separator (ucs4_t uc);
647 extern bool uc_is_property_bidi_eur_num_terminator (ucs4_t uc);
648 extern bool uc_is_property_bidi_arabic_digit (ucs4_t uc);
649 extern bool uc_is_property_bidi_common_separator (ucs4_t uc);
650 extern bool uc_is_property_bidi_block_separator (ucs4_t uc);
651 extern bool uc_is_property_bidi_segment_separator (ucs4_t uc);
652 extern bool uc_is_property_bidi_whitespace (ucs4_t uc);
653 extern bool uc_is_property_bidi_non_spacing_mark (ucs4_t uc);
654 extern bool uc_is_property_bidi_boundary_neutral (ucs4_t uc);
655 extern bool uc_is_property_bidi_pdf (ucs4_t uc);
656 extern bool uc_is_property_bidi_embedding_or_override (ucs4_t uc);
657 extern bool uc_is_property_bidi_other_neutral (ucs4_t uc);
658 extern bool uc_is_property_hex_digit (ucs4_t uc);
659 extern bool uc_is_property_ascii_hex_digit (ucs4_t uc);
660 extern bool uc_is_property_ideographic (ucs4_t uc);
661 extern bool uc_is_property_unified_ideograph (ucs4_t uc);
662 extern bool uc_is_property_radical (ucs4_t uc);
663 extern bool uc_is_property_ids_binary_operator (ucs4_t uc);
664 extern bool uc_is_property_ids_trinary_operator (ucs4_t uc);
665 extern bool uc_is_property_zero_width (ucs4_t uc);
666 extern bool uc_is_property_space (ucs4_t uc);
667 extern bool uc_is_property_non_break (ucs4_t uc);
668 extern bool uc_is_property_iso_control (ucs4_t uc);
669 extern bool uc_is_property_format_control (ucs4_t uc);
670 extern bool uc_is_property_dash (ucs4_t uc);
671 extern bool uc_is_property_hyphen (ucs4_t uc);
672 extern bool uc_is_property_punctuation (ucs4_t uc);
673 extern bool uc_is_property_line_separator (ucs4_t uc);
674 extern bool uc_is_property_paragraph_separator (ucs4_t uc);
675 extern bool uc_is_property_quotation_mark (ucs4_t uc);
676 extern bool uc_is_property_sentence_terminal (ucs4_t uc);
677 extern bool uc_is_property_terminal_punctuation (ucs4_t uc);
678 extern bool uc_is_property_currency_symbol (ucs4_t uc);
679 extern bool uc_is_property_math (ucs4_t uc);
680 extern bool uc_is_property_other_math (ucs4_t uc);
681 extern bool uc_is_property_paired_punctuation (ucs4_t uc);
682 extern bool uc_is_property_left_of_pair (ucs4_t uc);
683 extern bool uc_is_property_combining (ucs4_t uc);
684 extern bool uc_is_property_composite (ucs4_t uc);
685 extern bool uc_is_property_decimal_digit (ucs4_t uc);
686 extern bool uc_is_property_numeric (ucs4_t uc);
687 extern bool uc_is_property_diacritic (ucs4_t uc);
688 extern bool uc_is_property_extender (ucs4_t uc);
689 extern bool uc_is_property_ignorable_control (ucs4_t uc);
691 /* ========================================================================= */
693 /* Subdivision of the Unicode characters into scripts. */
697 unsigned int code : 21;
698 unsigned int start : 1;
699 unsigned int end : 1;
704 unsigned int nintervals;
705 const uc_interval_t *intervals;
710 /* Return the script of a Unicode character. */
711 extern const uc_script_t *
712 uc_script (ucs4_t uc);
714 /* Return the script given by name, e.g. "HAN". */
715 extern const uc_script_t *
716 uc_script_byname (const char *script_name);
718 /* Test whether a Unicode character belongs to a given script. */
720 uc_is_script (ucs4_t uc, const uc_script_t *script);
722 /* Get the list of all scripts. */
724 uc_all_scripts (const uc_script_t **scripts, size_t *count);
726 /* ========================================================================= */
728 /* Subdivision of the Unicode character range into blocks. */
738 /* Return the block a character belongs to. */
739 extern const uc_block_t *
740 uc_block (ucs4_t uc);
742 /* Test whether a Unicode character belongs to a given block. */
744 uc_is_block (ucs4_t uc, const uc_block_t *block);
746 /* Get the list of all blocks. */
748 uc_all_blocks (const uc_block_t **blocks, size_t *count);
750 /* ========================================================================= */
752 /* Properties taken from language standards. */
754 /* Test whether a Unicode character is considered whitespace in ISO C 99. */
756 uc_is_c_whitespace (ucs4_t uc);
758 /* Test whether a Unicode character is considered whitespace in Java. */
760 uc_is_java_whitespace (ucs4_t uc);
764 UC_IDENTIFIER_START, /* valid as first or subsequent character */
765 UC_IDENTIFIER_VALID, /* valid as subsequent character only */
766 UC_IDENTIFIER_INVALID, /* not valid */
767 UC_IDENTIFIER_IGNORABLE /* ignorable (Java only) */
770 /* Return the categorization of a Unicode character w.r.t. the ISO C 99
771 identifier syntax. */
773 uc_c_ident_category (ucs4_t uc);
775 /* Return the categorization of a Unicode character w.r.t. the Java
776 identifier syntax. */
778 uc_java_ident_category (ucs4_t uc);
780 /* ========================================================================= */
782 /* Like ISO C <ctype.h> and <wctype.h>. These functions are deprecated,
783 because this set of functions was designed with ASCII in mind and cannot
784 reflect the more diverse reality of the Unicode character set. But they
785 can be a quick-and-dirty porting aid when migrating from wchar_t APIs
786 to Unicode strings. */
788 /* Test for any character for which 'uc_is_alpha' or 'uc_is_digit' is true. */
790 uc_is_alnum (ucs4_t uc);
792 /* Test for any character for which 'uc_is_upper' or 'uc_is_lower' is true,
793 or any character that is one of a locale-specific set of characters for
794 which none of 'uc_is_cntrl', 'uc_is_digit', 'uc_is_punct', or 'uc_is_space'
797 uc_is_alpha (ucs4_t uc);
799 /* Test for any control character. */
801 uc_is_cntrl (ucs4_t uc);
803 /* Test for any character that corresponds to a decimal-digit character. */
805 uc_is_digit (ucs4_t uc);
807 /* Test for any character for which 'uc_is_print' is true and 'uc_is_space'
810 uc_is_graph (ucs4_t uc);
812 /* Test for any character that corresponds to a lowercase letter or is one
813 of a locale-specific set of characters for which none of 'uc_is_cntrl',
814 'uc_is_digit', 'uc_is_punct', or 'uc_is_space' is true. */
816 uc_is_lower (ucs4_t uc);
818 /* Test for any printing character. */
820 uc_is_print (ucs4_t uc);
822 /* Test for any printing character that is one of a locale-specific set of
823 characters for which neither 'uc_is_space' nor 'uc_is_alnum' is true. */
825 uc_is_punct (ucs4_t uc);
827 /* Test for any character that corresponds to a locale-specific set of
828 characters for which none of 'uc_is_alnum', 'uc_is_graph', or 'uc_is_punct'
831 uc_is_space (ucs4_t uc);
833 /* Test for any character that corresponds to an uppercase letter or is one
834 of a locale-specific set of character for which none of 'uc_is_cntrl',
835 'uc_is_digit', 'uc_is_punct', or 'uc_is_space' is true. */
837 uc_is_upper (ucs4_t uc);
839 /* Test for any character that corresponds to a hexadecimal-digit
842 uc_is_xdigit (ucs4_t uc);
845 /* Test for any character that corresponds to a standard blank character or
846 a locale-specific set of characters for which 'uc_is_alnum' is false. */
848 uc_is_blank (ucs4_t uc);
850 /* ========================================================================= */
856 #endif /* _UNICTYPE_H */