2003-04-30 Havoc Pennington <hp@redhat.com>
[platform/upstream/dbus.git] / dbus / dbus-internals.h
index 72658b6..6a0ae74 100644 (file)
@@ -1,7 +1,7 @@
 /* -*- mode: C; c-file-style: "gnu" -*- */
 /* dbus-internals.h  random utility stuff (internal to D-BUS implementation)
  *
- * Copyright (C) 2002  Red Hat, Inc.
+ * Copyright (C) 2002, 2003  Red Hat, Inc.
  *
  * Licensed under the Academic Free License version 1.2
  * 
 
 DBUS_BEGIN_DECLS;
 
-#if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
-#define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
-  __attribute__((__format__ (__printf__, format_idx, arg_idx)))
-#define _DBUS_GNUC_SCANF( format_idx, arg_idx )     \
-  __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
-#define _DBUS_GNUC_FORMAT( arg_idx )                \
-  __attribute__((__format_arg__ (arg_idx)))
-#define _DBUS_GNUC_NORETURN                         \
-  __attribute__((__noreturn__))
-#else   /* !__GNUC__ */
-#define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
-#define _DBUS_GNUC_SCANF( format_idx, arg_idx )
-#define _DBUS_GNUC_FORMAT( arg_idx )
-#define _DBUS_GNUC_NORETURN
-#endif  /* !__GNUC__ */
-
-void _dbus_warn         (const char *format,
-                         ...) _DBUS_GNUC_PRINTF (1, 2);
-void _dbus_verbose_real (const char *format,
-                         ...) _DBUS_GNUC_PRINTF (1, 2);
+void _dbus_warn               (const char *format,
+                               ...) _DBUS_GNUC_PRINTF (1, 2);
+void _dbus_verbose_real       (const char *format,
+                               ...) _DBUS_GNUC_PRINTF (1, 2);
+void _dbus_verbose_reset_real (void);
 
+#if defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
+#define _DBUS_FUNCTION_NAME __func__
+#elif defined(__GNUC__)
+#define _DBUS_FUNCTION_NAME __FUNCTION__
+#else
+#define _DBUS_FUNCTION_NAME "unknown function"
+#endif
 
 #ifdef DBUS_ENABLE_VERBOSE_MODE
 #  define _dbus_verbose _dbus_verbose_real
+#  define _dbus_verbose_reset _dbus_verbose_reset_real
 #else
 #  ifdef HAVE_ISO_VARARGS
 #    define _dbus_verbose(...)
