src/pluginprivate.h

   1 /*
   2  *      pluginprivate.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2009-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   5  *      Copyright 2009-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   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 #ifndef GEANY_PLUGIN_PRIVATE_H
  24 #define GEANY_PLUGIN_PRIVATE_H 1
  25
  26 #include "plugindata.h"
  27 #include "ui_utils.h"   /* GeanyAutoSeparator */
  28 #include "keybindings.h"        /* GeanyKeyGroup */
  29
  30 #include "gtkcompat.h"
  31
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct SignalConnection
  36 {
  37         GObject *object;
  38         gulong  handler_id;
  39 }
  40 SignalConnection;
  41
  42 typedef enum _LoadedFlags {
  43         LOADED_OK = 0x01,
  44         IS_LEGACY = 0x02,
  45         LOAD_DATA = 0x04,
  46 }
  47 LoadedFlags;
  48
  49 typedef struct GeanyPluginPrivate Plugin;       /* shorter alias */
  50
  51 typedef struct GeanyPluginPrivate
  52 {
  53         gchar                   *filename;                              /* plugin filename (/path/libname.so) */
  54         PluginInfo              info;                           /* plugin name, description, etc */
  55         GeanyPlugin             public;                         /* fields the plugin can read */
  56
  57         GeanyPluginFuncs cbs;                                   /* Callbacks set by geany_plugin_register() */
  58         void            (*configure_single) (GtkWidget *parent); /* plugin configure dialog, optional and deprecated */
  59
  60         /* extra stuff */
  61         PluginFields    fields;
  62         GeanyKeyGroup   *key_group;
  63         GeanyAutoSeparator      toolbar_separator;
  64         GArray                  *signal_ids;                    /* SignalConnection's to disconnect when unloading */
  65         GList                   *sources;                               /* GSources to destroy when unloading */
  66
  67         gpointer                cb_data;                                /* user data passed back to functions in GeanyPluginFuncs */
  68         GDestroyNotify  cb_data_destroy;                /* called when the plugin is unloaded, for cb_data */
  69         LoadedFlags             flags;                                  /* bit-or of LoadedFlags */
  70
  71         /* proxy plugin support */
  72         GeanyProxyFuncs proxy_cbs;
  73         Plugin                  *proxy;                                 /* The proxy that handles this plugin */
  74         gpointer                proxy_data;                             /* Data passed to the proxy hooks of above proxy, so
  75                                                                                          * this gives the proxy a pointer to each plugin */
  76         gint                    proxied_count;                  /* count of active plugins this provides a proxy for
  77                                                                                          * (a count because of possibly nested proxies) */
  78 }
  79 GeanyPluginPrivate;
  80
  81 #define PLUGIN_LOADED_OK(p) (((p)->flags & LOADED_OK) != 0)
  82 #define PLUGIN_IS_LEGACY(p) (((p)->flags & IS_LEGACY) != 0)
  83 #define PLUGIN_HAS_LOAD_DATA(p) (((p)->flags & LOAD_DATA) != 0)
  84
  85 void plugin_watch_object(Plugin *plugin, gpointer object);
  86 void plugin_make_resident(Plugin *plugin);
  87 gpointer plugin_get_module_symbol(Plugin *plugin, const gchar *sym);
  88
  89 G_END_DECLS
  90
  91 #endif /* GEANY_PLUGIN_PRIVATE_H */