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

ClangFormat: Pimpl ClangFormatConfigWidget

Browse Source 
Task-number: QTBUG-110780
Change-Id: I4039db916276c84660775a2cdd4e4538df784329
Reviewed-by: Artem Sokolovskii <artem.sokolovskii@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
This commit is contained in:
Christian Kandeler
2023-02-01 10:36:59 +01:00
parent 6758b5f69f
commit 93201df992
2 changed files with 77 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3,15 +3,13 @@
#include "clangformatconfigwidget.h"
#include "clangformatchecks.h"
#include "clangformatconstants.h"
#include "clangformatindenter.h"
#include "clangformatfile.h"
#include "clangformatindenter.h"
#include "clangformatutils.h"
// the file was generated by scripts/generateClangFormatChecksLayout.py
#include "clangformatchecks.h"
#include <clang/Format/Format.h>
#include <coreplugin/icore.h>
@@ -30,6 +28,7 @@
#include <texteditor/textdocument.h>
#include <texteditor/texteditorsettings.h>
#include <utils/guard.h>
#include <utils/layoutbuilder.h>
#include <utils/qtcassert.h>
@@ -37,11 +36,14 @@
#include <QLabel>
#include <QLineEdit>
#include <QPushButton>
#include <QScrollArea>
#include <QSharedPointer>
#include <QVBoxLayout>
#include <QWeakPointer>
#include <QWidget>
#include <clang/Format/Format.h>
#include <sstream>
using namespace ProjectExplorer;
@@ -49,6 +51,19 @@ using namespace Utils;
namespace ClangFormat {
class ClangFormatConfigWidget::Private
{
public:
ProjectExplorer::Project *project = nullptr;
QWidget *checksWidget = nullptr;
QScrollArea *checksScrollArea = nullptr;
TextEditor::SnippetEditorWidget *preview = nullptr;
std::unique_ptr<ClangFormatFile> config;
clang::format::FormatStyle style;
Utils::Guard ignoreChanges;
QLabel *fallbackConfig;
};
bool ClangFormatConfigWidget::eventFilter(QObject *object, QEvent *event)
{
if (event->type() == QEvent::Wheel && qobject_cast<QComboBox *>(object)) {
@@ -61,41 +76,41 @@ bool ClangFormatConfigWidget::eventFilter(QObject *object, QEvent *event)
ClangFormatConfigWidget::ClangFormatConfigWidget(TextEditor::ICodeStylePreferences *codeStyle,
ProjectExplorer::Project *project,
QWidget *parent)
: CppCodeStyleWidget(parent)
, m_project(project)
: CppCodeStyleWidget(parent), d(new Private)
{
m_config = std::make_unique<ClangFormatFile>(filePathToCurrentSettings(codeStyle->currentPreferences()));
d->project = project;
d->config = std::make_unique<ClangFormatFile>(filePathToCurrentSettings(codeStyle->currentPreferences()));
resize(489, 305);
m_fallbackConfig = new QLabel(tr("Clang-Format Style"));
m_checksScrollArea = new QScrollArea();
m_checksWidget = new ClangFormatChecks();
d->fallbackConfig = new QLabel(tr("Clang-Format Style"));
d->checksScrollArea = new QScrollArea();
d->checksWidget = new ClangFormatChecks();
m_checksScrollArea->setWidget(m_checksWidget);
m_checksScrollArea->setWidgetResizable(true);
m_checksWidget->setEnabled(!codeStyle->isReadOnly());
d->checksScrollArea->setWidget(d->checksWidget);
d->checksScrollArea->setWidgetResizable(true);
d->checksWidget->setEnabled(!codeStyle->isReadOnly());
FilePath fileName;
if (m_project)
fileName = m_project->projectFilePath().pathAppended("snippet.cpp");
if (d->project)
fileName = d->project->projectFilePath().pathAppended("snippet.cpp");
else
fileName = Core::ICore::userResourcePath("snippet.cpp");
m_preview = new TextEditor::SnippetEditorWidget(this);
TextEditor::DisplaySettings displaySettings = m_preview->displaySettings();
d->preview = new TextEditor::SnippetEditorWidget(this);
TextEditor::DisplaySettings displaySettings = d->preview->displaySettings();
displaySettings.m_visualizeWhitespace = true;
m_preview->setDisplaySettings(displaySettings);
m_preview->setPlainText(QLatin1String(CppEditor::Constants::DEFAULT_CODE_STYLE_SNIPPETS[0]));
m_preview->textDocument()->setIndenter(new ClangFormatIndenter(m_preview->document()));
m_preview->textDocument()->setFontSettings(TextEditor::TextEditorSettings::fontSettings());
m_preview->textDocument()->setSyntaxHighlighter(new CppEditor::CppHighlighter);
m_preview->textDocument()->indenter()->setFileName(fileName);
d->preview->setDisplaySettings(displaySettings);
d->preview->setPlainText(QLatin1String(CppEditor::Constants::DEFAULT_CODE_STYLE_SNIPPETS[0]));
d->preview->textDocument()->setIndenter(new ClangFormatIndenter(d->preview->document()));
d->preview->textDocument()->setFontSettings(TextEditor::TextEditorSettings::fontSettings());
d->preview->textDocument()->setSyntaxHighlighter(new CppEditor::CppHighlighter);
d->preview->textDocument()->indenter()->setFileName(fileName);
using namespace Layouting;
Column {
m_fallbackConfig,
Row { m_checksScrollArea, m_preview },
d->fallbackConfig,
Row { d->checksScrollArea, d->preview },
}.attachTo(this);
connect(codeStyle, &TextEditor::ICodeStylePreferences::currentPreferencesChanged,
@@ -110,18 +125,21 @@ ClangFormatConfigWidget::ClangFormatConfigWidget(TextEditor::ICodeStylePreferenc
connectChecks();
}
ClangFormatConfigWidget::~ClangFormatConfigWidget() = default;
ClangFormatConfigWidget::~ClangFormatConfigWidget()
{
delete d;
}
void ClangFormatConfigWidget::slotCodeStyleChanged(
TextEditor::ICodeStylePreferences *codeStyle)
{
if (!codeStyle)
return;
m_config.reset(new ClangFormatFile(filePathToCurrentSettings(codeStyle)));
m_config->setIsReadOnly(codeStyle->isReadOnly());
m_style = m_config->style();
d->config.reset(new ClangFormatFile(filePathToCurrentSettings(codeStyle)));
d->config->setIsReadOnly(codeStyle->isReadOnly());
d->style = d->config->style();
m_checksWidget->setEnabled(!codeStyle->isReadOnly());
d->checksWidget->setEnabled(!codeStyle->isReadOnly());
fillTable();
updatePreview();
@@ -130,11 +148,11 @@ void ClangFormatConfigWidget::slotCodeStyleChanged(
void ClangFormatConfigWidget::connectChecks()
{
auto doSaveChanges = [this](QObject *sender) {
if (!m_ignoreChanges.isLocked())
if (!d->ignoreChanges.isLocked())
saveChanges(sender);
};
for (QObject *child : m_checksWidget->children()) {
for (QObject *child : d->checksWidget->children()) {
auto comboBox = qobject_cast<QComboBox *>(child);
if (comboBox != nullptr) {
connect(comboBox, &QComboBox::currentIndexChanged,
@@ -173,8 +191,8 @@ Utils::FilePath ClangFormatConfigWidget::globalPath()
Utils::FilePath ClangFormatConfigWidget::projectPath()
{
if (m_project)
return globalPath().pathAppended("clang-format/" + projectUniqueId(m_project));
if (d->project)
return globalPath().pathAppended("clang-format/" + projectUniqueId(d->project));
return Utils::FilePath();
}
@@ -189,7 +207,7 @@ void ClangFormatConfigWidget::createStyleFileIfNeeded(bool isGlobal)
QDir().mkpath(path.toString());
if (!isGlobal) {
FilePath possibleProjectConfig = m_project->rootProjectDirectory()
FilePath possibleProjectConfig = d->project->rootProjectDirectory()
/ Constants::SETTINGS_FILE_NAME;
if (possibleProjectConfig.exists()) {
// Just copy th .clang-format if current project has one.
@@ -214,18 +232,18 @@ void ClangFormatConfigWidget::showOrHideWidgets()
if (lastItem->spacerItem())
verticalLayout->removeItem(lastItem);
createStyleFileIfNeeded(!m_project);
m_fallbackConfig->show();
m_checksScrollArea->show();
m_preview->show();
createStyleFileIfNeeded(!d->project);
d->fallbackConfig->show();
d->checksScrollArea->show();
d->preview->show();
}
void ClangFormatConfigWidget::updatePreview()
{
QTextCursor cursor(m_preview->document());
QTextCursor cursor(d->preview->document());
cursor.setPosition(0);
cursor.movePosition(QTextCursor::End, QTextCursor::KeepAnchor);
m_preview->textDocument()->autoIndent(cursor);
d->preview->textDocument()->autoIndent(cursor);
}
static inline void ltrim(std::string &s)
@@ -333,11 +351,11 @@ std::string ClangFormatConfigWidget::readFile(const QString &path)
void ClangFormatConfigWidget::fillTable()
{
Utils::GuardLocker locker(m_ignoreChanges);
Utils::GuardLocker locker(d->ignoreChanges);
const std::string configText = readFile(m_config->filePath().path());
const std::string configText = readFile(d->config->filePath().path());
for (QObject *child : m_checksWidget->children()) {
for (QObject *child : d->checksWidget->children()) {
if (!qobject_cast<QComboBox *>(child) && !qobject_cast<QLineEdit *>(child)
&& !qobject_cast<QPlainTextEdit *>(child)) {
continue;
@@ -357,19 +375,19 @@ void ClangFormatConfigWidget::fillTable()
void ClangFormatConfigWidget::saveChanges(QObject *sender)
{
if (sender->objectName() == "BasedOnStyle") {
const auto *basedOnStyle = m_checksWidget->findChild<QComboBox *>("BasedOnStyle");
m_config->setBasedOnStyle(basedOnStyle->currentText());
const auto *basedOnStyle = d->checksWidget->findChild<QComboBox *>("BasedOnStyle");
d->config->setBasedOnStyle(basedOnStyle->currentText());
} else {
QList<ClangFormatFile::Field> fields;
for (QObject *child : m_checksWidget->children()) {
for (QObject *child : d->checksWidget->children()) {
if (child->objectName() == "BasedOnStyle")
continue;
auto *label = qobject_cast<QLabel *>(child);
if (!label)
continue;
QWidget *valueWidget = m_checksWidget->findChild<QWidget *>(label->text().trimmed());
QWidget *valueWidget = d->checksWidget->findChild<QWidget *>(label->text().trimmed());
if (!valueWidget) {
// Currently BraceWrapping only.
fields.append({label->text(), ""});
@@ -407,7 +425,7 @@ void ClangFormatConfigWidget::saveChanges(QObject *sender)
fields.append({label->text(), text});
}
}
m_config->changeFields(fields);
d->config->changeFields(fields);
}
fillTable();
@@ -417,7 +435,7 @@ void ClangFormatConfigWidget::saveChanges(QObject *sender)
void ClangFormatConfigWidget::setCodeStyleSettings(const CppEditor::CppCodeStyleSettings &settings)
{
m_config->fromCppCodeStyleSettings(settings);
d->config->fromCppCodeStyleSettings(settings);
fillTable();
updatePreview();
@@ -425,7 +443,7 @@ void ClangFormatConfigWidget::setCodeStyleSettings(const CppEditor::CppCodeStyle
void ClangFormatConfigWidget::setTabSettings(const TextEditor::TabSettings &settings)
{
m_config->fromTabSettings(settings);
d->config->fromTabSettings(settings);
fillTable();
updatePreview();
@@ -433,24 +451,24 @@ void ClangFormatConfigWidget::setTabSettings(const TextEditor::TabSettings &sett
void ClangFormatConfigWidget::synchronize()
{
emit codeStyleSettingsChanged(m_config->toCppCodeStyleSettings(m_project));
emit tabSettingsChanged(m_config->toTabSettings(m_project));
emit codeStyleSettingsChanged(d->config->toCppCodeStyleSettings(d->project));
emit tabSettingsChanged(d->config->toTabSettings(d->project));
}
void ClangFormatConfigWidget::apply()
{
if (!m_checksWidget->isVisible() && !m_checksWidget->isEnabled())
if (!d->checksWidget->isVisible() && !d->checksWidget->isEnabled())
return;
m_style = m_config->style();
d->style = d->config->style();
}
void ClangFormatConfigWidget::finish()
{
if (!m_checksWidget->isVisible() && !m_checksWidget->isEnabled())
if (!d->checksWidget->isVisible() && !d->checksWidget->isEnabled())
return;
m_config->setStyle(m_style);
d->config->setStyle(d->style);
}
} // namespace ClangFormat