vrshoot

annotate libs/ft2static/freetype/internal/ftdriver.h @ 0:b2f14e535253

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /***************************************************************************/
nuclear@0 2 /* */
nuclear@0 3 /* ftdriver.h */
nuclear@0 4 /* */
nuclear@0 5 /* FreeType font driver interface (specification). */
nuclear@0 6 /* */
nuclear@0 7 /* Copyright 1996-2001, 2002, 2003, 2006, 2008 by */
nuclear@0 8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
nuclear@0 9 /* */
nuclear@0 10 /* This file is part of the FreeType project, and may only be used, */
nuclear@0 11 /* modified, and distributed under the terms of the FreeType project */
nuclear@0 12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
nuclear@0 13 /* this file you indicate that you have read the license and */
nuclear@0 14 /* understand and accept it fully. */
nuclear@0 15 /* */
nuclear@0 16 /***************************************************************************/
nuclear@0 17
nuclear@0 18
nuclear@0 19 #ifndef __FTDRIVER_H__
nuclear@0 20 #define __FTDRIVER_H__
nuclear@0 21
nuclear@0 22
nuclear@0 23 #include <ft2build.h>
nuclear@0 24 #include FT_MODULE_H
nuclear@0 25
nuclear@0 26
nuclear@0 27 FT_BEGIN_HEADER
nuclear@0 28
nuclear@0 29
nuclear@0 30 typedef FT_Error
nuclear@0 31 (*FT_Face_InitFunc)( FT_Stream stream,
nuclear@0 32 FT_Face face,
nuclear@0 33 FT_Int typeface_index,
nuclear@0 34 FT_Int num_params,
nuclear@0 35 FT_Parameter* parameters );
nuclear@0 36
nuclear@0 37 typedef void
nuclear@0 38 (*FT_Face_DoneFunc)( FT_Face face );
nuclear@0 39
nuclear@0 40
nuclear@0 41 typedef FT_Error
nuclear@0 42 (*FT_Size_InitFunc)( FT_Size size );
nuclear@0 43
nuclear@0 44 typedef void
nuclear@0 45 (*FT_Size_DoneFunc)( FT_Size size );
nuclear@0 46
nuclear@0 47
nuclear@0 48 typedef FT_Error
nuclear@0 49 (*FT_Slot_InitFunc)( FT_GlyphSlot slot );
nuclear@0 50
nuclear@0 51 typedef void
nuclear@0 52 (*FT_Slot_DoneFunc)( FT_GlyphSlot slot );
nuclear@0 53
nuclear@0 54
nuclear@0 55 typedef FT_Error
nuclear@0 56 (*FT_Size_RequestFunc)( FT_Size size,
nuclear@0 57 FT_Size_Request req );
nuclear@0 58
nuclear@0 59 typedef FT_Error
nuclear@0 60 (*FT_Size_SelectFunc)( FT_Size size,
nuclear@0 61 FT_ULong size_index );
nuclear@0 62
nuclear@0 63 #ifdef FT_CONFIG_OPTION_OLD_INTERNALS
nuclear@0 64
nuclear@0 65 typedef FT_Error
nuclear@0 66 (*FT_Size_ResetPointsFunc)( FT_Size size,
nuclear@0 67 FT_F26Dot6 char_width,
nuclear@0 68 FT_F26Dot6 char_height,
nuclear@0 69 FT_UInt horz_resolution,
nuclear@0 70 FT_UInt vert_resolution );
nuclear@0 71
nuclear@0 72 typedef FT_Error
nuclear@0 73 (*FT_Size_ResetPixelsFunc)( FT_Size size,
nuclear@0 74 FT_UInt pixel_width,
nuclear@0 75 FT_UInt pixel_height );
nuclear@0 76
nuclear@0 77 #endif /* FT_CONFIG_OPTION_OLD_INTERNALS */
nuclear@0 78
nuclear@0 79 typedef FT_Error
nuclear@0 80 (*FT_Slot_LoadFunc)( FT_GlyphSlot slot,
nuclear@0 81 FT_Size size,
nuclear@0 82 FT_UInt glyph_index,
nuclear@0 83 FT_Int32 load_flags );
nuclear@0 84
nuclear@0 85
nuclear@0 86 typedef FT_UInt
nuclear@0 87 (*FT_CharMap_CharIndexFunc)( FT_CharMap charmap,
nuclear@0 88 FT_Long charcode );
nuclear@0 89
nuclear@0 90 typedef FT_Long
nuclear@0 91 (*FT_CharMap_CharNextFunc)( FT_CharMap charmap,
nuclear@0 92 FT_Long charcode );
nuclear@0 93
nuclear@0 94
nuclear@0 95 typedef FT_Error
nuclear@0 96 (*FT_Face_GetKerningFunc)( FT_Face face,
nuclear@0 97 FT_UInt left_glyph,
nuclear@0 98 FT_UInt right_glyph,
nuclear@0 99 FT_Vector* kerning );
nuclear@0 100
nuclear@0 101
nuclear@0 102 typedef FT_Error
nuclear@0 103 (*FT_Face_AttachFunc)( FT_Face face,
nuclear@0 104 FT_Stream stream );
nuclear@0 105
nuclear@0 106
nuclear@0 107 typedef FT_Error
nuclear@0 108 (*FT_Face_GetAdvancesFunc)( FT_Face face,
nuclear@0 109 FT_UInt first,
nuclear@0 110 FT_UInt count,
nuclear@0 111 FT_Int32 flags,
nuclear@0 112 FT_Fixed* advances );
nuclear@0 113
nuclear@0 114
nuclear@0 115 /*************************************************************************/
nuclear@0 116 /* */
nuclear@0 117 /* <Struct> */
nuclear@0 118 /* FT_Driver_ClassRec */
nuclear@0 119 /* */
nuclear@0 120 /* <Description> */
nuclear@0 121 /* The font driver class. This structure mostly contains pointers to */
nuclear@0 122 /* driver methods. */
nuclear@0 123 /* */
nuclear@0 124 /* <Fields> */
nuclear@0 125 /* root :: The parent module. */
nuclear@0 126 /* */
nuclear@0 127 /* face_object_size :: The size of a face object in bytes. */
nuclear@0 128 /* */
nuclear@0 129 /* size_object_size :: The size of a size object in bytes. */
nuclear@0 130 /* */
nuclear@0 131 /* slot_object_size :: The size of a glyph object in bytes. */
nuclear@0 132 /* */
nuclear@0 133 /* init_face :: The format-specific face constructor. */
nuclear@0 134 /* */
nuclear@0 135 /* done_face :: The format-specific face destructor. */
nuclear@0 136 /* */
nuclear@0 137 /* init_size :: The format-specific size constructor. */
nuclear@0 138 /* */
nuclear@0 139 /* done_size :: The format-specific size destructor. */
nuclear@0 140 /* */
nuclear@0 141 /* init_slot :: The format-specific slot constructor. */
nuclear@0 142 /* */
nuclear@0 143 /* done_slot :: The format-specific slot destructor. */
nuclear@0 144 /* */
nuclear@0 145 /* */
nuclear@0 146 /* load_glyph :: A function handle to load a glyph to a slot. */
nuclear@0 147 /* This field is mandatory! */
nuclear@0 148 /* */
nuclear@0 149 /* get_kerning :: A function handle to return the unscaled */
nuclear@0 150 /* kerning for a given pair of glyphs. Can be */
nuclear@0 151 /* set to 0 if the format doesn't support */
nuclear@0 152 /* kerning. */
nuclear@0 153 /* */
nuclear@0 154 /* attach_file :: This function handle is used to read */
nuclear@0 155 /* additional data for a face from another */
nuclear@0 156 /* file/stream. For example, this can be used to */
nuclear@0 157 /* add data from AFM or PFM files on a Type 1 */
nuclear@0 158 /* face, or a CIDMap on a CID-keyed face. */
nuclear@0 159 /* */
nuclear@0 160 /* get_advances :: A function handle used to return advance */
nuclear@0 161 /* widths of `count' glyphs (in font units), */
nuclear@0 162 /* starting at `first'. The `vertical' flag must */
nuclear@0 163 /* be set to get vertical advance heights. The */
nuclear@0 164 /* `advances' buffer is caller-allocated. */
nuclear@0 165 /* Currently not implemented. The idea of this */
nuclear@0 166 /* function is to be able to perform */
nuclear@0 167 /* device-independent text layout without loading */
nuclear@0 168 /* a single glyph image. */
nuclear@0 169 /* */
nuclear@0 170 /* request_size :: A handle to a function used to request the new */
nuclear@0 171 /* character size. Can be set to 0 if the */
nuclear@0 172 /* scaling done in the base layer suffices. */
nuclear@0 173 /* */
nuclear@0 174 /* select_size :: A handle to a function used to select a new */
nuclear@0 175 /* fixed size. It is used only if */
nuclear@0 176 /* @FT_FACE_FLAG_FIXED_SIZES is set. Can be set */
nuclear@0 177 /* to 0 if the scaling done in the base layer */
nuclear@0 178 /* suffices. */
nuclear@0 179 /* <Note> */
nuclear@0 180 /* Most function pointers, with the exception of `load_glyph', can be */
nuclear@0 181 /* set to 0 to indicate a default behaviour. */
nuclear@0 182 /* */
nuclear@0 183 typedef struct FT_Driver_ClassRec_
nuclear@0 184 {
nuclear@0 185 FT_Module_Class root;
nuclear@0 186
nuclear@0 187 FT_Long face_object_size;
nuclear@0 188 FT_Long size_object_size;
nuclear@0 189 FT_Long slot_object_size;
nuclear@0 190
nuclear@0 191 FT_Face_InitFunc init_face;
nuclear@0 192 FT_Face_DoneFunc done_face;
nuclear@0 193
nuclear@0 194 FT_Size_InitFunc init_size;
nuclear@0 195 FT_Size_DoneFunc done_size;
nuclear@0 196
nuclear@0 197 FT_Slot_InitFunc init_slot;
nuclear@0 198 FT_Slot_DoneFunc done_slot;
nuclear@0 199
nuclear@0 200 #ifdef FT_CONFIG_OPTION_OLD_INTERNALS
nuclear@0 201
nuclear@0 202 FT_Size_ResetPointsFunc set_char_sizes;
nuclear@0 203 FT_Size_ResetPixelsFunc set_pixel_sizes;
nuclear@0 204
nuclear@0 205 #endif /* FT_CONFIG_OPTION_OLD_INTERNALS */
nuclear@0 206
nuclear@0 207 FT_Slot_LoadFunc load_glyph;
nuclear@0 208
nuclear@0 209 FT_Face_GetKerningFunc get_kerning;
nuclear@0 210 FT_Face_AttachFunc attach_file;
nuclear@0 211 FT_Face_GetAdvancesFunc get_advances;
nuclear@0 212
nuclear@0 213 /* since version 2.2 */
nuclear@0 214 FT_Size_RequestFunc request_size;
nuclear@0 215 FT_Size_SelectFunc select_size;
nuclear@0 216
nuclear@0 217 } FT_Driver_ClassRec, *FT_Driver_Class;
nuclear@0 218
nuclear@0 219
nuclear@0 220 /*
nuclear@0 221 * The following functions are used as stubs for `set_char_sizes' and
nuclear@0 222 * `set_pixel_sizes'; the code uses `request_size' and `select_size'
nuclear@0 223 * functions instead.
nuclear@0 224 *
nuclear@0 225 * Implementation is in `src/base/ftobjs.c'.
nuclear@0 226 */
nuclear@0 227 #ifdef FT_CONFIG_OPTION_OLD_INTERNALS
nuclear@0 228
nuclear@0 229 FT_BASE( FT_Error )
nuclear@0 230 ft_stub_set_char_sizes( FT_Size size,
nuclear@0 231 FT_F26Dot6 width,
nuclear@0 232 FT_F26Dot6 height,
nuclear@0 233 FT_UInt horz_res,
nuclear@0 234 FT_UInt vert_res );
nuclear@0 235
nuclear@0 236 FT_BASE( FT_Error )
nuclear@0 237 ft_stub_set_pixel_sizes( FT_Size size,
nuclear@0 238 FT_UInt width,
nuclear@0 239 FT_UInt height );
nuclear@0 240
nuclear@0 241 #endif /* FT_CONFIG_OPTION_OLD_INTERNALS */
nuclear@0 242
nuclear@0 243 /*************************************************************************/
nuclear@0 244 /* */
nuclear@0 245 /* <Macro> */
nuclear@0 246 /* FT_DECLARE_DRIVER */
nuclear@0 247 /* */
nuclear@0 248 /* <Description> */
nuclear@0 249 /* Used to create a forward declaration of a */
nuclear@0 250 /* FT_Driver_ClassRec stract instance. */
nuclear@0 251 /* */
nuclear@0 252 /* <Macro> */
nuclear@0 253 /* FT_DEFINE_DRIVER */
nuclear@0 254 /* */
nuclear@0 255 /* <Description> */
nuclear@0 256 /* Used to initialize an instance of FT_Driver_ClassRec struct. */
nuclear@0 257 /* */
nuclear@0 258 /* When FT_CONFIG_OPTION_PIC is defined a Create funtion will need */
nuclear@0 259 /* to called with a pointer where the allocated stracture is returned.*/
nuclear@0 260 /* And when it is no longer needed a Destroy function needs */
nuclear@0 261 /* to be called to release that allocation. */
nuclear@0 262 /* fcinit.c (ft_create_default_module_classes) already contains */
nuclear@0 263 /* a mechanism to call these functions for the default modules */
nuclear@0 264 /* described in ftmodule.h */
nuclear@0 265 /* */
nuclear@0 266 /* Notice that the created Create and Destroy functions call */
nuclear@0 267 /* pic_init and pic_free function to allow you to manually allocate */
nuclear@0 268 /* and initialize any additional global data, like module specific */
nuclear@0 269 /* interface, and put them in the global pic container defined in */
nuclear@0 270 /* ftpic.h. if you don't need them just implement the functions as */
nuclear@0 271 /* empty to resolve the link error. */
nuclear@0 272 /* */
nuclear@0 273 /* When FT_CONFIG_OPTION_PIC is not defined the struct will be */
nuclear@0 274 /* allocated in the global scope (or the scope where the macro */
nuclear@0 275 /* is used). */
nuclear@0 276 /* */
nuclear@0 277 #ifndef FT_CONFIG_OPTION_PIC
nuclear@0 278
nuclear@0 279 #ifdef FT_CONFIG_OPTION_OLD_INTERNALS
nuclear@0 280 #define FT_DEFINE_DRIVERS_OLD_INTERNALS(a_,b_) \
nuclear@0 281 a_, b_,
nuclear@0 282 #else
nuclear@0 283 #define FT_DEFINE_DRIVERS_OLD_INTERNALS(a_,b_)
nuclear@0 284 #endif
nuclear@0 285
nuclear@0 286 #define FT_DECLARE_DRIVER(class_) \
nuclear@0 287 FT_CALLBACK_TABLE \
nuclear@0 288 const FT_Driver_ClassRec class_;
nuclear@0 289
nuclear@0 290 #define FT_DEFINE_DRIVER(class_, \
nuclear@0 291 flags_, size_, name_, version_, requires_, \
nuclear@0 292 interface_, init_, done_, get_interface_, \
nuclear@0 293 face_object_size_, size_object_size_, \
nuclear@0 294 slot_object_size_, init_face_, done_face_, \
nuclear@0 295 init_size_, done_size_, init_slot_, done_slot_, \
nuclear@0 296 old_set_char_sizes_, old_set_pixel_sizes_, \
nuclear@0 297 load_glyph_, get_kerning_, attach_file_, \
nuclear@0 298 get_advances_, request_size_, select_size_ ) \
nuclear@0 299 FT_CALLBACK_TABLE_DEF \
nuclear@0 300 const FT_Driver_ClassRec class_ = \
nuclear@0 301 { \
nuclear@0 302 FT_DEFINE_ROOT_MODULE(flags_,size_,name_,version_,requires_,interface_, \
nuclear@0 303 init_,done_,get_interface_) \
nuclear@0 304 \
nuclear@0 305 face_object_size_, \
nuclear@0 306 size_object_size_, \
nuclear@0 307 slot_object_size_, \
nuclear@0 308 \
nuclear@0 309 init_face_, \
nuclear@0 310 done_face_, \
nuclear@0 311 \
nuclear@0 312 init_size_, \
nuclear@0 313 done_size_, \
nuclear@0 314 \
nuclear@0 315 init_slot_, \
nuclear@0 316 done_slot_, \
nuclear@0 317 \
nuclear@0 318 FT_DEFINE_DRIVERS_OLD_INTERNALS(old_set_char_sizes_, old_set_pixel_sizes_) \
nuclear@0 319 \
nuclear@0 320 load_glyph_, \
nuclear@0 321 \
nuclear@0 322 get_kerning_, \
nuclear@0 323 attach_file_, \
nuclear@0 324 get_advances_, \
nuclear@0 325 \
nuclear@0 326 request_size_, \
nuclear@0 327 select_size_ \
nuclear@0 328 };
nuclear@0 329
nuclear@0 330 #else /* FT_CONFIG_OPTION_PIC */
nuclear@0 331
nuclear@0 332 #ifdef FT_CONFIG_OPTION_OLD_INTERNALS
nuclear@0 333 #define FT_DEFINE_DRIVERS_OLD_INTERNALS(a_,b_) \
nuclear@0 334 clazz->set_char_sizes = a_; \
nuclear@0 335 clazz->set_pixel_sizes = b_;
nuclear@0 336 #else
nuclear@0 337 #define FT_DEFINE_DRIVERS_OLD_INTERNALS(a_,b_)
nuclear@0 338 #endif
nuclear@0 339
nuclear@0 340 #define FT_DECLARE_DRIVER(class_) FT_DECLARE_MODULE(class_)
nuclear@0 341
nuclear@0 342 #define FT_DEFINE_DRIVER(class_, \
nuclear@0 343 flags_, size_, name_, version_, requires_, \
nuclear@0 344 interface_, init_, done_, get_interface_, \
nuclear@0 345 face_object_size_, size_object_size_, \
nuclear@0 346 slot_object_size_, init_face_, done_face_, \
nuclear@0 347 init_size_, done_size_, init_slot_, done_slot_, \
nuclear@0 348 old_set_char_sizes_, old_set_pixel_sizes_, \
nuclear@0 349 load_glyph_, get_kerning_, attach_file_, \
nuclear@0 350 get_advances_, request_size_, select_size_ ) \
nuclear@0 351 void class_##_pic_free( FT_Library library ); \
nuclear@0 352 FT_Error class_##_pic_init( FT_Library library ); \
nuclear@0 353 \
nuclear@0 354 void \
nuclear@0 355 FT_Destroy_Class_##class_( FT_Library library, \
nuclear@0 356 FT_Module_Class* clazz ) \
nuclear@0 357 { \
nuclear@0 358 FT_Memory memory = library->memory; \
nuclear@0 359 FT_Driver_Class dclazz = (FT_Driver_Class)clazz; \
nuclear@0 360 class_##_pic_free( library ); \
nuclear@0 361 if ( dclazz ) \
nuclear@0 362 FT_FREE( dclazz ); \
nuclear@0 363 } \
nuclear@0 364 \
nuclear@0 365 FT_Error \
nuclear@0 366 FT_Create_Class_##class_( FT_Library library, \
nuclear@0 367 FT_Module_Class** output_class ) \
nuclear@0 368 { \
nuclear@0 369 FT_Driver_Class clazz; \
nuclear@0 370 FT_Error error; \
nuclear@0 371 FT_Memory memory = library->memory; \
nuclear@0 372 \
nuclear@0 373 if ( FT_ALLOC( clazz, sizeof(*clazz) ) ) \
nuclear@0 374 return error; \
nuclear@0 375 \
nuclear@0 376 error = class_##_pic_init( library ); \
nuclear@0 377 if(error) \
nuclear@0 378 { \
nuclear@0 379 FT_FREE( clazz ); \
nuclear@0 380 return error; \
nuclear@0 381 } \
nuclear@0 382 \
nuclear@0 383 FT_DEFINE_ROOT_MODULE(flags_,size_,name_,version_,requires_,interface_, \
nuclear@0 384 init_,done_,get_interface_) \
nuclear@0 385 \
nuclear@0 386 clazz->face_object_size = face_object_size_; \
nuclear@0 387 clazz->size_object_size = size_object_size_; \
nuclear@0 388 clazz->slot_object_size = slot_object_size_; \
nuclear@0 389 \
nuclear@0 390 clazz->init_face = init_face_; \
nuclear@0 391 clazz->done_face = done_face_; \
nuclear@0 392 \
nuclear@0 393 clazz->init_size = init_size_; \
nuclear@0 394 clazz->done_size = done_size_; \
nuclear@0 395 \
nuclear@0 396 clazz->init_slot = init_slot_; \
nuclear@0 397 clazz->done_slot = done_slot_; \
nuclear@0 398 \
nuclear@0 399 FT_DEFINE_DRIVERS_OLD_INTERNALS(old_set_char_sizes_, old_set_pixel_sizes_) \
nuclear@0 400 \
nuclear@0 401 clazz->load_glyph = load_glyph_; \
nuclear@0 402 \
nuclear@0 403 clazz->get_kerning = get_kerning_; \
nuclear@0 404 clazz->attach_file = attach_file_; \
nuclear@0 405 clazz->get_advances = get_advances_; \
nuclear@0 406 \
nuclear@0 407 clazz->request_size = request_size_; \
nuclear@0 408 clazz->select_size = select_size_; \
nuclear@0 409 \
nuclear@0 410 *output_class = (FT_Module_Class*)clazz; \
nuclear@0 411 return FT_Err_Ok; \
nuclear@0 412 }
nuclear@0 413
nuclear@0 414
nuclear@0 415 #endif /* FT_CONFIG_OPTION_PIC */
nuclear@0 416
nuclear@0 417 FT_END_HEADER
nuclear@0 418
nuclear@0 419 #endif /* __FTDRIVER_H__ */
nuclear@0 420
nuclear@0 421
nuclear@0 422 /* END */