Commit 8cfef965 authored by Nikolai Kosjar's avatar Nikolai Kosjar

Clang: Introduce switching/adding of warning configurations

A warning configuration is a list of command line (warning) options for
libclang. Three non-editable built-in configurations are provided by
default. The user can copy a configuration to customize it.

This is still a global setting and it changes take effect after
re-opening a document. Both issues will be addressed in follow-up
changes.

Change-Id: I86667d7dc39ad31b88666454220e6da563797740
Reviewed-by: default avatarLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: default avatarMarco Bubke <marco.bubke@theqtcompany.com>
parent 7026b26c
......@@ -342,8 +342,8 @@ static QStringList languageOptions(const QString &filePath, CppTools::ProjectPar
static QStringList fileArguments(const QString &filePath, CppTools::ProjectPart *projectPart)
{
return QStringList(languageOptions(filePath, projectPart))
+ CppTools::codeModelSettings()->extraClangOptions();
return languageOptions(filePath, projectPart)
+ CppTools::codeModelSettings()->clangDiagnosticConfig().commandLineOptions();
}
ClangBackEnd::FileContainer
......
/****************************************************************************
**
** 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 "clangdiagnosticconfig.h"
namespace CppTools {
Core::Id ClangDiagnosticConfig::id() const
{
return m_id;
}
void ClangDiagnosticConfig::setId(const Core::Id &id)
{
m_id = id;
}
QString ClangDiagnosticConfig::displayName() const
{
return m_displayName;
}
void ClangDiagnosticConfig::setDisplayName(const QString &displayName)
{
m_displayName = displayName;
}
QStringList ClangDiagnosticConfig::commandLineOptions() const
{
return m_commandLineOptions;
}
void ClangDiagnosticConfig::setCommandLineOptions(const QStringList &options)
{
m_commandLineOptions = options;
}
bool ClangDiagnosticConfig::isReadOnly() const
{
return m_isReadOnly;
}
void ClangDiagnosticConfig::setIsReadOnly(bool isReadOnly)
{
m_isReadOnly = isReadOnly;
}
bool ClangDiagnosticConfig::operator==(const ClangDiagnosticConfig &other) const
{
return m_id == other.m_id
&& m_displayName == other.m_displayName
&& m_commandLineOptions == other.m_commandLineOptions
&& m_isReadOnly == other.m_isReadOnly;
}
} // namespace CppTools
/****************************************************************************
**
** 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.
**
****************************************************************************/
#pragma once
#include "cpptools_global.h"
#include <coreplugin/id.h>
#include <QStringList>
#include <QVector>
namespace CppTools {
class CPPTOOLS_EXPORT ClangDiagnosticConfig
{
public:
Core::Id id() const;
void setId(const Core::Id &id);
QString displayName() const;
void setDisplayName(const QString &displayName);
QStringList commandLineOptions() const;
void setCommandLineOptions(const QStringList &commandLineOptions);
bool isReadOnly() const;
void setIsReadOnly(bool isReadOnly);
bool operator==(const ClangDiagnosticConfig &other) const;
private:
Core::Id m_id;
QString m_displayName;
QStringList m_commandLineOptions;
bool m_isReadOnly = false;
};
using ClangDiagnosticConfigs = QVector<ClangDiagnosticConfig>;
} // namespace CppTools
/****************************************************************************
**
** 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 "clangdiagnosticconfigsmodel.h"
#include "cpptoolsconstants.h"
#include <utils/algorithm.h>
#include <QCoreApplication>
namespace CppTools {
namespace Internal {
static void addConfigForQuestionableConstructs(ClangDiagnosticConfigsModel &model)
{
ClangDiagnosticConfig config;
config.setId("Builtin.Questionable");
config.setDisplayName(QCoreApplication::translate("ClangDiagnosticConfigsModel",
"Warnings for questionable constructs"));
config.setIsReadOnly(true);
config.setCommandLineOptions({
QStringLiteral("-Wall"),
QStringLiteral("-Wextra"),
});
model.appendOrUpdate(config);
}
static void addConfigForPedanticWarnings(ClangDiagnosticConfigsModel &model)
{
ClangDiagnosticConfig config;
config.setId("Builtin.Pedantic");
config.setDisplayName(QCoreApplication::translate("ClangDiagnosticConfigsModel",
"Pedantic Warnings"));
config.setIsReadOnly(true);
config.setCommandLineOptions({QStringLiteral("-Wpedantic")});
model.appendOrUpdate(config);
}
static void addConfigForAlmostEveryWarning(ClangDiagnosticConfigsModel &model)
{
ClangDiagnosticConfig config;
config.setId(Constants::CPP_CLANG_BUILTIN_CONFIG_ID_EVERYTHING_WITH_EXCEPTIONS);
config.setDisplayName(QCoreApplication::translate("ClangDiagnosticConfigsModel",
"Warnings for almost everything"));
config.setIsReadOnly(true);
config.setCommandLineOptions({
QStringLiteral("-Weverything"),
QStringLiteral("-Wno-c++98-compat"),
QStringLiteral("-Wno-c++98-compat-pedantic"),
QStringLiteral("-Wno-unused-macros"),
QStringLiteral("-Wno-newline-eof"),
QStringLiteral("-Wno-exit-time-destructors"),
QStringLiteral("-Wno-global-constructors"),
QStringLiteral("-Wno-gnu-zero-variadic-macro-arguments"),
QStringLiteral("-Wno-documentation"),
QStringLiteral("-Wno-shadow"),
QStringLiteral("-Wno-missing-prototypes"), // Not optimal for C projects.
});
model.appendOrUpdate(config);
}
static void addBuiltinConfigs(ClangDiagnosticConfigsModel &model)
{
addConfigForPedanticWarnings(model);
addConfigForQuestionableConstructs(model);
addConfigForAlmostEveryWarning(model);
}
ClangDiagnosticConfigsModel::ClangDiagnosticConfigsModel(const ClangDiagnosticConfigs &customConfigs)
{
addBuiltinConfigs(*this);
foreach (const ClangDiagnosticConfig &config, customConfigs)
m_diagnosticConfigs.append(config);
}
int ClangDiagnosticConfigsModel::size() const
{
return m_diagnosticConfigs.size();
}
const ClangDiagnosticConfig &ClangDiagnosticConfigsModel::at(int index) const
{
return m_diagnosticConfigs.at(index);
}
void ClangDiagnosticConfigsModel::appendOrUpdate(const ClangDiagnosticConfig &config)
{
const int index = indexOfConfig(config.id());
if (index >= 0 && index < m_diagnosticConfigs.size())
m_diagnosticConfigs.replace(index, config);
else
m_diagnosticConfigs.append(config);
}
void ClangDiagnosticConfigsModel::removeConfigWithId(const Core::Id &id)
{
m_diagnosticConfigs.removeOne(configWithId(id));
}
ClangDiagnosticConfigs ClangDiagnosticConfigsModel::configs() const
{
return m_diagnosticConfigs;
}
const ClangDiagnosticConfig &ClangDiagnosticConfigsModel::configWithId(const Core::Id &id) const
{
return m_diagnosticConfigs.at(indexOfConfig(id));
}
int ClangDiagnosticConfigsModel::indexOfConfig(const Core::Id &id) const
{
return Utils::indexOf(m_diagnosticConfigs, [&](const ClangDiagnosticConfig &config) {
return config.id() == id;
});
}
} // namespace Internal
} // namespace CppTools
/****************************************************************************
**
** 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.
**
****************************************************************************/
#pragma once
#include "clangdiagnosticconfig.h"
namespace CppTools {
namespace Internal {
class ClangDiagnosticConfigsModel
{
public:
ClangDiagnosticConfigsModel(const ClangDiagnosticConfigs &customConfigs);
int size() const;
const ClangDiagnosticConfig &at(int index) const;
void appendOrUpdate(const ClangDiagnosticConfig &config);
void removeConfigWithId(const Core::Id &id);
ClangDiagnosticConfigs configs() const;
const ClangDiagnosticConfig &configWithId(const Core::Id &id) const;
private:
int indexOfConfig(const Core::Id &id) const;
private:
ClangDiagnosticConfigs m_diagnosticConfigs;
};
} // namespace Internal
} // namespace CppTools
/****************************************************************************
**
** 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 "clangdiagnosticconfigswidget.h"
#include "ui_clangdiagnosticconfigswidget.h"
#include <utils/algorithm.h>
#include <utils/qtcassert.h>
#include <QDebug>
#include <QInputDialog>
#include <QUuid>
namespace CppTools {
namespace Internal {
ClangDiagnosticConfigsWidget::ClangDiagnosticConfigsWidget(
const ClangDiagnosticConfigs &customConfigs,
const Core::Id &configToSelect,
QWidget *parent)
: QWidget(parent)
, m_ui(new Ui::ClangDiagnosticConfigsWidget)
, m_diagnosticConfigsModel(customConfigs)
{
m_ui->setupUi(this);
connect(m_ui->configChooserComboBox,
static_cast<void(QComboBox::*)(int)>(&QComboBox::currentIndexChanged),
this,
&ClangDiagnosticConfigsWidget::onCurrentConfigChanged);
connect(m_ui->copyButton, &QPushButton::clicked,
this, &ClangDiagnosticConfigsWidget::onCopyButtonClicked);
connect(m_ui->removeButton, &QPushButton::clicked,
this, &ClangDiagnosticConfigsWidget::onRemoveButtonClicked);
connect(m_ui->diagnosticOptionsTextEdit->document(), &QTextDocument::contentsChanged,
this, &ClangDiagnosticConfigsWidget::onDiagnosticOptionsEdited);
syncWidgetsToModel(configToSelect);
}
ClangDiagnosticConfigsWidget::~ClangDiagnosticConfigsWidget()
{
delete m_ui;
}
void ClangDiagnosticConfigsWidget::onCurrentConfigChanged(int)
{
syncOtherWidgetsToComboBox();
}
static ClangDiagnosticConfig createCustomConfig(const ClangDiagnosticConfig &config,
const QString &displayName)
{
ClangDiagnosticConfig copied = config;
copied.setId(Core::Id::fromString(QUuid::createUuid().toString()));
copied.setDisplayName(displayName);
copied.setIsReadOnly(false);
return copied;
}
void ClangDiagnosticConfigsWidget::onCopyButtonClicked()
{
const ClangDiagnosticConfig &config = currentConfig();
bool diaglogAccepted = false;
const QString newName = QInputDialog::getText(this,
tr("Copy Diagnostic Configuration"),
tr("Diagnostic configuration name:"),
QLineEdit::Normal,
tr("%1 (Copy)").arg(config.displayName()),
&diaglogAccepted);
if (diaglogAccepted) {
const ClangDiagnosticConfig customConfig = createCustomConfig(config, newName);
m_diagnosticConfigsModel.appendOrUpdate(customConfig);
syncConfigChooserToModel(customConfig.id());
m_ui->diagnosticOptionsTextEdit->setFocus();
}
}
void ClangDiagnosticConfigsWidget::onRemoveButtonClicked()
{
m_diagnosticConfigsModel.removeConfigWithId(currentConfigId());
syncConfigChooserToModel();
}
void ClangDiagnosticConfigsWidget::onDiagnosticOptionsEdited()
{
const QString diagnosticOptions
= m_ui->diagnosticOptionsTextEdit->document()->toPlainText().trimmed();
const QStringList updatedCommandLine
= diagnosticOptions.trimmed().split(QLatin1Char(' '), QString::SkipEmptyParts);
ClangDiagnosticConfig updatedConfig = currentConfig();
updatedConfig.setCommandLineOptions(updatedCommandLine);
m_diagnosticConfigsModel.appendOrUpdate(updatedConfig);
}
void ClangDiagnosticConfigsWidget::syncWidgetsToModel(const Core::Id &configToSelect)
{
syncConfigChooserToModel(configToSelect);
syncOtherWidgetsToComboBox();
}
static QString adaptedDisplayName(const ClangDiagnosticConfig &config)
{
return config.isReadOnly()
? QObject::tr("%1 [built-in]").arg(config.displayName())
: config.displayName();
}
void ClangDiagnosticConfigsWidget::syncConfigChooserToModel(const Core::Id &configToSelect)
{
m_ui->configChooserComboBox->clear();
int currentIndex = -1;
const int size = m_diagnosticConfigsModel.size();
for (int i = 0; i < size; ++i) {
const ClangDiagnosticConfig &config = m_diagnosticConfigsModel.at(i);
m_ui->configChooserComboBox->addItem(adaptedDisplayName(config), config.id().toSetting());
if (configToSelect == config.id())
currentIndex = i;
}
if (currentIndex != -1)
m_ui->configChooserComboBox->setCurrentIndex(currentIndex);
}
void ClangDiagnosticConfigsWidget::syncOtherWidgetsToComboBox()
{
if (isConfigChooserEmpty())
return;
const ClangDiagnosticConfig &config = currentConfig();
// Update main button row
m_ui->removeButton->setEnabled(!config.isReadOnly());
// Update child widgets
const QString commandLineOptions = config.commandLineOptions().join(QLatin1Char(' '));
m_ui->diagnosticOptionsTextEdit->document()->setPlainText(commandLineOptions);
m_ui->diagnosticOptionsTextEdit->setReadOnly(config.isReadOnly());
}
bool ClangDiagnosticConfigsWidget::isConfigChooserEmpty() const
{
return m_ui->configChooserComboBox->count() == 0;
}
const ClangDiagnosticConfig &ClangDiagnosticConfigsWidget::currentConfig() const
{
return m_diagnosticConfigsModel.configWithId(currentConfigId());
}
Core::Id ClangDiagnosticConfigsWidget::currentConfigId() const
{
return Core::Id::fromSetting(m_ui->configChooserComboBox->currentData());
}
ClangDiagnosticConfigs ClangDiagnosticConfigsWidget::customConfigs() const
{
const ClangDiagnosticConfigs allConfigs = m_diagnosticConfigsModel.configs();
return Utils::filtered(allConfigs, [](const ClangDiagnosticConfig &config){
return !config.isReadOnly();
});
}
} // Internal namespace
} // CppTools namespace
/****************************************************************************
**
** 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.
**
****************************************************************************/
#pragma once
#include "clangdiagnosticconfig.h"
#include "clangdiagnosticconfigsmodel.h"
#include <QWidget>
namespace CppTools {
namespace Internal {
namespace Ui { class ClangDiagnosticConfigsWidget; }
class ClangDiagnosticConfigsWidget : public QWidget
{
Q_OBJECT
public:
explicit ClangDiagnosticConfigsWidget(const ClangDiagnosticConfigs &customConfigs,
const Core::Id &configToSelect,
QWidget *parent = 0);
Core::Id currentConfigId() const;
ClangDiagnosticConfigs customConfigs() const;
~ClangDiagnosticConfigsWidget();
private slots:
void onCurrentConfigChanged(int);
void onCopyButtonClicked();
void onRemoveButtonClicked();
void onDiagnosticOptionsEdited();
private:
void syncWidgetsToModel(const Core::Id &configToSelect = Core::Id());
void syncConfigChooserToModel(const Core::Id &configToSelect = Core::Id());
void syncOtherWidgetsToComboBox();
bool isConfigChooserEmpty() const;
const ClangDiagnosticConfig &currentConfig() const;
private:
Ui::ClangDiagnosticConfigsWidget *m_ui;
ClangDiagnosticConfigsModel m_diagnosticConfigsModel;
};
} // Internal namespace
} // CppTools namespace
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>CppTools::Internal::ClangDiagnosticConfigsWidget</class>
<widget class="QWidget" name="CppTools::Internal::ClangDiagnosticConfigsWidget">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>545</width>
<height>300</height>
</rect>
</property>
<property name="windowTitle">
<string>Form</string>
</property>
<layout class="QVBoxLayout" name="verticalLayout">
<property name="leftMargin">
<number>0</number>
</property>
<property name="topMargin">
<number>0</number>
</property>
<property name="rightMargin">
<number>0</number>
</property>
<property name="bottomMargin">
<number>0</number>
</property>
<item>
<layout class="QHBoxLayout" name="horizontalLayout">
<item>
<widget class="QLabel" name="label_2">
<property name="text">
<string>Configuration to use:</string>
</property>
</widget>
</item>
<item>
<widget class="QComboBox" name="configChooserComboBox">
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="Fixed">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
</widget>
</item>
<item>
<widget class="QPushButton" name="copyButton">
<property name="text">
<string>Copy...</string>
</property>
</widget>
</item>
<item>
<widget class="QPushButton" name="removeButton">
<property name="text">
<string>Remove</string>
</property>
</widget>
</item>
</layout>
</item>
<item>
<widget class="QPlainTextEdit" name="diagnosticOptionsTextEdit"/>
</item>
<item>
<widget class="QLabel" name="label">
<property name="text">
<string>For appropriate options, consult the GCC or Clang manual pages or the &lt;a href=&quot;https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html&quot;&gt;GCC online documentation&lt;/a&gt;.</string>
</property>
<property name="openExternalLinks">
<bool>true</bool>
</property>
</widget>
</item>
</layout>
</widget>
<resources/>
<connections/>
</ui>