genericmakestep.cpp 12.2 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>
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
43
#include <utils/stringutils.h>
44
#include <utils/qtcassert.h>
45

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

using namespace GenericProjectManager;
using namespace GenericProjectManager::Internal;

55 56 57 58 59 60 61 62 63 64
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
65 66
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent) :
    AbstractProcessStep(parent, QLatin1String(GENERIC_MS_ID))
67 68 69 70
{
    ctor();
}

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

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

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

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

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

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

105
    setEnabled(true);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
106 107
    QString buildDir = bc->buildDirectory();
    Utils::expandMacros(&buildDir, Core::VariableManager::instance()->macroExpander());
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
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
143
    Utils::AbstractMacroExpander *mx = Core::VariableManager::instance()->macroExpander();
144 145
    const QStringList targets = m_buildTargets;
    QStringList arguments = m_makeArguments;
146
    QStringList replacedArguments;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
147 148 149
    foreach (QString arg, arguments) {
        Utils::expandMacros(&arg, mx);
        replacedArguments << arg;
150
    }
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
151 152 153
    foreach (QString arg, targets) {
        Utils::expandMacros(&arg, mx);
        replacedArguments << arg;
154
    }
155 156
    return replacedArguments;
}
157

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

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

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

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

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

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

199
    m_buildTargets = old;
Roberto Raggi's avatar
Roberto Raggi committed
200 201 202
}

//
203
// GenericMakeStepConfigWidget
Roberto Raggi's avatar
Roberto Raggi committed
204
//
205 206

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

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

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

    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
231 232
}

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

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

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

248
    QString makeCommand = m_makeStep->m_makeCommand;
249 250
    m_ui->makeLineEdit->setText(makeCommand);

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

    // 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);
260
        item->setCheckState(m_makeStep->buildsTarget(item->text()) ? Qt::Checked : Qt::Unchecked);
Roberto Raggi's avatar
Roberto Raggi committed
261
    }
262

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

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

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

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

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

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

//
301
// GenericMakeStepFactory
Roberto Raggi's avatar
Roberto Raggi committed
302 303
//

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

GenericMakeStepFactory::~GenericMakeStepFactory()
{
}

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

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

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

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

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

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

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

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