1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-internals.h random utility stuff (internal to D-BUS implementation)
4 * Copyright (C) 2002 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifdef DBUS_INSIDE_DBUS_H
24 #error "You can't include dbus-internals.h in the public header dbus.h"
27 #ifndef DBUS_INTERNALS_H
28 #define DBUS_INTERNALS_H
32 #include <dbus/dbus-memory.h>
33 #include <dbus/dbus-types.h>
34 #include <dbus/dbus-errors.h>
35 #include <dbus/dbus-sysdeps.h>
36 #include <dbus/dbus-threads.h>
40 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
41 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
42 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
43 #define _DBUS_GNUC_SCANF( format_idx, arg_idx ) \
44 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
45 #define _DBUS_GNUC_FORMAT( arg_idx ) \
46 __attribute__((__format_arg__ (arg_idx)))
47 #define _DBUS_GNUC_NORETURN \
48 __attribute__((__noreturn__))
50 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
51 #define _DBUS_GNUC_SCANF( format_idx, arg_idx )
52 #define _DBUS_GNUC_FORMAT( arg_idx )
53 #define _DBUS_GNUC_NORETURN
54 #endif /* !__GNUC__ */
56 void _dbus_warn (const char *format,
57 ...) _DBUS_GNUC_PRINTF (1, 2);
58 void _dbus_verbose_real (const char *format,
59 ...) _DBUS_GNUC_PRINTF (1, 2);
62 #ifdef DBUS_ENABLE_VERBOSE_MODE
63 # define _dbus_verbose _dbus_verbose_real
65 # ifdef HAVE_ISO_VARARGS
66 # define _dbus_verbose(...)
67 # elif defined (HAVE_GNUC_VARARGS)
68 # define _dbus_verbose(format...)
70 # error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
72 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
74 const char* _dbus_strerror (int error_number);
76 DBusResultCode _dbus_result_from_errno (int error_number);
78 #ifdef DBUS_DISABLE_ASSERT
79 #define _dbus_assert(condition)
81 #define _dbus_assert(condition) \
85 _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n", \
86 #condition, __FILE__, __LINE__); \
90 #endif /* !DBUS_DISABLE_ASSERT */
92 #ifdef DBUS_DISABLE_ASSERT
93 #define _dbus_assert_not_reached(explanation)
95 #define _dbus_assert_not_reached(explanation) \
97 _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n", \
98 __FILE__, __LINE__, (explanation)); \
101 #endif /* !DBUS_DISABLE_ASSERT */
103 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
105 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
106 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
108 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
110 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
111 ((long) ((unsigned char*) &((struct_type*) 0)->member))
113 #define _DBUS_ASSERT_ERROR_IS_SET(error) _dbus_assert ((error) == NULL || dbus_error_is_set ((error)))
115 /* This alignment thing is from ORBit2 */
116 /* Align a value upward to a boundary, expressed as a number of bytes.
117 * E.g. align to an 8-byte boundary with argument of 8.
121 * (this + boundary - 1)
126 #define _DBUS_ALIGN_VALUE(this, boundary) \
127 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
129 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
130 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
132 char* _dbus_strdup (const char *str);
134 #define _DBUS_INT_MIN (-_DBUS_INT_MAX - 1)
135 #define _DBUS_INT_MAX 2147483647
136 #define _DBUS_UINT_MAX 0xffffffff
137 #define _DBUS_MAX_SUN_PATH_LENGTH 99
138 #define _DBUS_ONE_KILOBYTE 1024
139 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
140 #define _DBUS_ONE_HOUR_IN_MILLISECONDS (1000 * 60 * 60)
141 #define _DBUS_USEC_PER_SECOND (1000000)
144 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
147 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
150 #define ABS(a) (((a) < 0) ? -(a) : (a))
152 typedef void (* DBusForeachFunction) (void *element,
155 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
156 DBusResultCode *result);
158 void _dbus_verbose_bytes (const unsigned char *data,
160 void _dbus_verbose_bytes_of_string (const DBusString *str,
165 const char* _dbus_type_to_string (int type);
167 extern const char _dbus_no_memory_message[];
168 #define _DBUS_SET_OOM(error) dbus_set_error ((error), DBUS_ERROR_NO_MEMORY, _dbus_no_memory_message)
170 #ifdef DBUS_BUILD_TESTS
171 /* Memory debugging */
172 void _dbus_set_fail_alloc_counter (int until_next_fail);
173 int _dbus_get_fail_alloc_counter (void);
174 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
175 dbus_bool_t _dbus_disable_mem_pools (void);
177 #define _dbus_set_fail_alloc_counter(n)
178 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
180 /* These are constant expressions so that blocks
181 * they protect should be optimized away
183 #define _dbus_decrement_fail_alloc_counter() FALSE
184 #define _dbus_disable_mem_pools() FALSE
185 #endif /* !DBUS_BUILD_TESTS */
187 /* Thread initializers */
188 DBusMutex *_dbus_list_init_lock (void);
189 DBusMutex *_dbus_connection_slots_init_lock (void);
190 DBusMutex *_dbus_server_slots_init_lock (void);
191 DBusMutex *_dbus_atomic_init_lock (void);
192 DBusMutex *_dbus_message_handler_init_lock (void);
193 DBusMutex *_dbus_user_info_init_lock (void);
194 DBusMutex *_dbus_bus_init_lock (void);
198 #endif /* DBUS_INTERNALS_H */