PathUtils.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* The Base of this class has been adopted from the Delta3D engine
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Class Inspired by the Delta3D Engine
* http://delta3dengine.org/
*
* @author David Guthrie
* @author John K. Grant
* @author William E. Johnson II
* @author Chris Osborn
* @author Maxim Serebrennik
*/
#pragma once

#include <trUtil/Export.h>

#include <trUtil/PlatformMacros.h>
#include <trUtil/RefStr.h>

#include <string>
#include <vector>


namespace trUtil::PathUtils
{
#ifdef TR_APPLE
    const static std::string DEFAULT_TR_FOLDER("/TrueReality");
#elif defined(TR_WIN)
    const static std::string DEFAULT_TR_FOLDER("\\TrueReality");
#else
    const static std::string DEFAULT_TR_FOLDER("/.trueReality");
#endif
    const static std::string DATA_PATH_DEFAULT("/Data");
    const static std::string STATIC_MESHES_PATH("/StaticMeshes");
    const static std::string SKELETAL_MESHES_PATH("/SkeletalMeshes");
    const static std::string SOUNDS_PATH("/Sounds");
    const static std::string PARTICLES_PATH("/Particles");
    const static std::string TEXTURES_PATH("/Textures");
    const static std::string TERRAINS_PATH("/Terrains");
    const static std::string SHADERS_PATH("/Shaders");
    const static std::string GUI_PATH("/GUI");
    const static std::string CONFIG_PATH("/Config");

    TR_UTIL_EXPORT std::string GetUserHomeDirectory();

    TR_UTIL_EXPORT std::string GetUserDataPath();

    TR_UTIL_EXPORT std::string GetStaticMeshesPath();

    TR_UTIL_EXPORT std::string GetSkeletalMeshesPath();

    TR_UTIL_EXPORT std::string GetSoundsPath();

    TR_UTIL_EXPORT std::string GetParticlesPath();

    TR_UTIL_EXPORT std::string GetTexturesPath();

    TR_UTIL_EXPORT std::string GetTerrainsPath();

    TR_UTIL_EXPORT std::string GetShadersPath();

    TR_UTIL_EXPORT std::string GetGUIPath();

    TR_UTIL_EXPORT std::string GetConfigPath();

    TR_UTIL_EXPORT std::string GetUserStaticMeshesPath();

    TR_UTIL_EXPORT std::string GetUserSkeletalMeshesPath();

    TR_UTIL_EXPORT std::string GetUserSoundsPath();

    TR_UTIL_EXPORT std::string GetUserParticlesPath();

    TR_UTIL_EXPORT std::string GetUserTexturesPath();

    TR_UTIL_EXPORT std::string GetUserTerrainsPath();

    TR_UTIL_EXPORT std::string GetUserShadersPath();

    TR_UTIL_EXPORT std::string GetUserGUIPath();

    TR_UTIL_EXPORT std::string GetUserConfigPath();

    TR_UTIL_EXPORT std::string GetLogPath();

    TR_UTIL_EXPORT void SetDataFilePathList(const std::string& pathList);

    TR_UTIL_EXPORT std::string GetDataFilePathList();

    TR_UTIL_EXPORT std::string GetDataPath();

    TR_UTIL_EXPORT void SetDataPath(std::string& path);

    TR_UTIL_EXPORT void CreateDataPathTree();

    TR_UTIL_EXPORT void CreateUserDataPathTree();

    TR_UTIL_EXPORT void CreateDataPathTrees();

    TR_UTIL_EXPORT std::string GetRootPath();

    TR_UTIL_EXPORT std::string GetEnvironment(const std::string& env);

    TR_UTIL_EXPORT bool IsEnvironment(const std::string& env);

    TR_UTIL_EXPORT void SetEnvironment(const std::string& name, const std::string& value);

    TR_UTIL_EXPORT std::string FindFile(const std::string& fileName);

    TR_UTIL_EXPORT std::string FindFile(const std::string& fileName, std::vector<std::string> paths, bool caseInsensitive = true);

#ifdef TR_APPLE

    std::string GetBundleResourcesPath();

    std::string GetBundlePlugInsPath();

    std::string GetBundlePath();

    void RemovePSNCommandLineOption(int& argc, char**& argv);
#else

    inline void RemovePSNCommandLineOption(int& /*argc*/, char**& /*argv*/) {}
#endif
}