utils: fix typo in strndup fallback
[platform/upstream/libxkbcommon.git] / src / utils.h
index 020ed75..920db4c 100644 (file)
-#ifndef UTILS_H
-#define        UTILS_H 1
-
-  /*\
-   *
-   *                          COPYRIGHT 1990
-   *                    DIGITAL EQUIPMENT CORPORATION
-   *                       MAYNARD, MASSACHUSETTS
-   *                        ALL RIGHTS RESERVED.
-   *
-   * THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT NOTICE AND
-   * SHOULD NOT BE CONSTRUED AS A COMMITMENT BY DIGITAL EQUIPMENT CORPORATION.
-   * DIGITAL MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY OF THIS SOFTWARE
-   * FOR ANY PURPOSE.  IT IS SUPPLIED "AS IS" WITHOUT EXPRESS OR IMPLIED
-   * WARRANTY.
-   *
-   * IF THE SOFTWARE IS MODIFIED IN A MANNER CREATING DERIVATIVE COPYRIGHT
-   * RIGHTS, APPROPRIATE LEGENDS MAY BE PLACED ON THE DERIVATIVE WORK IN
-   * ADDITION TO THAT SET FORTH ABOVE.
-   *
-   * Permission to use, copy, modify, and distribute this software and its
-   * documentation for any purpose and without fee is hereby granted, provided
-   * that the above copyright notice appear in all copies and that both that
-   * copyright notice and this permission notice appear in supporting
-   * documentation, and that the name of Digital Equipment Corporation not be
-   * used in advertising or publicity pertaining to distribution of the
-   * software without specific, written prior permission.
-   \*/
-
-/***====================================================================***/
-
-#include       <stdio.h>
-#include       <X11/Xos.h>
-#include       <X11/Xfuncproto.h>
-#include       <X11/Xfuncs.h>
-
-#include <stddef.h>
-#include "config.h"
-
-#ifndef NUL
-#define        NUL     '\0'
-#endif
-
-/***====================================================================***/
-
-#ifndef BOOLEAN_DEFINED
-typedef char Boolean;
-#endif
-
-#ifndef True
-#define        True    ((Boolean)1)
-#define        False   ((Boolean)0)
-#endif /* ndef True */
-#define        booleanText(b)  ((b)?"True":"False")
+/*
+ * Copyright © 2012 Ran Benita <ran234@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
 
-#ifndef COMPARISON_DEFINED
-typedef int Comparison;
-
-#define        Greater         ((Comparison)1)
-#define        Equal           ((Comparison)0)
-#define        Less            ((Comparison)-1)
-#define        CannotCompare   ((Comparison)-37)
-#define        comparisonText(c)       ((c)?((c)<0?"Less":"Greater"):"Equal")
+#ifndef UTILS_H
+#define UTILS_H 1
+
+#include <errno.h>
+#include <inttypes.h>
+#include <stdbool.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "darray.h"
+
+#define STATIC_ASSERT(expr, message) do { \
+    switch (0) { case 0: case (expr): ; } \
+} while (0)
+
+char
+to_lower(char c);
+
+int
+istrcmp(const char *a, const char *b);
+
+int
+istrncmp(const char *a, const char *b, size_t n);
+
+static inline bool
+streq(const char *s1, const char *s2)
+{
+    return strcmp(s1, s2) == 0;
+}
+
+static inline bool
+streq_not_null(const char *s1, const char *s2)
+{
+    if (!s1 || !s2)
+        return false;
+    return streq(s1, s2);
+}
+
+static inline bool
+istreq(const char *s1, const char *s2)
+{
+    return istrcmp(s1, s2) == 0;
+}
+
+static inline bool
+istreq_prefix(const char *s1, const char *s2)
+{
+    return istrncmp(s1, s2, strlen(s1)) == 0;
+}
+
+static inline char *
+strdup_safe(const char *s)
+{
+    return s ? strdup(s) : NULL;
+}
+
+static inline size_t
+strlen_safe(const char *s)
+{
+    return s ? strlen(s) : 0;
+}
+
+static inline bool
+isempty(const char *s)
+{
+    return s == NULL || s[0] == '\0';
+}
+
+static inline const char *
+strnull(const char *s)
+{
+    return s ? s : "(null)";
+}
+
+static inline const char *
+strempty(const char *s)
+{
+    return s ? s : "";
+}
+
+static inline void *
+memdup(const void *mem, size_t nmemb, size_t size)
+{
+    void *p = calloc(nmemb, size);
+    if (p)
+        memcpy(p, mem, nmemb * size);
+    return p;
+}
+
+#if !(defined(HAVE_STRNDUP) && HAVE_STRNDUP)
+static inline char *
+strndup(const char *s, size_t n)
+{
+    size_t slen = strlen(s);
+    size_t len = MIN(slen, n);
+    char *p = malloc(len + 1);
+    if (!p)
+        return NULL;
+    memcpy(p, s, len);
+    p[len] = '\0';
+    return p;
+}
 #endif
 
-/***====================================================================***/
-
-extern void *
-recalloc(void * old, unsigned nOld, unsigned nNew, unsigned newSize);
-
-#define        uTypedAlloc(t)          ((t *)malloc((unsigned)sizeof(t)))
-#define        uTypedCalloc(n,t)       ((t *)calloc((unsigned)n,(unsigned)sizeof(t)))
-#define        uTypedRealloc(pO,n,t)   ((t *)realloc(pO,((unsigned)n)*sizeof(t)))
-#define        uTypedRecalloc(pO,o,n,t) ((t *)recalloc(pO,((unsigned)o),((unsigned)n),sizeof(t)))
-#if (defined mdHasAlloca) && (mdHasAlloca)
-#define        uTmpAlloc(n)    alloca((unsigned)n)
-#define        uTmpFree(p)
+/* ctype.h is locale-dependent and has other oddities. */
+static inline bool
+is_space(char ch)
+{
+    return ch == ' ' || (ch >= '\t' && ch <= '\r');
+}
+
+static inline bool
+is_alpha(char ch)
+{
+    return (ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z');
+}
+
+static inline bool
+is_digit(char ch)
+{
+    return ch >= '0' && ch <= '9';
+}
+
+static inline bool
+is_alnum(char ch)
+{
+    return is_alpha(ch) || is_digit(ch);
+}
+
+static inline bool
+is_xdigit(char ch)
+{
+    return
+        (ch >= '0' && ch <= '9') ||
+        (ch >= 'a' && ch <= 'f') ||
+        (ch >= 'A' && ch <= 'F');
+}
+
+static inline bool
+is_graph(char ch)
+{
+    /* See table in ascii(7). */
+    return ch >= '!' && ch <= '~';
+}
+
+/*
+ * Return the bit position of the most significant bit.
+ * Note: this is 1-based! It's more useful this way, and returns 0 when
+ * mask is all 0s.
+ */
+static inline unsigned
+msb_pos(uint32_t mask)
+{
+    unsigned pos = 0;
+    while (mask) {
+        pos++;
+        mask >>= 1u;
+    }
+    return pos;
+}
+
+static inline int
+one_bit_set(uint32_t x)
+{
+    return x && (x & (x - 1)) == 0;
+}
+
+bool
+map_file(FILE *file, char **string_out, size_t *size_out);
+
+void
+unmap_file(char *string, size_t size);
+
+#define ARRAY_SIZE(arr) ((sizeof(arr) / sizeof(*(arr))))
+
+#define MIN(a, b) ((a) < (b) ? (a) : (b))
+#define MAX(a, b) ((a) > (b) ? (a) : (b))
+
+/* Round up @a so it's divisible by @b. */
+#define ROUNDUP(a, b) (((a) + (b) - 1) / (b) * (b))
+
+#if defined(HAVE_SECURE_GETENV)
+# define secure_getenv secure_getenv
+#elif defined(HAVE___SECURE_GETENV)
+# define secure_getenv __secure_getenv
 #else
-#define        uTmpAlloc(n)    malloc(n)
-#define        uTmpFree(p)     free(p)
+# define secure_getenv getenv
 #endif
 
-/***====================================================================***/
-
-extern Boolean
-uSetErrorFile(char *name);
-
-#if defined(__GNUC__) && \
-    ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 6)))
-#define __ATTR_PRINTF(i, f) __attribute__ ((format(printf, (i), (f))))
+#if defined(HAVE___BUILTIN_EXPECT)
+# define likely(x)   __builtin_expect(!!(x), 1)
+# define unlikely(x) __builtin_expect(!!(x), 0)
 #else
