]> granicus.if.org Git - zziplib/blob - zzip/fetch.h
using mksite.sh for doc build
[zziplib] / zzip / fetch.h
1 #ifndef _ZZIP_FORMATS_H
2 #define _ZZIP_FORMATS_H
3
4 #include <zzip/types.h>
5 #include <zzip/format.h> 
6
7 /* linux knows "byteswap.h" giving us an optimized variant */
8 #ifdef ZZIP_HAVE_BYTESWAP_H
9 #include <byteswap.h>
10 #endif
11
12 /* get 16/32 bits from little-endian zip-file to host byteorder */
13 extern uint32_t __zzip_get32(unsigned char * s) __attribute__((const));
14 extern uint16_t __zzip_get16(unsigned char * s) __attribute__((const));
15 extern void     __zzip_set32(unsigned char * s, uint32_t v);
16 extern void     __zzip_set16(unsigned char * s, uint16_t v);
17
18 #ifdef ZZIP_WORDS_BIGENDIAN
19 # if defined bswap_16 && defined bswap_32 /* a.k.a. linux */
20 # define ZZIP_GET16(__p)                        bswap_16(*(uint16_t*)(__p))
21 # define ZZIP_GET32(__p)                        bswap_32(*(uint32_t*)(__p))
22 # define ZZIP_SET16(__p,__x) (*(uint16_t*)(__p) = bswap_16((uint16_t)(__x)))
23 # define ZZIP_SET32(__p,__x) (*(uint32_t*)(__p) = bswap_32((uint32_t)(__x)))
24 # else
25 # define ZZIP_GET32(__p)     (__zzip_get32((__p)))
26 # define ZZIP_GET16(__p)     (__zzip_get16((__p)))
27 # define ZZIP_SET32(__p,__x) (__zzip_set32((__p),(__x)))
28 # define ZZIP_SET16(__p,__x) (__zzip_set16((__p),(__x)))
29 # endif
30 #else /* little endian is the original zip format byteorder */
31 # define ZZIP_GET16(__p)     (*(uint16_t*)(__p))
32 # define ZZIP_GET32(__p)     (*(uint32_t*)(__p))
33 # define ZZIP_SET16(__p,__x) (*(uint16_t*)(__p) = (uint16_t)(__x))
34 # define ZZIP_SET32(__p,__x) (*(uint32_t*)(__p) = (uint32_t)(__x))
35 #endif
36
37 /* ..................... bitcorrect physical access .................... */
38
39 /* zzip_file_header - the local file header */
40 #define zzip_file_header_get_magic(__p)      ZZIP_GET32((__p)->z_magic)
41 #define zzip_file_header_set_magic(__p,__x)  ZZIP_SET32((__p)->z_magic,(__x))
42 #define zzip_file_header_get_flags(__p)      ZZIP_GET16((__p)->z_flags)
43 #define zzip_file_header_set_flags(__p,__x)  ZZIP_SET16((__p)->z_flags,(__x))
44 #define zzip_file_header_get_compr(__p)      ZZIP_GET16((__p)->z_compr)
45 #define zzip_file_header_set_compr(__p,__x)  ZZIP_SET16((__p)->z_compr,(__x))
46 #define zzip_file_header_get_crc32(__p)      ZZIP_GET32((__p)->z_crc32)
47 #define zzip_file_header_set_crc32(__p,__x)  ZZIP_SET32((__p)->z_crc32,(__x))
48 #define zzip_file_header_get_csize(__p)      ZZIP_GET32((__p)->z_csize)
49 #define zzip_file_header_set_csize(__p,__x)  ZZIP_SET32((__p)->z_csize,(__x))
50 #define zzip_file_header_get_usize(__p)      ZZIP_GET32((__p)->z_usize)
51 #define zzip_file_header_set_usize(__p,__x)  ZZIP_SET32((__p)->z_usize,(__x))
52 #define zzip_file_header_get_namlen(__p)     ZZIP_GET16((__p)->z_namlen)
53 #define zzip_file_header_set_namlen(__p,__x) ZZIP_SET16((__p)->z_namlen,(__x))
54 #define zzip_file_header_get_extras(__p)     ZZIP_GET16((__p)->z_extras)
55 #define zzip_file_header_set_extras(__p,__x) ZZIP_SET16((__p)->z_extras,(__x))
56 #define zzip_file_header_sizeof_tails(__p) (zzip_file_header_get_namlen(__p)+\
57                                             zzip_file_header_get_extras(__p) )
58 #define zzip_file_header_check_magic(__p)  ZZIP_FILE_HEADER_CHECKMAGIC((__p))
59
60 /* zzip_file_trailer - data descriptor per file block */
61 #define zzip_file_trailer_get_magic(__p)     ZZIP_GET32((__p)->z_magic)
62 #define zzip_file_trailer_set_magic(__p,__x) ZZIP_SET32((__p)->z_magic,(__x))
63 #define zzip_file_header_get_crc32(__p)      ZZIP_GET32((__p)->z_crc32)
64 #define zzip_file_trailer_set_crc32(__p,__x) ZZIP_SET32((__p)->z_crc32,(__x))
65 #define zzip_file_trailer_get_csize(__p)     ZZIP_GET32((__p)->z_csize)
66 #define zzip_file_trailer_set_csize(__p,__x) ZZIP_SET32((__p)->z_csize,(__x))
67 #define zzip_file_trailer_get_usize(__p)     ZZIP_GET32((__p)->z_usize)
68 #define zzip_file_trailer_set_usize(__p,__x) ZZIP_SET32((__p)->z_usize,(__x))
69 #define zzip_file_trailer_sizeof_tails(__p) 0
70 #define zzip_file_trailer_check_magic(__p)   ZZIP_FILE_TRAILER_CHECKMAGIC((__p))
71 /* zzip_disk_entry (currently named zzip_root_dirent) */
72 #define zzip_disk_entry_get_magic(__p)      ZZIP_GET32((__p)->z_magic)
73 #define zzip_disk_entry_set_magic(__p,__x)  ZZIP_SET32((__p)->z_magic,(__x))
74 #define zzip_disk_entry_get_flags(__p)      ZZIP_GET16((__p)->z_flags)
75 #define zzip_disk_entry_set_flags(__p,__x)  ZZIP_SET16((__p)->z_flags,(__x))
76 #define zzip_disk_entry_get_compr(__p)      ZZIP_GET16((__p)->z_compr)
77 #define zzip_disk_entry_set_compr(__p,__x)  ZZIP_SET16((__p)->z_compr,(__x))
78 #define zzip_disk_entry_get_crc32(__p)      ZZIP_GET32((__p)->z_crc32)
79 #define zzip_disk_entry_set_crc32(__p,__x)  ZZIP_SET32((__p)->z_crc32,(__x))
80 #define zzip_disk_entry_get_csize(__p)      ZZIP_GET32((__p)->z_csize)
81 #define zzip_disk_entry_set_csize(__p,__x)  ZZIP_SET32((__p)->z_csize,(__x))
82 #define zzip_disk_entry_get_usize(__p)      ZZIP_GET32((__p)->z_usize)
83 #define zzip_disk_entry_set_usize(__p,__x)  ZZIP_SET32((__p)->z_usize,(__x))
84 #define zzip_disk_entry_get_namlen(__p)     ZZIP_GET16((__p)->z_namlen)
85 #define zzip_disk_entry_set_namlen(__p,__x) ZZIP_SET16((__p)->z_namlen,(__x))
86 #define zzip_disk_entry_get_extras(__p)     ZZIP_GET16((__p)->z_extras)
87 #define zzip_disk_entry_set_extras(__p,__x) ZZIP_SET16((__p)->z_extras,(__x))
88 #define zzip_disk_entry_get_comment(__p)     ZZIP_GET16((__p)->z_comment)
89 #define zzip_disk_entry_set_comment(__p,__x) ZZIP_SET16((__p)->z_comment,(__x))
90 #define zzip_disk_entry_get_diskstart(__p)     ZZIP_GET16((__p)->z_diskstart)
91 #define zzip_disk_entry_set_diskstart(__p,__x) ZZIP_SET16((__p)->z_diskstart,(__x))
92 #define zzip_disk_entry_get_filetype(__p)     ZZIP_GET16((__p)->z_filetype)
93 #define zzip_disk_entry_set_filetype(__p,__x) ZZIP_SET16((__p)->z_filetype,(__x))
94 #define zzip_disk_entry_get_filemode(__p)     ZZIP_GET32((__p)->z_filemode)
95 #define zzip_disk_entry_set_filemode(__p,__x) ZZIP_SET32((__p)->z_filemode,(__x))
96 #define zzip_disk_entry_get_offset(__p)     ZZIP_GET32((__p)->z_offset)
97 #define zzip_disk_entry_set_offset(__p,__x) ZZIP_SET32((__p)->z_offset,(__x))
98 #define zzip_disk_entry_sizeof_tails(__p) (zzip_disk_entry_get_namlen(__p) +\
99                                            zzip_disk_entry_get_extras(__p) +\
100                                            zzip_disk_entry_get_comment(__p) )
101 #define zzip_disk_entry_check_magic(__p)  ZZIP_DISK_ENTRY_CHECKMAGIC((__p))
102
103 /* zzip_disk_trailer - the zip archive entry point */
104 #define zzip_disk_trailer_get_magic(__p)      ZZIP_GET32((__p)->z_magic)
105 #define zzip_disk_trailer_set_magic(__p,__x)  ZZIP_SET32((__p)->z_magic,(__x))
106 #define zzip_disk_trailer_get_disk(__p)     ZZIP_GET16((__p)->z_disk)
107 #define zzip_disk_trailer_set_disk(__p,__x) ZZIP_SET16((__p)->z_disk,(__x))
108 #define zzip_disk_trailer_get_finaldisk(__p)     ZZIP_GET16((__p)->z_finaldisk)
109 #define zzip_disk_trailer_set_finaldisk(__p,__x) ZZIP_SET16((__p)->z_finaldisk,(__x))
110 #define zzip_disk_trailer_get_entries(__p)     ZZIP_GET16((__p)->z_entries)
111 #define zzip_disk_trailer_set_entries(__p,__x) ZZIP_SET16((__p)->z_entries,(__x))
112 #define zzip_disk_trailer_get_finalentries(__p)     ZZIP_GET16((__p)->z_finalentries)
113 #define zzip_disk_trailer_set_finalentries(__p,__x) ZZIP_SET16((__p)->z_finalentries,(__x))
114 #define zzip_disk_trailer_get_rootsize(__p)     ZZIP_GET32((__p)->z_rootsize)
115 #define zzip_disk_trailer_set_rootsize(__p,__x) ZZIP_SET32((__p)->z_rootsize,(__x))
116 #define zzip_disk_trailer_get_rootseek(__p)     ZZIP_GET32((__p)->z_rootseek)
117 #define zzip_disk_trailer_set_rootseek(__p,__x) ZZIP_SET32((__p)->z_rootseek,(__x))
118 #define zzip_disk_trailer_get_comment(__p)     ZZIP_GET16((__p)->z_comment)
119 #define zzip_disk_trailer_set_comment(__p,__x) ZZIP_SET16((__p)->z_comment,(__x))
120 #define zzip_disk_trailer_sizeof_tails(__p) ( zzip_disk_entry_get_comment(__p))
121 #define zzip_disk_trailer_check_magic(__p)  ZZIP_DISK_TRAILER_CHECKMAGIC((__p))
122
123 /* extra field should be type + size + data + type + size + data ... */
124 #define zzip_extra_block_get_datatype(__p)     ZZIP_GET16((char*)(__p))
125 #define zzip_extra_block_set_datatype(__p,__x) ZZIP_SET16((char*)(__p),__x)
126 #define zzip_extra_block_get_datasize(__p)     ZZIP_GET16((char*)(__p)+2)
127 #define zzip_extra_block_set_datasize(__p,__x) ZZIP_SET16((char*)(__p)+2,__x)
128
129 /* .............. some logical typed access wrappers ....................... */
130
131 /* zzip_file_header - the local file header */
132 #define zzip_file_header_csize(__p)   ((zzip_size_t) \
133         zzip_file_header_get_csize(__p))
134 #define zzip_file_header_usize(__p)   ((zzip_size_t) \
135         zzip_file_header_get_usize(__p))
136 #define zzip_file_header_namlen(__p)   ((zzip_size_t) \
137         zzip_file_header_get_namlen(__p))
138 #define zzip_file_header_extras(__p)   ((zzip_size_t) \
139         zzip_file_header_get_extras(__p))
140 #define zzip_file_header_sizeof_tail(__p) ((zzip_size_t) \
141         zzip_file_header_sizeof_tails(__p))
142 #define zzip_file_header_sizeto_end(__p)   ((zzip_size_t) \
143         (zzip_file_header_sizeof_tail(__p) + zzip_file_header_headerlength))
144 #define zzip_file_header_skipto_end(__p)   ((char*) (__p) + \
145         (zzip_file_header_sizeof_tail(__p) + zzip_file_header_headerlength))
146
147 #define zzip_file_header_to_filename(__p)   ((char*) \
148         ((char*)(__p) + zzip_file_header_headerlength))
149 #define zzip_file_header_to_extras(__p)   ((char*) \
150         (zzip_file_header_to_filename(__p) + zzip_file_header_namlen(__p)))
151 #define zzip_file_header_to_data(__p)   ((char*) \
152         (zzip_file_header_to_extras(__p) + zzip_file_header_extras(__p)))
153 #define zzip_file_header_to_trailer(__p)   ((struct zzip_file_trailer*) \
154         (zzip_file_header_to_data(__p) + zzip_file_header_csize(__p)))
155
156 /* zzip_file_trailer - data descriptor per file block */
157 #define zzip_file_trailer_csize(__p)   ((zzip_size_t) \
158         zzip_file_trailer_get_csize(__p))
159 #define zzip_file_trailer_usize(__p)   ((zzip_size_t) \
160         zzip_file_trailer_get_usize(__p))
161 #define zzip_file_trailer_sizeof_tail(__p) ((zzip_size_t) \
162         zzip_file_trailer_sizeof_tails(__p))
163 #define zzip_file_trailer_sizeto_end(__p)   ((zzip_size_t) \
164         (zzip_file_trailer_sizeof_tail(__p) + zzip_file_trailer_headerlength))
165 #define zzip_file_trailer_skipto_end(__p)   ((char*) (__p) + \
166         (zzip_file_trailer_sizeof_tail(__p) + zzip_file_trailer_headerlength))
167
168 /* zzip_disk_entry (currently named zzip_root_dirent) */
169 #define zzip_disk_entry_csize(__p)   ((zzip_size_t) \
170         zzip_disk_entry_get_csize(__p))
171 #define zzip_disk_entry_usize(__p)   ((zzip_size_t) \
172         zzip_disk_entry_get_usize(__p))
173 #define zzip_disk_entry_namlen(__p)   ((zzip_size_t) \
174         zzip_disk_entry_get_namlen(__p))
175 #define zzip_disk_entry_extras(__p)   ((zzip_size_t) \
176         zzip_disk_entry_get_extras(__p))
177 #define zzip_disk_entry_comment(__p)   ((zzip_size_t) \
178         zzip_disk_entry_get_comment(__p))
179 #define zzip_disk_entry_diskstart(__p) ((int) \
180         zzip_disk_entry_get_diskstart(__p))
181 #define zzip_disk_entry_filetype(__p) ((int) \
182         zzip_disk_entry_get_filetype(__p))
183 #define zzip_disk_entry_filemode(__p) ((int) \
184         zzip_disk_entry_get_filemode(__p))
185 #define zzip_disk_entry_fileoffset(__p) ((zzip_off_t) \
186         zzip_disk_entry_get_offset(__p))
187 #define zzip_disk_entry_sizeof_tail(__p) ((zzip_size_t) \
188         zzip_disk_entry_sizeof_tails(__p))
189 #define zzip_disk_entry_sizeto_end(__p)   ((zzip_size_t) \
190         (zzip_disk_entry_sizeof_tail(__p) + zzip_disk_entry_headerlength))
191 #define zzip_disk_entry_skipto_end(__p)   ((char*) (__p) + \
192         (zzip_disk_entry_sizeof_tail(__p) + zzip_disk_entry_headerlength))
193
194 #define zzip_disk_entry_to_filename(__p)   ((char*) \
195         ((char*)(__p) + zzip_disk_entry_headerlength))
196 #define zzip_disk_entry_to_extras(__p)   ((char*) \
197         (zzip_disk_entry_to_filename(__p) + zzip_disk_entry_namlen(__p)))
198 #define zzip_disk_entry_to_comment(__p)   ((char*) \
199         (zzip_disk_entry_to_extras(__p) + zzip_disk_entry_extras(__p)))
200 #define zzip_disk_entry_to_next_entry(__p)   ((struct zzip_disk_entry*) \
201         (zzip_disk_entry_to_comment(__p) + zzip_disk_entry_comment(__p)))
202
203 /* zzip_disk_trailer - the zip archive entry point */
204 #define zzip_disk_trailer_localdisk(__p) ((int) \
205         zzip_disk_trailer_get_disk(__p))
206 #define zzip_disk_trailer_finaldisk(__p) ((int) \
207         zzip_disk_trailer_get_finaldisk(__p))
208 #define zzip_disk_trailer_localentries(__p) ((int) \
209         zzip_disk_trailer_get_entries(__p))
210 #define zzip_disk_trailer_finalentries(__p) ((int) \
211         zzip_disk_trailer_get_finalentries(__p))
212 #define zzip_disk_trailer_rootsize(__p) ((zzip_off_t) \
213         zzip_disk_trailer_get_rootsize(__p))
214 #define zzip_disk_trailer_rootseek(__p) ((zzip_off_t) \
215         zzip_disk_trailer_get_rootseek(__p))
216 #define zzip_disk_trailer_comment(__p)   ((zzip_size_t) \
217         zzip_disk_trailer_get_comment(__p))
218 #define zzip_disk_trailer_sizeof_tail(__p) ((zzip_size_t) \
219         zzip_disk_trailer_sizeof_tails(__p))
220 #define zzip_disk_trailer_sizeto_end(__p)   ((zzip_size_t) \
221         (zzip_disk_trailer_sizeof_tail(__p) + zzip_disk_trailer_headerlength))
222 #define zzip_disk_trailer_skipto_end(__p)   ((char*) (__p) \
223         (zzip_disk_trailer_sizeof_tail(__p) + zzip_disk_trailer_headerlength))
224
225 #define zzip_disk_trailer_to_comment(__p)   ((char*) \
226         ((char*)(__p) + zzip_disk_trailer_headerlength))
227 #define zzip_disk_trailer_to_endoffile(__p)   ((char*) \
228         (zzip_disk_trailer_to_comment(__p) + zzip_disk_trailer_comment(__p)))
229
230 /* extra field should be type + size + data + type + size + data ... */
231 #define zzip_extra_block_sizeof_tail(__p)  ((zzip_size_t) \
232         (zzip_extra_block_get_datasize(__p))
233 #define zzip_extra_block_sizeto_end(__p)    ((zzip_size_t) \
234         (zzip_extra_block_sizeof_tail(__p) + zzip_extra_block_headerlength))
235 #define zzip_extra_block_skipto_end(__p)    ((char*) (__p) \
236         (zzip_extra_block_sizeof_tail(__p) + zzip_extra_block_headerlength))
237
238 /* ................... and put these to the next level ................ */
239
240 #define zzip_file_header_data_encrypted(__p) \
241         ZZIP_IS_ENCRYPTED( zzip_file_header_get_flags(__p) )
242 #define zzip_file_header_data_comprlevel(__p) \
243         ZZIP_IS_COMPRLEVEL( zzip_file_header_get_flags(__p) )
244 #define zzip_file_header_data_streamed(__p) \
245         ZZIP_IS_STREAMED( zzip_file_header_get_flags(__p) )
246 #define zzip_file_header_data_stored(__p) \
247         ( ZZIP_IS_STORED ==   zzip_file_header_get_compr(__p) )
248 #define zzip_file_header_data_deflated(__p) \
249         ( ZZIP_IS_DEFLATED == zzip_file_header_get_compr(__p) )
250
251 #define zzip_disk_entry_data_encrypted(__p) \
252         ZZIP_IS_ENCRYPTED( zzip_disk_entry_get_flags(__p) )
253 #define zzip_disk_entry_data_comprlevel(__p) \
254         ZZIP_IS_COMPRLEVEL( zzip_disk_entry_get_flags(__p) )
255 #define zzip_disk_entry_data_streamed(__p) \
256         ZZIP_IS_STREAMED( zzip_disk_entry_get_flags(__p) )
257 #define zzip_disk_entry_data_stored(__p) \
258         ( ZZIP_IS_STORED ==  zzip_disk_entry_get_compr(__p) )
259 #define zzip_disk_entry_data_deflated(__p) \
260         ( ZZIP_IS_DEFLATED ==  zzip_disk_entry_get_compr(__p) )
261 #define zzip_disk_entry_data_ascii(__p) \
262         ( zzip_disk_entry_get_filetype(__p) & 1)
263
264 #define zzip_file_header_data_not_deflated(__p) \
265         (zzip_file_header_data_stored(__p))
266 #define zzip_file_header_data_std_deflated(__p) \
267         (zzip_file_header_data_deflated(__p) && \
268          zzip_file_header_data_comprlevel(__p) == ZZIP_DEFLATED_STD_COMPR)
269 #define zzip_file_header_data_max_deflated(__p) \
270         (zzip_file_header_data_deflated(__p) && \
271          zzip_file_header_data_comprlevel(__p) == ZZIP_DEFLATED_MAX_COMPR)
272 #define zzip_file_header_data_low_deflated(__p) \
273         (zzip_file_header_data_deflated(__p) && \
274          zzip_file_header_data_comprlevel(__p) == ZZIP_DEFLATED_LOW_COMPR)
275 #define zzip_file_header_data_min_deflated(__p) \
276         (zzip_file_header_data_deflated(__p) && \
277          zzip_file_header_data_comprlevel(__p) == ZZIP_DEFLATED_MIN_COMPR)
278
279 #define zzip_disk_entry_data_not_deflated(__p) \
280         (zzip_disk_entry_data_stored(__p))
281 #define zzip_disk_entry_data_std_deflated(__p) \
282         (zzip_disk_entry_data_deflated(__p) && \
283          zzip_disk_entry_data_comprlevel(__p) == ZZIP_DEFLATED_STD_COMPR)
284 #define zzip_disk_entry_data_max_deflated(__p) \
285         (zzip_disk_entry_data_deflated(__p) && \
286          zzip_disk_entry_data_comprlevel(__p) == ZZIP_DEFLATED_MAX_COMPR)
287 #define zzip_disk_entry_data_low_deflated(__p) \
288         (zzip_disk_entry_data_deflated(__p) && \
289          zzip_disk_entry_data_comprlevel(__p) == ZZIP_DEFLATED_LOW_COMPR)
290 #define zzip_disk_entry_data_min_deflated(__p) \
291         (zzip_disk_entry_data_deflated(__p) && \
292          zzip_disk_entry_data_comprlevel(__p) == ZZIP_DEFLATED_MIN_COMPR)
293
294 #endif