vrfPluginManager.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/

#pragma once

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

#include "vrfcgf/vrfPluginExtension.h"

class DtDynamicLibrary;
class DtVrfMessageInterface;
class DtIfPluginDataRequest;
class DtSimMessage;
class DtApplicationSettings;


#include "vrfcgf/vrfcgfDefines.h"

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

   virtual ~DtVrfPlugin();

   virtual bool init();

   virtual bool checkVersion(const DtString& curVersion);

   virtual bool initializePlugin(DtCgf*);
   virtual void initializePlugin(DtApplicationSettings&);
   virtual bool postInitializePlugin(DtCgf*);
   virtual void unloadPlugin(DtCgf*);

   const DtVrfPluginInformation& pluginInformation() const;

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

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

protected:
   DtVrfPluginInformation myPluginInformation;
   DtInitializeVrfSettingsFcn  myInitializeSettings;
   DtInitializeVrfPluginFcn  myInitializePlugin;
   DtPostInitializeVrfPluginFcn  myPostInitializePlugin;
   DtPluginInformationFcn        myPluginInformationFcn;
   DtVrfUnloadPluginFcn myUnloadPlugin;
   DtDynamicLibrary* myDynamicLibrary;
};

class DT_DLL_vrfcgf DtVrfPluginManager
{
public:
  
   DtVrfPluginManager();

   virtual ~DtVrfPluginManager();

   const std::map<DtFilename, DtVrfPlugin*>& plugins() const;

public:
   virtual bool init();

   virtual DtVrfPlugin* loadPlugin(const DtString&, DtCgf*);

   virtual DtVrfPlugin* loadPlugin(const DtString&, DtApplicationSettings&);

   virtual void postInitializePlugins(DtCgf*);

   virtual void unloadPlugins(DtCgf*);

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

   virtual void setVrfMessageInterface(DtVrfMessageInterface*);

protected:

   static void pluginInformationRequestCallback(DtSimMessage* msg, void* usr);
   virtual void processPluginInformationRequest(const DtIfPluginDataRequest& rsp);

protected:
   virtual DtVrfPlugin* loadPlugin(const DtString&);
   virtual void initializePlugin(DtVrfPlugin*, DtCgf*);
   virtual void initializePlugin(DtVrfPlugin*, DtApplicationSettings&);

protected:
   std::map<DtFilename, DtVrfPlugin*> myPlugins;
   bool                      myLoadIfVersionMismatch;
   DtVrfMessageInterface*    myVrfMessageInterface;
};

inline const std::map<DtFilename, DtVrfPlugin*>& DtVrfPluginManager::plugins() const
{
   return myPlugins;
}

inline const DtVrfPluginInformation& DtVrfPlugin::pluginInformation() const
{
   return myPluginInformation;
}

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

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