Source/Utils/Folders.hpp

   1 /*
   2 Copyright (C) 2003, 2010 - Wolfire Games
   3 Copyright (C) 2010-2017 - Lugaru contributors (see AUTHORS file)
   4
   5 This file is part of Lugaru.
   6
   7 Lugaru is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 Lugaru is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Lugaru.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _FOLDERS_HPP_
  22 #define _FOLDERS_HPP_
  23
  24 #include <string>
  25
  26 #ifndef DATA_DIR
  27 #define DATA_DIR "Data"
  28 #endif
  29
  30 struct FileNotFoundException : public std::exception
  31 {
  32     std::string errorText;
  33
  34     FileNotFoundException(const std::string& filename)
  35         : errorText(filename + " could not be found")
  36     {
  37     }
  38
  39     const char* what() const throw()
  40     {
  41         return errorText.c_str();
  42     }
  43 };
  44
  45 class Folders
  46 {
  47     static const std::string dataDir;
  48
  49 public:
  50     /** Returns path to the screenshot directory. Creates it if needed. */
  51     static std::string getScreenshotDir();
  52
  53     /** Returns full path for user data */
  54     static std::string getUserDataPath();
  55
  56     /** Returns full path for config file */
  57     static std::string getConfigFilePath();
  58
  59     static FILE* openMandatoryFile(const std::string& filename, const char* mode);
  60
  61     static bool file_exists(const std::string& filepath);
  62
  63     /* Returns full path for a game resource */
  64     static inline std::string getResourcePath(const std::string& filepath)
  65     {
  66         return dataDir + '/' + filepath;
  67     }
  68
  69     /** Returns full path for user progress save */
  70     static inline std::string getUserSavePath()
  71     {
  72         return getUserDataPath() + "/users";
  73     }
  74
  75     static bool makeDirectory(const std::string& path);
  76
  77 private:
  78     static const char* getHomeDirectory();
  79     static std::string getGenericDirectory(const char* ENVVAR, const std::string& fallback);
  80 };
  81
  82 #endif /* _FOLDERS_H_ */