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 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) G_ANALYZER_NORETURN;
 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) G_ANALYZER_NORETURN;
 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
 147 #if defined(G_HAVE_ISO_VARARGS) && !G_ANALYZER_ANALYZING
 148 /* for(;;) ; so that GCC knows that control doesn't go past g_error().
 149  * Put space before ending semicolon to avoid C++ build warnings.
 150  */
 151 #define g_error(...)  G_STMT_START {                 \
 152                         g_log (G_LOG_DOMAIN,         \
 153                                G_LOG_LEVEL_ERROR,    \
 154                                __VA_ARGS__);         \
 155                         for (;;) ;                   \
 156                       } G_STMT_END
 157
 158 #define g_message(...)  g_log (G_LOG_DOMAIN,         \
 159                                G_LOG_LEVEL_MESSAGE,  \
 160                                __VA_ARGS__)
 161 #define g_critical(...) g_log (G_LOG_DOMAIN,         \
 162                                G_LOG_LEVEL_CRITICAL, \
 163                                __VA_ARGS__)
 164 #define g_warning(...)  g_log (G_LOG_DOMAIN,         \
 165                                G_LOG_LEVEL_WARNING,  \
 166                                __VA_ARGS__)
 167 #define g_debug(...)    g_log (G_LOG_DOMAIN,         \
 168                                G_LOG_LEVEL_DEBUG,    \
 169                                __VA_ARGS__)
 170 #elif defined(G_HAVE_GNUC_VARARGS)  && !G_ANALYZER_ANALYZING
 171 #define g_error(format...)    G_STMT_START {                 \
 172                                 g_log (G_LOG_DOMAIN,         \
 173                                        G_LOG_LEVEL_ERROR,    \
 174                                        format);              \
 175                                 for (;;) ;                   \
 176                               } G_STMT_END
 177
 178 #define g_message(format...)    g_log (G_LOG_DOMAIN,         \
 179                                        G_LOG_LEVEL_MESSAGE,  \
 180                                        format)
 181 #define g_critical(format...)   g_log (G_LOG_DOMAIN,         \
 182                                        G_LOG_LEVEL_CRITICAL, \
 183                                        format)
 184 #define g_warning(format...)    g_log (G_LOG_DOMAIN,         \
 185                                        G_LOG_LEVEL_WARNING,  \
 186                                        format)
 187 #define g_debug(format...)      g_log (G_LOG_DOMAIN,         \
 188                                        G_LOG_LEVEL_DEBUG,    \
 189                                        format)
 190 #else   /* no varargs macros */
 191 static void g_error (const gchar *format, ...) G_ANALYZER_NORETURN;
 192 static void g_critical (const gchar *format, ...) G_ANALYZER_NORETURN;
 193
 194 static void
 195 g_error (const gchar *format,
 196          ...)
 197 {
 198   va_list args;
 199   va_start (args, format);
 200   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
 201   va_end (args);
 202
 203   for(;;) ;
 204 }
 205 static void
 206 g_message (const gchar *format,
 207            ...)
 208 {
 209   va_list args;
 210   va_start (args, format);
 211   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
 212   va_end (args);
 213 }
 214 static void
 215 g_critical (const gchar *format,
 216             ...)
 217 {
 218   va_list args;
 219   va_start (args, format);
 220   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
 221   va_end (args);
 222 }
 223 static void
 224 g_warning (const gchar *format,
 225            ...)
 226 {
 227   va_list args;
 228   va_start (args, format);
 229   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
 230   va_end (args);
 231 }
 232 static void
 233 g_debug (const gchar *format,
 234          ...)
 235 {
 236   va_list args;
 237   va_start (args, format);
 238   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, args);
 239   va_end (args);
 240 }
 241 #endif  /* !__GNUC__ */
 242
 243 /**
 244  * GPrintFunc:
 245  * @string: the message to output
 246  *
 247  * Specifies the type of the print handler functions.
 248  * These are called with the complete formatted string to output.
 249  */
 250 typedef void    (*GPrintFunc)           (const gchar    *string);
 251 GLIB_AVAILABLE_IN_ALL
 252 void            g_print                 (const gchar    *format,
 253                                          ...) G_GNUC_PRINTF (1, 2);
 254 GLIB_AVAILABLE_IN_ALL
 255 GPrintFunc      g_set_print_handler     (GPrintFunc      func);
 256 GLIB_AVAILABLE_IN_ALL
 257 void            g_printerr              (const gchar    *format,
 258                                          ...) G_GNUC_PRINTF (1, 2);
 259 GLIB_AVAILABLE_IN_ALL
 260 GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
 261
 262 /**
 263  * g_warn_if_reached:
 264  *
 265  * Logs a critical warning.
 266  *
 267  * Since: 2.16
 268  */
 269 #define g_warn_if_reached() \
 270   do { \
 271     g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); \
 272   } while (0)
 273
 274 /**
 275  * g_warn_if_fail:
 276  * @expr: the expression to check
 277  *
 278  * Logs a warning if the expression is not true.
 279  *
 280  * Since: 2.16
 281  */
 282 #define g_warn_if_fail(expr) \
 283   do { \
 284     if G_LIKELY (expr) ; \
 285     else g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, #expr); \
 286   } while (0)
 287
 288 #ifdef G_DISABLE_CHECKS
 289
 290 /**
 291  * g_return_if_fail:
 292  * @expr: the expression to check
 293  *
 294  * Verifies that the expression evaluates to %TRUE.  If the expression
 295  * evaluates to %FALSE, a critical message is logged and the current
 296  * function returns.  This can only be used in functions which do not
 297  * return a value.
 298  *
 299  * If G_DISABLE_CHECKS is defined then the check is not performed.  You
 300  * should therefore not depend on any side effects of @expr.
 301  */
 302 #define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
 303
 304 /**
 305  * g_return_val_if_fail:
 306  * @expr: the expression to check
 307  * @val: the value to return from the current function
 308  *       if the expression is not true
 309  *
 310  * Verifies that the expression evaluates to %TRUE.  If the expression
 311  * evaluates to %FALSE, a critical message is logged and @val is
 312  * returned from the current function.
 313  *
 314  * If G_DISABLE_CHECKS is defined then the check is not performed.  You
 315  * should therefore not depend on any side effects of @expr.
 316  */
 317 #define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END
 318
 319 /**
 320  * g_return_if_reached:
 321  *
 322  * Logs a critical message and returns from the current function.
 323  * This can only be used in functions which do not return a value.
 324  */
 325 #define g_return_if_reached() G_STMT_START{ return; }G_STMT_END
 326
 327 /**
 328  * g_return_val_if_reached:
 329  * @val: the value to return from the current function
 330  *
 331  * Logs a critical message and returns @val.
 332  */
 333 #define g_return_val_if_reached(val) G_STMT_START{ return (val); }G_STMT_END
 334
 335 #else /* !G_DISABLE_CHECKS */
 336
 337 #define g_return_if_fail(expr)          G_STMT_START{                   \
 338      if G_LIKELY(expr) { } else                                         \
 339        {                                                                \
 340          g_return_if_fail_warning (G_LOG_DOMAIN,                        \
 341                                    G_STRFUNC,                           \
 342                                    #expr);                              \
 343          return;                                                        \
 344        };                               }G_STMT_END
 345
 346 #define g_return_val_if_fail(expr,val)  G_STMT_START{                   \
 347      if G_LIKELY(expr) { } else                                         \
 348        {                                                                \
 349          g_return_if_fail_warning (G_LOG_DOMAIN,                        \
 350                                    G_STRFUNC,                           \
 351                                    #expr);                              \
 352          return (val);                                                  \
 353        };                               }G_STMT_END
 354
 355 #define g_return_if_reached()           G_STMT_START{                   \
 356      g_log (G_LOG_DOMAIN,                                               \
 357             G_LOG_LEVEL_CRITICAL,                                       \
 358             "file %s: line %d (%s): should not be reached",             \
 359             __FILE__,                                                   \
 360             __LINE__,                                                   \
 361             G_STRFUNC);                                                 \
 362      return;                            }G_STMT_END
 363
 364 #define g_return_val_if_reached(val)    G_STMT_START{                   \
 365      g_log (G_LOG_DOMAIN,                                               \
 366             G_LOG_LEVEL_CRITICAL,                                       \
 367             "file %s: line %d (%s): should not be reached",             \
 368             __FILE__,                                                   \
 369             __LINE__,                                                   \
 370             G_STRFUNC);                                                 \
 371      return (val);                      }G_STMT_END
 372
 373 #endif /* !G_DISABLE_CHECKS */
 374
 375 G_END_DECLS
 376
 377 #endif /* __G_MESSAGES_H__ */