genericmakestep.cpp 12.1 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) 2010 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 12 13 14 15 16 17 18 19 20 21 22 23 24 25
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
Roberto Raggi's avatar
Roberto Raggi committed
27 28 29
**
**************************************************************************/

30
#include "genericmakestep.h"
Roberto Raggi's avatar
Roberto Raggi committed
31 32
#include "genericprojectconstants.h"
#include "genericproject.h"
Tobias Hunger's avatar
Tobias Hunger committed
33
#include "generictarget.h"
34
#include "ui_genericmakestep.h"
35
#include "genericbuildconfiguration.h"
Roberto Raggi's avatar
Roberto Raggi committed
36

37
#include <extensionsystem/pluginmanager.h>
Tobias Hunger's avatar
Tobias Hunger committed
38
#include <projectexplorer/buildsteplist.h>
39
#include <projectexplorer/toolchain.h>
40
#include <projectexplorer/projectexplorer.h>
Tobias Hunger's avatar
Tobias Hunger committed
41
#include <projectexplorer/gnumakeparser.h>
42
#include <coreplugin/variablemanager.h>
43
#include <utils/qtcassert.h>
44

Roberto Raggi's avatar
Roberto Raggi committed
45 46 47 48 49 50 51 52 53
#include <QtGui/QFormLayout>
#include <QtGui/QGroupBox>
#include <QtGui/QCheckBox>
#include <QtGui/QLineEdit>
#include <QtGui/QListWidget>

using namespace GenericProjectManager;
using namespace GenericProjectManager::Internal;

54 55 56 57 58 59 60 61 62 63
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");
}

Tobias Hunger's avatar
Tobias Hunger committed
64 65
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent) :
    AbstractProcessStep(parent, QLatin1String(GENERIC_MS_ID))
66 67 68 69
{
    ctor();
}

Tobias Hunger's avatar
Tobias Hunger committed
70 71
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent, const QString &id) :
    AbstractProcessStep(parent, id)
72 73 74 75
{
    ctor();
}

Tobias Hunger's avatar
Tobias Hunger committed
76 77
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent, GenericMakeStep *bs) :
    AbstractProcessStep(parent, bs),
78 79 80
    m_buildTargets(bs->m_buildTargets),
    m_makeArguments(bs->m_makeArguments),
    m_makeCommand(bs->m_makeCommand)
Roberto Raggi's avatar
Roberto Raggi committed
81
{
82
    ctor();
Roberto Raggi's avatar
Roberto Raggi committed
83 84
}

85
void GenericMakeStep::ctor()
dt's avatar
Compile  
dt committed
86
{
87 88
    setDisplayName(QCoreApplication::translate("GenericProjectManager::Internal::GenericMakeStep",
                   GENERIC_MS_DISPLAY_NAME));
dt's avatar
Compile  
dt committed
89 90
}

91
GenericMakeStep::~GenericMakeStep()
Roberto Raggi's avatar
Roberto Raggi committed
92 93 94
{
}

dt's avatar
dt committed
95 96 97 98 99
GenericBuildConfiguration *GenericMakeStep::genericBuildConfiguration() const
{
    return static_cast<GenericBuildConfiguration *>(buildConfiguration());
}

100
bool GenericMakeStep::init()
Roberto Raggi's avatar
Roberto Raggi committed
101
{
dt's avatar
dt committed
102
    GenericBuildConfiguration *bc = genericBuildConfiguration();
Roberto Raggi's avatar
Roberto Raggi committed
103

104
    setEnabled(true);
105
    Core::VariableManager *vm = Core::VariableManager::instance();
106
    const QString rawBuildDir = bc->buildDirectory();
107
    const QString buildDir = vm->resolve(rawBuildDir);
108
    setWorkingDirectory(buildDir);
109

110 111
    setCommand(makeCommand());
    setArguments(replacedArguments());
112

113
    setEnvironment(bc->environment());
Tobias Hunger's avatar
Tobias Hunger committed
114 115

    setOutputParser(new ProjectExplorer::GnuMakeParser(buildDir));
Tobias Hunger's avatar
Tobias Hunger committed
116 117
    if (bc->genericTarget()->genericProject()->toolChain())
        appendOutputParser(bc->genericTarget()->genericProject()->toolChain()->outputParser());
Tobias Hunger's avatar
Tobias Hunger committed
118 119

    return AbstractProcessStep::init();
120 121
}

