forked from qt-creator/qt-creator
Merge CppTools into CppEditor
There was no proper separation of responsibilities between these plugins. In particular, CppTools had lots of editor-related functionality, so it's not clear why it was separated out in the first place. In fact, for a lot of code, it seemed quite arbitrary where it was put (just one example: switchHeaderSource() was in CppTools, wheras switchDeclarationDefinition() was in CppEditor). Merging the plugins will enable us to get rid of various convoluted pseudo-abstractions that were only introduced to keep up the artificial separation. Change-Id: Iafc3bce625b4794f6d4aa03df6cddc7f2d26716a Reviewed-by: Christian Stenger <christian.stenger@qt.io>
This commit is contained in:
Christian Kandeler
398
src/plugins/cppeditor/cppcodestylesettingspage.cpp
Normal file
398
src/plugins/cppeditor/cppcodestylesettingspage.cpp
Normal file
@@ -0,0 +1,398 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2016 The Qt Company Ltd.
|
||||
** Contact: https://www.qt.io/licensing/
|
||||
**
|
||||
** 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
|
||||
** a written agreement between you and The Qt Company. For licensing terms
|
||||
** and conditions see https://www.qt.io/terms-conditions. For further
|
||||
** information use the contact form at https://www.qt.io/contact-us.
|
||||
**
|
||||
** GNU General Public License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU
|
||||
** General Public License version 3 as published by the Free Software
|
||||
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
||||
** included in the packaging of this file. Please review the following
|
||||
** information to ensure the GNU General Public License requirements will
|
||||
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
#include "cppcodestylesettingspage.h"
|
||||
|
||||
#include "cppcodestylepreferences.h"
|
||||
#include "cppcodestylesnippets.h"
|
||||
#include "cppeditorconstants.h"
|
||||
#include "cpppointerdeclarationformatter.h"
|
||||
#include "cppqtstyleindenter.h"
|
||||
#include "cpptoolssettings.h"
|
||||
#include <ui_cppcodestylesettingspage.h>
|
||||
|
||||
#include <coreplugin/icore.h>
|
||||
#include <cppeditor/cppeditorconstants.h>
|
||||
#include <texteditor/codestyleeditor.h>
|
||||
#include <texteditor/fontsettings.h>
|
||||
#include <texteditor/icodestylepreferencesfactory.h>
|
||||
#include <texteditor/textdocument.h>
|
||||
#include <texteditor/displaysettings.h>
|
||||
#include <texteditor/snippets/snippetprovider.h>
|
||||
#include <texteditor/texteditorsettings.h>
|
||||
|
||||
#include <cplusplus/Overview.h>
|
||||
#include <cplusplus/pp.h>
|
||||
|
||||
#include <extensionsystem/pluginmanager.h>
|
||||
|
||||
#include <QTextBlock>
|
||||
#include <QTextStream>
|
||||
|
||||
using namespace TextEditor;
|
||||
|
||||
namespace CppEditor::Internal {
|
||||
|
||||
static void applyRefactorings(QTextDocument *textDocument, TextEditorWidget *editor,
|
||||
const CppCodeStyleSettings &settings)
|
||||
{
|
||||
// Preprocess source
|
||||
Environment env;
|
||||
Preprocessor preprocess(nullptr, &env);
|
||||
const QByteArray preprocessedSource
|
||||
= preprocess.run(QLatin1String("<no-file>"), textDocument->toPlainText());
|
||||
|
||||
Document::Ptr cppDocument = Document::create(QLatin1String("<no-file>"));
|
||||
cppDocument->setUtf8Source(preprocessedSource);
|
||||
cppDocument->parse(Document::ParseTranlationUnit);
|
||||
cppDocument->check();
|
||||
|
||||
CppRefactoringFilePtr cppRefactoringFile = CppRefactoringChanges::file(editor, cppDocument);
|
||||
|
||||
// Run the formatter
|
||||
Overview overview;
|
||||
overview.showReturnTypes = true;
|
||||
overview.starBindFlags = {};
|
||||
|
||||
if (settings.bindStarToIdentifier)
|
||||
overview.starBindFlags |= Overview::BindToIdentifier;
|
||||
if (settings.bindStarToTypeName)
|
||||
overview.starBindFlags |= Overview::BindToTypeName;
|
||||
if (settings.bindStarToLeftSpecifier)
|
||||
overview.starBindFlags |= Overview::BindToLeftSpecifier;
|
||||
if (settings.bindStarToRightSpecifier)
|
||||
overview.starBindFlags |= Overview::BindToRightSpecifier;
|
||||
|
||||
PointerDeclarationFormatter formatter(cppRefactoringFile, overview);
|
||||
Utils::ChangeSet change = formatter.format(cppDocument->translationUnit()->ast());
|
||||
|
||||
// Apply change
|
||||
QTextCursor cursor(textDocument);
|
||||
change.apply(&cursor);
|
||||
}
|
||||
|
||||
// ------------------ CppCodeStyleSettingsWidget
|
||||
|
||||
CppCodeStylePreferencesWidget::CppCodeStylePreferencesWidget(QWidget *parent)
|
||||
: QWidget(parent),
|
||||
m_ui(new Ui::CppCodeStyleSettingsPage)
|
||||
{
|
||||
m_ui->setupUi(this);
|
||||
m_ui->categoryTab->setProperty("_q_custom_style_disabled", true);
|
||||
|
||||
m_previews << m_ui->previewTextEditGeneral << m_ui->previewTextEditContent
|
||||
<< m_ui->previewTextEditBraces << m_ui->previewTextEditSwitch
|
||||
<< m_ui->previewTextEditPadding << m_ui->previewTextEditPointerReferences;
|
||||
for (int i = 0; i < m_previews.size(); ++i)
|
||||
m_previews[i]->setPlainText(QLatin1String(Constants::DEFAULT_CODE_STYLE_SNIPPETS[i]));
|
||||
|
||||
decorateEditors(TextEditorSettings::fontSettings());
|
||||
connect(TextEditorSettings::instance(), &TextEditorSettings::fontSettingsChanged,
|
||||
this, &CppCodeStylePreferencesWidget::decorateEditors);
|
||||
|
||||
setVisualizeWhitespace(true);
|
||||
|
||||
connect(m_ui->tabSettingsWidget, &TabSettingsWidget::settingsChanged,
|
||||
this, &CppCodeStylePreferencesWidget::slotTabSettingsChanged);
|
||||
connect(m_ui->indentBlockBraces, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentBlockBody, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentClassBraces, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentNamespaceBraces, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentEnumBraces, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentNamespaceBody, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentSwitchLabels, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentCaseStatements, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentCaseBlocks, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentCaseBreak, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentAccessSpecifiers, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentDeclarationsRelativeToAccessSpecifiers, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentFunctionBody, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->indentFunctionBraces, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->extraPaddingConditions, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->alignAssignments, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->bindStarToIdentifier, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->bindStarToTypeName, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->bindStarToLeftSpecifier, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
connect(m_ui->bindStarToRightSpecifier, &QCheckBox::toggled,
|
||||
this, &CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged);
|
||||
|
||||
m_ui->categoryTab->setCurrentIndex(0);
|
||||
}
|
||||
|
||||
CppCodeStylePreferencesWidget::~CppCodeStylePreferencesWidget()
|
||||
{
|
||||
delete m_ui;
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::setCodeStyle(CppCodeStylePreferences *codeStylePreferences)
|
||||
{
|
||||
// code preferences
|
||||
m_preferences = codeStylePreferences;
|
||||
|
||||
connect(m_preferences, &CppCodeStylePreferences::currentTabSettingsChanged,
|
||||
this, &CppCodeStylePreferencesWidget::setTabSettings);
|
||||
connect(m_preferences, &CppCodeStylePreferences::currentCodeStyleSettingsChanged,
|
||||
this, [this](const CppCodeStyleSettings &codeStyleSettings) {
|
||||
setCodeStyleSettings(codeStyleSettings);
|
||||
});
|
||||
|
||||
connect(m_preferences, &ICodeStylePreferences::currentPreferencesChanged,
|
||||
this, [this](TextEditor::ICodeStylePreferences *currentPreferences) {
|
||||
slotCurrentPreferencesChanged(currentPreferences);
|
||||
});
|
||||
|
||||
setTabSettings(m_preferences->tabSettings());
|
||||
setCodeStyleSettings(m_preferences->codeStyleSettings(), false);
|
||||
slotCurrentPreferencesChanged(m_preferences->currentPreferences(), false);
|
||||
|
||||
updatePreview();
|
||||
}
|
||||
|
||||
CppCodeStyleSettings CppCodeStylePreferencesWidget::cppCodeStyleSettings() const
|
||||
{
|
||||
CppCodeStyleSettings set;
|
||||
|
||||
set.indentBlockBraces = m_ui->indentBlockBraces->isChecked();
|
||||
set.indentBlockBody = m_ui->indentBlockBody->isChecked();
|
||||
set.indentClassBraces = m_ui->indentClassBraces->isChecked();
|
||||
set.indentEnumBraces = m_ui->indentEnumBraces->isChecked();
|
||||
set.indentNamespaceBraces = m_ui->indentNamespaceBraces->isChecked();
|
||||
set.indentNamespaceBody = m_ui->indentNamespaceBody->isChecked();
|
||||
set.indentAccessSpecifiers = m_ui->indentAccessSpecifiers->isChecked();
|
||||
set.indentDeclarationsRelativeToAccessSpecifiers = m_ui->indentDeclarationsRelativeToAccessSpecifiers->isChecked();
|
||||
set.indentFunctionBody = m_ui->indentFunctionBody->isChecked();
|
||||
set.indentFunctionBraces = m_ui->indentFunctionBraces->isChecked();
|
||||
set.indentSwitchLabels = m_ui->indentSwitchLabels->isChecked();
|
||||
set.indentStatementsRelativeToSwitchLabels = m_ui->indentCaseStatements->isChecked();
|
||||
set.indentBlocksRelativeToSwitchLabels = m_ui->indentCaseBlocks->isChecked();
|
||||
set.indentControlFlowRelativeToSwitchLabels = m_ui->indentCaseBreak->isChecked();
|
||||
set.bindStarToIdentifier = m_ui->bindStarToIdentifier->isChecked();
|
||||
set.bindStarToTypeName = m_ui->bindStarToTypeName->isChecked();
|
||||
set.bindStarToLeftSpecifier = m_ui->bindStarToLeftSpecifier->isChecked();
|
||||
set.bindStarToRightSpecifier = m_ui->bindStarToRightSpecifier->isChecked();
|
||||
set.extraPaddingForConditionsIfConfusingAlign = m_ui->extraPaddingConditions->isChecked();
|
||||
set.alignAssignments = m_ui->alignAssignments->isChecked();
|
||||
|
||||
return set;
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::setTabSettings(const TabSettings &settings)
|
||||
{
|
||||
m_ui->tabSettingsWidget->setTabSettings(settings);
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::setCodeStyleSettings(const CppCodeStyleSettings &s, bool preview)
|
||||
{
|
||||
const bool wasBlocked = m_blockUpdates;
|
||||
m_blockUpdates = true;
|
||||
m_ui->indentBlockBraces->setChecked(s.indentBlockBraces);
|
||||
m_ui->indentBlockBody->setChecked(s.indentBlockBody);
|
||||
m_ui->indentClassBraces->setChecked(s.indentClassBraces);
|
||||
m_ui->indentEnumBraces->setChecked(s.indentEnumBraces);
|
||||
m_ui->indentNamespaceBraces->setChecked(s.indentNamespaceBraces);
|
||||
m_ui->indentNamespaceBody->setChecked(s.indentNamespaceBody);
|
||||
m_ui->indentAccessSpecifiers->setChecked(s.indentAccessSpecifiers);
|
||||
m_ui->indentDeclarationsRelativeToAccessSpecifiers->setChecked(s.indentDeclarationsRelativeToAccessSpecifiers);
|
||||
m_ui->indentFunctionBody->setChecked(s.indentFunctionBody);
|
||||
m_ui->indentFunctionBraces->setChecked(s.indentFunctionBraces);
|
||||
m_ui->indentSwitchLabels->setChecked(s.indentSwitchLabels);
|
||||
m_ui->indentCaseStatements->setChecked(s.indentStatementsRelativeToSwitchLabels);
|
||||
m_ui->indentCaseBlocks->setChecked(s.indentBlocksRelativeToSwitchLabels);
|
||||
m_ui->indentCaseBreak->setChecked(s.indentControlFlowRelativeToSwitchLabels);
|
||||
m_ui->bindStarToIdentifier->setChecked(s.bindStarToIdentifier);
|
||||
m_ui->bindStarToTypeName->setChecked(s.bindStarToTypeName);
|
||||
m_ui->bindStarToLeftSpecifier->setChecked(s.bindStarToLeftSpecifier);
|
||||
m_ui->bindStarToRightSpecifier->setChecked(s.bindStarToRightSpecifier);
|
||||
m_ui->extraPaddingConditions->setChecked(s.extraPaddingForConditionsIfConfusingAlign);
|
||||
m_ui->alignAssignments->setChecked(s.alignAssignments);
|
||||
m_blockUpdates = wasBlocked;
|
||||
if (preview)
|
||||
updatePreview();
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::slotCurrentPreferencesChanged(ICodeStylePreferences *preferences, bool preview)
|
||||
{
|
||||
const bool enable = !preferences->isReadOnly() && !m_preferences->currentDelegate();
|
||||
m_ui->tabSettingsWidget->setEnabled(enable);
|
||||
m_ui->contentGroupBox->setEnabled(enable);
|
||||
m_ui->bracesGroupBox->setEnabled(enable);
|
||||
m_ui->switchGroupBox->setEnabled(enable);
|
||||
m_ui->alignmentGroupBox->setEnabled(enable);
|
||||
m_ui->pointerReferencesGroupBox->setEnabled(enable);
|
||||
if (preview)
|
||||
updatePreview();
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::slotCodeStyleSettingsChanged()
|
||||
{
|
||||
if (m_blockUpdates)
|
||||
return;
|
||||
|
||||
if (m_preferences) {
|
||||
auto current = qobject_cast<CppCodeStylePreferences *>(m_preferences->currentPreferences());
|
||||
if (current)
|
||||
current->setCodeStyleSettings(cppCodeStyleSettings());
|
||||
}
|
||||
|
||||
updatePreview();
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::slotTabSettingsChanged(const TabSettings &settings)
|
||||
{
|
||||
if (m_blockUpdates)
|
||||
return;
|
||||
|
||||
if (m_preferences) {
|
||||
auto current = qobject_cast<CppCodeStylePreferences *>(m_preferences->currentPreferences());
|
||||
if (current)
|
||||
current->setTabSettings(settings);
|
||||
}
|
||||
|
||||
updatePreview();
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::updatePreview()
|
||||
{
|
||||
CppCodeStylePreferences *cppCodeStylePreferences = m_preferences
|
||||
? m_preferences
|
||||
: CppToolsSettings::instance()->cppCodeStyle();
|
||||
const CppCodeStyleSettings ccss = cppCodeStylePreferences->currentCodeStyleSettings();
|
||||
const TabSettings ts = cppCodeStylePreferences->currentTabSettings();
|
||||
QtStyleCodeFormatter formatter(ts, ccss);
|
||||
foreach (SnippetEditorWidget *preview, m_previews) {
|
||||
preview->textDocument()->setTabSettings(ts);
|
||||
preview->setCodeStyle(cppCodeStylePreferences);
|
||||
|
||||
QTextDocument *doc = preview->document();
|
||||
formatter.invalidateCache(doc);
|
||||
|
||||
QTextBlock block = doc->firstBlock();
|
||||
QTextCursor tc = preview->textCursor();
|
||||
tc.beginEditBlock();
|
||||
while (block.isValid()) {
|
||||
preview->textDocument()->indenter()->indentBlock(block, QChar::Null, ts);
|
||||
|
||||
block = block.next();
|
||||
}
|
||||
applyRefactorings(doc, preview, ccss);
|
||||
tc.endEditBlock();
|
||||
}
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::decorateEditors(const FontSettings &fontSettings)
|
||||
{
|
||||
foreach (SnippetEditorWidget *editor, m_previews) {
|
||||
editor->textDocument()->setFontSettings(fontSettings);
|
||||
SnippetProvider::decorateEditor(editor, CppEditor::Constants::CPP_SNIPPETS_GROUP_ID);
|
||||
}
|
||||
}
|
||||
|
||||
void CppCodeStylePreferencesWidget::setVisualizeWhitespace(bool on)
|
||||
{
|
||||
foreach (SnippetEditorWidget *editor, m_previews) {
|
||||
DisplaySettings displaySettings = editor->displaySettings();
|
||||
displaySettings.m_visualizeWhitespace = on;
|
||||
editor->setDisplaySettings(displaySettings);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ------------------ CppCodeStyleSettingsPage
|
||||
|
||||
CppCodeStyleSettingsPage::CppCodeStyleSettingsPage()
|
||||
{
|
||||
setId(Constants::CPP_CODE_STYLE_SETTINGS_ID);
|
||||
setDisplayName(QCoreApplication::translate("CppEditor", Constants::CPP_CODE_STYLE_SETTINGS_NAME));
|
||||
setCategory(Constants::CPP_SETTINGS_CATEGORY);
|
||||
}
|
||||
|
||||
QWidget *CppCodeStyleSettingsPage::widget()
|
||||
{
|
||||
if (!m_widget) {
|
||||
CppCodeStylePreferences *originalCodeStylePreferences = CppToolsSettings::instance()
|
||||
->cppCodeStyle();
|
||||
m_pageCppCodeStylePreferences = new CppCodeStylePreferences();
|
||||
m_pageCppCodeStylePreferences->setDelegatingPool(
|
||||
originalCodeStylePreferences->delegatingPool());
|
||||
m_pageCppCodeStylePreferences->setCodeStyleSettings(
|
||||
originalCodeStylePreferences->codeStyleSettings());
|
||||
m_pageCppCodeStylePreferences->setCurrentDelegate(
|
||||
originalCodeStylePreferences->currentDelegate());
|
||||
// we set id so that it won't be possible to set delegate to the original prefs
|
||||
m_pageCppCodeStylePreferences->setId(originalCodeStylePreferences->id());
|
||||
m_widget = TextEditorSettings::codeStyleFactory(CppEditor::Constants::CPP_SETTINGS_ID)
|
||||
->createCodeStyleEditor(m_pageCppCodeStylePreferences);
|
||||
}
|
||||
return m_widget;
|
||||
}
|
||||
|
||||
void CppCodeStyleSettingsPage::apply()
|
||||
{
|
||||
if (m_widget) {
|
||||
QSettings *s = Core::ICore::settings();
|
||||
|
||||
CppCodeStylePreferences *originalCppCodeStylePreferences = CppToolsSettings::instance()->cppCodeStyle();
|
||||
if (originalCppCodeStylePreferences->codeStyleSettings() != m_pageCppCodeStylePreferences->codeStyleSettings()) {
|
||||
originalCppCodeStylePreferences->setCodeStyleSettings(m_pageCppCodeStylePreferences->codeStyleSettings());
|
||||
originalCppCodeStylePreferences->toSettings(QLatin1String(CppEditor::Constants::CPP_SETTINGS_ID), s);
|
||||
}
|
||||
if (originalCppCodeStylePreferences->tabSettings() != m_pageCppCodeStylePreferences->tabSettings()) {
|
||||
originalCppCodeStylePreferences->setTabSettings(m_pageCppCodeStylePreferences->tabSettings());
|
||||
originalCppCodeStylePreferences->toSettings(QLatin1String(CppEditor::Constants::CPP_SETTINGS_ID), s);
|
||||
}
|
||||
if (originalCppCodeStylePreferences->currentDelegate() != m_pageCppCodeStylePreferences->currentDelegate()) {
|
||||
originalCppCodeStylePreferences->setCurrentDelegate(m_pageCppCodeStylePreferences->currentDelegate());
|
||||
originalCppCodeStylePreferences->toSettings(QLatin1String(CppEditor::Constants::CPP_SETTINGS_ID), s);
|
||||
}
|
||||
|
||||
m_widget->apply();
|
||||
}
|
||||
}
|
||||
|
||||
void CppCodeStyleSettingsPage::finish()
|
||||
{
|
||||
delete m_widget;
|
||||
}
|
||||
|
||||
} // namespace CppEditor::Internal
|
||||
Reference in New Issue
Block a user