t9100-git-svn-basic.sh: Fix determination of utf-8 locale
[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>
85023577 66#include <fnmatch.h>
f4626df5
JS
67#include <assert.h>
68#include <regex.h>
69#include <utime.h>
70#ifndef __MINGW32__
71#include <sys/wait.h>
85023577
JH
72#include <sys/poll.h>
73#include <sys/socket.h>
80bbe72b 74#include <sys/ioctl.h>
2600973f 75#ifndef NO_SYS_SELECT_H
80bbe72b 76#include <sys/select.h>
2600973f 77#endif
85023577
JH
78#include <netinet/in.h>
79#include <netinet/tcp.h>
80#include <arpa/inet.h>
81#include <netdb.h>
82#include <pwd.h>
007e2ba6 83#include <inttypes.h>
41b20017
RJ
84#if defined(__CYGWIN__)
85#undef _XOPEN_SOURCE
86#include <grp.h>
87#define _XOPEN_SOURCE 600
88#else
fb952206 89#undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
85023577 90#include <grp.h>
fb952206 91#define _ALL_SOURCE 1
41b20017 92#endif
f4626df5
JS
93#else /* __MINGW32__ */
94/* pull in Windows compatibility stuff */
95#include "compat/mingw.h"
96#endif /* __MINGW32__ */
85023577
JH
97
98#ifndef NO_ICONV
99#include <iconv.h>
100#endif
4050c0df 101
d0c2449f
JH
102/* On most systems <limits.h> would have given us this, but
103 * not on some systems (e.g. GNU/Hurd).
104 */
105#ifndef PATH_MAX
106#define PATH_MAX 4096
107#endif
108
c4001d92
SP
109#ifndef PRIuMAX
110#define PRIuMAX "llu"
111#endif
112
80ba074f
JS
113#ifndef PATH_SEP
114#define PATH_SEP ':'
115#endif
116
23326d14
JS
117#ifndef STRIP_EXTENSION
118#define STRIP_EXTENSION ""
119#endif
120
25fe217b
JS
121#ifndef has_dos_drive_prefix
122#define has_dos_drive_prefix(path) 0
123#endif
124
125#ifndef is_dir_sep
126#define is_dir_sep(c) ((c) == '/')
127#endif
128
4050c0df
JH
129#ifdef __GNUC__
130#define NORETURN __attribute__((__noreturn__))
131#else
132#define NORETURN
133#ifndef __attribute__
134#define __attribute__(x)
135#endif
136#endif
137
138/* General helper functions */
139extern void usage(const char *err) NORETURN;
140extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
141extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
46efd2d9 142extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
4050c0df 143
39a3f5ea
PB
144extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
145extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
146extern void set_error_routine(void (*routine)(const char *err, va_list params));
fa39b6b5 147extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
39a3f5ea 148
698a68be 149extern int prefixcmp(const char *str, const char *prefix);
bb5799d6 150extern time_t tm_to_time_t(const struct tm *tm);
698a68be 151
4050c0df
JH
152#ifdef NO_MMAP
153
154#ifndef PROT_READ
155#define PROT_READ 1
156#define PROT_WRITE 2
157#define MAP_PRIVATE 1
158#define MAP_FAILED ((void*)-1)
159#endif
160
d6779124
SP
161#define mmap git_mmap
162#define munmap git_munmap
163extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
164extern int git_munmap(void *start, size_t length);
4050c0df 165
5faaf246 166/* This value must be multiple of (pagesize * 2) */
8c82534d
SP
167#define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
168
4050c0df
JH
169#else /* NO_MMAP */
170
171#include <sys/mman.h>
5faaf246
JH
172
173/* This value must be multiple of (pagesize * 2) */
22bac0ea
SP
174#define DEFAULT_PACKED_GIT_WINDOW_SIZE \
175 (sizeof(void*) >= 8 \
176 ? 1 * 1024 * 1024 * 1024 \
177 : 32 * 1024 * 1024)
4050c0df
JH
178
179#endif /* NO_MMAP */
180
22bac0ea 181#define DEFAULT_PACKED_GIT_LIMIT \
ecaebf4a 182 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
8c82534d 183
6900679c
SH
184#ifdef NO_PREAD
185#define pread git_pread
186extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
187#endif
14086b0a
SP
188/*
189 * Forward decl that will remind us if its twin in cache.h changes.
190 * This function is used in compat/pread.c. But we can't include
191 * cache.h there.
192 */
193extern ssize_t read_in_full(int fd, void *buf, size_t count);
6900679c 194
4050c0df
JH
195#ifdef NO_SETENV
196#define setenv gitsetenv
197extern int gitsetenv(const char *, const char *, int);
198#endif
199
ca5bb5d5
SP
200#ifdef NO_MKDTEMP
201#define mkdtemp gitmkdtemp
202extern char *gitmkdtemp(char *);
203#endif
204
731043fd
JR
205#ifdef NO_UNSETENV
206#define unsetenv gitunsetenv
207extern void gitunsetenv(const char *);
208#endif
209
4050c0df
JH
210#ifdef NO_STRCASESTR
211#define strcasestr gitstrcasestr
212extern char *gitstrcasestr(const char *haystack, const char *needle);
213#endif
214
817151e6
PE
215#ifdef NO_STRLCPY
216#define strlcpy gitstrlcpy
217extern size_t gitstrlcpy(char *, const char *, size_t);
218#endif
219
bc6b4f52
JR
220#ifdef NO_STRTOUMAX
221#define strtoumax gitstrtoumax
222extern uintmax_t gitstrtoumax(const char *, char **, int);
223#endif
224
fa0c87c3
AR
225#ifdef NO_HSTRERROR
226#define hstrerror githstrerror
227extern const char *githstrerror(int herror);
228#endif
229
b21b9f1d
RS
230#ifdef NO_MEMMEM
231#define memmem gitmemmem
232void *gitmemmem(const void *haystack, size_t haystacklen,
233 const void *needle, size_t needlelen);
234#endif
235
cba22528 236#ifdef FREAD_READS_DIRECTORIES
c5445fe0
JS
237#ifdef fopen
238#undef fopen
239#endif
cba22528
BC
240#define fopen(a,b) git_fopen(a,b)
241extern FILE *git_fopen(const char*, const char*);
242#endif
243
c4582f93
MR
244#ifdef SNPRINTF_RETURNS_BOGUS
245#define snprintf git_snprintf
246extern int git_snprintf(char *str, size_t maxsize,
247 const char *format, ...);
248#define vsnprintf git_vsnprintf
249extern int git_vsnprintf(char *str, size_t maxsize,
250 const char *format, va_list ap);
251#endif
252
726c8ef5
JS
253#ifdef __GLIBC_PREREQ
254#if __GLIBC_PREREQ(2, 1)
255#define HAVE_STRCHRNUL
256#endif
257#endif
258
259#ifndef HAVE_STRCHRNUL
659c69cf 260#define strchrnul gitstrchrnul
9e79f00f
AE
261static inline char *gitstrchrnul(const char *s, int c)
262{
263 while (*s && *s != c)
264 s++;
265 return (char *)s;
266}
659c69cf
RS
267#endif
268
d1efefa4 269extern void release_pack_memory(size_t, int);
97bfeb34 270
112db553
LT
271extern char *xstrdup(const char *str);
272extern void *xmalloc(size_t size);
273extern void *xmemdupz(const void *data, size_t len);
274extern char *xstrndup(const char *str, size_t len);
275extern void *xrealloc(void *ptr, size_t size);
276extern void *xcalloc(size_t nmemb, size_t size);
277extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
278extern ssize_t xread(int fd, void *buf, size_t len);
279extern ssize_t xwrite(int fd, const void *buf, size_t len);
280extern int xdup(int fd);
281extern FILE *xfdopen(int fd, const char *mode);
282extern int xmkstemp(char *template);
f21a47b2 283
dc49cd76
SP
284static inline size_t xsize_t(off_t len)
285{
286 return (size_t)len;
287}
288
5bb1cda5 289static inline int has_extension(const char *filename, const char *ext)
83a2b841 290{
5bb1cda5
RS
291 size_t len = strlen(filename);
292 size_t extlen = strlen(ext);
83a2b841
RS
293 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
294}
295
4050c0df
JH
296/* Sane ctype - no locale, and works with signed chars */
297#undef isspace
298#undef isdigit
299#undef isalpha
300#undef isalnum
301#undef tolower
302#undef toupper
303extern unsigned char sane_ctype[256];
304#define GIT_SPACE 0x01
305#define GIT_DIGIT 0x02
306#define GIT_ALPHA 0x04
307#define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
308#define isspace(x) sane_istest(x,GIT_SPACE)
309#define isdigit(x) sane_istest(x,GIT_DIGIT)
310#define isalpha(x) sane_istest(x,GIT_ALPHA)
311#define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
312#define tolower(x) sane_case((unsigned char)(x), 0x20)
313#define toupper(x) sane_case((unsigned char)(x), 0)
314
315static inline int sane_case(int x, int high)
316{
317 if (sane_istest(x, GIT_ALPHA))
318 x = (x & ~0x20) | high;
319 return x;
320}
321
6aead43d
JM
322static inline int strtoul_ui(char const *s, int base, unsigned int *result)
323{
324 unsigned long ul;
325 char *p;
326
327 errno = 0;
328 ul = strtoul(s, &p, base);
329 if (errno || *p || p == s || (unsigned int) ul != ul)
330 return -1;
331 *result = ul;
332 return 0;
333}
334
7791ecbc
JH
335static inline int strtol_i(char const *s, int base, int *result)
336{
337 long ul;
338 char *p;
339
340 errno = 0;
341 ul = strtol(s, &p, base);
342 if (errno || *p || p == s || (int) ul != ul)
343 return -1;
344 *result = ul;
345 return 0;
346}
347
43fe901b
BD
348#ifdef INTERNAL_QSORT
349void git_qsort(void *base, size_t nmemb, size_t size,
350 int(*compar)(const void *, const void *));
351#define qsort git_qsort
352#endif
353
81a24b52
AR
354#ifndef DIR_HAS_BSD_GROUP_SEMANTICS
355# define FORCE_DIR_SET_GID S_ISGID
356#else
357# define FORCE_DIR_SET_GID 0
358#endif
359
4050c0df 360#endif