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

CustomWizard: Make sure to create wizards with unique ids only

Browse Source 
* Warn when somebody tries to register the same id twice
* Make sure the user wizards override the global once so that
  this warning actually makes sense

Change-Id: I69624666960c8836e25fd34abeef67015c1363ad
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
This commit is contained in:
Tobias Hunger
2015-11-18 13:19:20 +01:00
parent e39b515cd2
commit c62ad6c450
1 changed files with 28 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/plugins/projectexplorer/customwizard/customwizard.cpp
View File

@@ -40,6 +40,7 @@
#include <coreplugin/messagemanager.h> #include <coreplugin/messagemanager.h>
#include <extensionsystem/pluginmanager.h> #include <extensionsystem/pluginmanager.h>
#include <utils/algorithm.h>
#include <utils/fileutils.h> #include <utils/fileutils.h>
#include <utils/qtcassert.h> #include <utils/qtcassert.h>
@@ -358,7 +359,6 @@ CustomWizard *CustomWizard::createWizard(const CustomProjectWizard::CustomWizard
QList<Core::IWizardFactory *> CustomWizard::createWizards() QList<Core::IWizardFactory *> CustomWizard::createWizards()
{ {
QList<Core::IWizardFactory *> rc;
QString errorMessage; QString errorMessage;
QString verboseLog; QString verboseLog;
const QString templateDirName = Core::ICore::resourcePath() + const QString templateDirName = Core::ICore::resourcePath() +
@@ -371,29 +371,32 @@ QList<Core::IWizardFactory *> CustomWizard::createWizards()
const QDir templateDir(templateDirName); const QDir templateDir(templateDirName);
if (CustomWizardPrivate::verbose) if (CustomWizardPrivate::verbose)
verboseLog = QString::fromLatin1("### CustomWizard: Checking \"%1\"\n").arg(templateDirName); verboseLog += QString::fromLatin1("### CustomWizard: Checking \"%1\"\n").arg(templateDirName);
if (!templateDir.exists()) { if (!templateDir.exists()) {
if (CustomWizardPrivate::verbose) if (CustomWizardPrivate::verbose)
qWarning("Custom project template path %s does not exist.", qPrintable(templateDir.absolutePath())); qWarning("Custom project template path %s does not exist.", qPrintable(templateDir.absolutePath()));
return rc; return QList<Core::IWizardFactory *>();
} }
const QDir userTemplateDir(userTemplateDirName); const QDir userTemplateDir(userTemplateDirName);
if (CustomWizardPrivate::verbose) if (CustomWizardPrivate::verbose)
verboseLog = QString::fromLatin1("### CustomWizard: Checking \"%1\"\n").arg(userTemplateDirName); verboseLog += QString::fromLatin1("### CustomWizard: Checking \"%1\"\n").arg(userTemplateDirName);
const QDir::Filters filters = QDir::Dirs|QDir::Readable|QDir::NoDotAndDotDot; const QDir::Filters filters = QDir::Dirs|QDir::Readable|QDir::NoDotAndDotDot;
const QDir::SortFlags sortflags = QDir::Name|QDir::IgnoreCase; const QDir::SortFlags sortflags = QDir::Name|QDir::IgnoreCase;
QList<QFileInfo> dirs = templateDir.entryInfoList(filters, sortflags); QList<QFileInfo> dirs;
if (userTemplateDir.exists()) { if (userTemplateDir.exists()) {
if (CustomWizardPrivate::verbose) if (CustomWizardPrivate::verbose)
verboseLog = QString::fromLatin1("### CustomWizard: userTemplateDir \"%1\" found, adding\n").arg(userTemplateDirName); verboseLog += QString::fromLatin1("### CustomWizard: userTemplateDir \"%1\" found, adding\n").arg(userTemplateDirName);
dirs += userTemplateDir.entryInfoList(filters, sortflags); dirs += userTemplateDir.entryInfoList(filters, sortflags);
} }
dirs += templateDir.entryInfoList(filters, sortflags);
const QString configFile = QLatin1String(configFileC); const QString configFile = QLatin1String(configFileC);
// Check and parse config file in each directory. // Check and parse config file in each directory.
QList<CustomWizardParametersPtr> toCreate;
while (!dirs.isEmpty()) { while (!dirs.isEmpty()) {
const QFileInfo dirFi = dirs.takeFirst(); const QFileInfo dirFi = dirs.takeFirst();
const QDir dir(dirFi.absoluteFilePath()); const QDir dir(dirFi.absoluteFilePath());
@@ -403,11 +406,13 @@ QList<Core::IWizardFactory *> CustomWizard::createWizards()
CustomWizardParametersPtr parameters(new CustomWizardParameters); CustomWizardParametersPtr parameters(new CustomWizardParameters);
switch (parameters->parse(dir.absoluteFilePath(configFile), &errorMessage)) { switch (parameters->parse(dir.absoluteFilePath(configFile), &errorMessage)) {
case CustomWizardParameters::ParseOk: case CustomWizardParameters::ParseOk:
parameters->directory = dir.absolutePath(); if (!Utils::contains(toCreate, [parameters](CustomWizardParametersPtr p) { return parameters->id == p->id; })) {
if (CustomWizard *w = createWizard(parameters)) parameters->directory = dir.absolutePath();
rc.push_back(w); toCreate.append(parameters);
else } else {
qWarning("Custom wizard factory function failed for %s", qPrintable(parameters->id.toString())); verboseLog += QString::fromLatin1("Customwizard: Ignoring wizard in %1 due to duplicate Id %2.\n")
.arg(dir.absolutePath()).arg(parameters->id.toString());
}
break; break;
case CustomWizardParameters::ParseDisabled: case CustomWizardParameters::ParseDisabled:
if (CustomWizardPrivate::verbose) if (CustomWizardPrivate::verbose)
@@ -429,6 +434,18 @@ QList<Core::IWizardFactory *> CustomWizard::createWizards()
} }
} }
} }
QList<Core::IWizardFactory *> rc;
foreach (CustomWizardParametersPtr p, toCreate) {
if (CustomWizard *w = createWizard(p)) {
rc.push_back(w);
} else {
qWarning("Custom wizard factory function failed for %s from %s.",
qPrintable(p->id.toString()), qPrintable(p->directory));
}
}
if (CustomWizardPrivate::verbose) { // Print to output pane for Windows. if (CustomWizardPrivate::verbose) { // Print to output pane for Windows.
qWarning("%s", qPrintable(verboseLog)); qWarning("%s", qPrintable(verboseLog));
Core::MessageManager::write(verboseLog, Core::MessageManager::ModeSwitch); Core::MessageManager::write(verboseLog, Core::MessageManager::ModeSwitch);