1 /***************************************************************************/
5 /* Embedded resource forks accessor (specification). */
7 /* Copyright 2004-2015 by */
8 /* Masatake YAMATO and Redhat K.K. */
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 /***************************************************************************/
18 /***************************************************************************/
19 /* Development of the code in this file is support of */
20 /* Information-technology Promotion Agency, Japan. */
21 /***************************************************************************/
29 #include FT_INTERNAL_OBJECTS_H
35 /* Number of guessing rules supported in `FT_Raccess_Guess'. */
36 /* Don't forget to increment the number if you add a new guessing rule. */
37 #define FT_RACCESS_N_RULES 9
40 /* A structure to describe a reference in a resource by its resource ID */
41 /* and internal offset. The `POST' resource expects to be concatenated */
42 /* by the order of resource IDs instead of its appearance in the file. */
44 typedef struct FT_RFork_Ref_
51 #ifdef FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
53 (*ft_raccess_guess_func
)( FT_Library library
,
56 char **result_file_name
,
57 FT_Long
*result_offset
);
59 typedef enum FT_RFork_Rule_
{
60 FT_RFork_Rule_invalid
= -2,
61 FT_RFork_Rule_uknown
, /* -1 */
62 FT_RFork_Rule_apple_double
,
63 FT_RFork_Rule_apple_single
,
64 FT_RFork_Rule_darwin_ufs_export
,
65 FT_RFork_Rule_darwin_newvfs
,
66 FT_RFork_Rule_darwin_hfsplus
,
68 FT_RFork_Rule_linux_cap
,
69 FT_RFork_Rule_linux_double
,
70 FT_RFork_Rule_linux_netatalk
73 /* For fast translation between rule index and rule type,
74 * the macros FT_RFORK_xxx should be kept consistent with
75 * the raccess_guess_funcs table
77 typedef struct ft_raccess_guess_rec_
{
78 ft_raccess_guess_func func
;
80 } ft_raccess_guess_rec
;
82 #ifndef FT_CONFIG_OPTION_PIC
84 /* this array is a storage in non-PIC mode, so ; is needed in END */
85 #define CONST_FT_RFORK_RULE_ARRAY_BEGIN( name, type ) \
86 static const type name[] = {
87 #define CONST_FT_RFORK_RULE_ARRAY_ENTRY( func_suffix, type_suffix ) \
88 { raccess_guess_ ## func_suffix, \
89 FT_RFork_Rule_ ## type_suffix },
90 #define CONST_FT_RFORK_RULE_ARRAY_END };
92 #else /* FT_CONFIG_OPTION_PIC */
94 /* this array is a function in PIC mode, so no ; is needed in END */
95 #define CONST_FT_RFORK_RULE_ARRAY_BEGIN( name, type ) \
97 FT_Init_Table_ ## name( type* storage ) \
99 type* local = storage; \
103 #define CONST_FT_RFORK_RULE_ARRAY_ENTRY( func_suffix, type_suffix ) \
104 local[i].func = raccess_guess_ ## func_suffix; \
105 local[i].type = FT_RFork_Rule_ ## type_suffix; \
107 #define CONST_FT_RFORK_RULE_ARRAY_END }
109 #endif /* FT_CONFIG_OPTION_PIC */
111 #endif /* FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK */
114 /*************************************************************************/
117 /* FT_Raccess_Guess */
120 /* Guess a file name and offset where the actual resource fork is */
121 /* stored. The macro FT_RACCESS_N_RULES holds the number of */
122 /* guessing rules; the guessed result for the Nth rule is */
123 /* represented as a triplet: a new file name (new_names[N]), a file */
124 /* offset (offsets[N]), and an error code (errors[N]). */
128 /* A FreeType library instance. */
131 /* A file stream containing the resource fork. */
134 /* The (base) file name of the resource fork used for some */
135 /* guessing rules. */
139 /* An array of guessed file names in which the resource forks may */
140 /* exist. If `new_names[N]' is NULL, the guessed file name is */
141 /* equal to `base_name'. */
144 /* An array of guessed file offsets. `offsets[N]' holds the file */
145 /* offset of the possible start of the resource fork in file */
146 /* `new_names[N]'. */
149 /* An array of FreeType error codes. `errors[N]' is the error */
150 /* code of Nth guessing rule function. If `errors[N]' is not */
151 /* FT_Err_Ok, `new_names[N]' and `offsets[N]' are meaningless. */
154 FT_Raccess_Guess( FT_Library library
,
162 /*************************************************************************/
165 /* FT_Raccess_Get_HeaderInfo */
168 /* Get the information from the header of resource fork. The */
169 /* information includes the file offset where the resource map */
170 /* starts, and the file offset where the resource data starts. */
171 /* `FT_Raccess_Get_DataOffsets' requires these two data. */
175 /* A FreeType library instance. */
178 /* A file stream containing the resource fork. */
180 /* rfork_offset :: */
181 /* The file offset where the resource fork starts. */
185 /* The file offset where the resource map starts. */
188 /* The file offset where the resource data starts. */
191 /* FreeType error code. FT_Err_Ok means success. */
194 FT_Raccess_Get_HeaderInfo( FT_Library library
,
196 FT_Long rfork_offset
,
198 FT_Long
*rdata_pos
);
201 /*************************************************************************/
204 /* FT_Raccess_Get_DataOffsets */
207 /* Get the data offsets for a tag in a resource fork. Offsets are */
208 /* stored in an array because, in some cases, resources in a resource */
209 /* fork have the same tag. */
213 /* A FreeType library instance. */
216 /* A file stream containing the resource fork. */
219 /* The file offset where the resource map starts. */
222 /* The file offset where the resource data starts. */
225 /* The resource tag. */
227 /* sort_by_res_id :: */
228 /* A Boolean to sort the fragmented resource by their ids. */
229 /* The fragmented resources for `POST' resource should be sorted */
230 /* to restore Type1 font properly. For `snft' resources, sorting */
231 /* may induce a different order of the faces in comparison to that */
232 /* by QuickDraw API. */
236 /* The stream offsets for the resource data specified by `tag'. */
237 /* This array is allocated by the function, so you have to call */
238 /* @ft_mem_free after use. */
241 /* The length of offsets array. */
244 /* FreeType error code. FT_Err_Ok means success. */
247 /* Normally you should use `FT_Raccess_Get_HeaderInfo' to get the */
248 /* value for `map_offset' and `rdata_pos'. */
251 FT_Raccess_Get_DataOffsets( FT_Library library
,
256 FT_Bool sort_by_res_id
,
263 #endif /* __FTRFORK_H__ */