buildstep.cpp 5.84 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
**
29
**************************************************************************/
hjk's avatar
hjk committed
30

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

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

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
/*!
    \class ProjectExplorer::BuildStep

    \brief BuildSteps are the primary way plugin developers can customize
    how their projects (or projects from other plugins) are build.

    Building a project, is done by taking the list of buildsteps
    from the project and calling first init() than run() on them.

    That means to change the way your project is build, reimplemnt
    this class and add your Step to the buildStep list of the project.

    Note: The projects own the buildstep, do not delete them yourself.

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

    run() is run via QtConccurrent in a own thread, if you need an
    eventloop you need to create it yourself!
*/

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

    This function is run in the gui thread,
    use it to retrieve any information that you need in run()
*/

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

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

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

    By returning true from \sa runInGuiThread() this function is called in the
    gui thread. Then the function should not block and instead the
    finished() signal should be emitted.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
*/

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

    Returns the Widget shown in the target settings dialog for this buildStep;
    ownership is transferred to the caller.
*/

/*!
    \fn bool ProjectExplorer::BuildStep::immutable() const

    If this function returns true, the user can't delete this BuildStep for this target
    and the user is prevented from changing the order immutable steps are run
    the default implementation returns false.
*/

/*!
    \fn  void ProjectExplorer::BuildStep::addTask(const ProjectExplorer::Task &task)
    \brief Add a task.
*/

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

    The string is added to the generated output, usually in the output window.
    It should be in plain text, with the format in the parameter.
*/

112 113 114 115 116 117 118 119 120 121 122
/*!
    \fn void ProjectExplorer::BuildStep::cancel() const

    This function needs to be reimplemented only for BuildSteps that return false from \sa runInGuiThread.
*/

/*!
    \fn  void ProjectExplorer::BuildStep::finished()
    \brief This signal needs to be emitted if the BuildStep runs in the gui thread.
*/

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

125
using namespace ProjectExplorer;
con's avatar
con committed
126

127
BuildStep::BuildStep(BuildStepList *bsl, const Core::Id id) :
Daniel Teske's avatar
Daniel Teske committed
128
    ProjectConfiguration(bsl, id), m_enabled(true)
con's avatar
con committed
129
{
Tobias Hunger's avatar
Tobias Hunger committed
130
    Q_ASSERT(bsl);
con's avatar
con committed
131 132
}

Tobias Hunger's avatar
Tobias Hunger committed
133
BuildStep::BuildStep(BuildStepList *bsl, BuildStep *bs) :
Daniel Teske's avatar
Daniel Teske committed
134
    ProjectConfiguration(bsl, bs), m_enabled(bs->m_enabled)
con's avatar
con committed
135
{
Tobias Hunger's avatar
Tobias Hunger committed
136
    Q_ASSERT(bsl);
137
    setDisplayName(bs->displayName());
con's avatar
con committed
138 139
}

140
BuildStep::~BuildStep()
con's avatar
con committed
141 142 143
{
}

Daniel Teske's avatar
Daniel Teske committed
144 145 146 147 148 149 150 151 152 153 154 155 156
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;
}

157
BuildConfiguration *BuildStep::buildConfiguration() const
con's avatar
con committed
158
{
159
    return qobject_cast<BuildConfiguration *>(parent()->parent());
Tobias Hunger's avatar
Tobias Hunger committed
160 161
}

162 163
DeployConfiguration *BuildStep::deployConfiguration() const
{
164
    return qobject_cast<DeployConfiguration *>(parent()->parent());
165 166
}

Daniel Teske's avatar
Daniel Teske committed
167 168 169 170 171
ProjectConfiguration *BuildStep::projectConfiguration() const
{
    return static_cast<ProjectConfiguration *>(parent()->parent());
}

Tobias Hunger's avatar
Tobias Hunger committed
172 173 174
Target *BuildStep::target() const
{
    return qobject_cast<Target *>(parent()->parent()->parent());
con's avatar
con committed
175 176
}

177 178 179 180 181
Project *BuildStep::project() const
{
    return target()->project();
}

con's avatar
con committed
182 183 184 185 186
bool BuildStep::immutable() const
{
    return false;
}

187 188 189 190 191 192 193 194 195 196
bool BuildStep::runInGuiThread() const
{
    return false;
}

void BuildStep::cancel()
{
    // Do nothing
}

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

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

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

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