src/hb-font.h

   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 #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                            hb_destroy_func_t    destroy,
  53                            void                *user_data);
  54
  55 hb_face_t *
  56 hb_face_reference (hb_face_t *face);
  57
  58 unsigned int
  59 hb_face_get_reference_count (hb_face_t *face);
  60
  61 void
  62 hb_face_destroy (hb_face_t *face);
  63
  64 /* Returns NULL if not found */
  65 hb_blob_t *
  66 hb_face_get_table (hb_face_t *face,
  67                    hb_tag_t   tag);
  68
  69
  70 /*
  71  * hb_font_funcs_t
  72  */
  73
  74 typedef struct _hb_font_funcs_t hb_font_funcs_t;
  75
  76 hb_font_funcs_t *
  77 hb_font_funcs_create (void);
  78
  79 hb_font_funcs_t *
  80 hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
  81
  82 unsigned int
  83 hb_font_funcs_get_reference_count (hb_font_funcs_t *ffuncs);
  84
  85 void
  86 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
  87
  88 hb_font_funcs_t *
  89 hb_font_funcs_copy (hb_font_funcs_t *ffuncs);
  90
  91 void
  92 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
  93
  94
  95 /* funcs */
  96
  97 typedef struct _hb_glyph_metrics_t
  98 {
  99     hb_position_t x_advance;
 100     hb_position_t y_advance;
 101     hb_position_t x_offset;
 102     hb_position_t y_offset;
 103     hb_position_t width;
 104     hb_position_t height;
 105 } hb_glyph_metrics_t;
 106
 107 typedef hb_codepoint_t (*hb_font_get_glyph_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 108                                                     hb_codepoint_t unicode, hb_codepoint_t variation_selector);
 109 typedef hb_bool_t (*hb_font_get_contour_point_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 110                                                        unsigned int point_index,
 111                                                        hb_codepoint_t glyph, hb_position_t *x, hb_position_t *y);
 112 typedef void (*hb_font_get_glyph_metrics_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 113                                                   hb_codepoint_t glyph, hb_glyph_metrics_t *metrics);
 114 typedef hb_position_t (*hb_font_get_kerning_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 115                                                      hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
 116
 117
 118 void
 119 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
 120                               hb_font_get_glyph_func_t glyph_func);
 121
 122 void
 123 hb_font_funcs_set_contour_point_func (hb_font_funcs_t *ffuncs,
 124                                       hb_font_get_contour_point_func_t contour_point_func);
 125
 126 void
 127 hb_font_funcs_set_glyph_metrics_func (hb_font_funcs_t *ffuncs,
 128                                       hb_font_get_glyph_metrics_func_t glyph_metrics_func);
 129
 130 void
 131 hb_font_funcs_set_kerning_func (hb_font_funcs_t *ffuncs,
 132                                 hb_font_get_kerning_func_t kerning_func);
 133
 134
 135 /* These never return NULL.  Return fallback defaults instead. */
 136
 137 hb_font_get_glyph_func_t
 138 hb_font_funcs_get_glyph_func (hb_font_funcs_t *ffuncs);
 139
 140 hb_font_get_contour_point_func_t
 141 hb_font_funcs_get_contour_point_func (hb_font_funcs_t *ffuncs);
 142
 143 hb_font_get_glyph_metrics_func_t
 144 hb_font_funcs_get_glyph_metrics_func (hb_font_funcs_t *ffuncs);
 145
 146 hb_font_get_kerning_func_t
 147 hb_font_funcs_get_kerning_func (hb_font_funcs_t *ffuncs);
 148
 149
 150 hb_codepoint_t
 151 hb_font_get_glyph (hb_font_t *font, hb_face_t *face,
 152                    hb_codepoint_t unicode, hb_codepoint_t variation_selector);
 153
 154 hb_bool_t
 155 hb_font_get_contour_point (hb_font_t *font, hb_face_t *face,
 156                            unsigned int point_index,
 157                            hb_codepoint_t glyph, hb_position_t *x, hb_position_t *y);
 158
 159 void
 160 hb_font_get_glyph_metrics (hb_font_t *font, hb_face_t *face,
 161                            hb_codepoint_t glyph, hb_glyph_metrics_t *metrics);
 162
 163 hb_position_t
 164 hb_font_get_kerning (hb_font_t *font, hb_face_t *face,
 165                      hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
 166
 167
 168 /*
 169  * hb_font_t
 170  */
 171
 172 /* Fonts are very light-weight objects */
 173
 174 hb_font_t *
 175 hb_font_create (void);
 176
 177 hb_font_t *
 178 hb_font_reference (hb_font_t *font);
 179
 180 unsigned int
 181 hb_font_get_reference_count (hb_font_t *font);
 182
 183 void
 184 hb_font_destroy (hb_font_t *font);
 185
 186 void
 187 hb_font_set_funcs (hb_font_t         *font,
 188                    hb_font_funcs_t   *klass,
 189                    hb_destroy_func_t  destroy,
 190                    void              *user_data);
 191
 192 /* Returns what was set and unsets it, but doesn't destroy(user_data).
 193  * This is useful for wrapping / chaining font_funcs_t's.
 194  *
 195  * The client is responsible for:
 196  *
 197  *   - Take ownership of the reference on the returned klass
 198  *   - Calling "destroy(user_data)" exactly once if returned destroy func
 199  *     is not NULL and the returned info is not needed anymore.
 200  */
 201 void
 202 hb_font_unset_funcs (hb_font_t          *font,
 203                      hb_font_funcs_t   **klass,
 204                      hb_destroy_func_t  *destroy,
 205                      void              **user_data);
 206
 207
 208 /*
 209  * We should add support for full matrices.
 210  */
 211 void
 212 hb_font_set_scale (hb_font_t *font,
 213                    unsigned int x_scale,
 214                    unsigned int y_scale);
 215
 216 void
 217 hb_font_get_scale (hb_font_t *font,
 218                    unsigned int *x_scale,
 219                    unsigned int *y_scale);
 220
 221 /*
 222  * A zero value means "no hinting in that direction"
 223  */
 224 void
 225 hb_font_set_ppem (hb_font_t *font,
 226                   unsigned int x_ppem,
 227                   unsigned int y_ppem);
 228
 229 void
 230 hb_font_get_ppem (hb_font_t *font,
 231                   unsigned int *x_ppem,
 232                   unsigned int *y_ppem);
 233
 234
 235 HB_END_DECLS
 236
 237 #endif /* HB_FONT_H */