src/hb-unicode.c

   1 /*
   2  * Copyright (C) 2009  Red Hat, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb-private.h"
  28
  29 #include "hb-unicode-private.h"
  30
  31 /*
  32  * hb_unicode_funcs_t
  33  */
  34
  35 static hb_codepoint_t hb_unicode_get_mirroring_nil (hb_codepoint_t unicode) { return unicode; }
  36 static hb_category_t hb_unicode_get_general_category_nil (hb_codepoint_t unicode HB_UNUSED) { return HB_CATEGORY_OTHER_LETTER; }
  37 static hb_script_t hb_unicode_get_script_nil (hb_codepoint_t unicode HB_UNUSED) { return HB_SCRIPT_UNKNOWN; }
  38 static unsigned int hb_unicode_get_combining_class_nil (hb_codepoint_t unicode HB_UNUSED) { return 0; }
  39 static unsigned int hb_unicode_get_eastasian_width_nil (hb_codepoint_t unicode HB_UNUSED) { return 1; }
  40
  41 hb_unicode_funcs_t _hb_unicode_funcs_nil = {
  42   HB_REFERENCE_COUNT_INVALID, /* ref_count */
  43
  44   TRUE, /* immutable */
  45
  46   hb_unicode_get_general_category_nil,
  47   hb_unicode_get_combining_class_nil,
  48   hb_unicode_get_mirroring_nil,
  49   hb_unicode_get_script_nil,
  50   hb_unicode_get_eastasian_width_nil
  51 };
  52
  53 hb_unicode_funcs_t *
  54 hb_unicode_funcs_create (void)
  55 {
  56   hb_unicode_funcs_t *ufuncs;
  57
  58   if (!HB_OBJECT_DO_CREATE (hb_unicode_funcs_t, ufuncs))
  59     return &_hb_unicode_funcs_nil;
  60
  61   *ufuncs = _hb_unicode_funcs_nil;
  62   HB_OBJECT_DO_INIT (ufuncs);
  63
  64   return ufuncs;
  65 }
  66
  67 hb_unicode_funcs_t *
  68 hb_unicode_funcs_reference (hb_unicode_funcs_t *ufuncs)
  69 {
  70   HB_OBJECT_DO_REFERENCE (ufuncs);
  71 }
  72
  73 unsigned int
  74 hb_unicode_funcs_get_reference_count (hb_unicode_funcs_t *ufuncs)
  75 {
  76   HB_OBJECT_DO_GET_REFERENCE_COUNT (ufuncs);
  77 }
  78
  79 void
  80 hb_unicode_funcs_destroy (hb_unicode_funcs_t *ufuncs)
  81 {
  82   HB_OBJECT_DO_DESTROY (ufuncs);
  83
  84   free (ufuncs);
  85 }
  86
  87 hb_unicode_funcs_t *
  88 hb_unicode_funcs_copy (hb_unicode_funcs_t *other_ufuncs)
  89 {
  90   hb_unicode_funcs_t *ufuncs;
  91
  92   if (!HB_OBJECT_DO_CREATE (hb_unicode_funcs_t, ufuncs))
  93     return &_hb_unicode_funcs_nil;
  94
  95   *ufuncs = *other_ufuncs;
  96   HB_OBJECT_DO_INIT (ufuncs);
  97   ufuncs->immutable = FALSE;
  98
  99   return ufuncs;
 100 }
 101
 102 void
 103 hb_unicode_funcs_make_immutable (hb_unicode_funcs_t *ufuncs)
 104 {
 105   if (HB_OBJECT_IS_INERT (ufuncs))
 106     return;
 107
 108   ufuncs->immutable = TRUE;
 109 }
 110
 111
 112 void
 113 hb_unicode_funcs_set_mirroring_func (hb_unicode_funcs_t *ufuncs,
 114                                      hb_unicode_get_mirroring_func_t mirroring_func)
 115 {
 116   if (ufuncs->immutable)
 117     return;
 118
 119   ufuncs->get_mirroring = mirroring_func ? mirroring_func : hb_unicode_get_mirroring_nil;
 120 }
 121
 122 void
 123 hb_unicode_funcs_set_general_category_func (hb_unicode_funcs_t *ufuncs,
 124                                             hb_unicode_get_general_category_func_t general_category_func)
 125 {
 126   if (ufuncs->immutable)
 127     return;
 128
 129   ufuncs->get_general_category = general_category_func ? general_category_func : hb_unicode_get_general_category_nil;
 130 }
 131
 132 void
 133 hb_unicode_funcs_set_script_func (hb_unicode_funcs_t *ufuncs,
 134                                   hb_unicode_get_script_func_t script_func)
 135 {
 136   if (ufuncs->immutable)
 137     return;
 138
 139   ufuncs->get_script = script_func ? script_func : hb_unicode_get_script_nil;
 140 }
 141
 142 void
 143 hb_unicode_funcs_set_combining_class_func (hb_unicode_funcs_t *ufuncs,
 144                                            hb_unicode_get_combining_class_func_t combining_class_func)
 145 {
 146   if (ufuncs->immutable)
 147     return;
 148
 149   ufuncs->get_combining_class = combining_class_func ? combining_class_func : hb_unicode_get_combining_class_nil;
 150 }
 151
 152 void
 153 hb_unicode_funcs_set_eastasian_width_func (hb_unicode_funcs_t *ufuncs,
 154                                            hb_unicode_get_eastasian_width_func_t eastasian_width_func)
 155 {
 156   if (ufuncs->immutable)
 157     return;
 158
 159   ufuncs->get_eastasian_width = eastasian_width_func ? eastasian_width_func : hb_unicode_get_eastasian_width_nil;
 160 }
 161
 162
 163 hb_codepoint_t
 164 hb_unicode_get_mirroring (hb_unicode_funcs_t *ufuncs,
 165                           hb_codepoint_t unicode)
 166 {
 167   return ufuncs->get_mirroring (unicode);
 168 }
 169
 170 hb_category_t
 171 hb_unicode_get_general_category (hb_unicode_funcs_t *ufuncs,
 172                                  hb_codepoint_t unicode)
 173 {
 174   return ufuncs->get_general_category (unicode);
 175 }
 176
 177 hb_script_t
 178 hb_unicode_get_script (hb_unicode_funcs_t *ufuncs,
 179                        hb_codepoint_t unicode)
 180 {
 181   return ufuncs->get_script (unicode);
 182 }
 183
 184 unsigned int
 185 hb_unicode_get_combining_class (hb_unicode_funcs_t *ufuncs,
 186                                 hb_codepoint_t unicode)
 187 {
 188   return ufuncs->get_combining_class (unicode);
 189 }
 190
 191 unsigned int
 192 hb_unicode_get_eastasian_width (hb_unicode_funcs_t *ufuncs,
 193                                 hb_codepoint_t unicode)
 194 {
 195   return ufuncs->get_eastasian_width (unicode);
 196 }
 197
 198
 199
 200 #define LTR HB_DIRECTION_LTR
 201 #define RTL HB_DIRECTION_RTL
 202 const hb_direction_t horiz_dir[] =
 203 {
 204   LTR,  /* Zyyy */
 205   LTR,  /* Qaai */
 206   RTL,  /* Arab */
 207   LTR,  /* Armn */
 208   LTR,  /* Beng */
 209   LTR,  /* Bopo */
 210   LTR,  /* Cher */
 211   LTR,  /* Qaac */
 212   LTR,  /* Cyrl (Cyrs) */
 213   LTR,  /* Dsrt */
 214   LTR,  /* Deva */
 215   LTR,  /* Ethi */
 216   LTR,  /* Geor (Geon, Geoa) */
 217   LTR,  /* Goth */
 218   LTR,  /* Grek */
 219   LTR,  /* Gujr */
 220   LTR,  /* Guru */
 221   LTR,  /* Hani */
 222   LTR,  /* Hang */
 223   RTL,  /* Hebr */
 224   LTR,  /* Hira */
 225   LTR,  /* Knda */
 226   LTR,  /* Kana */
 227   LTR,  /* Khmr */
 228   LTR,  /* Laoo */
 229   LTR,  /* Latn (Latf, Latg) */
 230   LTR,  /* Mlym */
 231   LTR,  /* Mong */
 232   LTR,  /* Mymr */
 233   LTR,  /* Ogam */
 234   LTR,  /* Ital */
 235   LTR,  /* Orya */
 236   LTR,  /* Runr */
 237   LTR,  /* Sinh */
 238   RTL,  /* Syrc (Syrj, Syrn, Syre) */
 239   LTR,  /* Taml */
 240   LTR,  /* Telu */
 241   RTL,  /* Thaa */
 242   LTR,  /* Thai */
 243   LTR,  /* Tibt */
 244   LTR,  /* Cans */
 245   LTR,  /* Yiii */
 246   LTR,  /* Tglg */
 247   LTR,  /* Hano */
 248   LTR,  /* Buhd */
 249   LTR,  /* Tagb */
 250
 251   /* Unicode-4.0 additions */
 252   LTR,  /* Brai */
 253   LTR,  /* Cprt */
 254   LTR,  /* Limb */
 255   LTR,  /* Osma */
 256   LTR,  /* Shaw */
 257   LTR,  /* Linb */
 258   LTR,  /* Tale */
 259   LTR,  /* Ugar */
 260
 261   /* Unicode-4.1 additions */
 262   LTR,  /* Talu */
 263   LTR,  /* Bugi */
 264   LTR,  /* Glag */
 265   LTR,  /* Tfng */
 266   LTR,  /* Sylo */
 267   LTR,  /* Xpeo */
 268   LTR,  /* Khar */
 269
 270   /* Unicode-5.0 additions */
 271   LTR,  /* Zzzz */
 272   LTR,  /* Bali */
 273   LTR,  /* Xsux */
 274   RTL,  /* Phnx */
 275   LTR,  /* Phag */
 276   RTL,  /* Nkoo */
 277
 278   /* Unicode-5.1 additions */
 279   LTR,  /* Kali */
 280   LTR,  /* Lepc */
 281   LTR,  /* Rjng */
 282   LTR,  /* Sund */
 283   LTR,  /* Saur */
 284   LTR,  /* Cham */
 285   LTR,  /* Olck */
 286   LTR,  /* Vaii */
 287   LTR,  /* Cari */
 288   LTR,  /* Lyci */
 289   LTR   /* Lydi */
 290 };
 291 #undef LTR
 292 #undef RTL
 293
 294 HB_INTERNAL hb_direction_t
 295 _hb_script_get_horizontal_direction (hb_script_t script)
 296 {
 297   if (unlikely ((unsigned int) script >= ARRAY_LENGTH (horiz_dir)))
 298     return HB_DIRECTION_LTR;
 299
 300   return horiz_dir[script];
 301 }