src/hb-font.h

   1 /*
   2  * Copyright © 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 #ifndef HB_FONT_H
  28 #define HB_FONT_H
  29
  30 #include "hb-common.h"
  31 #include "hb-blob.h"
  32
  33 HB_BEGIN_DECLS
  34
  35
  36 typedef struct _hb_face_t hb_face_t;
  37 typedef struct _hb_font_t hb_font_t;
  38
  39 /*
  40  * hb_face_t
  41  */
  42
  43 hb_face_t *
  44 hb_face_create (hb_blob_t    *blob,
  45                 unsigned int  index);
  46
  47 typedef hb_blob_t * (*hb_get_table_func_t)  (hb_face_t *face, hb_tag_t tag, void *user_data);
  48
  49 /* calls destroy() when not needing user_data anymore */
  50 hb_face_t *
  51 hb_face_create_for_tables (hb_get_table_func_t  get_table,
  52                            void                *user_data,
  53                            hb_destroy_func_t    destroy);
  54
  55 hb_face_t *
  56 hb_face_get_empty (void);
  57
  58 hb_face_t *
  59 hb_face_reference (hb_face_t *face);
  60
  61 void
  62 hb_face_destroy (hb_face_t *face);
  63
  64 hb_bool_t
  65 hb_face_set_user_data (hb_face_t          *face,
  66                        hb_user_data_key_t *key,
  67                        void *              data,
  68                        hb_destroy_func_t   destroy);
  69
  70
  71 void *
  72 hb_face_get_user_data (hb_face_t          *face,
  73                        hb_user_data_key_t *key);
  74
  75 void
  76 hb_face_make_immutable (hb_face_t *face);
  77
  78 hb_bool_t
  79 hb_face_is_immutable (hb_face_t *face);
  80
  81
  82 hb_blob_t *
  83 hb_face_reference_table (hb_face_t *face,
  84                          hb_tag_t   tag);
  85
  86 unsigned int
  87 hb_face_get_upem (hb_face_t *face);
  88
  89
  90 /*
  91  * hb_font_funcs_t
  92  */
  93
  94 typedef struct _hb_font_funcs_t hb_font_funcs_t;
  95
  96 hb_font_funcs_t *
  97 hb_font_funcs_create (void);
  98
  99 hb_font_funcs_t *
 100 hb_font_funcs_get_empty (void);
 101
 102 hb_font_funcs_t *
 103 hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
 104
 105 void
 106 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
 107
 108 hb_bool_t
 109 hb_font_funcs_set_user_data (hb_font_funcs_t    *ffuncs,
 110                              hb_user_data_key_t *key,
 111                              void *              data,
 112                              hb_destroy_func_t   destroy);
 113
 114
 115 void *
 116 hb_font_funcs_get_user_data (hb_font_funcs_t    *ffuncs,
 117                              hb_user_data_key_t *key);
 118
 119
 120 void
 121 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
 122
 123 hb_bool_t
 124 hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs);
 125
 126 /* funcs */
 127
 128 typedef struct _hb_glyph_extents_t
 129 {
 130   hb_position_t x_bearing;
 131   hb_position_t y_bearing;
 132   hb_position_t width;
 133   hb_position_t height;
 134 } hb_glyph_extents_t;
 135
 136
 137 /* func types */
 138
 139 typedef hb_bool_t (*hb_font_get_glyph_func_t) (hb_font_t *font, void *font_data,
 140                                                hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 141                                                hb_codepoint_t *glyph,
 142                                                void *user_data);
 143
 144
 145 typedef hb_bool_t (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, void *font_data,
 146                                                        hb_codepoint_t glyph,
 147                                                        hb_position_t *x_advance, hb_position_t *y_advance,
 148                                                        void *user_data);
 149 typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_h_advance_func_t;
 150 typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_v_advance_func_t;
 151
 152 typedef hb_bool_t (*hb_font_get_glyph_v_origin_func_t) (hb_font_t *font, void *font_data,
 153                                                         hb_codepoint_t glyph,
 154                                                         hb_position_t *x_origin, hb_position_t *y_origin,
 155                                                         void *user_data);
 156
 157 typedef hb_bool_t (*hb_font_get_kerning_func_t) (hb_font_t *font, void *font_data,
 158                                                  hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
 159                                                  hb_position_t *x_kern, hb_position_t *y_kern,
 160                                                  void *user_data);
 161 typedef hb_font_get_kerning_func_t hb_font_get_h_kerning_func_t;
 162 typedef hb_font_get_kerning_func_t hb_font_get_v_kerning_func_t;
 163
 164
 165 typedef hb_bool_t (*hb_font_get_glyph_extents_func_t) (hb_font_t *font, void *font_data,
 166                                                        hb_codepoint_t glyph,
 167                                                        hb_bool_t *vertical,
 168                                                        hb_glyph_extents_t *extents,
 169                                                        void *user_data);
 170 typedef hb_bool_t (*hb_font_get_contour_point_func_t) (hb_font_t *font, void *font_data,
 171                                                        hb_codepoint_t glyph, unsigned int point_index,
 172                                                        hb_bool_t *vertical,
 173                                                        hb_position_t *x, hb_position_t *y,
 174                                                        void *user_data);
 175
 176
 177 /* func setters */
 178
 179 void
 180 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
 181                               hb_font_get_glyph_func_t glyph_func,
 182                               void *user_data, hb_destroy_func_t destroy);
 183
 184 void
 185 hb_font_funcs_set_glyph_h_advance_func (hb_font_funcs_t *ffuncs,
 186                                         hb_font_get_glyph_h_advance_func_t glyph_advance_func,
 187                                         void *user_data, hb_destroy_func_t destroy);
 188 void
 189 hb_font_funcs_set_glyph_v_advance_func (hb_font_funcs_t *ffuncs,
 190                                         hb_font_get_glyph_v_advance_func_t glyph_advance_func,
 191                                         void *user_data, hb_destroy_func_t destroy);
 192
 193 void
 194 hb_font_funcs_set_glyph_v_origin_func (hb_font_funcs_t *ffuncs,
 195                                        hb_font_get_glyph_v_origin_func_t glyph_advance_func,
 196                                        void *user_data, hb_destroy_func_t destroy);
 197
 198 void
 199 hb_font_funcs_set_h_kerning_func (hb_font_funcs_t *ffuncs,
 200                                   hb_font_get_h_kerning_func_t kerning_func,
 201                                   void *user_data, hb_destroy_func_t destroy);
 202 void
 203 hb_font_funcs_set_v_kerning_func (hb_font_funcs_t *ffuncs,
 204                                   hb_font_get_v_kerning_func_t kerning_func,
 205                                   void *user_data, hb_destroy_func_t destroy);
 206
 207 void
 208 hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
 209                                       hb_font_get_glyph_extents_func_t glyph_extents_func,
 210                                       void *user_data, hb_destroy_func_t destroy);
 211 void
 212 hb_font_funcs_set_contour_point_func (hb_font_funcs_t *ffuncs,
 213                                       hb_font_get_contour_point_func_t contour_point_func,
 214                                       void *user_data, hb_destroy_func_t destroy);
 215
 216
 217 /* func dispatch */
 218
 219 hb_bool_t
 220 hb_font_get_glyph (hb_font_t *font,
 221                    hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 222                    hb_codepoint_t *glyph);
 223
 224 hb_bool_t
 225 hb_font_get_glyph_h_advance (hb_font_t *font,
 226                              hb_codepoint_t glyph,
 227                              hb_position_t *x_advance, hb_position_t *y_advance);
 228 hb_bool_t
 229 hb_font_get_glyph_v_advance (hb_font_t *font,
 230                              hb_codepoint_t glyph,
 231                              hb_position_t *x_advance, hb_position_t *y_advance);
 232
 233 hb_bool_t
 234 hb_font_get_glyph_v_origin (hb_font_t *font,
 235                             hb_codepoint_t glyph,
 236                             hb_position_t *x_kern, hb_position_t *y_kern);
 237
 238 hb_bool_t
 239 hb_font_get_h_kerning (hb_font_t *font,
 240                        hb_codepoint_t left_glyph, hb_codepoint_t right_glyph,
 241                        hb_position_t *x_kern, hb_position_t *y_kern);
 242 hb_bool_t
 243 hb_font_get_v_kerning (hb_font_t *font,
 244                        hb_codepoint_t top_glyph, hb_codepoint_t bottom_glyph,
 245                        hb_position_t *x_kern, hb_position_t *y_kern);
 246
 247 hb_bool_t
 248 hb_font_get_glyph_extents (hb_font_t *font,
 249                            hb_codepoint_t glyph,
 250                            hb_bool_t *vertical,
 251                            hb_glyph_extents_t *extents);
 252
 253 hb_bool_t
 254 hb_font_get_contour_point (hb_font_t *font,
 255                            hb_codepoint_t glyph, unsigned int point_index,
 256                            hb_bool_t *vertical,
 257                            hb_position_t *x, hb_position_t *y);
 258
 259
 260 /* high-level funcs, with fallback */
 261
 262 void
 263 hb_font_get_glyph_advance_for_direction (hb_font_t *font,
 264                                          hb_codepoint_t glyph,
 265                                          hb_direction_t direction,
 266                                          hb_position_t *x_advance, hb_position_t *y_advance);
 267
 268 void
 269 hb_font_get_kerning_for_direction (hb_font_t *font,
 270                                    hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
 271                                    hb_direction_t direction,
 272                                    hb_position_t *x_kern, hb_position_t *y_kern);
 273
 274 void
 275 hb_font_get_glyph_extents_for_direction (hb_font_t *font,
 276                                          hb_codepoint_t glyph,
 277                                          hb_direction_t direction,
 278                                          hb_glyph_extents_t *extents);
 279
 280 hb_bool_t
 281 hb_font_get_contour_point_for_direction (hb_font_t *font,
 282                                          hb_codepoint_t glyph, unsigned int point_index,
 283                                          hb_direction_t direction,
 284                                          hb_position_t *x, hb_position_t *y);
 285
 286
 287 /*
 288  * hb_font_t
 289  */
 290
 291 /* Fonts are very light-weight objects */
 292
 293 hb_font_t *
 294 hb_font_create (hb_face_t *face);
 295
 296 hb_font_t *
 297 hb_font_create_sub_font (hb_font_t *parent);
 298
 299 hb_font_t *
 300 hb_font_get_empty (void);
 301
 302 hb_font_t *
 303 hb_font_reference (hb_font_t *font);
 304
 305 void
 306 hb_font_destroy (hb_font_t *font);
 307
 308 hb_bool_t
 309 hb_font_set_user_data (hb_font_t          *font,
 310                        hb_user_data_key_t *key,
 311                        void *              data,
 312                        hb_destroy_func_t   destroy);
 313
 314
 315 void *
 316 hb_font_get_user_data (hb_font_t          *font,
 317                        hb_user_data_key_t *key);
 318
 319 void
 320 hb_font_make_immutable (hb_font_t *font);
 321
 322 hb_bool_t
 323 hb_font_is_immutable (hb_font_t *font);
 324
 325 hb_font_t *
 326 hb_font_get_parent (hb_font_t *font);
 327
 328 hb_face_t *
 329 hb_font_get_face (hb_font_t *font);
 330
 331
 332 void
 333 hb_font_set_funcs (hb_font_t         *font,
 334                    hb_font_funcs_t   *klass,
 335                    void              *font_data,
 336                    hb_destroy_func_t  destroy);
 337
 338
 339 /*
 340  * We should add support for full matrices.
 341  */
 342 void
 343 hb_font_set_scale (hb_font_t *font,
 344                    int x_scale,
 345                    int y_scale);
 346
 347 void
 348 hb_font_get_scale (hb_font_t *font,
 349                    int *x_scale,
 350                    int *y_scale);
 351
 352 /*
 353  * A zero value means "no hinting in that direction"
 354  */
 355 void
 356 hb_font_set_ppem (hb_font_t *font,
 357                   unsigned int x_ppem,
 358                   unsigned int y_ppem);
 359
 360 void
 361 hb_font_get_ppem (hb_font_t *font,
 362                   unsigned int *x_ppem,
 363                   unsigned int *y_ppem);
 364
 365
 366 HB_END_DECLS
 367
 368 #endif /* HB_FONT_H */