git-compat-util: suppress unavoidable Apple-specific deprecation warnings
[git/git.git] / git-compat-util.h
CommitLineData
4050c0df
JH
1#ifndef GIT_COMPAT_UTIL_H
2#define GIT_COMPAT_UTIL_H
3
b97e9116
MW
4#define _FILE_OFFSET_BITS 64
5
8f1d2e6f 6#ifndef FLEX_ARRAY
8e973991
JH
7/*
8 * See if our compiler is known to support flexible array members.
9 */
203ee91f 10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && (!defined(__SUNPRO_C) || (__SUNPRO_C > 0x580))
8e973991
JH
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
19
20/*
21 * Otherwise, default to safer but a bit wasteful traditional style
22 */
23#ifndef FLEX_ARRAY
24# define FLEX_ARRAY 1
8f1d2e6f
JH
25#endif
26#endif
27
b4f2a6ac 28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
f630cfda 29#define bitsizeof(x) (CHAR_BIT * sizeof(x))
b4f2a6ac 30
c03c8315
EFL
31#define maximum_signed_value_of_type(a) \
32 (INTMAX_MAX >> (bitsizeof(intmax_t) - bitsizeof(a)))
33
1368f650
JN
34#define maximum_unsigned_value_of_type(a) \
35 (UINTMAX_MAX >> (bitsizeof(uintmax_t) - bitsizeof(a)))
36
c03c8315
EFL
37/*
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.
40 *
41 * Requires: a >= 0, typeof(a) equals typeof(b)
42 */
43#define signed_add_overflows(a, b) \
44 ((b) > maximum_signed_value_of_type(a) - (a))
45
1368f650
JN
46#define unsigned_add_overflows(a, b) \
47 ((b) > maximum_unsigned_value_of_type(a) - (a))
48
8723f216
NP
49#ifdef __GNUC__
50#define TYPEOF(x) (__typeof__(x))
51#else
52#define TYPEOF(x)
53#endif
54
f630cfda 55#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (bitsizeof(x) - (bits))))
db7244bd 56#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 57
98cb6f30
PH
58#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
59
cf606e3d
AW
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)
62
4cb18a49
BC
63#if defined(__sun__)
64 /*
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.
70 */
71# if __STDC_VERSION__ - 0 >= 199901L
72# define _XOPEN_SOURCE 600
73# else
74# define _XOPEN_SOURCE 500
75# endif
6555b196 76#elif !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && \
6c109904 77 !defined(_M_UNIX) && !defined(__sgi) && !defined(__DragonFly__) && \
92164af9 78 !defined(__TANDEM) && !defined(__QNX__) && !defined(__MirBSD__)
85023577
JH
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 */
c902c9a6 81#endif
fb952206
JR
82#define _ALL_SOURCE 1
83#define _GNU_SOURCE 1
84#define _BSD_SOURCE 1
f978a99f 85#define _DEFAULT_SOURCE 1
9a695fbf 86#define _NETBSD_SOURCE 1
9398b859 87#define _SGI_SOURCE 1
85023577 88
380395d0 89#if defined(WIN32) && !defined(__CYGWIN__) /* Both MinGW and MSVC */
8453c125 90# if defined (_MSC_VER) && !defined(_WIN32_WINNT)
41f29991
RJ
91# define _WIN32_WINNT 0x0502
92# endif
435bdf8c
MSO
93#define WIN32_LEAN_AND_MEAN /* stops windows.h including winsock.h */
94#include <winsock2.h>
95#include <windows.h>
380395d0 96#define GIT_WINDOWS_NATIVE
435bdf8c
MSO
97#endif
98
4050c0df
JH
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>
b3e103da 107#ifdef HAVE_STRINGS_H
6c109904
JS
108#include <strings.h> /* for strcasecmp() */
109#endif
4050c0df
JH
110#include <errno.h>
111#include <limits.h>
b2d05e06 112#ifdef NEEDS_SYS_PARAM_H
4050c0df 113#include <sys/param.h>
6ede7205 114#endif
4050c0df
JH
115#include <sys/types.h>
116#include <dirent.h>
85023577
JH
117#include <sys/time.h>
118#include <time.h>
119#include <signal.h>
f4626df5
JS
120#include <assert.h>
121#include <regex.h>
122#include <utime.h>
088d8802 123#include <syslog.h>
2844923d 124#ifndef NO_SYS_POLL_H
fdc12114 125#include <sys/poll.h>
2844923d
MD
126#else
127#include <poll.h>
128#endif
2f0aaaf9 129
cfc755d3
VR
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
f4626df5 136#include <sys/wait.h>
ebae9ff9 137#include <sys/resource.h>
85023577 138#include <sys/socket.h>
80bbe72b 139#include <sys/ioctl.h>
eb80042c 140#include <termios.h>
2600973f 141#ifndef NO_SYS_SELECT_H
80bbe72b 142#include <sys/select.h>
2600973f 143#endif
85023577
JH
144#include <netinet/in.h>
145#include <netinet/tcp.h>
146#include <arpa/inet.h>
147#include <netdb.h>
148#include <pwd.h>
e2770979 149#include <sys/un.h>
2844923d 150#ifndef NO_INTTYPES_H
007e2ba6 151#include <inttypes.h>
2844923d
MD
152#else
153#include <stdint.h>
154#endif
6c109904
JS
155#ifdef NO_INTPTR_T
156/*
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.
162 */
163typedef long intptr_t;
164typedef unsigned long uintptr_t;
165#endif
41b20017
RJ
166#if defined(__CYGWIN__)
167#undef _XOPEN_SOURCE
168#include <grp.h>
169#define _XOPEN_SOURCE 600
170#else
fb952206 171#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 172#include <grp.h>
fb952206 173#define _ALL_SOURCE 1
41b20017 174#endif
d75f8e61 175#endif
85023577 176
76759c7d
TB
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
185
0539ecfd
JS
186#ifdef MKDIR_WO_TRAILING_SLASH
187#define mkdir(a,b) compat_mkdir_wo_trailing_slash((a),(b))
188extern int compat_mkdir_wo_trailing_slash(const char*, mode_t);
189#endif
190
7f9e848c
JS
191#ifdef NO_STRUCT_ITIMERVAL
192struct itimerval {
193 struct timeval it_interval;
194 struct timeval it_value;
981ff520 195};
7f9e848c
JS
196#endif
197
198#ifdef NO_SETITIMER
199#define setitimer(which,value,ovalue)
200#endif
201
e1c06886
DA
202#ifndef NO_LIBGEN_H
203#include <libgen.h>
204#else
205#define basename gitbasename
206extern char *gitbasename(char *);
207#endif
208
85023577
JH
209#ifndef NO_ICONV
210#include <iconv.h>
211#endif
4050c0df 212
684ec6c6 213#ifndef NO_OPENSSL
b195aa00
ES
214#define __AVAILABILITY_MACROS_USES_AVAILABILITY 0
215#define MAC_OS_X_VERSION_MIN_REQUIRED MAC_OS_X_VERSION_10_6
684ec6c6
RS
216#include <openssl/ssl.h>
217#include <openssl/err.h>
b195aa00
ES
218#undef MAC_OS_X_VERSION_MIN_REQUIRED
219#undef __AVAILABILITY_MACROS_USES_AVAILABILITY
684ec6c6
RS
220#endif
221
3b130ade
DM
222/* On most systems <netdb.h> would have given us this, but
223 * not on some systems (e.g. z/OS).
224 */
225#ifndef NI_MAXHOST
226#define NI_MAXHOST 1025
227#endif
228
229#ifndef NI_MAXSERV
230#define NI_MAXSERV 32
231#endif
232
d0c2449f
JH
233/* On most systems <limits.h> would have given us this, but
234 * not on some systems (e.g. GNU/Hurd).
235 */
236#ifndef PATH_MAX
237#define PATH_MAX 4096
238#endif
239
c4001d92
SP
240#ifndef PRIuMAX
241#define PRIuMAX "llu"
242#endif
243
607bb3ff
JS
244#ifndef PRIu32
245#define PRIu32 "u"
246#endif
247
248#ifndef PRIx32
249#define PRIx32 "x"
250#endif
251
5418d96d
RJ
252#ifndef PRIo32
253#define PRIo32 "o"
254#endif
255
80ba074f
JS
256#ifndef PATH_SEP
257#define PATH_SEP ':'
258#endif
259
cb6a22c0
CW
260#ifdef HAVE_PATHS_H
261#include <paths.h>
262#endif
263#ifndef _PATH_DEFPATH
264#define _PATH_DEFPATH "/usr/local/bin:/usr/bin:/bin"
265#endif
266
23326d14
JS
267#ifndef STRIP_EXTENSION
268#define STRIP_EXTENSION ""
269#endif
270
25fe217b 271#ifndef has_dos_drive_prefix
bf728346
RS
272static inline int git_has_dos_drive_prefix(const char *path)
273{
274 return 0;
275}
276#define has_dos_drive_prefix git_has_dos_drive_prefix
25fe217b
JS
277#endif
278
bf728346
RS
279#ifndef is_dir_sep
280static inline int git_is_dir_sep(int c)
281{
282 return c == '/';
283}
284#define is_dir_sep git_is_dir_sep
c2369bdf
CZ
285#endif
286
bf728346
RS
287#ifndef offset_1st_component
288static inline int git_offset_1st_component(const char *path)
289{
290 return is_dir_sep(path[0]);
291}
292#define offset_1st_component git_offset_1st_component
25fe217b
JS
293#endif
294
d1c69255 295#ifndef find_last_dir_sep
bf728346
RS
296static inline char *git_find_last_dir_sep(const char *path)
297{
298 return strrchr(path, '/');
299}
300#define find_last_dir_sep git_find_last_dir_sep
d1c69255
TN
301#endif
302
e4ac953b 303#if defined(__HP_cc) && (__HP_cc >= 61000)
b6ab349b
MR
304#define NORETURN __attribute__((noreturn))
305#define NORETURN_PTR
6520c846 306#elif defined(__GNUC__) && !defined(NO_NORETURN)
4050c0df 307#define NORETURN __attribute__((__noreturn__))
18660bc9 308#define NORETURN_PTR __attribute__((__noreturn__))
aba7dea8
RJ
309#elif defined(_MSC_VER)
310#define NORETURN __declspec(noreturn)
311#define NORETURN_PTR
4050c0df
JH
312#else
313#define NORETURN
18660bc9 314#define NORETURN_PTR
8cd7ebc8 315#ifndef __GNUC__
4050c0df
JH
316#ifndef __attribute__
317#define __attribute__(x)
318#endif
319#endif
8cd7ebc8 320#endif
4050c0df 321
9fe3edc4
RJ
322/* The sentinel attribute is valid from gcc version 4.0 */
323#if defined(__GNUC__) && (__GNUC__ >= 4)
324#define LAST_ARG_MUST_BE_NULL __attribute__((sentinel))
325#else
326#define LAST_ARG_MUST_BE_NULL
327#endif
328
51ea5519
NP
329#include "compat/bswap.h"
330
cebcab18 331#include "wildmatch.h"
cebcab18 332
9ccc0c08
RS
333struct strbuf;
334
4050c0df 335/* General helper functions */
ebaa79f4 336extern void vreportf(const char *prefix, const char *err, va_list params);
3bc4181f 337extern void vwritef(int fd, const char *prefix, const char *err, va_list params);
a4f3131c 338extern NORETURN void usage(const char *err);
64b1cb74 339extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
a4f3131c
EFL
340extern NORETURN void die(const char *err, ...) __attribute__((format (printf, 1, 2)));
341extern NORETURN void die_errno(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 342extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 343extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 344
f2be034c
BG
345#ifndef NO_OPENSSL
346#ifdef APPLE_COMMON_CRYPTO
347#include "compat/apple-common-crypto.h"
348#else
349#include <openssl/evp.h>
350#include <openssl/hmac.h>
351#endif /* APPLE_COMMON_CRYPTO */
352#include <openssl/x509v3.h>
353#endif /* NO_OPENSSL */
354
e208f9cc
JK
355/*
356 * Let callers be aware of the constant return value; this can help
9798f7e5
MK
357 * gcc with -Wuninitialized analysis. We restrict this trick to gcc, though,
358 * because some compilers may not support variadic macros. Since we're only
359 * trying to help gcc, anyway, it's OK; other compilers will fall back to
360 * using the function as usual.
e208f9cc 361 */
ff0a80af 362#if defined(__GNUC__)
87fe5df3
JK
363static inline int const_error(void)
364{
365 return -1;
366}
367#define error(...) (error(__VA_ARGS__), const_error())
e208f9cc
JK
368#endif
369
18660bc9 370extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
3bc4181f 371extern void set_error_routine(void (*routine)(const char *err, va_list params));
c19a490e 372extern void set_die_is_recursing_routine(int (*routine)(void));
39a3f5ea 373
95662315 374extern int starts_with(const char *str, const char *prefix);
698a68be 375
cf4fff57
JK
376/*
377 * If the string "str" begins with the string found in "prefix", return 1.
378 * The "out" parameter is set to "str + strlen(prefix)" (i.e., to the point in
379 * the string right after the prefix).
380 *
381 * Otherwise, return 0 and leave "out" untouched.
382 *
383 * Examples:
384 *
385 * [extract branch name, fail if not a branch]
386 * if (!skip_prefix(ref, "refs/heads/", &branch)
387 * return -1;
388 *
389 * [skip prefix if present, otherwise use whole string]
390 * skip_prefix(name, "refs/heads/", &name);
391 */
392static inline int skip_prefix(const char *str, const char *prefix,
393 const char **out)
fbca5837 394{
ba399c46 395 do {
cf4fff57
JK
396 if (!*prefix) {
397 *out = str;
398 return 1;
399 }
ba399c46 400 } while (*str++ == *prefix++);
cf4fff57 401 return 0;
fbca5837
MV
402}
403
35480f0b
JK
404/*
405 * If buf ends with suffix, return 1 and subtract the length of the suffix
406 * from *len. Otherwise, return 0 and leave *len untouched.
407 */
408static inline int strip_suffix_mem(const char *buf, size_t *len,
409 const char *suffix)
410{
411 size_t suflen = strlen(suffix);
412 if (*len < suflen || memcmp(buf + (*len - suflen), suffix, suflen))
413 return 0;
414 *len -= suflen;
415 return 1;
416}
417
418/*
419 * If str ends with suffix, return 1 and set *len to the size of the string
420 * without the suffix. Otherwise, return 0 and set *len to the size of the
421 * string.
422 *
423 * Note that we do _not_ NUL-terminate str to the new length.
424 */
425static inline int strip_suffix(const char *str, const char *suffix, size_t *len)
426{
427 *len = strlen(str);
428 return strip_suffix_mem(str, len, suffix);
429}
430
f52a35fd
JK
431static inline int ends_with(const char *str, const char *suffix)
432{
433 size_t len;
434 return strip_suffix(str, suffix, &len);
435}
436
b130a72b 437#if defined(NO_MMAP) || defined(USE_WIN32_MMAP)
4050c0df
JH
438
439#ifndef PROT_READ
440#define PROT_READ 1
441#define PROT_WRITE 2
442#define MAP_PRIVATE 1
4050c0df
JH
443#endif
444
d6779124
SP
445#define mmap git_mmap
446#define munmap git_munmap
447extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
448extern int git_munmap(void *start, size_t length);
4050c0df 449
b130a72b
JL
450#else /* NO_MMAP || USE_WIN32_MMAP */
451
452#include <sys/mman.h>
453
454#endif /* NO_MMAP || USE_WIN32_MMAP */
455
456#ifdef NO_MMAP
457
5faaf246 458/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
459#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
460
4050c0df
JH
461#else /* NO_MMAP */
462
5faaf246 463/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
464#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
465 (sizeof(void*) >= 8 \
466 ? 1 * 1024 * 1024 * 1024 \
467 : 32 * 1024 * 1024)
4050c0df
JH
468
469#endif /* NO_MMAP */
470
fcf3a21a
GV
471#ifndef MAP_FAILED
472#define MAP_FAILED ((void *)-1)
473#endif
474
fdb2a2a6
JH
475#ifdef NO_ST_BLOCKS_IN_STRUCT_STAT
476#define on_disk_bytes(st) ((st).st_size)
477#else
478#define on_disk_bytes(st) ((st).st_blocks * 512)
479#endif
480
22bac0ea 481#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 482 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 483
6900679c
SH
484#ifdef NO_PREAD
485#define pread git_pread
486extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
487#endif
14086b0a
SP
488/*
489 * Forward decl that will remind us if its twin in cache.h changes.
490 * This function is used in compat/pread.c. But we can't include
491 * cache.h there.
492 */
493extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 494
4050c0df
JH
495#ifdef NO_SETENV
496#define setenv gitsetenv
497extern int gitsetenv(const char *, const char *, int);
498#endif
499
ca5bb5d5
SP
500#ifdef NO_MKDTEMP
501#define mkdtemp gitmkdtemp
502extern char *gitmkdtemp(char *);
503#endif
504
0620b39b
DA
505#ifdef NO_MKSTEMPS
506#define mkstemps gitmkstemps
507extern int gitmkstemps(char *, int);
508#endif
509
731043fd
JR
510#ifdef NO_UNSETENV
511#define unsetenv gitunsetenv
512extern void gitunsetenv(const char *);
513#endif
514
4050c0df
JH
515#ifdef NO_STRCASESTR
516#define strcasestr gitstrcasestr
517extern char *gitstrcasestr(const char *haystack, const char *needle);
518#endif
519
817151e6
PE
520#ifdef NO_STRLCPY
521#define strlcpy gitstrlcpy
522extern size_t gitstrlcpy(char *, const char *, size_t);
523#endif
524
bc6b4f52
JR
525#ifdef NO_STRTOUMAX
526#define strtoumax gitstrtoumax
527extern uintmax_t gitstrtoumax(const char *, char **, int);
97000ba6
JS
528#define strtoimax gitstrtoimax
529extern intmax_t gitstrtoimax(const char *, char **, int);
bc6b4f52
JR
530#endif
531
fa0c87c3
AR
532#ifdef NO_HSTRERROR
533#define hstrerror githstrerror
534extern const char *githstrerror(int herror);
535#endif
536
b21b9f1d
RS
537#ifdef NO_MEMMEM
538#define memmem gitmemmem
539void *gitmemmem(const void *haystack, size_t haystacklen,
540 const void *needle, size_t needlelen);
541#endif
542
40036bed
MK
543#ifdef NO_GETPAGESIZE
544#define getpagesize() sysconf(_SC_PAGESIZE)
545#endif
546
cba22528 547#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
548#ifdef fopen
549#undef fopen
550#endif
cba22528
BC
551#define fopen(a,b) git_fopen(a,b)
552extern FILE *git_fopen(const char*, const char*);
553#endif
554
c4582f93 555#ifdef SNPRINTF_RETURNS_BOGUS
ab03803c
BS
556#ifdef snprintf
557#undef snprintf
558#endif
c4582f93
MR
559#define snprintf git_snprintf
560extern int git_snprintf(char *str, size_t maxsize,
561 const char *format, ...);
ab03803c
BS
562#ifdef vsnprintf
563#undef vsnprintf
564#endif
c4582f93
MR
565#define vsnprintf git_vsnprintf
566extern int git_vsnprintf(char *str, size_t maxsize,
567 const char *format, va_list ap);
568#endif
569
726c8ef5
JS
570#ifdef __GLIBC_PREREQ
571#if __GLIBC_PREREQ(2, 1)
572#define HAVE_STRCHRNUL
137c6eaa 573#define HAVE_MEMPCPY
726c8ef5
JS
574#endif
575#endif
576
577#ifndef HAVE_STRCHRNUL
659c69cf 578#define strchrnul gitstrchrnul
9e79f00f
AE
579static inline char *gitstrchrnul(const char *s, int c)
580{
581 while (*s && *s != c)
582 s++;
583 return (char *)s;
584}
659c69cf
RS
585#endif
586
137c6eaa
JN
587#ifndef HAVE_MEMPCPY
588#define mempcpy gitmempcpy
589static inline void *gitmempcpy(void *dest, const void *src, size_t n)
590{
591 return (char *)memcpy(dest, src, n) + n;
592}
593#endif
594
da523cc5
MP
595#ifdef NO_INET_PTON
596int inet_pton(int af, const char *src, void *dst);
597#endif
598
599#ifdef NO_INET_NTOP
600const char *inet_ntop(int af, const void *src, char *dst, size_t size);
601#endif
602
0f4b6db3
EB
603#ifdef NO_PTHREADS
604#define atexit git_atexit
605extern int git_atexit(void (*handler)(void));
606#endif
607
7c3ecb32 608extern void release_pack_memory(size_t);
97bfeb34 609
851c34b0
JS
610typedef void (*try_to_free_t)(size_t);
611extern try_to_free_t set_try_to_free_routine(try_to_free_t);
a9a74636 612
61f76a36
KS
613#ifdef HAVE_ALLOCA_H
614# include <alloca.h>
615# define xalloca(size) (alloca(size))
616# define xalloca_free(p) do {} while (0)
617#else
618# define xalloca(size) (xmalloc(size))
619# define xalloca_free(p) (free(p))
620#endif
112db553
LT
621extern char *xstrdup(const char *str);
622extern void *xmalloc(size_t size);
5bf9219d 623extern void *xmallocz(size_t size);
f8bb1d94 624extern void *xmallocz_gently(size_t size);
112db553
LT
625extern void *xmemdupz(const void *data, size_t len);
626extern char *xstrndup(const char *str, size_t len);
627extern void *xrealloc(void *ptr, size_t size);
628extern void *xcalloc(size_t nmemb, size_t size);
629extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
630extern ssize_t xread(int fd, void *buf, size_t len);
631extern ssize_t xwrite(int fd, const void *buf, size_t len);
9aa91af0 632extern ssize_t xpread(int fd, void *buf, size_t len, off_t offset);
112db553
LT
633extern int xdup(int fd);
634extern FILE *xfdopen(int fd, const char *mode);
635extern int xmkstemp(char *template);
463db9b1 636extern int xmkstemp_mode(char *template, int mode);
6e180cdc 637extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
8640d496 638extern int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1);
aa14e980 639extern char *xgetcwd(void);
f21a47b2 640
3ac22f82
RS
641#define REALLOC_ARRAY(x, alloc) (x) = xrealloc((x), (alloc) * sizeof(*(x)))
642
dc49cd76
SP
643static inline size_t xsize_t(off_t len)
644{
46be82df
TR
645 if (len > (size_t) len)
646 die("Cannot handle files this big");
dc49cd76
SP
647 return (size_t)len;
648}
649
f1589d10
RJ
650/* in ctype.c, for kwset users */
651extern const char tolower_trans_tbl[256];
652
4050c0df 653/* Sane ctype - no locale, and works with signed chars */
c2e9364a 654#undef isascii
4050c0df
JH
655#undef isspace
656#undef isdigit
657#undef isalpha
658#undef isalnum
0fcec2ce 659#undef isprint
43ccdf56
NK
660#undef islower
661#undef isupper
4050c0df
JH
662#undef tolower
663#undef toupper
1c149ab2
NTND
664#undef iscntrl
665#undef ispunct
666#undef isxdigit
2adf7247 667
ca5ab7d1 668extern const unsigned char sane_ctype[256];
4050c0df
JH
669#define GIT_SPACE 0x01
670#define GIT_DIGIT 0x02
671#define GIT_ALPHA 0x04
8cc32992 672#define GIT_GLOB_SPECIAL 0x08
f9b7cce6 673#define GIT_REGEX_SPECIAL 0x10
2f6c9760 674#define GIT_PATHSPEC_MAGIC 0x20
1c149ab2
NTND
675#define GIT_CNTRL 0x40
676#define GIT_PUNCT 0x80
4050c0df 677#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
c2e9364a 678#define isascii(x) (((x) & ~0x7f) == 0)
4050c0df
JH
679#define isspace(x) sane_istest(x,GIT_SPACE)
680#define isdigit(x) sane_istest(x,GIT_DIGIT)
681#define isalpha(x) sane_istest(x,GIT_ALPHA)
682#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
0fcec2ce 683#define isprint(x) ((x) >= 0x20 && (x) <= 0x7e)
43ccdf56
NK
684#define islower(x) sane_iscase(x, 1)
685#define isupper(x) sane_iscase(x, 0)
8cc32992 686#define is_glob_special(x) sane_istest(x,GIT_GLOB_SPECIAL)
f9b7cce6 687#define is_regex_special(x) sane_istest(x,GIT_GLOB_SPECIAL | GIT_REGEX_SPECIAL)
1c149ab2
NTND
688#define iscntrl(x) (sane_istest(x,GIT_CNTRL))
689#define ispunct(x) sane_istest(x, GIT_PUNCT | GIT_REGEX_SPECIAL | \
690 GIT_GLOB_SPECIAL | GIT_PATHSPEC_MAGIC)
50a71776 691#define isxdigit(x) (hexval_table[(unsigned char)(x)] != -1)
4050c0df
JH
692#define tolower(x) sane_case((unsigned char)(x), 0x20)
693#define toupper(x) sane_case((unsigned char)(x), 0)
2f6c9760 694#define is_pathspec_magic(x) sane_istest(x,GIT_PATHSPEC_MAGIC)
4050c0df
JH
695
696static inline int sane_case(int x, int high)
697{
698 if (sane_istest(x, GIT_ALPHA))
699 x = (x & ~0x20) | high;
700 return x;
701}
702
43ccdf56
NK
703static inline int sane_iscase(int x, int is_lower)
704{
705 if (!sane_istest(x, GIT_ALPHA))
706 return 0;
707
708 if (is_lower)
709 return (x & 0x20) != 0;
710 else
711 return (x & 0x20) == 0;
712}
713
6aead43d
JM
714static inline int strtoul_ui(char const *s, int base, unsigned int *result)
715{
716 unsigned long ul;
717 char *p;
718
719 errno = 0;
720 ul = strtoul(s, &p, base);
721 if (errno || *p || p == s || (unsigned int) ul != ul)
722 return -1;
723 *result = ul;
724 return 0;
725}
726
7791ecbc
JH
727static inline int strtol_i(char const *s, int base, int *result)
728{
729 long ul;
730 char *p;
731
732 errno = 0;
733 ul = strtol(s, &p, base);
734 if (errno || *p || p == s || (int) ul != ul)
735 return -1;
736 *result = ul;
737 return 0;
738}
739
43fe901b
BD
740#ifdef INTERNAL_QSORT
741void git_qsort(void *base, size_t nmemb, size_t size,
742 int(*compar)(const void *, const void *));
743#define qsort git_qsort
744#endif
745
81a24b52
AR
746#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
747# define FORCE_DIR_SET_GID S_ISGID
748#else
749# define FORCE_DIR_SET_GID 0
750#endif
751
c06ff490
KB
752#ifdef NO_NSEC
753#undef USE_NSEC
754#define ST_CTIME_NSEC(st) 0
755#define ST_MTIME_NSEC(st) 0
756#else
c567383b
BG
757#ifdef USE_ST_TIMESPEC
758#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctimespec.tv_nsec))
759#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtimespec.tv_nsec))
760#else
c06ff490
KB
761#define ST_CTIME_NSEC(st) ((unsigned int)((st).st_ctim.tv_nsec))
762#define ST_MTIME_NSEC(st) ((unsigned int)((st).st_mtim.tv_nsec))
763#endif
c567383b 764#endif
c06ff490 765
34779c53
JS
766#ifdef UNRELIABLE_FSTAT
767#define fstat_is_reliable() 0
768#else
769#define fstat_is_reliable() 1
770#endif
771
ab8632ae 772#ifndef va_copy
26db0f2e
JN
773/*
774 * Since an obvious implementation of va_list would be to make it a
775 * pointer into the stack frame, a simple assignment will work on
776 * many systems. But let's try to be more portable.
777 */
778#ifdef __va_copy
779#define va_copy(dst, src) __va_copy(dst, src)
780#else
781#define va_copy(dst, src) ((dst) = (src))
782#endif
ab8632ae
JK
783#endif
784
f51140c2 785#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__C99_MACRO_WITH_VA_ARGS)
e05bed96
KB
786#define HAVE_VARIADIC_MACROS 1
787#endif
788
fc71db39
AR
789/*
790 * Preserves errno, prints a message, but gives no warning for ENOENT.
1054af7d
RS
791 * Returns 0 on success, which includes trying to unlink an object that does
792 * not exist.
fc71db39
AR
793 */
794int unlink_or_warn(const char *path);
9ccc0c08
RS
795 /*
796 * Tries to unlink file. Returns 0 if unlink succeeded
797 * or the file already didn't exist. Returns -1 and
798 * appends a message to err suitable for
799 * 'error("%s", err->buf)' on error.
800 */
801int unlink_or_msg(const char *file, struct strbuf *err);
d1723296 802/*
1054af7d
RS
803 * Preserves errno, prints a message, but gives no warning for ENOENT.
804 * Returns 0 on success, which includes trying to remove a directory that does
805 * not exist.
d1723296
PC
806 */
807int rmdir_or_warn(const char *path);
80d706af
PC
808/*
809 * Calls the correct function out of {unlink,rmdir}_or_warn based on
810 * the supplied file mode.
811 */
812int remove_or_warn(unsigned int mode, const char *path);
fc71db39 813
e5c52c98
JN
814/*
815 * Call access(2), but warn for any error except "missing file"
816 * (ENOENT or ENOTDIR).
817 */
4698c8fe
JN
818#define ACCESS_EACCES_OK (1U << 0)
819int access_or_warn(const char *path, int mode, unsigned flag);
820int access_or_die(const char *path, int mode, unsigned flag);
ba8bd830 821
55b38a48
JH
822/* Warn on an inaccessible file that ought to be accessible */
823void warn_on_inaccessible(const char *path);
824
2f705875
JK
825/* Get the passwd entry for the UID of the current process. */
826struct passwd *xgetpwuid_self(void);
827
66547547
JK
828#ifdef GMTIME_UNRELIABLE_ERRORS
829struct tm *git_gmtime(const time_t *);
830struct tm *git_gmtime_r(const time_t *, struct tm *);
831#define gmtime git_gmtime
832#define gmtime_r git_gmtime_r
833#endif
834
4050c0df 835#endif