1 /***************************************************************************/
5 /* Auxiliary functions and data structures related to PostScript fonts */
8 /* Copyright 1996-2001, 2002, 2003, 2004, 2006, 2008, 2009 by */
9 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
11 /* This file is part of the FreeType project, and may only be used, */
12 /* modified, and distributed under the terms of the FreeType project */
13 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
14 /* this file you indicate that you have read the license and */
15 /* understand and accept it fully. */
17 /***************************************************************************/
25 #include FT_INTERNAL_OBJECTS_H
26 #include FT_INTERNAL_TYPE1_TYPES_H
27 #include FT_SERVICE_POSTSCRIPT_CMAPS_H
33 /*************************************************************************/
34 /*************************************************************************/
36 /***** T1_TABLE *****/
38 /*************************************************************************/
39 /*************************************************************************/
42 typedef struct PS_TableRec_* PS_Table;
43 typedef const struct PS_Table_FuncsRec_* PS_Table_Funcs;
46 /*************************************************************************/
49 /* PS_Table_FuncsRec */
52 /* A set of function pointers to manage PS_Table objects. */
55 /* table_init :: Used to initialize a table. */
57 /* table_done :: Finalizes resp. destroy a given table. */
59 /* table_add :: Adds a new object to a table. */
61 /* table_release :: Releases table data, then finalizes it. */
63 typedef struct PS_Table_FuncsRec_
66 (*init)( PS_Table table,
71 (*done)( PS_Table table );
74 (*add)( PS_Table table,
80 (*release)( PS_Table table );
85 /*************************************************************************/
91 /* A PS_Table is a simple object used to store an array of objects in */
92 /* a single memory block. */
95 /* block :: The address in memory of the growheap's block. This */
96 /* can change between two object adds, due to */
99 /* cursor :: The current top of the grow heap within its block. */
101 /* capacity :: The current size of the heap block. Increments by */
104 /* max_elems :: The maximum number of elements in table. */
106 /* num_elems :: The current number of elements in table. */
108 /* elements :: A table of element addresses within the block. */
110 /* lengths :: A table of element sizes within the block. */
112 /* memory :: The object used for memory operations */
113 /* (alloc/realloc). */
115 /* funcs :: A table of method pointers for this object. */
117 typedef struct PS_TableRec_
119 FT_Byte* block; /* current memory block */
120 FT_Offset cursor; /* current cursor in memory block */
121 FT_Offset capacity; /* current size of memory block */
126 FT_Byte** elements; /* addresses of table elements */
127 FT_PtrDist* lengths; /* lengths of table elements */
130 PS_Table_FuncsRec funcs;
135 /*************************************************************************/
136 /*************************************************************************/
138 /***** T1 FIELDS & TOKENS *****/
140 /*************************************************************************/
141 /*************************************************************************/
143 typedef struct PS_ParserRec_* PS_Parser;
145 typedef struct T1_TokenRec_* T1_Token;
147 typedef struct T1_FieldRec_* T1_Field;
150 /* simple enumeration type used to identify token types */
151 typedef enum T1_TokenType_
153 T1_TOKEN_TYPE_NONE = 0,
155 T1_TOKEN_TYPE_STRING,
157 T1_TOKEN_TYPE_KEY, /* aka `name' */
165 /* a simple structure used to identify tokens */
166 typedef struct T1_TokenRec_
168 FT_Byte* start; /* first character of token in input stream */
169 FT_Byte* limit; /* first character after the token */
170 T1_TokenType type; /* type of token */
175 /* enumeration type used to identify object fields */
176 typedef enum T1_FieldType_
178 T1_FIELD_TYPE_NONE = 0,
180 T1_FIELD_TYPE_INTEGER,
182 T1_FIELD_TYPE_FIXED_1000,
183 T1_FIELD_TYPE_STRING,
186 T1_FIELD_TYPE_INTEGER_ARRAY,
187 T1_FIELD_TYPE_FIXED_ARRAY,
188 T1_FIELD_TYPE_CALLBACK,
196 typedef enum T1_FieldLocation_
198 T1_FIELD_LOCATION_CID_INFO,
199 T1_FIELD_LOCATION_FONT_DICT,
200 T1_FIELD_LOCATION_FONT_EXTRA,
201 T1_FIELD_LOCATION_FONT_INFO,
202 T1_FIELD_LOCATION_PRIVATE,
203 T1_FIELD_LOCATION_BBOX,
204 T1_FIELD_LOCATION_LOADER,
205 T1_FIELD_LOCATION_FACE,
206 T1_FIELD_LOCATION_BLEND,
209 T1_FIELD_LOCATION_MAX
215 (*T1_Field_ParseFunc)( FT_Face face,
219 /* structure type used to model object fields */
220 typedef struct T1_FieldRec_
222 const char* ident; /* field identifier */
223 T1_FieldLocation location;
224 T1_FieldType type; /* type of field */
225 T1_Field_ParseFunc reader;
226 FT_UInt offset; /* offset of field in object */
227 FT_Byte size; /* size of field in bytes */
228 FT_UInt array_max; /* maximal number of elements for */
230 FT_UInt count_offset; /* offset of element count for */
231 /* arrays; must not be zero if in */
232 /* use -- in other words, a */
233 /* `num_FOO' element must not */
234 /* start the used structure if we */
235 /* parse a `FOO' array */
236 FT_UInt dict; /* where we expect it */
239 #define T1_FIELD_DICT_FONTDICT ( 1 << 0 ) /* also FontInfo and FDArray */
240 #define T1_FIELD_DICT_PRIVATE ( 1 << 1 )
244 #define T1_NEW_SIMPLE_FIELD( _ident, _type, _fname, _dict ) \
246 _ident, T1CODE, _type, \
248 FT_FIELD_OFFSET( _fname ), \
249 FT_FIELD_SIZE( _fname ), \
254 #define T1_NEW_CALLBACK_FIELD( _ident, _reader, _dict ) \
256 _ident, T1CODE, T1_FIELD_TYPE_CALLBACK, \
257 (T1_Field_ParseFunc)_reader, \
263 #define T1_NEW_TABLE_FIELD( _ident, _type, _fname, _max, _dict ) \
265 _ident, T1CODE, _type, \
267 FT_FIELD_OFFSET( _fname ), \
268 FT_FIELD_SIZE_DELTA( _fname ), \
270 FT_FIELD_OFFSET( num_ ## _fname ), \
274 #define T1_NEW_TABLE_FIELD2( _ident, _type, _fname, _max, _dict ) \
276 _ident, T1CODE, _type, \
278 FT_FIELD_OFFSET( _fname ), \
279 FT_FIELD_SIZE_DELTA( _fname ), \
285 #define T1_FIELD_BOOL( _ident, _fname, _dict ) \
286 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_BOOL, _fname, _dict )
288 #define T1_FIELD_NUM( _ident, _fname, _dict ) \
289 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_INTEGER, _fname, _dict )
291 #define T1_FIELD_FIXED( _ident, _fname, _dict ) \
292 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_FIXED, _fname, _dict )
294 #define T1_FIELD_FIXED_1000( _ident, _fname, _dict ) \
295 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_FIXED_1000, _fname, \
298 #define T1_FIELD_STRING( _ident, _fname, _dict ) \
299 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_STRING, _fname, _dict )
301 #define T1_FIELD_KEY( _ident, _fname, _dict ) \
302 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_KEY, _fname, _dict )
304 #define T1_FIELD_BBOX( _ident, _fname, _dict ) \
305 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_BBOX, _fname, _dict )
308 #define T1_FIELD_NUM_TABLE( _ident, _fname, _fmax, _dict ) \
309 T1_NEW_TABLE_FIELD( _ident, T1_FIELD_TYPE_INTEGER_ARRAY, \
310 _fname, _fmax, _dict )
312 #define T1_FIELD_FIXED_TABLE( _ident, _fname, _fmax, _dict ) \
313 T1_NEW_TABLE_FIELD( _ident, T1_FIELD_TYPE_FIXED_ARRAY, \
314 _fname, _fmax, _dict )
316 #define T1_FIELD_NUM_TABLE2( _ident, _fname, _fmax, _dict ) \
317 T1_NEW_TABLE_FIELD2( _ident, T1_FIELD_TYPE_INTEGER_ARRAY, \
318 _fname, _fmax, _dict )
320 #define T1_FIELD_FIXED_TABLE2( _ident, _fname, _fmax, _dict ) \
321 T1_NEW_TABLE_FIELD2( _ident, T1_FIELD_TYPE_FIXED_ARRAY, \
322 _fname, _fmax, _dict )
324 #define T1_FIELD_CALLBACK( _ident, _name, _dict ) \
325 T1_NEW_CALLBACK_FIELD( _ident, _name, _dict )
328 /*************************************************************************/
329 /*************************************************************************/
331 /***** T1 PARSER *****/
333 /*************************************************************************/
334 /*************************************************************************/
336 typedef const struct PS_Parser_FuncsRec_* PS_Parser_Funcs;
338 typedef struct PS_Parser_FuncsRec_
341 (*init)( PS_Parser parser,
347 (*done)( PS_Parser parser );
350 (*skip_spaces)( PS_Parser parser );
352 (*skip_PS_token)( PS_Parser parser );
355 (*to_int)( PS_Parser parser );
357 (*to_fixed)( PS_Parser parser,
361 (*to_bytes)( PS_Parser parser,
365 FT_Bool delimiters );
368 (*to_coord_array)( PS_Parser parser,
372 (*to_fixed_array)( PS_Parser parser,
378 (*to_token)( PS_Parser parser,
381 (*to_token_array)( PS_Parser parser,
384 FT_Int* pnum_tokens );
387 (*load_field)( PS_Parser parser,
388 const T1_Field field,
394 (*load_field_table)( PS_Parser parser,
395 const T1_Field field,
400 } PS_Parser_FuncsRec;
403 /*************************************************************************/
409 /* A PS_Parser is an object used to parse a Type 1 font very quickly. */
412 /* cursor :: The current position in the text. */
414 /* base :: Start of the processed text. */
416 /* limit :: End of the processed text. */
418 /* error :: The last error returned. */
420 /* memory :: The object used for memory operations (alloc/realloc). */
422 /* funcs :: A table of functions for the parser. */
424 typedef struct PS_ParserRec_
432 PS_Parser_FuncsRec funcs;
437 /*************************************************************************/
438 /*************************************************************************/
440 /***** T1 BUILDER *****/
442 /*************************************************************************/
443 /*************************************************************************/
446 typedef struct T1_BuilderRec_* T1_Builder;
450 (*T1_Builder_Check_Points_Func)( T1_Builder builder,
454 (*T1_Builder_Add_Point_Func)( T1_Builder builder,
460 (*T1_Builder_Add_Point1_Func)( T1_Builder builder,
465 (*T1_Builder_Add_Contour_Func)( T1_Builder builder );
468 (*T1_Builder_Start_Point_Func)( T1_Builder builder,
473 (*T1_Builder_Close_Contour_Func)( T1_Builder builder );
476 typedef const struct T1_Builder_FuncsRec_* T1_Builder_Funcs;
478 typedef struct T1_Builder_FuncsRec_
481 (*init)( T1_Builder builder,
488 (*done)( T1_Builder builder );
490 T1_Builder_Check_Points_Func check_points;
491 T1_Builder_Add_Point_Func add_point;
492 T1_Builder_Add_Point1_Func add_point1;
493 T1_Builder_Add_Contour_Func add_contour;
494 T1_Builder_Start_Point_Func start_point;
495 T1_Builder_Close_Contour_Func close_contour;
497 } T1_Builder_FuncsRec;
500 /* an enumeration type to handle charstring parsing states */
501 typedef enum T1_ParseState_
505 T1_Parse_Have_Moveto,
511 /*************************************************************************/
517 /* A structure used during glyph loading to store its outline. */
520 /* memory :: The current memory object. */
522 /* face :: The current face object. */
524 /* glyph :: The current glyph slot. */
528 /* base :: The base glyph outline. */
530 /* current :: The current glyph outline. */
532 /* max_points :: maximum points in builder outline */
534 /* max_contours :: Maximal number of contours in builder outline. */
536 /* pos_x :: The horizontal translation (if composite glyph). */
538 /* pos_y :: The vertical translation (if composite glyph). */
540 /* left_bearing :: The left side bearing point. */
542 /* advance :: The horizontal advance vector. */
544 /* bbox :: Unused. */
546 /* parse_state :: An enumeration which controls the charstring */
549 /* load_points :: If this flag is not set, no points are loaded. */
551 /* no_recurse :: Set but not used. */
553 /* metrics_only :: A boolean indicating that we only want to compute */
554 /* the metrics of a given glyph, not load all of its */
557 /* funcs :: An array of function pointers for the builder. */
559 typedef struct T1_BuilderRec_
564 FT_GlyphLoader loader;
571 FT_Vector left_bearing;
574 FT_BBox bbox; /* bounding box */
575 T1_ParseState parse_state;
579 FT_Bool metrics_only;
581 void* hints_funcs; /* hinter-specific */
582 void* hints_globals; /* hinter-specific */
584 T1_Builder_FuncsRec funcs;
589 /*************************************************************************/
590 /*************************************************************************/
592 /***** T1 DECODER *****/
594 /*************************************************************************/
595 /*************************************************************************/
599 /*************************************************************************/
601 /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */
602 /* calls during glyph loading. */
604 #define T1_MAX_SUBRS_CALLS 8
607 /*************************************************************************/
609 /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */
610 /* minimum of 16 is required. */
612 #define T1_MAX_CHARSTRINGS_OPERANDS 32
617 typedef struct T1_Decoder_ZoneRec_
623 } T1_Decoder_ZoneRec, *T1_Decoder_Zone;
626 typedef struct T1_DecoderRec_* T1_Decoder;
627 typedef const struct T1_Decoder_FuncsRec_* T1_Decoder_Funcs;
631 (*T1_Decoder_Callback)( T1_Decoder decoder,
632 FT_UInt glyph_index );
635 typedef struct T1_Decoder_FuncsRec_
638 (*init)( T1_Decoder decoder,
642 FT_Byte** glyph_names,
645 FT_Render_Mode hint_mode,
646 T1_Decoder_Callback callback );
649 (*done)( T1_Decoder decoder );
652 (*parse_charstrings)( T1_Decoder decoder,
656 } T1_Decoder_FuncsRec;
659 typedef struct T1_DecoderRec_
661 T1_BuilderRec builder;
663 FT_Long stack[T1_MAX_CHARSTRINGS_OPERANDS];
666 T1_Decoder_ZoneRec zones[T1_MAX_SUBRS_CALLS + 1];
667 T1_Decoder_Zone zone;
669 FT_Service_PsCMaps psnames; /* for seac */
671 FT_Byte** glyph_names;
673 FT_Int lenIV; /* internal for sub routine calls */
676 FT_PtrDist* subrs_len; /* array of subrs length (optional) */
678 FT_Matrix font_matrix;
679 FT_Vector font_offset;
682 FT_Int num_flex_vectors;
683 FT_Vector flex_vectors[7];
685 PS_Blend blend; /* for multiple master support */
687 FT_Render_Mode hint_mode;
689 T1_Decoder_Callback parse_callback;
690 T1_Decoder_FuncsRec funcs;
693 FT_UInt len_buildchar;
700 /*************************************************************************/
701 /*************************************************************************/
703 /***** AFM PARSER *****/
705 /*************************************************************************/
706 /*************************************************************************/
708 typedef struct AFM_ParserRec_* AFM_Parser;
710 typedef struct AFM_Parser_FuncsRec_
713 (*init)( AFM_Parser parser,
719 (*done)( AFM_Parser parser );
722 (*parse)( AFM_Parser parser );
724 } AFM_Parser_FuncsRec;
727 typedef struct AFM_StreamRec_* AFM_Stream;
730 /*************************************************************************/
736 /* An AFM_Parser is a parser for the AFM files. */
739 /* memory :: The object used for memory operations (alloc and */
742 /* stream :: This is an opaque object. */
744 /* FontInfo :: The result will be stored here. */
746 /* get_index :: A user provided function to get a glyph index by its */
749 typedef struct AFM_ParserRec_
754 AFM_FontInfo FontInfo;
757 (*get_index)( const char* name,
766 /*************************************************************************/
767 /*************************************************************************/
769 /***** TYPE1 CHARMAPS *****/
771 /*************************************************************************/
772 /*************************************************************************/
774 typedef const struct T1_CMap_ClassesRec_* T1_CMap_Classes;
776 typedef struct T1_CMap_ClassesRec_
778 FT_CMap_Class standard;
779 FT_CMap_Class expert;
780 FT_CMap_Class custom;
781 FT_CMap_Class unicode;
783 } T1_CMap_ClassesRec;
786 /*************************************************************************/
787 /*************************************************************************/
789 /***** PSAux Module Interface *****/
791 /*************************************************************************/
792 /*************************************************************************/
794 typedef struct PSAux_ServiceRec_
796 /* don't use `PS_Table_Funcs' and friends to avoid compiler warnings */
797 const PS_Table_FuncsRec* ps_table_funcs;
798 const PS_Parser_FuncsRec* ps_parser_funcs;
799 const T1_Builder_FuncsRec* t1_builder_funcs;
800 const T1_Decoder_FuncsRec* t1_decoder_funcs;
803 (*t1_decrypt)( FT_Byte* buffer,
807 T1_CMap_Classes t1_cmap_classes;
809 /* fields after this comment line were added after version 2.1.10 */
810 const AFM_Parser_FuncsRec* afm_parser_funcs;
812 } PSAux_ServiceRec, *PSAux_Service;
814 /* backwards-compatible type definition */
815 typedef PSAux_ServiceRec PSAux_Interface;
818 /*************************************************************************/
819 /*************************************************************************/
821 /***** Some convenience functions *****/
823 /*************************************************************************/
824 /*************************************************************************/
826 #define IS_PS_NEWLINE( ch ) \
830 #define IS_PS_SPACE( ch ) \
832 IS_PS_NEWLINE( ch ) || \
837 #define IS_PS_SPECIAL( ch ) \
839 (ch) == '(' || (ch) == ')' || \
840 (ch) == '<' || (ch) == '>' || \
841 (ch) == '[' || (ch) == ']' || \
842 (ch) == '{' || (ch) == '}' || \
845 #define IS_PS_DELIM( ch ) \
846 ( IS_PS_SPACE( ch ) || \
847 IS_PS_SPECIAL( ch ) )
849 #define IS_PS_DIGIT( ch ) \
850 ( (ch) >= '0' && (ch) <= '9' )
852 #define IS_PS_XDIGIT( ch ) \
853 ( IS_PS_DIGIT( ch ) || \
854 ( (ch) >= 'A' && (ch) <= 'F' ) || \
855 ( (ch) >= 'a' && (ch) <= 'f' ) )
857 #define IS_PS_BASE85( ch ) \
858 ( (ch) >= '!' && (ch) <= 'u' )
860 #define IS_PS_TOKEN( cur, limit, token ) \
861 ( (char)(cur)[0] == (token)[0] && \
862 ( (cur) + sizeof ( (token) ) == (limit) || \
863 ( (cur) + sizeof( (token) ) < (limit) && \
864 IS_PS_DELIM( (cur)[sizeof ( (token) ) - 1] ) ) ) && \
865 ft_strncmp( (char*)(cur), (token), sizeof ( (token) ) - 1 ) == 0 )
870 #endif /* __PSAUX_H__ */