libanjuta/anjuta-plugin-manager.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * anjuta-plugin-manager.h
   4  * Copyright (C) Naba Kumar  <naba@gnome.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  19  */
  20
  21 #ifndef _ANJUTA_PLUGIN_MANAGER_H_
  22 #define _ANJUTA_PLUGIN_MANAGER_H_
  23
  24 #include <glib-object.h>
  25 #include <libanjuta/anjuta-status.h>
  26 #include <libanjuta/anjuta-plugin-description.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define ANJUTA_TYPE_PLUGIN_MANAGER             (anjuta_plugin_manager_get_type ())
  31 #define ANJUTA_PLUGIN_MANAGER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), ANJUTA_TYPE_PLUGIN_MANAGER, AnjutaPluginManager))
  32 #define ANJUTA_PLUGIN_MANAGER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), ANJUTA_TYPE_PLUGIN_MANAGER, AnjutaPluginManagerClass))
  33 #define ANJUTA_IS_PLUGIN_MANAGER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ANJUTA_TYPE_PLUGIN_MANAGER))
  34 #define ANJUTA_IS_PLUGIN_MANAGER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), ANJUTA_TYPE_PLUGIN_MANAGER))
  35 #define ANJUTA_PLUGIN_MANAGER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), ANJUTA_TYPE_PLUGIN_MANAGER, AnjutaPluginManagerClass))
  36 #define ANJUTA_PLUGIN_MANAGER_ERROR            (anjuta_plugin_manager_error_quark())
  37
  38 typedef enum
  39 {
  40         ANJUTA_PLUGIN_MANAGER_MISSING_FACTORY,
  41         ANJUTA_PLUGIN_MANAGER_ERROR_UNKNOWN
  42 } AnjutaPluginManagerError;
  43
  44
  45 typedef struct _AnjutaPluginManagerClass AnjutaPluginManagerClass;
  46 typedef struct _AnjutaPluginManager AnjutaPluginManager;
  47 typedef struct _AnjutaPluginManagerPriv AnjutaPluginManagerPriv;
  48
  49 struct _AnjutaPluginManagerClass
  50 {
  51         GObjectClass parent_class;
  52
  53         /* Signals */
  54         void(* plugin_activated) (AnjutaPluginManager *self,
  55                                                           AnjutaPluginDescription* plugin_desc,
  56                                                           GObject *plugin);
  57         void(* plugin_deactivated) (AnjutaPluginManager *self,
  58                                                                 AnjutaPluginDescription* plugin_desc,
  59                                                                 GObject *plugin);
  60 };
  61
  62 struct _AnjutaPluginManager
  63 {
  64         GObject parent_instance;
  65         AnjutaPluginManagerPriv *priv;
  66 };
  67
  68 GQuark anjuta_plugin_manager_error_quark (void);
  69 GType anjuta_plugin_manager_get_type (void) G_GNUC_CONST;
  70 AnjutaPluginManager* anjuta_plugin_manager_new (GObject *shell,
  71                                                                                                 AnjutaStatus *status,
  72                                                                                                 GList* plugin_search_paths);
  73
  74 /* Plugin activation, deactivation and retrival */
  75 GObject* anjuta_plugin_manager_get_plugin (AnjutaPluginManager *plugin_manager,
  76                                                                                    const gchar *iface_name);
  77 GObject* anjuta_plugin_manager_get_plugin_by_id (AnjutaPluginManager *plugin_manager,
  78                                                                                                  const gchar *plugin_id);
  79 gboolean anjuta_plugin_manager_unload_plugin (AnjutaPluginManager *plugin_manager,
  80                                                                                           GObject *plugin);
  81 gboolean anjuta_plugin_manager_unload_plugin_by_id (AnjutaPluginManager *plugin_manager,
  82                                                                                                         const gchar *plugin_id);
  83 GList* anjuta_plugin_manager_get_active_plugins (AnjutaPluginManager *plugin_manager);
  84 GList* anjuta_plugin_manager_get_active_plugin_objects (AnjutaPluginManager *plugin_manager);
  85
  86 /* Selection dialogs */
  87 GtkWidget* anjuta_plugin_manager_get_plugins_page (AnjutaPluginManager *plugin_manager);
  88 GtkWidget* anjuta_plugin_manager_get_remembered_plugins_page (AnjutaPluginManager *plugin_manager);
  89
  90 /* Plugin queries based on meta-data */
  91 /* Returns a list of plugin Descriptions */
  92 GList* anjuta_plugin_manager_query (AnjutaPluginManager *plugin_manager,
  93                                                                         const gchar *section_name,
  94                                                                         const gchar *attribute_name,
  95                                                                         const gchar *attribute_value,
  96                                                                         ...);
  97
  98 /* Returns the plugin description that has been selected from the list */
  99 AnjutaPluginDescription* anjuta_plugin_manager_select (AnjutaPluginManager *plugin_manager,
 100                                                                                                            gchar *title, gchar *description,
 101                                                                                                            GList *plugin_descriptions);
 102
 103 /* Returns the plugin that has been selected and activated */
 104 GObject* anjuta_plugin_manager_select_and_activate (AnjutaPluginManager *plugin_manager,
 105                                                                                                         gchar *title,
 106                                                                                                         gchar *description,
 107                                                                                                         GList *plugin_descriptions);
 108
 109 void anjuta_plugin_manager_activate_plugins (AnjutaPluginManager *plugin_manager,
 110                                                                                          GList *plugin_descs);
 111
 112 void anjuta_plugin_manager_unload_all_plugins (AnjutaPluginManager *plugin_manager);
 113
 114 gchar* anjuta_plugin_manager_get_remembered_plugins (AnjutaPluginManager *plugin_manager);
 115 void anjuta_plugin_manager_set_remembered_plugins (AnjutaPluginManager *plugin_manager,
 116                                                                                                    const gchar *remembered_plugins);
 117
 118 /**
 119  * anjuta_plugin_manager_get_interface:
 120  * @plugin_manager: A #AnjutaPluginManager object
 121  * @iface_type: The interface type implemented by the object to be found
 122  * @error: Error propagation object.
 123  *
 124  * Equivalent to anjuta_plugin_manager_get_object(), but additionally
 125  * typecasts returned object to the interface type. It also takes
 126  * interface type directly. A usage of this function is:
 127  * <programlisting>
 128  * IAnjutaDocumentManager *docman =
 129  *     anjuta_plugin_manager_get_interface (plugin_manager, IAnjutaDocumentManager, error);
 130  * </programlisting>
 131  */
 132 #define anjuta_plugin_manager_get_interface(plugin_manager, iface_type, error) \
 133         (((iface_type*) anjuta_plugin_manager_get_plugin((plugin_manager), #iface_type, (error)))
 134
 135 G_END_DECLS
 136
 137 #endif /* _ANJUTA_PLUGIN_MANAGER_H_ */