Add JsonWizard

This is a generalization of the customwizard (using Json for its
configuration files since that is so easy to handle in Qt 5 and
since it is incompatible with the customwizard anyway).

It allows to define an arbitrary number of pages and generators to
generate the actual files.

Change-Id: I45a01cf7fb906701b627fa1471a898cad472f679
Reviewed-by: Daniel Teske <daniel.teske@digia.com>

src/plugins/projectexplorer/jsonwizard/jsonwizard.cpp

+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "jsonwizard.h"
+
+#include "jsonwizardexpander.h"
+#include "jsonwizardgeneratorfactory.h"
+
+#include <utils/algorithm.h>
+#include <utils/qtcassert.h>
+
+#include <QFileInfo>
+#include <QMessageBox>
+#include <QVariant>
+
+namespace ProjectExplorer {
+
+JsonWizard::JsonWizard(QWidget *parent) :
+    Utils::Wizard(parent),
+    m_expander(new Internal::JsonWizardExpander(this))
+{ }
+
+JsonWizard::~JsonWizard()
+{
+    qDeleteAll(m_generators);
+    delete m_expander;
+}
+
+void JsonWizard::addGenerator(JsonWizardGenerator *gen)
+{
+    QTC_ASSERT(gen, return);
+    QTC_ASSERT(!m_generators.contains(gen), return);
+
+    m_generators.append(gen);
+}
+
+Utils::AbstractMacroExpander *JsonWizard::expander() const
+{
+    return m_expander;
+}
+
+JsonWizard::GeneratorFiles JsonWizard::fileList()
+{
+    QString errorMessage;
+    GeneratorFiles list;
+
+    QString targetPath = value(QLatin1String("TargetPath")).toString();
+    if (targetPath.isEmpty()) {
+        errorMessage = tr("Could not determine target path. \"TargetPath\", \"Path\", or "
+                          "\"ProjectName\" were not set on any page.");
+        return list;
+    }
+
+    if (m_files.isEmpty()) {
+        emit preGenerateFiles();
+        foreach (JsonWizardGenerator *gen, m_generators) {
+            Core::GeneratedFiles tmp = gen->fileList(m_expander, value(QStringLiteral("WizardDir")).toString(),
+                                                     targetPath, &errorMessage);
+            if (!errorMessage.isEmpty())
+                break;
+            list.append(Utils::transform(tmp, [&gen](const Core::GeneratedFile &f)
+                                              { return GeneratorFile(f, gen); }));
+        }
+
+        if (errorMessage.isEmpty())
+            m_files = list;
+        emit postGenerateFiles(m_files);
+    }
+
+    if (!errorMessage.isEmpty()) {
+        QMessageBox::critical(this, tr("File Generation Failed"),
+                              tr("The wizard failed to generate files.<br>"
+                                 "The error message was: \"%1\".").arg(errorMessage));
+        reject();
+        return GeneratorFiles();
+    }
+
+    return m_files;
+}
+
+QVariant JsonWizard::value(const QString &n) const
+{
+    QVariant v = property(n.toUtf8());
+    if (v.isValid()) {
+        if (v.type() == QVariant::String)
+            return Utils::expandMacros(v.toString(), m_expander);
+        else
+            return v;
+    }
+    if (hasField(n))
+        return field(n); // Can not contain macros!
+    return QVariant();
+}
+
+void JsonWizard::setValue(const QString &key, const QVariant &value)
+{
+    setProperty(key.toUtf8(), value);
+}
+
+bool JsonWizard::boolFromVariant(const QVariant &v, Utils::AbstractMacroExpander *expander)
+{
+    if (v.type() == QVariant::String)
+        return !Utils::expandMacros(v.toString(), expander).isEmpty();
+    return v.toBool();
+}
+
+void JsonWizard::accept()
+{
+
+    Utils::Wizard::accept();
+
+    QString errorMessage;
+    GeneratorFiles list = fileList();
+
+    if (list.isEmpty())
+        return;
+
+    emit prePromptForOverwrite(m_files);
+    JsonWizardGenerator::OverwriteResult overwrite =
+            JsonWizardGenerator::promptForOverwrite(&list, &errorMessage);
+    if (overwrite == JsonWizardGenerator::OverwriteError) {
+        if (!errorMessage.isEmpty())
+            QMessageBox::warning(this, tr("Failed to Overwrite Files"), errorMessage);
+        return;
+    }
+
+    emit preFormatFiles(m_files);
+    if (!JsonWizardGenerator::formatFiles(this, &list, &errorMessage)) {
+        if (!errorMessage.isEmpty())
+            QMessageBox::warning(this, tr("Failed to Format Files"), errorMessage);
+        return;
+    }
+
+    emit preWriteFiles(m_files);
+    if (!JsonWizardGenerator::writeFiles(this, &list, &errorMessage)) {
+        if (!errorMessage.isEmpty())
+            QMessageBox::warning(this, tr("Failed to Write Files"), errorMessage);
+        return;
+    }
+
+    emit postProcessFiles(m_files);
+    if (!JsonWizardGenerator::postWrite(this, &list, &errorMessage)) {
+        if (!errorMessage.isEmpty())
+            QMessageBox::warning(this, tr("Failed to Post-Process Files"), errorMessage);
+        return;
+    }
+    emit filesReady(m_files);
+}
+
+} // namespace ProjectExplorer

