2002-11-24 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 <stdlib.h> /* for abort() */
36 #include <string.h> /* just so it's there in every file */
37
38 DBUS_BEGIN_DECLS;
39
40 void _dbus_warn    (const char *format,
41                     ...);
42 void _dbus_verbose (const char *format,
43                     ...);
44
45 const char* _dbus_strerror (int error_number);
46
47 DBusResultCode _dbus_result_from_errno (int error_number);
48
49 #define _dbus_assert(condition)                                         \
50 do {                                                                    \
51   if (!(condition))                                                     \
52     {                                                                   \
53       _dbus_warn ("Assertion failed \"%s\" file \"%s\" line %d\n",      \
54                   #condition, __FILE__, __LINE__);                      \
55       abort ();                                                         \
56     }                                                                   \
57 } while (0)
58
59 #define _dbus_assert_not_reached(explanation)                                   \
60 do {                                                                            \
61     _dbus_warn ("File \"%s\" line %d should not have been reached: %s\n",       \
62                __FILE__, __LINE__, (explanation));                              \
63     abort ();                                                                   \
64 } while (0)
65
66 #define _DBUS_N_ELEMENTS(array) (sizeof ((array)) / sizeof ((array)[0]))
67
68 #define _DBUS_POINTER_TO_INT(pointer) ((long)(pointer))
69 #define _DBUS_INT_TO_POINTER(integer) ((void*)((long)(integer)))
70
71 #define _DBUS_ZERO(object) (memset (&(object), '\0', sizeof ((object))))
72
73 char* _dbus_strdup (const char *str);
74
75 #define _DBUS_INT_MIN   (-_DBUS_INT_MAX - 1)
76 #define _DBUS_INT_MAX   2147483647
77 #define _DBUS_MAX_SUN_PATH_LENGTH 99
78
79 typedef void (* DBusForeachFunction) (void *element,
80                                       void *data);
81
82 dbus_bool_t _dbus_set_fd_nonblocking (int             fd,
83                                       DBusResultCode *result);
84
85 DBUS_END_DECLS;
86
87 #endif /* DBUS_INTERNALS_H */