plugin.h
Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028 #ifndef _HERAIA_PLUGIN_H_
00029 #define _HERAIA_PLUGIN_H_
00030
00031
00032
00033
00034
00035
00036
00037
00038 #define HERAIA_PLUGIN_API_VERSION 1
00039
00040
00041
00042
00043 typedef enum
00044 {
00045 HERAIA_PLUGIN_UNKNOWN = -1,
00046 HERAIA_PLUGIN_FILTER = 0,
00047 HERAIA_PLUGIN_ACTION = 1,
00048 } PluginType;
00049
00050
00051
00052
00053
00054 typedef enum
00055 {
00056 PLUGIN_STATE_RUNNING,
00057 PLUGIN_STATE_INITIALIZING,
00058 PLUGIN_STATE_LOADED,
00059 PLUGIN_STATE_NEW,
00060 PLUGIN_STATE_EXITING,
00061 PLUGIN_STATE_NONE,
00062 } PluginState;
00063
00064
00065
00066 typedef void (* InitProc) (heraia_struct_t *);
00067 typedef void (* QuitProc) (void);
00068 typedef void (* RunProc) (GtkWidget *, gpointer);
00069 typedef void (* RefreshProc) (heraia_struct_t *, void *);
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086 typedef int PluginPriority;
00087 #define HERAIA_PRIORITY_DEFAULT 0
00088 #define HERAIA_PRIORITY_HIGHEST 9999
00089 #define HERAIA_PRIORITY_LOWEST -9999
00090
00091
00092
00093
00094
00095
00096 typedef gboolean (* ImportFunction) (const gchar *filename, void *user_data);
00097
00098
00099
00100 typedef gboolean (* ExportFunction) (const gchar *filename, void *user_data);
00101
00102
00103
00104
00105
00106
00107 typedef struct
00108 {
00109 char *extensions;
00110
00111 ImportFunction import;
00112 ExportFunction export;
00113 } plugin_filter_t;
00114
00115
00116
00117
00118
00119
00120 typedef struct
00121 {
00122 unsigned int api_version;
00123 PluginType type;
00124 PluginPriority priority;
00125 unsigned int id;
00126
00127 char *name;
00128 char *version;
00129 char *summary;
00130 char *description;
00131 char *author;
00132 char *homepage;
00133
00134 } plugin_info_t;
00135
00136
00137
00138
00139
00140
00141 typedef struct
00142 {
00143 PluginState state;
00144 GModule *handle;
00145 char *path;
00146 char *filename;
00147 plugin_info_t *info;
00148 plugin_filter_t *filter;
00149 char *error;
00150 void *extra;
00151
00152 InitProc init_proc;
00153 QuitProc quit_proc;
00154 RunProc run_proc;
00155 RefreshProc refresh_proc;
00156
00157 GtkCheckMenuItem *cmi_entry;
00158 GtkBuilder *xml;
00159 window_prop_t *win_prop;
00160 } heraia_plugin_t;
00161
00162
00163
00164
00165
00166 extern gboolean plugin_capable(void);
00167 extern heraia_plugin_t *new_plugin(void);
00168 extern void free_plugin(heraia_plugin_t *plugin);
00169 extern void load_plugins(heraia_struct_t *main_struct);
00170 extern void add_entry_to_plugins_menu(heraia_struct_t *main_struct, heraia_plugin_t *plugin);
00171 extern heraia_plugin_t *find_plugin_by_name(GList *plugins_list, gchar *name);
00172 extern gboolean load_plugin_xml(heraia_struct_t *main_struct, heraia_plugin_t *plugin);
00173 extern void refresh_all_plugins(heraia_struct_t *main_struct);
00174
00175 #endif