utils: use MIN/MAX instead of min/max
[platform/upstream/libxkbcommon.git] / src / utils.h
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 <stdbool.h>
30 #include <stdio.h>
31 #include <string.h>
32
33 #include "darray.h"
34
35 #define STATIC_ASSERT(expr, message) do { \
36     switch (0) { case 0: case (expr): ; } \
37 } while (0)
38
39 char
40 to_lower(char c);
41
42 int
43 istrcmp(const char *a, const char *b);
44
45 int
46 istrncmp(const char *a, const char *b, size_t n);
47
48 static inline bool
49 streq(const char *s1, const char *s2)
50 {
51     return strcmp(s1, s2) == 0;
52 }
53
54 static inline bool
55 streq_not_null(const char *s1, const char *s2)
56 {
57     if (!s1 || !s2)
58         return false;
59     return streq(s1, s2);
60 }
61
62 static inline bool
63 istreq(const char *s1, const char *s2)
64 {
65     return istrcmp(s1, s2) == 0;
66 }
67
68 static inline bool
69 istreq_prefix(const char *s1, const char *s2)
70 {
71     return istrncmp(s1, s2, strlen(s1)) == 0;
72 }
73
74 static inline char *
75 strdup_safe(const char *s)
76 {
77     return s ? strdup(s) : NULL;
78 }
79
80 static inline size_t
81 strlen_safe(const char *s)
82 {
83     return s ? strlen(s) : 0;
84 }
85
86 static inline bool
87 isempty(const char *s)
88 {
89     return s == NULL || s[0] == '\0';
90 }
91
92 static inline const char *
93 strnull(const char *s)
94 {
95     return s ? s : "(null)";
96 }
97
98 static inline const char *
99 strempty(const char *s)
100 {
101     return s ? s : "";
102 }
103
104 static inline void *
105 memdup(const void *mem, size_t nmemb, size_t size)
106 {
107     void *p = calloc(nmemb, size);
108     if (p)
109         memcpy(p, mem, nmemb * size);
110     return p;
111 }
112
113 /* ctype.h is locale-dependent and has other oddities. */
114 static inline bool
115 is_space(char ch)
116 {
117     return ch == ' ' || (ch >= '\t' && ch <= '\r');
118 }
119
120 static inline bool
121 is_alpha(char ch)
122 {
123     return (ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z');
124 }
125
126 static inline bool
127 is_digit(char ch)
128 {
129     return ch >= '0' && ch <= '9';
130 }
131
132 static inline bool
133 is_alnum(char ch)
134 {
135     return is_alpha(ch) || is_digit(ch);
136 }
137
138 static inline bool
139 is_xdigit(char ch)
140 {
141     return
142         (ch >= '0' && ch <= '9') ||
143         (ch >= 'a' && ch <= 'f') ||
144         (ch >= 'A' && ch <= 'F');
145 }
146
147 static inline bool
148 is_graph(char ch)
149 {
150     /* See table in ascii(7). */
151     return ch >= '!' && ch <= '~';
152 }
153
154 /*
155  * Return the bit position of the most significant bit.
156  * Note: this is 1-based! It's more useful this way, and returns 0 when
157  * mask is all 0s.
158  */
159 static inline unsigned
160 msb_pos(uint32_t mask)
161 {
162     unsigned pos = 0;
163     while (mask) {
164         pos++;
165         mask >>= 1u;
166     }
167     return pos;
168 }
169
170 static inline int
171 one_bit_set(uint32_t x)
172 {
173     return x && (x & (x - 1)) == 0;
174 }
175
176 bool
177 map_file(FILE *file, char **string_out, size_t *size_out);
178
179 void
180 unmap_file(char *string, size_t size);
181
182 #define ARRAY_SIZE(arr) ((sizeof(arr) / sizeof(*(arr))))
183
184 #define MIN(a, b) ((a) < (b) ? (a) : (b))
185 #define MAX(a, b) ((a) > (b) ? (a) : (b))
186
187 /* Round up @a so it's divisible by @b. */
188 #define ROUNDUP(a, b) (((a) + (b) - 1) / (b) * (b))
189
190 #if defined(HAVE_SECURE_GETENV)
191 # define secure_getenv secure_getenv
192 #elif defined(HAVE___SECURE_GETENV)
193 # define secure_getenv __secure_getenv
194 #else
195 # define secure_getenv getenv
196 #endif
197
198 #if defined(HAVE___BUILTIN_EXPECT)
199 # define likely(x)   __builtin_expect(!!(x), 1)
200 # define unlikely(x) __builtin_expect(!!(x), 0)
201 #else
202 # define likely(x)   (x)
203 # define unlikely(x) (x)
204 #endif
205
206 /* Compiler Attributes */
207
208 #if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__CYGWIN__)
209 # define XKB_EXPORT      __attribute__((visibility("default")))
210 #elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x550)
211 # define XKB_EXPORT      __global
212 #else /* not gcc >= 4 and not Sun Studio >= 8 */
213 # define XKB_EXPORT
214 #endif
215
216 #if defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 203)
217 # define ATTR_PRINTF(x,y) __attribute__((__format__(__printf__, x, y)))
218 #else /* not gcc >= 2.3 */
219 # define ATTR_PRINTF(x,y)
220 #endif
221
222 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 205)) \
223     || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
224 # define ATTR_NORETURN __attribute__((__noreturn__))
225 #else
226 # define ATTR_NORETURN
227 #endif /* GNUC  */
228
229 #if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 296)
230 #define ATTR_MALLOC  __attribute__((__malloc__))
231 #else
232 #define ATTR_MALLOC
233 #endif
234
235 #if defined(__GNUC__) && (__GNUC__ >= 4)
236 # define ATTR_NULL_SENTINEL __attribute__((__sentinel__))
237 #else
238 # define ATTR_NULL_SENTINEL
239 #endif /* GNUC >= 4 */
240
241 #if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 295)
242 #define ATTR_PACKED  __attribute__((__packed__))
243 #else
244 #define ATTR_PACKED
245 #endif
246
247 #endif /* UTILS_H */