contrib/libarchive/libarchive/archive_write_private.h

   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$
  26  */
  27
  28 #ifndef __LIBARCHIVE_BUILD
  29 #ifndef __LIBARCHIVE_TEST
  30 #error This header is only to be used internally to libarchive.
  31 #endif
  32 #endif
  33
  34 #ifndef ARCHIVE_WRITE_PRIVATE_H_INCLUDED
  35 #define ARCHIVE_WRITE_PRIVATE_H_INCLUDED
  36
  37 #include "archive.h"
  38 #include "archive_string.h"
  39 #include "archive_private.h"
  40
  41 struct archive_write;
  42
  43 struct archive_write_filter {
  44         int64_t bytes_written;
  45         struct archive *archive; /* Associated archive. */
  46         struct archive_write_filter *next_filter; /* Who I write to. */
  47         int     (*options)(struct archive_write_filter *,
  48             const char *key, const char *value);
  49         int     (*open)(struct archive_write_filter *);
  50         int     (*write)(struct archive_write_filter *, const void *, size_t);
  51         int     (*close)(struct archive_write_filter *);
  52         int     (*free)(struct archive_write_filter *);
  53         void     *data;
  54         const char *name;
  55         int       code;
  56         int       bytes_per_block;
  57         int       bytes_in_last_block;
  58 };
  59
  60 #if ARCHIVE_VERSION < 4000000
  61 void __archive_write_filters_free(struct archive *);
  62 #endif
  63
  64 struct archive_write_filter *__archive_write_allocate_filter(struct archive *);
  65
  66 int __archive_write_output(struct archive_write *, const void *, size_t);
  67 int __archive_write_nulls(struct archive_write *, size_t);
  68 int __archive_write_filter(struct archive_write_filter *, const void *, size_t);
  69 int __archive_write_open_filter(struct archive_write_filter *);
  70 int __archive_write_close_filter(struct archive_write_filter *);
  71
  72 struct archive_write {
  73         struct archive  archive;
  74
  75         /* Dev/ino of the archive being written. */
  76         int               skip_file_set;
  77         int64_t           skip_file_dev;
  78         int64_t           skip_file_ino;
  79
  80         /* Utility:  Pointer to a block of nulls. */
  81         const unsigned char     *nulls;
  82         size_t                   null_length;
  83
  84         /* Callbacks to open/read/write/close archive stream. */
  85         archive_open_callback   *client_opener;
  86         archive_write_callback  *client_writer;
  87         archive_close_callback  *client_closer;
  88         void                    *client_data;
  89
  90         /*
  91          * Blocking information.  Note that bytes_in_last_block is
  92          * misleadingly named; I should find a better name.  These
  93          * control the final output from all compressors, including
  94          * compression_none.
  95          */
  96         int               bytes_per_block;
  97         int               bytes_in_last_block;
  98
  99         /*
 100          * First and last write filters in the pipeline.
 101          */
 102         struct archive_write_filter *filter_first;
 103         struct archive_write_filter *filter_last;
 104
 105         /*
 106          * Pointers to format-specific functions for writing.  They're
 107          * initialized by archive_write_set_format_XXX() calls.
 108          */
 109         void     *format_data;
 110         const char *format_name;
 111         int     (*format_init)(struct archive_write *);
 112         int     (*format_options)(struct archive_write *,
 113                     const char *key, const char *value);
 114         int     (*format_finish_entry)(struct archive_write *);
 115         int     (*format_write_header)(struct archive_write *,
 116                     struct archive_entry *);
 117         ssize_t (*format_write_data)(struct archive_write *,
 118                     const void *buff, size_t);
 119         int     (*format_close)(struct archive_write *);
 120         int     (*format_free)(struct archive_write *);
 121
 122
 123         /*
 124          * Encryption passphrase.
 125          */
 126         char            *passphrase;
 127         archive_passphrase_callback *passphrase_callback;
 128         void            *passphrase_client_data;
 129 };
 130
 131 /*
 132  * Utility function to format a USTAR header into a buffer.  If
 133  * "strict" is set, this tries to create the absolutely most portable
 134  * version of a ustar header.  If "strict" is set to 0, then it will
 135  * relax certain requirements.
 136  *
 137  * Generally, format-specific declarations don't belong in this
 138  * header; this is a rare example of a function that is shared by
 139  * two very similar formats (ustar and pax).
 140  */
 141 int
 142 __archive_write_format_header_ustar(struct archive_write *, char buff[512],
 143     struct archive_entry *, int tartype, int strict,
 144     struct archive_string_conv *);
 145
 146 struct archive_write_program_data;
 147 struct archive_write_program_data * __archive_write_program_allocate(const char *program_name);
 148 int     __archive_write_program_free(struct archive_write_program_data *);
 149 int     __archive_write_program_open(struct archive_write_filter *,
 150             struct archive_write_program_data *, const char *);
 151 int     __archive_write_program_close(struct archive_write_filter *,
 152             struct archive_write_program_data *);
 153 int     __archive_write_program_write(struct archive_write_filter *,
 154             struct archive_write_program_data *, const void *, size_t);
 155
 156 /*
 157  * Get a encryption passphrase.
 158  */
 159 const char * __archive_write_get_passphrase(struct archive_write *a);
 160 #endif