]> git.ipfire.org Git - thirdparty/libarchive.git/blame - libarchive/archive.h
projects / thirdparty / libarchive.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add test_compat_lzop_1.tar.lzo entry into the test_fuzz list for
[thirdparty/libarchive.git] / libarchive / archive.h
CommitLineData
eaae26f3 1/*-
911dc2bf 2 * Copyright (c) 2003-2010 Tim Kientzle
eaae26f3
TK		 3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 *
25 * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.50 2008/05/26 17:00:22 kientzle Exp $
26 */
27
28#ifndef ARCHIVE_H_INCLUDED
29#define ARCHIVE_H_INCLUDED
30
7f2ca0da 31#include <sys/stat.h>
5773f6f3 32#include <stddef.h> /* for wchar_t */
7f2ca0da
TK		 33#include <stdio.h> /* For FILE * */
34
eaae26f3
TK		 35/*
36 * Note: archive.h is for use outside of libarchive; the configuration
37 * headers (config.h, archive_platform.h, etc.) are purely internal.
38 * Do NOT use HAVE_XXX configuration macros to control the behavior of
39 * this header! If you must conditionalize, use predefined compiler and/or
40 * platform macros.
41 */
f828fbc1 42#if defined(__BORLANDC__) && __BORLANDC__ >= 0x560
7f2ca0da
TK		 43# include <stdint.h>
44#elif !defined(__WATCOMC__) && !defined(_MSC_VER) && !defined(__INTERIX) && !defined(__BORLANDC__) && !defined(_SCO_DS)
45# include <inttypes.h>
eaae26f3 46#endif
eaae26f3
TK		 47
48/* Get appropriate definitions of standard POSIX-style types. */
49/* These should match the types used in 'struct stat' */
44f9eb57 50#if defined(_WIN32) && !defined(__CYGWIN__)
7f2ca0da 51# define __LA_INT64_T __int64
ab198f9f 52# if defined(_SSIZE_T_DEFINED) || defined(_SSIZE_T_)
e0f0abf0
BK		 53# define __LA_SSIZE_T ssize_t
54# elif defined(_WIN64)
b05b5e14
TK		 55# define __LA_SSIZE_T __int64
56# else
57# define __LA_SSIZE_T long
58# endif
eaae26f3 59#else
dacf7241 60# include <unistd.h> /* ssize_t */
7f2ca0da
TK		 61# if defined(_SCO_DS)
62# define __LA_INT64_T long long
63# else
64# define __LA_INT64_T int64_t
65# endif
66# define __LA_SSIZE_T ssize_t
eaae26f3
TK		 67#endif
68
69/*
70 * On Windows, define LIBARCHIVE_STATIC if you're building or using a
71 * .lib. The default here assumes you're building a DLL. Only
72 * libarchive source should ever define __LIBARCHIVE_BUILD.
73 */
44f9eb57 74#if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC)
eaae26f3
TK		 75# ifdef __LIBARCHIVE_BUILD
76# ifdef __GNUC__
77# define __LA_DECL __attribute__((dllexport)) extern
78# else
79# define __LA_DECL __declspec(dllexport)
80# endif
81# else
82# ifdef __GNUC__
5a0de499 83# define __LA_DECL
eaae26f3
TK		 84# else
85# define __LA_DECL __declspec(dllimport)
86# endif
87# endif
88#else
89/* Static libraries or non-Windows needs no special declaration. */
90# define __LA_DECL
91#endif
92
5fb156f9 93#if defined(__GNUC__) && __GNUC__ >= 3 && !defined(__MINGW32__)
ac8ba3fa
JS		 94#define __LA_PRINTF(fmtarg, firstvararg) \
95 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
96#else
97#define __LA_PRINTF(fmtarg, firstvararg) /* nothing */
98#endif
99
152e191c
MN		 100#if defined(__GNUC__) && __GNUC__ >= 3 && __GNUC_MINOR__ >= 1
101# define __LA_DEPRECATED __attribute__((deprecated))
102#else
103# define __LA_DEPRECATED
104#endif
105
eaae26f3
TK		 106#ifdef __cplusplus
107extern "C" {
108#endif
109
110/*
111 * The version number is provided as both a macro and a function.
112 * The macro identifies the installed header; the function identifies
113 * the library version (which may not be the same if you're using a
114 * dynamically-linked version of the library). Of course, if the
115 * header and library are very different, you should expect some
116 * strangeness. Don't do that.
117 */
118
119/*
120 * The version number is expressed as a single integer that makes it
121 * easy to compare versions at build time: for version a.b.c, the
122 * version number is printf("%d%03d%03d",a,b,c). For example, if you
123 * know your application requires version 2.12.108 or later, you can
682b44d4 124 * assert that ARCHIVE_VERSION_NUMBER >= 2012108.
eaae26f3 125 */
42c1f3e1 126/* Note: Compiler will complain if this does not match archive_entry.h! */
e74a1a0e 127#define ARCHIVE_VERSION_NUMBER 3000200
eaae26f3
TK		 128__LA_DECL int archive_version_number(void);
129
130/*
131 * Textual name/version of the library, useful for version displays.
132 */
e74a1a0e 133#define ARCHIVE_VERSION_STRING "libarchive 3.0.200a"
eaae26f3
TK		 134__LA_DECL const char * archive_version_string(void);
135
eaae26f3
TK		 136/* Declare our basic types. */
137struct archive;
138struct archive_entry;
139
140/*
141 * Error codes: Use archive_errno() and archive_error_string()
142 * to retrieve details. Unless specified otherwise, all functions
143 * that return 'int' use these codes.
144 */
145#define ARCHIVE_EOF 1 /* Found end of archive. */
146#define ARCHIVE_OK 0 /* Operation was successful. */
147#define ARCHIVE_RETRY (-10) /* Retry might succeed. */
148#define ARCHIVE_WARN (-20) /* Partial success. */
149/* For example, if write_header "fails", then you can't push data. */
150#define ARCHIVE_FAILED (-25) /* Current operation cannot complete. */
151/* But if write_header is "fatal," then this archive is dead and useless. */
152#define ARCHIVE_FATAL (-30) /* No more operations are possible. */
153
154/*
155 * As far as possible, archive_errno returns standard platform errno codes.
156 * Of course, the details vary by platform, so the actual definitions
157 * here are stored in "archive_platform.h". The symbols are listed here
158 * for reference; as a rule, clients should not need to know the exact
159 * platform-dependent error code.
160 */
161/* Unrecognized or invalid file format. */
162/* #define ARCHIVE_ERRNO_FILE_FORMAT */
163/* Illegal usage of the library. */
164/* #define ARCHIVE_ERRNO_PROGRAMMER_ERROR */
165/* Unknown or unclassified error. */
166/* #define ARCHIVE_ERRNO_MISC */
167
168/*
169 * Callbacks are invoked to automatically read/skip/write/open/close the
170 * archive. You can provide your own for complex tasks (like breaking
171 * archives across multiple tapes) or use standard ones built into the
172 * library.
173 */
174
175/* Returns pointer and size of next block of data from archive. */
fc95189e
TK		 176typedef __LA_SSIZE_T archive_read_callback(struct archive *,
177 void *_client_data, const void **_buffer);
178
41f86ae9
TK		 179/* Skips at most request bytes from archive and returns the skipped amount.
180 * This may skip fewer bytes than requested; it may even skip zero bytes.
181 * If you do skip fewer bytes than requested, libarchive will invoke your
182 * read callback and discard data as necessary to make up the full skip.
183 */
fc95189e
TK		 184typedef __LA_INT64_T archive_skip_callback(struct archive *,
185 void *_client_data, __LA_INT64_T request);
fc95189e 186
41f86ae9
TK		 187/* Seeks to specified location in the file and returns the position.
188 * Whence values are SEEK_SET, SEEK_CUR, SEEK_END from stdio.h.
189 * Return ARCHIVE_FATAL if the seek fails for any reason.
190 */
191typedef __LA_INT64_T archive_seek_callback(struct archive *,
192 void *_client_data, __LA_INT64_T offset, int whence);
193
eaae26f3 194/* Returns size actually written, zero on EOF, -1 on error. */
fc95189e
TK		 195typedef __LA_SSIZE_T archive_write_callback(struct archive *,
196 void *_client_data,
197 const void *_buffer, size_t _length);
198
eaae26f3 199typedef int archive_open_callback(struct archive *, void *_client_data);
fc95189e 200
eaae26f3
TK		 201typedef int archive_close_callback(struct archive *, void *_client_data);
202
7b543b13
AM		 203/* Switches from one client data object to the next/prev client data object.
204 * This is useful for reading from different data blocks such as a set of files
205 * that make up one large file.
206 */
207typedef int archive_switch_callback(struct archive *, void *_client_data1,
208 void *_client_data2);
209
eaae26f3 210/*
911dc2bf 211 * Codes to identify various stream filters.
eaae26f3 212 */
911dc2bf
TK		 213#define ARCHIVE_FILTER_NONE 0
214#define ARCHIVE_FILTER_GZIP 1
215#define ARCHIVE_FILTER_BZIP2 2
216#define ARCHIVE_FILTER_COMPRESS 3
217#define ARCHIVE_FILTER_PROGRAM 4
218#define ARCHIVE_FILTER_LZMA 5
219#define ARCHIVE_FILTER_XZ 6
220#define ARCHIVE_FILTER_UU 7
221#define ARCHIVE_FILTER_RPM 8
d8961d39 222#define ARCHIVE_FILTER_LZIP 9
1e5f600e 223#define ARCHIVE_FILTER_LRZIP 10
f51924bb 224#define ARCHIVE_FILTER_LZOP 11
630ead78 225#define ARCHIVE_FILTER_GRZIP 12
911dc2bf
TK		 226
227#if ARCHIVE_VERSION_NUMBER < 4000000
228#define ARCHIVE_COMPRESSION_NONE ARCHIVE_FILTER_NONE
229#define ARCHIVE_COMPRESSION_GZIP ARCHIVE_FILTER_GZIP
230#define ARCHIVE_COMPRESSION_BZIP2 ARCHIVE_FILTER_BZIP2
231#define ARCHIVE_COMPRESSION_COMPRESS ARCHIVE_FILTER_COMPRESS
232#define ARCHIVE_COMPRESSION_PROGRAM ARCHIVE_FILTER_PROGRAM
233#define ARCHIVE_COMPRESSION_LZMA ARCHIVE_FILTER_LZMA
234#define ARCHIVE_COMPRESSION_XZ ARCHIVE_FILTER_XZ
235#define ARCHIVE_COMPRESSION_UU ARCHIVE_FILTER_UU
236#define ARCHIVE_COMPRESSION_RPM ARCHIVE_FILTER_RPM
d8961d39 237#define ARCHIVE_COMPRESSION_LZIP ARCHIVE_FILTER_LZIP
1e5f600e 238#define ARCHIVE_COMPRESSION_LRZIP ARCHIVE_FILTER_LRZIP
911dc2bf 239#endif
eaae26f3
TK		 240
241/*
242 * Codes returned by archive_format.
243 *
244 * Top 16 bits identifies the format family (e.g., "tar"); lower
245 * 16 bits indicate the variant. This is updated by read_next_header.
246 * Note that the lower 16 bits will often vary from entry to entry.
247 * In some cases, this variation occurs as libarchive learns more about
248 * the archive (for example, later entries might utilize extensions that
249 * weren't necessary earlier in the archive; in this case, libarchive
250 * will change the format code to indicate the extended format that
251 * was used). In other cases, it's because different tools have
252 * modified the archive and so different parts of the archive
a0b2ef61 253 * actually have slightly different formats. (Both tar and cpio store
eaae26f3
TK		 254 * format codes in each entry, so it is quite possible for each
255 * entry to be in a different format.)
256 */
257#define ARCHIVE_FORMAT_BASE_MASK 0xff0000
258#define ARCHIVE_FORMAT_CPIO 0x10000
259#define ARCHIVE_FORMAT_CPIO_POSIX (ARCHIVE_FORMAT_CPIO | 1)
260#define ARCHIVE_FORMAT_CPIO_BIN_LE (ARCHIVE_FORMAT_CPIO | 2)
261#define ARCHIVE_FORMAT_CPIO_BIN_BE (ARCHIVE_FORMAT_CPIO | 3)
262#define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC (ARCHIVE_FORMAT_CPIO | 4)
263#define ARCHIVE_FORMAT_CPIO_SVR4_CRC (ARCHIVE_FORMAT_CPIO | 5)
19cc1b68 264#define ARCHIVE_FORMAT_CPIO_AFIO_LARGE (ARCHIVE_FORMAT_CPIO | 6)
eaae26f3
TK		 265#define ARCHIVE_FORMAT_SHAR 0x20000
266#define ARCHIVE_FORMAT_SHAR_BASE (ARCHIVE_FORMAT_SHAR | 1)
267#define ARCHIVE_FORMAT_SHAR_DUMP (ARCHIVE_FORMAT_SHAR | 2)
268#define ARCHIVE_FORMAT_TAR 0x30000
269#define ARCHIVE_FORMAT_TAR_USTAR (ARCHIVE_FORMAT_TAR | 1)
270#define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE (ARCHIVE_FORMAT_TAR | 2)
271#define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED (ARCHIVE_FORMAT_TAR | 3)
272#define ARCHIVE_FORMAT_TAR_GNUTAR (ARCHIVE_FORMAT_TAR | 4)
273#define ARCHIVE_FORMAT_ISO9660 0x40000
274#define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE (ARCHIVE_FORMAT_ISO9660 | 1)
275#define ARCHIVE_FORMAT_ZIP 0x50000
276#define ARCHIVE_FORMAT_EMPTY 0x60000
277#define ARCHIVE_FORMAT_AR 0x70000
278#define ARCHIVE_FORMAT_AR_GNU (ARCHIVE_FORMAT_AR | 1)
279#define ARCHIVE_FORMAT_AR_BSD (ARCHIVE_FORMAT_AR | 2)
280#define ARCHIVE_FORMAT_MTREE 0x80000
ccdb0318 281#define ARCHIVE_FORMAT_RAW 0x90000
d2c0930d 282#define ARCHIVE_FORMAT_XAR 0xA0000
344711d5 283#define ARCHIVE_FORMAT_LHA 0xB0000
12a3fef6 284#define ARCHIVE_FORMAT_CAB 0xC0000
099075c1 285#define ARCHIVE_FORMAT_RAR 0xD0000
e58ec445 286#define ARCHIVE_FORMAT_7ZIP 0xE0000
eaae26f3
TK		 287
288/*-
289 * Basic outline for reading an archive:
290 * 1) Ask archive_read_new for an archive reader object.
291 * 2) Update any global properties as appropriate.
292 * In particular, you'll certainly want to call appropriate
293 * archive_read_support_XXX functions.
294 * 3) Call archive_read_open_XXX to open the archive
295 * 4) Repeatedly call archive_read_next_header to get information about
296 * successive archive entries. Call archive_read_data to extract
297 * data for entries of interest.
298 * 5) Call archive_read_finish to end processing.
299 */
300__LA_DECL struct archive *archive_read_new(void);
301
302/*
303 * The archive_read_support_XXX calls enable auto-detect for this
304 * archive handle. They also link in the necessary support code.
305 * For example, if you don't want bzlib linked in, don't invoke
306 * support_compression_bzip2(). The "all" functions provide the
307 * obvious shorthand.
308 */
911dc2bf 309
a58aaa4f 310#if ARCHIVE_VERSION_NUMBER < 4000000
b34f2a09
MN		 311__LA_DECL int archive_read_support_compression_all(struct archive *)
312 __LA_DEPRECATED;
313__LA_DECL int archive_read_support_compression_bzip2(struct archive *)
314 __LA_DEPRECATED;
315__LA_DECL int archive_read_support_compression_compress(struct archive *)
316 __LA_DEPRECATED;
317__LA_DECL int archive_read_support_compression_gzip(struct archive *)
318 __LA_DEPRECATED;
319__LA_DECL int archive_read_support_compression_lzip(struct archive *)
320 __LA_DEPRECATED;
321__LA_DECL int archive_read_support_compression_lzma(struct archive *)
322 __LA_DEPRECATED;
323__LA_DECL int archive_read_support_compression_none(struct archive *)
324 __LA_DEPRECATED;
911dc2bf 325__LA_DECL int archive_read_support_compression_program(struct archive *,
b34f2a09 326 const char *command) __LA_DEPRECATED;
911dc2bf
TK		 327__LA_DECL int archive_read_support_compression_program_signature
328 (struct archive *, const char *,
b34f2a09 329 const void * /* match */, size_t) __LA_DEPRECATED;
71aa143d 330
b34f2a09
MN		 331__LA_DECL int archive_read_support_compression_rpm(struct archive *)
332 __LA_DEPRECATED;
333__LA_DECL int archive_read_support_compression_uu(struct archive *)
334 __LA_DEPRECATED;
335__LA_DECL int archive_read_support_compression_xz(struct archive *)
336 __LA_DEPRECATED;
a58aaa4f
RN		 337#endif
338
339__LA_DECL int archive_read_support_filter_all(struct archive *);
340__LA_DECL int archive_read_support_filter_bzip2(struct archive *);
341__LA_DECL int archive_read_support_filter_compress(struct archive *);
342__LA_DECL int archive_read_support_filter_gzip(struct archive *);
630ead78 343__LA_DECL int archive_read_support_filter_grzip(struct archive *);
1e5f600e 344__LA_DECL int archive_read_support_filter_lrzip(struct archive *);
a58aaa4f
RN		 345__LA_DECL int archive_read_support_filter_lzip(struct archive *);
346__LA_DECL int archive_read_support_filter_lzma(struct archive *);
f51924bb 347__LA_DECL int archive_read_support_filter_lzop(struct archive *);
a58aaa4f
RN		 348__LA_DECL int archive_read_support_filter_none(struct archive *);
349__LA_DECL int archive_read_support_filter_program(struct archive *,
350 const char *command);
351__LA_DECL int archive_read_support_filter_program_signature
40722a25 352 (struct archive *, const char * /* cmd */,
a58aaa4f 353 const void * /* match */, size_t);
a58aaa4f
RN		 354__LA_DECL int archive_read_support_filter_rpm(struct archive *);
355__LA_DECL int archive_read_support_filter_uu(struct archive *);
356__LA_DECL int archive_read_support_filter_xz(struct archive *);
eaae26f3 357
e58ec445 358__LA_DECL int archive_read_support_format_7zip(struct archive *);
911dc2bf
TK		 359__LA_DECL int archive_read_support_format_all(struct archive *);
360__LA_DECL int archive_read_support_format_ar(struct archive *);
819e53c0 361__LA_DECL int archive_read_support_format_by_code(struct archive *, int);
12a3fef6 362__LA_DECL int archive_read_support_format_cab(struct archive *);
911dc2bf
TK		 363__LA_DECL int archive_read_support_format_cpio(struct archive *);
364__LA_DECL int archive_read_support_format_empty(struct archive *);
365__LA_DECL int archive_read_support_format_gnutar(struct archive *);
366__LA_DECL int archive_read_support_format_iso9660(struct archive *);
344711d5 367__LA_DECL int archive_read_support_format_lha(struct archive *);
911dc2bf 368__LA_DECL int archive_read_support_format_mtree(struct archive *);
41f86ae9 369__LA_DECL int archive_read_support_format_rar(struct archive *);
911dc2bf
TK		 370__LA_DECL int archive_read_support_format_raw(struct archive *);
371__LA_DECL int archive_read_support_format_tar(struct archive *);
372__LA_DECL int archive_read_support_format_xar(struct archive *);
373__LA_DECL int archive_read_support_format_zip(struct archive *);
eaae26f3 374
0dd337ef
TK		 375/* Set various callbacks. */
376__LA_DECL int archive_read_set_open_callback(struct archive *,
377 archive_open_callback *);
378__LA_DECL int archive_read_set_read_callback(struct archive *,
379 archive_read_callback *);
41f86ae9
TK		 380__LA_DECL int archive_read_set_seek_callback(struct archive *,
381 archive_seek_callback *);
0dd337ef
TK		 382__LA_DECL int archive_read_set_skip_callback(struct archive *,
383 archive_skip_callback *);
384__LA_DECL int archive_read_set_close_callback(struct archive *,
385 archive_close_callback *);
7b543b13
AM		 386/* Callback used to switch between one data object to the next */
387__LA_DECL int archive_read_set_switch_callback(struct archive *,
388 archive_switch_callback *);
389
390/* This sets the first data object. */
0dd337ef 391__LA_DECL int archive_read_set_callback_data(struct archive *, void *);
7b543b13
AM		 392/* This sets data object at specified index */
393__LA_DECL int archive_read_set_callback_data2(struct archive *, void *,
394 unsigned int);
395/* This adds a data object at the specified index. */
396__LA_DECL int archive_read_add_callback_data(struct archive *, void *,
397 unsigned int);
398/* This appends a data object to the end of list */
399__LA_DECL int archive_read_append_callback_data(struct archive *, void *);
400/* This prepends a data object to the beginning of list */
401__LA_DECL int archive_read_prepend_callback_data(struct archive *, void *);
402
0dd337ef
TK		 403/* Opening freezes the callbacks. */
404__LA_DECL int archive_read_open1(struct archive *);
405
406/* Convenience wrappers around the above. */
911dc2bf 407__LA_DECL int archive_read_open(struct archive *, void *_client_data,
eaae26f3
TK		 408 archive_open_callback *, archive_read_callback *,
409 archive_close_callback *);
911dc2bf 410__LA_DECL int archive_read_open2(struct archive *, void *_client_data,
eaae26f3
TK		 411 archive_open_callback *, archive_read_callback *,
412 archive_skip_callback *, archive_close_callback *);
413
414/*
415 * A variety of shortcuts that invoke archive_read_open() with
416 * canned callbacks suitable for common situations. The ones that
417 * accept a block size handle tape blocking correctly.
418 */
419/* Use this if you know the filename. Note: NULL indicates stdin. */
911dc2bf 420__LA_DECL int archive_read_open_filename(struct archive *,
eaae26f3 421 const char *_filename, size_t _block_size);
7b543b13
AM		 422/* Use this for reading multivolume files by filenames.
423 * NOTE: Must be NULL terminated. Sorting is NOT done. */
424__LA_DECL int archive_read_open_filenames(struct archive *,
425 const char **_filenames, size_t _block_size);
87cc7b92
MN		 426__LA_DECL int archive_read_open_filename_w(struct archive *,
427 const wchar_t *_filename, size_t _block_size);
eaae26f3 428/* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
911dc2bf 429__LA_DECL int archive_read_open_file(struct archive *,
152e191c 430 const char *_filename, size_t _block_size) __LA_DEPRECATED;
eaae26f3 431/* Read an archive that's stored in memory. */
911dc2bf 432__LA_DECL int archive_read_open_memory(struct archive *,
eaae26f3
TK		 433 void * buff, size_t size);
434/* A more involved version that is only used for internal testing. */
911dc2bf 435__LA_DECL int archive_read_open_memory2(struct archive *a, void *buff,
eaae26f3
TK		 436 size_t size, size_t read_size);
437/* Read an archive that's already open, using the file descriptor. */
911dc2bf 438__LA_DECL int archive_read_open_fd(struct archive *, int _fd,
eaae26f3
TK		 439 size_t _block_size);
440/* Read an archive that's already open, using a FILE *. */
441/* Note: DO NOT use this with tape drives. */
911dc2bf 442__LA_DECL int archive_read_open_FILE(struct archive *, FILE *_file);
eaae26f3
TK		 443
444/* Parses and returns next entry header. */
911dc2bf 445__LA_DECL int archive_read_next_header(struct archive *,
eaae26f3
TK		 446 struct archive_entry **);
447
ff12dfa8 448/* Parses and returns next entry header using the archive_entry passed in */
911dc2bf 449__LA_DECL int archive_read_next_header2(struct archive *,
ff12dfa8
TK		 450 struct archive_entry *);
451
eaae26f3
TK		 452/*
453 * Retrieve the byte offset in UNCOMPRESSED data where last-read
454 * header started.
455 */
07be984c 456__LA_DECL __LA_INT64_T archive_read_header_position(struct archive *);
eaae26f3
TK		 457
458/* Read data from the body of an entry. Similar to read(2). */
fc95189e
TK		 459__LA_DECL __LA_SSIZE_T archive_read_data(struct archive *,
460 void *, size_t);
461
a5b03cc1
AM		 462/* Seek within the body of an entry. Similar to lseek(2). */
463__LA_DECL __LA_INT64_T archive_seek_data(struct archive *, __LA_INT64_T, int);
464
eaae26f3
TK		 465/*
466 * A zero-copy version of archive_read_data that also exposes the file offset
467 * of each returned block. Note that the client has no way to specify
468 * the desired size of the block. The API does guarantee that offsets will
469 * be strictly increasing and that returned blocks will not overlap.
470 */
911dc2bf
TK		 471__LA_DECL int archive_read_data_block(struct archive *a,
472 const void **buff, size_t *size, __LA_INT64_T *offset);
eaae26f3
TK		 473
474/*-
475 * Some convenience functions that are built on archive_read_data:
476 * 'skip': skips entire entry
477 * 'into_buffer': writes data into memory buffer that you provide
478 * 'into_fd': writes data to specified filedes
479 */
911dc2bf 480__LA_DECL int archive_read_data_skip(struct archive *);
911dc2bf 481__LA_DECL int archive_read_data_into_fd(struct archive *, int fd);
eaae26f3 482
6943997e
MN		 483/*
484 * Set read options.
485 */
11e7a909
TK		 486/* Apply option to the format only. */
487__LA_DECL int archive_read_set_format_option(struct archive *_a,
488 const char *m, const char *o,
489 const char *v);
490/* Apply option to the filter only. */
491__LA_DECL int archive_read_set_filter_option(struct archive *_a,
492 const char *m, const char *o,
493 const char *v);
494/* Apply option to both the format and the filter. */
495__LA_DECL int archive_read_set_option(struct archive *_a,
496 const char *m, const char *o,
497 const char *v);
6943997e 498/* Apply option string to both the format and the filter. */
911dc2bf 499__LA_DECL int archive_read_set_options(struct archive *_a,
11e7a909 500 const char *opts);
6943997e 501
eaae26f3
TK		 502/*-
503 * Convenience function to recreate the current entry (whose header
504 * has just been read) on disk.
505 *
506 * This does quite a bit more than just copy data to disk. It also:
507 * - Creates intermediate directories as required.
508 * - Manages directory permissions: non-writable directories will
509 * be initially created with write permission enabled; when the
510 * archive is closed, dir permissions are edited to the values specified
511 * in the archive.
512 * - Checks hardlinks: hardlinks will not be extracted unless the
513 * linked-to file was also extracted within the same session. (TODO)
514 */
515
516/* The "flags" argument selects optional behavior, 'OR' the flags you want. */
517
518/* Default: Do not try to set owner/group. */
519#define ARCHIVE_EXTRACT_OWNER (0x0001)
520/* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
521#define ARCHIVE_EXTRACT_PERM (0x0002)
522/* Default: Do not restore mtime/atime. */
523#define ARCHIVE_EXTRACT_TIME (0x0004)
524/* Default: Replace existing files. */
525#define ARCHIVE_EXTRACT_NO_OVERWRITE (0x0008)
526/* Default: Try create first, unlink only if create fails with EEXIST. */
527#define ARCHIVE_EXTRACT_UNLINK (0x0010)
528/* Default: Do not restore ACLs. */
529#define ARCHIVE_EXTRACT_ACL (0x0020)
530/* Default: Do not restore fflags. */
531#define ARCHIVE_EXTRACT_FFLAGS (0x0040)
532/* Default: Do not restore xattrs. */
533#define ARCHIVE_EXTRACT_XATTR (0x0080)
534/* Default: Do not try to guard against extracts redirected by symlinks. */
535/* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
536#define ARCHIVE_EXTRACT_SECURE_SYMLINKS (0x0100)
537/* Default: Do not reject entries with '..' as path elements. */
538#define ARCHIVE_EXTRACT_SECURE_NODOTDOT (0x0200)
539/* Default: Create parent directories as needed. */
540#define ARCHIVE_EXTRACT_NO_AUTODIR (0x0400)
541/* Default: Overwrite files, even if one on disk is newer. */
542#define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER (0x0800)
543/* Detect blocks of 0 and write holes instead. */
544#define ARCHIVE_EXTRACT_SPARSE (0x1000)
b8ad1655
TK		 545/* Default: Do not restore Mac extended metadata. */
546/* This has no effect except on Mac OS. */
547#define ARCHIVE_EXTRACT_MAC_METADATA (0x2000)
eaae26f3 548
911dc2bf 549__LA_DECL int archive_read_extract(struct archive *, struct archive_entry *,
eaae26f3 550 int flags);
911dc2bf 551__LA_DECL int archive_read_extract2(struct archive *, struct archive_entry *,
eaae26f3
TK		 552 struct archive * /* dest */);
553__LA_DECL void archive_read_extract_set_progress_callback(struct archive *,
554 void (*_progress_func)(void *), void *_user_data);
555
556/* Record the dev/ino of a file that will not be written. This is
557 * generally set to the dev/ino of the archive being read. */
73f39d90
TK		 558__LA_DECL void archive_read_extract_set_skip_file(struct archive *,
559 __LA_INT64_T, __LA_INT64_T);
eaae26f3
TK		 560
561/* Close the file and release most resources. */
562__LA_DECL int archive_read_close(struct archive *);
563/* Release all resources and destroy the object. */
9890b31f
TK		 564/* Note that archive_read_free will call archive_read_close for you. */
565__LA_DECL int archive_read_free(struct archive *);
566#if ARCHIVE_VERSION_NUMBER < 4000000
567/* Synonym for archive_read_free() for backwards compatibility. */
b34f2a09 568__LA_DECL int archive_read_finish(struct archive *) __LA_DEPRECATED;
9890b31f 569#endif
eaae26f3
TK		 570
571/*-
572 * To create an archive:
a0b2ef61 573 * 1) Ask archive_write_new for an archive writer object.
eaae26f3
TK		 574 * 2) Set any global properties. In particular, you should set
575 * the compression and format to use.
576 * 3) Call archive_write_open to open the file (most people
577 * will use archive_write_open_file or archive_write_open_fd,
578 * which provide convenient canned I/O callbacks for you).
579 * 4) For each entry:
580 * - construct an appropriate struct archive_entry structure
581 * - archive_write_header to write the header
582 * - archive_write_data to write the entry data
583 * 5) archive_write_close to close the output
9890b31f 584 * 6) archive_write_free to cleanup the writer and release resources
eaae26f3
TK		 585 */
586__LA_DECL struct archive *archive_write_new(void);
911dc2bf 587__LA_DECL int archive_write_set_bytes_per_block(struct archive *,
eaae26f3 588 int bytes_per_block);
911dc2bf 589__LA_DECL int archive_write_get_bytes_per_block(struct archive *);
eaae26f3 590/* XXX This is badly misnamed; suggestions appreciated. XXX */
911dc2bf 591__LA_DECL int archive_write_set_bytes_in_last_block(struct archive *,
eaae26f3 592 int bytes_in_last_block);
911dc2bf 593__LA_DECL int archive_write_get_bytes_in_last_block(struct archive *);
eaae26f3
TK		 594
595/* The dev/ino of a file that won't be archived. This is used
596 * to avoid recursively adding an archive to itself. */
73f39d90
TK		 597__LA_DECL int archive_write_set_skip_file(struct archive *,
598 __LA_INT64_T, __LA_INT64_T);
911dc2bf
TK		 599
600#if ARCHIVE_VERSION_NUMBER < 4000000
b34f2a09
MN		 601__LA_DECL int archive_write_set_compression_bzip2(struct archive *)
602 __LA_DEPRECATED;
603__LA_DECL int archive_write_set_compression_compress(struct archive *)
604 __LA_DEPRECATED;
605__LA_DECL int archive_write_set_compression_gzip(struct archive *)
606 __LA_DEPRECATED;
607__LA_DECL int archive_write_set_compression_lzip(struct archive *)
608 __LA_DEPRECATED;
609__LA_DECL int archive_write_set_compression_lzma(struct archive *)
610 __LA_DEPRECATED;
611__LA_DECL int archive_write_set_compression_none(struct archive *)
612 __LA_DEPRECATED;
911dc2bf 613__LA_DECL int archive_write_set_compression_program(struct archive *,
b34f2a09
MN		 614 const char *cmd) __LA_DEPRECATED;
615__LA_DECL int archive_write_set_compression_xz(struct archive *)
616 __LA_DEPRECATED;
911dc2bf
TK		 617#endif
618
9ca74e37
OH		 619/* A convenience function to set the filter based on the code. */
620__LA_DECL int archive_write_add_filter(struct archive *, int filter_code);
ba3b5811 621__LA_DECL int archive_write_add_filter_b64encode(struct archive *);
911dc2bf
TK		 622__LA_DECL int archive_write_add_filter_bzip2(struct archive *);
623__LA_DECL int archive_write_add_filter_compress(struct archive *);
630ead78 624__LA_DECL int archive_write_add_filter_grzip(struct archive *);
911dc2bf 625__LA_DECL int archive_write_add_filter_gzip(struct archive *);
1e5f600e 626__LA_DECL int archive_write_add_filter_lrzip(struct archive *);
4295807f 627__LA_DECL int archive_write_add_filter_lzip(struct archive *);
911dc2bf 628__LA_DECL int archive_write_add_filter_lzma(struct archive *);
f51924bb 629__LA_DECL int archive_write_add_filter_lzop(struct archive *);
911dc2bf
TK		 630__LA_DECL int archive_write_add_filter_none(struct archive *);
631__LA_DECL int archive_write_add_filter_program(struct archive *,
eaae26f3 632 const char *cmd);
1cbc562a 633__LA_DECL int archive_write_add_filter_uuencode(struct archive *);
911dc2bf
TK		 634__LA_DECL int archive_write_add_filter_xz(struct archive *);
635
636
eaae26f3 637/* A convenience function to set the format based on the code or name. */
911dc2bf
TK		 638__LA_DECL int archive_write_set_format(struct archive *, int format_code);
639__LA_DECL int archive_write_set_format_by_name(struct archive *,
eaae26f3
TK		 640 const char *name);
641/* To minimize link pollution, use one or more of the following. */
3b413389 642__LA_DECL int archive_write_set_format_7zip(struct archive *);
911dc2bf
TK		 643__LA_DECL int archive_write_set_format_ar_bsd(struct archive *);
644__LA_DECL int archive_write_set_format_ar_svr4(struct archive *);
645__LA_DECL int archive_write_set_format_cpio(struct archive *);
646__LA_DECL int archive_write_set_format_cpio_newc(struct archive *);
7862cf7a 647__LA_DECL int archive_write_set_format_gnutar(struct archive *);
9d72ea76 648__LA_DECL int archive_write_set_format_iso9660(struct archive *);
911dc2bf 649__LA_DECL int archive_write_set_format_mtree(struct archive *);
f83da353 650__LA_DECL int archive_write_set_format_mtree_classic(struct archive *);
eaae26f3 651/* TODO: int archive_write_set_format_old_tar(struct archive *); */
911dc2bf
TK		 652__LA_DECL int archive_write_set_format_pax(struct archive *);
653__LA_DECL int archive_write_set_format_pax_restricted(struct archive *);
654__LA_DECL int archive_write_set_format_shar(struct archive *);
655__LA_DECL int archive_write_set_format_shar_dump(struct archive *);
656__LA_DECL int archive_write_set_format_ustar(struct archive *);
b7115a7d 657__LA_DECL int archive_write_set_format_xar(struct archive *);
911dc2bf 658__LA_DECL int archive_write_set_format_zip(struct archive *);
36a3cc51
MB		 659__LA_DECL int archive_write_zip_set_compression_deflate(struct archive *);
660__LA_DECL int archive_write_zip_set_compression_store(struct archive *);
911dc2bf 661__LA_DECL int archive_write_open(struct archive *, void *,
eaae26f3
TK		 662 archive_open_callback *, archive_write_callback *,
663 archive_close_callback *);
911dc2bf
TK		 664__LA_DECL int archive_write_open_fd(struct archive *, int _fd);
665__LA_DECL int archive_write_open_filename(struct archive *, const char *_file);
87cc7b92
MN		 666__LA_DECL int archive_write_open_filename_w(struct archive *,
667 const wchar_t *_file);
eaae26f3 668/* A deprecated synonym for archive_write_open_filename() */
152e191c
MN		 669__LA_DECL int archive_write_open_file(struct archive *, const char *_file)
670 __LA_DEPRECATED;
911dc2bf 671__LA_DECL int archive_write_open_FILE(struct archive *, FILE *);
eaae26f3
TK		 672/* _buffSize is the size of the buffer, _used refers to a variable that
673 * will be updated after each write into the buffer. */
911dc2bf 674__LA_DECL int archive_write_open_memory(struct archive *,
eaae26f3
TK		 675 void *_buffer, size_t _buffSize, size_t *_used);
676
677/*
678 * Note that the library will truncate writes beyond the size provided
679 * to archive_write_header or pad if the provided data is short.
680 */
911dc2bf 681__LA_DECL int archive_write_header(struct archive *,
eaae26f3 682 struct archive_entry *);
911dc2bf 683__LA_DECL __LA_SSIZE_T archive_write_data(struct archive *,
fc95189e 684 const void *, size_t);
fc95189e 685
a653ac94 686/* This interface is currently only available for archive_write_disk handles. */
fc95189e
TK		 687__LA_DECL __LA_SSIZE_T archive_write_data_block(struct archive *,
688 const void *, size_t, __LA_INT64_T);
a653ac94 689
eaae26f3
TK		 690__LA_DECL int archive_write_finish_entry(struct archive *);
691__LA_DECL int archive_write_close(struct archive *);
aceae782
TK		 692/* Marks the archive as FATAL so that a subsequent free() operation
693 * won't try to close() cleanly. Provides a fast abort capability
694 * when the client discovers that things have gone wrong. */
695__LA_DECL int archive_write_fail(struct archive *);
9890b31f
TK		 696/* This can fail if the archive wasn't already closed, in which case
697 * archive_write_free() will implicitly call archive_write_close(). */
698__LA_DECL int archive_write_free(struct archive *);
699#if ARCHIVE_VERSION_NUMBER < 4000000
700/* Synonym for archive_write_free() for backwards compatibility. */
b34f2a09 701__LA_DECL int archive_write_finish(struct archive *) __LA_DEPRECATED;
9890b31f 702#endif
eaae26f3 703
6943997e 704/*
11e7a909 705 * Set write options.
6943997e 706 */
11e7a909
TK		 707/* Apply option to the format only. */
708__LA_DECL int archive_write_set_format_option(struct archive *_a,
709 const char *m, const char *o,
710 const char *v);
711/* Apply option to the filter only. */
712__LA_DECL int archive_write_set_filter_option(struct archive *_a,
713 const char *m, const char *o,
714 const char *v);
715/* Apply option to both the format and the filter. */
716__LA_DECL int archive_write_set_option(struct archive *_a,
717 const char *m, const char *o,
718 const char *v);
719/* Apply option string to both the format and the filter. */
720__LA_DECL int archive_write_set_options(struct archive *_a,
721 const char *opts);
6943997e 722
eaae26f3 723/*-
2d892504
TK		 724 * ARCHIVE_WRITE_DISK API
725 *
eaae26f3
TK		 726 * To create objects on disk:
727 * 1) Ask archive_write_disk_new for a new archive_write_disk object.
2d892504
TK		 728 * 2) Set any global properties. In particular, you probably
729 * want to set the options.
eaae26f3
TK		 730 * 3) For each entry:
731 * - construct an appropriate struct archive_entry structure
732 * - archive_write_header to create the file/dir/etc on disk
733 * - archive_write_data to write the entry data
9890b31f 734 * 4) archive_write_free to cleanup the writer and release resources
eaae26f3
TK		 735 *
736 * In particular, you can use this in conjunction with archive_read()
737 * to pull entries out of an archive and create them on disk.
738 */
739__LA_DECL struct archive *archive_write_disk_new(void);
740/* This file will not be overwritten. */
73f39d90
TK		 741__LA_DECL int archive_write_disk_set_skip_file(struct archive *,
742 __LA_INT64_T, __LA_INT64_T);
2d892504
TK		 743/* Set flags to control how the next item gets created.
744 * This accepts a bitmask of ARCHIVE_EXTRACT_XXX flags defined above. */
eaae26f3
TK		 745__LA_DECL int archive_write_disk_set_options(struct archive *,
746 int flags);
747/*
748 * The lookup functions are given uname/uid (or gname/gid) pairs and
749 * return a uid (gid) suitable for this system. These are used for
750 * restoring ownership and for setting ACLs. The default functions
751 * are naive, they just return the uid/gid. These are small, so reasonable
752 * for applications that don't need to preserve ownership; they
753 * are probably also appropriate for applications that are doing
754 * same-system backup and restore.
755 */
756/*
757 * The "standard" lookup functions use common system calls to lookup
758 * the uname/gname, falling back to the uid/gid if the names can't be
759 * found. They cache lookups and are reasonably fast, but can be very
760 * large, so they are not used unless you ask for them. In
761 * particular, these match the specifications of POSIX "pax" and old
762 * POSIX "tar".
763 */
764__LA_DECL int archive_write_disk_set_standard_lookup(struct archive *);
765/*
766 * If neither the default (naive) nor the standard (big) functions suit
767 * your needs, you can write your own and register them. Be sure to
768 * include a cleanup function if you have allocated private data.
769 */
73f39d90
TK		 770__LA_DECL int archive_write_disk_set_group_lookup(struct archive *,
771 void * /* private_data */,
772 __LA_INT64_T (*)(void *, const char *, __LA_INT64_T),
773 void (* /* cleanup */)(void *));
774__LA_DECL int archive_write_disk_set_user_lookup(struct archive *,
775 void * /* private_data */,
776 __LA_INT64_T (*)(void *, const char *, __LA_INT64_T),
777 void (* /* cleanup */)(void *));
f4f791ea
TK		 778__LA_DECL __LA_INT64_T archive_write_disk_gid(struct archive *, const char *, __LA_INT64_T);
779__LA_DECL __LA_INT64_T archive_write_disk_uid(struct archive *, const char *, __LA_INT64_T);
eaae26f3 780
aede8174
TK		 781/*
782 * ARCHIVE_READ_DISK API
a8ac0b18
TK		 783 *
784 * This is still evolving and somewhat experimental.
aede8174
TK		 785 */
786__LA_DECL struct archive *archive_read_disk_new(void);
a8ac0b18
TK		 787/* The names for symlink modes here correspond to an old BSD
788 * command-line argument convention: -L, -P, -H */
789/* Follow all symlinks. */
790__LA_DECL int archive_read_disk_set_symlink_logical(struct archive *);
791/* Follow no symlinks. */
792__LA_DECL int archive_read_disk_set_symlink_physical(struct archive *);
793/* Follow symlink initially, then not. */
794__LA_DECL int archive_read_disk_set_symlink_hybrid(struct archive *);
795/* TODO: Handle Linux stat32/stat64 ugliness. <sigh> */
796__LA_DECL int archive_read_disk_entry_from_file(struct archive *,
797 struct archive_entry *, int /* fd */, const struct stat *);
798/* Look up gname for gid or uname for uid. */
799/* Default implementations are very, very stupid. */
73f39d90
TK		 800__LA_DECL const char *archive_read_disk_gname(struct archive *, __LA_INT64_T);
801__LA_DECL const char *archive_read_disk_uname(struct archive *, __LA_INT64_T);
a8ac0b18
TK		 802/* "Standard" implementation uses getpwuid_r, getgrgid_r and caches the
803 * results for performance. */
804__LA_DECL int archive_read_disk_set_standard_lookup(struct archive *);
805/* You can install your own lookups if you like. */
73f39d90
TK		 806__LA_DECL int archive_read_disk_set_gname_lookup(struct archive *,
807 void * /* private_data */,
808 const char *(* /* lookup_fn */)(void *, __LA_INT64_T),
809 void (* /* cleanup_fn */)(void *));
810__LA_DECL int archive_read_disk_set_uname_lookup(struct archive *,
811 void * /* private_data */,
812 const char *(* /* lookup_fn */)(void *, __LA_INT64_T),
813 void (* /* cleanup_fn */)(void *));
3311bb52
MN		 814/* Start traversal. */
815__LA_DECL int archive_read_disk_open(struct archive *, const char *);
5773f6f3 816__LA_DECL int archive_read_disk_open_w(struct archive *, const wchar_t *);
3311bb52
MN		 817/*
818 * Request that current entry be visited. If you invoke it on every
819 * directory, you'll get a physical traversal. This is ignored if the
820 * current entry isn't a directory or a link to a directory. So, if
821 * you invoke this on every returned path, you'll get a full logical
822 * traversal.
823 */
824__LA_DECL int archive_read_disk_descend(struct archive *);
4fd30257 825__LA_DECL int archive_read_disk_can_descend(struct archive *);
9690aef4 826__LA_DECL int archive_read_disk_current_filesystem(struct archive *);
e3d450a7
MN		 827__LA_DECL int archive_read_disk_current_filesystem_is_synthetic(struct archive *);
828__LA_DECL int archive_read_disk_current_filesystem_is_remote(struct archive *);
b857ba4f
MN		 829/* Request that the access time of the entry visited by travesal be restored. */
830__LA_DECL int archive_read_disk_set_atime_restored(struct archive *);
3df7554a
MN		 831/*
832 * Set behavior. The "flags" argument selects optional behavior.
833 */
834/* Request that the access time of the entry visited by travesal be restored.
835 * This is the same as archive_read_disk_set_atime_restored. */
836#define ARCHIVE_READDISK_RESTORE_ATIME (0x0001)
837/* Default: Do not skip an entry which has nodump flags. */
838#define ARCHIVE_READDISK_HONOR_NODUMP (0x0002)
839/* Default: Skip a mac resource fork file whose prefix is "._" because of
840 * using copyfile. */
841#define ARCHIVE_READDISK_MAC_COPYFILE (0x0004)
842/* Default: Do not traverse mount points. */
843#define ARCHIVE_READDISK_NO_TRAVERSE_MOUNTS (0x0008)
844
845__LA_DECL int archive_read_disk_set_behavior(struct archive *,
846 int flags);
847
4fd30257 848/*
b4d25a74 849 * Set archive_match object that will be used in archive_read_disk to
4fd30257
MN		 850 * know whether an entry should be skipped. The callback function
851 * _excluded_func will be invoked when an entry is skipped by the result
b4d25a74 852 * of archive_match.
4fd30257
MN		 853 */
854__LA_DECL int archive_read_disk_set_matching(struct archive *,
855 struct archive *_matching, void (*_excluded_func)
856 (struct archive *, void *, struct archive_entry *),
857 void *_client_data);
fcc5dcbe
MN		 858__LA_DECL int archive_read_disk_set_metadata_filter_callback(struct archive *,
859 int (*_metadata_filter_func)(struct archive *, void *,
27b627f2
MN		 860 struct archive_entry *), void *_client_data);
861
eaae26f3
TK		 862/*
863 * Accessor functions to read/set various information in
864 * the struct archive object:
865 */
911dc2bf
TK		 866
867/* Number of filters in the current filter pipeline. */
868/* Filter #0 is the one closest to the format, -1 is a synonym for the
869 * last filter, which is always the pseudo-filter that wraps the
870 * client callbacks. */
871__LA_DECL int archive_filter_count(struct archive *);
872__LA_DECL __LA_INT64_T archive_filter_bytes(struct archive *, int);
873__LA_DECL int archive_filter_code(struct archive *, int);
874__LA_DECL const char * archive_filter_name(struct archive *, int);
875
876#if ARCHIVE_VERSION_NUMBER < 4000000
877/* These don't properly handle multiple filters, so are deprecated and
878 * will eventually be removed. */
879/* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, -1); */
152e191c
MN		 880__LA_DECL __LA_INT64_T archive_position_compressed(struct archive *)
881 __LA_DEPRECATED;
911dc2bf 882/* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, 0); */
152e191c
MN		 883__LA_DECL __LA_INT64_T archive_position_uncompressed(struct archive *)
884 __LA_DEPRECATED;
911dc2bf 885/* As of libarchive 3.0, this is an alias for archive_filter_name(a, 0); */
152e191c
MN		 886__LA_DECL const char *archive_compression_name(struct archive *)
887 __LA_DEPRECATED;
911dc2bf 888/* As of libarchive 3.0, this is an alias for archive_filter_code(a, 0); */
152e191c
MN		 889__LA_DECL int archive_compression(struct archive *)
890 __LA_DEPRECATED;
911dc2bf
TK		 891#endif
892
eaae26f3
TK		 893__LA_DECL int archive_errno(struct archive *);
894__LA_DECL const char *archive_error_string(struct archive *);
895__LA_DECL const char *archive_format_name(struct archive *);
896__LA_DECL int archive_format(struct archive *);
897__LA_DECL void archive_clear_error(struct archive *);
898__LA_DECL void archive_set_error(struct archive *, int _err,
ac8ba3fa 899 const char *fmt, ...) __LA_PRINTF(3, 4);
eaae26f3
TK		 900__LA_DECL void archive_copy_error(struct archive *dest,
901 struct archive *src);
ab649de7 902__LA_DECL int archive_file_count(struct archive *);
eaae26f3 903
3b14daeb 904/*
b4d25a74 905 * ARCHIVE_MATCH API
3b14daeb 906 */
b4d25a74
MN		 907__LA_DECL struct archive *archive_match_new(void);
908__LA_DECL int archive_match_free(struct archive *);
3b14daeb
MN		 909
910/*
911 * Test if archive_entry is excluded.
912 * This is a convenience function. This is the same as calling all
b4d25a74
MN		 913 * archive_match_path_excluded, archive_match_time_excluded
914 * and archive_match_owner_excluded.
3b14daeb 915 */
b4d25a74 916__LA_DECL int archive_match_excluded(struct archive *,
3b14daeb
MN		 917 struct archive_entry *);
918
919/*
56418500 920 * Test if pathname is excluded. The conditions are set by following functions.
3b14daeb 921 */
b4d25a74 922__LA_DECL int archive_match_path_excluded(struct archive *,
3b14daeb 923 struct archive_entry *);
56418500 924/* Add exclusion pathname pattern. */
b4d25a74
MN		 925__LA_DECL int archive_match_exclude_pattern(struct archive *, const char *);
926__LA_DECL int archive_match_exclude_pattern_w(struct archive *,
3b14daeb 927 const wchar_t *);
ae314ad8
MN		 928/* Add exclusion pathname pattern from file. */
929__LA_DECL int archive_match_exclude_pattern_from_file(struct archive *,
930 const char *, int _nullSeparator);
931__LA_DECL int archive_match_exclude_pattern_from_file_w(struct archive *,
932 const wchar_t *, int _nullSeparator);
56418500 933/* Add inclusion pathname pattern. */
b4d25a74
MN		 934__LA_DECL int archive_match_include_pattern(struct archive *, const char *);
935__LA_DECL int archive_match_include_pattern_w(struct archive *,
3b14daeb 936 const wchar_t *);
ae314ad8
MN		 937/* Add inclusion pathname pattern from file. */
938__LA_DECL int archive_match_include_pattern_from_file(struct archive *,
939 const char *, int _nullSeparator);
940__LA_DECL int archive_match_include_pattern_from_file_w(struct archive *,
941 const wchar_t *, int _nullSeparator);
3b14daeb
MN		 942/*
943 * How to get statistic information for inclusion patterns.
944 */
945/* Return the amount number of unmatched inclusion patterns. */
b4d25a74 946__LA_DECL int archive_match_path_unmatched_inclusions(struct archive *);
3b14daeb
MN		 947/* Return the pattern of unmatched inclusion with ARCHIVE_OK.
948 * Return ARCHIVE_EOF if there is no inclusion pattern. */
b4d25a74 949__LA_DECL int archive_match_path_unmatched_inclusions_next(
3b14daeb 950 struct archive *, const char **);
b4d25a74 951__LA_DECL int archive_match_path_unmatched_inclusions_next_w(
3b14daeb
MN		 952 struct archive *, const wchar_t **);
953
954/*
955 * Test if a file is excluded by its time stamp.
956 * The conditions are set by following functions.
957 */
b4d25a74 958__LA_DECL int archive_match_time_excluded(struct archive *,
3b14daeb 959 struct archive_entry *);
70779b91
MN		 960
961/*
962 * Flags to tell a matching type of time stamps. These are used for
b4d25a74 963 * following functinos.
70779b91
MN		 964 */
965/* Time flag: mtime to be tested. */
b4d25a74 966#define ARCHIVE_MATCH_MTIME (0x0100)
70779b91 967/* Time flag: ctime to be tested. */
b4d25a74 968#define ARCHIVE_MATCH_CTIME (0x0200)
70779b91 969/* Comparison flag: Match the time if it is newer than. */
b4d25a74 970#define ARCHIVE_MATCH_NEWER (0x0001)
70779b91 971/* Comparison flag: Match the time if it is older than. */
b4d25a74 972#define ARCHIVE_MATCH_OLDER (0x0002)
70779b91 973/* Comparison flag: Match the time if it is equal to. */
b4d25a74 974#define ARCHIVE_MATCH_EQUAL (0x0010)
70779b91 975/* Set inclusion time. */
b4d25a74 976__LA_DECL int archive_match_include_time(struct archive *, int _flag,
6aed59f1 977 time_t _sec, long _nsec);
70779b91 978/* Set inclusion time by a date string. */
b4d25a74 979__LA_DECL int archive_match_include_date(struct archive *, int _flag,
6aed59f1 980 const char *_datestr);
b4d25a74 981__LA_DECL int archive_match_include_date_w(struct archive *, int _flag,
6aed59f1 982 const wchar_t *_datestr);
70779b91 983/* Set inclusion time by a particluar file. */
b4d25a74 984__LA_DECL int archive_match_include_file_time(struct archive *,
70779b91 985 int _flag, const char *_pathname);
b4d25a74 986__LA_DECL int archive_match_include_file_time_w(struct archive *,
70779b91
MN		 987 int _flag, const wchar_t *_pathname);
988/* Add exclusion entry. */
b4d25a74 989__LA_DECL int archive_match_exclude_entry(struct archive *,
70779b91 990 int _flag, struct archive_entry *);
3b14daeb
MN		 991
992/*
993 * Test if a file is excluded by its uid ,gid, uname or gname.
994 * The conditions are set by following functions.
995 */
b4d25a74 996__LA_DECL int archive_match_owner_excluded(struct archive *,
3b14daeb
MN		 997 struct archive_entry *);
998/* Add inclusion uid, gid, uname and gname. */
63694f87
MN		 999__LA_DECL int archive_match_include_uid(struct archive *, __LA_INT64_T);
1000__LA_DECL int archive_match_include_gid(struct archive *, __LA_INT64_T);
b4d25a74
MN		 1001__LA_DECL int archive_match_include_uname(struct archive *, const char *);
1002__LA_DECL int archive_match_include_uname_w(struct archive *,
3b14daeb 1003 const wchar_t *);
b4d25a74
MN		 1004__LA_DECL int archive_match_include_gname(struct archive *, const char *);
1005__LA_DECL int archive_match_include_gname_w(struct archive *,
3b14daeb
MN		 1006 const wchar_t *);
1007
eaae26f3
TK		 1008#ifdef __cplusplus
1009}
1010#endif
1011
1ca7365e 1012/* These are meaningless outside of this header. */
eaae26f3
TK		 1013#undef __LA_DECL
1014
1ca7365e
TK		 1015/* These need to remain defined because they're used in the
1016 * callback type definitions. XXX Fix this. This is ugly. XXX */
1017/* #undef __LA_INT64_T */
1018/* #undef __LA_SSIZE_T */
1019
eaae26f3 1020#endif /* !ARCHIVE_H_INCLUDED */
Mirror of https://github.com/libarchive/libarchive.git