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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <stdarg.h>
  35 #include <glib/gtypes.h>
  36 #include <glib/gmacros.h>
  37
  38 /* Suppress warnings when GCC is in -pedantic mode and not -std=c99
  39  */
  40 #if (__GNUC__ >= 3 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96))
  41 #pragma GCC system_header
  42 #endif
  43
  44 G_BEGIN_DECLS
  45
  46 /* calculate a string size, guaranteed to fit format + args.
  47  */
  48 GLIB_AVAILABLE_IN_ALL
  49 gsize   g_printf_string_upper_bound (const gchar* format,
  50                                      va_list      args) G_GNUC_PRINTF(1, 0);
  51
  52 /* Log level shift offset for user defined
  53  * log levels (0-7 are used by GLib).
  54  */
  55 #define G_LOG_LEVEL_USER_SHIFT  (8)
  56
  57 /* Glib log levels and flags.
  58  */
  59 typedef enum
  60 {
  61   /* log flags */
  62   G_LOG_FLAG_RECURSION          = 1 << 0,
  63   G_LOG_FLAG_FATAL              = 1 << 1,
  64
  65   /* GLib log levels */
  66   G_LOG_LEVEL_ERROR             = 1 << 2,       /* always fatal */
  67   G_LOG_LEVEL_CRITICAL          = 1 << 3,
  68   G_LOG_LEVEL_WARNING           = 1 << 4,
  69   G_LOG_LEVEL_MESSAGE           = 1 << 5,
  70   G_LOG_LEVEL_INFO              = 1 << 6,
  71   G_LOG_LEVEL_DEBUG             = 1 << 7,
  72
  73   G_LOG_LEVEL_MASK              = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
  74 } GLogLevelFlags;
  75
  76 /* GLib log levels that are considered fatal by default */
  77 #define G_LOG_FATAL_MASK        (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
  78
  79 typedef void            (*GLogFunc)             (const gchar   *log_domain,
  80                                                  GLogLevelFlags log_level,
  81                                                  const gchar   *message,
  82                                                  gpointer       user_data);
  83
  84 /* Logging mechanism
  85  */
  86 GLIB_AVAILABLE_IN_ALL
  87 guint           g_log_set_handler       (const gchar    *log_domain,
  88                                          GLogLevelFlags  log_levels,
  89                                          GLogFunc        log_func,
  90                                          gpointer        user_data);
  91 GLIB_AVAILABLE_IN_ALL
  92 void            g_log_remove_handler    (const gchar    *log_domain,
  93                                          guint           handler_id);
  94 GLIB_AVAILABLE_IN_ALL
  95 void            g_log_default_handler   (const gchar    *log_domain,
  96                                          GLogLevelFlags  log_level,
  97                                          const gchar    *message,
  98                                          gpointer        unused_data);
  99 GLIB_AVAILABLE_IN_ALL
 100 GLogFunc        g_log_set_default_handler (GLogFunc      log_func,
 101                                            gpointer      user_data);
 102 GLIB_AVAILABLE_IN_ALL
 103 void            g_log                   (const gchar    *log_domain,
 104                                          GLogLevelFlags  log_level,
 105                                          const gchar    *format,
 106                                          ...) G_GNUC_PRINTF (3, 4);
 107 GLIB_AVAILABLE_IN_ALL
 108 void            g_logv                  (const gchar    *log_domain,
 109                                          GLogLevelFlags  log_level,
 110                                          const gchar    *format,
 111                                          va_list         args) G_GNUC_PRINTF(3, 0);
 112 GLIB_AVAILABLE_IN_ALL
 113 GLogLevelFlags  g_log_set_fatal_mask    (const gchar    *log_domain,
 114                                          GLogLevelFlags  fatal_mask);
 115 GLIB_AVAILABLE_IN_ALL
 116 GLogLevelFlags  g_log_set_always_fatal  (GLogLevelFlags  fatal_mask);
 117
 118 /* internal */
 119 G_GNUC_INTERNAL void    _g_log_fallback_handler (const gchar   *log_domain,
 120                                                  GLogLevelFlags log_level,
 121                                                  const gchar   *message,
 122                                                  gpointer       unused_data);
 123
 124 /* Internal functions, used to implement the following macros */
 125 GLIB_AVAILABLE_IN_ALL
 126 void g_return_if_fail_warning (const char *log_domain,
 127                                const char *pretty_function,
 128                                const char *expression);
 129 GLIB_AVAILABLE_IN_ALL
 130 void g_warn_message           (const char     *domain,
 131                                const char     *file,
 132                                int             line,
 133                                const char     *func,
 134                                const char     *warnexpr);
 135 GLIB_DEPRECATED
 136 void g_assert_warning         (const char *log_domain,
 137                                const char *file,
 138                                const int   line,
 139                                const char *pretty_function,
 140                                const char *expression) G_GNUC_NORETURN;
 141
 142
 143 #ifndef G_LOG_DOMAIN
 144 #define G_LOG_DOMAIN    ((gchar*) 0)
 145 #endif  /* G_LOG_DOMAIN */
 146 #ifdef G_HAVE_ISO_VARARGS
 147 /* for(;;) ; so that GCC knows that control doesn't go past g_error().
 148  * Put space before ending semicolon to avoid C++ build warnings.
 149  */
 150 #define g_error(...)  G_STMT_START {                 \
 151                         g_log (G_LOG_DOMAIN,         \
 152                                G_LOG_LEVEL_ERROR,    \
 153                                __VA_ARGS__);         \
 154                         for (;;) ;                   \
 155                       } G_STMT_END
 156
 157 #define g_message(...)  g_log (G_LOG_DOMAIN,         \
 158                                G_LOG_LEVEL_MESSAGE,  \
 159                                __VA_ARGS__)
 160 #define g_critical(...) g_log (G_LOG_DOMAIN,         \
 161                                G_LOG_LEVEL_CRITICAL, \
 162                                __VA_ARGS__)
 163 #define g_warning(...)  g_log (G_LOG_DOMAIN,         \
 164                                G_LOG_LEVEL_WARNING,  \
 165                                __VA_ARGS__)
 166 #define g_debug(...)    g_log (G_LOG_DOMAIN,         \
 167                                G_LOG_LEVEL_DEBUG,    \
 168                                __VA_ARGS__)
 169 #elif defined(G_HAVE_GNUC_VARARGS)
 170 #define g_error(format...)    G_STMT_START {                 \
 171                                 g_log (G_LOG_DOMAIN,         \
 172                                        G_LOG_LEVEL_ERROR,    \
 173                                        format);              \
 174                                 for (;;) ;                   \
 175                               } G_STMT_END
 176
 177 #define g_message(format...)    g_log (G_LOG_DOMAIN,         \
 178                                        G_LOG_LEVEL_MESSAGE,  \
 179                                        format)
 180 #define g_critical(format...)   g_log (G_LOG_DOMAIN,         \
 181                                        G_LOG_LEVEL_CRITICAL, \
 182                                        format)
 183 #define g_warning(format...)    g_log (G_LOG_DOMAIN,         \
 184                                        G_LOG_LEVEL_WARNING,  \
 185                                        format)
 186 #define g_debug(format...)      g_log (G_LOG_DOMAIN,         \
 187                                        G_LOG_LEVEL_DEBUG,    \
 188                                        format)
 189 #else   /* no varargs macros */
 190 static void
 191 g_error (const gchar *format,
 192          ...)
 193 {
 194   va_list args;
 195   va_start (args, format);
 196   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
 197   va_end (args);
 198
 199   for(;;) ;
 200 }
 201 static void
 202 g_message (const gchar *format,
 203            ...)
 204 {
 205   va_list args;
 206   va_start (args, format);
 207   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
 208   va_end (args);
 209 }
 210 static void
 211 g_critical (const gchar *format,
 212             ...)
 213 {
 214   va_list args;
 215   va_start (args, format);
 216   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
 217   va_end (args);
 218 }
 219 static void
 220 g_warning (const gchar *format,
 221            ...)
 222 {
 223   va_list args;
 224   va_start (args, format);
 225   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
 226   va_end (args);
 227 }
 228 static void
 229 g_debug (const gchar *format,
 230          ...)
 231 {
 232   va_list args;
 233   va_start (args, format);
 234   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, args);
 235   va_end (args);
 236 }
 237 #endif  /* !__GNUC__ */
 238
 239 /**
 240  * GPrintFunc:
 241  * @string: the message to output
 242  *
 243  * Specifies the type of the print handler functions.
 244  * These are called with the complete formatted string to output.
 245  */
 246 typedef void    (*GPrintFunc)           (const gchar    *string);
 247 GLIB_AVAILABLE_IN_ALL
 248 void            g_print                 (const gchar    *format,
 249                                          ...) G_GNUC_PRINTF (1, 2);
 250 GLIB_AVAILABLE_IN_ALL
 251 GPrintFunc      g_set_print_handler     (GPrintFunc      func);
 252 GLIB_AVAILABLE_IN_ALL
 253 void            g_printerr              (const gchar    *format,
 254                                          ...) G_GNUC_PRINTF (1, 2);
 255 GLIB_AVAILABLE_IN_ALL
 256 GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
 257
 258 /**
 259  * g_warn_if_reached:
 260  *
 261  * Logs a critical warning.
 262  *
 263  * Since: 2.16
 264  */
 265 #define g_warn_if_reached() \
 266   do { \
 267     g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); \
 268   } while (0)
 269
 270 /**
 271  * g_warn_if_fail:
 272  * @expr: the expression to check
 273  *
 274  * Logs a warning if the expression is not true.
 275  *
 276  * Since: 2.16
 277  */
 278 #define g_warn_if_fail(expr) \
 279   do { \
 280     if G_LIKELY (expr) ; \
 281     else g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, #expr); \
 282   } while (0)
 283
 284 #ifdef G_DISABLE_CHECKS
 285
 286 /**
 287  * g_return_if_fail:
 288  * @expr: the expression to check
 289  *
 290  * Verifies that the expression evaluates to %TRUE.  If the expression
 291  * evaluates to %FALSE, a critical message is logged and the current
 292  * function returns.  This can only be used in functions which do not
 293  * return a value.
 294  *
 295  * If G_DISABLE_CHECKS is defined then the check is not performed.  You
 296  * should therefore not depend on any side effects of @expr.
 297  */
 298 #define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
 299
 300 /**
 301  * g_return_val_if_fail:
 302  * @expr: the expression to check
 303  * @val: the value to return from the current function
 304  *       if the expression is not true
 305  *
 306  * Verifies that the expression evaluates to %TRUE.  If the expression
 307  * evaluates to %FALSE, a critical message is logged and @val is
 308  * returned from the current function.
 309  *
 310  * If G_DISABLE_CHECKS is defined then the check is not performed.  You
 311  * should therefore not depend on any side effects of @expr.
 312  */
 313 #define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END
 314
 315 /**
 316  * g_return_if_reached:
 317  *
 318  * Logs a critical message and returns from the current function.
 319  * This can only be used in functions which do not return a value.
 320  */
 321 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
 322
 323 /**
 324  * g_return_val_if_reached:
 325  * @val: the value to return from the current function
 326  *
 327  * Logs a critical message and returns @val.
 328  */
 329 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
 330
 331 #else /* !G_DISABLE_CHECKS */
 332
 333 #ifdef __GNUC__
 334
 335 #define g_return_if_fail(expr)          G_STMT_START{                   \
 336      if G_LIKELY(expr) { } else                                         \
 337        {                                                                \
 338          g_return_if_fail_warning (G_LOG_DOMAIN,                        \
 339                                    __PRETTY_FUNCTION__,                 \
 340                                    #expr);                              \
 341          return;                                                        \
 342        };                               }G_STMT_END
 343
 344 #define g_return_val_if_fail(expr,val)  G_STMT_START{                   \
 345      if G_LIKELY(expr) { } else                                         \
 346        {                                                                \
 347          g_return_if_fail_warning (G_LOG_DOMAIN,                        \
 348                                    __PRETTY_FUNCTION__,                 \
 349                                    #expr);                              \
 350          return (val);                                                  \
 351        };                               }G_STMT_END
 352
 353 #define g_return_if_reached()           G_STMT_START{                   \
 354      g_log (G_LOG_DOMAIN,                                               \
 355             G_LOG_LEVEL_CRITICAL,                                       \
 356             "file %s: line %d (%s): should not be reached",             \
 357             __FILE__,                                                   \
 358             __LINE__,                                                   \
 359             __PRETTY_FUNCTION__);                                       \
 360      return;                            }G_STMT_END
 361
 362 #define g_return_val_if_reached(val)    G_STMT_START{                   \
 363      g_log (G_LOG_DOMAIN,                                               \
 364             G_LOG_LEVEL_CRITICAL,                                       \
 365             "file %s: line %d (%s): should not be reached",             \
 366             __FILE__,                                                   \
 367             __LINE__,                                                   \
 368             __PRETTY_FUNCTION__);                                       \
 369      return (val);                      }G_STMT_END
 370
 371 #else /* !__GNUC__ */
 372
 373 #define g_return_if_fail(expr)          G_STMT_START{           \
 374      if (expr) { } else                                         \
 375        {                                                        \
 376          g_log (G_LOG_DOMAIN,                                   \
 377                 G_LOG_LEVEL_CRITICAL,                           \
 378                 "file %s: line %d: assertion `%s' failed",      \
 379                 __FILE__,                                       \
 380                 __LINE__,                                       \
 381                 #expr);                                         \
 382          return;                                                \
 383        };                               }G_STMT_END
 384
 385 #define g_return_val_if_fail(expr, val) G_STMT_START{           \
 386      if (expr) { } else                                         \
 387        {                                                        \
 388          g_log (G_LOG_DOMAIN,                                   \
 389                 G_LOG_LEVEL_CRITICAL,                           \
 390                 "file %s: line %d: assertion `%s' failed",      \
 391                 __FILE__,                                       \
 392                 __LINE__,                                       \
 393                 #expr);                                         \
 394          return (val);                                          \
 395        };                               }G_STMT_END
 396
 397 #define g_return_if_reached()           G_STMT_START{           \
 398      g_log (G_LOG_DOMAIN,                                       \
 399             G_LOG_LEVEL_CRITICAL,                               \
 400             "file %s: line %d: should not be reached",          \
 401             __FILE__,                                           \
 402             __LINE__);                                          \
 403      return;                            }G_STMT_END
 404
 405 #define g_return_val_if_reached(val)    G_STMT_START{           \
 406      g_log (G_LOG_DOMAIN,                                       \
 407             G_LOG_LEVEL_CRITICAL,                               \
 408             "file %s: line %d: should not be reached",          \
 409             __FILE__,                                           \
 410             __LINE__);                                          \
 411      return (val);                      }G_STMT_END
 412
 413 #endif /* !__GNUC__ */
 414
 415 #endif /* !G_DISABLE_CHECKS */
 416
 417 G_END_DECLS
 418
 419 #endif /* __G_MESSAGES_H__ */