reflog: improve and update documentation
[git.git] / git-compat-util.h
blobeb9b0ff32829ef62bf2d1af432742841b9720906
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 #if defined(__CYGWIN__)
168 #undef _XOPEN_SOURCE
169 #include <grp.h>
170 #define _XOPEN_SOURCE 600
171 #else
172 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
173 #include <grp.h>
174 #define _ALL_SOURCE 1
175 #endif
176 #endif
178 /* used on Mac OS X */
179 #ifdef PRECOMPOSE_UNICODE
180 #include "compat/precompose_utf8.h"
181 #else
182 #define precompose_str(in,i_nfd2nfc)
183 #define precompose_argv(c,v)
184 #define probe_utf8_pathname_composition(a,b)
185 #endif
187 #ifdef MKDIR_WO_TRAILING_SLASH
188 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
189 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
190 #endif
192 #ifdef NO_STRUCT_ITIMERVAL
193 struct itimerval {
194 struct timeval it_interval;
195 struct timeval it_value;
197 #endif
199 #ifdef NO_SETITIMER
200 #define setitimer(which,value,ovalue)
201 #endif
203 #ifndef NO_LIBGEN_H
204 #include <libgen.h>
205 #else
206 #define basename gitbasename
207 extern char *gitbasename(char *);
208 #endif
210 #ifndef NO_ICONV
211 #include <iconv.h>
212 #endif
214 #ifndef NO_OPENSSL
215 #define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
216 #define MAC_OS_X_VERSION_MIN_REQUIRED MAC_OS_X_VERSION_10_6
217 #include <openssl/ssl.h>
218 #include <openssl/err.h>
219 #undef MAC_OS_X_VERSION_MIN_REQUIRED
220 #undef __AVAILABILITY_MACROS_USES_AVAILABILITY
221 #ifdef NO_HMAC_CTX_CLEANUP
222 #define HMAC_CTX_cleanup HMAC_cleanup
223 #endif
224 #endif
226 /* On most systems <netdb.h> would have given us this, but
227 * not on some systems (e.g. z/OS).
229 #ifndef NI_MAXHOST
230 #define NI_MAXHOST 1025
231 #endif
233 #ifndef NI_MAXSERV
234 #define NI_MAXSERV 32
235 #endif
237 /* On most systems <limits.h> would have given us this, but
238 * not on some systems (e.g. GNU/Hurd).
240 #ifndef PATH_MAX
241 #define PATH_MAX 4096
242 #endif
244 #ifndef PRIuMAX
245 #define PRIuMAX "llu"
246 #endif
248 #ifndef PRIu32
249 #define PRIu32 "u"
250 #endif
252 #ifndef PRIx32
253 #define PRIx32 "x"
254 #endif
256 #ifndef PRIo32
257 #define PRIo32 "o"
258 #endif
260 #ifndef PATH_SEP
261 #define PATH_SEP ':'
262 #endif
264 #ifdef HAVE_PATHS_H
265 #include <paths.h>
266 #endif
267 #ifndef _PATH_DEFPATH
268 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
269 #endif
271 #ifndef STRIP_EXTENSION
272 #define STRIP_EXTENSION ""
273 #endif
275 #ifndef has_dos_drive_prefix
276 static inline int git_has_dos_drive_prefix(const char *path)
278 return 0;
280 #define has_dos_drive_prefix git_has_dos_drive_prefix
281 #endif
283 #ifndef is_dir_sep
284 static inline int git_is_dir_sep(int c)
286 return c == '/';
288 #define is_dir_sep git_is_dir_sep
289 #endif
291 #ifndef offset_1st_component
292 static inline int git_offset_1st_component(const char *path)
294 return is_dir_sep(path[0]);
296 #define offset_1st_component git_offset_1st_component
297 #endif
299 #ifndef find_last_dir_sep
300 static inline char *git_find_last_dir_sep(const char *path)
302 return strrchr(path, '/');
304 #define find_last_dir_sep git_find_last_dir_sep
305 #endif
307 #if defined(__HP_cc) && (__HP_cc >= 61000)
308 #define NORETURN __attribute__((noreturn))
309 #define NORETURN_PTR
310 #elif defined(__GNUC__) && !defined(NO_NORETURN)
311 #define NORETURN __attribute__((__noreturn__))
312 #define NORETURN_PTR __attribute__((__noreturn__))
313 #elif defined(_MSC_VER)
314 #define NORETURN __declspec(noreturn)
315 #define NORETURN_PTR
316 #else
317 #define NORETURN
318 #define NORETURN_PTR
319 #ifndef __GNUC__
320 #ifndef __attribute__
321 #define __attribute__(x)
322 #endif
323 #endif
324 #endif
326 /* The sentinel attribute is valid from gcc version 4.0 */
327 #if defined(__GNUC__) && (__GNUC__ >= 4)
328 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
329 #else
330 #define LAST_ARG_MUST_BE_NULL
331 #endif
333 #include "compat/bswap.h"
335 #include "wildmatch.h"
337 struct strbuf;
339 /* General helper functions */
340 extern void vreportf(const char *prefix, const char *err, va_list params);
341 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
342 extern NORETURN void usage(const char *err);
343 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
344 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
345 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
346 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
347 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
349 #ifndef NO_OPENSSL
350 #ifdef APPLE_COMMON_CRYPTO
351 #include "compat/apple-common-crypto.h"
352 #else
353 #include <openssl/evp.h>
354 #include <openssl/hmac.h>
355 #endif /* APPLE_COMMON_CRYPTO */
356 #include <openssl/x509v3.h>
357 #endif /* NO_OPENSSL */
360 * Let callers be aware of the constant return value; this can help
361 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
362 * because some compilers may not support variadic macros. Since we're only
363 * trying to help gcc, anyway, it's OK; other compilers will fall back to
364 * using the function as usual.
366 #if defined(__GNUC__)
367 static inline int const_error(void)
369 return -1;
371 #define error(...) (error(__VA_ARGS__), const_error())
372 #endif
374 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
375 extern void set_error_routine(void (*routine)(const char *err, va_list params));
376 extern void set_die_is_recursing_routine(int (*routine)(void));
378 extern int starts_with(const char *str, const char *prefix);
381 * If the string "str" begins with the string found in "prefix", return 1.
382 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
383 * the string right after the prefix).
385 * Otherwise, return 0 and leave "out" untouched.
387 * Examples:
389 * [extract branch name, fail if not a branch]
390 * if (!skip_prefix(ref, "refs/heads/", &branch)
391 * return -1;
393 * [skip prefix if present, otherwise use whole string]
394 * skip_prefix(name, "refs/heads/", &name);
396 static inline int skip_prefix(const char *str, const char *prefix,
397 const char **out)
399 do {
400 if (!*prefix) {
401 *out = str;
402 return 1;
404 } while (*str++ == *prefix++);
405 return 0;
409 * If buf ends with suffix, return 1 and subtract the length of the suffix
410 * from *len. Otherwise, return 0 and leave *len untouched.
412 static inline int strip_suffix_mem(const char *buf, size_t *len,
413 const char *suffix)
415 size_t suflen = strlen(suffix);
416 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
417 return 0;
418 *len -= suflen;
419 return 1;
423 * If str ends with suffix, return 1 and set *len to the size of the string
424 * without the suffix. Otherwise, return 0 and set *len to the size of the
425 * string.
427 * Note that we do _not_ NUL-terminate str to the new length.
429 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
431 *len = strlen(str);
432 return strip_suffix_mem(str, len, suffix);
435 static inline int ends_with(const char *str, const char *suffix)
437 size_t len;
438 return strip_suffix(str, suffix, &len);
441 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
443 #ifndef PROT_READ
444 #define PROT_READ 1
445 #define PROT_WRITE 2
446 #define MAP_PRIVATE 1
447 #endif
449 #define mmap git_mmap
450 #define munmap git_munmap
451 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
452 extern int git_munmap(void *start, size_t length);
454 #else /* NO_MMAP || USE_WIN32_MMAP */
456 #include <sys/mman.h>
458 #endif /* NO_MMAP || USE_WIN32_MMAP */
460 #ifdef NO_MMAP
462 /* This value must be multiple of (pagesize * 2) */
463 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
465 #else /* NO_MMAP */
467 /* This value must be multiple of (pagesize * 2) */
468 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
469 (sizeof(void*) >= 8 \
470 ? 1 * 1024 * 1024 * 1024 \
471 : 32 * 1024 * 1024)
473 #endif /* NO_MMAP */
475 #ifndef MAP_FAILED
476 #define MAP_FAILED ((void *)-1)
477 #endif
479 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
480 #define on_disk_bytes(st) ((st).st_size)
481 #else
482 #define on_disk_bytes(st) ((st).st_blocks * 512)
483 #endif
485 #ifdef NEEDS_MODE_TRANSLATION
486 #undef S_IFMT
487 #undef S_IFREG
488 #undef S_IFDIR
489 #undef S_IFLNK
490 #undef S_IFBLK
491 #undef S_IFCHR
492 #undef S_IFIFO
493 #undef S_IFSOCK
494 #define S_IFMT 0170000
495 #define S_IFREG 0100000
496 #define S_IFDIR 0040000
497 #define S_IFLNK 0120000
498 #define S_IFBLK 0060000
499 #define S_IFCHR 0020000
500 #define S_IFIFO 0010000
501 #define S_IFSOCK 0140000
502 #ifdef stat
503 #undef stat
504 #endif
505 #define stat(path, buf) git_stat(path, buf)
506 extern int git_stat(const char *, struct stat *);
507 #ifdef fstat
508 #undef fstat
509 #endif
510 #define fstat(fd, buf) git_fstat(fd, buf)
511 extern int git_fstat(int, struct stat *);
512 #ifdef lstat
513 #undef lstat
514 #endif
515 #define lstat(path, buf) git_lstat(path, buf)
516 extern int git_lstat(const char *, struct stat *);
517 #endif
519 #define DEFAULT_PACKED_GIT_LIMIT \
520 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
522 #ifdef NO_PREAD
523 #define pread git_pread
524 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
525 #endif
527 * Forward decl that will remind us if its twin in cache.h changes.
528 * This function is used in compat/pread.c. But we can't include
529 * cache.h there.
531 extern ssize_t read_in_full(int fd, void *buf, size_t count);
533 #ifdef NO_SETENV
534 #define setenv gitsetenv
535 extern int gitsetenv(const char *, const char *, int);
536 #endif
538 #ifdef NO_MKDTEMP
539 #define mkdtemp gitmkdtemp
540 extern char *gitmkdtemp(char *);
541 #endif
543 #ifdef NO_MKSTEMPS
544 #define mkstemps gitmkstemps
545 extern int gitmkstemps(char *, int);
546 #endif
548 #ifdef NO_UNSETENV
549 #define unsetenv gitunsetenv
550 extern void gitunsetenv(const char *);
551 #endif
553 #ifdef NO_STRCASESTR
554 #define strcasestr gitstrcasestr
555 extern char *gitstrcasestr(const char *haystack, const char *needle);
556 #endif
558 #ifdef NO_STRLCPY
559 #define strlcpy gitstrlcpy
560 extern size_t gitstrlcpy(char *, const char *, size_t);
561 #endif
563 #ifdef NO_STRTOUMAX
564 #define strtoumax gitstrtoumax
565 extern uintmax_t gitstrtoumax(const char *, char **, int);
566 #define strtoimax gitstrtoimax
567 extern intmax_t gitstrtoimax(const char *, char **, int);
568 #endif
570 #ifdef NO_HSTRERROR
571 #define hstrerror githstrerror
572 extern const char *githstrerror(int herror);
573 #endif
575 #ifdef NO_MEMMEM
576 #define memmem gitmemmem
577 void *gitmemmem(const void *haystack, size_t haystacklen,
578 const void *needle, size_t needlelen);
579 #endif
581 #ifdef NO_GETPAGESIZE
582 #define getpagesize() sysconf(_SC_PAGESIZE)
583 #endif
585 #ifdef FREAD_READS_DIRECTORIES
586 #ifdef fopen
587 #undef fopen
588 #endif
589 #define fopen(a,b) git_fopen(a,b)
590 extern FILE *git_fopen(const char*, const char*);
591 #endif
593 #ifdef SNPRINTF_RETURNS_BOGUS
594 #ifdef snprintf
595 #undef snprintf
596 #endif
597 #define snprintf git_snprintf
598 extern int git_snprintf(char *str, size_t maxsize,
599 const char *format, ...);
600 #ifdef vsnprintf
601 #undef vsnprintf
602 #endif
603 #define vsnprintf git_vsnprintf
604 extern int git_vsnprintf(char *str, size_t maxsize,
605 const char *format, va_list ap);
606 #endif
608 #ifdef __GLIBC_PREREQ
609 #if __GLIBC_PREREQ(2, 1)
610 #define HAVE_STRCHRNUL
611 #define HAVE_MEMPCPY
612 #endif
613 #endif
615 #ifndef HAVE_STRCHRNUL
616 #define strchrnul gitstrchrnul
617 static inline char *gitstrchrnul(const char *s, int c)
619 while (*s && *s != c)
620 s++;
621 return (char *)s;
623 #endif
625 #ifndef HAVE_MEMPCPY
626 #define mempcpy gitmempcpy
627 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
629 return (char *)memcpy(dest, src, n) + n;
631 #endif
633 #ifdef NO_INET_PTON
634 int inet_pton(int af, const char *src, void *dst);
635 #endif
637 #ifdef NO_INET_NTOP
638 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
639 #endif
641 #ifdef NO_PTHREADS
642 #define atexit git_atexit
643 extern int git_atexit(void (*handler)(void));
644 #endif
646 extern void release_pack_memory(size_t);
648 typedef void (*try_to_free_t)(size_t);
649 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
651 #ifdef HAVE_ALLOCA_H
652 # include <alloca.h>
653 # define xalloca(size) (alloca(size))
654 # define xalloca_free(p) do {} while (0)
655 #else
656 # define xalloca(size) (xmalloc(size))
657 # define xalloca_free(p) (free(p))
658 #endif
659 extern char *xstrdup(const char *str);
660 extern void *xmalloc(size_t size);
661 extern void *xmallocz(size_t size);
662 extern void *xmallocz_gently(size_t size);
663 extern void *xmemdupz(const void *data, size_t len);
664 extern char *xstrndup(const char *str, size_t len);
665 extern void *xrealloc(void *ptr, size_t size);
666 extern void *xcalloc(size_t nmemb, size_t size);
667 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
668 extern ssize_t xread(int fd, void *buf, size_t len);
669 extern ssize_t xwrite(int fd, const void *buf, size_t len);
670 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
671 extern int xdup(int fd);
672 extern FILE *xfdopen(int fd, const char *mode);
673 extern int xmkstemp(char *template);
674 extern int xmkstemp_mode(char *template, int mode);
675 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
676 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
677 extern char *xgetcwd(void);
679 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
681 static inline size_t xsize_t(off_t len)
683 if (len > (size_t) len)
684 die("Cannot handle files this big");
685 return (size_t)len;
688 /* in ctype.c, for kwset users */
689 extern const char tolower_trans_tbl[256];
691 /* Sane ctype - no locale, and works with signed chars */
692 #undef isascii
693 #undef isspace
694 #undef isdigit
695 #undef isalpha
696 #undef isalnum
697 #undef isprint
698 #undef islower
699 #undef isupper
700 #undef tolower
701 #undef toupper
702 #undef iscntrl
703 #undef ispunct
704 #undef isxdigit
706 extern const unsigned char sane_ctype[256];
707 #define GIT_SPACE 0x01
708 #define GIT_DIGIT 0x02
709 #define GIT_ALPHA 0x04
710 #define GIT_GLOB_SPECIAL 0x08
711 #define GIT_REGEX_SPECIAL 0x10
712 #define GIT_PATHSPEC_MAGIC 0x20
713 #define GIT_CNTRL 0x40
714 #define GIT_PUNCT 0x80
715 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
716 #define isascii(x) (((x) & ~0x7f) == 0)
717 #define isspace(x) sane_istest(x,GIT_SPACE)
718 #define isdigit(x) sane_istest(x,GIT_DIGIT)
719 #define isalpha(x) sane_istest(x,GIT_ALPHA)
720 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
721 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
722 #define islower(x) sane_iscase(x, 1)
723 #define isupper(x) sane_iscase(x, 0)
724 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
725 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
726 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
727 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
728 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
729 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
730 #define tolower(x) sane_case((unsigned char)(x), 0x20)
731 #define toupper(x) sane_case((unsigned char)(x), 0)
732 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
734 static inline int sane_case(int x, int high)
736 if (sane_istest(x, GIT_ALPHA))
737 x = (x & ~0x20) | high;
738 return x;
741 static inline int sane_iscase(int x, int is_lower)
743 if (!sane_istest(x, GIT_ALPHA))
744 return 0;
746 if (is_lower)
747 return (x & 0x20) != 0;
748 else
749 return (x & 0x20) == 0;
752 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
754 unsigned long ul;
755 char *p;
757 errno = 0;
758 ul = strtoul(s, &p, base);
759 if (errno || *p || p == s || (unsigned int) ul != ul)
760 return -1;
761 *result = ul;
762 return 0;
765 static inline int strtol_i(char const *s, int base, int *result)
767 long ul;
768 char *p;
770 errno = 0;
771 ul = strtol(s, &p, base);
772 if (errno || *p || p == s || (int) ul != ul)
773 return -1;
774 *result = ul;
775 return 0;
778 #ifdef INTERNAL_QSORT
779 void git_qsort(void *base, size_t nmemb, size_t size,
780 int(*compar)(const void *, const void *));
781 #define qsort git_qsort
782 #endif
784 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
785 # define FORCE_DIR_SET_GID S_ISGID
786 #else
787 # define FORCE_DIR_SET_GID 0
788 #endif
790 #ifdef NO_NSEC
791 #undef USE_NSEC
792 #define ST_CTIME_NSEC(st) 0
793 #define ST_MTIME_NSEC(st) 0
794 #else
795 #ifdef USE_ST_TIMESPEC
796 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
797 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
798 #else
799 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
800 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
801 #endif
802 #endif
804 #ifdef UNRELIABLE_FSTAT
805 #define fstat_is_reliable() 0
806 #else
807 #define fstat_is_reliable() 1
808 #endif
810 #ifndef va_copy
812 * Since an obvious implementation of va_list would be to make it a
813 * pointer into the stack frame, a simple assignment will work on
814 * many systems. But let's try to be more portable.
816 #ifdef __va_copy
817 #define va_copy(dst, src) __va_copy(dst, src)
818 #else
819 #define va_copy(dst, src) ((dst) = (src))
820 #endif
821 #endif
823 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
824 #define HAVE_VARIADIC_MACROS 1
825 #endif
828 * Preserves errno, prints a message, but gives no warning for ENOENT.
829 * Returns 0 on success, which includes trying to unlink an object that does
830 * not exist.
832 int unlink_or_warn(const char *path);
834 * Tries to unlink file. Returns 0 if unlink succeeded
835 * or the file already didn't exist. Returns -1 and
836 * appends a message to err suitable for
837 * 'error("%s", err->buf)' on error.
839 int unlink_or_msg(const char *file, struct strbuf *err);
841 * Preserves errno, prints a message, but gives no warning for ENOENT.
842 * Returns 0 on success, which includes trying to remove a directory that does
843 * not exist.
845 int rmdir_or_warn(const char *path);
847 * Calls the correct function out of {unlink,rmdir}_or_warn based on
848 * the supplied file mode.
850 int remove_or_warn(unsigned int mode, const char *path);
853 * Call access(2), but warn for any error except "missing file"
854 * (ENOENT or ENOTDIR).
856 #define ACCESS_EACCES_OK (1U << 0)
857 int access_or_warn(const char *path, int mode, unsigned flag);
858 int access_or_die(const char *path, int mode, unsigned flag);
860 /* Warn on an inaccessible file that ought to be accessible */
861 void warn_on_inaccessible(const char *path);
863 /* Get the passwd entry for the UID of the current process. */
864 struct passwd *xgetpwuid_self(void);
866 #ifdef GMTIME_UNRELIABLE_ERRORS
867 struct tm *git_gmtime(const time_t *);
868 struct tm *git_gmtime_r(const time_t *, struct tm *);
869 #define gmtime git_gmtime
870 #define gmtime_r git_gmtime_r
871 #endif
873 #endif