vrfScriptedTaskManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfutil/vrfScriptedTasksConstants.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <vrvCore/DtUniqueID.h>
#include <vrfutil/scriptedTaskMetaData.h>
#include <vlpi/simulationAddress.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrftasks/vrfObjectMessageTypeTemplate.h>
#include <vrvUtil/DtUnicode.h>

#include <boost/function.hpp>

class DtSimMessage;
class DtScenarioExplorer;

class QWidget;

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DtVrfBackendState;

   class DT_DLL_VRFGUICORE DtVrfScriptedTaskManager : public makVrv::DtVirtualBaseClass
   {
   public:
      typedef std::map<int, makVrv::DtUnicode> ScriptedTaskTypeNames;
      typedef std::map<bool, std::string> IconType;
      typedef std::map<int, std::string> DoctrinesByForce;

      struct ScriptedTaskDialogInformation
      {
         makVrv::DtUnicode name;
         IconType icon;
      };

      typedef std::map<int, ScriptedTaskDialogInformation> ScriptedTaskTypeInformation;

      struct ScenarioSystemPair
      {
         ScenarioSystemPair() : scenarioScript(0), systemScript(0) {};
         ScenarioSystemPair(DtScriptedTaskMetaData* sc, DtScriptedTaskMetaData* sy) : scenarioScript(sc), systemScript(sy) {};

         DtScriptedTaskMetaData* scenarioScript;
         DtScriptedTaskMetaData* systemScript;
         std::string scriptError;                
         bool modified;
      };

      typedef std::map<std::string, ScenarioSystemPair> ScriptedTasks;
      typedef std::pair<std::string, bool> ActionCategory;
      typedef std::set<std::string> Doctrines;
      typedef std::map<std::string, ActionCategory> ActionCategories;

      struct PreservedScript
      {
         DtScriptedTaskMetaData scriptedTask;
         std::string scriptError;
      };

      typedef std::map<std::string, PreservedScript> PreservedScripts;

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

      static DtVrfScriptedTaskManager& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe&, DtVrfScriptedTaskManager*);

      virtual void clear(bool andSetting = true, bool reset = true, bool signal = true);

      virtual void removeScriptedTaskMetaData(const std::string& scriptedTaskId, bool signal = true);

      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const DtSimTaskMessageType& scriptId, bool system) const;
      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const DtSetMessageType& scriptId, bool system) const;
      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const std::string& scriptId, bool system) const;
      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const DtGenericMessageType& scriptId, bool system) const;

      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const DtSimTaskMessageType& scriptId) const;
      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const DtSetMessageType& scriptId) const;
      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const DtGenericMessageType& scriptId) const;
      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const std::string& scriptId) const;

      virtual bool doesNotHaveSMSLoaded(const DtScenarioExplorer&) const;

      virtual void addScriptedTaskMetaDataToScenario(const DtScriptedTaskMetaData&, bool addScript = false, bool addLayout = false);

      virtual void duplicateScriptedTaskMetaDataToScenario(const DtScriptedTaskMetaData&, const std::string& sourceId);

      virtual void updateScriptedTaskMetaDataToScenario(const DtScriptedTaskMetaData&, const std::string& originalId = "");

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

      virtual void addScriptedTaskMetaData(const DtScriptedTaskMetaData&, bool signal = true);

      virtual void requestScriptedTasks(const std::vector<std::string>& scripts = std::vector<std::string>());

      virtual void loadScripts(const DtScenarioExplorer& explorer);

      virtual bool isSystemScript(const DtSimTaskMessageType&) const;
      virtual bool isSystemScript(const DtSetMessageType&) const;
      virtual bool isSystemScript(const std::string&) const;

      virtual bool hasSystemScript(const DtSimTaskMessageType&) const;
      virtual bool hasSystemScript(const DtSetMessageType&) const;
      virtual bool hasSystemScript(const std::string&) const;

      virtual bool appearsOnMenu(const std::string&) const;

      virtual bool appearsOnToolbar(const std::string&) const;

      virtual bool systemScriptAvailable(const std::string&) const;

      virtual void setSystemScriptAvailable(const std::string& id, bool);

      virtual void removeSystemScript(const std::string& id, bool signal = true);

      virtual const ScriptedTasks& scriptedTaskMetaData() const;

      virtual std::string remapMenuPath(std::string originalPath) const;
      
      virtual bool hasScriptedTaskMetaData(const DtSimTaskMessageType&) const;
      virtual bool hasScriptedTaskMetaData(const DtSetMessageType&) const;
      virtual bool hasScriptedTaskMetaData(const std::string&) const;

      virtual bool hasScenarioScriptedTaskMetaData(const DtSimTaskMessageType&) const;
      virtual bool hasScenarioScriptedTaskMetaData(const DtSetMessageType&) const;
      virtual bool hasScenarioScriptedTaskMetaData(const std::string&) const;

      virtual bool hasSystemScriptedTaskMetaData(const DtSimTaskMessageType&) const;
      virtual bool hasSystemScriptedTaskMetaData(const DtSetMessageType&) const;
      virtual bool hasSystemScriptedTaskMetaData(const std::string&) const;

      virtual bool hasDoctrine(const std::string&) const;

      virtual std::string uniqueScriptIdFrom(const std::string&, int scriptType,
         std::set<std::string> additionalToCheck = std::set<std::string>()) const;

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

      virtual void assignScriptError(const std::string& scriptId, const std::string& error);

      virtual void clearScriptError(const std::string& scriptId);

      virtual bool scriptHasError(const std::string& scriptId, std::string* error = 0) const;

      virtual bool scriptIsModified(const std::string& scriptId) const;

      virtual void setScriptModified(const std::string& scriptId, bool);

      virtual void clearModifiedScripts();

      virtual void setScript(const std::string& scriptId, const std::string& script, bool setAsModified = true);

      virtual void setUiLayout(const std::string& scriptId, const std::string& uiLayout, bool setAsModified = true, bool sendUpdate = true);

      virtual bool hasModifiedScripts() const;

      virtual void preserveModifiedScripts();

      virtual void restorePreservedScripts();

      virtual int mapScriptToAction(const DtScriptedTaskMetaData& script, bool addIfMissing = true);
      virtual int mapScriptToAction(const std::string& scriptId) const;

      virtual void unmapScript(const DtScriptedTaskMetaData&);

      virtual void setMonitorFrameRates(const std::string& scriptId, bool monitor);

      virtual const ActionCategories& actionCategories() const;

      virtual const Doctrines& doctrines() const;

      virtual void requestScriptsIfNeeded();

      virtual void addScriptedTaskType(int, const makVrv::DtUnicode& name);
      virtual void addScriptedTaskTypeIcon(int, bool isSystemIcon, const std::string&);
      virtual makVrv::DtUnicode getScriptedTaskTypeName(int) const;
      virtual std::string getScriptedTaskTypeIcon(int, bool isSystemScrript) const;
      virtual ScriptedTaskTypeNames getScriptedTaskTypes() const;
      virtual void removeScriptedTaskType(int);

      virtual DtSimTaskMessageType remapScriptId(const DtSimTaskMessageType& scriptId) const;
      virtual DtSetMessageType remapScriptId(const DtSetMessageType& scriptId) const;
      virtual std::string remapScriptId(const std::string& scriptId) const;

      virtual std::vector<DtSimTaskMessageType> scriptedTasksValidFor(const DtEntityType&, int force = -1) const;

      virtual std::vector<DtSetMessageType> scriptedSetsValidFor(const DtEntityType&, int force = -1) const;

      virtual std::vector<DtSimTaskMessageType> reactiveTasksValidFor(const DtEntityType&, int force = -1) const;

      virtual std::vector<DtSimTaskMessageType> backgroundProcessesValidFor(const DtEntityType&, int force = -1) const;

      virtual std::vector<DtSimTaskMessageType> scriptedTasksValidFor(makVrv::DtUniqueID) const;

      virtual std::vector<DtSimTaskMessageType> reactiveTasksValidFor(makVrv::DtUniqueID) const;

      virtual std::vector<DtSimTaskMessageType> backgroundProcessesValidFor(makVrv::DtUniqueID) const;
      
      virtual std::vector<std::string> scriptsValidFor(const DtEntityType&, int scriptType, int force = -1) const;
      
      virtual std::vector<std::string> scriptsValidFor(int scriptType) const;

      virtual std::vector<std::string> scriptsThatSupportDoctrine(const std::string&) const;

      virtual int scriptedTaskTypeFor(const makVrv::DtUnicode&) const;

      virtual std::string formatScript(const std::string& script, int scriptType, const std::string& commentBlock) const;

      const DoctrinesByForce& doctrinesByForce() const
      {
         return myDoctrinesByForce;
      }

      virtual const std::set<DtString>& scriptedTasksToShowOnTopLevelRightClickMenu() const;

      virtual std::string doctrineForForce(int) const;

      virtual void removeUiLayout(const std::string& scriptId, bool removeFromBackEnd = true);

      virtual bool scriptsLoaded() const;

      virtual bool activeRequest() const;

   protected:
      virtual std::string language() const;

      virtual void receiveScriptedTaskChecksums(DtSimMessage* msg);

      virtual void receiveScriptedTaskList(DtSimMessage* msg);

      virtual void receiveActionCategories(DtSimMessage* msg);

      virtual void receiveDoctrines(DtSimMessage* msg);

      virtual void processDoctrinesOperation(DtSimMessage* msg);

      virtual void receivedScriptedTaskUpdateMessage(DtSimMessage* msg);

      virtual void slot_backendRemoved(const DtVrfBackendState&);

      virtual void scriptIdChanged(const std::string& oldId, const std::string& newId);

      virtual std::string addPrefixOrSuffix(int type, const DtString& scriptdId) const;

   public:
      boost::signals2::signal<void (std::string)> signal_scriptSaveError;
      boost::signals2::signal<void ()> signal_scriptedTaskManagerAboutToChange;
      boost::signals2::signal<void ()> signal_aboutToClearScriptedTasks;
      boost::signals2::signal<void (std::string)> signal_scriptedTaskAboutToBeRemoved;
      boost::signals2::signal<void (std::string)> signal_scriptedTaskAdded;
      boost::signals2::signal<void ()> signal_receivedScriptedTasks;
      boost::signals2::signal<void (int)> signal_scriptedTaskTypeAdded;
      boost::signals2::signal<void (int)> signal_scriptedTaskTypeRemoved;
      boost::signals2::signal<void ()> signal_doctrinesReceived;

      boost::signals2::signal<void (std::string, bool, std::string)> signal_scriptErrorChange;

      boost::signals2::signal<void (std::string, bool)> signal_scriptModified;

      boost::signals2::signal<void ()> signal_scriptModifiedCleared;

      boost::signals2::signal<void (int, std::string)> signal_scriptRemovedFromTaskMenu;

      boost::signals2::signal<void (int, std::string)> signal_scriptRemovedFromSetMenu;

      boost::signals2::signal<void (int, std::string)> signal_scriptAddedToTaskMenu;

      boost::signals2::signal<void (int, std::string)> signal_scriptAddedToSetMenu;

      boost::signals2::signal<void (int, std::string)> signal_assignedDoctrineChanged;

      boost::signals2::signal<void (std::string, std::string, int)> signal_scriptIdChanged;

   protected:
      virtual void addToCreatorFactory(const DtScriptedTaskMetaData& md);
      virtual void removeFromFactory(const DtScriptedTaskMetaData& script);

   protected:
      makVrv::DtDe& myDe;
      makVrv::DtSignalConnectionManager myConnectionManager;
      ScriptedTasks myScriptedTasks;
      PreservedScripts myPreservedScripts;

      unsigned int myRequestId;

      typedef std::map<std::string, int> ScriptIdToActionIdMap;
      ScriptIdToActionIdMap myScriptIdToActionIdMap;

      DtSimulationAddress myScriptMonitorAddress;
      std::map<std::string, int> myMonitoring;

      ActionCategories myActionCategories;
      Doctrines myDoctrines;
      bool myRequestScriptsIfNeeded;

      bool myRequestScriptChecksums;

      ScriptedTaskTypeInformation myScriptedTaskTypeInformation;

      DoctrinesByForce myDoctrinesByForce;

      std::set<DtString> myScriptsToShowOnTopLevelRightClickMenu;

      std::map<std::string, bool> myWaitingToBeModified;
      std::map<std::string, std::string> myScriptIdToScriptIdMap;
      bool myScriptsLoaded;
      bool myNewContentAdded;

      std::set<DtFilename> mySMSLoaded;
   };
}