src/plugins/projectexplorer/jsonwizard/jsonwizard.h

+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef JSONWIZARD_H
+#define JSONWIZARD_H
+
+#include "../projectexplorer_export.h"
+
+#include <coreplugin/generatedfile.h>
+
+#include <utils/wizard.h>
+
+namespace Utils { class AbstractMacroExpander; }
+
+namespace ProjectExplorer {
+
+namespace Internal { class JsonWizardExpander; }
+
+class JsonWizardGenerator;
+
+// Documentation inside.
+class PROJECTEXPLORER_EXPORT JsonWizard : public Utils::Wizard
+{
+    Q_OBJECT
+
+public:
+    class GeneratorFile {
+    public:
+        GeneratorFile() : generator(0) { }
+        GeneratorFile(const Core::GeneratedFile &f, JsonWizardGenerator *g) :
+            file(f), generator(g)
+        { }
+
+        bool isValid() const { return generator; }
+
+        Core::GeneratedFile file;
+        JsonWizardGenerator *generator;
+    };
+    typedef QList<GeneratorFile> GeneratorFiles;
+    Q_PROPERTY(GeneratorFiles fileList READ fileList)
+
+    explicit JsonWizard(QWidget *parent = 0);
+    ~JsonWizard();
+
+    void addGenerator(JsonWizardGenerator *gen);
+
+    Utils::AbstractMacroExpander *expander() const;
+
+    GeneratorFiles fileList();
+
+    QVariant value(const QString &n) const;
+    void setValue(const QString &key, const QVariant &value);
+
+    static bool boolFromVariant(const QVariant &v, Utils::AbstractMacroExpander *expander);
+
+signals:
+    void preGenerateFiles(); // emitted before files are generated.
+    void postGenerateFiles(const JsonWizard::GeneratorFiles &files); // emitted after files are generated.
+    void prePromptForOverwrite(const JsonWizard::GeneratorFiles &files); // emitted before overwriting checks are done.
+    void preFormatFiles(const JsonWizard::GeneratorFiles &files); // emitted before files are formatted.
+    void preWriteFiles(const JsonWizard::GeneratorFiles &files); // emitted before files are written to disk.
+    void postProcessFiles(const JsonWizard::GeneratorFiles &files); // emitted before files are post-processed.
+    void filesReady(const JsonWizard::GeneratorFiles &files); // emitted just after files are in final state on disk.
+
+public slots:
+    void accept();
+
+private:
+    QList<JsonWizardGenerator *> m_generators;
+
+    GeneratorFiles m_files;
+    Internal::JsonWizardExpander *m_expander;
+};
+
+} // namespace ProjectExplorer
+
+#endif // JSONWIZARD_H

src/plugins/projectexplorer/jsonwizard/jsonwizard.pri

+HEADERS += $$PWD/jsonwizard.h \
+    $$PWD/jsonwizardexpander.h \
+    $$PWD/jsonwizardfactory.h \
+    $$PWD/jsonwizardgeneratorfactory.h \
+    $$PWD/jsonwizardpagefactory.h
+
+SOURCES += $$PWD/jsonwizard.cpp \
+    $$PWD/jsonwizardexpander.cpp \
+    $$PWD/jsonwizardfactory.cpp \
+    $$PWD/jsonwizardgeneratorfactory.cpp \
+    $$PWD/jsonwizardpagefactory.cpp

src/plugins/projectexplorer/jsonwizard/jsonwizardexpander.cpp

+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "jsonwizardexpander.h"
+
+#include "jsonwizard.h"
+
+#include <coreplugin/variablemanager.h>
+
+#include <utils/qtcassert.h>
+
+#include <QVariant>
+
+namespace ProjectExplorer {
+namespace Internal {
+
+// --------------------------------------------------------------------
+// JsonWizardExpander:
+// --------------------------------------------------------------------
+
+JsonWizardExpander::JsonWizardExpander(JsonWizard *wizard) :
+    m_wizard(wizard)
+{
+    QTC_CHECK(m_wizard);
+}
+
+bool JsonWizardExpander::resolveMacro(const QString &name, QString *ret)
+{
+    QVariant v = m_wizard->value(name);
+    if (v.isValid()) {
+        *ret = v.toString();
+        return true;
+    }
+
+    return Core::VariableManager::macroExpander()->resolveMacro(name, ret);
+}
+
+} // namespace Internal
+} // namespace ProjectExplorer

