2 * pluginutils.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2009-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
5 * Copyright 2009-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 /** @file pluginutils.h
23 * Plugin utility functions.
24 * These functions all take the @ref geany_plugin symbol as their first argument. */
32 #include "pluginutils.h"
35 #include "geanyobject.h"
36 #include "plugindata.h"
37 #include "pluginprivate.h"
45 /** Inserts a toolbar item before the Quit button, or after the previous plugin toolbar item.
46 * A separator is added on the first call to this function, and will be shown when @a item is
47 * shown; hidden when @a item is hidden.
48 * @note You should still destroy @a item yourself, usually in @ref plugin_cleanup().
49 * @param plugin Must be @ref geany_plugin.
50 * @param item The item to add. */
52 void plugin_add_toolbar_item(GeanyPlugin
*plugin
, GtkToolItem
*item
)
54 GtkToolbar
*toolbar
= GTK_TOOLBAR(main_widgets
.toolbar
);
56 GeanyAutoSeparator
*autosep
;
58 g_return_if_fail(plugin
);
59 autosep
= &plugin
->priv
->toolbar_separator
;
65 pos
= toolbar_get_insert_position();
67 sep
= gtk_separator_tool_item_new();
68 gtk_toolbar_insert(toolbar
, sep
, pos
);
69 autosep
->widget
= GTK_WIDGET(sep
);
71 toolbar_item_ref(sep
);
75 pos
= gtk_toolbar_get_item_index(toolbar
, GTK_TOOL_ITEM(autosep
->widget
));
76 g_return_if_fail(pos
>= 0);
79 gtk_toolbar_insert(toolbar
, item
, pos
+ autosep
->item_count
+ 1);
80 toolbar_item_ref(item
);
82 /* hide the separator widget if there are no toolbar items showing for the plugin */
83 ui_auto_separator_add_ref(autosep
, GTK_WIDGET(item
));
87 /** Ensures that a plugin's module (*.so) will never be unloaded.
88 * This is necessary if you register new GTypes in your plugin, e.g. when using own classes
89 * using the GObject system.
91 * @param plugin Must be @ref geany_plugin.
96 void plugin_module_make_resident(GeanyPlugin
*plugin
)
98 g_return_if_fail(plugin
);
100 g_module_make_resident(plugin
->priv
->module
);
104 /** Connects a signal which will be disconnected on unloading the plugin, to prevent a possible segfault.
105 * @param plugin Must be @ref geany_plugin.
106 * @param object Object to connect to, or @c NULL when using @link pluginsignals.c Geany signals @endlink.
107 * @param signal_name The name of the signal. For a list of available
108 * signals, please see the @link pluginsignals.c Signal documentation @endlink.
109 * @param after Set to @c TRUE to call your handler after the main signal handlers have been called
110 * (if supported by @a signal_name).
111 * @param callback The function to call when the signal is emitted.
112 * @param user_data The user data passed to the signal handler.
113 * @see plugin_callbacks.
115 * @warning Before version 1.25 (API < 218),
116 * this should only be used on objects that outlive the plugin, never on
117 * objects that will get destroyed before the plugin is unloaded. For objects
118 * created and destroyed by the plugin, you can simply use @c g_signal_connect(),
119 * since all handlers are disconnected when the object is destroyed anyway.
120 * For objects that may or may not outlive the plugin (like @link GeanyEditor.sci
121 * a document's @c ScintillaObject @endlink, which is destroyed when the document
122 * is closed), you currently have to manually handle both situations, when the
123 * plugin is unloaded before the object is destroyed (and then, you have to
124 * disconnect the signal on @c plugin_cleanup()), and when the object is destroyed
125 * during the plugin's lifetime (in which case you cannot and should not disconnect
126 * manually in @c plugin_cleanup() since it already has been disconnected and the
127 * object has been destroyed), and disconnect yourself or not as appropriate.
128 * @note Since version 1.25 (API >= 218), the object lifetime is watched and so the above
129 * restriction does not apply. However, for objects destroyed by the plugin,
130 * @c g_signal_connect() is safe and has lower overhead. */
132 void plugin_signal_connect(GeanyPlugin
*plugin
,
133 GObject
*object
, const gchar
*signal_name
, gboolean after
,
134 GCallback callback
, gpointer user_data
)
139 g_return_if_fail(plugin
!= NULL
);
140 g_return_if_fail(object
== NULL
|| G_IS_OBJECT(object
));
143 object
= geany_object
;
146 g_signal_connect_after(object
, signal_name
, callback
, user_data
) :
147 g_signal_connect(object
, signal_name
, callback
, user_data
);
149 if (!plugin
->priv
->signal_ids
)
150 plugin
->priv
->signal_ids
= g_array_new(FALSE
, FALSE
, sizeof(SignalConnection
));
154 g_array_append_val(plugin
->priv
->signal_ids
, sc
);
156 /* watch the object lifetime to nuke our pointers to it */
157 plugin_watch_object(plugin
->priv
, object
);
161 typedef struct PluginSourceData
164 GList list_link
; /* element of plugin->sources cointaining this GSource */
165 GSourceFunc function
;
170 /* prepend psd->list_link to psd->plugin->sources */
171 static void psd_register(PluginSourceData
*psd
, GSource
*source
)
173 psd
->list_link
.data
= source
;
174 psd
->list_link
.prev
= NULL
;
175 psd
->list_link
.next
= psd
->plugin
->sources
;
176 if (psd
->list_link
.next
)
177 psd
->list_link
.next
->prev
= &psd
->list_link
;
178 psd
->plugin
->sources
= &psd
->list_link
;
182 /* removes psd->list_link from psd->plugin->sources */
183 static void psd_unregister(PluginSourceData
*psd
)
185 if (psd
->list_link
.next
)
186 psd
->list_link
.next
->prev
= psd
->list_link
.prev
;
187 if (psd
->list_link
.prev
)
188 psd
->list_link
.prev
->next
= psd
->list_link
.next
;
189 else /* we were the first of the list, update the plugin->sources pointer */
190 psd
->plugin
->sources
= psd
->list_link
.next
;
194 static void on_plugin_source_destroy(gpointer data
)
196 PluginSourceData
*psd
= data
;
199 g_slice_free1(sizeof *psd
, psd
);
203 static gboolean
on_plugin_source_callback(gpointer data
)
205 PluginSourceData
*psd
= data
;
207 return psd
->function(psd
->user_data
);
211 /* adds the given source to the default GMainContext and to the list of sources to remove at plugin
213 static guint
plugin_source_add(GeanyPlugin
*plugin
, GSource
*source
, GSourceFunc func
, gpointer data
)
216 PluginSourceData
*psd
= g_slice_alloc(sizeof *psd
);
218 psd
->plugin
= plugin
->priv
;
219 psd
->function
= func
;
220 psd
->user_data
= data
;
222 g_source_set_callback(source
, on_plugin_source_callback
, psd
, on_plugin_source_destroy
);
223 psd_register(psd
, source
);
224 id
= g_source_attach(source
, NULL
);
225 g_source_unref(source
);
231 /** Adds a GLib main loop timeout callback that will be removed when unloading the plugin,
232 * preventing it to run after the plugin has been unloaded (which may lead to a segfault).
234 * @param plugin Must be @ref geany_plugin.
235 * @param interval The time between calls to the function, in milliseconds.
236 * @param function The function to call after the given timeout.
237 * @param data The user data passed to the function.
238 * @return the ID of the event source (you generally won't need it, or better use g_timeout_add()
239 * directly if you want to manage this event source manually).
241 * @see g_timeout_add()
242 * @since 0.21, plugin API 205.
245 guint
plugin_timeout_add(GeanyPlugin
*plugin
, guint interval
, GSourceFunc function
, gpointer data
)
247 return plugin_source_add(plugin
, g_timeout_source_new(interval
), function
, data
);
251 /** Adds a GLib main loop timeout callback that will be removed when unloading the plugin,
252 * preventing it to run after the plugin has been unloaded (which may lead to a segfault).
254 * @param plugin Must be @ref geany_plugin.
255 * @param interval The time between calls to the function, in seconds.
256 * @param function The function to call after the given timeout.
257 * @param data The user data passed to the function.
258 * @return the ID of the event source (you generally won't need it, or better use
259 * g_timeout_add_seconds() directly if you want to manage this event source manually).
261 * @see g_timeout_add_seconds()
262 * @since 0.21, plugin API 205.
265 guint
plugin_timeout_add_seconds(GeanyPlugin
*plugin
, guint interval
, GSourceFunc function
,
268 return plugin_source_add(plugin
, g_timeout_source_new_seconds(interval
), function
, data
);
272 /** Adds a GLib main loop IDLE callback that will be removed when unloading the plugin, preventing
273 * it to run after the plugin has been unloaded (which may lead to a segfault).
275 * @param plugin Must be @ref geany_plugin.
276 * @param function The function to call in IDLE time.
277 * @param data The user data passed to the function.
278 * @return the ID of the event source (you generally won't need it, or better use g_idle_add()
279 * directly if you want to manage this event source manually).
282 * @since 0.21, plugin API 205.
285 guint
plugin_idle_add(GeanyPlugin
*plugin
, GSourceFunc function
, gpointer data
)
287 return plugin_source_add(plugin
, g_idle_source_new(), function
, data
);
291 /** Sets up or resizes a keybinding group for the plugin.
292 * You should then call keybindings_set_item() for each keybinding in the group.
293 * @param plugin Must be @ref geany_plugin.
294 * @param section_name Name used in the configuration file, such as @c "html_chars".
295 * @param count Number of keybindings for the group.
296 * @param callback Group callback, or @c NULL if you only want individual keybinding callbacks.
297 * @return The plugin's keybinding group.
300 GeanyKeyGroup
*plugin_set_key_group(GeanyPlugin
*plugin
,
301 const gchar
*section_name
, gsize count
, GeanyKeyGroupCallback callback
)
303 Plugin
*priv
= plugin
->priv
;
305 priv
->key_group
= keybindings_set_group(priv
->key_group
, section_name
,
306 priv
->info
.name
, count
, callback
);
307 return priv
->key_group
;
311 static void on_pref_btn_clicked(gpointer btn
, Plugin
*p
)
313 p
->configure_single(main_widgets
.window
);
317 static GtkWidget
*create_pref_page(Plugin
*p
, GtkWidget
*dialog
)
319 GtkWidget
*page
= NULL
; /* some plugins don't have prefs */
321 if (p
->cbs
.configure
)
323 page
= p
->cbs
.configure(&p
->public, GTK_DIALOG(dialog
), p
->cb_data
);
324 if (! GTK_IS_WIDGET(page
))
326 geany_debug("Invalid widget returned from plugin_configure() in plugin \"%s\"!",
332 GtkWidget
*align
= gtk_alignment_new(0.5, 0.5, 1, 1);
334 gtk_alignment_set_padding(GTK_ALIGNMENT(align
), 6, 6, 6, 6);
335 gtk_container_add(GTK_CONTAINER(align
), page
);
336 page
= gtk_vbox_new(FALSE
, 0);
337 gtk_box_pack_start(GTK_BOX(page
), align
, TRUE
, TRUE
, 0);
340 else if (p
->configure_single
)
342 GtkWidget
*align
= gtk_alignment_new(0.5, 0.5, 0, 0);
345 gtk_alignment_set_padding(GTK_ALIGNMENT(align
), 6, 6, 6, 6);
347 btn
= gtk_button_new_from_stock(GTK_STOCK_PREFERENCES
);
348 g_signal_connect(btn
, "clicked", G_CALLBACK(on_pref_btn_clicked
), p
);
349 gtk_container_add(GTK_CONTAINER(align
), btn
);
356 /* multiple plugin configure dialog
357 * current_plugin can be NULL */
358 static void configure_plugins(Plugin
*current_plugin
)
360 GtkWidget
*dialog
, *vbox
, *nb
;
364 dialog
= gtk_dialog_new_with_buttons(_("Configure Plugins"),
365 GTK_WINDOW(main_widgets
.window
), GTK_DIALOG_DESTROY_WITH_PARENT
,
366 GTK_STOCK_APPLY
, GTK_RESPONSE_APPLY
,
367 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
368 GTK_STOCK_OK
, GTK_RESPONSE_OK
, NULL
);
369 gtk_widget_set_name(dialog
, "GeanyDialog");
371 vbox
= ui_dialog_vbox_new(GTK_DIALOG(dialog
));
372 nb
= gtk_notebook_new();
373 gtk_notebook_set_scrollable(GTK_NOTEBOOK(nb
), TRUE
);
374 gtk_box_pack_start(GTK_BOX(vbox
), nb
, TRUE
, TRUE
, 0);
376 foreach_list(node
, active_plugin_list
)
378 Plugin
*p
= node
->data
;
379 GtkWidget
*page
= create_pref_page(p
, dialog
);
383 GtkWidget
*label
= gtk_label_new(p
->info
.name
);
384 gint n
= gtk_notebook_append_page(GTK_NOTEBOOK(nb
), page
, label
);
386 if (p
== current_plugin
)
390 if (gtk_notebook_get_n_pages(GTK_NOTEBOOK(nb
)))
392 gtk_widget_show_all(vbox
);
394 gtk_notebook_set_current_page(GTK_NOTEBOOK(nb
), cur_page
);
397 while (gtk_dialog_run(GTK_DIALOG(dialog
)) == GTK_RESPONSE_APPLY
);
402 gtk_widget_destroy(dialog
);
406 /** Shows the plugin's configure dialog.
407 * The plugin must implement one of the plugin_configure() or plugin_configure_single() symbols.
408 * @param plugin Must be @ref geany_plugin.
410 /* if NULL, show all plugins */
412 void plugin_show_configure(GeanyPlugin
*plugin
)
418 configure_plugins(NULL
);
423 if (p
->cbs
.configure
)
424 configure_plugins(p
);
427 g_return_if_fail(p
->configure_single
);
428 p
->configure_single(main_widgets
.window
);
433 struct BuilderConnectData
440 static void connect_plugin_signals(GtkBuilder
*builder
, GObject
*object
,
441 const gchar
*signal_name
, const gchar
*handler_name
,
442 GObject
*connect_object
, GConnectFlags flags
, gpointer user_data
)
444 gpointer symbol
= NULL
;
445 struct BuilderConnectData
*data
= user_data
;
447 if (!g_module_symbol(data
->plugin
->priv
->module
, handler_name
, &symbol
))
449 g_warning("Failed to locate signal handler for '%s': %s",
450 signal_name
, g_module_error());
454 plugin_signal_connect(data
->plugin
, object
, signal_name
, FALSE
,
455 G_CALLBACK(symbol
) /*ub?*/, data
->user_data
);
460 * Allows auto-connecting Glade/GtkBuilder signals in plugins.
462 * When a plugin uses GtkBuilder to load some UI from file/string,
463 * the gtk_builder_connect_signals() function is unable to automatically
464 * connect to the plugin's signal handlers. A plugin could itself use
465 * the gtk_builder_connect_signals_full() function to automatically
466 * connect to the signal handler functions by loading it's GModule
467 * and retrieving pointers to the handler functions, but rather than
468 * each plugin having to do that, this function handles it automatically.
472 * GeanyPlugin *geany_plugin;
474 * G_MODULE_EXPORT void
475 * myplugin_button_clicked(GtkButton *button, gpointer user_data)
477 * g_print("Button pressed\n");
480 * void plugin_init(GeanyData *data)
482 * GtkBuilder *builder = gtk_builder_new();
483 * gtk_builder_add_from_file(builder, "gui.glade", NULL);
484 * plugin_builder_connect_signals(geany_plugin, builder, NULL);
489 * @note It's important that you prefix your callback handlers with
490 * a plugin-specific prefix to avoid clashing with other plugins since
491 * the function symbols will be exported process-wide.
493 * @param plugin Must be @ref geany_plugin.
494 * @param builder The GtkBuilder to connect signals with.
495 * @param user_data User data to pass to the connected signal handlers.
497 * @since 1.24, plugin API 217.
500 void plugin_builder_connect_signals(GeanyPlugin
*plugin
,
501 GtkBuilder
*builder
, gpointer user_data
)
503 struct BuilderConnectData data
= { NULL
};
505 g_return_if_fail(plugin
!= NULL
&& plugin
->priv
!= NULL
);
506 g_return_if_fail(plugin
->priv
->module
!= NULL
);
507 g_return_if_fail(GTK_IS_BUILDER(builder
));
509 data
.user_data
= user_data
;
510 data
.plugin
= plugin
;
512 gtk_builder_connect_signals_full(builder
, connect_plugin_signals
, &data
);
516 /** Add additional data that corresponds to the plugin.
518 * @p pdata is the pointer going to be passed to the individual plugin callbacks
519 * of GeanyPlugin::funcs. When the plugin is cleaned up, @p free_func is invoked for the data,
520 * which connects the data to the time the plugin is enabled.
522 * One intended use case is to set GObjects as data and have them destroyed automatically
523 * by passing g_object_unref() as @a free_func, so that member functions can be used
524 * for the @ref GeanyPluginFuncs (via wrappers) but you can set completely custom data.
526 * Be aware that this can only be called once and only by plugins registered via
527 * @ref geany_plugin_register(). So-called legacy plugins cannot use this function.
529 * @note This function must not be called if the plugin was registered with
530 * geany_plugin_register_full().
532 * @param plugin The plugin provided by Geany
533 * @param pdata The plugin's data to associate, must not be @c NULL
534 * @param free_func The destroy notify
536 * @since 1.26 (API 225)
539 void geany_plugin_set_data(GeanyPlugin
*plugin
, gpointer pdata
, GDestroyNotify free_func
)
541 Plugin
*p
= plugin
->priv
;
543 g_return_if_fail(PLUGIN_LOADED_OK(p
));
544 /* Do not allow calling this only to set a notify. */
545 g_return_if_fail(pdata
!= NULL
);
546 /* The rationale to allow only setting the data once is the following:
547 * In the future we want to support proxy plugins (which bind non-C plugins to
548 * Geany's plugin api). These proxy plugins might need to own the data pointer
549 * on behalf of the proxied plugin. However, if not, then the plugin should be
550 * free to use it. This way we can make sure the plugin doesn't accidently trash
553 * Better a more limited API now that can be opened up later than a potentially
554 * wrong one that can only be replaced by another one. */
555 if (p
->cb_data
!= NULL
|| p
->cb_data_destroy
!= NULL
)
557 if (PLUGIN_HAS_LOAD_DATA(p
))
558 g_warning("Invalid call to %s(), geany_plugin_register_full() was used. Ignored!\n", G_STRFUNC
);
560 g_warning("Double call to %s(), ignored!", G_STRFUNC
);
565 p
->cb_data_destroy
= free_func
;