Merge branch 'master' of git://repo.or.cz/alt-git
[git/mingw/4msysgit/wingit-dll.git] / git-compat-util.h
blobcf89cdf4598b3796724a85aa707f740245155cdc
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
6 #ifndef FLEX_ARRAY
7 /*
8 * See if our compiler is known to support flexible array members.
9 */
10 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
11 # define FLEX_ARRAY /* empty */
12 #elif defined(__GNUC__)
13 # if (__GNUC__ >= 3)
14 # define FLEX_ARRAY /* empty */
15 # else
16 # define FLEX_ARRAY 0 /* older GNU extension */
17 # endif
18 #endif
21 * Otherwise, default to safer but a bit wasteful traditional style
23 #ifndef FLEX_ARRAY
24 # define FLEX_ARRAY 1
25 #endif
26 #endif
28 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
30 #ifdef __GNUC__
31 #define TYPEOF(x) (__typeof__(x))
32 #else
33 #define TYPEOF(x)
34 #endif
36 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
37 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
39 /* Approximation of the length of the decimal representation of this type. */
40 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
42 #if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
43 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
45 #endif
46 #define _ALL_SOURCE 1
47 #define _GNU_SOURCE 1
48 #define _BSD_SOURCE 1
50 #include <unistd.h>
51 #include <stdio.h>
52 #include <sys/stat.h>
53 #include <fcntl.h>
54 #include <stddef.h>
55 #include <stdlib.h>
56 #include <stdarg.h>
57 #include <string.h>
58 #include <errno.h>
59 #include <limits.h>
60 #include <sys/param.h>
61 #include <sys/types.h>
62 #include <dirent.h>
63 #include <sys/time.h>
64 #include <time.h>
65 #include <signal.h>
66 #include <fnmatch.h>
67 #include <assert.h>
68 #include <regex.h>
69 #include <utime.h>
70 #ifndef __MINGW32__
71 #include <sys/wait.h>
72 #include <sys/poll.h>
73 #include <sys/socket.h>
74 #include <sys/ioctl.h>
75 #ifndef NO_SYS_SELECT_H
76 #include <sys/select.h>
77 #endif
78 #include <netinet/in.h>
79 #include <netinet/tcp.h>
80 #include <arpa/inet.h>
81 #include <netdb.h>
82 #include <pwd.h>
83 #include <inttypes.h>
84 #if defined(__CYGWIN__)
85 #undef _XOPEN_SOURCE
86 #include <grp.h>
87 #define _XOPEN_SOURCE 600
88 #else
89 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
90 #include <grp.h>
91 #define _ALL_SOURCE 1
92 #endif
93 #else /* __MINGW32__ */
94 /* pull in Windows compatibility stuff */
95 #include "compat/mingw.h"
96 #endif /* __MINGW32__ */
98 #ifndef NO_ICONV
99 #include <iconv.h>
100 #endif
102 /* On most systems <limits.h> would have given us this, but
103 * not on some systems (e.g. GNU/Hurd).
105 #ifndef PATH_MAX
106 #define PATH_MAX 4096
107 #endif
109 #ifndef PRIuMAX
110 #define PRIuMAX "llu"
111 #endif
113 #ifndef PRIu32
114 #define PRIu32 "u"
115 #endif
117 #ifndef PRIx32
118 #define PRIx32 "x"
119 #endif
121 #ifndef PATH_SEP
122 #define PATH_SEP ':'
123 #endif
125 #ifndef STRIP_EXTENSION
126 #define STRIP_EXTENSION ""
127 #endif
129 #ifndef has_dos_drive_prefix
130 #define has_dos_drive_prefix(path) 0
131 #endif
133 #ifndef is_dir_sep
134 #define is_dir_sep(c) ((c) == '/')
135 #endif
137 #ifdef __GNUC__
138 #define NORETURN __attribute__((__noreturn__))
139 #else
140 #define NORETURN
141 #ifndef __attribute__
142 #define __attribute__(x)
143 #endif
144 #endif
146 /* General helper functions */
147 extern void usage(const char *err) NORETURN;
148 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
149 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
150 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
152 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
153 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
154 extern void set_error_routine(void (*routine)(const char *err, va_list params));
155 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
157 extern int prefixcmp(const char *str, const char *prefix);
158 extern time_t tm_to_time_t(const struct tm *tm);
160 static inline const char *skip_prefix(const char *str, const char *prefix)
162 size_t len = strlen(prefix);
163 return strncmp(str, prefix, len) ? NULL : str + len;
166 #ifdef NO_MMAP
168 #ifndef PROT_READ
169 #define PROT_READ 1
170 #define PROT_WRITE 2
171 #define MAP_PRIVATE 1
172 #define MAP_FAILED ((void*)-1)
173 #endif
175 #define mmap git_mmap
176 #define munmap git_munmap
177 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
178 extern int git_munmap(void *start, size_t length);
180 /* This value must be multiple of (pagesize * 2) */
181 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
183 #else /* NO_MMAP */
185 #include <sys/mman.h>
187 /* This value must be multiple of (pagesize * 2) */
188 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
189 (sizeof(void*) >= 8 \
190 ? 1 * 1024 * 1024 * 1024 \
191 : 32 * 1024 * 1024)
193 #endif /* NO_MMAP */
195 #define DEFAULT_PACKED_GIT_LIMIT \
196 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
198 #ifdef NO_PREAD
199 #define pread git_pread
200 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
201 #endif
203 * Forward decl that will remind us if its twin in cache.h changes.
204 * This function is used in compat/pread.c. But we can't include
205 * cache.h there.
207 extern ssize_t read_in_full(int fd, void *buf, size_t count);
209 #ifdef NO_SETENV
210 #define setenv gitsetenv
211 extern int gitsetenv(const char *, const char *, int);
212 #endif
214 #ifdef NO_MKDTEMP
215 #define mkdtemp gitmkdtemp
216 extern char *gitmkdtemp(char *);
217 #endif
219 #ifdef NO_UNSETENV
220 #define unsetenv gitunsetenv
221 extern void gitunsetenv(const char *);
222 #endif
224 #ifdef NO_STRCASESTR
225 #define strcasestr gitstrcasestr
226 extern char *gitstrcasestr(const char *haystack, const char *needle);
227 #endif
229 #ifdef NO_STRLCPY
230 #define strlcpy gitstrlcpy
231 extern size_t gitstrlcpy(char *, const char *, size_t);
232 #endif
234 #ifdef NO_STRTOUMAX
235 #define strtoumax gitstrtoumax
236 extern uintmax_t gitstrtoumax(const char *, char **, int);
237 #endif
239 #ifdef NO_HSTRERROR
240 #define hstrerror githstrerror
241 extern const char *githstrerror(int herror);
242 #endif
244 #ifdef NO_MEMMEM
245 #define memmem gitmemmem
246 void *gitmemmem(const void *haystack, size_t haystacklen,
247 const void *needle, size_t needlelen);
248 #endif
250 #ifdef FREAD_READS_DIRECTORIES
251 #ifdef fopen
252 #undef fopen
253 #endif
254 #define fopen(a,b) git_fopen(a,b)
255 extern FILE *git_fopen(const char*, const char*);
256 #endif
258 #ifdef SNPRINTF_RETURNS_BOGUS
259 #define snprintf git_snprintf
260 extern int git_snprintf(char *str, size_t maxsize,
261 const char *format, ...);
262 #define vsnprintf git_vsnprintf
263 extern int git_vsnprintf(char *str, size_t maxsize,
264 const char *format, va_list ap);
265 #endif
267 #ifdef __GLIBC_PREREQ
268 #if __GLIBC_PREREQ(2, 1)
269 #define HAVE_STRCHRNUL
270 #endif
271 #endif
273 #ifndef HAVE_STRCHRNUL
274 #define strchrnul gitstrchrnul
275 static inline char *gitstrchrnul(const char *s, int c)
277 while (*s && *s != c)
278 s++;
279 return (char *)s;
281 #endif
283 extern void release_pack_memory(size_t, int);
285 extern char *xstrdup(const char *str);
286 extern void *xmalloc(size_t size);
287 extern void *xmemdupz(const void *data, size_t len);
288 extern char *xstrndup(const char *str, size_t len);
289 extern void *xrealloc(void *ptr, size_t size);
290 extern void *xcalloc(size_t nmemb, size_t size);
291 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
292 extern ssize_t xread(int fd, void *buf, size_t len);
293 extern ssize_t xwrite(int fd, const void *buf, size_t len);
294 extern int xdup(int fd);
295 extern FILE *xfdopen(int fd, const char *mode);
296 extern int xmkstemp(char *template);
298 static inline size_t xsize_t(off_t len)
300 return (size_t)len;
303 static inline int has_extension(const char *filename, const char *ext)
305 size_t len = strlen(filename);
306 size_t extlen = strlen(ext);
307 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
310 /* Sane ctype - no locale, and works with signed chars */
311 #undef isspace
312 #undef isdigit
313 #undef isalpha
314 #undef isalnum
315 #undef tolower
316 #undef toupper
317 extern unsigned char sane_ctype[256];
318 #define GIT_SPACE 0x01
319 #define GIT_DIGIT 0x02
320 #define GIT_ALPHA 0x04
321 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
322 #define isspace(x) sane_istest(x,GIT_SPACE)
323 #define isdigit(x) sane_istest(x,GIT_DIGIT)
324 #define isalpha(x) sane_istest(x,GIT_ALPHA)
325 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
326 #define tolower(x) sane_case((unsigned char)(x), 0x20)
327 #define toupper(x) sane_case((unsigned char)(x), 0)
329 static inline int sane_case(int x, int high)
331 if (sane_istest(x, GIT_ALPHA))
332 x = (x & ~0x20) | high;
333 return x;
336 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
338 unsigned long ul;
339 char *p;
341 errno = 0;
342 ul = strtoul(s, &p, base);
343 if (errno || *p || p == s || (unsigned int) ul != ul)
344 return -1;
345 *result = ul;
346 return 0;
349 static inline int strtol_i(char const *s, int base, int *result)
351 long ul;
352 char *p;
354 errno = 0;
355 ul = strtol(s, &p, base);
356 if (errno || *p || p == s || (int) ul != ul)
357 return -1;
358 *result = ul;
359 return 0;
362 #ifdef INTERNAL_QSORT
363 void git_qsort(void *base, size_t nmemb, size_t size,
364 int(*compar)(const void *, const void *));
365 #define qsort git_qsort
366 #endif
368 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
369 # define FORCE_DIR_SET_GID S_ISGID
370 #else
371 # define FORCE_DIR_SET_GID 0
372 #endif
374 #endif