feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

ProjectExplorer/all: Re-organize BuildSteps/{Deploy,Build}Config setup

Browse Source 
This follow the rough pattern of recent *RunConfigurationFactory changes
for build and deploy configurations.

- Collapse the two lines of constructors similar to what
  890c1906e6 did for RunConfigurations
  * Deploy* was purely mechanical
  * Build* ctors are split in connects() in the ctor body
    to create "empty shell for clone" etc
    and build step additions in initialize() functions which
    are only used in the create() case.
  -- Allows to collapse the shared 'ctor()' functions, too.

- Move FooBuildConfigurationFactory::create() implementations
  to FooBuildConfiguration() constructor. That was a strange
  and unneeded ping-pong between factories and objects, and
  furthermore allows one level less of indirection (and for a
  later, left out here, some reduction of the
  FooBuildConfiguration interfaces that were only used to
  accommodate the *Factory::create() functions.

- Most {Build,Deploy}Configuration{,Factory} classes had a canHandle(),
  but there wasn't one in the base classses. Have one there.

- Most canHandle() functions were checking simple restrictions on
  e.g. project or target types, specify those by setters in the
  constructors instead and check them in the base canHandle()

- clone() is generally replaced by a creation of a "shell object"
  and a fromMap(source->toMap()), implemented in the base, there
  are two cases left for Android and Qbs that needed(?) some extra
  polish

- generally use canHandle() in base implementation, instead
  of doing that in all Derived::canFoo()

- as a result, canCreate/create/canClone/clone reimplementations
  are not needed anymore, keep the base implementation for
  now (could be inlined into their only users later), but
  de-virtualize them.

- Combine Ios{Preset,DSym}BuildStepFactory. There was only one
  'dsym' build step they could create.

- Split the 'mangled' id into the ProjectConfiguration subtype
  specific constant identifier, and a QString extraId() bit.
  Only maintain the mangled id in saved settings.

- Make ProjectConfiguration::m_id a constant member, adapt
  all constructors of derived classe.

Not done in this patch:

- Finish possible cosmetic changes on top

- Add a way to specify restrictions to supported Qt versions
  (used in Android/Ios), as the base implementation does not
  depend on the qtsupport plugin

- Combine the QList<X> availableFoo() + createFoo(X) function
  pairs to somthing like a direct
   QList<struct { X; std::function<X()>; }> fooCreators()
  to avoid e.g. the baseId.withSuffix() <-> id.suffixAfter(base)
  pingpong

- Remove the *Factories from the global object pool

- Do something about priority(). Falling back to plain
  qmake in android+qmake setup is not helpful.

Change-Id: I2be7d88d554c5aa8b7db8edf5b93278e1ae0112a
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
This commit is contained in:
hjk
2017-11-29 12:28:40 +01:00
parent 9d3c5c6ff5
commit 53a151074a
174 changed files with 2042 additions and 4705 deletions
Download Patch File Download Diff File Expand all files Collapse all files

448
src/plugins/ios/iosdsymbuildstep.cpp
View File

@@ -56,31 +56,13 @@ static const char COMMAND_PARTIAL_KEY[] = ".Command";
static const char ARGUMENTS_PARTIAL_KEY[] = ".Arguments";
static const char CLEAN_PARTIAL_KEY[] = ".Clean";
IosPresetBuildStep::IosPresetBuildStep(BuildStepList *parent, const Id id) :
AbstractProcessStep(parent, id),
IosDsymBuildStep::IosDsymBuildStep(BuildStepList *parent) :
AbstractProcessStep(parent, Constants::IOS_DSYM_BUILD_STEP_ID),
m_clean(parent->id() == ProjectExplorer::Constants::BUILDSTEPS_CLEAN)
{
}
bool IosPresetBuildStep::completeSetup()
{
m_command = defaultCommand();
m_arguments = defaultArguments();
return true;
}
bool IosPresetBuildStep::completeSetupWithStep(BuildStep *bs)
{
IosPresetBuildStep *o = qobject_cast<IosPresetBuildStep *>(bs);
if (!o)
return false;
m_arguments = o->m_arguments;
m_clean = o->m_clean;
m_command = o->m_command;
return true;
}
bool IosPresetBuildStep::init(QList<const BuildStep *> &earlierSteps)
bool IosDsymBuildStep::init(QList<const BuildStep *> &earlierSteps)
{
BuildConfiguration *bc = buildConfiguration();
if (!bc)
@@ -108,7 +90,7 @@ bool IosPresetBuildStep::init(QList<const BuildStep *> &earlierSteps)
return AbstractProcessStep::init(earlierSteps);
}
QVariantMap IosPresetBuildStep::toMap() const
QVariantMap IosDsymBuildStep::toMap() const
{
QVariantMap map(AbstractProcessStep::toMap());
@@ -121,7 +103,7 @@ QVariantMap IosPresetBuildStep::toMap() const
return map;
}
bool IosPresetBuildStep::fromMap(const QVariantMap &map)
bool IosDsymBuildStep::fromMap(const QVariantMap &map)
{
QVariant bArgs = map.value(id().withSuffix(ARGUMENTS_PARTIAL_KEY).toString());
m_arguments = bArgs.toStringList();
@@ -138,14 +120,14 @@ bool IosPresetBuildStep::fromMap(const QVariantMap &map)
return BuildStep::fromMap(map);
}
QStringList IosPresetBuildStep::defaultArguments() const
QStringList IosDsymBuildStep::defaultArguments() const
{
if (m_clean)
return defaultCleanCmdList().mid(1);
return defaultCmdList().mid(1);
}
QString IosPresetBuildStep::defaultCommand() const
QString IosDsymBuildStep::defaultCommand() const
{
if (m_clean)
return defaultCleanCmdList().at(0);
@@ -153,248 +135,9 @@ QString IosPresetBuildStep::defaultCommand() const
return defaultCmdList().at(0);
}
QString IosPresetBuildStep::command() const
{
if (m_command.isEmpty())
return defaultCommand();
return m_command;
}
void IosPresetBuildStep::setCommand(const QString &command)
{
if (command == m_command)
return;
if (command.isEmpty() || command == defaultCommand()) {
if (arguments() == defaultArguments())
m_command.clear();
else
m_command = defaultCommand();
} else if (m_command.isEmpty()) {
m_arguments = defaultArguments();
m_command = command;
} else {
m_command = command;
}
}
bool IosPresetBuildStep::clean() const
{
return m_clean;
}
void IosPresetBuildStep::setClean(bool clean)
{
if (m_clean != clean) {
m_clean = clean;
m_arguments = defaultArguments();
m_command = defaultCommand();
}
}
bool IosPresetBuildStep::isDefault() const
{
return arguments() == defaultArguments() && command() == defaultCommand();
}
void IosPresetBuildStep::run(QFutureInterface<bool> &fi)
{
AbstractProcessStep::run(fi);
}
BuildStepConfigWidget *IosPresetBuildStep::createConfigWidget()
{
return new IosPresetBuildStepConfigWidget(this);
}
bool IosPresetBuildStep::immutable() const
{
return false;
}
void IosPresetBuildStep::setArguments(const QStringList &args)
{
if (arguments() == args)
return;
if (args == defaultArguments() && command() == defaultCommand())
m_command.clear();
else {
if (m_command.isEmpty())
m_command = defaultCommand();
m_arguments = args;
}
}
QStringList IosPresetBuildStep::arguments() const
{
if (m_command.isEmpty())
return defaultArguments();
return m_arguments;
}
//
// IosPresetBuildStepConfigWidget
//
IosPresetBuildStepConfigWidget::IosPresetBuildStepConfigWidget(IosPresetBuildStep *buildStep)
: m_buildStep(buildStep)
{
m_ui = new Ui::IosPresetBuildStep;
m_ui->setupUi(this);
Project *pro = m_buildStep->target()->project();
m_ui->commandLineEdit->setText(m_buildStep->command());
m_ui->argumentsTextEdit->setPlainText(Utils::QtcProcess::joinArgs(
m_buildStep->arguments()));
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
connect(m_ui->argumentsTextEdit, &QPlainTextEdit::textChanged,
this, &IosPresetBuildStepConfigWidget::argumentsChanged);
connect(m_ui->commandLineEdit, &QLineEdit::editingFinished,
this, &IosPresetBuildStepConfigWidget::commandChanged);
connect(m_ui->resetDefaultsButton, &QAbstractButton::clicked,
this, &IosPresetBuildStepConfigWidget::resetDefaults);
connect(ProjectExplorerPlugin::instance(), &ProjectExplorerPlugin::settingsChanged,
this, &IosPresetBuildStepConfigWidget::updateDetails);
connect(m_buildStep->target(), &Target::kitChanged,
this, &IosPresetBuildStepConfigWidget::updateDetails);
pro->subscribeSignal(&BuildConfiguration::environmentChanged, this, [this]() {
if (static_cast<BuildConfiguration *>(sender())->isActive())
updateDetails();
});
connect(pro, &Project::activeProjectConfigurationChanged,
this, [this](ProjectConfiguration *pc) {
if (pc && pc->isActive())
updateDetails();
});
}
IosPresetBuildStepConfigWidget::~IosPresetBuildStepConfigWidget()
{
delete m_ui;
}
QString IosPresetBuildStepConfigWidget::displayName() const
{
return m_buildStep->displayName();
}
void IosPresetBuildStepConfigWidget::updateDetails()
{
BuildConfiguration *bc = m_buildStep->buildConfiguration();
if (!bc)
bc = m_buildStep->target()->activeBuildConfiguration();
ProcessParameters param;
param.setMacroExpander(bc->macroExpander());
param.setWorkingDirectory(bc->buildDirectory().toString());
param.setEnvironment(bc->environment());
param.setCommand(m_buildStep->command());
param.setArguments(Utils::QtcProcess::joinArgs(m_buildStep->arguments()));
m_summaryText = param.summary(displayName());
emit updateSummary();
}
QString IosPresetBuildStepConfigWidget::summaryText() const
{
return m_summaryText;
}
void IosPresetBuildStepConfigWidget::commandChanged()
{
m_buildStep->setCommand(m_ui->commandLineEdit->text());
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
}
void IosPresetBuildStepConfigWidget::argumentsChanged()
{
m_buildStep->setArguments(Utils::QtcProcess::splitArgs(
m_ui->argumentsTextEdit->toPlainText()));
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
}
void IosPresetBuildStepConfigWidget::resetDefaults()
{
m_buildStep->setCommand(m_buildStep->defaultCommand());
m_buildStep->setArguments(m_buildStep->defaultArguments());
m_ui->commandLineEdit->setText(m_buildStep->command());
m_ui->argumentsTextEdit->setPlainText(Utils::QtcProcess::joinArgs(
m_buildStep->arguments()));
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
}
//
// IosPresetBuildStepFactory
//
IosPresetBuildStepFactory::IosPresetBuildStepFactory(QObject *parent) :
IBuildStepFactory(parent)
{
}
BuildStep *IosPresetBuildStepFactory::create(BuildStepList *parent, const Id id)
{
IosPresetBuildStep *step = createPresetStep(parent, id);
if (step->completeSetup())
return step;
delete step;
return 0;
}
BuildStep *IosPresetBuildStepFactory::clone(BuildStepList *parent, BuildStep *source)
{
IosPresetBuildStep *old = qobject_cast<IosPresetBuildStep *>(source);
Q_ASSERT(old);
IosPresetBuildStep *res = createPresetStep(parent, old->id());
if (res->completeSetupWithStep(old))
return res;
delete res;
return 0;
}
BuildStep *IosPresetBuildStepFactory::restore(BuildStepList *parent, const QVariantMap &map)
{
IosPresetBuildStep *bs = createPresetStep(parent, idFromMap(map));
if (bs->fromMap(map))
return bs;
delete bs;
return 0;
}
QList<BuildStepInfo> IosDsymBuildStepFactory::availableSteps(BuildStepList *parent) const
{
if (parent->id() != ProjectExplorer::Constants::BUILDSTEPS_CLEAN
&& parent->id() != ProjectExplorer::Constants::BUILDSTEPS_BUILD
&& parent->id() != ProjectExplorer::Constants::BUILDSTEPS_DEPLOY)
return {};
Id deviceType = DeviceTypeKitInformation::deviceTypeId(parent->target()->kit());
if (deviceType != Constants::IOS_DEVICE_TYPE && deviceType != Constants::IOS_SIMULATOR_TYPE)
return {};
return {{Constants::IOS_DSYM_BUILD_STEP_ID, "dsymutil"}};
}
IosPresetBuildStep *IosDsymBuildStepFactory::createPresetStep(BuildStepList *parent, const Id id) const
{
return new IosDsymBuildStep(parent, id);
}
IosDsymBuildStep::IosDsymBuildStep(BuildStepList *parent, const Id id)
: IosPresetBuildStep(parent, id)
{
setDefaultDisplayName("dsymutil");
}
QStringList IosDsymBuildStep::defaultCleanCmdList() const
{
IosRunConfiguration *runConf =
qobject_cast<IosRunConfiguration *>(target()->activeRunConfiguration());
auto runConf = qobject_cast<IosRunConfiguration *>(target()->activeRunConfiguration());
QTC_ASSERT(runConf, return QStringList("echo"));
QString dsymPath = runConf->bundleDirectory().toUserOutput();
dsymPath.chop(4);
@@ -418,6 +161,181 @@ QStringList IosDsymBuildStep::defaultCmdList() const
return QStringList({dsymutilCmd, "-o", dsymPath, runConf->localExecutable().toUserOutput()});
}
QString IosDsymBuildStep::command() const
{
if (m_command.isEmpty())
return defaultCommand();
return m_command;
}
void IosDsymBuildStep::setCommand(const QString &command)
{
if (command == m_command)
return;
if (command.isEmpty() || command == defaultCommand()) {
if (arguments() == defaultArguments())
m_command.clear();
else
m_command = defaultCommand();
} else if (m_command.isEmpty()) {
m_arguments = defaultArguments();
m_command = command;
} else {
m_command = command;
}
}
bool IosDsymBuildStep::isDefault() const
{
return arguments() == defaultArguments() && command() == defaultCommand();
}
void IosDsymBuildStep::run(QFutureInterface<bool> &fi)
{
AbstractProcessStep::run(fi);
}
BuildStepConfigWidget *IosDsymBuildStep::createConfigWidget()
{
return new IosDsymBuildStepConfigWidget(this);
}
bool IosDsymBuildStep::immutable() const
{
return false;
}
void IosDsymBuildStep::setArguments(const QStringList &args)
{
if (arguments() == args)
return;
if (args == defaultArguments() && command() == defaultCommand())
m_command.clear();
else {
if (m_command.isEmpty())
m_command = defaultCommand();
m_arguments = args;
}
}
QStringList IosDsymBuildStep::arguments() const
{
if (m_command.isEmpty())
return defaultArguments();
return m_arguments;
}
//
// IosDsymBuildStepConfigWidget
//
IosDsymBuildStepConfigWidget::IosDsymBuildStepConfigWidget(IosDsymBuildStep *buildStep)
: m_buildStep(buildStep)
{
m_ui = new Ui::IosPresetBuildStep;
m_ui->setupUi(this);
Project *pro = m_buildStep->target()->project();
m_ui->commandLineEdit->setText(m_buildStep->command());
m_ui->argumentsTextEdit->setPlainText(Utils::QtcProcess::joinArgs(
m_buildStep->arguments()));
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
connect(m_ui->argumentsTextEdit, &QPlainTextEdit::textChanged,
this, &IosDsymBuildStepConfigWidget::argumentsChanged);
connect(m_ui->commandLineEdit, &QLineEdit::editingFinished,
this, &IosDsymBuildStepConfigWidget::commandChanged);
connect(m_ui->resetDefaultsButton, &QAbstractButton::clicked,
this, &IosDsymBuildStepConfigWidget::resetDefaults);
connect(ProjectExplorerPlugin::instance(), &ProjectExplorerPlugin::settingsChanged,
this, &IosDsymBuildStepConfigWidget::updateDetails);
connect(m_buildStep->target(), &Target::kitChanged,
this, &IosDsymBuildStepConfigWidget::updateDetails);
pro->subscribeSignal(&BuildConfiguration::environmentChanged, this, [this]() {
if (static_cast<BuildConfiguration *>(sender())->isActive())
updateDetails();
});
connect(pro, &Project::activeProjectConfigurationChanged,
this, [this](ProjectConfiguration *pc) {
if (pc && pc->isActive())
updateDetails();
});
}
IosDsymBuildStepConfigWidget::~IosDsymBuildStepConfigWidget()
{
delete m_ui;
}
QString IosDsymBuildStepConfigWidget::displayName() const
{
return m_buildStep->displayName();
}
void IosDsymBuildStepConfigWidget::updateDetails()
{
BuildConfiguration *bc = m_buildStep->buildConfiguration();
if (!bc)
bc = m_buildStep->target()->activeBuildConfiguration();
ProcessParameters param;
param.setMacroExpander(bc->macroExpander());
param.setWorkingDirectory(bc->buildDirectory().toString());
param.setEnvironment(bc->environment());
param.setCommand(m_buildStep->command());
param.setArguments(Utils::QtcProcess::joinArgs(m_buildStep->arguments()));
m_summaryText = param.summary(displayName());
emit updateSummary();
}
QString IosDsymBuildStepConfigWidget::summaryText() const
{
return m_summaryText;
}
void IosDsymBuildStepConfigWidget::commandChanged()
{
m_buildStep->setCommand(m_ui->commandLineEdit->text());
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
}
void IosDsymBuildStepConfigWidget::argumentsChanged()
{
m_buildStep->setArguments(Utils::QtcProcess::splitArgs(
m_ui->argumentsTextEdit->toPlainText()));
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
}
void IosDsymBuildStepConfigWidget::resetDefaults()
{
m_buildStep->setCommand(m_buildStep->defaultCommand());
m_buildStep->setArguments(m_buildStep->defaultArguments());
m_ui->commandLineEdit->setText(m_buildStep->command());
m_ui->argumentsTextEdit->setPlainText(Utils::QtcProcess::joinArgs(
m_buildStep->arguments()));
m_ui->resetDefaultsButton->setEnabled(!m_buildStep->isDefault());
updateDetails();
}
//
// IosDsymBuildStepFactory
//
IosDsymBuildStepFactory::IosDsymBuildStepFactory()
{
registerStep<IosDsymBuildStep>(Constants::IOS_DSYM_BUILD_STEP_ID);
setSupportedStepLists({ProjectExplorer::Constants::BUILDSTEPS_CLEAN,
ProjectExplorer::Constants::BUILDSTEPS_BUILD,
ProjectExplorer::Constants::BUILDSTEPS_DEPLOY});
setSupportedDeviceTypes({Constants::IOS_DEVICE_TYPE,
Constants::IOS_SIMULATOR_TYPE});
setDisplayName("dsymutil");
}
} // namespace Internal
} // namespace Ios