contrib/libarchive/libarchive/archive_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: head/lib/libarchive/archive_private.h 201098 2009-12-28 02:58:14Z kientzle $
  26  */
  27
  28 #ifndef __LIBARCHIVE_BUILD
  29 #error This header is only to be used internally to libarchive.
  30 #endif
  31
  32 #ifndef ARCHIVE_PRIVATE_H_INCLUDED
  33 #define ARCHIVE_PRIVATE_H_INCLUDED
  34
  35 #if HAVE_ICONV_H
  36 #include <iconv.h>
  37 #endif
  38
  39 #include "archive.h"
  40 #include "archive_string.h"
  41
  42 #if defined(__GNUC__) && (__GNUC__ > 2 || \
  43                           (__GNUC__ == 2 && __GNUC_MINOR__ >= 5))
  44 #define __LA_DEAD       __attribute__((__noreturn__))
  45 #else
  46 #define __LA_DEAD
  47 #endif
  48
  49 #define ARCHIVE_WRITE_MAGIC     (0xb0c5c0deU)
  50 #define ARCHIVE_READ_MAGIC      (0xdeb0c5U)
  51 #define ARCHIVE_WRITE_DISK_MAGIC (0xc001b0c5U)
  52 #define ARCHIVE_READ_DISK_MAGIC (0xbadb0c5U)
  53
  54 #define ARCHIVE_STATE_NEW       1U
  55 #define ARCHIVE_STATE_HEADER    2U
  56 #define ARCHIVE_STATE_DATA      4U
  57 #define ARCHIVE_STATE_EOF       0x10U
  58 #define ARCHIVE_STATE_CLOSED    0x20U
  59 #define ARCHIVE_STATE_FATAL     0x8000U
  60 #define ARCHIVE_STATE_ANY       (0xFFFFU & ~ARCHIVE_STATE_FATAL)
  61
  62 struct archive_vtable {
  63         int     (*archive_close)(struct archive *);
  64         int     (*archive_free)(struct archive *);
  65         int     (*archive_write_header)(struct archive *,
  66             struct archive_entry *);
  67         int     (*archive_write_finish_entry)(struct archive *);
  68         ssize_t (*archive_write_data)(struct archive *,
  69             const void *, size_t);
  70         ssize_t (*archive_write_data_block)(struct archive *,
  71             const void *, size_t, int64_t);
  72
  73         int     (*archive_read_next_header)(struct archive *,
  74             struct archive_entry **);
  75         int     (*archive_read_next_header2)(struct archive *,
  76             struct archive_entry *);
  77         int     (*archive_read_data_block)(struct archive *,
  78             const void **, size_t *, int64_t *);
  79
  80         int     (*archive_filter_count)(struct archive *);
  81         int64_t (*archive_filter_bytes)(struct archive *, int);
  82         int     (*archive_filter_code)(struct archive *, int);
  83         const char * (*archive_filter_name)(struct archive *, int);
  84 };
  85
  86 struct archive_string_conv;
  87
  88 struct archive {
  89         /*
  90          * The magic/state values are used to sanity-check the
  91          * client's usage.  If an API function is called at a
  92          * ridiculous time, or the client passes us an invalid
  93          * pointer, these values allow me to catch that.
  94          */
  95         unsigned int    magic;
  96         unsigned int    state;
  97
  98         /*
  99          * Some public API functions depend on the "real" type of the
 100          * archive object.
 101          */
 102         struct archive_vtable *vtable;
 103
 104         int               archive_format;
 105         const char       *archive_format_name;
 106
 107         int       compression_code;     /* Currently active compression. */
 108         const char *compression_name;
 109
 110         /* Number of file entries processed. */
 111         int               file_count;
 112
 113         int               archive_error_number;
 114         const char       *error;
 115         struct archive_string   error_string;
 116
 117         char *current_code;
 118         unsigned current_codepage; /* Current ACP(ANSI CodePage). */
 119         unsigned current_oemcp; /* Current OEMCP(OEM CodePage). */
 120         struct archive_string_conv *sconv;
 121 };
 122
 123 /* Check magic value and state; return(ARCHIVE_FATAL) if it isn't valid. */
 124 int     __archive_check_magic(struct archive *, unsigned int magic,
 125             unsigned int state, const char *func);
 126 #define archive_check_magic(a, expected_magic, allowed_states, function_name) \
 127         do { \
 128                 int magic_test = __archive_check_magic((a), (expected_magic), \
 129                         (allowed_states), (function_name)); \
 130                 if (magic_test == ARCHIVE_FATAL) \
 131                         return ARCHIVE_FATAL; \
 132         } while (0)
 133
 134 void    __archive_errx(int retvalue, const char *msg) __LA_DEAD;
 135
 136 int     __archive_mktemp(const char *tmpdir);
 137
 138 int     __archive_clean(struct archive *);
 139
 140 #define err_combine(a,b)        ((a) < (b) ? (a) : (b))
 141
 142 #if defined(__BORLANDC__) || (defined(_MSC_VER) &&  _MSC_VER <= 1300)
 143 # define        ARCHIVE_LITERAL_LL(x)   x##i64
 144 # define        ARCHIVE_LITERAL_ULL(x)  x##ui64
 145 #else
 146 # define        ARCHIVE_LITERAL_LL(x)   x##ll
 147 # define        ARCHIVE_LITERAL_ULL(x)  x##ull
 148 #endif
 149
 150 #endif