cppcheck/gui/librarydialog.cpp

368 lines
11 KiB
C++
Raw Normal View History

2015-08-16 17:36:10 +02:00
/*
* Cppcheck - A tool for static C/C++ code analysis
2023-01-28 10:16:34 +01:00
* Copyright (C) 2007-2023 Cppcheck team.
2015-08-16 17:36:10 +02:00
*
* 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 3 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, see <http://www.gnu.org/licenses/>.
*/
#include "librarydialog.h"
2022-02-02 16:17:28 +01:00
#include "common.h"
#include "libraryaddfunctiondialog.h"
#include "libraryeditargdialog.h"
#include "path.h"
2015-08-16 17:36:10 +02:00
#include "ui_librarydialog.h"
#include <string>
#include <QCheckBox>
#include <QComboBox>
2015-08-16 17:36:10 +02:00
#include <QFile>
#include <QFileDialog>
#include <QFlags>
#include <QIODevice>
#include <QLineEdit>
#include <QList>
#include <QListWidget>
#include <QListWidgetItem>
#include <QMessageBox>
#include <QPlainTextEdit>
#include <QPushButton>
#include <QRegularExpression>
2022-02-02 16:17:28 +01:00
#include <QTextStream>
#include <Qt>
2015-08-16 17:36:10 +02:00
class QWidget;
2015-08-16 17:36:10 +02:00
// TODO: get/compare functions from header
2015-09-08 15:38:02 +02:00
class FunctionListItem : public QListWidgetItem {
public:
FunctionListItem(QListWidget *view,
CppcheckLibraryData::Function *function,
bool selected)
: QListWidgetItem(view), function(function) {
2015-09-08 15:38:02 +02:00
setText(function->name);
setFlags(flags() | Qt::ItemIsEditable);
setSelected(selected);
}
CppcheckLibraryData::Function *function;
};
2015-08-16 17:36:10 +02:00
LibraryDialog::LibraryDialog(QWidget *parent) :
QDialog(parent),
2018-06-18 10:13:33 +02:00
mUi(new Ui::LibraryDialog),
2018-06-18 14:11:34 +02:00
mIgnoreChanges(false)
2015-08-16 17:36:10 +02:00
{
2018-06-18 10:13:33 +02:00
mUi->setupUi(this);
mUi->buttonSave->setEnabled(false);
mUi->buttonSaveAs->setEnabled(false);
mUi->sortFunctions->setEnabled(false);
mUi->filter->setEnabled(false);
mUi->addFunction->setEnabled(false);
//As no function selected, this disables function editing widgets
selectFunction();
2015-08-16 17:36:10 +02:00
}
LibraryDialog::~LibraryDialog()
{
2018-06-18 10:13:33 +02:00
delete mUi;
2015-08-16 17:36:10 +02:00
}
CppcheckLibraryData::Function *LibraryDialog::currentFunction()
{
2018-06-18 10:13:33 +02:00
QList<QListWidgetItem *> selitems = mUi->functions->selectedItems();
if (selitems.count() != 1)
return nullptr;
return static_cast<FunctionListItem *>(selitems.first())->function;
}
2015-08-16 17:36:10 +02:00
void LibraryDialog::openCfg()
{
const QString datadir = getDataDir();
2015-08-16 17:36:10 +02:00
QString selectedFilter;
const QString filter(tr("Library files (*.cfg)"));
const QString selectedFile = QFileDialog::getOpenFileName(this,
2021-08-07 20:51:18 +02:00
tr("Open library file"),
datadir,
filter,
&selectedFilter);
2015-08-16 17:36:10 +02:00
2017-11-11 21:52:36 +01:00
if (selectedFile.isEmpty())
return;
QFile file(selectedFile);
if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
2017-11-11 21:52:36 +01:00
QMessageBox msg(QMessageBox::Critical,
tr("Cppcheck"),
2019-07-12 17:55:44 +02:00
tr("Cannot open file %1.").arg(selectedFile),
2017-11-11 21:52:36 +01:00
QMessageBox::Ok,
this);
msg.exec();
return;
}
CppcheckLibraryData tempdata;
const QString errmsg = tempdata.open(file);
if (!errmsg.isNull()) {
QMessageBox msg(QMessageBox::Critical,
tr("Cppcheck"),
tr("Failed to load %1. %2.").arg(selectedFile).arg(errmsg),
QMessageBox::Ok,
this);
msg.exec();
return;
}
2018-06-18 14:11:34 +02:00
mIgnoreChanges = true;
mData.swap(tempdata);
mFileName = selectedFile;
2018-06-18 10:13:33 +02:00
mUi->buttonSave->setEnabled(false);
mUi->buttonSaveAs->setEnabled(true);
mUi->filter->clear();
mUi->functions->clear();
2018-06-18 14:11:34 +02:00
for (CppcheckLibraryData::Function &function : mData.functions) {
2018-06-18 10:13:33 +02:00
mUi->functions->addItem(new FunctionListItem(mUi->functions,
2021-08-07 20:51:18 +02:00
&function,
false));
2015-08-16 17:36:10 +02:00
}
2018-06-18 14:11:34 +02:00
mUi->sortFunctions->setEnabled(!mData.functions.empty());
mUi->filter->setEnabled(!mData.functions.empty());
2018-06-18 10:13:33 +02:00
mUi->addFunction->setEnabled(true);
2018-06-18 14:11:34 +02:00
mIgnoreChanges = false;
}
2015-08-16 17:36:10 +02:00
void LibraryDialog::saveCfg()
{
if (mFileName.isNull())
return;
QFile file(mFileName);
if (file.open(QIODevice::WriteOnly | QIODevice::Text)) {
2015-08-23 13:34:50 +02:00
QTextStream ts(&file);
2018-06-18 14:11:34 +02:00
ts << mData.toString() << '\n';
2018-06-18 10:13:33 +02:00
mUi->buttonSave->setEnabled(false);
} else {
QMessageBox msg(QMessageBox::Critical,
tr("Cppcheck"),
2019-07-12 17:55:44 +02:00
tr("Cannot save file %1.").arg(mFileName),
QMessageBox::Ok,
this);
msg.exec();
}
2015-08-16 17:36:10 +02:00
}
void LibraryDialog::saveCfgAs()
{
const QString filter(tr("Library files (*.cfg)"));
const QString path = Path::getPathFromFilename(mFileName.toStdString()).c_str();
QString selectedFile = QFileDialog::getSaveFileName(this,
2021-08-07 20:51:18 +02:00
tr("Save the library as"),
path,
filter);
if (selectedFile.isEmpty())
return;
if (!selectedFile.endsWith(".cfg", Qt::CaseInsensitive))
selectedFile += ".cfg";
mFileName = selectedFile;
saveCfg();
}
void LibraryDialog::addFunction()
{
LibraryAddFunctionDialog *d = new LibraryAddFunctionDialog;
if (d->exec() == QDialog::Accepted && !d->functionName().isEmpty()) {
CppcheckLibraryData::Function f;
f.name = d->functionName();
const int args = d->numberOfArguments();
for (int i = 1; i <= args; i++) {
CppcheckLibraryData::Function::Arg arg;
arg.nr = i;
f.args.append(arg);
}
2018-06-18 14:11:34 +02:00
mData.functions.append(f);
mUi->functions->addItem(new FunctionListItem(mUi->functions, &mData.functions.back(), false));
2018-06-18 10:13:33 +02:00
mUi->buttonSave->setEnabled(true);
2018-06-18 14:11:34 +02:00
mUi->sortFunctions->setEnabled(!mData.functions.empty());
mUi->filter->setEnabled(!mData.functions.empty());
}
delete d;
}
2015-09-08 15:38:02 +02:00
void LibraryDialog::editFunctionName(QListWidgetItem* item)
{
2018-06-18 14:11:34 +02:00
if (mIgnoreChanges)
2015-09-08 15:38:02 +02:00
return;
QString functionName = item->text();
CppcheckLibraryData::Function * const function = dynamic_cast<FunctionListItem*>(item)->function;
if (functionName != function->name) {
const QRegularExpressionMatch matchRes = QRegularExpression("^" NAMES "$").match(functionName);
if (matchRes.hasMatch()) {
2015-09-08 15:38:02 +02:00
function->name = functionName;
2018-06-18 10:13:33 +02:00
mUi->buttonSave->setEnabled(true);
2015-09-08 15:38:02 +02:00
} else {
2018-06-18 14:11:34 +02:00
mIgnoreChanges = true;
2015-09-08 15:38:02 +02:00
item->setText(function->name);
2018-06-18 14:11:34 +02:00
mIgnoreChanges = false;
2015-09-08 15:38:02 +02:00
}
}
}
void LibraryDialog::selectFunction()
2015-08-16 17:36:10 +02:00
{
const CppcheckLibraryData::Function * const function = currentFunction();
if (function == nullptr) {
2018-06-18 10:13:33 +02:00
mUi->comments->clear();
mUi->comments->setEnabled(false);
2018-06-18 10:13:33 +02:00
mUi->noreturn->setCurrentIndex(0);
mUi->noreturn->setEnabled(false);
2018-06-18 10:13:33 +02:00
mUi->useretval->setChecked(false);
mUi->useretval->setEnabled(false);
2018-06-18 10:13:33 +02:00
mUi->leakignore->setChecked(false);
mUi->leakignore->setEnabled(false);
2018-06-18 10:13:33 +02:00
mUi->arguments->clear();
mUi->arguments->setEnabled(false);
2018-06-18 10:13:33 +02:00
mUi->editArgButton->setEnabled(false);
2015-08-30 02:49:17 +02:00
return;
}
2018-06-18 14:11:34 +02:00
mIgnoreChanges = true;
2018-06-18 10:13:33 +02:00
mUi->comments->setPlainText(function->comments);
mUi->comments->setEnabled(true);
2018-06-18 10:13:33 +02:00
mUi->noreturn->setCurrentIndex(function->noreturn);
mUi->noreturn->setEnabled(true);
2018-06-18 10:13:33 +02:00
mUi->useretval->setChecked(function->useretval);
mUi->useretval->setEnabled(true);
2018-06-18 10:13:33 +02:00
mUi->leakignore->setChecked(function->leakignore);
mUi->leakignore->setEnabled(true);
updateArguments(*function);
2018-06-18 10:13:33 +02:00
mUi->arguments->setEnabled(true);
2018-06-18 10:13:33 +02:00
mUi->editArgButton->setEnabled(true);
2018-06-18 14:11:34 +02:00
mIgnoreChanges = false;
2015-08-16 17:36:10 +02:00
}
void LibraryDialog::sortFunctions(bool sort)
{
2015-09-08 15:38:02 +02:00
if (sort) {
2018-06-18 10:13:33 +02:00
mUi->functions->sortItems();
2015-09-08 15:38:02 +02:00
} else {
2018-06-18 14:11:34 +02:00
mIgnoreChanges = true;
const CppcheckLibraryData::Function* selfunction = currentFunction();
2018-06-18 10:13:33 +02:00
mUi->functions->clear();
2018-06-18 14:11:34 +02:00
for (CppcheckLibraryData::Function &function : mData.functions) {
2018-06-18 10:13:33 +02:00
mUi->functions->addItem(new FunctionListItem(mUi->functions,
2021-08-07 20:51:18 +02:00
&function,
selfunction == &function));
}
2018-06-18 10:13:33 +02:00
if (!mUi->filter->text().isEmpty())
filterFunctions(mUi->filter->text());
2018-06-18 14:11:34 +02:00
mIgnoreChanges = false;
}
}
void LibraryDialog::filterFunctions(const QString& filter)
{
2018-06-18 10:13:33 +02:00
QList<QListWidgetItem *> allItems = mUi->functions->findItems(QString(), Qt::MatchContains);
if (filter.isEmpty()) {
for (QListWidgetItem *item : allItems) {
item->setHidden(false);
}
} else {
for (QListWidgetItem *item : allItems) {
item->setHidden(!item->text().startsWith(filter));
}
}
}
void LibraryDialog::changeFunction()
{
2018-06-18 14:11:34 +02:00
if (mIgnoreChanges)
return;
CppcheckLibraryData::Function *function = currentFunction();
if (!function)
return;
2018-06-18 10:13:33 +02:00
function->comments = mUi->comments->toPlainText();
function->noreturn = (CppcheckLibraryData::Function::TrueFalseUnknown)mUi->noreturn->currentIndex();
function->useretval = mUi->useretval->isChecked();
function->leakignore = mUi->leakignore->isChecked();
2018-06-18 10:13:33 +02:00
mUi->buttonSave->setEnabled(true);
}
void LibraryDialog::editArg()
{
CppcheckLibraryData::Function *function = currentFunction();
if (!function)
return;
2018-06-18 10:13:33 +02:00
if (mUi->arguments->selectedItems().count() != 1)
return;
2018-06-18 10:13:33 +02:00
CppcheckLibraryData::Function::Arg &arg = function->args[mUi->arguments->row(mUi->arguments->selectedItems().first())];
LibraryEditArgDialog d(nullptr, arg);
if (d.exec() == QDialog::Accepted) {
const unsigned number = arg.nr;
arg = d.getArg();
arg.nr = number;
2018-06-18 10:13:33 +02:00
mUi->arguments->selectedItems().first()->setText(getArgText(arg));
}
2018-06-18 10:13:33 +02:00
mUi->buttonSave->setEnabled(true);
}
2015-08-30 18:37:12 +02:00
QString LibraryDialog::getArgText(const CppcheckLibraryData::Function::Arg &arg)
{
QString s("arg");
if (arg.nr != CppcheckLibraryData::Function::Arg::ANY)
s += QString::number(arg.nr);
s += "\n not bool: " + QString(arg.notbool ? "true" : "false");
s += "\n not null: " + QString(arg.notnull ? "true" : "false");
s += "\n not uninit: " + QString(arg.notuninit ? "true" : "false");
s += "\n format string: " + QString(arg.formatstr ? "true" : "false");
s += "\n strz: " + QString(arg.strz ? "true" : "false");
s += "\n valid: " + QString(arg.valid.isEmpty() ? "any" : arg.valid);
for (const CppcheckLibraryData::Function::Arg::MinSize &minsize : arg.minsizes) {
2015-08-30 18:37:12 +02:00
s += "\n minsize: " + minsize.type + " " + minsize.arg + " " + minsize.arg2;
}
return s;
}
void LibraryDialog::updateArguments(const CppcheckLibraryData::Function &function)
{
2018-06-18 10:13:33 +02:00
mUi->arguments->clear();
for (const CppcheckLibraryData::Function::Arg &arg : function.args) {
2018-06-18 10:13:33 +02:00
mUi->arguments->addItem(getArgText(arg));
}
}