compat/terminal: header-fixup
[git/dscho.git] / git-compat-util.h
blob6429352c8d486749d9e6392b9f0f0719358e251b
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 #define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
34 #define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
38 * Signed integer overflow is undefined in C, so here's a helper macro
39 * to detect if the sum of two integers will overflow.
41 * Requires: a >= 0, typeof(a) equals typeof(b)
43 #define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
46 #define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
49 #ifdef __GNUC__
50 #define TYPEOF(x) (__typeof__(x))
51 #else
52 #define TYPEOF(x)
53 #endif
55 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
56 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
58 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
60 /* Approximation of the length of the decimal representation of this type. */
61 #define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
63 #if defined(__sun__)
65 * On Solaris, when _XOPEN_EXTENDED is set, its header file
66 * forces the programs to be XPG4v2, defeating any _XOPEN_SOURCE
67 * setting to say we are XPG5 or XPG6. Also on Solaris,
68 * XPG6 programs must be compiled with a c99 compiler, while
69 * non XPG6 programs must be compiled with a pre-c99 compiler.
71 # if __STDC_VERSION__ - 0 >= 199901L
72 # define _XOPEN_SOURCE 600
73 # else
74 # define _XOPEN_SOURCE 500
75 # endif
76 #elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
78 !defined(__TANDEM)
79 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
80 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
81 #endif
82 #define _ALL_SOURCE 1
83 #define _GNU_SOURCE 1
84 #define _BSD_SOURCE 1
85 #define _NETBSD_SOURCE 1
86 #define _SGI_SOURCE 1
88 #ifdef WIN32 /* Both MinGW and MSVC */
89 #define _WIN32_WINNT 0x0501
90 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
91 #include <winsock2.h>
92 #include <windows.h>
93 #include <conio.h>
94 #endif
96 #include <unistd.h>
97 #include <stdio.h>
98 #include <sys/stat.h>
99 #include <fcntl.h>
100 #include <stddef.h>
101 #include <stdlib.h>
102 #include <stdarg.h>
103 #include <string.h>
104 #ifdef __TANDEM /* or HAVE_STRINGS_H or !NO_STRINGS_H? */
105 #include <strings.h> /* for strcasecmp() */
106 #endif
107 #include <errno.h>
108 #include <limits.h>
109 #include <sys/param.h>
110 #include <sys/types.h>
111 #include <dirent.h>
112 #include <sys/time.h>
113 #include <time.h>
114 #include <signal.h>
115 #include <fnmatch.h>
116 #include <assert.h>
117 #include <regex.h>
118 #include <utime.h>
119 #include <syslog.h>
120 #ifndef NO_SYS_POLL_H
121 #include <sys/poll.h>
122 #else
123 #include <poll.h>
124 #endif
125 #if defined(__MINGW32__)
126 /* pull in Windows compatibility stuff */
127 #include "compat/mingw.h"
128 #elif defined(_MSC_VER)
129 #include "compat/msvc.h"
130 #else
131 #include <sys/wait.h>
132 #include <sys/resource.h>
133 #include <sys/socket.h>
134 #include <sys/ioctl.h>
135 #include <termios.h>
136 #ifndef NO_SYS_SELECT_H
137 #include <sys/select.h>
138 #endif
139 #include <netinet/in.h>
140 #include <netinet/tcp.h>
141 #include <arpa/inet.h>
142 #include <netdb.h>
143 #include <pwd.h>
144 #include <sys/un.h>
145 #ifndef NO_INTTYPES_H
146 #include <inttypes.h>
147 #else
148 #include <stdint.h>
149 #endif
150 #ifdef NO_INTPTR_T
152 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
153 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
154 * while on IP16 and IP16L32 it is "int" (resp. "short")
155 * Size needs to match (or exceed) 'sizeof(void *)'.
156 * We can't take "long long" here as not everybody has it.
158 typedef long intptr_t;
159 typedef unsigned long uintptr_t;
160 #endif
161 #if defined(__CYGWIN__)
162 #undef _XOPEN_SOURCE
163 #include <grp.h>
164 #define _XOPEN_SOURCE 600
165 #include "compat/cygwin.h"
166 #else
167 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
168 #include <grp.h>
169 #define _ALL_SOURCE 1
170 #endif
171 #endif
173 /* used on Mac OS X */
174 #ifdef PRECOMPOSE_UNICODE
175 #include "compat/precompose_utf8.h"
176 #else
177 #define precompose_str(in,i_nfd2nfc)
178 #define precompose_argv(c,v)
179 #define probe_utf8_pathname_composition(a,b)
180 #endif
182 #ifdef MKDIR_WO_TRAILING_SLASH
183 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
184 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
185 #endif
187 #ifdef NO_STRUCT_ITIMERVAL
188 struct itimerval {
189 struct timeval it_interval;
190 struct timeval it_value;
192 #endif
194 #ifdef NO_SETITIMER
195 #define setitimer(which,value,ovalue)
196 #endif
198 #ifndef NO_LIBGEN_H
199 #include <libgen.h>
200 #else
201 #define basename gitbasename
202 extern char *gitbasename(char *);
203 #endif
205 #ifndef NO_ICONV
206 #include <iconv.h>
207 #endif
209 #ifndef NO_OPENSSL
210 #include <openssl/ssl.h>
211 #include <openssl/err.h>
212 #endif
214 /* On most systems <limits.h> would have given us this, but
215 * not on some systems (e.g. GNU/Hurd).
217 #ifndef PATH_MAX
218 #define PATH_MAX 4096
219 #endif
221 #ifndef PRIuMAX
222 #define PRIuMAX "llu"
223 #endif
225 #ifndef PRIu32
226 #define PRIu32 "u"
227 #endif
229 #ifndef PRIx32
230 #define PRIx32 "x"
231 #endif
233 #ifndef PRIo32
234 #define PRIo32 "o"
235 #endif
237 #ifndef PATH_SEP
238 #define PATH_SEP ':'
239 #endif
241 #ifdef HAVE_PATHS_H
242 #include <paths.h>
243 #endif
244 #ifndef _PATH_DEFPATH
245 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
246 #endif
248 #ifndef STRIP_EXTENSION
249 #define STRIP_EXTENSION ""
250 #endif
252 #ifndef has_dos_drive_prefix
253 #define has_dos_drive_prefix(path) 0
254 #endif
256 #ifndef offset_1st_component
257 #define offset_1st_component(path) (is_dir_sep((path)[0]))
258 #endif
260 #ifndef is_dir_sep
261 #define is_dir_sep(c) ((c) == '/')
262 #endif
264 #ifndef find_last_dir_sep
265 #define find_last_dir_sep(path) strrchr(path, '/')
266 #endif
268 #if defined(__HP_cc) && (__HP_cc >= 61000)
269 #define NORETURN __attribute__((noreturn))
270 #define NORETURN_PTR
271 #elif defined(__GNUC__) && !defined(NO_NORETURN)
272 #define NORETURN __attribute__((__noreturn__))
273 #define NORETURN_PTR __attribute__((__noreturn__))
274 #elif defined(_MSC_VER)
275 #define NORETURN __declspec(noreturn)
276 #define NORETURN_PTR
277 #else
278 #define NORETURN
279 #define NORETURN_PTR
280 #ifndef __attribute__
281 #define __attribute__(x)
282 #endif
283 #endif
285 #include "compat/bswap.h"
287 /* General helper functions */
288 extern void vreportf(const char *prefix, const char *err, va_list params);
289 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
290 extern NORETURN void usage(const char *err);
291 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
292 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
293 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
294 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
295 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
297 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
298 extern void set_error_routine(void (*routine)(const char *err, va_list params));
300 extern int prefixcmp(const char *str, const char *prefix);
301 extern int suffixcmp(const char *str, const char *suffix);
303 static inline const char *skip_prefix(const char *str, const char *prefix)
305 size_t len = strlen(prefix);
306 return strncmp(str, prefix, len) ? NULL : str + len;
309 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
311 #ifndef PROT_READ
312 #define PROT_READ 1
313 #define PROT_WRITE 2
314 #define MAP_PRIVATE 1
315 #endif
317 #define mmap git_mmap
318 #define munmap git_munmap
319 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
320 extern int git_munmap(void *start, size_t length);
322 #else /* NO_MMAP || USE_WIN32_MMAP */
324 #include <sys/mman.h>
326 #endif /* NO_MMAP || USE_WIN32_MMAP */
328 #ifdef NO_MMAP
330 /* This value must be multiple of (pagesize * 2) */
331 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
333 #else /* NO_MMAP */
335 /* This value must be multiple of (pagesize * 2) */
336 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
337 (sizeof(void*) >= 8 \
338 ? 1 * 1024 * 1024 * 1024 \
339 : 32 * 1024 * 1024)
341 #endif /* NO_MMAP */
343 #ifndef MAP_FAILED
344 #define MAP_FAILED ((void *)-1)
345 #endif
347 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
348 #define on_disk_bytes(st) ((st).st_size)
349 #else
350 #define on_disk_bytes(st) ((st).st_blocks * 512)
351 #endif
353 #define DEFAULT_PACKED_GIT_LIMIT \
354 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
356 #ifdef NO_PREAD
357 #define pread git_pread
358 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
359 #endif
361 * Forward decl that will remind us if its twin in cache.h changes.
362 * This function is used in compat/pread.c. But we can't include
363 * cache.h there.
365 extern ssize_t read_in_full(int fd, void *buf, size_t count);
367 #ifdef NO_SETENV
368 #define setenv gitsetenv
369 extern int gitsetenv(const char *, const char *, int);
370 #endif
372 #ifdef NO_MKDTEMP
373 #define mkdtemp gitmkdtemp
374 extern char *gitmkdtemp(char *);
375 #endif
377 #ifdef NO_MKSTEMPS
378 #define mkstemps gitmkstemps
379 extern int gitmkstemps(char *, int);
380 #endif
382 #ifdef NO_UNSETENV
383 #define unsetenv gitunsetenv
384 extern void gitunsetenv(const char *);
385 #endif
387 #ifdef NO_STRCASESTR
388 #define strcasestr gitstrcasestr
389 extern char *gitstrcasestr(const char *haystack, const char *needle);
390 #endif
392 #ifdef NO_STRLCPY
393 #define strlcpy gitstrlcpy
394 extern size_t gitstrlcpy(char *, const char *, size_t);
395 #endif
397 #ifdef NO_STRTOUMAX
398 #define strtoumax gitstrtoumax
399 extern uintmax_t gitstrtoumax(const char *, char **, int);
400 #define strtoimax gitstrtoimax
401 extern intmax_t gitstrtoimax(const char *, char **, int);
402 #endif
404 #ifdef NO_STRTOK_R
405 #define strtok_r gitstrtok_r
406 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
407 #endif
409 #ifdef NO_HSTRERROR
410 #define hstrerror githstrerror
411 extern const char *githstrerror(int herror);
412 #endif
414 #ifdef NO_MEMMEM
415 #define memmem gitmemmem
416 void *gitmemmem(const void *haystack, size_t haystacklen,
417 const void *needle, size_t needlelen);
418 #endif
420 #ifdef FREAD_READS_DIRECTORIES
421 #ifdef fopen
422 #undef fopen
423 #endif
424 #define fopen(a,b) git_fopen(a,b)
425 extern FILE *git_fopen(const char*, const char*);
426 #endif
428 #ifdef SNPRINTF_RETURNS_BOGUS
429 #define snprintf git_snprintf
430 extern int git_snprintf(char *str, size_t maxsize,
431 const char *format, ...);
432 #define vsnprintf git_vsnprintf
433 extern int git_vsnprintf(char *str, size_t maxsize,
434 const char *format, va_list ap);
435 #endif
437 #ifdef __GLIBC_PREREQ
438 #if __GLIBC_PREREQ(2, 1)
439 #define HAVE_STRCHRNUL
440 #define HAVE_MEMPCPY
441 #endif
442 #endif
444 #ifndef HAVE_STRCHRNUL
445 #define strchrnul gitstrchrnul
446 static inline char *gitstrchrnul(const char *s, int c)
448 while (*s && *s != c)
449 s++;
450 return (char *)s;
452 #endif
454 #ifndef HAVE_MEMPCPY
455 #define mempcpy gitmempcpy
456 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
458 return (char *)memcpy(dest, src, n) + n;
460 #endif
462 #ifdef NO_INET_PTON
463 int inet_pton(int af, const char *src, void *dst);
464 #endif
466 #ifdef NO_INET_NTOP
467 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
468 #endif
470 extern void release_pack_memory(size_t, int);
472 typedef void (*try_to_free_t)(size_t);
473 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
475 extern char *xstrdup(const char *str);
476 extern void *xmalloc(size_t size);
477 extern void *xmallocz(size_t size);
478 extern void *xmemdupz(const void *data, size_t len);
479 extern char *xstrndup(const char *str, size_t len);
480 extern void *xrealloc(void *ptr, size_t size);
481 extern void *xcalloc(size_t nmemb, size_t size);
482 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
483 extern ssize_t xread(int fd, void *buf, size_t len);
484 extern ssize_t xwrite(int fd, const void *buf, size_t len);
485 extern int xdup(int fd);
486 extern FILE *xfdopen(int fd, const char *mode);
487 extern int xmkstemp(char *template);
488 extern int xmkstemp_mode(char *template, int mode);
489 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
490 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
492 static inline size_t xsize_t(off_t len)
494 if (len > (size_t) len)
495 die("Cannot handle files this big");
496 return (size_t)len;
499 static inline int has_extension(const char *filename, const char *ext)
501 size_t len = strlen(filename);
502 size_t extlen = strlen(ext);
503 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
506 /* in ctype.c, for kwset users */
507 extern const char tolower_trans_tbl[256];
509 /* Sane ctype - no locale, and works with signed chars */
510 #undef isascii
511 #undef isspace
512 #undef isdigit
513 #undef isalpha
514 #undef isalnum
515 #undef islower
516 #undef isupper
517 #undef tolower
518 #undef toupper
519 extern unsigned char sane_ctype[256];
520 #define GIT_SPACE 0x01
521 #define GIT_DIGIT 0x02
522 #define GIT_ALPHA 0x04
523 #define GIT_GLOB_SPECIAL 0x08
524 #define GIT_REGEX_SPECIAL 0x10
525 #define GIT_PATHSPEC_MAGIC 0x20
526 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
527 #define isascii(x) (((x) & ~0x7f) == 0)
528 #define isspace(x) sane_istest(x,GIT_SPACE)
529 #define isdigit(x) sane_istest(x,GIT_DIGIT)
530 #define isalpha(x) sane_istest(x,GIT_ALPHA)
531 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
532 #define islower(x) sane_iscase(x, 1)
533 #define isupper(x) sane_iscase(x, 0)
534 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
535 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
536 #define tolower(x) sane_case((unsigned char)(x), 0x20)
537 #define toupper(x) sane_case((unsigned char)(x), 0)
538 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
540 static inline int sane_case(int x, int high)
542 if (sane_istest(x, GIT_ALPHA))
543 x = (x & ~0x20) | high;
544 return x;
547 static inline int sane_iscase(int x, int is_lower)
549 if (!sane_istest(x, GIT_ALPHA))
550 return 0;
552 if (is_lower)
553 return (x & 0x20) != 0;
554 else
555 return (x & 0x20) == 0;
558 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
560 unsigned long ul;
561 char *p;
563 errno = 0;
564 ul = strtoul(s, &p, base);
565 if (errno || *p || p == s || (unsigned int) ul != ul)
566 return -1;
567 *result = ul;
568 return 0;
571 static inline int strtol_i(char const *s, int base, int *result)
573 long ul;
574 char *p;
576 errno = 0;
577 ul = strtol(s, &p, base);
578 if (errno || *p || p == s || (int) ul != ul)
579 return -1;
580 *result = ul;
581 return 0;
584 #ifdef INTERNAL_QSORT
585 void git_qsort(void *base, size_t nmemb, size_t size,
586 int(*compar)(const void *, const void *));
587 #define qsort git_qsort
588 #endif
590 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
591 # define FORCE_DIR_SET_GID S_ISGID
592 #else
593 # define FORCE_DIR_SET_GID 0
594 #endif
596 #ifdef NO_NSEC
597 #undef USE_NSEC
598 #define ST_CTIME_NSEC(st) 0
599 #define ST_MTIME_NSEC(st) 0
600 #else
601 #ifdef USE_ST_TIMESPEC
602 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
603 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
604 #else
605 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
606 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
607 #endif
608 #endif
610 #ifdef UNRELIABLE_FSTAT
611 #define fstat_is_reliable() 0
612 #else
613 #define fstat_is_reliable() 1
614 #endif
616 #ifndef va_copy
618 * Since an obvious implementation of va_list would be to make it a
619 * pointer into the stack frame, a simple assignment will work on
620 * many systems. But let's try to be more portable.
622 #ifdef __va_copy
623 #define va_copy(dst, src) __va_copy(dst, src)
624 #else
625 #define va_copy(dst, src) ((dst) = (src))
626 #endif
627 #endif
630 * Preserves errno, prints a message, but gives no warning for ENOENT.
631 * Always returns the return value of unlink(2).
633 int unlink_or_warn(const char *path);
635 * Likewise for rmdir(2).
637 int rmdir_or_warn(const char *path);
639 * Calls the correct function out of {unlink,rmdir}_or_warn based on
640 * the supplied file mode.
642 int remove_or_warn(unsigned int mode, const char *path);
644 /* Call access(2), but warn for any error besides ENOENT. */
645 int access_or_warn(const char *path, int mode);
647 /* Warn on an inaccessible file that ought to be accessible */
648 void warn_on_inaccessible(const char *path);
650 /* Get the passwd entry for the UID of the current process. */
651 struct passwd *xgetpwuid_self(void);
653 #ifndef mark_as_git_dir
654 #define mark_as_git_dir(x) /* noop */
655 #endif
657 #ifndef get_home_directory
658 #define get_home_directory() getenv("HOME")
659 #endif
661 #endif