1 /***************************************************************************/
5 /* Auto-fitter routines to compute global hinting values (body). */
7 /* Copyright 2003-2011 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
16 /***************************************************************************/
28 #ifdef FT_OPTION_AUTOFIT2
32 #ifndef FT_CONFIG_OPTION_PIC
34 /* when updating this table, don't forget to update */
35 /* AF_SCRIPT_CLASSES_COUNT and autofit_module_class_pic_init */
37 /* populate this list when you add new scripts */
38 static AF_ScriptClass const af_script_classes[] =
40 &af_dummy_script_class,
41 #ifdef FT_OPTION_AUTOFIT2
42 &af_latin2_script_class,
44 &af_latin_script_class,
46 &af_indic_script_class,
47 NULL /* do not remove */
50 #endif /* !FT_CONFIG_OPTION_PIC */
52 /* index of default script in `af_script_classes' */
53 #define AF_SCRIPT_LIST_DEFAULT 2
54 /* a bit mask indicating an uncovered glyph */
55 #define AF_SCRIPT_LIST_NONE 0x7F
56 /* if this flag is set, we have an ASCII digit */
61 * Note that glyph_scripts[] is used to map each glyph into
62 * an index into the `af_script_classes' array.
65 typedef struct AF_FaceGlobalsRec_
68 FT_Long glyph_count; /* same as face->num_glyphs */
69 FT_Byte* glyph_scripts;
71 AF_ScriptMetrics metrics[AF_SCRIPT_MAX];
76 /* Compute the script index of each glyph within a given face. */
79 af_face_globals_compute_script_coverage( AF_FaceGlobals globals )
81 FT_Error error = AF_Err_Ok;
82 FT_Face face = globals->face;
83 FT_CharMap old_charmap = face->charmap;
84 FT_Byte* gscripts = globals->glyph_scripts;
88 /* the value AF_SCRIPT_LIST_NONE means `uncovered glyph' */
89 FT_MEM_SET( globals->glyph_scripts,
91 globals->glyph_count );
93 error = FT_Select_Charmap( face, FT_ENCODING_UNICODE );
97 * Ignore this error; we simply use the default script.
98 * XXX: Shouldn't we rather disable hinting?
104 /* scan each script in a Unicode charmap */
105 for ( ss = 0; AF_SCRIPT_CLASSES_GET[ss]; ss++ )
107 AF_ScriptClass clazz = AF_SCRIPT_CLASSES_GET[ss];
108 AF_Script_UniRange range;
111 if ( clazz->script_uni_ranges == NULL )
115 * Scan all unicode points in the range and set the corresponding
116 * glyph script index.
118 for ( range = clazz->script_uni_ranges; range->first != 0; range++ )
120 FT_ULong charcode = range->first;
124 gindex = FT_Get_Char_Index( face, charcode );
127 gindex < (FT_ULong)globals->glyph_count &&
128 gscripts[gindex] == AF_SCRIPT_LIST_NONE )
129 gscripts[gindex] = (FT_Byte)ss;
133 charcode = FT_Get_Next_Char( face, charcode, &gindex );
135 if ( gindex == 0 || charcode > range->last )
138 if ( gindex < (FT_ULong)globals->glyph_count &&
139 gscripts[gindex] == AF_SCRIPT_LIST_NONE )
140 gscripts[gindex] = (FT_Byte)ss;
145 /* mark ASCII digits */
146 for ( i = 0x30; i <= 0x39; i++ )
148 FT_UInt gindex = FT_Get_Char_Index( face, i );
151 if ( gindex != 0 && gindex < (FT_ULong)globals->glyph_count )
152 gscripts[gindex] |= AF_DIGIT;
157 * By default, all uncovered glyphs are set to the latin script.
158 * XXX: Shouldn't we disable hinting or do something similar?
164 for ( nn = 0; nn < globals->glyph_count; nn++ )
166 if ( ( gscripts[nn] & ~AF_DIGIT ) == AF_SCRIPT_LIST_NONE )
168 gscripts[nn] &= ~AF_SCRIPT_LIST_NONE;
169 gscripts[nn] |= AF_SCRIPT_LIST_DEFAULT;
174 FT_Set_Charmap( face, old_charmap );
179 FT_LOCAL_DEF( FT_Error )
180 af_face_globals_new( FT_Face face,
181 AF_FaceGlobals *aglobals )
185 AF_FaceGlobals globals = NULL;
188 memory = face->memory;
190 if ( !FT_ALLOC( globals, sizeof ( *globals ) +
191 face->num_glyphs * sizeof ( FT_Byte ) ) )
193 globals->face = face;
194 globals->glyph_count = face->num_glyphs;
195 globals->glyph_scripts = (FT_Byte*)( globals + 1 );
197 error = af_face_globals_compute_script_coverage( globals );
200 af_face_globals_free( globals );
211 af_face_globals_free( AF_FaceGlobals globals )
215 FT_Memory memory = globals->face->memory;
219 for ( nn = 0; nn < AF_SCRIPT_MAX; nn++ )
221 if ( globals->metrics[nn] )
223 AF_ScriptClass clazz = AF_SCRIPT_CLASSES_GET[nn];
226 FT_ASSERT( globals->metrics[nn]->clazz == clazz );
228 if ( clazz->script_metrics_done )
229 clazz->script_metrics_done( globals->metrics[nn] );
231 FT_FREE( globals->metrics[nn] );
235 globals->glyph_count = 0;
236 globals->glyph_scripts = NULL; /* no need to free this one! */
237 globals->face = NULL;
244 FT_LOCAL_DEF( FT_Error )
245 af_face_globals_get_metrics( AF_FaceGlobals globals,
248 AF_ScriptMetrics *ametrics )
250 AF_ScriptMetrics metrics = NULL;
252 AF_ScriptClass clazz;
253 FT_UInt script = options & 15;
254 const FT_Offset script_max = sizeof ( AF_SCRIPT_CLASSES_GET ) /
255 sizeof ( AF_SCRIPT_CLASSES_GET[0] );
256 FT_Error error = AF_Err_Ok;
259 if ( gindex >= (FT_ULong)globals->glyph_count )
261 error = AF_Err_Invalid_Argument;
266 if ( gidx == 0 || gidx + 1 >= script_max )
267 gidx = globals->glyph_scripts[gindex] & AF_SCRIPT_LIST_NONE;
269 clazz = AF_SCRIPT_CLASSES_GET[gidx];
271 script = clazz->script;
273 metrics = globals->metrics[clazz->script];
274 if ( metrics == NULL )
276 /* create the global metrics object when needed */
277 FT_Memory memory = globals->face->memory;
280 if ( FT_ALLOC( metrics, clazz->script_metrics_size ) )
283 metrics->clazz = clazz;
285 if ( clazz->script_metrics_init )
287 error = clazz->script_metrics_init( metrics, globals->face );
290 if ( clazz->script_metrics_done )
291 clazz->script_metrics_done( metrics );
298 globals->metrics[clazz->script] = metrics;
308 FT_LOCAL_DEF( FT_Bool )
309 af_face_globals_is_digit( AF_FaceGlobals globals,
312 if ( gindex < (FT_ULong)globals->glyph_count )
313 return (FT_Bool)( globals->glyph_scripts[gindex] & AF_DIGIT );