2 * Copyright (c) 2003-2010 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
25 * $FreeBSD: src/lib/libarchive/archive.h.in,v 1.50 2008/05/26 17:00:22 kientzle Exp $
28 #ifndef ARCHIVE_H_INCLUDED
29 #define ARCHIVE_H_INCLUDED
32 * The version number is expressed as a single integer that makes it
33 * easy to compare versions at build time: for version a.b.c, the
34 * version number is printf("%d%03d%03d",a,b,c). For example, if you
35 * know your application requires version 2.12.108 or later, you can
36 * assert that ARCHIVE_VERSION_NUMBER >= 2012108.
38 /* Note: Compiler will complain if this does not match archive_entry.h! */
39 #define ARCHIVE_VERSION_NUMBER 3003003
42 #include <stddef.h> /* for wchar_t */
43 #include <stdio.h> /* For FILE * */
44 #include <time.h> /* For time_t */
47 * Note: archive.h is for use outside of libarchive; the configuration
48 * headers (config.h, archive_platform.h, etc.) are purely internal.
49 * Do NOT use HAVE_XXX configuration macros to control the behavior of
50 * this header! If you must conditionalize, use predefined compiler and/or
53 #if defined(__BORLANDC__) && __BORLANDC__ >= 0x560
55 #elif !defined(__WATCOMC__) && !defined(_MSC_VER) && !defined(__INTERIX) && !defined(__BORLANDC__) && !defined(_SCO_DS) && !defined(__osf__)
56 # include <inttypes.h>
59 /* Get appropriate definitions of 64-bit integer */
60 #if !defined(__LA_INT64_T_DEFINED)
61 /* Older code relied on the __LA_INT64_T macro; after 4.0 we'll switch to the typedef exclusively. */
62 # if ARCHIVE_VERSION_NUMBER < 4000000
63 #define __LA_INT64_T la_int64_t
65 #define __LA_INT64_T_DEFINED
66 # if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__)
67 typedef __int64 la_int64_t;
69 # include <unistd.h> /* ssize_t */
70 # if defined(_SCO_DS) || defined(__osf__)
71 typedef long long la_int64_t;
73 typedef int64_t la_int64_t;
78 /* The la_ssize_t should match the type used in 'struct stat' */
79 #if !defined(__LA_SSIZE_T_DEFINED)
80 /* Older code relied on the __LA_SSIZE_T macro; after 4.0 we'll switch to the typedef exclusively. */
81 # if ARCHIVE_VERSION_NUMBER < 4000000
82 #define __LA_SSIZE_T la_ssize_t
84 #define __LA_SSIZE_T_DEFINED
85 # if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__)
86 # if defined(_SSIZE_T_DEFINED) || defined(_SSIZE_T_)
87 typedef ssize_t la_ssize_t;
88 # elif defined(_WIN64)
89 typedef __int64 la_ssize_t;
91 typedef long la_ssize_t;
94 # include <unistd.h> /* ssize_t */
95 typedef ssize_t la_ssize_t;
99 /* Large file support for Android */
101 #include "android_lf.h"
105 * On Windows, define LIBARCHIVE_STATIC if you're building or using a
106 * .lib. The default here assumes you're building a DLL. Only
107 * libarchive source should ever define __LIBARCHIVE_BUILD.
109 #if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC)
110 # ifdef __LIBARCHIVE_BUILD
112 # define __LA_DECL __attribute__((dllexport)) extern
114 # define __LA_DECL __declspec(dllexport)
120 # define __LA_DECL __declspec(dllimport)
124 /* Static libraries or non-Windows needs no special declaration. */
128 #if defined(__GNUC__) && __GNUC__ >= 3 && !defined(__MINGW32__)
129 #define __LA_PRINTF(fmtarg, firstvararg) \
130 __attribute__((__format__ (__printf__, fmtarg, firstvararg)))
132 #define __LA_PRINTF(fmtarg, firstvararg) /* nothing */
135 #if defined(__GNUC__) && __GNUC__ >= 3 && __GNUC_MINOR__ >= 1
136 # define __LA_DEPRECATED __attribute__((deprecated))
138 # define __LA_DEPRECATED
146 * The version number is provided as both a macro and a function.
147 * The macro identifies the installed header; the function identifies
148 * the library version (which may not be the same if you're using a
149 * dynamically-linked version of the library). Of course, if the
150 * header and library are very different, you should expect some
151 * strangeness. Don't do that.
153 __LA_DECL int archive_version_number(void);
156 * Textual name/version of the library, useful for version displays.
158 #define ARCHIVE_VERSION_ONLY_STRING "3.3.3"
159 #define ARCHIVE_VERSION_STRING "libarchive " ARCHIVE_VERSION_ONLY_STRING
160 __LA_DECL const char * archive_version_string(void);
163 * Detailed textual name/version of the library and its dependencies.
165 * "libarchive x.y.z zlib/a.b.c liblzma/d.e.f ... etc ..."
166 * the list of libraries described here will vary depending on how
167 * libarchive was compiled.
169 __LA_DECL const char * archive_version_details(void);
172 * Returns NULL if libarchive was compiled without the associated library.
173 * Otherwise, returns the version number that libarchive was compiled
176 __LA_DECL const char * archive_zlib_version(void);
177 __LA_DECL const char * archive_liblzma_version(void);
178 __LA_DECL const char * archive_bzlib_version(void);
179 __LA_DECL const char * archive_liblz4_version(void);
180 __LA_DECL const char * archive_libzstd_version(void);
182 /* Declare our basic types. */
184 struct archive_entry;
187 * Error codes: Use archive_errno() and archive_error_string()
188 * to retrieve details. Unless specified otherwise, all functions
189 * that return 'int' use these codes.
191 #define ARCHIVE_EOF 1 /* Found end of archive. */
192 #define ARCHIVE_OK 0 /* Operation was successful. */
193 #define ARCHIVE_RETRY (-10) /* Retry might succeed. */
194 #define ARCHIVE_WARN (-20) /* Partial success. */
195 /* For example, if write_header "fails", then you can't push data. */
196 #define ARCHIVE_FAILED (-25) /* Current operation cannot complete. */
197 /* But if write_header is "fatal," then this archive is dead and useless. */
198 #define ARCHIVE_FATAL (-30) /* No more operations are possible. */
201 * As far as possible, archive_errno returns standard platform errno codes.
202 * Of course, the details vary by platform, so the actual definitions
203 * here are stored in "archive_platform.h". The symbols are listed here
204 * for reference; as a rule, clients should not need to know the exact
205 * platform-dependent error code.
207 /* Unrecognized or invalid file format. */
208 /* #define ARCHIVE_ERRNO_FILE_FORMAT */
209 /* Illegal usage of the library. */
210 /* #define ARCHIVE_ERRNO_PROGRAMMER_ERROR */
211 /* Unknown or unclassified error. */
212 /* #define ARCHIVE_ERRNO_MISC */
215 * Callbacks are invoked to automatically read/skip/write/open/close the
216 * archive. You can provide your own for complex tasks (like breaking
217 * archives across multiple tapes) or use standard ones built into the
221 /* Returns pointer and size of next block of data from archive. */
222 typedef la_ssize_t archive_read_callback(struct archive *,
223 void *_client_data, const void **_buffer);
225 /* Skips at most request bytes from archive and returns the skipped amount.
226 * This may skip fewer bytes than requested; it may even skip zero bytes.
227 * If you do skip fewer bytes than requested, libarchive will invoke your
228 * read callback and discard data as necessary to make up the full skip.
230 typedef la_int64_t archive_skip_callback(struct archive *,
231 void *_client_data, la_int64_t request);
233 /* Seeks to specified location in the file and returns the position.
234 * Whence values are SEEK_SET, SEEK_CUR, SEEK_END from stdio.h.
235 * Return ARCHIVE_FATAL if the seek fails for any reason.
237 typedef la_int64_t archive_seek_callback(struct archive *,
238 void *_client_data, la_int64_t offset, int whence);
240 /* Returns size actually written, zero on EOF, -1 on error. */
241 typedef la_ssize_t archive_write_callback(struct archive *,
243 const void *_buffer, size_t _length);
245 typedef int archive_open_callback(struct archive *, void *_client_data);
247 typedef int archive_close_callback(struct archive *, void *_client_data);
249 /* Switches from one client data object to the next/prev client data object.
250 * This is useful for reading from different data blocks such as a set of files
251 * that make up one large file.
253 typedef int archive_switch_callback(struct archive *, void *_client_data1,
254 void *_client_data2);
257 * Returns a passphrase used for encryption or decryption, NULL on nothing
258 * to do and give it up.
260 typedef const char *archive_passphrase_callback(struct archive *,
264 * Codes to identify various stream filters.
266 #define ARCHIVE_FILTER_NONE 0
267 #define ARCHIVE_FILTER_GZIP 1
268 #define ARCHIVE_FILTER_BZIP2 2
269 #define ARCHIVE_FILTER_COMPRESS 3
270 #define ARCHIVE_FILTER_PROGRAM 4
271 #define ARCHIVE_FILTER_LZMA 5
272 #define ARCHIVE_FILTER_XZ 6
273 #define ARCHIVE_FILTER_UU 7
274 #define ARCHIVE_FILTER_RPM 8
275 #define ARCHIVE_FILTER_LZIP 9
276 #define ARCHIVE_FILTER_LRZIP 10
277 #define ARCHIVE_FILTER_LZOP 11
278 #define ARCHIVE_FILTER_GRZIP 12
279 #define ARCHIVE_FILTER_LZ4 13
280 #define ARCHIVE_FILTER_ZSTD 14
282 #if ARCHIVE_VERSION_NUMBER < 4000000
283 #define ARCHIVE_COMPRESSION_NONE ARCHIVE_FILTER_NONE
284 #define ARCHIVE_COMPRESSION_GZIP ARCHIVE_FILTER_GZIP
285 #define ARCHIVE_COMPRESSION_BZIP2 ARCHIVE_FILTER_BZIP2
286 #define ARCHIVE_COMPRESSION_COMPRESS ARCHIVE_FILTER_COMPRESS
287 #define ARCHIVE_COMPRESSION_PROGRAM ARCHIVE_FILTER_PROGRAM
288 #define ARCHIVE_COMPRESSION_LZMA ARCHIVE_FILTER_LZMA
289 #define ARCHIVE_COMPRESSION_XZ ARCHIVE_FILTER_XZ
290 #define ARCHIVE_COMPRESSION_UU ARCHIVE_FILTER_UU
291 #define ARCHIVE_COMPRESSION_RPM ARCHIVE_FILTER_RPM
292 #define ARCHIVE_COMPRESSION_LZIP ARCHIVE_FILTER_LZIP
293 #define ARCHIVE_COMPRESSION_LRZIP ARCHIVE_FILTER_LRZIP
297 * Codes returned by archive_format.
299 * Top 16 bits identifies the format family (e.g., "tar"); lower
300 * 16 bits indicate the variant. This is updated by read_next_header.
301 * Note that the lower 16 bits will often vary from entry to entry.
302 * In some cases, this variation occurs as libarchive learns more about
303 * the archive (for example, later entries might utilize extensions that
304 * weren't necessary earlier in the archive; in this case, libarchive
305 * will change the format code to indicate the extended format that
306 * was used). In other cases, it's because different tools have
307 * modified the archive and so different parts of the archive
308 * actually have slightly different formats. (Both tar and cpio store
309 * format codes in each entry, so it is quite possible for each
310 * entry to be in a different format.)
312 #define ARCHIVE_FORMAT_BASE_MASK 0xff0000
313 #define ARCHIVE_FORMAT_CPIO 0x10000
314 #define ARCHIVE_FORMAT_CPIO_POSIX (ARCHIVE_FORMAT_CPIO | 1)
315 #define ARCHIVE_FORMAT_CPIO_BIN_LE (ARCHIVE_FORMAT_CPIO | 2)
316 #define ARCHIVE_FORMAT_CPIO_BIN_BE (ARCHIVE_FORMAT_CPIO | 3)
317 #define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC (ARCHIVE_FORMAT_CPIO | 4)
318 #define ARCHIVE_FORMAT_CPIO_SVR4_CRC (ARCHIVE_FORMAT_CPIO | 5)
319 #define ARCHIVE_FORMAT_CPIO_AFIO_LARGE (ARCHIVE_FORMAT_CPIO | 6)
320 #define ARCHIVE_FORMAT_SHAR 0x20000
321 #define ARCHIVE_FORMAT_SHAR_BASE (ARCHIVE_FORMAT_SHAR | 1)
322 #define ARCHIVE_FORMAT_SHAR_DUMP (ARCHIVE_FORMAT_SHAR | 2)
323 #define ARCHIVE_FORMAT_TAR 0x30000
324 #define ARCHIVE_FORMAT_TAR_USTAR (ARCHIVE_FORMAT_TAR | 1)
325 #define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE (ARCHIVE_FORMAT_TAR | 2)
326 #define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED (ARCHIVE_FORMAT_TAR | 3)
327 #define ARCHIVE_FORMAT_TAR_GNUTAR (ARCHIVE_FORMAT_TAR | 4)
328 #define ARCHIVE_FORMAT_ISO9660 0x40000
329 #define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE (ARCHIVE_FORMAT_ISO9660 | 1)
330 #define ARCHIVE_FORMAT_ZIP 0x50000
331 #define ARCHIVE_FORMAT_EMPTY 0x60000
332 #define ARCHIVE_FORMAT_AR 0x70000
333 #define ARCHIVE_FORMAT_AR_GNU (ARCHIVE_FORMAT_AR | 1)
334 #define ARCHIVE_FORMAT_AR_BSD (ARCHIVE_FORMAT_AR | 2)
335 #define ARCHIVE_FORMAT_MTREE 0x80000
336 #define ARCHIVE_FORMAT_RAW 0x90000
337 #define ARCHIVE_FORMAT_XAR 0xA0000
338 #define ARCHIVE_FORMAT_LHA 0xB0000
339 #define ARCHIVE_FORMAT_CAB 0xC0000
340 #define ARCHIVE_FORMAT_RAR 0xD0000
341 #define ARCHIVE_FORMAT_7ZIP 0xE0000
342 #define ARCHIVE_FORMAT_WARC 0xF0000
345 * Codes returned by archive_read_format_capabilities().
347 * This list can be extended with values between 0 and 0xffff.
348 * The original purpose of this list was to let different archive
349 * format readers expose their general capabilities in terms of
352 #define ARCHIVE_READ_FORMAT_CAPS_NONE (0) /* no special capabilities */
353 #define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_DATA (1<<0) /* reader can detect encrypted data */
354 #define ARCHIVE_READ_FORMAT_CAPS_ENCRYPT_METADATA (1<<1) /* reader can detect encryptable metadata (pathname, mtime, etc.) */
357 * Codes returned by archive_read_has_encrypted_entries().
359 * In case the archive does not support encryption detection at all
360 * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned. If the reader
361 * for some other reason (e.g. not enough bytes read) cannot say if
362 * there are encrypted entries, ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW
365 #define ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED -2
366 #define ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW -1
369 * Basic outline for reading an archive:
370 * 1) Ask archive_read_new for an archive reader object.
371 * 2) Update any global properties as appropriate.
372 * In particular, you'll certainly want to call appropriate
373 * archive_read_support_XXX functions.
374 * 3) Call archive_read_open_XXX to open the archive
375 * 4) Repeatedly call archive_read_next_header to get information about
376 * successive archive entries. Call archive_read_data to extract
377 * data for entries of interest.
378 * 5) Call archive_read_free to end processing.
380 __LA_DECL struct archive *archive_read_new(void);
383 * The archive_read_support_XXX calls enable auto-detect for this
384 * archive handle. They also link in the necessary support code.
385 * For example, if you don't want bzlib linked in, don't invoke
386 * support_compression_bzip2(). The "all" functions provide the
390 #if ARCHIVE_VERSION_NUMBER < 4000000
391 __LA_DECL int archive_read_support_compression_all(struct archive *)
393 __LA_DECL int archive_read_support_compression_bzip2(struct archive *)
395 __LA_DECL int archive_read_support_compression_compress(struct archive *)
397 __LA_DECL int archive_read_support_compression_gzip(struct archive *)
399 __LA_DECL int archive_read_support_compression_lzip(struct archive *)
401 __LA_DECL int archive_read_support_compression_lzma(struct archive *)
403 __LA_DECL int archive_read_support_compression_none(struct archive *)
405 __LA_DECL int archive_read_support_compression_program(struct archive *,
406 const char *command) __LA_DEPRECATED;
407 __LA_DECL int archive_read_support_compression_program_signature
408 (struct archive *, const char *,
409 const void * /* match */, size_t) __LA_DEPRECATED;
411 __LA_DECL int archive_read_support_compression_rpm(struct archive *)
413 __LA_DECL int archive_read_support_compression_uu(struct archive *)
415 __LA_DECL int archive_read_support_compression_xz(struct archive *)
419 __LA_DECL int archive_read_support_filter_all(struct archive *);
420 __LA_DECL int archive_read_support_filter_bzip2(struct archive *);
421 __LA_DECL int archive_read_support_filter_compress(struct archive *);
422 __LA_DECL int archive_read_support_filter_gzip(struct archive *);
423 __LA_DECL int archive_read_support_filter_grzip(struct archive *);
424 __LA_DECL int archive_read_support_filter_lrzip(struct archive *);
425 __LA_DECL int archive_read_support_filter_lz4(struct archive *);
426 __LA_DECL int archive_read_support_filter_lzip(struct archive *);
427 __LA_DECL int archive_read_support_filter_lzma(struct archive *);
428 __LA_DECL int archive_read_support_filter_lzop(struct archive *);
429 __LA_DECL int archive_read_support_filter_none(struct archive *);
430 __LA_DECL int archive_read_support_filter_program(struct archive *,
431 const char *command);
432 __LA_DECL int archive_read_support_filter_program_signature
433 (struct archive *, const char * /* cmd */,
434 const void * /* match */, size_t);
435 __LA_DECL int archive_read_support_filter_rpm(struct archive *);
436 __LA_DECL int archive_read_support_filter_uu(struct archive *);
437 __LA_DECL int archive_read_support_filter_xz(struct archive *);
438 __LA_DECL int archive_read_support_filter_zstd(struct archive *);
440 __LA_DECL int archive_read_support_format_7zip(struct archive *);
441 __LA_DECL int archive_read_support_format_all(struct archive *);
442 __LA_DECL int archive_read_support_format_ar(struct archive *);
443 __LA_DECL int archive_read_support_format_by_code(struct archive *, int);
444 __LA_DECL int archive_read_support_format_cab(struct archive *);
445 __LA_DECL int archive_read_support_format_cpio(struct archive *);
446 __LA_DECL int archive_read_support_format_empty(struct archive *);
447 __LA_DECL int archive_read_support_format_gnutar(struct archive *);
448 __LA_DECL int archive_read_support_format_iso9660(struct archive *);
449 __LA_DECL int archive_read_support_format_lha(struct archive *);
450 __LA_DECL int archive_read_support_format_mtree(struct archive *);
451 __LA_DECL int archive_read_support_format_rar(struct archive *);
452 __LA_DECL int archive_read_support_format_raw(struct archive *);
453 __LA_DECL int archive_read_support_format_tar(struct archive *);
454 __LA_DECL int archive_read_support_format_warc(struct archive *);
455 __LA_DECL int archive_read_support_format_xar(struct archive *);
456 /* archive_read_support_format_zip() enables both streamable and seekable
458 __LA_DECL int archive_read_support_format_zip(struct archive *);
459 /* Reads Zip archives as stream from beginning to end. Doesn't
460 * correctly handle SFX ZIP files or ZIP archives that have been modified
462 __LA_DECL int archive_read_support_format_zip_streamable(struct archive *);
463 /* Reads starting from central directory; requires seekable input. */
464 __LA_DECL int archive_read_support_format_zip_seekable(struct archive *);
466 /* Functions to manually set the format and filters to be used. This is
467 * useful to bypass the bidding process when the format and filters to use
468 * is known in advance.
470 __LA_DECL int archive_read_set_format(struct archive *, int);
471 __LA_DECL int archive_read_append_filter(struct archive *, int);
472 __LA_DECL int archive_read_append_filter_program(struct archive *,
474 __LA_DECL int archive_read_append_filter_program_signature
475 (struct archive *, const char *, const void * /* match */, size_t);
477 /* Set various callbacks. */
478 __LA_DECL int archive_read_set_open_callback(struct archive *,
479 archive_open_callback *);
480 __LA_DECL int archive_read_set_read_callback(struct archive *,
481 archive_read_callback *);
482 __LA_DECL int archive_read_set_seek_callback(struct archive *,
483 archive_seek_callback *);
484 __LA_DECL int archive_read_set_skip_callback(struct archive *,
485 archive_skip_callback *);
486 __LA_DECL int archive_read_set_close_callback(struct archive *,
487 archive_close_callback *);
488 /* Callback used to switch between one data object to the next */
489 __LA_DECL int archive_read_set_switch_callback(struct archive *,
490 archive_switch_callback *);
492 /* This sets the first data object. */
493 __LA_DECL int archive_read_set_callback_data(struct archive *, void *);
494 /* This sets data object at specified index */
495 __LA_DECL int archive_read_set_callback_data2(struct archive *, void *,
497 /* This adds a data object at the specified index. */
498 __LA_DECL int archive_read_add_callback_data(struct archive *, void *,
500 /* This appends a data object to the end of list */
501 __LA_DECL int archive_read_append_callback_data(struct archive *, void *);
502 /* This prepends a data object to the beginning of list */
503 __LA_DECL int archive_read_prepend_callback_data(struct archive *, void *);
505 /* Opening freezes the callbacks. */
506 __LA_DECL int archive_read_open1(struct archive *);
508 /* Convenience wrappers around the above. */
509 __LA_DECL int archive_read_open(struct archive *, void *_client_data,
510 archive_open_callback *, archive_read_callback *,
511 archive_close_callback *);
512 __LA_DECL int archive_read_open2(struct archive *, void *_client_data,
513 archive_open_callback *, archive_read_callback *,
514 archive_skip_callback *, archive_close_callback *);
517 * A variety of shortcuts that invoke archive_read_open() with
518 * canned callbacks suitable for common situations. The ones that
519 * accept a block size handle tape blocking correctly.
521 /* Use this if you know the filename. Note: NULL indicates stdin. */
522 __LA_DECL int archive_read_open_filename(struct archive *,
523 const char *_filename, size_t _block_size);
524 /* Use this for reading multivolume files by filenames.
525 * NOTE: Must be NULL terminated. Sorting is NOT done. */
526 __LA_DECL int archive_read_open_filenames(struct archive *,
527 const char **_filenames, size_t _block_size);
528 __LA_DECL int archive_read_open_filename_w(struct archive *,
529 const wchar_t *_filename, size_t _block_size);
530 /* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
531 __LA_DECL int archive_read_open_file(struct archive *,
532 const char *_filename, size_t _block_size) __LA_DEPRECATED;
533 /* Read an archive that's stored in memory. */
534 __LA_DECL int archive_read_open_memory(struct archive *,
535 const void * buff, size_t size);
536 /* A more involved version that is only used for internal testing. */
537 __LA_DECL int archive_read_open_memory2(struct archive *a, const void *buff,
538 size_t size, size_t read_size);
539 /* Read an archive that's already open, using the file descriptor. */
540 __LA_DECL int archive_read_open_fd(struct archive *, int _fd,
542 /* Read an archive that's already open, using a FILE *. */
543 /* Note: DO NOT use this with tape drives. */
544 __LA_DECL int archive_read_open_FILE(struct archive *, FILE *_file);
546 /* Parses and returns next entry header. */
547 __LA_DECL int archive_read_next_header(struct archive *,
548 struct archive_entry **);
550 /* Parses and returns next entry header using the archive_entry passed in */
551 __LA_DECL int archive_read_next_header2(struct archive *,
552 struct archive_entry *);
555 * Retrieve the byte offset in UNCOMPRESSED data where last-read
558 __LA_DECL la_int64_t archive_read_header_position(struct archive *);
561 * Returns 1 if the archive contains at least one encrypted entry.
562 * If the archive format not support encryption at all
563 * ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED is returned.
564 * If for any other reason (e.g. not enough data read so far)
565 * we cannot say whether there are encrypted entries, then
566 * ARCHIVE_READ_FORMAT_ENCRYPTION_DONT_KNOW is returned.
567 * In general, this function will return values below zero when the
568 * reader is uncertain or totally incapable of encryption support.
569 * When this function returns 0 you can be sure that the reader
570 * supports encryption detection but no encrypted entries have
573 * NOTE: If the metadata/header of an archive is also encrypted, you
574 * cannot rely on the number of encrypted entries. That is why this
575 * function does not return the number of encrypted entries but#
576 * just shows that there are some.
578 __LA_DECL int archive_read_has_encrypted_entries(struct archive *);
581 * Returns a bitmask of capabilities that are supported by the archive format reader.
582 * If the reader has no special capabilities, ARCHIVE_READ_FORMAT_CAPS_NONE is returned.
584 __LA_DECL int archive_read_format_capabilities(struct archive *);
586 /* Read data from the body of an entry. Similar to read(2). */
587 __LA_DECL la_ssize_t archive_read_data(struct archive *,
590 /* Seek within the body of an entry. Similar to lseek(2). */
591 __LA_DECL la_int64_t archive_seek_data(struct archive *, la_int64_t, int);
594 * A zero-copy version of archive_read_data that also exposes the file offset
595 * of each returned block. Note that the client has no way to specify
596 * the desired size of the block. The API does guarantee that offsets will
597 * be strictly increasing and that returned blocks will not overlap.
599 __LA_DECL int archive_read_data_block(struct archive *a,
600 const void **buff, size_t *size, la_int64_t *offset);
603 * Some convenience functions that are built on archive_read_data:
604 * 'skip': skips entire entry
605 * 'into_buffer': writes data into memory buffer that you provide
606 * 'into_fd': writes data to specified filedes
608 __LA_DECL int archive_read_data_skip(struct archive *);
609 __LA_DECL int archive_read_data_into_fd(struct archive *, int fd);
614 /* Apply option to the format only. */
615 __LA_DECL int archive_read_set_format_option(struct archive *_a,
616 const char *m, const char *o,
618 /* Apply option to the filter only. */
619 __LA_DECL int archive_read_set_filter_option(struct archive *_a,
620 const char *m, const char *o,
622 /* Apply option to both the format and the filter. */
623 __LA_DECL int archive_read_set_option(struct archive *_a,
624 const char *m, const char *o,
626 /* Apply option string to both the format and the filter. */
627 __LA_DECL int archive_read_set_options(struct archive *_a,
631 * Add a decryption passphrase.
633 __LA_DECL int archive_read_add_passphrase(struct archive *, const char *);
634 __LA_DECL int archive_read_set_passphrase_callback(struct archive *,
635 void *client_data, archive_passphrase_callback *);
639 * Convenience function to recreate the current entry (whose header
640 * has just been read) on disk.
642 * This does quite a bit more than just copy data to disk. It also:
643 * - Creates intermediate directories as required.
644 * - Manages directory permissions: non-writable directories will
645 * be initially created with write permission enabled; when the
646 * archive is closed, dir permissions are edited to the values specified
648 * - Checks hardlinks: hardlinks will not be extracted unless the
649 * linked-to file was also extracted within the same session. (TODO)
652 /* The "flags" argument selects optional behavior, 'OR' the flags you want. */
654 /* Default: Do not try to set owner/group. */
655 #define ARCHIVE_EXTRACT_OWNER (0x0001)
656 /* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
657 #define ARCHIVE_EXTRACT_PERM (0x0002)
658 /* Default: Do not restore mtime/atime. */
659 #define ARCHIVE_EXTRACT_TIME (0x0004)
660 /* Default: Replace existing files. */
661 #define ARCHIVE_EXTRACT_NO_OVERWRITE (0x0008)
662 /* Default: Try create first, unlink only if create fails with EEXIST. */
663 #define ARCHIVE_EXTRACT_UNLINK (0x0010)
664 /* Default: Do not restore ACLs. */
665 #define ARCHIVE_EXTRACT_ACL (0x0020)
666 /* Default: Do not restore fflags. */
667 #define ARCHIVE_EXTRACT_FFLAGS (0x0040)
668 /* Default: Do not restore xattrs. */
669 #define ARCHIVE_EXTRACT_XATTR (0x0080)
670 /* Default: Do not try to guard against extracts redirected by symlinks. */
671 /* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
672 #define ARCHIVE_EXTRACT_SECURE_SYMLINKS (0x0100)
673 /* Default: Do not reject entries with '..' as path elements. */
674 #define ARCHIVE_EXTRACT_SECURE_NODOTDOT (0x0200)
675 /* Default: Create parent directories as needed. */
676 #define ARCHIVE_EXTRACT_NO_AUTODIR (0x0400)
677 /* Default: Overwrite files, even if one on disk is newer. */
678 #define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER (0x0800)
679 /* Detect blocks of 0 and write holes instead. */
680 #define ARCHIVE_EXTRACT_SPARSE (0x1000)
681 /* Default: Do not restore Mac extended metadata. */
682 /* This has no effect except on Mac OS. */
683 #define ARCHIVE_EXTRACT_MAC_METADATA (0x2000)
684 /* Default: Use HFS+ compression if it was compressed. */
685 /* This has no effect except on Mac OS v10.6 or later. */
686 #define ARCHIVE_EXTRACT_NO_HFS_COMPRESSION (0x4000)
687 /* Default: Do not use HFS+ compression if it was not compressed. */
688 /* This has no effect except on Mac OS v10.6 or later. */
689 #define ARCHIVE_EXTRACT_HFS_COMPRESSION_FORCED (0x8000)
690 /* Default: Do not reject entries with absolute paths */
691 #define ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS (0x10000)
692 /* Default: Do not clear no-change flags when unlinking object */
693 #define ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS (0x20000)
695 __LA_DECL int archive_read_extract(struct archive *, struct archive_entry *,
697 __LA_DECL int archive_read_extract2(struct archive *, struct archive_entry *,
698 struct archive * /* dest */);
699 __LA_DECL void archive_read_extract_set_progress_callback(struct archive *,
700 void (*_progress_func)(void *), void *_user_data);
702 /* Record the dev/ino of a file that will not be written. This is
703 * generally set to the dev/ino of the archive being read. */
704 __LA_DECL void archive_read_extract_set_skip_file(struct archive *,
705 la_int64_t, la_int64_t);
707 /* Close the file and release most resources. */
708 __LA_DECL int archive_read_close(struct archive *);
709 /* Release all resources and destroy the object. */
710 /* Note that archive_read_free will call archive_read_close for you. */
711 __LA_DECL int archive_read_free(struct archive *);
712 #if ARCHIVE_VERSION_NUMBER < 4000000
713 /* Synonym for archive_read_free() for backwards compatibility. */
714 __LA_DECL int archive_read_finish(struct archive *) __LA_DEPRECATED;
718 * To create an archive:
719 * 1) Ask archive_write_new for an archive writer object.
720 * 2) Set any global properties. In particular, you should set
721 * the compression and format to use.
722 * 3) Call archive_write_open to open the file (most people
723 * will use archive_write_open_file or archive_write_open_fd,
724 * which provide convenient canned I/O callbacks for you).
726 * - construct an appropriate struct archive_entry structure
727 * - archive_write_header to write the header
728 * - archive_write_data to write the entry data
729 * 5) archive_write_close to close the output
730 * 6) archive_write_free to cleanup the writer and release resources
732 __LA_DECL struct archive *archive_write_new(void);
733 __LA_DECL int archive_write_set_bytes_per_block(struct archive *,
734 int bytes_per_block);
735 __LA_DECL int archive_write_get_bytes_per_block(struct archive *);
736 /* XXX This is badly misnamed; suggestions appreciated. XXX */
737 __LA_DECL int archive_write_set_bytes_in_last_block(struct archive *,
738 int bytes_in_last_block);
739 __LA_DECL int archive_write_get_bytes_in_last_block(struct archive *);
741 /* The dev/ino of a file that won't be archived. This is used
742 * to avoid recursively adding an archive to itself. */
743 __LA_DECL int archive_write_set_skip_file(struct archive *,
744 la_int64_t, la_int64_t);
746 #if ARCHIVE_VERSION_NUMBER < 4000000
747 __LA_DECL int archive_write_set_compression_bzip2(struct archive *)
749 __LA_DECL int archive_write_set_compression_compress(struct archive *)
751 __LA_DECL int archive_write_set_compression_gzip(struct archive *)
753 __LA_DECL int archive_write_set_compression_lzip(struct archive *)
755 __LA_DECL int archive_write_set_compression_lzma(struct archive *)
757 __LA_DECL int archive_write_set_compression_none(struct archive *)
759 __LA_DECL int archive_write_set_compression_program(struct archive *,
760 const char *cmd) __LA_DEPRECATED;
761 __LA_DECL int archive_write_set_compression_xz(struct archive *)
765 /* A convenience function to set the filter based on the code. */
766 __LA_DECL int archive_write_add_filter(struct archive *, int filter_code);
767 __LA_DECL int archive_write_add_filter_by_name(struct archive *,
769 __LA_DECL int archive_write_add_filter_b64encode(struct archive *);
770 __LA_DECL int archive_write_add_filter_bzip2(struct archive *);
771 __LA_DECL int archive_write_add_filter_compress(struct archive *);
772 __LA_DECL int archive_write_add_filter_grzip(struct archive *);
773 __LA_DECL int archive_write_add_filter_gzip(struct archive *);
774 __LA_DECL int archive_write_add_filter_lrzip(struct archive *);
775 __LA_DECL int archive_write_add_filter_lz4(struct archive *);
776 __LA_DECL int archive_write_add_filter_lzip(struct archive *);
777 __LA_DECL int archive_write_add_filter_lzma(struct archive *);
778 __LA_DECL int archive_write_add_filter_lzop(struct archive *);
779 __LA_DECL int archive_write_add_filter_none(struct archive *);
780 __LA_DECL int archive_write_add_filter_program(struct archive *,
782 __LA_DECL int archive_write_add_filter_uuencode(struct archive *);
783 __LA_DECL int archive_write_add_filter_xz(struct archive *);
784 __LA_DECL int archive_write_add_filter_zstd(struct archive *);
787 /* A convenience function to set the format based on the code or name. */
788 __LA_DECL int archive_write_set_format(struct archive *, int format_code);
789 __LA_DECL int archive_write_set_format_by_name(struct archive *,
791 /* To minimize link pollution, use one or more of the following. */
792 __LA_DECL int archive_write_set_format_7zip(struct archive *);
793 __LA_DECL int archive_write_set_format_ar_bsd(struct archive *);
794 __LA_DECL int archive_write_set_format_ar_svr4(struct archive *);
795 __LA_DECL int archive_write_set_format_cpio(struct archive *);
796 __LA_DECL int archive_write_set_format_cpio_newc(struct archive *);
797 __LA_DECL int archive_write_set_format_gnutar(struct archive *);
798 __LA_DECL int archive_write_set_format_iso9660(struct archive *);
799 __LA_DECL int archive_write_set_format_mtree(struct archive *);
800 __LA_DECL int archive_write_set_format_mtree_classic(struct archive *);
801 /* TODO: int archive_write_set_format_old_tar(struct archive *); */
802 __LA_DECL int archive_write_set_format_pax(struct archive *);
803 __LA_DECL int archive_write_set_format_pax_restricted(struct archive *);
804 __LA_DECL int archive_write_set_format_raw(struct archive *);
805 __LA_DECL int archive_write_set_format_shar(struct archive *);
806 __LA_DECL int archive_write_set_format_shar_dump(struct archive *);
807 __LA_DECL int archive_write_set_format_ustar(struct archive *);
808 __LA_DECL int archive_write_set_format_v7tar(struct archive *);
809 __LA_DECL int archive_write_set_format_warc(struct archive *);
810 __LA_DECL int archive_write_set_format_xar(struct archive *);
811 __LA_DECL int archive_write_set_format_zip(struct archive *);
812 __LA_DECL int archive_write_set_format_filter_by_ext(struct archive *a, const char *filename);
813 __LA_DECL int archive_write_set_format_filter_by_ext_def(struct archive *a, const char *filename, const char * def_ext);
814 __LA_DECL int archive_write_zip_set_compression_deflate(struct archive *);
815 __LA_DECL int archive_write_zip_set_compression_store(struct archive *);
816 __LA_DECL int archive_write_open(struct archive *, void *,
817 archive_open_callback *, archive_write_callback *,
818 archive_close_callback *);
819 __LA_DECL int archive_write_open_fd(struct archive *, int _fd);
820 __LA_DECL int archive_write_open_filename(struct archive *, const char *_file);
821 __LA_DECL int archive_write_open_filename_w(struct archive *,
822 const wchar_t *_file);
823 /* A deprecated synonym for archive_write_open_filename() */
824 __LA_DECL int archive_write_open_file(struct archive *, const char *_file)
826 __LA_DECL int archive_write_open_FILE(struct archive *, FILE *);
827 /* _buffSize is the size of the buffer, _used refers to a variable that
828 * will be updated after each write into the buffer. */
829 __LA_DECL int archive_write_open_memory(struct archive *,
830 void *_buffer, size_t _buffSize, size_t *_used);
833 * Note that the library will truncate writes beyond the size provided
834 * to archive_write_header or pad if the provided data is short.
836 __LA_DECL int archive_write_header(struct archive *,
837 struct archive_entry *);
838 __LA_DECL la_ssize_t archive_write_data(struct archive *,
839 const void *, size_t);
841 /* This interface is currently only available for archive_write_disk handles. */
842 __LA_DECL la_ssize_t archive_write_data_block(struct archive *,
843 const void *, size_t, la_int64_t);
845 __LA_DECL int archive_write_finish_entry(struct archive *);
846 __LA_DECL int archive_write_close(struct archive *);
847 /* Marks the archive as FATAL so that a subsequent free() operation
848 * won't try to close() cleanly. Provides a fast abort capability
849 * when the client discovers that things have gone wrong. */
850 __LA_DECL int archive_write_fail(struct archive *);
851 /* This can fail if the archive wasn't already closed, in which case
852 * archive_write_free() will implicitly call archive_write_close(). */
853 __LA_DECL int archive_write_free(struct archive *);
854 #if ARCHIVE_VERSION_NUMBER < 4000000
855 /* Synonym for archive_write_free() for backwards compatibility. */
856 __LA_DECL int archive_write_finish(struct archive *) __LA_DEPRECATED;
862 /* Apply option to the format only. */
863 __LA_DECL int archive_write_set_format_option(struct archive *_a,
864 const char *m, const char *o,
866 /* Apply option to the filter only. */
867 __LA_DECL int archive_write_set_filter_option(struct archive *_a,
868 const char *m, const char *o,
870 /* Apply option to both the format and the filter. */
871 __LA_DECL int archive_write_set_option(struct archive *_a,
872 const char *m, const char *o,
874 /* Apply option string to both the format and the filter. */
875 __LA_DECL int archive_write_set_options(struct archive *_a,
879 * Set a encryption passphrase.
881 __LA_DECL int archive_write_set_passphrase(struct archive *_a, const char *p);
882 __LA_DECL int archive_write_set_passphrase_callback(struct archive *,
883 void *client_data, archive_passphrase_callback *);
886 * ARCHIVE_WRITE_DISK API
888 * To create objects on disk:
889 * 1) Ask archive_write_disk_new for a new archive_write_disk object.
890 * 2) Set any global properties. In particular, you probably
891 * want to set the options.
893 * - construct an appropriate struct archive_entry structure
894 * - archive_write_header to create the file/dir/etc on disk
895 * - archive_write_data to write the entry data
896 * 4) archive_write_free to cleanup the writer and release resources
898 * In particular, you can use this in conjunction with archive_read()
899 * to pull entries out of an archive and create them on disk.
901 __LA_DECL struct archive *archive_write_disk_new(void);
902 /* This file will not be overwritten. */
903 __LA_DECL int archive_write_disk_set_skip_file(struct archive *,
904 la_int64_t, la_int64_t);
905 /* Set flags to control how the next item gets created.
906 * This accepts a bitmask of ARCHIVE_EXTRACT_XXX flags defined above. */
907 __LA_DECL int archive_write_disk_set_options(struct archive *,
910 * The lookup functions are given uname/uid (or gname/gid) pairs and
911 * return a uid (gid) suitable for this system. These are used for
912 * restoring ownership and for setting ACLs. The default functions
913 * are naive, they just return the uid/gid. These are small, so reasonable
914 * for applications that don't need to preserve ownership; they
915 * are probably also appropriate for applications that are doing
916 * same-system backup and restore.
919 * The "standard" lookup functions use common system calls to lookup
920 * the uname/gname, falling back to the uid/gid if the names can't be
921 * found. They cache lookups and are reasonably fast, but can be very
922 * large, so they are not used unless you ask for them. In
923 * particular, these match the specifications of POSIX "pax" and old
926 __LA_DECL int archive_write_disk_set_standard_lookup(struct archive *);
928 * If neither the default (naive) nor the standard (big) functions suit
929 * your needs, you can write your own and register them. Be sure to
930 * include a cleanup function if you have allocated private data.
932 __LA_DECL int archive_write_disk_set_group_lookup(struct archive *,
933 void * /* private_data */,
934 la_int64_t (*)(void *, const char *, la_int64_t),
935 void (* /* cleanup */)(void *));
936 __LA_DECL int archive_write_disk_set_user_lookup(struct archive *,
937 void * /* private_data */,
938 la_int64_t (*)(void *, const char *, la_int64_t),
939 void (* /* cleanup */)(void *));
940 __LA_DECL la_int64_t archive_write_disk_gid(struct archive *, const char *, la_int64_t);
941 __LA_DECL la_int64_t archive_write_disk_uid(struct archive *, const char *, la_int64_t);
944 * ARCHIVE_READ_DISK API
946 * This is still evolving and somewhat experimental.
948 __LA_DECL struct archive *archive_read_disk_new(void);
949 /* The names for symlink modes here correspond to an old BSD
950 * command-line argument convention: -L, -P, -H */
951 /* Follow all symlinks. */
952 __LA_DECL int archive_read_disk_set_symlink_logical(struct archive *);
953 /* Follow no symlinks. */
954 __LA_DECL int archive_read_disk_set_symlink_physical(struct archive *);
955 /* Follow symlink initially, then not. */
956 __LA_DECL int archive_read_disk_set_symlink_hybrid(struct archive *);
957 /* TODO: Handle Linux stat32/stat64 ugliness. <sigh> */
958 __LA_DECL int archive_read_disk_entry_from_file(struct archive *,
959 struct archive_entry *, int /* fd */, const struct stat *);
960 /* Look up gname for gid or uname for uid. */
961 /* Default implementations are very, very stupid. */
962 __LA_DECL const char *archive_read_disk_gname(struct archive *, la_int64_t);
963 __LA_DECL const char *archive_read_disk_uname(struct archive *, la_int64_t);
964 /* "Standard" implementation uses getpwuid_r, getgrgid_r and caches the
965 * results for performance. */
966 __LA_DECL int archive_read_disk_set_standard_lookup(struct archive *);
967 /* You can install your own lookups if you like. */
968 __LA_DECL int archive_read_disk_set_gname_lookup(struct archive *,
969 void * /* private_data */,
970 const char *(* /* lookup_fn */)(void *, la_int64_t),
971 void (* /* cleanup_fn */)(void *));
972 __LA_DECL int archive_read_disk_set_uname_lookup(struct archive *,
973 void * /* private_data */,
974 const char *(* /* lookup_fn */)(void *, la_int64_t),
975 void (* /* cleanup_fn */)(void *));
976 /* Start traversal. */
977 __LA_DECL int archive_read_disk_open(struct archive *, const char *);
978 __LA_DECL int archive_read_disk_open_w(struct archive *, const wchar_t *);
980 * Request that current entry be visited. If you invoke it on every
981 * directory, you'll get a physical traversal. This is ignored if the
982 * current entry isn't a directory or a link to a directory. So, if
983 * you invoke this on every returned path, you'll get a full logical
986 __LA_DECL int archive_read_disk_descend(struct archive *);
987 __LA_DECL int archive_read_disk_can_descend(struct archive *);
988 __LA_DECL int archive_read_disk_current_filesystem(struct archive *);
989 __LA_DECL int archive_read_disk_current_filesystem_is_synthetic(struct archive *);
990 __LA_DECL int archive_read_disk_current_filesystem_is_remote(struct archive *);
991 /* Request that the access time of the entry visited by traversal be restored. */
992 __LA_DECL int archive_read_disk_set_atime_restored(struct archive *);
994 * Set behavior. The "flags" argument selects optional behavior.
996 /* Request that the access time of the entry visited by traversal be restored.
997 * This is the same as archive_read_disk_set_atime_restored. */
998 #define ARCHIVE_READDISK_RESTORE_ATIME (0x0001)
999 /* Default: Do not skip an entry which has nodump flags. */
1000 #define ARCHIVE_READDISK_HONOR_NODUMP (0x0002)
1001 /* Default: Skip a mac resource fork file whose prefix is "._" because of
1002 * using copyfile. */
1003 #define ARCHIVE_READDISK_MAC_COPYFILE (0x0004)
1004 /* Default: Traverse mount points. */
1005 #define ARCHIVE_READDISK_NO_TRAVERSE_MOUNTS (0x0008)
1006 /* Default: Xattrs are read from disk. */
1007 #define ARCHIVE_READDISK_NO_XATTR (0x0010)
1008 /* Default: ACLs are read from disk. */
1009 #define ARCHIVE_READDISK_NO_ACL (0x0020)
1010 /* Default: File flags are read from disk. */
1011 #define ARCHIVE_READDISK_NO_FFLAGS (0x0040)
1013 __LA_DECL int archive_read_disk_set_behavior(struct archive *,
1017 * Set archive_match object that will be used in archive_read_disk to
1018 * know whether an entry should be skipped. The callback function
1019 * _excluded_func will be invoked when an entry is skipped by the result
1022 __LA_DECL int archive_read_disk_set_matching(struct archive *,
1023 struct archive *_matching, void (*_excluded_func)
1024 (struct archive *, void *, struct archive_entry *),
1025 void *_client_data);
1026 __LA_DECL int archive_read_disk_set_metadata_filter_callback(struct archive *,
1027 int (*_metadata_filter_func)(struct archive *, void *,
1028 struct archive_entry *), void *_client_data);
1030 /* Simplified cleanup interface;
1031 * This calls archive_read_free() or archive_write_free() as needed. */
1032 __LA_DECL int archive_free(struct archive *);
1035 * Accessor functions to read/set various information in
1036 * the struct archive object:
1039 /* Number of filters in the current filter pipeline. */
1040 /* Filter #0 is the one closest to the format, -1 is a synonym for the
1041 * last filter, which is always the pseudo-filter that wraps the
1042 * client callbacks. */
1043 __LA_DECL int archive_filter_count(struct archive *);
1044 __LA_DECL la_int64_t archive_filter_bytes(struct archive *, int);
1045 __LA_DECL int archive_filter_code(struct archive *, int);
1046 __LA_DECL const char * archive_filter_name(struct archive *, int);
1048 #if ARCHIVE_VERSION_NUMBER < 4000000
1049 /* These don't properly handle multiple filters, so are deprecated and
1050 * will eventually be removed. */
1051 /* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, -1); */
1052 __LA_DECL la_int64_t archive_position_compressed(struct archive *)
1054 /* As of libarchive 3.0, this is an alias for archive_filter_bytes(a, 0); */
1055 __LA_DECL la_int64_t archive_position_uncompressed(struct archive *)
1057 /* As of libarchive 3.0, this is an alias for archive_filter_name(a, 0); */
1058 __LA_DECL const char *archive_compression_name(struct archive *)
1060 /* As of libarchive 3.0, this is an alias for archive_filter_code(a, 0); */
1061 __LA_DECL int archive_compression(struct archive *)
1065 __LA_DECL int archive_errno(struct archive *);
1066 __LA_DECL const char *archive_error_string(struct archive *);
1067 __LA_DECL const char *archive_format_name(struct archive *);
1068 __LA_DECL int archive_format(struct archive *);
1069 __LA_DECL void archive_clear_error(struct archive *);
1070 __LA_DECL void archive_set_error(struct archive *, int _err,
1071 const char *fmt, ...) __LA_PRINTF(3, 4);
1072 __LA_DECL void archive_copy_error(struct archive *dest,
1073 struct archive *src);
1074 __LA_DECL int archive_file_count(struct archive *);
1079 __LA_DECL struct archive *archive_match_new(void);
1080 __LA_DECL int archive_match_free(struct archive *);
1083 * Test if archive_entry is excluded.
1084 * This is a convenience function. This is the same as calling all
1085 * archive_match_path_excluded, archive_match_time_excluded
1086 * and archive_match_owner_excluded.
1088 __LA_DECL int archive_match_excluded(struct archive *,
1089 struct archive_entry *);
1092 * Test if pathname is excluded. The conditions are set by following functions.
1094 __LA_DECL int archive_match_path_excluded(struct archive *,
1095 struct archive_entry *);
1096 /* Add exclusion pathname pattern. */
1097 __LA_DECL int archive_match_exclude_pattern(struct archive *, const char *);
1098 __LA_DECL int archive_match_exclude_pattern_w(struct archive *,
1100 /* Add exclusion pathname pattern from file. */
1101 __LA_DECL int archive_match_exclude_pattern_from_file(struct archive *,
1102 const char *, int _nullSeparator);
1103 __LA_DECL int archive_match_exclude_pattern_from_file_w(struct archive *,
1104 const wchar_t *, int _nullSeparator);
1105 /* Add inclusion pathname pattern. */
1106 __LA_DECL int archive_match_include_pattern(struct archive *, const char *);
1107 __LA_DECL int archive_match_include_pattern_w(struct archive *,
1109 /* Add inclusion pathname pattern from file. */
1110 __LA_DECL int archive_match_include_pattern_from_file(struct archive *,
1111 const char *, int _nullSeparator);
1112 __LA_DECL int archive_match_include_pattern_from_file_w(struct archive *,
1113 const wchar_t *, int _nullSeparator);
1115 * How to get statistic information for inclusion patterns.
1117 /* Return the amount number of unmatched inclusion patterns. */
1118 __LA_DECL int archive_match_path_unmatched_inclusions(struct archive *);
1119 /* Return the pattern of unmatched inclusion with ARCHIVE_OK.
1120 * Return ARCHIVE_EOF if there is no inclusion pattern. */
1121 __LA_DECL int archive_match_path_unmatched_inclusions_next(
1122 struct archive *, const char **);
1123 __LA_DECL int archive_match_path_unmatched_inclusions_next_w(
1124 struct archive *, const wchar_t **);
1127 * Test if a file is excluded by its time stamp.
1128 * The conditions are set by following functions.
1130 __LA_DECL int archive_match_time_excluded(struct archive *,
1131 struct archive_entry *);
1134 * Flags to tell a matching type of time stamps. These are used for
1135 * following functions.
1137 /* Time flag: mtime to be tested. */
1138 #define ARCHIVE_MATCH_MTIME (0x0100)
1139 /* Time flag: ctime to be tested. */
1140 #define ARCHIVE_MATCH_CTIME (0x0200)
1141 /* Comparison flag: Match the time if it is newer than. */
1142 #define ARCHIVE_MATCH_NEWER (0x0001)
1143 /* Comparison flag: Match the time if it is older than. */
1144 #define ARCHIVE_MATCH_OLDER (0x0002)
1145 /* Comparison flag: Match the time if it is equal to. */
1146 #define ARCHIVE_MATCH_EQUAL (0x0010)
1147 /* Set inclusion time. */
1148 __LA_DECL int archive_match_include_time(struct archive *, int _flag,
1149 time_t _sec, long _nsec);
1150 /* Set inclusion time by a date string. */
1151 __LA_DECL int archive_match_include_date(struct archive *, int _flag,
1152 const char *_datestr);
1153 __LA_DECL int archive_match_include_date_w(struct archive *, int _flag,
1154 const wchar_t *_datestr);
1155 /* Set inclusion time by a particular file. */
1156 __LA_DECL int archive_match_include_file_time(struct archive *,
1157 int _flag, const char *_pathname);
1158 __LA_DECL int archive_match_include_file_time_w(struct archive *,
1159 int _flag, const wchar_t *_pathname);
1160 /* Add exclusion entry. */
1161 __LA_DECL int archive_match_exclude_entry(struct archive *,
1162 int _flag, struct archive_entry *);
1165 * Test if a file is excluded by its uid ,gid, uname or gname.
1166 * The conditions are set by following functions.
1168 __LA_DECL int archive_match_owner_excluded(struct archive *,
1169 struct archive_entry *);
1170 /* Add inclusion uid, gid, uname and gname. */
1171 __LA_DECL int archive_match_include_uid(struct archive *, la_int64_t);
1172 __LA_DECL int archive_match_include_gid(struct archive *, la_int64_t);
1173 __LA_DECL int archive_match_include_uname(struct archive *, const char *);
1174 __LA_DECL int archive_match_include_uname_w(struct archive *,
1176 __LA_DECL int archive_match_include_gname(struct archive *, const char *);
1177 __LA_DECL int archive_match_include_gname_w(struct archive *,
1180 /* Utility functions */
1181 /* Convenience function to sort a NULL terminated list of strings */
1182 __LA_DECL int archive_utility_string_sort(char **);
1188 /* These are meaningless outside of this header. */
1191 #endif /* !ARCHIVE_H_INCLUDED */