feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

ClangFormat: De-Q_OBJECT and de-pimpl ClangFormatConfigWidget

Browse Source 
Somewhat tighter code.

Change-Id: I8fde17ac66d0b1e49eb6554800f0f40d8f214ee3
Reviewed-by: Artem Sokolovskii <artem.sokolovskii@qt.io>
This commit is contained in:
hjk
2023-12-13 08:43:40 +01:00
parent 657a90ef52
commit 1200419059
3 changed files with 120 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files

199
src/plugins/clangformat/clangformatconfigwidget.cpp
View File

@@ -15,6 +15,7 @@
#include <cppeditor/cppcodestylepreferences.h> #include <cppeditor/cppcodestylepreferences.h>
#include <cppeditor/cppcodestylesettings.h> #include <cppeditor/cppcodestylesettings.h>
#include <cppeditor/cppcodestylesettingspage.h>
#include <cppeditor/cppcodestylesnippets.h> #include <cppeditor/cppcodestylesnippets.h>
#include <cppeditor/cpphighlighter.h> #include <cppeditor/cpphighlighter.h>
#include <cppeditor/cpptoolssettings.h> #include <cppeditor/cpptoolssettings.h>
@@ -38,15 +39,12 @@
#include <QLineEdit> #include <QLineEdit>
#include <QPushButton> #include <QPushButton>
#include <QScrollArea> #include <QScrollArea>
#include <QSharedPointer>
#include <QVBoxLayout> #include <QVBoxLayout>
#include <QVersionNumber>
#include <QWeakPointer>
#include <QWidget>
#include <clang/Basic/Version.h> #include <clang/Basic/Version.h>
#include <clang/Format/Format.h> #include <clang/Format/Format.h>
#include <memory>
#include <sstream> #include <sstream>
using namespace ProjectExplorer; using namespace ProjectExplorer;
@@ -54,20 +52,46 @@ using namespace Utils;
namespace ClangFormat { namespace ClangFormat {
class ClangFormatConfigWidget::Private class ClangFormatConfigWidget final : public CppEditor::CppCodeStyleWidget
{ {
public: public:
ProjectExplorer::Project *project = nullptr; ClangFormatConfigWidget(TextEditor::ICodeStylePreferences *codeStyle,
QWidget *checksWidget = nullptr; Project *project,
QScrollArea *checksScrollArea = nullptr; QWidget *parent);
TextEditor::SnippetEditorWidget *preview = nullptr; void apply() final;
std::unique_ptr<ClangFormatFile> config; void finish() final;
clang::format::FormatStyle style; void setCodeStyleSettings(const CppEditor::CppCodeStyleSettings &settings) final;
Utils::Guard ignoreChanges; void setTabSettings(const TextEditor::TabSettings &settings) final;
QLabel *fallbackConfig; void synchronize() final;
QLabel *clangVersion;
QLabel *clangWarningText; private:
QLabel *clangWarningIcon; bool eventFilter(QObject *object, QEvent *event) final;
FilePath globalPath();
FilePath projectPath();
void createStyleFileIfNeeded(bool isGlobal);
void showOrHideWidgets();
void initChecksAndPreview();
void connectChecks();
void fillTable();
std::string readFile(const QString &path);
void saveChanges(QObject *sender);
void updatePreview();
void slotCodeStyleChanged(TextEditor::ICodeStylePreferences *currentPreferences);
ProjectExplorer::Project *m_project = nullptr;
QWidget *m_checksWidget = nullptr;
QScrollArea *m_checksScrollArea = nullptr;
TextEditor::SnippetEditorWidget *m_preview = nullptr;
std::unique_ptr<ClangFormatFile> m_config;
clang::format::FormatStyle m_style;
Guard m_ignoreChanges;
QLabel *m_fallbackConfig;
QLabel *m_clangVersion;
QLabel *m_clangWarningText;
QLabel *m_clangWarningIcon;
}; };
bool ClangFormatConfigWidget::eventFilter(QObject *object, QEvent *event) bool ClangFormatConfigWidget::eventFilter(QObject *object, QEvent *event)
@@ -80,68 +104,68 @@ bool ClangFormatConfigWidget::eventFilter(QObject *object, QEvent *event)
} }
ClangFormatConfigWidget::ClangFormatConfigWidget(TextEditor::ICodeStylePreferences *codeStyle, ClangFormatConfigWidget::ClangFormatConfigWidget(TextEditor::ICodeStylePreferences *codeStyle,
ProjectExplorer::Project *project, Project *project,
QWidget *parent) QWidget *parent)
: CppCodeStyleWidget(parent), d(new Private) : CppCodeStyleWidget(parent)
{ {
d->project = project; m_project = project;
d->config = std::make_unique<ClangFormatFile>(codeStyle->currentPreferences()); m_config = std::make_unique<ClangFormatFile>(codeStyle->currentPreferences());
d->fallbackConfig = new QLabel(Tr::tr("Clang-Format Style")); m_fallbackConfig = new QLabel(Tr::tr("Clang-Format Style"));
d->checksScrollArea = new QScrollArea(); m_checksScrollArea = new QScrollArea();
d->checksWidget = new ClangFormatChecks(); m_checksWidget = new ClangFormatChecks();
d->checksScrollArea->setWidget(d->checksWidget); m_checksScrollArea->setWidget(m_checksWidget);
d->checksScrollArea->setWidgetResizable(true); m_checksScrollArea->setWidgetResizable(true);
d->checksWidget->setEnabled(!codeStyle->isReadOnly() && !codeStyle->isTemporarilyReadOnly() m_checksWidget->setEnabled(!codeStyle->isReadOnly() && !codeStyle->isTemporarilyReadOnly()
&& !codeStyle->isAdditionalTabDisabled()); && !codeStyle->isAdditionalTabDisabled());
static const int expectedMajorVersion = 17; static const int expectedMajorVersion = 17;
d->clangVersion = new QLabel(Tr::tr("Current ClangFormat version: %1.").arg(LLVM_VERSION_STRING), m_clangVersion = new QLabel(Tr::tr("Current ClangFormat version: %1.").arg(LLVM_VERSION_STRING),
this); this);
d->clangWarningText m_clangWarningText
= new QLabel(Tr::tr("The widget was generated for ClangFormat %1. " = new QLabel(Tr::tr("The widget was generated for ClangFormat %1. "
"If you use a different version, the widget may work incorrectly.") "If you use a different version, the widget may work incorrectly.")
.arg(expectedMajorVersion), .arg(expectedMajorVersion),
this); this);
QPalette palette = d->clangWarningText->palette(); QPalette palette = m_clangWarningText->palette();
palette.setColor(QPalette::WindowText, Qt::red); palette.setColor(QPalette::WindowText, Qt::red);
d->clangWarningText->setPalette(palette); m_clangWarningText->setPalette(palette);
d->clangWarningIcon = new QLabel(this); m_clangWarningIcon = new QLabel(this);
d->clangWarningIcon->setPixmap(Utils::Icons::WARNING.icon().pixmap(16, 16)); m_clangWarningIcon->setPixmap(Icons::WARNING.icon().pixmap(16, 16));
if (LLVM_VERSION_MAJOR == expectedMajorVersion) { if (LLVM_VERSION_MAJOR == expectedMajorVersion) {
d->clangWarningText->hide(); m_clangWarningText->hide();
d->clangWarningIcon->hide(); m_clangWarningIcon->hide();
} }
FilePath fileName; FilePath fileName;
if (d->project) if (m_project)
fileName = d->project->projectFilePath().pathAppended("snippet.cpp"); fileName = m_project->projectFilePath().pathAppended("snippet.cpp");
else else
fileName = Core::ICore::userResourcePath("snippet.cpp"); fileName = Core::ICore::userResourcePath("snippet.cpp");
d->preview = new TextEditor::SnippetEditorWidget(this); m_preview = new TextEditor::SnippetEditorWidget(this);
TextEditor::DisplaySettings displaySettings = d->preview->displaySettings(); TextEditor::DisplaySettings displaySettings = m_preview->displaySettings();
displaySettings.m_visualizeWhitespace = true; displaySettings.m_visualizeWhitespace = true;
d->preview->setDisplaySettings(displaySettings); m_preview->setDisplaySettings(displaySettings);
d->preview->setPlainText(QLatin1String(CppEditor::Constants::DEFAULT_CODE_STYLE_SNIPPETS[0])); m_preview->setPlainText(QLatin1String(CppEditor::Constants::DEFAULT_CODE_STYLE_SNIPPETS[0]));
d->preview->textDocument()->setIndenter(new ClangFormatIndenter(d->preview->document())); m_preview->textDocument()->setIndenter(new ClangFormatIndenter(m_preview->document()));
d->preview->textDocument()->setFontSettings(TextEditor::TextEditorSettings::fontSettings()); m_preview->textDocument()->setFontSettings(TextEditor::TextEditorSettings::fontSettings());
d->preview->textDocument()->resetSyntaxHighlighter( m_preview->textDocument()->resetSyntaxHighlighter(
[] { return new CppEditor::CppHighlighter(); }); [] { return new CppEditor::CppHighlighter(); });
d->preview->textDocument()->indenter()->setFileName(fileName); m_preview->textDocument()->indenter()->setFileName(fileName);
using namespace Layouting; using namespace Layouting;
Column { Column {
d->fallbackConfig, m_fallbackConfig,
Row {d->clangWarningIcon, d->clangWarningText, st}, Row {m_clangWarningIcon, m_clangWarningText, st},
d->clangVersion, m_clangVersion,
Row { d->checksScrollArea, d->preview }, Row { m_checksScrollArea, m_preview },
}.attachTo(this); }.attachTo(this);
connect(codeStyle, &TextEditor::ICodeStylePreferences::currentPreferencesChanged, connect(codeStyle, &TextEditor::ICodeStylePreferences::currentPreferencesChanged,
@@ -156,21 +180,16 @@ ClangFormatConfigWidget::ClangFormatConfigWidget(TextEditor::ICodeStylePreferenc
connectChecks(); connectChecks();
} }
ClangFormatConfigWidget::~ClangFormatConfigWidget()
{
delete d;
}
void ClangFormatConfigWidget::slotCodeStyleChanged( void ClangFormatConfigWidget::slotCodeStyleChanged(
TextEditor::ICodeStylePreferences *codeStyle) TextEditor::ICodeStylePreferences *codeStyle)
{ {
if (!codeStyle) if (!codeStyle)
return; return;
d->config.reset(new ClangFormatFile(codeStyle)); m_config.reset(new ClangFormatFile(codeStyle));
d->config->setIsReadOnly(codeStyle->isReadOnly()); m_config->setIsReadOnly(codeStyle->isReadOnly());
d->style = d->config->style(); m_style = m_config->style();
d->checksWidget->setEnabled(!codeStyle->isReadOnly() && !codeStyle->isTemporarilyReadOnly() m_checksWidget->setEnabled(!codeStyle->isReadOnly() && !codeStyle->isTemporarilyReadOnly()
&& !codeStyle->isAdditionalTabDisabled()); && !codeStyle->isAdditionalTabDisabled());
fillTable(); fillTable();
@@ -180,11 +199,11 @@ void ClangFormatConfigWidget::slotCodeStyleChanged(
void ClangFormatConfigWidget::connectChecks() void ClangFormatConfigWidget::connectChecks()
{ {
auto doSaveChanges = [this](QObject *sender) { auto doSaveChanges = [this](QObject *sender) {
if (!d->ignoreChanges.isLocked()) if (!m_ignoreChanges.isLocked())
saveChanges(sender); saveChanges(sender);
}; };
for (QObject *child : d->checksWidget->children()) { for (QObject *child : m_checksWidget->children()) {
auto comboBox = qobject_cast<QComboBox *>(child); auto comboBox = qobject_cast<QComboBox *>(child);
if (comboBox != nullptr) { if (comboBox != nullptr) {
connect(comboBox, &QComboBox::currentIndexChanged, connect(comboBox, &QComboBox::currentIndexChanged,
@@ -216,15 +235,15 @@ static clang::format::FormatStyle constructStyle(const QByteArray &baseStyle = Q
return qtcStyle(); return qtcStyle();
} }
Utils::FilePath ClangFormatConfigWidget::globalPath() FilePath ClangFormatConfigWidget::globalPath()
{ {
return Core::ICore::userResourcePath(); return Core::ICore::userResourcePath();
} }
Utils::FilePath ClangFormatConfigWidget::projectPath() FilePath ClangFormatConfigWidget::projectPath()
{ {
if (d->project) if (m_project)
return globalPath().pathAppended("clang-format/" + projectUniqueId(d->project)); return globalPath().pathAppended("clang-format/" + projectUniqueId(m_project));
return {}; return {};
} }
@@ -239,7 +258,7 @@ void ClangFormatConfigWidget::createStyleFileIfNeeded(bool isGlobal)
path.ensureWritableDir(); path.ensureWritableDir();
if (!isGlobal) { if (!isGlobal) {
FilePath possibleProjectConfig = d->project->rootProjectDirectory() FilePath possibleProjectConfig = m_project->rootProjectDirectory()
/ Constants::SETTINGS_FILE_NAME; / Constants::SETTINGS_FILE_NAME;
if (possibleProjectConfig.exists()) { if (possibleProjectConfig.exists()) {
// Just copy th .clang-format if current project has one. // Just copy th .clang-format if current project has one.
@@ -261,18 +280,18 @@ void ClangFormatConfigWidget::showOrHideWidgets()
if (lastItem->spacerItem()) if (lastItem->spacerItem())
verticalLayout->removeItem(lastItem); verticalLayout->removeItem(lastItem);
createStyleFileIfNeeded(!d->project); createStyleFileIfNeeded(!m_project);
d->fallbackConfig->show(); m_fallbackConfig->show();
d->checksScrollArea->show(); m_checksScrollArea->show();
d->preview->show(); m_preview->show();
} }
void ClangFormatConfigWidget::updatePreview() void ClangFormatConfigWidget::updatePreview()
{ {
QTextCursor cursor(d->preview->document()); QTextCursor cursor(m_preview->document());
cursor.setPosition(0); cursor.setPosition(0);
cursor.movePosition(QTextCursor::End, QTextCursor::KeepAnchor); cursor.movePosition(QTextCursor::End, QTextCursor::KeepAnchor);
d->preview->textDocument()->autoIndent(cursor); m_preview->textDocument()->autoIndent(cursor);
} }
std::string ClangFormatConfigWidget::readFile(const QString &path) std::string ClangFormatConfigWidget::readFile(const QString &path)
@@ -352,12 +371,12 @@ static std::map<QString, QString> getMapFromString(const QString &text)
void ClangFormatConfigWidget::fillTable() void ClangFormatConfigWidget::fillTable()
{ {
Utils::GuardLocker locker(d->ignoreChanges); GuardLocker locker(m_ignoreChanges);
const QString configText = QString::fromStdString(readFile(d->config->filePath().path())); const QString configText = QString::fromStdString(readFile(m_config->filePath().path()));
std::map<QString, QString> objectNameMap = getMapFromString(configText); std::map<QString, QString> objectNameMap = getMapFromString(configText);
for (QObject *child : d->checksWidget->children()) { for (QObject *child : m_checksWidget->children()) {
if (!qobject_cast<QComboBox *>(child) && !qobject_cast<QLineEdit *>(child) if (!qobject_cast<QComboBox *>(child) && !qobject_cast<QLineEdit *>(child)
&& !qobject_cast<QPlainTextEdit *>(child)) { && !qobject_cast<QPlainTextEdit *>(child)) {
continue; continue;
@@ -390,13 +409,13 @@ void ClangFormatConfigWidget::fillTable()
void ClangFormatConfigWidget::saveChanges(QObject *sender) void ClangFormatConfigWidget::saveChanges(QObject *sender)
{ {
if (sender->objectName() == "BasedOnStyle") { if (sender->objectName() == "BasedOnStyle") {
const auto *basedOnStyle = d->checksWidget->findChild<QComboBox *>("BasedOnStyle"); const auto *basedOnStyle = m_checksWidget->findChild<QComboBox *>("BasedOnStyle");
d->config->setBasedOnStyle(basedOnStyle->currentText()); m_config->setBasedOnStyle(basedOnStyle->currentText());
} else { } else {
QList<ClangFormatFile::Field> fields; QList<ClangFormatFile::Field> fields;
QString parentName; QString parentName;
for (QObject *child : d->checksWidget->children()) { for (QObject *child : m_checksWidget->children()) {
if (child->objectName() == "BasedOnStyle") if (child->objectName() == "BasedOnStyle")
continue; continue;
auto *label = qobject_cast<QLabel *>(child); auto *label = qobject_cast<QLabel *>(child);
@@ -407,7 +426,7 @@ void ClangFormatConfigWidget::saveChanges(QObject *sender)
if (!label->text().startsWith(" ")) if (!label->text().startsWith(" "))
parentName = ""; parentName = "";
QList<QWidget *> valueWidgets = d->checksWidget->findChildren<QWidget *>( QList<QWidget *> valueWidgets = m_checksWidget->findChildren<QWidget *>(
parentName + label->text().trimmed()); parentName + label->text().trimmed());
if (valueWidgets.empty()) { if (valueWidgets.empty()) {
@@ -458,7 +477,7 @@ void ClangFormatConfigWidget::saveChanges(QObject *sender)
fields.append({label->text(), text}); fields.append({label->text(), text});
} }
} }
d->config->changeFields(fields); m_config->changeFields(fields);
} }
fillTable(); fillTable();
@@ -468,7 +487,7 @@ void ClangFormatConfigWidget::saveChanges(QObject *sender)
void ClangFormatConfigWidget::setCodeStyleSettings(const CppEditor::CppCodeStyleSettings &settings) void ClangFormatConfigWidget::setCodeStyleSettings(const CppEditor::CppCodeStyleSettings &settings)
{ {
d->config->fromCppCodeStyleSettings(settings); m_config->fromCppCodeStyleSettings(settings);
fillTable(); fillTable();
updatePreview(); updatePreview();
@@ -476,7 +495,7 @@ void ClangFormatConfigWidget::setCodeStyleSettings(const CppEditor::CppCodeStyle
void ClangFormatConfigWidget::setTabSettings(const TextEditor::TabSettings &settings) void ClangFormatConfigWidget::setTabSettings(const TextEditor::TabSettings &settings)
{ {
d->config->fromTabSettings(settings); m_config->fromTabSettings(settings);
fillTable(); fillTable();
updatePreview(); updatePreview();
@@ -484,24 +503,32 @@ void ClangFormatConfigWidget::setTabSettings(const TextEditor::TabSettings &sett
void ClangFormatConfigWidget::synchronize() void ClangFormatConfigWidget::synchronize()
{ {
emit codeStyleSettingsChanged(d->config->toCppCodeStyleSettings(d->project)); emit codeStyleSettingsChanged(m_config->toCppCodeStyleSettings(m_project));
emit tabSettingsChanged(d->config->toTabSettings(d->project)); emit tabSettingsChanged(m_config->toTabSettings(m_project));
} }
void ClangFormatConfigWidget::apply() void ClangFormatConfigWidget::apply()
{ {
if (!d->checksWidget->isVisible() && !d->checksWidget->isEnabled()) if (!m_checksWidget->isVisible() && !m_checksWidget->isEnabled())
return; return;
d->style = d->config->style(); m_style = m_config->style();
} }
void ClangFormatConfigWidget::finish() void ClangFormatConfigWidget::finish()
{ {
if (!d->checksWidget->isVisible() && !d->checksWidget->isEnabled()) if (!m_checksWidget->isVisible() && !m_checksWidget->isEnabled())
return; return;
d->config->setStyle(d->style); m_config->setStyle(m_style);
}
CppEditor::CppCodeStyleWidget *createClangFormatConfigWidget(
TextEditor::ICodeStylePreferences *codeStyle,
Project *project,
QWidget *parent)
{
return new ClangFormatConfigWidget(codeStyle, project, parent);
} }
} // namespace ClangFormat } // namespace ClangFormat

46
src/plugins/clangformat/clangformatconfigwidget.h
View File

@@ -3,49 +3,15 @@
#pragma once #pragma once
#include <cppeditor/cppcodestylesettingspage.h> namespace CppEditor { class CppCodeStyleWidget; }
namespace TextEditor { class ICodeStylePreferences; }
#include <memory>
namespace ProjectExplorer { class Project; } namespace ProjectExplorer { class Project; }
namespace CppEditor { class CppCodeStyleSettings; }
namespace ClangFormat { namespace ClangFormat {
class ClangFormatConfigWidget : public CppEditor::CppCodeStyleWidget CppEditor::CppCodeStyleWidget *createClangFormatConfigWidget(
{ TextEditor::ICodeStylePreferences *codeStyle,
Q_OBJECT ProjectExplorer::Project *project,
QWidget *parent);
public:
explicit ClangFormatConfigWidget(TextEditor::ICodeStylePreferences *codeStyle,
ProjectExplorer::Project *project = nullptr,
QWidget *parent = nullptr);
~ClangFormatConfigWidget() override;
void apply() override;
void finish() override;
void setCodeStyleSettings(const CppEditor::CppCodeStyleSettings &settings) override;
void setTabSettings(const TextEditor::TabSettings &settings) override;
void synchronize() override;
private:
bool eventFilter(QObject *object, QEvent *event) override;
Utils::FilePath globalPath();
Utils::FilePath projectPath();
void createStyleFileIfNeeded(bool isGlobal);
void showOrHideWidgets();
void initChecksAndPreview();
void connectChecks();
void fillTable();
std::string readFile(const QString &path);
void saveChanges(QObject *sender);
void updatePreview();
void slotCodeStyleChanged(TextEditor::ICodeStylePreferences *currentPreferences);
class Private;
Private * const d;
};
} // ClangFormat } // ClangFormat

2
src/plugins/clangformat/clangformatplugin.cpp
View File

@@ -47,7 +47,7 @@ public:
std::pair<CppCodeStyleWidget *, QString> additionalTab( std::pair<CppCodeStyleWidget *, QString> additionalTab(
ICodeStylePreferences *codeStyle, Project *project, QWidget *parent) const override ICodeStylePreferences *codeStyle, Project *project, QWidget *parent) const override
{ {
return {new ClangFormatConfigWidget(codeStyle, project, parent), Tr::tr("ClangFormat")}; return {createClangFormatConfigWidget(codeStyle, project, parent), Tr::tr("ClangFormat")};
} }
CodeStyleEditorWidget *createAdditionalGlobalSettings( CodeStyleEditorWidget *createAdditionalGlobalSettings(