-#define __ATTR_PRINTF(i, f)
+# define likely(x)   (x)
+# define unlikely(x) (x)
 #endif
 
-#define INFO                   uInformation
-
-extern __ATTR_PRINTF(1, 2) void
-uInformation(const char *s, ...);
-
-#define ACTION                 uAction
-
-extern __ATTR_PRINTF(1, 2) void
-uAction(const char *s, ...);
+/* Compiler Attributes */
 
-#define WARN                   uWarning
-
-extern __ATTR_PRINTF(1, 2) void
-uWarning(const char *s, ...);
-
-#define ERROR                  uError
-
-extern __ATTR_PRINTF(1, 2) void
-uError(const char *s, ...);
-
-#define FATAL                  uFatalError
-
-extern __ATTR_PRINTF(1, 2) _X_NORETURN void
-uFatalError(const char *s, ...);
-
-/* WSGO stands for "Weird Stuff Going On" (wtf???) */
-#define WSGO                   uInternalError
-
-extern __ATTR_PRINTF(1, 2) void
-uInternalError(const char *s, ...);
-
-/***====================================================================***/
-
-#define        NullString      ((char *)NULL)
+#if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__CYGWIN__)
+# define XKB_EXPORT      __attribute__((visibility("default")))
+#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x550)
+# define XKB_EXPORT      __global
+#else /* not gcc >= 4 and not Sun Studio >= 8 */
+# define XKB_EXPORT
+#endif
 
