Skip to content

Commit f4c9f3a

Browse files
firewavefirewave
authored
added lookup debug logging for the remaining configuration files (#6609)
1 parent 45219c0 commit f4c9f3a

9 files changed

Lines changed: 324 additions & 34 deletions

File tree

‎cli/cmdlineparser.cpp‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,25 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
556556
else if (std::strcmp(argv[i], "--debug-lookup") == 0)
557557
mSettings.debuglookup = true;
558558

559+
else if (std::strncmp(argv[i], "--debug-lookup=", 15) == 0) {
560+
const std::string lookup = argv[i] + 15;
561+
if (lookup == "all")
562+
mSettings.debuglookup = true;
563+
else if (lookup == "addon")
564+
mSettings.debuglookupAddon = true;
565+
else if (lookup == "config")
566+
mSettings.debuglookupConfig = true;
567+
else if (lookup == "library")
568+
mSettings.debuglookupLibrary = true;
569+
else if (lookup == "platform")
570+
mSettings.debuglookupPlatform = true;
571+
else
572+
{
573+
mLogger.printError("unknown lookup '" + lookup + "'");
574+
return Result::Fail;
575+
}
576+
}
577+
559578
// Flag used for various purposes during debugging
560579
else if (std::strcmp(argv[i], "--debug-simplified") == 0)
561580
mSettings.debugSimplified = true;
@@ -928,7 +947,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
928947

929948
std::string errstr;
930949
const std::vector<std::string> paths = {argv[0]};
931-
if (!mSettings.platform.set(platform, errstr, paths)) {
950+
if (!mSettings.platform.set(platform, errstr, paths, mSettings.debuglookup || mSettings.debuglookupPlatform)) {
932951
mLogger.printError(errstr);
933952
return Result::Fail;
934953
}
@@ -1022,7 +1041,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
10221041
if (!platform.empty()) {
10231042
std::string errstr;
10241043
const std::vector<std::string> paths = {projectFile, argv[0]};
1025-
if (!mSettings.platform.set(platform, errstr, paths)) {
1044+
if (!mSettings.platform.set(platform, errstr, paths, mSettings.debuglookup || mSettings.debuglookupPlatform)) {
10261045
mLogger.printError(errstr);
10271046
return Result::Fail;
10281047
}
@@ -1820,7 +1839,7 @@ std::string CmdLineParser::getVersion() const {
18201839

18211840
bool CmdLineParser::isCppcheckPremium() const {
18221841
if (mSettings.cppcheckCfgProductName.empty())
1823-
Settings::loadCppcheckCfg(mSettings, mSettings.supprs);
1842+
Settings::loadCppcheckCfg(mSettings, mSettings.supprs, mSettings.debuglookup || mSettings.debuglookupConfig);
18241843
return startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
18251844
}
18261845

@@ -1873,7 +1892,7 @@ bool CmdLineParser::tryLoadLibrary(Library& destination, const std::string& base
18731892

18741893
bool CmdLineParser::loadLibraries(Settings& settings)
18751894
{
1876-
if (!tryLoadLibrary(settings.library, settings.exename, "std.cfg", settings.debuglookup)) {
1895+
if (!tryLoadLibrary(settings.library, settings.exename, "std.cfg", settings.debuglookup || settings.debuglookupLibrary)) {
18771896
const std::string msg("Failed to load std.cfg. Your Cppcheck installation is broken, please re-install.");
18781897
#ifdef FILESDIR
18791898
const std::string details("The Cppcheck binary was compiled with FILESDIR set to \""
@@ -1891,7 +1910,7 @@ bool CmdLineParser::loadLibraries(Settings& settings)
18911910

18921911
bool result = true;
18931912
for (const auto& lib : settings.libraries) {
1894-
if (!tryLoadLibrary(settings.library, settings.exename, lib.c_str(), settings.debuglookup)) {
1913+
if (!tryLoadLibrary(settings.library, settings.exename, lib.c_str(), settings.debuglookup || settings.debuglookupLibrary)) {
18951914
result = false;
18961915
}
18971916
}
@@ -1903,7 +1922,7 @@ bool CmdLineParser::loadAddons(Settings& settings)
19031922
bool result = true;
19041923
for (const std::string &addon: settings.addons) {
19051924
AddonInfo addonInfo;
1906-
const std::string failedToGetAddonInfo = addonInfo.getAddonInfo(addon, settings.exename);
1925+
const std::string failedToGetAddonInfo = addonInfo.getAddonInfo(addon, settings.exename, settings.debuglookup || settings.debuglookupAddon);
19071926
if (!failedToGetAddonInfo.empty()) {
19081927
mLogger.printRaw(failedToGetAddonInfo); // TODO: do not print as raw
19091928
result = false;
@@ -1916,7 +1935,7 @@ bool CmdLineParser::loadAddons(Settings& settings)
19161935

19171936
bool CmdLineParser::loadCppcheckCfg()
19181937
{
1919-
const std::string cfgErr = Settings::loadCppcheckCfg(mSettings, mSuppressions);
1938+
const std::string cfgErr = Settings::loadCppcheckCfg(mSettings, mSuppressions, mSettings.debuglookup || mSettings.debuglookupConfig);
19201939
if (!cfgErr.empty()) {
19211940
mLogger.printError("could not load cppcheck.cfg - " + cfgErr);
19221941
return false;

‎lib/addoninfo.cpp‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,29 @@
2727

2828
#include "json.h"
2929

30-
static std::string getFullPath(const std::string &fileName, const std::string &exename) {
30+
static std::string getFullPath(const std::string &fileName, const std::string &exename, bool debug = false) {
31+
if (debug)
32+
std::cout << "looking for addon '" << fileName << "'" << std::endl;
3133
if (Path::isFile(fileName))
3234
return fileName;
3335

3436
const std::string exepath = Path::getPathFromFilename(exename);
37+
if (debug)
38+
std::cout << "looking for addon '" << (exepath + fileName) << "'" << std::endl;
3539
if (Path::isFile(exepath + fileName))
3640
return exepath + fileName;
41+
if (debug)
42+
std::cout << "looking for addon '" << (exepath + "addons/" + fileName) << "'" << std::endl;
3743
if (Path::isFile(exepath + "addons/" + fileName))
3844
return exepath + "addons/" + fileName;
3945

4046
#ifdef FILESDIR
47+
if (debug)
48+
std::cout << "looking for addon '" << (FILESDIR + ("/" + fileName)) << "'" << std::endl;
4149
if (Path::isFile(FILESDIR + ("/" + fileName)))
4250
return FILESDIR + ("/" + fileName);
51+
if (debug)
52+
std::cout << "looking for addon '" << (FILESDIR + ("/addons/" + fileName)) << "'" << std::endl;
4353
if (Path::isFile(FILESDIR + ("/addons/" + fileName)))
4454
return FILESDIR + ("/addons/" + fileName);
4555
#endif
@@ -124,18 +134,18 @@ static std::string parseAddonInfo(AddonInfo& addoninfo, const picojson::value &j
124134
return addoninfo.getAddonInfo(val.get<std::string>(), exename);
125135
}
126136

127-
std::string AddonInfo::getAddonInfo(const std::string &fileName, const std::string &exename) {
137+
std::string AddonInfo::getAddonInfo(const std::string &fileName, const std::string &exename, bool debug) {
128138
if (fileName[0] == '{') {
129139
picojson::value json;
130140
const std::string err = picojson::parse(json, fileName);
131141
(void)err; // TODO: report
132142
return parseAddonInfo(*this, json, fileName, exename);
133143
}
134144
if (fileName.find('.') == std::string::npos)
135-
return getAddonInfo(fileName + ".py", exename);
145+
return getAddonInfo(fileName + ".py", exename, debug);
136146

137147
if (endsWith(fileName, ".py")) {
138-
scriptFile = Path::fromNativeSeparators(getFullPath(fileName, exename));
148+
scriptFile = Path::fromNativeSeparators(getFullPath(fileName, exename, debug));
139149
if (scriptFile.empty())
140150
return "Did not find addon " + fileName;
141151

‎lib/addoninfo.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ struct CPPCHECKLIB AddonInfo {
3232
bool ctu = false;
3333
std::string runScript;
3434

35-
std::string getAddonInfo(const std::string &fileName, const std::string &exename);
35+
std::string getAddonInfo(const std::string &fileName, const std::string &exename, bool debug = false);
3636
};
3737

3838
#endif // addonInfoH

‎lib/platform.cpp‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ bool Platform::set(Type t)
150150
return false;
151151
}
152152

153-
bool Platform::set(const std::string& platformstr, std::string& errstr, const std::vector<std::string>& paths, bool verbose)
153+
bool Platform::set(const std::string& platformstr, std::string& errstr, const std::vector<std::string>& paths, bool debug)
154154
{
155155
if (platformstr == "win32A")
156156
set(Type::Win32A);
@@ -173,9 +173,9 @@ bool Platform::set(const std::string& platformstr, std::string& errstr, const st
173173
else {
174174
bool found = false;
175175
for (const std::string& path : paths) {
176-
if (verbose)
176+
if (debug)
177177
std::cout << "looking for platform '" + platformstr + "' in '" + path + "'" << std::endl;
178-
if (loadFromFile(path.c_str(), platformstr, verbose)) {
178+
if (loadFromFile(path.c_str(), platformstr, debug)) {
179179
found = true;
180180
break;
181181
}
@@ -189,7 +189,7 @@ bool Platform::set(const std::string& platformstr, std::string& errstr, const st
189189
return true;
190190
}
191191

192-
bool Platform::loadFromFile(const char exename[], const std::string &filename, bool verbose)
192+
bool Platform::loadFromFile(const char exename[], const std::string &filename, bool debug)
193193
{
194194
// TODO: only append .xml if missing
195195
// TODO: use native separators
@@ -216,15 +216,15 @@ bool Platform::loadFromFile(const char exename[], const std::string &filename, b
216216
tinyxml2::XMLDocument doc;
217217
bool success = false;
218218
for (const std::string & f : filenames) {
219-
if (verbose)
219+
if (debug)
220220
std::cout << "try to load platform file '" << f << "' ... ";
221221
if (doc.LoadFile(f.c_str()) == tinyxml2::XML_SUCCESS) {
222-
if (verbose)
222+
if (debug)
223223
std::cout << "Success" << std::endl;
224224
success = true;
225225
break;
226226
}
227-
if (verbose)
227+
if (debug)
228228
std::cout << doc.ErrorStr() << std::endl;
229229
}
230230
if (!success)

‎lib/platform.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,16 +122,16 @@ class CPPCHECKLIB Platform {
122122
bool set(Type t);
123123

124124
/** set the platform type */
125-
bool set(const std::string& platformstr, std::string& errstr, const std::vector<std::string>& paths = {}, bool verbose = false);
125+
bool set(const std::string& platformstr, std::string& errstr, const std::vector<std::string>& paths = {}, bool debug = false);
126126

127127
/**
128128
* load platform file
129129
* @param exename application path
130130
* @param filename platform filename
131-
* @param verbose log verbose information about the lookup
131+
* @param debug log verbose information about the lookup
132132
* @return returns true if file was loaded successfully
133133
*/
134-
bool loadFromFile(const char exename[], const std::string &filename, bool verbose = false);
134+
bool loadFromFile(const char exename[], const std::string &filename, bool debug = false);
135135

136136
/** load platform from xml document, primarily for testing */
137137
bool loadFromXmlDocument(const tinyxml2::XMLDocument *doc);

‎lib/settings.cpp‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,32 @@ Settings::Settings()
6262
pid = getPid();
6363
}
6464

65-
std::string Settings::loadCppcheckCfg(Settings& settings, Suppressions& suppressions)
65+
std::string Settings::loadCppcheckCfg(Settings& settings, Suppressions& suppressions, bool debug)
6666
{
6767
// TODO: this always needs to be run *after* the Settings has been filled
6868
static const std::string cfgFilename = "cppcheck.cfg";
6969
std::string fileName;
7070
#ifdef FILESDIR
71-
if (Path::isFile(Path::join(FILESDIR, cfgFilename)))
72-
fileName = Path::join(FILESDIR, cfgFilename);
71+
{
72+
const std::string filesdirCfg = Path::join(FILESDIR, cfgFilename);
73+
if (debug)
74+
std::cout << "looking for '" << filesdirCfg << "'" << std::endl;
75+
if (Path::isFile(filesdirCfg))
76+
fileName = filesdirCfg;
77+
}
7378
#endif
7479
// cppcheck-suppress knownConditionTrueFalse
7580
if (fileName.empty()) {
7681
// TODO: make sure that exename is set
7782
fileName = Path::getPathFromFilename(settings.exename) + cfgFilename;
83+
if (debug)
84+
std::cout << "looking for '" << fileName << "'" << std::endl;
7885
if (!Path::isFile(fileName))
86+
{
87+
if (debug)
88+
std::cout << "no configuration found" << std::endl;
7989
return "";
90+
}
8091
}
8192

8293
std::ifstream fin(fileName);

‎lib/settings.h‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ class CPPCHECKLIB WARN_UNUSED Settings {
102102
public:
103103
Settings();
104104

105-
static std::string loadCppcheckCfg(Settings& settings, Suppressions& suppressions);
105+
static std::string loadCppcheckCfg(Settings& settings, Suppressions& suppressions, bool debug = false);
106106

107107
static std::pair<std::string, std::string> getNameAndVersion(const std::string& productName);
108108

@@ -174,9 +174,21 @@ class CPPCHECKLIB WARN_UNUSED Settings {
174174
/** @brief Are we running from DACA script? */
175175
bool daca{};
176176

177-
/** @brief Internal: Is --debug-lookup given? */
177+
/** @brief Internal: Is --debug-lookup or --debug-lookup=all given? */
178178
bool debuglookup{};
179179

180+
/** @brief Internal: Is --debug-lookup=addon given? */
181+
bool debuglookupAddon{};
182+
183+
/** @brief Internal: Is --debug-lookup=config given? */
184+
bool debuglookupConfig{};
185+
186+
/** @brief Internal: Is --debug-lookup=library given? */
187+
bool debuglookupLibrary{};
188+
189+
/** @brief Internal: Is --debug-lookup=platform given? */
190+
bool debuglookupPlatform{};
191+
180192
/** @brief Is --debug-normal given? */
181193
bool debugnormal{};
182194

0 commit comments

Comments
 (0)