cppcheck/gui/threadresult.h

166 lines
3.7 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
2023-01-28 10:16:34 +01:00
* Copyright (C) 2007-2023 Cppcheck team.
*
* 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/>.
*/
#ifndef THREADRESULT_H
#define THREADRESULT_H
2021-07-08 21:21:35 +02:00
#include "color.h"
#include "errorlogger.h"
2016-08-18 21:58:50 +02:00
#include "importproject.h"
#include <list>
#include <mutex>
#include <string>
2022-02-02 16:17:28 +01:00
#include <QObject>
#include <QString>
2022-02-02 16:17:28 +01:00
#include <QStringList>
#include <QtGlobal>
2022-02-02 16:17:28 +01:00
class ErrorItem;
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief Threads use this class to obtain new files to process and to publish results
*
*/
2011-10-13 20:53:06 +02:00
class ThreadResult : public QObject, public ErrorLogger {
Q_OBJECT
public:
ThreadResult() = default;
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Get next unprocessed file
* @return File path
*/
2017-07-28 12:39:28 +02:00
QString getNextFile();
2017-07-28 12:39:28 +02:00
ImportProject::FileSettings getNextFileSettings();
2016-08-18 21:58:50 +02:00
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Set list of files to check
* @param files List of files to check
*/
2017-07-28 12:39:28 +02:00
void setFiles(const QStringList &files);
2017-07-28 12:39:28 +02:00
void setProject(const ImportProject &prj);
2016-08-18 21:58:50 +02:00
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Clear files to check
*
*/
2017-07-28 12:39:28 +02:00
void clearFiles();
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Get the number of files to check
*
*/
2017-07-28 12:39:28 +02:00
int getFileCount() const;
/**
2021-08-07 20:51:18 +02:00
* ErrorLogger methods
*/
2021-07-08 21:21:35 +02:00
void reportOut(const std::string &outmsg, Color c = Color::Reset) override;
2020-05-23 07:16:49 +02:00
void reportErr(const ErrorMessage &msg) override;
public slots:
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Slot threads use to signal this class that a specific file is checked
* @param file File that is checked
*/
2017-07-28 12:39:28 +02:00
void fileChecked(const QString &file);
signals:
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Progress signal
* @param value Current progress
* @param description Description of the current stage
*/
// NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
2017-07-28 12:39:28 +02:00
void progress(int value, const QString& description);
/**
2021-08-07 20:51:18 +02:00
* @brief Signal of a new error
*
* @param item Error data
*/
// NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
2017-07-28 12:39:28 +02:00
void error(const ErrorItem &item);
/**
2021-08-07 20:51:18 +02:00
* @brief Signal of a new log message
*
* @param logline Log line
*/
// NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
2017-07-28 12:39:28 +02:00
void log(const QString &logline);
/**
2021-08-07 20:51:18 +02:00
* @brief Signal of a debug error
*
* @param item Error data
*/
// NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
2017-07-28 12:39:28 +02:00
void debugError(const ErrorItem &item);
protected:
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Mutex
*
*/
mutable std::mutex mutex;
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief List of files to check
*
*/
QStringList mFiles;
2016-08-18 21:58:50 +02:00
std::list<ImportProject::FileSettings> mFileSettings;
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Max progress
*
*/
quint64 mMaxProgress{};
2009-06-02 00:39:52 +02:00
/**
2021-08-07 20:51:18 +02:00
* @brief Current progress
*
*/
quint64 mProgress{};
/**
2021-08-07 20:51:18 +02:00
* @brief Current number of files checked
*
*/
unsigned long mFilesChecked{};
/**
2021-08-07 20:51:18 +02:00
* @brief Total number of files
*
*/
unsigned long mTotalFiles{};
};
/// @}
#endif // THREADRESULT_H