Import libarchive-2.8.4.
[dragonfly.git] / contrib / libarchive / libarchive / archive_platform.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_platform.h 201090 2009-12-28 02:22:04Z kientzle $
26  */
27
28 /* !!ONLY FOR USE INTERNALLY TO LIBARCHIVE!! */
29
30 /*
31  * This header is the first thing included in any of the libarchive
32  * source files.  As far as possible, platform-specific issues should
33  * be dealt with here and not within individual source files.  I'm
34  * actively trying to minimize #if blocks within the main source,
35  * since they obfuscate the code.
36  */
37
38 #ifndef ARCHIVE_PLATFORM_H_INCLUDED
39 #define ARCHIVE_PLATFORM_H_INCLUDED
40
41 /* archive.h and archive_entry.h require this. */
42 #define __LIBARCHIVE_BUILD 1
43
44 #if defined(PLATFORM_CONFIG_H)
45 /* Use hand-built config.h in environments that need it. */
46 #include PLATFORM_CONFIG_H
47 #elif defined(HAVE_CONFIG_H)
48 /* Most POSIX platforms use the 'configure' script to build config.h */
49 #include "config.h"
50 #else
51 /* Warn if the library hasn't been (automatically or manually) configured. */
52 #error Oops: No config.h and no pre-built configuration in archive_platform.h.
53 #endif
54
55 /* It should be possible to get rid of this by extending the feature-test
56  * macros to cover Windows API functions, probably along with non-trivial
57  * refactoring of code to find structures that sit more cleanly on top of
58  * either Windows or Posix APIs. */
59 #if (defined(__WIN32__) || defined(_WIN32) || defined(__WIN32)) && !defined(__CYGWIN__)
60 #include "archive_windows.h"
61 #endif
62
63 /*
64  * The config files define a lot of feature macros.  The following
65  * uses those macros to select/define replacements and include key
66  * headers as required.
67  */
68
69 /* Get a real definition for __FBSDID if we can */
70 #if HAVE_SYS_CDEFS_H
71 #include <sys/cdefs.h>
72 #endif
73
74 /* If not, define it so as to avoid dangling semicolons. */
75 #ifndef __FBSDID
76 #define __FBSDID(a)     struct _undefined_hack
77 #endif
78
79 /* Try to get standard C99-style integer type definitions. */
80 #if HAVE_INTTYPES_H
81 #include <inttypes.h>
82 #endif
83 #if HAVE_STDINT_H
84 #include <stdint.h>
85 #endif
86
87 /* Borland warns about its own constants!  */
88 #if defined(__BORLANDC__)
89 # if HAVE_DECL_UINT64_MAX
90 #  undef        UINT64_MAX
91 #  undef        HAVE_DECL_UINT64_MAX
92 # endif
93 # if HAVE_DECL_UINT64_MIN
94 #  undef        UINT64_MIN
95 #  undef        HAVE_DECL_UINT64_MIN
96 # endif
97 # if HAVE_DECL_INT64_MAX
98 #  undef        INT64_MAX
99 #  undef        HAVE_DECL_INT64_MAX
100 # endif
101 # if HAVE_DECL_INT64_MIN
102 #  undef        INT64_MIN
103 #  undef        HAVE_DECL_INT64_MIN
104 # endif
105 #endif
106
107 /* Some platforms lack the standard *_MAX definitions. */
108 #if !HAVE_DECL_SIZE_MAX
109 #define SIZE_MAX (~(size_t)0)
110 #endif
111 #if !HAVE_DECL_SSIZE_MAX
112 #define SSIZE_MAX ((ssize_t)(SIZE_MAX >> 1))
113 #endif
114 #if !HAVE_DECL_UINT32_MAX
115 #define UINT32_MAX (~(uint32_t)0)
116 #endif
117 #if !HAVE_DECL_UINT64_MAX
118 #define UINT64_MAX (~(uint64_t)0)
119 #endif
120 #if !HAVE_DECL_INT64_MAX
121 #define INT64_MAX ((int64_t)(UINT64_MAX >> 1))
122 #endif
123 #if !HAVE_DECL_INT64_MIN
124 #define INT64_MIN ((int64_t)(~INT64_MAX))
125 #endif
126
127 /*
128  * If this platform has <sys/acl.h>, acl_create(), acl_init(),
129  * acl_set_file(), and ACL_USER, we assume it has the rest of the
130  * POSIX.1e draft functions used in archive_read_extract.c.
131  */
132 #if HAVE_SYS_ACL_H && HAVE_ACL_CREATE_ENTRY && HAVE_ACL_INIT && HAVE_ACL_SET_FILE && HAVE_ACL_USER
133 #define HAVE_POSIX_ACL  1
134 #endif
135
136 /*
137  * If we can't restore metadata using a file descriptor, then
138  * for compatibility's sake, close files before trying to restore metadata.
139  */
140 #if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
141 #define CAN_RESTORE_METADATA_FD
142 #endif
143
144 /* Set up defaults for internal error codes. */
145 #ifndef ARCHIVE_ERRNO_FILE_FORMAT
146 #if HAVE_EFTYPE
147 #define ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
148 #else
149 #if HAVE_EILSEQ
150 #define ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
151 #else
152 #define ARCHIVE_ERRNO_FILE_FORMAT EINVAL
153 #endif
154 #endif
155 #endif
156
157 #ifndef ARCHIVE_ERRNO_PROGRAMMER
158 #define ARCHIVE_ERRNO_PROGRAMMER EINVAL
159 #endif
160
161 #ifndef ARCHIVE_ERRNO_MISC
162 #define ARCHIVE_ERRNO_MISC (-1)
163 #endif
164
165 #endif /* !ARCHIVE_PLATFORM_H_INCLUDED */