1 /*
2  * Copyright © 2012 Ran Benita <ran234@gmail.com>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  */
23 
24 #ifndef UTILS_H
25 #define UTILS_H 1
26 
27 #include <errno.h>
28 #include <inttypes.h>
29 #include <stdarg.h>
30 #include <stdbool.h>
31 #include <stdio.h>
32 #include <string.h>
33 #if HAVE_UNISTD_H
34 #include <unistd.h>
35 #else
36 /* Required on Windows where unistd.h doesn't exist */
37 #define R_OK    4               /* Test for read permission.  */
38 #define W_OK    2               /* Test for write permission.  */
39 #define X_OK    1               /* Test for execute permission.  */
40 #define F_OK    0               /* Test for existence.  */
41 #endif
42 
43 #include "darray.h"
44 
45 #define STATIC_ASSERT(expr, message) do { \
46     switch (0) { case 0: case (expr): ; } \
47 } while (0)
48 
49 #define ARRAY_SIZE(arr) ((sizeof(arr) / sizeof(*(arr))))
50 
51 #define MIN(a, b) ((a) < (b) ? (a) : (b))
52 #define MAX(a, b) ((a) > (b) ? (a) : (b))
53 
54 /* Round up @a so it's divisible by @b. */
55 #define ROUNDUP(a, b) (((a) + (b) - 1) / (b) * (b))
56 
57 char
58 to_lower(char c);
59 
60 int
61 istrcmp(const char *a, const char *b);
62 
63 int
64 istrncmp(const char *a, const char *b, size_t n);
65 
66 static inline bool
streq(const char * s1,const char * s2)67 streq(const char *s1, const char *s2)
68 {
69     return strcmp(s1, s2) == 0;
70 }
71 
72 static inline bool
streq_null(const char * s1,const char * s2)73 streq_null(const char *s1, const char *s2)
74 {
75     if (s1 == NULL || s2 == NULL)
76         return s1 == s2;
77     return streq(s1, s2);
78 }
79 
80 static inline bool
streq_not_null(const char * s1,const char * s2)81 streq_not_null(const char *s1, const char *s2)
82 {
83     if (!s1 || !s2)
84         return false;
85     return streq(s1, s2);
86 }
87 
88 static inline bool
istreq(const char * s1,const char * s2)89 istreq(const char *s1, const char *s2)
90 {
91     return istrcmp(s1, s2) == 0;
92 }
93 
94 static inline bool
istreq_prefix(const char * s1,const char * s2)95 istreq_prefix(const char *s1, const char *s2)
96 {
97     return istrncmp(s1, s2, strlen(s1)) == 0;
98 }
99 
100 static inline char *
strdup_safe(const char * s)101 strdup_safe(const char *s)
102 {
103     return s ? strdup(s) : NULL;
104 }
105 
106 static inline size_t
strlen_safe(const char * s)107 strlen_safe(const char *s)
108 {
109     return s ? strlen(s) : 0;
110 }
111 
112 static inline bool
isempty(const char * s)113 isempty(const char *s)
114 {
115     return s == NULL || s[0] == '\0';
116 }
117 
118 static inline const char *
strnull(const char * s)119 strnull(const char *s)
120 {
121     return s ? s : "(null)";
122 }
123 
124 static inline const char *
strempty(const char * s)125 strempty(const char *s)
126 {
127     return s ? s : "";
128 }
129 
130 static inline void *
memdup(const void * mem,size_t nmemb,size_t size)131 memdup(const void *mem, size_t nmemb, size_t size)
132 {
133     void *p = calloc(nmemb, size);
134     if (p)
135         memcpy(p, mem, nmemb * size);
136     return p;
137 }
138 
139 #if !(defined(HAVE_STRNDUP) && HAVE_STRNDUP)
140 static inline char *
strndup(const char * s,size_t n)141 strndup(const char *s, size_t n)
142 {
143     size_t slen = strlen(s);
144     size_t len = MIN(slen, n);
145     char *p = malloc(len + 1);
146     if (!p)
147         return NULL;
148     memcpy(p, s, len);
149     p[len] = '\0';
150     return p;
151 }
152 #endif
153 
154 /* ctype.h is locale-dependent and has other oddities. */
155 static inline bool
is_space(char ch)156 is_space(char ch)
157 {
158     return ch == ' ' || (ch >= '\t' && ch <= '\r');
159 }
160 
161 static inline bool
is_alpha(char ch)162 is_alpha(char ch)
163 {
164     return (ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z');
165 }
166 
167 static inline bool
is_digit(char ch)168 is_digit(char ch)
169 {
170     return ch >= '0' && ch <= '9';
171 }
172 
173 static inline bool
is_alnum(char ch)174 is_alnum(char ch)
175 {
176     return is_alpha(ch) || is_digit(ch);
177 }
178 
179 static inline bool
is_xdigit(char ch)180 is_xdigit(char ch)
181 {
182     return
183         (ch >= '0' && ch <= '9') ||
184         (ch >= 'a' && ch <= 'f') ||
185         (ch >= 'A' && ch <= 'F');
186 }
187 
188 static inline bool
is_graph(char ch)189 is_graph(char ch)
190 {
191     /* See table in ascii(7). */
192     return ch >= '!' && ch <= '~';
193 }
194 
195 /*
196  * Return the bit position of the most significant bit.
197  * Note: this is 1-based! It's more useful this way, and returns 0 when
198  * mask is all 0s.
199  */
200 static inline unsigned
msb_pos(uint32_t mask)201 msb_pos(uint32_t mask)
202 {
203     unsigned pos = 0;
204     while (mask) {
205         pos++;
206         mask >>= 1u;
207     }
208     return pos;
209 }
210 
211 static inline int
one_bit_set(uint32_t x)212 one_bit_set(uint32_t x)
213 {
214     return x && (x & (x - 1)) == 0;
215 }
216 
217 bool
218 map_file(FILE *file, char **string_out, size_t *size_out);
219 
220 void
221 unmap_file(char *string, size_t size);
222 
223 static inline bool
check_eaccess(const char * path,int mode)224 check_eaccess(const char *path, int mode)
225 {
226 #if defined(HAVE_EACCESS)
227     if (eaccess(path, mode) != 0)
228         return false;
229 #elif defined(HAVE_EUIDACCESS)
230     if (euidaccess(path, mode) != 0)
231         return false;
232 #endif
233 
234     return true;
235 }
236 
237 #if defined(HAVE_SECURE_GETENV)
238 # define secure_getenv secure_getenv
239 #elif defined(HAVE___SECURE_GETENV)
240 # define secure_getenv __secure_getenv
241 #else
242 # define secure_getenv getenv
243 #endif
244 
245 #if defined(HAVE___BUILTIN_EXPECT)
246 # define likely(x)   __builtin_expect(!!(x), 1)
247 # define unlikely(x) __builtin_expect(!!(x), 0)
248 #else
249 # define likely(x)   (x)
250 # define unlikely(x) (x)
251 #endif
252 
253 /* Compiler Attributes */
254 
255 #if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__CYGWIN__)
256 # define XKB_EXPORT      __attribute__((visibility("default")))
257 #elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x550)
258 # define XKB_EXPORT      __global
259 #else /* not gcc >= 4 and not Sun Studio >= 8 */
260 # define XKB_EXPORT
261 #endif
262 
263 #if defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 203)
264 # define ATTR_PRINTF(x,y) __attribute__((__format__(__printf__, x, y)))
265 #else /* not gcc >= 2.3 */
266 # define ATTR_PRINTF(x,y)
267 #endif
268 
269 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 205)) \
270     || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
271 # define ATTR_NORETURN __attribute__((__noreturn__))
272 #else
273 # define ATTR_NORETURN
274 #endif /* GNUC  */
275 
276 #if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 296)
277 #define ATTR_MALLOC  __attribute__((__malloc__))
278 #else
279 #define ATTR_MALLOC
280 #endif
281 
282 #if defined(__GNUC__) && (__GNUC__ >= 4)
283 # define ATTR_NULL_SENTINEL __attribute__((__sentinel__))
284 #else
285 # define ATTR_NULL_SENTINEL
286 #endif /* GNUC >= 4 */
287 
288 #if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 295)
289 #define ATTR_PACKED  __attribute__((__packed__))
290 #else
291 #define ATTR_PACKED
292 #endif
293 
294 #if !(defined(HAVE_ASPRINTF) && HAVE_ASPRINTF)
295 int asprintf(char **strp, const char *fmt, ...) ATTR_PRINTF(2, 3);
296 # if !(defined(HAVE_VASPRINTF) && HAVE_VASPRINTF)
297 #  include <stdarg.h>
298 int vasprintf(char **strp, const char *fmt, va_list ap);
299 # endif /* !HAVE_VASPRINTF */
300 #endif /* !HAVE_ASPRINTF */
301 
302 static inline bool
303 ATTR_PRINTF(3, 4)
snprintf_safe(char * buf,size_t sz,const char * format,...)304 snprintf_safe(char *buf, size_t sz, const char *format, ...)
305 {
306     va_list ap;
307     int rc;
308 
309     va_start(ap, format);
310     rc = vsnprintf(buf, sz, format, ap);
311     va_end(ap);
312 
313     return rc >= 0 && (size_t)rc < sz;
314 }
315 
316 static inline char *
317 ATTR_PRINTF(1, 0)
vasprintf_safe(const char * fmt,va_list args)318 vasprintf_safe(const char *fmt, va_list args)
319 {
320     char *str;
321     int len;
322 
323     len = vasprintf(&str, fmt, args);
324 
325     if (len == -1)
326         return NULL;
327 
328     return str;
329 }
330 
331 /**
332  * A version of asprintf that returns the allocated string or NULL on error.
333  */
334 static inline char *
335 ATTR_PRINTF(1, 2)
asprintf_safe(const char * fmt,...)336 asprintf_safe(const char *fmt, ...)
337 {
338     va_list args;
339     char *str;
340 
341     va_start(args, fmt);
342     str = vasprintf_safe(fmt, args);
343     va_end(args);
344 
345     return str;
346 }
347 
348 #endif /* UTILS_H */
349