cpptoolssettings.cpp 10.3 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29

30
#include "cpptoolssettings.h"
31

32 33
#include "cpptoolsconstants.h"
#include "cppcodestylepreferences.h"
Jarek Kobus's avatar
Jarek Kobus committed
34
#include "cppcodestylepreferencesfactory.h"
35 36
#include "commentssettings.h"
#include "completionsettingspage.h"
37

38
#include <coreplugin/icore.h>
Jarek Kobus's avatar
Jarek Kobus committed
39
#include <texteditor/codestylepool.h>
40 41
#include <texteditor/tabsettings.h>
#include <texteditor/texteditorsettings.h>
42

43
#include <extensionsystem/pluginmanager.h>
44
#include <utils/qtcassert.h>
45 46
#include <utils/settingsutils.h>

47
#include <QSettings>
48

49
static const char idKey[] = "CppGlobal";
50 51

using namespace CppTools;
52
using namespace CppTools::Internal;
53
using namespace TextEditor;
54 55 56 57 58 59 60

namespace CppTools {
namespace Internal {

class CppToolsSettingsPrivate
{
public:
61 62 63 64 65
    CppToolsSettingsPrivate()
        : m_globalCodeStyle(0)
        , m_completionSettingsPage(0)
    {}

Jarek Kobus's avatar
Jarek Kobus committed
66
    CppCodeStylePreferences *m_globalCodeStyle;
67
    CompletionSettingsPage *m_completionSettingsPage;
68 69 70 71 72 73 74 75 76
};

} // namespace Internal
} // namespace CppTools

CppToolsSettings *CppToolsSettings::m_instance = 0;

CppToolsSettings::CppToolsSettings(QObject *parent)
    : QObject(parent)
hjk's avatar
hjk committed
77
    , d(new Internal::CppToolsSettingsPrivate)
