Document 'git-log --decorate'
[git/git-p4.git] / git-compat-util.h
blobc08688c8f355ccf61a746bbe1ac9a6788bdea7e3
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
4 #define _FILE_OFFSET_BITS 64
6 #ifndef FLEX_ARRAY
7 #if defined(__GNUC__) && (__GNUC__ < 3)
8 #define FLEX_ARRAY 0
9 #else
10 #define FLEX_ARRAY /* empty */
11 #endif
12 #endif
14 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
16 #ifdef __GNUC__
17 #define TYPEOF(x) (__typeof__(x))
18 #else
19 #define TYPEOF(x)
20 #endif
22 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
24 #if !defined(__APPLE__) && !defined(__FreeBSD__)
25 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
26 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
27 #endif
28 #define _ALL_SOURCE 1
29 #define _GNU_SOURCE 1
30 #define _BSD_SOURCE 1
32 #include <unistd.h>
33 #include <stdio.h>
34 #include <sys/stat.h>
35 #include <fcntl.h>
36 #include <stddef.h>
37 #include <stdlib.h>
38 #include <stdarg.h>
39 #include <string.h>
40 #include <errno.h>
41 #include <limits.h>
42 #include <sys/param.h>
43 #include <sys/types.h>
44 #include <dirent.h>
45 #include <sys/time.h>
46 #include <time.h>
47 #include <signal.h>
48 #include <sys/wait.h>
49 #include <fnmatch.h>
50 #include <sys/poll.h>
51 #include <sys/socket.h>
52 #include <assert.h>
53 #include <regex.h>
54 #include <netinet/in.h>
55 #include <netinet/tcp.h>
56 #include <arpa/inet.h>
57 #include <netdb.h>
58 #include <pwd.h>
59 #include <inttypes.h>
60 #if defined(__CYGWIN__)
61 #undef _XOPEN_SOURCE
62 #include <grp.h>
63 #define _XOPEN_SOURCE 600
64 #else
65 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
66 #include <grp.h>
67 #define _ALL_SOURCE 1
68 #endif
70 #ifndef NO_ICONV
71 #include <iconv.h>
72 #endif
74 /* On most systems <limits.h> would have given us this, but
75 * not on some systems (e.g. GNU/Hurd).
77 #ifndef PATH_MAX
78 #define PATH_MAX 4096
79 #endif
81 #ifndef PRIuMAX
82 #define PRIuMAX "llu"
83 #endif
85 #ifdef __GNUC__
86 #define NORETURN __attribute__((__noreturn__))
87 #else
88 #define NORETURN
89 #ifndef __attribute__
90 #define __attribute__(x)
91 #endif
92 #endif
94 /* General helper functions */
95 extern void usage(const char *err) NORETURN;
96 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
97 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
98 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
100 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
101 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
102 extern void set_error_routine(void (*routine)(const char *err, va_list params));
103 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
105 #ifdef NO_MMAP
107 #ifndef PROT_READ
108 #define PROT_READ 1
109 #define PROT_WRITE 2
110 #define MAP_PRIVATE 1
111 #define MAP_FAILED ((void*)-1)
112 #endif
114 #define mmap git_mmap
115 #define munmap git_munmap
116 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
117 extern int git_munmap(void *start, size_t length);
119 /* This value must be multiple of (pagesize * 2) */
120 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
122 #else /* NO_MMAP */
124 #include <sys/mman.h>
126 /* This value must be multiple of (pagesize * 2) */
127 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
128 (sizeof(void*) >= 8 \
129 ? 1 * 1024 * 1024 * 1024 \
130 : 32 * 1024 * 1024)
132 #endif /* NO_MMAP */
134 #define DEFAULT_PACKED_GIT_LIMIT \
135 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
137 #ifdef NO_PREAD
138 #define pread git_pread
139 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
140 #endif
142 #ifdef NO_SETENV
143 #define setenv gitsetenv
144 extern int gitsetenv(const char *, const char *, int);
145 #endif
147 #ifdef NO_UNSETENV
148 #define unsetenv gitunsetenv
149 extern void gitunsetenv(const char *);
150 #endif
152 #ifdef NO_STRCASESTR
153 #define strcasestr gitstrcasestr
154 extern char *gitstrcasestr(const char *haystack, const char *needle);
155 #endif
157 #ifdef NO_STRLCPY
158 #define strlcpy gitstrlcpy
159 extern size_t gitstrlcpy(char *, const char *, size_t);
160 #endif
162 #ifdef NO_STRTOUMAX
163 #define strtoumax gitstrtoumax
164 extern uintmax_t gitstrtoumax(const char *, char **, int);
165 #endif
167 extern void release_pack_memory(size_t, int);
169 static inline char* xstrdup(const char *str)
171 char *ret = strdup(str);
172 if (!ret) {
173 release_pack_memory(strlen(str) + 1, -1);
174 ret = strdup(str);
175 if (!ret)
176 die("Out of memory, strdup failed");
178 return ret;
181 static inline void *xmalloc(size_t size)
183 void *ret = malloc(size);
184 if (!ret && !size)
185 ret = malloc(1);
186 if (!ret) {
187 release_pack_memory(size, -1);
188 ret = malloc(size);
189 if (!ret && !size)
190 ret = malloc(1);
191 if (!ret)
192 die("Out of memory, malloc failed");
194 #ifdef XMALLOC_POISON
195 memset(ret, 0xA5, size);
196 #endif
197 return ret;
200 static inline char *xstrndup(const char *str, size_t len)
202 char *p;
204 p = memchr(str, '\0', len);
205 if (p)
206 len = p - str;
207 p = xmalloc(len + 1);
208 memcpy(p, str, len);
209 p[len] = '\0';
210 return p;
213 static inline void *xrealloc(void *ptr, size_t size)
215 void *ret = realloc(ptr, size);
216 if (!ret && !size)
217 ret = realloc(ptr, 1);
218 if (!ret) {
219 release_pack_memory(size, -1);
220 ret = realloc(ptr, size);
221 if (!ret && !size)
222 ret = realloc(ptr, 1);
223 if (!ret)
224 die("Out of memory, realloc failed");
226 return ret;
229 static inline void *xcalloc(size_t nmemb, size_t size)
231 void *ret = calloc(nmemb, size);
232 if (!ret && (!nmemb || !size))
233 ret = calloc(1, 1);
234 if (!ret) {
235 release_pack_memory(nmemb * size, -1);
236 ret = calloc(nmemb, size);
237 if (!ret && (!nmemb || !size))
238 ret = calloc(1, 1);
239 if (!ret)
240 die("Out of memory, calloc failed");
242 return ret;
245 static inline void *xmmap(void *start, size_t length,
246 int prot, int flags, int fd, off_t offset)
248 void *ret = mmap(start, length, prot, flags, fd, offset);
249 if (ret == MAP_FAILED) {
250 if (!length)
251 return NULL;
252 release_pack_memory(length, fd);
253 ret = mmap(start, length, prot, flags, fd, offset);
254 if (ret == MAP_FAILED)
255 die("Out of memory? mmap failed: %s", strerror(errno));
257 return ret;
260 static inline ssize_t xread(int fd, void *buf, size_t len)
262 ssize_t nr;
263 while (1) {
264 nr = read(fd, buf, len);
265 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
266 continue;
267 return nr;
271 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
273 ssize_t nr;
274 while (1) {
275 nr = write(fd, buf, len);
276 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
277 continue;
278 return nr;
282 static inline size_t xsize_t(off_t len)
284 return (size_t)len;
287 static inline int has_extension(const char *filename, const char *ext)
289 size_t len = strlen(filename);
290 size_t extlen = strlen(ext);
291 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
294 /* Sane ctype - no locale, and works with signed chars */
295 #undef isspace
296 #undef isdigit
297 #undef isalpha
298 #undef isalnum
299 #undef tolower
300 #undef toupper
301 extern unsigned char sane_ctype[256];
302 #define GIT_SPACE 0x01
303 #define GIT_DIGIT 0x02
304 #define GIT_ALPHA 0x04
305 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
306 #define isspace(x) sane_istest(x,GIT_SPACE)
307 #define isdigit(x) sane_istest(x,GIT_DIGIT)
308 #define isalpha(x) sane_istest(x,GIT_ALPHA)
309 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
310 #define tolower(x) sane_case((unsigned char)(x), 0x20)
311 #define toupper(x) sane_case((unsigned char)(x), 0)
313 static inline int sane_case(int x, int high)
315 if (sane_istest(x, GIT_ALPHA))
316 x = (x & ~0x20) | high;
317 return x;
320 static inline int prefixcmp(const char *str, const char *prefix)
322 return strncmp(str, prefix, strlen(prefix));
325 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
327 unsigned long ul;
328 char *p;
330 errno = 0;
331 ul = strtoul(s, &p, base);
332 if (errno || *p || p == s || (unsigned int) ul != ul)
333 return -1;
334 *result = ul;
335 return 0;
338 #endif