src/plugins/coreplugin/basefilewizard.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at info@qt.nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef BASEFILEWIZARD_H
  34 #define BASEFILEWIZARD_H
  35
  36 #include "core_global.h"
  37 #include "generatedfile.h"
  38
  39 #include <coreplugin/dialogs/iwizard.h>
  40
  41 #include <QtCore/QSharedDataPointer>
  42 #include <QtCore/QList>
  43
  44 QT_BEGIN_NAMESPACE
  45 class QIcon;
  46 class QWizard;
  47 class QWizardPage;
  48 class QDebug;
  49 QT_END_NAMESPACE
  50
  51 namespace Utils {
  52     class Wizard;
  53 }
  54
  55 namespace Core {
  56
  57 class IEditor;
  58 class IFileWizardExtension;
  59
  60 class BaseFileWizardParameterData;
  61 struct BaseFileWizardPrivate;
  62
  63 class CORE_EXPORT BaseFileWizardParameters
  64 {
  65 public:
  66     explicit BaseFileWizardParameters(IWizard::WizardKind kind = IWizard::FileWizard);
  67     BaseFileWizardParameters(const BaseFileWizardParameters &);
  68     BaseFileWizardParameters &operator=(const BaseFileWizardParameters&);
  69    ~BaseFileWizardParameters();
  70
  71     void clear();
  72
  73     IWizard::WizardKind kind() const;
  74     void setKind(IWizard::WizardKind k);
  75
  76     QIcon icon() const;
  77     void setIcon(const QIcon &icon);
  78
  79     QString description() const;
  80     void setDescription(const QString &description);
  81
  82     QString displayName() const;
  83     void setDisplayName(const QString &name);
  84
  85     QString id() const;
  86     void setId(const QString &id);
  87
  88     QString category() const;
  89     void setCategory(const QString &category);
  90
  91     QString displayCategory() const;
  92     void setDisplayCategory(const QString &trCategory);
  93
  94 private:
  95     QSharedDataPointer<BaseFileWizardParameterData> m_d;
  96 };
  97
  98 CORE_EXPORT QDebug operator<<(QDebug d, const BaseFileWizardParameters &);
  99
 100 class CORE_EXPORT BaseFileWizard : public IWizard
 101 {
 102     Q_OBJECT
 103
 104 public:
 105     virtual ~BaseFileWizard();
 106
 107     // IWizard
 108     virtual WizardKind kind() const;
 109     virtual QIcon icon() const;
 110     virtual QString description() const;
 111     virtual QString displayName() const;
 112     virtual QString id() const;
 113
 114     virtual QString category() const;
 115     virtual QString displayCategory() const;
 116
 117     virtual void runWizard(const QString &path, QWidget *parent);
 118
 119     static QString buildFileName(const QString &path, const QString &baseName, const QString &extension);
 120     static void setupWizard(QWizard *);
 121     static void applyExtensionPageShortTitle(Utils::Wizard *wizard, int pageId);
 122
 123 protected:
 124     typedef QList<QWizardPage *> WizardPageList;
 125
 126     explicit BaseFileWizard(const BaseFileWizardParameters &parameters, QObject *parent = 0);
 127
 128     virtual QWizard *createWizardDialog(QWidget *parent,
 129                                         const QString &defaultPath,
 130                                         const WizardPageList &extensionPages) const = 0;
 131     virtual GeneratedFiles generateFiles(const QWizard *w,
 132                                          QString *errorMessage) const = 0;
 133
 134     virtual bool writeFiles(const GeneratedFiles &files, QString *errorMessage);
 135
 136     virtual bool postGenerateFiles(const QWizard *w, const GeneratedFiles &l, QString *errorMessage);
 137
 138     static QString preferredSuffix(const QString &mimeType);
 139
 140     enum OverwriteResult { OverwriteOk,  OverwriteError,  OverwriteCanceled };
 141     OverwriteResult promptOverwrite(GeneratedFiles *files,
 142                                     QString *errorMessage) const;
 143     static bool postGenerateOpenEditors(const GeneratedFiles &l, QString *errorMessage = 0);
 144
 145 private:
 146     BaseFileWizardPrivate *m_d;
 147 };
 148
 149 class CORE_EXPORT StandardFileWizard : public BaseFileWizard
 150 {
 151     Q_OBJECT
 152
 153 protected:
 154     explicit StandardFileWizard(const BaseFileWizardParameters &parameters, QObject *parent = 0);
 155     virtual QWizard *createWizardDialog(QWidget *parent,
 156                                         const QString &defaultPath,
 157                                         const WizardPageList &extensionPages) const;
 158     virtual GeneratedFiles generateFiles(const QWizard *w, QString *errorMessage) const;
 159     virtual GeneratedFiles generateFilesFromPath(const QString &path, const QString &name,
 160                                                  QString *errorMessage) const = 0;
 161 };
 162
 163 } // namespace Core
 164
 165 Q_DECLARE_OPERATORS_FOR_FLAGS(Core::GeneratedFile::Attributes)
 166
 167 #endif // BASEFILEWIZARD_H