1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of Qbs.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 #ifndef QBS_INSTALLOPTIONS_H
40 #define QBS_INSTALLOPTIONS_H
41 
42 #include "qbs_export.h"
43 
44 #include <QtCore/qshareddata.h>
45 
46 QT_BEGIN_NAMESPACE
47 class QJsonObject;
48 class QString;
49 QT_END_NAMESPACE
50 
51 namespace qbs {
52 class InstallOptions;
53 namespace Internal {
54 class InstallOptionsPrivate;
55 class TopLevelProject;
56 QString effectiveInstallRoot(const InstallOptions &options, const TopLevelProject *project);
57 }
58 
59 class QBS_EXPORT InstallOptions
60 {
61 public:
62     InstallOptions();
63     InstallOptions(const InstallOptions &other);
64     InstallOptions(InstallOptions &&other) Q_DECL_NOEXCEPT;
65     InstallOptions &operator=(const InstallOptions &other);
66     InstallOptions &operator=(InstallOptions &&other) Q_DECL_NOEXCEPT;
67     ~InstallOptions();
68 
69     static InstallOptions fromJson(const QJsonObject &data);
70 
71     static QString defaultInstallRoot();
72     QString installRoot() const;
73     void setInstallRoot(const QString &installRoot);
74 
75     bool installIntoSysroot() const;
76     void setInstallIntoSysroot(bool useSysroot);
77 
78     bool removeExistingInstallation() const;
79     void setRemoveExistingInstallation(bool removeExisting);
80 
81     bool dryRun() const;
82     void setDryRun(bool dryRun);
83 
84     bool keepGoing() const;
85     void setKeepGoing(bool keepGoing);
86 
87     bool logElapsedTime() const;
88     void setLogElapsedTime(bool logElapsedTime);
89 
90 private:
91     QSharedDataPointer<Internal::InstallOptionsPrivate> d;
92 };
93 
94 } // namespace qbs
95 
96 #endif // QBS_INSTALLOPTIONS_H
97