genericmakestep.cpp 12.5 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"
Tobias Hunger's avatar
Tobias Hunger committed
36
#include "generictarget.h"
37
#include "ui_genericmakestep.h"
38
#include "genericbuildconfiguration.h"
Roberto Raggi's avatar
Roberto Raggi committed
39

40
#include <extensionsystem/pluginmanager.h>
Tobias Hunger's avatar
Tobias Hunger committed
41
#include <projectexplorer/buildsteplist.h>
42
#include <projectexplorer/toolchain.h>
43
#include <projectexplorer/projectexplorer.h>
Tobias Hunger's avatar
Tobias Hunger committed
44
#include <projectexplorer/gnumakeparser.h>
45
#include <projectexplorer/projectexplorerconstants.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 73
    AbstractProcessStep(parent, QLatin1String(GENERIC_MS_ID)),
    m_clean(false)
74 75 76 77
{
    ctor();
}

Tobias Hunger's avatar
Tobias Hunger committed
78
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent, const QString &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
    if (bc->genericTarget()->genericProject()->toolChain())
        appendOutputParser(bc->genericTarget()->genericProject()->toolChain()->outputParser());
131
    outputParser()->setWorkingDirectory(pp->effectiveWorkingDirectory());
Tobias Hunger's avatar
Tobias Hunger committed
132 133

    return AbstractProcessStep::init();
134 135
}

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

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

146
QVariantMap GenericMakeStep::toMap() const
147
{
148 149 150 151 152
    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);
153
    map.insert(QLatin1String(CLEAN_KEY), m_clean);
154
    return map;
155 156
}

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

    return BuildStep::fromMap(map);
165 166
}

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

174
QString GenericMakeStep::makeCommand() const
175
{
176
    QString command = m_makeCommand;
177
    if (command.isEmpty()) {
178
        GenericProject *pro = static_cast<GenericProject *>(target()->project());
dt's avatar
dt committed
179
        if (ProjectExplorer::ToolChain *toolChain = pro->toolChain())
180 181 182 183 184
            command = toolChain->makeCommand();
        else
            command = QLatin1String("make");
    }
    return command;
Roberto Raggi's avatar
Roberto Raggi committed
185 186
}

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

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

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

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

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

215
    m_buildTargets = old;
Roberto Raggi's avatar
Roberto Raggi committed
216 217 218
}

//
219
// GenericMakeStepConfigWidget
Roberto Raggi's avatar
Roberto Raggi committed
220
//
221 222

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

    // TODO update this list also on rescans of the GenericLists.txt
229
    GenericProject *pro = static_cast<GenericProject *>(m_makeStep->target()->project());
Tobias Hunger's avatar
Tobias Hunger committed
230
    foreach (const QString &target, pro->buildTargets()) {
231
        QListWidgetItem *item = new QListWidgetItem(target, m_ui->targetsList);
Roberto Raggi's avatar
Roberto Raggi committed
232
        item->setFlags(item->flags() | Qt::ItemIsUserCheckable);
dt_'s avatar
dt_ committed
233
        item->setCheckState(m_makeStep->buildsTarget(item->text()) ? Qt::Checked : Qt::Unchecked);
Roberto Raggi's avatar
Roberto Raggi committed
234 235
    }

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

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

    connect(ProjectExplorer::ProjectExplorerPlugin::instance(), SIGNAL(settingsChanged()),
            this, SLOT(updateMakeOverrrideLabel()));
    connect(ProjectExplorer::ProjectExplorerPlugin::instance(), SIGNAL(settingsChanged()),
            this, SLOT(updateDetails()));
Roberto Raggi's avatar
Roberto Raggi committed
252 253
}

254
QString GenericMakeStepConfigWidget::displayName() const
Roberto Raggi's avatar
Roberto Raggi committed
255
{
256
    return tr("Make", "GenericMakestep display name.");
Roberto Raggi's avatar
Roberto Raggi committed
257 258
}

