File: project_settings.h

package info (click to toggle)
codelite 17.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 136,204 kB
  • sloc: cpp: 491,547; ansic: 280,393; php: 10,259; sh: 8,930; lisp: 7,664; vhdl: 6,518; python: 6,020; lex: 4,920; yacc: 3,123; perl: 2,385; javascript: 1,715; cs: 1,193; xml: 1,110; makefile: 804; cobol: 741; sql: 709; ruby: 620; f90: 566; ada: 534; asm: 464; fortran: 350; objc: 289; tcl: 258; java: 157; erlang: 61; pascal: 51; ml: 49; awk: 44; haskell: 36
file content (151 lines) | stat: -rw-r--r-- 5,269 bytes parent folder | download | duplicates (2)
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
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright            : (C) 2008 by Eran Ifrah
// file name            : project_settings.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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef PROJECT_SETTINGS_H
#define PROJECT_SETTINGS_H

#include "build_config.h"
#include "codelite_exports.h"
#include "wx/string.h"

#include <map>

/**
 * \ingroup SDK
 * A cookie class to allow the enumration operation to be reentrants by multiple threads
 *
 * \version 1.0
 * first version
 *
 * \date 05-15-2007
 *
 * \author Eran
 *
 */
class ProjectSettingsCookie
{
public:
    std::map<wxString, BuildConfigPtr>::const_iterator iter;
};

/**
 * \ingroup SDK
 * Representation class for the project settings
 *
 * \version 1.0
 * first version
 *
 * \date 05-15-2007
 *
 * \author Eran
 *
 */
class WXDLLIMPEXP_SDK ProjectSettings : public ConfObject
{
    std::map<wxString, BuildConfigPtr> m_configs;
    BuildConfigCommonPtr m_globalSettings;
    wxString m_projectType;

public:
    /**
     * Clone this project settings, the cloned object is allocated on the heap
     * and it is the responsibility of the caller to call delete when there are no
     * more refreneces to it
     * \return
     */
    ProjectSettings* Clone() const;

    /**
     * Construct ProjectSettings object from its XML representation
     * \param node XML node of the settings object
     */
    ProjectSettings(wxXmlNode* node);

    /**
     * Destructor
     */
    virtual ~ProjectSettings();

    /**
     * Serialize the object to XML representation
     */
    wxXmlNode* ToXml() const;

    // enumaration
    /**
     * Find the first build configuration by name
     * \param configName build configuration name to find
     * \param merge merge with global settings or not
     * \return build configuration smart pointer, will be deleted automatically when no more refrences to it
     */
    BuildConfigPtr GetBuildConfiguration(const wxString& configName, bool merge = false) const;

    /**
     * enumerate through all the build build configuration, this function returns the first build configuration found
     * \param cookie an object to allow this call to be reentrant by multiple threads
     * \return build configuration smart pointer, will be deleted automatically when no more refrences to it
     */
    BuildConfigPtr GetFirstBuildConfiguration(ProjectSettingsCookie& cookie) const;
    /**
     * enumerate through all the build build configuration, this function returns the next build configuration found
     * cookie should be the same as passed to previous calls to GetFirstBuildConfiguration or
     * \param cookie an object to allow this call to be reentrant by multiple threads GetNextBuildConfiguration
     * \return build configuration smart pointer, will be deleted automatically when no more refrences to it
     */
    BuildConfigPtr GetNextBuildConfiguration(ProjectSettingsCookie& cookie) const;

    /**
     * Insert or Update BuildConfigPtr, if a build configuration with this name already exist,
     * it is replaced
     * \param bc build configuration object
     */
    void SetBuildConfiguration(const BuildConfigPtr bc);

    /**
     * Remove build configuration from the project settings. The build configuration objects stored under
     * this object are stored using smart pointers, thus if there are no more refrences to the removed build
     * configuration it will be deleted automatically
     * \param configName configuration name to remove.
     */
    void RemoveConfiguration(const wxString& configName);

    /**
     * \brief Return the global settings, common to all configurations
     */
    BuildConfigCommonPtr GetGlobalSettings() const { return m_globalSettings; }

    /**
     * \brief Set the global settings
     * \param global settings
     */
    void SetGlobalSettings(BuildConfigCommonPtr globalSettings) { m_globalSettings = globalSettings; }

    // setters/getters
    wxString GetProjectType(const wxString& confName);
    void SetProjectType(const wxString& type) { m_projectType = type; }
};

typedef SmartPtr<ProjectSettings> ProjectSettingsPtr;

#endif // PROJECT_SETTINGS_H