scriptEditor.h

Go to the documentation of this file.

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



#pragma once

#include <vrvUtil/signalslib.h>
#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vlutil/vlFilename.h>
#include <vrftasks/vrfObjectMessageTypeTemplate.h>

#include <QObject>
#include <QDateTime>
#include <QtCore/QProcess>

namespace makVrv
{
   class DtDe;
}

class DtSimMessage;
class QProcess;
class DtScriptedTaskMetaData;

namespace makVrf
{
   class DT_DLL_VRFGUICOREQT DtScriptEditor : public QObject, public makVrv::DtVirtualBaseClass
   {
      Q_OBJECT

   public:
      DtScriptEditor(makVrv::DtDe&, const std::string& tmpDir = "scripts");

      virtual ~DtScriptEditor();

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

      virtual void edit(const std::string&, int scriptType, const std::string& commentBlock = "");

      virtual void editNew(const std::string& id, int sType, const std::string& script, const std::string& scriptEngine,
         const std::string& commentBlock = "");

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

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

      virtual bool alreadyEditing(const std::string& id) const;

      virtual void editExternalScript(const std::string& filename);

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

      boost::signal<void (const std::string&, const std::string&)> signal_scriptModified;

      boost::signal<void (const std::string&)> signal_editingComplete;

   protected:
      virtual void slot_scriptSaveError(std::string scriptId);

      virtual void receivedScript(DtSimMessage*);

      virtual void slot_aboutToClearScriptedTasks();
      virtual void slot_scriptedTaskAboutToBeRemoved(std::string scriptId);

      virtual void editScript(const std::string& id, int sType, const std::string& script,
         const std::string& scriptEngine = "lua", bool readOnly = false,
         bool localOnly = false, bool scriptIsFilename = false,
         const std::string& commentBlock = "");

      virtual void tick();

      virtual void checkNeedsUpdate(const std::string& filename);

      virtual void scriptBeingRemoved();

      virtual void slot_scriptedTaskAdded(std::string);

      virtual void editingComplete(QProcess*);

      virtual bool checkForScriptErrors(const DtScriptedTaskMetaData&) const;

      virtual std::string cleanUpError(const std::string&) const;

   protected slots:
      virtual void editingComplete(int, QProcess::ExitStatus);
      virtual void startupError(QProcess::ProcessError);

   protected:
      makVrv::DtDe& myDe;

      struct PendingRequest
      {
         DtGenericMessageType scriptid;
         bool viewOnly;
         bool localOnly;
         bool editingFile;
         std::string commentBlock;
         int scriptType;
         std::string userData;
      };

      std::map<DtU32, PendingRequest> myPendingRequests;

      struct FileInfo
      {
         QProcess* editingProcess;
         QDateTime lastModified;
         DtGenericMessageType scriptId;
         bool readOnly;
         bool localOnly;
         bool alreadyRunning;
         bool editingFile;
         std::string scriptEditor;
         int retries;
         bool isSystemScript;
      };

      typedef std::map<std::string, FileInfo> FileInfoMap;
      FileInfoMap myFileInfoMap;

      makVrv::DtSignalConnectionManager myConnections;

      DtFilename myTempDirectory;

      std::set<std::string> myHasScriptFor;
   };
}