File: windowspath.hpp

package info (click to toggle)
openmw 0.49.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,992 kB
  • sloc: cpp: 372,479; xml: 2,149; sh: 1,403; python: 797; makefile: 26
file content (79 lines) | stat: -rw-r--r-- 1,905 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#ifndef COMPONENTS_FILES_WINDOWSPATH_HPP
#define COMPONENTS_FILES_WINDOWSPATH_HPP

#if defined(_WIN32) || defined(__WINDOWS__)

#include <filesystem>

/**
 * \namespace Files
 */
namespace Files
{

    /**
     * \struct WindowsPath
     */
    struct WindowsPath
    {
        /**
         * \brief WindowsPath constructor.
         *
         * \param [in] application_name - The name of the application.
         */
        WindowsPath(const std::string& application_name);

        /**
         * \brief Returns user path i.e.:
         * "X:\Documents And Settings\<User name>\My Documents\My Games\"
         *
         * \return std::filesystem::path
         */
        std::filesystem::path getUserConfigPath() const;

        std::filesystem::path getUserDataPath() const;

        /**
         * \brief Returns "X:\Program Files\"
         *
         * \return std::filesystem::path
         */
        std::filesystem::path getGlobalConfigPath() const;

        /**
         * \brief Return local path which is a location where
         * an application was started
         *
         * \return std::filesystem::path
         */
        std::filesystem::path getLocalPath() const;

        /**
         * \brief
         *
         * \return std::filesystem::path
         */
        std::filesystem::path getCachePath() const;

        /**
         * \brief Return same path like getGlobalPath
         *
         * \return std::filesystem::path
         */
        std::filesystem::path getGlobalDataPath() const;

        /**
         * \brief Gets the path of the installed Morrowind version if there is one.
         *
         * \return std::filesystem::path
         */
        std::filesystem::path getInstallPath() const;

        std::string mName;
    };

} /* namespace Files */

#endif /* defined(_WIN32) || defined(__WINDOWS__) */

#endif /* COMPONENTS_FILES_WINDOWSPATH_HPP */