122
QVariantMap GenericMakeStep::toMap() const
123
{
124 125 126 127 128 129
    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);
    return map;
130 131
}

132
bool GenericMakeStep::fromMap(const QVariantMap &map)
133
{
134 135 136 137 138
    m_buildTargets = map.value(QLatin1String(BUILD_TARGETS_KEY)).toStringList();
    m_makeArguments = map.value(QLatin1String(MAKE_ARGUMENTS_KEY)).toStringList();
    m_makeCommand = map.value(QLatin1String(MAKE_COMMAND_KEY)).toString();

    return BuildStep::fromMap(map);
139 140
}

141
QStringList GenericMakeStep::replacedArguments() const
142 143
{
    Core::VariableManager *vm = Core::VariableManager::instance();
144 145
    const QStringList targets = m_buildTargets;
    QStringList arguments = m_makeArguments;
146 147 148 149 150 151 152
    QStringList replacedArguments;
    foreach (const QString &arg, arguments) {
      replacedArguments.append(vm->resolve(arg));
    }
    foreach (const QString &arg, targets) {
      replacedArguments.append(vm->resolve(arg));
    }
153 154
    return replacedArguments;
}
155

156
QString GenericMakeStep::makeCommand() const
157
{
158
    QString command = m_makeCommand;
159
    if (command.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
160
        GenericProject *pro = genericBuildConfiguration()->genericTarget()->genericProject();
dt's avatar
dt committed
161
        if (ProjectExplorer::ToolChain *toolChain = pro->toolChain())
162 163 164 165 166
            command = toolChain->makeCommand();
        else
            command = QLatin1String("make");
    }
    return command;
Roberto Raggi's avatar
Roberto Raggi committed
167 168
}

169
void GenericMakeStep::run(QFutureInterface<bool> &fi)
Roberto Raggi's avatar
Roberto Raggi committed
170 171 172 173
{
    AbstractProcessStep::run(fi);
}

174
ProjectExplorer::BuildStepConfigWidget *GenericMakeStep::createConfigWidget()
Roberto Raggi's avatar
Roberto Raggi committed
175
{
176
    return new GenericMakeStepConfigWidget(this);
Roberto Raggi's avatar
Roberto Raggi committed
177 178
}

179
bool GenericMakeStep::immutable() const
Roberto Raggi's avatar
Roberto Raggi committed
180
{
181
    return false;
Roberto Raggi's avatar
Roberto Raggi committed
182 183
}

184
bool GenericMakeStep::buildsTarget(const QString &target) const
Roberto Raggi's avatar
Roberto Raggi committed
185
{
186
    return m_buildTargets.contains(target);
Roberto Raggi's avatar
Roberto Raggi committed
187 188
}

189
void GenericMakeStep::setBuildTarget(const QString &target, bool on)
Roberto Raggi's avatar
Roberto Raggi committed
190
{
191
    QStringList old = m_buildTargets;
Roberto Raggi's avatar
Roberto Raggi committed
192
    if (on && !old.contains(target))
193
         old << target;
Roberto Raggi's avatar
Roberto Raggi committed
194
    else if(!on && old.contains(target))
195
        old.removeOne(target);
196

197
    m_buildTargets = old;
Roberto Raggi's avatar
Roberto Raggi committed
198 199 200
}

//
201
// GenericMakeStepConfigWidget
Roberto Raggi's avatar
Roberto Raggi committed
202
//
203 204

