make it possible to disable single-file includes by defining
[platform/upstream/glib.git] / glib / gmessages.h
index 3a4a8dd..05fc37d 100644 (file)
  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GLib Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__G_LIB_H__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
 #ifndef __G_MESSAGES_H__
 #define __G_MESSAGES_H__
 
@@ -39,7 +43,7 @@
 
 G_BEGIN_DECLS
 
-/* calculate a string size, guarranteed to fit format + args.
+/* calculate a string size, guaranteed to fit format + args.
  */
 gsize  g_printf_string_upper_bound (const gchar* format,
                                     va_list      args);
@@ -88,6 +92,8 @@ void            g_log_default_handler   (const gchar    *log_domain,
                                          GLogLevelFlags  log_level,
                                          const gchar    *message,
                                          gpointer        unused_data);
+GLogFunc        g_log_set_default_handler (GLogFunc      log_func,
+                                          gpointer      user_data);
 void            g_log                   (const gchar    *log_domain,
                                          GLogLevelFlags  log_level,
                                          const gchar    *format,
@@ -101,19 +107,41 @@ GLogLevelFlags  g_log_set_fatal_mask    (const gchar    *log_domain,
 GLogLevelFlags  g_log_set_always_fatal  (GLogLevelFlags  fatal_mask);
 
 /* internal */
-void   _g_log_fallback_handler (const gchar   *log_domain,
-                                GLogLevelFlags log_level,
-                                const gchar   *message,
-                                gpointer       unused_data);
+G_GNUC_INTERNAL void   _g_log_fallback_handler (const gchar   *log_domain,
+                                                GLogLevelFlags log_level,
+                                                const gchar   *message,
+                                                gpointer       unused_data);
+
+/* Internal functions, used to implement the following macros */
+void g_return_if_fail_warning (const char *log_domain,
+                              const char *pretty_function,
+                              const char *expression);
+void g_warn_message           (const char     *domain,
+                               const char     *file,
+                               int             line,
+                               const char     *func,
+                               const char     *warnexpr);
+#ifndef G_DISABLE_DEPRECATED
+void g_assert_warning         (const char *log_domain,
+                              const char *file,
+                              const int   line,
+                              const char *pretty_function,
+                              const char *expression) G_GNUC_NORETURN;
+#endif /* !G_DISABLE_DEPRECATED */
 
 
 #ifndef G_LOG_DOMAIN
 #define G_LOG_DOMAIN    ((gchar*) 0)
 #endif  /* G_LOG_DOMAIN */
 #ifdef G_HAVE_ISO_VARARGS
-#define g_error(...)    g_log (G_LOG_DOMAIN,         \
+/* for(;;); so that GCC knows that control doesn't go past g_error() */
+#define g_error(...)  G_STMT_START {                 \
+                        g_log (G_LOG_DOMAIN,         \
                                G_LOG_LEVEL_ERROR,    \
-                               __VA_ARGS__)
+                               __VA_ARGS__);         \
+                        for (;;);                    \
+                      } G_STMT_END
+                        
 #define g_message(...)  g_log (G_LOG_DOMAIN,         \
                                G_LOG_LEVEL_MESSAGE,  \
                                __VA_ARGS__)
@@ -123,10 +151,17 @@ void      _g_log_fallback_handler (const gchar   *log_domain,
 #define g_warning(...)  g_log (G_LOG_DOMAIN,         \
                                G_LOG_LEVEL_WARNING,  \
                                __VA_ARGS__)
+#define g_debug(...)    g_log (G_LOG_DOMAIN,         \
+                               G_LOG_LEVEL_DEBUG,    \
+                               __VA_ARGS__)
 #elif defined(G_HAVE_GNUC_VARARGS)
-#define g_error(format...)      g_log (G_LOG_DOMAIN,         \
+#define g_error(format...)    G_STMT_START {                 \
+                                g_log (G_LOG_DOMAIN,         \
                                        G_LOG_LEVEL_ERROR,    \
-                                       format)
+                                       format);              \
+                                for (;;);                    \
+                              } G_STMT_END
+                              
 #define g_message(format...)    g_log (G_LOG_DOMAIN,         \
                                        G_LOG_LEVEL_MESSAGE,  \
                                        format)
@@ -136,6 +171,9 @@ void        _g_log_fallback_handler (const gchar   *log_domain,
 #define g_warning(format...)    g_log (G_LOG_DOMAIN,         \
                                        G_LOG_LEVEL_WARNING,  \
                                        format)
