Gamedev Framework (gf)  0.7.0
A C++14 framework for 2D games
Paths.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2018 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_PATHS_H
22 #define GF_PATHS_H
23 
24 #include "Path.h"
25 #include "Portability.h"
26 #include "StringRef.h"
27 
28 namespace gf {
29 #ifndef DOXYGEN_SHOULD_SKIP_THIS
30 inline namespace v1 {
31 #endif
32 
39  struct GF_API Paths {
43  Paths() = delete;
44 
55  static Path getPrefPath(StringRef org, StringRef app);
56 
63  static Path getBasePath();
64 
70  static Path getCurrentPath();
71 
72  };
73 
74 #ifndef DOXYGEN_SHOULD_SKIP_THIS
75 }
76 #endif
77 }
78 
79 #endif // GF_PATHS_H
Special paths.
Definition: Paths.h:39
The namespace for gf classes.
Definition: Action.h:34
boost::filesystem::path Path
A path in the filesystem.
Definition: Path.h:41
A constant reference to a string and its size.
Definition: StringRef.h:41