1 /**************************************************************************
3 ** This file is part of Qt Creator
5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
7 ** Contact: Nokia Corporation (info@qt.nokia.com)
10 ** GNU Lesser General Public License Usage
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.
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.
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.
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
31 **************************************************************************/
33 #include "basefilewizard.h"
35 #include "coreconstants.h"
37 #include "ifilewizardextension.h"
38 #include "mimedatabase.h"
39 #include "editormanager/editormanager.h"
41 #include <extensionsystem/pluginmanager.h>
42 #include <utils/filewizarddialog.h>
43 #include <utils/qtcassert.h>
44 #include <utils/stringutils.h>
46 #include <QtCore/QDir>
47 #include <QtCore/QFile>
48 #include <QtCore/QFileInfo>
49 #include <QtCore/QVector>
50 #include <QtCore/QDebug>
51 #include <QtCore/QSharedData>
52 #include <QtCore/QEventLoop>
53 #include <QtCore/QSharedPointer>
54 #include <QtCore/QScopedPointer>
56 #include <QtGui/QMessageBox>
57 #include <QtGui/QWizard>
58 #include <QtGui/QMainWindow>
59 #include <QtGui/QIcon>
61 enum { debugWizard = 0 };
65 class GeneratedFilePrivate : public QSharedData
68 GeneratedFilePrivate() : binary(false) {}
69 explicit GeneratedFilePrivate(const QString &p);
74 GeneratedFile::Attributes attributes;
77 GeneratedFilePrivate::GeneratedFilePrivate(const QString &p) :
78 path(QDir::cleanPath(p)),
84 GeneratedFile::GeneratedFile() :
85 m_d(new GeneratedFilePrivate)
89 GeneratedFile::GeneratedFile(const QString &p) :
90 m_d(new GeneratedFilePrivate(p))
94 GeneratedFile::GeneratedFile(const GeneratedFile &rhs) :
99 GeneratedFile &GeneratedFile::operator=(const GeneratedFile &rhs)
102 m_d.operator=(rhs.m_d);
106 GeneratedFile::~GeneratedFile()
110 QString GeneratedFile::path() const
115 void GeneratedFile::setPath(const QString &p)
117 m_d->path = QDir::cleanPath(p);
120 QString GeneratedFile::contents() const
122 return QString::fromUtf8(m_d->contents);
125 void GeneratedFile::setContents(const QString &c)
127 m_d->contents = c.toUtf8();
130 QByteArray GeneratedFile::binaryContents() const
132 return m_d->contents;
135 void GeneratedFile::setBinaryContents(const QByteArray &c)
140 bool GeneratedFile::isBinary() const
145 void GeneratedFile::setBinary(bool b)
150 QString GeneratedFile::editorId() const
152 return m_d->editorId;
155 void GeneratedFile::setEditorId(const QString &k)
160 bool GeneratedFile::write(QString *errorMessage) const
162 // Ensure the directory
163 const QFileInfo info(m_d->path);
164 const QDir dir = info.absoluteDir();
166 if (!dir.mkpath(dir.absolutePath())) {
167 *errorMessage = BaseFileWizard::tr("Unable to create the directory %1.").arg(dir.absolutePath());
172 QFile file(m_d->path);
174 QIODevice::OpenMode flags = QIODevice::WriteOnly|QIODevice::Truncate;
176 flags |= QIODevice::Text;
178 if (!file.open(flags)) {
179 *errorMessage = BaseFileWizard::tr("Unable to open %1 for writing: %2").arg(m_d->path, file.errorString());
182 if (file.write(m_d->contents) == -1) {
183 *errorMessage = BaseFileWizard::tr("Error while writing to %1: %2").arg(m_d->path, file.errorString());
190 GeneratedFile::Attributes GeneratedFile::attributes() const
192 return m_d->attributes;
195 void GeneratedFile::setAttributes(Attributes a)
200 // ------------ BaseFileWizardParameterData
201 class BaseFileWizardParameterData : public QSharedData
204 explicit BaseFileWizardParameterData(IWizard::WizardKind kind = IWizard::FileWizard);
207 IWizard::WizardKind kind;
213 QString displayCategory;
216 BaseFileWizardParameterData::BaseFileWizardParameterData(IWizard::WizardKind k) :
221 void BaseFileWizardParameterData::clear()
223 kind = IWizard::FileWizard;
229 displayCategory.clear();
232 BaseFileWizardParameters::BaseFileWizardParameters(IWizard::WizardKind kind) :
233 m_d(new BaseFileWizardParameterData(kind))
237 BaseFileWizardParameters::BaseFileWizardParameters(const BaseFileWizardParameters &rhs) :
242 BaseFileWizardParameters &BaseFileWizardParameters::operator=(const BaseFileWizardParameters &rhs)
245 m_d.operator=(rhs.m_d);
249 BaseFileWizardParameters::~BaseFileWizardParameters()
253 void BaseFileWizardParameters::clear()
258 CORE_EXPORT QDebug operator<<(QDebug d, const BaseFileWizardParameters &p)
260 d.nospace() << "Kind: " << p.kind() << " Id: " << p.id()
261 << " Category: " << p.category()
262 << " DisplayName: " << p.displayName()
263 << " Description: " << p.description()
264 << " DisplayCategory: " << p.displayCategory();
268 IWizard::WizardKind BaseFileWizardParameters::kind() const
273 void BaseFileWizardParameters::setKind(IWizard::WizardKind k)
278 QIcon BaseFileWizardParameters::icon() const
283 void BaseFileWizardParameters::setIcon(const QIcon &icon)
288 QString BaseFileWizardParameters::description() const
290 return m_d->description;
293 void BaseFileWizardParameters::setDescription(const QString &v)
295 m_d->description = v;
298 QString BaseFileWizardParameters::displayName() const
300 return m_d->displayName;
303 void BaseFileWizardParameters::setDisplayName(const QString &v)
305 m_d->displayName = v;
308 QString BaseFileWizardParameters::id() const
313 void BaseFileWizardParameters::setId(const QString &v)
318 QString BaseFileWizardParameters::category() const
320 return m_d->category;
323 void BaseFileWizardParameters::setCategory(const QString &v)
328 QString BaseFileWizardParameters::displayCategory() const
330 return m_d->displayCategory;
333 void BaseFileWizardParameters::setDisplayCategory(const QString &v)
335 m_d->displayCategory = v;
338 /* WizardEventLoop: Special event loop that runs a QWizard and terminates if the page changes.
341 Wizard wizard(parent);
342 WizardEventLoop::WizardResult wr;
344 wr = WizardEventLoop::execWizardPage(wizard);
345 } while (wr == WizardEventLoop::PageChanged);
348 class WizardEventLoop : public QEventLoop
351 Q_DISABLE_COPY(WizardEventLoop)
352 WizardEventLoop(QObject *parent);
355 enum WizardResult { Accepted, Rejected , PageChanged };
357 static WizardResult execWizardPage(QWizard &w);
360 void pageChanged(int);
365 WizardResult execWizardPageI();
367 WizardResult m_result;
370 WizardEventLoop::WizardEventLoop(QObject *parent) :
376 WizardEventLoop::WizardResult WizardEventLoop::execWizardPage(QWizard &wizard)
378 /* Install ourselves on the wizard. Main trick is here to connect
379 * to the page changed signal and quit() on it. */
380 WizardEventLoop *eventLoop = wizard.findChild<WizardEventLoop *>();
382 eventLoop = new WizardEventLoop(&wizard);
383 connect(&wizard, SIGNAL(currentIdChanged(int)), eventLoop, SLOT(pageChanged(int)));
384 connect(&wizard, SIGNAL(accepted()), eventLoop, SLOT(accepted()));
385 connect(&wizard, SIGNAL(rejected()), eventLoop, SLOT(rejected()));
386 wizard.setAttribute(Qt::WA_ShowModal, true);
389 const WizardResult result = eventLoop->execWizardPageI();
391 if (result != PageChanged)
394 qDebug() << "WizardEventLoop::runWizard" << wizard.pageIds() << " returns " << result;
399 WizardEventLoop::WizardResult WizardEventLoop::execWizardPageI()
402 exec(QEventLoop::DialogExec);
406 void WizardEventLoop::pageChanged(int /*page*/)
408 m_result = PageChanged;
412 void WizardEventLoop::accepted()
418 void WizardEventLoop::rejected()
424 // ---------------- BaseFileWizardPrivate
425 struct BaseFileWizardPrivate
427 explicit BaseFileWizardPrivate(const Core::BaseFileWizardParameters ¶meters)
428 : m_parameters(parameters), m_wizardDialog(0)
431 const Core::BaseFileWizardParameters m_parameters;
432 QWizard *m_wizardDialog;
435 // ---------------- Wizard
436 BaseFileWizard::BaseFileWizard(const BaseFileWizardParameters ¶meters,
439 m_d(new BaseFileWizardPrivate(parameters))
443 BaseFileWizard::~BaseFileWizard()
448 IWizard::WizardKind BaseFileWizard::kind() const
450 return m_d->m_parameters.kind();
453 QIcon BaseFileWizard::icon() const
455 return m_d->m_parameters.icon();
458 QString BaseFileWizard::description() const
460 return m_d->m_parameters.description();
463 QString BaseFileWizard::displayName() const
465 return m_d->m_parameters.displayName();
468 QString BaseFileWizard::id() const
470 return m_d->m_parameters.id();
473 QString BaseFileWizard::category() const
475 return m_d->m_parameters.category();
478 QString BaseFileWizard::displayCategory() const
480 return m_d->m_parameters.displayCategory();
483 void BaseFileWizard::runWizard(const QString &path, QWidget *parent)
485 QTC_ASSERT(!path.isEmpty(), return);
487 typedef QList<IFileWizardExtension*> ExtensionList;
489 QString errorMessage;
490 // Compile extension pages, purge out unused ones
491 ExtensionList extensions = ExtensionSystem::PluginManager::instance()->getObjects<IFileWizardExtension>();
492 WizardPageList allExtensionPages;
493 for (ExtensionList::iterator it = extensions.begin(); it != extensions.end(); ) {
494 const WizardPageList extensionPages = (*it)->extensionPages(this);
495 if (extensionPages.empty()) {
496 it = extensions.erase(it);
498 allExtensionPages += extensionPages;
504 qDebug() << Q_FUNC_INFO << path << parent << "exs" << extensions.size() << allExtensionPages.size();
506 QWizardPage *firstExtensionPage = 0;
507 if (!allExtensionPages.empty())
508 firstExtensionPage = allExtensionPages.front();
510 // Create dialog and run it. Ensure that the dialog is deleted when
511 // leaving the func, but not before the IFileWizardExtension::process
513 const QScopedPointer<QWizard> wizard(createWizardDialog(parent, path, allExtensionPages));
514 QTC_ASSERT(!wizard.isNull(), return);
516 GeneratedFiles files;
517 // Run the wizard: Call generate files on switching to the first extension
518 // page is OR after 'Accepted' if there are no extension pages
520 const WizardEventLoop::WizardResult wr = WizardEventLoop::execWizardPage(*wizard);
521 if (wr == WizardEventLoop::Rejected) {
525 const bool accepted = wr == WizardEventLoop::Accepted;
526 const bool firstExtensionPageHit = wr == WizardEventLoop::PageChanged
527 && wizard->page(wizard->currentId()) == firstExtensionPage;
528 const bool needGenerateFiles = firstExtensionPageHit || (accepted && allExtensionPages.empty());
529 if (needGenerateFiles) {
530 QString errorMessage;
531 files = generateFiles(wizard.data(), &errorMessage);
533 QMessageBox::critical(0, tr("File Generation Failure"), errorMessage);
537 if (firstExtensionPageHit)
538 foreach (IFileWizardExtension *ex, extensions)
539 ex->firstExtensionPageShown(files);
545 // Compile result list and prompt for overwrite
547 foreach (const GeneratedFile &generatedFile, files)
548 result.push_back(generatedFile.path());
550 switch (promptOverwrite(result, &errorMessage)) {
551 case OverwriteCanceled:
554 QMessageBox::critical(0, tr("Existing files"), errorMessage);
561 if (!writeFiles(files, &errorMessage)) {
562 QMessageBox::critical(parent, tr("File Generation Failure"), errorMessage);
566 bool removeOpenProjectAttribute = false;
567 // Run the extensions
568 foreach (IFileWizardExtension *ex, extensions) {
570 if (!ex->process(files, &remove, &errorMessage)) {
571 QMessageBox::critical(parent, tr("File Generation Failure"), errorMessage);
574 removeOpenProjectAttribute |= remove;
577 if (removeOpenProjectAttribute) {
578 for (int i = 0; i < files.count(); i++) {
579 if (files[i].attributes() & Core::GeneratedFile::OpenProjectAttribute)
580 files[i].setAttributes(Core::GeneratedFile::OpenEditorAttribute);
584 // Post generation handler
585 if (!postGenerateFiles(wizard.data(), files, &errorMessage))
586 QMessageBox::critical(0, tr("File Generation Failure"), errorMessage);
590 bool BaseFileWizard::writeFiles(const GeneratedFiles &files, QString *errorMessage)
592 foreach (const GeneratedFile &generatedFile, files)
593 if (!(generatedFile.attributes() & GeneratedFile::CustomGeneratorAttribute))
594 if (!generatedFile.write(errorMessage))
600 void BaseFileWizard::setupWizard(QWizard *w)
602 w->setOption(QWizard::NoCancelButton, false);
603 w->setOption(QWizard::NoDefaultButton, false);
604 w->setOption(QWizard::NoBackButtonOnStartPage, true);
607 void BaseFileWizard::applyExtensionPageShortTitle(Utils::Wizard *wizard, int pageId)
611 QWizardPage *p = wizard->page(pageId);
614 Utils::WizardProgressItem *item = wizard->wizardProgress()->item(pageId);
617 const QString shortTitle = p->property("shortTitle").toString();
618 if (!shortTitle.isEmpty())
619 item->setTitle(shortTitle);
622 bool BaseFileWizard::postGenerateFiles(const QWizard *, const GeneratedFiles &l, QString *errorMessage)
624 return BaseFileWizard::postGenerateOpenEditors(l, errorMessage);
627 bool BaseFileWizard::postGenerateOpenEditors(const GeneratedFiles &l, QString *errorMessage)
629 Core::EditorManager *em = Core::EditorManager::instance();
630 foreach(const Core::GeneratedFile &file, l) {
631 if (file.attributes() & Core::GeneratedFile::OpenEditorAttribute) {
632 if (!em->openEditor(file.path(), file.editorId(), Core::EditorManager::ModeSwitch )) {
634 *errorMessage = tr("Failed to open an editor for '%1'.").arg(QDir::toNativeSeparators(file.path()));
642 BaseFileWizard::OverwriteResult BaseFileWizard::promptOverwrite(const QStringList &files,
643 QString *errorMessage) const
646 qDebug() << Q_FUNC_INFO << files;
648 QStringList existingFiles;
649 bool oddStuffFound = false;
651 static const QString readOnlyMsg = tr(" [read only]");
652 static const QString directoryMsg = tr(" [directory]");
653 static const QString symLinkMsg = tr(" [symbolic link]");
655 foreach (const QString &fileName, files) {
656 const QFileInfo fi(fileName);
658 existingFiles.append(fileName);
660 // Note: Generated files are using native separators, no need to convert.
661 const QString commonExistingPath = Utils::commonPath(existingFiles);
662 // Format a file list message as ( "<file1> [readonly], <file2> [directory]").
663 QString fileNamesMsgPart;
664 foreach (const QString &fileName, existingFiles) {
665 const QFileInfo fi(fileName);
667 if (!fileNamesMsgPart.isEmpty())
668 fileNamesMsgPart += QLatin1String(", ");
669 fileNamesMsgPart += QDir::toNativeSeparators(fileName.mid(commonExistingPath.size() + 1));
672 oddStuffFound = true;
673 fileNamesMsgPart += directoryMsg;
676 if (fi.isSymLink()) {
677 oddStuffFound = true;
678 fileNamesMsgPart += symLinkMsg;
681 if (!fi.isWritable()) {
682 oddStuffFound = true;
683 fileNamesMsgPart += readOnlyMsg;
689 if (existingFiles.isEmpty())
693 *errorMessage = tr("The project directory %1 contains files which cannot be overwritten:\n%2.")
694 .arg(QDir::toNativeSeparators(commonExistingPath)).arg(fileNamesMsgPart);
695 return OverwriteError;
698 const QString messageFormat = tr("The following files already exist in the directory %1:\n"
699 "%2.\nWould you like to overwrite them?");
700 const QString message = messageFormat.arg(QDir::toNativeSeparators(commonExistingPath)).arg(fileNamesMsgPart);
701 const bool yes = (QMessageBox::question(Core::ICore::instance()->mainWindow(),
702 tr("Existing files"), message,
703 QMessageBox::Yes | QMessageBox::No,
705 == QMessageBox::Yes);
706 return yes ? OverwriteOk : OverwriteCanceled;
709 QString BaseFileWizard::buildFileName(const QString &path,
710 const QString &baseName,
711 const QString &extension)
714 if (!rc.isEmpty() && !rc.endsWith(QDir::separator()))
715 rc += QDir::separator();
717 // Add extension unless user specified something else
718 const QChar dot = QLatin1Char('.');
719 if (!extension.isEmpty() && !baseName.contains(dot)) {
720 if (!extension.startsWith(dot))
725 qDebug() << Q_FUNC_INFO << rc;
729 QString BaseFileWizard::preferredSuffix(const QString &mimeType)
731 const QString rc = Core::ICore::instance()->mimeDatabase()->preferredSuffixByType(mimeType);
733 qWarning("%s: WARNING: Unable to find a preferred suffix for %s.",
734 Q_FUNC_INFO, mimeType.toUtf8().constData());
738 // ------------- StandardFileWizard
740 StandardFileWizard::StandardFileWizard(const BaseFileWizardParameters ¶meters,
742 BaseFileWizard(parameters, parent)
746 QWizard *StandardFileWizard::createWizardDialog(QWidget *parent,
747 const QString &defaultPath,
748 const WizardPageList &extensionPages) const
750 Utils::FileWizardDialog *standardWizardDialog = new Utils::FileWizardDialog(parent);
751 standardWizardDialog->setWindowTitle(tr("New %1").arg(displayName()));
752 setupWizard(standardWizardDialog);
753 standardWizardDialog->setPath(defaultPath);
754 foreach (QWizardPage *p, extensionPages)
755 BaseFileWizard::applyExtensionPageShortTitle(standardWizardDialog, standardWizardDialog->addPage(p));
756 return standardWizardDialog;
759 GeneratedFiles StandardFileWizard::generateFiles(const QWizard *w,
760 QString *errorMessage) const
762 const Utils::FileWizardDialog *standardWizardDialog = qobject_cast<const Utils::FileWizardDialog *>(w);
763 return generateFilesFromPath(standardWizardDialog->path(),
764 standardWizardDialog->fileName(),
770 #include "basefilewizard.moc"