From 8eececaa96153c69c11ac42c4b09e5b1944f9d4e Mon Sep 17 00:00:00 2001 From: Ivan Donchevskii Date: Thu, 2 Nov 2017 16:26:17 +0100 Subject: [PATCH] Clang: add clang plugins checks to code model settings Add UI controls to change settings and apply them together with warnings and command line options. Current settings are not very flexible but should be easy to test and use without reading tidy/clazy help. Change-Id: I1ca6b49a42a1169b34a703dd50de0bbc105df28f Reviewed-by: Leena Miettinen Reviewed-by: Nikolai Kosjar --- .../clangeditordocumentprocessor.cpp | 48 +++++- src/plugins/clangcodemodel/clangutils.cpp | 32 +--- src/plugins/cpptools/clazychecks.ui | 80 +++++++++ src/plugins/cpptools/cppcodemodelsettings.cpp | 34 ++++ src/plugins/cpptools/cppcodemodelsettings.h | 9 + .../cpptools/cppcodemodelsettingspage.cpp | 71 ++++++++ .../cpptools/cppcodemodelsettingspage.h | 18 ++ .../cpptools/cppcodemodelsettingspage.ui | 37 +++++ src/plugins/cpptools/cpptools.pro | 4 +- src/plugins/cpptools/cpptools.qbs | 2 + src/plugins/cpptools/cpptoolsconstants.h | 2 + src/plugins/cpptools/tidychecks.ui | 157 ++++++++++++++++++ 12 files changed, 460 insertions(+), 34 deletions(-) create mode 100644 src/plugins/cpptools/clazychecks.ui create mode 100644 src/plugins/cpptools/tidychecks.ui diff --git a/src/plugins/clangcodemodel/clangeditordocumentprocessor.cpp b/src/plugins/clangcodemodel/clangeditordocumentprocessor.cpp index 3d2f2f5267e..4735c8497bd 100644 --- a/src/plugins/clangcodemodel/clangeditordocumentprocessor.cpp +++ b/src/plugins/clangcodemodel/clangeditordocumentprocessor.cpp @@ -553,12 +553,54 @@ static QStringList warningOptions(CppTools::ProjectPart *projectPart) return CppTools::codeModelSettings()->clangDiagnosticConfig().commandLineWarnings(); } +static QStringList tidyCommandLine() +{ + const QString tidyChecks = CppTools::codeModelSettings()->tidyChecks(); + + if (tidyChecks.isEmpty()) + return QStringList(); + + QStringList result; + result.append("-Xclang"); + result.append("-add-plugin"); + result.append("-Xclang"); + result.append("clang-tidy"); + result.append("-Xclang"); + result.append("-plugin-arg-clang-tidy"); + result.append("-Xclang"); + result.append("-checks='-*" + tidyChecks + "'"); + return result; +} + +static QStringList clazyCommandLine() +{ + const QString clazyChecks = CppTools::codeModelSettings()->clazyChecks(); + + if (clazyChecks.isEmpty()) + return QStringList(); + + QStringList result; + result.append("-Xclang"); + result.append("-add-plugin"); + result.append("-Xclang"); + result.append("clang-lazy"); + result.append("-Xclang"); + result.append("-plugin-arg-clang-lazy"); + result.append("-Xclang"); + result.append(clazyChecks); + return result; +} + static QStringList commandLineOptions(CppTools::ProjectPart *projectPart) { + QStringList result; if (!projectPart || !projectPart->project) - return ClangProjectSettings::globalCommandLineOptions(); - - return ClangProjectSettings{projectPart->project}.commandLineOptions(); + result.append(ClangProjectSettings::globalCommandLineOptions()); + else + result.append(ClangProjectSettings{projectPart->project}.commandLineOptions()); + result.append(tidyCommandLine()); + result.append(clazyCommandLine()); + return result; } static QStringList precompiledHeaderOptions( diff --git a/src/plugins/clangcodemodel/clangutils.cpp b/src/plugins/clangcodemodel/clangutils.cpp index 81c85dc12c7..8d04157d59e 100644 --- a/src/plugins/clangcodemodel/clangutils.cpp +++ b/src/plugins/clangcodemodel/clangutils.cpp @@ -35,6 +35,8 @@ #include #include #include +#include +#include #include #include @@ -79,12 +81,6 @@ static QString creatorResourcePath() #endif } -static bool loadClangPlugins() -{ - static bool load = qEnvironmentVariableIntValue("QTC_CLANG_PLUGINS_LOAD"); - return load; -} - class LibClangOptionsBuilder final : public CompilerOptionsBuilder { public: @@ -102,10 +98,6 @@ public: void addExtraOptions() final { addDummyUiHeaderOnDiskIncludePath(); - if (loadClangPlugins()) { - addTidyPlugin(); - addClazyPlugin(); - } add("-fmessage-length=0"); add("-fdiagnostics-show-note-include-stack"); add("-fmacro-backtrace-limit=0"); @@ -133,26 +125,6 @@ private: if (!path.isEmpty()) add(includeDirOption() + QDir::toNativeSeparators(path)); } - - void addClazyPlugin() - { - add("-Xclang"); - add("-add-plugin"); - add("-Xclang"); - add("clang-lazy"); - } - - void addTidyPlugin() - { - add("-Xclang"); - add("-add-plugin"); - add("-Xclang"); - add("clang-tidy"); - add("-Xclang"); - add("-plugin-arg-clang-tidy"); - add("-Xclang"); - add("-checks='-*,clang-diagnostic-*,llvm-*,misc-*,-misc-unused-parameters,readability-identifier-naming'"); - } }; /** diff --git a/src/plugins/cpptools/clazychecks.ui b/src/plugins/cpptools/clazychecks.ui new file mode 100644 index 00000000000..7008201b4a7 --- /dev/null +++ b/src/plugins/cpptools/clazychecks.ui @@ -0,0 +1,80 @@ + + + CppTools::ClazyChecks + + + + 0 + 0 + 503 + 40 + + + + + 0 + 0 + + + + Form + + + + 0 + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + 0 + 0 + + + + 0 + + + + Disable + + + + + level0 + + + + + level1 + + + + + level2 + + + + + level3 + + + + + + + + + diff --git a/src/plugins/cpptools/cppcodemodelsettings.cpp b/src/plugins/cpptools/cppcodemodelsettings.cpp index f5bb404b612..f7356973479 100644 --- a/src/plugins/cpptools/cppcodemodelsettings.cpp +++ b/src/plugins/cpptools/cppcodemodelsettings.cpp @@ -67,6 +67,12 @@ static QString skipIndexingBigFilesKey() static QString indexerFileSizeLimitKey() { return QLatin1String(Constants::CPPTOOLS_INDEXER_FILE_SIZE_LIMIT); } +static QString tidyChecksKey() +{ return QLatin1String(Constants::CPPTOOLS_TIDY_CHECKS); } + +static QString clazyChecksKey() +{ return QLatin1String(Constants::CPPTOOLS_CLAZY_CHECKS); } + void CppCodeModelSettings::fromSettings(QSettings *s) { s->beginGroup(QLatin1String(Constants::CPPTOOLS_SETTINGSGROUP)); @@ -101,6 +107,12 @@ void CppCodeModelSettings::fromSettings(QSettings *s) const QVariant indexerFileSizeLimit = s->value(indexerFileSizeLimitKey(), 5); setIndexerFileSizeLimitInMb(indexerFileSizeLimit.toInt()); + const QVariant tidyChecks = s->value(tidyChecksKey(), + QString("clang-diagnostic-*,llvm-*,misc-*")); + setTidyChecks(tidyChecks.toString()); + const QVariant clazyChecks = s->value(clazyChecksKey(), QString("level1")); + setClazyChecks(clazyChecks.toString()); + s->endGroup(); emit changed(); @@ -127,6 +139,8 @@ void CppCodeModelSettings::toSettings(QSettings *s) s->setValue(interpretAmbiguousHeadersAsCHeadersKey(), interpretAmbigiousHeadersAsCHeaders()); s->setValue(skipIndexingBigFilesKey(), skipIndexingBigFiles()); s->setValue(indexerFileSizeLimitKey(), indexerFileSizeLimitInMb()); + s->setValue(tidyChecksKey(), tidyChecks()); + s->setValue(clazyChecksKey(), clazyChecks()); s->endGroup(); @@ -204,3 +218,23 @@ void CppCodeModelSettings::setIndexerFileSizeLimitInMb(int sizeInMB) { m_indexerFileSizeLimitInMB = sizeInMB; } + +QString CppCodeModelSettings::tidyChecks() const +{ + return m_tidyChecks; +} + +void CppCodeModelSettings::setTidyChecks(QString checks) +{ + m_tidyChecks = checks; +} + +QString CppCodeModelSettings::clazyChecks() const +{ + return m_clazyChecks; +} + +void CppCodeModelSettings::setClazyChecks(QString checks) +{ + m_clazyChecks = checks; +} diff --git a/src/plugins/cpptools/cppcodemodelsettings.h b/src/plugins/cpptools/cppcodemodelsettings.h index 4c6404e506c..edf0a6e1dc3 100644 --- a/src/plugins/cpptools/cppcodemodelsettings.h +++ b/src/plugins/cpptools/cppcodemodelsettings.h @@ -72,6 +72,12 @@ public: int indexerFileSizeLimitInMb() const; void setIndexerFileSizeLimitInMb(int sizeInMB); + QString tidyChecks() const; + void setTidyChecks(QString checks); + + QString clazyChecks() const; + void setClazyChecks(QString checks); + public: // for tests void emitChanged(); @@ -86,6 +92,9 @@ private: int m_indexerFileSizeLimitInMB = 5; ClangDiagnosticConfigs m_clangCustomDiagnosticConfigs; Core::Id m_clangDiagnosticConfigId; + + QString m_tidyChecks; + QString m_clazyChecks; }; } // namespace CppTools diff --git a/src/plugins/cpptools/cppcodemodelsettingspage.cpp b/src/plugins/cpptools/cppcodemodelsettingspage.cpp index e6af115aed4..d9bc8c9370f 100644 --- a/src/plugins/cpptools/cppcodemodelsettingspage.cpp +++ b/src/plugins/cpptools/cppcodemodelsettingspage.cpp @@ -29,6 +29,8 @@ #include "cppmodelmanager.h" #include "cpptoolsconstants.h" #include "ui_cppcodemodelsettingspage.h" +#include "ui_clazychecks.h" +#include "ui_tidychecks.h" #include #include @@ -84,6 +86,65 @@ void CppCodeModelSettingsWidget::setupClangCodeModelWidgets() diagnosticConfigsModel, m_settings->clangDiagnosticConfigId()); m_ui->clangSettingsGroupBox->layout()->addWidget(m_clangDiagnosticConfigsWidget); + + setupPluginsWidgets(); +} + +void CppCodeModelSettingsWidget::setupPluginsWidgets() +{ + m_clazyChecks.reset(new CppTools::Ui::ClazyChecks); + m_clazyChecksWidget = new QWidget(); + m_clazyChecks->setupUi(m_clazyChecksWidget); + + m_tidyChecks.reset(new CppTools::Ui::TidyChecks); + m_tidyChecksWidget = new QWidget(); + m_tidyChecks->setupUi(m_tidyChecksWidget); + + m_ui->pluginChecks->layout()->addWidget(m_tidyChecksWidget); + m_ui->pluginChecks->layout()->addWidget(m_clazyChecksWidget); + m_clazyChecksWidget->setVisible(false); + connect(m_ui->pluginSelection, + static_cast(&QComboBox::currentIndexChanged), + [this](int index) { + (index ? m_clazyChecksWidget : m_tidyChecksWidget)->setVisible(true); + (!index ? m_clazyChecksWidget : m_tidyChecksWidget)->setVisible(false); + }); + + setupTidyChecks(); + setupClazyChecks(); +} + +void CppCodeModelSettingsWidget::setupTidyChecks() +{ + m_currentTidyChecks = m_settings->tidyChecks(); + for (QObject *child : m_tidyChecksWidget->children()) { + auto *check = qobject_cast(child); + if (!check) + continue; + if (m_currentTidyChecks.indexOf(check->text()) != -1) + check->setChecked(true); + connect(check, &QCheckBox::clicked, [this, check](bool checked) { + const QString prefix = check->text(); + checked ? m_currentTidyChecks.append(',' + prefix) + : m_currentTidyChecks.remove(',' + prefix); + }); + } +} + +void CppCodeModelSettingsWidget::setupClazyChecks() +{ + m_currentClazyChecks = m_settings->clazyChecks(); + if (!m_currentClazyChecks.isEmpty()) + m_clazyChecks->clazyLevel->setCurrentText(m_currentClazyChecks); + connect(m_clazyChecks->clazyLevel, + static_cast(&QComboBox::currentIndexChanged), + [this](int index) { + if (index == 0) { + m_currentClazyChecks.clear(); + return; + } + m_currentClazyChecks = m_clazyChecks->clazyLevel->itemText(index); + }); } void CppCodeModelSettingsWidget::setupGeneralWidgets() @@ -117,6 +178,16 @@ bool CppCodeModelSettingsWidget::applyClangCodeModelWidgetsToSettings() const settingsChanged = true; } + if (m_settings->tidyChecks() != m_currentTidyChecks) { + m_settings->setTidyChecks(m_currentTidyChecks); + settingsChanged = true; + } + + if (m_settings->clazyChecks() != m_currentClazyChecks) { + m_settings->setClazyChecks(m_currentClazyChecks); + settingsChanged = true; + } + return settingsChanged; } diff --git a/src/plugins/cpptools/cppcodemodelsettingspage.h b/src/plugins/cpptools/cppcodemodelsettingspage.h index 21911763a13..478c0b11b0b 100644 --- a/src/plugins/cpptools/cppcodemodelsettingspage.h +++ b/src/plugins/cpptools/cppcodemodelsettingspage.h @@ -32,6 +32,8 @@ #include #include +#include + QT_FORWARD_DECLARE_CLASS(QComboBox) QT_FORWARD_DECLARE_CLASS(QSettings) @@ -39,6 +41,11 @@ namespace CppTools { class ClangDiagnosticConfigsWidget; +namespace Ui { +class ClazyChecks; +class TidyChecks; +} // namespace Ui + namespace Internal { namespace Ui { class CppCodeModelSettingsPage; } @@ -57,6 +64,9 @@ public: private: void setupGeneralWidgets(); void setupClangCodeModelWidgets(); + void setupPluginsWidgets(); + void setupTidyChecks(); + void setupClazyChecks(); bool applyGeneralWidgetsToSettings() const; bool applyClangCodeModelWidgetsToSettings() const; @@ -65,6 +75,14 @@ private: Ui::CppCodeModelSettingsPage *m_ui; QPointer m_clangDiagnosticConfigsWidget; QSharedPointer m_settings; + + std::unique_ptr m_clazyChecks; + QWidget *m_clazyChecksWidget; + QString m_currentClazyChecks; + + std::unique_ptr m_tidyChecks; + QWidget *m_tidyChecksWidget; + QString m_currentTidyChecks; }; class CppCodeModelSettingsPage: public Core::IOptionsPage diff --git a/src/plugins/cpptools/cppcodemodelsettingspage.ui b/src/plugins/cpptools/cppcodemodelsettingspage.ui index 36ce48f28a4..443ba44804b 100644 --- a/src/plugins/cpptools/cppcodemodelsettingspage.ui +++ b/src/plugins/cpptools/cppcodemodelsettingspage.ui @@ -108,6 +108,43 @@ + + + + Clang Plugins + + + + + + + 0 + 0 + + + + + ClangTidy + + + + + Clazy + + + + + + + + Checks + + + + + + + diff --git a/src/plugins/cpptools/cpptools.pro b/src/plugins/cpptools/cpptools.pro index 8067604fcc0..4dfc0ceeced 100644 --- a/src/plugins/cpptools/cpptools.pro +++ b/src/plugins/cpptools/cpptools.pro @@ -183,7 +183,9 @@ FORMS += \ clangdiagnosticconfigswidget.ui \ cppcodemodelsettingspage.ui \ cppcodestylesettingspage.ui \ - cppfilesettingspage.ui + cppfilesettingspage.ui \ + clazychecks.ui \ + tidychecks.ui equals(TEST, 1) { HEADERS += \ diff --git a/src/plugins/cpptools/cpptools.qbs b/src/plugins/cpptools/cpptools.qbs index 934629ccb06..a510f5a21d6 100644 --- a/src/plugins/cpptools/cpptools.qbs +++ b/src/plugins/cpptools/cpptools.qbs @@ -49,6 +49,7 @@ Project { "clangdiagnosticconfigswidget.cpp", "clangdiagnosticconfigswidget.h", "clangdiagnosticconfigswidget.ui", + "clazychecks.ui", "compileroptionsbuilder.cpp", "compileroptionsbuilder.h", "cppcanonicalsymbol.cpp", @@ -201,6 +202,7 @@ Project { "symbolfinder.h", "symbolsfindfilter.cpp", "symbolsfindfilter.h", + "tidychecks.ui", "typehierarchybuilder.cpp", "typehierarchybuilder.h", "usages.h" diff --git a/src/plugins/cpptools/cpptoolsconstants.h b/src/plugins/cpptools/cpptoolsconstants.h index dff6d2c6f04..b5e9d86bdbf 100644 --- a/src/plugins/cpptools/cpptoolsconstants.h +++ b/src/plugins/cpptools/cpptoolsconstants.h @@ -56,6 +56,8 @@ const char CPPTOOLS_INTERPRET_AMBIGIUOUS_HEADERS_AS_C_HEADERS[] = "InterpretAmbiguousHeadersAsCHeaders"; const char CPPTOOLS_SKIP_INDEXING_BIG_FILES[] = "SkipIndexingBigFiles"; const char CPPTOOLS_INDEXER_FILE_SIZE_LIMIT[] = "IndexerFileSizeLimit"; +const char CPPTOOLS_TIDY_CHECKS[] = "TidyChecks"; +const char CPPTOOLS_CLAZY_CHECKS[] = "ClazyChecks"; const char CPP_CLANG_BUILTIN_CONFIG_ID_EVERYTHING_WITH_EXCEPTIONS[] = "Builtin.EverythingWithExceptions"; diff --git a/src/plugins/cpptools/tidychecks.ui b/src/plugins/cpptools/tidychecks.ui new file mode 100644 index 00000000000..78c4878ae40 --- /dev/null +++ b/src/plugins/cpptools/tidychecks.ui @@ -0,0 +1,157 @@ + + + CppTools::TidyChecks + + + + 0 + 0 + 682 + 300 + + + + Form + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + + android-* + + + + + + + boost- + + + + + + + bugprone-* + + + + + + + cert-* + + + + + + + cppcoreguidelines-* + + + + + + + + + + + clang-analyzer-* + + + + + + + clang-diagnostic-* + + + + + + + google-* + + + + + + + hicpp-* + + + + + + + llvm-* + + + + + + + + + + + misc-* + + + + + + + modernize-* + + + + + + + mpi-* + + + + + + + objc-* + + + + + + + performance-* + + + + + + + + + readability-* + + + + + + + +