259 260 261
// TODO: Label should update when tool chain is changed
void GenericMakeStepConfigWidget::updateMakeOverrrideLabel()
{
262
    m_ui->makeLabel->setText(tr("Override %1:").arg(m_makeStep->makeCommand()));
263 264
}

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

    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());
278 279 280
    emit updateSummary();
}

dt's avatar
dt committed
281 282
QString GenericMakeStepConfigWidget::summaryText() const
{
283
    return m_summaryText;
dt's avatar
dt committed
284 285
}

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

void GenericMakeStepConfigWidget::makeLineEditTextEdited()
{
294
    m_makeStep->m_makeCommand = m_ui->makeLineEdit->text();
295
    updateDetails();
296 297 298 299
}

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

//
305
// GenericMakeStepFactory
Roberto Raggi's avatar
Roberto Raggi committed
306 307
//

308 309 310 311 312 313 314 315 316
GenericMakeStepFactory::GenericMakeStepFactory(QObject *parent) :
    ProjectExplorer::IBuildStepFactory(parent)
{
}

GenericMakeStepFactory::~GenericMakeStepFactory()
{
}

Tobias Hunger's avatar
Tobias Hunger committed
317
bool GenericMakeStepFactory::canCreate(ProjectExplorer::BuildStepList *parent,
318
                                       const QString &id) const
319
{
Tobias Hunger's avatar
Tobias Hunger committed
320
    if (parent->target()->project()->id() != QLatin1String(Constants::GENERICPROJECT_ID))
321 322 323 324
        return false;
    return id == QLatin1String(GENERIC_MS_ID);
}

Tobias Hunger's avatar
Tobias Hunger committed
325
ProjectExplorer::BuildStep *GenericMakeStepFactory::create(ProjectExplorer::BuildStepList *parent,
326 327
                                                           const QString &id)
{
Tobias Hunger's avatar
Tobias Hunger committed
328
    if (!canCreate(parent, id))
329
        return 0;
330 331 332 333 334 335
    GenericMakeStep *step = new GenericMakeStep(parent);
    if (parent->id() == ProjectExplorer::Constants::BUILDSTEPS_CLEAN) {
        step->setClean(true);
        step->setBuildTarget("clean", /* on = */ true);
    }
    return step;
336 337
}

Tobias Hunger's avatar
Tobias Hunger committed
338
bool GenericMakeStepFactory::canClone(ProjectExplorer::BuildStepList *parent,
339 340 341
                                      ProjectExplorer::BuildStep *source) const
{
    const QString id(source->id());
Tobias Hunger's avatar
Tobias Hunger committed
342
    return canCreate(parent, id);
343 344
}

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

Tobias Hunger's avatar
Tobias Hunger committed
355
bool GenericMakeStepFactory::canRestore(ProjectExplorer::BuildStepList *parent,
356
                                        const QVariantMap &map) const
Roberto Raggi's avatar
Roberto Raggi committed
357
{
358
    QString id(ProjectExplorer::idFromMap(map));
Tobias Hunger's avatar
Tobias Hunger committed
359
    return canCreate(parent, id);
360 361
}

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

Tobias Hunger's avatar
Tobias Hunger committed
374
QStringList GenericMakeStepFactory::availableCreationIds(ProjectExplorer::BuildStepList *parent) const
Roberto Raggi's avatar
Roberto Raggi committed
375
{
Tobias Hunger's avatar
Tobias Hunger committed
376
    if (parent->target()->project()->id() != QLatin1String(Constants::GENERICPROJECT_ID))
377 378
        return QStringList();
    return QStringList() << QLatin1String(GENERIC_MS_ID);
Roberto Raggi's avatar
Roberto Raggi committed
379 380
}

381
QString GenericMakeStepFactory::displayNameForId(const QString &id) const
Roberto Raggi's avatar
Roberto Raggi committed
382
{
383 384 385 386
    if (id == QLatin1String(GENERIC_MS_ID))
        return QCoreApplication::translate("GenericProjectManager::Internal::GenericMakeStep",
                                           GENERIC_MS_DISPLAY_NAME);
    return QString();
Roberto Raggi's avatar
Roberto Raggi committed
387
}