78 79 80
{
    QTC_ASSERT(!m_instance, return);
    m_instance = this;
81

Jarek Kobus's avatar
Jarek Kobus committed
82 83
    qRegisterMetaType<CppTools::CppCodeStyleSettings>("CppTools::CppCodeStyleSettings");

84
    d->m_completionSettingsPage = new CompletionSettingsPage(this);
85
    ExtensionSystem::PluginManager::addObject(d->m_completionSettingsPage);
86 87 88 89 90 91

    connect(d->m_completionSettingsPage,
            SIGNAL(commentsSettingsChanged(CppTools::CommentsSettings)),
            this,
            SIGNAL(commentsSettingsChanged(CppTools::CommentsSettings)));

Jarek Kobus's avatar
Jarek Kobus committed
92
    // code style factory
93 94
    ICodeStylePreferencesFactory *factory = new CppTools::CppCodeStylePreferencesFactory();
    TextEditorSettings::registerCodeStyleFactory(factory);
Jarek Kobus's avatar
Jarek Kobus committed
95 96

    // code style pool
97 98
    CodeStylePool *pool = new CodeStylePool(factory, this);
    TextEditorSettings::registerCodeStylePool(Constants::CPP_SETTINGS_ID, pool);
Jarek Kobus's avatar
Jarek Kobus committed
99 100 101 102 103

    // global code style settings
    d->m_globalCodeStyle = new CppCodeStylePreferences(this);
    d->m_globalCodeStyle->setDelegatingPool(pool);
    d->m_globalCodeStyle->setDisplayName(tr("Global", "Settings"));
104
    d->m_globalCodeStyle->setId(idKey);
Jarek Kobus's avatar
Jarek Kobus committed
105
    pool->addCodeStyle(d->m_globalCodeStyle);
106
    TextEditorSettings::registerCodeStyle(CppTools::Constants::CPP_SETTINGS_ID, d->m_globalCodeStyle);
Jarek Kobus's avatar
Jarek Kobus committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

    /*
    For every language we have exactly 1 pool. The pool contains:
    1) All built-in code styles (Qt/GNU)
    2) All custom code styles (which will be added dynamically)
    3) A global code style

    If the code style gets a pool (setCodeStylePool()) it means it can behave
    like a proxy to one of the code styles from that pool
    (ICodeStylePreferences::setCurrentDelegate()).
    That's why the global code style gets a pool (it can point to any code style
    from the pool), while built-in and custom code styles don't get a pool
    (they can't point to any other code style).

    The instance of the language pool is shared. The same instance of the pool
    is used for all project code style settings and for global one.
    Project code style can point to one of built-in or custom code styles
    or to the global one as well. That's why the global code style is added
    to the pool. The proxy chain can look like:
    ProjectCodeStyle -> GlobalCodeStyle -> BuildInCodeStyle (e.g. Qt).

    With the global pool there is an exception - it gets a pool
    in which it exists itself. The case in which a code style point to itself
    is disallowed and is handled in ICodeStylePreferences::setCurrentDelegate().
    */

    // built-in settings
    // Qt style
    CppCodeStylePreferences *qtCodeStyle = new CppCodeStylePreferences();
136
    qtCodeStyle->setId("qt");
Jarek Kobus's avatar
Jarek Kobus committed
137 138 139 140 141 142 143 144 145 146 147 148
    qtCodeStyle->setDisplayName(tr("Qt"));
    qtCodeStyle->setReadOnly(true);
    TabSettings qtTabSettings;
    qtTabSettings.m_tabPolicy = TabSettings::SpacesOnlyTabPolicy;
    qtTabSettings.m_tabSize = 4;
    qtTabSettings.m_indentSize = 4;
    qtTabSettings.m_continuationAlignBehavior = TabSettings::ContinuationAlignWithIndent;
    qtCodeStyle->setTabSettings(qtTabSettings);
    pool->addCodeStyle(qtCodeStyle);

    // GNU style
    CppCodeStylePreferences *gnuCodeStyle = new CppCodeStylePreferences();
149
    gnuCodeStyle->setId("gnu");
Jarek Kobus's avatar
Jarek Kobus committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
    gnuCodeStyle->setDisplayName(tr("GNU"));
    gnuCodeStyle->setReadOnly(true);
    TabSettings gnuTabSettings;
    gnuTabSettings.m_tabPolicy = TabSettings::MixedTabPolicy;
    gnuTabSettings.m_tabSize = 8;
    gnuTabSettings.m_indentSize = 2;
    gnuTabSettings.m_continuationAlignBehavior = TabSettings::ContinuationAlignWithIndent;
    gnuCodeStyle->setTabSettings(gnuTabSettings);
    CppCodeStyleSettings gnuCodeStyleSettings;
    gnuCodeStyleSettings.indentNamespaceBody = true;
    gnuCodeStyleSettings.indentBlockBraces = true;
    gnuCodeStyleSettings.indentSwitchLabels = true;
    gnuCodeStyleSettings.indentBlocksRelativeToSwitchLabels = true;
    gnuCodeStyle->setCodeStyleSettings(gnuCodeStyleSettings);
    pool->addCodeStyle(gnuCodeStyle);

    // default delegate for global preferences
    d->m_globalCodeStyle->setCurrentDelegate(qtCodeStyle);

    pool->loadCustomCodeStyles();

    // load global settings (after built-in settings are added to the pool)
172
    QSettings *s = Core::ICore::settings();
hjk's avatar
hjk committed
173
    d->m_globalCodeStyle->fromSettings(QLatin1String(CppTools::Constants::CPP_SETTINGS_ID), s);
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193

    // legacy handling start (Qt Creator Version < 2.4)
    const bool legacyTransformed =
                s->value(QLatin1String("CppCodeStyleSettings/LegacyTransformed"), false).toBool();

    if (!legacyTransformed) {
        // creator 2.4 didn't mark yet the transformation (first run of creator 2.4)

        // we need to transform the settings only if at least one from
        // below settings was already written - otherwise we use
        // defaults like it would be the first run of creator 2.4 without stored settings
        const QStringList groups = s->childGroups();
        const bool needTransform = groups.contains(QLatin1String("textTabPreferences")) ||
                                   groups.contains(QLatin1String("CppTabPreferences")) ||
                                   groups.contains(QLatin1String("CppCodeStyleSettings"));
        if (needTransform) {
            CppCodeStyleSettings legacyCodeStyleSettings;
            if (groups.contains(QLatin1String("CppCodeStyleSettings"))) {
                Utils::fromSettings(QLatin1String("CppCodeStyleSettings"),
                                    QString(), s, &legacyCodeStyleSettings);
194
            }
195 196 197 198 199 200 201 202 203

            const QString currentFallback = s->value(QLatin1String("CppTabPreferences/CurrentFallback")).toString();
            TabSettings legacyTabSettings;
            if (currentFallback == QLatin1String("CppGlobal")) {
                // no delegate, global overwritten
                Utils::fromSettings(QLatin1String("CppTabPreferences"),
                                    QString(), s, &legacyTabSettings);
            } else {
                // delegating to global
204
                legacyTabSettings = TextEditorSettings::codeStyle()->currentTabSettings();
205 206 207 208 209 210
            }

            // create custom code style out of old settings
            QVariant v;
            v.setValue(legacyCodeStyleSettings);
            TextEditor::ICodeStylePreferences *oldCreator = pool->createCodeStyle(
211
                     "legacy", legacyTabSettings, v, tr("Old Creator"));
212 213 214

            // change the current delegate and save
            d->m_globalCodeStyle->setCurrentDelegate(oldCreator);
215
            d->m_globalCodeStyle->toSettings(QLatin1String(CppTools::Constants::CPP_SETTINGS_ID), s);
Jarek Kobus's avatar
Jarek Kobus committed
216
        }
217 218
        // mark old settings as transformed
        s->setValue(QLatin1String("CppCodeStyleSettings/LegacyTransformed"), true);
Jarek Kobus's avatar
Jarek Kobus committed
219
        // legacy handling stop
220
    }
Jarek Kobus's avatar
Jarek Kobus committed
221 222 223


    // mimetypes to be handled
224 225 226 227
    TextEditorSettings::registerMimeTypeForLanguageId(Constants::C_SOURCE_MIMETYPE, Constants::CPP_SETTINGS_ID);
    TextEditorSettings::registerMimeTypeForLanguageId(Constants::C_HEADER_MIMETYPE, Constants::CPP_SETTINGS_ID);
    TextEditorSettings::registerMimeTypeForLanguageId(Constants::CPP_SOURCE_MIMETYPE, Constants::CPP_SETTINGS_ID);
    TextEditorSettings::registerMimeTypeForLanguageId(Constants::CPP_HEADER_MIMETYPE, Constants::CPP_SETTINGS_ID);
228 229 230 231
}

CppToolsSettings::~CppToolsSettings()
{
232
    ExtensionSystem::PluginManager::removeObject(d->m_completionSettingsPage);
233

234 235 236
    TextEditorSettings::unregisterCodeStyle(Constants::CPP_SETTINGS_ID);
    TextEditorSettings::unregisterCodeStylePool(Constants::CPP_SETTINGS_ID);
    TextEditorSettings::unregisterCodeStyleFactory(Constants::CPP_SETTINGS_ID);
jkobus's avatar
jkobus committed
237

hjk's avatar
hjk committed
238
    delete d;
239 240 241 242 243 244 245 246 247

    m_instance = 0;
}

CppToolsSettings *CppToolsSettings::instance()
{
    return m_instance;
}

Jarek Kobus's avatar
Jarek Kobus committed
248
CppCodeStylePreferences *CppToolsSettings::cppCodeStyle() const
249
{
Jarek Kobus's avatar
Jarek Kobus committed
250
    return d->m_globalCodeStyle;
251 252
}

253 254 255 256
const CommentsSettings &CppToolsSettings::commentsSettings() const
{
    return d->m_completionSettingsPage->commentsSettings();
}