1 /***************************************************************************/
5 /* Auxiliary functions and data structures related to PostScript fonts */
8 /* Copyright 1996-2001, 2002, 2003, 2004, 2006 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_INFO
,
201 T1_FIELD_LOCATION_PRIVATE
,
202 T1_FIELD_LOCATION_BBOX
,
203 T1_FIELD_LOCATION_LOADER
,
204 T1_FIELD_LOCATION_FACE
,
205 T1_FIELD_LOCATION_BLEND
,
208 T1_FIELD_LOCATION_MAX
214 (*T1_Field_ParseFunc
)( FT_Face face
,
218 /* structure type used to model object fields */
219 typedef struct T1_FieldRec_
221 const char* ident
; /* field identifier */
222 T1_FieldLocation location
;
223 T1_FieldType type
; /* type of field */
224 T1_Field_ParseFunc reader
;
225 FT_UInt offset
; /* offset of field in object */
226 FT_Byte size
; /* size of field in bytes */
227 FT_UInt array_max
; /* maximal number of elements for */
229 FT_UInt count_offset
; /* offset of element count for */
231 FT_UInt dict
; /* where we expect it */
234 #define T1_FIELD_DICT_FONTDICT ( 1 << 0 ) /* also FontInfo and FDArray */
235 #define T1_FIELD_DICT_PRIVATE ( 1 << 1 )
239 #define T1_NEW_SIMPLE_FIELD( _ident, _type, _fname, _dict ) \
241 _ident, T1CODE, _type, \
243 FT_FIELD_OFFSET( _fname ), \
244 FT_FIELD_SIZE( _fname ), \
249 #define T1_NEW_CALLBACK_FIELD( _ident, _reader, _dict ) \
251 _ident, T1CODE, T1_FIELD_TYPE_CALLBACK, \
252 (T1_Field_ParseFunc)_reader, \
258 #define T1_NEW_TABLE_FIELD( _ident, _type, _fname, _max, _dict ) \
260 _ident, T1CODE, _type, \
262 FT_FIELD_OFFSET( _fname ), \
263 FT_FIELD_SIZE_DELTA( _fname ), \
265 FT_FIELD_OFFSET( num_ ## _fname ), \
269 #define T1_NEW_TABLE_FIELD2( _ident, _type, _fname, _max, _dict ) \
271 _ident, T1CODE, _type, \
273 FT_FIELD_OFFSET( _fname ), \
274 FT_FIELD_SIZE_DELTA( _fname ), \
280 #define T1_FIELD_BOOL( _ident, _fname, _dict ) \
281 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_BOOL, _fname, _dict )
283 #define T1_FIELD_NUM( _ident, _fname, _dict ) \
284 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_INTEGER, _fname, _dict )
286 #define T1_FIELD_FIXED( _ident, _fname, _dict ) \
287 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_FIXED, _fname, _dict )
289 #define T1_FIELD_FIXED_1000( _ident, _fname, _dict ) \
290 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_FIXED_1000, _fname, \
293 #define T1_FIELD_STRING( _ident, _fname, _dict ) \
294 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_STRING, _fname, _dict )
296 #define T1_FIELD_KEY( _ident, _fname, _dict ) \
297 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_KEY, _fname, _dict )
299 #define T1_FIELD_BBOX( _ident, _fname, _dict ) \
300 T1_NEW_SIMPLE_FIELD( _ident, T1_FIELD_TYPE_BBOX, _fname, _dict )
303 #define T1_FIELD_NUM_TABLE( _ident, _fname, _fmax, _dict ) \
304 T1_NEW_TABLE_FIELD( _ident, T1_FIELD_TYPE_INTEGER_ARRAY, \
305 _fname, _fmax, _dict )
307 #define T1_FIELD_FIXED_TABLE( _ident, _fname, _fmax, _dict ) \
308 T1_NEW_TABLE_FIELD( _ident, T1_FIELD_TYPE_FIXED_ARRAY, \
309 _fname, _fmax, _dict )
311 #define T1_FIELD_NUM_TABLE2( _ident, _fname, _fmax, _dict ) \
312 T1_NEW_TABLE_FIELD2( _ident, T1_FIELD_TYPE_INTEGER_ARRAY, \
313 _fname, _fmax, _dict )
315 #define T1_FIELD_FIXED_TABLE2( _ident, _fname, _fmax, _dict ) \
316 T1_NEW_TABLE_FIELD2( _ident, T1_FIELD_TYPE_FIXED_ARRAY, \
317 _fname, _fmax, _dict )
319 #define T1_FIELD_CALLBACK( _ident, _name, _dict ) \
320 T1_NEW_CALLBACK_FIELD( _ident, _name, _dict )
323 /*************************************************************************/
324 /*************************************************************************/
326 /***** T1 PARSER *****/
328 /*************************************************************************/
329 /*************************************************************************/
331 typedef const struct PS_Parser_FuncsRec_
* PS_Parser_Funcs
;
333 typedef struct PS_Parser_FuncsRec_
336 (*init
)( PS_Parser parser
,
342 (*done
)( PS_Parser parser
);
345 (*skip_spaces
)( PS_Parser parser
);
347 (*skip_PS_token
)( PS_Parser parser
);
350 (*to_int
)( PS_Parser parser
);
352 (*to_fixed
)( PS_Parser parser
,
356 (*to_bytes
)( PS_Parser parser
,
360 FT_Bool delimiters
);
363 (*to_coord_array
)( PS_Parser parser
,
367 (*to_fixed_array
)( PS_Parser parser
,
373 (*to_token
)( PS_Parser parser
,
376 (*to_token_array
)( PS_Parser parser
,
379 FT_Int
* pnum_tokens
);
382 (*load_field
)( PS_Parser parser
,
383 const T1_Field field
,
389 (*load_field_table
)( PS_Parser parser
,
390 const T1_Field field
,
395 } PS_Parser_FuncsRec
;
398 /*************************************************************************/
404 /* A PS_Parser is an object used to parse a Type 1 font very quickly. */
407 /* cursor :: The current position in the text. */
409 /* base :: Start of the processed text. */
411 /* limit :: End of the processed text. */
413 /* error :: The last error returned. */
415 /* memory :: The object used for memory operations (alloc/realloc). */
417 /* funcs :: A table of functions for the parser. */
419 typedef struct PS_ParserRec_
427 PS_Parser_FuncsRec funcs
;
432 /*************************************************************************/
433 /*************************************************************************/
435 /***** T1 BUILDER *****/
437 /*************************************************************************/
438 /*************************************************************************/
441 typedef struct T1_BuilderRec_
* T1_Builder
;
445 (*T1_Builder_Check_Points_Func
)( T1_Builder builder
,
449 (*T1_Builder_Add_Point_Func
)( T1_Builder builder
,
455 (*T1_Builder_Add_Point1_Func
)( T1_Builder builder
,
460 (*T1_Builder_Add_Contour_Func
)( T1_Builder builder
);
463 (*T1_Builder_Start_Point_Func
)( T1_Builder builder
,
468 (*T1_Builder_Close_Contour_Func
)( T1_Builder builder
);
471 typedef const struct T1_Builder_FuncsRec_
* T1_Builder_Funcs
;
473 typedef struct T1_Builder_FuncsRec_
476 (*init
)( T1_Builder builder
,
483 (*done
)( T1_Builder builder
);
485 T1_Builder_Check_Points_Func check_points
;
486 T1_Builder_Add_Point_Func add_point
;
487 T1_Builder_Add_Point1_Func add_point1
;
488 T1_Builder_Add_Contour_Func add_contour
;
489 T1_Builder_Start_Point_Func start_point
;
490 T1_Builder_Close_Contour_Func close_contour
;
492 } T1_Builder_FuncsRec
;
495 /* an enumeration type to handle charstring parsing states */
496 typedef enum T1_ParseState_
500 T1_Parse_Have_Moveto
,
506 /*************************************************************************/
512 /* A structure used during glyph loading to store its outline. */
515 /* memory :: The current memory object. */
517 /* face :: The current face object. */
519 /* glyph :: The current glyph slot. */
523 /* base :: The base glyph outline. */
525 /* current :: The current glyph outline. */
527 /* max_points :: maximum points in builder outline */
529 /* max_contours :: Maximal number of contours in builder outline. */
531 /* last :: The last point position. */
533 /* scale_x :: The horizontal scaling value (FUnits to */
536 /* scale_y :: The vertical scaling value (FUnits to sub-pixels). */
538 /* pos_x :: The horizontal translation (if composite glyph). */
540 /* pos_y :: The vertical translation (if composite glyph). */
542 /* left_bearing :: The left side bearing point. */
544 /* advance :: The horizontal advance vector. */
546 /* bbox :: Unused. */
548 /* parse_state :: An enumeration which controls the charstring */
551 /* load_points :: If this flag is not set, no points are loaded. */
553 /* no_recurse :: Set but not used. */
555 /* metrics_only :: A boolean indicating that we only want to compute */
556 /* the metrics of a given glyph, not load all of its */
559 /* funcs :: An array of function pointers for the builder. */
561 typedef struct T1_BuilderRec_
566 FT_GlyphLoader loader
;
578 FT_Vector left_bearing
;
581 FT_BBox bbox
; /* bounding box */
582 T1_ParseState parse_state
;
587 FT_Bool metrics_only
;
589 void* hints_funcs
; /* hinter-specific */
590 void* hints_globals
; /* hinter-specific */
592 T1_Builder_FuncsRec funcs
;
597 /*************************************************************************/
598 /*************************************************************************/
600 /***** T1 DECODER *****/
602 /*************************************************************************/
603 /*************************************************************************/
607 /*************************************************************************/
609 /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */
610 /* calls during glyph loading. */
612 #define T1_MAX_SUBRS_CALLS 8
615 /*************************************************************************/
617 /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */
618 /* minimum of 16 is required. */
620 #define T1_MAX_CHARSTRINGS_OPERANDS 32
625 typedef struct T1_Decoder_ZoneRec_
631 } T1_Decoder_ZoneRec
, *T1_Decoder_Zone
;
634 typedef struct T1_DecoderRec_
* T1_Decoder
;
635 typedef const struct T1_Decoder_FuncsRec_
* T1_Decoder_Funcs
;
639 (*T1_Decoder_Callback
)( T1_Decoder decoder
,
640 FT_UInt glyph_index
);
643 typedef struct T1_Decoder_FuncsRec_
646 (*init
)( T1_Decoder decoder
,
650 FT_Byte
** glyph_names
,
653 FT_Render_Mode hint_mode
,
654 T1_Decoder_Callback callback
);
657 (*done
)( T1_Decoder decoder
);
660 (*parse_charstrings
)( T1_Decoder decoder
,
664 } T1_Decoder_FuncsRec
;
667 typedef struct T1_DecoderRec_
669 T1_BuilderRec builder
;
671 FT_Long stack
[T1_MAX_CHARSTRINGS_OPERANDS
];
674 T1_Decoder_ZoneRec zones
[T1_MAX_SUBRS_CALLS
+ 1];
675 T1_Decoder_Zone zone
;
677 FT_Service_PsCMaps psnames
; /* for seac */
679 FT_Byte
** glyph_names
;
681 FT_Int lenIV
; /* internal for sub routine calls */
684 FT_PtrDist
* subrs_len
; /* array of subrs length (optional) */
686 FT_Matrix font_matrix
;
687 FT_Vector font_offset
;
690 FT_Int num_flex_vectors
;
691 FT_Vector flex_vectors
[7];
693 PS_Blend blend
; /* for multiple master support */
695 FT_Render_Mode hint_mode
;
697 T1_Decoder_Callback parse_callback
;
698 T1_Decoder_FuncsRec funcs
;
701 FT_UInt len_buildchar
;
706 /*************************************************************************/
707 /*************************************************************************/
709 /***** AFM PARSER *****/
711 /*************************************************************************/
712 /*************************************************************************/
714 typedef struct AFM_ParserRec_
* AFM_Parser
;
716 typedef struct AFM_Parser_FuncsRec_
719 (*init
)( AFM_Parser parser
,
725 (*done
)( AFM_Parser parser
);
728 (*parse
)( AFM_Parser parser
);
730 } AFM_Parser_FuncsRec
;
733 typedef struct AFM_StreamRec_
* AFM_Stream
;
736 /*************************************************************************/
742 /* An AFM_Parser is a parser for the AFM files. */
745 /* memory :: The object used for memory operations (alloc and */
748 /* stream :: This is an opaque object. */
750 /* FontInfo :: The result will be stored here. */
752 /* get_index :: A user provided function to get a glyph index by its */
755 typedef struct AFM_ParserRec_
760 AFM_FontInfo FontInfo
;
763 (*get_index
)( const char* name
,
772 /*************************************************************************/
773 /*************************************************************************/
775 /***** TYPE1 CHARMAPS *****/
777 /*************************************************************************/
778 /*************************************************************************/
780 typedef const struct T1_CMap_ClassesRec_
* T1_CMap_Classes
;
782 typedef struct T1_CMap_ClassesRec_
784 FT_CMap_Class standard
;
785 FT_CMap_Class expert
;
786 FT_CMap_Class custom
;
787 FT_CMap_Class unicode
;
789 } T1_CMap_ClassesRec
;
792 /*************************************************************************/
793 /*************************************************************************/
795 /***** PSAux Module Interface *****/
797 /*************************************************************************/
798 /*************************************************************************/
800 typedef struct PSAux_ServiceRec_
802 /* don't use `PS_Table_Funcs' and friends to avoid compiler warnings */
803 const PS_Table_FuncsRec
* ps_table_funcs
;
804 const PS_Parser_FuncsRec
* ps_parser_funcs
;
805 const T1_Builder_FuncsRec
* t1_builder_funcs
;
806 const T1_Decoder_FuncsRec
* t1_decoder_funcs
;
809 (*t1_decrypt
)( FT_Byte
* buffer
,
813 T1_CMap_Classes t1_cmap_classes
;
815 /* fields after this comment line were added after version 2.1.10 */
816 const AFM_Parser_FuncsRec
* afm_parser_funcs
;
818 } PSAux_ServiceRec
, *PSAux_Service
;
820 /* backwards-compatible type definition */
821 typedef PSAux_ServiceRec PSAux_Interface
;
824 /*************************************************************************/
825 /*************************************************************************/
827 /***** Some convenience functions *****/
829 /*************************************************************************/
830 /*************************************************************************/
832 #define IS_PS_NEWLINE( ch ) \
836 #define IS_PS_SPACE( ch ) \
838 IS_PS_NEWLINE( ch ) || \
843 #define IS_PS_SPECIAL( ch ) \
845 (ch) == '(' || (ch) == ')' || \
846 (ch) == '<' || (ch) == '>' || \
847 (ch) == '[' || (ch) == ']' || \
848 (ch) == '{' || (ch) == '}' || \
851 #define IS_PS_DELIM( ch ) \
852 ( IS_PS_SPACE( ch ) || \
853 IS_PS_SPECIAL( ch ) )
855 #define IS_PS_DIGIT( ch ) \
856 ( (ch) >= '0' && (ch) <= '9' )
858 #define IS_PS_XDIGIT( ch ) \
859 ( IS_PS_DIGIT( ch ) || \
860 ( (ch) >= 'A' && (ch) <= 'F' ) || \
861 ( (ch) >= 'a' && (ch) <= 'f' ) )
863 #define IS_PS_BASE85( ch ) \
864 ( (ch) >= '!' && (ch) <= 'u' )
866 #define IS_PS_TOKEN( cur, limit, token ) \
867 ( (char)(cur)[0] == (token)[0] && \
868 ( (cur) + sizeof ( (token) ) == (limit) || \
869 ( (cur) + sizeof( (token) ) < (limit) && \
870 IS_PS_DELIM( (cur)[sizeof ( (token) ) - 1] ) ) ) && \
871 ft_strncmp( (char*)(cur), (token), sizeof ( (token) ) - 1 ) == 0 )
876 #endif /* __PSAUX_H__ */