Mercurial > pidgin.yaz
annotate src/plugin.h @ 5411:2c4188300aba
[gaim-migrate @ 5787]
This fixes an i18n thing, I think.
I changed some stuff in oscar.c to use _() instead of calling gettext
directly. That's ok, right? I like the macro better.
I also fixed a compile warning or two. If that function declaration
isn't supposed to be there, feel free to move it, or remove it, or
lemme know and I'll do it.
Viva 0.63!
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sat, 17 May 2003 05:41:18 +0000 |
parents | fd81a00480ac |
children | 9442e8d0b21d |
rev | line source |
---|---|
5205 | 1 /** |
2 * @file plugin.h Plugin API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Copyright (C) 2003 Christian Hammond <chipx86@gnupdate.org> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 #ifndef _GAIM_PLUGIN_H_ | |
24 #define _GAIM_PLUGIN_H_ | |
5224
5160333a80df
[gaim-migrate @ 5594]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5205
diff
changeset
|
25 #include <gmodule.h> |
5205 | 26 |
27 typedef enum _GaimPluginType GaimPluginType; /**< GaimPluginType */ | |
28 typedef struct _GaimPlugin GaimPlugin; /**< GaimPlugin */ | |
29 typedef struct _GaimPluginInfo GaimPluginInfo; /**< GaimPluginInfo */ | |
30 typedef struct _GaimPluginLoaderInfo GaimPluginLoaderInfo; | |
31 | |
32 typedef int GaimPluginPriority; /**< Plugin priority. */ | |
33 | |
34 /* XXX */ | |
35 #include "config.h" | |
36 #include "event.h" | |
37 | |
38 /** | |
39 * Plugin types. | |
40 */ | |
41 enum _GaimPluginType | |
42 { | |
43 GAIM_PLUGIN_UNKNOWN = -1, /**< Unknown type. */ | |
44 GAIM_PLUGIN_STANDARD = 0, /**< Standard plugin. */ | |
45 GAIM_PLUGIN_LOADER, /**< Loader plugin. */ | |
46 GAIM_PLUGIN_PROTOCOL /**< Protocol plugin. */ | |
47 }; | |
48 | |
49 #define GAIM_PRIORITY_DEFAULT 0 | |
50 #define GAIM_PRIORITY_HIGHEST 9999 | |
51 #define GAIM_PRIORITY_LOWEST -9999 | |
52 | |
53 #define GAIM_PLUGIN_ID_UNSET { 0, 0, 0, 0 } | |
54 | |
55 /** | |
56 * Detailed information about a plugin. | |
57 * | |
58 * This is used in the version 2.0 API and up. | |
59 */ | |
60 struct _GaimPluginInfo | |
61 { | |
62 unsigned int api_version; | |
63 GaimPluginType type; | |
64 char *ui_requirement; | |
65 unsigned long flags; | |
66 GList *dependencies; | |
67 GaimPluginPriority priority; | |
68 | |
69 char *id; | |
70 char *name; | |
71 char *version; | |
72 char *summary; | |
73 char *description; | |
74 char *author; | |
75 char *homepage; | |
76 | |
77 gboolean (*load)(GaimPlugin *plugin); | |
78 gboolean (*unload)(GaimPlugin *plugin); | |
79 void (*destroy)(GaimPlugin *plugin); | |
80 | |
81 void *ui_info; | |
82 void *extra_info; | |
83 }; | |
84 | |
85 /** | |
86 * Extra information for loader plugins. | |
87 */ | |
88 struct _GaimPluginLoaderInfo | |
89 { | |
90 GList *exts; | |
91 | |
92 gboolean (*probe)(GaimPlugin *plugin); | |
93 gboolean (*load)(GaimPlugin *plugin); | |
94 gboolean (*unload)(GaimPlugin *plugin); | |
95 void (*destroy)(GaimPlugin *plugin); | |
96 | |
97 GaimSignalBroadcastFunc broadcast; | |
98 }; | |
99 | |
100 /** | |
101 * A plugin handle. | |
102 */ | |
103 struct _GaimPlugin | |
104 { | |
105 gboolean native_plugin; /**< Native C plugin. */ | |
106 gboolean loaded; /**< The loaded state. */ | |
107 void *handle; /**< The module handle. */ | |
108 char *path; /**< The path to the plugin. */ | |
109 GaimPluginInfo *info; /**< The plugin information. */ | |
110 char *error; | |
111 void *extra; /**< Plugin-specific data. */ | |
112 }; | |
113 | |
114 #define GAIM_PLUGIN_LOADER_INFO(plugin) \ | |
115 ((GaimPluginLoaderInfo *)(plugin)->info->extra_info) | |
116 | |
117 /** | |
118 * Handles the initialization of modules. | |
119 */ | |
120 #ifdef STATIC_MODULE | |
121 # define GAIM_INIT_PLUGIN(pluginname, initfunc, plugininfo) \ | |
122 gboolean gaim_init_##pluginname##_plugin(void) { \ | |
123 GaimPlugin *plugin = gaim_plugin_new(TRUE, NULL); \ | |
124 plugin->info = &(plugininfo); \ | |
125 initfunc((plugin)); \ | |
126 return gaim_plugin_register(plugin); \ | |
127 } | |
128 #else /* if !STATIC_MODULE */ | |
129 # define GAIM_INIT_PLUGIN(pluginname, initfunc, plugininfo) \ | |
5224
5160333a80df
[gaim-migrate @ 5594]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
5205
diff
changeset
|
130 G_MODULE_EXPORT gboolean gaim_init_plugin(GaimPlugin *plugin) { \ |
5205 | 131 plugin->info = &(plugininfo); \ |
132 initfunc((plugin)); \ | |
133 return gaim_plugin_register(plugin); \ | |
134 } | |
135 #endif | |
136 | |
137 /**************************************************************************/ | |
138 /** @name Plugin namespace */ | |
139 /**************************************************************************/ | |
140 /*@{*/ | |
141 | |
142 /** | |
143 * Creates a new plugin structure. | |
144 * | |
145 * @param native Whether or not the plugin is native. | |
146 * @param path The path to the plugin, or @c NULL if statically compiled. | |
147 * | |
148 * @return A new GaimPlugin structure. | |
149 */ | |
150 GaimPlugin *gaim_plugin_new(gboolean native, const char *path); | |
151 | |
152 /** | |
153 * Probes a plugin, retrieving the information on it and adding it to the | |
154 * list of available plugins. | |
155 * | |
156 * @param filename The plugin's filename. | |
157 * | |
158 * @return The plugin handle. | |
159 * | |
160 * @see gaim_plugin_load() | |
161 * @see gaim_plugin_destroy() | |
162 */ | |
163 GaimPlugin *gaim_plugin_probe(const char *filename); | |
164 | |
165 /** | |
166 * Registers a plugin and prepares it for loading. | |
167 * | |
168 * This shouldn't be called by anything but the internal module code. | |
169 * | |
170 * @param plugin The plugin to register. | |
171 */ | |
172 gboolean gaim_plugin_register(GaimPlugin *plugin); | |
173 | |
174 /** | |
175 * Attempts to load a previously probed plugin. | |
176 * | |
177 * @param filename The plugin's filename. | |
178 * | |
179 * @return @c TRUE if successful, or @c FALSE otherwise. | |
180 * | |
181 * @see gaim_plugin_reload() | |
182 * @see gaim_plugin_unload() | |
183 */ | |
184 gboolean gaim_plugin_load(GaimPlugin *plugin); | |
185 | |
186 /** | |
187 * Unloads the specified plugin. | |
188 * | |
189 * @param plugin The plugin handle. | |
190 * | |
191 * @return @c TRUE if successful, or @c FALSE otherwise. | |
192 * | |
193 * @see gaim_plugin_load() | |
194 * @see gaim_plugin_reload() | |
195 */ | |
196 gboolean gaim_plugin_unload(GaimPlugin *plugin); | |
197 | |
198 /** | |
199 * Reloads a plugin. | |
200 * | |
201 * @param plugin The old plugin handle. | |
202 * | |
203 * @return @c TRUE if successful, or @c FALSE otherwise. | |
204 * | |
205 * @see gaim_plugin_load() | |
206 * @see gaim_plugin_unload() | |
207 */ | |
208 gboolean gaim_plugin_reload(GaimPlugin *plugin); | |
209 | |
210 /** | |
211 * Unloads a plugin and destroys the structure from memory. | |
212 * | |
213 * @param plugin The plugin handle. | |
214 */ | |
215 void gaim_plugin_destroy(GaimPlugin *plugin); | |
216 | |
217 /** | |
218 * Returns whether or not a plugin is currently loaded. | |
219 * | |
220 * @param plugin The plugin. | |
221 * | |
222 * @return TRUE if loaded, or FALSE otherwise. | |
223 */ | |
224 gboolean gaim_plugin_is_loaded(const GaimPlugin *plugin); | |
225 | |
226 /*@}*/ | |
227 | |
228 /**************************************************************************/ | |
229 /** @name Plugins namespace */ | |
230 /**************************************************************************/ | |
231 /*@{*/ | |
232 | |
233 /** | |
234 * Sets the search paths for plugins. | |
235 * | |
236 * @param count The number of search paths. | |
237 * @param paths The search paths. | |
238 */ | |
239 void gaim_plugins_set_search_paths(size_t count, char **paths); | |
240 | |
241 /** | |
5242
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
242 * Unloads all loaded plugins. |
5205 | 243 */ |
244 void gaim_plugins_unload_all(void); | |
245 | |
5242
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
246 |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
247 /** |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
248 * Destroys all registered plugins. |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
249 */ |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
250 void gaim_plugins_destroy_all(void); |
fd81a00480ac
[gaim-migrate @ 5613]
Christian Hammond <chipx86@chipx86.com>
parents:
5224
diff
changeset
|
251 |
5205 | 252 /** |
253 * Probes for plugins in the registered module paths. | |
254 * | |
255 * @param ext The extension type to probe for, or @c NULL for all. | |
256 * | |
257 * @see gaim_plugin_set_probe_path() | |
258 */ | |
259 void gaim_plugins_probe(const char *ext); | |
260 | |
261 /** | |
262 * Returns whether or not plugin support is enabled. | |
263 * | |
264 * @return TRUE if plugin support is enabled, or FALSE otherwise. | |
265 */ | |
266 gboolean gaim_plugins_enabled(void); | |
267 | |
268 /** | |
269 * Registers a function that will be called when probing is finished. | |
270 * | |
271 * @param func The callback function. | |
272 * @param data Data to pass to the callback. | |
273 */ | |
274 void gaim_plugins_register_probe_notify_cb(void (*func)(void *), void *data); | |
275 | |
276 /** | |
277 * Unregisters a function that would be called when probing is finished. | |
278 * | |
279 * @param func The callback function. | |
280 */ | |
281 void gaim_plugins_unregister_probe_notify_cb(void (*func)(void *)); | |
282 | |
283 /** | |
284 * Registers a function that will be called when a plugin is loaded. | |
285 * | |
286 * @param func The callback functino. | |
287 * @param data Data to pass to the callback. | |
288 */ | |
289 void gaim_plugins_register_load_notify_cb(void (*func)(GaimPlugin *, void *), | |
290 void *data); | |
291 | |
292 /** | |
293 * Unregisters a function that would be called when a plugin is loaded. | |
294 * | |
295 * @param func The callback functino. | |
296 */ | |
297 void gaim_plugins_unregister_load_notify_cb(void (*func)(GaimPlugin *, void *)); | |
298 | |
299 /** | |
300 * Registers a function that will be called when a plugin is unloaded. | |
301 * | |
302 * @param func The callback functino. | |
303 * @param data Data to pass to the callback. | |
304 */ | |
305 void gaim_plugins_register_unload_notify_cb(void (*func)(GaimPlugin *, void *), | |
306 void *data); | |
307 | |
308 /** | |
309 * Unregisters a function that would be called when a plugin is unloaded. | |
310 * | |
311 * @param func The callback functino. | |
312 */ | |
313 void gaim_plugins_unregister_unload_notify_cb(void (*func)(GaimPlugin *, | |
314 void *)); | |
315 | |
316 /** | |
317 * Finds a plugin with the specified name. | |
318 * | |
319 * @param name The plugin name. | |
320 * | |
321 * @return The plugin if found, or @c NULL if not found. | |
322 */ | |
323 GaimPlugin *gaim_plugins_find_with_name(const char *name); | |
324 | |
325 /** | |
326 * Finds a plugin with the specified filename. | |
327 * | |
328 * @param filename The plugin filename. | |
329 * | |
330 * @return The plugin if found, or @c NULL if not found. | |
331 */ | |
332 GaimPlugin *gaim_plugins_find_with_filename(const char *filename); | |
333 | |
334 /** | |
335 * Finds a plugin with the specified plugin ID. | |
336 * | |
337 * @param id The plugin ID. | |
338 * | |
339 * @return The plugin if found, or @c NULL if not found. | |
340 */ | |
341 GaimPlugin *gaim_plugins_find_with_id(const char *id); | |
342 | |
343 /** | |
344 * Returns a list of all loaded plugins. | |
345 * | |
346 * @return A list of all plugins. | |
347 */ | |
348 GList *gaim_plugins_get_loaded(void); | |
349 | |
350 /** | |
351 * Returns a list of all plugins, whether loaded or not. | |
352 * | |
353 * @return A list of all plugins. | |
354 */ | |
355 GList *gaim_plugins_get_all(void); | |
356 | |
357 /*@}*/ | |
358 | |
359 #endif /* _GAIM_PLUGIN_H_ */ |