get rid of warning here
[platform/upstream/glib.git] / glib / gmacros.h
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GLib Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 /* This file must not include any other glib header file and must thus
28  * not refer to variables from glibconfig.h 
29  */
30
31 #ifndef __G_MACROS_H__
32 #define __G_MACROS_H__
33
34 /* We include stddef.h to get the system's definition of NULL
35  */
36 #include <stddef.h>
37
38 /* Here we provide G_GNUC_EXTENSION as an alias for __extension__,
39  * where this is valid. This allows for warningless compilation of
40  * "long long" types even in the presence of '-ansi -pedantic'. 
41  */
42 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8)
43 #  define G_GNUC_EXTENSION __extension__
44 #else
45 #  define G_GNUC_EXTENSION
46 #endif
47
48 /* Provide macros to feature the GCC function attribute.
49  */
50 #if    __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
51 #define G_GNUC_PURE                            \
52   __attribute__((__pure__))
53 #else
54 #define G_GNUC_PURE
55 #endif
56
57 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
58 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
59   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
60 #define G_GNUC_SCANF( format_idx, arg_idx )     \
61   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
62 #define G_GNUC_FORMAT( arg_idx )                \
63   __attribute__((__format_arg__ (arg_idx)))
64 #define G_GNUC_NORETURN                         \
65   __attribute__((__noreturn__))
66 #define G_GNUC_CONST                            \
67   __attribute__((__const__))
68 #define G_GNUC_UNUSED                           \
69   __attribute__((__unused__))
70 #define G_GNUC_NO_INSTRUMENT                    \
71   __attribute__((__no_instrument_function__))
72 #else   /* !__GNUC__ */
73 #define G_GNUC_PRINTF( format_idx, arg_idx )
74 #define G_GNUC_SCANF( format_idx, arg_idx )
75 #define G_GNUC_FORMAT( arg_idx )
76 #define G_GNUC_NORETURN
77 #define G_GNUC_CONST
78 #define G_GNUC_UNUSED
79 #define G_GNUC_NO_INSTRUMENT
80 #endif  /* !__GNUC__ */
81
82 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
83  * macros, so we can refer to them as strings unconditionally.
84  */
85 #if defined (__GNUC__) && (__GNUC__ < 3)
86 #define G_GNUC_FUNCTION         __FUNCTION__
87 #define G_GNUC_PRETTY_FUNCTION  __PRETTY_FUNCTION__
88 #else   /* !__GNUC__ */
89 #define G_GNUC_FUNCTION         ""
90 #define G_GNUC_PRETTY_FUNCTION  ""
91 #endif  /* !__GNUC__ */
92
93 #define G_STRINGIFY(macro_or_string)    G_STRINGIFY_ARG (macro_or_string)
94 #define G_STRINGIFY_ARG(contents)       #contents
95
96 /* Provide a string identifying the current code position */
97 #if defined(__GNUC__) && (__GNUC__ < 3)
98 #  define G_STRLOC      __FILE__ ":" G_STRINGIFY (__LINE__) ":" __PRETTY_FUNCTION__ "()"
99 #else
100 #  define G_STRLOC      __FILE__ ":" G_STRINGIFY (__LINE__)
101 #endif
102
103 /* Guard C code in headers, while including them from C++ */
104 #ifdef  __cplusplus
105 # define G_BEGIN_DECLS  extern "C" {
106 # define G_END_DECLS    }
107 #else
108 # define G_BEGIN_DECLS
109 # define G_END_DECLS
110 #endif
111
112 /* Provide definitions for some commonly used macros.
113  *  Some of them are only provided if they haven't already
114  *  been defined. It is assumed that if they are already
115  *  defined then the current definition is correct.
116  */
117 #ifndef NULL
118 #  ifdef __cplusplus
119 #    define NULL        (0L)
120 #  else /* !__cplusplus */
121 #    define NULL        ((void*) 0)
122 #  endif /* !__cplusplus */
123 #endif
124
125 #ifndef FALSE
126 #define FALSE   (0)
127 #endif
128
129 #ifndef TRUE
130 #define TRUE    (!FALSE)
131 #endif
132
133 #undef  MAX
134 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
135
136 #undef  MIN
137 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
138
139 #undef  ABS
140 #define ABS(a)     (((a) < 0) ? -(a) : (a))
141
142 #undef  CLAMP
143 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
144
145 /* Count the number of elements in an array. The array must be defined
146  * as such; using this with a dynamically allocated array will give
147  * incorrect results.
148  */
149 #define G_N_ELEMENTS(arr)               (sizeof (arr) / sizeof ((arr)[0]))
150
151 /* Macros by analogy to GINT_TO_POINTER, GPOINTER_TO_INT
152  */
153 #define GPOINTER_TO_SIZE(p)     ((gsize) (p))
154 #define GSIZE_TO_POINTER(s)     ((gpointer) (gsize) (s))
155
156 /* Provide convenience macros for handling structure
157  * fields through their offsets.
158  */
159 #define G_STRUCT_OFFSET(struct_type, member)    \
160     ((glong) ((guint8*) &((struct_type*) 0)->member))
161 #define G_STRUCT_MEMBER_P(struct_p, struct_offset)   \
162     ((gpointer) ((guint8*) (struct_p) + (glong) (struct_offset)))
163 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset)   \
164     (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
165
166 /* Provide simple macro statement wrappers (adapted from Perl):
167  *  G_STMT_START { statements; } G_STMT_END;
168  *  can be used as a single statement, as in
169  *  if (x) G_STMT_START { ... } G_STMT_END; else ...
170  *
171  *  For gcc we will wrap the statements within `({' and `})' braces.
172  *  For SunOS they will be wrapped within `if (1)' and `else (void) 0',
173  *  and otherwise within `do' and `while (0)'.
174  */
175 #if !(defined (G_STMT_START) && defined (G_STMT_END))
176 #  if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
177 #    define G_STMT_START        (void)(
178 #    define G_STMT_END          )
179 #  else
180 #    if (defined (sun) || defined (__sun__))
181 #      define G_STMT_START      if (1)
182 #      define G_STMT_END        else (void)0
183 #    else
184 #      define G_STMT_START      do
185 #      define G_STMT_END        while (0)
186 #    endif
187 #  endif
188 #endif
189
190 /* Allow the app programmer to select whether or not return values
191  * (usually char*) are const or not.  Don't try using this feature for
192  * functions with C++ linkage.
193  */
194 #ifdef G_DISABLE_CONST_RETURNS
195 #define G_CONST_RETURN
196 #else
197 #define G_CONST_RETURN const
198 #endif
199
200 #endif /* __G_MACROS_H__ */