summaryrefslogtreecommitdiffstats
path: root/src/common/profile.h
blob: 444975c02d6ddc6a9a4786860f22db98f346793d (plain)
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * This file is part of the Colobot: Gold Edition source code
 * Copyright (C) 2001-2014, Daniel Roux, EPSITEC SA & TerranovaTeam
 * http://epsiteс.ch; http://colobot.info; http://github.com/colobot
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see http://gnu.org/licenses
 */

/**
 * \file common/profile.h
 * \brief Class for loading profile (currently for loading ini config file)
 */

#pragma once

#include "common/singleton.h"

#include <boost/property_tree/ptree.hpp>
#include <boost/filesystem.hpp>
#include <boost/algorithm/string/replace.hpp>

#include <string>
#include <vector>

namespace fs = boost::filesystem;


/**
* \class CProfile
*
* \brief Class for loading profile (currently for loading ini config file)
*
*/
class CProfile : public CSingleton<CProfile>
{
public:
    CProfile();
    virtual ~CProfile();

    /** Set flag to force using ini file from current directory */
    void SetUseCurrentDirectory(bool useCurrentDirectory);

    /** Loads colobot.ini from current directory
     * \return return true on success
     */
    bool Init();

    /** Saves colobot.ini to current directory
     * \return return true on success
     */
    bool Save();

    /** Sets string value in section under specified key
     * \param section
     * \param key
     * \param value
     * \return return true on success
     */
    bool SetStringProperty(std::string section, std::string key, std::string value);

    /** Gets string value in section under specified key
     * \param section
     * \param key
     * \param buffer
     * \return return true on success
     */
    bool GetStringProperty(std::string section, std::string key, std::string& buffer);

    /** Sets int value in section under specified key
     * \param section
     * \param key
     * \param value
     * \return return true on success
     */
    bool SetIntProperty(std::string section, std::string key, int value);

    /** Gets int value in section under specified key
     * \param section
     * \param key
     * \param value
     * \return return true on success
     */
    bool GetIntProperty(std::string section, std::string key, int &value);

    /** Sets float value in section under specified key
     * \param section
     * \param key
     * \param value
     * \return return true on success
     */
    bool SetFloatProperty(std::string section, std::string key, float value);

    /** Gets float value in section under specified key
     * \param section
     * \param key
     * \param value
     * \return return true on success
     */
    bool GetFloatProperty(std::string section, std::string key, float &value);

    /** Gets all values in section under specified key
     * \param section
     * \param key
     * \return vector of values
     */
    std::vector< std::string > GetSection(std::string section, std::string key);

    /** Sets current user directory
     * \param dir
     */
    void SetUserDir(std::string dir);

    /** Returns path based on current user. Replaces %user% in path with current user dir or
     * uses default_dir param if no user dir is specified
     * \param dir
     * \param default_dir
     * \return path
     */
    std::string GetUserBasedPath(std::string dir, std::string defaultDir);

    /** Copy a file into the temporary folder.
     * \param filename
     * \return true on success
     */
    bool CopyFileToTemp(std::string filename);

private:
    boost::property_tree::ptree m_propertyTree;
    bool m_profileNeedSave;
    std::string m_userDirectory;
    bool m_useCurrentDirectory;
};

//! Global function to get profile instance
inline CProfile & GetProfile()
{
    return *CProfile::GetInstancePointer();
}