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