contrib/libarchive-2/libarchive/archive.h.in

   1 /*-
   2  * Copyright (c) 2003-2007 Tim Kientzle
   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.46 2007/07/06 15:36:37 kientzle Exp $
  26  */
  27
  28 #ifndef ARCHIVE_H_INCLUDED
  29 #define ARCHIVE_H_INCLUDED
  30
  31 /*
  32  * This header file corresponds to:
  33  *   Library version @ARCHIVE_VERSION@
  34  *   Shared library version @SHLIB_MAJOR@
  35  */
  36
  37 #include <sys/types.h>  /* Linux requires this for off_t */
  38 @ARCHIVE_H_INCLUDE_INTTYPES_H@
  39 #include <stdio.h> /* For FILE * */
  40 #ifndef _WIN32
  41 #include <unistd.h>  /* For ssize_t and size_t */
  42 #else
  43 typedef long ssize_t;
  44 typedef unsigned int uid_t;
  45 typedef unsigned int gid_t;
  46 typedef unsigned short mode_t;
  47 #endif
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /*
  54  * Each of the version identifiers comes as a macro and a function.
  55  * The macro identifies the installed header; the function identifies
  56  * the library version (which may not be the same if you're using a
  57  * dynamically-linked version of the library).
  58  */
  59
  60 /*
  61  * Textual name/version of the library, useful for version displays.
  62  */
  63 #define ARCHIVE_LIBRARY_VERSION "libarchive @ARCHIVE_VERSION@"
  64 const char *    archive_version(void);
  65
  66 /*
  67  * Major version number: If ARCHIVE_API_VERSION !=
  68  * archive_api_version(), then the library you were linked with is
  69  * using an incompatible API to the one you were compiled with.  This
  70  * is almost certainly a fatal problem.
  71  */
  72 #define ARCHIVE_API_VERSION     @ARCHIVE_API_MAJOR@
  73 int             archive_api_version(void);
  74
  75 /*
  76  * Minor version number: ARCHIVE_API_FEATURE is incremented with each
  77  * significant feature addition, so you can test (at compile or run
  78  * time) if a particular feature is implemented.  It's no big deal if
  79  * ARCHIVE_API_FEATURE != archive_api_feature(), as long as both are
  80  * high enough to include the features you're relying on.  Specific
  81  * values of FEATURE are documented here:
  82  *
  83  *    1 - Version tests are available.
  84  *    2 - archive_{read,write}_close available separately from _finish.
  85  *    3 - open_memory, open_memory2, open_FILE, open_fd available
  86  *    5 - archive_write_disk interface available
  87  *
  88  * Unfortunately, this count resets whenever ARCHIVE_API_VERSION changes,
  89  * making it awkward to use in practice.  For that reason, it is deprecated
  90  * in favor of the more-accurate version stamp below.  It will eventually
  91  * be removed.
  92  */
  93 #define ARCHIVE_API_FEATURE     @ARCHIVE_API_MINOR@
  94 int             archive_api_feature(void);
  95
  96 /*
  97  * The "version stamp" is a single integer that makes it easy to check
  98  * the exact version: for version a.b.c, the version stamp is
  99  * printf("%d%03d%03d",a,b,c).  For example, version 2.12.108 has
 100  * version stamp 2012108.
 101  *
 102  * This was introduced with libarchive 1.9.0 in the libarchive 1.x family
 103  * and libarchive 2.2.4 in the libarchive 2.x family.  The following
 104  * may be useful if you really want to do feature detection for earlier
 105  * libarchive versions:
 106  *
 107  * #ifndef ARCHIVE_VERSION_STAMP
 108  * #define ARCHIVE_VERSION_STAMP        \
 109  *             (ARCHIVE_API_VERSION * 1000000 + ARCHIVE_API_FEATURE * 1000)
 110  * #endif
 111  */
 112 #define ARCHIVE_VERSION_STAMP   @ARCHIVE_VERSION_STAMP@
 113 int             archive_version_stamp(void);
 114
 115
 116 #define ARCHIVE_BYTES_PER_RECORD          512
 117 #define ARCHIVE_DEFAULT_BYTES_PER_BLOCK 10240
 118
 119 /* Declare our basic types. */
 120 struct archive;
 121 struct archive_entry;
 122
 123 /*
 124  * Error codes: Use archive_errno() and archive_error_string()
 125  * to retrieve details.  Unless specified otherwise, all functions
 126  * that return 'int' use these codes.
 127  */
 128 #define ARCHIVE_EOF       1     /* Found end of archive. */
 129 #define ARCHIVE_OK        0     /* Operation was successful. */
 130 #define ARCHIVE_RETRY   (-10)   /* Retry might succeed. */
 131 #define ARCHIVE_WARN    (-20)   /* Partial success. */
 132 /* For example, if write_header "fails", then you can't push data. */
 133 #define ARCHIVE_FAILED  (-25)   /* Current operation cannot complete. */
 134 #define ARCHIVE_FATAL   (-30)   /* No more operations are possible. */
 135
 136 /*
 137  * As far as possible, archive_errno returns standard platform errno codes.
 138  * Of course, the details vary by platform, so the actual definitions
 139  * here are stored in "archive_platform.h".  The symbols are listed here
 140  * for reference; as a rule, clients should not need to know the exact
 141  * platform-dependent error code.
 142  */
 143 /* Unrecognized or invalid file format. */
 144 /* #define      ARCHIVE_ERRNO_FILE_FORMAT */
 145 /* Illegal usage of the library. */
 146 /* #define      ARCHIVE_ERRNO_PROGRAMMER_ERROR */
 147 /* Unknown or unclassified error. */
 148 /* #define      ARCHIVE_ERRNO_MISC */
 149
 150 /*
 151  * Callbacks are invoked to automatically read/skip/write/open/close the
 152  * archive. You can provide your own for complex tasks (like breaking
 153  * archives across multiple tapes) or use standard ones built into the
 154  * library.
 155  */
 156
 157 /* Returns pointer and size of next block of data from archive. */
 158 typedef ssize_t archive_read_callback(struct archive *, void *_client_data,
 159                     const void **_buffer);
 160 /* Skips at most request bytes from archive and returns the skipped amount */
 161 #if ARCHIVE_API_VERSION < 2
 162 typedef ssize_t archive_skip_callback(struct archive *, void *_client_data,
 163                     size_t request);
 164 #else
 165 typedef off_t   archive_skip_callback(struct archive *, void *_client_data,
 166                     off_t request);
 167 #endif
 168 /* Returns size actually written, zero on EOF, -1 on error. */
 169 typedef ssize_t archive_write_callback(struct archive *, void *_client_data,
 170                     const void *_buffer, size_t _length);
 171 typedef int     archive_open_callback(struct archive *, void *_client_data);
 172 typedef int     archive_close_callback(struct archive *, void *_client_data);
 173
 174 /*
 175  * Codes for archive_compression.
 176  */
 177 #define ARCHIVE_COMPRESSION_NONE        0
 178 #define ARCHIVE_COMPRESSION_GZIP        1
 179 #define ARCHIVE_COMPRESSION_BZIP2       2
 180 #define ARCHIVE_COMPRESSION_COMPRESS    3
 181 #define ARCHIVE_COMPRESSION_PROGRAM     4
 182
 183 /*
 184  * Codes returned by archive_format.
 185  *
 186  * Top 16 bits identifies the format family (e.g., "tar"); lower
 187  * 16 bits indicate the variant.  This is updated by read_next_header.
 188  * Note that the lower 16 bits will often vary from entry to entry.
 189  * In some cases, this variation occurs as libarchive learns more about
 190  * the archive (for example, later entries might utilize extensions that
 191  * weren't necessary earlier in the archive; in this case, libarchive
 192  * will change the format code to indicate the extended format that
 193  * was used).  In other cases, it's because different tools have
 194  * modified the archive and so different parts of the archive
 195  * actually have slightly different formts.  (Both tar and cpio store
 196  * format codes in each entry, so it is quite possible for each
 197  * entry to be in a different format.)
 198  */
 199 #define ARCHIVE_FORMAT_BASE_MASK                0xff0000
 200 #define ARCHIVE_FORMAT_CPIO                     0x10000
 201 #define ARCHIVE_FORMAT_CPIO_POSIX               (ARCHIVE_FORMAT_CPIO | 1)
 202 #define ARCHIVE_FORMAT_CPIO_BIN_LE              (ARCHIVE_FORMAT_CPIO | 2)
 203 #define ARCHIVE_FORMAT_CPIO_BIN_BE              (ARCHIVE_FORMAT_CPIO | 3)
 204 #define ARCHIVE_FORMAT_CPIO_SVR4_NOCRC          (ARCHIVE_FORMAT_CPIO | 4)
 205 #define ARCHIVE_FORMAT_CPIO_SVR4_CRC            (ARCHIVE_FORMAT_CPIO | 5)
 206 #define ARCHIVE_FORMAT_SHAR                     0x20000
 207 #define ARCHIVE_FORMAT_SHAR_BASE                (ARCHIVE_FORMAT_SHAR | 1)
 208 #define ARCHIVE_FORMAT_SHAR_DUMP                (ARCHIVE_FORMAT_SHAR | 2)
 209 #define ARCHIVE_FORMAT_TAR                      0x30000
 210 #define ARCHIVE_FORMAT_TAR_USTAR                (ARCHIVE_FORMAT_TAR | 1)
 211 #define ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE      (ARCHIVE_FORMAT_TAR | 2)
 212 #define ARCHIVE_FORMAT_TAR_PAX_RESTRICTED       (ARCHIVE_FORMAT_TAR | 3)
 213 #define ARCHIVE_FORMAT_TAR_GNUTAR               (ARCHIVE_FORMAT_TAR | 4)
 214 #define ARCHIVE_FORMAT_ISO9660                  0x40000
 215 #define ARCHIVE_FORMAT_ISO9660_ROCKRIDGE        (ARCHIVE_FORMAT_ISO9660 | 1)
 216 #define ARCHIVE_FORMAT_ZIP                      0x50000
 217 #define ARCHIVE_FORMAT_EMPTY                    0x60000
 218 #define ARCHIVE_FORMAT_AR                       0x70000
 219 #define ARCHIVE_FORMAT_AR_GNU                   (ARCHIVE_FORMAT_AR | 1)
 220 #define ARCHIVE_FORMAT_AR_BSD                   (ARCHIVE_FORMAT_AR | 2)
 221 #define ARCHIVE_FORMAT_MTREE                    0x80000
 222 #define ARCHIVE_FORMAT_MTREE_V1                 (ARCHIVE_FORMAT_MTREE | 1)
 223 #define ARCHIVE_FORMAT_MTREE_V2                 (ARCHIVE_FORMAT_MTREE | 2)
 224
 225 /*-
 226  * Basic outline for reading an archive:
 227  *   1) Ask archive_read_new for an archive reader object.
 228  *   2) Update any global properties as appropriate.
 229  *      In particular, you'll certainly want to call appropriate
 230  *      archive_read_support_XXX functions.
 231  *   3) Call archive_read_open_XXX to open the archive
 232  *   4) Repeatedly call archive_read_next_header to get information about
 233  *      successive archive entries.  Call archive_read_data to extract
 234  *      data for entries of interest.
 235  *   5) Call archive_read_finish to end processing.
 236  */
 237 struct archive  *archive_read_new(void);
 238
 239 /*
 240  * The archive_read_support_XXX calls enable auto-detect for this
 241  * archive handle.  They also link in the necessary support code.
 242  * For example, if you don't want bzlib linked in, don't invoke
 243  * support_compression_bzip2().  The "all" functions provide the
 244  * obvious shorthand.
 245  */
 246 int              archive_read_support_compression_all(struct archive *);
 247 int              archive_read_support_compression_bzip2(struct archive *);
 248 int              archive_read_support_compression_compress(struct archive *);
 249 int              archive_read_support_compression_gzip(struct archive *);
 250 int              archive_read_support_compression_none(struct archive *);
 251 int              archive_read_support_compression_program(struct archive *,
 252                      const char *command);
 253
 254 int              archive_read_support_format_all(struct archive *);
 255 int              archive_read_support_format_ar(struct archive *);
 256 int              archive_read_support_format_cpio(struct archive *);
 257 int              archive_read_support_format_empty(struct archive *);
 258 int              archive_read_support_format_gnutar(struct archive *);
 259 int              archive_read_support_format_iso9660(struct archive *);
 260 int              archive_read_support_format_mtree(struct archive *);
 261 int              archive_read_support_format_tar(struct archive *);
 262 int              archive_read_support_format_zip(struct archive *);
 263
 264
 265 /* Open the archive using callbacks for archive I/O. */
 266 int              archive_read_open(struct archive *, void *_client_data,
 267                      archive_open_callback *, archive_read_callback *,
 268                      archive_close_callback *);
 269 int              archive_read_open2(struct archive *, void *_client_data,
 270                      archive_open_callback *, archive_read_callback *,
 271                      archive_skip_callback *, archive_close_callback *);
 272
 273 /*
 274  * A variety of shortcuts that invoke archive_read_open() with
 275  * canned callbacks suitable for common situations.  The ones that
 276  * accept a block size handle tape blocking correctly.
 277  */
 278 /* Use this if you know the filename.  Note: NULL indicates stdin. */
 279 int              archive_read_open_filename(struct archive *,
 280                      const char *_filename, size_t _block_size);
 281 /* archive_read_open_file() is a deprecated synonym for ..._open_filename(). */
 282 int              archive_read_open_file(struct archive *,
 283                      const char *_filename, size_t _block_size);
 284 /* Read an archive that's stored in memory. */
 285 int              archive_read_open_memory(struct archive *,
 286                      void * buff, size_t size);
 287 /* A more involved version that is only used for internal testing. */
 288 int             archive_read_open_memory2(struct archive *a, void *buff,
 289                      size_t size, size_t read_size);
 290 /* Read an archive that's already open, using the file descriptor. */
 291 int              archive_read_open_fd(struct archive *, int _fd,
 292                      size_t _block_size);
 293 /* Read an archive that's already open, using a FILE *. */
 294 /* Note: DO NOT use this with tape drives. */
 295 int              archive_read_open_FILE(struct archive *, FILE *_file);
 296
 297 /* Parses and returns next entry header. */
 298 int              archive_read_next_header(struct archive *,
 299                      struct archive_entry **);
 300
 301 /*
 302  * Retrieve the byte offset in UNCOMPRESSED data where last-read
 303  * header started.
 304  */
 305 int64_t          archive_read_header_position(struct archive *);
 306
 307 /* Read data from the body of an entry.  Similar to read(2). */
 308 ssize_t          archive_read_data(struct archive *, void *, size_t);
 309 /*
 310  * A zero-copy version of archive_read_data that also exposes the file offset
 311  * of each returned block.  Note that the client has no way to specify
 312  * the desired size of the block.  The API does guarantee that offsets will
 313  * be strictly increasing and that returned blocks will not overlap.
 314  */
 315 int              archive_read_data_block(struct archive *a,
 316                     const void **buff, size_t *size, off_t *offset);
 317
 318 /*-
 319  * Some convenience functions that are built on archive_read_data:
 320  *  'skip': skips entire entry
 321  *  'into_buffer': writes data into memory buffer that you provide
 322  *  'into_fd': writes data to specified filedes
 323  */
 324 int              archive_read_data_skip(struct archive *);
 325 int              archive_read_data_into_buffer(struct archive *, void *buffer,
 326                      ssize_t len);
 327 int              archive_read_data_into_fd(struct archive *, int fd);
 328
 329 /*-
 330  * Convenience function to recreate the current entry (whose header
 331  * has just been read) on disk.
 332  *
 333  * This does quite a bit more than just copy data to disk. It also:
 334  *  - Creates intermediate directories as required.
 335  *  - Manages directory permissions:  non-writable directories will
 336  *    be initially created with write permission enabled; when the
 337  *    archive is closed, dir permissions are edited to the values specified
 338  *    in the archive.
 339  *  - Checks hardlinks:  hardlinks will not be extracted unless the
 340  *    linked-to file was also extracted within the same session. (TODO)
 341  */
 342
 343 /* The "flags" argument selects optional behavior, 'OR' the flags you want. */
 344
 345 /* Default: Do not try to set owner/group. */
 346 #define ARCHIVE_EXTRACT_OWNER   (1)
 347 /* Default: Do obey umask, do not restore SUID/SGID/SVTX bits. */
 348 #define ARCHIVE_EXTRACT_PERM    (2)
 349 /* Default: Do not restore mtime/atime. */
 350 #define ARCHIVE_EXTRACT_TIME    (4)
 351 /* Default: Replace existing files. */
 352 #define ARCHIVE_EXTRACT_NO_OVERWRITE (8)
 353 /* Default: Try create first, unlink only if create fails with EEXIST. */
 354 #define ARCHIVE_EXTRACT_UNLINK  (16)
 355 /* Default: Do not restore ACLs. */
 356 #define ARCHIVE_EXTRACT_ACL     (32)
 357 /* Default: Do not restore fflags. */
 358 #define ARCHIVE_EXTRACT_FFLAGS  (64)
 359 /* Default: Do not restore xattrs. */
 360 #define ARCHIVE_EXTRACT_XATTR   (128)
 361 /* Default: Do not try to guard against extracts redirected by symlinks. */
 362 /* Note: With ARCHIVE_EXTRACT_UNLINK, will remove any intermediate symlink. */
 363 #define ARCHIVE_EXTRACT_SECURE_SYMLINKS (256)
 364 /* Default: Do not reject entries with '..' as path elements. */
 365 #define ARCHIVE_EXTRACT_SECURE_NODOTDOT (512)
 366 /* Default: Create parent directories as needed. */
 367 #define ARCHIVE_EXTRACT_NO_AUTODIR (1024)
 368 /* Default: Overwrite files, even if one on disk is newer. */
 369 #define ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER (2048)
 370
 371 int              archive_read_extract(struct archive *, struct archive_entry *,
 372                      int flags);
 373 void             archive_read_extract_set_progress_callback(struct archive *,
 374                      void (*_progress_func)(void *), void *_user_data);
 375
 376 /* Record the dev/ino of a file that will not be written.  This is
 377  * generally set to the dev/ino of the archive being read. */
 378 void            archive_read_extract_set_skip_file(struct archive *,
 379                      dev_t, ino_t);
 380
 381 /* Close the file and release most resources. */
 382 int              archive_read_close(struct archive *);
 383 /* Release all resources and destroy the object. */
 384 /* Note that archive_read_finish will call archive_read_close for you. */
 385 #if ARCHIVE_API_VERSION > 1
 386 int              archive_read_finish(struct archive *);
 387 #else
 388 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
 389 /* Erroneously declared to return void in libarchive 1.x */
 390 void             archive_read_finish(struct archive *);
 391 #endif
 392
 393 /*-
 394  * To create an archive:
 395  *   1) Ask archive_write_new for a archive writer object.
 396  *   2) Set any global properties.  In particular, you should set
 397  *      the compression and format to use.
 398  *   3) Call archive_write_open to open the file (most people
 399  *       will use archive_write_open_file or archive_write_open_fd,
 400  *       which provide convenient canned I/O callbacks for you).
 401  *   4) For each entry:
 402  *      - construct an appropriate struct archive_entry structure
 403  *      - archive_write_header to write the header
 404  *      - archive_write_data to write the entry data
 405  *   5) archive_write_close to close the output
 406  *   6) archive_write_finish to cleanup the writer and release resources
 407  */
 408 struct archive  *archive_write_new(void);
 409 int              archive_write_set_bytes_per_block(struct archive *,
 410                      int bytes_per_block);
 411 int              archive_write_get_bytes_per_block(struct archive *);
 412 /* XXX This is badly misnamed; suggestions appreciated. XXX */
 413 int              archive_write_set_bytes_in_last_block(struct archive *,
 414                      int bytes_in_last_block);
 415 int              archive_write_get_bytes_in_last_block(struct archive *);
 416
 417 /* The dev/ino of a file that won't be archived.  This is used
 418  * to avoid recursively adding an archive to itself. */
 419 int              archive_write_set_skip_file(struct archive *, dev_t, ino_t);
 420
 421 int              archive_write_set_compression_bzip2(struct archive *);
 422 int              archive_write_set_compression_gzip(struct archive *);
 423 int              archive_write_set_compression_none(struct archive *);
 424 int              archive_write_set_compression_program(struct archive *,
 425                      const char *cmd);
 426 /* A convenience function to set the format based on the code or name. */
 427 int              archive_write_set_format(struct archive *, int format_code);
 428 int              archive_write_set_format_by_name(struct archive *,
 429                      const char *name);
 430 /* To minimize link pollution, use one or more of the following. */
 431 int              archive_write_set_format_ar_bsd(struct archive *);
 432 int              archive_write_set_format_ar_svr4(struct archive *);
 433 int              archive_write_set_format_cpio(struct archive *);
 434 int              archive_write_set_format_cpio_newc(struct archive *);
 435 /* TODO: int archive_write_set_format_old_tar(struct archive *); */
 436 int              archive_write_set_format_pax(struct archive *);
 437 int              archive_write_set_format_pax_restricted(struct archive *);
 438 int              archive_write_set_format_shar(struct archive *);
 439 int              archive_write_set_format_shar_dump(struct archive *);
 440 int              archive_write_set_format_ustar(struct archive *);
 441 int              archive_write_open(struct archive *, void *,
 442                      archive_open_callback *, archive_write_callback *,
 443                      archive_close_callback *);
 444 int              archive_write_open_fd(struct archive *, int _fd);
 445 int              archive_write_open_filename(struct archive *, const char *_file);
 446 /* A deprecated synonym for archive_write_open_filename() */
 447 int              archive_write_open_file(struct archive *, const char *_file);
 448 int              archive_write_open_FILE(struct archive *, FILE *);
 449 /* _buffSize is the size of the buffer, _used refers to a variable that
 450  * will be updated after each write into the buffer. */
 451 int              archive_write_open_memory(struct archive *,
 452                         void *_buffer, size_t _buffSize, size_t *_used);
 453
 454 /*
 455  * Note that the library will truncate writes beyond the size provided
 456  * to archive_write_header or pad if the provided data is short.
 457  */
 458 int              archive_write_header(struct archive *,
 459                      struct archive_entry *);
 460 #if ARCHIVE_API_VERSION > 1
 461 ssize_t          archive_write_data(struct archive *, const void *, size_t);
 462 #else
 463 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
 464 /* This was erroneously declared to return "int" in libarchive 1.x. */
 465 int              archive_write_data(struct archive *, const void *, size_t);
 466 #endif
 467 ssize_t          archive_write_data_block(struct archive *, const void *, size_t, off_t);
 468 int              archive_write_finish_entry(struct archive *);
 469 int              archive_write_close(struct archive *);
 470 #if ARCHIVE_API_VERSION > 1
 471 int              archive_write_finish(struct archive *);
 472 #else
 473 /* Temporarily allow library to compile with either 1.x or 2.0 API. */
 474 /* Return value was incorrect in libarchive 1.x. */
 475 void             archive_write_finish(struct archive *);
 476 #endif
 477
 478 /*-
 479  * To create objects on disk:
 480  *   1) Ask archive_write_disk_new for a new archive_write_disk object.
 481  *   2) Set any global properties.  In particular, you should set
 482  *      the compression and format to use.
 483  *   3) For each entry:
 484  *      - construct an appropriate struct archive_entry structure
 485  *      - archive_write_header to create the file/dir/etc on disk
 486  *      - archive_write_data to write the entry data
 487  *   4) archive_write_finish to cleanup the writer and release resources
 488  *
 489  * In particular, you can use this in conjunction with archive_read()
 490  * to pull entries out of an archive and create them on disk.
 491  */
 492 struct archive  *archive_write_disk_new(void);
 493 /* This file will not be overwritten. */
 494 int              archive_write_disk_set_skip_file(struct archive *,
 495                      dev_t, ino_t);
 496 /* Set flags to control how the next item gets created. */
 497 int              archive_write_disk_set_options(struct archive *,
 498                      int flags);
 499 /*
 500  * The lookup functions are given uname/uid (or gname/gid) pairs and
 501  * return a uid (gid) suitable for this system.  These are used for
 502  * restoring ownership and for setting ACLs.  The default functions
 503  * are naive, they just return the uid/gid.  These are small, so reasonable
 504  * for applications that don't need to preserve ownership; they
 505  * are probably also appropriate for applications that are doing
 506  * same-system backup and restore.
 507  */
 508 /*
 509  * The "standard" lookup functions use common system calls to lookup
 510  * the uname/gname, falling back to the uid/gid if the names can't be
 511  * found.  They cache lookups and are reasonably fast, but can be very
 512  * large, so they are not used unless you ask for them.  In
 513  * particular, these match the specifications of POSIX "pax" and old
 514  * POSIX "tar".
 515  */
 516 int              archive_write_disk_set_standard_lookup(struct archive *);
 517 /*
 518  * If neither the default (naive) nor the standard (big) functions suit
 519  * your needs, you can write your own and register them.  Be sure to
 520  * include a cleanup function if you have allocated private data.
 521  */
 522 int              archive_write_disk_set_group_lookup(struct archive *,
 523                      void *private_data,
 524                      gid_t (*loookup)(void *, const char *gname, gid_t gid),
 525                      void (*cleanup)(void *));
 526 int              archive_write_disk_set_user_lookup(struct archive *,
 527                      void *private_data,
 528                      uid_t (*)(void *, const char *uname, uid_t uid),
 529                      void (*cleanup)(void *));
 530
 531 /*
 532  * Accessor functions to read/set various information in
 533  * the struct archive object:
 534  */
 535 /* Bytes written after compression or read before decompression. */
 536 int64_t          archive_position_compressed(struct archive *);
 537 /* Bytes written to compressor or read from decompressor. */
 538 int64_t          archive_position_uncompressed(struct archive *);
 539
 540 const char      *archive_compression_name(struct archive *);
 541 int              archive_compression(struct archive *);
 542 int              archive_errno(struct archive *);
 543 const char      *archive_error_string(struct archive *);
 544 const char      *archive_format_name(struct archive *);
 545 int              archive_format(struct archive *);
 546 void             archive_clear_error(struct archive *);
 547 void             archive_set_error(struct archive *, int _err, const char *fmt, ...);
 548 void             archive_copy_error(struct archive *dest, struct archive *src);
 549
 550 #ifdef __cplusplus
 551 }
 552 #endif
 553
 554 #endif /* !ARCHIVE_H_INCLUDED */