The Tor Browser / annotate

gfx/harfbuzz/src/hb-font.h@925c144e1f1f (annotated)

gfx/harfbuzz/src/hb-font.h

Fri, 16 Jan 2015 18:13:44 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 16 Jan 2015 18:13:44 +0100
branch
TOR_BUG_9701
changeset 14
925c144e1f1f
permissions
-rw-r--r--

Integrate suggestion from review to improve consistency with existing code.

michael@0 1 /*
michael@0 2 * Copyright © 2009 Red Hat, Inc.
michael@0 3 *
michael@0 4 * This is part of HarfBuzz, a text shaping library.
michael@0 5 *
michael@0 6 * Permission is hereby granted, without written agreement and without
michael@0 7 * license or royalty fees, to use, copy, modify, and distribute this
michael@0 8 * software and its documentation for any purpose, provided that the
michael@0 9 * above copyright notice and the following two paragraphs appear in
michael@0 10 * all copies of this software.
michael@0 11 *
michael@0 12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
michael@0 13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
michael@0 14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
michael@0 15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
michael@0 16 * DAMAGE.
michael@0 17 *
michael@0 18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
michael@0 19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
michael@0 20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
michael@0 21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
michael@0 22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
michael@0 23 *
michael@0 24 * Red Hat Author(s): Behdad Esfahbod
michael@0 25 */
michael@0 26
michael@0 27 #ifndef HB_H_IN
michael@0 28 #error "Include <hb.h> instead."
michael@0 29 #endif
michael@0 30
michael@0 31 #ifndef HB_FONT_H
michael@0 32 #define HB_FONT_H
michael@0 33
michael@0 34 #include "hb-common.h"
michael@0 35 #include "hb-face.h"
michael@0 36
michael@0 37 HB_BEGIN_DECLS
michael@0 38
michael@0 39
michael@0 40 typedef struct hb_font_t hb_font_t;
michael@0 41
michael@0 42
michael@0 43 /*
michael@0 44 * hb_font_funcs_t
michael@0 45 */
michael@0 46
michael@0 47 typedef struct hb_font_funcs_t hb_font_funcs_t;
michael@0 48
michael@0 49 hb_font_funcs_t *
michael@0 50 hb_font_funcs_create (void);
michael@0 51
michael@0 52 hb_font_funcs_t *
michael@0 53 hb_font_funcs_get_empty (void);
michael@0 54
michael@0 55 hb_font_funcs_t *
michael@0 56 hb_font_funcs_reference (hb_font_funcs_t *ffuncs);
michael@0 57
michael@0 58 void
michael@0 59 hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);
michael@0 60
michael@0 61 hb_bool_t
michael@0 62 hb_font_funcs_set_user_data (hb_font_funcs_t *ffuncs,
michael@0 63 hb_user_data_key_t *key,
michael@0 64 void * data,
michael@0 65 hb_destroy_func_t destroy,
michael@0 66 hb_bool_t replace);
michael@0 67
michael@0 68
michael@0 69 void *
michael@0 70 hb_font_funcs_get_user_data (hb_font_funcs_t *ffuncs,
michael@0 71 hb_user_data_key_t *key);
michael@0 72
michael@0 73
michael@0 74 void
michael@0 75 hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);
michael@0 76
michael@0 77 hb_bool_t
michael@0 78 hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs);
michael@0 79
michael@0 80
michael@0 81 /* glyph extents */
michael@0 82
michael@0 83 typedef struct hb_glyph_extents_t
michael@0 84 {
michael@0 85 hb_position_t x_bearing;
michael@0 86 hb_position_t y_bearing;
michael@0 87 hb_position_t width;
michael@0 88 hb_position_t height;
michael@0 89 } hb_glyph_extents_t;
michael@0 90
michael@0 91
michael@0 92 /* func types */
michael@0 93
michael@0 94 typedef hb_bool_t (*hb_font_get_glyph_func_t) (hb_font_t *font, void *font_data,
michael@0 95 hb_codepoint_t unicode, hb_codepoint_t variation_selector,
michael@0 96 hb_codepoint_t *glyph,
michael@0 97 void *user_data);
michael@0 98
michael@0 99
michael@0 100 typedef hb_position_t (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, void *font_data,
michael@0 101 hb_codepoint_t glyph,
michael@0 102 void *user_data);
michael@0 103 typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_h_advance_func_t;
michael@0 104 typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_v_advance_func_t;
michael@0 105
michael@0 106 typedef hb_bool_t (*hb_font_get_glyph_origin_func_t) (hb_font_t *font, void *font_data,
michael@0 107 hb_codepoint_t glyph,
michael@0 108 hb_position_t *x, hb_position_t *y,
michael@0 109 void *user_data);
michael@0 110 typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_h_origin_func_t;
michael@0 111 typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_v_origin_func_t;
michael@0 112
michael@0 113 typedef hb_position_t (*hb_font_get_glyph_kerning_func_t) (hb_font_t *font, void *font_data,
michael@0 114 hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
michael@0 115 void *user_data);
michael@0 116 typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_h_kerning_func_t;
michael@0 117 typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_v_kerning_func_t;
michael@0 118
michael@0 119
michael@0 120 typedef hb_bool_t (*hb_font_get_glyph_extents_func_t) (hb_font_t *font, void *font_data,
michael@0 121 hb_codepoint_t glyph,
michael@0 122 hb_glyph_extents_t *extents,
michael@0 123 void *user_data);
michael@0 124 typedef hb_bool_t (*hb_font_get_glyph_contour_point_func_t) (hb_font_t *font, void *font_data,
michael@0 125 hb_codepoint_t glyph, unsigned int point_index,
michael@0 126 hb_position_t *x, hb_position_t *y,
michael@0 127 void *user_data);
michael@0 128
michael@0 129
michael@0 130 typedef hb_bool_t (*hb_font_get_glyph_name_func_t) (hb_font_t *font, void *font_data,
michael@0 131 hb_codepoint_t glyph,
michael@0 132 char *name, unsigned int size,
michael@0 133 void *user_data);
michael@0 134 typedef hb_bool_t (*hb_font_get_glyph_from_name_func_t) (hb_font_t *font, void *font_data,
michael@0 135 const char *name, int len, /* -1 means nul-terminated */
michael@0 136 hb_codepoint_t *glyph,
michael@0 137 void *user_data);
michael@0 138
michael@0 139
michael@0 140 /* func setters */
michael@0 141
michael@0 142 /**
michael@0 143 * hb_font_funcs_set_glyph_func:
michael@0 144 * @ffuncs: font functions.
michael@0 145 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 146 * @user_data:
michael@0 147 * @destroy:
michael@0 148 *
michael@0 149 *
michael@0 150 *
michael@0 151 * Since: 1.0
michael@0 152 **/
michael@0 153 void
michael@0 154 hb_font_funcs_set_glyph_func (hb_font_funcs_t *ffuncs,
michael@0 155 hb_font_get_glyph_func_t func,
michael@0 156 void *user_data, hb_destroy_func_t destroy);
michael@0 157
michael@0 158 /**
michael@0 159 * hb_font_funcs_set_glyph_h_advance_func:
michael@0 160 * @ffuncs: font functions.
michael@0 161 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 162 * @user_data:
michael@0 163 * @destroy:
michael@0 164 *
michael@0 165 *
michael@0 166 *
michael@0 167 * Since: 1.0
michael@0 168 **/
michael@0 169 void
michael@0 170 hb_font_funcs_set_glyph_h_advance_func (hb_font_funcs_t *ffuncs,
michael@0 171 hb_font_get_glyph_h_advance_func_t func,
michael@0 172 void *user_data, hb_destroy_func_t destroy);
michael@0 173
michael@0 174 /**
michael@0 175 * hb_font_funcs_set_glyph_v_advance_func:
michael@0 176 * @ffuncs: font functions.
michael@0 177 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 178 * @user_data:
michael@0 179 * @destroy:
michael@0 180 *
michael@0 181 *
michael@0 182 *
michael@0 183 * Since: 1.0
michael@0 184 **/
michael@0 185 void
michael@0 186 hb_font_funcs_set_glyph_v_advance_func (hb_font_funcs_t *ffuncs,
michael@0 187 hb_font_get_glyph_v_advance_func_t func,
michael@0 188 void *user_data, hb_destroy_func_t destroy);
michael@0 189
michael@0 190 /**
michael@0 191 * hb_font_funcs_set_glyph_h_origin_func:
michael@0 192 * @ffuncs: font functions.
michael@0 193 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 194 * @user_data:
michael@0 195 * @destroy:
michael@0 196 *
michael@0 197 *
michael@0 198 *
michael@0 199 * Since: 1.0
michael@0 200 **/
michael@0 201 void
michael@0 202 hb_font_funcs_set_glyph_h_origin_func (hb_font_funcs_t *ffuncs,
michael@0 203 hb_font_get_glyph_h_origin_func_t func,
michael@0 204 void *user_data, hb_destroy_func_t destroy);
michael@0 205
michael@0 206 /**
michael@0 207 * hb_font_funcs_set_glyph_v_origin_func:
michael@0 208 * @ffuncs: font functions.
michael@0 209 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 210 * @user_data:
michael@0 211 * @destroy:
michael@0 212 *
michael@0 213 *
michael@0 214 *
michael@0 215 * Since: 1.0
michael@0 216 **/
michael@0 217 void
michael@0 218 hb_font_funcs_set_glyph_v_origin_func (hb_font_funcs_t *ffuncs,
michael@0 219 hb_font_get_glyph_v_origin_func_t func,
michael@0 220 void *user_data, hb_destroy_func_t destroy);
michael@0 221
michael@0 222 /**
michael@0 223 * hb_font_funcs_set_glyph_h_kerning_func:
michael@0 224 * @ffuncs: font functions.
michael@0 225 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 226 * @user_data:
michael@0 227 * @destroy:
michael@0 228 *
michael@0 229 *
michael@0 230 *
michael@0 231 * Since: 1.0
michael@0 232 **/
michael@0 233 void
michael@0 234 hb_font_funcs_set_glyph_h_kerning_func (hb_font_funcs_t *ffuncs,
michael@0 235 hb_font_get_glyph_h_kerning_func_t func,
michael@0 236 void *user_data, hb_destroy_func_t destroy);
michael@0 237
michael@0 238 /**
michael@0 239 * hb_font_funcs_set_glyph_v_kerning_func:
michael@0 240 * @ffuncs: font functions.
michael@0 241 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 242 * @user_data:
michael@0 243 * @destroy:
michael@0 244 *
michael@0 245 *
michael@0 246 *
michael@0 247 * Since: 1.0
michael@0 248 **/
michael@0 249 void
michael@0 250 hb_font_funcs_set_glyph_v_kerning_func (hb_font_funcs_t *ffuncs,
michael@0 251 hb_font_get_glyph_v_kerning_func_t func,
michael@0 252 void *user_data, hb_destroy_func_t destroy);
michael@0 253
michael@0 254 /**
michael@0 255 * hb_font_funcs_set_glyph_extents_func:
michael@0 256 * @ffuncs: font functions.
michael@0 257 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 258 * @user_data:
michael@0 259 * @destroy:
michael@0 260 *
michael@0 261 *
michael@0 262 *
michael@0 263 * Since: 1.0
michael@0 264 **/
michael@0 265 void
michael@0 266 hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
michael@0 267 hb_font_get_glyph_extents_func_t func,
michael@0 268 void *user_data, hb_destroy_func_t destroy);
michael@0 269
michael@0 270 /**
michael@0 271 * hb_font_funcs_set_glyph_contour_point_func:
michael@0 272 * @ffuncs: font functions.
michael@0 273 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 274 * @user_data:
michael@0 275 * @destroy:
michael@0 276 *
michael@0 277 *
michael@0 278 *
michael@0 279 * Since: 1.0
michael@0 280 **/
michael@0 281 void
michael@0 282 hb_font_funcs_set_glyph_contour_point_func (hb_font_funcs_t *ffuncs,
michael@0 283 hb_font_get_glyph_contour_point_func_t func,
michael@0 284 void *user_data, hb_destroy_func_t destroy);
michael@0 285
michael@0 286 /**
michael@0 287 * hb_font_funcs_set_glyph_name_func:
michael@0 288 * @ffuncs: font functions.
michael@0 289 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 290 * @user_data:
michael@0 291 * @destroy:
michael@0 292 *
michael@0 293 *
michael@0 294 *
michael@0 295 * Since: 1.0
michael@0 296 **/
michael@0 297 void
michael@0 298 hb_font_funcs_set_glyph_name_func (hb_font_funcs_t *ffuncs,
michael@0 299 hb_font_get_glyph_name_func_t func,
michael@0 300 void *user_data, hb_destroy_func_t destroy);
michael@0 301
michael@0 302 /**
michael@0 303 * hb_font_funcs_set_glyph_from_name_func:
michael@0 304 * @ffuncs: font functions.
michael@0 305 * @func: (closure user_data) (destroy destroy) (scope notified):
michael@0 306 * @user_data:
michael@0 307 * @destroy:
michael@0 308 *
michael@0 309 *
michael@0 310 *
michael@0 311 * Since: 1.0
michael@0 312 **/
michael@0 313 void
michael@0 314 hb_font_funcs_set_glyph_from_name_func (hb_font_funcs_t *ffuncs,
michael@0 315 hb_font_get_glyph_from_name_func_t func,
michael@0 316 void *user_data, hb_destroy_func_t destroy);
michael@0 317
michael@0 318
michael@0 319 /* func dispatch */
michael@0 320
michael@0 321 hb_bool_t
michael@0 322 hb_font_get_glyph (hb_font_t *font,
michael@0 323 hb_codepoint_t unicode, hb_codepoint_t variation_selector,
michael@0 324 hb_codepoint_t *glyph);
michael@0 325
michael@0 326 hb_position_t
michael@0 327 hb_font_get_glyph_h_advance (hb_font_t *font,
michael@0 328 hb_codepoint_t glyph);
michael@0 329 hb_position_t
michael@0 330 hb_font_get_glyph_v_advance (hb_font_t *font,
michael@0 331 hb_codepoint_t glyph);
michael@0 332
michael@0 333 hb_bool_t
michael@0 334 hb_font_get_glyph_h_origin (hb_font_t *font,
michael@0 335 hb_codepoint_t glyph,
michael@0 336 hb_position_t *x, hb_position_t *y);
michael@0 337 hb_bool_t
michael@0 338 hb_font_get_glyph_v_origin (hb_font_t *font,
michael@0 339 hb_codepoint_t glyph,
michael@0 340 hb_position_t *x, hb_position_t *y);
michael@0 341
michael@0 342 hb_position_t
michael@0 343 hb_font_get_glyph_h_kerning (hb_font_t *font,
michael@0 344 hb_codepoint_t left_glyph, hb_codepoint_t right_glyph);
michael@0 345 hb_position_t
michael@0 346 hb_font_get_glyph_v_kerning (hb_font_t *font,
michael@0 347 hb_codepoint_t top_glyph, hb_codepoint_t bottom_glyph);
michael@0 348
michael@0 349 hb_bool_t
michael@0 350 hb_font_get_glyph_extents (hb_font_t *font,
michael@0 351 hb_codepoint_t glyph,
michael@0 352 hb_glyph_extents_t *extents);
michael@0 353
michael@0 354 hb_bool_t
michael@0 355 hb_font_get_glyph_contour_point (hb_font_t *font,
michael@0 356 hb_codepoint_t glyph, unsigned int point_index,
michael@0 357 hb_position_t *x, hb_position_t *y);
michael@0 358
michael@0 359 hb_bool_t
michael@0 360 hb_font_get_glyph_name (hb_font_t *font,
michael@0 361 hb_codepoint_t glyph,
michael@0 362 char *name, unsigned int size);
michael@0 363 hb_bool_t
michael@0 364 hb_font_get_glyph_from_name (hb_font_t *font,
michael@0 365 const char *name, int len, /* -1 means nul-terminated */
michael@0 366 hb_codepoint_t *glyph);
michael@0 367
michael@0 368
michael@0 369 /* high-level funcs, with fallback */
michael@0 370
michael@0 371 void
michael@0 372 hb_font_get_glyph_advance_for_direction (hb_font_t *font,
michael@0 373 hb_codepoint_t glyph,
michael@0 374 hb_direction_t direction,
michael@0 375 hb_position_t *x, hb_position_t *y);
michael@0 376 void
michael@0 377 hb_font_get_glyph_origin_for_direction (hb_font_t *font,
michael@0 378 hb_codepoint_t glyph,
michael@0 379 hb_direction_t direction,
michael@0 380 hb_position_t *x, hb_position_t *y);
michael@0 381 void
michael@0 382 hb_font_add_glyph_origin_for_direction (hb_font_t *font,
michael@0 383 hb_codepoint_t glyph,
michael@0 384 hb_direction_t direction,
michael@0 385 hb_position_t *x, hb_position_t *y);
michael@0 386 void
michael@0 387 hb_font_subtract_glyph_origin_for_direction (hb_font_t *font,
michael@0 388 hb_codepoint_t glyph,
michael@0 389 hb_direction_t direction,
michael@0 390 hb_position_t *x, hb_position_t *y);
michael@0 391
michael@0 392 void
michael@0 393 hb_font_get_glyph_kerning_for_direction (hb_font_t *font,
michael@0 394 hb_codepoint_t first_glyph, hb_codepoint_t second_glyph,
michael@0 395 hb_direction_t direction,
michael@0 396 hb_position_t *x, hb_position_t *y);
michael@0 397
michael@0 398 hb_bool_t
michael@0 399 hb_font_get_glyph_extents_for_origin (hb_font_t *font,
michael@0 400 hb_codepoint_t glyph,
michael@0 401 hb_direction_t direction,
michael@0 402 hb_glyph_extents_t *extents);
michael@0 403
michael@0 404 hb_bool_t
michael@0 405 hb_font_get_glyph_contour_point_for_origin (hb_font_t *font,
michael@0 406 hb_codepoint_t glyph, unsigned int point_index,
michael@0 407 hb_direction_t direction,
michael@0 408 hb_position_t *x, hb_position_t *y);
michael@0 409
michael@0 410 /* Generates gidDDD if glyph has no name. */
michael@0 411 void
michael@0 412 hb_font_glyph_to_string (hb_font_t *font,
michael@0 413 hb_codepoint_t glyph,
michael@0 414 char *s, unsigned int size);
michael@0 415 /* Parses gidDDD and uniUUUU strings automatically. */
michael@0 416 hb_bool_t
michael@0 417 hb_font_glyph_from_string (hb_font_t *font,
michael@0 418 const char *s, int len, /* -1 means nul-terminated */
michael@0 419 hb_codepoint_t *glyph);
michael@0 420
michael@0 421
michael@0 422 /*
michael@0 423 * hb_font_t
michael@0 424 */
michael@0 425
michael@0 426 /* Fonts are very light-weight objects */
michael@0 427
michael@0 428 hb_font_t *
michael@0 429 hb_font_create (hb_face_t *face);
michael@0 430
michael@0 431 hb_font_t *
michael@0 432 hb_font_create_sub_font (hb_font_t *parent);
michael@0 433
michael@0 434 hb_font_t *
michael@0 435 hb_font_get_empty (void);
michael@0 436
michael@0 437 hb_font_t *
michael@0 438 hb_font_reference (hb_font_t *font);
michael@0 439
michael@0 440 void
michael@0 441 hb_font_destroy (hb_font_t *font);
michael@0 442
michael@0 443 hb_bool_t
michael@0 444 hb_font_set_user_data (hb_font_t *font,
michael@0 445 hb_user_data_key_t *key,
michael@0 446 void * data,
michael@0 447 hb_destroy_func_t destroy,
michael@0 448 hb_bool_t replace);
michael@0 449
michael@0 450
michael@0 451 void *
michael@0 452 hb_font_get_user_data (hb_font_t *font,
michael@0 453 hb_user_data_key_t *key);
michael@0 454
michael@0 455 void
michael@0 456 hb_font_make_immutable (hb_font_t *font);
michael@0 457
michael@0 458 hb_bool_t
michael@0 459 hb_font_is_immutable (hb_font_t *font);
michael@0 460
michael@0 461 hb_font_t *
michael@0 462 hb_font_get_parent (hb_font_t *font);
michael@0 463
michael@0 464 hb_face_t *
michael@0 465 hb_font_get_face (hb_font_t *font);
michael@0 466
michael@0 467
michael@0 468 void
michael@0 469 hb_font_set_funcs (hb_font_t *font,
michael@0 470 hb_font_funcs_t *klass,
michael@0 471 void *font_data,
michael@0 472 hb_destroy_func_t destroy);
michael@0 473
michael@0 474 /* Be *very* careful with this function! */
michael@0 475 void
michael@0 476 hb_font_set_funcs_data (hb_font_t *font,
michael@0 477 void *font_data,
michael@0 478 hb_destroy_func_t destroy);
michael@0 479
michael@0 480
michael@0 481 void
michael@0 482 hb_font_set_scale (hb_font_t *font,
michael@0 483 int x_scale,
michael@0 484 int y_scale);
michael@0 485
michael@0 486 void
michael@0 487 hb_font_get_scale (hb_font_t *font,
michael@0 488 int *x_scale,
michael@0 489 int *y_scale);
michael@0 490
michael@0 491 /*
michael@0 492 * A zero value means "no hinting in that direction"
michael@0 493 */
michael@0 494 void
michael@0 495 hb_font_set_ppem (hb_font_t *font,
michael@0 496 unsigned int x_ppem,
michael@0 497 unsigned int y_ppem);
michael@0 498
michael@0 499 void
michael@0 500 hb_font_get_ppem (hb_font_t *font,
michael@0 501 unsigned int *x_ppem,
michael@0 502 unsigned int *y_ppem);
michael@0 503
michael@0 504
michael@0 505 HB_END_DECLS
michael@0 506
michael@0 507 #endif /* HB_FONT_H */

Mercurial Repository: The Tor Browser

Europalab SCM Repository Server

mercurial