forked from qt-creator/qt-creator
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>
This commit is contained in:
121
src/plugins/projectexplorer/jsonwizard/jsonwizardfactory.h
Normal file
121
src/plugins/projectexplorer/jsonwizard/jsonwizardfactory.h
Normal file
@@ -0,0 +1,121 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** 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
|
||||
Reference in New Issue
Block a user