Make the MSVC projects use PDB/IDB files named after the project
[git/dscho.git] / git-compat-util.h
blobef6080338480f509e720a484998c286ae1814b0a
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) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
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]))
29 #define bitsizeof(x) (CHAR_BIT * sizeof(x))
31 #ifdef __GNUC__
32 #define TYPEOF(x) (__typeof__(x))
33 #else
34 #define TYPEOF(x)
35 #endif
37 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
38 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
40 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
42 /* Approximation of the length of the decimal representation of this type. */
43 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
45 #if defined(__sun__)
47 * On Solaris, when _XOPEN_EXTENDED is set, its header file
48 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
49 * setting to say we are XPG5 or XPG6. Also on Solaris,
50 * XPG6 programs must be compiled with a c99 compiler, while
51 * non XPG6 programs must be compiled with a pre-c99 compiler.
53 # if __STDC_VERSION__ - 0 >= 199901L
54 # define _XOPEN_SOURCE 600
55 # else
56 # define _XOPEN_SOURCE 500
57 # endif
58 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX) && !defined(sgi)
59 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
60 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
61 #endif
62 #define _ALL_SOURCE 1
63 #define _GNU_SOURCE 1
64 #define _BSD_SOURCE 1
65 #define _NETBSD_SOURCE 1
66 #define _SGI_SOURCE 1
68 #ifdef WIN32 /* Both MinGW and MSVC */
69 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
70 #include <winsock2.h>
71 #include <windows.h>
72 #endif
74 #include <unistd.h>
75 #include <stdio.h>
76 #include <sys/stat.h>
77 #include <fcntl.h>
78 #include <stddef.h>
79 #include <stdlib.h>
80 #include <stdarg.h>
81 #include <string.h>
82 #include <errno.h>
83 #include <limits.h>
84 #include <sys/param.h>
85 #include <sys/types.h>
86 #include <dirent.h>
87 #include <sys/time.h>
88 #include <time.h>
89 #include <signal.h>
90 #include <fnmatch.h>
91 #include <assert.h>
92 #include <regex.h>
93 #include <utime.h>
94 #ifndef __MINGW32__
95 #include <sys/wait.h>
96 #include <sys/poll.h>
97 #include <sys/socket.h>
98 #include <sys/ioctl.h>
99 #ifndef NO_SYS_SELECT_H
100 #include <sys/select.h>
101 #endif
102 #include <netinet/in.h>
103 #include <netinet/tcp.h>
104 #include <arpa/inet.h>
105 #include <netdb.h>
106 #include <pwd.h>
107 #include <inttypes.h>
108 #if defined(__CYGWIN__)
109 #undef _XOPEN_SOURCE
110 #include <grp.h>
111 #define _XOPEN_SOURCE 600
112 #include "compat/cygwin.h"
113 #else
114 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
115 #include <grp.h>
116 #define _ALL_SOURCE 1
117 #endif
118 #else /* __MINGW32__ */
119 /* pull in Windows compatibility stuff */
120 #include "compat/mingw.h"
121 #endif /* __MINGW32__ */
122 #ifdef _MSC_VER
123 #include "compat/msvc.h"
124 #endif
126 #ifndef NO_LIBGEN_H
127 #include <libgen.h>
128 #else
129 #define basename gitbasename
130 extern char *gitbasename(char *);
131 #endif
133 #ifndef NO_ICONV
134 #include <iconv.h>
135 #endif
137 #ifndef NO_OPENSSL
138 #include <openssl/ssl.h>
139 #include <openssl/err.h>
140 #endif
142 /* On most systems <limits.h> would have given us this, but
143 * not on some systems (e.g. GNU/Hurd).
145 #ifndef PATH_MAX
146 #define PATH_MAX 4096
147 #endif
149 #ifndef PRIuMAX
150 #define PRIuMAX "llu"
151 #endif
153 #ifndef PRIu32
154 #define PRIu32 "u"
155 #endif
157 #ifndef PRIx32
158 #define PRIx32 "x"
159 #endif
161 #ifndef PATH_SEP
162 #define PATH_SEP ':'
163 #endif
165 #ifndef STRIP_EXTENSION
166 #define STRIP_EXTENSION ""
167 #endif
169 #ifndef has_dos_drive_prefix
170 #define has_dos_drive_prefix(path) 0
171 #endif
173 #ifndef is_dir_sep
174 #define is_dir_sep(c) ((c) == '/')
175 #endif
177 #ifdef __GNUC__
178 #define NORETURN __attribute__((__noreturn__))
179 #define NORETURN_PTR __attribute__((__noreturn__))
180 #else
181 #define NORETURN
182 #define NORETURN_PTR
183 #ifndef __attribute__
184 #define __attribute__(x)
185 #endif
186 #endif
188 #include "compat/bswap.h"
190 /* General helper functions */
191 extern NORETURN void usage(const char *err);
192 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
193 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
194 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
195 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
197 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
199 extern int prefixcmp(const char *str, const char *prefix);
200 extern time_t tm_to_time_t(const struct tm *tm);
202 static inline const char *skip_prefix(const char *str, const char *prefix)
204 size_t len = strlen(prefix);
205 return strncmp(str, prefix, len) ? NULL : str + len;
208 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
210 #ifndef PROT_READ
211 #define PROT_READ 1
212 #define PROT_WRITE 2
213 #define MAP_PRIVATE 1
214 #define MAP_FAILED ((void*)-1)
215 #endif
217 #define mmap git_mmap
218 #define munmap git_munmap
219 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
220 extern int git_munmap(void *start, size_t length);
222 #else /* NO_MMAP || USE_WIN32_MMAP */
224 #include <sys/mman.h>
226 #endif /* NO_MMAP || USE_WIN32_MMAP */
228 #ifdef NO_MMAP
230 /* This value must be multiple of (pagesize * 2) */
231 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
233 #else /* NO_MMAP */
235 /* This value must be multiple of (pagesize * 2) */
236 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
237 (sizeof(void*) >= 8 \
238 ? 1 * 1024 * 1024 * 1024 \
239 : 32 * 1024 * 1024)
241 #endif /* NO_MMAP */
243 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
244 #define on_disk_bytes(st) ((st).st_size)
245 #else
246 #define on_disk_bytes(st) ((st).st_blocks * 512)
247 #endif
249 #define DEFAULT_PACKED_GIT_LIMIT \
250 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
252 #ifdef NO_PREAD
253 #define pread git_pread
254 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
255 #endif
257 * Forward decl that will remind us if its twin in cache.h changes.
258 * This function is used in compat/pread.c. But we can't include
259 * cache.h there.
261 extern ssize_t read_in_full(int fd, void *buf, size_t count);
263 #ifdef NO_SETENV
264 #define setenv gitsetenv
265 extern int gitsetenv(const char *, const char *, int);
266 #endif
268 #ifdef NO_MKDTEMP
269 #define mkdtemp gitmkdtemp
270 extern char *gitmkdtemp(char *);
271 #endif
273 #ifdef NO_MKSTEMPS
274 #define mkstemps gitmkstemps
275 extern int gitmkstemps(char *, int);
276 #endif
278 #ifdef NO_UNSETENV
279 #define unsetenv gitunsetenv
280 extern void gitunsetenv(const char *);
281 #endif
283 #ifdef NO_STRCASESTR
284 #define strcasestr gitstrcasestr
285 extern char *gitstrcasestr(const char *haystack, const char *needle);
286 #endif
288 #ifdef NO_STRLCPY
289 #define strlcpy gitstrlcpy
290 extern size_t gitstrlcpy(char *, const char *, size_t);
291 #endif
293 #ifdef NO_STRTOUMAX
294 #define strtoumax gitstrtoumax
295 extern uintmax_t gitstrtoumax(const char *, char **, int);
296 #endif
298 #ifdef NO_HSTRERROR
299 #define hstrerror githstrerror
300 extern const char *githstrerror(int herror);
301 #endif
303 #ifdef NO_MEMMEM
304 #define memmem gitmemmem
305 void *gitmemmem(const void *haystack, size_t haystacklen,
306 const void *needle, size_t needlelen);
307 #endif
309 #ifdef FREAD_READS_DIRECTORIES
310 #ifdef fopen
311 #undef fopen
312 #endif
313 #define fopen(a,b) git_fopen(a,b)
314 extern FILE *git_fopen(const char*, const char*);
315 #endif
317 #ifdef SNPRINTF_RETURNS_BOGUS
318 #define snprintf git_snprintf
319 extern int git_snprintf(char *str, size_t maxsize,
320 const char *format, ...);
321 #define vsnprintf git_vsnprintf
322 extern int git_vsnprintf(char *str, size_t maxsize,
323 const char *format, va_list ap);
324 #endif
326 #ifdef __GLIBC_PREREQ
327 #if __GLIBC_PREREQ(2, 1)
328 #define HAVE_STRCHRNUL
329 #endif
330 #endif
332 #ifndef HAVE_STRCHRNUL
333 #define strchrnul gitstrchrnul
334 static inline char *gitstrchrnul(const char *s, int c)
336 while (*s && *s != c)
337 s++;
338 return (char *)s;
340 #endif
342 extern void release_pack_memory(size_t, int);
344 extern char *xstrdup(const char *str);
345 extern void *xmalloc(size_t size);
346 extern void *xmemdupz(const void *data, size_t len);
347 extern char *xstrndup(const char *str, size_t len);
348 extern void *xrealloc(void *ptr, size_t size);
349 extern void *xcalloc(size_t nmemb, size_t size);
350 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
351 extern ssize_t xread(int fd, void *buf, size_t len);
352 extern ssize_t xwrite(int fd, const void *buf, size_t len);
353 extern int xdup(int fd);
354 extern FILE *xfdopen(int fd, const char *mode);
355 extern int xmkstemp(char *template);
356 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
357 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
359 static inline size_t xsize_t(off_t len)
361 return (size_t)len;
364 static inline int has_extension(const char *filename, const char *ext)
366 size_t len = strlen(filename);
367 size_t extlen = strlen(ext);
368 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
371 /* Sane ctype - no locale, and works with signed chars */
372 #undef isascii
373 #undef isspace
374 #undef isdigit
375 #undef isalpha
376 #undef isalnum
377 #undef tolower
378 #undef toupper
379 extern unsigned char sane_ctype[256];
380 #define GIT_SPACE 0x01
381 #define GIT_DIGIT 0x02
382 #define GIT_ALPHA 0x04
383 #define GIT_GLOB_SPECIAL 0x08
384 #define GIT_REGEX_SPECIAL 0x10
385 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
386 #define isascii(x) (((x) & ~0x7f) == 0)
387 #define isspace(x) sane_istest(x,GIT_SPACE)
388 #define isdigit(x) sane_istest(x,GIT_DIGIT)
389 #define isalpha(x) sane_istest(x,GIT_ALPHA)
390 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
391 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
392 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
393 #define tolower(x) sane_case((unsigned char)(x), 0x20)
394 #define toupper(x) sane_case((unsigned char)(x), 0)
396 static inline int sane_case(int x, int high)
398 if (sane_istest(x, GIT_ALPHA))
399 x = (x & ~0x20) | high;
400 return x;
403 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
405 unsigned long ul;
406 char *p;
408 errno = 0;
409 ul = strtoul(s, &p, base);
410 if (errno || *p || p == s || (unsigned int) ul != ul)
411 return -1;
412 *result = ul;
413 return 0;
416 static inline int strtol_i(char const *s, int base, int *result)
418 long ul;
419 char *p;
421 errno = 0;
422 ul = strtol(s, &p, base);
423 if (errno || *p || p == s || (int) ul != ul)
424 return -1;
425 *result = ul;
426 return 0;
429 #ifdef INTERNAL_QSORT
430 void git_qsort(void *base, size_t nmemb, size_t size,
431 int(*compar)(const void *, const void *));
432 #define qsort git_qsort
433 #endif
435 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
436 # define FORCE_DIR_SET_GID S_ISGID
437 #else
438 # define FORCE_DIR_SET_GID 0
439 #endif
441 #ifdef NO_NSEC
442 #undef USE_NSEC
443 #define ST_CTIME_NSEC(st) 0
444 #define ST_MTIME_NSEC(st) 0
445 #else
446 #ifdef USE_ST_TIMESPEC
447 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
448 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
449 #else
450 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
451 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
452 #endif
453 #endif
455 #ifdef UNRELIABLE_FSTAT
456 #define fstat_is_reliable() 0
457 #else
458 #define fstat_is_reliable() 1
459 #endif
462 * Preserves errno, prints a message, but gives no warning for ENOENT.
463 * Always returns the return value of unlink(2).
465 int unlink_or_warn(const char *path);
467 #endif