genericmakestep.cpp 12.6 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1 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).
Roberto Raggi's avatar
Roberto Raggi committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
Roberto Raggi's avatar
Roberto Raggi committed
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
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.
Roberto Raggi's avatar
Roberto Raggi committed
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
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
Roberto Raggi's avatar
Roberto Raggi committed
30 31 32
**
**************************************************************************/

33
#include "genericmakestep.h"
Roberto Raggi's avatar
Roberto Raggi committed
34 35
#include "genericprojectconstants.h"
#include "genericproject.h"
36
#include "ui_genericmakestep.h"
37
#include "genericbuildconfiguration.h"
Roberto Raggi's avatar
Roberto Raggi committed
38

39
#include <extensionsystem/pluginmanager.h>
Tobias Hunger's avatar
Tobias Hunger committed
40
#include <projectexplorer/buildsteplist.h>
Tobias Hunger's avatar
Tobias Hunger committed
41
#include <projectexplorer/gnumakeparser.h>
Tobias Hunger's avatar
Tobias Hunger committed
42 43
#include <projectexplorer/profileinformation.h>
#include <projectexplorer/projectexplorer.h>
44
#include <projectexplorer/projectexplorerconstants.h>
Tobias Hunger's avatar
Tobias Hunger committed
45
#include <projectexplorer/toolchain.h>
46
#include <coreplugin/variablemanager.h>
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
47
#include <utils/stringutils.h>
48
#include <utils/qtcassert.h>
49
#include <utils/qtcprocess.h>
50

51 52 53 54 55
#include <QFormLayout>
#include <QGroupBox>
#include <QCheckBox>
#include <QLineEdit>
#include <QListWidget>
Roberto Raggi's avatar
Roberto Raggi committed
56 57 58 59

using namespace GenericProjectManager;
using namespace GenericProjectManager::Internal;

60 61 62 63 64 65 66 67
namespace {
const char * const GENERIC_MS_ID("GenericProjectManager.GenericMakeStep");
const char * const GENERIC_MS_DISPLAY_NAME(QT_TRANSLATE_NOOP("GenericProjectManager::Internal::GenericMakeStep",
                                                             "Make"));

const char * const BUILD_TARGETS_KEY("GenericProjectManager.GenericMakeStep.BuildTargets");
const char * const MAKE_ARGUMENTS_KEY("GenericProjectManager.GenericMakeStep.MakeArguments");
const char * const MAKE_COMMAND_KEY("GenericProjectManager.GenericMakeStep.MakeCommand");
68
const char * const CLEAN_KEY("GenericProjectManager.GenericMakeStep.Clean");
69 70
}

Tobias Hunger's avatar
Tobias Hunger committed
71
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent) :
72
    AbstractProcessStep(parent, Core::Id(GENERIC_MS_ID)),
73
    m_clean(false)
74 75 76 77
{
    ctor();
}

78
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent, const Core::Id id) :
79 80
    AbstractProcessStep(parent, id),
    m_clean(false)
81 82 83 84
{
    ctor();
}

Tobias Hunger's avatar
Tobias Hunger committed
85 86
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent, GenericMakeStep *bs) :
    AbstractProcessStep(parent, bs),
87 88
    m_buildTargets(bs->m_buildTargets),
    m_makeArguments(bs->m_makeArguments),
89 90
    m_makeCommand(bs->m_makeCommand),
    m_clean(bs->m_clean)
Roberto Raggi's avatar
Roberto Raggi committed
91
{
92
    ctor();
Roberto Raggi's avatar
Roberto Raggi committed
93 94
}

95
void GenericMakeStep::ctor()
dt's avatar
Compile  
dt committed
96
{
97 98
    setDefaultDisplayName(QCoreApplication::translate("GenericProjectManager::Internal::GenericMakeStep",
                                                      GENERIC_MS_DISPLAY_NAME));
dt's avatar
Compile  
dt committed
99 100
}

101
GenericMakeStep::~GenericMakeStep()
Roberto Raggi's avatar
Roberto Raggi committed
102 103 104
{
}

dt's avatar
dt committed
105 106 107 108 109
GenericBuildConfiguration *GenericMakeStep::genericBuildConfiguration() const
{
    return static_cast<GenericBuildConfiguration *>(buildConfiguration());
}

