File indexing completed on 2024-04-21 15:08:23

 //
 // C++ Interface: cpluginmanager
 //
 // Description: plug-in manager
 //
 /*
 Copyright 2006-2011 Tomas Mecir <kmuddy@kmuddy.com>
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License as
 published by the Free Software Foundation; either version 2 of 
 the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef CPLUGINMANAGER_H
 #define CPLUGINMANAGER_H
 
 
 #include <cactionbase.h>
 #include <kmuddy_export.h>
 
 #include <qobject.h>
 #include <qstringlist.h>
 #include <map>
 
 #include <KConfigGroup>
 #include <KPluginMetaData>
 
 using namespace std;
 
 class cPlugin;
 class cTextChunk;
 class QDialog;
 class KPluginWidget;
 
 /**
 Plug-in manager handles plug-in information, loads plug-ins, and passes data/events to them as needed.
 
 @author Tomas Mecir
 */
 
 class KMUDDY_EXPORT cPluginManager : public QObject, public cActionBase
 {
 Q_OBJECT
  public:
   ~cPluginManager () override;
 
   static cPluginManager *self();
 
   /** load a plug-in into memory, if possible */
   bool loadPlugin (const QString &name);
   /** unload a plug-in from memory, if possible */
   bool unloadPlugin (const QString &name);
   bool isLoaded (const QString &name);
 
   /** list of plug-ins that should not be loaded - from preferences */
   void setConfigGroup (const KConfigGroup &group) { pluginConfig = group; }
   
   /** Load all available plug-ins expect those that should not be loaded.
   This ensures that all newly installed plug-ins get loaded initially. */
   void loadAll ();
   /** unload all plug-ins that are currently loaded, but are to be disabled */
   void unloadUnwanted ();
   /** unload all plug-ins */
   void unloadAll ();
 
 public slots:
   /** show the Plugins dialog */
   void showPluginsDialog ();
   
 protected slots:
   /** apply settings from the plugins dialog */
   void applyPluginDialog ();
   void closeDialog();
   
 protected:
   cPluginManager ();
   
   static cPluginManager *_self;
 
   void eventIntHandler (QString event, int session, int par1, int par2) override;
   void eventStringHandler (QString event, int session, QString &par1, const QString &par2) override;
   void eventNothingHandler (QString event, int session) override;
   void eventChunkHandler (QString event, int session, cTextChunk *par) override;
   
   void findPlugins ();
   
   void passSessionAdd (int sess);
   void passSessionRemove (int sess);
   void passSessionSwitch (int sess);
   void passConnected (int sess);
   void passDisconnected (int sess);
   void passSave (int sess);
   void passRawData (int sess, char *);
   void passDecompressedData (int sess, char *);
   void passInput (int sess, int phase, cTextChunk *chunk, bool gagged);
   void passPrompt (int sess, cTextChunk *chunk);
   void passCommand (int sess, QString &command);
   
   map<QString, KPluginMetaData> pluginInfo;
   map<QString, cPlugin *> loadedPlugins;
   /** plug-ins sorted by priority */
   multimap<int, cPlugin *> plugins;
   /** iterator, it's not a local variable, so that passing data to plug-ins is a bit faster :) */
   multimap<int, cPlugin *>::iterator it;
   KConfigGroup pluginConfig;
   /** existing sessions */
   map<int, bool> sessions;
   /** active session */
   int activeSess;
   bool lastGagged;
 
   QDialog *pluginDialog;
   KPluginWidget *pluginSelector;
 };
 
 #endif