include/tmqt/tmPluginManager.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: tmPluginManager.h,v $ $Revision: 1.17 $ $State: Exp $
*********************************************************************/


#ifndef DTTMPLUGINMANAGER_H_
#define DTTMPLUGINMANAGER_H_

#include <QtCore/QObject>
#include <QtCore/QStringList>

#include <vector>
#include <mtl/lispEnv.h>

#include "tmqt/pluginExtension.h"

class DtTMApplication;
class DtFilename;
class DtMtlEnvironment;
class DtDynamicLibrary;

#include "tmqt/tmqtDefines.h"

class DT_DLL_tmqt DtTMPlugin
{
public:
   DtTMPlugin(const DtString &libName, 
              bool addPlatExt = true,
               bool useLazyEval = true);

   virtual ~DtTMPlugin();

   virtual bool init();
   virtual bool init(DtTMApplication*);
   virtual bool postAppInitialize(DtTMApplication*);
   virtual void unloadPlugin();

   DtTMApplication* createApplication(int argc, char** argv);

   const DtPluginInformation& pluginInformation() const;
   virtual void pluginInformation(std::string& str) const;

   virtual bool checkVersion(const QString& curVersion);

public:
   virtual bool isValid() const;
   virtual DtString libraryName() const;
   virtual const char *error() const;

protected:
   DtPluginInformation myPluginInformation;
   DtInitializePluginFcn myPluginInit;
   DtPostAppInitializeFcn myPostAppInitialize;
   DtUnloadPluginFcn myUnloadPlugin;
   DtDynamicLibrary* myDynamicLibrary;
};

class DT_DLL_tmqt DtTMPluginManager : public QObject
{
   Q_OBJECT

public:
  
   DtTMPluginManager();

   virtual ~DtTMPluginManager();

   const QList<DtTMPlugin*>& plugins() const;

   virtual DtTMPlugin* loadPlugin(const QString&, DtTMApplication* app);

   virtual void postAppInitialize(DtTMApplication*);

   void setLoadIfVersionMismatch(bool);
   bool loadIfVersionMismatch() const;

public:
   virtual bool init(const DtFilename& pluginFile, DtTMApplication* app, int argc, char** argv);

   static DtlObjPtr addMtlPlugin(const DtlObjPtr& args, const DtlObjPtr&);
   static DtTMPluginManager* create();

protected:
   virtual void readPluginsFromPluginFile(const DtString&);

   virtual void readPluginsFromCommandLine(DtTMApplication* app, int argc, char** argv);

   virtual void loadAllPlugins(DtTMApplication* app);

   virtual void initPluginVariables(DtTMApplication* app);

   virtual void unloadPlugins();

   virtual void processPluginsDirectory(const DtFilename&);

signals:
   void pluginLoaded(const DtTMPlugin*);

protected:
   QString myPluginFile;
   QList<DtTMPlugin*> myPlugins;
   DtMtlEnvironment* myMtlEnv;
   static std::vector<DtString>   thePluginsFromPluginFile;
   bool                           myLoadIfVersionMismatch;
};

inline const QList<DtTMPlugin*>& DtTMPluginManager::plugins() const
{
   return myPlugins;
}

inline const DtPluginInformation& DtTMPlugin::pluginInformation() const
{
   return myPluginInformation;
}

inline void DtTMPluginManager::setLoadIfVersionMismatch(bool b)
{
   myLoadIfVersionMismatch = b;
}

inline bool DtTMPluginManager::loadIfVersionMismatch() const
{
   return myLoadIfVersionMismatch;
}

#endif