110
bool GenericMakeStep::init()
Roberto Raggi's avatar
Roberto Raggi committed
111
{
dt's avatar
dt committed
112
    GenericBuildConfiguration *bc = genericBuildConfiguration();
113 114
    if (!bc)
        bc = static_cast<GenericBuildConfiguration *>(target()->activeBuildConfiguration());
Roberto Raggi's avatar
Roberto Raggi committed
115

116 117 118 119 120 121 122
    ProjectExplorer::ProcessParameters *pp = processParameters();
    pp->setMacroExpander(bc->macroExpander());
    pp->setWorkingDirectory(bc->buildDirectory());
    pp->setEnvironment(bc->environment());
    pp->setCommand(makeCommand());
    pp->setArguments(allArguments());

123 124 125 126 127
    // If we are cleaning, then make can fail with an error code, but that doesn't mean
    // we should stop the clean queue
    // That is mostly so that rebuild works on an already clean project
    setIgnoreReturnValue(m_clean);

128
    setOutputParser(new ProjectExplorer::GnuMakeParser());
Tobias Hunger's avatar
Tobias Hunger committed
129 130 131 132
    ProjectExplorer::ToolChain *tc =
            ProjectExplorer::ToolChainProfileInformation::toolChain(bc->target()->profile());
    if (tc)
        appendOutputParser(tc->outputParser());
133
    outputParser()->setWorkingDirectory(pp->effectiveWorkingDirectory());
Tobias Hunger's avatar
Tobias Hunger committed
134 135

    return AbstractProcessStep::init();
136 137
}

138 139 140 141 142 143 144 145 146 147
void GenericMakeStep::setClean(bool clean)
{
    m_clean = clean;
}

bool GenericMakeStep::isClean() const
{
    return m_clean;
}

148
QVariantMap GenericMakeStep::toMap() const
149
{
150 151 152 153 154
    QVariantMap map(AbstractProcessStep::toMap());

    map.insert(QLatin1String(BUILD_TARGETS_KEY), m_buildTargets);
    map.insert(QLatin1String(MAKE_ARGUMENTS_KEY), m_makeArguments);
    map.insert(QLatin1String(MAKE_COMMAND_KEY), m_makeCommand);
155
    map.insert(QLatin1String(CLEAN_KEY), m_clean);
156
    return map;
157 158
}

159
bool GenericMakeStep::fromMap(const QVariantMap &map)
160
{
161
    m_buildTargets = map.value(QLatin1String(BUILD_TARGETS_KEY)).toStringList();
162
    m_makeArguments = map.value(QLatin1String(MAKE_ARGUMENTS_KEY)).toString();
163
    m_makeCommand = map.value(QLatin1String(MAKE_COMMAND_KEY)).toString();
164
    m_clean = map.value(QLatin1String(CLEAN_KEY)).toBool();
165 166

    return BuildStep::fromMap(map);
167 168
}

169
QString GenericMakeStep::allArguments() const
170
{
171 172 173
    QString args = m_makeArguments;
    Utils::QtcProcess::addArgs(&args, m_buildTargets);
    return args;
174
}
175

176
QString GenericMakeStep::makeCommand() const
177
{
178
    QString command = m_makeCommand;
179
    if (command.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
180 181 182
        ProjectExplorer::ToolChain *tc = ProjectExplorer::ToolChainProfileInformation::toolChain(target()->profile());
        if (tc)
            command = tc->makeCommand();
183 184 185 186
        else
            command = QLatin1String("make");
    }
    return command;
Roberto Raggi's avatar
Roberto Raggi committed
187 188
}

189
void GenericMakeStep::run(QFutureInterface<bool> &fi)
Roberto Raggi's avatar
Roberto Raggi committed
190 191 192 193
{
    AbstractProcessStep::run(fi);
}

194
ProjectExplorer::BuildStepConfigWidget *GenericMakeStep::createConfigWidget()
Roberto Raggi's avatar
Roberto Raggi committed
195
{
196
    return new GenericMakeStepConfigWidget(this);
Roberto Raggi's avatar
Roberto Raggi committed
197 198
}

199
bool GenericMakeStep::immutable() const
Roberto Raggi's avatar
Roberto Raggi committed
200
{
201
    return false;
Roberto Raggi's avatar
Roberto Raggi committed
202 203
}

204
bool GenericMakeStep::buildsTarget(const QString &target) const
Roberto Raggi's avatar
Roberto Raggi committed
205
{
206
    return m_buildTargets.contains(target);
Roberto Raggi's avatar
Roberto Raggi committed
207 208
}

209
void GenericMakeStep::setBuildTarget(const QString &target, bool on)
Roberto Raggi's avatar
Roberto Raggi committed
210
{
211
    QStringList old = m_buildTargets;
Roberto Raggi's avatar
Roberto Raggi committed
212
    if (on && !old.contains(target))
213
         old << target;
Roberto Raggi's avatar
Roberto Raggi committed
214
    else if(!on && old.contains(target))
215
        old.removeOne(target);
216

217
    m_buildTargets = old;
Roberto Raggi's avatar
Roberto Raggi committed
218 219 220
}

