Disabling auto-refresh of game list by default, as it is causing bugs sometimes
[open-ps2-loader.git] / thirdparty / freetype-2.3.12 / src / type1 / t1parse.c
blob2a762279fd3693837a4917818a8593fe68078a85
1 /***************************************************************************/
2 /* */
3 /* t1parse.c */
4 /* */
5 /* Type 1 parser (body). */
6 /* */
7 /* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2008, 2009 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
9 /* */
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. */
15 /* */
16 /***************************************************************************/
19 /*************************************************************************/
20 /* */
21 /* The Type 1 parser is in charge of the following: */
22 /* */
23 /* - provide an implementation of a growing sequence of objects called */
24 /* a `T1_Table' (used to build various tables needed by the loader). */
25 /* */
26 /* - opening .pfb and .pfa files to extract their top-level and private */
27 /* dictionaries. */
28 /* */
29 /* - read numbers, arrays & strings from any dictionary. */
30 /* */
31 /* See `t1load.c' to see how data is loaded from the font file. */
32 /* */
33 /*************************************************************************/
36 #include <ft2build.h>
37 #include FT_INTERNAL_DEBUG_H
38 #include FT_INTERNAL_STREAM_H
39 #include FT_INTERNAL_POSTSCRIPT_AUX_H
41 #include "t1parse.h"
43 #include "t1errors.h"
46 /*************************************************************************/
47 /* */
48 /* The macro FT_COMPONENT is used in trace mode. It is an implicit */
49 /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log */
50 /* messages during execution. */
51 /* */
52 #undef FT_COMPONENT
53 #define FT_COMPONENT trace_t1parse
56 /*************************************************************************/
57 /*************************************************************************/
58 /*************************************************************************/
59 /***** *****/
60 /***** INPUT STREAM PARSER *****/
61 /***** *****/
62 /*************************************************************************/
63 /*************************************************************************/
64 /*************************************************************************/
67 /* see Adobe Technical Note 5040.Download_Fonts.pdf */
69 static FT_Error
70 read_pfb_tag( FT_Stream stream,
71 FT_UShort *atag,
72 FT_ULong *asize )
74 FT_Error error;
75 FT_UShort tag;
76 FT_ULong size;
79 *atag = 0;
80 *asize = 0;
82 if ( !FT_READ_USHORT( tag ) )
84 if ( tag == 0x8001U || tag == 0x8002U )
86 if ( !FT_READ_ULONG_LE( size ) )
87 *asize = size;
90 *atag = tag;
93 return error;
97 static FT_Error
98 check_type1_format( FT_Stream stream,
99 const char* header_string,
100 size_t header_length )
102 FT_Error error;
103 FT_UShort tag;
104 FT_ULong dummy;
107 if ( FT_STREAM_SEEK( 0 ) )
108 goto Exit;
110 error = read_pfb_tag( stream, &tag, &dummy );
111 if ( error )
112 goto Exit;
114 /* We assume that the first segment in a PFB is always encoded as */
115 /* text. This might be wrong (and the specification doesn't insist */
116 /* on that), but we have never seen a counterexample. */
117 if ( tag != 0x8001U && FT_STREAM_SEEK( 0 ) )
118 goto Exit;
120 if ( !FT_FRAME_ENTER( header_length ) )
122 error = T1_Err_Ok;
124 if ( ft_memcmp( stream->cursor, header_string, header_length ) != 0 )
125 error = T1_Err_Unknown_File_Format;
127 FT_FRAME_EXIT();
130 Exit:
131 return error;
135 FT_LOCAL_DEF( FT_Error )
136 T1_New_Parser( T1_Parser parser,
137 FT_Stream stream,
138 FT_Memory memory,
139 PSAux_Service psaux )
141 FT_Error error;
142 FT_UShort tag;
143 FT_ULong size;
146 psaux->ps_parser_funcs->init( &parser->root, 0, 0, memory );
148 parser->stream = stream;
149 parser->base_len = 0;
150 parser->base_dict = 0;
151 parser->private_len = 0;
152 parser->private_dict = 0;
153 parser->in_pfb = 0;
154 parser->in_memory = 0;
155 parser->single_block = 0;
157 /* check the header format */
158 error = check_type1_format( stream, "%!PS-AdobeFont", 14 );
159 if ( error )
161 if ( error != T1_Err_Unknown_File_Format )
162 goto Exit;
164 error = check_type1_format( stream, "%!FontType", 10 );
165 if ( error )
167 FT_TRACE2(( "[not a Type1 font]\n" ));
168 goto Exit;
172 /******************************************************************/
173 /* */
174 /* Here a short summary of what is going on: */
175 /* */
176 /* When creating a new Type 1 parser, we try to locate and load */
177 /* the base dictionary if this is possible (i.e., for PFB */
178 /* files). Otherwise, we load the whole font into memory. */
179 /* */
180 /* When `loading' the base dictionary, we only setup pointers */
181 /* in the case of a memory-based stream. Otherwise, we */
182 /* allocate and load the base dictionary in it. */
183 /* */
184 /* parser->in_pfb is set if we are in a binary (`.pfb') font. */
185 /* parser->in_memory is set if we have a memory stream. */
186 /* */
188 /* try to compute the size of the base dictionary; */
189 /* look for a Postscript binary file tag, i.e., 0x8001 */
190 if ( FT_STREAM_SEEK( 0L ) )
191 goto Exit;
193 error = read_pfb_tag( stream, &tag, &size );
194 if ( error )
195 goto Exit;
197 if ( tag != 0x8001U )
199 /* assume that this is a PFA file for now; an error will */
200 /* be produced later when more things are checked */
201 if ( FT_STREAM_SEEK( 0L ) )
202 goto Exit;
203 size = stream->size;
205 else
206 parser->in_pfb = 1;
208 /* now, try to load `size' bytes of the `base' dictionary we */
209 /* found previously */
211 /* if it is a memory-based resource, set up pointers */
212 if ( !stream->read )
214 parser->base_dict = (FT_Byte*)stream->base + stream->pos;
215 parser->base_len = size;
216 parser->in_memory = 1;
218 /* check that the `size' field is valid */
219 if ( FT_STREAM_SKIP( size ) )
220 goto Exit;
222 else
224 /* read segment in memory -- this is clumsy, but so does the format */
225 if ( FT_ALLOC( parser->base_dict, size ) ||
226 FT_STREAM_READ( parser->base_dict, size ) )
227 goto Exit;
228 parser->base_len = size;
231 parser->root.base = parser->base_dict;
232 parser->root.cursor = parser->base_dict;
233 parser->root.limit = parser->root.cursor + parser->base_len;
235 Exit:
236 if ( error && !parser->in_memory )
237 FT_FREE( parser->base_dict );
239 return error;
243 FT_LOCAL_DEF( void )
244 T1_Finalize_Parser( T1_Parser parser )
246 FT_Memory memory = parser->root.memory;
249 /* always free the private dictionary */
250 FT_FREE( parser->private_dict );
252 /* free the base dictionary only when we have a disk stream */
253 if ( !parser->in_memory )
254 FT_FREE( parser->base_dict );
256 parser->root.funcs.done( &parser->root );
260 FT_LOCAL_DEF( FT_Error )
261 T1_Get_Private_Dict( T1_Parser parser,
262 PSAux_Service psaux )
264 FT_Stream stream = parser->stream;
265 FT_Memory memory = parser->root.memory;
266 FT_Error error = T1_Err_Ok;
267 FT_ULong size;
270 if ( parser->in_pfb )
272 /* in the case of the PFB format, the private dictionary can be */
273 /* made of several segments. We thus first read the number of */
274 /* segments to compute the total size of the private dictionary */
275 /* then re-read them into memory. */
276 FT_Long start_pos = FT_STREAM_POS();
277 FT_UShort tag;
280 parser->private_len = 0;
281 for (;;)
283 error = read_pfb_tag( stream, &tag, &size );
284 if ( error )
285 goto Fail;
287 if ( tag != 0x8002U )
288 break;
290 parser->private_len += size;
292 if ( FT_STREAM_SKIP( size ) )
293 goto Fail;
296 /* Check that we have a private dictionary there */
297 /* and allocate private dictionary buffer */
298 if ( parser->private_len == 0 )
300 FT_ERROR(( "T1_Get_Private_Dict:"
301 " invalid private dictionary section\n" ));
302 error = T1_Err_Invalid_File_Format;
303 goto Fail;
306 if ( FT_STREAM_SEEK( start_pos ) ||
307 FT_ALLOC( parser->private_dict, parser->private_len ) )
308 goto Fail;
310 parser->private_len = 0;
311 for (;;)
313 error = read_pfb_tag( stream, &tag, &size );
314 if ( error || tag != 0x8002U )
316 error = T1_Err_Ok;
317 break;
320 if ( FT_STREAM_READ( parser->private_dict + parser->private_len,
321 size ) )
322 goto Fail;
324 parser->private_len += size;
327 else
329 /* We have already `loaded' the whole PFA font file into memory; */
330 /* if this is a memory resource, allocate a new block to hold */
331 /* the private dict. Otherwise, simply overwrite into the base */
332 /* dictionary block in the heap. */
334 /* first of all, look at the `eexec' keyword */
335 FT_Byte* cur = parser->base_dict;
336 FT_Byte* limit = cur + parser->base_len;
337 FT_Byte c;
340 Again:
341 for (;;)
343 c = cur[0];
344 if ( c == 'e' && cur + 9 < limit ) /* 9 = 5 letters for `eexec' + */
345 /* newline + 4 chars */
347 if ( cur[1] == 'e' &&
348 cur[2] == 'x' &&
349 cur[3] == 'e' &&
350 cur[4] == 'c' )
351 break;
353 cur++;
354 if ( cur >= limit )
356 FT_ERROR(( "T1_Get_Private_Dict:"
357 " could not find `eexec' keyword\n" ));
358 error = T1_Err_Invalid_File_Format;
359 goto Exit;
363 /* check whether `eexec' was real -- it could be in a comment */
364 /* or string (as e.g. in u003043t.gsf from ghostscript) */
366 parser->root.cursor = parser->base_dict;
367 parser->root.limit = cur + 9;
369 cur = parser->root.cursor;
370 limit = parser->root.limit;
372 while ( cur < limit )
374 if ( *cur == 'e' && ft_strncmp( (char*)cur, "eexec", 5 ) == 0 )
375 goto Found;
377 T1_Skip_PS_Token( parser );
378 if ( parser->root.error )
379 break;
380 T1_Skip_Spaces ( parser );
381 cur = parser->root.cursor;
384 /* we haven't found the correct `eexec'; go back and continue */
385 /* searching */
387 cur = limit;
388 limit = parser->base_dict + parser->base_len;
389 goto Again;
391 /* now determine where to write the _encrypted_ binary private */
392 /* dictionary. We overwrite the base dictionary for disk-based */
393 /* resources and allocate a new block otherwise */
395 Found:
396 parser->root.limit = parser->base_dict + parser->base_len;
398 T1_Skip_PS_Token( parser );
399 cur = parser->root.cursor;
401 /* according to the Type1 spec, the first cipher byte must not be */
402 /* an ASCII whitespace character code (blank, tab, carriage return */
403 /* or line feed). We have seen Type 1 fonts with two line feed */
404 /* characters... So skip now all whitespace character codes. */
405 while ( cur < limit &&
406 ( *cur == ' ' ||
407 *cur == '\t' ||
408 *cur == '\r' ||
409 *cur == '\n' ) )
410 ++cur;
411 if ( cur >= limit )
413 FT_ERROR(( "T1_Get_Private_Dict:"
414 " `eexec' not properly terminated\n" ));
415 error = T1_Err_Invalid_File_Format;
416 goto Exit;
419 size = parser->base_len - ( cur - parser->base_dict );
421 if ( parser->in_memory )
423 /* note that we allocate one more byte to put a terminating `0' */
424 if ( FT_ALLOC( parser->private_dict, size + 1 ) )
425 goto Fail;
426 parser->private_len = size;
428 else
430 parser->single_block = 1;
431 parser->private_dict = parser->base_dict;
432 parser->private_len = size;
433 parser->base_dict = 0;
434 parser->base_len = 0;
437 /* now determine whether the private dictionary is encoded in binary */
438 /* or hexadecimal ASCII format -- decode it accordingly */
440 /* we need to access the next 4 bytes (after the final \r following */
441 /* the `eexec' keyword); if they all are hexadecimal digits, then */
442 /* we have a case of ASCII storage */
444 if ( ft_isxdigit( cur[0] ) && ft_isxdigit( cur[1] ) &&
445 ft_isxdigit( cur[2] ) && ft_isxdigit( cur[3] ) )
447 /* ASCII hexadecimal encoding */
448 FT_Long len;
451 parser->root.cursor = cur;
452 (void)psaux->ps_parser_funcs->to_bytes( &parser->root,
453 parser->private_dict,
454 parser->private_len,
455 &len,
456 0 );
457 parser->private_len = len;
459 /* put a safeguard */
460 parser->private_dict[len] = '\0';
462 else
463 /* binary encoding -- copy the private dict */
464 FT_MEM_MOVE( parser->private_dict, cur, size );
467 /* we now decrypt the encoded binary private dictionary */
468 psaux->t1_decrypt( parser->private_dict, parser->private_len, 55665U );
470 /* replace the four random bytes at the beginning with whitespace */
471 parser->private_dict[0] = ' ';
472 parser->private_dict[1] = ' ';
473 parser->private_dict[2] = ' ';
474 parser->private_dict[3] = ' ';
476 parser->root.base = parser->private_dict;
477 parser->root.cursor = parser->private_dict;
478 parser->root.limit = parser->root.cursor + parser->private_len;
480 Fail:
481 Exit:
482 return error;
486 /* END */