+#define g_debug(format...)      g_log (G_LOG_DOMAIN,         \
+                                       G_LOG_LEVEL_DEBUG,    \
+                                       format)
 #else   /* no varargs macros */
 static void
 g_error (const gchar *format,
@@ -145,6 +183,8 @@ g_error (const gchar *format,
   va_start (args, format);
   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
   va_end (args);
+
+  for(;;);
 }
 static void
 g_message (const gchar *format,
@@ -173,6 +213,15 @@ g_warning (const gchar *format,
   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
   va_end (args);
 }
+static void
+g_debug (const gchar *format,
+         ...)
+{
+  va_list args;
+  va_start (args, format);
+  g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, args);
+  va_end (args);
+}
 #endif  /* !__GNUC__ */
 
 typedef void    (*GPrintFunc)           (const gchar    *string);
@@ -184,62 +233,15 @@ void            g_printerr              (const gchar    *format,
 GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
 
 
-/* Provide macros for error handling. The "assert" macros will
- *  exit on failure. The "return" macros will exit the current
- *  function. Two different definitions are given for the macros
- *  if G_DISABLE_ASSERT is not defined, in order to support gcc's
- *  __PRETTY_FUNCTION__ capability.
+/* Provide macros for graceful error handling.
+ * The "return" macros will return from the current function.
+ * Two different definitions are given for the macros in
+ * order to support gcc's __PRETTY_FUNCTION__ capability.
  */
 
-#ifdef G_DISABLE_ASSERT
-
-#define g_assert(expr)         G_STMT_START{ (void)0; }G_STMT_END
-#define g_assert_not_reached() G_STMT_START{ (void)0; }G_STMT_END
-
-#else /* !G_DISABLE_ASSERT */
-
-#ifdef __GNUC__
-
-#define g_assert(expr)                 G_STMT_START{           \
-     if (!G_LIKELY (expr))                                     \
-       g_log (G_LOG_DOMAIN,                                    \
-             G_LOG_LEVEL_ERROR,                                \
-             "file %s: line %d (%s): assertion failed: (%s)",  \
-             __FILE__,                                         \
-             __LINE__,                                         \
-             __PRETTY_FUNCTION__,                              \
-             #expr);                   }G_STMT_END
-
-#define g_assert_not_reached()         G_STMT_START{           \
-     g_log (G_LOG_DOMAIN,                                      \
-           G_LOG_LEVEL_ERROR,                                  \
-           "file %s: line %d (%s): should not be reached",     \
-           __FILE__,                                           \
-           __LINE__,                                           \
-           __PRETTY_FUNCTION__);       }G_STMT_END
-
-#else /* !__GNUC__ */
-
-#define g_assert(expr)                 G_STMT_START{           \
-     if (expr) { } else                                                \
-       g_log (G_LOG_DOMAIN,                                    \
-             G_LOG_LEVEL_ERROR,                                \
-             "file %s: line %d: assertion failed: (%s)",       \
-             __FILE__,                                         \
-             __LINE__,                                         \
-             #expr);                   }G_STMT_END
-
-#define g_assert_not_reached()         G_STMT_START{   \
-     g_log (G_LOG_DOMAIN,                              \
-           G_LOG_LEVEL_ERROR,                          \
-           "file %s: line %d: should not be reached",  \
-           __FILE__,                                   \
-           __LINE__);          }G_STMT_END
-
-#endif /* __GNUC__ */
-
-#endif /* !G_DISABLE_ASSERT */
-
+#define g_warn_if_reached()     do { g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
+#define g_warn_if_fail(expr)    do { if G_LIKELY (expr) ; else \
+                                       g_warn_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, #expr); } while (0)
 
 #ifdef G_DISABLE_CHECKS
 
@@ -253,28 +255,20 @@ GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
 #ifdef __GNUC__
 
 #define g_return_if_fail(expr)         G_STMT_START{                   \
-     if (!G_LIKELY (expr))                                             \
+     if G_LIKELY(expr) { } else                                        \
        {                                                               \
-        g_log (G_LOG_DOMAIN,                                           \
-               G_LOG_LEVEL_CRITICAL,                                   \
-               "file %s: line %d (%s): assertion `%s' failed",         \
-               __FILE__,                                               \
-               __LINE__,                                               \
-               __PRETTY_FUNCTION__,                                    \
-               #expr);                                                 \
+        g_return_if_fail_warning (G_LOG_DOMAIN,                        \
+                                  __PRETTY_FUNCTION__,                 \
+                                  #expr);                              \
         return;                                                        \
        };                              }G_STMT_END
 
 #define g_return_val_if_fail(expr,val) G_STMT_START{                   \
-     if (!G_LIKELY (expr))                                             \
+     if G_LIKELY(expr) { } else                                                \
        {                                                               \
-        g_log (G_LOG_DOMAIN,                                           \
-               G_LOG_LEVEL_CRITICAL,                                   \
-               "file %s: line %d (%s): assertion `%s' failed",         \
-               __FILE__,                                               \
-               __LINE__,                                               \
-               __PRETTY_FUNCTION__,                                    \
-               #expr);                                                 \
+        g_return_if_fail_warning (G_LOG_DOMAIN,                        \
+                                  __PRETTY_FUNCTION__,                 \
+                                  #expr);                              \
         return (val);                                                  \
        };                              }G_STMT_END
 
@@ -345,4 +339,3 @@ GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
 G_END_DECLS
 
 #endif /* __G_MESSAGES_H__ */
-