//
221
// GenericMakeStepConfigWidget
Roberto Raggi's avatar
Roberto Raggi committed
222
//
223 224

GenericMakeStepConfigWidget::GenericMakeStepConfigWidget(GenericMakeStep *makeStep)
Roberto Raggi's avatar
Roberto Raggi committed
225 226
    : m_makeStep(makeStep)
{
227 228
    m_ui = new Ui::GenericMakeStep;
    m_ui->setupUi(this);
Roberto Raggi's avatar
Roberto Raggi committed
229

230
    GenericProject *pro = static_cast<GenericProject *>(m_makeStep->target()->project());
Tobias Hunger's avatar
Tobias Hunger committed
231
    foreach (const QString &target, pro->buildTargets()) {
232
        QListWidgetItem *item = new QListWidgetItem(target, m_ui->targetsList);
Roberto Raggi's avatar
Roberto Raggi committed
233
        item->setFlags(item->flags() | Qt::ItemIsUserCheckable);
dt_'s avatar
dt_ committed
234
        item->setCheckState(m_makeStep->buildsTarget(item->text()) ? Qt::Checked : Qt::Unchecked);
Roberto Raggi's avatar
Roberto Raggi committed
235 236
    }

dt_'s avatar
dt_ committed
237 238 239 240 241
    m_ui->makeLineEdit->setText(m_makeStep->m_makeCommand);
    m_ui->makeArgumentsLineEdit->setText(m_makeStep->m_makeArguments);
    updateMakeOverrrideLabel();
    updateDetails();

242 243
    connect(m_ui->targetsList, SIGNAL(itemChanged(QListWidgetItem*)),
            this, SLOT(itemChanged(QListWidgetItem*)));
244
    connect(m_ui->makeLineEdit, SIGNAL(textEdited(QString)),
245
            this, SLOT(makeLineEditTextEdited()));
246
    connect(m_ui->makeArgumentsLineEdit, SIGNAL(textEdited(QString)),
247
            this, SLOT(makeArgumentsLineEditTextEdited()));
248 249 250 251 252

    connect(ProjectExplorer::ProjectExplorerPlugin::instance(), SIGNAL(settingsChanged()),
            this, SLOT(updateMakeOverrrideLabel()));
    connect(ProjectExplorer::ProjectExplorerPlugin::instance(), SIGNAL(settingsChanged()),
            this, SLOT(updateDetails()));
253

Tobias Hunger's avatar
Tobias Hunger committed
254
    connect(m_makeStep->target(), SIGNAL(profileChanged()),
255
            this, SLOT(updateMakeOverrrideLabel()));
Roberto Raggi's avatar
Roberto Raggi committed
256 257
}

258
QString GenericMakeStepConfigWidget::displayName() const
Roberto Raggi's avatar
Roberto Raggi committed
259
{
260
    return tr("Make", "GenericMakestep display name.");
Roberto Raggi's avatar
Roberto Raggi committed
261 262
}

263 264
void GenericMakeStepConfigWidget::updateMakeOverrrideLabel()
{
265
    m_ui->makeLabel->setText(tr("Override %1:").arg(m_makeStep->makeCommand()));
266 267
}

268 269
void GenericMakeStepConfigWidget::updateDetails()
{
270
    GenericBuildConfiguration *bc = m_makeStep->genericBuildConfiguration();
271 272
    if (!bc)
        bc = static_cast<GenericBuildConfiguration *>(m_makeStep->target()->activeBuildConfiguration());
273 274 275 276 277 278 279 280

    ProjectExplorer::ProcessParameters param;
    param.setMacroExpander(bc->macroExpander());
    param.setWorkingDirectory(bc->buildDirectory());
    param.setEnvironment(bc->environment());
    param.setCommand(m_makeStep->makeCommand());
    param.setArguments(m_makeStep->allArguments());
    m_summaryText = param.summary(displayName());
281 282 283
    emit updateSummary();
}

dt's avatar
dt committed
284 285
QString GenericMakeStepConfigWidget::summaryText() const
{
286
    return m_summaryText;
dt's avatar
dt committed
287 288
}

289 290
void GenericMakeStepConfigWidget::itemChanged(QListWidgetItem *item)
{
291
    m_makeStep->setBuildTarget(item->text(), item->checkState() & Qt::Checked);
292
    updateDetails();
293 294 295 296
}

void GenericMakeStepConfigWidget::makeLineEditTextEdited()
{
297
    m_makeStep->m_makeCommand = m_ui->makeLineEdit->text();
298
    updateDetails();
299 300 301 302
}

void GenericMakeStepConfigWidget::makeArgumentsLineEditTextEdited()
{
303
    m_makeStep->m_makeArguments = m_ui->makeArgumentsLineEdit->text();
304
    updateDetails();
Roberto Raggi's avatar
Roberto Raggi committed
305 306 307
}

