cppcheck/lib/settings.h

451 lines
13 KiB
C
Raw Normal View History

2010-04-13 19:25:08 +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.
2010-04-13 19:25:08 +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/>.
*/
//---------------------------------------------------------------------------
#ifndef settingsH
#define settingsH
//---------------------------------------------------------------------------
2010-04-13 19:25:08 +02:00
#include "addoninfo.h"
#include "config.h"
#include "errortypes.h"
2017-05-27 04:33:47 +02:00
#include "importproject.h"
#include "library.h"
#include "platform.h"
#include "standards.h"
2017-05-27 04:33:47 +02:00
#include "suppressions.h"
2010-04-13 19:25:08 +02:00
#include <algorithm>
#include <atomic>
#include <cstddef>
#include <cstdint>
2017-05-27 04:33:47 +02:00
#include <list>
#include <set>
#include <string>
#include <tuple>
2017-05-27 04:33:47 +02:00
#include <vector>
#include <unordered_set>
2017-05-27 04:33:47 +02:00
enum class SHOWTIME_MODES;
namespace ValueFlow {
class Value;
}
2010-04-13 19:25:08 +02:00
/// @addtogroup Core
/// @{
template<typename T>
class SimpleEnableGroup {
2021-02-25 10:54:13 +01:00
uint32_t mFlags = 0;
public:
uint32_t intValue() const {
2021-02-25 10:54:13 +01:00
return mFlags;
}
void clear() {
2021-02-25 10:54:13 +01:00
mFlags = 0;
}
void fill() {
2021-02-25 10:54:13 +01:00
mFlags = 0xFFFFFFFF;
}
bool isEnabled(T flag) const {
2021-02-25 10:54:13 +01:00
return (mFlags & (1U << (uint32_t)flag)) != 0;
}
void enable(T flag) {
2021-02-25 10:54:13 +01:00
mFlags |= (1U << (uint32_t)flag);
}
void enable(SimpleEnableGroup<T> group) {
mFlags |= group.intValue();
}
void disable(T flag) {
2021-02-25 10:54:13 +01:00
mFlags &= ~(1U << (uint32_t)flag);
}
void disable(SimpleEnableGroup<T> group) {
mFlags &= ~(group.intValue());
}
void setEnabled(T flag, bool enabled) {
if (enabled)
enable(flag);
else
disable(flag);
}
};
2010-04-13 19:25:08 +02:00
/**
* @brief This is just a container for general settings so that we don't need
* to pass individual values to functions or constructors now or in the
* future when we might have even more detailed settings.
*/
class CPPCHECKLIB WARN_UNUSED Settings {
2010-04-13 19:25:08 +02:00
private:
/** @brief terminate checking */
static std::atomic<bool> mTerminated;
2010-04-13 19:25:08 +02:00
public:
Settings();
void loadCppcheckCfg();
/** @brief addons, either filename of python/json file or json data */
std::unordered_set<std::string> addons;
/** @brief the loaded addons infos */
std::vector<AddonInfo> addonInfos;
/** @brief Path to the python interpreter to be used to run addons. */
std::string addonPython;
/** @brief Paths used as base for conversion to relative paths. */
std::vector<std::string> basePaths;
2021-07-06 12:18:03 +02:00
/** @brief --cppcheck-build-dir. Always uses / as path separator. No trailing path separator. */
2016-10-29 12:18:11 +02:00
std::string buildDir;
/** @brief check all configurations (false if -D or --max-configs is used */
bool checkAllConfigurations = true;
/** Is the 'configuration checking' wanted? */
bool checkConfiguration{};
2020-04-26 15:24:25 +02:00
/**
* Check code in the headers, this is on by default but can
* be turned off to save CPU */
bool checkHeaders = true;
2020-04-26 15:24:25 +02:00
/** Check for incomplete info in library files? */
bool checkLibrary{};
/** @brief The maximum time in seconds for the checks of a single file */
int checksMaxTime{};
/** @brief --checkers-report=<filename> : Generate report of executed checkers */
std::string checkersReportFilename;
/** @brief check unknown function return values */
std::set<std::string> checkUnknownFunctionReturn;
/** Check unused/uninstantiated templates */
bool checkUnusedTemplates = true;
/** Use Clang */
bool clang{};
/** Custom Clang executable */
std::string clangExecutable = "clang";
2020-01-30 07:14:17 +01:00
/** Use clang-tidy */
bool clangTidy{};
2020-01-30 07:14:17 +01:00
/** Internal: Clear the simplecpp non-existing include cache */
bool clearIncludeCache{};
/** @brief include paths excluded from checking the configuration */
std::set<std::string> configExcludePaths;
/** cppcheck.cfg: Custom product name */
std::string cppcheckCfgProductName;
/** cppcheck.cfg: About text */
std::string cppcheckCfgAbout;
/** @brief Are we running from DACA script? */
bool daca{};
/** @brief Is --debug-normal given? */
bool debugnormal{};
/** @brief Is --debug-simplified given? */
bool debugSimplified{};
/** @brief Is --debug-template given? */
bool debugtemplate{};
/** @brief Is --debug-warnings given? */
bool debugwarnings{};
2014-07-14 15:51:45 +02:00
/** @brief Is --dump given? */
bool dump{};
std::string dumpFile;
2014-07-14 15:51:45 +02:00
enum Language {
None, C, CPP
};
/** @brief Name of the language that is enforced. Empty per default. */
Language enforcedLang{};
#if defined(USE_WINDOWS_SEH) || defined(USE_UNIX_SIGNAL_HANDLING)
/** @brief Is --exception-handling given */
bool exceptionHandling{};
#endif
2019-04-14 15:00:03 +02:00
// argv[0]
std::string exename;
/** @brief If errors are found, this value is returned from main().
Default value is 0. */
int exitCode{};
/** @brief List of --file-filter for analyzing special files */
std::vector<std::string> fileFilters;
2010-04-13 19:25:08 +02:00
/** @brief Force checking the files with "too many" configurations (--force). */
bool force{};
2010-04-13 19:25:08 +02:00
/** @brief List of include paths, e.g. "my/includes/" which should be used
for finding include files inside source files. (-I) */
std::list<std::string> includePaths;
2017-05-16 14:07:23 +02:00
/** @brief Is --inline-suppr given? */
bool inlineSuppressions{};
2010-04-13 19:25:08 +02:00
/** @brief How many processes/threads should do checking at the same
time. Default is 1. (-j N) */
unsigned int jobs = 1;
2010-04-13 19:25:08 +02:00
/** @brief --library= */
std::list<std::string> libraries;
2016-01-02 11:48:36 +01:00
/** Library */
Library library;
/** @brief Load average value */
int loadAverage{};
2010-04-13 19:25:08 +02:00
2011-10-22 11:11:54 +02:00
/** @brief Maximum number of configurations to check before bailing.
Default is 12. (--max-configs=N) */
int maxConfigs = 12;
/** @brief --max-ctu-depth */
int maxCtuDepth = 2;
/** @brief max template recursion */
int maxTemplateRecursion = 100;
/** @brief suppress exitcode */
Suppressions nofail;
2010-04-13 19:25:08 +02:00
/** @brief suppress message (--suppressions) */
Suppressions nomsg;
/** @brief write results (--output-file=&lt;file&gt;) */
std::string outputFile;
Platform platform;
/** @brief Experimental: --performance-valueflow-max-time=T */
int performanceValueFlowMaxTime = -1;
/** @brief --performance-valueflow-max-if-count=C */
2023-04-09 13:48:13 +02:00
int performanceValueFlowMaxIfCount;
/** @brief max number of sets of arguments to pass to subfuncions in valueflow */
int performanceValueFlowMaxSubFunctionArgs;
/** @brief plist output (--plist-output=&lt;dir&gt;) */
std::string plistOutput;
2022-08-22 21:11:28 +02:00
/** @brief Extra arguments for Cppcheck Premium addon */
std::string premiumArgs;
/** @brief Using -E for debugging purposes */
bool preprocessOnly{};
ImportProject project;
/** @brief Is --quiet given? */
bool quiet{};
/** @brief Use relative paths in output. */
bool relativePaths{};
/** @brief --report-progress */
int reportProgress{-1};
#ifdef HAVE_RULES
2010-12-12 11:56:22 +01:00
/** Rule */
struct CPPCHECKLIB Rule {
std::string tokenlist = "normal"; // use normal tokenlist
2010-12-12 11:56:22 +01:00
std::string pattern;
std::string id = "rule"; // default id
2010-12-12 11:56:22 +01:00
std::string summary;
Severity severity = Severity::style; // default severity
2010-12-12 11:56:22 +01:00
};
/**
* @brief Extra rules
*/
std::list<Rule> rules;
#endif
/** Do not only check how interface is used. Also check that interface is safe. */
struct CPPCHECKLIB SafeChecks {
static const char XmlRootName[];
static const char XmlClasses[];
static const char XmlExternalFunctions[];
static const char XmlInternalFunctions[];
static const char XmlExternalVariables[];
void clear() {
classes = externalFunctions = internalFunctions = externalVariables = false;
}
/**
* Public interface of classes
* - public function parameters can have any value
* - public functions can be called in any order
* - public variables can have any value
*/
bool classes{};
/**
* External functions
* - external functions can be called in any order
* - function parameters can have any values
*/
bool externalFunctions{};
/**
* Experimental: assume that internal functions can be used in any way
* This is only available in the GUI.
*/
bool internalFunctions{};
/**
* Global variables that can be modified outside the TU.
* - Such variable can have "any" value
*/
bool externalVariables{};
};
SafeChecks safeChecks;
SimpleEnableGroup<Severity> severity;
SimpleEnableGroup<Certainty> certainty;
SimpleEnableGroup<Checks> checks;
/** @brief show timing information (--showtime=file|summary|top5) */
SHOWTIME_MODES showtime{};
/** Struct contains standards settings */
Standards standards;
/** @brief The output format in which the errors are printed in text mode,
e.g. "{severity} {file}:{line} {message} {id}" */
std::string templateFormat;
/** @brief The output format in which the error locations are printed in
* text mode, e.g. "{file}:{line} {info}" */
std::string templateLocation;
2019-03-02 19:52:15 +01:00
/** @brief The maximum time in seconds for the template instantiation */
std::size_t templateMaxTime{};
/** @brief The maximum time in seconds for the typedef simplification */
std::size_t typedefMaxTime{};
/** @brief defines given by the user */
std::string userDefines;
/** @brief undefines given by the user */
std::set<std::string> userUndefs;
/** @brief forced includes given by the user */
std::list<std::string> userIncludes;
/** @brief the maximum iterations of valueflow (--valueflow-max-iterations=T) */
std::size_t valueFlowMaxIterations = 4;
/** @brief Is --verbose given? */
bool verbose{};
/** @brief write XML results (--xml) */
bool xml{};
/** @brief XML version (--xml-version=..) */
int xml_version = 2;
/**
* @brief return true if a included file is to be excluded in Preprocessor::getConfigs
* @return true for the file to be excluded.
*/
2014-11-20 14:20:09 +01:00
bool configurationExcluded(const std::string &file) const {
return std::any_of(configExcludePaths.begin(), configExcludePaths.end(), [&file](const std::string& path) {
return file.length() >= path.length() && file.compare(0, path.length(), path) == 0;
});
}
/**
* @brief Enable extra checks by id. See isEnabled()
* @param str single id or list of id values to be enabled
* or empty string to enable all. e.g. "style,possibleError"
* @return error message. empty upon success
*/
std::string addEnabled(const std::string &str);
/**
* @brief Disable extra checks by id
* @param str single id or list of id values to be enabled
* or empty string to enable all. e.g. "style,possibleError"
* @return error message. empty upon success
*/
std::string removeEnabled(const std::string &str);
/**
2021-08-07 20:51:18 +02:00
* @brief Returns true if given value can be shown
* @return true if the value can be shown
*/
bool isEnabled(const ValueFlow::Value *value, bool inconclusiveCheck=false) const;
/** Is library specified? */
bool hasLib(const std::string &lib) const {
return std::find(libraries.cbegin(), libraries.cend(), lib) != libraries.cend();
}
/** @brief Request termination of checking */
static void terminate(bool t = true) {
Settings::mTerminated = t;
}
/** @brief termination requested? */
static bool terminated() {
return Settings::mTerminated;
}
2020-12-19 19:02:42 +01:00
std::set<std::string> summaryReturn;
2020-12-19 19:02:42 +01:00
void loadSummaries();
bool useSingleJob() const {
return jobs == 1;
}
2023-04-09 13:48:13 +02:00
void setCheckLevelExhaustive();
void setCheckLevelNormal();
private:
static std::string parseEnabled(const std::string &str, std::tuple<SimpleEnableGroup<Severity>, SimpleEnableGroup<Checks>> &groups);
std::string applyEnabled(const std::string &str, bool enable);
2010-04-13 19:25:08 +02:00
};
/// @}
//---------------------------------------------------------------------------
#endif // settingsH