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 224
  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 (71 << 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 /** @deprecated - use plugin_set_key_group() instead.
 161  * @see PLUGIN_KEY_GROUP() macro. */
 162 typedef struct GeanyKeyGroupInfo
 163 {
 164         const gchar *name;              /**< Group name used in the configuration file, such as @c "html_chars" */
 165         gsize count;                    /**< The number of keybindings the group will hold */
 166 }
 167 GeanyKeyGroupInfo;
 168
 169 /** @deprecated - use plugin_set_key_group() instead.
 170  * Declare and initialise a keybinding group.
 171  * @code GeanyKeyGroup *plugin_key_group; @endcode
 172  * You must then set the @c plugin_key_group::keys[] entries for the group in plugin_init(),
 173  * normally using keybindings_set_item().
 174  * The @c plugin_key_group::label field is set by Geany after @c plugin_init()
 175  * is called, to the name of the plugin.
 176  * @param group_name A unique group name (without quotes) to be used in the
 177  * configuration file, such as @c html_chars.
 178  * @param key_count     The number of keybindings the group will hold. */
 179 #define PLUGIN_KEY_GROUP(group_name, key_count) \
 180         /* We have to declare this as a single element array.
 181          * Declaring as a pointer to a struct doesn't work with g_module_symbol(). */ \
 182         GeanyKeyGroupInfo plugin_key_group_info[1] = \
 183         { \
 184                 {G_STRINGIFY(group_name), key_count} \
 185         };\
 186         GeanyKeyGroup *plugin_key_group = NULL;
 187
 188
 189 /** Callback array entry type used with the @ref plugin_callbacks symbol. */
 190 typedef struct PluginCallback
 191 {
 192         /** The name of signal, must be an existing signal. For a list of available signals,
 193          *  please see the @link pluginsignals.c Signal documentation @endlink. */
 194         const gchar     *signal_name;
 195         /** A callback function which is called when the signal is emitted. */
 196         GCallback       callback;
 197         /** Set to TRUE to connect your handler with g_signal_connect_after(). */
 198         gboolean        after;
 199         /** The user data passed to the signal handler. */
 200         gpointer        user_data;
 201 }
 202 PluginCallback;
 203
 204
 205 /** @deprecated Use @ref ui_add_document_sensitive() instead.
 206  * Flags to be set by plugins in PluginFields struct. */
 207 typedef enum
 208 {
 209         /** Whether a plugin's menu item should be disabled when there are no open documents */
 210         PLUGIN_IS_DOCUMENT_SENSITIVE    = 1 << 0
 211 }
 212 PluginFlags;
 213
 214 /** @deprecated Use @ref ui_add_document_sensitive() instead.
 215  * Fields set and owned by the plugin. */
 216 typedef struct PluginFields
 217 {
 218         /** Bitmask of @c PluginFlags. */
 219         PluginFlags     flags;
 220         /** Pointer to a plugin's menu item which will be automatically enabled/disabled when there
 221          *  are no open documents and @c PLUGIN_IS_DOCUMENT_SENSITIVE is set.
 222          *  This is required if using @c PLUGIN_IS_DOCUMENT_SENSITIVE, ignored otherwise */
 223         GtkWidget       *menu_item;
 224 }
 225 PluginFields;
 226
 227
 228 /** This contains pointers to global variables owned by Geany for plugins to use.
 229  * Core variable pointers can be appended when needed by plugin authors, if appropriate. */
 230 typedef struct GeanyData
 231 {
 232         struct GeanyApp                         *app;                           /**< Geany application data fields */
 233         struct GeanyMainWidgets         *main_widgets;          /**< Important widgets in the main window */
 234         GPtrArray                                       *documents_array;       /**< See document.h#documents_array. */
 235         GPtrArray                                       *filetypes_array;       /**< Dynamic array of GeanyFiletype pointers */
 236         struct GeanyPrefs                       *prefs;                         /**< General settings */
 237         struct GeanyInterfacePrefs      *interface_prefs;       /**< Interface settings */
 238         struct GeanyToolbarPrefs        *toolbar_prefs;         /**< Toolbar settings */
 239         struct GeanyEditorPrefs         *editor_prefs;          /**< Editor settings */
 240         struct GeanyFilePrefs           *file_prefs;            /**< File-related settings */
 241         struct GeanySearchPrefs         *search_prefs;          /**< Search-related settings */
 242         struct GeanyToolPrefs           *tool_prefs;            /**< Tool settings */
 243         struct GeanyTemplatePrefs       *template_prefs;        /**< Template settings */
 244         struct GeanyBuildInfo           *build_info;            /**< Current build information */
 245         GSList                                          *filetypes_by_title; /**< See filetypes.h#filetypes_by_title. */
 246 }
 247 GeanyData;
 248
 249 #define geany                   geany_data      /**< Simple macro for @c geany_data that reduces typing. */
 250
 251
 252 #ifndef GEANY_PRIVATE
 253
 254 /* Prototypes for building plugins with -Wmissing-prototypes
 255  * Also allows the compiler to check if the signature of the plugin's
 256  * symbol properly matches what we expect. */
 257 gint plugin_version_check(gint abi_ver);
 258 void plugin_set_info(PluginInfo *info);
 259
 260 void plugin_init(GeanyData *data);
 261 GtkWidget *plugin_configure(GtkDialog *dialog);
 262 void plugin_configure_single(GtkWidget *parent);
 263 void plugin_help(void);
 264 void plugin_cleanup(void);
 265
 266 #endif
 267
 268 /* Deprecated aliases */
 269 #ifndef GEANY_DISABLE_DEPRECATED
 270
 271 /* This remains so that older plugins that contain a `GeanyFunctions *geany_functions;`
 272  * variable in their plugin - as was previously required - will still compile
 273  * without changes.  */
 274 typedef struct GeanyFunctionsUndefined GeanyFunctions;
 275
 276 #define document_reload_file document_reload_force
 277
 278 /** @deprecated - copy into your plugin code if needed.
 279  * @c NULL-safe way to get the index of @a doc_ptr in the documents array. */
 280 #define DOC_IDX(doc_ptr) \
 281         (doc_ptr ? doc_ptr->index : -1)
 282 #define DOC_IDX_VALID(doc_idx) \
 283         ((doc_idx) >= 0 && (guint)(doc_idx) < documents_array->len && documents[doc_idx]->is_valid)
 284
 285 #define GEANY_WINDOW_MINIMAL_WIDTH              550
 286 #define GEANY_WINDOW_MINIMAL_HEIGHT             GEANY_DEFAULT_DIALOG_HEIGHT
 287
 288 #endif  /* GEANY_DISABLE_DEPRECATED */
 289
 290 G_END_DECLS
 291
 292 #endif /* GEANY_PLUGIN_DATA_H */