src/hb-common.h

   1 /*
   2  * Copyright © 2007,2008,2009  Red Hat, Inc.
   3  * Copyright © 2011  Google, Inc.
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  * Google Author(s): Behdad Esfahbod
  27  */
  28
  29 #ifndef HB_COMMON_H
  30 #define HB_COMMON_H
  31
  32 # ifdef __cplusplus
  33 #  define HB_BEGIN_DECLS        extern "C" {
  34 #  define HB_END_DECLS          }
  35 # else /* !__cplusplus */
  36 #  define HB_BEGIN_DECLS
  37 #  define HB_END_DECLS
  38 # endif /* !__cplusplus */
  39
  40 HB_BEGIN_DECLS
  41
  42 #if !defined (HB_DONT_DEFINE_STDINT)
  43
  44 #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \
  45     defined (_sgi) || defined (__sun) || defined (sun) || \
  46     defined (__digital__) || defined (__HP_cc)
  47 #  include <inttypes.h>
  48 #elif defined (_AIX)
  49 #  include <sys/inttypes.h>
  50 /* VS 2010 (_MSC_VER 1600) has stdint.h */
  51 #elif defined (_MSC_VER) && _MSC_VER < 1600
  52 typedef __int8 int8_t;
  53 typedef unsigned __int8 uint8_t;
  54 typedef __int16 int16_t;
  55 typedef unsigned __int16 uint16_t;
  56 typedef __int32 int32_t;
  57 typedef unsigned __int32 uint32_t;
  58 typedef __int64 int64_t;
  59 typedef unsigned __int64 uint64_t;
  60 #else
  61 #  include <stdint.h>
  62 #endif
  63
  64 #endif
  65
  66
  67 typedef int hb_bool_t;
  68
  69 typedef uint32_t hb_codepoint_t;
  70 typedef int32_t hb_position_t;
  71 typedef uint32_t hb_mask_t;
  72
  73 typedef union _hb_var_int_t {
  74   uint32_t u32;
  75   int32_t i32;
  76   uint16_t u16[2];
  77   int16_t i16[2];
  78   uint8_t u8[4];
  79   int8_t i8[4];
  80 } hb_var_int_t;
  81
  82
  83 /* hb_tag_t */
  84
  85 typedef uint32_t hb_tag_t;
  86
  87 #define HB_TAG(a,b,c,d) ((hb_tag_t)((((uint8_t)(a))<<24)|(((uint8_t)(b))<<16)|(((uint8_t)(c))<<8)|((uint8_t)(d))))
  88 #define HB_UNTAG(tag)   ((uint8_t)((tag)>>24)), ((uint8_t)((tag)>>16)), ((uint8_t)((tag)>>8)), ((uint8_t)(tag))
  89
  90 #define HB_TAG_NONE HB_TAG(0,0,0,0)
  91
  92 hb_tag_t hb_tag_from_string (const char *s);
  93
  94
  95 /* hb_direction_t */
  96
  97 typedef enum _hb_direction_t {
  98   HB_DIRECTION_INVALID = -1,
  99   HB_DIRECTION_LTR = 0,
 100   HB_DIRECTION_RTL,
 101   HB_DIRECTION_TTB,
 102   HB_DIRECTION_BTT
 103 } hb_direction_t;
 104
 105 hb_direction_t
 106 hb_direction_from_string (const char *str);
 107
 108 const char *
 109 hb_direction_to_string (hb_direction_t direction);
 110
 111 #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 0)
 112 #define HB_DIRECTION_IS_VERTICAL(dir)   ((((unsigned int) (dir)) & ~1U) == 2)
 113 #define HB_DIRECTION_IS_FORWARD(dir)    ((((unsigned int) (dir)) & ~2U) == 0)
 114 #define HB_DIRECTION_IS_BACKWARD(dir)   ((((unsigned int) (dir)) & ~2U) == 1)
 115 #define HB_DIRECTION_REVERSE(dir)       ((hb_direction_t) (((unsigned int) (dir)) ^ 1))
 116
 117
 118 /* hb_language_t */
 119
 120 typedef struct _hb_language_t *hb_language_t;
 121
 122 hb_language_t
 123 hb_language_from_string (const char *str);
 124
 125 const char *
 126 hb_language_to_string (hb_language_t language);
 127
 128 #define HB_LANGUAGE_INVALID ((hb_language_t) NULL)
 129
 130 hb_language_t
 131 hb_language_get_default (void);
 132
 133
 134 /* hb_unicode_general_category_t */
 135
 136 typedef enum
 137 {
 138   HB_UNICODE_GENERAL_CATEGORY_CONTROL,                  /* Cc */
 139   HB_UNICODE_GENERAL_CATEGORY_FORMAT,                   /* Cf */
 140   HB_UNICODE_GENERAL_CATEGORY_UNASSIGNED,               /* Cn */
 141   HB_UNICODE_GENERAL_CATEGORY_PRIVATE_USE,              /* Co */
 142   HB_UNICODE_GENERAL_CATEGORY_SURROGATE,                /* Cs */
 143   HB_UNICODE_GENERAL_CATEGORY_LOWERCASE_LETTER,         /* Ll */
 144   HB_UNICODE_GENERAL_CATEGORY_MODIFIER_LETTER,          /* Lm */
 145   HB_UNICODE_GENERAL_CATEGORY_OTHER_LETTER,             /* Lo */
 146   HB_UNICODE_GENERAL_CATEGORY_TITLECASE_LETTER,         /* Lt */
 147   HB_UNICODE_GENERAL_CATEGORY_UPPERCASE_LETTER,         /* Lu */
 148   HB_UNICODE_GENERAL_CATEGORY_SPACING_MARK,             /* Mc */
 149   HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK,           /* Me */
 150   HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK,         /* Mn */
 151   HB_UNICODE_GENERAL_CATEGORY_DECIMAL_NUMBER,           /* Nd */
 152   HB_UNICODE_GENERAL_CATEGORY_LETTER_NUMBER,            /* Nl */
 153   HB_UNICODE_GENERAL_CATEGORY_OTHER_NUMBER,             /* No */
 154   HB_UNICODE_GENERAL_CATEGORY_CONNECT_PUNCTUATION,      /* Pc */
 155   HB_UNICODE_GENERAL_CATEGORY_DASH_PUNCTUATION,         /* Pd */
 156   HB_UNICODE_GENERAL_CATEGORY_CLOSE_PUNCTUATION,        /* Pe */
 157   HB_UNICODE_GENERAL_CATEGORY_FINAL_PUNCTUATION,        /* Pf */
 158   HB_UNICODE_GENERAL_CATEGORY_INITIAL_PUNCTUATION,      /* Pi */
 159   HB_UNICODE_GENERAL_CATEGORY_OTHER_PUNCTUATION,        /* Po */
 160   HB_UNICODE_GENERAL_CATEGORY_OPEN_PUNCTUATION,         /* Ps */
 161   HB_UNICODE_GENERAL_CATEGORY_CURRENCY_SYMBOL,          /* Sc */
 162   HB_UNICODE_GENERAL_CATEGORY_MODIFIER_SYMBOL,          /* Sk */
 163   HB_UNICODE_GENERAL_CATEGORY_MATH_SYMBOL,              /* Sm */
 164   HB_UNICODE_GENERAL_CATEGORY_OTHER_SYMBOL,             /* So */
 165   HB_UNICODE_GENERAL_CATEGORY_LINE_SEPARATOR,           /* Zl */
 166   HB_UNICODE_GENERAL_CATEGORY_PARAGRAPH_SEPARATOR,      /* Zp */
 167   HB_UNICODE_GENERAL_CATEGORY_SPACE_SEPARATOR           /* Zs */
 168 } hb_unicode_general_category_t;
 169
 170
 171 /* hb_script_t */
 172
 173 /* http://unicode.org/iso15924/ */
 174 typedef enum
 175 {
 176   HB_SCRIPT_COMMON                  = HB_TAG ('Z','y','y','y'),
 177   HB_SCRIPT_INHERITED               = HB_TAG ('Z','i','n','h'),
 178   HB_SCRIPT_ARABIC                  = HB_TAG ('A','r','a','b'),
 179   HB_SCRIPT_ARMENIAN                = HB_TAG ('A','r','m','n'),
 180   HB_SCRIPT_BENGALI                 = HB_TAG ('B','e','n','g'),
 181   HB_SCRIPT_BOPOMOFO                = HB_TAG ('B','o','p','o'),
 182   HB_SCRIPT_CHEROKEE                = HB_TAG ('C','h','e','r'),
 183   HB_SCRIPT_COPTIC                  = HB_TAG ('C','o','p','t'),
 184   HB_SCRIPT_CYRILLIC                = HB_TAG ('C','y','r','l'),
 185   HB_SCRIPT_DESERET                 = HB_TAG ('D','s','r','t'),
 186   HB_SCRIPT_DEVANAGARI              = HB_TAG ('D','e','v','a'),
 187   HB_SCRIPT_ETHIOPIC                = HB_TAG ('E','t','h','i'),
 188   HB_SCRIPT_GEORGIAN                = HB_TAG ('G','e','o','r'),
 189   HB_SCRIPT_GOTHIC                  = HB_TAG ('G','o','t','h'),
 190   HB_SCRIPT_GREEK                   = HB_TAG ('G','r','e','k'),
 191   HB_SCRIPT_GUJARATI                = HB_TAG ('G','u','j','r'),
 192   HB_SCRIPT_GURMUKHI                = HB_TAG ('G','u','r','u'),
 193   HB_SCRIPT_HAN                     = HB_TAG ('H','a','n','i'),
 194   HB_SCRIPT_HANGUL                  = HB_TAG ('H','a','n','g'),
 195   HB_SCRIPT_HEBREW                  = HB_TAG ('H','e','b','r'),
 196   HB_SCRIPT_HIRAGANA                = HB_TAG ('H','i','r','a'),
 197   HB_SCRIPT_KANNADA                 = HB_TAG ('K','n','d','a'),
 198   HB_SCRIPT_KATAKANA                = HB_TAG ('K','a','n','a'),
 199   HB_SCRIPT_KHMER                   = HB_TAG ('K','h','m','r'),
 200   HB_SCRIPT_LAO                     = HB_TAG ('L','a','o','o'),
 201   HB_SCRIPT_LATIN                   = HB_TAG ('L','a','t','n'),
 202   HB_SCRIPT_MALAYALAM               = HB_TAG ('M','l','y','m'),
 203   HB_SCRIPT_MONGOLIAN               = HB_TAG ('M','o','n','g'),
 204   HB_SCRIPT_MYANMAR                 = HB_TAG ('M','y','m','r'),
 205   HB_SCRIPT_OGHAM                   = HB_TAG ('O','g','a','m'),
 206   HB_SCRIPT_OLD_ITALIC              = HB_TAG ('I','t','a','l'),
 207   HB_SCRIPT_ORIYA                   = HB_TAG ('O','r','y','a'),
 208   HB_SCRIPT_RUNIC                   = HB_TAG ('R','u','n','r'),
 209   HB_SCRIPT_SINHALA                 = HB_TAG ('S','i','n','h'),
 210   HB_SCRIPT_SYRIAC                  = HB_TAG ('S','y','r','c'),
 211   HB_SCRIPT_TAMIL                   = HB_TAG ('T','a','m','l'),
 212   HB_SCRIPT_TELUGU                  = HB_TAG ('T','e','l','u'),
 213   HB_SCRIPT_THAANA                  = HB_TAG ('T','h','a','a'),
 214   HB_SCRIPT_THAI                    = HB_TAG ('T','h','a','i'),
 215   HB_SCRIPT_TIBETAN                 = HB_TAG ('T','i','b','t'),
 216   HB_SCRIPT_CANADIAN_ABORIGINAL     = HB_TAG ('C','a','n','s'),
 217   HB_SCRIPT_YI                      = HB_TAG ('Y','i','i','i'),
 218   HB_SCRIPT_TAGALOG                 = HB_TAG ('T','g','l','g'),
 219   HB_SCRIPT_HANUNOO                 = HB_TAG ('H','a','n','o'),
 220   HB_SCRIPT_BUHID                   = HB_TAG ('B','u','h','d'),
 221   HB_SCRIPT_TAGBANWA                = HB_TAG ('T','a','g','b'),
 222
 223   /* Unicode-4.0 additions */
 224   HB_SCRIPT_BRAILLE                 = HB_TAG ('B','r','a','i'),
 225   HB_SCRIPT_CYPRIOT                 = HB_TAG ('C','p','r','t'),
 226   HB_SCRIPT_LIMBU                   = HB_TAG ('L','i','m','b'),
 227   HB_SCRIPT_OSMANYA                 = HB_TAG ('O','s','m','a'),
 228   HB_SCRIPT_SHAVIAN                 = HB_TAG ('S','h','a','w'),
 229   HB_SCRIPT_LINEAR_B                = HB_TAG ('L','i','n','b'),
 230   HB_SCRIPT_TAI_LE                  = HB_TAG ('T','a','l','e'),
 231   HB_SCRIPT_UGARITIC                = HB_TAG ('U','g','a','r'),
 232
 233   /* Unicode-4.1 additions */
 234   HB_SCRIPT_NEW_TAI_LUE             = HB_TAG ('T','a','l','u'),
 235   HB_SCRIPT_BUGINESE                = HB_TAG ('B','u','g','i'),
 236   HB_SCRIPT_GLAGOLITIC              = HB_TAG ('G','l','a','g'),
 237   HB_SCRIPT_TIFINAGH                = HB_TAG ('T','f','n','g'),
 238   HB_SCRIPT_SYLOTI_NAGRI            = HB_TAG ('S','y','l','o'),
 239   HB_SCRIPT_OLD_PERSIAN             = HB_TAG ('X','p','e','o'),
 240   HB_SCRIPT_KHAROSHTHI              = HB_TAG ('K','h','a','r'),
 241
 242   /* Unicode-5.0 additions */
 243   HB_SCRIPT_UNKNOWN                 = HB_TAG ('Z','z','z','z'),
 244   HB_SCRIPT_BALINESE                = HB_TAG ('B','a','l','i'),
 245   HB_SCRIPT_CUNEIFORM               = HB_TAG ('X','s','u','x'),
 246   HB_SCRIPT_PHOENICIAN              = HB_TAG ('P','h','n','x'),
 247   HB_SCRIPT_PHAGS_PA                = HB_TAG ('P','h','a','g'),
 248   HB_SCRIPT_NKO                     = HB_TAG ('N','k','o','o'),
 249
 250   /* Unicode-5.1 additions */
 251   HB_SCRIPT_KAYAH_LI                = HB_TAG ('K','a','l','i'),
 252   HB_SCRIPT_LEPCHA                  = HB_TAG ('L','e','p','c'),
 253   HB_SCRIPT_REJANG                  = HB_TAG ('R','j','n','g'),
 254   HB_SCRIPT_SUNDANESE               = HB_TAG ('S','u','n','d'),
 255   HB_SCRIPT_SAURASHTRA              = HB_TAG ('S','a','u','r'),
 256   HB_SCRIPT_CHAM                    = HB_TAG ('C','h','a','m'),
 257   HB_SCRIPT_OL_CHIKI                = HB_TAG ('O','l','c','k'),
 258   HB_SCRIPT_VAI                     = HB_TAG ('V','a','i','i'),
 259   HB_SCRIPT_CARIAN                  = HB_TAG ('C','a','r','i'),
 260   HB_SCRIPT_LYCIAN                  = HB_TAG ('L','y','c','i'),
 261   HB_SCRIPT_LYDIAN                  = HB_TAG ('L','y','d','i'),
 262
 263   /* Unicode-5.2 additions */
 264   HB_SCRIPT_AVESTAN                 = HB_TAG ('A','v','s','t'),
 265   HB_SCRIPT_BAMUM                   = HB_TAG ('B','a','m','u'),
 266   HB_SCRIPT_EGYPTIAN_HIEROGLYPHS    = HB_TAG ('E','g','y','p'),
 267   HB_SCRIPT_IMPERIAL_ARAMAIC        = HB_TAG ('A','r','m','i'),
 268   HB_SCRIPT_INSCRIPTIONAL_PAHLAVI   = HB_TAG ('P','h','l','i'),
 269   HB_SCRIPT_INSCRIPTIONAL_PARTHIAN  = HB_TAG ('P','r','t','i'),
 270   HB_SCRIPT_JAVANESE                = HB_TAG ('J','a','v','a'),
 271   HB_SCRIPT_KAITHI                  = HB_TAG ('K','t','h','i'),
 272   HB_SCRIPT_LISU                    = HB_TAG ('L','i','s','u'),
 273   HB_SCRIPT_MEETEI_MAYEK            = HB_TAG ('M','t','e','i'),
 274   HB_SCRIPT_OLD_SOUTH_ARABIAN       = HB_TAG ('S','a','r','b'),
 275   HB_SCRIPT_OLD_TURKIC              = HB_TAG ('O','r','k','h'),
 276   HB_SCRIPT_SAMARITAN               = HB_TAG ('S','a','m','r'),
 277   HB_SCRIPT_TAI_THAM                = HB_TAG ('L','a','n','a'),
 278   HB_SCRIPT_TAI_VIET                = HB_TAG ('T','a','v','t'),
 279
 280   /* Unicode-6.0 additions */
 281   HB_SCRIPT_BATAK                   = HB_TAG ('B','a','t','k'),
 282   HB_SCRIPT_BRAHMI                  = HB_TAG ('B','r','a','h'),
 283   HB_SCRIPT_MANDAIC                 = HB_TAG ('M','a','n','d'),
 284
 285   /* No script set */
 286   HB_SCRIPT_INVALID                 = HB_TAG_NONE
 287 } hb_script_t;
 288
 289
 290 /* Script functions */
 291
 292 hb_script_t
 293 hb_script_from_iso15924_tag (hb_tag_t tag);
 294
 295 /* suger for tag_from_string() then script_from_iso15924_tag */
 296 hb_script_t
 297 hb_script_from_string (const char *s);
 298
 299 hb_tag_t
 300 hb_script_to_iso15924_tag (hb_script_t script);
 301
 302 hb_direction_t
 303 hb_script_get_horizontal_direction (hb_script_t script);
 304
 305
 306 /* User data */
 307
 308 typedef struct _hb_user_data_key_t {
 309   char unused;
 310 } hb_user_data_key_t;
 311
 312 typedef void (*hb_destroy_func_t) (void *user_data);
 313
 314
 315 HB_END_DECLS
 316
 317 #endif /* HB_COMMON_H */