GenericMakeStepConfigWidget::GenericMakeStepConfigWidget(GenericMakeStep *makeStep)
Roberto Raggi's avatar
Roberto Raggi committed
205 206
    : m_makeStep(makeStep)
{
207 208
    m_ui = new Ui::GenericMakeStep;
    m_ui->setupUi(this);
Roberto Raggi's avatar
Roberto Raggi committed
209 210

    // TODO update this list also on rescans of the GenericLists.txt
Tobias Hunger's avatar
Tobias Hunger committed
211 212
    GenericProject *pro = m_makeStep->genericBuildConfiguration()->genericTarget()->genericProject();
    foreach (const QString &target, pro->buildTargets()) {
213
        QListWidgetItem *item = new QListWidgetItem(target, m_ui->targetsList);
Roberto Raggi's avatar
Roberto Raggi committed
214 215 216 217
        item->setFlags(item->flags() | Qt::ItemIsUserCheckable);
        item->setCheckState(Qt::Unchecked);
    }

218 219
    connect(m_ui->targetsList, SIGNAL(itemChanged(QListWidgetItem*)),
            this, SLOT(itemChanged(QListWidgetItem*)));
220
    connect(m_ui->makeLineEdit, SIGNAL(textEdited(QString)),
221
            this, SLOT(makeLineEditTextEdited()));
222
    connect(m_ui->makeArgumentsLineEdit, SIGNAL(textEdited(QString)),
223
            this, SLOT(makeArgumentsLineEditTextEdited()));
224 225 226 227 228

    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
229 230
}

231
QString GenericMakeStepConfigWidget::displayName() const
Roberto Raggi's avatar
Roberto Raggi committed
232
{
233
    return tr("Make", "GenericMakestep display name.");
Roberto Raggi's avatar
Roberto Raggi committed
234 235
}

236 237 238
// TODO: Label should update when tool chain is changed
void GenericMakeStepConfigWidget::updateMakeOverrrideLabel()
{
239
    m_ui->makeLabel->setText(tr("Override %1:").arg(m_makeStep->makeCommand()));
240 241
}

242
void GenericMakeStepConfigWidget::init()
Roberto Raggi's avatar
Roberto Raggi committed
243
{
244
    updateMakeOverrrideLabel();
245

246
    QString makeCommand = m_makeStep->m_makeCommand;
247 248
    m_ui->makeLineEdit->setText(makeCommand);

249
    const QStringList &makeArguments = m_makeStep->m_makeArguments;
250 251 252 253 254 255 256 257
    m_ui->makeArgumentsLineEdit->setText(ProjectExplorer::Environment::joinArgumentList(makeArguments));

    // Disconnect to make the changes to the items
    disconnect(m_ui->targetsList, SIGNAL(itemChanged(QListWidgetItem*)), this, SLOT(itemChanged(QListWidgetItem*)));

    int count = m_ui->targetsList->count();
    for (int i = 0; i < count; ++i) {
        QListWidgetItem *item = m_ui->targetsList->item(i);
258
        item->setCheckState(m_makeStep->buildsTarget(item->text()) ? Qt::Checked : Qt::Unchecked);
Roberto Raggi's avatar
Roberto Raggi committed
259
    }
260

261
    updateDetails();
Roberto Raggi's avatar
Roberto Raggi committed
262
    // and connect again
263 264 265
    connect(m_ui->targetsList, SIGNAL(itemChanged(QListWidgetItem*)), this, SLOT(itemChanged(QListWidgetItem*)));
}

266 267 268
void GenericMakeStepConfigWidget::updateDetails()
{
    m_summaryText = tr("<b>Make:</b> %1 %2")
269 270
                    .arg(m_makeStep->makeCommand(),
                         ProjectExplorer::Environment::joinArgumentList(m_makeStep->replacedArguments()));
271 272 273
    emit updateSummary();
}

dt's avatar
dt committed
274 275
QString GenericMakeStepConfigWidget::summaryText() const
{
276
    return m_summaryText;
dt's avatar
dt committed
277 278
}

279 280
void GenericMakeStepConfigWidget::itemChanged(QListWidgetItem *item)
{
281
    m_makeStep->setBuildTarget(item->text(), item->checkState() & Qt::Checked);
282
    updateDetails();
283 284 285 286
}

void GenericMakeStepConfigWidget::makeLineEditTextEdited()
{
287
    m_makeStep->m_makeCommand = m_ui->makeLineEdit->text();
288
    updateDetails();
289 290 291 292
}

void GenericMakeStepConfigWidget::makeArgumentsLineEditTextEdited()
{
293 294
    m_makeStep->m_makeArguments =
            ProjectExplorer::Environment::parseCombinedArgString(m_ui->makeArgumentsLineEdit->text());
295
    updateDetails();
Roberto Raggi's avatar
Roberto Raggi committed
296 297 298
}

