summaryrefslogtreecommitdiffstats
path: root/src/common/profile.h
blob: facb414ac45bed8139124bea5bd4f434a46612b5 (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
// * This file is part of the COLOBOT source code
// * Copyright (C) 2001-2008, Daniel ROUX & EPSITEC SA, www.epsitec.ch
// *
// * 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://www.gnu.org/licenses/.

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

#pragma once

#include <boost/property_tree/ptree.hpp>

#include "common/singleton.h"

#include <string>
#include <vector>


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

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

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

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

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

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

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

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

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

    private:
        boost::property_tree::ptree m_propertyTree;
        bool m_profileNeedSave;
};

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