2 * plugindata.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2007 The Geany contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * This file defines the plugin API, the interface between Geany and its plugins.
24 * For detailed documentation of the plugin system please read the plugin
27 /* Note: Remember to increment GEANY_API_VERSION (and GEANY_ABI_VERSION if necessary)
28 * when making changes (see 'Keeping the plugin ABI stable' in the HACKING file). */
31 #ifndef GEANY_PLUGIN_DATA_H
32 #define GEANY_PLUGIN_DATA_H 1
34 #include "geany.h" /* for GEANY_DEPRECATED */
35 #include "build.h" /* GeanyBuildGroup, GeanyBuildSource, GeanyBuildCmdEntries enums */
36 #include "document.h" /* GeanyDocument */
37 #include "editor.h" /* GeanyEditor, GeanyIndentType */
38 #include "filetypes.h" /* GeanyFiletype */
40 #include "gtkcompat.h"
44 /* Compatibility for sharing macros between API and core.
45 * First include geany.h, then plugindata.h, then other API headers. */
47 #define GEANY(symbol_name) geany->symbol_name
50 /** The Application Programming Interface (API) version, incremented
51 * whenever any plugin data types are modified or appended to.
53 * You can protect code that needs a higher API than e.g. 200 with:
54 * @code #if GEANY_API_VERSION >= 200
55 * some_newer_function();
58 * @warning You should not test for values below 200 as previously
59 * @c GEANY_API_VERSION was defined as an enum value, not a macro.
61 #define GEANY_API_VERSION 244
63 /* hack to have a different ABI when built with different GTK major versions
64 * because loading plugins linked to a different one leads to crashes.
65 * Only GTK3 is currently supported. */
66 #define GEANY_ABI_SHIFT 8
67 /** The Application Binary Interface (ABI) version, incremented whenever
68 * existing fields in the plugin data types have to be changed or reordered.
69 * Changing this forces all plugins to be recompiled before Geany can load them. */
70 /* This should usually stay the same if fields are only appended, assuming only pointers to
71 * structs and not structs themselves are declared by plugins. */
72 #define GEANY_ABI_VERSION (72 << GEANY_ABI_SHIFT)
75 /** Defines a function to check the plugin is safe to load.
76 * This performs runtime checks that try to ensure:
77 * - Geany ABI data types are compatible with this plugin.
78 * - Geany sources provide the required API for this plugin.
79 * @param api_required The minimum API number your plugin requires.
80 * Look at the source for the value of @c GEANY_API_VERSION to use if you
81 * want your plugin to require the current Geany version on your machine.
82 * You should update this value when using any new API features. */
83 #define PLUGIN_VERSION_CHECK(api_required) \
84 gint plugin_version_check(gint abi_ver) \
86 if (abi_ver != GEANY_ABI_VERSION) \
88 return (api_required); \
92 /** Basic information about a plugin available to Geany without loading the plugin.
93 * The fields are set in plugin_set_info(), usually with the PLUGIN_SET_INFO() macro. */
94 typedef struct PluginInfo
96 /** The name of the plugin. */
98 /** The description of the plugin. */
99 const gchar
*description
;
100 /** The version of the plugin. */
101 const gchar
*version
;
102 /** The author of the plugin. */
108 /** Sets the plugin name and some other basic information about a plugin.
110 * @note If you want some of the arguments to be translated, see @ref PLUGIN_SET_TRANSLATABLE_INFO()
113 * @code PLUGIN_SET_INFO("Cool Feature", "Adds cool feature support.", "0.1", "Joe Author") @endcode */
114 /* plugin_set_info() could be written manually for plugins if we want to add any
115 * extra PluginInfo features (such as an icon), so we don't need to break API
116 * compatibility. Alternatively just add a new macro, PLUGIN_SET_INFO_FULL(). -ntrel */
117 #define PLUGIN_SET_INFO(p_name, p_description, p_version, p_author) \
118 void plugin_set_info(PluginInfo *info) \
120 info->name = (p_name); \
121 info->description = (p_description); \
122 info->version = (p_version); \
123 info->author = (p_author); \
126 /** Sets the plugin name and some other basic information about a plugin.
127 * This macro is like @ref PLUGIN_SET_INFO() but allows the passed information to be translated
128 * by setting up the translation mechanism with @ref main_locale_init().
129 * You therefore don't need to call it manually in plugin_init().
132 * @code PLUGIN_SET_TRANSLATABLE_INFO(LOCALEDIR, GETTEXT_PACKAGE, _("Cool Feature"), _("Adds a cool feature."), "0.1", "John Doe") @endcode
135 #define PLUGIN_SET_TRANSLATABLE_INFO(localedir, package, p_name, p_description, p_version, p_author) \
136 void plugin_set_info(PluginInfo *info) \
138 main_locale_init((localedir), (package)); \
139 info->name = (p_name); \
140 info->description = (p_description); \
141 info->version = (p_version); \
142 info->author = (p_author); \
146 /** Callback array entry type used with the @ref plugin_callbacks symbol. */
147 typedef struct PluginCallback
149 /** The name of signal, must be an existing signal. For a list of available signals,
150 * please see the @link pluginsignals.c Signal documentation @endlink. */
151 const gchar
*signal_name
;
152 /** A callback function which is called when the signal is emitted. */
154 /** Set to TRUE to connect your handler with g_signal_connect_after(). */
156 /** The user data passed to the signal handler. If set to NULL then the signal
157 * handler will receive the data set with geany_plugin_register_full() or
158 * geany_plugin_set_data() */
164 /** This contains pointers to global variables owned by Geany for plugins to use.
165 * Core variable pointers can be appended when needed by plugin authors, if appropriate. */
166 typedef struct GeanyData
168 struct GeanyApp
*app
; /**< Geany application data fields */
169 struct GeanyMainWidgets
*main_widgets
; /**< Important widgets in the main window */
170 /** Dynamic array of GeanyDocument pointers.
171 * Once a pointer is added to this, it is never freed. This means the same document pointer
172 * can represent a different document later on, or it may have been closed and become invalid.
173 * For this reason, you should use document_find_by_id() instead of storing
174 * document pointers over time if there is a chance the user can close the
177 * @warning You must check @c GeanyDocument::is_valid when iterating over this array.
178 * This is done automatically if you use the foreach_document() macro.
181 * Never assume that the order of document pointers is the same as the order of notebook tabs.
182 * One reason is that notebook tabs can be reordered.
183 * Use @c document_get_from_page() to lookup a document from a notebook tab number.
187 * @elementtype{GeanyDocument}
189 GPtrArray
*documents_array
;
190 /** Dynamic array of filetype pointers
192 * List the list is dynamically expanded for custom filetypes filetypes so don't expect
193 * the list of known filetypes to be a constant.
195 * @elementtype{GeanyFiletype}
197 GPtrArray
*filetypes_array
;
198 struct GeanyPrefs
*prefs
; /**< General settings */
199 struct GeanyInterfacePrefs
*interface_prefs
; /**< Interface settings */
200 struct GeanyToolbarPrefs
*toolbar_prefs
; /**< Toolbar settings */
201 struct GeanyEditorPrefs
*editor_prefs
; /**< Editor settings */
202 struct GeanyFilePrefs
*file_prefs
; /**< File-related settings */
203 struct GeanySearchPrefs
*search_prefs
; /**< Search-related settings */
204 struct GeanyToolPrefs
*tool_prefs
; /**< Tool settings */
205 struct GeanyTemplatePrefs
*template_prefs
; /**< Template settings */
206 gpointer
*_compat
; /* Remove field on next ABI break (abi-todo) */
207 /** List of filetype pointers sorted by name, but with @c filetypes_index(GEANY_FILETYPES_NONE)
208 * first, as this is usually treated specially.
209 * The list does not change (after filetypes have been initialized), so you can use
210 * @code g_slist_nth_data(filetypes_by_title, n) @endcode and expect the same result at different times.
211 * @see filetypes_get_sorted_by_name().
213 * @elementtype{GeanyFiletype}
215 GSList
*filetypes_by_title
;
217 * Global object signalling events via signals
219 * This is mostly for language bindings. Otherwise prefer to use
220 * plugin_signal_connect() instead this which adds automatic cleanup. */
225 #define geany geany_data /**< Simple macro for @c geany_data that reduces typing. */
227 typedef struct GeanyPluginFuncs GeanyPluginFuncs
;
228 typedef struct GeanyProxyFuncs GeanyProxyFuncs
;
230 /** Basic information for the plugin and identification.
231 * @see geany_plugin. */
232 typedef struct GeanyPlugin
234 PluginInfo
*info
; /**< Fields set in plugin_set_info(). */
235 GeanyData
*geany_data
; /**< Pointer to global GeanyData intance */
236 GeanyPluginFuncs
*funcs
; /**< Functions implemented by the plugin, set in geany_load_module() */
237 GeanyProxyFuncs
*proxy_funcs
; /**< Hooks implemented by the plugin if it wants to act as a proxy
238 Must be set prior to calling geany_plugin_register_proxy() */
239 struct GeanyPluginPrivate
*priv
; /* private */
243 #ifndef GEANY_PRIVATE
245 /* Prototypes for building plugins with -Wmissing-prototypes
246 * Also allows the compiler to check if the signature of the plugin's
247 * symbol properly matches what we expect. */
248 gint
plugin_version_check(gint abi_ver
);
249 void plugin_set_info(PluginInfo
*info
);
251 void plugin_init(GeanyData
*data
);
252 GtkWidget
*plugin_configure(GtkDialog
*dialog
);
253 void plugin_configure_single(GtkWidget
*parent
);
254 void plugin_help(void);
255 void plugin_cleanup(void);
257 /** Called by Geany when a plugin library is loaded.
259 * This is the original entry point. Implement and export this function to be loadable at all.
260 * Then fill in GeanyPlugin::info and GeanyPlugin::funcs of the passed @p plugin. Finally
261 * GEANY_PLUGIN_REGISTER() and specify a minimum supported API version.
263 * For all glory details please read @ref howto.
265 * Because the plugin is not yet enabled by the user you may not call plugin API functions inside
266 * this function, except for the API functions below which are required for proper registration.
268 * API functions which are allowed to be called within this function:
269 * - main_locale_init()
270 * - geany_plugin_register() (and GEANY_PLUGIN_REGISTER())
271 * - geany_plugin_register_full() (and GEANY_PLUGIN_REGISTER_FULL())
272 * - plugin_module_make_resident()
274 * @param plugin The unique plugin handle to your plugin. You must set some fields here.
276 * @since 1.26 (API 225)
279 void geany_load_module(GeanyPlugin
*plugin
);
283 /** Callback functions that need to be implemented for every plugin.
285 * These callbacks should be registered by the plugin within Geany's call to
286 * geany_load_module() by calling geany_plugin_register() with an instance of this type.
288 * Geany will then call the callbacks at appropriate times. Each gets passed the
289 * plugin-defined data pointer as well as the corresponding GeanyPlugin instance
292 * @since 1.26 (API 225)
295 struct GeanyPluginFuncs
297 /** Array of plugin-provided signal handlers @see PluginCallback */
298 PluginCallback
*callbacks
;
299 /** Called to initialize the plugin, when the user activates it (must not be @c NULL) */
300 gboolean (*init
) (GeanyPlugin
*plugin
, gpointer pdata
);
301 /** plugins configure dialog, optional (can be @c NULL) */
302 GtkWidget
* (*configure
) (GeanyPlugin
*plugin
, GtkDialog
*dialog
, gpointer pdata
);
303 /** Called when the plugin should show some help, optional (can be @c NULL) */
304 void (*help
) (GeanyPlugin
*plugin
, gpointer pdata
);
305 /** Called when the plugin is disabled or when Geany exits (must not be @c NULL) */
306 void (*cleanup
) (GeanyPlugin
*plugin
, gpointer pdata
);
309 gboolean
geany_plugin_register(GeanyPlugin
*plugin
, gint api_version
,
310 gint min_api_version
, gint abi_version
);
311 gboolean
geany_plugin_register_full(GeanyPlugin
*plugin
, gint api_version
,
312 gint min_api_version
, gint abi_version
,
313 gpointer data
, GDestroyNotify free_func
);
314 gpointer
geany_plugin_get_data(const GeanyPlugin
*plugin
);
315 void geany_plugin_set_data(GeanyPlugin
*plugin
, gpointer data
, GDestroyNotify free_func
);
317 /** Convenience macro to register a plugin.
319 * It simply calls geany_plugin_register() with GEANY_API_VERSION and GEANY_ABI_VERSION.
321 * @since 1.26 (API 225)
324 #define GEANY_PLUGIN_REGISTER(plugin, min_api_version) \
325 geany_plugin_register((plugin), GEANY_API_VERSION, \
326 (min_api_version), GEANY_ABI_VERSION)
328 /** Convenience macro to register a plugin with data.
330 * It simply calls geany_plugin_register_full() with GEANY_API_VERSION and GEANY_ABI_VERSION.
332 * @since 1.26 (API 225)
335 #define GEANY_PLUGIN_REGISTER_FULL(plugin, min_api_version, pdata, free_func) \
336 geany_plugin_register_full((plugin), GEANY_API_VERSION, \
337 (min_api_version), GEANY_ABI_VERSION, (pdata), (free_func))
339 /** Return values for GeanyProxyHooks::probe()
341 * @see geany_plugin_register_proxy() for a full description of the proxy plugin mechanisms.
345 /** The proxy is not responsible at all, and Geany or other plugins are free
348 * @since 1.29 (API 229)
351 /** The proxy is responsible for this file, and creates a plugin for it.
353 * @since 1.29 (API 229)
356 /** The proxy is does not directly load it, but it's still tied to the proxy.
358 * This is for plugins that come in multiple files where only one of these
359 * files is relevant for the plugin creation (for the PM dialog). The other
360 * files should be ignored by Geany and other proxies. Example: libpeas has
361 * a .plugin and a .so per plugin. Geany should not process the .so file
362 * if there is a corresponding .plugin.
364 * @since 1.29 (API 229)
366 GEANY_PROXY_RELATED
= GEANY_PROXY_MATCH
| 0x100
368 GeanyProxyProbeResults
;
370 /** Hooks that need to be implemented by every proxy
372 * @see geany_plugin_register_proxy() for a full description of the proxy mechanism.
374 * @since 1.26 (API 226)
376 struct GeanyProxyFuncs
378 /** Called to determine whether the proxy is truly responsible for the requested plugin.
379 * A NULL pointer assumes the probe() function would always return @ref GEANY_PROXY_MATCH */
380 gint (*probe
) (GeanyPlugin
*proxy
, const gchar
*filename
, gpointer pdata
);
381 /** Called after probe(), to perform the actual job of loading the plugin */
382 gpointer (*load
) (GeanyPlugin
*proxy
, GeanyPlugin
*subplugin
, const gchar
*filename
, gpointer pdata
);
383 /** Called when the user initiates unloading of a plugin, e.g. on Geany exit */
384 void (*unload
) (GeanyPlugin
*proxy
, GeanyPlugin
*subplugin
, gpointer load_data
, gpointer pdata
);
387 gint
geany_plugin_register_proxy(GeanyPlugin
*plugin
, const gchar
**extensions
);
389 /* Deprecated aliases */
390 #ifndef GEANY_DISABLE_DEPRECATED
392 /* This remains so that older plugins that contain a `GeanyFunctions *geany_functions;`
393 * variable in their plugin - as was previously required - will still compile
394 * without changes. */
395 typedef struct GeanyFunctionsUndefined GeanyFunctions GEANY_DEPRECATED
;
397 /** @deprecated - use plugin_set_key_group() instead.
398 * @see PLUGIN_KEY_GROUP() macro. */
399 typedef struct GeanyKeyGroupInfo
401 const gchar
*name
; /**< Group name used in the configuration file, such as @c "html_chars" */
402 gsize count
; /**< The number of keybindings the group will hold */
404 GeanyKeyGroupInfo
GEANY_DEPRECATED_FOR(plugin_set_key_group
);
406 /** @deprecated - use plugin_set_key_group() instead.
407 * Declare and initialise a keybinding group.
408 * @code GeanyKeyGroup *plugin_key_group; @endcode
409 * You must then set the @c plugin_key_group::keys[] entries for the group in plugin_init(),
410 * normally using keybindings_set_item().
411 * The @c plugin_key_group::label field is set by Geany after @c plugin_init()
412 * is called, to the name of the plugin.
413 * @param group_name A unique group name (without quotes) to be used in the
414 * configuration file, such as @c html_chars.
415 * @param key_count The number of keybindings the group will hold. */
416 #define PLUGIN_KEY_GROUP(group_name, key_count) \
417 /* We have to declare this as a single element array.
418 * Declaring as a pointer to a struct doesn't work with g_module_symbol(). */ \
419 GeanyKeyGroupInfo plugin_key_group_info[1] = \
421 {G_STRINGIFY(group_name), key_count} \
423 GeanyKeyGroup *plugin_key_group = NULL;
425 /** @deprecated Use @ref ui_add_document_sensitive() instead.
426 * Flags to be set by plugins in PluginFields struct. */
429 /** Whether a plugin's menu item should be disabled when there are no open documents */
430 PLUGIN_IS_DOCUMENT_SENSITIVE
= 1 << 0
434 /** @deprecated Use @ref ui_add_document_sensitive() instead.
435 * Fields set and owned by the plugin. */
436 typedef struct PluginFields
438 /** Bitmask of @c PluginFlags. */
440 /** Pointer to a plugin's menu item which will be automatically enabled/disabled when there
441 * are no open documents and @c PLUGIN_IS_DOCUMENT_SENSITIVE is set.
442 * This is required if using @c PLUGIN_IS_DOCUMENT_SENSITIVE, ignored otherwise */
443 GtkWidget
*menu_item
;
445 PluginFields
GEANY_DEPRECATED_FOR(ui_add_document_sensitive
);
447 #define document_reload_file document_reload_force
449 /** @deprecated - copy into your plugin code if needed.
450 * @c NULL-safe way to get the index of @a doc_ptr in the documents array. */
451 #define DOC_IDX(doc_ptr) \
452 (doc_ptr ? doc_ptr->index : -1)
453 #define DOC_IDX_VALID(doc_idx) \
454 ((doc_idx) >= 0 && (guint)(doc_idx) < documents_array->len && documents[doc_idx]->is_valid)
456 #define GEANY_WINDOW_MINIMAL_WIDTH 550
457 #define GEANY_WINDOW_MINIMAL_HEIGHT GEANY_DEFAULT_DIALOG_HEIGHT
459 #endif /* GEANY_DISABLE_DEPRECATED */
463 #endif /* GEANY_PLUGIN_DATA_H */