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
|
/* -*- C++ -*-
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2025 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 cppcheckH
#define cppcheckH
//---------------------------------------------------------------------------
#include "check.h"
#include "config.h"
#include "standards.h"
#include <cstdint>
#include <fstream>
#include <functional>
#include <list>
#include <memory>
#include <string>
#include <vector>
class TokenList;
enum class SHOWTIME_MODES : std::uint8_t;
struct FileSettings;
class CheckUnusedFunctions;
class Tokenizer;
class FileWithDetails;
class AnalyzerInformation;
class ErrorLogger;
class Settings;
struct Suppressions;
namespace simplecpp { class TokenList; }
/// @addtogroup Core
/// @{
/**
* @brief This is the base class which will use other classes to do
* static code analysis for C and C++ code to find possible
* errors or places that could be improved.
* Usage: See check() for more info.
*/
class CPPCHECKLIB CppCheck {
public:
using ExecuteCmdFn = std::function<int (std::string,std::vector<std::string>,std::string,std::string&)>;
/**
* @brief Constructor.
*/
CppCheck(const Settings& settings,
Suppressions& supprs,
ErrorLogger &errorLogger,
bool useGlobalSuppressions,
ExecuteCmdFn executeCommand);
/**
* @brief Destructor.
*/
~CppCheck();
/**
* @brief This starts the actual checking. Note that you must call
* parseFromArgs() or settings() and addFile() before calling this.
* @return amount of errors found or 0 if none were found.
*/
/**
* @brief Check the file.
* This function checks one given file for errors.
* @param file The file to check.
* @return amount of errors found or 0 if none were found.
* @note You must set settings before calling this function (by calling
* settings()).
*/
unsigned int check(const FileWithDetails &file);
unsigned int check(const FileSettings &fs);
/**
* @brief Check the file.
* This function checks one "virtual" file. The file is not read from
* the disk but the content is given in @p content. In errors the @p path
* is used as a filename.
* @param file The file to check.
* @param content File content as a string.
* @return amount of errors found or 0 if none were found.
* @note You must set settings before calling this function (by calling
* settings()).
*/
unsigned int check(const FileWithDetails &file, const std::string &content);
/**
* @brief Returns current version number as a string.
* @return version, e.g. "1.38"
*/
RET_NONNULL static const char * version();
/**
* @brief Returns extra version info as a string.
* This is for returning extra version info, like Git commit id, build
* time/date etc.
* @return extra version info, e.g. "04d42151" (Git commit id).
*/
RET_NONNULL static const char * extraVersion();
/**
* @brief Call all "getErrorMessages" in all registered Check classes.
* Also print out XML header and footer.
*/
static void getErrorMessages(ErrorLogger &errorlogger);
void tooManyConfigsError(const std::string &file, int numberOfConfigurations);
void purgedConfigurationMessage(const std::string &file, const std::string& configuration);
/** Analyse whole program, run this after all TUs has been scanned.
* This is deprecated and the plan is to remove this when
* .analyzeinfo is good enough.
* Return true if an error is reported.
*/
bool analyseWholeProgram();
/** Analyze all files using clang-tidy */
void analyseClangTidy(const FileSettings &fileSettings);
/** analyse whole program use .analyzeinfo files or ctuinfo string */
unsigned int analyseWholeProgram(const std::string &buildDir, const std::list<FileWithDetails> &files, const std::list<FileSettings>& fileSettings, const std::string& ctuInfo);
static void resetTimerResults();
static void printTimerResults(SHOWTIME_MODES mode);
bool isPremiumCodingStandardId(const std::string& id) const;
/**
* @brief Get dumpfile <rawtokens> contents, this is only public for testing purposes
*/
std::string getDumpFileContentsRawTokens(const std::vector<std::string>& files, const simplecpp::TokenList& tokens1) const;
std::string getLibraryDumpData() const;
/**
* @brief Get the clang command line flags using the Settings
* @param fileLang language guessed from filename
* @return Clang command line flags
*/
std::string getClangFlags(Standards::Language fileLang) const;
private:
#ifdef HAVE_RULES
/** Are there "simple" rules */
bool hasRule(const std::string &tokenlist) const;
#endif
/** @brief There has been an internal error => Report information message */
void internalError(const std::string &filename, const std::string &msg);
/**
* @brief Check a file using stream
* @param file the file
* @param cfgname cfg name
* @param fileStream stream the file content can be read from
* @return number of errors found
*/
unsigned int checkFile(const FileWithDetails& file, const std::string &cfgname, std::istream* fileStream = nullptr);
/**
* @brief Check normal tokens
* @param tokenizer tokenizer instance
* @param analyzerInformation the analyzer infomation
*/
void checkNormalTokens(const Tokenizer &tokenizer, AnalyzerInformation* analyzerInformation);
/**
* Execute addons
*/
void executeAddons(const std::vector<std::string>& files, const std::string& file0);
void executeAddons(const std::string &dumpFile, const FileWithDetails& file);
/**
* Execute addons
*/
void executeAddonsWholeProgram(const std::list<FileWithDetails> &files, const std::list<FileSettings>& fileSettings, const std::string& ctuInfo);
#ifdef HAVE_RULES
/**
* @brief Execute rules, if any
* @param tokenlist token list to use (define / normal / raw)
* @param list token list
*/
void executeRules(const std::string &tokenlist, const TokenList &list);
#endif
unsigned int checkClang(const FileWithDetails &file);
const Settings& mSettings;
Suppressions& mSuppressions;
class CppCheckLogger;
std::unique_ptr<CppCheckLogger> mLogger;
/** the internal ErrorLogger */
ErrorLogger& mErrorLogger;
/** the ErrorLogger provided to this instance */
ErrorLogger& mErrorLoggerDirect;
/** @brief Current preprocessor configuration */
std::string mCurrentConfig;
bool mUseGlobalSuppressions;
/** Are there too many configs? */
bool mTooManyConfigs{};
/** File info used for whole program analysis */
std::list<Check::FileInfo*> mFileInfo;
/** Callback for executing a shell command (exe, args, output) */
ExecuteCmdFn mExecuteCommand;
std::unique_ptr<CheckUnusedFunctions> mUnusedFunctionsCheck;
};
/// @}
//---------------------------------------------------------------------------
#endif // cppcheckH
|