/***************************************************************************/ /* */ /* ttobjs.c */ /* */ /* Objects manager (body). */ /* */ /* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006 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. */ /* */ /***************************************************************************/ #include #include FT_INTERNAL_DEBUG_H #include FT_INTERNAL_CALC_H #include FT_INTERNAL_STREAM_H #include FT_TRUETYPE_IDS_H #include FT_TRUETYPE_TAGS_H #include FT_INTERNAL_SFNT_H #include "ttgload.h" #include "ttpload.h" #include "tterrors.h" #ifdef TT_USE_BYTECODE_INTERPRETER #include "ttinterp.h" #endif #ifdef TT_CONFIG_OPTION_UNPATENTED_HINTING #include FT_TRUETYPE_UNPATENTED_H #endif #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT #include "ttgxvar.h" #endif /*************************************************************************/ /* */ /* The macro FT_COMPONENT is used in trace mode. It is an implicit */ /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log */ /* messages during execution. */ /* */ #undef FT_COMPONENT #define FT_COMPONENT trace_ttobjs #ifdef TT_USE_BYTECODE_INTERPRETER /*************************************************************************/ /* */ /* GLYPH ZONE FUNCTIONS */ /* */ /*************************************************************************/ /*************************************************************************/ /* */ /* */ /* tt_glyphzone_done */ /* */ /* */ /* Deallocate a glyph zone. */ /* */ /* */ /* zone :: A pointer to the target glyph zone. */ /* */ FT_LOCAL_DEF( void ) tt_glyphzone_done( TT_GlyphZone zone ) { FT_Memory memory = zone->memory; if ( memory ) { FT_FREE( zone->contours ); FT_FREE( zone->tags ); FT_FREE( zone->cur ); FT_FREE( zone->org ); FT_FREE( zone->orus ); zone->max_points = zone->n_points = 0; zone->max_contours = zone->n_contours = 0; zone->memory = NULL; } } /*************************************************************************/ /* */ /* */ /* tt_glyphzone_new */ /* */ /* */ /* Allocate a new glyph zone. */ /* */ /* */ /* memory :: A handle to the current memory object. */ /* */ /* maxPoints :: The capacity of glyph zone in points. */ /* */ /* maxContours :: The capacity of glyph zone in contours. */ /* */ /* */ /* zone :: A pointer to the target glyph zone record. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_glyphzone_new( FT_Memory memory, FT_UShort maxPoints, FT_Short maxContours, TT_GlyphZone zone ) { FT_Error error; FT_MEM_ZERO( zone, sizeof ( *zone ) ); zone->memory = memory; if ( FT_NEW_ARRAY( zone->org, maxPoints ) || FT_NEW_ARRAY( zone->cur, maxPoints ) || FT_NEW_ARRAY( zone->orus, maxPoints ) || FT_NEW_ARRAY( zone->tags, maxPoints ) || FT_NEW_ARRAY( zone->contours, maxContours ) ) { tt_glyphzone_done( zone ); } else { zone->max_points = maxPoints; zone->max_contours = maxContours; } return error; } #endif /* TT_USE_BYTECODE_INTERPRETER */ /*************************************************************************/ /* */ /* */ /* tt_face_init */ /* */ /* */ /* Initialize a given TrueType face object. */ /* */ /* */ /* stream :: The source font stream. */ /* */ /* face_index :: The index of the font face in the resource. */ /* */ /* num_params :: Number of additional generic parameters. Ignored. */ /* */ /* params :: Additional generic parameters. Ignored. */ /* */ /* */ /* face :: The newly built face object. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_face_init( FT_Stream stream, FT_Face ttface, /* TT_Face */ FT_Int face_index, FT_Int num_params, FT_Parameter* params ) { FT_Error error; FT_Library library; SFNT_Service sfnt; TT_Face face = (TT_Face)ttface; library = face->root.driver->root.library; sfnt = (SFNT_Service)FT_Get_Module_Interface( library, "sfnt" ); if ( !sfnt ) goto Bad_Format; /* create input stream from resource */ if ( FT_STREAM_SEEK( 0 ) ) goto Exit; /* check that we have a valid TrueType file */ error = sfnt->init_face( stream, face, face_index, num_params, params ); if ( error ) goto Exit; /* We must also be able to accept Mac/GX fonts, as well as OT ones. */ /* The 0x00020000 tag is completely undocumented; some fonts from */ /* Arphic made for Chinese Windows 3.1 have this. */ if ( face->format_tag != 0x00010000L && /* MS fonts */ face->format_tag != 0x00020000L && /* CJK fonts for Win 3.1 */ face->format_tag != TTAG_true ) /* Mac fonts */ { FT_TRACE2(( "[not a valid TTF font]\n" )); goto Bad_Format; } #ifdef TT_USE_BYTECODE_INTERPRETER face->root.face_flags |= FT_FACE_FLAG_HINTER; #endif /* If we are performing a simple font format check, exit immediately. */ if ( face_index < 0 ) return TT_Err_Ok; /* Load font directory */ error = sfnt->load_face( stream, face, face_index, num_params, params ); if ( error ) goto Exit; error = tt_face_load_hdmx( face, stream ); if ( error ) goto Exit; if ( face->root.face_flags & FT_FACE_FLAG_SCALABLE ) { #ifdef FT_CONFIG_OPTION_INCREMENTAL if ( !face->root.internal->incremental_interface ) error = tt_face_load_loca( face, stream ); if ( !error ) error = tt_face_load_cvt( face, stream ) || tt_face_load_fpgm( face, stream ) || tt_face_load_prep( face, stream ); #else if ( !error ) error = tt_face_load_loca( face, stream ) || tt_face_load_cvt( face, stream ) || tt_face_load_fpgm( face, stream ) || tt_face_load_prep( face, stream ); #endif } #if defined( TT_CONFIG_OPTION_UNPATENTED_HINTING ) && \ !defined( TT_CONFIG_OPTION_BYTECODE_INTERPRETER ) { FT_Bool unpatented_hinting; int i; /* Determine whether unpatented hinting is to be used for this face. */ unpatented_hinting = FT_BOOL ( library->debug_hooks[FT_DEBUG_HOOK_UNPATENTED_HINTING] != NULL ); for ( i = 0; i < num_params && !face->unpatented_hinting; i++ ) if ( params[i].tag == FT_PARAM_TAG_UNPATENTED_HINTING ) unpatented_hinting = TRUE; /* Compare the face with a list of well-known `tricky' fonts. */ /* This list shall be expanded as we find more of them. */ if ( !unpatented_hinting ) { static const char* const trick_names[] = { "DFKaiSho-SB", /* dfkaisb.ttf */ "DFKai-SB", /* kaiu.ttf */ "HuaTianSongTi?", /* htst3.ttf */ "MingLiU", /* mingliu.ttf & mingliu.ttc */ "PMingLiU", /* mingliu.ttc */ "MingLi43", /* mingli.ttf */ NULL }; int nn; /* Note that we only check the face name at the moment; it might */ /* be worth to do more checks for a few special cases. */ for ( nn = 0; trick_names[nn] != NULL; nn++ ) { if ( ttface->family && ft_strcmp( ttface->family_name, trick_names[nn] ) == 0 ) { unpatented_hinting = 1; break; } } } ttface->internal->ignore_unpatented_hinter = !unpatented_hinting; } #endif /* TT_CONFIG_OPTION_UNPATENTED_HINTING && !TT_CONFIG_OPTION_BYTECODE_INTERPRETER */ /* initialize standard glyph loading routines */ TT_Init_Glyph_Loading( face ); Exit: return error; Bad_Format: error = TT_Err_Unknown_File_Format; goto Exit; } /*************************************************************************/ /* */ /* */ /* tt_face_done */ /* */ /* */ /* Finalize a given face object. */ /* */ /* */ /* face :: A pointer to the face object to destroy. */ /* */ FT_LOCAL_DEF( void ) tt_face_done( FT_Face ttface ) /* TT_Face */ { TT_Face face = (TT_Face)ttface; FT_Memory memory = face->root.memory; FT_Stream stream = face->root.stream; SFNT_Service sfnt = (SFNT_Service)face->sfnt; /* for `extended TrueType formats' (i.e. compressed versions) */ if ( face->extra.finalizer ) face->extra.finalizer( face->extra.data ); if ( sfnt ) sfnt->done_face( face ); /* freeing the locations table */ tt_face_done_loca( face ); tt_face_free_hdmx( face ); /* freeing the CVT */ FT_FREE( face->cvt ); face->cvt_size = 0; /* freeing the programs */ FT_FRAME_RELEASE( face->font_program ); FT_FRAME_RELEASE( face->cvt_program ); face->font_program_size = 0; face->cvt_program_size = 0; #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT tt_done_blend( memory, face->blend ); face->blend = NULL; #endif } /*************************************************************************/ /* */ /* SIZE FUNCTIONS */ /* */ /*************************************************************************/ #ifdef TT_USE_BYTECODE_INTERPRETER /*************************************************************************/ /* */ /* */ /* tt_size_run_fpgm */ /* */ /* */ /* Run the font program. */ /* */ /* */ /* size :: A handle to the size object. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_size_run_fpgm( TT_Size size ) { TT_Face face = (TT_Face)size->root.face; TT_ExecContext exec; FT_Error error; /* debugging instances have their own context */ if ( size->debug ) exec = size->context; else exec = ( (TT_Driver)FT_FACE_DRIVER( face ) )->context; if ( !exec ) return TT_Err_Could_Not_Find_Context; TT_Load_Context( exec, face, size ); exec->callTop = 0; exec->top = 0; exec->period = 64; exec->phase = 0; exec->threshold = 0; exec->instruction_trap = FALSE; exec->F_dot_P = 0x10000L; { FT_Size_Metrics* metrics = &exec->metrics; TT_Size_Metrics* tt_metrics = &exec->tt_metrics; metrics->x_ppem = 0; metrics->y_ppem = 0; metrics->x_scale = 0; metrics->y_scale = 0; tt_metrics->ppem = 0; tt_metrics->scale = 0; tt_metrics->ratio = 0x10000L; } /* allow font program execution */ TT_Set_CodeRange( exec, tt_coderange_font, face->font_program, face->font_program_size ); /* disable CVT and glyph programs coderange */ TT_Clear_CodeRange( exec, tt_coderange_cvt ); TT_Clear_CodeRange( exec, tt_coderange_glyph ); if ( face->font_program_size > 0 ) { error = TT_Goto_CodeRange( exec, tt_coderange_font, 0 ); if ( !error ) error = face->interpreter( exec ); } else error = TT_Err_Ok; if ( !error ) TT_Save_Context( exec, size ); return error; } /*************************************************************************/ /* */ /* */ /* tt_size_run_prep */ /* */ /* */ /* Run the control value program. */ /* */ /* */ /* size :: A handle to the size object. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_size_run_prep( TT_Size size ) { TT_Face face = (TT_Face)size->root.face; TT_ExecContext exec; FT_Error error; /* debugging instances have their own context */ if ( size->debug ) exec = size->context; else exec = ( (TT_Driver)FT_FACE_DRIVER( face ) )->context; if ( !exec ) return TT_Err_Could_Not_Find_Context; TT_Load_Context( exec, face, size ); exec->callTop = 0; exec->top = 0; exec->instruction_trap = FALSE; TT_Set_CodeRange( exec, tt_coderange_cvt, face->cvt_program, face->cvt_program_size ); TT_Clear_CodeRange( exec, tt_coderange_glyph ); if ( face->cvt_program_size > 0 ) { error = TT_Goto_CodeRange( exec, tt_coderange_cvt, 0 ); if ( !error && !size->debug ) error = face->interpreter( exec ); } else error = TT_Err_Ok; /* save as default graphics state */ size->GS = exec->GS; TT_Save_Context( exec, size ); return error; } #endif /* TT_USE_BYTECODE_INTERPRETER */ /*************************************************************************/ /* */ /* */ /* tt_size_init */ /* */ /* */ /* Initialize a new TrueType size object. */ /* */ /* */ /* size :: A handle to the size object. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_size_init( FT_Size ttsize ) /* TT_Size */ { TT_Size size = (TT_Size)ttsize; FT_Error error = TT_Err_Ok; #ifdef TT_USE_BYTECODE_INTERPRETER TT_Face face = (TT_Face)size->root.face; FT_Memory memory = face->root.memory; FT_Int i; FT_UShort n_twilight; TT_MaxProfile* maxp = &face->max_profile; size->max_function_defs = maxp->maxFunctionDefs; size->max_instruction_defs = maxp->maxInstructionDefs; size->num_function_defs = 0; size->num_instruction_defs = 0; size->max_func = 0; size->max_ins = 0; size->cvt_size = face->cvt_size; size->storage_size = maxp->maxStorage; /* Set default metrics */ { FT_Size_Metrics* metrics = &size->root.metrics; TT_Size_Metrics* metrics2 = &size->ttmetrics; metrics->x_ppem = 0; metrics->y_ppem = 0; metrics2->rotated = FALSE; metrics2->stretched = FALSE; /* set default compensation (all 0) */ for ( i = 0; i < 4; i++ ) metrics2->compensations[i] = 0; } /* allocate function defs, instruction defs, cvt, and storage area */ if ( FT_NEW_ARRAY( size->function_defs, size->max_function_defs ) || FT_NEW_ARRAY( size->instruction_defs, size->max_instruction_defs ) || FT_NEW_ARRAY( size->cvt, size->cvt_size ) || FT_NEW_ARRAY( size->storage, size->storage_size ) ) { tt_size_done( ttsize ); return error; } /* reserve twilight zone */ n_twilight = maxp->maxTwilightPoints; /* there are 4 phantom points (do we need this?) */ n_twilight += 4; error = tt_glyphzone_new( memory, n_twilight, 0, &size->twilight ); if ( error ) { tt_size_done( ttsize ); return error; } size->twilight.n_points = n_twilight; size->GS = tt_default_graphics_state; /* set `face->interpreter' according to the debug hook present */ { FT_Library library = face->root.driver->root.library; face->interpreter = (TT_Interpreter) library->debug_hooks[FT_DEBUG_HOOK_TRUETYPE]; if ( !face->interpreter ) face->interpreter = (TT_Interpreter)TT_RunIns; } /* Fine, now run the font program! */ error = tt_size_run_fpgm( size ); if ( error ) tt_size_done( ttsize ); #endif /* TT_USE_BYTECODE_INTERPRETER */ size->ttmetrics.valid = FALSE; size->strike_index = 0xFFFFFFFFUL; return error; } /*************************************************************************/ /* */ /* */ /* tt_size_done */ /* */ /* */ /* The TrueType size object finalizer. */ /* */ /* */ /* size :: A handle to the target size object. */ /* */ FT_LOCAL_DEF( void ) tt_size_done( FT_Size ttsize ) /* TT_Size */ { TT_Size size = (TT_Size)ttsize; #ifdef TT_USE_BYTECODE_INTERPRETER FT_Memory memory = size->root.face->memory; if ( size->debug ) { /* the debug context must be deleted by the debugger itself */ size->context = NULL; size->debug = FALSE; } FT_FREE( size->cvt ); size->cvt_size = 0; /* free storage area */ FT_FREE( size->storage ); size->storage_size = 0; /* twilight zone */ tt_glyphzone_done( &size->twilight ); FT_FREE( size->function_defs ); FT_FREE( size->instruction_defs ); size->num_function_defs = 0; size->max_function_defs = 0; size->num_instruction_defs = 0; size->max_instruction_defs = 0; size->max_func = 0; size->max_ins = 0; #endif size->ttmetrics.valid = FALSE; } /*************************************************************************/ /* */ /* */ /* tt_size_reset */ /* */ /* */ /* Reset a TrueType size when resolutions and character dimensions */ /* have been changed. */ /* */ /* */ /* size :: A handle to the target size object. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_size_reset( TT_Size size ) { TT_Face face; FT_Error error = TT_Err_Ok; FT_Size_Metrics* metrics; size->ttmetrics.valid = FALSE; face = (TT_Face)size->root.face; metrics = &size->metrics; /* copy the result from base layer */ *metrics = size->root.metrics; if ( metrics->x_ppem < 1 || metrics->y_ppem < 1 ) return TT_Err_Invalid_PPem; /* This bit flag, if set, indicates that the ppems must be */ /* rounded to integers. Nearly all TrueType fonts have this bit */ /* set, as hinting won't work really well otherwise. */ /* */ if ( face->header.Flags & 8 ) { metrics->x_scale = FT_DivFix( metrics->x_ppem << 6, face->root.units_per_EM ); metrics->y_scale = FT_DivFix( metrics->y_ppem << 6, face->root.units_per_EM ); metrics->ascender = FT_PIX_ROUND( FT_MulFix( face->root.ascender, metrics->y_scale ) ); metrics->descender = FT_PIX_ROUND( FT_MulFix( face->root.descender, metrics->y_scale ) ); metrics->height = FT_PIX_ROUND( FT_MulFix( face->root.height, metrics->y_scale ) ); metrics->max_advance = FT_PIX_ROUND( FT_MulFix( face->root.max_advance_width, metrics->x_scale ) ); } /* compute new transformation */ if ( metrics->x_ppem >= metrics->y_ppem ) { size->ttmetrics.scale = metrics->x_scale; size->ttmetrics.ppem = metrics->x_ppem; size->ttmetrics.x_ratio = 0x10000L; size->ttmetrics.y_ratio = FT_MulDiv( metrics->y_ppem, 0x10000L, metrics->x_ppem ); } else { size->ttmetrics.scale = metrics->y_scale; size->ttmetrics.ppem = metrics->y_ppem; size->ttmetrics.x_ratio = FT_MulDiv( metrics->x_ppem, 0x10000L, metrics->y_ppem ); size->ttmetrics.y_ratio = 0x10000L; } #ifdef TT_USE_BYTECODE_INTERPRETER { FT_UInt i; /* Scale the cvt values to the new ppem. */ /* We use by default the y ppem to scale the CVT. */ for ( i = 0; i < size->cvt_size; i++ ) size->cvt[i] = FT_MulFix( face->cvt[i], size->ttmetrics.scale ); /* All twilight points are originally zero */ for ( i = 0; i < (FT_UInt)size->twilight.n_points; i++ ) { size->twilight.org[i].x = 0; size->twilight.org[i].y = 0; size->twilight.cur[i].x = 0; size->twilight.cur[i].y = 0; } /* clear storage area */ for ( i = 0; i < (FT_UInt)size->storage_size; i++ ) size->storage[i] = 0; size->GS = tt_default_graphics_state; error = tt_size_run_prep( size ); } #endif /* TT_USE_BYTECODE_INTERPRETER */ if ( !error ) size->ttmetrics.valid = TRUE; return error; } /*************************************************************************/ /* */ /* */ /* tt_driver_init */ /* */ /* */ /* Initialize a given TrueType driver object. */ /* */ /* */ /* driver :: A handle to the target driver object. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_driver_init( FT_Module ttdriver ) /* TT_Driver */ { #ifdef TT_USE_BYTECODE_INTERPRETER TT_Driver driver = (TT_Driver)ttdriver; if ( !TT_New_Context( driver ) ) return TT_Err_Could_Not_Find_Context; #else FT_UNUSED( ttdriver ); #endif return TT_Err_Ok; } /*************************************************************************/ /* */ /* */ /* tt_driver_done */ /* */ /* */ /* Finalize a given TrueType driver. */ /* */ /* */ /* driver :: A handle to the target TrueType driver. */ /* */ FT_LOCAL_DEF( void ) tt_driver_done( FT_Module ttdriver ) /* TT_Driver */ { #ifdef TT_USE_BYTECODE_INTERPRETER TT_Driver driver = (TT_Driver)ttdriver; /* destroy the execution context */ if ( driver->context ) { TT_Done_Context( driver->context ); driver->context = NULL; } #else FT_UNUSED( ttdriver ); #endif } /*************************************************************************/ /* */ /* */ /* tt_slot_init */ /* */ /* */ /* Initialize a new slot object. */ /* */ /* */ /* slot :: A handle to the slot object. */ /* */ /* */ /* FreeType error code. 0 means success. */ /* */ FT_LOCAL_DEF( FT_Error ) tt_slot_init( FT_GlyphSlot slot ) { return FT_GlyphLoader_CreateExtra( slot->internal->loader ); } /* END */