|
pidgin 2.14.4
|
Plugin API. More...
#include <glib.h>#include <gmodule.h>#include "signals.h"#include "value.h"#include "pluginpref.h"Go to the source code of this file.
Data Structures | |
| struct | _PurplePluginInfo |
| Detailed information about a plugin. More... | |
| struct | _PurplePluginLoaderInfo |
| Extra information for loader plugins. More... | |
| struct | _PurplePlugin |
| A plugin handle. More... | |
| struct | _PurplePluginUiInfo |
| struct | _PurplePluginAction |
| The structure used in the actions member of PurplePluginInfo. More... | |
Macros | |
| #define | PURPLE_PRIORITY_DEFAULT 0 |
| #define | PURPLE_PRIORITY_HIGHEST 9999 |
| #define | PURPLE_PRIORITY_LOWEST -9999 |
| #define | PURPLE_PLUGIN_FLAG_INVISIBLE 0x01 |
| #define | PURPLE_PLUGIN_MAGIC 5 /* once we hit 6.0.0 I think we can remove this */ |
| #define | PURPLE_PLUGIN_LOADER_INFO(plugin) ((PurplePluginLoaderInfo *)(plugin)->info->extra_info) |
| #define | PURPLE_PLUGIN_HAS_PREF_FRAME(plugin) ((plugin)->info != NULL && (plugin)->info->prefs_info != NULL) |
| #define | PURPLE_PLUGIN_UI_INFO(plugin) ((PurplePluginUiInfo*)(plugin)->info->prefs_info) |
| #define | PURPLE_PLUGIN_HAS_ACTIONS(plugin) ((plugin)->info != NULL && (plugin)->info->actions != NULL) |
| #define | PURPLE_PLUGIN_ACTIONS(plugin, context) |
| #define | _FUNC_NAME(x) purple_init_##x##_plugin |
| Handles the initialization of modules. | |
| #define | PURPLE_INIT_PLUGIN(pluginname, initfunc, plugininfo) |
Typedefs | |
| typedef struct _PurplePlugin | PurplePlugin |
| A plugin handle. | |
| typedef struct _PurplePluginInfo | PurplePluginInfo |
| Detailed information about a plugin. | |
| typedef struct _PurplePluginUiInfo | PurplePluginUiInfo |
| typedef struct _PurplePluginLoaderInfo | PurplePluginLoaderInfo |
| Extra information for loader plugins. | |
| typedef struct _PurplePluginAction | PurplePluginAction |
| The structure used in the actions member of PurplePluginInfo. | |
| typedef int | PurplePluginPriority |
| Plugin priority. | |
Enumerations | |
| enum | PurplePluginType { PURPLE_PLUGIN_UNKNOWN = -1 , PURPLE_PLUGIN_STANDARD = 0 , PURPLE_PLUGIN_LOADER , PURPLE_PLUGIN_PROTOCOL } |
| Plugin types. More... | |
Functions | |
Plugin API <br> | |
| PurplePlugin * | purple_plugin_new (gboolean native, const char *path) |
| Creates a new plugin structure. | |
| PurplePlugin * | purple_plugin_probe (const char *filename) |
| Probes a plugin, retrieving the information on it and adding it to the list of available plugins. | |
| gboolean | purple_plugin_register (PurplePlugin *plugin) |
| Registers a plugin and prepares it for loading. | |
| gboolean | purple_plugin_load (PurplePlugin *plugin) |
| Attempts to load a previously probed plugin. | |
| gboolean | purple_plugin_unload (PurplePlugin *plugin) |
| Unloads the specified plugin. | |
| void | purple_plugin_disable (PurplePlugin *plugin) |
| Disable a plugin. | |
| gboolean | purple_plugin_reload (PurplePlugin *plugin) |
| Reloads a plugin. | |
| void | purple_plugin_destroy (PurplePlugin *plugin) |
| Unloads a plugin and destroys the structure from memory. | |
| gboolean | purple_plugin_is_loaded (const PurplePlugin *plugin) |
| Returns whether or not a plugin is currently loaded. | |
| gboolean | purple_plugin_is_unloadable (const PurplePlugin *plugin) |
| Returns whether or not a plugin is unloadable. | |
| const gchar * | purple_plugin_get_id (const PurplePlugin *plugin) |
| Returns a plugin's id. | |
| const gchar * | purple_plugin_get_name (const PurplePlugin *plugin) |
| Returns a plugin's name. | |
| const gchar * | purple_plugin_get_version (const PurplePlugin *plugin) |
| Returns a plugin's version. | |
| const gchar * | purple_plugin_get_summary (const PurplePlugin *plugin) |
| Returns a plugin's summary. | |
| const gchar * | purple_plugin_get_description (const PurplePlugin *plugin) |
| Returns a plugin's description. | |
| const gchar * | purple_plugin_get_author (const PurplePlugin *plugin) |
| Returns a plugin's author. | |
| const gchar * | purple_plugin_get_homepage (const PurplePlugin *plugin) |
| Returns a plugin's homepage. | |
Plugin IPC API <br> | |
| gboolean | purple_plugin_ipc_register (PurplePlugin *plugin, const char *command, PurpleCallback func, PurpleSignalMarshalFunc marshal, PurpleValue *ret_value, int num_params,...) |
| Registers an IPC command in a plugin. | |
| void | purple_plugin_ipc_unregister (PurplePlugin *plugin, const char *command) |
| Unregisters an IPC command in a plugin. | |
| void | purple_plugin_ipc_unregister_all (PurplePlugin *plugin) |
| Unregisters all IPC commands in a plugin. | |
| gboolean | purple_plugin_ipc_get_params (PurplePlugin *plugin, const char *command, PurpleValue **ret_value, int *num_params, PurpleValue ***params) |
| Returns a list of value types used for an IPC command. | |
| void * | purple_plugin_ipc_call (PurplePlugin *plugin, const char *command, gboolean *ok,...) |
| Executes an IPC command. | |
Plugins API <br> | |
| void | purple_plugins_add_search_path (const char *path) |
| Add a new directory to search for plugins. | |
| GList * | purple_plugins_get_search_paths (void) |
| Returns a list of plugin search paths. | |
| void | purple_plugins_unload_all (void) |
| Unloads all loaded plugins. | |
| void | purple_plugins_unload (PurplePluginType type) |
| Unloads all plugins of a specific type. | |
| void | purple_plugins_destroy_all (void) |
| Destroys all registered plugins. | |
| void | purple_plugins_save_loaded (const char *key) |
| Saves the list of loaded plugins to the specified preference key. | |
| void | purple_plugins_load_saved (const char *key) |
| Attempts to load all the plugins in the specified preference key that were loaded when purple last quit. | |
| void | purple_plugins_probe (const char *ext) |
| Probes for plugins in the registered module paths. | |
| gboolean | purple_plugins_enabled (void) |
| Returns whether or not plugin support is enabled. | |
| void | purple_plugins_register_probe_notify_cb (void(*func)(void *), void *data) |
| Registers a function that will be called when probing is finished. | |
| void | purple_plugins_unregister_probe_notify_cb (void(*func)(void *)) |
| Unregisters a function that would be called when probing is finished. | |
| void | purple_plugins_register_load_notify_cb (void(*func)(PurplePlugin *, void *), void *data) |
| Registers a function that will be called when a plugin is loaded. | |
| void | purple_plugins_unregister_load_notify_cb (void(*func)(PurplePlugin *, void *)) |
| Unregisters a function that would be called when a plugin is loaded. | |
| void | purple_plugins_register_unload_notify_cb (void(*func)(PurplePlugin *, void *), void *data) |
| Registers a function that will be called when a plugin is unloaded. | |
| void | purple_plugins_unregister_unload_notify_cb (void(*func)(PurplePlugin *, void *)) |
| Unregisters a function that would be called when a plugin is unloaded. | |
| PurplePlugin * | purple_plugins_find_with_name (const char *name) |
| Finds a plugin with the specified name. | |
| PurplePlugin * | purple_plugins_find_with_filename (const char *filename) |
| Finds a plugin with the specified filename (filename with a path). | |
| PurplePlugin * | purple_plugins_find_with_basename (const char *basename) |
| Finds a plugin with the specified basename (filename without a path). | |
| PurplePlugin * | purple_plugins_find_with_id (const char *id) |
| Finds a plugin with the specified plugin ID. | |
| GList * | purple_plugins_get_loaded (void) |
| Returns a list of all loaded plugins. | |
| GList * | purple_plugins_get_protocols (void) |
| Returns a list of all valid protocol plugins. | |
| GList * | purple_plugins_get_all (void) |
| Returns a list of all plugins, whether loaded or not. | |
Plugins SubSytem API <br> | |
| void * | purple_plugins_get_handle (void) |
| Returns the plugin subsystem handle. | |
| void | purple_plugins_init (void) |
| Initializes the plugin subsystem. | |
| void | purple_plugins_uninit (void) |
| Uninitializes the plugin subsystem. | |
| PurplePluginAction * | purple_plugin_action_new (const char *label, void(*callback)(PurplePluginAction *)) |
| Allocates and returns a new PurplePluginAction. | |
| void | purple_plugin_action_free (PurplePluginAction *action) |
| Frees a PurplePluginAction. | |
Plugin API.
Definition in file plugin.h.
| #define _FUNC_NAME | ( | x | ) | purple_init_##x##_plugin |
| #define PURPLE_INIT_PLUGIN | ( | pluginname, | |
| initfunc, | |||
| plugininfo | |||
| ) |
| #define PURPLE_PLUGIN_ACTIONS | ( | plugin, | |
| context | |||
| ) |
| #define PURPLE_PLUGIN_HAS_ACTIONS | ( | plugin | ) | ((plugin)->info != NULL && (plugin)->info->actions != NULL) |
| #define PURPLE_PLUGIN_HAS_PREF_FRAME | ( | plugin | ) | ((plugin)->info != NULL && (plugin)->info->prefs_info != NULL) |
| #define PURPLE_PLUGIN_LOADER_INFO | ( | plugin | ) | ((PurplePluginLoaderInfo *)(plugin)->info->extra_info) |
| #define PURPLE_PLUGIN_MAGIC 5 /* once we hit 6.0.0 I think we can remove this */ |
| #define PURPLE_PLUGIN_UI_INFO | ( | plugin | ) | ((PurplePluginUiInfo*)(plugin)->info->prefs_info) |
| typedef struct _PurplePlugin PurplePlugin |
| typedef struct _PurplePluginAction PurplePluginAction |
| typedef struct _PurplePluginInfo PurplePluginInfo |
| typedef struct _PurplePluginLoaderInfo PurplePluginLoaderInfo |
| typedef int PurplePluginPriority |
| typedef struct _PurplePluginUiInfo PurplePluginUiInfo |
| enum PurplePluginType |
| void purple_plugin_action_free | ( | PurplePluginAction * | action | ) |
Frees a PurplePluginAction.
| action | The PurplePluginAction to free. |
| PurplePluginAction * purple_plugin_action_new | ( | const char * | label, |
| void(*)(PurplePluginAction *) | callback | ||
| ) |
Allocates and returns a new PurplePluginAction.
| label | The description of the action to show to the user. |
| callback | The callback to call when the user selects this action. |
| void purple_plugin_destroy | ( | PurplePlugin * | plugin | ) |
Unloads a plugin and destroys the structure from memory.
| plugin | The plugin handle. |
| void purple_plugin_disable | ( | PurplePlugin * | plugin | ) |
Disable a plugin.
This function adds the plugin to a list of plugins to "disable at the next startup" by excluding said plugins from the list of plugins to save. The UI needs to call purple_plugins_save_loaded() after calling this for it to have any effect.
| const gchar * purple_plugin_get_author | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's author.
| plugin | The plugin. |
| const gchar * purple_plugin_get_description | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's description.
| plugin | The plugin. |
| const gchar * purple_plugin_get_homepage | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's homepage.
| plugin | The plugin. |
| const gchar * purple_plugin_get_id | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's id.
| plugin | The plugin. |
| const gchar * purple_plugin_get_name | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's name.
| plugin | The plugin. |
NULL. | const gchar * purple_plugin_get_summary | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's summary.
| plugin | The plugin. |
| const gchar * purple_plugin_get_version | ( | const PurplePlugin * | plugin | ) |
Returns a plugin's version.
| plugin | The plugin. |
NULL. | void * purple_plugin_ipc_call | ( | PurplePlugin * | plugin, |
| const char * | command, | ||
| gboolean * | ok, | ||
| ... | |||
| ) |
Executes an IPC command.
| plugin | The plugin to execute the command on. |
| command | The name of the command. |
| ok | TRUE if the call was successful, or FALSE otherwise. |
| ... | The parameters to pass. |
| gboolean purple_plugin_ipc_get_params | ( | PurplePlugin * | plugin, |
| const char * | command, | ||
| PurpleValue ** | ret_value, | ||
| int * | num_params, | ||
| PurpleValue *** | params | ||
| ) |
Returns a list of value types used for an IPC command.
| plugin | The plugin. |
| command | The name of the command. |
| ret_value | The returned return value. |
| num_params | The returned number of parameters. |
| params | The returned list of parameters. |
| gboolean purple_plugin_ipc_register | ( | PurplePlugin * | plugin, |
| const char * | command, | ||
| PurpleCallback | func, | ||
| PurpleSignalMarshalFunc | marshal, | ||
| PurpleValue * | ret_value, | ||
| int | num_params, | ||
| ... | |||
| ) |
Registers an IPC command in a plugin.
| plugin | The plugin to register the command with. |
| command | The name of the command. |
| func | The function to execute. |
| marshal | The marshalling function. |
| ret_value | The return value type. |
| num_params | The number of parameters. |
| ... | The parameter types. |
| void purple_plugin_ipc_unregister | ( | PurplePlugin * | plugin, |
| const char * | command | ||
| ) |
Unregisters an IPC command in a plugin.
| plugin | The plugin to unregister the command from. |
| command | The name of the command. |
| void purple_plugin_ipc_unregister_all | ( | PurplePlugin * | plugin | ) |
Unregisters all IPC commands in a plugin.
| plugin | The plugin to unregister the commands from. |
| gboolean purple_plugin_is_loaded | ( | const PurplePlugin * | plugin | ) |
Returns whether or not a plugin is currently loaded.
| plugin | The plugin. |
TRUE if loaded, or FALSE otherwise. | gboolean purple_plugin_is_unloadable | ( | const PurplePlugin * | plugin | ) |
Returns whether or not a plugin is unloadable.
If this returns TRUE, the plugin is guaranteed to not be loadable. However, a return value of FALSE does not guarantee the plugin is loadable.
| plugin | The plugin. |
TRUE if the plugin is known to be unloadable,\ FALSE otherwise | gboolean purple_plugin_load | ( | PurplePlugin * | plugin | ) |
Attempts to load a previously probed plugin.
| plugin | The plugin to load. |
TRUE if successful, or FALSE otherwise.| PurplePlugin * purple_plugin_new | ( | gboolean | native, |
| const char * | path | ||
| ) |
Creates a new plugin structure.
| native | Whether or not the plugin is native. |
| path | The path to the plugin, or NULL if statically compiled. |
| PurplePlugin * purple_plugin_probe | ( | const char * | filename | ) |
Probes a plugin, retrieving the information on it and adding it to the list of available plugins.
| filename | The plugin's filename. |
| gboolean purple_plugin_register | ( | PurplePlugin * | plugin | ) |
Registers a plugin and prepares it for loading.
This shouldn't be called by anything but the internal module code. Plugins should use the PURPLE_INIT_PLUGIN() macro to register themselves with the core.
| plugin | The plugin to register. |
TRUE if the plugin was registered successfully. Otherwise FALSE is returned (this happens if the plugin does not contain the necessary information). | gboolean purple_plugin_reload | ( | PurplePlugin * | plugin | ) |
Reloads a plugin.
| plugin | The old plugin handle. |
TRUE if successful, or FALSE otherwise.| gboolean purple_plugin_unload | ( | PurplePlugin * | plugin | ) |
Unloads the specified plugin.
| plugin | The plugin handle. |
TRUE if successful, or FALSE otherwise.| void purple_plugins_add_search_path | ( | const char * | path | ) |
Add a new directory to search for plugins.
| path | The new search path. |
| gboolean purple_plugins_enabled | ( | void | ) |
Returns whether or not plugin support is enabled.
| PurplePlugin * purple_plugins_find_with_basename | ( | const char * | basename | ) |
Finds a plugin with the specified basename (filename without a path).
| basename | The plugin basename. |
NULL if not found. | PurplePlugin * purple_plugins_find_with_filename | ( | const char * | filename | ) |
Finds a plugin with the specified filename (filename with a path).
| filename | The plugin filename. |
NULL if not found. | PurplePlugin * purple_plugins_find_with_id | ( | const char * | id | ) |
Finds a plugin with the specified plugin ID.
| id | The plugin ID. |
NULL if not found. | PurplePlugin * purple_plugins_find_with_name | ( | const char * | name | ) |
Finds a plugin with the specified name.
| name | The plugin name. |
NULL if not found. | GList * purple_plugins_get_all | ( | void | ) |
Returns a list of all plugins, whether loaded or not.
| void * purple_plugins_get_handle | ( | void | ) |
Returns the plugin subsystem handle.
| GList * purple_plugins_get_loaded | ( | void | ) |
Returns a list of all loaded plugins.
| GList * purple_plugins_get_protocols | ( | void | ) |
Returns a list of all valid protocol plugins.
A protocol plugin is considered invalid if it does not contain the call to the PURPLE_INIT_PLUGIN() macro, or if it was compiled against an incompatable API version.
| GList * purple_plugins_get_search_paths | ( | void | ) |
Returns a list of plugin search paths.
| void purple_plugins_load_saved | ( | const char * | key | ) |
Attempts to load all the plugins in the specified preference key that were loaded when purple last quit.
| key | The preference key containing the list of plugins. |
| void purple_plugins_probe | ( | const char * | ext | ) |
Probes for plugins in the registered module paths.
| ext | The extension type to probe for, or NULL for all. |
| void purple_plugins_register_load_notify_cb | ( | void(*)(PurplePlugin *, void *) | func, |
| void * | data | ||
| ) |
Registers a function that will be called when a plugin is loaded.
| func | The callback function. |
| data | Data to pass to the callback. |
| void purple_plugins_register_probe_notify_cb | ( | void(*)(void *) | func, |
| void * | data | ||
| ) |
Registers a function that will be called when probing is finished.
| func | The callback function. |
| data | Data to pass to the callback. |
| void purple_plugins_register_unload_notify_cb | ( | void(*)(PurplePlugin *, void *) | func, |
| void * | data | ||
| ) |
Registers a function that will be called when a plugin is unloaded.
| func | The callback function. |
| data | Data to pass to the callback. |
| void purple_plugins_save_loaded | ( | const char * | key | ) |
Saves the list of loaded plugins to the specified preference key.
| key | The preference key to save the list of plugins to. |
| void purple_plugins_unregister_load_notify_cb | ( | void(*)(PurplePlugin *, void *) | func | ) |
Unregisters a function that would be called when a plugin is loaded.
| func | The callback function. |
| void purple_plugins_unregister_probe_notify_cb | ( | void(*)(void *) | func | ) |
Unregisters a function that would be called when probing is finished.
| func | The callback function. |
| void purple_plugins_unregister_unload_notify_cb | ( | void(*)(PurplePlugin *, void *) | func | ) |
Unregisters a function that would be called when a plugin is unloaded.
| func | The callback function. |