vrfGuiPluginManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>

#include <vrvCore/DtPluginManager.h>
#include <vrfutil/vrfPluginRecordManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <vrfmsgs/ifPluginData.h>
#include <boost/signals2.hpp>
#include <boost/function.hpp>

namespace makVrv
{
   class DtDe;
   class DtVrvApplicationConfiguration;
   class DtVrvCommandLineProcessor;
}

class DtSimMessage;
class DtSimulationAddress;
class DtIfPluginData;
class DtDynamicLibrary;

namespace makVrf 
{
   class DtVrfBackendState;


   class DT_DLL_VRFGUICORE DtVrfGuiPluginManagerExt : public makVrv::DtPluginManager
   {
   public:
      DtVrfGuiPluginManagerExt(makVrv::DtDe&);

      virtual ~DtVrfGuiPluginManagerExt() override;

      virtual void initializePluginsInOrder(bool loadDefaultPlugins = true);

      makVrv::DtLibraryLoader* libraryLoader()
      {
         return myLibraryLoader;
      }

      virtual void initializeCommandLineArguments(bool loadDefaultPlugins, makVrv::DtVrvCommandLineProcessor*);

      virtual void initializePluginsToLoad(bool loadDefaultPlugins);

      typedef boost::function<bool (void)> VerifierFunction;
      virtual void addLoadVerifierFunction(const DtString&, VerifierFunction f);

   protected:
      virtual bool shouldLoadPlugin(const std::string& plugin) const;

   protected:
      bool myPluginsLoaded;
      std::list<std::string> myPlugins;
      typedef std::map<DtString, VerifierFunction> VerifierFunctions;
      VerifierFunctions myVerifierFunctions;
   };

   class DT_DLL_VRFGUICORE DtVrfGuiPluginManager : public DtVrfPluginRecordManager,
      public makVrv::DtVirtualBaseClass
   {
   public:
      typedef std::vector<DtVrfMessagePluginInformation>   PluginInformationList;
      typedef std::map<std::string, PluginInformationList> PluginInformationMap;

      static const std::string theFrontEndPluginName; 

   public:
      DtVrfGuiPluginManager(makVrv::DtDe&);
      virtual ~DtVrfGuiPluginManager() override;

      static DtVrfGuiPluginManager& instance(makVrv::DtDe& de);

      virtual void readPluginsFrom(makVrv::DtVrvApplicationConfiguration& config);

      virtual const std::vector<std::string>& additionalPluginsToLoad();
      virtual void setAdditionalPluginsToLoad(const std::vector<std::string>&);

      virtual bool loadDefaultPlugins();
      virtual void setLoadDefaultPlugins(bool);

      virtual void setPluginsDirectory(const std::string&);
      virtual const std::string& pluginsDirectory() const;

      virtual void addPluginRecord(const DtVrfPluginRecord&) override;

      virtual bool removePluginRecord(const std::string&) override;

      virtual bool renamePluginRecord(const std::string& curFileName, const std::string& newName) override;

      virtual void initializeCommandLineArguments(makVrv::DtVrvCommandLineProcessor*, bool initializeDefaultPlugins = true);

      virtual bool removePlugin(const std::string& fileName, const std::string& application,
         const std::string& platform, const std::string& configuration, const std::string& transport) override;

      virtual bool addPlugin(const std::string& fileName, const std::string& application, const std::string& platform,
         const std::string& configuration, const std::string& transport) override;

      virtual void setLoadPlugin(const std::string& fileName, bool b) override;

      const PluginInformationMap& loadedPlugins() const;

      void setVrvPluginManager(makVrv::DtPluginManager* m)
      {
         myVrvPluginManager = m;
      }

      void setCheckPluginVersions(bool);
      bool checkPluginVersions() const;

   public:
      boost::signals2::signal<void (const DtVrfPluginRecord&)> signal_pluginRecordAdded;
      boost::signals2::signal<void (const DtVrfPluginRecord&)> signal_pluginRecordRemoved;
      boost::signals2::signal<void (const std::string&, const std::string&)> signal_pluginRecordRenamed;
      boost::signals2::signal<void (const std::string&, const std::string&,
         const std::string&, const std::string&, const std::string&)> signal_pluginRemoved;
      boost::signals2::signal<void (const std::string&, const std::string&,
         const std::string&, const std::string&, const std::string&)> signal_pluginAdded;
      boost::signals2::signal<void (const std::string&, bool)> signal_pluginLoadStateChanged;

      boost::signals2::signal<void (const std::string&, const PluginInformationList&)> signal_pluginsAdded;
      boost::signals2::signal<void (const std::string&, const PluginInformationList&)> signal_pluginsRemoved;

   protected:
      virtual void initializePlugins();

      virtual void initializeFrontEndPlugins();
      virtual void initializeBackEndPlugins();

      virtual void slot_backendDiscovered(const DtVrfBackendState&);
      virtual void slot_backendRemoved(const DtVrfBackendState&);
      virtual void slot_allBackendsAboutToBeRemoved();

      virtual void processPluginData(DtSimMessage*);
      virtual void removePendingRequest(const DtVrfBackendState&);

      virtual bool checkVersion(DtDynamicLibrary* lib, const std::string& appVer) const;

      virtual std::string pluginVersion() const;

      virtual bool containsPlugin(const makVrv::DtVrvApplicationConfiguration&, const std::string&) const;

   protected:
      std::vector<std::string>   myAdditionalPluginsToLoad;

      bool                       myLoadDefaultPlugins;
      bool                       myCheckPluginVersions;
      std::string                myPluginsDirectory;
      makVrv::DtDe&              myDe;

      std::vector<std::string>   myPendingPluginRequests;

      PluginInformationMap       myPlugins;

      makVrv::DtPluginManager*   myVrvPluginManager;
   };
}