shell/plugincontroller.h

   1 /* This file is part of the KDE project
   2 Copyright 2007 Andreas Pakulat <apaku@gmx.de>
   3 Copyright 2004, 2007 Alexander Dymo <adymo@kdevelop.org>
   4 Copyright 2006 Matt Rogers <mattr@kde.org
   5
   6 Based on code from Kopete
   7 Copyright (c) 2002-2003 Martijn Klingens <klingens@kde.org>
   8
   9 This library is free software; you can redistribute it and/or
  10 modify it under the terms of the GNU Library General Public
  11 License as published by the Free Software Foundation; either
  12 version 2 of the License, or (at your option) any later version.
  13
  14 This library is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 Library General Public License for more details.
  18
  19 You should have received a copy of the GNU Library General Public License
  20 along with this library; see the file COPYING.LIB.  If not, write to
  21 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22 Boston, MA 02110-1301, USA.
  23 */
  24 #ifndef KDEVPLUGINCONTROLLER_H
  25 #define KDEVPLUGINCONTROLLER_H
  26
  27
  28 #include <QtCore/QHash>
  29
  30 #include <kurl.h>
  31 #include <kservice.h>
  32 #include <kplugininfo.h>
  33 #include <kservicetypetrader.h>
  34
  35 #include <interfaces/iplugincontroller.h>
  36
  37 #include "shellexport.h"
  38
  39
  40 namespace KDevelop
  41 {
  42 class Core;
  43 class IPlugin;
  44 class ProfileEngine;
  45 class PluginControllerPrivate;
  46 /**
  47  * The KDevelop plugin controller.
  48  * The Plugin controller is responsible for querying, loading and unloading
  49  * available plugins.
  50  */
  51 class KDEVPLATFORMSHELL_EXPORT PluginController: public IPluginController
  52 {
  53
  54     Q_OBJECT
  55 friend class Core;
  56
  57 public:
  58
  59     PluginController(Core *core);
  60
  61     virtual ~PluginController();
  62
  63     /**
  64      * Get the plugin instance based on the ID. The ID should be whatever is
  65      * in X-KDE-PluginInfo-Name
  66      */
  67     IPlugin* plugin( const QString& );
  68
  69     /**
  70      * Get the plugin info for a loaded plugin
  71      */
  72     KPluginInfo pluginInfo( const IPlugin* ) const;
  73
  74     /**
  75      * Get a list of currently loaded plugins
  76      */
  77     QList<IPlugin*> loadedPlugins() const;
  78
  79     /**
  80      * Returns a uniquely specified plugin. If it isn't already loaded, it will be.
  81      * @param pluginName the name of the plugin, as given in the X-KDE-PluginInfo-Name property
  82      * @returns a pointer to the plugin instance or 0
  83      */
  84     IPlugin * loadPlugin( const QString & pluginName );
  85
  86     /**
  87      * @brief Unloads the plugin specified by @p plugin
  88      *
  89      * @param plugin The name of the plugin as specified by the
  90      * X-KDE-PluginInfo-Name key of the .desktop file for the plugin
  91      */
  92     void unloadPlugin( const QString & plugin );
  93
  94     enum PluginDeletion {
  95         Now,
  96         Later
  97     };
  98
  99     /**
 100      * Directly unload the given \a plugin, either deleting it now or \a later.
 101      *
 102      * \param plugin plugin to unload
 103      * \param later if true, delete the plugin later, if false, delete it now.
 104      */
 105     void unloadPlugin(IPlugin* plugin, PluginDeletion deletion);
 106
 107     /**
 108      * Queries for the plugin which supports given extension interface.
 109      * All already loaded plugins will be queried and the first one to support the extension interface
 110      * will be returned. Any plugin can be an extension, only "ServiceTypes=..." entry is
 111      * required in .desktop file for that plugin.
 112      * @param extension The extension interface
 113      * @param pluginname The name of the plugin to load if multiple plugins for the extension exist, corresponds to the X-KDE-PluginInfo-Name
 114      * @return A KDevelop extension plugin for given service type or 0 if no plugin supports it
 115      */
 116     IPlugin *pluginForExtension(const QString &extension, const QString &pluginname = "");
 117     IPlugin *pluginForExtension(const QString &extension, const QStringList &constraints);
 118
 119     QList<IPlugin*> allPluginsForExtension(const QString &extension, const QStringList &constraints = QStringList());
 120
 121     static KPluginInfo::List queryExtensionPlugins(const QString &extension, const QStringList &constraints);
 122
 123     /**
 124      * Reimplement this function only if your shell supports plugin profiles.
 125      * @return The list of URLs to the profile resources (files) with given @p extension.
 126      * @param nameFilter Name filter for files. @see QDir::setNameFilter documentation
 127      * for name filters syntax.
 128      */
 129     KUrl::List profileResources( const QString &nameFilter );
 130
 131     /**
 132      * Reimplement this function only if your shell supports plugin profiles.
 133      * @return The list of URLs to the resources (files) with given @p extension.
 134      * This list is obtained by a recursive search that process given profile
 135      * and all it's subprofiles.
 136      * @param nameFilter Name filter for files. @see QDir::setNameFilter documentation
 137      * for name filters syntax.
 138      */
 139     KUrl::List profileResourcesRecursive( const QString &nameFilter );
 140
 141     QString currentProfile() const;
 142
 143     void loadPlugins( PluginType offer );
 144     void unloadPlugins( PluginType offer );
 145
 146     ProfileEngine &engine() const;
 147
 148     //returns the name of an old profile that was unloaded
 149     QString changeProfile( const QString &newProfile );
 150
 151     QExtensionManager* extensionManager();
 152
 153     QStringList allPluginNames();
 154
 155     QList<ContextMenuExtension> queryPluginsForContextMenuExtensions( KDevelop::Context* context ) const;
 156
 157     QStringList projectPlugins();
 158
 159 private:
 160
 161     /**
 162      * @internal
 163      *
 164      * The internal method for loading plugins.
 165      * Called by @ref loadPlugin directly or through the queue for async plugin
 166      * loading.
 167      */
 168     IPlugin* loadPluginInternal( const QString &pluginId );
 169
 170     /**
 171      * @internal
 172      *
 173      * Find the KPluginInfo structure by key. Reduces some code duplication.
 174      *
 175      * Returns a null pointer when no plugin info is found.
 176      */
 177     KPluginInfo infoForPluginId( const QString &pluginId ) const;
 178
 179     bool checkForDependencies( const KPluginInfo& info, QStringList& missing ) const;
 180
 181     void loadDependencies( const KPluginInfo& );
 182     void loadOptionalDependencies( const KPluginInfo& info );
 183
 184     void cleanup();
 185
 186 private:
 187     class PluginControllerPrivate* const d;
 188 };
 189
 190 }
 191 #endif
 192
 193