appPathResolver.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2020 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrfutil/vrfutilDefines.h"

#include "vlutil/vlString.h"
#include "vlutil/vlFilename.h"

#include <string>

namespace makVrf
{
   class DT_DLL_vrfutil DtAppPathResolver
   {
   public:
      static DtAppPathResolver& Instance();

      void setDataPath(const DtFilename& dataPath);
      void setAppDataPath(const DtFilename& appDataPath);
      void setUserDataPath(const DtFilename& userDataPath);
      void setMakLuaPath(const DtFilename& makLuaPath);

      DtFilename dataPath();
      DtFilename appDataPath();
      DtFilename userDataPath();

      void setAdditionalModelDefinitionPaths(const std::vector<DtFilename>&);
      const std::vector<DtFilename>& additionalModelDefinitionPaths() const;

      std::vector<DtString> environmentVariables(const DtString& path) const;

      virtual DtString resolvePath(const DtString& path) const;
      virtual std::string resolvePathStdString(const std::string& path) const;

      virtual DtString markupPath(const DtString& path) const;
      virtual std::string markupPathStdString(const std::string& path) const;

      virtual void setSharedSettingsDirectory(const DtFilename&);

      virtual DtFilename sharedSettingsDirectory();
      virtual DtFilename sharedSettingsDirectory(const DtString& appName);

      virtual void setUseSharedSettingsDirectory(bool);
      virtual bool useSharedSettingsDirectory() const;

      virtual DtFilename settingsDirectoryPathFor(const DtString&, bool andSetupFiles = true);

      virtual DtFilename settingsDirectory();

      virtual DtFilename connectionsSettingsDirectory();

      virtual void setUserSettingsDirectory(const DtFilename&);
      virtual const DtFilename& userSettingsDirectory();

      virtual DtFilename resolveSettingsFile(const DtFilename&);

      virtual DtFilename backupsPath();

      virtual void setApplication(const DtString&);

      virtual const DtString& application() const;

      virtual void setVersionString(const DtString& version);
      virtual const DtString& versionString() const;

      virtual void setApplicationRootName(const DtString&);
      virtual const DtString& applicationRootName() const;

      virtual void setupUserSettingsDirectory(const DtFilename& userSettings, const DtFilename& rootPath, bool copyIfDateIsLater = true);

      virtual void setCopyIfDateIsLater(bool);
      bool copyIfDateIsLater() const
      {
         return myCopyIfDateIsLater;
      }

      virtual DtFilename sharedDataPath() const;
      virtual void setSharedDataPath(const DtFilename& path);

      virtual DtFilename sharedDataRoot() const;
      virtual void setSharedDataRoot(const DtFilename& path);

      virtual DtString sharedDataStem() const;
      virtual void setSharedDataStem(const DtString& path);

      virtual const DtFilename& rawTerrainPath() const;

      virtual DtFilename terrainPath() const;
      virtual void setTerrainPath(const DtFilename& path);

      virtual DtString convertQuickIcon(const DtString&) const;

      virtual DtString markupTerrainDirectory(const DtString& orig) const;

      virtual std::string replaceEnvironmentVariables(const std::string& path) const;
      virtual std::string nativePath(const std::string& rawPath) const;
      virtual void replaceAll(std::string& searchText,const std::string& stringToFind, const std::string& stringToReplace) const;

   protected:
      virtual void setupSharedDataPath();

   protected:
      DtAppPathResolver();

      DtFilename myDataPath;
      DtFilename myAppDataPath;
      DtFilename myUserDataPath;
      DtFilename myMakLuaPath;
      DtFilename mySharedSettingsDirectory;
      DtFilename myUserSettingsDirectory;
      DtFilename mySharedDataRoot;
      DtFilename mySharedDataPath;
      DtFilename myTerrainPath;
      DtString mySharedDataStem;
      DtString myApplicationRootName;
      bool myUseSharedSettingsDirectory;
      DtString myApplicationName;
      bool myNeedsToSetupSettingsDirectory;
      std::vector<DtFilename> myAdditonalModelDefinitionPaths;
      bool myUserSetSettingsDirectory;
      bool myCopyIfDateIsLater;
      DtString myVersionString;
   };
}