2002-12-26 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / dbus / dbus-internals.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-internals.h  random utility stuff (internal to D-BUS implementation)
3  *
4  * Copyright (C) 2002  Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 1.2
7  * 
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.
12  *
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.
17  * 
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
21  *
22  */
23 #ifdef DBUS_INSIDE_DBUS_H
24 #error "You can't include dbus-internals.h in the public header dbus.h"
25 #endif
26
27 #ifndef DBUS_INTERNALS_H
28 #define DBUS_INTERNALS_H
29
30 #include <config.h>
31
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
37 DBUS_BEGIN_DECLS;
38
39 void _dbus_warn    (const char *format,
40                     ...);
41 void _dbus_verbose (const char *format,
42                     ...);
43
44 const char* _dbus_strerror (int error_number);
45
46 DBusResultCode _dbus_result_from_errno (int error_number);
47
48 #define _dbus_assert(condition)                                         \
49 do {                                                                    \
50   if (!(condition))                                                     \
51     {                                                                   \
52       _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",      \
53                   #condition, __FILE__, __LINE__);                      \
54       _dbus_abort ();                                                   \
55     }                                                                   \
56 } while (0)
57
58 #define _dbus_assert_not_reached(explanation)                                   \
59 do {                                                                            \
60     _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",       \
61                __FILE__, __LINE__, (explanation));                              \
62     _dbus_abort ();                                                             \
63 } while (0)
64
65 #define _DBUS_N_ELEMENTS(array) ((int) (sizeof ((array)) / sizeof ((array)[0])))
66
67 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
68 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
69
70 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
71
72 char* _dbus_strdup (const char *str);
73
74 #define _DBUS_INT_MIN   (-_DBUS_INT_MAX - 1)
75 #define _DBUS_INT_MAX   2147483647
76 #define _DBUS_MAX_SUN_PATH_LENGTH 99
77 #define _DBUS_ONE_KILOBYTE 1024
78 #define _DBUS_ONE_MEGABYTE 1024 * _DBUS_ONE_KILOBYTE
79
80 typedef void (* DBusForeachFunction) (void *element,
81                                       void *data);
82
83 dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
84                                       DBusResultCode *result);
85
86 void _dbus_verbose_bytes (const unsigned char *data,
87                           int                  len);
88
89 DBUS_END_DECLS;
90
91 #endif /* DBUS_INTERNALS_H */