]> git.jsancho.org Git - lugaru.git/blob - Source/Utils/Folders.h
Improve formatting of devtools docs
[lugaru.git] / Source / Utils / Folders.h
1 /*
2 Copyright (C) 2003, 2010 - Wolfire Games
3 Copyright (C) 2010-2016 - 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_H_
22 #define _FOLDERS_H_
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     FileNotFoundException (const std::string& filename) {
34         errorText = filename + " could not be found";
35     }
36
37     const char * what () const throw () {
38         return errorText.c_str();
39     }
40 };
41
42 class Folders
43 {
44     static const std::string dataDir;
45
46 public:
47     /* Returns path to the screenshot directory. Creates it if needed. */
48     static std::string getScreenshotDir();
49
50     /* Returns full path for a game resource */
51     static std::string getResourcePath(std::string filepath);
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(std::string filename, const char* mode);
60
61 private:
62     static const char* getHomeDirectory();
63     static std::string getGenericDirectory(const char* ENVVAR, const std::string fallback);
64     static bool makeDirectory(std::string path);
65 };
66
67 #endif /* _FOLDERS_H_ */