193a52cc6746a552f7d5750f3b66a31657f16c5b
[dragonfly.git] / contrib / libarchive-2 / 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: src/lib/libarchive/archive_platform.h,v 1.27 2007/05/29 01:00:18 kientzle Exp $
26  */
27
28 /*
29  * This header is the first thing included in any of the libarchive
30  * source files.  As far as possible, platform-specific issues should
31  * be dealt with here and not within individual source files.  I'm
32  * actively trying to minimize #if blocks within the main source,
33  * since they obfuscate the code.
34  */
35
36 #ifndef ARCHIVE_PLATFORM_H_INCLUDED
37 #define ARCHIVE_PLATFORM_H_INCLUDED
38
39 #if defined(PLATFORM_CONFIG_H)
40 /* Use hand-built config.h in environments that need it. */
41 #include PLATFORM_CONFIG_H
42 #elif defined(HAVE_CONFIG_H)
43 /* Most POSIX platforms use the 'configure' script to build config.h */
44 #include "../config.h"
45 #else
46 /* Warn if the library hasn't been (automatically or manually) configured. */
47 #error Oops: No config.h and no pre-built configuration in archive_platform.h.
48 #endif
49
50 /*
51  * The config files define a lot of feature macros.  The following
52  * uses those macros to select/define replacements and include key
53  * headers as required.
54  */
55
56 /* No non-FreeBSD platform will have __FBSDID, so just define it here. */
57 #ifdef __FreeBSD__
58 #include <sys/cdefs.h>  /* For __FBSDID */
59 #else
60 /* Just leaving this macro replacement empty leads to a dangling semicolon. */
61 #define __FBSDID(a)     struct _undefined_hack
62 #endif
63
64 /* Try to get standard C99-style integer type definitions. */
65 #if HAVE_INTTYPES_H
66 #include <inttypes.h>
67 #elif HAVE_STDINT_H
68 #include <stdint.h>
69 #endif
70
71 /* Some platforms lack the standard *_MAX definitions. */
72 #if !HAVE_DECL_SIZE_MAX
73 #define SIZE_MAX (~(size_t)0)
74 #endif
75 #if !HAVE_DECL_UINT32_MAX
76 #define UINT32_MAX (~(uint32_t)0)
77 #endif
78 #if !HAVE_DECL_UINT64_MAX
79 #define UINT64_MAX (~(uint64_t)0)
80 #endif
81 #if !HAVE_DECL_INT64_MAX
82 #define INT64_MAX ((int64_t)(UINT64_MAX >> 1))
83 #endif
84 #if !HAVE_DECL_INT64_MIN
85 #define INT64_MIN ((int64_t)(~INT64_MAX))
86 #endif
87
88 /*
89  * If this platform has <sys/acl.h>, acl_create(), acl_init(),
90  * acl_set_file(), and ACL_USER, we assume it has the rest of the
91  * POSIX.1e draft functions used in archive_read_extract.c.
92  */
93 #if HAVE_SYS_ACL_H && HAVE_ACL_CREATE_ENTRY && HAVE_ACL_INIT && HAVE_ACL_SET_FILE && HAVE_ACL_USER
94 #define HAVE_POSIX_ACL  1
95 #endif
96
97 /*
98  * If we can't restore metadata using a file descriptor, then
99  * for compatibility's sake, close files before trying to restore metadata.
100  */
101 #if defined(HAVE_FCHMOD) || defined(HAVE_FUTIMES) || defined(HAVE_ACL_SET_FD) || defined(HAVE_ACL_SET_FD_NP) || defined(HAVE_FCHOWN)
102 #define CAN_RESTORE_METADATA_FD
103 #endif
104
105 /* Set up defaults for internal error codes. */
106 #ifndef ARCHIVE_ERRNO_FILE_FORMAT
107 #if HAVE_EFTYPE
108 #define ARCHIVE_ERRNO_FILE_FORMAT EFTYPE
109 #else
110 #if HAVE_EILSEQ
111 #define ARCHIVE_ERRNO_FILE_FORMAT EILSEQ
112 #else
113 #define ARCHIVE_ERRNO_FILE_FORMAT EINVAL
114 #endif
115 #endif
116 #endif
117
118 #ifndef ARCHIVE_ERRNO_PROGRAMMER
119 #define ARCHIVE_ERRNO_PROGRAMMER EINVAL
120 #endif
121
122 #ifndef ARCHIVE_ERRNO_MISC
123 #define ARCHIVE_ERRNO_MISC (-1)
124 #endif
125
126 #endif /* !ARCHIVE_PLATFORM_H_INCLUDED */