Implement Code Style schemes

Task-number: QTCREATORBUG-5092 Change-Id: I218cef02f7c242e4dfae59b1b8021ea618e60d07 Reviewed-on: http://codereview.qt-project.org/5160 Reviewed-by: Leandro T. C. Melo <leandro.melo@nokia.com>
2011-08-16 10:45:23 +02:00
parent 3955df7855
commit 2244911826
92 changed files with 3138 additions and 2125 deletions
--- a/src/plugins/texteditor/codestylepool.cpp
+++ b/src/plugins/texteditor/codestylepool.cpp
@@ -0,0 +1,289 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (info@qt.nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at info@qt.nokia.com.
+**
+**************************************************************************/
+
+#include "codestylepool.h"
+#include "icodestylepreferencesfactory.h"
+#include "icodestylepreferences.h"
+#include "tabsettings.h"
+#include <utils/persistentsettings.h>
+#include <coreplugin/icore.h>
+
+#include <QtCore/QMap>
+#include <QtCore/QDir>
+#include <QtCore/QDebug>
+
+using namespace TextEditor;
+
+static const char *codeStyleDataKey = "CodeStyleData";
+static const char *displayNameKey = "DisplayName";
+static const char *codeStyleDocKey = "QtCreatorCodeStyle";
+
+namespace TextEditor {
+namespace Internal {
+
+class CodeStylePoolPrivate
+{
+public:
+    CodeStylePoolPrivate()
+        : m_factory(0)
+    {}
+
+    QString generateUniqueId(const QString &id) const;
+
+    ICodeStylePreferencesFactory *m_factory;
+    QList<ICodeStylePreferences *> m_pool;
+    QList<ICodeStylePreferences *> m_builtInPool;
+    QList<ICodeStylePreferences *> m_customPool;
+    QMap<QString, ICodeStylePreferences *> m_idToCodeStyle;
+    QString m_settingsPath;
+};
+
+QString CodeStylePoolPrivate::generateUniqueId(const QString &id) const
+{
+    if (!m_idToCodeStyle.contains(id))
+        return id;
+
+    int idx = id.size();
+    while (idx > 0) {
+        if (!id.at(idx - 1).isDigit())
+            break;
+        idx--;
+    }
+
+    const QString baseName = id.left(idx);
+    QString newName = baseName;
+    int i = 2;
+    while (m_idToCodeStyle.contains(newName))
+        newName = baseName + QString::number(i++);
+
+    return newName;
+}
+
+}
+}
+
+static QString customCodeStylesPath()
+{
+    QString path = Core::ICore::instance()->userResourcePath();
+    path.append(QLatin1String("/codestyles/"));
+    return path;
+}
+
+CodeStylePool::CodeStylePool(ICodeStylePreferencesFactory *factory, QObject *parent)
+    : QObject(parent),
+      d(new Internal::CodeStylePoolPrivate)
+{
+    d->m_factory = factory;
+}
+
+CodeStylePool::~CodeStylePool()
+{
+    delete d;
+}
+
+QString CodeStylePool::settingsDir() const
+{
+    const QString suffix = d->m_factory ? d->m_factory->languageId() : QLatin1String("default");
+    return customCodeStylesPath().append(suffix);
+}
+
+QString CodeStylePool::settingsPath(const QString &id) const
+{
+    return settingsDir() + QLatin1Char('/') + id + QLatin1String(".xml");
+}
+
+QList<ICodeStylePreferences *> CodeStylePool::codeStyles() const
+{
+    return d->m_pool;
+}
+
+QList<ICodeStylePreferences *> CodeStylePool::builtInCodeStyles() const
+{
+    return d->m_builtInPool;
+}
+
+QList<ICodeStylePreferences *> CodeStylePool::customCodeStyles() const
+{
+    return d->m_customPool;
+}
+
+ICodeStylePreferences *CodeStylePool::cloneCodeStyle(ICodeStylePreferences *originalCodeStyle)
+{
+    return createCodeStyle(originalCodeStyle->id(), originalCodeStyle->tabSettings(),
+                        originalCodeStyle->value(), originalCodeStyle->displayName());
+}
+
+ICodeStylePreferences *CodeStylePool::createCodeStyle(const QString &id, const TabSettings &tabSettings,
+                  const QVariant &codeStyleData, const QString &displayName)
+{
+    if (!d->m_factory)
+        return 0;
+
+    TextEditor::ICodeStylePreferences *codeStyle = d->m_factory->createCodeStyle();
+    codeStyle->setId(id);
+    codeStyle->setTabSettings(tabSettings);
+    codeStyle->setValue(codeStyleData);
+    codeStyle->setDisplayName(displayName);
+
+    addCodeStyle(codeStyle);
+
+    saveCodeStyle(codeStyle);
+
+    return codeStyle;
+}
+
+void CodeStylePool::addCodeStyle(ICodeStylePreferences *codeStyle)
+{
+    const QString newId = d->generateUniqueId(codeStyle->id());
+    codeStyle->setId(newId);
+
+    d->m_pool.append(codeStyle);
+    if (codeStyle->isReadOnly())
+        d->m_builtInPool.append(codeStyle);
+    else
+        d->m_customPool.append(codeStyle);
+    d->m_idToCodeStyle.insert(newId, codeStyle);
+    // take ownership
+    codeStyle->setParent(this);
+
+    connect(codeStyle, SIGNAL(valueChanged(QVariant)), this, SLOT(slotSaveCodeStyle()));
+    connect(codeStyle, SIGNAL(tabSettingsChanged(TextEditor::TabSettings)), this, SLOT(slotSaveCodeStyle()));
+    connect(codeStyle, SIGNAL(displayNameChanged(QString)), this, SLOT(slotSaveCodeStyle()));
+    emit codeStyleAdded(codeStyle);
+}
+
+void CodeStylePool::removeCodeStyle(ICodeStylePreferences *codeStyle)
+{
+    const int idx = d->m_customPool.indexOf(codeStyle);
+    if (idx < 0)
+        return;
+
+    if (codeStyle->isReadOnly())
+        return;
+
+    emit codeStyleRemoved(codeStyle);
+    d->m_customPool.removeAt(idx);
+    d->m_pool.removeOne(codeStyle);
+    d->m_idToCodeStyle.remove(codeStyle->id());
+
+    QDir dir(settingsDir());
+    dir.remove(QFileInfo(settingsPath(codeStyle->id())).fileName());
+
+    delete codeStyle;
+}
+
+ICodeStylePreferences *CodeStylePool::codeStyle(const QString &id) const
+{
+    return d->m_idToCodeStyle.value(id);
+}
+
+void CodeStylePool::loadCustomCodeStyles()
+{
+    QDir dir(settingsDir());
+    const QStringList codeStyleFiles = dir.entryList(QStringList() << QLatin1String("*.xml"), QDir::Files);
+    for (int i = 0; i < codeStyleFiles.count(); i++) {
+        const QString codeStyleFile = codeStyleFiles.at(i);
+        // filter out styles which id is the same as one of built-in styles
+        if (!d->m_idToCodeStyle.contains(QFileInfo(codeStyleFile).completeBaseName()))
+            loadCodeStyle(dir.absoluteFilePath(codeStyleFile));
+    }
+}
+
+ICodeStylePreferences *CodeStylePool::importCodeStyle(const QString &fileName)
+{
+    TextEditor::ICodeStylePreferences *codeStyle = loadCodeStyle(fileName);
+    if (codeStyle)
+        saveCodeStyle(codeStyle);
+    return codeStyle;
+}
+
+ICodeStylePreferences *CodeStylePool::loadCodeStyle(const QString &fileName)
+{
+    TextEditor::ICodeStylePreferences *codeStyle = 0;
+    Utils::PersistentSettingsReader reader;
+    reader.load(fileName);
+    QVariantMap m = reader.restoreValues();
+    if (m.contains(QLatin1String(codeStyleDataKey))) {
+        const QString id = QFileInfo(fileName).completeBaseName();
+        const QString displayName = reader.restoreValue(QLatin1String(displayNameKey)).toString();
+        const QVariantMap map = reader.restoreValue(QLatin1String(codeStyleDataKey)).toMap();
+        if (d->m_factory) {
+            codeStyle = d->m_factory->createCodeStyle();
+            codeStyle->setId(id);
+            codeStyle->setDisplayName(displayName);
+            codeStyle->fromMap(QString::null, map);
+
+            addCodeStyle(codeStyle);
+        }
+    }
+    return codeStyle;
+}
+
+void CodeStylePool::slotSaveCodeStyle()
+{
+    ICodeStylePreferences *codeStyle = qobject_cast<ICodeStylePreferences *>(sender());
+    if (!codeStyle)
+        return;
+
+    saveCodeStyle(codeStyle);
+}
+
+void CodeStylePool::saveCodeStyle(ICodeStylePreferences *codeStyle) const
+{
+    const QString codeStylesPath = customCodeStylesPath();
+
+    // Create the base directory when it doesn't exist
+    if (!QFile::exists(codeStylesPath) && !QDir().mkpath(codeStylesPath)) {
+        qWarning() << "Failed to create code style directory:" << codeStylesPath;
+        return;
+    }
+    const QString languageCodeStylesPath = settingsDir();
+    // Create the base directory for the language when it doesn't exist
+    if (!QFile::exists(languageCodeStylesPath) && !QDir().mkpath(languageCodeStylesPath)) {
+        qWarning() << "Failed to create language code style directory:" << languageCodeStylesPath;
+        return;
+    }
+
+    exportCodeStyle(settingsPath(codeStyle->id()), codeStyle);
+}
+
+void CodeStylePool::exportCodeStyle(const QString &fileName, ICodeStylePreferences *codeStyle) const
+{
+    QVariantMap map;
+    codeStyle->toMap(QString::null, &map);
+    Utils::PersistentSettingsWriter writer;
+    writer.saveValue(QLatin1String(displayNameKey), codeStyle->displayName());
+    writer.saveValue(QLatin1String(codeStyleDataKey), map);
+    writer.save(fileName, QLatin1String(codeStyleDocKey), 0);
+}
+
+