cppcheck/gui/checkthread.h

145 lines
3.6 KiB
C
Raw Normal View History

/*
* Cppcheck - A tool for static C/C++ code analysis
2022-02-05 11:45:17 +01:00
* Copyright (C) 2007-2022 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 CHECKTHREAD_H
#define CHECKTHREAD_H
#include "cppcheck.h"
#include "suppressions.h"
2022-02-02 16:17:28 +01:00
#include <QThread>
class Settings;
class ThreadResult;
/// @addtogroup GUI
/// @{
/**
2021-08-07 20:51:18 +02:00
* @brief Thread to run cppcheck
*
*/
2011-10-13 20:53:06 +02:00
class CheckThread : public QThread {
Q_OBJECT
public:
explicit CheckThread(ThreadResult &result);
virtual ~CheckThread();
/**
2021-08-07 20:51:18 +02:00
* @brief Set settings for cppcheck
*
* @param settings settings for cppcheck
*/
2017-07-28 05:26:11 +02:00
void check(const Settings &settings);
2016-11-19 20:38:50 +01:00
/**
2021-08-07 20:51:18 +02:00
* @brief Run whole program analysis
* @param files All files
*/
2017-07-28 05:26:11 +02:00
void analyseWholeProgram(const QStringList &files);
2016-11-19 20:38:50 +01:00
void setAddonsAndTools(const QStringList &addonsAndTools) {
mAddonsAndTools = addonsAndTools;
}
void setDataDir(const QString &dataDir) {
mDataDir = dataDir;
}
2017-08-12 12:04:42 +02:00
void setClangIncludePaths(const QStringList &s) {
mClangIncludePaths = s;
}
void setSuppressions(const QList<Suppressions::Suppression> &s) {
2017-08-11 07:45:29 +02:00
mSuppressions = s;
}
/**
2021-08-07 20:51:18 +02:00
* @brief method that is run in a thread
*
*/
void run() override;
void stop();
2017-10-12 17:02:25 +02:00
/**
2017-10-12 22:24:45 +02:00
* Determine command to run clang
* \return Command to run clang, empty if it is not found
2017-10-12 17:02:25 +02:00
*/
static QString clangCmd();
/**
2017-10-12 22:24:45 +02:00
* Determine command to run clang-tidy
* \return Command to run clang-tidy, empty if it is not found
2017-10-12 17:02:25 +02:00
*/
static QString clangTidyCmd();
signals:
/**
2021-08-07 20:51:18 +02:00
* @brief cpp checking is done
*
*/
2017-07-28 13:43:49 +02:00
void done();
2017-07-28 13:43:49 +02:00
void fileChecked(const QString &file);
protected:
/**
2021-08-07 20:51:18 +02:00
* @brief States for the check thread.
* Whole purpose of these states is to allow stopping of the checking. When
* stopping we say for the thread (Stopping) that stop when current check
* has been completed. Thread must be stopped cleanly, just terminating thread
* likely causes unpredictable side-effects.
*/
2011-10-13 20:53:06 +02:00
enum State {
Running, /**< The thread is checking. */
Stopping, /**< The thread will stop after current work. */
Stopped, /**< The thread has been stopped. */
Ready, /**< The thread is ready. */
};
/**
2021-08-07 20:51:18 +02:00
* @brief Thread's current execution state.
*/
State mState;
ThreadResult &mResult;
/**
2021-08-07 20:51:18 +02:00
* @brief Cppcheck itself
*/
CppCheck mCppcheck;
2016-11-19 20:38:50 +01:00
private:
2017-10-11 23:02:00 +02:00
void runAddonsAndTools(const ImportProject::FileSettings *fileSettings, const QString &fileName);
2017-08-03 18:04:15 +02:00
2017-08-09 20:53:17 +02:00
void parseClangErrors(const QString &tool, const QString &file0, QString err);
2019-08-09 19:00:09 +02:00
bool isSuppressed(const Suppressions::ErrorMessage &errorMessage) const;
2016-11-19 20:38:50 +01:00
QStringList mFiles;
2016-12-09 20:48:32 +01:00
bool mAnalyseWholeProgram;
QStringList mAddonsAndTools;
QString mDataDir;
2017-08-12 12:04:42 +02:00
QStringList mClangIncludePaths;
QList<Suppressions::Suppression> mSuppressions;
};
/// @}
#endif // CHECKTHREAD_H