File: CMakeSettingsManager.h

package info (click to toggle)
codelite 12.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 95,112 kB
  • sloc: cpp: 424,040; ansic: 18,284; php: 9,569; lex: 4,186; yacc: 2,820; python: 2,294; sh: 312; makefile: 51; xml: 13
file content (226 lines) | stat: -rw-r--r-- 7,015 bytes parent folder | download | duplicates (5)
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright            : (C) 2014 Eran Ifrah
// file name            : CMakeSettingsManager.h
//
// -------------------------------------------------------------------------
// A
//              _____           _      _     _ _
//             /  __ \         | |    | |   (_) |
//             | /  \/ ___   __| | ___| |    _| |_ ___
//             | |    / _ \ / _  |/ _ \ |   | | __/ _ )
//             | \__/\ (_) | (_| |  __/ |___| | ||  __/
//              \____/\___/ \__,_|\___\_____/_|\__\___|
//
//                                                  F i l e
//
//    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 2 of the License, or
//    (at your option) any later version.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////

/* ************************************************************************ */
/*                                                                          */
/* CMakePlugin for Codelite                                                 */
/* Copyright (C) 2013 Jiří Fatka <ntsfka@gmail.com>                         */
/*                                                                          */
/* 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/>.     */
/*                                                                          */
/* ************************************************************************ */

#ifndef CMAKE_SETTINGS_MANAGER_H_
#define CMAKE_SETTINGS_MANAGER_H_

/* ************************************************************************ */
/* INCLUDES                                                                 */
/* ************************************************************************ */

// C++
#include <map>

// wxWidgets
#include <wx/string.h>
#include <wx/scopedptr.h>

// CMakePlugin
#include "CMakeProjectSettings.h"

/* ************************************************************************ */
/* FORWARD DECLARATIONS                                                     */
/* ************************************************************************ */

class CMakePlugin;

/* ************************************************************************ */
/* CLASSES                                                                  */
/* ************************************************************************ */

/**
 * @brief Manager for CMake projects settings.
 *
 * Configuration is stored in JSON format:
 * [
 *   { name: "Debug", enabled: true, ...}
 *   { name: "Release", enabled: true, ...}
 * ]
 */
class CMakeSettingsManager
{

// Public Ctors
public:


    /**
     * @brief Create settings manager.
     *
     * @param plugin
     */
    explicit CMakeSettingsManager(CMakePlugin* plugin);


// Public Accessors
public:


    /**
     * @brief Returns all project configurations.
     *
     * @param project Project name.
     * @param create  If not exists, create one.
     *
     * @return A pointer to project settings for specific config or
     * nullptr if config doesn't exists.
     */
    CMakeProjectSettingsMap* GetProjectSettings(const wxString& project,
                                                bool create = false);


    /**
     * @brief Returns all project configurations.
     *
     * @param project Project name.
     *
     * @return A pointer to project settings for specific config or
     * nullptr if config doesn't exists.
     */
    const CMakeProjectSettingsMap* GetProjectSettings(const wxString& project) const;


    /**
     * @brief Return project configuration for given config.
     *
     * @param project Project name.
     * @param config  Configuration name.
     * @param create  If not exists, create one.
     *
     * @return A pointer to project settings for specific config or
     * nullptr if config doesn't exists.
     */
    CMakeProjectSettings* GetProjectSettings(const wxString& project,
                                             const wxString& config,
                                             bool create = false);


    /**
     * @brief Return project configuration for given config.
     *
     * @param project Project name.
     * @param config  Configuration name.
     *
     * @return A pointer to project settings for specific config or
     * nullptr if config doesn't exists.
     */
    const CMakeProjectSettings* GetProjectSettings(const wxString& project,
                                                   const wxString& config) const;


    /**
     * @brief Returns if project settings exists and are use CMake.
     *
     * @param project Project name.
     * @param config  Configuration name.
     *
     * @return
     */
    bool IsProjectEnabled(const wxString& project, const wxString& config) const;


// Public Operations
public:


    /**
     * @brief Save all settings.
     */
    inline void Save() {
        SaveProjects();
    }


    /**
     * @brief Save all projects settings.
     */
    void SaveProjects();


    /**
     * @brief Save project settings.
     *
     * @param name Project name.
     */
    void SaveProject(const wxString& name);


    /**
     * @brief Load all settings.
     */
    inline void Load() {
        LoadProjects();
    }


    /**
     * @brief Load all projects settings.
     */
    void LoadProjects();


    /**
     * @brief Load project settings.
     *
     * @param name Project name.
     */
    void LoadProject(const wxString& name);


// Private Data Members
private:


    /// CMake plugin pointer.
    CMakePlugin* const m_plugin;

    /// Settings for all projects.
    std::map<wxString, CMakeProjectSettingsMap> m_projectSettings;

};

/* ************************************************************************ */

#endif // CMAKE_SETTINGS_MANAGER_H_