src/plugindata.h

   1 /*
   2  *      plugindata.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   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>
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 /**
  23  * @file plugindata.h
  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
  26  * API documentation.
  27  **/
  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). */
  30
  31
  32 #ifndef GEANY_PLUGIN_DATA_H
  33 #define GEANY_PLUGIN_DATA_H 1
  34
  35 #include "build.h"  /* GeanyBuildGroup, GeanyBuildSource, GeanyBuildCmdEntries enums */
  36 #include "document.h" /* GeanyDocument */
  37 #include "editor.h"     /* GeanyEditor, GeanyIndentType */
  38 #include "filetypes.h" /* GeanyFiletype */
  39
  40 #include "gtkcompat.h"
  41
  42 G_BEGIN_DECLS
  43
  44 /* Compatibility for sharing macros between API and core.
  45  * First include geany.h, then plugindata.h, then other API headers. */
  46 #undef GEANY
  47 #define GEANY(symbol_name) geany->symbol_name
  48
  49
  50 /** The Application Programming Interface (API) version, incremented
  51  * whenever any plugin data types are modified or appended to.
  52  *
  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();
  56  * #endif @endcode
  57  *
  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.
  60  */
  61 #define GEANY_API_VERSION 218
  62
  63 /* hack to have a different ABI when built with GTK3 because loading GTK2-linked plugins
  64  * with GTK3-linked Geany leads to crash */
  65 #if GTK_CHECK_VERSION(3, 0, 0)
  66 #       define GEANY_ABI_SHIFT 8
  67 #else
  68 #       define GEANY_ABI_SHIFT 0
  69 #endif
  70 /** The Application Binary Interface (ABI) version, incremented whenever
  71  * existing fields in the plugin data types have to be changed or reordered.
  72  * Changing this forces all plugins to be recompiled before Geany can load them. */
  73 /* This should usually stay the same if fields are only appended, assuming only pointers to
  74  * structs and not structs themselves are declared by plugins. */
  75 #define GEANY_ABI_VERSION (69 << GEANY_ABI_SHIFT)
  76
  77
  78 /** Defines a function to check the plugin is safe to load.
  79  * This performs runtime checks that try to ensure:
  80  * - Geany ABI data types are compatible with this plugin.
  81  * - Geany sources provide the required API for this plugin.
  82  * @param api_required The minimum API number your plugin requires.
  83  * Look at the source for the value of @c GEANY_API_VERSION to use if you
  84  * want your plugin to require the current Geany version on your machine.
  85  * You should update this value when using any new API features. */
  86 #define PLUGIN_VERSION_CHECK(api_required) \
  87         gint plugin_version_check(gint abi_ver) \
  88         { \
  89                 if (abi_ver != GEANY_ABI_VERSION) \
  90                         return -1; \
  91                 return (api_required); \
  92         }
  93
  94
  95 /** Basic information about a plugin available to Geany without loading the plugin.
  96  * The fields are set in plugin_set_info(), usually with the PLUGIN_SET_INFO() macro. */
  97 typedef struct PluginInfo
  98 {
  99         /** The name of the plugin. */
 100         const gchar     *name;
 101         /** The description of the plugin. */
 102         const gchar     *description;
 103         /** The version of the plugin. */
 104         const gchar     *version;
 105         /** The author of the plugin. */
 106         const gchar     *author;
 107 }
 108 PluginInfo;
 109
 110
 111 /** Basic information for the plugin and identification.
 112  * @see geany_plugin. */
 113 typedef struct GeanyPlugin
 114 {
 115         PluginInfo      *info;  /**< Fields set in plugin_set_info(). */
 116
 117         struct GeanyPluginPrivate *priv;        /* private */
 118 }
 119 GeanyPlugin;
 120
 121
 122 /** Sets the plugin name and some other basic information about a plugin.
 123  *
 124  * @note If you want some of the arguments to be translated, see @ref PLUGIN_SET_TRANSLATABLE_INFO()
 125  *
 126  * Example:
 127  * @code PLUGIN_SET_INFO("Cool Feature", "Adds cool feature support.", "0.1", "Joe Author") @endcode */
 128 /* plugin_set_info() could be written manually for plugins if we want to add any
 129  * extra PluginInfo features (such as an icon), so we don't need to break API
 130  * compatibility. Alternatively just add a new macro, PLUGIN_SET_INFO_FULL(). -ntrel */
 131 #define PLUGIN_SET_INFO(p_name, p_description, p_version, p_author) \
 132         void plugin_set_info(PluginInfo *info) \
 133         { \
 134                 info->name = (p_name); \
 135                 info->description = (p_description); \
 136                 info->version = (p_version); \
 137                 info->author = (p_author); \
 138         }
 139
 140 /** Sets the plugin name and some other basic information about a plugin.
 141  * This macro is like @ref PLUGIN_SET_INFO() but allows the passed information to be translated
 142  * by setting up the translation mechanism with @ref main_locale_init().
 143  * You therefore don't need to call it manually in plugin_init().
 144  *
 145  * Example:
 146  * @code PLUGIN_SET_TRANSLATABLE_INFO(LOCALEDIR, GETTEXT_PACKAGE, _("Cool Feature"), _("Adds a cool feature."), "0.1", "John Doe") @endcode
 147  *
 148  * @since 0.19 */
 149 #define PLUGIN_SET_TRANSLATABLE_INFO(localedir, package, p_name, p_description, p_version, p_author) \
 150         void plugin_set_info(PluginInfo *info) \
 151         { \
 152                 main_locale_init((localedir), (package)); \
 153                 info->name = (p_name); \
 154                 info->description = (p_description); \
 155                 info->version = (p_version); \
 156                 info->author = (p_author); \
 157         }
 158
 159
 160 #ifndef GEANY_PRIVATE
 161
 162 /* Prototypes for building plugins with -Wmissing-prototypes */
 163 gint plugin_version_check(gint abi_ver);
 164 void plugin_set_info(PluginInfo *info);
 165
 166 #endif
 167
 168
 169 /** @deprecated - use plugin_set_key_group() instead.
 170  * @see PLUGIN_KEY_GROUP() macro. */
 171 typedef struct GeanyKeyGroupInfo
 172 {
 173         const gchar *name;              /**< Group name used in the configuration file, such as @c "html_chars" */
 174         gsize count;                    /**< The number of keybindings the group will hold */
 175 }
 176 GeanyKeyGroupInfo;
 177
 178 /** @deprecated - use plugin_set_key_group() instead.
 179  * Declare and initialise a keybinding group.
 180  * @code GeanyKeyGroup *plugin_key_group; @endcode
 181  * You must then set the @c plugin_key_group::keys[] entries for the group in plugin_init(),
 182  * normally using keybindings_set_item().
 183  * The @c plugin_key_group::label field is set by Geany after @c plugin_init()
 184  * is called, to the name of the plugin.
 185  * @param group_name A unique group name (without quotes) to be used in the
 186  * configuration file, such as @c html_chars.
 187  * @param key_count     The number of keybindings the group will hold. */
 188 #define PLUGIN_KEY_GROUP(group_name, key_count) \
 189         /* We have to declare this as a single element array.
 190          * Declaring as a pointer to a struct doesn't work with g_module_symbol(). */ \
 191         GeanyKeyGroupInfo plugin_key_group_info[1] = \
 192         { \
 193                 {G_STRINGIFY(group_name), key_count} \
 194         };\
 195         GeanyKeyGroup *plugin_key_group = NULL;
 196
 197
 198 /** Callback array entry type used with the @ref plugin_callbacks symbol. */
 199 typedef struct PluginCallback
 200 {
 201         /** The name of signal, must be an existing signal. For a list of available signals,
 202          *  please see the @link pluginsignals.c Signal documentation @endlink. */
 203         const gchar     *signal_name;
 204         /** A callback function which is called when the signal is emitted. */
 205         GCallback       callback;
 206         /** Set to TRUE to connect your handler with g_signal_connect_after(). */
 207         gboolean        after;
 208         /** The user data passed to the signal handler. */
 209         gpointer        user_data;
 210 }
 211 PluginCallback;
 212
 213
 214 /** @deprecated Use @ref ui_add_document_sensitive() instead.
 215  * Flags to be set by plugins in PluginFields struct. */
 216 typedef enum
 217 {
 218         /** Whether a plugin's menu item should be disabled when there are no open documents */
 219         PLUGIN_IS_DOCUMENT_SENSITIVE    = 1 << 0
 220 }
 221 PluginFlags;
 222
 223 /** @deprecated Use @ref ui_add_document_sensitive() instead.
 224  * Fields set and owned by the plugin. */
 225 typedef struct PluginFields
 226 {
 227         /** Bitmask of @c PluginFlags. */
 228         PluginFlags     flags;
 229         /** Pointer to a plugin's menu item which will be automatically enabled/disabled when there
 230          *  are no open documents and @c PLUGIN_IS_DOCUMENT_SENSITIVE is set.
 231          *  This is required if using @c PLUGIN_IS_DOCUMENT_SENSITIVE, ignored otherwise */
 232         GtkWidget       *menu_item;
 233 }
 234 PluginFields;
 235
 236
 237 /** This contains pointers to global variables owned by Geany for plugins to use.
 238  * Core variable pointers can be appended when needed by plugin authors, if appropriate. */
 239 typedef struct GeanyData
 240 {
 241         struct GeanyApp                         *app;                           /**< Geany application data fields */
 242         struct GeanyMainWidgets         *main_widgets;          /**< Important widgets in the main window */
 243         GPtrArray                                       *documents_array;       /**< See document.h#documents_array. */
 244         GPtrArray                                       *filetypes_array;       /**< Dynamic array of GeanyFiletype pointers */
 245         struct GeanyPrefs                       *prefs;                         /**< General settings */
 246         struct GeanyInterfacePrefs      *interface_prefs;       /**< Interface settings */
 247         struct GeanyToolbarPrefs        *toolbar_prefs;         /**< Toolbar settings */
 248         struct GeanyEditorPrefs         *editor_prefs;          /**< Editor settings */
 249         struct GeanyFilePrefs           *file_prefs;            /**< File-related settings */
 250         struct GeanySearchPrefs         *search_prefs;          /**< Search-related settings */
 251         struct GeanyToolPrefs           *tool_prefs;            /**< Tool settings */
 252         struct GeanyTemplatePrefs       *template_prefs;        /**< Template settings */
 253         struct GeanyBuildInfo           *build_info;            /**< Current build information */
 254         GSList                                          *filetypes_by_title; /**< See filetypes.h#filetypes_by_title. */
 255 }
 256 GeanyData;
 257
 258 #define geany                   geany_data      /**< Simple macro for @c geany_data that reduces typing. */
 259
 260
 261 /** This contains pointers to functions owned by Geany for plugins to use.
 262  * Functions from the core can be appended when needed by plugin authors, but may
 263  * require some changes. */
 264 typedef struct GeanyFunctions
 265 {
 266         struct DocumentFuncs            *p_document;            /**< See document.h */
 267         struct SciFuncs                         *p_sci;                         /**< See sciwrappers.h */
 268         struct TemplateFuncs            *p_templates;           /**< See templates.h */
 269         struct UtilsFuncs                       *p_utils;                       /**< See utils.h */
 270         struct UIUtilsFuncs                     *p_ui;                          /**< See ui_utils.h */
 271         /** @deprecated Use ui_lookup_widget() instead. */
 272         struct SupportFuncs                     *p_support;
 273         struct DialogFuncs                      *p_dialogs;                     /**< See dialogs.h */
 274         /** @deprecated Use @ref GeanyFunctions::p_msgwin instead. */
 275         struct MsgWinFuncs                      *p_msgwindow;
 276         struct EncodingFuncs            *p_encodings;           /**< See encodings.h */
 277         struct KeybindingFuncs          *p_keybindings;         /**< See keybindings.h */
 278         struct TagManagerFuncs          *p_tm;                          /**< See tagmanager/src */
 279         struct SearchFuncs                      *p_search;                      /**< See search.h */
 280         struct HighlightingFuncs        *p_highlighting;        /**< See highlighting.h */
 281         struct FiletypeFuncs            *p_filetypes;           /**< See filetypes.h */
 282         struct NavQueueFuncs            *p_navqueue;            /**< See navqueue.h */
 283         struct EditorFuncs                      *p_editor;                      /**< See editor.h */
 284         struct MainFuncs                        *p_main;                        /**< See main.h */
 285         struct PluginFuncs                      *p_plugin;                      /**< See pluginutils.c */
 286         struct ScintillaFuncs           *p_scintilla;           /**< See ScintillaFuncs */
 287         struct MsgWinFuncs                      *p_msgwin;                      /**< See msgwindow.h */
 288         struct StashFuncs                       *p_stash;                       /**< See stash.h */
 289         struct SymbolsFuncs                     *p_symbols;                     /**< See symbols.h */
 290         struct BuildFuncs                       *p_build;                       /**< See build.h */
 291 }
 292 GeanyFunctions;
 293
 294
 295 /* For more information about these functions, see the main source code.
 296  * E.g. for p_document->new_file(), see document_new_file() in document.c. */
 297
 298 /* See document.h */
 299 typedef struct DocumentFuncs
 300 {
 301         struct GeanyDocument*   (*document_new_file) (const gchar *utf8_filename, struct GeanyFiletype *ft,
 302                         const gchar *text);
 303         struct GeanyDocument*   (*document_get_current) (void);
 304         struct GeanyDocument*   (*document_get_from_page) (guint page_num);
 305         struct GeanyDocument*   (*document_find_by_filename) (const gchar *utf8_filename);
 306         struct GeanyDocument*   (*document_find_by_real_path) (const gchar *realname);
 307         gboolean                                (*document_save_file) (struct GeanyDocument *doc, gboolean force);
 308         struct GeanyDocument*   (*document_open_file) (const gchar *locale_filename, gboolean readonly,
 309                         struct GeanyFiletype *ft, const gchar *forced_enc);
 310         void            (*document_open_files) (const GSList *filenames, gboolean readonly,
 311                         struct GeanyFiletype *ft, const gchar *forced_enc);
 312         gboolean        (*document_remove_page) (guint page_num);
 313         gboolean        (*document_reload_file) (struct GeanyDocument *doc, const gchar *forced_enc);
 314         void            (*document_set_encoding) (struct GeanyDocument *doc, const gchar *new_encoding);
 315         void            (*document_set_text_changed) (struct GeanyDocument *doc, gboolean changed);
 316         void            (*document_set_filetype) (struct GeanyDocument *doc, struct GeanyFiletype *type);
 317         gboolean        (*document_close) (struct GeanyDocument *doc);
 318         struct GeanyDocument*   (*document_index)(gint idx);
 319         gboolean        (*document_save_file_as) (struct GeanyDocument *doc, const gchar *utf8_fname);
 320         void            (*document_rename_file) (struct GeanyDocument *doc, const gchar *new_filename);
 321         const GdkColor* (*document_get_status_color) (struct GeanyDocument *doc);
 322         gchar*          (*document_get_basename_for_display) (struct GeanyDocument *doc, gint length);
 323         gint            (*document_get_notebook_page) (struct GeanyDocument *doc);
 324         gint            (*document_compare_by_display_name) (gconstpointer a, gconstpointer b);
 325         gint            (*document_compare_by_tab_order) (gconstpointer a, gconstpointer b);
 326         gint            (*document_compare_by_tab_order_reverse) (gconstpointer a, gconstpointer b);
 327 }
 328 DocumentFuncs;
 329
 330
 331 struct _ScintillaObject;
 332
 333 /** See http://scintilla.org for the full documentation. */
 334 typedef struct ScintillaFuncs
 335 {
 336         /** Send Scintilla a message. */
 337         long int        (*scintilla_send_message) (struct _ScintillaObject *sci, unsigned int iMessage,
 338                         long unsigned int wParam, long int lParam);
 339         /** Create a new ScintillaObject widget. */
 340         GtkWidget*      (*scintilla_new)(void);
 341 }
 342 ScintillaFuncs;
 343
 344
 345 /** Wrapper functions for Scintilla messages.
 346  * See sciwrappers.h for the list of functions. */
 347 typedef struct SciFuncs
 348 {
 349         /** @deprecated Use @c scintilla_send_message() instead. */
 350         long int (*sci_send_message) (struct _ScintillaObject *sci, unsigned int iMessage,
 351                         long unsigned int wParam, long int lParam);
 352         void    (*sci_send_command) (struct _ScintillaObject *sci, gint cmd);
 353
 354         void    (*sci_start_undo_action) (struct _ScintillaObject *sci);
 355         void    (*sci_end_undo_action) (struct _ScintillaObject *sci);
 356         void    (*sci_set_text) (struct _ScintillaObject *sci, const gchar *text);
 357         void    (*sci_insert_text) (struct _ScintillaObject *sci, gint pos, const gchar *text);
 358         void    (*sci_get_text) (struct _ScintillaObject *sci, gint len, gchar *text);
 359         gint    (*sci_get_length) (struct _ScintillaObject *sci);
 360         gint    (*sci_get_current_position) (struct _ScintillaObject *sci);
 361         void    (*sci_set_current_position) (struct _ScintillaObject *sci, gint position,
 362                          gboolean scroll_to_caret);
 363         gint    (*sci_get_col_from_position) (struct _ScintillaObject *sci, gint position);
 364         gint    (*sci_get_line_from_position) (struct _ScintillaObject *sci, gint position);
 365         gint    (*sci_get_position_from_line) (struct _ScintillaObject *sci, gint line);
 366         void    (*sci_replace_sel) (struct _ScintillaObject *sci, const gchar *text);
 367         void    (*sci_get_selected_text) (struct _ScintillaObject *sci, gchar *text);
 368         gint    (*sci_get_selected_text_length) (struct _ScintillaObject *sci);
 369         gint    (*sci_get_selection_start) (struct _ScintillaObject *sci);
 370         gint    (*sci_get_selection_end) (struct _ScintillaObject *sci);
 371         gint    (*sci_get_selection_mode) (struct _ScintillaObject *sci);
 372         void    (*sci_set_selection_mode) (struct _ScintillaObject *sci, gint mode);
 373         void    (*sci_set_selection_start) (struct _ScintillaObject *sci, gint position);
 374         void    (*sci_set_selection_end) (struct _ScintillaObject *sci, gint position);
 375         void    (*sci_get_text_range) (struct _ScintillaObject *sci, gint start, gint end, gchar *text);
 376         gchar*  (*sci_get_line) (struct _ScintillaObject *sci, gint line_num);
 377         gint    (*sci_get_line_length) (struct _ScintillaObject *sci, gint line);
 378         gint    (*sci_get_line_count) (struct _ScintillaObject *sci);
 379         gboolean (*sci_get_line_is_visible) (struct _ScintillaObject *sci, gint line);
 380         void    (*sci_ensure_line_is_visible) (struct _ScintillaObject *sci, gint line);
 381         void    (*sci_scroll_caret) (struct _ScintillaObject *sci);
 382         gint    (*sci_find_matching_brace) (struct _ScintillaObject *sci, gint pos);
 383         gint    (*sci_get_style_at) (struct _ScintillaObject *sci, gint position);
 384         gchar   (*sci_get_char_at) (struct _ScintillaObject *sci, gint pos);
 385         gint    (*sci_get_current_line) (struct _ScintillaObject *sci);
 386         gboolean (*sci_has_selection) (struct _ScintillaObject *sci);
 387         gint    (*sci_get_tab_width) (struct _ScintillaObject *sci);
 388         void    (*sci_indicator_clear) (struct _ScintillaObject *sci, gint start, gint end);
 389         void    (*sci_indicator_set) (struct _ScintillaObject *sci, gint indic);
 390         gchar*  (*sci_get_contents) (struct _ScintillaObject *sci, gint len);
 391         gchar*  (*sci_get_contents_range) (struct _ScintillaObject *sci, gint start, gint end);
 392         gchar*  (*sci_get_selection_contents) (struct _ScintillaObject *sci);
 393         void    (*sci_set_font) (struct _ScintillaObject *sci, gint style, const gchar *font, gint size);
 394         gint    (*sci_get_line_end_position) (struct _ScintillaObject *sci, gint line);
 395         void    (*sci_set_target_start) (struct _ScintillaObject *sci, gint start);
 396         void    (*sci_set_target_end) (struct _ScintillaObject *sci, gint end);
 397         gint    (*sci_replace_target) (struct _ScintillaObject *sci, const gchar *text, gboolean regex);
 398         void    (*sci_set_marker_at_line) (struct _ScintillaObject *sci, gint line_number, gint marker);
 399         void    (*sci_delete_marker_at_line) (struct _ScintillaObject *sci, gint line_number, gint marker);
 400         gboolean (*sci_is_marker_set_at_line) (struct _ScintillaObject *sci, gint line, gint marker);
 401         void    (*sci_goto_line) (struct _ScintillaObject *sci, gint line, gboolean unfold);
 402         gint    (*sci_find_text) (struct _ScintillaObject *sci, gint flags, struct Sci_TextToFind *ttf);
 403         void    (*sci_set_line_indentation) (struct _ScintillaObject *sci, gint line, gint indent);
 404         gint    (*sci_get_line_indentation) (struct _ScintillaObject *sci, gint line);
 405         gint    (*sci_get_lexer) (struct _ScintillaObject *sci);
 406 }
 407 SciFuncs;
 408
 409
 410 /* See templates.h */
 411 typedef struct TemplateFuncs
 412 {
 413         gchar*          (*templates_get_template_fileheader) (gint filetype_idx, const gchar *fname);
 414 }
 415 TemplateFuncs;
 416
 417
 418 /* See utils.h */
 419 typedef struct UtilsFuncs
 420 {
 421         gboolean        (*utils_str_equal) (const gchar *a, const gchar *b);
 422         guint           (*utils_string_replace_all) (GString *haystack, const gchar *needle,
 423                                  const gchar *replacement);
 424         GSList*         (*utils_get_file_list) (const gchar *path, guint *length, GError **error);
 425         gint            (*utils_write_file) (const gchar *filename, const gchar *text);
 426         gchar*          (*utils_get_locale_from_utf8) (const gchar *utf8_text);
 427         gchar*          (*utils_get_utf8_from_locale) (const gchar *locale_text);
 428         gchar*          (*utils_remove_ext_from_filename) (const gchar *filename);
 429         gint            (*utils_mkdir) (const gchar *path, gboolean create_parent_dirs);
 430         gboolean        (*utils_get_setting_boolean) (GKeyFile *config, const gchar *section, const gchar *key,
 431                                  const gboolean default_value);
 432         gint            (*utils_get_setting_integer) (GKeyFile *config, const gchar *section, const gchar *key,
 433                                  const gint default_value);
 434         gchar*          (*utils_get_setting_string) (GKeyFile *config, const gchar *section, const gchar *key,
 435                                  const gchar *default_value);
 436         gboolean        (*utils_spawn_sync) (const gchar *dir, gchar **argv, gchar **env, GSpawnFlags flags,
 437                                  GSpawnChildSetupFunc child_setup, gpointer user_data, gchar **std_out,
 438                                  gchar **std_err, gint *exit_status, GError **error);
 439         gboolean        (*utils_spawn_async) (const gchar *dir, gchar **argv, gchar **env, GSpawnFlags flags,
 440                                  GSpawnChildSetupFunc child_setup, gpointer user_data, GPid *child_pid,
 441                                  GError **error);
 442         gint            (*utils_str_casecmp) (const gchar *s1, const gchar *s2);
 443         gchar*          (*utils_get_date_time) (const gchar *format, time_t *time_to_use);
 444         void            (*utils_open_browser) (const gchar *uri);
 445         guint           (*utils_string_replace_first) (GString *haystack, const gchar *needle,
 446                                  const gchar *replace);
 447         gchar*          (*utils_str_middle_truncate) (const gchar *string, guint truncate_length);
 448         gchar*          (*utils_str_remove_chars) (gchar *string, const gchar *chars);
 449         GSList*         (*utils_get_file_list_full)(const gchar *path, gboolean full_path, gboolean sort,
 450                                 GError **error);
 451         gchar**         (*utils_copy_environment)(const gchar **exclude_vars, const gchar *first_varname, ...);
 452         gchar*          (*utils_find_open_xml_tag) (const gchar sel[], gint size);
 453         const gchar*    (*utils_find_open_xml_tag_pos) (const gchar sel[], gint size);
 454 }
 455 UtilsFuncs;
 456
 457
 458 /* See main.h */
 459 typedef struct MainFuncs
 460 {
 461         void            (*main_reload_configuration) (void);
 462         void            (*main_locale_init) (const gchar *locale_dir, const gchar *package);
 463         gboolean        (*main_is_realized) (void);
 464 }
 465 MainFuncs;
 466
 467
 468 /* See ui_utils.h */
 469 typedef struct UIUtilsFuncs
 470 {
 471         GtkWidget*      (*ui_dialog_vbox_new) (GtkDialog *dialog);
 472         GtkWidget*      (*ui_frame_new_with_alignment) (const gchar *label_text, GtkWidget **alignment);
 473         void            (*ui_set_statusbar) (gboolean log, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
 474         void            (*ui_table_add_row) (GtkTable *table, gint row, ...) G_GNUC_NULL_TERMINATED;
 475         GtkWidget*      (*ui_path_box_new) (const gchar *title, GtkFileChooserAction action, GtkEntry *entry);
 476         GtkWidget*      (*ui_button_new_with_image) (const gchar *stock_id, const gchar *text);
 477         void            (*ui_add_document_sensitive) (GtkWidget *widget);
 478         void            (*ui_widget_set_tooltip_text) (GtkWidget *widget, const gchar *text);
 479         GtkWidget*      (*ui_image_menu_item_new) (const gchar *stock_id, const gchar *label);
 480         GtkWidget*      (*ui_lookup_widget) (GtkWidget *widget, const gchar *widget_name);
 481         void            (*ui_progress_bar_start) (const gchar *text);
 482         void            (*ui_progress_bar_stop) (void);
 483         void            (*ui_entry_add_clear_icon) (GtkEntry *entry);
 484         void            (*ui_menu_add_document_items) (GtkMenu *menu, struct GeanyDocument *active,
 485                                 GCallback callback);
 486         void            (*ui_widget_modify_font_from_string) (GtkWidget *widget, const gchar *str);
 487         gboolean        (*ui_is_keyval_enter_or_return) (guint keyval);
 488         gint            (*ui_get_gtk_settings_integer) (const gchar *property_name, gint default_value);
 489         void            (*ui_combo_box_add_to_history) (GtkComboBoxText *combo_entry,
 490                                 const gchar *text, gint history_len);
 491         void            (*ui_menu_add_document_items_sorted) (GtkMenu *menu, struct GeanyDocument *active,
 492                                 GCallback callback, GCompareFunc compare_func);
 493         const gchar* (*ui_lookup_stock_label)(const gchar *stock_id);
 494 }
 495 UIUtilsFuncs;
 496
 497
 498 /* See dialogs.h */
 499 typedef struct DialogFuncs
 500 {
 501         gboolean        (*dialogs_show_question) (const gchar *text, ...) G_GNUC_PRINTF (1, 2);
 502         void            (*dialogs_show_msgbox) (GtkMessageType type, const gchar *text, ...) G_GNUC_PRINTF (2, 3);
 503         gboolean        (*dialogs_show_save_as) (void);
 504         gboolean        (*dialogs_show_input_numeric) (const gchar *title, const gchar *label_text,
 505                                  gdouble *value, gdouble min, gdouble max, gdouble step);
 506         gchar*          (*dialogs_show_input)(const gchar *title, GtkWindow *parent, const gchar *label_text,
 507                                 const gchar *default_text);
 508 }
 509 DialogFuncs;
 510
 511
 512 /* @deprecated Use ui_lookup_widget() instead. */
 513 typedef struct SupportFuncs
 514 {
 515         GtkWidget*      (*support_lookup_widget) (GtkWidget *widget, const gchar *widget_name);
 516 }
 517 SupportFuncs;
 518
 519
 520 /* See msgwindow.h */
 521 typedef struct MsgWinFuncs
 522 {
 523         /* status_add() does not set the status bar - use ui->set_statusbar() instead. */
 524         void            (*msgwin_status_add) (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 525         void            (*msgwin_compiler_add) (gint msg_color, const gchar *format, ...) G_GNUC_PRINTF (2, 3);
 526         void            (*msgwin_msg_add) (gint msg_color, gint line, struct GeanyDocument *doc,
 527                                  const gchar *format, ...) G_GNUC_PRINTF (4, 5);
 528         void            (*msgwin_clear_tab) (gint tabnum);
 529         void            (*msgwin_switch_tab) (gint tabnum, gboolean show);
 530         void            (*msgwin_set_messages_dir) (const gchar *messages_dir);
 531 }
 532 MsgWinFuncs;
 533
 534
 535 /* See encodings.h */
 536 typedef struct EncodingFuncs
 537 {
 538         gchar*                  (*encodings_convert_to_utf8) (const gchar *buffer, gssize size, gchar **used_encoding);
 539         gchar*                  (*encodings_convert_to_utf8_from_charset) (const gchar *buffer, gssize size,
 540                                                                                                          const gchar *charset, gboolean fast);
 541         const gchar*    (*encodings_get_charset_from_index) (gint idx);
 542 }
 543 EncodingFuncs;
 544
 545
 546 struct GeanyKeyGroup;
 547 /* avoid including keybindings.h */
 548 typedef void (*_GeanyKeyCallback) (guint key_id);
 549
 550 /* See keybindings.h */
 551 typedef struct KeybindingFuncs
 552 {
 553         void            (*keybindings_send_command) (guint group_id, guint key_id);
 554         struct GeanyKeyBinding* (*keybindings_set_item) (struct GeanyKeyGroup *group, gsize key_id,
 555                                         _GeanyKeyCallback callback, guint key, GdkModifierType mod,
 556                                         const gchar *name, const gchar *label, GtkWidget *menu_item);
 557         struct GeanyKeyBinding* (*keybindings_get_item)(struct GeanyKeyGroup *group, gsize key_id);
 558
 559 }
 560 KeybindingFuncs;
 561
 562
 563 /* See highlighting.h */
 564 typedef struct HighlightingFuncs
 565 {
 566         const struct GeanyLexerStyle* (*highlighting_get_style) (gint ft_id, gint style_id);
 567         void            (*highlighting_set_styles) (struct _ScintillaObject *sci, struct GeanyFiletype *ft);
 568         gboolean        (*highlighting_is_string_style) (gint lexer, gint style);
 569         gboolean        (*highlighting_is_comment_style) (gint lexer, gint style);
 570         gboolean        (*highlighting_is_code_style) (gint lexer, gint style);
 571 }
 572 HighlightingFuncs;
 573
 574
 575 /* See filetypes.h */
 576 typedef struct FiletypeFuncs
 577 {
 578         GeanyFiletype*  (*filetypes_detect_from_file) (const gchar *utf8_filename);
 579         GeanyFiletype*  (*filetypes_lookup_by_name) (const gchar *name);
 580         GeanyFiletype*  (*filetypes_index)(gint idx);
 581         const gchar*    (*filetypes_get_display_name)(GeanyFiletype *ft);
 582         const GSList*   (*filetypes_get_sorted_by_name)(void);
 583         /* Remember to convert any filetype_id arguments to GeanyFiletype pointers in any
 584          * appended functions */
 585 }
 586 FiletypeFuncs;
 587
 588
 589 /* See search.h */
 590 typedef struct SearchFuncs
 591 {
 592         void            (*search_show_find_in_files_dialog) (const gchar *dir);
 593 }
 594 SearchFuncs;
 595
 596
 597 /* See tagmanager/include */
 598 typedef struct TagManagerFuncs
 599 {
 600         gchar*                  (*tm_get_real_path) (const gchar *file_name);
 601         TMWorkObject*   (*tm_source_file_new) (const char *file_name, gboolean update, const char *name);
 602         gboolean                (*tm_workspace_add_object) (TMWorkObject *work_object);
 603         gboolean                (*tm_source_file_update) (TMWorkObject *source_file, gboolean force,
 604                                          gboolean recurse, gboolean update_parent);
 605         void                    (*tm_work_object_free) (gpointer work_object);
 606         gboolean                (*tm_workspace_remove_object) (TMWorkObject *w, gboolean do_free, gboolean update);
 607 }
 608 TagManagerFuncs;
 609
 610
 611 /* See navqueue.h */
 612 typedef struct NavQueueFuncs
 613 {
 614         gboolean                (*navqueue_goto_line) (struct GeanyDocument *old_doc, struct GeanyDocument *new_doc,
 615                                          gint line);
 616 }
 617 NavQueueFuncs;
 618
 619
 620 struct GeanyEditor;
 621
 622 /* See editor.h */
 623 typedef struct EditorFuncs
 624 {
 625         const struct GeanyIndentPrefs* (*editor_get_indent_prefs)(struct GeanyEditor *editor);
 626         struct _ScintillaObject* (*editor_create_widget)(struct GeanyEditor *editor);
 627
 628         void    (*editor_indicator_set_on_range) (struct GeanyEditor *editor, gint indic, gint start, gint end);
 629         void    (*editor_indicator_set_on_line) (struct GeanyEditor *editor, gint indic, gint line);
 630         void    (*editor_indicator_clear) (struct GeanyEditor *editor, gint indic);
 631
 632         void    (*editor_set_indent_type)(struct GeanyEditor *editor, GeanyIndentType type);
 633         gchar*  (*editor_get_word_at_pos) (struct GeanyEditor *editor, gint pos, const gchar *wordchars);
 634
 635         const gchar*    (*editor_get_eol_char_name) (struct GeanyEditor *editor);
 636         gint                    (*editor_get_eol_char_len) (struct GeanyEditor *editor);
 637         const gchar*    (*editor_get_eol_char) (struct GeanyEditor *editor);
 638
 639         void    (*editor_insert_text_block) (struct GeanyEditor *editor, const gchar *text,
 640                          gint insert_pos, gint cursor_index, gint newline_indent_size,
 641                          gboolean replace_newlines);
 642
 643         gint    (*editor_get_eol_char_mode) (struct GeanyEditor *editor);
 644         gboolean (*editor_goto_pos) (struct GeanyEditor *editor, gint pos, gboolean mark);
 645
 646         const gchar* (*editor_find_snippet) (struct GeanyEditor *editor, const gchar *snippet_name);
 647         void    (*editor_insert_snippet) (struct GeanyEditor *editor, gint pos, const gchar *snippet);
 648 }
 649 EditorFuncs;
 650
 651
 652 /* avoid including keybindings.h */
 653 typedef gboolean (*_GeanyKeyGroupCallback) (guint key_id);
 654
 655 /* See pluginutils.c */
 656 typedef struct PluginFuncs
 657 {
 658         void    (*plugin_add_toolbar_item)(GeanyPlugin *plugin, GtkToolItem *item);
 659         void    (*plugin_module_make_resident) (GeanyPlugin *plugin);
 660         void    (*plugin_signal_connect) (GeanyPlugin *plugin,
 661                 GObject *object, const gchar *signal_name, gboolean after,
 662                 GCallback callback, gpointer user_data);
 663         struct GeanyKeyGroup* (*plugin_set_key_group)(GeanyPlugin *plugin,
 664                 const gchar *section_name, gsize count, _GeanyKeyGroupCallback callback);
 665         void    (*plugin_show_configure)(GeanyPlugin *plugin);
 666         guint   (*plugin_timeout_add) (GeanyPlugin *plugin, guint interval, GSourceFunc function,
 667                 gpointer data);
 668         guint   (*plugin_timeout_add_seconds) (GeanyPlugin *plugin, guint interval,
 669                 GSourceFunc function, gpointer data);
 670         guint   (*plugin_idle_add) (GeanyPlugin *plugin, GSourceFunc function, gpointer data);
 671         void    (*plugin_builder_connect_signals) (GeanyPlugin *plugin, GtkBuilder *builder, gpointer user_data);
 672 }
 673 PluginFuncs;
 674
 675
 676 struct StashGroup;
 677
 678 /* See stash.h */
 679 typedef struct StashFuncs
 680 {
 681         struct StashGroup *(*stash_group_new)(const gchar *name);
 682         void (*stash_group_add_boolean)(struct StashGroup *group, gboolean *setting,
 683                         const gchar *key_name, gboolean default_value);
 684         void (*stash_group_add_integer)(struct StashGroup *group, gint *setting,
 685                         const gchar *key_name, gint default_value);
 686         void (*stash_group_add_string)(struct StashGroup *group, gchar **setting,
 687                         const gchar *key_name, const gchar *default_value);
 688         void (*stash_group_add_string_vector)(struct StashGroup *group, gchar ***setting,
 689                         const gchar *key_name, const gchar **default_value);
 690         void (*stash_group_load_from_key_file)(struct StashGroup *group, GKeyFile *keyfile);
 691         void (*stash_group_save_to_key_file)(struct StashGroup *group, GKeyFile *keyfile);
 692         void (*stash_group_free)(struct StashGroup *group);
 693         gboolean (*stash_group_load_from_file)(struct StashGroup *group, const gchar *filename);
 694         gint (*stash_group_save_to_file)(struct StashGroup *group, const gchar *filename,
 695                         GKeyFileFlags flags);
 696         void (*stash_group_add_toggle_button)(struct StashGroup *group, gboolean *setting,
 697                         const gchar *key_name, gboolean default_value, gconstpointer widget_id);
 698         void (*stash_group_add_radio_buttons)(struct StashGroup *group, gint *setting,
 699                         const gchar *key_name, gint default_value,
 700                         gconstpointer widget_id, gint enum_id, ...) G_GNUC_NULL_TERMINATED;
 701         void (*stash_group_add_spin_button_integer)(struct StashGroup *group, gint *setting,
 702                         const gchar *key_name, gint default_value, gconstpointer widget_id);
 703         void (*stash_group_add_combo_box)(struct StashGroup *group, gint *setting,
 704                         const gchar *key_name, gint default_value, gconstpointer widget_id);
 705         void (*stash_group_add_combo_box_entry)(struct StashGroup *group, gchar **setting,
 706                         const gchar *key_name, const gchar *default_value, gconstpointer widget_id);
 707         void (*stash_group_add_entry)(struct StashGroup *group, gchar **setting,
 708                         const gchar *key_name, const gchar *default_value, gconstpointer widget_id);
 709         void (*stash_group_add_widget_property)(struct StashGroup *group, gpointer setting,
 710                         const gchar *key_name, gpointer default_value, gconstpointer widget_id,
 711                         const gchar *property_name, GType type);
 712         void (*stash_group_display)(struct StashGroup *group, GtkWidget *owner);
 713         void (*stash_group_update)(struct StashGroup *group, GtkWidget *owner);
 714         void (*stash_group_free_settings)(struct StashGroup *group);
 715 }
 716 StashFuncs;
 717
 718
 719 /* See symbols.h */
 720 typedef struct SymbolsFuncs
 721 {
 722         const gchar*    (*symbols_get_context_separator)(gint ft_id);
 723 }
 724 SymbolsFuncs;
 725
 726 /* See build.h */
 727 typedef struct BuildFuncs
 728 {
 729         void (*build_activate_menu_item)(const GeanyBuildGroup grp, const guint cmd);
 730         const gchar *(*build_get_current_menu_item)(const GeanyBuildGroup grp, const guint cmd,
 731                         const GeanyBuildCmdEntries field);
 732         void (*build_remove_menu_item)(const GeanyBuildSource src, const GeanyBuildGroup grp,
 733                         const gint cmd);
 734         void (*build_set_menu_item)(const GeanyBuildSource src, const GeanyBuildGroup grp,
 735                         const guint cmd, const GeanyBuildCmdEntries field, const gchar *value);
 736         guint (*build_get_group_count)(const GeanyBuildGroup grp);
 737 }
 738 BuildFuncs;
 739
 740 /* Deprecated aliases */
 741 #ifndef GEANY_DISABLE_DEPRECATED
 742
 743 /** @deprecated - copy into your plugin code if needed.
 744  * @c NULL-safe way to get the index of @a doc_ptr in the documents array. */
 745 #define DOC_IDX(doc_ptr) \
 746         (doc_ptr ? doc_ptr->index : -1)
 747 #define DOC_IDX_VALID(doc_idx) \
 748         ((doc_idx) >= 0 && (guint)(doc_idx) < documents_array->len && documents[doc_idx]->is_valid)
 749
 750 #define GEANY_WINDOW_MINIMAL_WIDTH              550
 751 #define GEANY_WINDOW_MINIMAL_HEIGHT             GEANY_DEFAULT_DIALOG_HEIGHT
 752
 753 #endif  /* GEANY_DISABLE_DEPRECATED */
 754
 755 G_END_DECLS
 756
 757 #endif /* GEANY_PLUGIN_DATA_H */