1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
|
/*************************************************************************************
* Copyright (C) 2016 by Carlos Nihelton <carlosnsoliveira@gmail.com> *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software *
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA *
*************************************************************************************/
#include <unistd.h>
#include <QAction>
#include <QMessageBox>
#include <kactioncollection.h>
#include <klocalizedstring.h>
#include <kpluginfactory.h>
#include <kpluginloader.h>
#include <kprocess.h>
#include <execute/iexecuteplugin.h>
#include <KXMLGUIFactory>
#include <interfaces/icore.h>
#include <interfaces/idebugcontroller.h>
#include <interfaces/idocument.h>
#include <interfaces/idocumentcontroller.h>
#include <interfaces/ilanguagecontroller.h>
#include <interfaces/iplugincontroller.h>
#include <interfaces/iproject.h>
#include <interfaces/iprojectcontroller.h>
#include <interfaces/iruncontroller.h>
#include <interfaces/iuicontroller.h>
#include <interfaces/launchconfigurationtype.h>
#include <language/interfaces/editorcontext.h>
#include <project/interfaces/ibuildsystemmanager.h>
#include <project/projectconfigpage.h>
#include <project/projectmodel.h>
#include <shell/problemmodelset.h>
#include <util/executecompositejob.h>
#include "./config/clangtidypreferences.h"
#include "./config/perprojectconfigpage.h"
#include "debug.h"
#include "job.h"
#include "plugin.h"
using namespace KDevelop;
K_PLUGIN_FACTORY_WITH_JSON(ClangTidyFactory, "res/kdevclangtidy.json", registerPlugin<ClangTidy::Plugin>();)
namespace ClangTidy
{
Plugin::Plugin(QObject* parent, const QVariantList& /*unused*/)
: IPlugin("kdevclangtidy", parent)
, m_model(new KDevelop::ProblemModel(parent))
{
qCDebug(KDEV_CLANGTIDY) << "setting clangtidy rc file";
setXMLFile("kdevclangtidy.rc");
QAction* act_checkfile;
act_checkfile = actionCollection()->addAction("clangtidy_file", this, SLOT(runClangTidyFile()));
act_checkfile->setStatusTip(i18n("Launches ClangTidy for current file"));
act_checkfile->setText(i18n("clang-tidy"));
/* TODO: Uncomment this only when discover a safe way to run clang-tidy on the whole project.
// QAction* act_check_all_files;
// act_check_all_files = actionCollection()->addAction ( "clangtidy_all", this, SLOT ( runClangTidyAll() ) );
// act_check_all_files->setStatusTip ( i18n ( "Launches clangtidy for all translation "
// "units of current project" ) );
// act_check_all_files->setText ( i18n ( "clang-tidy (all)" ) );
*/
IExecutePlugin* iface = KDevelop::ICore::self()
->pluginController()
->pluginForExtension("org.kdevelop.IExecutePlugin")
->extension<IExecutePlugin>();
Q_ASSERT(iface);
ProblemModelSet* pms = core()->languageController()->problemModelSet();
pms->addModel(QStringLiteral("ClangTidy"), m_model.data());
m_config = KSharedConfig::openConfig()->group("ClangTidy");
auto clangtidyPath = m_config.readEntry(ConfigGroup::ExecutablePath);
// TODO(cnihelton): auto detect clang-tidy executable instead of hard-coding it.
if (clangtidyPath.isEmpty()) {
clangtidyPath = QString("/usr/bin/clang-tidy");
}
collectAllAvailableChecks(clangtidyPath);
m_config.writeEntry(ConfigGroup::AdditionalParameters, "");
for (auto check : m_allChecks) {
bool enable = check.contains("cert") || check.contains("-core.") || check.contains("-cplusplus")
|| check.contains("-deadcode") || check.contains("-security") || check.contains("cppcoreguide");
if (enable) {
m_activeChecks << check;
} else {
m_activeChecks.removeAll(check);
}
}
m_activeChecks.removeDuplicates();
m_config.writeEntry(ConfigGroup::EnabledChecks, m_activeChecks.join(','));
}
void Plugin::unload()
{
ProblemModelSet* pms = core()->languageController()->problemModelSet();
pms->removeModel(QStringLiteral("ClangTidy"));
}
void Plugin::collectAllAvailableChecks(QString clangtidyPath)
{
m_allChecks.clear();
KProcess tidy;
tidy << clangtidyPath << QLatin1String("-checks=*") << QLatin1String("--list-checks");
tidy.setOutputChannelMode(KProcess::OnlyStdoutChannel);
tidy.start();
if (!tidy.waitForStarted()) {
qCDebug(KDEV_CLANGTIDY) << "Unable to execute clang-tidy.";
return;
}
tidy.closeWriteChannel();
if (!tidy.waitForFinished()) {
qCDebug(KDEV_CLANGTIDY) << "Failed during clang-tidy execution.";
return;
}
QTextStream ios(&tidy);
QString each;
while (ios.readLineInto(&each)) {
m_allChecks.append(each.trimmed());
}
if (m_allChecks.size() > 3) {
m_allChecks.removeAt(m_allChecks.length() - 1);
m_allChecks.removeAt(0);
}
m_allChecks.removeDuplicates();
}
void Plugin::runClangTidy(bool allFiles)
{
KDevelop::IDocument* doc = core()->documentController()->activeDocument();
if (!doc) {
QMessageBox::critical(nullptr, i18n("Error starting clang-tidy"),
i18n("No suitable active file, unable to deduce project."));
return;
}
KDevelop::IProject* project = core()->projectController()->findProjectForUrl(doc->url());
if (!project) {
QMessageBox::critical(nullptr, i18n("Error starting clang-tidy"), i18n("Active file isn't in a project"));
return;
}
m_config = project->projectConfiguration()->group("ClangTidy");
if (!m_config.isValid()) {
QMessageBox::critical(nullptr, i18n("Error starting ClangTidy"),
i18n("Can't load parameters. They must be set in the project settings."));
return;
}
auto clangtidyPath = m_config.readEntry(ConfigGroup::ExecutablePath);
auto buildSystem = project->buildSystemManager();
Job::Parameters params;
params.projectRootDir = project->path().toLocalFile();
// TODO: auto detect clang-tidy executable instead of hard-coding it.
if (clangtidyPath.isEmpty()) {
params.executablePath = QStringLiteral("/usr/bin/clang-tidy");
} else {
params.executablePath = clangtidyPath;
}
if (allFiles) {
params.filePath = project->path().toUrl().toLocalFile();
} else {
params.filePath = doc->url().toLocalFile();
}
params.buildDir = buildSystem->buildDirectory(project->projectItem()).toLocalFile();
params.additionalParameters = m_config.readEntry(ConfigGroup::AdditionalParameters);
params.analiseTempDtors = m_config.readEntry(ConfigGroup::AnaliseTempDtors);
params.enabledChecks = m_activeChecks.join(',');
params.useConfigFile = m_config.readEntry(ConfigGroup::UseConfigFile);
params.dumpConfig = m_config.readEntry(ConfigGroup::DumpConfig);
params.enableChecksProfile = m_config.readEntry(ConfigGroup::EnableChecksProfile);
params.exportFixes = m_config.readEntry(ConfigGroup::ExportFixes);
params.extraArgs = m_config.readEntry(ConfigGroup::ExtraArgs);
params.extraArgsBefore = m_config.readEntry(ConfigGroup::ExtraArgsBefore);
params.autoFix = m_config.readEntry(ConfigGroup::AutoFix);
params.headerFilter = m_config.readEntry(ConfigGroup::HeaderFilter);
params.lineFilter = m_config.readEntry(ConfigGroup::LineFilter);
params.listChecks = m_config.readEntry(ConfigGroup::ListChecks);
params.checkSystemHeaders = m_config.readEntry(ConfigGroup::CheckSystemHeaders);
if (!params.dumpConfig.isEmpty()) {
Job* job = new ClangTidy::Job(params, this);
core()->runController()->registerJob(job);
params.dumpConfig = QString();
}
Job* job2 = new ClangTidy::Job(params, this);
connect(job2, SIGNAL(finished(KJob*)), this, SLOT(result(KJob*)));
core()->runController()->registerJob(job2);
}
void Plugin::runClangTidyFile()
{
bool allFiles = false;
runClangTidy(allFiles);
}
void Plugin::runClangTidyAll()
{
bool allFiles = true;
runClangTidy(allFiles);
}
void Plugin::loadOutput()
{
}
void Plugin::result(KJob* job)
{
Job* aj = dynamic_cast<Job*>(job);
if (!aj) {
return;
}
if (aj->status() == KDevelop::OutputExecuteJob::JobStatus::JobSucceeded) {
m_model->setProblems(aj->problems());
core()->uiController()->findToolView(i18nd("kdevproblemreporter", "Problems"), 0,
KDevelop::IUiController::FindFlags::Raise);
}
}
KDevelop::ContextMenuExtension Plugin::contextMenuExtension(KDevelop::Context* context)
{
KDevelop::IDocument* doc = core()->documentController()->activeDocument();
KDevelop::ContextMenuExtension extension = KDevelop::IPlugin::contextMenuExtension(context);
if (context->type() == KDevelop::Context::EditorContext) {
auto mime = doc->mimeType().name();
if (mime == QLatin1String("text/x-c++src") || mime == QLatin1String("text/x-csrc")) {
QAction* action
= new QAction(QIcon::fromTheme("document-new"), i18n("Check current unit with clang-tidy"), this);
connect(action, SIGNAL(triggered(bool)), this, SLOT(runClangTidyFile()));
extension.addAction(KDevelop::ContextMenuExtension::AnalyzeGroup, action);
}
}
return extension;
}
KDevelop::ConfigPage* Plugin::perProjectConfigPage(int number, const ProjectConfigOptions& options, QWidget* parent)
{
if (number != 0) {
return nullptr;
} else {
auto config = new PerProjectConfigPage(options.project, parent);
config->setActiveChecksReceptorList(&m_activeChecks);
config->setList(m_allChecks);
return config;
}
}
KDevelop::ConfigPage* Plugin::configPage(int number, QWidget* parent)
{
if (number != 0) {
return nullptr;
} else {
return new ClangTidyPreferences(this, parent);
}
}
}
#include "plugin.moc"
|