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_for_data (hb_blob_t    *blob,
  45                          unsigned int  index);
  46
  47 typedef hb_blob_t * (*hb_get_table_func_t)  (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_reference (hb_face_t *face);
  57
  58 void
  59 hb_face_destroy (hb_face_t *face);
  60
  61 hb_bool_t
  62 hb_face_set_user_data (hb_face_t          *face,
  63                        hb_user_data_key_t *key,
  64                        void *              data,
  65                        hb_destroy_func_t   destroy);
  66
  67
  68 void *
  69 hb_face_get_user_data (hb_face_t          *face,
  70                        hb_user_data_key_t *key);
  71
  72
  73 hb_blob_t *
  74 hb_face_reference_table (hb_face_t *face,
  75                          hb_tag_t   tag);
  76
  77 unsigned int
  78 hb_face_get_upem (hb_face_t *face);
  79
  80
  81 /*
  82  * hb_font_funcs_t
  83  */
  84
  85 typedef struct _hb_font_funcs_t hb_font_funcs_t;
  86
  87 hb_font_funcs_t *
  88 hb_font_funcs_create (void);
  89
  90 hb_font_funcs_t *
  91 hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
  92
  93 void
  94 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
  95
  96 hb_bool_t
  97 hb_font_funcs_set_user_data (hb_font_funcs_t    *ffuncs,
  98                              hb_user_data_key_t *key,
  99                              void *              data,
 100                              hb_destroy_func_t   destroy);
 101
 102
 103 void *
 104 hb_font_funcs_get_user_data (hb_font_funcs_t    *ffuncs,
 105                              hb_user_data_key_t *key);
 106
 107
 108 hb_font_funcs_t *
 109 hb_font_funcs_copy (hb_font_funcs_t *ffuncs);
 110
 111 void
 112 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
 113
 114 hb_bool_t
 115 hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs);
 116
 117 /* funcs */
 118
 119 typedef struct _hb_glyph_extents_t
 120 {
 121     hb_position_t x_bearing;
 122     hb_position_t y_bearing;
 123     hb_position_t width;
 124     hb_position_t height;
 125 } hb_glyph_extents_t;
 126
 127 typedef hb_codepoint_t (*hb_font_get_glyph_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 128                                                     hb_codepoint_t unicode, hb_codepoint_t variation_selector);
 129 typedef void (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 130                                                   hb_codepoint_t glyph,
 131                                                   hb_position_t *x_advance, hb_position_t *y_advance);
 132 typedef void (*hb_font_get_glyph_extents_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 133                                                   hb_codepoint_t glyph,
 134                                                   hb_glyph_extents_t *extents);
 135 typedef hb_bool_t (*hb_font_get_contour_point_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 136                                                        unsigned int point_index, hb_codepoint_t glyph,
 137                                                        hb_position_t *x, hb_position_t *y);
 138 typedef hb_position_t (*hb_font_get_kerning_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 139                                                      hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
 140
 141
 142 void
 143 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
 144                               hb_font_get_glyph_func_t glyph_func);
 145
 146 void
 147 hb_font_funcs_set_glyph_advance_func (hb_font_funcs_t *ffuncs,
 148                                       hb_font_get_glyph_advance_func_t glyph_advance_func);
 149
 150 void
 151 hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
 152                                       hb_font_get_glyph_extents_func_t glyph_extents_func);
 153
 154 void
 155 hb_font_funcs_set_contour_point_func (hb_font_funcs_t *ffuncs,
 156                                       hb_font_get_contour_point_func_t contour_point_func);
 157
 158 void
 159 hb_font_funcs_set_kerning_func (hb_font_funcs_t *ffuncs,
 160                                 hb_font_get_kerning_func_t kerning_func);
 161
 162
 163 /* These never return NULL.  Return fallback defaults instead. */
 164
 165 hb_font_get_glyph_func_t
 166 hb_font_funcs_get_glyph_func (hb_font_funcs_t *ffuncs);
 167
 168 hb_font_get_glyph_advance_func_t
 169 hb_font_funcs_get_glyph_advance_func (hb_font_funcs_t *ffuncs);
 170
 171 hb_font_get_glyph_extents_func_t
 172 hb_font_funcs_get_glyph_extents_func (hb_font_funcs_t *ffuncs);
 173
 174 hb_font_get_contour_point_func_t
 175 hb_font_funcs_get_contour_point_func (hb_font_funcs_t *ffuncs);
 176
 177 hb_font_get_kerning_func_t
 178 hb_font_funcs_get_kerning_func (hb_font_funcs_t *ffuncs);
 179
 180
 181 hb_codepoint_t
 182 hb_font_get_glyph (hb_font_t *font, hb_face_t *face,
 183                    hb_codepoint_t unicode, hb_codepoint_t variation_selector);
 184
 185 void
 186 hb_font_get_glyph_advance (hb_font_t *font, hb_face_t *face,
 187                            hb_codepoint_t glyph,
 188                            hb_position_t *x_advance, hb_position_t *y_advance);
 189
 190 void
 191 hb_font_get_glyph_extents (hb_font_t *font, hb_face_t *face,
 192                            hb_codepoint_t glyph,
 193                            hb_glyph_extents_t *extents);
 194
 195 hb_bool_t
 196 hb_font_get_contour_point (hb_font_t *font, hb_face_t *face,
 197                            unsigned int point_index, hb_codepoint_t glyph,
 198                            hb_position_t *x, hb_position_t *y);
 199
 200 hb_position_t
 201 hb_font_get_kerning (hb_font_t *font, hb_face_t *face,
 202                      hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
 203
 204
 205 /*
 206  * hb_font_t
 207  */
 208
 209 /* Fonts are very light-weight objects */
 210
 211 hb_font_t *
 212 hb_font_create (void);
 213
 214 hb_font_t *
 215 hb_font_reference (hb_font_t *font);
 216
 217 void
 218 hb_font_destroy (hb_font_t *font);
 219
 220 hb_bool_t
 221 hb_font_set_user_data (hb_font_t          *font,
 222                        hb_user_data_key_t *key,
 223                        void *              data,
 224                        hb_destroy_func_t   destroy);
 225
 226
 227 void *
 228 hb_font_get_user_data (hb_font_t          *font,
 229                        hb_user_data_key_t *key);
 230
 231
 232 void
 233 hb_font_set_funcs (hb_font_t         *font,
 234                    hb_font_funcs_t   *klass,
 235                    void              *user_data,
 236                    hb_destroy_func_t  destroy);
 237
 238 /* Returns what was set and unsets it, but doesn't destroy(user_data).
 239  * This is useful for wrapping / chaining font_funcs_t's.
 240  *
 241  * The client is responsible for:
 242  *
 243  *   - Take ownership of the reference on the returned klass,
 244  *
 245  *   - Calling "destroy(user_data)" exactly once if returned destroy func
 246  *     is not NULL and the returned info is not needed anymore.
 247  */
 248 void
 249 hb_font_unset_funcs (hb_font_t          *font,
 250                      hb_font_funcs_t   **klass,
 251                      void              **user_data,
 252                      hb_destroy_func_t  *destroy);
 253
 254
 255 /*
 256  * We should add support for full matrices.
 257  */
 258 void
 259 hb_font_set_scale (hb_font_t *font,
 260                    int x_scale,
 261                    int y_scale);
 262
 263 void
 264 hb_font_get_scale (hb_font_t *font,
 265                    int *x_scale,
 266                    int *y_scale);
 267
 268 /*
 269  * A zero value means "no hinting in that direction"
 270  */
 271 void
 272 hb_font_set_ppem (hb_font_t *font,
 273                   unsigned int x_ppem,
 274                   unsigned int y_ppem);
 275
 276 void
 277 hb_font_get_ppem (hb_font_t *font,
 278                   unsigned int *x_ppem,
 279                   unsigned int *y_ppem);
 280
 281
 282 HB_END_DECLS
 283
 284 #endif /* HB_FONT_H */