src/plugins/projectexplorer/jsonwizard/jsonwizardexpander.h

+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef JSONWIZARDEXPANDER_H
+#define JSONWIZARDEXPANDER_H
+
+#include <utils/stringutils.h>
+
+#include <QString>
+
+namespace ProjectExplorer {
+
+class JsonWizard;
+
+namespace Internal {
+
+// Documentation inside.
+class JsonWizardExpander : public Utils::AbstractMacroExpander
+{
+public:
+    explicit JsonWizardExpander(JsonWizard *wizard);
+
+    bool resolveMacro(const QString &name, QString *ret);
+
+public:
+    JsonWizard *m_wizard;
+};
+
+} // namespace Internal
+} // namespace ProjectExplorer
+
+#endif // JSONWIZARDEXPANDER_H

src/plugins/projectexplorer/jsonwizard/jsonwizardfactory.h

+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef JSONWIZARDFACTORY_H
+#define JSONWIZARDFACTORY_H
+
+#include "../projectexplorer_export.h"
+
+#include <coreplugin/iwizardfactory.h>
+
+#include <utils/fileutils.h>
+
+#include <QMap>
+
+QT_BEGIN_NAMESPACE
+class QDir;
+QT_END_NAMESPACE
+
+namespace ProjectExplorer {
+
+class JsonWizardFactory;
+class JsonWizardPageFactory;
+class JsonWizardGeneratorFactory;
+class ProjectExplorerPlugin;
+
+// Documentation inside.
+class PROJECTEXPLORER_EXPORT JsonWizardFactory : public Core::IWizardFactory
+{
+    Q_OBJECT
+
+public:
+    // Add search paths for wizard.json files. All subdirs are going to be checked.
+    static void addWizardPath(const Utils::FileName &path);
+
+    // actual interface of the wizard factory:
+    class Generator {
+    public:
+        bool isValid() const { return typeId.isValid(); }
+
+        Core::Id typeId;
+        QVariant data;
+    };
+
+    class Page {
+    public:
+        bool isValid() const { return typeId.isValid(); }
+        QString title;
+        QString subTitle;
+        QString shortTitle;
+        int index; // page index in the wizard
+        Core::Id typeId;
+        QVariant data;
+    };
+
+    static void registerPageFactory(JsonWizardPageFactory *factory);
+    static void registerGeneratorFactory(JsonWizardGeneratorFactory *factory);
+
+    ~JsonWizardFactory();
+
+    void runWizard(const QString &path, QWidget *parent, const QString &platform,
+                   const QVariantMap &variables);
+
+    static QList<QVariant> objectOrList(const QVariant &data, QString *errorMessage);
+    static QString localizedString(const QVariant &value);
+
+private:
+    // Create all wizards. As other plugins might register factories for derived
+    // classes. Called when the new file dialog is shown for the first time.
+    static QList<JsonWizardFactory *> createWizardFactories();
+    static JsonWizardFactory *createWizardFactory(const QVariantMap &data, const QDir &baseDir,
+                                                  QString *errorMessage);
+
+    static void setVerbose(int level);
+    static int verbose();
+
+    static void destroyAllFactories();
+    bool initialize(const QVariantMap &data, const QDir &baseDir, QString *errorMessage);
+
+    QString m_wizardDir;
+    QList<Generator> m_generators;
+
+    QList<Page> m_pages;
+    QMap<QString, QString> m_options;
+
+    Core::FeatureSet m_preferredFeatures;
+
+    static QList<Utils::FileName> m_searchPaths;
+    static int m_verbose;
+
+    friend class ProjectExplorerPlugin;
+};
+
+} //namespace ProjectExplorer
+
+#endif // JSONWIZARDFACTORY_H

src/plugins/projectexplorer/jsonwizard/jsonwizardgeneratorfactory.cpp

+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "jsonwizardgeneratorfactory.h"
+
+#include "jsonwizard.h"
+
+#include "../projectexplorerconstants.h"
+
+#include <coreplugin/dialogs/promptoverwritedialog.h>
+
+#include <utils/algorithm.h>
+#include <utils/stringutils.h>
+#include <utils/qtcassert.h>
+
+#include <QCoreApplication>
+#include <QDir>
+#include <QFileInfo>
+#include <QDebug>
+#include <QStringList>
+
+namespace ProjectExplorer {
+
+// --------------------------------------------------------------------
+// JsonWizardGenerator:
+// --------------------------------------------------------------------
+
+JsonWizardGenerator::OverwriteResult JsonWizardGenerator::promptForOverwrite(JsonWizard::GeneratorFiles *files,