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
**
con's avatar
con committed
5
** Copyright (c) 2011 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 <coreplugin/variablemanager.h>
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
46
#include <utils/stringutils.h>
47
#include <utils/qtcassert.h>
48
#include <utils/qtcprocess.h>
49

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

using namespace GenericProjectManager;
using namespace GenericProjectManager::Internal;

59 60 61 62 63 64 65 66
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");
67
const char * const CLEAN_KEY("GenericProjectManager.GenericMakeStep.Clean");
68 69
}

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

Tobias Hunger's avatar
Tobias Hunger committed
77
GenericMakeStep::GenericMakeStep(ProjectExplorer::BuildStepList *parent, const QString &id) :
78 79
    AbstractProcessStep(parent, id),
    m_clean(false)
80 81 82 83
{
    ctor();
}

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

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

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

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

109
bool GenericMakeStep::init()
Roberto Raggi's avatar
Roberto Raggi committed
110
{
dt's avatar
dt committed
111
    GenericBuildConfiguration *bc = genericBuildConfiguration();
Roberto Raggi's avatar
Roberto Raggi committed
112

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

121 122 123 124 125
    // 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);

126
    setOutputParser(new ProjectExplorer::GnuMakeParser());
Tobias Hunger's avatar
Tobias Hunger committed
127 128
    if (bc->genericTarget()->genericProject()->toolChain())
        appendOutputParser(bc->genericTarget()->genericProject()->toolChain()->outputParser());
129
    outputParser()->setWorkingDirectory(pp->effectiveWorkingDirectory());
Tobias Hunger's avatar
Tobias Hunger committed
130 131

    return AbstractProcessStep::init();
132 133
}

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

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

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

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

    return BuildStep::fromMap(map);
163 164
}

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

172
QString GenericMakeStep::makeCommand() const
173
{
174
    QString command = m_makeCommand;
175
    if (command.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
176
        GenericProject *pro = genericBuildConfiguration()->genericTarget()->genericProject();
dt's avatar
dt committed
177
        if (ProjectExplorer::ToolChain *toolChain = pro->toolChain())
178 179 180 181 182
            command = toolChain->makeCommand();
        else
            command = QLatin1String("make");
    }
    return command;
Roberto Raggi's avatar
Roberto Raggi committed
183 184
}

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

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

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

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

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

213
    m_buildTargets = old;
Roberto Raggi's avatar
Roberto Raggi committed
214 215 216
}

//
217
// GenericMakeStepConfigWidget
Roberto Raggi's avatar
Roberto Raggi committed
218
//
219 220

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

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

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

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

    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
250 251
}

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

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

263 264
void GenericMakeStepConfigWidget::updateDetails()
{
265 266 267 268 269 270 271 272 273
    GenericBuildConfiguration *bc = m_makeStep->genericBuildConfiguration();

    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());
274 275 276
    emit updateSummary();
}

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

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

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

void GenericMakeStepConfigWidget::makeArgumentsLineEditTextEdited()
{
296
    m_makeStep->m_makeArguments = 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
}