aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/projectexplorer/project.h
blob: 9a8c7bf0cbe962504176ec9e4c285428f422e11b (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
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
/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.3, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/

#ifndef PROJECT_H
#define PROJECT_H

#include "persistentsettings.h"
#include "projectexplorer_export.h"
#include "buildconfiguration.h"
#include "environment.h"
#include "projectnodes.h"

#include <QtCore/QSharedPointer>
#include <QtCore/QObject>
#include <QtCore/QModelIndex>
#include <QtCore/QFileInfo>
#include <QtGui/QFileSystemModel>
#include <QtGui/QMenu>
#include <QtGui/QIcon>

namespace Core {
class IFile;
}

namespace ProjectExplorer {

class BuildManager;
class BuildStep;
class BuildStepConfigWidget;
class IProjectManager;
class RunConfiguration;
class EditorConfiguration;

class PROJECTEXPLORER_EXPORT Project
    : public QObject
{
    Q_OBJECT

public:
    // Roles to be implemented by all models that are exported via model()
    enum ModelRoles {
        // Absolute file path
        FilePathRole = QFileSystemModel::FilePathRole
    };

    Project();
    virtual ~Project();

    virtual QString name() const = 0;
    virtual Core::IFile *file() const = 0;
    virtual IProjectManager *projectManager() const = 0;

    virtual QList<Project *> dependsOn() = 0; //NBS TODO implement dependsOn

    virtual bool isApplication() const = 0;

    // Build/Clean Step functions
    QList<BuildStep *> buildSteps() const;
    void insertBuildStep(int position, BuildStep *step);
    void removeBuildStep(int position);
    void moveBuildStepUp(int position);

    QList<BuildStep *> cleanSteps() const;
    void insertCleanStep(int position, BuildStep *step);
    void removeCleanStep(int position);

    // Build configuration
    void addBuildConfiguration(const QString &name);
    void removeBuildConfiguration(const QString  &name);
    void copyBuildConfiguration(const QString &source, const QString &dest);
    QStringList buildConfigurations() const;
    QString displayNameFor(const QString &buildConfiguration);
    void setDisplayNameFor(const QString &buildConfiguration, const QString &displayName);

    QString activeBuildConfiguration() const;
    void setActiveBuildConfiguration(const QString& config);

    void setValue(const QString &name, const QVariant &value);
    QVariant value(const QString &name) const;

    void setValue(const QString &buildConfiguration, const QString &name, const QVariant &value);
    QVariant value(const QString &buildConfiguration, const QString &name) const;

    // Running
    QList<QSharedPointer<RunConfiguration> > runConfigurations() const;
    void addRunConfiguration(QSharedPointer<RunConfiguration> runConfiguration);
    void removeRunConfiguration(QSharedPointer<RunConfiguration> runConfiguration);

    QSharedPointer<RunConfiguration> activeRunConfiguration() const;
    void setActiveRunConfiguration(QSharedPointer<RunConfiguration> runConfiguration);

    EditorConfiguration *editorConfiguration() const;

    virtual Environment environment(const QString &buildConfiguration) const = 0;
    virtual QString buildDirectory(const QString &buildConfiguration) const = 0;

    void saveSettings();
    void restoreSettings();

    virtual BuildStepConfigWidget *createConfigWidget() = 0;
    virtual QList<BuildStepConfigWidget*> subConfigWidgets();

    /* This method is called for new build configurations. You should probably
     * set some default values in this method.
     */
    virtual void newBuildConfiguration(const QString &buildConfiguration) = 0;

    virtual ProjectNode *rootProjectNode() const = 0;

    enum FilesMode { AllFiles, ExcludeGeneratedFiles };
    virtual QStringList files(FilesMode fileMode) const = 0;

signals:
    void fileListChanged();
    void activeBuildConfigurationChanged();
    void activeRunConfigurationChanged();
    // This signal is jut there for updating the tree list in the buildsettings wizard
    void buildConfigurationDisplayNameChanged(const QString &buildConfiguraiton);

protected:
    /* This method is called when the project .user file is saved. Simply call
     * writer.saveValue() for each value you want to save. Make sure to always
     * call your base class implementation.
     *
     * Note: All the values from the project/buildsteps and buildconfigurations
     * are automatically stored.
     */
    virtual void saveSettingsImpl(PersistentSettingsWriter &writer);

    /* This method is called when the project is opened. You can retrieve all
     * the values you saved in saveSettingsImpl() in this method.
     *
     * Note: This function is also called if there is no .user file. You should
     * probably add some default build and run settings to the project so that
     * it can be build and run.
     */
    virtual void restoreSettingsImpl(PersistentSettingsReader &reader);

private:
    BuildConfiguration *getBuildConfiguration(const QString & name) const;

    QList<BuildStep *> m_buildSteps;
    QList<BuildStep *> m_cleanSteps;
    QStringList m_buildConfigurations;
    QMap<QString, QVariant> m_values;
    QList<BuildConfiguration *> m_buildConfigurationValues;
    QString m_activeBuildConfiguration;
    QList<QSharedPointer<RunConfiguration> > m_runConfigurations;
    QSharedPointer<RunConfiguration> m_activeRunConfiguration;
    EditorConfiguration *m_editorConfiguration;
};

} // namespace ProjectExplorer

#endif // PROJECT_H