git.sur5r.net Git - openldap/blob - libraries/liblunicode/ucdata/ucdata.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 2000 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /*
   7  * Copyright 1999 Computing Research Labs, New Mexico State University
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * THE COMPUTING RESEARCH LAB OR NEW MEXICO STATE UNIVERSITY BE LIABLE FOR ANY
  23  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
  24  * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
  25  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  */
  27 #ifndef _h_ucdata
  28 #define _h_ucdata
  29
  30 /*
  31  * $Id: ucdata.h,v 1.5 1999/11/19 15:24:29 mleisher Exp $
  32  */
  33
  34 LDAP_BEGIN_DECL
  35
  36 #undef __
  37 #define __(x) x
  38
  39 #define UCDATA_VERSION "2.3"
  40
  41 /**************************************************************************
  42  *
  43  * Masks and macros for character properties.
  44  *
  45  **************************************************************************/
  46
  47 /*
  48  * Values that can appear in the `mask1' parameter of the ucisprop()
  49  * function.
  50  */
  51 #define UC_MN 0x00000001 /* Mark, Non-Spacing          */
  52 #define UC_MC 0x00000002 /* Mark, Spacing Combining    */
  53 #define UC_ME 0x00000004 /* Mark, Enclosing            */
  54 #define UC_ND 0x00000008 /* Number, Decimal Digit      */
  55 #define UC_NL 0x00000010 /* Number, Letter             */
  56 #define UC_NO 0x00000020 /* Number, Other              */
  57 #define UC_ZS 0x00000040 /* Separator, Space           */
  58 #define UC_ZL 0x00000080 /* Separator, Line            */
  59 #define UC_ZP 0x00000100 /* Separator, Paragraph       */
  60 #define UC_CC 0x00000200 /* Other, Control             */
  61 #define UC_CF 0x00000400 /* Other, Format              */
  62 #define UC_OS 0x00000800 /* Other, Surrogate           */
  63 #define UC_CO 0x00001000 /* Other, Private Use         */
  64 #define UC_CN 0x00002000 /* Other, Not Assigned        */
  65 #define UC_LU 0x00004000 /* Letter, Uppercase          */
  66 #define UC_LL 0x00008000 /* Letter, Lowercase          */
  67 #define UC_LT 0x00010000 /* Letter, Titlecase          */
  68 #define UC_LM 0x00020000 /* Letter, Modifier           */
  69 #define UC_LO 0x00040000 /* Letter, Other              */
  70 #define UC_PC 0x00080000 /* Punctuation, Connector     */
  71 #define UC_PD 0x00100000 /* Punctuation, Dash          */
  72 #define UC_PS 0x00200000 /* Punctuation, Open          */
  73 #define UC_PE 0x00400000 /* Punctuation, Close         */
  74 #define UC_PO 0x00800000 /* Punctuation, Other         */
  75 #define UC_SM 0x01000000 /* Symbol, Math               */
  76 #define UC_SC 0x02000000 /* Symbol, Currency           */
  77 #define UC_SK 0x04000000 /* Symbol, Modifier           */
  78 #define UC_SO 0x08000000 /* Symbol, Other              */
  79 #define UC_L  0x10000000 /* Left-To-Right              */
  80 #define UC_R  0x20000000 /* Right-To-Left              */
  81 #define UC_EN 0x40000000 /* European Number            */
  82 #define UC_ES 0x80000000 /* European Number Separator  */
  83
  84 /*
  85  * Values that can appear in the `mask2' parameter of the ucisprop()
  86  * function.
  87  */
  88 #define UC_ET 0x00000001 /* European Number Terminator */
  89 #define UC_AN 0x00000002 /* Arabic Number              */
  90 #define UC_CS 0x00000004 /* Common Number Separator    */
  91 #define UC_B  0x00000008 /* Block Separator            */
  92 #define UC_S  0x00000010 /* Segment Separator          */
  93 #define UC_WS 0x00000020 /* Whitespace                 */
  94 #define UC_ON 0x00000040 /* Other Neutrals             */
  95 /*
  96  * Implementation specific character properties.
  97  */
  98 #define UC_CM 0x00000080 /* Composite                  */
  99 #define UC_NB 0x00000100 /* Non-Breaking               */
 100 #define UC_SY 0x00000200 /* Symmetric                  */
 101 #define UC_HD 0x00000400 /* Hex Digit                  */
 102 #define UC_QM 0x00000800 /* Quote Mark                 */
 103 #define UC_MR 0x00001000 /* Mirroring                  */
 104 #define UC_SS 0x00002000 /* Space, other               */
 105
 106 #define UC_CP 0x00004000 /* Defined                    */
 107
 108 /*
 109  * Added for UnicodeData-2.1.3.
 110  */
 111 #define UC_PI 0x00008000 /* Punctuation, Initial       */
 112 #define UC_PF 0x00010000 /* Punctuation, Final         */
 113
 114 /*
 115  * This is the primary function for testing to see if a character has some set
 116  * of properties.  The macros that test for various character properties all
 117  * call this function with some set of masks.
 118  */
 119 extern int ucisprop __((unsigned long code, unsigned long mask1,
 120                         unsigned long mask2));
 121
 122 #define ucisalpha(cc) ucisprop(cc, UC_LU|UC_LL|UC_LM|UC_LO|UC_LT, 0)
 123 #define ucisdigit(cc) ucisprop(cc, UC_ND, 0)
 124 #define ucisalnum(cc) ucisprop(cc, UC_LU|UC_LL|UC_LM|UC_LO|UC_LT|UC_ND, 0)
 125 #define uciscntrl(cc) ucisprop(cc, UC_CC|UC_CF, 0)
 126 #define ucisspace(cc) ucisprop(cc, UC_ZS|UC_SS, 0)
 127 #define ucisblank(cc) ucisprop(cc, UC_ZS, 0)
 128 #define ucispunct(cc) ucisprop(cc, UC_PD|UC_PS|UC_PE|UC_PO, UC_PI|UC_PF)
 129 #define ucisgraph(cc) ucisprop(cc, UC_MN|UC_MC|UC_ME|UC_ND|UC_NL|UC_NO|\
 130                                UC_LU|UC_LL|UC_LT|UC_LM|UC_LO|UC_PC|UC_PD|\
 131                                UC_PS|UC_PE|UC_PO|UC_SM|UC_SM|UC_SC|UC_SK|\
 132                                UC_SO, UC_PI|UC_PF)
 133 #define ucisprint(cc) ucisprop(cc, UC_MN|UC_MC|UC_ME|UC_ND|UC_NL|UC_NO|\
 134                                UC_LU|UC_LL|UC_LT|UC_LM|UC_LO|UC_PC|UC_PD|\
 135                                UC_PS|UC_PE|UC_PO|UC_SM|UC_SM|UC_SC|UC_SK|\
 136                                UC_SO|UC_ZS, UC_PI|UC_PF)
 137 #define ucisupper(cc) ucisprop(cc, UC_LU, 0)
 138 #define ucislower(cc) ucisprop(cc, UC_LL, 0)
 139 #define ucistitle(cc) ucisprop(cc, UC_LT, 0)
 140 #define ucisxdigit(cc) ucisprop(cc, 0, UC_HD)
 141
 142 #define ucisisocntrl(cc) ucisprop(cc, UC_CC, 0)
 143 #define ucisfmtcntrl(cc) ucisprop(cc, UC_CF, 0)
 144
 145 #define ucissymbol(cc) ucisprop(cc, UC_SM|UC_SC|UC_SO|UC_SK, 0)
 146 #define ucisnumber(cc) ucisprop(cc, UC_ND|UC_NO|UC_NL, 0)
 147 #define ucisnonspacing(cc) ucisprop(cc, UC_MN, 0)
 148 #define ucisopenpunct(cc) ucisprop(cc, UC_PS, 0)
 149 #define ucisclosepunct(cc) ucisprop(cc, UC_PE, 0)
 150 #define ucisinitialpunct(cc) ucisprop(cc, 0, UC_PI)
 151 #define ucisfinalpunct(cc) ucisprop(cc, 0, UC_PF)
 152
 153 #define uciscomposite(cc) ucisprop(cc, 0, UC_CM)
 154 #define ucishex(cc) ucisprop(cc, 0, UC_HD)
 155 #define ucisquote(cc) ucisprop(cc, 0, UC_QM)
 156 #define ucissymmetric(cc) ucisprop(cc, 0, UC_SY)
 157 #define ucismirroring(cc) ucisprop(cc, 0, UC_MR)
 158 #define ucisnonbreaking(cc) ucisprop(cc, 0, UC_NB)
 159
 160 /*
 161  * Directionality macros.
 162  */
 163 #define ucisrtl(cc) ucisprop(cc, UC_R, 0)
 164 #define ucisltr(cc) ucisprop(cc, UC_L, 0)
 165 #define ucisstrong(cc) ucisprop(cc, UC_L|UC_R, 0)
 166 #define ucisweak(cc) ucisprop(cc, UC_EN|UC_ES, UC_ET|UC_AN|UC_CS)
 167 #define ucisneutral(cc) ucisprop(cc, 0, UC_B|UC_S|UC_WS|UC_ON)
 168 #define ucisseparator(cc) ucisprop(cc, 0, UC_B|UC_S)
 169
 170 /*
 171  * Other macros inspired by John Cowan.
 172  */
 173 #define ucismark(cc) ucisprop(cc, UC_MN|UC_MC|UC_ME, 0)
 174 #define ucismodif(cc) ucisprop(cc, UC_LM, 0)
 175 #define ucisletnum(cc) ucisprop(cc, UC_NL, 0)
 176 #define ucisconnect(cc) ucisprop(cc, UC_PC, 0)
 177 #define ucisdash(cc) ucisprop(cc, UC_PD, 0)
 178 #define ucismath(cc) ucisprop(cc, UC_SM, 0)
 179 #define uciscurrency(cc) ucisprop(cc, UC_SC, 0)
 180 #define ucismodifsymbol(cc) ucisprop(cc, UC_SK, 0)
 181 #define ucisnsmark(cc) ucisprop(cc, UC_MN, 0)
 182 #define ucisspmark(cc) ucisprop(cc, UC_MC, 0)
 183 #define ucisenclosing(cc) ucisprop(cc, UC_ME, 0)
 184 #define ucisprivate(cc) ucisprop(cc, UC_CO, 0)
 185 #define ucissurrogate(cc) ucisprop(cc, UC_OS, 0)
 186 #define ucislsep(cc) ucisprop(cc, UC_ZL, 0)
 187 #define ucispsep(cc) ucisprop(cc, UC_ZP, 0)
 188
 189 #define ucisidentstart(cc) ucisprop(cc, UC_LU|UC_LL|UC_LT|UC_LO|UC_NL, 0)
 190 #define ucisidentpart(cc) ucisprop(cc, UC_LU|UC_LL|UC_LT|UC_LO|UC_NL|\
 191                                    UC_MN|UC_MC|UC_ND|UC_PC|UC_CF, 0)
 192
 193 #define ucisdefined(cc) ucisprop(cc, 0, UC_CP)
 194 #define ucisundefined(cc) !ucisprop(cc, 0, UC_CP)
 195
 196 /*
 197  * Other miscellaneous character property macros.
 198  */
 199 #define ucishan(cc) (((cc) >= 0x4e00 && (cc) <= 0x9fff) ||\
 200                      ((cc) >= 0xf900 && (cc) <= 0xfaff))
 201 #define ucishangul(cc) ((cc) >= 0xac00 && (cc) <= 0xd7ff)
 202
 203 /**************************************************************************
 204  *
 205  * Functions for case conversion.
 206  *
 207  **************************************************************************/
 208
 209 extern unsigned long uctoupper __((unsigned long code));
 210 extern unsigned long uctolower __((unsigned long code));
 211 extern unsigned long uctotitle __((unsigned long code));
 212
 213 /**************************************************************************
 214  *
 215  * Functions for getting decompositions.
 216  *
 217  **************************************************************************/
 218
 219 /*
 220  * This routine determines if the code has a decomposition.  If it returns 0,
 221  * there is no decomposition.  Any other value indicates a decomposition was
 222  * returned.
 223  */
 224 extern int ucdecomp __((unsigned long code, unsigned long *num,
 225
 226                         unsigned long **decomp));
 227
 228 /*
 229  * If the code is a Hangul syllable, this routine decomposes it into the array
 230  * passed.  The array size should be at least 3.
 231  */
 232 extern int ucdecomp_hangul __((unsigned long code, unsigned long *num,
 233                                unsigned long decomp[]));
 234
 235 /**************************************************************************
 236  *
 237  * Functions for getting combining classes.
 238  *
 239  **************************************************************************/
 240
 241 /*
 242  * This will return the combining class for a character to be used with the
 243  * Canonical Ordering algorithm.
 244  */
 245 extern unsigned long uccombining_class __((unsigned long code));
 246
 247 /**************************************************************************
 248  *
 249  * Functions for getting numbers and digits.
 250  *
 251  **************************************************************************/
 252
 253 struct ucnumber {
 254     int numerator;
 255     int denominator;
 256 };
 257
 258 extern int ucnumber_lookup __((unsigned long code, struct ucnumber *num));
 259 extern int ucdigit_lookup __((unsigned long code, int *digit));
 260
 261 /*
 262  * For compatibility with John Cowan's "uctype" package.
 263  */
 264 extern struct ucnumber ucgetnumber __((unsigned long code));
 265 extern int ucgetdigit __((unsigned long code));
 266
 267 /**************************************************************************
 268  *
 269  * Functions library initialization and cleanup.
 270  *
 271  **************************************************************************/
 272
 273 /*
 274  * Macros for specifying the data tables to be loaded, unloaded, or reloaded
 275  * by the ucdata_load(), ucdata_unload(), and ucdata_reload() routines.
 276  */
 277 #define UCDATA_CASE   0x01
 278 #define UCDATA_CTYPE  0x02
 279 #define UCDATA_DECOMP 0x04
 280 #define UCDATA_CMBCL  0x08
 281 #define UCDATA_NUM    0x10
 282
 283 #define UCDATA_ALL (UCDATA_CASE|UCDATA_CTYPE|UCDATA_DECOMP|\
 284                     UCDATA_CMBCL|UCDATA_NUM)
 285
 286 /*
 287  * Functions to load, unload, and reload specific data files.
 288  */
 289 extern void ucdata_load __((char *paths, int mask));
 290 extern void ucdata_unload __((int mask));
 291 extern void ucdata_reload __((char *paths, int mask));
 292
 293 #ifdef UCDATA_DEPRECATED
 294 /*
 295  * Deprecated functions, now just compatibility macros.
 296  */
 297 #define ucdata_setup(p) ucdata_load(p, UCDATA_ALL)
 298 #define ucdata_cleanup() ucdata_unload(UCDATA_ALL)
 299 #endif
 300
 301 #undef __
 302
 303 LDAP_END_DECL
 304
 305 #endif /* _h_ucdata */