aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/api/project.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/api/project.h')
-rw-r--r--src/lib/api/project.h101
1 files changed, 101 insertions, 0 deletions
diff --git a/src/lib/api/project.h b/src/lib/api/project.h
new file mode 100644
index 000000000..63e957673
--- /dev/null
+++ b/src/lib/api/project.h
@@ -0,0 +1,101 @@
+/****************************************************************************
+**
+** 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 <QExplicitlySharedDataPointer>
+#include <QList>
+#include <QSharedPointer>
+#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 QSharedPointer<Internal::BuildProject> &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