@@ -69,35 +62,52 @@ void _dbus_verbose_real (const char *format,
 #  else
 #    error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
 #  endif
+#  define _dbus_verbose_reset()
 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
 
 const char* _dbus_strerror (int error_number);
 
-DBusResultCode _dbus_result_from_errno (int error_number);
-
 #ifdef DBUS_DISABLE_ASSERT
 #define _dbus_assert(condition)
 #else
+void _dbus_real_assert (dbus_bool_t  condition,
+                        const char  *condition_text,
+                        const char  *file,
+                        int          line);
 #define _dbus_assert(condition)                                         \
-do {                                                                    \
-  if (!(condition))                                                     \
-    {                                                                   \
-      _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",      \
-                  #condition, __FILE__, __LINE__);                      \
-      _dbus_abort ();                                                   \
-    }                                                                   \
-} while (0)
+  _dbus_real_assert ((condition) != 0, #condition, __FILE__, __LINE__)
 #endif /* !DBUS_DISABLE_ASSERT */
 
 #ifdef DBUS_DISABLE_ASSERT
 #define _dbus_assert_not_reached(explanation)
 #else
+void _dbus_real_assert_not_reached (const char *explanation,
+                                    const char *file,
+                                    int         line) _DBUS_GNUC_NORETURN;
 #define _dbus_assert_not_reached(explanation)                                   \
-do {                                                                            \
-    _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",       \
-               __FILE__, __LINE__, (explanation));                              \
-    _dbus_abort ();                                                             \
-} while (0)
+  _dbus_real_assert_not_reached (explanation, __FILE__, __LINE__)
+#endif /* !DBUS_DISABLE_ASSERT */
+
+#ifdef DBUS_DISABLE_CHECKS
+#define _dbus_return_if_fail(condition)
+#define _dbus_return_val_if_fail(condition, val)
+#else
+extern const char _dbus_return_if_fail_warning_format[];
+
+#define _dbus_return_if_fail(condition) do {                            \
+  if (!(condition)) {                                                   \
+    _dbus_warn (_dbus_return_if_fail_warning_format,                    \
+                _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);   \
+    return;                                                             \
+  } } while (0)
+
+#define _dbus_return_val_if_fail(condition, val) do {                   \
+  if (!(condition)) {                                                   \
+    _dbus_warn (_dbus_return_if_fail_warning_format,                    \
+                _DBUS_FUNCTION_NAME, #condition, __FILE__, __LINE__);   \
+    return (val);                                                       \
+  } } while (0)
+
 #endif /* !DBUS_DISABLE_ASSERT */
 
 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
@@ -110,7 +120,11 @@ do {
 #define _DBUS_STRUCT_OFFSET(struct_type, member)       \
     ((long) ((unsigned char*) &((struct_type*) 0)->member))
 
-#define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
+#define _DBUS_ASSERT_ERROR_IS_SET(error)   _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
+#define _DBUS_ASSERT_ERROR_IS_CLEAR(error) _dbus_assert ((error) == NULL || !dbus_error_is_set ((error)))
+
+#define _dbus_return_if_error_is_set(error) _dbus_return_if_fail ((error) == NULL || !dbus_error_is_set ((error)))
+#define _dbus_return_val_if_error_is_set(error, val) _dbus_return_val_if_fail ((error) == NULL || !dbus_error_is_set ((error)), (val))
 
 /* This alignment thing is from ORBit2 */
 /* Align a value upward to a boundary, expressed as a number of bytes.
@@ -129,12 +143,18 @@ do {
 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
   ((void*)_DBUS_ALIGN_VALUE(this, boundary))
 
-char* _dbus_strdup (const char *str);
-
-#define _DBUS_INT_MIN  (-_DBUS_INT_MAX - 1)
-#define _DBUS_INT_MAX  2147483647
-#define _DBUS_UINT_MAX 0xffffffff
-#define _DBUS_MAX_SUN_PATH_LENGTH 99
+char*       _dbus_strdup                (const char  *str);
+dbus_bool_t _dbus_string_array_contains (const char **array,
+                                         const char  *str);
+char**      _dbus_dup_string_array      (const char **array);
+
+#define _DBUS_INT_MIN   (-_DBUS_INT_MAX - 1)
+#define _DBUS_INT_MAX   2147483647
+#define _DBUS_UINT_MAX  0xffffffff
+#ifdef DBUS_HAVE_INT64
+#define _DBUS_INT64_MAX         DBUS_INT64_CONSTANT (9223372036854775807)
+#define _DBUS_UINT64_MAX DBUS_UINT64_CONSTANT (0xffffffffffffffff)
+#endif
 #define _DBUS_ONE_KILOBYTE 1024
 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
@@ -153,7 +173,7 @@ typedef void (* DBusForeachFunction) (void *element,
                                       void *data);
 
 dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
-                                      DBusResultCode *result);
+                                      DBusError      *error);
 
 void _dbus_verbose_bytes           (const unsigned char *data,
                                     int                  len);
@@ -171,9 +191,16 @@ extern const char _dbus_no_memory_message[];
 /* Memory debugging */
 void        _dbus_set_fail_alloc_counter        (int  until_next_fail);
 int         _dbus_get_fail_alloc_counter        (void);
+void        _dbus_set_fail_alloc_failures       (int  failures_per_failure);
+int         _dbus_get_fail_alloc_failures       (void);
 dbus_bool_t _dbus_decrement_fail_alloc_counter  (void);
 dbus_bool_t _dbus_disable_mem_pools             (void);
 int         _dbus_get_malloc_blocks_outstanding (void);
+
+typedef dbus_bool_t (* DBusTestMemoryFunction)  (void *data);
+dbus_bool_t _dbus_test_oom_handling (const char             *description,
+                                     DBusTestMemoryFunction  func,
+                                     void                   *data);
 #else
 #define _dbus_set_fail_alloc_counter(n)
 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
@@ -204,9 +231,12 @@ _DBUS_DECLARE_GLOBAL_LOCK (connection_slots);
 _DBUS_DECLARE_GLOBAL_LOCK (server_slots);
 _DBUS_DECLARE_GLOBAL_LOCK (atomic);
 _DBUS_DECLARE_GLOBAL_LOCK (message_handler);
-_DBUS_DECLARE_GLOBAL_LOCK (user_info);
 _DBUS_DECLARE_GLOBAL_LOCK (bus);
-#define _DBUS_N_GLOBAL_LOCKS (7)
+_DBUS_DECLARE_GLOBAL_LOCK (shutdown_funcs);
+_DBUS_DECLARE_GLOBAL_LOCK (system_users);
+#define _DBUS_N_GLOBAL_LOCKS (8)
+
+dbus_bool_t _dbus_threads_init_debug (void);
 
 DBUS_END_DECLS;