vrfConfigurationFileComposer.h

Go to the documentation of this file.

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


#pragma once

#include "vrfcontrol/vrfcontrolDefines.h"
#include <vlutil/vlFilename.h>
#include <vlutil/vlHashlist.h>
#include <vlutil/vlHashKeys.h>
#include <vlutil/vlList.h>
#include <vl/hostStructs.h>
#include "vrfutil/addressMap.h"
#include "vrfcontrol/vrfFileParser.h"
#include "vrfutil/scenario.h"
#include "vrfutil/backendMap.h"


class DT_DLL_vrfcontrol DtVrfConfigurationFileComposer
{
public:

   DtVrfConfigurationFileComposer();

   virtual ~DtVrfConfigurationFileComposer();

   virtual bool init();
   
   virtual bool readObjectMap(const DtFilename& objectMap);   
   virtual bool readObjectMapFromZipFile(const DtFilename& scenarioZipFile, const DtFilename& objectMap);   

   virtual std::set<DtSimulationAddress> scenarioBackends() const;

   virtual DtBackendMap* backendMap();
   
   virtual DtAddressMap* objectMap();
   
   virtual bool composeOrderOfBattleFile(
      const DtFilename& targetFileName, const DtList& files, DtString& sError, void* zf = 0);

   virtual bool saveOrderOfBattleToZipFile(
      const DtFilename& targetFileName, const DtList& files, DtString& sError, void* zf = 0);

   virtual bool saveOrderOfBattleToFile(
      const DtFilename& targetFileName, const DtList& files, DtString& sError);

   virtual bool composeScenarioScriptsFile(
      const DtFilename& targetFileName, const DtString& files, void* zf = 0);

   virtual bool composeOrbatFile(
      const DtFilename& targetFileName, const DtString& files, void* zf = 0);

   virtual bool composePlanFile(
      const DtFilename& targetFileName, const DtList& files, void* zf = 0);

   virtual bool composeHostilityFile(
      const DtFilename& targetFileName, const DtList& files, void* zf = 0);

   virtual bool composeScenarioExtrasFile(
      const DtFilename& targetFileName, const DtList& files, void* zf = 0);
 

   virtual bool createMapFile(
      const DtFilename& targetFileName, 
      const DtList& simAddresses, const DtList& oobFiles,
      const DtList& planFiles,
      bool preserveMappings = true, void* zf = 0);

   std::vector<DtFilename>& customComponentAttachmentFilenames();
   const std::vector<DtFilename>& customComponentAttachmentFilenames() const;
   virtual bool decompose(const DtFilename& orderOfBattle, 
      const DtFilename& plan, const DtFilename& globalPlan, bool& hasGlobalWeatherObject,
      bool& hasGlobalDynamicTerrainObject);
   virtual bool decomposeFromZipFile(const DtFilename& scenarioZipFile, const DtFilename& orderOfBattle, 
      const DtFilename& plan, const DtFilename& globalPlan, bool& hasGlobalWeatherObject,
      bool& hasGlobalDynamicTerrainObject);

   virtual bool decomposeScenarioScriptsFile(const DtFilename&);
   virtual bool decomposeScenarioScriptsFromZipFile(const DtFilename& scenarioZipFile, const DtFilename& scriptsFile);

   virtual bool decomposeOrbatFile(const DtFilename&);
   virtual bool decomposeOrbatFromZipFile(const DtFilename& scenarioZipFile, const DtFilename& orbatFile);

   virtual bool decomposeComponentAttachmentFile(const DtFilename& originalFile,
      unsigned numBackends);

   virtual DtFilename* getOrderOfBattleFile(
      const DtSimulationAddress& addr) const;
   virtual DtFilename* getScenarioScriptsFile(const DtSimulationAddress& addr) const;
   virtual DtFilename* getOrbatFile(const DtSimulationAddress& addr) const;
   virtual DtFilename* getPlanFile(
      const DtSimulationAddress& addr) const;
   virtual DtFilename* getGlobalPlanFile(const DtSimulationAddress& addr) const;

   virtual const DtFilename& getComponentAttachmentFile(unsigned idx) const;

   virtual const DtFilename& tempDirectory();
   virtual void setTempDirectory(const DtFilename& f);

   virtual void setFilePrefix(const DtString&);
   virtual const DtString& filePrefix() const;

protected:
   virtual bool storeFileInZipFile(void* zf, const DtFilename& sourceFile, const DtFilename& destFile);
   virtual bool storeStringInZipFile(void* zf, const DtString&, const DtFilename& target);

protected:

   virtual void clear();
   virtual bool createBackendFiles(
      const DtFilename& origFileName, 
      DtHashList& createdFiles, const char* prefix = "(\n",
      bool* hasGlobalWeatherObject = 0, bool* hasGlobalDynamicTerrainObject = 0);
   virtual bool createBackendFilesFromZip(const DtFilename& zipFile,
      const DtFilename& origFileName, 
      DtHashList& createdFiles, const char* prefix = "(\n", 
      bool* hasGlobalWeatherObject = 0, bool* hasGlobalDynamicTerrainObject = 0);
   virtual bool finalizeBackendFilesParse(const DtFilename& origFileName,
      DtHashlist& createdFiles, const char* prefix,
      bool* hasGlobalWeatherObject, bool* hasGlobalDynamicTerrainObject = 0);

   virtual bool composePlanFileBody(FILE* fp, const DtList& files);
   virtual bool composePlanFileBody(DtString& fp, const DtList& files);

   virtual bool fastProcess(const DtFilename& fullname, FILE* fp, DtString* returnBuffer, int& size);

   virtual bool fastProcessPlanFileBody(const DtFilename& fullname, FILE* fp, DtString* returnBuffer, int& size);

protected:
   DtBackendMap* myBackendMap;
   DtAddressMap* myObjectMap;
   DtAddressMap* myOriginalObjectMap;
   DtVrfFileParser myParser;
   DtHashlist myAddr2FileMap;
   DtHashlist myCreatedPlnFiles;
   DtHashlist myCreatedOobFiles;
   DtHashlist myCreatedGlobalPlanFiles;
   DtHashlist myCreatedHostilityFiles;
   std::vector<DtFilename> myCreatedComponentAttachmentFiles;
   DtFilename myTempDirectory;
   DtList myRequiredBackendAddrs;
   DtFilename* myScenarioScriptsFile;
   DtFilename* myOrbatFile;
   DtString myFilePrefix;

   static DtUUID theUnknownMappingName;
};

inline std::vector<DtFilename>& DtVrfConfigurationFileComposer::customComponentAttachmentFilenames()
{
   return (myCreatedComponentAttachmentFiles);
}

inline const std::vector<DtFilename>& DtVrfConfigurationFileComposer::customComponentAttachmentFilenames() const
{
   return (myCreatedComponentAttachmentFiles);
}