aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/api/project.h
blob: 6e9735782aa6699bf3a8b459c56363713bd88b88 (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
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Build Suite.
**
** 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
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** 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 QBS_PROJECT_H
#define QBS_PROJECT_H

#include <buildgraph/forward_decls.h>

#include <QExplicitlySharedDataPointer>
#include <QList>
#include <QVariantMap>

QT_BEGIN_NAMESPACE
class QObject;
class QProcessEnvironment;
QT_END_NAMESPACE

namespace qbs {
class BuildJob;
class BuildOptions;
class CleanJob;
class ProductData;
class ProjectData;
class RunEnvironment;
class SetupProjectJob;

namespace Internal {
class BuildProject;
class ProjectPrivate;
} // namespace Internal;

class Project
{
    friend class SetupProjectJob;
    friend uint qHash(const Project &p);
public:
    static SetupProjectJob *setupProject(const QString &projectFilePath,
            const QVariantMap &buildConfig, const QString &buildRoot, QObject *jobOwner);

    Project(const Project &other);
    Project &operator=(const Project &other);
    ~Project();

    ProjectData projectData() const;
    QString targetExecutable(const ProductData &product) const;
    RunEnvironment getRunEnvironment(const ProductData &product,
                                     const QProcessEnvironment &environment) const;

    BuildJob *buildAllProducts(const BuildOptions &options, QObject *jobOwner = 0) const;
    BuildJob *buildSomeProducts(const QList<ProductData> &products, const BuildOptions &options,
                                QObject *jobOwner = 0) const;
    BuildJob *buildOneProduct(const ProductData &product, const BuildOptions &options,
                              QObject *jobOwner = 0) const;

    enum CleanType { CleanupAll, CleanupTemporaries };
    CleanJob *cleanAllProducts(const BuildOptions &options, CleanType cleanType,
                               QObject *jobOwner = 0) const;
    CleanJob *cleanSomeProducts(const QList<ProductData> &products, const BuildOptions &options,
                                CleanType cleanType, QObject *jobOwner = 0) const;
    CleanJob *cleanOneProduct(const ProductData &product, const BuildOptions &options,
                              CleanType cleanType, QObject *jobOwner = 0) const;

    bool operator==(const Project &other) const { return d.data() == other.d.data(); }

private:
    Project();
    Project(const Internal::BuildProjectPtr &internalProject);

    QExplicitlySharedDataPointer<Internal::ProjectPrivate> d;
};

inline bool operator!=(const Project &p1, const Project &p2) { return !(p1 == p2); }
inline uint qHash(const Project &p) { return QT_PREPEND_NAMESPACE(qHash)(p.d.data()); }

} // namespace qbs

#endif // QBS_PROJECT_H