Documentation/describe: improve one-line summary
[git.git] / git-compat-util.h
blob400e92108687e31dd16fbcea1a43e04556b98566
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 #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 _DEFAULT_SOURCE 1
86 #define _NETBSD_SOURCE 1
87 #define _SGI_SOURCE 1
89 #if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
90 # if defined (_MSC_VER) && !defined(_WIN32_WINNT)
91 # define _WIN32_WINNT 0x0502
92 # endif
93 #define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
94 #include <winsock2.h>
95 #include <windows.h>
96 #define GIT_WINDOWS_NATIVE
97 #endif
99 #include <unistd.h>
100 #include <stdio.h>
101 #include <sys/stat.h>
102 #include <fcntl.h>
103 #include <stddef.h>
104 #include <stdlib.h>
105 #include <stdarg.h>
106 #include <string.h>
107 #ifdef HAVE_STRINGS_H
108 #include <strings.h> /* for strcasecmp() */
109 #endif
110 #include <errno.h>
111 #include <limits.h>
112 #ifdef NEEDS_SYS_PARAM_H
113 #include <sys/param.h>
114 #endif
115 #include <sys/types.h>
116 #include <dirent.h>
117 #include <sys/time.h>
118 #include <time.h>
119 #include <signal.h>
120 #include <assert.h>
121 #include <regex.h>
122 #include <utime.h>
123 #include <syslog.h>
124 #ifndef NO_SYS_POLL_H
125 #include <sys/poll.h>
126 #else
127 #include <poll.h>
128 #endif
130 #if defined(__MINGW32__)
131 /* pull in Windows compatibility stuff */
132 #include "compat/mingw.h"
133 #elif defined(_MSC_VER)
134 #include "compat/msvc.h"
135 #else
136 #include <sys/wait.h>
137 #include <sys/resource.h>
138 #include <sys/socket.h>
139 #include <sys/ioctl.h>
140 #include <termios.h>
141 #ifndef NO_SYS_SELECT_H
142 #include <sys/select.h>
143 #endif
144 #include <netinet/in.h>
145 #include <netinet/tcp.h>
146 #include <arpa/inet.h>
147 #include <netdb.h>
148 #include <pwd.h>
149 #include <sys/un.h>
150 #ifndef NO_INTTYPES_H
151 #include <inttypes.h>
152 #else
153 #include <stdint.h>
154 #endif
155 #ifdef NO_INTPTR_T
157 * On I16LP32, ILP32 and LP64 "long" is the save bet, however
158 * on LLP86, IL33LLP64 and P64 it needs to be "long long",
159 * while on IP16 and IP16L32 it is "int" (resp. "short")
160 * Size needs to match (or exceed) 'sizeof(void *)'.
161 * We can't take "long long" here as not everybody has it.
163 typedef long intptr_t;
164 typedef unsigned long uintptr_t;
165 #endif
166 #if defined(__CYGWIN__)
167 #undef _XOPEN_SOURCE
168 #include <grp.h>
169 #define _XOPEN_SOURCE 600
170 #else
171 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
172 #include <grp.h>
173 #define _ALL_SOURCE 1
174 #endif
175 #endif
177 /* used on Mac OS X */
178 #ifdef PRECOMPOSE_UNICODE
179 #include "compat/precompose_utf8.h"
180 #else
181 #define precompose_str(in,i_nfd2nfc)
182 #define precompose_argv(c,v)
183 #define probe_utf8_pathname_composition(a,b)
184 #endif
186 #ifdef MKDIR_WO_TRAILING_SLASH
187 #define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
188 extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
189 #endif
191 #ifdef NO_STRUCT_ITIMERVAL
192 struct itimerval {
193 struct timeval it_interval;
194 struct timeval it_value;
196 #endif
198 #ifdef NO_SETITIMER
199 #define setitimer(which,value,ovalue)
200 #endif
202 #ifndef NO_LIBGEN_H
203 #include <libgen.h>
204 #else
205 #define basename gitbasename
206 extern char *gitbasename(char *);
207 #endif
209 #ifndef NO_ICONV
210 #include <iconv.h>
211 #endif
213 #ifndef NO_OPENSSL
214 #include <openssl/ssl.h>
215 #include <openssl/err.h>
216 #endif
218 /* On most systems <netdb.h> would have given us this, but
219 * not on some systems (e.g. z/OS).
221 #ifndef NI_MAXHOST
222 #define NI_MAXHOST 1025
223 #endif
225 #ifndef NI_MAXSERV
226 #define NI_MAXSERV 32
227 #endif
229 /* On most systems <limits.h> would have given us this, but
230 * not on some systems (e.g. GNU/Hurd).
232 #ifndef PATH_MAX
233 #define PATH_MAX 4096
234 #endif
236 #ifndef PRIuMAX
237 #define PRIuMAX "llu"
238 #endif
240 #ifndef PRIu32
241 #define PRIu32 "u"
242 #endif
244 #ifndef PRIx32
245 #define PRIx32 "x"
246 #endif
248 #ifndef PRIo32
249 #define PRIo32 "o"
250 #endif
252 #ifndef PATH_SEP
253 #define PATH_SEP ':'
254 #endif
256 #ifdef HAVE_PATHS_H
257 #include <paths.h>
258 #endif
259 #ifndef _PATH_DEFPATH
260 #define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
261 #endif
263 #ifndef STRIP_EXTENSION
264 #define STRIP_EXTENSION ""
265 #endif
267 #ifndef has_dos_drive_prefix
268 static inline int git_has_dos_drive_prefix(const char *path)
270 return 0;
272 #define has_dos_drive_prefix git_has_dos_drive_prefix
273 #endif
275 #ifndef is_dir_sep
276 static inline int git_is_dir_sep(int c)
278 return c == '/';
280 #define is_dir_sep git_is_dir_sep
281 #endif
283 #ifndef offset_1st_component
284 static inline int git_offset_1st_component(const char *path)
286 return is_dir_sep(path[0]);
288 #define offset_1st_component git_offset_1st_component
289 #endif
291 #ifndef find_last_dir_sep
292 static inline char *git_find_last_dir_sep(const char *path)
294 return strrchr(path, '/');
296 #define find_last_dir_sep git_find_last_dir_sep
297 #endif
299 #if defined(__HP_cc) && (__HP_cc >= 61000)
300 #define NORETURN __attribute__((noreturn))
301 #define NORETURN_PTR
302 #elif defined(__GNUC__) && !defined(NO_NORETURN)
303 #define NORETURN __attribute__((__noreturn__))
304 #define NORETURN_PTR __attribute__((__noreturn__))
305 #elif defined(_MSC_VER)
306 #define NORETURN __declspec(noreturn)
307 #define NORETURN_PTR
308 #else
309 #define NORETURN
310 #define NORETURN_PTR
311 #ifndef __GNUC__
312 #ifndef __attribute__
313 #define __attribute__(x)
314 #endif
315 #endif
316 #endif
318 /* The sentinel attribute is valid from gcc version 4.0 */
319 #if defined(__GNUC__) && (__GNUC__ >= 4)
320 #define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
321 #else
322 #define LAST_ARG_MUST_BE_NULL
323 #endif
325 #include "compat/bswap.h"
327 #include "wildmatch.h"
329 struct strbuf;
331 /* General helper functions */
332 extern void vreportf(const char *prefix, const char *err, va_list params);
333 extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
334 extern NORETURN void usage(const char *err);
335 extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
336 extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
337 extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
338 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
339 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
341 #ifndef NO_OPENSSL
342 #ifdef APPLE_COMMON_CRYPTO
343 #include "compat/apple-common-crypto.h"
344 #else
345 #include <openssl/evp.h>
346 #include <openssl/hmac.h>
347 #endif /* APPLE_COMMON_CRYPTO */
348 #include <openssl/x509v3.h>
349 #endif /* NO_OPENSSL */
352 * Let callers be aware of the constant return value; this can help
353 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
354 * because some compilers may not support variadic macros. Since we're only
355 * trying to help gcc, anyway, it's OK; other compilers will fall back to
356 * using the function as usual.
358 #if defined(__GNUC__)
359 static inline int const_error(void)
361 return -1;
363 #define error(...) (error(__VA_ARGS__), const_error())
364 #endif
366 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
367 extern void set_error_routine(void (*routine)(const char *err, va_list params));
368 extern void set_die_is_recursing_routine(int (*routine)(void));
370 extern int starts_with(const char *str, const char *prefix);
373 * If the string "str" begins with the string found in "prefix", return 1.
374 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
375 * the string right after the prefix).
377 * Otherwise, return 0 and leave "out" untouched.
379 * Examples:
381 * [extract branch name, fail if not a branch]
382 * if (!skip_prefix(ref, "refs/heads/", &branch)
383 * return -1;
385 * [skip prefix if present, otherwise use whole string]
386 * skip_prefix(name, "refs/heads/", &name);
388 static inline int skip_prefix(const char *str, const char *prefix,
389 const char **out)
391 do {
392 if (!*prefix) {
393 *out = str;
394 return 1;
396 } while (*str++ == *prefix++);
397 return 0;
401 * If buf ends with suffix, return 1 and subtract the length of the suffix
402 * from *len. Otherwise, return 0 and leave *len untouched.
404 static inline int strip_suffix_mem(const char *buf, size_t *len,
405 const char *suffix)
407 size_t suflen = strlen(suffix);
408 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
409 return 0;
410 *len -= suflen;
411 return 1;
415 * If str ends with suffix, return 1 and set *len to the size of the string
416 * without the suffix. Otherwise, return 0 and set *len to the size of the
417 * string.
419 * Note that we do _not_ NUL-terminate str to the new length.
421 static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
423 *len = strlen(str);
424 return strip_suffix_mem(str, len, suffix);
427 static inline int ends_with(const char *str, const char *suffix)
429 size_t len;
430 return strip_suffix(str, suffix, &len);
433 #if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
435 #ifndef PROT_READ
436 #define PROT_READ 1
437 #define PROT_WRITE 2
438 #define MAP_PRIVATE 1
439 #endif
441 #define mmap git_mmap
442 #define munmap git_munmap
443 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
444 extern int git_munmap(void *start, size_t length);
446 #else /* NO_MMAP || USE_WIN32_MMAP */
448 #include <sys/mman.h>
450 #endif /* NO_MMAP || USE_WIN32_MMAP */
452 #ifdef NO_MMAP
454 /* This value must be multiple of (pagesize * 2) */
455 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
457 #else /* NO_MMAP */
459 /* This value must be multiple of (pagesize * 2) */
460 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
461 (sizeof(void*) >= 8 \
462 ? 1 * 1024 * 1024 * 1024 \
463 : 32 * 1024 * 1024)
465 #endif /* NO_MMAP */
467 #ifndef MAP_FAILED
468 #define MAP_FAILED ((void *)-1)
469 #endif
471 #ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
472 #define on_disk_bytes(st) ((st).st_size)
473 #else
474 #define on_disk_bytes(st) ((st).st_blocks * 512)
475 #endif
477 #define DEFAULT_PACKED_GIT_LIMIT \
478 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
480 #ifdef NO_PREAD
481 #define pread git_pread
482 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
483 #endif
485 * Forward decl that will remind us if its twin in cache.h changes.
486 * This function is used in compat/pread.c. But we can't include
487 * cache.h there.
489 extern ssize_t read_in_full(int fd, void *buf, size_t count);
491 #ifdef NO_SETENV
492 #define setenv gitsetenv
493 extern int gitsetenv(const char *, const char *, int);
494 #endif
496 #ifdef NO_MKDTEMP
497 #define mkdtemp gitmkdtemp
498 extern char *gitmkdtemp(char *);
499 #endif
501 #ifdef NO_MKSTEMPS
502 #define mkstemps gitmkstemps
503 extern int gitmkstemps(char *, int);
504 #endif
506 #ifdef NO_UNSETENV
507 #define unsetenv gitunsetenv
508 extern void gitunsetenv(const char *);
509 #endif
511 #ifdef NO_STRCASESTR
512 #define strcasestr gitstrcasestr
513 extern char *gitstrcasestr(const char *haystack, const char *needle);
514 #endif
516 #ifdef NO_STRLCPY
517 #define strlcpy gitstrlcpy
518 extern size_t gitstrlcpy(char *, const char *, size_t);
519 #endif
521 #ifdef NO_STRTOUMAX
522 #define strtoumax gitstrtoumax
523 extern uintmax_t gitstrtoumax(const char *, char **, int);
524 #define strtoimax gitstrtoimax
525 extern intmax_t gitstrtoimax(const char *, char **, int);
526 #endif
528 #ifdef NO_HSTRERROR
529 #define hstrerror githstrerror
530 extern const char *githstrerror(int herror);
531 #endif
533 #ifdef NO_MEMMEM
534 #define memmem gitmemmem
535 void *gitmemmem(const void *haystack, size_t haystacklen,
536 const void *needle, size_t needlelen);
537 #endif
539 #ifdef NO_GETPAGESIZE
540 #define getpagesize() sysconf(_SC_PAGESIZE)
541 #endif
543 #ifdef FREAD_READS_DIRECTORIES
544 #ifdef fopen
545 #undef fopen
546 #endif
547 #define fopen(a,b) git_fopen(a,b)
548 extern FILE *git_fopen(const char*, const char*);
549 #endif
551 #ifdef SNPRINTF_RETURNS_BOGUS
552 #ifdef snprintf
553 #undef snprintf
554 #endif
555 #define snprintf git_snprintf
556 extern int git_snprintf(char *str, size_t maxsize,
557 const char *format, ...);
558 #ifdef vsnprintf
559 #undef vsnprintf
560 #endif
561 #define vsnprintf git_vsnprintf
562 extern int git_vsnprintf(char *str, size_t maxsize,
563 const char *format, va_list ap);
564 #endif
566 #ifdef __GLIBC_PREREQ
567 #if __GLIBC_PREREQ(2, 1)
568 #define HAVE_STRCHRNUL
569 #define HAVE_MEMPCPY
570 #endif
571 #endif
573 #ifndef HAVE_STRCHRNUL
574 #define strchrnul gitstrchrnul
575 static inline char *gitstrchrnul(const char *s, int c)
577 while (*s && *s != c)
578 s++;
579 return (char *)s;
581 #endif
583 #ifndef HAVE_MEMPCPY
584 #define mempcpy gitmempcpy
585 static inline void *gitmempcpy(void *dest, const void *src, size_t n)
587 return (char *)memcpy(dest, src, n) + n;
589 #endif
591 #ifdef NO_INET_PTON
592 int inet_pton(int af, const char *src, void *dst);
593 #endif
595 #ifdef NO_INET_NTOP
596 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
597 #endif
599 #ifdef NO_PTHREADS
600 #define atexit git_atexit
601 extern int git_atexit(void (*handler)(void));
602 #endif
604 extern void release_pack_memory(size_t);
606 typedef void (*try_to_free_t)(size_t);
607 extern try_to_free_t set_try_to_free_routine(try_to_free_t);
609 #ifdef HAVE_ALLOCA_H
610 # include <alloca.h>
611 # define xalloca(size) (alloca(size))
612 # define xalloca_free(p) do {} while (0)
613 #else
614 # define xalloca(size) (xmalloc(size))
615 # define xalloca_free(p) (free(p))
616 #endif
617 extern char *xstrdup(const char *str);
618 extern void *xmalloc(size_t size);
619 extern void *xmallocz(size_t size);
620 extern void *xmallocz_gently(size_t size);
621 extern void *xmemdupz(const void *data, size_t len);
622 extern char *xstrndup(const char *str, size_t len);
623 extern void *xrealloc(void *ptr, size_t size);
624 extern void *xcalloc(size_t nmemb, size_t size);
625 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
626 extern ssize_t xread(int fd, void *buf, size_t len);
627 extern ssize_t xwrite(int fd, const void *buf, size_t len);
628 extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
629 extern int xdup(int fd);
630 extern FILE *xfdopen(int fd, const char *mode);
631 extern int xmkstemp(char *template);
632 extern int xmkstemp_mode(char *template, int mode);
633 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
634 extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
635 extern char *xgetcwd(void);
637 #define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
639 static inline size_t xsize_t(off_t len)
641 if (len > (size_t) len)
642 die("Cannot handle files this big");
643 return (size_t)len;
646 /* in ctype.c, for kwset users */
647 extern const char tolower_trans_tbl[256];
649 /* Sane ctype - no locale, and works with signed chars */
650 #undef isascii
651 #undef isspace
652 #undef isdigit
653 #undef isalpha
654 #undef isalnum
655 #undef isprint
656 #undef islower
657 #undef isupper
658 #undef tolower
659 #undef toupper
660 #undef iscntrl
661 #undef ispunct
662 #undef isxdigit
664 extern const unsigned char sane_ctype[256];
665 #define GIT_SPACE 0x01
666 #define GIT_DIGIT 0x02
667 #define GIT_ALPHA 0x04
668 #define GIT_GLOB_SPECIAL 0x08
669 #define GIT_REGEX_SPECIAL 0x10
670 #define GIT_PATHSPEC_MAGIC 0x20
671 #define GIT_CNTRL 0x40
672 #define GIT_PUNCT 0x80
673 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
674 #define isascii(x) (((x) & ~0x7f) == 0)
675 #define isspace(x) sane_istest(x,GIT_SPACE)
676 #define isdigit(x) sane_istest(x,GIT_DIGIT)
677 #define isalpha(x) sane_istest(x,GIT_ALPHA)
678 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
679 #define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
680 #define islower(x) sane_iscase(x, 1)
681 #define isupper(x) sane_iscase(x, 0)
682 #define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
683 #define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
684 #define iscntrl(x) (sane_istest(x,GIT_CNTRL))
685 #define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
686 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
687 #define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
688 #define tolower(x) sane_case((unsigned char)(x), 0x20)
689 #define toupper(x) sane_case((unsigned char)(x), 0)
690 #define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
692 static inline int sane_case(int x, int high)
694 if (sane_istest(x, GIT_ALPHA))
695 x = (x & ~0x20) | high;
696 return x;
699 static inline int sane_iscase(int x, int is_lower)
701 if (!sane_istest(x, GIT_ALPHA))
702 return 0;
704 if (is_lower)
705 return (x & 0x20) != 0;
706 else
707 return (x & 0x20) == 0;
710 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
712 unsigned long ul;
713 char *p;
715 errno = 0;
716 ul = strtoul(s, &p, base);
717 if (errno || *p || p == s || (unsigned int) ul != ul)
718 return -1;
719 *result = ul;
720 return 0;
723 static inline int strtol_i(char const *s, int base, int *result)
725 long ul;
726 char *p;
728 errno = 0;
729 ul = strtol(s, &p, base);
730 if (errno || *p || p == s || (int) ul != ul)
731 return -1;
732 *result = ul;
733 return 0;
736 #ifdef INTERNAL_QSORT
737 void git_qsort(void *base, size_t nmemb, size_t size,
738 int(*compar)(const void *, const void *));
739 #define qsort git_qsort
740 #endif
742 #ifndef DIR_HAS_BSD_GROUP_SEMANTICS
743 # define FORCE_DIR_SET_GID S_ISGID
744 #else
745 # define FORCE_DIR_SET_GID 0
746 #endif
748 #ifdef NO_NSEC
749 #undef USE_NSEC
750 #define ST_CTIME_NSEC(st) 0
751 #define ST_MTIME_NSEC(st) 0
752 #else
753 #ifdef USE_ST_TIMESPEC
754 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
755 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
756 #else
757 #define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
758 #define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
759 #endif
760 #endif
762 #ifdef UNRELIABLE_FSTAT
763 #define fstat_is_reliable() 0
764 #else
765 #define fstat_is_reliable() 1
766 #endif
768 #ifndef va_copy
770 * Since an obvious implementation of va_list would be to make it a
771 * pointer into the stack frame, a simple assignment will work on
772 * many systems. But let's try to be more portable.
774 #ifdef __va_copy
775 #define va_copy(dst, src) __va_copy(dst, src)
776 #else
777 #define va_copy(dst, src) ((dst) = (src))
778 #endif
779 #endif
781 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
782 #define HAVE_VARIADIC_MACROS 1
783 #endif
786 * Preserves errno, prints a message, but gives no warning for ENOENT.
787 * Returns 0 on success, which includes trying to unlink an object that does
788 * not exist.
790 int unlink_or_warn(const char *path);
792 * Tries to unlink file. Returns 0 if unlink succeeded
793 * or the file already didn't exist. Returns -1 and
794 * appends a message to err suitable for
795 * 'error("%s", err->buf)' on error.
797 int unlink_or_msg(const char *file, struct strbuf *err);
799 * Preserves errno, prints a message, but gives no warning for ENOENT.
800 * Returns 0 on success, which includes trying to remove a directory that does
801 * not exist.
803 int rmdir_or_warn(const char *path);
805 * Calls the correct function out of {unlink,rmdir}_or_warn based on
806 * the supplied file mode.
808 int remove_or_warn(unsigned int mode, const char *path);
811 * Call access(2), but warn for any error except "missing file"
812 * (ENOENT or ENOTDIR).
814 #define ACCESS_EACCES_OK (1U << 0)
815 int access_or_warn(const char *path, int mode, unsigned flag);
816 int access_or_die(const char *path, int mode, unsigned flag);
818 /* Warn on an inaccessible file that ought to be accessible */
819 void warn_on_inaccessible(const char *path);
821 /* Get the passwd entry for the UID of the current process. */
822 struct passwd *xgetpwuid_self(void);
824 #ifdef GMTIME_UNRELIABLE_ERRORS
825 struct tm *git_gmtime(const time_t *);
826 struct tm *git_gmtime_r(const time_t *, struct tm *);
827 #define gmtime git_gmtime
828 #define gmtime_r git_gmtime_r
829 #endif
831 #endif