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_H_IN
  28 #error "Include <hb.h> instead."
  29 #endif
  30
  31 #ifndef HB_FONT_H
  32 #define HB_FONT_H
  33
  34 #include "hb-common.h"
  35 #include "hb-blob.h"
  36
  37 HB_BEGIN_DECLS
  38
  39
  40 typedef struct _hb_face_t hb_face_t;
  41 typedef struct _hb_font_t hb_font_t;
  42
  43 /*
  44  * hb_face_t
  45  */
  46
  47 hb_face_t *
  48 hb_face_create (hb_blob_t    *blob,
  49                 unsigned int  index);
  50
  51 typedef hb_blob_t * (*hb_reference_table_func_t)  (hb_face_t *face, hb_tag_t tag, void *user_data);
  52
  53 /* calls destroy() when not needing user_data anymore */
  54 hb_face_t *
  55 hb_face_create_for_tables (hb_reference_table_func_t  reference_table,
  56                            void                      *user_data,
  57                            hb_destroy_func_t          destroy);
  58
  59 hb_face_t *
  60 hb_face_get_empty (void);
  61
  62 hb_face_t *
  63 hb_face_reference (hb_face_t *face);
  64
  65 void
  66 hb_face_destroy (hb_face_t *face);
  67
  68 hb_bool_t
  69 hb_face_set_user_data (hb_face_t          *face,
  70                        hb_user_data_key_t *key,
  71                        void *              data,
  72                        hb_destroy_func_t   destroy,
  73                        hb_bool_t           replace);
  74
  75
  76 void *
  77 hb_face_get_user_data (hb_face_t          *face,
  78                        hb_user_data_key_t *key);
  79
  80 void
  81 hb_face_make_immutable (hb_face_t *face);
  82
  83 hb_bool_t
  84 hb_face_is_immutable (hb_face_t *face);
  85
  86
  87 hb_blob_t *
  88 hb_face_reference_table (hb_face_t *face,
  89                          hb_tag_t   tag);
  90
  91 hb_blob_t *
  92 hb_face_reference_blob (hb_face_t *face);
  93
  94 void
  95 hb_face_set_index (hb_face_t    *face,
  96                    unsigned int  index);
  97
  98 unsigned int
  99 hb_face_get_index (hb_face_t    *face);
 100
 101 void
 102 hb_face_set_upem (hb_face_t    *face,
 103                   unsigned int  upem);
 104
 105 unsigned int
 106 hb_face_get_upem (hb_face_t *face);
 107
 108
 109 /*
 110  * hb_font_funcs_t
 111  */
 112
 113 typedef struct _hb_font_funcs_t hb_font_funcs_t;
 114
 115 hb_font_funcs_t *
 116 hb_font_funcs_create (void);
 117
 118 hb_font_funcs_t *
 119 hb_font_funcs_get_empty (void);
 120
 121 hb_font_funcs_t *
 122 hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
 123
 124 void
 125 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
 126
 127 hb_bool_t
 128 hb_font_funcs_set_user_data (hb_font_funcs_t    *ffuncs,
 129                              hb_user_data_key_t *key,
 130                              void *              data,
 131                              hb_destroy_func_t   destroy,
 132                              hb_bool_t           replace);
 133
 134
 135 void *
 136 hb_font_funcs_get_user_data (hb_font_funcs_t    *ffuncs,
 137                              hb_user_data_key_t *key);
 138
 139
 140 void
 141 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
 142
 143 hb_bool_t
 144 hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs);
 145
 146 /* funcs */
 147
 148 typedef struct _hb_glyph_extents_t
 149 {
 150   hb_position_t x_bearing;
 151   hb_position_t y_bearing;
 152   hb_position_t width;
 153   hb_position_t height;
 154 } hb_glyph_extents_t;
 155
 156
 157 /* func types */
 158
 159 typedef hb_bool_t (*hb_font_get_glyph_func_t) (hb_font_t *font, void *font_data,
 160                                                hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 161                                                hb_codepoint_t *glyph,
 162                                                void *user_data);
 163
 164
 165 typedef hb_position_t (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, void *font_data,
 166                                                            hb_codepoint_t glyph,
 167                                                            void *user_data);
 168 typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_h_advance_func_t;
 169 typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_v_advance_func_t;
 170
 171 typedef hb_bool_t (*hb_font_get_glyph_origin_func_t) (hb_font_t *font, void *font_data,
 172                                                       hb_codepoint_t glyph,
 173                                                       hb_position_t *x, hb_position_t *y,
 174                                                       void *user_data);
 175 typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_h_origin_func_t;
 176 typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_v_origin_func_t;
 177
 178 typedef hb_position_t (*hb_font_get_glyph_kerning_func_t) (hb_font_t *font, void *font_data,
 179                                                            hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
 180                                                            void *user_data);
 181 typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_h_kerning_func_t;
 182 typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_v_kerning_func_t;
 183
 184
 185 typedef hb_bool_t (*hb_font_get_glyph_extents_func_t) (hb_font_t *font, void *font_data,
 186                                                        hb_codepoint_t glyph,
 187                                                        hb_glyph_extents_t *extents,
 188                                                        void *user_data);
 189 typedef hb_bool_t (*hb_font_get_glyph_contour_point_func_t) (hb_font_t *font, void *font_data,
 190                                                              hb_codepoint_t glyph, unsigned int point_index,
 191                                                              hb_position_t *x, hb_position_t *y,
 192                                                              void *user_data);
 193
 194
 195 typedef hb_bool_t (*hb_font_get_glyph_name_func_t) (hb_font_t *font, void *font_data,
 196                                                     hb_codepoint_t glyph,
 197                                                     char *name, unsigned int size,
 198                                                     void *user_data);
 199 typedef hb_bool_t (*hb_font_get_glyph_from_name_func_t) (hb_font_t *font, void *font_data,
 200                                                          const char *name, int len, /* -1 means nul-terminated */
 201                                                          hb_codepoint_t *glyph,
 202                                                          void *user_data);
 203
 204
 205 /* func setters */
 206
 207 void
 208 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
 209                               hb_font_get_glyph_func_t glyph_func,
 210                               void *user_data, hb_destroy_func_t destroy);
 211
 212 void
 213 hb_font_funcs_set_glyph_h_advance_func (hb_font_funcs_t *ffuncs,
 214                                         hb_font_get_glyph_h_advance_func_t func,
 215                                         void *user_data, hb_destroy_func_t destroy);
 216 void
 217 hb_font_funcs_set_glyph_v_advance_func (hb_font_funcs_t *ffuncs,
 218                                         hb_font_get_glyph_v_advance_func_t func,
 219                                         void *user_data, hb_destroy_func_t destroy);
 220
 221 void
 222 hb_font_funcs_set_glyph_h_origin_func (hb_font_funcs_t *ffuncs,
 223                                        hb_font_get_glyph_h_origin_func_t func,
 224                                        void *user_data, hb_destroy_func_t destroy);
 225 void
 226 hb_font_funcs_set_glyph_v_origin_func (hb_font_funcs_t *ffuncs,
 227                                        hb_font_get_glyph_v_origin_func_t func,
 228                                        void *user_data, hb_destroy_func_t destroy);
 229
 230 void
 231 hb_font_funcs_set_glyph_h_kerning_func (hb_font_funcs_t *ffuncs,
 232                                         hb_font_get_glyph_h_kerning_func_t func,
 233                                         void *user_data, hb_destroy_func_t destroy);
 234 void
 235 hb_font_funcs_set_glyph_v_kerning_func (hb_font_funcs_t *ffuncs,
 236                                         hb_font_get_glyph_v_kerning_func_t func,
 237                                         void *user_data, hb_destroy_func_t destroy);
 238
 239 void
 240 hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
 241                                       hb_font_get_glyph_extents_func_t func,
 242                                       void *user_data, hb_destroy_func_t destroy);
 243 void
 244 hb_font_funcs_set_glyph_contour_point_func (hb_font_funcs_t *ffuncs,
 245                                             hb_font_get_glyph_contour_point_func_t func,
 246                                             void *user_data, hb_destroy_func_t destroy);
 247
 248 void
 249 hb_font_funcs_set_glyph_name_func (hb_font_funcs_t *ffuncs,
 250                                    hb_font_get_glyph_name_func_t glyph_func,
 251                                    void *user_data, hb_destroy_func_t destroy);
 252 void
 253 hb_font_funcs_set_glyph_from_name_func (hb_font_funcs_t *ffuncs,
 254                                         hb_font_get_glyph_from_name_func_t glyph_func,
 255                                         void *user_data, hb_destroy_func_t destroy);
 256
 257
 258 /* func dispatch */
 259
 260 hb_bool_t
 261 hb_font_get_glyph (hb_font_t *font,
 262                    hb_codepoint_t unicode, hb_codepoint_t variation_selector,
 263                    hb_codepoint_t *glyph);
 264
 265 hb_position_t
 266 hb_font_get_glyph_h_advance (hb_font_t *font,
 267                              hb_codepoint_t glyph);
 268 hb_position_t
 269 hb_font_get_glyph_v_advance (hb_font_t *font,
 270                              hb_codepoint_t glyph);
 271
 272 hb_bool_t
 273 hb_font_get_glyph_h_origin (hb_font_t *font,
 274                             hb_codepoint_t glyph,
 275                             hb_position_t *x, hb_position_t *y);
 276 hb_bool_t
 277 hb_font_get_glyph_v_origin (hb_font_t *font,
 278                             hb_codepoint_t glyph,
 279                             hb_position_t *x, hb_position_t *y);
 280
 281 hb_position_t
 282 hb_font_get_glyph_h_kerning (hb_font_t *font,
 283                              hb_codepoint_t left_glyph, hb_codepoint_t right_glyph);
 284 hb_position_t
 285 hb_font_get_glyph_v_kerning (hb_font_t *font,
 286                              hb_codepoint_t top_glyph, hb_codepoint_t bottom_glyph);
 287
 288 hb_bool_t
 289 hb_font_get_glyph_extents (hb_font_t *font,
 290                            hb_codepoint_t glyph,
 291                            hb_glyph_extents_t *extents);
 292
 293 hb_bool_t
 294 hb_font_get_glyph_contour_point (hb_font_t *font,
 295                                  hb_codepoint_t glyph, unsigned int point_index,
 296                                  hb_position_t *x, hb_position_t *y);
 297
 298 hb_bool_t
 299 hb_font_get_glyph_name (hb_font_t *font,
 300                         hb_codepoint_t glyph,
 301                         char *name, unsigned int size);
 302 hb_bool_t
 303 hb_font_get_glyph_from_name (hb_font_t *font,
 304                              const char *name, int len, /* -1 means nul-terminated */
 305                              hb_codepoint_t *glyph);
 306
 307
 308 /* high-level funcs, with fallback */
 309
 310 void
 311 hb_font_get_glyph_advance_for_direction (hb_font_t *font,
 312                                          hb_codepoint_t glyph,
 313                                          hb_direction_t direction,
 314                                          hb_position_t *x, hb_position_t *y);
 315 void
 316 hb_font_get_glyph_origin_for_direction (hb_font_t *font,
 317                                         hb_codepoint_t glyph,
 318                                         hb_direction_t direction,
 319                                         hb_position_t *x, hb_position_t *y);
 320 void
 321 hb_font_add_glyph_origin_for_direction (hb_font_t *font,
 322                                         hb_codepoint_t glyph,
 323                                         hb_direction_t direction,
 324                                         hb_position_t *x, hb_position_t *y);
 325 void
 326 hb_font_subtract_glyph_origin_for_direction (hb_font_t *font,
 327                                              hb_codepoint_t glyph,
 328                                              hb_direction_t direction,
 329                                              hb_position_t *x, hb_position_t *y);
 330
 331 void
 332 hb_font_get_glyph_kerning_for_direction (hb_font_t *font,
 333                                          hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
 334                                          hb_direction_t direction,
 335                                          hb_position_t *x, hb_position_t *y);
 336
 337 hb_bool_t
 338 hb_font_get_glyph_extents_for_origin (hb_font_t *font,
 339                                       hb_codepoint_t glyph,
 340                                       hb_direction_t direction,
 341                                       hb_glyph_extents_t *extents);
 342
 343 hb_bool_t
 344 hb_font_get_glyph_contour_point_for_origin (hb_font_t *font,
 345                                             hb_codepoint_t glyph, unsigned int point_index,
 346                                             hb_direction_t direction,
 347                                             hb_position_t *x, hb_position_t *y);
 348
 349
 350 /*
 351  * hb_font_t
 352  */
 353
 354 /* Fonts are very light-weight objects */
 355
 356 hb_font_t *
 357 hb_font_create (hb_face_t *face);
 358
 359 hb_font_t *
 360 hb_font_create_sub_font (hb_font_t *parent);
 361
 362 hb_font_t *
 363 hb_font_get_empty (void);
 364
 365 hb_font_t *
 366 hb_font_reference (hb_font_t *font);
 367
 368 void
 369 hb_font_destroy (hb_font_t *font);
 370
 371 hb_bool_t
 372 hb_font_set_user_data (hb_font_t          *font,
 373                        hb_user_data_key_t *key,
 374                        void *              data,
 375                        hb_destroy_func_t   destroy,
 376                        hb_bool_t           replace);
 377
 378
 379 void *
 380 hb_font_get_user_data (hb_font_t          *font,
 381                        hb_user_data_key_t *key);
 382
 383 void
 384 hb_font_make_immutable (hb_font_t *font);
 385
 386 hb_bool_t
 387 hb_font_is_immutable (hb_font_t *font);
 388
 389 hb_font_t *
 390 hb_font_get_parent (hb_font_t *font);
 391
 392 hb_face_t *
 393 hb_font_get_face (hb_font_t *font);
 394
 395
 396 void
 397 hb_font_set_funcs (hb_font_t         *font,
 398                    hb_font_funcs_t   *klass,
 399                    void              *font_data,
 400                    hb_destroy_func_t  destroy);
 401
 402 /* Be *very* careful with this function! */
 403 void
 404 hb_font_set_funcs_data (hb_font_t         *font,
 405                         void              *font_data,
 406                         hb_destroy_func_t  destroy);
 407
 408
 409 void
 410 hb_font_set_scale (hb_font_t *font,
 411                    int x_scale,
 412                    int y_scale);
 413
 414 void
 415 hb_font_get_scale (hb_font_t *font,
 416                    int *x_scale,
 417                    int *y_scale);
 418
 419 /*
 420  * A zero value means "no hinting in that direction"
 421  */
 422 void
 423 hb_font_set_ppem (hb_font_t *font,
 424                   unsigned int x_ppem,
 425                   unsigned int y_ppem);
 426
 427 void
 428 hb_font_get_ppem (hb_font_t *font,
 429                   unsigned int *x_ppem,
 430                   unsigned int *y_ppem);
 431
 432
 433 HB_END_DECLS
 434
 435 #endif /* HB_FONT_H */