Mercurial > pidgin.yaz
annotate src/dbus-server.h @ 14133:31d33e7bc0e6
[gaim-migrate @ 16775]
A global buddy icon selector in the statusbox.
This is done totally in the GTK+ UI; the core still sees a buddy icon as
belonging to an account.
Per-account icons can override the global one in Modify Account.
There are some caching issues to work out, still.
committer: Tailor Script <tailor@pidgin.im>
author | Sean Egan <seanegan@gmail.com> |
---|---|
date | Tue, 15 Aug 2006 23:25:29 +0000 |
parents | 8bda65b88e49 |
children |
rev | line source |
---|---|
11055 | 1 /** |
2 * @file dbus-server.h Gaim DBUS Server | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 * | |
25 */ | |
26 | |
27 #ifndef _GAIM_DBUS_SERVER_H_ | |
28 #define _GAIM_DBUS_SERVER_H_ | |
29 | |
11080 | 30 #include "value.h" |
11067 | 31 |
11171 | 32 |
11055 | 33 G_BEGIN_DECLS |
34 | |
14035 | 35 /** |
11171 | 36 Types of pointers are identified by the ADDRESS of a GaimDbusType |
37 object. This way, plugins can easily access types defined in gaim | |
38 proper as well as introduce their own types that will not conflict | |
39 with those introduced by other plugins. | |
40 | |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
41 The structure GaimDbusType has only one element (GaimDBusType::parent), a |
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
42 contains a pointer to the parent type, or @c NULL if the type has no |
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
43 parent. Parent means the same as the base class in object oriented |
14035 | 44 programming. |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
45 */ |
11171 | 46 |
47 typedef struct _GaimDBusType GaimDBusType; | |
48 | |
49 struct _GaimDBusType { | |
50 GaimDBusType *parent; | |
51 }; | |
11067 | 52 |
13783
a539caf502b0
[gaim-migrate @ 16195]
Richard Laager <rlaager@wiktel.com>
parents:
12627
diff
changeset
|
53 /* By convention, the GaimDBusType variable representing each structure |
11171 | 54 GaimSomeStructure has the name GAIM_DBUS_TYPE_GaimSomeStructure. |
55 The following macros facilitate defining such variables | |
11067 | 56 |
11171 | 57 #GAIM_DBUS_DECLARE_TYPE declares an extern variable representing a |
58 given type, for use in header files. | |
59 | |
60 #GAIM_DBUS_DEFINE_TYPE defines a variable representing a given | |
61 type, use in .c files. It defines a new type without a parent; for | |
62 types with a parent use #GAIM_DBUS_DEFINE_INHERITING_TYPE. | |
63 */ | |
11080 | 64 |
11171 | 65 #define GAIM_DBUS_TYPE(type) (&GAIM_DBUS_TYPE_##type) |
66 | |
67 | |
68 #define GAIM_DBUS_DECLARE_TYPE(type) \ | |
69 extern GaimDBusType GAIM_DBUS_TYPE_##type; | |
11067 | 70 |
11171 | 71 #define GAIM_DBUS_DEFINE_TYPE(type) \ |
72 GaimDBusType GAIM_DBUS_TYPE_##type = { NULL }; | |
11080 | 73 |
11171 | 74 #define GAIM_DBUS_DEFINE_INHERITING_TYPE(type, parent) \ |
75 GaimDBusType GAIM_DBUS_TYPE_##type = { GAIM_DBUS_TYPE(parent) }; | |
76 | |
13956 | 77 #define GAIM_DBUS_RETURN_FALSE_IF_DISABLED(plugin) \ |
78 if (gaim_dbus_get_init_error() != NULL) \ | |
79 { \ | |
80 gchar *title; \ | |
81 title = g_strdup_printf("Unable to Load %s Plugin", plugin->info->name); \ | |
82 gaim_notify_error(NULL, title, \ | |
83 _("Gaim's D-BUS server is not running for the reason listed below"), \ | |
84 _(gaim_dbus_get_init_error())); \ | |
85 g_free(title); \ | |
86 return FALSE; \ | |
87 } | |
11055 | 88 |
11067 | 89 /** |
90 Initializes gaim dbus pointer registration engine. | |
91 | |
92 Remote dbus applications need a way of addressing objects exposed | |
93 by gaim to the outside world. In gaim itself, these objects (such | |
94 as GaimBuddy and company) are identified by pointers. The gaim | |
95 dbus pointer registration engine converts pointers to handles and | |
96 back. | |
97 | |
98 In order for an object to participate in the scheme, it must | |
99 register itself and its type with the engine. This registration | |
100 allocates an integer id which can be resolved to the pointer and | |
14035 | 101 back. |
11067 | 102 |
103 Handles are not persistent. They are reissued every time gaim is | |
104 started. This is not good; external applications that use gaim | |
105 should work even whether gaim was restarted in the middle of the | |
106 interaction. | |
107 | |
108 Pointer registration is only a temporary solution. When GaimBuddy | |
109 and similar structures have been converted into gobjects, this | |
110 registration will be done automatically by objects themselves. | |
14035 | 111 |
11067 | 112 By the way, this kind of object-handle translation should be so |
113 common that there must be a library (maybe even glib) that | |
114 implements it. I feel a bit like reinventing the wheel here. | |
115 */ | |
116 void gaim_dbus_init_ids(void); | |
117 | |
14035 | 118 /** |
11067 | 119 Registers a typed pointer. |
120 | |
11129 | 121 @param node The pointer to register. |
122 @param type Type of that pointer. | |
11067 | 123 */ |
11171 | 124 void gaim_dbus_register_pointer(gpointer node, GaimDBusType *type); |
11067 | 125 |
14035 | 126 /** |
11067 | 127 Unregisters a pointer previously registered with |
128 gaim_dbus_register_pointer. | |
129 | |
11129 | 130 @param node The pointer to register. |
11067 | 131 */ |
132 void gaim_dbus_unregister_pointer(gpointer node); | |
133 | |
11080 | 134 |
135 | |
136 /** | |
137 Emits a dbus signal. | |
138 | |
11171 | 139 @param name The name of the signal ("bla-bla-blaa") |
11080 | 140 @param num_values The number of parameters. |
141 @param values Array of pointers to #GaimValue objects representing | |
142 the types of the parameters. | |
143 @param vargs A va_list containing the actual parameters. | |
11171 | 144 */ |
14035 | 145 void gaim_dbus_signal_emit_gaim(const char *name, int num_values, |
11171 | 146 GaimValue **values, va_list vargs); |
11080 | 147 |
11171 | 148 /** |
13955 | 149 * Returns whether Gaim's D-BUS subsystem is up and running. If it's |
150 * NOT running then gaim_dbus_dispatch_init() failed for some reason, | |
151 * and a message should have been gaim_debug_error()'ed. | |
152 * | |
13956 | 153 * Gaim plugins that use D-BUS should use the |
154 * GAIM_DBUS_RETURN_FALSE_IF_DISABLED macro to short-circuit | |
155 * initialization if Gaim's D-BUS subsystem is not running. | |
11171 | 156 * |
13955 | 157 * @return If the D-BUS subsystem started with no problems then this |
158 * will return NULL and everything will be hunky dory. If | |
159 * there was an error initializing the D-BUS subsystem then | |
160 * this will return an error message explaining why. | |
11171 | 161 */ |
13955 | 162 const char *gaim_dbus_get_init_error(void); |
11080 | 163 |
12627 | 164 /** |
165 * Returns the dbus subsystem handle. | |
166 * | |
167 * @return The dbus subsystem handle. | |
168 */ | |
169 void *gaim_dbus_get_handle(void); | |
11080 | 170 |
11171 | 171 /** |
13955 | 172 * Starts Gaim's D-BUS server. It is responsible for handling DBUS |
173 * requests from other applications. | |
174 */ | |
175 void gaim_dbus_init(void); | |
176 | |
177 /** | |
178 * Uninitializes Gaim's D-BUS server. | |
179 */ | |
180 void gaim_dbus_uninit(void); | |
181 | |
182 /** | |
11171 | 183 |
184 Macro #DBUS_EXPORT expands to nothing. It is used to indicate to the | |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
185 dbus-analize-functions.py script that the given function should be |
11171 | 186 available to other applications through DBUS. If |
11501
9563b768e8e2
[gaim-migrate @ 13746]
Richard Laager <rlaager@wiktel.com>
parents:
11171
diff
changeset
|
187 dbus-analize-functions.py is run without the "--export-only" option, |
11171 | 188 this prefix is ignored. |
189 | |
190 */ | |
191 | |
192 #define DBUS_EXPORT | |
193 | |
14035 | 194 /* |
11171 | 195 Here we include the list of #GAIM_DBUS_DECLARE_TYPE statements for |
196 all structs defined in gaim. This file has been generated by the | |
197 #dbus-analize-types.py script. | |
198 */ | |
199 | |
200 #include "dbus-types.h" | |
11067 | 201 |
11055 | 202 G_END_DECLS |
203 | |
204 #endif /* _GAIM_DBUS_SERVER_H_ */ |