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 void _dbus_warn (const char *format,
42 void _dbus_verbose_real (const char *format,
46 #ifdef DBUS_ENABLE_VERBOSE_MODE
47 # define _dbus_verbose _dbus_verbose_real
49 # ifdef HAVE_ISO_VARARGS
50 # define _dbus_verbose(...)
51 # elif defined (HAVE_GNUC_VARARGS)
52 # define _dbus_verbose(format...)
54 # error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
56 #endif /* !DBUS_ENABLE_VERBOSE_MODE */
58 const char* _dbus_strerror (int error_number);
60 DBusResultCode _dbus_result_from_errno (int error_number);
62 #ifdef DBUS_DISABLE_ASSERT
63 #define _dbus_assert(condition)
65 #define _dbus_assert(condition) \
69 _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n", \
70 #condition, __FILE__, __LINE__); \
74 #endif /* !DBUS_DISABLE_ASSERT */
76 #ifdef DBUS_DISABLE_ASSERT
77 #define _dbus_assert_not_reached(explanation)
79 #define _dbus_assert_not_reached(explanation) \
81 _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n", \
82 __FILE__, __LINE__, (explanation)); \
85 #endif /* !DBUS_DISABLE_ASSERT */
87 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
89 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
90 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
92 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
94 #define _DBUS_STRUCT_OFFSET(struct_type, member) \
95 ((long) ((unsigned char*) &((struct_type*) 0)->member))
97 /* This alignment thing is from ORBit2 */
98 /* Align a value upward to a boundary, expressed as a number of bytes.
99 * E.g. align to an 8-byte boundary with argument of 8.
103 * (this + boundary - 1)
108 #define _DBUS_ALIGN_VALUE(this, boundary) \
109 (( ((unsigned long)(this)) + (((unsigned long)(boundary)) -1)) & (~(((unsigned long)(boundary))-1)))
111 #define _DBUS_ALIGN_ADDRESS(this, boundary) \
112 ((void*)_DBUS_ALIGN_VALUE(this, boundary))
114 char* _dbus_strdup (const char *str);
116 #define _DBUS_INT_MIN (-_DBUS_INT_MAX - 1)
117 #define _DBUS_INT_MAX 2147483647
118 #define _DBUS_MAX_SUN_PATH_LENGTH 99
119 #define _DBUS_ONE_KILOBYTE 1024
120 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
123 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
126 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
129 #define ABS(a) (((a) < 0) ? -(a) : (a))
131 typedef void (* DBusForeachFunction) (void *element,
134 dbus_bool_t _dbus_set_fd_nonblocking (int fd,
135 DBusResultCode *result);
137 void _dbus_verbose_bytes (const unsigned char *data,
139 void _dbus_verbose_bytes_of_string (const DBusString *str,
144 const char* _dbus_type_to_string (int type);
146 #ifdef DBUS_BUILD_TESTS
147 /* Memory debugging */
148 void _dbus_set_fail_alloc_counter (int until_next_fail);
149 int _dbus_get_fail_alloc_counter (void);
150 dbus_bool_t _dbus_decrement_fail_alloc_counter (void);
152 #define _dbus_set_fail_alloc_counter(n)
153 #define _dbus_get_fail_alloc_counter _DBUS_INT_MAX
154 #define _dbus_decrement_fail_alloc_counter() FALSE
155 #endif /* !DBUS_BUILD_TESTS */
157 /* Thread initializers */
158 DBusMutex *_dbus_list_init_lock (void);
159 DBusMutex *_dbus_allocated_slots_init_lock (void);
160 DBusMutex *_dbus_atomic_init_lock (void);
161 DBusMutex *_dbus_message_handler_init_lock (void);
165 #endif /* DBUS_INTERNALS_H */