Move parse-options's skip_prefix() to git-compat-util.h
[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 */
10#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
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
JH
28#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
29
8723f216
NP
30#ifdef __GNUC__
31#define TYPEOF(x) (__typeof__(x))
32#else
33#define TYPEOF(x)
34#endif
35
36#define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
db7244bd 37#define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
8723f216 38
cf606e3d
AW
39/* Approximation of the length of the decimal representation of this type. */
40#define decimal_length(x) ((int)(sizeof(x) * 2.56 + 0.5) + 1)
41
457bb452 42#if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
85023577
JH
43#define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
44#define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
c902c9a6 45#endif
fb952206
JR
46#define _ALL_SOURCE 1
47#define _GNU_SOURCE 1
48#define _BSD_SOURCE 1
85023577 49
4050c0df
JH
50#include <unistd.h>
51#include <stdio.h>
52#include <sys/stat.h>
53#include <fcntl.h>
54#include <stddef.h>
55#include <stdlib.h>
56#include <stdarg.h>
57#include <string.h>
58#include <errno.h>
59#include <limits.h>
60#include <sys/param.h>
4050c0df
JH
61#include <sys/types.h>
62#include <dirent.h>
85023577
JH
63#include <sys/time.h>
64#include <time.h>
65#include <signal.h>
66#include <sys/wait.h>
67#include <fnmatch.h>
68#include <sys/poll.h>
69#include <sys/socket.h>
80bbe72b 70#include <sys/ioctl.h>
f746bae8 71#include <utime.h>
2600973f 72#ifndef NO_SYS_SELECT_H
80bbe72b 73#include <sys/select.h>
2600973f 74#endif
85023577
JH
75#include <assert.h>
76#include <regex.h>
77#include <netinet/in.h>
78#include <netinet/tcp.h>
79#include <arpa/inet.h>
80#include <netdb.h>
81#include <pwd.h>
007e2ba6 82#include <inttypes.h>
41b20017
RJ
83#if defined(__CYGWIN__)
84#undef _XOPEN_SOURCE
85#include <grp.h>
86#define _XOPEN_SOURCE 600
87#else
fb952206 88#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 89#include <grp.h>
fb952206 90#define _ALL_SOURCE 1
41b20017 91#endif
85023577
JH
92
93#ifndef NO_ICONV
94#include <iconv.h>
95#endif
4050c0df 96
d0c2449f
JH
97/* On most systems <limits.h> would have given us this, but
98 * not on some systems (e.g. GNU/Hurd).
99 */
100#ifndef PATH_MAX
101#define PATH_MAX 4096
102#endif
103
c4001d92
SP
104#ifndef PRIuMAX
105#define PRIuMAX "llu"
106#endif
107
4050c0df
JH
108#ifdef __GNUC__
109#define NORETURN __attribute__((__noreturn__))
110#else
111#define NORETURN
112#ifndef __attribute__
113#define __attribute__(x)
114#endif
115#endif
116
117/* General helper functions */
118extern void usage(const char *err) NORETURN;
119extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
120extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 121extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 122
39a3f5ea
PB
123extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
124extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
125extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 126extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 127
698a68be
JH
128extern int prefixcmp(const char *str, const char *prefix);
129
fbca5837
MV
130static inline const char *skip_prefix(const char *str, const char *prefix)
131{
132 size_t len = strlen(prefix);
133 return strncmp(str, prefix, len) ? NULL : str + len;
134}
135
4050c0df
JH
136#ifdef NO_MMAP
137
138#ifndef PROT_READ
139#define PROT_READ 1
140#define PROT_WRITE 2
141#define MAP_PRIVATE 1
142#define MAP_FAILED ((void*)-1)
143#endif
144
d6779124
SP
145#define mmap git_mmap
146#define munmap git_munmap
147extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
148extern int git_munmap(void *start, size_t length);
4050c0df 149
5faaf246 150/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
151#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
152
4050c0df
JH
153#else /* NO_MMAP */
154
155#include <sys/mman.h>
5faaf246
JH
156
157/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
158#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
159 (sizeof(void*) >= 8 \
160 ? 1 * 1024 * 1024 * 1024 \
161 : 32 * 1024 * 1024)
4050c0df
JH
162
163#endif /* NO_MMAP */
164
22bac0ea 165#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 166 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 167
6900679c
SH
168#ifdef NO_PREAD
169#define pread git_pread
170extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
171#endif
172
4050c0df
JH
173#ifdef NO_SETENV
174#define setenv gitsetenv
175extern int gitsetenv(const char *, const char *, int);
176#endif
177
ca5bb5d5
SP
178#ifdef NO_MKDTEMP
179#define mkdtemp gitmkdtemp
180extern char *gitmkdtemp(char *);
181#endif
182
731043fd
JR
183#ifdef NO_UNSETENV
184#define unsetenv gitunsetenv
185extern void gitunsetenv(const char *);
186#endif
187
4050c0df
JH
188#ifdef NO_STRCASESTR
189#define strcasestr gitstrcasestr
190extern char *gitstrcasestr(const char *haystack, const char *needle);
191#endif
192
817151e6
PE
193#ifdef NO_STRLCPY
194#define strlcpy gitstrlcpy
195extern size_t gitstrlcpy(char *, const char *, size_t);
196#endif
197
bc6b4f52
JR
198#ifdef NO_STRTOUMAX
199#define strtoumax gitstrtoumax
200extern uintmax_t gitstrtoumax(const char *, char **, int);
201#endif
202
fa0c87c3
AR
203#ifdef NO_HSTRERROR
204#define hstrerror githstrerror
205extern const char *githstrerror(int herror);
206#endif
207
b21b9f1d
RS
208#ifdef NO_MEMMEM
209#define memmem gitmemmem
210void *gitmemmem(const void *haystack, size_t haystacklen,
211 const void *needle, size_t needlelen);
212#endif
213
cba22528 214#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
215#ifdef fopen
216#undef fopen
217#endif
cba22528
BC
218#define fopen(a,b) git_fopen(a,b)
219extern FILE *git_fopen(const char*, const char*);
220#endif
221
c4582f93
MR
222#ifdef SNPRINTF_RETURNS_BOGUS
223#define snprintf git_snprintf
224extern int git_snprintf(char *str, size_t maxsize,
225 const char *format, ...);
226#define vsnprintf git_vsnprintf
227extern int git_vsnprintf(char *str, size_t maxsize,
228 const char *format, va_list ap);
229#endif
230
726c8ef5
JS
231#ifdef __GLIBC_PREREQ
232#if __GLIBC_PREREQ(2, 1)
233#define HAVE_STRCHRNUL
234#endif
235#endif
236
237#ifndef HAVE_STRCHRNUL
659c69cf 238#define strchrnul gitstrchrnul
9e79f00f
AE
239static inline char *gitstrchrnul(const char *s, int c)
240{
241 while (*s && *s != c)
242 s++;
243 return (char *)s;
244}
659c69cf
RS
245#endif
246
d1efefa4 247extern void release_pack_memory(size_t, int);
97bfeb34 248
112db553
LT
249extern char *xstrdup(const char *str);
250extern void *xmalloc(size_t size);
251extern void *xmemdupz(const void *data, size_t len);
252extern char *xstrndup(const char *str, size_t len);
253extern void *xrealloc(void *ptr, size_t size);
254extern void *xcalloc(size_t nmemb, size_t size);
255extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
256extern ssize_t xread(int fd, void *buf, size_t len);
257extern ssize_t xwrite(int fd, const void *buf, size_t len);
258extern int xdup(int fd);
259extern FILE *xfdopen(int fd, const char *mode);
260extern int xmkstemp(char *template);
f21a47b2 261
dc49cd76
SP
262static inline size_t xsize_t(off_t len)
263{
264 return (size_t)len;
265}
266
5bb1cda5 267static inline int has_extension(const char *filename, const char *ext)
83a2b841 268{
5bb1cda5
RS
269 size_t len = strlen(filename);
270 size_t extlen = strlen(ext);
83a2b841
RS
271 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
272}
273
4050c0df
JH
274/* Sane ctype - no locale, and works with signed chars */
275#undef isspace
276#undef isdigit
277#undef isalpha
278#undef isalnum
279#undef tolower
280#undef toupper
281extern unsigned char sane_ctype[256];
282#define GIT_SPACE 0x01
283#define GIT_DIGIT 0x02
284#define GIT_ALPHA 0x04
285#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
286#define isspace(x) sane_istest(x,GIT_SPACE)
287#define isdigit(x) sane_istest(x,GIT_DIGIT)
288#define isalpha(x) sane_istest(x,GIT_ALPHA)
289#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
290#define tolower(x) sane_case((unsigned char)(x), 0x20)
291#define toupper(x) sane_case((unsigned char)(x), 0)
292
293static inline int sane_case(int x, int high)
294{
295 if (sane_istest(x, GIT_ALPHA))
296 x = (x & ~0x20) | high;
297 return x;
298}
299
6aead43d
JM
300static inline int strtoul_ui(char const *s, int base, unsigned int *result)
301{
302 unsigned long ul;
303 char *p;
304
305 errno = 0;
306 ul = strtoul(s, &p, base);
307 if (errno || *p || p == s || (unsigned int) ul != ul)
308 return -1;
309 *result = ul;
310 return 0;
311}
312
7791ecbc
JH
313static inline int strtol_i(char const *s, int base, int *result)
314{
315 long ul;
316 char *p;
317
318 errno = 0;
319 ul = strtol(s, &p, base);
320 if (errno || *p || p == s || (int) ul != ul)
321 return -1;
322 *result = ul;
323 return 0;
324}
325
43fe901b
BD
326#ifdef INTERNAL_QSORT
327void git_qsort(void *base, size_t nmemb, size_t size,
328 int(*compar)(const void *, const void *));
329#define qsort git_qsort
330#endif
331
81a24b52
AR
332#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
333# define FORCE_DIR_SET_GID S_ISGID
334#else
335# define FORCE_DIR_SET_GID 0
336#endif
337
4050c0df 338#endif