lib/unictype.in.h

   1 /* Unicode character classification and properties.
   2    Copyright (C) 2002, 2005-2011 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>.  */
  16
  17 #ifndef _UNICTYPE_H
  18 #define _UNICTYPE_H
  19
  20 #include "unitypes.h"
  21
  22 /* Get bool.  */
  23 #include <stdbool.h>
  24
  25 /* Get size_t.  */
  26 #include <stddef.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* ========================================================================= */
  33
  34 /* Field 1 of Unicode Character Database: Character name.
  35    See "uniname.h".  */
  36
  37 /* ========================================================================= */
  38
  39 /* Field 2 of Unicode Character Database: General category.  */
  40
  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.  */
  45 typedef struct
  46 {
  47   uint32_t bitmask : 31;
  48   /*bool*/ unsigned int generic : 1;
  49   union
  50   {
  51     const void *table;                               /* when generic is 0 */
  52     bool (*lookup_fn) (ucs4_t uc, uint32_t bitmask); /* when generic is 1 */
  53   } lookup;
  54 }
  55 uc_general_category_t;
  56
  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
  60    function.  */
  61 enum
  62 {
  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
 101 };
 102
 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;
 142 /* Non-public.  */
 143 extern const uc_general_category_t _UC_CATEGORY_NONE;
 144
 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 */
 184
 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);
 190
 191 /* Return the intersection of two general categories as bit masks.
 192    This *does*not* correspond to the intersection of the two sets of
 193    characters.  */
 194 extern uc_general_category_t
 195        uc_general_category_and (uc_general_category_t category1,
 196                                 uc_general_category_t category2);
 197
 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);
 205
 206 /* Return the name of a general category.  */
 207 extern const char *
 208        uc_general_category_name (uc_general_category_t category);
 209
 210 /* Return the general category given by name, e.g. "Lu".  */
 211 extern uc_general_category_t
 212        uc_general_category_byname (const char *category_name);
 213
 214 /* Return the general category of a Unicode character.  */
 215 extern uc_general_category_t
 216        uc_general_category (ucs4_t uc);
 217
 218 /* Test whether a Unicode character belongs to a given category.
 219    The CATEGORY argument can be the combination of several predefined
 220    general categories.  */
 221 extern bool
 222        uc_is_general_category (ucs4_t uc, uc_general_category_t category);
 223 /* Likewise.  This function uses a big table comprising all categories.  */
 224 extern bool
 225        uc_is_general_category_withtable (ucs4_t uc, uint32_t bitmask);
 226
 227 /* ========================================================================= */
 228
 229 /* Field 3 of Unicode Character Database: Canonical combining class.  */
 230
 231 /* The possible results of uc_combining_class (0..255) are described in
 232    UCD.html.  The list here is not definitive; more values can be added
 233    in future versions.  */
 234 enum
 235 {
 236   UC_CCC_NR   =   0, /* Not Reordered */
 237   UC_CCC_OV   =   1, /* Overlay */
 238   UC_CCC_NK   =   7, /* Nukta */
 239   UC_CCC_KV   =   8, /* Kana Voicing */
 240   UC_CCC_VR   =   9, /* Virama */
 241   UC_CCC_ATBL = 200, /* Attached Below Left */
 242   UC_CCC_ATB  = 202, /* Attached Below */
 243   UC_CCC_ATAR = 216, /* Attached Above Right */
 244   UC_CCC_BL   = 218, /* Below Left */
 245   UC_CCC_B    = 220, /* Below */
 246   UC_CCC_BR   = 222, /* Below Right */
 247   UC_CCC_L    = 224, /* Left */
 248   UC_CCC_R    = 226, /* Right */
 249   UC_CCC_AL   = 228, /* Above Left */
 250   UC_CCC_A    = 230, /* Above */
 251   UC_CCC_AR   = 232, /* Above Right */
 252   UC_CCC_DB   = 233, /* Double Below */
 253   UC_CCC_DA   = 234, /* Double Above */
 254   UC_CCC_IS   = 240  /* Iota Subscript */
 255 };
 256
 257 /* Return the canonical combining class of a Unicode character.  */
 258 extern int
 259        uc_combining_class (ucs4_t uc);
 260
 261 /* ========================================================================= */
 262
 263 /* Field 4 of Unicode Character Database: Bidi class.
 264    Before Unicode 4.0, this field was called "Bidirectional category".  */
 265
 266 enum
 267 {
 268   UC_BIDI_L,   /* Left-to-Right */
 269   UC_BIDI_LRE, /* Left-to-Right Embedding */
 270   UC_BIDI_LRO, /* Left-to-Right Override */
 271   UC_BIDI_R,   /* Right-to-Left */
 272   UC_BIDI_AL,  /* Right-to-Left Arabic */
 273   UC_BIDI_RLE, /* Right-to-Left Embedding */
 274   UC_BIDI_RLO, /* Right-to-Left Override */
 275   UC_BIDI_PDF, /* Pop Directional Format */
 276   UC_BIDI_EN,  /* European Number */
 277   UC_BIDI_ES,  /* European Number Separator */
 278   UC_BIDI_ET,  /* European Number Terminator */
 279   UC_BIDI_AN,  /* Arabic Number */
 280   UC_BIDI_CS,  /* Common Number Separator */
 281   UC_BIDI_NSM, /* Non-Spacing Mark */
 282   UC_BIDI_BN,  /* Boundary Neutral */
 283   UC_BIDI_B,   /* Paragraph Separator */
 284   UC_BIDI_S,   /* Segment Separator */
 285   UC_BIDI_WS,  /* Whitespace */
 286   UC_BIDI_ON   /* Other Neutral */
 287 };
 288
 289 /* Return the name of a bidi class.  */
 290 extern const char *
 291        uc_bidi_class_name (int bidi_class);
 292 /* Same; obsolete function name.  */
 293 extern const char *
 294        uc_bidi_category_name (int category);
 295
 296 /* Return the bidi class given by name, e.g. "LRE".  */
 297 extern int
 298        uc_bidi_class_byname (const char *bidi_class_name);
 299 /* Same; obsolete function name.  */
 300 extern int
 301        uc_bidi_category_byname (const char *category_name);
 302
 303 /* Return the bidi class of a Unicode character.  */
 304 extern int
 305        uc_bidi_class (ucs4_t uc);
 306 /* Same; obsolete function name.  */
 307 extern int
 308        uc_bidi_category (ucs4_t uc);
 309
 310 /* Test whether a Unicode character belongs to a given bidi class.  */
 311 extern bool
 312        uc_is_bidi_class (ucs4_t uc, int bidi_class);
 313 /* Same; obsolete function name.  */
 314 extern bool
 315        uc_is_bidi_category (ucs4_t uc, int category);
 316
 317 /* ========================================================================= */
 318
 319 /* Field 5 of Unicode Character Database: Character decomposition mapping.
 320    See "uninorm.h".  */
 321
 322 /* ========================================================================= */
 323
 324 /* Field 6 of Unicode Character Database: Decimal digit value.  */
 325
 326 /* Return the decimal digit value of a Unicode character.  */
 327 extern int
 328        uc_decimal_value (ucs4_t uc);
 329
 330 /* ========================================================================= */
 331
 332 /* Field 7 of Unicode Character Database: Digit value.  */
 333
 334 /* Return the digit value of a Unicode character.  */
 335 extern int
 336        uc_digit_value (ucs4_t uc);
 337
 338 /* ========================================================================= */
 339
 340 /* Field 8 of Unicode Character Database: Numeric value.  */
 341
 342 /* Return the numeric value of a Unicode character.  */
 343 typedef struct
 344 {
 345   int numerator;
 346   int denominator;
 347 }
 348 uc_fraction_t;
 349 extern uc_fraction_t
 350        uc_numeric_value (ucs4_t uc);
 351
 352 /* ========================================================================= */
 353
 354 /* Field 9 of Unicode Character Database: Mirrored.  */
 355
 356 /* Return the mirrored character of a Unicode character UC in *PUC.  */
 357 extern bool
 358        uc_mirror_char (ucs4_t uc, ucs4_t *puc);
 359
 360 /* ========================================================================= */
 361
 362 /* Field 10 of Unicode Character Database: Unicode 1.0 Name.
 363    Not available in this library.  */
 364
 365 /* ========================================================================= */
 366
 367 /* Field 11 of Unicode Character Database: ISO 10646 comment.
 368    Not available in this library.  */
 369
 370 /* ========================================================================= */
 371
 372 /* Field 12, 13, 14 of Unicode Character Database: Uppercase mapping,
 373    lowercase mapping, titlecase mapping.  See "unicase.h".  */
 374
 375 /* ========================================================================= */
 376
 377 /* Field 2 of the file ArabicShaping.txt in the Unicode Character Database.  */
 378
 379 /* Possible joining types.  */
 380 enum
 381 {
 382   UC_JOINING_TYPE_U, /* Non_Joining */
 383   UC_JOINING_TYPE_T, /* Transparent */
 384   UC_JOINING_TYPE_C, /* Join_Causing */
 385   UC_JOINING_TYPE_L, /* Left_Joining */
 386   UC_JOINING_TYPE_R, /* Right_Joining */
 387   UC_JOINING_TYPE_D  /* Dual_Joining */
 388 };
 389
 390 /* Return the name of a joining type.  */
 391 extern const char *
 392        uc_joining_type_name (int joining_type);
 393
 394 /* Return the joining type given by name, e.g. "D".  */
 395 extern int
 396        uc_joining_type_byname (const char *joining_type_name);
 397
 398 /* Return the joining type of a Unicode character.  */
 399 extern int
 400        uc_joining_type (ucs4_t uc);
 401
 402 /* ========================================================================= */
 403
 404 /* Field 3 of the file ArabicShaping.txt in the Unicode Character Database.  */
 405
 406 /* Possible joining groups.
 407    This enumeration may be extended in the future.  */
 408 enum
 409 {
 410   UC_JOINING_GROUP_NONE,                  /* No_Joining_Group */
 411   UC_JOINING_GROUP_AIN,                   /* Ain */
 412   UC_JOINING_GROUP_ALAPH,                 /* Alaph */
 413   UC_JOINING_GROUP_ALEF,                  /* Alef */
 414   UC_JOINING_GROUP_BEH,                   /* Beh */
 415   UC_JOINING_GROUP_BETH,                  /* Beth */
 416   UC_JOINING_GROUP_BURUSHASKI_YEH_BARREE, /* Burushaski_Yeh_Barree */
 417   UC_JOINING_GROUP_DAL,                   /* Dal */
 418   UC_JOINING_GROUP_DALATH_RISH,           /* Dalath_Rish */
 419   UC_JOINING_GROUP_E,                     /* E */
 420   UC_JOINING_GROUP_FARSI_YEH,             /* Farsi_Yeh */
 421   UC_JOINING_GROUP_FE,                    /* Fe */
 422   UC_JOINING_GROUP_FEH,                   /* Feh */
 423   UC_JOINING_GROUP_FINAL_SEMKATH,         /* Final_Semkath */
 424   UC_JOINING_GROUP_GAF,                   /* Gaf */
 425   UC_JOINING_GROUP_GAMAL,                 /* Gamal */
 426   UC_JOINING_GROUP_HAH,                   /* Hah */
 427   UC_JOINING_GROUP_HE,                    /* He */
 428   UC_JOINING_GROUP_HEH,                   /* Heh */
 429   UC_JOINING_GROUP_HEH_GOAL,              /* Heh_Goal */
 430   UC_JOINING_GROUP_HETH,                  /* Heth */
 431   UC_JOINING_GROUP_KAF,                   /* Kaf */
 432   UC_JOINING_GROUP_KAPH,                  /* Kaph */
 433   UC_JOINING_GROUP_KHAPH,                 /* Khaph */
 434   UC_JOINING_GROUP_KNOTTED_HEH,           /* Knotted_Heh */
 435   UC_JOINING_GROUP_LAM,                   /* Lam */
 436   UC_JOINING_GROUP_LAMADH,                /* Lamadh */
 437   UC_JOINING_GROUP_MEEM,                  /* Meem */
 438   UC_JOINING_GROUP_MIM,                   /* Mim */
 439   UC_JOINING_GROUP_NOON,                  /* Noon */
 440   UC_JOINING_GROUP_NUN,                   /* Nun */
 441   UC_JOINING_GROUP_NYA,                   /* Nya */
 442   UC_JOINING_GROUP_PE,                    /* Pe */
 443   UC_JOINING_GROUP_QAF,                   /* Qaf */
 444   UC_JOINING_GROUP_QAPH,                  /* Qaph */
 445   UC_JOINING_GROUP_REH,                   /* Reh */
 446   UC_JOINING_GROUP_REVERSED_PE,           /* Reversed_Pe */
 447   UC_JOINING_GROUP_SAD,                   /* Sad */
 448   UC_JOINING_GROUP_SADHE,                 /* Sadhe */
 449   UC_JOINING_GROUP_SEEN,                  /* Seen */
 450   UC_JOINING_GROUP_SEMKATH,               /* Semkath */
 451   UC_JOINING_GROUP_SHIN,                  /* Shin */
 452   UC_JOINING_GROUP_SWASH_KAF,             /* Swash_Kaf */
 453   UC_JOINING_GROUP_SYRIAC_WAW,            /* Syriac_Waw */
 454   UC_JOINING_GROUP_TAH,                   /* Tah */
 455   UC_JOINING_GROUP_TAW,                   /* Taw */
 456   UC_JOINING_GROUP_TEH_MARBUTA,           /* Teh_Marbuta */
 457   UC_JOINING_GROUP_TEH_MARBUTA_GOAL,      /* Teh_Marbuta_Goal */
 458   UC_JOINING_GROUP_TETH,                  /* Teth */
 459   UC_JOINING_GROUP_WAW,                   /* Waw */
 460   UC_JOINING_GROUP_YEH,                   /* Yeh */
 461   UC_JOINING_GROUP_YEH_BARREE,            /* Yeh_Barree */
 462   UC_JOINING_GROUP_YEH_WITH_TAIL,         /* Yeh_With_Tail */
 463   UC_JOINING_GROUP_YUDH,                  /* Yudh */
 464   UC_JOINING_GROUP_YUDH_HE,               /* Yudh_He */
 465   UC_JOINING_GROUP_ZAIN,                  /* Zain */
 466   UC_JOINING_GROUP_ZHAIN                  /* Zhain */
 467 };
 468
 469 /* Return the name of a joining group.  */
 470 extern const char *
 471        uc_joining_group_name (int joining_group);
 472
 473 /* Return the joining group given by name, e.g. "Teh_Marbuta".  */
 474 extern int
 475        uc_joining_group_byname (const char *joining_group_name);
 476
 477 /* Return the joining group of a Unicode character.  */
 478 extern int
 479        uc_joining_group (ucs4_t uc);
 480
 481 /* ========================================================================= */
 482
 483 /* Common API for properties.  */
 484
 485 /* Data type denoting a property.  This is not just a number, but rather a
 486    pointer to the test functions, so that programs that use only few of the
 487    properties don't have a link-time dependency towards all the tables.  */
 488 typedef struct
 489 {
 490   bool (*test_fn) (ucs4_t uc);
 491 }
 492 uc_property_t;
 493
 494 /* Predefined properties.  */
 495 /* General.  */
 496 extern const uc_property_t UC_PROPERTY_WHITE_SPACE;
 497 extern const uc_property_t UC_PROPERTY_ALPHABETIC;
 498 extern const uc_property_t UC_PROPERTY_OTHER_ALPHABETIC;
 499 extern const uc_property_t UC_PROPERTY_NOT_A_CHARACTER;
 500 extern const uc_property_t UC_PROPERTY_DEFAULT_IGNORABLE_CODE_POINT;
 501 extern const uc_property_t UC_PROPERTY_OTHER_DEFAULT_IGNORABLE_CODE_POINT;
 502 extern const uc_property_t UC_PROPERTY_DEPRECATED;
 503 extern const uc_property_t UC_PROPERTY_LOGICAL_ORDER_EXCEPTION;
 504 extern const uc_property_t UC_PROPERTY_VARIATION_SELECTOR;
 505 extern const uc_property_t UC_PROPERTY_PRIVATE_USE;
 506 extern const uc_property_t UC_PROPERTY_UNASSIGNED_CODE_VALUE;
 507 /* Case.  */
 508 extern const uc_property_t UC_PROPERTY_UPPERCASE;
 509 extern const uc_property_t UC_PROPERTY_OTHER_UPPERCASE;
 510 extern const uc_property_t UC_PROPERTY_LOWERCASE;
 511 extern const uc_property_t UC_PROPERTY_OTHER_LOWERCASE;
 512 extern const uc_property_t UC_PROPERTY_TITLECASE;
 513 extern const uc_property_t UC_PROPERTY_CASED;
 514 extern const uc_property_t UC_PROPERTY_CASE_IGNORABLE;
 515 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_LOWERCASED;
 516 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_UPPERCASED;
 517 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_TITLECASED;
 518 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_CASEFOLDED;
 519 extern const uc_property_t UC_PROPERTY_CHANGES_WHEN_CASEMAPPED;
 520 extern const uc_property_t UC_PROPERTY_SOFT_DOTTED;
 521 /* Identifiers.  */
 522 extern const uc_property_t UC_PROPERTY_ID_START;
 523 extern const uc_property_t UC_PROPERTY_OTHER_ID_START;
 524 extern const uc_property_t UC_PROPERTY_ID_CONTINUE;
 525 extern const uc_property_t UC_PROPERTY_OTHER_ID_CONTINUE;
 526 extern const uc_property_t UC_PROPERTY_XID_START;
 527 extern const uc_property_t UC_PROPERTY_XID_CONTINUE;
 528 extern const uc_property_t UC_PROPERTY_PATTERN_WHITE_SPACE;
 529 extern const uc_property_t UC_PROPERTY_PATTERN_SYNTAX;
 530 /* Shaping and rendering.  */
 531 extern const uc_property_t UC_PROPERTY_JOIN_CONTROL;
 532 extern const uc_property_t UC_PROPERTY_GRAPHEME_BASE;
 533 extern const uc_property_t UC_PROPERTY_GRAPHEME_EXTEND;
 534 extern const uc_property_t UC_PROPERTY_OTHER_GRAPHEME_EXTEND;
 535 extern const uc_property_t UC_PROPERTY_GRAPHEME_LINK;
 536 /* Bidi.  */
 537 extern const uc_property_t UC_PROPERTY_BIDI_CONTROL;
 538 extern const uc_property_t UC_PROPERTY_BIDI_LEFT_TO_RIGHT;
 539 extern const uc_property_t UC_PROPERTY_BIDI_HEBREW_RIGHT_TO_LEFT;
 540 extern const uc_property_t UC_PROPERTY_BIDI_ARABIC_RIGHT_TO_LEFT;
 541 extern const uc_property_t UC_PROPERTY_BIDI_EUROPEAN_DIGIT;
 542 extern const uc_property_t UC_PROPERTY_BIDI_EUR_NUM_SEPARATOR;
 543 extern const uc_property_t UC_PROPERTY_BIDI_EUR_NUM_TERMINATOR;
 544 extern const uc_property_t UC_PROPERTY_BIDI_ARABIC_DIGIT;
 545 extern const uc_property_t UC_PROPERTY_BIDI_COMMON_SEPARATOR;
 546 extern const uc_property_t UC_PROPERTY_BIDI_BLOCK_SEPARATOR;
 547 extern const uc_property_t UC_PROPERTY_BIDI_SEGMENT_SEPARATOR;
 548 extern const uc_property_t UC_PROPERTY_BIDI_WHITESPACE;
 549 extern const uc_property_t UC_PROPERTY_BIDI_NON_SPACING_MARK;
 550 extern const uc_property_t UC_PROPERTY_BIDI_BOUNDARY_NEUTRAL;
 551 extern const uc_property_t UC_PROPERTY_BIDI_PDF;
 552 extern const uc_property_t UC_PROPERTY_BIDI_EMBEDDING_OR_OVERRIDE;
 553 extern const uc_property_t UC_PROPERTY_BIDI_OTHER_NEUTRAL;
 554 /* Numeric.  */
 555 extern const uc_property_t UC_PROPERTY_HEX_DIGIT;
 556 extern const uc_property_t UC_PROPERTY_ASCII_HEX_DIGIT;
 557 /* CJK.  */
 558 extern const uc_property_t UC_PROPERTY_IDEOGRAPHIC;
 559 extern const uc_property_t UC_PROPERTY_UNIFIED_IDEOGRAPH;
 560 extern const uc_property_t UC_PROPERTY_RADICAL;
 561 extern const uc_property_t UC_PROPERTY_IDS_BINARY_OPERATOR;
 562 extern const uc_property_t UC_PROPERTY_IDS_TRINARY_OPERATOR;
 563 /* Misc.  */
 564 extern const uc_property_t UC_PROPERTY_ZERO_WIDTH;
 565 extern const uc_property_t UC_PROPERTY_SPACE;
 566 extern const uc_property_t UC_PROPERTY_NON_BREAK;
 567 extern const uc_property_t UC_PROPERTY_ISO_CONTROL;
 568 extern const uc_property_t UC_PROPERTY_FORMAT_CONTROL;
 569 extern const uc_property_t UC_PROPERTY_DASH;
 570 extern const uc_property_t UC_PROPERTY_HYPHEN;
 571 extern const uc_property_t UC_PROPERTY_PUNCTUATION;
 572 extern const uc_property_t UC_PROPERTY_LINE_SEPARATOR;
 573 extern const uc_property_t UC_PROPERTY_PARAGRAPH_SEPARATOR;
 574 extern const uc_property_t UC_PROPERTY_QUOTATION_MARK;
 575 extern const uc_property_t UC_PROPERTY_SENTENCE_TERMINAL;
 576 extern const uc_property_t UC_PROPERTY_TERMINAL_PUNCTUATION;
 577 extern const uc_property_t UC_PROPERTY_CURRENCY_SYMBOL;
 578 extern const uc_property_t UC_PROPERTY_MATH;
 579 extern const uc_property_t UC_PROPERTY_OTHER_MATH;
 580 extern const uc_property_t UC_PROPERTY_PAIRED_PUNCTUATION;
 581 extern const uc_property_t UC_PROPERTY_LEFT_OF_PAIR;
 582 extern const uc_property_t UC_PROPERTY_COMBINING;
 583 extern const uc_property_t UC_PROPERTY_COMPOSITE;
 584 extern const uc_property_t UC_PROPERTY_DECIMAL_DIGIT;
 585 extern const uc_property_t UC_PROPERTY_NUMERIC;
 586 extern const uc_property_t UC_PROPERTY_DIACRITIC;
 587 extern const uc_property_t UC_PROPERTY_EXTENDER;
 588 extern const uc_property_t UC_PROPERTY_IGNORABLE_CONTROL;
 589
 590 /* Return the property given by name, e.g. "White space".  */
 591 extern uc_property_t
 592        uc_property_byname (const char *property_name);
 593
 594 /* Test whether a property is valid.  */
 595 #define uc_property_is_valid(property) ((property).test_fn != NULL)
 596
 597 /* Test whether a Unicode character has a given property.  */
 598 extern bool
 599        uc_is_property (ucs4_t uc, uc_property_t property);
 600 extern bool uc_is_property_white_space (ucs4_t uc);
 601 extern bool uc_is_property_alphabetic (ucs4_t uc);
 602 extern bool uc_is_property_other_alphabetic (ucs4_t uc);
 603 extern bool uc_is_property_not_a_character (ucs4_t uc);
 604 extern bool uc_is_property_default_ignorable_code_point (ucs4_t uc);
 605 extern bool uc_is_property_other_default_ignorable_code_point (ucs4_t uc);
 606 extern bool uc_is_property_deprecated (ucs4_t uc);
 607 extern bool uc_is_property_logical_order_exception (ucs4_t uc);
 608 extern bool uc_is_property_variation_selector (ucs4_t uc);
 609 extern bool uc_is_property_private_use (ucs4_t uc);
 610 extern bool uc_is_property_unassigned_code_value (ucs4_t uc);
 611 extern bool uc_is_property_uppercase (ucs4_t uc);
 612 extern bool uc_is_property_other_uppercase (ucs4_t uc);
 613 extern bool uc_is_property_lowercase (ucs4_t uc);
 614 extern bool uc_is_property_other_lowercase (ucs4_t uc);
 615 extern bool uc_is_property_titlecase (ucs4_t uc);
 616 extern bool uc_is_property_cased (ucs4_t uc);
 617 extern bool uc_is_property_case_ignorable (ucs4_t uc);
 618 extern bool uc_is_property_changes_when_lowercased (ucs4_t uc);
 619 extern bool uc_is_property_changes_when_uppercased (ucs4_t uc);
 620 extern bool uc_is_property_changes_when_titlecased (ucs4_t uc);
 621 extern bool uc_is_property_changes_when_casefolded (ucs4_t uc);
 622 extern bool uc_is_property_changes_when_casemapped (ucs4_t uc);
 623 extern bool uc_is_property_soft_dotted (ucs4_t uc);
 624 extern bool uc_is_property_id_start (ucs4_t uc);
 625 extern bool uc_is_property_other_id_start (ucs4_t uc);
 626 extern bool uc_is_property_id_continue (ucs4_t uc);
 627 extern bool uc_is_property_other_id_continue (ucs4_t uc);
 628 extern bool uc_is_property_xid_start (ucs4_t uc);
 629 extern bool uc_is_property_xid_continue (ucs4_t uc);
 630 extern bool uc_is_property_pattern_white_space (ucs4_t uc);
 631 extern bool uc_is_property_pattern_syntax (ucs4_t uc);
 632 extern bool uc_is_property_join_control (ucs4_t uc);
 633 extern bool uc_is_property_grapheme_base (ucs4_t uc);
 634 extern bool uc_is_property_grapheme_extend (ucs4_t uc);
 635 extern bool uc_is_property_other_grapheme_extend (ucs4_t uc);
 636 extern bool uc_is_property_grapheme_link (ucs4_t uc);
 637 extern bool uc_is_property_bidi_control (ucs4_t uc);
 638 extern bool uc_is_property_bidi_left_to_right (ucs4_t uc);
 639 extern bool uc_is_property_bidi_hebrew_right_to_left (ucs4_t uc);
 640 extern bool uc_is_property_bidi_arabic_right_to_left (ucs4_t uc);
 641 extern bool uc_is_property_bidi_european_digit (ucs4_t uc);
 642 extern bool uc_is_property_bidi_eur_num_separator (ucs4_t uc);
 643 extern bool uc_is_property_bidi_eur_num_terminator (ucs4_t uc);
 644 extern bool uc_is_property_bidi_arabic_digit (ucs4_t uc);
 645 extern bool uc_is_property_bidi_common_separator (ucs4_t uc);
 646 extern bool uc_is_property_bidi_block_separator (ucs4_t uc);
 647 extern bool uc_is_property_bidi_segment_separator (ucs4_t uc);
 648 extern bool uc_is_property_bidi_whitespace (ucs4_t uc);
 649 extern bool uc_is_property_bidi_non_spacing_mark (ucs4_t uc);
 650 extern bool uc_is_property_bidi_boundary_neutral (ucs4_t uc);
 651 extern bool uc_is_property_bidi_pdf (ucs4_t uc);
 652 extern bool uc_is_property_bidi_embedding_or_override (ucs4_t uc);
 653 extern bool uc_is_property_bidi_other_neutral (ucs4_t uc);
 654 extern bool uc_is_property_hex_digit (ucs4_t uc);
 655 extern bool uc_is_property_ascii_hex_digit (ucs4_t uc);
 656 extern bool uc_is_property_ideographic (ucs4_t uc);
 657 extern bool uc_is_property_unified_ideograph (ucs4_t uc);
 658 extern bool uc_is_property_radical (ucs4_t uc);
 659 extern bool uc_is_property_ids_binary_operator (ucs4_t uc);
 660 extern bool uc_is_property_ids_trinary_operator (ucs4_t uc);
 661 extern bool uc_is_property_zero_width (ucs4_t uc);
 662 extern bool uc_is_property_space (ucs4_t uc);
 663 extern bool uc_is_property_non_break (ucs4_t uc);
 664 extern bool uc_is_property_iso_control (ucs4_t uc);
 665 extern bool uc_is_property_format_control (ucs4_t uc);
 666 extern bool uc_is_property_dash (ucs4_t uc);
 667 extern bool uc_is_property_hyphen (ucs4_t uc);
 668 extern bool uc_is_property_punctuation (ucs4_t uc);
 669 extern bool uc_is_property_line_separator (ucs4_t uc);
 670 extern bool uc_is_property_paragraph_separator (ucs4_t uc);
 671 extern bool uc_is_property_quotation_mark (ucs4_t uc);
 672 extern bool uc_is_property_sentence_terminal (ucs4_t uc);
 673 extern bool uc_is_property_terminal_punctuation (ucs4_t uc);
 674 extern bool uc_is_property_currency_symbol (ucs4_t uc);
 675 extern bool uc_is_property_math (ucs4_t uc);
 676 extern bool uc_is_property_other_math (ucs4_t uc);
 677 extern bool uc_is_property_paired_punctuation (ucs4_t uc);
 678 extern bool uc_is_property_left_of_pair (ucs4_t uc);
 679 extern bool uc_is_property_combining (ucs4_t uc);
 680 extern bool uc_is_property_composite (ucs4_t uc);
 681 extern bool uc_is_property_decimal_digit (ucs4_t uc);
 682 extern bool uc_is_property_numeric (ucs4_t uc);
 683 extern bool uc_is_property_diacritic (ucs4_t uc);
 684 extern bool uc_is_property_extender (ucs4_t uc);
 685 extern bool uc_is_property_ignorable_control (ucs4_t uc);
 686
 687 /* ========================================================================= */
 688
 689 /* Subdivision of the Unicode characters into scripts.  */
 690
 691 typedef struct
 692 {
 693   unsigned int code : 21;
 694   unsigned int start : 1;
 695   unsigned int end : 1;
 696 }
 697 uc_interval_t;
 698 typedef struct
 699 {
 700   unsigned int nintervals;
 701   const uc_interval_t *intervals;
 702   const char *name;
 703 }
 704 uc_script_t;
 705
 706 /* Return the script of a Unicode character.  */
 707 extern const uc_script_t *
 708        uc_script (ucs4_t uc);
 709
 710 /* Return the script given by name, e.g. "HAN".  */
 711 extern const uc_script_t *
 712        uc_script_byname (const char *script_name);
 713
 714 /* Test whether a Unicode character belongs to a given script.  */
 715 extern bool
 716        uc_is_script (ucs4_t uc, const uc_script_t *script);
 717
 718 /* Get the list of all scripts.  */
 719 extern void
 720        uc_all_scripts (const uc_script_t **scripts, size_t *count);
 721
 722 /* ========================================================================= */
 723
 724 /* Subdivision of the Unicode character range into blocks.  */
 725
 726 typedef struct
 727 {
 728   ucs4_t start;
 729   ucs4_t end;
 730   const char *name;
 731 }
 732 uc_block_t;
 733
 734 /* Return the block a character belongs to.  */
 735 extern const uc_block_t *
 736        uc_block (ucs4_t uc);
 737
 738 /* Test whether a Unicode character belongs to a given block.  */
 739 extern bool
 740        uc_is_block (ucs4_t uc, const uc_block_t *block);
 741
 742 /* Get the list of all blocks.  */
 743 extern void
 744        uc_all_blocks (const uc_block_t **blocks, size_t *count);
 745
 746 /* ========================================================================= */
 747
 748 /* Properties taken from language standards.  */
 749
 750 /* Test whether a Unicode character is considered whitespace in ISO C 99.  */
 751 extern bool
 752        uc_is_c_whitespace (ucs4_t uc);
 753
 754 /* Test whether a Unicode character is considered whitespace in Java.  */
 755 extern bool
 756        uc_is_java_whitespace (ucs4_t uc);
 757
 758 enum
 759 {
 760   UC_IDENTIFIER_START,    /* valid as first or subsequent character */
 761   UC_IDENTIFIER_VALID,    /* valid as subsequent character only */
 762   UC_IDENTIFIER_INVALID,  /* not valid */
 763   UC_IDENTIFIER_IGNORABLE /* ignorable (Java only) */
 764 };
 765
 766 /* Return the categorization of a Unicode character w.r.t. the ISO C 99
 767    identifier syntax.  */
 768 extern int
 769        uc_c_ident_category (ucs4_t uc);
 770
 771 /* Return the categorization of a Unicode character w.r.t. the Java
 772    identifier syntax.  */
 773 extern int
 774        uc_java_ident_category (ucs4_t uc);
 775
 776 /* ========================================================================= */
 777
 778 /* Like ISO C <ctype.h> and <wctype.h>.  These functions are deprecated,
 779    because this set of functions was designed with ASCII in mind and cannot
 780    reflect the more diverse reality of the Unicode character set.  But they
 781    can be a quick-and-dirty porting aid when migrating from wchar_t APIs
 782    to Unicode strings.  */
 783
 784 /* Test for any character for which 'uc_is_alpha' or 'uc_is_digit' is true.  */
 785 extern bool
 786        uc_is_alnum (ucs4_t uc);
 787
 788 /* Test for any character for which 'uc_is_upper' or 'uc_is_lower' is true,
 789    or any character that is one of a locale-specific set of characters for
 790    which none of 'uc_is_cntrl', 'uc_is_digit', 'uc_is_punct', or 'uc_is_space'
 791    is true.  */
 792 extern bool
 793        uc_is_alpha (ucs4_t uc);
 794
 795 /* Test for any control character.  */
 796 extern bool
 797        uc_is_cntrl (ucs4_t uc);
 798
 799 /* Test for any character that corresponds to a decimal-digit character.  */
 800 extern bool
 801        uc_is_digit (ucs4_t uc);
 802
 803 /* Test for any character for which 'uc_is_print' is true and 'uc_is_space'
 804    is false.  */
 805 extern bool
 806        uc_is_graph (ucs4_t uc);
 807
 808 /* Test for any character that corresponds to a lowercase letter or is one
 809    of a locale-specific set of characters for which none of 'uc_is_cntrl',
 810    'uc_is_digit', 'uc_is_punct', or 'uc_is_space' is true.  */
 811 extern bool
 812        uc_is_lower (ucs4_t uc);
 813
 814 /* Test for any printing character.  */
 815 extern bool
 816        uc_is_print (ucs4_t uc);
 817
 818 /* Test for any printing character that is one of a locale-specific set of
 819    characters for which neither 'uc_is_space' nor 'uc_is_alnum' is true.  */
 820 extern bool
 821        uc_is_punct (ucs4_t uc);
 822
 823 /* Test for any character that corresponds to a locale-specific set of
 824    characters for which none of 'uc_is_alnum', 'uc_is_graph', or 'uc_is_punct'
 825    is true.  */
 826 extern bool
 827        uc_is_space (ucs4_t uc);
 828
 829 /* Test for any character that corresponds to an uppercase letter or is one
 830    of a locale-specific set of character for which none of 'uc_is_cntrl',
 831    'uc_is_digit', 'uc_is_punct', or 'uc_is_space' is true.  */
 832 extern bool
 833        uc_is_upper (ucs4_t uc);
 834
 835 /* Test for any character that corresponds to a hexadecimal-digit
 836    character.  */
 837 extern bool
 838        uc_is_xdigit (ucs4_t uc);
 839
 840 /* GNU extension. */
 841 /* Test for any character that corresponds to a standard blank character or
 842    a locale-specific set of characters for which 'uc_is_alnum' is false.  */
 843 extern bool
 844        uc_is_blank (ucs4_t uc);
 845
 846 /* ========================================================================= */
 847
 848 #ifdef __cplusplus
 849 }
 850 #endif
 851
 852 #endif /* _UNICTYPE_H */