http://mail.gnome.org/archives/gtk-devel-list/2007-October/msg00089.html
[platform/upstream/glib.git] / glib / gmessages.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 #ifndef __G_MESSAGES_H__
28 #define __G_MESSAGES_H__
29
30 #include <stdarg.h>
31 #include <glib/gtypes.h>
32 #include <glib/gmacros.h>
33
34 /* Suppress warnings when GCC is in -pedantic mode and not -std=c99
35  */
36 #if (__GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96))
37 #pragma GCC system_header
38 #endif
39
40 G_BEGIN_DECLS
41
42 /* calculate a string size, guaranteed to fit format + args.
43  */
44 gsize   g_printf_string_upper_bound (const gchar* format,
45                                      va_list      args);
46
47 /* Log level shift offset for user defined
48  * log levels (0-7 are used by GLib).
49  */
50 #define G_LOG_LEVEL_USER_SHIFT  (8)
51
52 /* Glib log levels and flags.
53  */
54 typedef enum
55 {
56   /* log flags */
57   G_LOG_FLAG_RECURSION          = 1 << 0,
58   G_LOG_FLAG_FATAL              = 1 << 1,
59
60   /* GLib log levels */
61   G_LOG_LEVEL_ERROR             = 1 << 2,       /* always fatal */
62   G_LOG_LEVEL_CRITICAL          = 1 << 3,
63   G_LOG_LEVEL_WARNING           = 1 << 4,
64   G_LOG_LEVEL_MESSAGE           = 1 << 5,
65   G_LOG_LEVEL_INFO              = 1 << 6,
66   G_LOG_LEVEL_DEBUG             = 1 << 7,
67
68   G_LOG_LEVEL_MASK              = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
69 } GLogLevelFlags;
70
71 /* GLib log levels that are considered fatal by default */
72 #define G_LOG_FATAL_MASK        (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
73
74 typedef void            (*GLogFunc)             (const gchar   *log_domain,
75                                                  GLogLevelFlags log_level,
76                                                  const gchar   *message,
77                                                  gpointer       user_data);
78
79 /* Logging mechanism
80  */
81 guint           g_log_set_handler       (const gchar    *log_domain,
82                                          GLogLevelFlags  log_levels,
83                                          GLogFunc        log_func,
84                                          gpointer        user_data);
85 void            g_log_remove_handler    (const gchar    *log_domain,
86                                          guint           handler_id);
87 void            g_log_default_handler   (const gchar    *log_domain,
88                                          GLogLevelFlags  log_level,
89                                          const gchar    *message,
90                                          gpointer        unused_data);
91 GLogFunc        g_log_set_default_handler (GLogFunc      log_func,
92                                            gpointer      user_data);
93 void            g_log                   (const gchar    *log_domain,
94                                          GLogLevelFlags  log_level,
95                                          const gchar    *format,
96                                          ...) G_GNUC_PRINTF (3, 4);
97 void            g_logv                  (const gchar    *log_domain,
98                                          GLogLevelFlags  log_level,
99                                          const gchar    *format,
100                                          va_list         args);
101 GLogLevelFlags  g_log_set_fatal_mask    (const gchar    *log_domain,
102                                          GLogLevelFlags  fatal_mask);
103 GLogLevelFlags  g_log_set_always_fatal  (GLogLevelFlags  fatal_mask);
104
105 /* internal */
106 G_GNUC_INTERNAL void    _g_log_fallback_handler (const gchar   *log_domain,
107                                                  GLogLevelFlags log_level,
108                                                  const gchar   *message,
109                                                  gpointer       unused_data);
110
111 /* Internal functions, used to implement the following macros */
112 void g_return_if_fail_warning (const char *log_domain,
113                                const char *pretty_function,
114                                const char *expression);
115 void g_warn_message           (const char     *domain,
116                                const char     *file,
117                                int             line,
118                                const char     *func,
119                                const char     *warnexpr);
120 #ifndef G_DISABLE_DEPRECATED
121 void g_assert_warning         (const char *log_domain,
122                                const char *file,
123                                const int   line,
124                                const char *pretty_function,
125                                const char *expression) G_GNUC_NORETURN;
126 #endif /* !G_DISABLE_DEPRECATED */
127
128
129 #ifndef G_LOG_DOMAIN
130 #define G_LOG_DOMAIN    ((gchar*) 0)
131 #endif  /* G_LOG_DOMAIN */
132 #ifdef G_HAVE_ISO_VARARGS
133 #define g_error(...)    g_log (G_LOG_DOMAIN,         \
134                                G_LOG_LEVEL_ERROR,    \
135                                __VA_ARGS__)
136 #define g_message(...)  g_log (G_LOG_DOMAIN,         \
137                                G_LOG_LEVEL_MESSAGE,  \
138                                __VA_ARGS__)
139 #define g_critical(...) g_log (G_LOG_DOMAIN,         \
140                                G_LOG_LEVEL_CRITICAL, \
141                                __VA_ARGS__)
142 #define g_warning(...)  g_log (G_LOG_DOMAIN,         \
143                                G_LOG_LEVEL_WARNING,  \
144                                __VA_ARGS__)
145 #define g_debug(...)    g_log (G_LOG_DOMAIN,         \
146                                G_LOG_LEVEL_DEBUG,    \
147                                __VA_ARGS__)
148 #elif defined(G_HAVE_GNUC_VARARGS)
149 #define g_error(format...)      g_log (G_LOG_DOMAIN,         \
150                                        G_LOG_LEVEL_ERROR,    \
151                                        format)
152 #define g_message(format...)    g_log (G_LOG_DOMAIN,         \
153                                        G_LOG_LEVEL_MESSAGE,  \
154                                        format)
155 #define g_critical(format...)   g_log (G_LOG_DOMAIN,         \
156                                        G_LOG_LEVEL_CRITICAL, \
157                                        format)
158 #define g_warning(format...)    g_log (G_LOG_DOMAIN,         \
159                                        G_LOG_LEVEL_WARNING,  \
160                                        format)
161 #define g_debug(format...)      g_log (G_LOG_DOMAIN,         \
162                                        G_LOG_LEVEL_DEBUG,    \
163                                        format)
164 #else   /* no varargs macros */
165 static void
166 g_error (const gchar *format,
167          ...)
168 {
169   va_list args;
170   va_start (args, format);
171   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
172   va_end (args);
173 }
174 static void
175 g_message (const gchar *format,
176            ...)
177 {
178   va_list args;
179   va_start (args, format);
180   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
181   va_end (args);
182 }
183 static void
184 g_critical (const gchar *format,
185             ...)
186 {
187   va_list args;
188   va_start (args, format);
189   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
190   va_end (args);
191 }
192 static void
193 g_warning (const gchar *format,
194            ...)
195 {
196   va_list args;
197   va_start (args, format);
198   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
199   va_end (args);
200 }
201 static void
202 g_debug (const gchar *format,
203          ...)
204 {
205   va_list args;
206   va_start (args, format);
207   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, args);
208   va_end (args);
209 }
210 #endif  /* !__GNUC__ */
211
212 typedef void    (*GPrintFunc)           (const gchar    *string);
213 void            g_print                 (const gchar    *format,
214                                          ...) G_GNUC_PRINTF (1, 2);
215 GPrintFunc      g_set_print_handler     (GPrintFunc      func);
216 void            g_printerr              (const gchar    *format,
217                                          ...) G_GNUC_PRINTF (1, 2);
218 GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
219
220
221 /* Provide macros for graceful error handling.
222  * The "return" macros will return from the current function.
223  * Two different definitions are given for the macros in
224  * order to support gcc's __PRETTY_FUNCTION__ capability.
225  */
226
227 #define g_warn_if_reached()     do { g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
228 #define g_warn_if_fail(expr)    do { if G_LIKELY (expr) ; else \
229                                        g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, #expr); } while (0)
230
231 #ifdef G_DISABLE_CHECKS
232
233 #define g_return_if_fail(expr)                  G_STMT_START{ (void)0; }G_STMT_END
234 #define g_return_val_if_fail(expr,val)          G_STMT_START{ (void)0; }G_STMT_END
235 #define g_return_if_reached()                   G_STMT_START{ return; }G_STMT_END
236 #define g_return_val_if_reached(val)            G_STMT_START{ return (val); }G_STMT_END
237
238 #else /* !G_DISABLE_CHECKS */
239
240 #ifdef __GNUC__
241
242 #define g_return_if_fail(expr)          G_STMT_START{                   \
243      if G_LIKELY(expr) { } else                                         \
244        {                                                                \
245          g_return_if_fail_warning (G_LOG_DOMAIN,                        \
246                                    __PRETTY_FUNCTION__,                 \
247                                    #expr);                              \
248          return;                                                        \
249        };                               }G_STMT_END
250
251 #define g_return_val_if_fail(expr,val)  G_STMT_START{                   \
252      if G_LIKELY(expr) { } else                                         \
253        {                                                                \
254          g_return_if_fail_warning (G_LOG_DOMAIN,                        \
255                                    __PRETTY_FUNCTION__,                 \
256                                    #expr);                              \
257          return (val);                                                  \
258        };                               }G_STMT_END
259
260 #define g_return_if_reached()           G_STMT_START{                   \
261      g_log (G_LOG_DOMAIN,                                               \
262             G_LOG_LEVEL_CRITICAL,                                       \
263             "file %s: line %d (%s): should not be reached",             \
264             __FILE__,                                                   \
265             __LINE__,                                                   \
266             __PRETTY_FUNCTION__);                                       \
267      return;                            }G_STMT_END
268
269 #define g_return_val_if_reached(val)    G_STMT_START{                   \
270      g_log (G_LOG_DOMAIN,                                               \
271             G_LOG_LEVEL_CRITICAL,                                       \
272             "file %s: line %d (%s): should not be reached",             \
273             __FILE__,                                                   \
274             __LINE__,                                                   \
275             __PRETTY_FUNCTION__);                                       \
276      return (val);                      }G_STMT_END
277
278 #else /* !__GNUC__ */
279
280 #define g_return_if_fail(expr)          G_STMT_START{           \
281      if (expr) { } else                                         \
282        {                                                        \
283          g_log (G_LOG_DOMAIN,                                   \
284                 G_LOG_LEVEL_CRITICAL,                           \
285                 "file %s: line %d: assertion `%s' failed",      \
286                 __FILE__,                                       \
287                 __LINE__,                                       \
288                 #expr);                                         \
289          return;                                                \
290        };                               }G_STMT_END
291
292 #define g_return_val_if_fail(expr, val) G_STMT_START{           \
293      if (expr) { } else                                         \
294        {                                                        \
295          g_log (G_LOG_DOMAIN,                                   \
296                 G_LOG_LEVEL_CRITICAL,                           \
297                 "file %s: line %d: assertion `%s' failed",      \
298                 __FILE__,                                       \
299                 __LINE__,                                       \
300                 #expr);                                         \
301          return (val);                                          \
302        };                               }G_STMT_END
303
304 #define g_return_if_reached()           G_STMT_START{           \
305      g_log (G_LOG_DOMAIN,                                       \
306             G_LOG_LEVEL_CRITICAL,                               \
307             "file %s: line %d: should not be reached",          \
308             __FILE__,                                           \
309             __LINE__);                                          \
310      return;                            }G_STMT_END
311
312 #define g_return_val_if_reached(val)    G_STMT_START{           \
313      g_log (G_LOG_DOMAIN,                                       \
314             G_LOG_LEVEL_CRITICAL,                               \
315             "file %s: line %d: should not be reached",          \
316             __FILE__,                                           \
317             __LINE__);                                          \
318      return (val);                      }G_STMT_END
319
320 #endif /* !__GNUC__ */
321
322 #endif /* !G_DISABLE_CHECKS */
323
324 G_END_DECLS
325
326 #endif /* __G_MESSAGES_H__ */
327