kc3-lang/freetype/include/internal/sfnt.h
-
Show log
Commit
-
Hash : fae38207
Author :
Date : 2013-11-13T08:55:46
Simplify header file hierarchy. This large patch changes the header file directory layout from `include/freetype/...' to `include/...', effectively removing one level. Since the file `ft2build.h' is also located in `include' (and it stays there even after installation), all FreeType header files are now in a single directory. Applications that use (a) `freetype-config' or FreeType's `pkg-config' file to get the include directory for the compiler, and (b) the documented way for header inclusion like #include <ft2build.h> #include FT_FREETYPE_H ... don't need any change to the source code. * include/freetype/*: Move up to... * include/*: ... this directory. * builds/amiga/include/freetype/*: Move up to... * builds/amiga/include/*: ... this directory. */*: Essentially do `s@/freetype/@/@' where appropriate. * CMakeList.txt: Simplify. * builds/unix/freetype-config.in, builds/unix/freetype2.in: For `--cflags', return a single directory. * builds/unix/install.mk (install): No longer try to remove `cache' and `internal' subdirectories; instead, remove the `freetype' subdirectory.
-
include/internal/sfnt.h
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
/***************************************************************************/ /* */ /* sfnt.h */ /* */ /* High-level `sfnt' driver interface (specification). */ /* */ /* Copyright 1996-2006, 2009, 2012-2013 by */ /* David Turner, Robert Wilhelm, and Werner Lemberg. */ /* */ /* This file is part of the FreeType project, and may only be used, */ /* modified, and distributed under the terms of the FreeType project */ /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ /* this file you indicate that you have read the license and */ /* understand and accept it fully. */ /* */ /***************************************************************************/ #ifndef __SFNT_H__ #define __SFNT_H__ #include <ft2build.h> #include FT_INTERNAL_DRIVER_H #include FT_INTERNAL_TRUETYPE_TYPES_H FT_BEGIN_HEADER /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Init_Face_Func */ /* */ /* <Description> */ /* First part of the SFNT face object initialization. This finds */ /* the face in a SFNT file or collection, and load its format tag in */ /* face->format_tag. */ /* */ /* <Input> */ /* stream :: The input stream. */ /* */ /* face :: A handle to the target face object. */ /* */ /* face_index :: The index of the TrueType font, if we are opening a */ /* collection. */ /* */ /* num_params :: The number of additional parameters. */ /* */ /* params :: Optional additional parameters. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. */ /* */ /* <Note> */ /* The stream cursor must be at the font file's origin. */ /* */ /* This function recognizes fonts embedded in a `TrueType */ /* collection'. */ /* */ /* Once the format tag has been validated by the font driver, it */ /* should then call the TT_Load_Face_Func() callback to read the rest */ /* of the SFNT tables in the object. */ /* */ typedef FT_Error (*TT_Init_Face_Func)( FT_Stream stream, TT_Face face, FT_Int face_index, FT_Int num_params, FT_Parameter* params ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_Face_Func */ /* */ /* <Description> */ /* Second part of the SFNT face object initialization. This loads */ /* the common SFNT tables (head, OS/2, maxp, metrics, etc.) in the */ /* face object. */ /* */ /* <Input> */ /* stream :: The input stream. */ /* */ /* face :: A handle to the target face object. */ /* */ /* face_index :: The index of the TrueType font, if we are opening a */ /* collection. */ /* */ /* num_params :: The number of additional parameters. */ /* */ /* params :: Optional additional parameters. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. */ /* */ /* <Note> */ /* This function must be called after TT_Init_Face_Func(). */ /* */ typedef FT_Error (*TT_Load_Face_Func)( FT_Stream stream, TT_Face face, FT_Int face_index, FT_Int num_params, FT_Parameter* params ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Done_Face_Func */ /* */ /* <Description> */ /* A callback used to delete the common SFNT data from a face. */ /* */ /* <Input> */ /* face :: A handle to the target face object. */ /* */ /* <Note> */ /* This function does NOT destroy the face object. */ /* */ typedef void (*TT_Done_Face_Func)( TT_Face face ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_Any_Func */ /* */ /* <Description> */ /* Load any font table into client memory. */ /* */ /* <Input> */ /* face :: The face object to look for. */ /* */ /* tag :: The tag of table to load. Use the value 0 if you want */ /* to access the whole font file, else set this parameter */ /* to a valid TrueType table tag that you can forge with */ /* the MAKE_TT_TAG macro. */ /* */ /* offset :: The starting offset in the table (or the file if */ /* tag == 0). */ /* */ /* length :: The address of the decision variable: */ /* */ /* If length == NULL: */ /* Loads the whole table. Returns an error if */ /* `offset' == 0! */ /* */ /* If *length == 0: */ /* Exits immediately; returning the length of the given */ /* table or of the font file, depending on the value of */ /* `tag'. */ /* */ /* If *length != 0: */ /* Loads the next `length' bytes of table or font, */ /* starting at offset `offset' (in table or font too). */ /* */ /* <Output> */ /* buffer :: The address of target buffer. */ /* */ /* <Return> */ /* TrueType error code. 0 means success. */ /* */ typedef FT_Error (*TT_Load_Any_Func)( TT_Face face, FT_ULong tag, FT_Long offset, FT_Byte *buffer, FT_ULong* length ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Find_SBit_Image_Func */ /* */ /* <Description> */ /* Check whether an embedded bitmap (an `sbit') exists for a given */ /* glyph, at a given strike. */ /* */ /* <Input> */ /* face :: The target face object. */ /* */ /* glyph_index :: The glyph index. */ /* */ /* strike_index :: The current strike index. */ /* */ /* <Output> */ /* arange :: The SBit range containing the glyph index. */ /* */ /* astrike :: The SBit strike containing the glyph index. */ /* */ /* aglyph_offset :: The offset of the glyph data in `EBDT' table. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. Returns */ /* SFNT_Err_Invalid_Argument if no sbit exists for the requested */ /* glyph. */ /* */ typedef FT_Error (*TT_Find_SBit_Image_Func)( TT_Face face, FT_UInt glyph_index, FT_ULong strike_index, TT_SBit_Range *arange, TT_SBit_Strike *astrike, FT_ULong *aglyph_offset ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_SBit_Metrics_Func */ /* */ /* <Description> */ /* Get the big metrics for a given embedded bitmap. */ /* */ /* <Input> */ /* stream :: The input stream. */ /* */ /* range :: The SBit range containing the glyph. */ /* */ /* <Output> */ /* big_metrics :: A big SBit metrics structure for the glyph. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. */ /* */ /* <Note> */ /* The stream cursor must be positioned at the glyph's offset within */ /* the `EBDT' table before the call. */ /* */ /* If the image format uses variable metrics, the stream cursor is */ /* positioned just after the metrics header in the `EBDT' table on */ /* function exit. */ /* */ typedef FT_Error (*TT_Load_SBit_Metrics_Func)( FT_Stream stream, TT_SBit_Range range, TT_SBit_Metrics metrics ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_SBit_Image_Func */ /* */ /* <Description> */ /* Load a given glyph sbit image from the font resource. This also */ /* returns its metrics. */ /* */ /* <Input> */ /* face :: */ /* The target face object. */ /* */ /* strike_index :: */ /* The strike index. */ /* */ /* glyph_index :: */ /* The current glyph index. */ /* */ /* load_flags :: */ /* The current load flags. */ /* */ /* stream :: */ /* The input stream. */ /* */ /* <Output> */ /* amap :: */ /* The target pixmap. */ /* */ /* ametrics :: */ /* A big sbit metrics structure for the glyph image. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. Returns an error if no */ /* glyph sbit exists for the index. */ /* */ /* <Note> */ /* The `map.buffer' field is always freed before the glyph is loaded. */ /* */ typedef FT_Error (*TT_Load_SBit_Image_Func)( TT_Face face, FT_ULong strike_index, FT_UInt glyph_index, FT_UInt load_flags, FT_Stream stream, FT_Bitmap *amap, TT_SBit_MetricsRec *ametrics ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Set_SBit_Strike_Func */ /* */ /* <Description> */ /* Select an sbit strike for a given size request. */ /* */ /* <Input> */ /* face :: The target face object. */ /* */ /* req :: The size request. */ /* */ /* <Output> */ /* astrike_index :: The index of the sbit strike. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. Returns an error if no */ /* sbit strike exists for the selected ppem values. */ /* */ typedef FT_Error (*TT_Set_SBit_Strike_Func)( TT_Face face, FT_Size_Request req, FT_ULong* astrike_index ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_Strike_Metrics_Func */ /* */ /* <Description> */ /* Load the metrics of a given strike. */ /* */ /* <Input> */ /* face :: The target face object. */ /* */ /* strike_index :: The strike index. */ /* */ /* <Output> */ /* metrics :: the metrics of the strike. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. Returns an error if no */ /* such sbit strike exists. */ /* */ typedef FT_Error (*TT_Load_Strike_Metrics_Func)( TT_Face face, FT_ULong strike_index, FT_Size_Metrics* metrics ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Get_PS_Name_Func */ /* */ /* <Description> */ /* Get the PostScript glyph name of a glyph. */ /* */ /* <Input> */ /* idx :: The glyph index. */ /* */ /* PSname :: The address of a string pointer. Will be NULL in case */ /* of error, otherwise it is a pointer to the glyph name. */ /* */ /* You must not modify the returned string! */ /* */ /* <Output> */ /* FreeType error code. 0 means success. */ /* */ typedef FT_Error (*TT_Get_PS_Name_Func)( TT_Face face, FT_UInt idx, FT_String** PSname ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_Metrics_Func */ /* */ /* <Description> */ /* Load a metrics table, which is a table with a horizontal and a */ /* vertical version. */ /* */ /* <Input> */ /* face :: A handle to the target face object. */ /* */ /* stream :: The input stream. */ /* */ /* vertical :: A boolean flag. If set, load the vertical one. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. */ /* */ typedef FT_Error (*TT_Load_Metrics_Func)( TT_Face face, FT_Stream stream, FT_Bool vertical ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Get_Metrics_Func */ /* */ /* <Description> */ /* Load the horizontal or vertical header in a face object. */ /* */ /* <Input> */ /* face :: A handle to the target face object. */ /* */ /* stream :: The input stream. */ /* */ /* vertical :: A boolean flag. If set, load vertical metrics. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. */ /* */ typedef FT_Error (*TT_Get_Metrics_Func)( TT_Face face, FT_Bool vertical, FT_UInt gindex, FT_Short* abearing, FT_UShort* aadvance ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Load_Table_Func */ /* */ /* <Description> */ /* Load a given TrueType table. */ /* */ /* <Input> */ /* face :: A handle to the target face object. */ /* */ /* stream :: The input stream. */ /* */ /* <Return> */ /* FreeType error code. 0 means success. */ /* */ /* <Note> */ /* The function uses `face->goto_table' to seek the stream to the */ /* start of the table, except while loading the font directory. */ /* */ typedef FT_Error (*TT_Load_Table_Func)( TT_Face face, FT_Stream stream ); /*************************************************************************/ /* */ /* <FuncType> */ /* TT_Free_Table_Func */ /* */ /* <Description> */ /* Free a given TrueType table. */ /* */ /* <Input> */ /* face :: A handle to the target face object. */ /* */ typedef void (*TT_Free_Table_Func)( TT_Face face ); /* * @functype: * TT_Face_GetKerningFunc * * @description: * Return the horizontal kerning value between two glyphs. * * @input: * face :: A handle to the source face object. * left_glyph :: The left glyph index. * right_glyph :: The right glyph index. * * @return: * The kerning value in font units. */ typedef FT_Int (*TT_Face_GetKerningFunc)( TT_Face face, FT_UInt left_glyph, FT_UInt right_glyph ); /*************************************************************************/ /* */ /* <Struct> */ /* SFNT_Interface */ /* */ /* <Description> */ /* This structure holds pointers to the functions used to load and */ /* free the basic tables that are required in a `sfnt' font file. */ /* */ /* <Fields> */ /* Check the various xxx_Func() descriptions for details. */ /* */ typedef struct SFNT_Interface_ { TT_Loader_GotoTableFunc goto_table; TT_Init_Face_Func init_face; TT_Load_Face_Func load_face; TT_Done_Face_Func done_face; FT_Module_Requester get_interface; TT_Load_Any_Func load_any; /* these functions are called by `load_face' but they can also */ /* be called from external modules, if there is a need to do so */ TT_Load_Table_Func load_head; TT_Load_Metrics_Func load_hhea; TT_Load_Table_Func load_cmap; TT_Load_Table_Func load_maxp; TT_Load_Table_Func load_os2; TT_Load_Table_Func load_post; TT_Load_Table_Func load_name; TT_Free_Table_Func free_name; /* this field was called `load_kerning' up to version 2.1.10 */ TT_Load_Table_Func load_kern; TT_Load_Table_Func load_gasp; TT_Load_Table_Func load_pclt; /* see `ttload.h'; this field was called `load_bitmap_header' up to */ /* version 2.1.10 */ TT_Load_Table_Func load_bhed; TT_Load_SBit_Image_Func load_sbit_image; /* see `ttpost.h' */ TT_Get_PS_Name_Func get_psname; TT_Free_Table_Func free_psnames; /* starting here, the structure differs from version 2.1.7 */ /* this field was introduced in version 2.1.8, named `get_psname' */ TT_Face_GetKerningFunc get_kerning; /* new elements introduced after version 2.1.10 */ /* load the font directory, i.e., the offset table and */ /* the table directory */ TT_Load_Table_Func load_font_dir; TT_Load_Metrics_Func load_hmtx; TT_Load_Table_Func load_eblc; TT_Free_Table_Func free_eblc; TT_Set_SBit_Strike_Func set_sbit_strike; TT_Load_Strike_Metrics_Func load_strike_metrics; TT_Get_Metrics_Func get_metrics; } SFNT_Interface; /* transitional */ typedef SFNT_Interface* SFNT_Service; #ifndef FT_CONFIG_OPTION_PIC #define FT_DEFINE_SFNT_INTERFACE( \ class_, \ goto_table_, \ init_face_, \ load_face_, \ done_face_, \ get_interface_, \ load_any_, \ load_head_, \ load_hhea_, \ load_cmap_, \ load_maxp_, \ load_os2_, \ load_post_, \ load_name_, \ free_name_, \ load_kern_, \ load_gasp_, \ load_pclt_, \ load_bhed_, \ load_sbit_image_, \ get_psname_, \ free_psnames_, \ get_kerning_, \ load_font_dir_, \ load_hmtx_, \ load_eblc_, \ free_eblc_, \ set_sbit_strike_, \ load_strike_metrics_, \ get_metrics_ ) \ static const SFNT_Interface class_ = \ { \ goto_table_, \ init_face_, \ load_face_, \ done_face_, \ get_interface_, \ load_any_, \ load_head_, \ load_hhea_, \ load_cmap_, \ load_maxp_, \ load_os2_, \ load_post_, \ load_name_, \ free_name_, \ load_kern_, \ load_gasp_, \ load_pclt_, \ load_bhed_, \ load_sbit_image_, \ get_psname_, \ free_psnames_, \ get_kerning_, \ load_font_dir_, \ load_hmtx_, \ load_eblc_, \ free_eblc_, \ set_sbit_strike_, \ load_strike_metrics_, \ get_metrics_, \ }; #else /* FT_CONFIG_OPTION_PIC */ #define FT_INTERNAL( a, a_ ) \ clazz->a = a_; #define FT_DEFINE_SFNT_INTERFACE( \ class_, \ goto_table_, \ init_face_, \ load_face_, \ done_face_, \ get_interface_, \ load_any_, \ load_head_, \ load_hhea_, \ load_cmap_, \ load_maxp_, \ load_os2_, \ load_post_, \ load_name_, \ free_name_, \ load_kern_, \ load_gasp_, \ load_pclt_, \ load_bhed_, \ load_sbit_image_, \ get_psname_, \ free_psnames_, \ get_kerning_, \ load_font_dir_, \ load_hmtx_, \ load_eblc_, \ free_eblc_, \ set_sbit_strike_, \ load_strike_metrics_, \ get_metrics_ ) \ void \ FT_Init_Class_ ## class_( FT_Library library, \ SFNT_Interface* clazz ) \ { \ FT_UNUSED( library ); \ \ clazz->goto_table = goto_table_; \ clazz->init_face = init_face_; \ clazz->load_face = load_face_; \ clazz->done_face = done_face_; \ clazz->get_interface = get_interface_; \ clazz->load_any = load_any_; \ clazz->load_head = load_head_; \ clazz->load_hhea = load_hhea_; \ clazz->load_cmap = load_cmap_; \ clazz->load_maxp = load_maxp_; \ clazz->load_os2 = load_os2_; \ clazz->load_post = load_post_; \ clazz->load_name = load_name_; \ clazz->free_name = free_name_; \ clazz->load_kern = load_kern_; \ clazz->load_gasp = load_gasp_; \ clazz->load_pclt = load_pclt_; \ clazz->load_bhed = load_bhed_; \ clazz->load_sbit_image = load_sbit_image_; \ clazz->get_psname = get_psname_; \ clazz->free_psnames = free_psnames_; \ clazz->get_kerning = get_kerning_; \ clazz->load_font_dir = load_font_dir_; \ clazz->load_hmtx = load_hmtx_; \ clazz->load_eblc = load_eblc_; \ clazz->free_eblc = free_eblc_; \ clazz->set_sbit_strike = set_sbit_strike_; \ clazz->load_strike_metrics = load_strike_metrics_; \ clazz->get_metrics = get_metrics_; \ } #endif /* FT_CONFIG_OPTION_PIC */ FT_END_HEADER #endif /* __SFNT_H__ */ /* END */