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