-#define        uStringText(s)          ((s)==NullString?"<NullString>":(s))
-#define        uStringEqual(s1,s2)     (uStringCompare(s1,s2)==Equal)
-#define        uStringPrefix(p,s)      (strncmp(p,s,strlen(p))==0)
-#define        uStringCompare(s1,s2)   (((s1)==NullString||(s2)==NullString)?\
-                                 (s1)!=(s2):strcmp(s1,s2))
-#define        uStrCaseEqual(s1,s2)    (uStrCaseCmp(s1,s2)==0)
-#ifdef HAVE_STRCASECMP
-#define        uStrCaseCmp(s1,s2)      (strcasecmp(s1,s2))
-#define        uStrCasePrefix(p,s)     (strncasecmp(p,s,strlen(p))==0)
-#else
-extern int
-uStrCaseCmp(const char *s1, const char *s2);
-extern int
-uStrCasePrefix(const char *p, char *str);
+#if defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 203)
+# define ATTR_PRINTF(x,y) __attribute__((__format__(__printf__, x, y)))
+#else /* not gcc >= 2.3 */
+# define ATTR_PRINTF(x,y)
 #endif
 
-/***====================================================================***/
+#if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 205)) \
+    || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
+# define ATTR_NORETURN __attribute__((__noreturn__))
+#else
+# define ATTR_NORETURN
+#endif /* GNUC  */
 
-#ifdef ASSERTIONS_ON
-#define        uASSERT(where,why) \
-       {if (!(why)) uFatalError("assertion botched in %s ( why )\n",where);}
+#if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 296)
+#define ATTR_MALLOC  __attribute__((__malloc__))
 #else
-#define        uASSERT(where,why)
+#define ATTR_MALLOC
 #endif
 
-/***====================================================================***/
+#if defined(__GNUC__) && (__GNUC__ >= 4)
+# define ATTR_NULL_SENTINEL __attribute__((__sentinel__))
+#else
+# define ATTR_NULL_SENTINEL
+#endif /* GNUC >= 4 */
 
-#ifndef DEBUG_VAR
-#define        DEBUG_VAR       debugFlags
+#if (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 295)
+#define ATTR_PACKED  __attribute__((__packed__))
+#else
+#define ATTR_PACKED
 #endif
 
-extern unsigned int DEBUG_VAR;
+#if !(defined(HAVE_ASPRINTF) && HAVE_ASPRINTF)
+int asprintf(char **strp, const char *fmt, ...) ATTR_PRINTF(2, 3);
+# if !(defined(HAVE_VASPRINTF) && HAVE_VASPRINTF)
+#  include <stdarg.h>
+int vasprintf(char **strp, const char *fmt, va_list ap);
+# endif /* !HAVE_VASPRINTF */
+#endif /* !HAVE_ASPRINTF */
 
 #endif /* UTILS_H */