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_PLUGINPRIVATE_H
  24 #define GEANY_PLUGINPRIVATE_H
  25
  26 #include "plugindata.h"
  27 #include "ui_utils.h"   /* GeanyAutoSeparator */
  28 #include "keybindings.h"        /* GeanyKeyGroup */
  29
  30
  31 typedef struct SignalConnection
  32 {
  33         GObject *object;
  34         gulong  handler_id;
  35 }
  36 SignalConnection;
  37
  38
  39 typedef struct GeanyPluginPrivate
  40 {
  41         GModule                 *module;
  42         gchar                   *filename;                              /* plugin filename (/path/libname.so) */
  43         PluginInfo              info;                           /* plugin name, description, etc */
  44         GeanyPlugin             public;                         /* fields the plugin can read */
  45
  46         void            (*init) (GeanyData *data);                      /* Called when the plugin is enabled */
  47         GtkWidget*      (*configure) (GtkDialog *dialog);       /* plugins configure dialog, optional */
  48         void            (*configure_single) (GtkWidget *parent); /* plugin configure dialog, optional */
  49         void            (*help) (void);                                         /* Called when the plugin should show some help, optional */
  50         void            (*cleanup) (void);                                      /* Called when the plugin is disabled or when Geany exits */
  51
  52         /* extra stuff */
  53         PluginFields    fields;
  54         GeanyKeyGroup   *key_group;
  55         GeanyAutoSeparator      toolbar_separator;
  56         GArray                  *signal_ids;                    /* SignalConnection's to disconnect when unloading */
  57         GList                   *sources;                               /* GSources to destroy when unloading */
  58 }
  59 GeanyPluginPrivate;
  60
  61 typedef GeanyPluginPrivate Plugin;      /* shorter alias */
  62
  63
  64 void plugin_watch_object(Plugin *plugin, gpointer object);
  65
  66
  67 #endif /* GEANY_PLUGINPRIVATE_H */