jsonwizardfactory.h 4.18 KB
Newer Older
Tobias Hunger's avatar
Tobias Hunger committed
1
2
/****************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3
4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
Tobias Hunger's avatar
Tobias Hunger committed
5
6
7
8
9
10
11
**
** 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
Eike Ziller's avatar
Eike Ziller committed
12
13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
Tobias Hunger's avatar
Tobias Hunger committed
15
16
17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18
19
20
21
22
23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
Tobias Hunger's avatar
Tobias Hunger committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25
26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
Tobias Hunger's avatar
Tobias Hunger committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
** 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;
52
class ProjectExplorerPluginPrivate;
Tobias Hunger's avatar
Tobias Hunger committed
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

// 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;
80
        QVariant enabled;
Tobias Hunger's avatar
Tobias Hunger committed
81
82
83
84
85
86
87
88
89
        QVariant data;
    };

    static void registerPageFactory(JsonWizardPageFactory *factory);
    static void registerGeneratorFactory(JsonWizardGeneratorFactory *factory);

    ~JsonWizardFactory();

    static QList<QVariant> objectOrList(const QVariant &data, QString *errorMessage);
90

Tobias Hunger's avatar
Tobias Hunger committed
91
92
    static QString localizedString(const QVariant &value);

93
94
    bool isAvailable(const QString &platformName) const override;

Tobias Hunger's avatar
Tobias Hunger committed
95
private:
96
97
    Utils::Wizard *runWizardImpl(const QString &path, QWidget *parent, const QString &platform,
                                 const QVariantMap &variables) override;
98

Tobias Hunger's avatar
Tobias Hunger committed
99
100
    // Create all wizards. As other plugins might register factories for derived
    // classes. Called when the new file dialog is shown for the first time.
101
    static QList<IWizardFactory *> createWizardFactories();
Tobias Hunger's avatar
Tobias Hunger committed
102
103
    static JsonWizardFactory *createWizardFactory(const QVariantMap &data, const QDir &baseDir,
                                                  QString *errorMessage);
104
    static QList<Utils::FileName> &searchPaths();
Tobias Hunger's avatar
Tobias Hunger committed
105
106
107
108
109
110
111

    static void setVerbose(int level);
    static int verbose();

    static void destroyAllFactories();
    bool initialize(const QVariantMap &data, const QDir &baseDir, QString *errorMessage);

112
    QVariant m_enabledExpression;
Tobias Hunger's avatar
Tobias Hunger committed
113
114
115
116
117
118
119
120
121
122
123
    QString m_wizardDir;
    QList<Generator> m_generators;

    QList<Page> m_pages;
    QMap<QString, QString> m_options;

    Core::FeatureSet m_preferredFeatures;

    static int m_verbose;

    friend class ProjectExplorerPlugin;
124
    friend class ProjectExplorerPluginPrivate;
Tobias Hunger's avatar
Tobias Hunger committed
125
126
127
128
129
};

} //namespace ProjectExplorer

#endif // JSONWIZARDFACTORY_H