Documentation: remove master:origin example from pull-fetch-param.txt
[git] / git-compat-util.h
1 #ifndef GIT_COMPAT_UTIL_H
2 #define GIT_COMPAT_UTIL_H
3
4 #ifndef FLEX_ARRAY
5 #if defined(__GNUC__) && (__GNUC__ < 3)
6 #define FLEX_ARRAY 0
7 #else
8 #define FLEX_ARRAY /* empty */
9 #endif
10 #endif
11
12 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
13
14 #if !defined(__APPLE__) && !defined(__FreeBSD__)
15 #define _XOPEN_SOURCE 600 /* glibc2 and AIX 5.3L need 500, OpenBSD needs 600 for S_ISLNK() */
16 #define _XOPEN_SOURCE_EXTENDED 1 /* AIX 5.3L needs this */
17 #endif
18 #define _GNU_SOURCE
19 #define _BSD_SOURCE
20
21 #include <unistd.h>
22 #include <stdio.h>
23 #include <sys/stat.h>
24 #include <fcntl.h>
25 #include <stddef.h>
26 #include <stdlib.h>
27 #include <stdarg.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <limits.h>
31 #include <sys/param.h>
32 #include <sys/types.h>
33 #include <dirent.h>
34 #include <sys/time.h>
35 #include <time.h>
36 #include <signal.h>
37 #include <sys/wait.h>
38 #include <fnmatch.h>
39 #include <sys/poll.h>
40 #include <sys/socket.h>
41 #include <assert.h>
42 #include <regex.h>
43 #include <netinet/in.h>
44 #include <netinet/tcp.h>
45 #include <arpa/inet.h>
46 #include <netdb.h>
47 #include <pwd.h>
48 #include <grp.h>
49
50 #ifndef NO_ICONV
51 #include <iconv.h>
52 #endif
53
54 /* On most systems <limits.h> would have given us this, but
55  * not on some systems (e.g. GNU/Hurd).
56  */
57 #ifndef PATH_MAX
58 #define PATH_MAX 4096
59 #endif
60
61 #ifdef __GNUC__
62 #define NORETURN __attribute__((__noreturn__))
63 #else
64 #define NORETURN
65 #ifndef __attribute__
66 #define __attribute__(x)
67 #endif
68 #endif
69
70 /* General helper functions */
71 extern void usage(const char *err) NORETURN;
72 extern void die(const char *err, ...) NORETURN __attribute__((format (printf, 1, 2)));
73 extern int error(const char *err, ...) __attribute__((format (printf, 1, 2)));
74 extern void warn(const char *err, ...) __attribute__((format (printf, 1, 2)));
75
76 extern void set_usage_routine(void (*routine)(const char *err) NORETURN);
77 extern void set_die_routine(void (*routine)(const char *err, va_list params) NORETURN);
78 extern void set_error_routine(void (*routine)(const char *err, va_list params));
79 extern void set_warn_routine(void (*routine)(const char *warn, va_list params));
80
81 #ifdef NO_MMAP
82
83 #ifndef PROT_READ
84 #define PROT_READ 1
85 #define PROT_WRITE 2
86 #define MAP_PRIVATE 1
87 #define MAP_FAILED ((void*)-1)
88 #endif
89
90 #define mmap git_mmap
91 #define munmap git_munmap
92 extern void *git_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
93 extern int git_munmap(void *start, size_t length);
94
95 #else /* NO_MMAP */
96
97 #include <sys/mman.h>
98
99 #endif /* NO_MMAP */
100
101 #ifdef NO_SETENV
102 #define setenv gitsetenv
103 extern int gitsetenv(const char *, const char *, int);
104 #endif
105
106 #ifdef NO_UNSETENV
107 #define unsetenv gitunsetenv
108 extern void gitunsetenv(const char *);
109 #endif
110
111 #ifdef NO_STRCASESTR
112 #define strcasestr gitstrcasestr
113 extern char *gitstrcasestr(const char *haystack, const char *needle);
114 #endif
115
116 #ifdef NO_STRLCPY
117 #define strlcpy gitstrlcpy
118 extern size_t gitstrlcpy(char *, const char *, size_t);
119 #endif
120
121 static inline char* xstrdup(const char *str)
122 {
123         char *ret = strdup(str);
124         if (!ret)
125                 die("Out of memory, strdup failed");
126         return ret;
127 }
128
129 static inline void *xmalloc(size_t size)
130 {
131         void *ret = malloc(size);
132         if (!ret && !size)
133                 ret = malloc(1);
134         if (!ret)
135                 die("Out of memory, malloc failed");
136 #ifdef XMALLOC_POISON
137         memset(ret, 0xA5, size);
138 #endif
139         return ret;
140 }
141
142 static inline void *xrealloc(void *ptr, size_t size)
143 {
144         void *ret = realloc(ptr, size);
145         if (!ret && !size)
146                 ret = realloc(ptr, 1);
147         if (!ret)
148                 die("Out of memory, realloc failed");
149         return ret;
150 }
151
152 static inline void *xcalloc(size_t nmemb, size_t size)
153 {
154         void *ret = calloc(nmemb, size);
155         if (!ret && (!nmemb || !size))
156                 ret = calloc(1, 1);
157         if (!ret)
158                 die("Out of memory, calloc failed");
159         return ret;
160 }
161
162 static inline ssize_t xread(int fd, void *buf, size_t len)
163 {
164         ssize_t nr;
165         while (1) {
166                 nr = read(fd, buf, len);
167                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
168                         continue;
169                 return nr;
170         }
171 }
172
173 static inline ssize_t xwrite(int fd, const void *buf, size_t len)
174 {
175         ssize_t nr;
176         while (1) {
177                 nr = write(fd, buf, len);
178                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
179                         continue;
180                 return nr;
181         }
182 }
183
184 static inline int has_extension(const char *filename, const char *ext)
185 {
186         size_t len = strlen(filename);
187         size_t extlen = strlen(ext);
188         return len > extlen && !memcmp(filename + len - extlen, ext, extlen);
189 }
190
191 /* Sane ctype - no locale, and works with signed chars */
192 #undef isspace
193 #undef isdigit
194 #undef isalpha
195 #undef isalnum
196 #undef tolower
197 #undef toupper
198 extern unsigned char sane_ctype[256];
199 #define GIT_SPACE 0x01
200 #define GIT_DIGIT 0x02
201 #define GIT_ALPHA 0x04
202 #define sane_istest(x,mask) ((sane_ctype[(unsigned char)(x)] & (mask)) != 0)
203 #define isspace(x) sane_istest(x,GIT_SPACE)
204 #define isdigit(x) sane_istest(x,GIT_DIGIT)
205 #define isalpha(x) sane_istest(x,GIT_ALPHA)
206 #define isalnum(x) sane_istest(x,GIT_ALPHA | GIT_DIGIT)
207 #define tolower(x) sane_case((unsigned char)(x), 0x20)
208 #define toupper(x) sane_case((unsigned char)(x), 0)
209
210 static inline int sane_case(int x, int high)
211 {
212         if (sane_istest(x, GIT_ALPHA))
213                 x = (x & ~0x20) | high;
214         return x;
215 }
216
217 #endif