buildstep.cpp 6.15 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
#include "buildstep.h"
hjk's avatar
hjk committed
31

Tobias Hunger's avatar
Tobias Hunger committed
32 33
#include "buildconfiguration.h"
#include "buildsteplist.h"
34
#include "deployconfiguration.h"
Tobias Hunger's avatar
Tobias Hunger committed
35 36
#include "target.h"

37 38 39
/*!
    \class ProjectExplorer::BuildStep

40
    \brief The BuildStep class provides build steps for projects.
41

42 43
    Build steps are the primary way plugin developers can customize
    how their projects (or projects from other plugins) are built.
44

45 46
    Projects are built by taking the list of build steps
    from the project and calling first \c init() and then \c run() on them.
47

48 49
    To change the way your project is built, reimplement
    this class and add your build step to the build step list of the project.
50

51 52 53
    \note The projects own the build step. Do not delete them yourself.

    \c init() is called in the GUI thread and can be used to query the
54 55
    project for any information you need.

56 57
    \c run() is run via QtConcurrent in a separate thread. If you need an
    event loop, you need to create it yourself.
58 59 60 61 62
*/

/*!
    \fn bool ProjectExplorer::BuildStep::init()

63 64
    This function is run in the GUI thread. Use it to retrieve any information
    that you need in the run() function.
65 66 67 68 69
*/

/*!
    \fn void ProjectExplorer::BuildStep::run(QFutureInterface<bool> &fi)

70 71
    Reimplement this function. It is called when the target is built.
    By default, this function is NOT run in the GUI thread, but runs in its
72 73
    own thread. If you need an event loop, you need to create one.
    This function should block until the task is done
74 75 76 77 78

    The absolute minimal implementation is:
    \code
    fi.reportResult(true);
    \endcode
79

80 81
    By returning \c true from runInGuiThread(), this function is called in
    the GUI thread. Then the function should not block and instead the
82
    finished() signal should be emitted.
83

84
    \sa runInGuiThread()
85 86 87
*/

/*!
88
    \fn BuildStepConfigWidget *ProjectExplorer::BuildStep::createConfigWidget()
89

90 91
    Returns the Widget shown in the target settings dialog for this build step.
    Ownership is transferred to the caller.
92 93 94 95
*/

/*!
    \fn  void ProjectExplorer::BuildStep::addTask(const ProjectExplorer::Task &task)
96
    Adds \a task.
97 98 99 100 101 102
*/

/*!
    \fn  void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format,
              ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting)

103
    The \a string is added to the generated output, usually in the output pane.
104 105 106
    It should be in plain text, with the format in the parameter.
*/

107 108 109

/*!
    \fn  void ProjectExplorer::BuildStep::finished()
110
    This signal needs to be emitted if the build step runs in the GUI thread.
111 112
*/

Daniel Teske's avatar
Daniel Teske committed
113 114
static const char buildStepEnabledKey[] = "ProjectExplorer.BuildStep.Enabled";

115
using namespace ProjectExplorer;
con's avatar
con committed
116

117
BuildStep::BuildStep(BuildStepList *bsl, const Core::Id id) :
Daniel Teske's avatar
Daniel Teske committed
118
    ProjectConfiguration(bsl, id), m_enabled(true)
con's avatar
con committed
119
{
Tobias Hunger's avatar
Tobias Hunger committed
120
    Q_ASSERT(bsl);
con's avatar
con committed
121 122
}

Tobias Hunger's avatar
Tobias Hunger committed
123
BuildStep::BuildStep(BuildStepList *bsl, BuildStep *bs) :
Daniel Teske's avatar
Daniel Teske committed
124
    ProjectConfiguration(bsl, bs), m_enabled(bs->m_enabled)
con's avatar
con committed
125
{
Tobias Hunger's avatar
Tobias Hunger committed
126
    Q_ASSERT(bsl);
127
    setDisplayName(bs->displayName());
con's avatar
con committed
128 129
}

130
BuildStep::~BuildStep()
con's avatar
con committed
131 132 133
{
}

Daniel Teske's avatar
Daniel Teske committed
134 135 136 137 138 139 140 141 142 143 144 145 146
bool BuildStep::fromMap(const QVariantMap &map)
{
    m_enabled = map.value(QLatin1String(buildStepEnabledKey), true).toBool();
    return ProjectConfiguration::fromMap(map);
}

QVariantMap BuildStep::toMap() const
{
    QVariantMap map = ProjectConfiguration::toMap();
    map.insert(QLatin1String(buildStepEnabledKey), m_enabled);
    return map;
}

147
BuildConfiguration *BuildStep::buildConfiguration() const
con's avatar
con committed
148
{
149
    return qobject_cast<BuildConfiguration *>(parent()->parent());
Tobias Hunger's avatar
Tobias Hunger committed
150 151
}

152 153
DeployConfiguration *BuildStep::deployConfiguration() const
{
154
    return qobject_cast<DeployConfiguration *>(parent()->parent());
155 156
}

Daniel Teske's avatar
Daniel Teske committed
157 158 159 160 161
ProjectConfiguration *BuildStep::projectConfiguration() const
{
    return static_cast<ProjectConfiguration *>(parent()->parent());
}

Tobias Hunger's avatar
Tobias Hunger committed
162 163 164
Target *BuildStep::target() const
{
    return qobject_cast<Target *>(parent()->parent()->parent());
con's avatar
con committed
165 166
}

167 168 169 170 171
Project *BuildStep::project() const
{
    return target()->project();
}

172 173 174 175 176 177
/*!
    If this function returns \c true, the user cannot delete this build step for
    this target and the user is prevented from changing the order in which
    immutable steps are run. The default implementation returns \c false.
*/

con's avatar
con committed
178 179 180 181 182
bool BuildStep::immutable() const
{
    return false;
}

183 184 185 186 187
bool BuildStep::runInGuiThread() const
{
    return false;
}

188 189 190 191 192 193
/*!
    This function needs to be reimplemented only for build steps that return
    \c false from runInGuiThread().

    \sa runInGuiThread()
*/
194 195 196 197 198
void BuildStep::cancel()
{
    // Do nothing
}

Daniel Teske's avatar
Daniel Teske committed
199 200 201 202 203 204 205 206 207 208 209 210 211
void BuildStep::setEnabled(bool b)
{
    if (m_enabled == b)
        return;
    m_enabled = b;
    emit enabledChanged();
}

bool BuildStep::enabled() const
{
    return m_enabled;
}

212 213
IBuildStepFactory::IBuildStepFactory(QObject *parent) :
    QObject(parent)
Tobias Hunger's avatar
Tobias Hunger committed
214
{ }
con's avatar
con committed
215 216

IBuildStepFactory::~IBuildStepFactory()
Tobias Hunger's avatar
Tobias Hunger committed
217
{ }