cppprojects.h 6.91 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
Eike Ziller's avatar
Eike Ziller committed
13
14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15
16
17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18
19
20
21
22
23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef CPPPROJECTPART_H
#define CPPPROJECTPART_H

#include "cpptools_global.h"

#include "cppprojectfile.h"

#include <projectexplorer/project.h>
#include <projectexplorer/toolchain.h>

#include <QPointer>
42
#include <QSet>
43

44
45
#include <functional>

46
47
48
49
namespace CppTools {

class CPPTOOLS_EXPORT ProjectPart
{
50
public: // Types
51
    enum LanguageVersion {
52
53
        C89,
        C99,
54
        C11,
55
        CXX98,
56
57
58
59
        CXX03,
        CXX11,
        CXX14,
        CXX17
60
61
    };

62
63
64
65
66
67
68
    enum LanguageExtension {
        NoExtensions         = 0,
        GnuExtensions        = 1 << 0,
        MicrosoftExtensions  = 1 << 1,
        BorlandExtensions    = 1 << 2,
        OpenMPExtensions     = 1 << 3,
        ObjectiveCExtensions = 1 << 4,
69
70

        AllExtensions = GnuExtensions | MicrosoftExtensions | BorlandExtensions | OpenMPExtensions
71
                      | ObjectiveCExtensions
72
    };
73
    Q_DECLARE_FLAGS(LanguageExtensions, LanguageExtension)
74
75
76
77
78
79
80
81

    enum QtVersion {
        UnknownQt = -1,
        NoQt = 0,
        Qt4 = 1,
        Qt5 = 2
    };

82
83
84
    typedef QSharedPointer<ProjectPart> Ptr;

    struct HeaderPath {
85
86
        enum Type { InvalidPath, IncludePath, FrameworkPath };

87
    public:
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
        QString path;
        Type type;

        HeaderPath(): type(InvalidPath) {}
        HeaderPath(const QString &path, Type type): path(path), type(type) {}

        bool isValid() const { return type != InvalidPath; }
        bool isFrameworkPath() const { return type == FrameworkPath; }

        bool operator==(const HeaderPath &other) const
        { return path == other.path && type == other.type; }

        bool operator!=(const HeaderPath &other) const
        { return !(*this == other); }
    };
    typedef QList<HeaderPath> HeaderPaths;

105
106
107
108
public: // methods
    ProjectPart();

    void evaluateToolchain(const ProjectExplorer::ToolChain *tc,
109
                           const QStringList &commandLineFlags,
110
111
112
113
                           const Utils::FileName &sysRoot);

    Ptr copy() const;

114
115
    QString id() const;

116
117
    static QByteArray readProjectConfigFile(const ProjectPart::Ptr &part);

118
public: // fields
119
120
121
122
123
124
125
126
127
    QString displayName;
    QString projectFile;
    ProjectExplorer::Project *project;
    QList<ProjectFile> files;
    QString projectConfigFile; // currently only used by the Generic Project Manager
    QByteArray projectDefines;
    QByteArray toolchainDefines;
    QList<HeaderPath> headerPaths;
    QStringList precompiledHeaders;
128
129
    LanguageVersion languageVersion;
    LanguageExtensions languageExtensions;
130
    QtVersion qtVersion;
131
    ProjectExplorer::ToolChain::WarningFlags warningFlags;
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
};

inline uint qHash(const ProjectPart::HeaderPath &key, uint seed = 0)
{ return ((qHash(key.path) << 2) | key.type) ^ seed; }

class CPPTOOLS_EXPORT ProjectInfo
{
public:
    ProjectInfo();
    ProjectInfo(QPointer<ProjectExplorer::Project> project);

    operator bool() const;
    bool isValid() const;

    QPointer<ProjectExplorer::Project> project() const;
    const QList<ProjectPart::Ptr> projectParts() const;

    void appendProjectPart(const ProjectPart::Ptr &part);
150
    void finish();
151
152
153
    void clearProjectParts();

    const ProjectPart::HeaderPaths headerPaths() const;
154
    const QSet<QString> sourceFiles() const;
155
156
157
158
159
160
161
    const QByteArray defines() const;

private:
    QPointer<ProjectExplorer::Project> m_project;
    QList<ProjectPart::Ptr> m_projectParts;
    // The members below are (re)calculated from the project parts once a part is appended.
    ProjectPart::HeaderPaths m_headerPaths;
162
    QSet<QString> m_sourceFiles;
163
164
165
    QByteArray m_defines;
};

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
class CPPTOOLS_EXPORT ProjectPartBuilder
{
public:
    ProjectPartBuilder(ProjectInfo &m_pInfo);

    void setQtVersion(ProjectPart::QtVersion qtVersion);
    void setCFlags(const QStringList &flags);
    void setCxxFlags(const QStringList &flags);
    void setDefines(const QByteArray &defines);
    void setHeaderPaths(const ProjectPart::HeaderPaths &headerPaths);
    void setIncludePaths(const QStringList &includePaths);
    void setPreCompiledHeaders(const QStringList &pchs);
    void setProjectFile(const QString &projectFile);
    void setDisplayName(const QString &displayName);
    void setConfigFileName(const QString &configFileName);

    QList<Core::Id> createProjectPartsForFiles(const QStringList &files);

private:
    void createProjectPart(const QStringList &theSources, const QString &partName,
186
187
                           ProjectPart::LanguageVersion languageVersion,
                           ProjectPart::LanguageExtensions languageExtensions);
188
189
190
191
192
193
194

private:
    ProjectPart::Ptr m_templatePart;
    ProjectInfo &m_pInfo;
    QStringList m_cFlags, m_cxxFlags;
};

195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
class CPPTOOLS_EXPORT CompilerOptionsBuilder
{
public:
    typedef std::function<bool (const QString &)> IsBlackListed;
    static QStringList createHeaderPathOptions(const ProjectPart::HeaderPaths &headerPaths,
                                               IsBlackListed isBlackListed = IsBlackListed());

    static QStringList createDefineOptions(const QByteArray &defines,
                                           bool toolchainDefines = false);

    static QStringList createLanguageOption(ProjectFile::Kind fileKind, bool objcExt);
    static QStringList createOptionsForLanguage(ProjectPart::LanguageVersion languageVersion,
                                                ProjectPart::LanguageExtensions languageExtensions,
                                                bool checkForBorlandExtensions = true);
};

211
212
213
} // namespace CppTools

#endif // CPPPROJECTPART_H