taskSetBuilder.h

Go to the documentation of this file.

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


#pragma once

#include <vrfLua/vrfLuaDefines.h>
#include <vlutil/vlString.h>
#include <luabind/luabind.hpp>
#include <set>
#include <vlutil/vlFilename.h>
#include <vrfutil/consoleCommandManager.h>
#include "vrftasks/vrfObjectMessageTypeTemplate.h"

class DtSimTaskFactory;
class DtSimTask;
class DtScriptedTaskManager;
class DtReaderWriter;
class DtSetDataRequest;
class DtScriptedTaskVariable;

class DT_DLL_vrfLua DtTaskSetBuilder
{
private:

   DtTaskSetBuilder();
   DtTaskSetBuilder(const DtTaskSetBuilder& orig);
   DtTaskSetBuilder& operator=(const DtTaskSetBuilder& orig);
public:
   DtTaskSetBuilder(const DtScriptedTaskManager* scriptedTaskManager);

   virtual DtSimTask* buildTask(const DtString& taskType,
      luabind::object const& parameters);

   virtual DtSetDataRequest* buildSet(const DtString& setType,
      luabind::object const& parameters);

   virtual void generateTaskSetLuaDoc(const DtFilename& outputFile);

protected:

   virtual DtReaderWriter* scriptedTaskVariableToReaderWriter(const DtScriptedTaskVariable& variable,
      luabind::object const& parameters);

   virtual bool fillInParameter(DtReaderWriter* rw, luabind::object const& parameters,
      DtString& usedParam);

   virtual DtString availableParamsString(DtReaderWriter* taskOrSet, bool longForm = false);

   virtual DtSetDataRequest* buildSetReactiveTaskEnabled(luabind::object const& parameters);

   typedef bool (*findParamFcn)(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findPropertyParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findStringParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findAnimationModelParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findIntParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findDoubleParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findBoolParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findVectorParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findOffsetVectorParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findLifeformPostureParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findLifeformWeaponStateParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findAggregateStateParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findForceTypeParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findNLengthStringVectorParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findStringListParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findEntityTypeParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   static bool findKeyValueListParam(const DtString& paramName, luabind::object const& parameters,
      DtReaderWriter* result, const DtScriptedTaskManager*);

   DtString convertToLuaSymbol(const DtString& inputString);

   virtual DtString generateRwLuaDoc(DtReaderWriter& rw);

   virtual bool cleanTaskName(DtString& taskName);

protected:
   const DtScriptedTaskManager* myScriptedTaskManager;

   typedef DtString (*printRwFcn)(DtReaderWriter* rw);

   struct RwParamInfo
   {
      RwParamInfo(findParamFcn gpf, DtString lpt, printRwFcn pvf)
         : getParamFcn(gpf), luaParamType(lpt), printValFcn(pvf) {};
      RwParamInfo() : getParamFcn(0), luaParamType(0), printValFcn(0) {};

      findParamFcn getParamFcn;
      DtString luaParamType;
      printRwFcn printValFcn;

   };

   typedef std::map<DtString, RwParamInfo> DtParamFcnMap ;
   DtParamFcnMap myFindParamFcnMap;

   std::set<DtString> myParamsIgnored;
   std::set<DtSimTaskMessageType> myIgnoredTasks;
   std::set<DtSetMessageType> myIgnoredSets;
   std::map<DtString, DtString> mySpecializedDoc;
};

class DT_DLL_vrfLua DtGenerateTaskSetLuaDocCommand : public DtConsoleCommand
{
public:

   DtGenerateTaskSetLuaDocCommand();
   virtual ~DtGenerateTaskSetLuaDocCommand();
   virtual bool execute(const DtString& arguments);
   virtual bool showInHelp() const;
   virtual DtString help(const DtString& parameters);
};