DtDeSettings.h

Go to the documentation of this file.

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

#pragma once


#include <vrvCore/vrvCore.h>

#include <vrvUtil/DtVrvFilesystem.h>
#include <vrvUtil/DtDeError.h>
#include <makArchives/DtElementsRecord.h>

#include <vrvCore/DtDe.h>

#include <string>

#define DT_DE_SETTINGS_USE_BINARY_FILES 0

namespace makVrv
{

   class DT_DLL_VRVCORE DtDeSettings
   {
   public:


      virtual ~DtDeSettings();

   private:
      DtDeSettings(const DtDeSettings& copy);
      DtDeSettings();
      DtDeSettings& operator=(const DtDeSettings&);

   public:
      const std::string& name() const;

      const std::string& extension() const;

      template <typename RecordType>
      bool readDefaultRecord(RecordType& r);

      template <typename RecordType>
      bool readDefaultRecordAndName(RecordType& r, std::string& fName);

      template <typename RecordType>
      bool readBackupRecord(RecordType& r);

      template <typename RecordType>
      bool readFactoryDefaultRecord(RecordType& r) const;

      template <typename RecordType>
      bool writeDefaultRecord(const RecordType& r);

      template <typename RecordType>
      bool writeBackupRecord(const RecordType& r);

      template <typename RecordType>
      bool readRecordsFrom(std::map<std::string, RecordType>& r, const std::string& importFileName);

      template <typename RecordType>
      bool readRecordFrom(RecordType& r, const std::string& importFileName) const;

      template <typename RecordType>
      bool readRecordFromBinary(RecordType& r, const std::string& importFileName);

      template <typename RecordType>
      bool writeRecordTo(const RecordType& r, const std::string& exportFileName) const;

      template <typename RecordType>
      bool writeRecordToBinary(const RecordType& r, const std::string& exportFileName) const;

      inline void setAutoSave(bool b)
      {
         myAutoSave = b;
      }

      inline bool autoSave() const
      {
         return myAutoSave;
      }

      bool defaultFileExists() const;
      virtual std::string defaultFilePath() const;

      bool defaultBinaryFileExists() const;
      virtual std::string defaultBinaryFilePath() const;


      bool factoryFileExists() const;
      virtual std::string factoryFilePath() const;

      bool backupFileExists() const;
      virtual std::string backupFilePath() const;

      static std::string binaryFileExtension(void);

      bool defaultDirExists() const;
      virtual std::string defaultDirPath() const;

      bool factoryDirExists() const;
      virtual std::string factoryDirPath() const;

      bool backupDirExists() const;
      virtual std::string backupDirPath() const;

      bool mergedFilesExist() const;
      virtual const std::vector<std::string>& mergedFiles() const;
      virtual void addMergedFile(std::string fileName);

      bool entityElementDefinitionDirExists() const;
      virtual std::string entityElementDefinitionDirPath() const;

      bool tacticalGraphicsElementDefinitionDirExists() const;
      virtual std::string tacticalGraphicsElementDefinitionDirPath() const;

      bool unitElementDefinitionDirExists() const;
      virtual std::string unitElementDefinitionDirPath() const;

      template <typename RecordType>
      bool readDefaultRecords(std::map<std::string, RecordType>& recordMap);

      template <typename RecordType>
      bool readRecordFromFile(RecordType& record,
         const std::string& importFileName);

      template <typename RecordType>
      bool readRecordsFromDir(std::map<std::string, RecordType>& recordMap,
         const std::string& importDirName);

   protected:

      friend class DtDeSettingsManager;

      DtDeSettings(DtDe& de, const std::string& name, const std::string& ext);

   protected:

      DtDe& myDe;
      std::string myName;
      std::string myExtension;
      bool myAutoSave;
      std::vector<std::string> myMergedFiles;

      static const std::string myBinaryFileExtension;

   };

}

#define DtDeSettings_INL_
#include <vrvCore/DtDeSettings.inl>
#undef DtDeSettings_INL_