forked from qt-creator/qt-creator
966f4ea6a9
Originally, the build manager used to run all build steps in a dedicated thread. Communication between the step and the manager happened via a QFutureInterface that was passed into the step's run() function. Later, new steps were added that operated asynchronously, so the build manager had to differentiate between the different kinds of steps for starting and stopping. These days, almost all build and deploy steps work asynchronously, which made the QFuture-based interface look increasingly odd. With this patch, all build steps are expected to work asynchronously, so the build manager no longer needs to differentiate. Steps are started and requested to stop via the run() and cancel() functions, respectively, and emit the finished() signal when they are done. Build step implementors no longer have to deal with a QFutureInterface. For steps whose implementation is inherently synchronous, the BuildStep base class offers a runInThread() function. Change-Id: If905c68b234c5a669f6e19f43142eaa57d594803 Reviewed-by: hjk <hjk@qt.io>
129 lines
4.2 KiB
C++
129 lines
4.2 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) Filippo Cucchetto <filippocucchetto@gmail.com>
|
|
** Contact: http://www.qt.io/licensing
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "nimcompilercleanstep.h"
|
|
#include "nimbuildconfiguration.h"
|
|
#include "nimcompilercleanstepconfigwidget.h"
|
|
|
|
#include "../nimconstants.h"
|
|
|
|
#include <projectexplorer/projectexplorerconstants.h>
|
|
#include <utils/qtcassert.h>
|
|
|
|
#include <QDir>
|
|
#include <QDateTime>
|
|
|
|
using namespace ProjectExplorer;
|
|
using namespace Utils;
|
|
|
|
namespace Nim {
|
|
|
|
NimCompilerCleanStep::NimCompilerCleanStep(BuildStepList *parentList)
|
|
: BuildStep(parentList, Constants::C_NIMCOMPILERCLEANSTEP_ID)
|
|
{
|
|
setDefaultDisplayName(tr("Nim Clean Step"));
|
|
setDisplayName(tr("Nim Clean Step"));
|
|
}
|
|
|
|
BuildStepConfigWidget *NimCompilerCleanStep::createConfigWidget()
|
|
{
|
|
return new NimCompilerCleanStepConfigWidget(this);
|
|
}
|
|
|
|
bool NimCompilerCleanStep::init()
|
|
{
|
|
FileName buildDir = buildConfiguration()->buildDirectory();
|
|
bool result = buildDir.exists();
|
|
if (result)
|
|
m_buildDir = buildDir;
|
|
return result;
|
|
}
|
|
|
|
void NimCompilerCleanStep::doRun()
|
|
{
|
|
if (!m_buildDir.exists()) {
|
|
emit addOutput(tr("Build directory \"%1\" does not exist.").arg(m_buildDir.toUserOutput()), BuildStep::OutputFormat::ErrorMessage);
|
|
emit finished(false);
|
|
return;
|
|
}
|
|
|
|
if (!removeCacheDirectory()) {
|
|
emit addOutput(tr("Failed to delete the cache directory."), BuildStep::OutputFormat::ErrorMessage);
|
|
emit finished(false);
|
|
return;
|
|
}
|
|
|
|
if (!removeOutFilePath()) {
|
|
emit addOutput(tr("Failed to delete the out file."), BuildStep::OutputFormat::ErrorMessage);
|
|
emit finished(false);
|
|
return;
|
|
}
|
|
|
|
emit addOutput(tr("Clean step completed successfully."), BuildStep::OutputFormat::NormalMessage);
|
|
emit finished(true);
|
|
}
|
|
|
|
void NimCompilerCleanStep::doCancel()
|
|
{
|
|
// Can be left empty. The run() function hardly does anything.
|
|
}
|
|
|
|
bool NimCompilerCleanStep::removeCacheDirectory()
|
|
{
|
|
auto bc = qobject_cast<NimBuildConfiguration*>(buildConfiguration());
|
|
QTC_ASSERT(bc, return false);
|
|
if (!bc->cacheDirectory().exists())
|
|
return true;
|
|
QDir dir = QDir::fromNativeSeparators(bc->cacheDirectory().toString());
|
|
const QString dirName = dir.dirName();
|
|
if (!dir.cdUp())
|
|
return false;
|
|
const QString newName = QStringLiteral("%1.bkp.%2").arg(dirName, QString::number(QDateTime::currentMSecsSinceEpoch()));
|
|
return dir.rename(dirName, newName);
|
|
}
|
|
|
|
bool NimCompilerCleanStep::removeOutFilePath()
|
|
{
|
|
auto bc = qobject_cast<NimBuildConfiguration*>(buildConfiguration());
|
|
QTC_ASSERT(bc, return false);
|
|
if (!bc->outFilePath().exists())
|
|
return true;
|
|
return QFile(bc->outFilePath().toFileInfo().absoluteFilePath()).remove();
|
|
}
|
|
|
|
// NimCompilerCleanStepFactory
|
|
|
|
NimCompilerCleanStepFactory::NimCompilerCleanStepFactory()
|
|
{
|
|
registerStep<NimCompilerCleanStep>(Constants::C_NIMCOMPILERCLEANSTEP_ID);
|
|
setFlags(BuildStepInfo::Unclonable);
|
|
setSupportedStepList(ProjectExplorer::Constants::BUILDSTEPS_CLEAN);
|
|
setSupportedConfiguration(Constants::C_NIMBUILDCONFIGURATION_ID);
|
|
setRepeatable(false);
|
|
setDisplayName(NimCompilerCleanStep::tr(Nim::Constants::C_NIMCOMPILERCLEANSTEP_DISPLAY));
|
|
}
|
|
|
|
} // Nim
|