2003-08-15 Havoc Pennington <hp@redhat.com>
[platform/upstream/dbus.git] / dbus / dbus-objectid.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-objectid.h  DBusObjectID type
3  *
4  * Copyright (C) 2003  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 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25 #endif
26
27 #ifndef DBUS_OBJECTID_H
28 #define DBUS_OBJECTID_H
29
30 #include <dbus/dbus-arch-deps.h>
31 #include <dbus/dbus-types.h>
32
33 DBUS_BEGIN_DECLS;
34
35 typedef struct DBusObjectID DBusObjectID;
36
37 struct DBusObjectID
38 {
39 #ifdef DBUS_HAVE_INT64
40   dbus_uint64_t dbus_do_not_use_dummy1;
41 #else
42   dbus_uint32_t dbus_do_not_use_dummy2;
43   dbus_uint32_t dbus_do_not_use_dummy3;
44 #endif
45 };
46
47 dbus_bool_t   dbus_object_id_equal               (const DBusObjectID *a,
48                                                   const DBusObjectID *b);
49 int           dbus_object_id_compare             (const DBusObjectID *a,
50                                                   const DBusObjectID *b);
51 dbus_uint16_t dbus_object_id_get_server_bits     (const DBusObjectID *obj_id);
52 dbus_uint16_t dbus_object_id_get_client_bits     (const DBusObjectID *obj_id);
53 dbus_uint32_t dbus_object_id_get_connection_bits (const DBusObjectID *obj_id);
54 dbus_bool_t   dbus_object_id_get_is_server_bit   (const DBusObjectID *obj_id);
55 dbus_uint32_t dbus_object_id_get_instance_bits   (const DBusObjectID *obj_id);
56 void          dbus_object_id_set_server_bits     (DBusObjectID       *obj_id,
57                                                   dbus_uint16_t       value);
58 void          dbus_object_id_set_client_bits     (DBusObjectID       *obj_id,
59                                                   dbus_uint16_t       value);
60 void          dbus_object_id_set_is_server_bit   (DBusObjectID       *obj_id,
61                                                   dbus_bool_t         value);
62 void          dbus_object_id_set_instance_bits   (DBusObjectID       *obj_id,
63                                                   dbus_uint32_t       value);
64 void          dbus_object_id_set_null            (DBusObjectID       *obj_id);
65 dbus_bool_t   dbus_object_id_is_null             (const DBusObjectID *obj_id);
66
67 #ifdef DBUS_HAVE_INT64
68 dbus_uint64_t          dbus_object_id_get_as_integer (const DBusObjectID *obj_id);
69 void                   dbus_object_id_set_as_integer (DBusObjectID       *obj_id,
70                                                       dbus_uint64_t       value);
71 #endif
72
73 DBUS_END_DECLS;
74
75 #endif /* DBUS_OBJECTID_H */