//
299
// GenericMakeStepFactory
Roberto Raggi's avatar
Roberto Raggi committed
300 301
//

302 303 304 305 306 307 308 309 310
GenericMakeStepFactory::GenericMakeStepFactory(QObject *parent) :
    ProjectExplorer::IBuildStepFactory(parent)
{
}

GenericMakeStepFactory::~GenericMakeStepFactory()
{
}

Tobias Hunger's avatar
Tobias Hunger committed
311
bool GenericMakeStepFactory::canCreate(ProjectExplorer::BuildStepList *parent,
312
                                       const QString &id) const
313
{
Tobias Hunger's avatar
Tobias Hunger committed
314
    if (parent->target()->project()->id() != QLatin1String(Constants::GENERICPROJECT_ID))
315 316 317 318
        return false;
    return id == QLatin1String(GENERIC_MS_ID);
}

Tobias Hunger's avatar
Tobias Hunger committed
319
ProjectExplorer::BuildStep *GenericMakeStepFactory::create(ProjectExplorer::BuildStepList *parent,
320 321
                                                           const QString &id)
{
Tobias Hunger's avatar
Tobias Hunger committed
322
    if (!canCreate(parent, id))
323 324 325 326
        return 0;
    return new GenericMakeStep(parent);
}

Tobias Hunger's avatar
Tobias Hunger committed
327
bool GenericMakeStepFactory::canClone(ProjectExplorer::BuildStepList *parent,
328 329 330
                                      ProjectExplorer::BuildStep *source) const
{
    const QString id(source->id());
Tobias Hunger's avatar
Tobias Hunger committed
331
    return canCreate(parent, id);
332 333
}

Tobias Hunger's avatar
Tobias Hunger committed
334
ProjectExplorer::BuildStep *GenericMakeStepFactory::clone(ProjectExplorer::BuildStepList *parent,
335
                                                          ProjectExplorer::BuildStep *source)
Roberto Raggi's avatar
Roberto Raggi committed
336
{
Tobias Hunger's avatar
Tobias Hunger committed
337
    if (!canClone(parent, source))
338 339 340 341
        return 0;
    GenericMakeStep *old(qobject_cast<GenericMakeStep *>(source));
    Q_ASSERT(old);
    return new GenericMakeStep(parent, old);
Roberto Raggi's avatar
Roberto Raggi committed
342 343
}

Tobias Hunger's avatar
Tobias Hunger committed
344
bool GenericMakeStepFactory::canRestore(ProjectExplorer::BuildStepList *parent,
345
                                        const QVariantMap &map) const
Roberto Raggi's avatar
Roberto Raggi committed
346
{
347
    QString id(ProjectExplorer::idFromMap(map));
Tobias Hunger's avatar
Tobias Hunger committed
348
    return canCreate(parent, id);
349 350
}

Tobias Hunger's avatar
Tobias Hunger committed
351
ProjectExplorer::BuildStep *GenericMakeStepFactory::restore(ProjectExplorer::BuildStepList *parent,
352
                                                            const QVariantMap &map)
353
{
Tobias Hunger's avatar
Tobias Hunger committed
354
    if (!canRestore(parent, map))
355 356 357 358 359 360
        return 0;
    GenericMakeStep *bs(new GenericMakeStep(parent));
    if (bs->fromMap(map))
        return bs;
    delete bs;
    return 0;
Roberto Raggi's avatar
Roberto Raggi committed
361 362
}

Tobias Hunger's avatar
Tobias Hunger committed
363
QStringList GenericMakeStepFactory::availableCreationIds(ProjectExplorer::BuildStepList *parent) const
Roberto Raggi's avatar
Roberto Raggi committed
364
{
Tobias Hunger's avatar
Tobias Hunger committed
365
    if (parent->target()->project()->id() != QLatin1String(Constants::GENERICPROJECT_ID))
366 367
        return QStringList();
    return QStringList() << QLatin1String(GENERIC_MS_ID);
Roberto Raggi's avatar
Roberto Raggi committed
368 369
}

370
QString GenericMakeStepFactory::displayNameForId(const QString &id) const
Roberto Raggi's avatar
Roberto Raggi committed
371
{
372 373 374 375
    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
376
}