2 * plugindata.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2007-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2007-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
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.
24 * This file defines the plugin API, the interface between Geany and its plugins.
25 * For detailed documentation of the plugin system please read the plugin
28 /* Note: Remember to increment GEANY_API_VERSION (and GEANY_ABI_VERSION if necessary)
29 * when making changes (see 'Keeping the plugin ABI stable' in the HACKING file). */
32 #ifndef GEANY_PLUGINDATA_H
33 #define GEANY_PLUGINDATA_H
37 /* Compatibility for sharing macros between API and core.
38 * First include geany.h, then plugindata.h, then other API headers. */
40 #define GEANY(symbol_name) geany->symbol_name
42 #include "editor.h" /* GeanyIndentType */
43 #include "build.h" /* GeanyBuildGroup, GeanyBuildSource, GeanyBuildCmdEntries enums */
44 #include "gtkcompat.h"
47 /** The Application Programming Interface (API) version, incremented
48 * whenever any plugin data types are modified or appended to.
50 * You can protect code that needs a higher API than e.g. 200 with:
51 * @code #if GEANY_API_VERSION >= 200
52 * some_newer_function();
55 * @warning You should not test for values below 200 as previously
56 * @c GEANY_API_VERSION was defined as an enum value, not a macro.
58 #define GEANY_API_VERSION 218
60 /* hack to have a different ABI when built with GTK3 because loading GTK2-linked plugins
61 * with GTK3-linked Geany leads to crash */
62 #if GTK_CHECK_VERSION(3, 0, 0)
63 # define GEANY_ABI_SHIFT 8
65 # define GEANY_ABI_SHIFT 0
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 (69 << 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 /** Basic information for the plugin and identification.
109 * @see geany_plugin. */
110 typedef struct GeanyPlugin
112 PluginInfo
*info
; /**< Fields set in plugin_set_info(). */
114 struct GeanyPluginPrivate
*priv
; /* private */
119 /** Sets the plugin name and some other basic information about a plugin.
121 * @note If you want some of the arguments to be translated, see @ref PLUGIN_SET_TRANSLATABLE_INFO()
124 * @code PLUGIN_SET_INFO("Cool Feature", "Adds cool feature support.", "0.1", "Joe Author") @endcode */
125 /* plugin_set_info() could be written manually for plugins if we want to add any
126 * extra PluginInfo features (such as an icon), so we don't need to break API
127 * compatibility. Alternatively just add a new macro, PLUGIN_SET_INFO_FULL(). -ntrel */
128 #define PLUGIN_SET_INFO(p_name, p_description, p_version, p_author) \
129 void plugin_set_info(PluginInfo *info) \
131 info->name = (p_name); \
132 info->description = (p_description); \
133 info->version = (p_version); \
134 info->author = (p_author); \
137 /** Sets the plugin name and some other basic information about a plugin.
138 * This macro is like @ref PLUGIN_SET_INFO() but allows the passed information to be translated
139 * by setting up the translation mechanism with @ref main_locale_init().
140 * You therefore don't need to call it manually in plugin_init().
143 * @code PLUGIN_SET_TRANSLATABLE_INFO(LOCALEDIR, GETTEXT_PACKAGE, _("Cool Feature"), _("Adds a cool feature."), "0.1", "John Doe") @endcode
146 #define PLUGIN_SET_TRANSLATABLE_INFO(localedir, package, p_name, p_description, p_version, p_author) \
147 void plugin_set_info(PluginInfo *info) \
149 main_locale_init((localedir), (package)); \
150 info->name = (p_name); \
151 info->description = (p_description); \
152 info->version = (p_version); \
153 info->author = (p_author); \
157 #ifndef GEANY_PRIVATE
159 /* Prototypes for building plugins with -Wmissing-prototypes */
160 gint
plugin_version_check(gint abi_ver
);
161 void plugin_set_info(PluginInfo
*info
);
166 /** @deprecated - use plugin_set_key_group() instead.
167 * @see PLUGIN_KEY_GROUP() macro. */
168 typedef struct GeanyKeyGroupInfo
170 const gchar
*name
; /**< Group name used in the configuration file, such as @c "html_chars" */
171 gsize count
; /**< The number of keybindings the group will hold */
175 /** @deprecated - use plugin_set_key_group() instead.
176 * Declare and initialise a keybinding group.
177 * @code GeanyKeyGroup *plugin_key_group; @endcode
178 * You must then set the @c plugin_key_group::keys[] entries for the group in plugin_init(),
179 * normally using keybindings_set_item().
180 * The @c plugin_key_group::label field is set by Geany after @c plugin_init()
181 * is called, to the name of the plugin.
182 * @param group_name A unique group name (without quotes) to be used in the
183 * configuration file, such as @c html_chars.
184 * @param key_count The number of keybindings the group will hold. */
185 #define PLUGIN_KEY_GROUP(group_name, key_count) \
186 /* We have to declare this as a single element array.
187 * Declaring as a pointer to a struct doesn't work with g_module_symbol(). */ \
188 GeanyKeyGroupInfo plugin_key_group_info[1] = \
190 {G_STRINGIFY(group_name), key_count} \
192 GeanyKeyGroup *plugin_key_group = NULL;
195 /** Callback array entry type used with the @ref plugin_callbacks symbol. */
196 typedef struct PluginCallback
198 /** The name of signal, must be an existing signal. For a list of available signals,
199 * please see the @link pluginsignals.c Signal documentation @endlink. */
200 const gchar
*signal_name
;
201 /** A callback function which is called when the signal is emitted. */
203 /** Set to TRUE to connect your handler with g_signal_connect_after(). */
205 /** The user data passed to the signal handler. */
211 /** @deprecated Use @ref ui_add_document_sensitive() instead.
212 * Flags to be set by plugins in PluginFields struct. */
215 /** Whether a plugin's menu item should be disabled when there are no open documents */
216 PLUGIN_IS_DOCUMENT_SENSITIVE
= 1 << 0
220 /** @deprecated Use @ref ui_add_document_sensitive() instead.
221 * Fields set and owned by the plugin. */
222 typedef struct PluginFields
224 /** Bitmask of @c PluginFlags. */
226 /** Pointer to a plugin's menu item which will be automatically enabled/disabled when there
227 * are no open documents and @c PLUGIN_IS_DOCUMENT_SENSITIVE is set.
228 * This is required if using @c PLUGIN_IS_DOCUMENT_SENSITIVE, ignored otherwise */
229 GtkWidget
*menu_item
;
234 /** This contains pointers to global variables owned by Geany for plugins to use.
235 * Core variable pointers can be appended when needed by plugin authors, if appropriate. */
236 typedef struct GeanyData
238 struct GeanyApp
*app
; /**< Geany application data fields */
239 struct GeanyMainWidgets
*main_widgets
; /**< Important widgets in the main window */
240 GPtrArray
*documents_array
; /**< See document.h#documents_array. */
241 GPtrArray
*filetypes_array
; /**< Dynamic array of GeanyFiletype pointers */
242 struct GeanyPrefs
*prefs
; /**< General settings */
243 struct GeanyInterfacePrefs
*interface_prefs
; /**< Interface settings */
244 struct GeanyToolbarPrefs
*toolbar_prefs
; /**< Toolbar settings */
245 struct GeanyEditorPrefs
*editor_prefs
; /**< Editor settings */
246 struct GeanyFilePrefs
*file_prefs
; /**< File-related settings */
247 struct GeanySearchPrefs
*search_prefs
; /**< Search-related settings */
248 struct GeanyToolPrefs
*tool_prefs
; /**< Tool settings */
249 struct GeanyTemplatePrefs
*template_prefs
; /**< Template settings */
250 struct GeanyBuildInfo
*build_info
; /**< Current build information */
251 GSList
*filetypes_by_title
; /**< See filetypes.h#filetypes_by_title. */
255 #define geany geany_data /**< Simple macro for @c geany_data that reduces typing. */
258 /** This contains pointers to functions owned by Geany for plugins to use.
259 * Functions from the core can be appended when needed by plugin authors, but may
260 * require some changes. */
261 typedef struct GeanyFunctions
263 struct DocumentFuncs
*p_document
; /**< See document.h */
264 struct SciFuncs
*p_sci
; /**< See sciwrappers.h */
265 struct TemplateFuncs
*p_templates
; /**< See templates.h */
266 struct UtilsFuncs
*p_utils
; /**< See utils.h */
267 struct UIUtilsFuncs
*p_ui
; /**< See ui_utils.h */
268 /** @deprecated Use ui_lookup_widget() instead. */
269 struct SupportFuncs
*p_support
;
270 struct DialogFuncs
*p_dialogs
; /**< See dialogs.h */
271 /** @deprecated Use @ref GeanyFunctions::p_msgwin instead. */
272 struct MsgWinFuncs
*p_msgwindow
;
273 struct EncodingFuncs
*p_encodings
; /**< See encodings.h */
274 struct KeybindingFuncs
*p_keybindings
; /**< See keybindings.h */
275 struct TagManagerFuncs
*p_tm
; /**< See tagmanager/src */
276 struct SearchFuncs
*p_search
; /**< See search.h */
277 struct HighlightingFuncs
*p_highlighting
; /**< See highlighting.h */
278 struct FiletypeFuncs
*p_filetypes
; /**< See filetypes.h */
279 struct NavQueueFuncs
*p_navqueue
; /**< See navqueue.h */
280 struct EditorFuncs
*p_editor
; /**< See editor.h */
281 struct MainFuncs
*p_main
; /**< See main.h */
282 struct PluginFuncs
*p_plugin
; /**< See pluginutils.c */
283 struct ScintillaFuncs
*p_scintilla
; /**< See ScintillaFuncs */
284 struct MsgWinFuncs
*p_msgwin
; /**< See msgwindow.h */
285 struct StashFuncs
*p_stash
; /**< See stash.h */
286 struct SymbolsFuncs
*p_symbols
; /**< See symbols.h */
287 struct BuildFuncs
*p_build
; /**< See build.h */
292 /* For more information about these functions, see the main source code.
293 * E.g. for p_document->new_file(), see document_new_file() in document.c. */
297 typedef struct DocumentFuncs
299 struct GeanyDocument
* (*document_new_file
) (const gchar
*utf8_filename
, struct GeanyFiletype
*ft
,
301 struct GeanyDocument
* (*document_get_current
) (void);
302 struct GeanyDocument
* (*document_get_from_page
) (guint page_num
);
303 struct GeanyDocument
* (*document_find_by_filename
) (const gchar
*utf8_filename
);
304 struct GeanyDocument
* (*document_find_by_real_path
) (const gchar
*realname
);
305 gboolean (*document_save_file
) (struct GeanyDocument
*doc
, gboolean force
);
306 struct GeanyDocument
* (*document_open_file
) (const gchar
*locale_filename
, gboolean readonly
,
307 struct GeanyFiletype
*ft
, const gchar
*forced_enc
);
308 void (*document_open_files
) (const GSList
*filenames
, gboolean readonly
,
309 struct GeanyFiletype
*ft
, const gchar
*forced_enc
);
310 gboolean (*document_remove_page
) (guint page_num
);
311 gboolean (*document_reload_file
) (struct GeanyDocument
*doc
, const gchar
*forced_enc
);
312 void (*document_set_encoding
) (struct GeanyDocument
*doc
, const gchar
*new_encoding
);
313 void (*document_set_text_changed
) (struct GeanyDocument
*doc
, gboolean changed
);
314 void (*document_set_filetype
) (struct GeanyDocument
*doc
, struct GeanyFiletype
*type
);
315 gboolean (*document_close
) (struct GeanyDocument
*doc
);
316 struct GeanyDocument
* (*document_index
)(gint idx
);
317 gboolean (*document_save_file_as
) (struct GeanyDocument
*doc
, const gchar
*utf8_fname
);
318 void (*document_rename_file
) (struct GeanyDocument
*doc
, const gchar
*new_filename
);
319 const GdkColor
* (*document_get_status_color
) (struct GeanyDocument
*doc
);
320 gchar
* (*document_get_basename_for_display
) (struct GeanyDocument
*doc
, gint length
);
321 gint (*document_get_notebook_page
) (struct GeanyDocument
*doc
);
322 gint (*document_compare_by_display_name
) (gconstpointer a
, gconstpointer b
);
323 gint (*document_compare_by_tab_order
) (gconstpointer a
, gconstpointer b
);
324 gint (*document_compare_by_tab_order_reverse
) (gconstpointer a
, gconstpointer b
);
329 struct _ScintillaObject
;
331 /** See http://scintilla.org for the full documentation. */
332 typedef struct ScintillaFuncs
334 /** Send Scintilla a message. */
335 long int (*scintilla_send_message
) (struct _ScintillaObject
*sci
, unsigned int iMessage
,
336 long unsigned int wParam
, long int lParam
);
337 /** Create a new ScintillaObject widget. */
338 GtkWidget
* (*scintilla_new
)(void);
343 /** Wrapper functions for Scintilla messages.
344 * See sciwrappers.h for the list of functions. */
345 typedef struct SciFuncs
347 /** @deprecated Use @c scintilla_send_message() instead. */
348 long int (*sci_send_message
) (struct _ScintillaObject
*sci
, unsigned int iMessage
,
349 long unsigned int wParam
, long int lParam
);
350 void (*sci_send_command
) (struct _ScintillaObject
*sci
, gint cmd
);
352 void (*sci_start_undo_action
) (struct _ScintillaObject
*sci
);
353 void (*sci_end_undo_action
) (struct _ScintillaObject
*sci
);
354 void (*sci_set_text
) (struct _ScintillaObject
*sci
, const gchar
*text
);
355 void (*sci_insert_text
) (struct _ScintillaObject
*sci
, gint pos
, const gchar
*text
);
356 void (*sci_get_text
) (struct _ScintillaObject
*sci
, gint len
, gchar
*text
);
357 gint (*sci_get_length
) (struct _ScintillaObject
*sci
);
358 gint (*sci_get_current_position
) (struct _ScintillaObject
*sci
);
359 void (*sci_set_current_position
) (struct _ScintillaObject
*sci
, gint position
,
360 gboolean scroll_to_caret
);
361 gint (*sci_get_col_from_position
) (struct _ScintillaObject
*sci
, gint position
);
362 gint (*sci_get_line_from_position
) (struct _ScintillaObject
*sci
, gint position
);
363 gint (*sci_get_position_from_line
) (struct _ScintillaObject
*sci
, gint line
);
364 void (*sci_replace_sel
) (struct _ScintillaObject
*sci
, const gchar
*text
);
365 void (*sci_get_selected_text
) (struct _ScintillaObject
*sci
, gchar
*text
);
366 gint (*sci_get_selected_text_length
) (struct _ScintillaObject
*sci
);
367 gint (*sci_get_selection_start
) (struct _ScintillaObject
*sci
);
368 gint (*sci_get_selection_end
) (struct _ScintillaObject
*sci
);
369 gint (*sci_get_selection_mode
) (struct _ScintillaObject
*sci
);
370 void (*sci_set_selection_mode
) (struct _ScintillaObject
*sci
, gint mode
);
371 void (*sci_set_selection_start
) (struct _ScintillaObject
*sci
, gint position
);
372 void (*sci_set_selection_end
) (struct _ScintillaObject
*sci
, gint position
);
373 void (*sci_get_text_range
) (struct _ScintillaObject
*sci
, gint start
, gint end
, gchar
*text
);
374 gchar
* (*sci_get_line
) (struct _ScintillaObject
*sci
, gint line_num
);
375 gint (*sci_get_line_length
) (struct _ScintillaObject
*sci
, gint line
);
376 gint (*sci_get_line_count
) (struct _ScintillaObject
*sci
);
377 gboolean (*sci_get_line_is_visible
) (struct _ScintillaObject
*sci
, gint line
);
378 void (*sci_ensure_line_is_visible
) (struct _ScintillaObject
*sci
, gint line
);
379 void (*sci_scroll_caret
) (struct _ScintillaObject
*sci
);
380 gint (*sci_find_matching_brace
) (struct _ScintillaObject
*sci
, gint pos
);
381 gint (*sci_get_style_at
) (struct _ScintillaObject
*sci
, gint position
);
382 gchar (*sci_get_char_at
) (struct _ScintillaObject
*sci
, gint pos
);
383 gint (*sci_get_current_line
) (struct _ScintillaObject
*sci
);
384 gboolean (*sci_has_selection
) (struct _ScintillaObject
*sci
);
385 gint (*sci_get_tab_width
) (struct _ScintillaObject
*sci
);
386 void (*sci_indicator_clear
) (struct _ScintillaObject
*sci
, gint start
, gint end
);
387 void (*sci_indicator_set
) (struct _ScintillaObject
*sci
, gint indic
);
388 gchar
* (*sci_get_contents
) (struct _ScintillaObject
*sci
, gint len
);
389 gchar
* (*sci_get_contents_range
) (struct _ScintillaObject
*sci
, gint start
, gint end
);
390 gchar
* (*sci_get_selection_contents
) (struct _ScintillaObject
*sci
);
391 void (*sci_set_font
) (struct _ScintillaObject
*sci
, gint style
, const gchar
*font
, gint size
);
392 gint (*sci_get_line_end_position
) (struct _ScintillaObject
*sci
, gint line
);
393 void (*sci_set_target_start
) (struct _ScintillaObject
*sci
, gint start
);
394 void (*sci_set_target_end
) (struct _ScintillaObject
*sci
, gint end
);
395 gint (*sci_replace_target
) (struct _ScintillaObject
*sci
, const gchar
*text
, gboolean regex
);
396 void (*sci_set_marker_at_line
) (struct _ScintillaObject
*sci
, gint line_number
, gint marker
);
397 void (*sci_delete_marker_at_line
) (struct _ScintillaObject
*sci
, gint line_number
, gint marker
);
398 gboolean (*sci_is_marker_set_at_line
) (struct _ScintillaObject
*sci
, gint line
, gint marker
);
399 void (*sci_goto_line
) (struct _ScintillaObject
*sci
, gint line
, gboolean unfold
);
400 gint (*sci_find_text
) (struct _ScintillaObject
*sci
, gint flags
, struct Sci_TextToFind
*ttf
);
401 void (*sci_set_line_indentation
) (struct _ScintillaObject
*sci
, gint line
, gint indent
);
402 gint (*sci_get_line_indentation
) (struct _ScintillaObject
*sci
, gint line
);
403 gint (*sci_get_lexer
) (struct _ScintillaObject
*sci
);
408 /* See templates.h */
409 typedef struct TemplateFuncs
411 gchar
* (*templates_get_template_fileheader
) (gint filetype_idx
, const gchar
*fname
);
417 typedef struct UtilsFuncs
419 gboolean (*utils_str_equal
) (const gchar
*a
, const gchar
*b
);
420 guint (*utils_string_replace_all
) (GString
*haystack
, const gchar
*needle
,
421 const gchar
*replacement
);
422 GSList
* (*utils_get_file_list
) (const gchar
*path
, guint
*length
, GError
**error
);
423 gint (*utils_write_file
) (const gchar
*filename
, const gchar
*text
);
424 gchar
* (*utils_get_locale_from_utf8
) (const gchar
*utf8_text
);
425 gchar
* (*utils_get_utf8_from_locale
) (const gchar
*locale_text
);
426 gchar
* (*utils_remove_ext_from_filename
) (const gchar
*filename
);
427 gint (*utils_mkdir
) (const gchar
*path
, gboolean create_parent_dirs
);
428 gboolean (*utils_get_setting_boolean
) (GKeyFile
*config
, const gchar
*section
, const gchar
*key
,
429 const gboolean default_value
);
430 gint (*utils_get_setting_integer
) (GKeyFile
*config
, const gchar
*section
, const gchar
*key
,
431 const gint default_value
);
432 gchar
* (*utils_get_setting_string
) (GKeyFile
*config
, const gchar
*section
, const gchar
*key
,
433 const gchar
*default_value
);
434 gboolean (*utils_spawn_sync
) (const gchar
*dir
, gchar
**argv
, gchar
**env
, GSpawnFlags flags
,
435 GSpawnChildSetupFunc child_setup
, gpointer user_data
, gchar
**std_out
,
436 gchar
**std_err
, gint
*exit_status
, GError
**error
);
437 gboolean (*utils_spawn_async
) (const gchar
*dir
, gchar
**argv
, gchar
**env
, GSpawnFlags flags
,
438 GSpawnChildSetupFunc child_setup
, gpointer user_data
, GPid
*child_pid
,
440 gint (*utils_str_casecmp
) (const gchar
*s1
, const gchar
*s2
);
441 gchar
* (*utils_get_date_time
) (const gchar
*format
, time_t *time_to_use
);
442 void (*utils_open_browser
) (const gchar
*uri
);
443 guint (*utils_string_replace_first
) (GString
*haystack
, const gchar
*needle
,
444 const gchar
*replace
);
445 gchar
* (*utils_str_middle_truncate
) (const gchar
*string
, guint truncate_length
);
446 gchar
* (*utils_str_remove_chars
) (gchar
*string
, const gchar
*chars
);
447 GSList
* (*utils_get_file_list_full
)(const gchar
*path
, gboolean full_path
, gboolean sort
,
449 gchar
** (*utils_copy_environment
)(const gchar
**exclude_vars
, const gchar
*first_varname
, ...);
450 gchar
* (*utils_find_open_xml_tag
) (const gchar sel
[], gint size
);
451 const gchar
* (*utils_find_open_xml_tag_pos
) (const gchar sel
[], gint size
);
457 typedef struct MainFuncs
459 void (*main_reload_configuration
) (void);
460 void (*main_locale_init
) (const gchar
*locale_dir
, const gchar
*package
);
461 gboolean (*main_is_realized
) (void);
467 typedef struct UIUtilsFuncs
469 GtkWidget
* (*ui_dialog_vbox_new
) (GtkDialog
*dialog
);
470 GtkWidget
* (*ui_frame_new_with_alignment
) (const gchar
*label_text
, GtkWidget
**alignment
);
471 void (*ui_set_statusbar
) (gboolean log
, const gchar
*format
, ...) G_GNUC_PRINTF (2, 3);
472 void (*ui_table_add_row
) (GtkTable
*table
, gint row
, ...) G_GNUC_NULL_TERMINATED
;
473 GtkWidget
* (*ui_path_box_new
) (const gchar
*title
, GtkFileChooserAction action
, GtkEntry
*entry
);
474 GtkWidget
* (*ui_button_new_with_image
) (const gchar
*stock_id
, const gchar
*text
);
475 void (*ui_add_document_sensitive
) (GtkWidget
*widget
);
476 void (*ui_widget_set_tooltip_text
) (GtkWidget
*widget
, const gchar
*text
);
477 GtkWidget
* (*ui_image_menu_item_new
) (const gchar
*stock_id
, const gchar
*label
);
478 GtkWidget
* (*ui_lookup_widget
) (GtkWidget
*widget
, const gchar
*widget_name
);
479 void (*ui_progress_bar_start
) (const gchar
*text
);
480 void (*ui_progress_bar_stop
) (void);
481 void (*ui_entry_add_clear_icon
) (GtkEntry
*entry
);
482 void (*ui_menu_add_document_items
) (GtkMenu
*menu
, struct GeanyDocument
*active
,
484 void (*ui_widget_modify_font_from_string
) (GtkWidget
*widget
, const gchar
*str
);
485 gboolean (*ui_is_keyval_enter_or_return
) (guint keyval
);
486 gint (*ui_get_gtk_settings_integer
) (const gchar
*property_name
, gint default_value
);
487 void (*ui_combo_box_add_to_history
) (GtkComboBoxText
*combo_entry
,
488 const gchar
*text
, gint history_len
);
489 void (*ui_menu_add_document_items_sorted
) (GtkMenu
*menu
, struct GeanyDocument
*active
,
490 GCallback callback
, GCompareFunc compare_func
);
491 const gchar
* (*ui_lookup_stock_label
)(const gchar
*stock_id
);
497 typedef struct DialogFuncs
499 gboolean (*dialogs_show_question
) (const gchar
*text
, ...) G_GNUC_PRINTF (1, 2);
500 void (*dialogs_show_msgbox
) (GtkMessageType type
, const gchar
*text
, ...) G_GNUC_PRINTF (2, 3);
501 gboolean (*dialogs_show_save_as
) (void);
502 gboolean (*dialogs_show_input_numeric
) (const gchar
*title
, const gchar
*label_text
,
503 gdouble
*value
, gdouble min
, gdouble max
, gdouble step
);
504 gchar
* (*dialogs_show_input
)(const gchar
*title
, GtkWindow
*parent
, const gchar
*label_text
,
505 const gchar
*default_text
);
510 /* @deprecated Use ui_lookup_widget() instead. */
511 typedef struct SupportFuncs
513 GtkWidget
* (*support_lookup_widget
) (GtkWidget
*widget
, const gchar
*widget_name
);
518 /* See msgwindow.h */
519 typedef struct MsgWinFuncs
521 /* status_add() does not set the status bar - use ui->set_statusbar() instead. */
522 void (*msgwin_status_add
) (const gchar
*format
, ...) G_GNUC_PRINTF (1, 2);
523 void (*msgwin_compiler_add
) (gint msg_color
, const gchar
*format
, ...) G_GNUC_PRINTF (2, 3);
524 void (*msgwin_msg_add
) (gint msg_color
, gint line
, struct GeanyDocument
*doc
,
525 const gchar
*format
, ...) G_GNUC_PRINTF (4, 5);
526 void (*msgwin_clear_tab
) (gint tabnum
);
527 void (*msgwin_switch_tab
) (gint tabnum
, gboolean show
);
528 void (*msgwin_set_messages_dir
) (const gchar
*messages_dir
);
533 /* See encodings.h */
534 typedef struct EncodingFuncs
536 gchar
* (*encodings_convert_to_utf8
) (const gchar
*buffer
, gssize size
, gchar
**used_encoding
);
537 gchar
* (*encodings_convert_to_utf8_from_charset
) (const gchar
*buffer
, gssize size
,
538 const gchar
*charset
, gboolean fast
);
539 const gchar
* (*encodings_get_charset_from_index
) (gint idx
);
544 struct GeanyKeyGroup
;
545 /* avoid including keybindings.h */
546 typedef void (*_GeanyKeyCallback
) (guint key_id
);
548 /* See keybindings.h */
549 typedef struct KeybindingFuncs
551 void (*keybindings_send_command
) (guint group_id
, guint key_id
);
552 struct GeanyKeyBinding
* (*keybindings_set_item
) (struct GeanyKeyGroup
*group
, gsize key_id
,
553 _GeanyKeyCallback callback
, guint key
, GdkModifierType mod
,
554 const gchar
*name
, const gchar
*label
, GtkWidget
*menu_item
);
555 struct GeanyKeyBinding
* (*keybindings_get_item
)(struct GeanyKeyGroup
*group
, gsize key_id
);
561 /* See highlighting.h */
562 typedef struct HighlightingFuncs
564 const struct GeanyLexerStyle
* (*highlighting_get_style
) (gint ft_id
, gint style_id
);
565 void (*highlighting_set_styles
) (struct _ScintillaObject
*sci
, struct GeanyFiletype
*ft
);
566 gboolean (*highlighting_is_string_style
) (gint lexer
, gint style
);
567 gboolean (*highlighting_is_comment_style
) (gint lexer
, gint style
);
568 gboolean (*highlighting_is_code_style
) (gint lexer
, gint style
);
573 /* See filetypes.h */
574 typedef struct FiletypeFuncs
576 GeanyFiletype
* (*filetypes_detect_from_file
) (const gchar
*utf8_filename
);
577 GeanyFiletype
* (*filetypes_lookup_by_name
) (const gchar
*name
);
578 GeanyFiletype
* (*filetypes_index
)(gint idx
);
579 const gchar
* (*filetypes_get_display_name
)(GeanyFiletype
*ft
);
580 const GSList
* (*filetypes_get_sorted_by_name
)(void);
581 /* Remember to convert any filetype_id arguments to GeanyFiletype pointers in any
582 * appended functions */
588 typedef struct SearchFuncs
590 void (*search_show_find_in_files_dialog
) (const gchar
*dir
);
595 /* See tagmanager/include */
596 typedef struct TagManagerFuncs
598 gchar
* (*tm_get_real_path
) (const gchar
*file_name
);
599 TMWorkObject
* (*tm_source_file_new
) (const char *file_name
, gboolean update
, const char *name
);
600 gboolean (*tm_workspace_add_object
) (TMWorkObject
*work_object
);
601 gboolean (*tm_source_file_update
) (TMWorkObject
*source_file
, gboolean force
,
602 gboolean recurse
, gboolean update_parent
);
603 void (*tm_work_object_free
) (gpointer work_object
);
604 gboolean (*tm_workspace_remove_object
) (TMWorkObject
*w
, gboolean do_free
, gboolean update
);
610 typedef struct NavQueueFuncs
612 gboolean (*navqueue_goto_line
) (struct GeanyDocument
*old_doc
, struct GeanyDocument
*new_doc
,
621 typedef struct EditorFuncs
623 const struct GeanyIndentPrefs
* (*editor_get_indent_prefs
)(struct GeanyEditor
*editor
);
624 struct _ScintillaObject
* (*editor_create_widget
)(struct GeanyEditor
*editor
);
626 void (*editor_indicator_set_on_range
) (struct GeanyEditor
*editor
, gint indic
, gint start
, gint end
);
627 void (*editor_indicator_set_on_line
) (struct GeanyEditor
*editor
, gint indic
, gint line
);
628 void (*editor_indicator_clear
) (struct GeanyEditor
*editor
, gint indic
);
630 void (*editor_set_indent_type
)(struct GeanyEditor
*editor
, GeanyIndentType type
);
631 gchar
* (*editor_get_word_at_pos
) (struct GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
);
633 const gchar
* (*editor_get_eol_char_name
) (struct GeanyEditor
*editor
);
634 gint (*editor_get_eol_char_len
) (struct GeanyEditor
*editor
);
635 const gchar
* (*editor_get_eol_char
) (struct GeanyEditor
*editor
);
637 void (*editor_insert_text_block
) (struct GeanyEditor
*editor
, const gchar
*text
,
638 gint insert_pos
, gint cursor_index
, gint newline_indent_size
,
639 gboolean replace_newlines
);
641 gint (*editor_get_eol_char_mode
) (struct GeanyEditor
*editor
);
642 gboolean (*editor_goto_pos
) (struct GeanyEditor
*editor
, gint pos
, gboolean mark
);
644 const gchar
* (*editor_find_snippet
) (struct GeanyEditor
*editor
, const gchar
*snippet_name
);
645 void (*editor_insert_snippet
) (struct GeanyEditor
*editor
, gint pos
, const gchar
*snippet
);
650 /* avoid including keybindings.h */
651 typedef gboolean (*_GeanyKeyGroupCallback
) (guint key_id
);
653 /* See pluginutils.c */
654 typedef struct PluginFuncs
656 void (*plugin_add_toolbar_item
)(GeanyPlugin
*plugin
, GtkToolItem
*item
);
657 void (*plugin_module_make_resident
) (GeanyPlugin
*plugin
);
658 void (*plugin_signal_connect
) (GeanyPlugin
*plugin
,
659 GObject
*object
, const gchar
*signal_name
, gboolean after
,
660 GCallback callback
, gpointer user_data
);
661 struct GeanyKeyGroup
* (*plugin_set_key_group
)(GeanyPlugin
*plugin
,
662 const gchar
*section_name
, gsize count
, _GeanyKeyGroupCallback callback
);
663 void (*plugin_show_configure
)(GeanyPlugin
*plugin
);
664 guint (*plugin_timeout_add
) (GeanyPlugin
*plugin
, guint interval
, GSourceFunc function
,
666 guint (*plugin_timeout_add_seconds
) (GeanyPlugin
*plugin
, guint interval
,
667 GSourceFunc function
, gpointer data
);
668 guint (*plugin_idle_add
) (GeanyPlugin
*plugin
, GSourceFunc function
, gpointer data
);
669 void (*plugin_builder_connect_signals
) (GeanyPlugin
*plugin
, GtkBuilder
*builder
, gpointer user_data
);
677 typedef struct StashFuncs
679 struct StashGroup
*(*stash_group_new
)(const gchar
*name
);
680 void (*stash_group_add_boolean
)(struct StashGroup
*group
, gboolean
*setting
,
681 const gchar
*key_name
, gboolean default_value
);
682 void (*stash_group_add_integer
)(struct StashGroup
*group
, gint
*setting
,
683 const gchar
*key_name
, gint default_value
);
684 void (*stash_group_add_string
)(struct StashGroup
*group
, gchar
**setting
,
685 const gchar
*key_name
, const gchar
*default_value
);
686 void (*stash_group_add_string_vector
)(struct StashGroup
*group
, gchar
***setting
,
687 const gchar
*key_name
, const gchar
**default_value
);
688 void (*stash_group_load_from_key_file
)(struct StashGroup
*group
, GKeyFile
*keyfile
);
689 void (*stash_group_save_to_key_file
)(struct StashGroup
*group
, GKeyFile
*keyfile
);
690 void (*stash_group_free
)(struct StashGroup
*group
);
691 gboolean (*stash_group_load_from_file
)(struct StashGroup
*group
, const gchar
*filename
);
692 gint (*stash_group_save_to_file
)(struct StashGroup
*group
, const gchar
*filename
,
693 GKeyFileFlags flags
);
694 void (*stash_group_add_toggle_button
)(struct StashGroup
*group
, gboolean
*setting
,
695 const gchar
*key_name
, gboolean default_value
, gconstpointer widget_id
);
696 void (*stash_group_add_radio_buttons
)(struct StashGroup
*group
, gint
*setting
,
697 const gchar
*key_name
, gint default_value
,
698 gconstpointer widget_id
, gint enum_id
, ...) G_GNUC_NULL_TERMINATED
;
699 void (*stash_group_add_spin_button_integer
)(struct StashGroup
*group
, gint
*setting
,
700 const gchar
*key_name
, gint default_value
, gconstpointer widget_id
);
701 void (*stash_group_add_combo_box
)(struct StashGroup
*group
, gint
*setting
,
702 const gchar
*key_name
, gint default_value
, gconstpointer widget_id
);
703 void (*stash_group_add_combo_box_entry
)(struct StashGroup
*group
, gchar
**setting
,
704 const gchar
*key_name
, const gchar
*default_value
, gconstpointer widget_id
);
705 void (*stash_group_add_entry
)(struct StashGroup
*group
, gchar
**setting
,
706 const gchar
*key_name
, const gchar
*default_value
, gconstpointer widget_id
);
707 void (*stash_group_add_widget_property
)(struct StashGroup
*group
, gpointer setting
,
708 const gchar
*key_name
, gpointer default_value
, gconstpointer widget_id
,
709 const gchar
*property_name
, GType type
);
710 void (*stash_group_display
)(struct StashGroup
*group
, GtkWidget
*owner
);
711 void (*stash_group_update
)(struct StashGroup
*group
, GtkWidget
*owner
);
712 void (*stash_group_free_settings
)(struct StashGroup
*group
);
718 typedef struct SymbolsFuncs
720 const gchar
* (*symbols_get_context_separator
)(gint ft_id
);
725 typedef struct BuildFuncs
727 void (*build_activate_menu_item
)(const GeanyBuildGroup grp
, const guint cmd
);
728 const gchar
*(*build_get_current_menu_item
)(const GeanyBuildGroup grp
, const guint cmd
,
729 const GeanyBuildCmdEntries field
);
730 void (*build_remove_menu_item
)(const GeanyBuildSource src
, const GeanyBuildGroup grp
,
732 void (*build_set_menu_item
)(const GeanyBuildSource src
, const GeanyBuildGroup grp
,
733 const guint cmd
, const GeanyBuildCmdEntries field
, const gchar
*value
);
734 guint (*build_get_group_count
)(const GeanyBuildGroup grp
);
738 /* Deprecated aliases */
739 #ifndef GEANY_DISABLE_DEPRECATED
741 /** @deprecated - copy into your plugin code if needed.
742 * @c NULL-safe way to get the index of @a doc_ptr in the documents array. */
743 #define DOC_IDX(doc_ptr) \
744 (doc_ptr ? doc_ptr->index : -1)
745 #define DOC_IDX_VALID(doc_idx) \
746 ((doc_idx) >= 0 && (guint)(doc_idx) < documents_array->len && documents[doc_idx]->is_valid)
748 #define GEANY_WINDOW_MINIMAL_WIDTH 550
749 #define GEANY_WINDOW_MINIMAL_HEIGHT GEANY_DEFAULT_DIALOG_HEIGHT
751 #endif /* GEANY_DISABLE_DEPRECATED */