Mercurial > pidgin.yaz
annotate src/plugin.h @ 10467:cbbf5af9e520
[gaim-migrate @ 11747]
Stupid mistake. Hopefully this will enable SecurID for real.
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Mon, 03 Jan 2005 05:08:03 +0000 |
parents | 577fdf4110fc |
children | 12460aa2c820 |
rev | line source |
---|---|
5205 | 1 /** |
2 * @file plugin.h Plugin API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
8046 | 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. | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
5949
diff
changeset
|
10 * |
5205 | 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 #ifndef _GAIM_PLUGIN_H_ | |
26 #define _GAIM_PLUGIN_H_ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
27 |
8986 | 28 #include <glib/glist.h> |
5224
5160333a80df
[gaim-migrate @ 5594]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5205
diff
changeset
|
29 #include <gmodule.h> |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
30 #include "signals.h" |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
31 #include "value.h" |
5205 | 32 |
8749
d7b8eb1f0a18
[gaim-migrate @ 9504]
Christian Hammond <chipx86@chipx86.com>
parents:
8735
diff
changeset
|
33 typedef struct _GaimPlugin GaimPlugin; |
d7b8eb1f0a18
[gaim-migrate @ 9504]
Christian Hammond <chipx86@chipx86.com>
parents:
8735
diff
changeset
|
34 typedef struct _GaimPluginInfo GaimPluginInfo; |
d7b8eb1f0a18
[gaim-migrate @ 9504]
Christian Hammond <chipx86@chipx86.com>
parents:
8735
diff
changeset
|
35 typedef struct _GaimPluginUiInfo GaimPluginUiInfo; |
5205 | 36 typedef struct _GaimPluginLoaderInfo GaimPluginLoaderInfo; |
37 | |
9015 | 38 typedef struct _GaimPluginAction GaimPluginAction; |
39 | |
5205 | 40 typedef int GaimPluginPriority; /**< Plugin priority. */ |
41 | |
8713 | 42 #include "pluginpref.h" |
43 | |
5205 | 44 /** |
45 * Plugin types. | |
46 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
47 typedef enum |
5205 | 48 { |
49 GAIM_PLUGIN_UNKNOWN = -1, /**< Unknown type. */ | |
50 GAIM_PLUGIN_STANDARD = 0, /**< Standard plugin. */ | |
51 GAIM_PLUGIN_LOADER, /**< Loader plugin. */ | |
52 GAIM_PLUGIN_PROTOCOL /**< Protocol plugin. */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
53 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
54 } GaimPluginType; |
5205 | 55 |
56 #define GAIM_PRIORITY_DEFAULT 0 | |
57 #define GAIM_PRIORITY_HIGHEST 9999 | |
58 #define GAIM_PRIORITY_LOWEST -9999 | |
59 | |
6928
6ed0a1c045b4
[gaim-migrate @ 7475]
Christian Hammond <chipx86@chipx86.com>
parents:
6822
diff
changeset
|
60 #define GAIM_PLUGIN_FLAG_INVISIBLE 0x01 |
6ed0a1c045b4
[gaim-migrate @ 7475]
Christian Hammond <chipx86@chipx86.com>
parents:
6822
diff
changeset
|
61 |
9946 | 62 #define GAIM_PLUGIN_MAGIC 5 /* once we hit 6.0.0 I think we can remove this */ |
8749
d7b8eb1f0a18
[gaim-migrate @ 9504]
Christian Hammond <chipx86@chipx86.com>
parents:
8735
diff
changeset
|
63 |
5205 | 64 /** |
65 * Detailed information about a plugin. | |
66 * | |
67 * This is used in the version 2.0 API and up. | |
68 */ | |
69 struct _GaimPluginInfo | |
70 { | |
9943 | 71 unsigned int magic; |
72 unsigned int major_version; | |
73 unsigned int minor_version; | |
5205 | 74 GaimPluginType type; |
75 char *ui_requirement; | |
76 unsigned long flags; | |
77 GList *dependencies; | |
78 GaimPluginPriority priority; | |
79 | |
80 char *id; | |
81 char *name; | |
82 char *version; | |
83 char *summary; | |
84 char *description; | |
85 char *author; | |
86 char *homepage; | |
87 | |
10450 | 88 /* |
89 * TODO: I think the intention was the allow multiple load and unload | |
90 * callback functions. Perhaps using a GList instead of a pointer to | |
91 * 1 function. | |
92 */ | |
5205 | 93 gboolean (*load)(GaimPlugin *plugin); |
94 gboolean (*unload)(GaimPlugin *plugin); | |
95 void (*destroy)(GaimPlugin *plugin); | |
96 | |
97 void *ui_info; | |
98 void *extra_info; | |
8814 | 99 GaimPluginUiInfo *prefs_info; |
9015 | 100 GList *(*actions)(GaimPlugin *plugin, gpointer context); |
5205 | 101 }; |
102 | |
103 /** | |
104 * Extra information for loader plugins. | |
105 */ | |
106 struct _GaimPluginLoaderInfo | |
107 { | |
108 GList *exts; | |
109 | |
110 gboolean (*probe)(GaimPlugin *plugin); | |
111 gboolean (*load)(GaimPlugin *plugin); | |
112 gboolean (*unload)(GaimPlugin *plugin); | |
113 void (*destroy)(GaimPlugin *plugin); | |
114 }; | |
115 | |
116 /** | |
117 * A plugin handle. | |
118 */ | |
119 struct _GaimPlugin | |
120 { | |
121 gboolean native_plugin; /**< Native C plugin. */ | |
122 gboolean loaded; /**< The loaded state. */ | |
123 void *handle; /**< The module handle. */ | |
124 char *path; /**< The path to the plugin. */ | |
125 GaimPluginInfo *info; /**< The plugin information. */ | |
126 char *error; | |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
127 void *ipc_data; /**< IPC data. */ |
5205 | 128 void *extra; /**< Plugin-specific data. */ |
129 }; | |
130 | |
131 #define GAIM_PLUGIN_LOADER_INFO(plugin) \ | |
132 ((GaimPluginLoaderInfo *)(plugin)->info->extra_info) | |
133 | |
8713 | 134 struct _GaimPluginUiInfo { |
135 GaimPluginPrefFrame *(*get_plugin_pref_frame)(GaimPlugin *plugin); | |
136 | |
137 void *iter; /**< Reserved */ | |
8814 | 138 GaimPluginPrefFrame *frame; /**< Reserved */ |
8713 | 139 }; |
140 | |
141 #define GAIM_PLUGIN_HAS_PREF_FRAME(plugin) \ | |
142 ((plugin)->info != NULL && (plugin)->info->prefs_info != NULL) | |
143 | |
144 #define GAIM_PLUGIN_UI_INFO(plugin) \ | |
145 ((GaimPluginUiInfo*)(plugin)->info->prefs_info) | |
146 | |
9015 | 147 |
148 /** | |
149 * The structure used in the actions member of GaimPluginInfo | |
150 */ | |
151 struct _GaimPluginAction { | |
152 char *label; | |
153 void (*callback)(GaimPluginAction *); | |
154 | |
155 /** set to the owning plugin */ | |
156 GaimPlugin *plugin; | |
157 | |
158 /** NULL for plugin actions menu, set to the GaimConnection for | |
159 account actions menu */ | |
160 gpointer context; | |
161 }; | |
162 | |
163 #define GAIM_PLUGIN_HAS_ACTIONS(plugin) \ | |
164 ((plugin)->info != NULL && (plugin)->info->actions != NULL) | |
165 | |
166 #define GAIM_PLUGIN_ACTIONS(plugin, context) \ | |
167 (GAIM_PLUGIN_HAS_ACTIONS(plugin)? \ | |
168 (plugin)->info->actions(plugin, context): NULL) | |
169 | |
170 | |
5205 | 171 /** |
172 * Handles the initialization of modules. | |
173 */ | |
8082 | 174 #if !defined(GAIM_PLUGINS) || defined(GAIM_STATIC_PRPL) |
5205 | 175 # define GAIM_INIT_PLUGIN(pluginname, initfunc, plugininfo) \ |
176 gboolean gaim_init_##pluginname##_plugin(void) { \ | |
177 GaimPlugin *plugin = gaim_plugin_new(TRUE, NULL); \ | |
178 plugin->info = &(plugininfo); \ | |
179 initfunc((plugin)); \ | |
180 return gaim_plugin_register(plugin); \ | |
181 } | |
8082 | 182 #else /* GAIM_PLUGINS && !GAIM_STATIC_PRPL */ |
5205 | 183 # define GAIM_INIT_PLUGIN(pluginname, initfunc, plugininfo) \ |
5224
5160333a80df
[gaim-migrate @ 5594]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5205
diff
changeset
|
184 G_MODULE_EXPORT gboolean gaim_init_plugin(GaimPlugin *plugin) { \ |
5205 | 185 plugin->info = &(plugininfo); \ |
186 initfunc((plugin)); \ | |
187 return gaim_plugin_register(plugin); \ | |
188 } | |
189 #endif | |
190 | |
9015 | 191 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
192 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
193 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
194 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
195 |
8986 | 196 |
197 void *gaim_plugins_get_handle(void); | |
198 | |
199 | |
5205 | 200 /**************************************************************************/ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
201 /** @name Plugin API */ |
5205 | 202 /**************************************************************************/ |
203 /*@{*/ | |
204 | |
205 /** | |
206 * Creates a new plugin structure. | |
207 * | |
208 * @param native Whether or not the plugin is native. | |
209 * @param path The path to the plugin, or @c NULL if statically compiled. | |
210 * | |
211 * @return A new GaimPlugin structure. | |
212 */ | |
213 GaimPlugin *gaim_plugin_new(gboolean native, const char *path); | |
214 | |
215 /** | |
216 * Probes a plugin, retrieving the information on it and adding it to the | |
217 * list of available plugins. | |
218 * | |
219 * @param filename The plugin's filename. | |
220 * | |
221 * @return The plugin handle. | |
222 * | |
223 * @see gaim_plugin_load() | |
224 * @see gaim_plugin_destroy() | |
225 */ | |
226 GaimPlugin *gaim_plugin_probe(const char *filename); | |
227 | |
228 /** | |
229 * Registers a plugin and prepares it for loading. | |
230 * | |
231 * This shouldn't be called by anything but the internal module code. | |
10447 | 232 * Plugins should use the GAIM_INIT_PLUGIN() macro to register themselves |
233 * with the core. | |
5205 | 234 * |
235 * @param plugin The plugin to register. | |
10447 | 236 * |
237 * @return @c TRUE if the plugin was registered successfully. Otherwise | |
238 * @c FALSE is returned (this happens if the plugin does not contain | |
239 * the necessary information). | |
5205 | 240 */ |
241 gboolean gaim_plugin_register(GaimPlugin *plugin); | |
242 | |
243 /** | |
244 * Attempts to load a previously probed plugin. | |
245 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6486
diff
changeset
|
246 * @param plugin The plugin to load. |
5205 | 247 * |
248 * @return @c TRUE if successful, or @c FALSE otherwise. | |
249 * | |
250 * @see gaim_plugin_reload() | |
251 * @see gaim_plugin_unload() | |
252 */ | |
253 gboolean gaim_plugin_load(GaimPlugin *plugin); | |
254 | |
255 /** | |
256 * Unloads the specified plugin. | |
257 * | |
258 * @param plugin The plugin handle. | |
259 * | |
260 * @return @c TRUE if successful, or @c FALSE otherwise. | |
261 * | |
262 * @see gaim_plugin_load() | |
263 * @see gaim_plugin_reload() | |
264 */ | |
265 gboolean gaim_plugin_unload(GaimPlugin *plugin); | |
266 | |
267 /** | |
268 * Reloads a plugin. | |
269 * | |
270 * @param plugin The old plugin handle. | |
6486
fab81e4b885c
[gaim-migrate @ 7000]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
271 * |
5205 | 272 * @return @c TRUE if successful, or @c FALSE otherwise. |
273 * | |
274 * @see gaim_plugin_load() | |
275 * @see gaim_plugin_unload() | |
276 */ | |
277 gboolean gaim_plugin_reload(GaimPlugin *plugin); | |
278 | |
279 /** | |
280 * Unloads a plugin and destroys the structure from memory. | |
281 * | |
282 * @param plugin The plugin handle. | |
283 */ | |
284 void gaim_plugin_destroy(GaimPlugin *plugin); | |
285 | |
286 /** | |
287 * Returns whether or not a plugin is currently loaded. | |
288 * | |
289 * @param plugin The plugin. | |
290 * | |
291 * @return TRUE if loaded, or FALSE otherwise. | |
292 */ | |
293 gboolean gaim_plugin_is_loaded(const GaimPlugin *plugin); | |
294 | |
295 /*@}*/ | |
296 | |
297 /**************************************************************************/ | |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
298 /** @name Plugin IPC API */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
299 /**************************************************************************/ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
300 /*@{*/ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
301 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
302 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
303 * Registers an IPC command in a plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
304 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
305 * @param plugin The plugin to register the command with. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
306 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
307 * @param func The function to execute. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
308 * @param marshal The marshalling function. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
309 * @param ret_value The return value type. |
7114
c47633e9e2a4
[gaim-migrate @ 7681]
Christian Hammond <chipx86@chipx86.com>
parents:
7034
diff
changeset
|
310 * @param num_params The number of parameters. |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
311 * @param ... The parameter types. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
312 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
313 * @return TRUE if the function was registered successfully, or |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
314 * FALSE otherwise. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
315 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
316 gboolean gaim_plugin_ipc_register(GaimPlugin *plugin, const char *command, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
317 GaimCallback func, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
318 GaimSignalMarshalFunc marshal, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
319 GaimValue *ret_value, int num_params, ...); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
320 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
321 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
322 * Unregisters an IPC command in a plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
323 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
324 * @param plugin The plugin to unregister the command from. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
325 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
326 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
327 void gaim_plugin_ipc_unregister(GaimPlugin *plugin, const char *command); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
328 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
329 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
330 * Unregisters all IPC commands in a plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
331 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
332 * @param plugin The plugin to unregister the commands from. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
333 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
334 void gaim_plugin_ipc_unregister_all(GaimPlugin *plugin); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
335 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
336 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
337 * Returns a list of value types used for an IPC command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
338 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
339 * @param plugin The plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
340 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
341 * @param ret_value The returned return value. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
342 * @param num_params The returned number of parameters. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
343 * @param params The returned list of parameters. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
344 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
345 * @return TRUE if the command was found, or FALSE otherwise. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
346 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
347 gboolean gaim_plugin_ipc_get_params(GaimPlugin *plugin, const char *command, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
348 GaimValue **ret_value, int *num_params, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
349 GaimValue ***params); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
350 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
351 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
352 * Executes an IPC command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
353 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
354 * @param plugin The plugin to execute the command on. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
355 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
356 * @param ok TRUE if the call was successful, or FALSE otherwise. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
357 * @param ... The parameters to pass. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
358 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
359 * @return The return value, which will be NULL if the command doesn't |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
360 * return a value. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
361 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
362 void *gaim_plugin_ipc_call(GaimPlugin *plugin, const char *command, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
363 gboolean *ok, ...); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
364 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
365 /*@}*/ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
366 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
367 /**************************************************************************/ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
368 /** @name Plugins API */ |
5205 | 369 /**************************************************************************/ |
370 /*@{*/ | |
371 | |
372 /** | |
10447 | 373 * Add a new directory to search for plugins |
5205 | 374 * |
10448 | 375 * @param path The new search path. |
5205 | 376 */ |
10447 | 377 void gaim_plugins_add_search_path(const char *path); |
5205 | 378 |
379 /** | |
5242
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
380 * Unloads all loaded plugins. |
5205 | 381 */ |
382 void gaim_plugins_unload_all(void); | |
383 | |
5242
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
384 /** |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
385 * Destroys all registered plugins. |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
386 */ |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
387 void gaim_plugins_destroy_all(void); |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
388 |
5205 | 389 /** |
5949
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
390 * Attempts to load all the plugins in the specified preference key |
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
391 * that were loaded when gaim last quit. |
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
392 * |
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
393 * @param key The preference key containing the list of plugins. |
5838 | 394 */ |
5949
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
395 void gaim_plugins_load_saved(const char *key); |
5838 | 396 |
397 /** | |
5205 | 398 * Probes for plugins in the registered module paths. |
399 * | |
400 * @param ext The extension type to probe for, or @c NULL for all. | |
401 * | |
402 * @see gaim_plugin_set_probe_path() | |
403 */ | |
404 void gaim_plugins_probe(const char *ext); | |
405 | |
406 /** | |
407 * Returns whether or not plugin support is enabled. | |
408 * | |
409 * @return TRUE if plugin support is enabled, or FALSE otherwise. | |
410 */ | |
411 gboolean gaim_plugins_enabled(void); | |
412 | |
413 /** | |
414 * Registers a function that will be called when probing is finished. | |
415 * | |
416 * @param func The callback function. | |
417 * @param data Data to pass to the callback. | |
418 */ | |
419 void gaim_plugins_register_probe_notify_cb(void (*func)(void *), void *data); | |
420 | |
421 /** | |
422 * Unregisters a function that would be called when probing is finished. | |
423 * | |
424 * @param func The callback function. | |
425 */ | |
426 void gaim_plugins_unregister_probe_notify_cb(void (*func)(void *)); | |
427 | |
428 /** | |
429 * Registers a function that will be called when a plugin is loaded. | |
430 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
431 * @param func The callback function. |
5205 | 432 * @param data Data to pass to the callback. |
433 */ | |
434 void gaim_plugins_register_load_notify_cb(void (*func)(GaimPlugin *, void *), | |
435 void *data); | |
436 | |
437 /** | |
438 * Unregisters a function that would be called when a plugin is loaded. | |
439 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
440 * @param func The callback function. |
5205 | 441 */ |
442 void gaim_plugins_unregister_load_notify_cb(void (*func)(GaimPlugin *, void *)); | |
443 | |
444 /** | |
445 * Registers a function that will be called when a plugin is unloaded. | |
446 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
447 * @param func The callback function. |
5205 | 448 * @param data Data to pass to the callback. |
449 */ | |
450 void gaim_plugins_register_unload_notify_cb(void (*func)(GaimPlugin *, void *), | |
451 void *data); | |
452 | |
453 /** | |
454 * Unregisters a function that would be called when a plugin is unloaded. | |
455 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
456 * @param func The callback function. |
5205 | 457 */ |
458 void gaim_plugins_unregister_unload_notify_cb(void (*func)(GaimPlugin *, | |
459 void *)); | |
460 | |
461 /** | |
462 * Finds a plugin with the specified name. | |
463 * | |
464 * @param name The plugin name. | |
465 * | |
466 * @return The plugin if found, or @c NULL if not found. | |
467 */ | |
468 GaimPlugin *gaim_plugins_find_with_name(const char *name); | |
469 | |
470 /** | |
7034
f7ff0dfa6b9f
[gaim-migrate @ 7597]
Christian Hammond <chipx86@chipx86.com>
parents:
7033
diff
changeset
|
471 * Finds a plugin with the specified filename (filename with a path). |
5205 | 472 * |
473 * @param filename The plugin filename. | |
474 * | |
475 * @return The plugin if found, or @c NULL if not found. | |
476 */ | |
477 GaimPlugin *gaim_plugins_find_with_filename(const char *filename); | |
478 | |
479 /** | |
7034
f7ff0dfa6b9f
[gaim-migrate @ 7597]
Christian Hammond <chipx86@chipx86.com>
parents:
7033
diff
changeset
|
480 * Finds a plugin with the specified basename (filename without a path). |
7033
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
481 * |
7034
f7ff0dfa6b9f
[gaim-migrate @ 7597]
Christian Hammond <chipx86@chipx86.com>
parents:
7033
diff
changeset
|
482 * @param basename The plugin basename. |
7033
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
483 * |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
484 * @return The plugin if found, or @c NULL if not found. |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
485 */ |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
486 GaimPlugin *gaim_plugins_find_with_basename(const char *basename); |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
487 |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
488 /** |
5205 | 489 * Finds a plugin with the specified plugin ID. |
490 * | |
491 * @param id The plugin ID. | |
492 * | |
493 * @return The plugin if found, or @c NULL if not found. | |
494 */ | |
495 GaimPlugin *gaim_plugins_find_with_id(const char *id); | |
496 | |
497 /** | |
498 * Returns a list of all loaded plugins. | |
499 * | |
5573
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
500 * @return A list of all loaded plugins. |
5205 | 501 */ |
502 GList *gaim_plugins_get_loaded(void); | |
503 | |
504 /** | |
5573
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
505 * Returns a list of all protocol plugins. |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
506 * |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
507 * @return A list of all protocol plugins. |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
508 */ |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
509 GList *gaim_plugins_get_protocols(void); |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
510 |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
511 /** |
5205 | 512 * Returns a list of all plugins, whether loaded or not. |
513 * | |
514 * @return A list of all plugins. | |
515 */ | |
516 GList *gaim_plugins_get_all(void); | |
517 | |
518 /*@}*/ | |
519 | |
9015 | 520 |
521 /** | |
522 * Allocates and returns a new GaimPluginAction. | |
523 */ | |
524 GaimPluginAction *gaim_plugin_action_new(char* label, void (*callback)(GaimPluginAction *)); | |
525 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
526 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
527 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
528 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
529 |
5205 | 530 #endif /* _GAIM_PLUGIN_H_ */ |