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 typedef struct _hb_face_t hb_face_t;
  36 typedef struct _hb_font_t hb_font_t;
  37
  38 /*
  39  * hb_face_t
  40  */
  41
  42 hb_face_t *
  43 hb_face_create_for_data (hb_blob_t    *blob,
  44                          unsigned int  index);
  45
  46 typedef hb_blob_t * (*hb_get_table_func_t)  (hb_tag_t tag, void *user_data);
  47
  48 /* calls destroy() when not needing user_data anymore */
  49 hb_face_t *
  50 hb_face_create_for_tables (hb_get_table_func_t  get_table,
  51                            hb_destroy_func_t    destroy,
  52                            void                *user_data);
  53
  54 hb_face_t *
  55 hb_face_reference (hb_face_t *face);
  56
  57 unsigned int
  58 hb_face_get_reference_count (hb_face_t *face);
  59
  60 void
  61 hb_face_destroy (hb_face_t *face);
  62
  63 hb_blob_t *
  64 hb_face_get_table (hb_face_t *face,
  65                    hb_tag_t   tag);
  66
  67
  68 /*
  69  * hb_font_funcs_t
  70  */
  71
  72 typedef struct _hb_font_funcs_t hb_font_funcs_t;
  73
  74 hb_font_funcs_t *
  75 hb_font_funcs_create (void);
  76
  77 hb_font_funcs_t *
  78 hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
  79
  80 unsigned int
  81 hb_font_funcs_get_reference_count (hb_font_funcs_t *ffuncs);
  82
  83 void
  84 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
  85
  86 hb_font_funcs_t *
  87 hb_font_funcs_copy (hb_font_funcs_t *ffuncs);
  88
  89 void
  90 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
  91
  92
  93 /* funcs */
  94
  95 typedef struct _hb_glyph_metrics_t
  96 {
  97     hb_position_t x_advance;
  98     hb_position_t y_advance;
  99     hb_position_t x_offset;
 100     hb_position_t y_offset;
 101     hb_position_t width;
 102     hb_position_t height;
 103 } hb_glyph_metrics_t;
 104
 105 typedef hb_codepoint_t (*hb_font_get_glyph_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 106                                                     hb_codepoint_t unicode, hb_codepoint_t variation_selector);
 107 typedef hb_bool_t (*hb_font_get_contour_point_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 108                                                        unsigned int point_index,
 109                                                        hb_codepoint_t glyph, hb_position_t *x, hb_position_t *y);
 110 typedef void (*hb_font_get_glyph_metrics_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 111                                                   hb_codepoint_t glyph, hb_glyph_metrics_t *metrics);
 112 typedef hb_position_t (*hb_font_get_kerning_func_t) (hb_font_t *font, hb_face_t *face, const void *user_data,
 113                                                      hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
 114
 115
 116 void
 117 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
 118                               hb_font_get_glyph_func_t glyph_func);
 119
 120 void
 121 hb_font_funcs_set_contour_point_func (hb_font_funcs_t *ffuncs,
 122                                       hb_font_get_contour_point_func_t contour_point_func);
 123
 124 void
 125 hb_font_funcs_set_glyph_metrics_func (hb_font_funcs_t *ffuncs,
 126                                       hb_font_get_glyph_metrics_func_t glyph_metrics_func);
 127
 128 void
 129 hb_font_funcs_set_kerning_func (hb_font_funcs_t *ffuncs,
 130                                 hb_font_get_kerning_func_t kerning_func);
 131
 132
 133 hb_codepoint_t
 134 hb_font_get_glyph (hb_font_t *font, hb_face_t *face,
 135                    hb_codepoint_t unicode, hb_codepoint_t variation_selector);
 136
 137 hb_bool_t
 138 hb_font_get_contour_point (hb_font_t *font, hb_face_t *face,
 139                            unsigned int point_index,
 140                            hb_codepoint_t glyph, hb_position_t *x, hb_position_t *y);
 141
 142 void
 143 hb_font_get_glyph_metrics (hb_font_t *font, hb_face_t *face,
 144                            hb_codepoint_t glyph, hb_glyph_metrics_t *metrics);
 145
 146 hb_position_t
 147 hb_font_get_kerning (hb_font_t *font, hb_face_t *face,
 148                      hb_codepoint_t first_glyph, hb_codepoint_t second_glyph);
 149
 150
 151 /*
 152  * hb_font_t
 153  */
 154
 155 /* Fonts are very light-weight objects */
 156
 157 hb_font_t *
 158 hb_font_create (void);
 159
 160 hb_font_t *
 161 hb_font_reference (hb_font_t *font);
 162
 163 unsigned int
 164 hb_font_get_reference_count (hb_font_t *font);
 165
 166 void
 167 hb_font_destroy (hb_font_t *font);
 168
 169 void
 170 hb_font_set_funcs (hb_font_t         *font,
 171                    hb_font_funcs_t   *klass,
 172                    hb_destroy_func_t  destroy,
 173                    void              *user_data);
 174
 175 hb_font_funcs_t *
 176 hb_font_get_funcs (hb_font_t       *font);
 177
 178
 179 /*
 180  * XXX
 181  * should we decompose this to units_per_EM and font-size?
 182  * units_per_EM setting then can go into the face, or better,
 183  * read from the 'head' table.
 184  *
 185  * Then we either need size+shape like freetype does, or a full
 186  * matrix.
 187  */
 188 void
 189 hb_font_set_scale (hb_font_t *font,
 190                    hb_16dot16_t x_scale,
 191                    hb_16dot16_t y_scale);
 192
 193 /*
 194  * A zero value means "no hinting in that direction"
 195  */
 196 void
 197 hb_font_set_ppem (hb_font_t *font,
 198                   unsigned int x_ppem,
 199                   unsigned int y_ppem);
 200
 201
 202 HB_END_DECLS
 203
 204 #endif /* HB_FONT_H */