//
308
// GenericMakeStepFactory
Roberto Raggi's avatar
Roberto Raggi committed
309 310
//

311 312 313 314 315 316 317 318 319
GenericMakeStepFactory::GenericMakeStepFactory(QObject *parent) :
    ProjectExplorer::IBuildStepFactory(parent)
{
}

GenericMakeStepFactory::~GenericMakeStepFactory()
{
}

Tobias Hunger's avatar
Tobias Hunger committed
320
bool GenericMakeStepFactory::canCreate(ProjectExplorer::BuildStepList *parent,
321
                                       const Core::Id id) const
322
{
323
    if (parent->target()->project()->id() != Core::Id(Constants::GENERICPROJECT_ID))
324
        return false;
325
    return id == Core::Id(GENERIC_MS_ID);
326 327
}

Tobias Hunger's avatar
Tobias Hunger committed
328
ProjectExplorer::BuildStep *GenericMakeStepFactory::create(ProjectExplorer::BuildStepList *parent,
329
                                                           const Core::Id id)
330
{
Tobias Hunger's avatar
Tobias Hunger committed
331
    if (!canCreate(parent, id))
332
        return 0;
333
    GenericMakeStep *step = new GenericMakeStep(parent);
334
    if (parent->id() == Core::Id(ProjectExplorer::Constants::BUILDSTEPS_CLEAN)) {
335
        step->setClean(true);
336
        step->setBuildTarget(QLatin1String("clean"), /* on = */ true);
337
    } else if (parent->id() == Core::Id(ProjectExplorer::Constants::BUILDSTEPS_BUILD)) {
338
        step->setBuildTarget(QLatin1String("all"), /* on = */ true);
339 340
    }
    return step;
341 342
}

Tobias Hunger's avatar
Tobias Hunger committed
343
bool GenericMakeStepFactory::canClone(ProjectExplorer::BuildStepList *parent,
344 345
                                      ProjectExplorer::BuildStep *source) const
{
346
    return canCreate(parent, source->id());
347 348
}

Tobias Hunger's avatar
Tobias Hunger committed
349
ProjectExplorer::BuildStep *GenericMakeStepFactory::clone(ProjectExplorer::BuildStepList *parent,
350
                                                          ProjectExplorer::BuildStep *source)
Roberto Raggi's avatar
Roberto Raggi committed
351
{
Tobias Hunger's avatar
Tobias Hunger committed
352
    if (!canClone(parent, source))
353 354 355 356
        return 0;
    GenericMakeStep *old(qobject_cast<GenericMakeStep *>(source));
    Q_ASSERT(old);
    return new GenericMakeStep(parent, old);
Roberto Raggi's avatar
Roberto Raggi committed
357 358
}

Tobias Hunger's avatar
Tobias Hunger committed
359
bool GenericMakeStepFactory::canRestore(ProjectExplorer::BuildStepList *parent,
360
                                        const QVariantMap &map) const
Roberto Raggi's avatar
Roberto Raggi committed
361
{
362
    return canCreate(parent, ProjectExplorer::idFromMap(map));
363 364
}

Tobias Hunger's avatar
Tobias Hunger committed
365
ProjectExplorer::BuildStep *GenericMakeStepFactory::restore(ProjectExplorer::BuildStepList *parent,
366
                                                            const QVariantMap &map)
367
{
Tobias Hunger's avatar
Tobias Hunger committed
368
    if (!canRestore(parent, map))
369 370 371 372 373 374
        return 0;
    GenericMakeStep *bs(new GenericMakeStep(parent));
    if (bs->fromMap(map))
        return bs;
    delete bs;
    return 0;
Roberto Raggi's avatar
Roberto Raggi committed
375 376
}

377
QList<Core::Id> GenericMakeStepFactory::availableCreationIds(ProjectExplorer::BuildStepList *parent) const
Roberto Raggi's avatar
Roberto Raggi committed
378
{
379 380 381
    if (parent->target()->project()->id() != Core::Id(Constants::GENERICPROJECT_ID))
        return QList<Core::Id>();
    return QList<Core::Id>() << Core::Id(GENERIC_MS_ID);
Roberto Raggi's avatar
Roberto Raggi committed
382 383
}

384
QString GenericMakeStepFactory::displayNameForId(const Core::Id id) const
Roberto Raggi's avatar
Roberto Raggi committed
385
{
386
    if (id == Core::Id(GENERIC_MS_ID))
387 388 389
        return QCoreApplication::translate("GenericProjectManager::Internal::GenericMakeStep",
                                           GENERIC_MS_DISPLAY_NAME);
    return QString();
Roberto Raggi's avatar
Roberto Raggi committed
390
}