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