i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / git-compat-util.h
blob35b095e8ae989ae02228f814528b43d5bd026aab
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 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
79 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
80 #endif
81 #define _ALL_SOURCE 1
82 #define _GNU_SOURCE 1
83 #define _BSD_SOURCE 1
84 #define _NETBSD_SOURCE 1
85 #define _SGI_SOURCE 1
87 #ifdef WIN32 /* Both MinGW and MSVC */
88 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
89 #include <winsock2.h>
90 #include <windows.h>
91 #endif
93 #include <unistd.h>
94 #include <stdio.h>
95 #include <sys/stat.h>
96 #include <fcntl.h>
97 #include <stddef.h>
98 #include <stdlib.h>
99 #include <stdarg.h>
100 #include <string.h>
101 #include <errno.h>
102 #include <limits.h>
103 #include <sys/param.h>
104 #include <sys/types.h>
105 #include <dirent.h>
106 #include <sys/time.h>
107 #include <time.h>
108 #include <signal.h>
109 #include <fnmatch.h>
110 #include <assert.h>
111 #include <regex.h>
112 #include <utime.h>
113 #include <syslog.h>
114 #ifndef NO_SYS_POLL_H
115 #include <sys/poll.h>
116 #else
117 #include <poll.h>
118 #endif
119 #if defined(__MINGW32__)
120 /* pull in Windows compatibility stuff */
121 #include "compat/mingw.h"
122 #elif defined(_MSC_VER)
123 #include "compat/msvc.h"
124 #else
125 #include <sys/wait.h>
126 #include <sys/resource.h>
127 #include <sys/socket.h>
128 #include <sys/ioctl.h>
129 #include <termios.h>
130 #ifndef NO_SYS_SELECT_H
131 #include <sys/select.h>
132 #endif
133 #include <netinet/in.h>
134 #include <netinet/tcp.h>
135 #include <arpa/inet.h>
136 #include <netdb.h>
137 #include <pwd.h>
138 #include <sys/un.h>
139 #ifndef NO_INTTYPES_H
140 #include <inttypes.h>
141 #else
142 #include <stdint.h>
143 #endif
144 #if defined(__CYGWIN__)
145 #undef _XOPEN_SOURCE
146 #include <grp.h>
147 #define _XOPEN_SOURCE 600
148 #include "compat/cygwin.h"
149 #else
150 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
151 #include <grp.h>
152 #define _ALL_SOURCE 1
153 #endif
154 #endif
156 /* used on Mac OS X */
157 #ifdef PRECOMPOSE_UNICODE
158 #include "compat/precompose_utf8.h"
159 #else
160 #define precompose_str(in,i_nfd2nfc)
161 #define precompose_argv(c,v)
162 #define probe_utf8_pathname_composition(a,b)
163 #endif
165 #ifndef NO_LIBGEN_H
166 #include <libgen.h>
167 #else
168 #define basename gitbasename
169 extern char *gitbasename(char *);
170 #endif
172 #ifndef NO_ICONV
173 #include <iconv.h>
174 #endif
176 #ifndef NO_OPENSSL
177 #include <openssl/ssl.h>
178 #include <openssl/err.h>
179 #endif
181 /* On most systems <limits.h> would have given us this, but
182 * not on some systems (e.g. GNU/Hurd).
184 #ifndef PATH_MAX
185 #define PATH_MAX 4096
186 #endif
188 #ifndef PRIuMAX
189 #define PRIuMAX "llu"
190 #endif
192 #ifndef PRIu32
193 #define PRIu32 "u"
194 #endif
196 #ifndef PRIx32
197 #define PRIx32 "x"
198 #endif
200 #ifndef PRIo32
201 #define PRIo32 "o"
202 #endif
204 #ifndef PATH_SEP
205 #define PATH_SEP ':'
206 #endif
208 #ifdef HAVE_PATHS_H
209 #include <paths.h>
210 #endif
211 #ifndef _PATH_DEFPATH
212 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
213 #endif
215 #ifndef STRIP_EXTENSION
216 #define STRIP_EXTENSION ""
217 #endif
219 #ifndef has_dos_drive_prefix
220 #define has_dos_drive_prefix(path) 0
221 #endif
223 #ifndef is_dir_sep
224 #define is_dir_sep(c) ((c) == '/')
225 #endif
227 #ifndef find_last_dir_sep
228 #define find_last_dir_sep(path) strrchr(path, '/')
229 #endif
231 #if defined(__HP_cc) && (__HP_cc >= 61000)
232 #define NORETURN __attribute__((noreturn))
233 #define NORETURN_PTR
234 #elif defined(__GNUC__) && !defined(NO_NORETURN)
235 #define NORETURN __attribute__((__noreturn__))
236 #define NORETURN_PTR __attribute__((__noreturn__))
237 #elif defined(_MSC_VER)
238 #define NORETURN __declspec(noreturn)
239 #define NORETURN_PTR
240 #else
241 #define NORETURN
242 #define NORETURN_PTR
243 #ifndef __attribute__
244 #define __attribute__(x)
245 #endif
246 #endif
248 #include "compat/bswap.h"
250 /* General helper functions */
251 extern void vreportf(const char *prefix, const char *err, va_list params);
252 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
253 extern NORETURN void usage(const char *err);
254 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
255 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
256 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
257 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
258 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
260 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
261 extern void set_error_routine(void (*routine)(const char *err, va_list params));
263 extern int prefixcmp(const char *str, const char *prefix);
264 extern int suffixcmp(const char *str, const char *suffix);
266 static inline const char *skip_prefix(const char *str, const char *prefix)
268 size_t len = strlen(prefix);
269 return strncmp(str, prefix, len) ? NULL : str + len;
272 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
274 #ifndef PROT_READ
275 #define PROT_READ 1
276 #define PROT_WRITE 2
277 #define MAP_PRIVATE 1
278 #endif
280 #define mmap git_mmap
281 #define munmap git_munmap
282 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
283 extern int git_munmap(void *start, size_t length);
285 #else /* NO_MMAP || USE_WIN32_MMAP */
287 #include <sys/mman.h>
289 #endif /* NO_MMAP || USE_WIN32_MMAP */
291 #ifdef NO_MMAP
293 /* This value must be multiple of (pagesize * 2) */
294 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
296 #else /* NO_MMAP */
298 /* This value must be multiple of (pagesize * 2) */
299 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
300 (sizeof(void*) >= 8 \
301 ? 1 * 1024 * 1024 * 1024 \
302 : 32 * 1024 * 1024)
304 #endif /* NO_MMAP */
306 #ifndef MAP_FAILED
307 #define MAP_FAILED ((void *)-1)
308 #endif
310 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
311 #define on_disk_bytes(st) ((st).st_size)
312 #else
313 #define on_disk_bytes(st) ((st).st_blocks * 512)
314 #endif
316 #define DEFAULT_PACKED_GIT_LIMIT \
317 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
319 #ifdef NO_PREAD
320 #define pread git_pread
321 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
322 #endif
324 * Forward decl that will remind us if its twin in cache.h changes.
325 * This function is used in compat/pread.c. But we can't include
326 * cache.h there.
328 extern ssize_t read_in_full(int fd, void *buf, size_t count);
330 #ifdef NO_SETENV
331 #define setenv gitsetenv
332 extern int gitsetenv(const char *, const char *, int);
333 #endif
335 #ifdef NO_MKDTEMP
336 #define mkdtemp gitmkdtemp
337 extern char *gitmkdtemp(char *);
338 #endif
340 #ifdef NO_MKSTEMPS
341 #define mkstemps gitmkstemps
342 extern int gitmkstemps(char *, int);
343 #endif
345 #ifdef NO_UNSETENV
346 #define unsetenv gitunsetenv
347 extern void gitunsetenv(const char *);
348 #endif
350 #ifdef NO_STRCASESTR
351 #define strcasestr gitstrcasestr
352 extern char *gitstrcasestr(const char *haystack, const char *needle);
353 #endif
355 #ifdef NO_STRLCPY
356 #define strlcpy gitstrlcpy
357 extern size_t gitstrlcpy(char *, const char *, size_t);
358 #endif
360 #ifdef NO_STRTOUMAX
361 #define strtoumax gitstrtoumax
362 extern uintmax_t gitstrtoumax(const char *, char **, int);
363 #define strtoimax gitstrtoimax
364 extern intmax_t gitstrtoimax(const char *, char **, int);
365 #endif
367 #ifdef NO_STRTOK_R
368 #define strtok_r gitstrtok_r
369 extern char *gitstrtok_r(char *s, const char *delim, char **save_ptr);
370 #endif
372 #ifdef NO_HSTRERROR
373 #define hstrerror githstrerror
374 extern const char *githstrerror(int herror);
375 #endif
377 #ifdef NO_MEMMEM
378 #define memmem gitmemmem
379 void *gitmemmem(const void *haystack, size_t haystacklen,
380 const void *needle, size_t needlelen);
381 #endif
383 #ifdef FREAD_READS_DIRECTORIES
384 #ifdef fopen
385 #undef fopen
386 #endif
387 #define fopen(a,b) git_fopen(a,b)
388 extern FILE *git_fopen(const char*, const char*);
389 #endif
391 #ifdef SNPRINTF_RETURNS_BOGUS
392 #define snprintf git_snprintf
393 extern int git_snprintf(char *str, size_t maxsize,
394 const char *format, ...);
395 #define vsnprintf git_vsnprintf
396 extern int git_vsnprintf(char *str, size_t maxsize,
397 const char *format, va_list ap);
398 #endif
400 #ifdef __GLIBC_PREREQ
401 #if __GLIBC_PREREQ(2, 1)
402 #define HAVE_STRCHRNUL
403 #define HAVE_MEMPCPY
404 #endif
405 #endif
407 #ifndef HAVE_STRCHRNUL
408 #define strchrnul gitstrchrnul
409 static inline char *gitstrchrnul(const char *s, int c)
411 while (*s && *s != c)
412 s++;
413 return (char *)s;
415 #endif
417 #ifndef HAVE_MEMPCPY
418 #define mempcpy gitmempcpy
419 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
421 return (char *)memcpy(dest, src, n) + n;
423 #endif
425 #ifdef NO_INET_PTON
426 int inet_pton(int af, const char *src, void *dst);
427 #endif
429 #ifdef NO_INET_NTOP
430 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
431 #endif
433 extern void release_pack_memory(size_t, int);
435 typedef void (*try_to_free_t)(size_t);
436 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
438 extern char *xstrdup(const char *str);
439 extern void *xmalloc(size_t size);
440 extern void *xmallocz(size_t size);
441 extern void *xmemdupz(const void *data, size_t len);
442 extern char *xstrndup(const char *str, size_t len);
443 extern void *xrealloc(void *ptr, size_t size);
444 extern void *xcalloc(size_t nmemb, size_t size);
445 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
446 extern ssize_t xread(int fd, void *buf, size_t len);
447 extern ssize_t xwrite(int fd, const void *buf, size_t len);
448 extern int xdup(int fd);
449 extern FILE *xfdopen(int fd, const char *mode);
450 extern int xmkstemp(char *template);
451 extern int xmkstemp_mode(char *template, int mode);
452 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
453 extern int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1);
455 static inline size_t xsize_t(off_t len)
457 if (len > (size_t) len)
458 die("Cannot handle files this big");
459 return (size_t)len;
462 static inline int has_extension(const char *filename, const char *ext)
464 size_t len = strlen(filename);
465 size_t extlen = strlen(ext);
466 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
469 /* in ctype.c, for kwset users */
470 extern const char tolower_trans_tbl[256];
472 /* Sane ctype - no locale, and works with signed chars */
473 #undef isascii
474 #undef isspace
475 #undef isdigit
476 #undef isalpha
477 #undef isalnum
478 #undef islower
479 #undef isupper
480 #undef tolower
481 #undef toupper
482 extern unsigned char sane_ctype[256];
483 #define GIT_SPACE 0x01
484 #define GIT_DIGIT 0x02
485 #define GIT_ALPHA 0x04
486 #define GIT_GLOB_SPECIAL 0x08
487 #define GIT_REGEX_SPECIAL 0x10
488 #define GIT_PATHSPEC_MAGIC 0x20
489 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
490 #define isascii(x) (((x) & ~0x7f) == 0)
491 #define isspace(x) sane_istest(x,GIT_SPACE)
492 #define isdigit(x) sane_istest(x,GIT_DIGIT)
493 #define isalpha(x) sane_istest(x,GIT_ALPHA)
494 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
495 #define islower(x) sane_iscase(x, 1)
496 #define isupper(x) sane_iscase(x, 0)
497 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
498 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
499 #define tolower(x) sane_case((unsigned char)(x), 0x20)
500 #define toupper(x) sane_case((unsigned char)(x), 0)
501 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
503 static inline int sane_case(int x, int high)
505 if (sane_istest(x, GIT_ALPHA))
506 x = (x & ~0x20) | high;
507 return x;
510 static inline int sane_iscase(int x, int is_lower)
512 if (!sane_istest(x, GIT_ALPHA))
513 return 0;
515 if (is_lower)
516 return (x & 0x20) != 0;
517 else
518 return (x & 0x20) == 0;
521 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
523 unsigned long ul;
524 char *p;
526 errno = 0;
527 ul = strtoul(s, &p, base);
528 if (errno || *p || p == s || (unsigned int) ul != ul)
529 return -1;
530 *result = ul;
531 return 0;
534 static inline int strtol_i(char const *s, int base, int *result)
536 long ul;
537 char *p;
539 errno = 0;
540 ul = strtol(s, &p, base);
541 if (errno || *p || p == s || (int) ul != ul)
542 return -1;
543 *result = ul;
544 return 0;
547 #ifdef INTERNAL_QSORT
548 void git_qsort(void *base, size_t nmemb, size_t size,
549 int(*compar)(const void *, const void *));
550 #define qsort git_qsort
551 #endif
553 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
554 # define FORCE_DIR_SET_GID S_ISGID
555 #else
556 # define FORCE_DIR_SET_GID 0
557 #endif
559 #ifdef NO_NSEC
560 #undef USE_NSEC
561 #define ST_CTIME_NSEC(st) 0
562 #define ST_MTIME_NSEC(st) 0
563 #else
564 #ifdef USE_ST_TIMESPEC
565 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
566 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
567 #else
568 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
569 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
570 #endif
571 #endif
573 #ifdef UNRELIABLE_FSTAT
574 #define fstat_is_reliable() 0
575 #else
576 #define fstat_is_reliable() 1
577 #endif
579 #ifndef va_copy
581 * Since an obvious implementation of va_list would be to make it a
582 * pointer into the stack frame, a simple assignment will work on
583 * many systems. But let's try to be more portable.
585 #ifdef __va_copy
586 #define va_copy(dst, src) __va_copy(dst, src)
587 #else
588 #define va_copy(dst, src) ((dst) = (src))
589 #endif
590 #endif
593 * Preserves errno, prints a message, but gives no warning for ENOENT.
594 * Always returns the return value of unlink(2).
596 int unlink_or_warn(const char *path);
598 * Likewise for rmdir(2).
600 int rmdir_or_warn(const char *path);
602 * Calls the correct function out of {unlink,rmdir}_or_warn based on
603 * the supplied file mode.
605 int remove_or_warn(unsigned int mode, const char *path);
607 /* Get the passwd entry for the UID of the current process. */
608 struct passwd *xgetpwuid_self(void);
610 #endif