126 lines
3.8 KiB
C++
126 lines
3.8 KiB
C++
/*
|
|
* Cppcheck - A tool for static C/C++ code analysis
|
|
* 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 CPPCHECKEXECUTOR_H
|
|
#define CPPCHECKEXECUTOR_H
|
|
|
|
#include "config.h"
|
|
#include "filesettings.h"
|
|
|
|
#include <cstdio>
|
|
#include <list>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
class CppCheck;
|
|
class Settings;
|
|
class ErrorLogger;
|
|
class Suppressions;
|
|
|
|
/**
|
|
* This class works as an example of how CppCheck can be used in external
|
|
* programs without very little knowledge of the internal parts of the
|
|
* program itself. If you wish to use cppcheck e.g. as a part of IDE,
|
|
* just rewrite this class for your needs and possibly use other methods
|
|
* from CppCheck class instead the ones used here.
|
|
*/
|
|
class CppCheckExecutor {
|
|
public:
|
|
friend class TestSuppressions;
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
CppCheckExecutor() = default;
|
|
CppCheckExecutor(const CppCheckExecutor &) = delete;
|
|
CppCheckExecutor& operator=(const CppCheckExecutor&) = delete;
|
|
|
|
/**
|
|
* Starts the checking.
|
|
*
|
|
* @param argc from main()
|
|
* @param argv from main()
|
|
* @return EXIT_FAILURE if arguments are invalid or no input files
|
|
* were found.
|
|
* If errors are found and --error-exitcode is used,
|
|
* given value is returned instead of default 0.
|
|
* If no errors are found, 0 is returned.
|
|
*/
|
|
int check(int argc, const char* const argv[]);
|
|
|
|
/**
|
|
* @param exceptionOutput Output file
|
|
*/
|
|
static void setExceptionOutput(FILE* exceptionOutput);
|
|
/**
|
|
* @return file name to be used for output from exception handler. Has to be either "stdout" or "stderr".
|
|
*/
|
|
static FILE* getExceptionOutput();
|
|
|
|
private:
|
|
|
|
/**
|
|
* Execute a shell command and read the output from it. Returns exitcode of the executed command,.
|
|
*/
|
|
static int executeCommand(std::string exe, std::vector<std::string> args, std::string redirect, std::string &output_);
|
|
|
|
protected:
|
|
|
|
static bool reportSuppressions(const Settings &settings, const Suppressions& suppressions, bool unusedFunctionCheckEnabled, const std::list<std::pair<std::string, std::size_t>> &files, const std::list<FileSettings>& fileSettings, ErrorLogger& errorLogger);
|
|
|
|
/**
|
|
* Wrapper around check_internal
|
|
* - installs optional platform dependent signal handling
|
|
*
|
|
* @param cppcheck cppcheck instance
|
|
**/
|
|
int check_wrapper(CppCheck& cppcheck);
|
|
|
|
/**
|
|
* Starts the checking.
|
|
*
|
|
* @param cppcheck cppcheck instance
|
|
* @return EXIT_FAILURE if arguments are invalid or no input files
|
|
* were found.
|
|
* If errors are found and --error-exitcode is used,
|
|
* given value is returned instead of default 0.
|
|
* If no errors are found, 0 is returned.
|
|
*/
|
|
int check_internal(CppCheck& cppcheck) const;
|
|
|
|
/**
|
|
* Filename associated with size of file
|
|
*/
|
|
std::list<std::pair<std::string, std::size_t>> mFiles;
|
|
|
|
std::list<FileSettings> mFileSettings;
|
|
|
|
#if defined(USE_WINDOWS_SEH) || defined(USE_UNIX_SIGNAL_HANDLING)
|
|
/**
|
|
* Output file name for exception handler
|
|
*/
|
|
static FILE* mExceptionOutput;
|
|
#endif
|
|
|
|
class StdLogger;
|
|
StdLogger* mStdLogger{};
|
|
};
|
|
|
|
#endif // CPPCHECKEXECUTOR_H
|