src/hb-unicode.cc

   1 /*
   2  * Copyright © 2009  Red Hat, Inc.
   3  * Copyright © 2011 Codethink Limited
   4  * Copyright © 2010,2011  Google, Inc.
   5  *
   6  *  This is part of HarfBuzz, a text shaping library.
   7  *
   8  * Permission is hereby granted, without written agreement and without
   9  * license or royalty fees, to use, copy, modify, and distribute this
  10  * software and its documentation for any purpose, provided that the
  11  * above copyright notice and the following two paragraphs appear in
  12  * all copies of this software.
  13  *
  14  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  15  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  16  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  17  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  18  * DAMAGE.
  19  *
  20  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  21  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  22  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  23  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  24  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  25  *
  26  * Red Hat Author(s): Behdad Esfahbod
  27  * Codethink Author(s): Ryan Lortie
  28  * Google Author(s): Behdad Esfahbod
  29  */
  30
  31 #include "hb-private.hh"
  32
  33 #include "hb-unicode-private.hh"
  34
  35 HB_BEGIN_DECLS
  36
  37
  38 /*
  39  * hb_unicode_funcs_t
  40  */
  41
  42 static unsigned int
  43 hb_unicode_get_combining_class_nil (hb_unicode_funcs_t *ufuncs    HB_UNUSED,
  44                                     hb_codepoint_t      unicode   HB_UNUSED,
  45                                     void               *user_data HB_UNUSED)
  46 {
  47   return 0;
  48 }
  49
  50 static unsigned int
  51 hb_unicode_get_eastasian_width_nil (hb_unicode_funcs_t *ufuncs    HB_UNUSED,
  52                                     hb_codepoint_t      unicode   HB_UNUSED,
  53                                     void               *user_data HB_UNUSED)
  54 {
  55   return 1;
  56 }
  57
  58 static hb_unicode_general_category_t
  59 hb_unicode_get_general_category_nil (hb_unicode_funcs_t *ufuncs    HB_UNUSED,
  60                                      hb_codepoint_t      unicode   HB_UNUSED,
  61                                      void               *user_data HB_UNUSED)
  62 {
  63   return HB_UNICODE_GENERAL_CATEGORY_OTHER_LETTER;
  64 }
  65
  66 static hb_codepoint_t
  67 hb_unicode_get_mirroring_nil (hb_unicode_funcs_t *ufuncs    HB_UNUSED,
  68                               hb_codepoint_t      unicode   HB_UNUSED,
  69                               void               *user_data HB_UNUSED)
  70 {
  71   return unicode;
  72 }
  73
  74 static hb_script_t
  75 hb_unicode_get_script_nil (hb_unicode_funcs_t *ufuncs    HB_UNUSED,
  76                            hb_codepoint_t      unicode   HB_UNUSED,
  77                            void               *user_data HB_UNUSED)
  78 {
  79   return HB_SCRIPT_UNKNOWN;
  80 }
  81
  82
  83 hb_unicode_funcs_t _hb_unicode_funcs_nil = {
  84   HB_OBJECT_HEADER_STATIC,
  85
  86   NULL, /* parent */
  87   TRUE, /* immutable */
  88   {
  89     hb_unicode_get_combining_class_nil,
  90     hb_unicode_get_eastasian_width_nil,
  91     hb_unicode_get_general_category_nil,
  92     hb_unicode_get_mirroring_nil,
  93     hb_unicode_get_script_nil,
  94   }
  95 };
  96
  97
  98 hb_unicode_funcs_t *
  99 hb_unicode_funcs_get_default (void)
 100 {
 101   return &_hb_unicode_funcs_default;
 102 }
 103
 104 hb_unicode_funcs_t *
 105 hb_unicode_funcs_create (hb_unicode_funcs_t *parent)
 106 {
 107   hb_unicode_funcs_t *ufuncs;
 108
 109   if (!(ufuncs = hb_object_create<hb_unicode_funcs_t> ()))
 110     return &_hb_unicode_funcs_nil;
 111
 112   if (!parent)
 113     parent = &_hb_unicode_funcs_nil;
 114
 115   hb_unicode_funcs_make_immutable (parent);
 116   ufuncs->parent = hb_unicode_funcs_reference (parent);
 117
 118   ufuncs->get = parent->get;
 119
 120   /* We can safely copy user_data from parent since we hold a reference
 121    * onto it and it's immutable.  We should not copy the destroy notifiers
 122    * though. */
 123   ufuncs->user_data = parent->user_data;
 124
 125   return ufuncs;
 126 }
 127
 128 hb_unicode_funcs_t *
 129 hb_unicode_funcs_reference (hb_unicode_funcs_t *ufuncs)
 130 {
 131   return hb_object_reference (ufuncs);
 132 }
 133
 134 void
 135 hb_unicode_funcs_destroy (hb_unicode_funcs_t *ufuncs)
 136 {
 137   if (!hb_object_destroy (ufuncs)) return;
 138
 139 #define DESTROY(name) if (ufuncs->destroy.name) ufuncs->destroy.name (ufuncs->user_data.name)
 140   DESTROY (combining_class);
 141   DESTROY (eastasian_width);
 142   DESTROY (general_category);
 143   DESTROY (mirroring);
 144   DESTROY (script);
 145 #undef DESTROY
 146
 147   hb_unicode_funcs_destroy (ufuncs->parent);
 148
 149   free (ufuncs);
 150 }
 151
 152 hb_bool_t
 153 hb_unicode_funcs_set_user_data (hb_unicode_funcs_t *ufuncs,
 154                                 hb_user_data_key_t *key,
 155                                 void *              data,
 156                                 hb_destroy_func_t   destroy)
 157 {
 158   return hb_object_set_user_data (ufuncs, key, data, destroy);
 159 }
 160
 161 void *
 162 hb_unicode_funcs_get_user_data (hb_unicode_funcs_t *ufuncs,
 163                                 hb_user_data_key_t *key)
 164 {
 165   return hb_object_get_user_data (ufuncs, key);
 166 }
 167
 168
 169 void
 170 hb_unicode_funcs_make_immutable (hb_unicode_funcs_t *ufuncs)
 171 {
 172   if (hb_object_is_inert (ufuncs))
 173     return;
 174
 175   ufuncs->immutable = TRUE;
 176 }
 177
 178 hb_bool_t
 179 hb_unicode_funcs_is_immutable (hb_unicode_funcs_t *ufuncs)
 180 {
 181   return ufuncs->immutable;
 182 }
 183
 184 hb_unicode_funcs_t *
 185 hb_unicode_funcs_get_parent (hb_unicode_funcs_t *ufuncs)
 186 {
 187   return ufuncs->parent ? ufuncs->parent : &_hb_unicode_funcs_nil;
 188 }
 189
 190
 191 #define IMPLEMENT(return_type, name)                                           \
 192                                                                                \
 193 void                                                                           \
 194 hb_unicode_funcs_set_##name##_func (hb_unicode_funcs_t             *ufuncs,    \
 195                                     hb_unicode_get_##name##_func_t  func,      \
 196                                     void                           *user_data, \
 197                                     hb_destroy_func_t               destroy)   \
 198 {                                                                              \
 199   if (ufuncs->immutable)                                                       \
 200     return;                                                                    \
 201                                                                                \
 202   if (ufuncs->destroy.name)                                                    \
 203     ufuncs->destroy.name (ufuncs->user_data.name);                             \
 204                                                                                \
 205   if (func) {                                                                  \
 206     ufuncs->get.name = func;                                                   \
 207     ufuncs->user_data.name = user_data;                                        \
 208     ufuncs->destroy.name = destroy;                                            \
 209   } else {                                                                     \
 210     ufuncs->get.name = ufuncs->parent->get.name;                               \
 211     ufuncs->user_data.name = ufuncs->parent->user_data.name;                   \
 212     ufuncs->destroy.name = NULL;                                               \
 213   }                                                                            \
 214 }                                                                              \
 215                                                                                \
 216 return_type                                                                    \
 217 hb_unicode_get_##name (hb_unicode_funcs_t *ufuncs,                             \
 218                        hb_codepoint_t      unicode)                            \
 219 {                                                                              \
 220   return ufuncs->get.name (ufuncs, unicode, ufuncs->user_data.name);           \
 221 }
 222
 223 IMPLEMENT (unsigned int, combining_class)
 224 IMPLEMENT (unsigned int, eastasian_width)
 225 IMPLEMENT (hb_unicode_general_category_t, general_category)
 226 IMPLEMENT (hb_codepoint_t, mirroring)
 227 IMPLEMENT (hb_script_t, script)
 228
 229 #undef IMPLEMENT
 230
 231
 232 HB_END_DECLS