rules: reformat LoadRules and XkbRF_Free
[profile/ivi/libxkbcommon.git] / src / utils.h
1 #ifndef UTILS_H
2 #define UTILS_H 1
3
4   /*\
5    *
6    *                          COPYRIGHT 1990
7    *                    DIGITAL EQUIPMENT CORPORATION
8    *                       MAYNARD, MASSACHUSETTS
9    *                        ALL RIGHTS RESERVED.
10    *
11    * THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT NOTICE AND
12    * SHOULD NOT BE CONSTRUED AS A COMMITMENT BY DIGITAL EQUIPMENT CORPORATION.
13    * DIGITAL MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY OF THIS SOFTWARE
14    * FOR ANY PURPOSE.  IT IS SUPPLIED "AS IS" WITHOUT EXPRESS OR IMPLIED
15    * WARRANTY.
16    *
17    * IF THE SOFTWARE IS MODIFIED IN A MANNER CREATING DERIVATIVE COPYRIGHT
18    * RIGHTS, APPROPRIATE LEGENDS MAY BE PLACED ON THE DERIVATIVE WORK IN
19    * ADDITION TO THAT SET FORTH ABOVE.
20    *
21    * Permission to use, copy, modify, and distribute this software and its
22    * documentation for any purpose and without fee is hereby granted, provided
23    * that the above copyright notice appear in all copies and that both that
24    * copyright notice and this permission notice appear in supporting
25    * documentation, and that the name of Digital Equipment Corporation not be
26    * used in advertising or publicity pertaining to distribution of the
27    * software without specific, written prior permission.
28    \*/
29
30 /***====================================================================***/
31
32 #include <stdbool.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35
36 #include <X11/Xfuncproto.h>
37
38 extern void *
39 recalloc(void *ptr, size_t old_size, size_t new_size);
40
41 /*
42  * We sometimes malloc strings and then expose them as const char*'s. This
43  * macro is used when we free these strings in order to avoid -Wcast-qual
44  * errors.
45  */
46 #define UNCONSTIFY(const_ptr) ((void *)(uintptr_t)(const_ptr))
47
48 #define uTypedAlloc(t)              ((t*)malloc(sizeof(t)))
49 #define uTypedCalloc(n, t)          ((t*)calloc((n), sizeof(t)))
50 #define uTypedRealloc(pO, n, t)     ((t*)realloc((pO), (n) * sizeof(t)))
51 #define uTypedRecalloc(pO, o, n, t) ((t*)recalloc((pO), (o) * sizeof(t), (n) * sizeof(t)))
52
53 #define uDupString(s)          ((s) ? strdup(s) : NULL)
54 #define uStringText(s)         ((s) == NULL ? "<NullString>" : (s))
55 #define uStrCasePrefix(s1, s2) (strncasecmp((s1), (s2), strlen(s1)) == 0)
56
57 /***====================================================================***/
58
59 extern bool
60 uSetErrorFile(char *name);
61
62 #define INFO                    uInformation
63
64 extern _X_ATTRIBUTE_PRINTF(1, 2) void
65 uInformation(const char *s, ...);
66
67 #define ACTION                  uAction
68
69 extern _X_ATTRIBUTE_PRINTF(1, 2) void
70 uAction(const char *s, ...);
71
72 #define WARN                    uWarning
73
74 extern _X_ATTRIBUTE_PRINTF(1, 2) void
75 uWarning(const char *s, ...);
76
77 #define ERROR                   uError
78
79 extern _X_ATTRIBUTE_PRINTF(1, 2) void
80 uError(const char *s, ...);
81
82 #define FATAL                   uFatalError
83
84 extern _X_ATTRIBUTE_PRINTF(1, 2) _X_NORETURN void
85 uFatalError(const char *s, ...);
86
87 /* WSGO stands for "Weird Stuff Going On" (wtf???) */
88 #define WSGO                    uInternalError
89
90 extern _X_ATTRIBUTE_PRINTF(1, 2) void
91 uInternalError(const char *s, ...);
92
93 #endif /* UTILS_H */