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 typedef hb_bool_t (*hb_font_get_contour_point_func_t) (hb_font_t *font, void *font_data,
 138                                                        hb_codepoint_t glyph, unsigned int point_index,
 139                                                        hb_position_t *x, hb_position_t *y,
 140                                                        void *user_data);
 141 typedef void (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, void *font_data,
 142                                                   hb_codepoint_t glyph,
 143                                                   hb_position_t *x_advance, hb_position_t *y_advance,
 144                                                   void *user_data);
 145 typedef void (*hb_font_get_glyph_extents_func_t) (hb_font_t *font, void *font_data,
 146                                                   hb_codepoint_t glyph,
 147                                                   hb_glyph_extents_t *extents,
 148                                                   void *user_data);
 149 typedef hb_bool_t (*hb_font_get_glyph_func_t) (hb_font_t *font, void *font_data,
 150                                                hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 151                                                hb_codepoint_t *glyph,
 152                                                void *user_data);
 153 typedef void (*hb_font_get_kerning_func_t) (hb_font_t *font, void *font_data,
 154                                             hb_codepoint_t left_glyph, hb_codepoint_t right_glyph,
 155                                             hb_position_t *x_kern, hb_position_t *y_kern,
 156                                             void *user_data);
 157
 158
 159 void
 160 hb_font_funcs_set_contour_point_func (hb_font_funcs_t *ffuncs,
 161                                       hb_font_get_contour_point_func_t contour_point_func,
 162                                       void *user_data, hb_destroy_func_t destroy);
 163
 164 void
 165 hb_font_funcs_set_glyph_advance_func (hb_font_funcs_t *ffuncs,
 166                                       hb_font_get_glyph_advance_func_t glyph_advance_func,
 167                                       void *user_data, hb_destroy_func_t destroy);
 168
 169 void
 170 hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
 171                                       hb_font_get_glyph_extents_func_t glyph_extents_func,
 172                                       void *user_data, hb_destroy_func_t destroy);
 173
 174 void
 175 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
 176                               hb_font_get_glyph_func_t glyph_func,
 177                               void *user_data, hb_destroy_func_t destroy);
 178
 179 void
 180 hb_font_funcs_set_kerning_func (hb_font_funcs_t *ffuncs,
 181                                 hb_font_get_kerning_func_t kerning_func,
 182                                 void *user_data, hb_destroy_func_t destroy);
 183
 184
 185 hb_bool_t
 186 hb_font_get_contour_point (hb_font_t *font,
 187                            hb_codepoint_t glyph, unsigned int point_index,
 188                            hb_position_t *x, hb_position_t *y);
 189
 190 void
 191 hb_font_get_glyph_advance (hb_font_t *font,
 192                            hb_codepoint_t glyph,
 193                            hb_position_t *x_advance, hb_position_t *y_advance);
 194
 195 void
 196 hb_font_get_glyph_extents (hb_font_t *font,
 197                            hb_codepoint_t glyph,
 198                            hb_glyph_extents_t *extents);
 199
 200 hb_bool_t
 201 hb_font_get_glyph (hb_font_t *font,
 202                    hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 203                    hb_codepoint_t *glyph);
 204
 205 void
 206 hb_font_get_kerning (hb_font_t *font,
 207                      hb_codepoint_t left_glyph, hb_codepoint_t right_glyph,
 208                      hb_position_t *x_kern, hb_position_t *y_kern);
 209
 210
 211 /*
 212  * hb_font_t
 213  */
 214
 215 /* Fonts are very light-weight objects */
 216
 217 hb_font_t *
 218 hb_font_create (hb_face_t *face);
 219
 220 hb_font_t *
 221 hb_font_create_sub_font (hb_font_t *parent);
 222
 223 hb_font_t *
 224 hb_font_get_empty (void);
 225
 226 hb_font_t *
 227 hb_font_reference (hb_font_t *font);
 228
 229 void
 230 hb_font_destroy (hb_font_t *font);
 231
 232 hb_bool_t
 233 hb_font_set_user_data (hb_font_t          *font,
 234                        hb_user_data_key_t *key,
 235                        void *              data,
 236                        hb_destroy_func_t   destroy);
 237
 238
 239 void *
 240 hb_font_get_user_data (hb_font_t          *font,
 241                        hb_user_data_key_t *key);
 242
 243 void
 244 hb_font_make_immutable (hb_font_t *font);
 245
 246 hb_bool_t
 247 hb_font_is_immutable (hb_font_t *font);
 248
 249 hb_font_t *
 250 hb_font_get_parent (hb_font_t *font);
 251
 252 hb_face_t *
 253 hb_font_get_face (hb_font_t *font);
 254
 255
 256 void
 257 hb_font_set_funcs (hb_font_t         *font,
 258                    hb_font_funcs_t   *klass,
 259                    void              *font_data,
 260                    hb_destroy_func_t  destroy);
 261
 262
 263 /*
 264  * We should add support for full matrices.
 265  */
 266 void
 267 hb_font_set_scale (hb_font_t *font,
 268                    int x_scale,
 269                    int y_scale);
 270
 271 void
 272 hb_font_get_scale (hb_font_t *font,
 273                    int *x_scale,
 274                    int *y_scale);
 275
 276 /*
 277  * A zero value means "no hinting in that direction"
 278  */
 279 void
 280 hb_font_set_ppem (hb_font_t *font,
 281                   unsigned int x_ppem,
 282                   unsigned int y_ppem);
 283
 284 void
 285 hb_font_get_ppem (hb_font_t *font,
 286                   unsigned int *x_ppem,
 287                   unsigned int *y_ppem);
 288
 289
 290 HB_END_DECLS
 291
 292 #endif /* HB_FONT_H */