Merge branch 'jk/cherry-pick-docfix' into maint
[git.git] / git-compat-util.h
blob35b3fe0b3be6097bc98516a0469b25c1338fdbca
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) && !defined(__QNX__) && !defined(__MirBSD__) && \
79 !defined(__CYGWIN__)
80 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
81 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
82 #endif
83 #define _ALL_SOURCE 1
84 #define _GNU_SOURCE 1
85 #define _BSD_SOURCE 1
86 #define _DEFAULT_SOURCE 1
87 #define _NETBSD_SOURCE 1
88 #define _SGI_SOURCE 1
90 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
91 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
92 # define _WIN32_WINNT 0x0502
93 # endif
94 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
95 #include <winsock2.h>
96 #include <windows.h>
97 #define GIT_WINDOWS_NATIVE
98 #endif
100 #include <unistd.h>
101 #include <stdio.h>
102 #include <sys/stat.h>
103 #include <fcntl.h>
104 #include <stddef.h>
105 #include <stdlib.h>
106 #include <stdarg.h>
107 #include <string.h>
108 #ifdef HAVE_STRINGS_H
109 #include <strings.h> /* for strcasecmp() */
110 #endif
111 #include <errno.h>
112 #include <limits.h>
113 #ifdef NEEDS_SYS_PARAM_H
114 #include <sys/param.h>
115 #endif
116 #include <sys/types.h>
117 #include <dirent.h>
118 #include <sys/time.h>
119 #include <time.h>
120 #include <signal.h>
121 #include <assert.h>
122 #include <regex.h>
123 #include <utime.h>
124 #include <syslog.h>
125 #ifndef NO_SYS_POLL_H
126 #include <sys/poll.h>
127 #else
128 #include <poll.h>
129 #endif
131 #if defined(__MINGW32__)
132 /* pull in Windows compatibility stuff */
133 #include "compat/mingw.h"
134 #elif defined(_MSC_VER)
135 #include "compat/msvc.h"
136 #else
137 #include <sys/wait.h>
138 #include <sys/resource.h>
139 #include <sys/socket.h>
140 #include <sys/ioctl.h>
141 #include <termios.h>
142 #ifndef NO_SYS_SELECT_H
143 #include <sys/select.h>
144 #endif
145 #include <netinet/in.h>
146 #include <netinet/tcp.h>
147 #include <arpa/inet.h>
148 #include <netdb.h>
149 #include <pwd.h>
150 #include <sys/un.h>
151 #ifndef NO_INTTYPES_H
152 #include <inttypes.h>
153 #else
154 #include <stdint.h>
155 #endif
156 #ifdef NO_INTPTR_T
158 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
159 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
160 * while on IP16 and IP16L32 it is "int" (resp. "short")
161 * Size needs to match (or exceed) 'sizeof(void *)'.
162 * We can't take "long long" here as not everybody has it.
164 typedef long intptr_t;
165 typedef unsigned long uintptr_t;
166 #endif
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
172 /* used on Mac OS X */
173 #ifdef PRECOMPOSE_UNICODE
174 #include "compat/precompose_utf8.h"
175 #else
176 #define precompose_str(in,i_nfd2nfc)
177 #define precompose_argv(c,v)
178 #define probe_utf8_pathname_composition(a,b)
179 #endif
181 #ifdef MKDIR_WO_TRAILING_SLASH
182 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
183 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
184 #endif
186 #ifdef NO_STRUCT_ITIMERVAL
187 struct itimerval {
188 struct timeval it_interval;
189 struct timeval it_value;
191 #endif
193 #ifdef NO_SETITIMER
194 #define setitimer(which,value,ovalue)
195 #endif
197 #ifndef NO_LIBGEN_H
198 #include <libgen.h>
199 #else
200 #define basename gitbasename
201 extern char *gitbasename(char *);
202 #endif
204 #ifndef NO_ICONV
205 #include <iconv.h>
206 #endif
208 #ifndef NO_OPENSSL
209 #ifdef __APPLE__
210 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
211 #include <AvailabilityMacros.h>
212 #undef DEPRECATED_ATTRIBUTE
213 #define DEPRECATED_ATTRIBUTE
214 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
215 #endif
216 #include <openssl/ssl.h>
217 #include <openssl/err.h>
218 #ifdef NO_HMAC_CTX_CLEANUP
219 #define HMAC_CTX_cleanup HMAC_cleanup
220 #endif
221 #endif
223 /* On most systems <netdb.h> would have given us this, but
224 * not on some systems (e.g. z/OS).
226 #ifndef NI_MAXHOST
227 #define NI_MAXHOST 1025
228 #endif
230 #ifndef NI_MAXSERV
231 #define NI_MAXSERV 32
232 #endif
234 /* On most systems <limits.h> would have given us this, but
235 * not on some systems (e.g. GNU/Hurd).
237 #ifndef PATH_MAX
238 #define PATH_MAX 4096
239 #endif
241 #ifndef PRIuMAX
242 #define PRIuMAX "llu"
243 #endif
245 #ifndef PRIu32
246 #define PRIu32 "u"
247 #endif
249 #ifndef PRIx32
250 #define PRIx32 "x"
251 #endif
253 #ifndef PRIo32
254 #define PRIo32 "o"
255 #endif
257 #ifndef PATH_SEP
258 #define PATH_SEP ':'
259 #endif
261 #ifdef HAVE_PATHS_H
262 #include <paths.h>
263 #endif
264 #ifndef _PATH_DEFPATH
265 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
266 #endif
268 #ifndef STRIP_EXTENSION
269 #define STRIP_EXTENSION ""
270 #endif
272 #ifndef has_dos_drive_prefix
273 static inline int git_has_dos_drive_prefix(const char *path)
275 return 0;
277 #define has_dos_drive_prefix git_has_dos_drive_prefix
278 #endif
280 #ifndef is_dir_sep
281 static inline int git_is_dir_sep(int c)
283 return c == '/';
285 #define is_dir_sep git_is_dir_sep
286 #endif
288 #ifndef offset_1st_component
289 static inline int git_offset_1st_component(const char *path)
291 return is_dir_sep(path[0]);
293 #define offset_1st_component git_offset_1st_component
294 #endif
296 #ifndef find_last_dir_sep
297 static inline char *git_find_last_dir_sep(const char *path)
299 return strrchr(path, '/');
301 #define find_last_dir_sep git_find_last_dir_sep
302 #endif
304 #if defined(__HP_cc) && (__HP_cc >= 61000)
305 #define NORETURN __attribute__((noreturn))
306 #define NORETURN_PTR
307 #elif defined(__GNUC__) && !defined(NO_NORETURN)
308 #define NORETURN __attribute__((__noreturn__))
309 #define NORETURN_PTR __attribute__((__noreturn__))
310 #elif defined(_MSC_VER)
311 #define NORETURN __declspec(noreturn)
312 #define NORETURN_PTR
313 #else
314 #define NORETURN
315 #define NORETURN_PTR
316 #ifndef __GNUC__
317 #ifndef __attribute__
318 #define __attribute__(x)
319 #endif
320 #endif
321 #endif
323 /* The sentinel attribute is valid from gcc version 4.0 */
324 #if defined(__GNUC__) && (__GNUC__ >= 4)
325 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
326 #else
327 #define LAST_ARG_MUST_BE_NULL
328 #endif
330 #include "compat/bswap.h"
332 #include "wildmatch.h"
334 struct strbuf;
336 /* General helper functions */
337 extern void vreportf(const char *prefix, const char *err, va_list params);
338 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
339 extern NORETURN void usage(const char *err);
340 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
341 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
342 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
343 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
344 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
346 #ifndef NO_OPENSSL
347 #ifdef APPLE_COMMON_CRYPTO
348 #include "compat/apple-common-crypto.h"
349 #else
350 #include <openssl/evp.h>
351 #include <openssl/hmac.h>
352 #endif /* APPLE_COMMON_CRYPTO */
353 #include <openssl/x509v3.h>
354 #endif /* NO_OPENSSL */
357 * Let callers be aware of the constant return value; this can help
358 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
359 * because some compilers may not support variadic macros. Since we're only
360 * trying to help gcc, anyway, it's OK; other compilers will fall back to
361 * using the function as usual.
363 #if defined(__GNUC__)
364 static inline int const_error(void)
366 return -1;
368 #define error(...) (error(__VA_ARGS__), const_error())
369 #endif
371 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
372 extern void set_error_routine(void (*routine)(const char *err, va_list params));
373 extern void set_die_is_recursing_routine(int (*routine)(void));
375 extern int starts_with(const char *str, const char *prefix);
378 * If the string "str" begins with the string found in "prefix", return 1.
379 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
380 * the string right after the prefix).
382 * Otherwise, return 0 and leave "out" untouched.
384 * Examples:
386 * [extract branch name, fail if not a branch]
387 * if (!skip_prefix(ref, "refs/heads/", &branch)
388 * return -1;
390 * [skip prefix if present, otherwise use whole string]
391 * skip_prefix(name, "refs/heads/", &name);
393 static inline int skip_prefix(const char *str, const char *prefix,
394 const char **out)
396 do {
397 if (!*prefix) {
398 *out = str;
399 return 1;
401 } while (*str++ == *prefix++);
402 return 0;
406 * If buf ends with suffix, return 1 and subtract the length of the suffix
407 * from *len. Otherwise, return 0 and leave *len untouched.
409 static inline int strip_suffix_mem(const char *buf, size_t *len,
410 const char *suffix)
412 size_t suflen = strlen(suffix);
413 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
414 return 0;
415 *len -= suflen;
416 return 1;
420 * If str ends with suffix, return 1 and set *len to the size of the string
421 * without the suffix. Otherwise, return 0 and set *len to the size of the
422 * string.
424 * Note that we do _not_ NUL-terminate str to the new length.
426 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
428 *len = strlen(str);
429 return strip_suffix_mem(str, len, suffix);
432 static inline int ends_with(const char *str, const char *suffix)
434 size_t len;
435 return strip_suffix(str, suffix, &len);
438 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
440 #ifndef PROT_READ
441 #define PROT_READ 1
442 #define PROT_WRITE 2
443 #define MAP_PRIVATE 1
444 #endif
446 #define mmap git_mmap
447 #define munmap git_munmap
448 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
449 extern int git_munmap(void *start, size_t length);
451 #else /* NO_MMAP || USE_WIN32_MMAP */
453 #include <sys/mman.h>
455 #endif /* NO_MMAP || USE_WIN32_MMAP */
457 #ifdef NO_MMAP
459 /* This value must be multiple of (pagesize * 2) */
460 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
462 #else /* NO_MMAP */
464 /* This value must be multiple of (pagesize * 2) */
465 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
466 (sizeof(void*) >= 8 \
467 ? 1 * 1024 * 1024 * 1024 \
468 : 32 * 1024 * 1024)
470 #endif /* NO_MMAP */
472 #ifndef MAP_FAILED
473 #define MAP_FAILED ((void *)-1)
474 #endif
476 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
477 #define on_disk_bytes(st) ((st).st_size)
478 #else
479 #define on_disk_bytes(st) ((st).st_blocks * 512)
480 #endif
482 #ifdef NEEDS_MODE_TRANSLATION
483 #undef S_IFMT
484 #undef S_IFREG
485 #undef S_IFDIR
486 #undef S_IFLNK
487 #undef S_IFBLK
488 #undef S_IFCHR
489 #undef S_IFIFO
490 #undef S_IFSOCK
491 #define S_IFMT 0170000
492 #define S_IFREG 0100000
493 #define S_IFDIR 0040000
494 #define S_IFLNK 0120000
495 #define S_IFBLK 0060000
496 #define S_IFCHR 0020000
497 #define S_IFIFO 0010000
498 #define S_IFSOCK 0140000
499 #ifdef stat
500 #undef stat
501 #endif
502 #define stat(path, buf) git_stat(path, buf)
503 extern int git_stat(const char *, struct stat *);
504 #ifdef fstat
505 #undef fstat
506 #endif
507 #define fstat(fd, buf) git_fstat(fd, buf)
508 extern int git_fstat(int, struct stat *);
509 #ifdef lstat
510 #undef lstat
511 #endif
512 #define lstat(path, buf) git_lstat(path, buf)
513 extern int git_lstat(const char *, struct stat *);
514 #endif
516 #define DEFAULT_PACKED_GIT_LIMIT \
517 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
519 #ifdef NO_PREAD
520 #define pread git_pread
521 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
522 #endif
524 * Forward decl that will remind us if its twin in cache.h changes.
525 * This function is used in compat/pread.c. But we can't include
526 * cache.h there.
528 extern ssize_t read_in_full(int fd, void *buf, size_t count);
530 #ifdef NO_SETENV
531 #define setenv gitsetenv
532 extern int gitsetenv(const char *, const char *, int);
533 #endif
535 #ifdef NO_MKDTEMP
536 #define mkdtemp gitmkdtemp
537 extern char *gitmkdtemp(char *);
538 #endif
540 #ifdef NO_MKSTEMPS
541 #define mkstemps gitmkstemps
542 extern int gitmkstemps(char *, int);
543 #endif
545 #ifdef NO_UNSETENV
546 #define unsetenv gitunsetenv
547 extern void gitunsetenv(const char *);
548 #endif
550 #ifdef NO_STRCASESTR
551 #define strcasestr gitstrcasestr
552 extern char *gitstrcasestr(const char *haystack, const char *needle);
553 #endif
555 #ifdef NO_STRLCPY
556 #define strlcpy gitstrlcpy
557 extern size_t gitstrlcpy(char *, const char *, size_t);
558 #endif
560 #ifdef NO_STRTOUMAX
561 #define strtoumax gitstrtoumax
562 extern uintmax_t gitstrtoumax(const char *, char **, int);
563 #define strtoimax gitstrtoimax
564 extern intmax_t gitstrtoimax(const char *, char **, int);
565 #endif
567 #ifdef NO_HSTRERROR
568 #define hstrerror githstrerror
569 extern const char *githstrerror(int herror);
570 #endif
572 #ifdef NO_MEMMEM
573 #define memmem gitmemmem
574 void *gitmemmem(const void *haystack, size_t haystacklen,
575 const void *needle, size_t needlelen);
576 #endif
578 #ifdef NO_GETPAGESIZE
579 #define getpagesize() sysconf(_SC_PAGESIZE)
580 #endif
582 #ifdef FREAD_READS_DIRECTORIES
583 #ifdef fopen
584 #undef fopen
585 #endif
586 #define fopen(a,b) git_fopen(a,b)
587 extern FILE *git_fopen(const char*, const char*);
588 #endif
590 #ifdef SNPRINTF_RETURNS_BOGUS
591 #ifdef snprintf
592 #undef snprintf
593 #endif
594 #define snprintf git_snprintf
595 extern int git_snprintf(char *str, size_t maxsize,
596 const char *format, ...);
597 #ifdef vsnprintf
598 #undef vsnprintf
599 #endif
600 #define vsnprintf git_vsnprintf
601 extern int git_vsnprintf(char *str, size_t maxsize,
602 const char *format, va_list ap);
603 #endif
605 #ifdef __GLIBC_PREREQ
606 #if __GLIBC_PREREQ(2, 1)
607 #define HAVE_STRCHRNUL
608 #define HAVE_MEMPCPY
609 #endif
610 #endif
612 #ifndef HAVE_STRCHRNUL
613 #define strchrnul gitstrchrnul
614 static inline char *gitstrchrnul(const char *s, int c)
616 while (*s && *s != c)
617 s++;
618 return (char *)s;
620 #endif
622 #ifndef HAVE_MEMPCPY
623 #define mempcpy gitmempcpy
624 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
626 return (char *)memcpy(dest, src, n) + n;
628 #endif
630 #ifdef NO_INET_PTON
631 int inet_pton(int af, const char *src, void *dst);
632 #endif
634 #ifdef NO_INET_NTOP
635 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
636 #endif
638 #ifdef NO_PTHREADS
639 #define atexit git_atexit
640 extern int git_atexit(void (*handler)(void));
641 #endif
643 extern void release_pack_memory(size_t);
645 typedef void (*try_to_free_t)(size_t);
646 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
648 #ifdef HAVE_ALLOCA_H
649 # include <alloca.h>
650 # define xalloca(size) (alloca(size))
651 # define xalloca_free(p) do {} while (0)
652 #else
653 # define xalloca(size) (xmalloc(size))
654 # define xalloca_free(p) (free(p))
655 #endif
656 extern char *xstrdup(const char *str);
657 extern void *xmalloc(size_t size);
658 extern void *xmallocz(size_t size);
659 extern void *xmallocz_gently(size_t size);
660 extern void *xmemdupz(const void *data, size_t len);
661 extern char *xstrndup(const char *str, size_t len);
662 extern void *xrealloc(void *ptr, size_t size);
663 extern void *xcalloc(size_t nmemb, size_t size);
664 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
665 extern ssize_t xread(int fd, void *buf, size_t len);
666 extern ssize_t xwrite(int fd, const void *buf, size_t len);
667 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
668 extern int xdup(int fd);
669 extern FILE *xfdopen(int fd, const char *mode);
670 extern int xmkstemp(char *template);
671 extern int xmkstemp_mode(char *template, int mode);
672 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
673 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
674 extern char *xgetcwd(void);
676 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
678 static inline char *xstrdup_or_null(const char *str)
680 return str ? xstrdup(str) : NULL;
683 static inline size_t xsize_t(off_t len)
685 if (len > (size_t) len)
686 die("Cannot handle files this big");
687 return (size_t)len;
690 /* in ctype.c, for kwset users */
691 extern const unsigned char tolower_trans_tbl[256];
693 /* Sane ctype - no locale, and works with signed chars */
694 #undef isascii
695 #undef isspace
696 #undef isdigit
697 #undef isalpha
698 #undef isalnum
699 #undef isprint
700 #undef islower
701 #undef isupper
702 #undef tolower
703 #undef toupper
704 #undef iscntrl
705 #undef ispunct
706 #undef isxdigit
708 extern const unsigned char sane_ctype[256];
709 #define GIT_SPACE 0x01
710 #define GIT_DIGIT 0x02
711 #define GIT_ALPHA 0x04
712 #define GIT_GLOB_SPECIAL 0x08
713 #define GIT_REGEX_SPECIAL 0x10
714 #define GIT_PATHSPEC_MAGIC 0x20
715 #define GIT_CNTRL 0x40
716 #define GIT_PUNCT 0x80
717 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
718 #define isascii(x) (((x) & ~0x7f) == 0)
719 #define isspace(x) sane_istest(x,GIT_SPACE)
720 #define isdigit(x) sane_istest(x,GIT_DIGIT)
721 #define isalpha(x) sane_istest(x,GIT_ALPHA)
722 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
723 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
724 #define islower(x) sane_iscase(x, 1)
725 #define isupper(x) sane_iscase(x, 0)
726 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
727 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
728 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
729 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
730 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
731 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
732 #define tolower(x) sane_case((unsigned char)(x), 0x20)
733 #define toupper(x) sane_case((unsigned char)(x), 0)
734 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
736 static inline int sane_case(int x, int high)
738 if (sane_istest(x, GIT_ALPHA))
739 x = (x & ~0x20) | high;
740 return x;
743 static inline int sane_iscase(int x, int is_lower)
745 if (!sane_istest(x, GIT_ALPHA))
746 return 0;
748 if (is_lower)
749 return (x & 0x20) != 0;
750 else
751 return (x & 0x20) == 0;
754 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
756 unsigned long ul;
757 char *p;
759 errno = 0;
760 ul = strtoul(s, &p, base);
761 if (errno || *p || p == s || (unsigned int) ul != ul)
762 return -1;
763 *result = ul;
764 return 0;
767 static inline int strtol_i(char const *s, int base, int *result)
769 long ul;
770 char *p;
772 errno = 0;
773 ul = strtol(s, &p, base);
774 if (errno || *p || p == s || (int) ul != ul)
775 return -1;
776 *result = ul;
777 return 0;
780 #ifdef INTERNAL_QSORT
781 void git_qsort(void *base, size_t nmemb, size_t size,
782 int(*compar)(const void *, const void *));
783 #define qsort git_qsort
784 #endif
786 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
787 # define FORCE_DIR_SET_GID S_ISGID
788 #else
789 # define FORCE_DIR_SET_GID 0
790 #endif
792 #ifdef NO_NSEC
793 #undef USE_NSEC
794 #define ST_CTIME_NSEC(st) 0
795 #define ST_MTIME_NSEC(st) 0
796 #else
797 #ifdef USE_ST_TIMESPEC
798 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
799 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
800 #else
801 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
802 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
803 #endif
804 #endif
806 #ifdef UNRELIABLE_FSTAT
807 #define fstat_is_reliable() 0
808 #else
809 #define fstat_is_reliable() 1
810 #endif
812 #ifndef va_copy
814 * Since an obvious implementation of va_list would be to make it a
815 * pointer into the stack frame, a simple assignment will work on
816 * many systems. But let's try to be more portable.
818 #ifdef __va_copy
819 #define va_copy(dst, src) __va_copy(dst, src)
820 #else
821 #define va_copy(dst, src) ((dst) = (src))
822 #endif
823 #endif
825 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
826 #define HAVE_VARIADIC_MACROS 1
827 #endif
830 * Preserves errno, prints a message, but gives no warning for ENOENT.
831 * Returns 0 on success, which includes trying to unlink an object that does
832 * not exist.
834 int unlink_or_warn(const char *path);
836 * Tries to unlink file. Returns 0 if unlink succeeded
837 * or the file already didn't exist. Returns -1 and
838 * appends a message to err suitable for
839 * 'error("%s", err->buf)' on error.
841 int unlink_or_msg(const char *file, struct strbuf *err);
843 * Preserves errno, prints a message, but gives no warning for ENOENT.
844 * Returns 0 on success, which includes trying to remove a directory that does
845 * not exist.
847 int rmdir_or_warn(const char *path);
849 * Calls the correct function out of {unlink,rmdir}_or_warn based on
850 * the supplied file mode.
852 int remove_or_warn(unsigned int mode, const char *path);
855 * Call access(2), but warn for any error except "missing file"
856 * (ENOENT or ENOTDIR).
858 #define ACCESS_EACCES_OK (1U << 0)
859 int access_or_warn(const char *path, int mode, unsigned flag);
860 int access_or_die(const char *path, int mode, unsigned flag);
862 /* Warn on an inaccessible file that ought to be accessible */
863 void warn_on_inaccessible(const char *path);
865 /* Get the passwd entry for the UID of the current process. */
866 struct passwd *xgetpwuid_self(void);
868 #ifdef GMTIME_UNRELIABLE_ERRORS
869 struct tm *git_gmtime(const time_t *);
870 struct tm *git_gmtime_r(const time_t *, struct tm *);
871 #define gmtime git_gmtime
872 #define gmtime_r git_gmtime_r
873 #endif
875 #endif