Mercurial > pidgin.yaz
annotate src/plugin.h @ 12974:7080dfef2077
[gaim-migrate @ 15327]
He wrote the original man page, and designed one of the older prefs pages,
or something.
committer: Tailor Script <tailor@pidgin.im>
author | Stu Tomlinson <stu@nosnilmot.com> |
---|---|
date | Sat, 21 Jan 2006 01:48:52 +0000 |
parents | 2c4f20ff387c |
children | 4e9935a539db |
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 | |
11963 | 88 /** |
89 * If a plugin defines a 'load' function, and it returns FALSE, | |
90 * then the plugin will not be loaded. | |
10450 | 91 */ |
5205 | 92 gboolean (*load)(GaimPlugin *plugin); |
93 gboolean (*unload)(GaimPlugin *plugin); | |
94 void (*destroy)(GaimPlugin *plugin); | |
95 | |
11817
1bb0efbd4394
[gaim-migrate @ 14108]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11772
diff
changeset
|
96 void *ui_info; /**< Used only by UI-specific plugins to build a preference screen with a custom UI */ |
5205 | 97 void *extra_info; |
11817
1bb0efbd4394
[gaim-migrate @ 14108]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11772
diff
changeset
|
98 GaimPluginUiInfo *prefs_info; /**< Used by any plugin to display preferences. If #ui_info has been specified, this will be ignored. */ |
9015 | 99 GList *(*actions)(GaimPlugin *plugin, gpointer context); |
5205 | 100 }; |
101 | |
102 /** | |
103 * Extra information for loader plugins. | |
104 */ | |
105 struct _GaimPluginLoaderInfo | |
106 { | |
107 GList *exts; | |
108 | |
109 gboolean (*probe)(GaimPlugin *plugin); | |
110 gboolean (*load)(GaimPlugin *plugin); | |
111 gboolean (*unload)(GaimPlugin *plugin); | |
112 void (*destroy)(GaimPlugin *plugin); | |
113 }; | |
114 | |
115 /** | |
116 * A plugin handle. | |
117 */ | |
118 struct _GaimPlugin | |
119 { | |
120 gboolean native_plugin; /**< Native C plugin. */ | |
121 gboolean loaded; /**< The loaded state. */ | |
122 void *handle; /**< The module handle. */ | |
123 char *path; /**< The path to the plugin. */ | |
124 GaimPluginInfo *info; /**< The plugin information. */ | |
125 char *error; | |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
126 void *ipc_data; /**< IPC data. */ |
5205 | 127 void *extra; /**< Plugin-specific data. */ |
12695
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
128 gboolean unloadable; /**< Unloadable */ |
12926
2c4f20ff387c
[gaim-migrate @ 15279]
Richard Laager <rlaager@wiktel.com>
parents:
12695
diff
changeset
|
129 GList *dependent_plugins; /**< Plugins depending on this */ |
5205 | 130 }; |
131 | |
132 #define GAIM_PLUGIN_LOADER_INFO(plugin) \ | |
133 ((GaimPluginLoaderInfo *)(plugin)->info->extra_info) | |
134 | |
8713 | 135 struct _GaimPluginUiInfo { |
136 GaimPluginPrefFrame *(*get_plugin_pref_frame)(GaimPlugin *plugin); | |
137 | |
10759 | 138 int page_num; /**< Reserved */ |
8814 | 139 GaimPluginPrefFrame *frame; /**< Reserved */ |
8713 | 140 }; |
141 | |
142 #define GAIM_PLUGIN_HAS_PREF_FRAME(plugin) \ | |
143 ((plugin)->info != NULL && (plugin)->info->prefs_info != NULL) | |
144 | |
145 #define GAIM_PLUGIN_UI_INFO(plugin) \ | |
146 ((GaimPluginUiInfo*)(plugin)->info->prefs_info) | |
147 | |
9015 | 148 |
149 /** | |
150 * The structure used in the actions member of GaimPluginInfo | |
151 */ | |
152 struct _GaimPluginAction { | |
153 char *label; | |
154 void (*callback)(GaimPluginAction *); | |
155 | |
156 /** set to the owning plugin */ | |
157 GaimPlugin *plugin; | |
158 | |
159 /** NULL for plugin actions menu, set to the GaimConnection for | |
160 account actions menu */ | |
161 gpointer context; | |
162 }; | |
163 | |
164 #define GAIM_PLUGIN_HAS_ACTIONS(plugin) \ | |
165 ((plugin)->info != NULL && (plugin)->info->actions != NULL) | |
166 | |
167 #define GAIM_PLUGIN_ACTIONS(plugin, context) \ | |
168 (GAIM_PLUGIN_HAS_ACTIONS(plugin)? \ | |
169 (plugin)->info->actions(plugin, context): NULL) | |
170 | |
171 | |
5205 | 172 /** |
173 * Handles the initialization of modules. | |
174 */ | |
8082 | 175 #if !defined(GAIM_PLUGINS) || defined(GAIM_STATIC_PRPL) |
5205 | 176 # define GAIM_INIT_PLUGIN(pluginname, initfunc, plugininfo) \ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12066
diff
changeset
|
177 gboolean gaim_init_##pluginname##_plugin(void);\ |
5205 | 178 gboolean gaim_init_##pluginname##_plugin(void) { \ |
179 GaimPlugin *plugin = gaim_plugin_new(TRUE, NULL); \ | |
180 plugin->info = &(plugininfo); \ | |
181 initfunc((plugin)); \ | |
182 return gaim_plugin_register(plugin); \ | |
183 } | |
8082 | 184 #else /* GAIM_PLUGINS && !GAIM_STATIC_PRPL */ |
5205 | 185 # define GAIM_INIT_PLUGIN(pluginname, initfunc, plugininfo) \ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12066
diff
changeset
|
186 G_MODULE_EXPORT gboolean gaim_init_plugin(GaimPlugin *plugin); \ |
5224
5160333a80df
[gaim-migrate @ 5594]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5205
diff
changeset
|
187 G_MODULE_EXPORT gboolean gaim_init_plugin(GaimPlugin *plugin) { \ |
5205 | 188 plugin->info = &(plugininfo); \ |
189 initfunc((plugin)); \ | |
190 return gaim_plugin_register(plugin); \ | |
191 } | |
192 #endif | |
193 | |
9015 | 194 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
195 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
196 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
197 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
198 |
5205 | 199 /**************************************************************************/ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
200 /** @name Plugin API */ |
5205 | 201 /**************************************************************************/ |
202 /*@{*/ | |
203 | |
204 /** | |
205 * Creates a new plugin structure. | |
206 * | |
207 * @param native Whether or not the plugin is native. | |
208 * @param path The path to the plugin, or @c NULL if statically compiled. | |
209 * | |
210 * @return A new GaimPlugin structure. | |
211 */ | |
212 GaimPlugin *gaim_plugin_new(gboolean native, const char *path); | |
213 | |
214 /** | |
215 * Probes a plugin, retrieving the information on it and adding it to the | |
216 * list of available plugins. | |
217 * | |
218 * @param filename The plugin's filename. | |
219 * | |
220 * @return The plugin handle. | |
221 * | |
222 * @see gaim_plugin_load() | |
223 * @see gaim_plugin_destroy() | |
224 */ | |
225 GaimPlugin *gaim_plugin_probe(const char *filename); | |
226 | |
227 /** | |
228 * Registers a plugin and prepares it for loading. | |
229 * | |
230 * This shouldn't be called by anything but the internal module code. | |
10447 | 231 * Plugins should use the GAIM_INIT_PLUGIN() macro to register themselves |
232 * with the core. | |
5205 | 233 * |
234 * @param plugin The plugin to register. | |
10447 | 235 * |
236 * @return @c TRUE if the plugin was registered successfully. Otherwise | |
237 * @c FALSE is returned (this happens if the plugin does not contain | |
238 * the necessary information). | |
5205 | 239 */ |
240 gboolean gaim_plugin_register(GaimPlugin *plugin); | |
241 | |
242 /** | |
243 * Attempts to load a previously probed plugin. | |
244 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6486
diff
changeset
|
245 * @param plugin The plugin to load. |
5205 | 246 * |
247 * @return @c TRUE if successful, or @c FALSE otherwise. | |
248 * | |
249 * @see gaim_plugin_reload() | |
250 * @see gaim_plugin_unload() | |
251 */ | |
252 gboolean gaim_plugin_load(GaimPlugin *plugin); | |
253 | |
254 /** | |
255 * Unloads the specified plugin. | |
256 * | |
257 * @param plugin The plugin handle. | |
258 * | |
259 * @return @c TRUE if successful, or @c FALSE otherwise. | |
260 * | |
261 * @see gaim_plugin_load() | |
262 * @see gaim_plugin_reload() | |
263 */ | |
264 gboolean gaim_plugin_unload(GaimPlugin *plugin); | |
265 | |
266 /** | |
267 * Reloads a plugin. | |
268 * | |
269 * @param plugin The old plugin handle. | |
6486
fab81e4b885c
[gaim-migrate @ 7000]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
270 * |
5205 | 271 * @return @c TRUE if successful, or @c FALSE otherwise. |
272 * | |
273 * @see gaim_plugin_load() | |
274 * @see gaim_plugin_unload() | |
275 */ | |
276 gboolean gaim_plugin_reload(GaimPlugin *plugin); | |
277 | |
278 /** | |
279 * Unloads a plugin and destroys the structure from memory. | |
280 * | |
281 * @param plugin The plugin handle. | |
282 */ | |
283 void gaim_plugin_destroy(GaimPlugin *plugin); | |
284 | |
285 /** | |
286 * Returns whether or not a plugin is currently loaded. | |
287 * | |
288 * @param plugin The plugin. | |
289 * | |
12695
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
290 * @return @c TRUE if loaded, or @c FALSE otherwise. |
5205 | 291 */ |
292 gboolean gaim_plugin_is_loaded(const GaimPlugin *plugin); | |
293 | |
11772
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
294 /** |
12695
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
295 * Returns whether or not a plugin is unloadable. |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
296 * |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
297 * If this returns @c TRUE, the plugin is guaranteed to not |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
298 * be loadable. However, a return value of @c FALSE does not |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
299 * guarantee the plugin is loadable. |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
300 * |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
301 * @param plugin The plugin. |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
302 * |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
303 * @return @c TRUE if the plugin is known to be unloadable,\ |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
304 * @c FALSE otherwise |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
305 */ |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
306 gboolean gaim_plugin_is_unloadable(const GaimPlugin *plugin); |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
307 |
0bc110c7ab91
[gaim-migrate @ 15038]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
308 /** |
11772
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
309 * Returns a plugin's id. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
310 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
311 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
312 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
313 * @return The plugin's id. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
314 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
315 const gchar *gaim_plugin_get_id(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
316 |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
317 /** |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
318 * Returns a plugin's name. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
319 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
320 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
321 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
322 * @return THe name of the plugin, or @c NULL. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
323 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
324 const gchar *gaim_plugin_get_name(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
325 |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
326 /** |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
327 * Returns a plugin's version. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
328 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
329 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
330 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
331 * @return The plugin's version or @c NULL. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
332 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
333 const gchar *gaim_plugin_get_version(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
334 |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
335 /** |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
336 * Returns a plugin's summary. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
337 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
338 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
339 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
340 * @return The plugin's summary. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
341 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
342 const gchar *gaim_plugin_get_summary(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
343 |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
344 /** |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
345 * Returns a plugin's description. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
346 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
347 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
348 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
349 * @return The plugin's description. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
350 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
351 const gchar *gaim_plugin_get_description(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
352 |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
353 /** |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
354 * Returns a plugin's author. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
355 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
356 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
357 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
358 * @return The plugin's author. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
359 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
360 const gchar *gaim_plugin_get_author(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
361 |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
362 /** |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
363 * Returns a plugin's homepage. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
364 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
365 * @param plugin The plugin. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
366 * |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
367 * @return The plugin's homepage. |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
368 */ |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
369 const gchar *gaim_plugin_get_homepage(const GaimPlugin *plugin); |
d1d5f27de95d
[gaim-migrate @ 14063]
Gary Kramlich <grim@reaperworld.com>
parents:
10759
diff
changeset
|
370 |
5205 | 371 /*@}*/ |
372 | |
373 /**************************************************************************/ | |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
374 /** @name Plugin IPC API */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
375 /**************************************************************************/ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
376 /*@{*/ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
377 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
378 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
379 * Registers an IPC command in a plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
380 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
381 * @param plugin The plugin to register the command with. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
382 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
383 * @param func The function to execute. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
384 * @param marshal The marshalling function. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
385 * @param ret_value The return value type. |
7114
c47633e9e2a4
[gaim-migrate @ 7681]
Christian Hammond <chipx86@chipx86.com>
parents:
7034
diff
changeset
|
386 * @param num_params The number of parameters. |
6822
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
387 * @param ... The parameter types. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
388 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
389 * @return TRUE if the function was registered successfully, or |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
390 * FALSE otherwise. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
391 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
392 gboolean gaim_plugin_ipc_register(GaimPlugin *plugin, const char *command, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
393 GaimCallback func, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
394 GaimSignalMarshalFunc marshal, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
395 GaimValue *ret_value, int num_params, ...); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
396 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
397 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
398 * Unregisters an IPC command in a plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
399 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
400 * @param plugin The plugin to unregister the command from. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
401 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
402 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
403 void gaim_plugin_ipc_unregister(GaimPlugin *plugin, const char *command); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
404 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
405 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
406 * Unregisters all IPC commands in a plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
407 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
408 * @param plugin The plugin to unregister the commands from. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
409 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
410 void gaim_plugin_ipc_unregister_all(GaimPlugin *plugin); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
411 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
412 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
413 * Returns a list of value types used for an IPC command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
414 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
415 * @param plugin The plugin. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
416 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
417 * @param ret_value The returned return value. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
418 * @param num_params The returned number of parameters. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
419 * @param params The returned list of parameters. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
420 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
421 * @return TRUE if the command was found, or FALSE otherwise. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
422 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
423 gboolean gaim_plugin_ipc_get_params(GaimPlugin *plugin, const char *command, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
424 GaimValue **ret_value, int *num_params, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
425 GaimValue ***params); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
426 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
427 /** |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
428 * Executes an IPC command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
429 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
430 * @param plugin The plugin to execute the command on. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
431 * @param command The name of the command. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
432 * @param ok TRUE if the call was successful, or FALSE otherwise. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
433 * @param ... The parameters to pass. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
434 * |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
435 * @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
|
436 * return a value. |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
437 */ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
438 void *gaim_plugin_ipc_call(GaimPlugin *plugin, const char *command, |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
439 gboolean *ok, ...); |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
440 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
441 /*@}*/ |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
442 |
7dba3e17cb21
[gaim-migrate @ 7366]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
443 /**************************************************************************/ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
444 /** @name Plugins API */ |
5205 | 445 /**************************************************************************/ |
446 /*@{*/ | |
447 | |
448 /** | |
10447 | 449 * Add a new directory to search for plugins |
5205 | 450 * |
10448 | 451 * @param path The new search path. |
5205 | 452 */ |
10447 | 453 void gaim_plugins_add_search_path(const char *path); |
5205 | 454 |
455 /** | |
5242
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
456 * Unloads all loaded plugins. |
5205 | 457 */ |
458 void gaim_plugins_unload_all(void); | |
459 | |
5242
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
460 /** |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
461 * Destroys all registered plugins. |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
462 */ |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
463 void gaim_plugins_destroy_all(void); |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
464 |
5205 | 465 /** |
5949
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
466 * Attempts to load all the plugins in the specified preference key |
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
467 * that were loaded when gaim last quit. |
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
468 * |
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
469 * @param key The preference key containing the list of plugins. |
5838 | 470 */ |
5949
90d0849abd3c
[gaim-migrate @ 6393]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
471 void gaim_plugins_load_saved(const char *key); |
5838 | 472 |
473 /** | |
5205 | 474 * Probes for plugins in the registered module paths. |
475 * | |
476 * @param ext The extension type to probe for, or @c NULL for all. | |
477 * | |
478 * @see gaim_plugin_set_probe_path() | |
479 */ | |
480 void gaim_plugins_probe(const char *ext); | |
481 | |
482 /** | |
483 * Returns whether or not plugin support is enabled. | |
484 * | |
485 * @return TRUE if plugin support is enabled, or FALSE otherwise. | |
486 */ | |
487 gboolean gaim_plugins_enabled(void); | |
488 | |
489 /** | |
490 * Registers a function that will be called when probing is finished. | |
491 * | |
492 * @param func The callback function. | |
493 * @param data Data to pass to the callback. | |
494 */ | |
495 void gaim_plugins_register_probe_notify_cb(void (*func)(void *), void *data); | |
496 | |
497 /** | |
498 * Unregisters a function that would be called when probing is finished. | |
499 * | |
500 * @param func The callback function. | |
501 */ | |
502 void gaim_plugins_unregister_probe_notify_cb(void (*func)(void *)); | |
503 | |
504 /** | |
505 * Registers a function that will be called when a plugin is loaded. | |
506 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
507 * @param func The callback function. |
5205 | 508 * @param data Data to pass to the callback. |
509 */ | |
510 void gaim_plugins_register_load_notify_cb(void (*func)(GaimPlugin *, void *), | |
511 void *data); | |
512 | |
513 /** | |
514 * Unregisters a function that would be called when a plugin is loaded. | |
515 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
516 * @param func The callback function. |
5205 | 517 */ |
518 void gaim_plugins_unregister_load_notify_cb(void (*func)(GaimPlugin *, void *)); | |
519 | |
520 /** | |
521 * Registers a function that will be called when a plugin is unloaded. | |
522 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
523 * @param func The callback function. |
5205 | 524 * @param data Data to pass to the callback. |
525 */ | |
526 void gaim_plugins_register_unload_notify_cb(void (*func)(GaimPlugin *, void *), | |
527 void *data); | |
528 | |
529 /** | |
530 * Unregisters a function that would be called when a plugin is unloaded. | |
531 * | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
532 * @param func The callback function. |
5205 | 533 */ |
534 void gaim_plugins_unregister_unload_notify_cb(void (*func)(GaimPlugin *, | |
535 void *)); | |
536 | |
537 /** | |
538 * Finds a plugin with the specified name. | |
539 * | |
540 * @param name The plugin name. | |
541 * | |
542 * @return The plugin if found, or @c NULL if not found. | |
543 */ | |
544 GaimPlugin *gaim_plugins_find_with_name(const char *name); | |
545 | |
546 /** | |
7034
f7ff0dfa6b9f
[gaim-migrate @ 7597]
Christian Hammond <chipx86@chipx86.com>
parents:
7033
diff
changeset
|
547 * Finds a plugin with the specified filename (filename with a path). |
5205 | 548 * |
549 * @param filename The plugin filename. | |
550 * | |
551 * @return The plugin if found, or @c NULL if not found. | |
552 */ | |
553 GaimPlugin *gaim_plugins_find_with_filename(const char *filename); | |
554 | |
555 /** | |
7034
f7ff0dfa6b9f
[gaim-migrate @ 7597]
Christian Hammond <chipx86@chipx86.com>
parents:
7033
diff
changeset
|
556 * 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
|
557 * |
7034
f7ff0dfa6b9f
[gaim-migrate @ 7597]
Christian Hammond <chipx86@chipx86.com>
parents:
7033
diff
changeset
|
558 * @param basename The plugin basename. |
7033
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
559 * |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
560 * @return The plugin if found, or @c NULL if not found. |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
561 */ |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
562 GaimPlugin *gaim_plugins_find_with_basename(const char *basename); |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
563 |
cf1126ba1834
[gaim-migrate @ 7596]
Christian Hammond <chipx86@chipx86.com>
parents:
6928
diff
changeset
|
564 /** |
5205 | 565 * Finds a plugin with the specified plugin ID. |
566 * | |
567 * @param id The plugin ID. | |
568 * | |
569 * @return The plugin if found, or @c NULL if not found. | |
570 */ | |
571 GaimPlugin *gaim_plugins_find_with_id(const char *id); | |
572 | |
573 /** | |
574 * Returns a list of all loaded plugins. | |
575 * | |
5573
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
576 * @return A list of all loaded plugins. |
5205 | 577 */ |
578 GList *gaim_plugins_get_loaded(void); | |
579 | |
580 /** | |
11950 | 581 * Returns a list of all valid protocol plugins. A protocol |
582 * plugin is considered invalid if it does not contain the call | |
583 * to the GAIM_INIT_PLUGIN() macro, or if it was compiled | |
584 * against an incompatable API version. | |
5573
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
585 * |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
586 * @return A list of all protocol plugins. |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
587 */ |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
588 GList *gaim_plugins_get_protocols(void); |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
589 |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5449
diff
changeset
|
590 /** |
5205 | 591 * Returns a list of all plugins, whether loaded or not. |
592 * | |
593 * @return A list of all plugins. | |
594 */ | |
595 GList *gaim_plugins_get_all(void); | |
596 | |
597 /*@}*/ | |
598 | |
10479 | 599 /**************************************************************************/ |
600 /** @name Plugins SubSytem API */ | |
601 /**************************************************************************/ | |
602 /*@{*/ | |
603 | |
604 /** | |
605 * Returns the plugin subsystem handle. | |
606 * | |
607 * @return The plugin sybsystem handle. | |
608 */ | |
609 void *gaim_plugins_get_handle(void); | |
610 | |
611 /** | |
612 * Initializes the plugin subsystem | |
613 */ | |
614 void gaim_plugins_init(void); | |
615 | |
616 /** | |
617 * Uninitializes the plugin subsystem | |
618 */ | |
619 void gaim_plugins_uninit(void); | |
620 | |
621 /*@}*/ | |
9015 | 622 |
623 /** | |
624 * Allocates and returns a new GaimPluginAction. | |
625 */ | |
626 GaimPluginAction *gaim_plugin_action_new(char* label, void (*callback)(GaimPluginAction *)); | |
627 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
628 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
629 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
630 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5840
diff
changeset
|
631 |
5205 | 632 #endif /* _GAIM_PLUGIN_H_ */ |