manpages: italicize git command names (which were in teletype font)
[git/mjg.git] / git-compat-util.h
blob545df5924247c9d4ffe700db6c158715561f6a62
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)
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]))
30 #ifdef __GNUC__
31 #define TYPEOF(x) (__typeof__(x))
32 #else
33 #define TYPEOF(x)
34 #endif
36 #define MSB(x, bits) ((x) & TYPEOF(x)(~0ULL << (sizeof(x) * 8 - (bits))))
37 #define HAS_MULTI_BITS(i) ((i) & ((i) - 1)) /* checks if an integer has more than 1 bit set */
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)
42 #if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__USLC__) && !defined(_M_UNIX)
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 */
45 #endif
46 #define _ALL_SOURCE 1
47 #define _GNU_SOURCE 1
48 #define _BSD_SOURCE 1
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>
61 #include <sys/types.h>
62 #include <dirent.h>
63 #include <sys/time.h>
64 #include <time.h>
65 #include <signal.h>
66 #include <fnmatch.h>
67 #include <assert.h>
68 #include <regex.h>
69 #include <utime.h>
70 #ifndef __MINGW32__
71 #include <sys/wait.h>
72 #include <sys/poll.h>
73 #include <sys/socket.h>
74 #include <sys/ioctl.h>
75 #ifndef NO_SYS_SELECT_H
76 #include <sys/select.h>
77 #endif
78 #include <netinet/in.h>
79 #include <netinet/tcp.h>
80 #include <arpa/inet.h>
81 #include <netdb.h>
82 #include <pwd.h>
83 #include <inttypes.h>
84 #if defined(__CYGWIN__)
85 #undef _XOPEN_SOURCE
86 #include <grp.h>
87 #define _XOPEN_SOURCE 600
88 #else
89 #undef _ALL_SOURCE /* AIX 5.3L defines a struct list with _ALL_SOURCE. */
90 #include <grp.h>
91 #define _ALL_SOURCE 1
92 #endif
93 #else /* __MINGW32__ */
94 /* pull in Windows compatibility stuff */
95 #include "compat/mingw.h"
96 #endif /* __MINGW32__ */
98 #ifndef NO_ICONV
99 #include <iconv.h>
100 #endif
102 /* On most systems <limits.h> would have given us this, but
103 * not on some systems (e.g. GNU/Hurd).
105 #ifndef PATH_MAX
106 #define PATH_MAX 4096
107 #endif
109 #ifndef PRIuMAX
110 #define PRIuMAX "llu"
111 #endif
113 #ifndef PATH_SEP
114 #define PATH_SEP ':'
115 #endif
117 #ifndef STRIP_EXTENSION
118 #define STRIP_EXTENSION ""
119 #endif
121 #ifndef has_dos_drive_prefix
122 #define has_dos_drive_prefix(path) 0
123 #endif
125 #ifndef is_dir_sep
126 #define is_dir_sep(c) ((c) == '/')
127 #endif
129 #ifdef __GNUC__
130 #define NORETURN __attribute__((__noreturn__))
131 #else
132 #define NORETURN
133 #ifndef __attribute__
134 #define __attribute__(x)
135 #endif
136 #endif
138 /* General helper functions */
139 extern void usage(const char *err) NORETURN;
140 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
141 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
142 extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)));
144 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
145 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
146 extern void set_error_routine(void (*routine)(const char *err, va_list params));
147 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
149 extern int prefixcmp(const char *str, const char *prefix);
150 extern time_t tm_to_time_t(const struct tm *tm);
152 #ifdef NO_MMAP
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
161 #define mmap git_mmap
162 #define munmap git_munmap
163 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
164 extern int git_munmap(void *start, size_t length);
166 /* This value must be multiple of (pagesize * 2) */
167 #define DEFAULT_PACKED_GIT_WINDOW_SIZE (1 * 1024 * 1024)
169 #else /* NO_MMAP */
171 #include <sys/mman.h>
173 /* This value must be multiple of (pagesize * 2) */
174 #define DEFAULT_PACKED_GIT_WINDOW_SIZE \
175 (sizeof(void*) >= 8 \
176 ? 1 * 1024 * 1024 * 1024 \
177 : 32 * 1024 * 1024)
179 #endif /* NO_MMAP */
181 #define DEFAULT_PACKED_GIT_LIMIT \
182 ((1024L * 1024L) * (sizeof(void*) >= 8 ? 8192 : 256))
184 #ifdef NO_PREAD
185 #define pread git_pread
186 extern ssize_t git_pread(int fd, void *buf, size_t count, off_t offset);
187 #endif
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.
193 extern ssize_t read_in_full(int fd, void *buf, size_t count);
195 #ifdef NO_SETENV
196 #define setenv gitsetenv
197 extern int gitsetenv(const char *, const char *, int);
198 #endif
200 #ifdef NO_MKDTEMP
201 #define mkdtemp gitmkdtemp
202 extern char *gitmkdtemp(char *);
203 #endif
205 #ifdef NO_UNSETENV
206 #define unsetenv gitunsetenv
207 extern void gitunsetenv(const char *);
208 #endif
210 #ifdef NO_STRCASESTR
211 #define strcasestr gitstrcasestr
212 extern char *gitstrcasestr(const char *haystack, const char *needle);
213 #endif
215 #ifdef NO_STRLCPY
216 #define strlcpy gitstrlcpy
217 extern size_t gitstrlcpy(char *, const char *, size_t);
218 #endif
220 #ifdef NO_STRTOUMAX
221 #define strtoumax gitstrtoumax
222 extern uintmax_t gitstrtoumax(const char *, char **, int);
223 #endif
225 #ifdef NO_HSTRERROR
226 #define hstrerror githstrerror
227 extern const char *githstrerror(int herror);
228 #endif
230 #ifdef NO_MEMMEM
231 #define memmem gitmemmem
232 void *gitmemmem(const void *haystack, size_t haystacklen,
233 const void *needle, size_t needlelen);
234 #endif
236 #ifdef FREAD_READS_DIRECTORIES
237 #ifdef fopen
238 #undef fopen
239 #endif
240 #define fopen(a,b) git_fopen(a,b)
241 extern FILE *git_fopen(const char*, const char*);
242 #endif
244 #ifdef SNPRINTF_RETURNS_BOGUS
245 #define snprintf git_snprintf
246 extern int git_snprintf(char *str, size_t maxsize,
247 const char *format, ...);
248 #define vsnprintf git_vsnprintf
249 extern int git_vsnprintf(char *str, size_t maxsize,
250 const char *format, va_list ap);
251 #endif
253 #ifdef __GLIBC_PREREQ
254 #if __GLIBC_PREREQ(2, 1)
255 #define HAVE_STRCHRNUL
256 #endif
257 #endif
259 #ifndef HAVE_STRCHRNUL
260 #define strchrnul gitstrchrnul
261 static inline char *gitstrchrnul(const char *s, int c)
263 while (*s && *s != c)
264 s++;
265 return (char *)s;
267 #endif
269 extern void release_pack_memory(size_t, int);
271 extern char *xstrdup(const char *str);
272 extern void *xmalloc(size_t size);
273 extern void *xmemdupz(const void *data, size_t len);
274 extern char *xstrndup(const char *str, size_t len);
275 extern void *xrealloc(void *ptr, size_t size);
276 extern void *xcalloc(size_t nmemb, size_t size);
277 extern void *xmmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
278 extern ssize_t xread(int fd, void *buf, size_t len);
279 extern ssize_t xwrite(int fd, const void *buf, size_t len);
280 extern int xdup(int fd);
281 extern FILE *xfdopen(int fd, const char *mode);
282 extern int xmkstemp(char *template);
284 static inline size_t xsize_t(off_t len)
286 return (size_t)len;
289 static inline int has_extension(const char *filename, const char *ext)
291 size_t len = strlen(filename);
292 size_t extlen = strlen(ext);
293 return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
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
303 extern 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)
315 static inline int sane_case(int x, int high)
317 if (sane_istest(x, GIT_ALPHA))
318 x = (x & ~0x20) | high;
319 return x;
322 static inline int strtoul_ui(char const *s, int base, unsigned int *result)
324 unsigned long ul;
325 char *p;
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;
335 static inline int strtol_i(char const *s, int base, int *result)
337 long ul;
338 char *p;
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;
348 #ifdef INTERNAL_QSORT
349 void git_qsort(void *base, size_t nmemb, size_t size,
350 int(*compar)(const void *, const void *));
351 #define qsort git_qsort
352 #endif
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
360 #endif