src/hb-ucdn/ucdn.h

   1 /*
   2  * Copyright (C) 2012 Grigori Goronzy <greg@kinoho.net>
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef UCDN_H
  18 #define UCDN_H
  19
  20 #if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__)
  21 # define HB_BEGIN_VISIBILITY _Pragma ("GCC visibility push(hidden)")
  22 # define HB_END_VISIBILITY _Pragma ("GCC visibility pop")
  23 #else
  24 # define HB_BEGIN_VISIBILITY
  25 # define HB_END_VISIBILITY
  26 #endif
  27 #ifdef __cplusplus
  28 # define HB_BEGIN_HEADER  extern "C" { HB_BEGIN_VISIBILITY
  29 # define HB_END_HEADER  HB_END_VISIBILITY }
  30 #else
  31 # define HB_BEGIN_HEADER  HB_BEGIN_VISIBILITY
  32 # define HB_END_HEADER  HB_END_VISIBILITY
  33 #endif
  34
  35 HB_BEGIN_HEADER
  36
  37 #if !defined (HB_DONT_DEFINE_STDINT)
  38
  39 #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \
  40     defined (_sgi) || defined (__sun) || defined (sun) || \
  41     defined (__digital__) || defined (__HP_cc)
  42 #  include <inttypes.h>
  43 #elif defined (_AIX)
  44 #  include <sys/inttypes.h>
  45 /* VS 2010 (_MSC_VER 1600) has stdint.h */
  46 #elif defined (_MSC_VER) && _MSC_VER < 1600
  47 typedef __int8 int8_t;
  48 typedef unsigned __int8 uint8_t;
  49 typedef __int16 int16_t;
  50 typedef unsigned __int16 uint16_t;
  51 typedef __int32 int32_t;
  52 typedef unsigned __int32 uint32_t;
  53 typedef __int64 int64_t;
  54 typedef unsigned __int64 uint64_t;
  55 #else
  56 #  include <stdint.h>
  57 #endif
  58
  59 #endif
  60
  61 #define UCDN_EAST_ASIAN_F 0
  62 #define UCDN_EAST_ASIAN_H 1
  63 #define UCDN_EAST_ASIAN_W 2
  64 #define UCDN_EAST_ASIAN_NA 3
  65 #define UCDN_EAST_ASIAN_A 4
  66 #define UCDN_EAST_ASIAN_N 5
  67
  68 #define UCDN_SCRIPT_COMMON 0
  69 #define UCDN_SCRIPT_LATIN 1
  70 #define UCDN_SCRIPT_GREEK 2
  71 #define UCDN_SCRIPT_CYRILLIC 3
  72 #define UCDN_SCRIPT_ARMENIAN 4
  73 #define UCDN_SCRIPT_HEBREW 5
  74 #define UCDN_SCRIPT_ARABIC 6
  75 #define UCDN_SCRIPT_SYRIAC 7
  76 #define UCDN_SCRIPT_THAANA 8
  77 #define UCDN_SCRIPT_DEVANAGARI 9
  78 #define UCDN_SCRIPT_BENGALI 10
  79 #define UCDN_SCRIPT_GURMUKHI 11
  80 #define UCDN_SCRIPT_GUJARATI 12
  81 #define UCDN_SCRIPT_ORIYA 13
  82 #define UCDN_SCRIPT_TAMIL 14
  83 #define UCDN_SCRIPT_TELUGU 15
  84 #define UCDN_SCRIPT_KANNADA 16
  85 #define UCDN_SCRIPT_MALAYALAM 17
  86 #define UCDN_SCRIPT_SINHALA 18
  87 #define UCDN_SCRIPT_THAI 19
  88 #define UCDN_SCRIPT_LAO 20
  89 #define UCDN_SCRIPT_TIBETAN 21
  90 #define UCDN_SCRIPT_MYANMAR 22
  91 #define UCDN_SCRIPT_GEORGIAN 23
  92 #define UCDN_SCRIPT_HANGUL 24
  93 #define UCDN_SCRIPT_ETHIOPIC 25
  94 #define UCDN_SCRIPT_CHEROKEE 26
  95 #define UCDN_SCRIPT_CANADIAN_ABORIGINAL 27
  96 #define UCDN_SCRIPT_OGHAM 28
  97 #define UCDN_SCRIPT_RUNIC 29
  98 #define UCDN_SCRIPT_KHMER 30
  99 #define UCDN_SCRIPT_MONGOLIAN 31
 100 #define UCDN_SCRIPT_HIRAGANA 32
 101 #define UCDN_SCRIPT_KATAKANA 33
 102 #define UCDN_SCRIPT_BOPOMOFO 34
 103 #define UCDN_SCRIPT_HAN 35
 104 #define UCDN_SCRIPT_YI 36
 105 #define UCDN_SCRIPT_OLD_ITALIC 37
 106 #define UCDN_SCRIPT_GOTHIC 38
 107 #define UCDN_SCRIPT_DESERET 39
 108 #define UCDN_SCRIPT_INHERITED 40
 109 #define UCDN_SCRIPT_TAGALOG 41
 110 #define UCDN_SCRIPT_HANUNOO 42
 111 #define UCDN_SCRIPT_BUHID 43
 112 #define UCDN_SCRIPT_TAGBANWA 44
 113 #define UCDN_SCRIPT_LIMBU 45
 114 #define UCDN_SCRIPT_TAI_LE 46
 115 #define UCDN_SCRIPT_LINEAR_B 47
 116 #define UCDN_SCRIPT_UGARITIC 48
 117 #define UCDN_SCRIPT_SHAVIAN 49
 118 #define UCDN_SCRIPT_OSMANYA 50
 119 #define UCDN_SCRIPT_CYPRIOT 51
 120 #define UCDN_SCRIPT_BRAILLE 52
 121 #define UCDN_SCRIPT_BUGINESE 53
 122 #define UCDN_SCRIPT_COPTIC 54
 123 #define UCDN_SCRIPT_NEW_TAI_LUE 55
 124 #define UCDN_SCRIPT_GLAGOLITIC 56
 125 #define UCDN_SCRIPT_TIFINAGH 57
 126 #define UCDN_SCRIPT_SYLOTI_NAGRI 58
 127 #define UCDN_SCRIPT_OLD_PERSIAN 59
 128 #define UCDN_SCRIPT_KHAROSHTHI 60
 129 #define UCDN_SCRIPT_BALINESE 61
 130 #define UCDN_SCRIPT_CUNEIFORM 62
 131 #define UCDN_SCRIPT_PHOENICIAN 63
 132 #define UCDN_SCRIPT_PHAGS_PA 64
 133 #define UCDN_SCRIPT_NKO 65
 134 #define UCDN_SCRIPT_SUNDANESE 66
 135 #define UCDN_SCRIPT_LEPCHA 67
 136 #define UCDN_SCRIPT_OL_CHIKI 68
 137 #define UCDN_SCRIPT_VAI 69
 138 #define UCDN_SCRIPT_SAURASHTRA 70
 139 #define UCDN_SCRIPT_KAYAH_LI 71
 140 #define UCDN_SCRIPT_REJANG 72
 141 #define UCDN_SCRIPT_LYCIAN 73
 142 #define UCDN_SCRIPT_CARIAN 74
 143 #define UCDN_SCRIPT_LYDIAN 75
 144 #define UCDN_SCRIPT_CHAM 76
 145 #define UCDN_SCRIPT_TAI_THAM 77
 146 #define UCDN_SCRIPT_TAI_VIET 78
 147 #define UCDN_SCRIPT_AVESTAN 79
 148 #define UCDN_SCRIPT_EGYPTIAN_HIEROGLYPHS 80
 149 #define UCDN_SCRIPT_SAMARITAN 81
 150 #define UCDN_SCRIPT_LISU 82
 151 #define UCDN_SCRIPT_BAMUM 83
 152 #define UCDN_SCRIPT_JAVANESE 84
 153 #define UCDN_SCRIPT_MEETEI_MAYEK 85
 154 #define UCDN_SCRIPT_IMPERIAL_ARAMAIC 86
 155 #define UCDN_SCRIPT_OLD_SOUTH_ARABIAN 87
 156 #define UCDN_SCRIPT_INSCRIPTIONAL_PARTHIAN 88
 157 #define UCDN_SCRIPT_INSCRIPTIONAL_PAHLAVI 89
 158 #define UCDN_SCRIPT_OLD_TURKIC 90
 159 #define UCDN_SCRIPT_KAITHI 91
 160 #define UCDN_SCRIPT_BATAK 92
 161 #define UCDN_SCRIPT_BRAHMI 93
 162 #define UCDN_SCRIPT_MANDAIC 94
 163 #define UCDN_SCRIPT_CHAKMA 95
 164 #define UCDN_SCRIPT_MEROITIC_CURSIVE 96
 165 #define UCDN_SCRIPT_MEROITIC_HIEROGLYPHS 97
 166 #define UCDN_SCRIPT_MIAO 98
 167 #define UCDN_SCRIPT_SHARADA 99
 168 #define UCDN_SCRIPT_SORA_SOMPENG 100
 169 #define UCDN_SCRIPT_TAKRI 101
 170 #define UCDN_SCRIPT_UNKNOWN 102
 171 #define UCDN_SCRIPT_BASSA_VAH 103
 172 #define UCDN_SCRIPT_CAUCASIAN_ALBANIAN 104
 173 #define UCDN_SCRIPT_DUPLOYAN 105
 174 #define UCDN_SCRIPT_ELBASAN 106
 175 #define UCDN_SCRIPT_GRANTHA 107
 176 #define UCDN_SCRIPT_KHOJKI 108
 177 #define UCDN_SCRIPT_KHUDAWADI 109
 178 #define UCDN_SCRIPT_LINEAR_A 110
 179 #define UCDN_SCRIPT_MAHAJANI 111
 180 #define UCDN_SCRIPT_MANICHAEAN 112
 181 #define UCDN_SCRIPT_MENDE_KIKAKUI 113
 182 #define UCDN_SCRIPT_MODI 114
 183 #define UCDN_SCRIPT_MRO 115
 184 #define UCDN_SCRIPT_NABATAEAN 116
 185 #define UCDN_SCRIPT_OLD_NORTH_ARABIAN 117
 186 #define UCDN_SCRIPT_OLD_PERMIC 118
 187 #define UCDN_SCRIPT_PAHAWH_HMONG 119
 188 #define UCDN_SCRIPT_PALMYRENE 120
 189 #define UCDN_SCRIPT_PAU_CIN_HAU 121
 190 #define UCDN_SCRIPT_PSALTER_PAHLAVI 122
 191 #define UCDN_SCRIPT_SIDDHAM 123
 192 #define UCDN_SCRIPT_TIRHUTA 124
 193 #define UCDN_SCRIPT_WARANG_CITI 125
 194
 195 #define UCDN_GENERAL_CATEGORY_CC 0
 196 #define UCDN_GENERAL_CATEGORY_CF 1
 197 #define UCDN_GENERAL_CATEGORY_CN 2
 198 #define UCDN_GENERAL_CATEGORY_CO 3
 199 #define UCDN_GENERAL_CATEGORY_CS 4
 200 #define UCDN_GENERAL_CATEGORY_LL 5
 201 #define UCDN_GENERAL_CATEGORY_LM 6
 202 #define UCDN_GENERAL_CATEGORY_LO 7
 203 #define UCDN_GENERAL_CATEGORY_LT 8
 204 #define UCDN_GENERAL_CATEGORY_LU 9
 205 #define UCDN_GENERAL_CATEGORY_MC 10
 206 #define UCDN_GENERAL_CATEGORY_ME 11
 207 #define UCDN_GENERAL_CATEGORY_MN 12
 208 #define UCDN_GENERAL_CATEGORY_ND 13
 209 #define UCDN_GENERAL_CATEGORY_NL 14
 210 #define UCDN_GENERAL_CATEGORY_NO 15
 211 #define UCDN_GENERAL_CATEGORY_PC 16
 212 #define UCDN_GENERAL_CATEGORY_PD 17
 213 #define UCDN_GENERAL_CATEGORY_PE 18
 214 #define UCDN_GENERAL_CATEGORY_PF 19
 215 #define UCDN_GENERAL_CATEGORY_PI 20
 216 #define UCDN_GENERAL_CATEGORY_PO 21
 217 #define UCDN_GENERAL_CATEGORY_PS 22
 218 #define UCDN_GENERAL_CATEGORY_SC 23
 219 #define UCDN_GENERAL_CATEGORY_SK 24
 220 #define UCDN_GENERAL_CATEGORY_SM 25
 221 #define UCDN_GENERAL_CATEGORY_SO 26
 222 #define UCDN_GENERAL_CATEGORY_ZL 27
 223 #define UCDN_GENERAL_CATEGORY_ZP 28
 224 #define UCDN_GENERAL_CATEGORY_ZS 29
 225
 226 #define UCDN_BIDI_CLASS_L 0
 227 #define UCDN_BIDI_CLASS_LRE 1
 228 #define UCDN_BIDI_CLASS_LRO 2
 229 #define UCDN_BIDI_CLASS_R 3
 230 #define UCDN_BIDI_CLASS_AL 4
 231 #define UCDN_BIDI_CLASS_RLE 5
 232 #define UCDN_BIDI_CLASS_RLO 6
 233 #define UCDN_BIDI_CLASS_PDF 7
 234 #define UCDN_BIDI_CLASS_EN 8
 235 #define UCDN_BIDI_CLASS_ES 9
 236 #define UCDN_BIDI_CLASS_ET 10
 237 #define UCDN_BIDI_CLASS_AN 11
 238 #define UCDN_BIDI_CLASS_CS 12
 239 #define UCDN_BIDI_CLASS_NSM 13
 240 #define UCDN_BIDI_CLASS_BN 14
 241 #define UCDN_BIDI_CLASS_B 15
 242 #define UCDN_BIDI_CLASS_S 16
 243 #define UCDN_BIDI_CLASS_WS 17
 244 #define UCDN_BIDI_CLASS_ON 18
 245 #define UCDN_BIDI_CLASS_LRI 19
 246 #define UCDN_BIDI_CLASS_RLI 20
 247 #define UCDN_BIDI_CLASS_FSI 21
 248 #define UCDN_BIDI_CLASS_PDI 22
 249
 250 /**
 251  * Return version of the Unicode database.
 252  *
 253  * @return Unicode database version
 254  */
 255 const char *ucdn_get_unicode_version(void);
 256
 257 /**
 258  * Get combining class of a codepoint.
 259  *
 260  * @param code Unicode codepoint
 261  * @return combining class value, as defined in UAX#44
 262  */
 263 int ucdn_get_combining_class(uint32_t code);
 264
 265 /**
 266  * Get east-asian width of a codepoint.
 267  *
 268  * @param code Unicode codepoint
 269  * @return value according to UCDN_EAST_ASIAN_* and as defined in UAX#11.
 270  */
 271 int ucdn_get_east_asian_width(uint32_t code);
 272
 273 /**
 274  * Get general category of a codepoint.
 275  *
 276  * @param code Unicode codepoint
 277  * @return value according to UCDN_GENERAL_CATEGORY_* and as defined in
 278  * UAX#44.
 279  */
 280 int ucdn_get_general_category(uint32_t code);
 281
 282 /**
 283  * Get bidirectional class of a codepoint.
 284  *
 285  * @param code Unicode codepoint
 286  * @return value according to UCDN_BIDI_CLASS_* and as defined in UAX#44.
 287  */
 288 int ucdn_get_bidi_class(uint32_t code);
 289
 290 /**
 291  * Get script of a codepoint.
 292  *
 293  * @param code Unicode codepoint
 294  * @return value according to UCDN_SCRIPT_* and as defined in UAX#24.
 295  */
 296 int ucdn_get_script(uint32_t code);
 297
 298 /**
 299  * Check if codepoint can be mirrored.
 300  *
 301  * @param code Unicode codepoint
 302  * @return 1 if mirrored character exists, otherwise 0
 303  */
 304 int ucdn_get_mirrored(uint32_t code);
 305
 306 /**
 307  * Mirror a codepoint.
 308  *
 309  * @param code Unicode codepoint
 310  * @return mirrored codepoint or the original codepoint if no
 311  * mirrored character exists
 312  */
 313 uint32_t ucdn_mirror(uint32_t code);
 314
 315 /**
 316  * Pairwise canonical decomposition of a codepoint. This includes
 317  * Hangul Jamo decomposition (see chapter 3.12 of the Unicode core
 318  * specification).
 319  *
 320  * Hangul is decomposed into L and V jamos for LV forms, and an
 321  * LV precomposed syllable and a T jamo for LVT forms.
 322  *
 323  * @param code Unicode codepoint
 324  * @param a filled with first codepoint of decomposition
 325  * @param b filled with second codepoint of decomposition, or 0
 326  * @return success
 327  */
 328 int ucdn_decompose(uint32_t code, uint32_t *a, uint32_t *b);
 329
 330 /**
 331  * Compatibility decomposition of a codepoint.
 332  *
 333  * @param code Unicode codepoint
 334  * @param decomposed filled with decomposition, must be able to hold 18
 335  * characters
 336  * @return length of decomposition or 0 in case none exists
 337  */
 338 int ucdn_compat_decompose(uint32_t code, uint32_t *decomposed);
 339
 340 /**
 341  * Pairwise canonical composition of two codepoints. This includes
 342  * Hangul Jamo composition (see chapter 3.12 of the Unicode core
 343  * specification).
 344  *
 345  * Hangul composition expects either L and V jamos, or an LV
 346  * precomposed syllable and a T jamo. This is exactly the inverse
 347  * of pairwise Hangul decomposition.
 348  *
 349  * @param code filled with composition
 350  * @param a first codepoint
 351  * @param b second codepoint
 352  * @return success
 353  */
 354 int ucdn_compose(uint32_t *code, uint32_t a, uint32_t b);
 355
 356 HB_END_HEADER
 357
 358 #endif