Skip to content

Commit b65e45d

Browse files
firewavefirewave
committed
improved determination if application is Premium / added TODOs
1 parent c12d8f9 commit b65e45d

12 files changed

Lines changed: 175 additions & 78 deletions

‎cli/cmdlineparser.cpp‎

Lines changed: 52 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -321,8 +321,37 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
321321
// default to --check-level=normal from CLI for now
322322
mSettings.setCheckLevel(Settings::CheckLevel::normal);
323323

324+
// read --debug-lookup early so the option is available for the cppcheck.cfg loading
325+
for (int i = 1; i < argc; i++) {
326+
// Show debug warnings for lookup for configuration files
327+
if (std::strcmp(argv[i], "--debug-lookup") == 0)
328+
mSettings.debuglookup = true;
329+
330+
else if (std::strncmp(argv[i], "--debug-lookup=", 15) == 0) {
331+
const std::string lookup = argv[i] + 15;
332+
if (lookup == "all")
333+
mSettings.debuglookup = true;
334+
else if (lookup == "addon")
335+
mSettings.debuglookupAddon = true;
336+
else if (lookup == "config")
337+
mSettings.debuglookupConfig = true;
338+
else if (lookup == "library")
339+
mSettings.debuglookupLibrary = true;
340+
else if (lookup == "platform")
341+
mSettings.debuglookupPlatform = true;
342+
else
343+
{
344+
mLogger.printError("unknown lookup '" + lookup + "'");
345+
return Result::Fail;
346+
}
347+
}
348+
}
349+
350+
if (!loadCppcheckCfg())
351+
return Result::Fail;
352+
324353
if (argc <= 1) {
325-
printHelp();
354+
printHelp(mSettings.premium);
326355
return Result::Exit;
327356
}
328357

@@ -346,8 +375,6 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
346375

347376
// print all possible error messages..
348377
if (std::strcmp(argv[i], "--errorlist") == 0) {
349-
if (!loadCppcheckCfg())
350-
return Result::Fail;
351378
{
352379
XMLErrorMessagesLogger xmlLogger;
353380
std::cout << ErrorMessage::getXMLHeader(mSettings.cppcheckCfgProductName, 2);
@@ -359,7 +386,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
359386

360387
// Print help
361388
if (std::strcmp(argv[i], "-h") == 0 || std::strcmp(argv[i], "--help") == 0) {
362-
printHelp();
389+
printHelp(mSettings.premium);
363390
return Result::Exit;
364391
}
365392

@@ -371,8 +398,6 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
371398
}
372399

373400
if (std::strcmp(argv[i], "--version") == 0) {
374-
if (!loadCppcheckCfg())
375-
return Result::Fail;
376401
const std::string version = getVersion();
377402
mLogger.printRaw(version); // TODO: should not include newline
378403
return Result::Exit;
@@ -611,28 +636,11 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
611636
std::strcmp(argv[i], "--debug-normal") == 0)
612637
debug = true;
613638

614-
// Show debug warnings for lookup for configuration files
615639
else if (std::strcmp(argv[i], "--debug-lookup") == 0)
616-
mSettings.debuglookup = true;
640+
continue; // already handled above
617641

618-
else if (std::strncmp(argv[i], "--debug-lookup=", 15) == 0) {
619-
const std::string lookup = argv[i] + 15;
620-
if (lookup == "all")
621-
mSettings.debuglookup = true;
622-
else if (lookup == "addon")
623-
mSettings.debuglookupAddon = true;
624-
else if (lookup == "config")
625-
mSettings.debuglookupConfig = true;
626-
else if (lookup == "library")
627-
mSettings.debuglookupLibrary = true;
628-
else if (lookup == "platform")
629-
mSettings.debuglookupPlatform = true;
630-
else
631-
{
632-
mLogger.printError("unknown lookup '" + lookup + "'");
633-
return Result::Fail;
634-
}
635-
}
642+
else if (std::strncmp(argv[i], "--debug-lookup=", 15) == 0)
643+
continue; // already handled above
636644

637645
// Flag used for various purposes during debugging
638646
else if (std::strcmp(argv[i], "--debug-simplified") == 0)
@@ -1084,7 +1092,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
10841092
}
10851093

10861094
// Special Cppcheck Premium options
1087-
else if ((std::strncmp(argv[i], "--premium=", 10) == 0 || std::strncmp(argv[i], "--premium-", 10) == 0) && isCppcheckPremium()) {
1095+
else if ((std::strncmp(argv[i], "--premium=", 10) == 0 || std::strncmp(argv[i], "--premium-", 10) == 0) && mSettings.premium) {
10881096
// valid options --premium=..
10891097
const std::set<std::string> valid{
10901098
"autosar",
@@ -1145,7 +1153,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
11451153

11461154
mSettings.checkAllConfigurations = false; // Can be overridden with --max-configs or --force
11471155
std::string projectFile = argv[i]+10;
1148-
projectType = project.import(projectFile, &mSettings, &mSuppressions, isCppcheckPremium());
1156+
projectType = project.import(projectFile, &mSettings, &mSuppressions, mSettings.premium);
11491157
if (projectType == ImportProject::Type::CPPCHECK_GUI) {
11501158
for (const std::string &lib : project.guiProject.libraries)
11511159
mSettings.libraries.emplace_back(lib);
@@ -1543,9 +1551,6 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
15431551
}
15441552
}
15451553

1546-
if (!loadCppcheckCfg())
1547-
return Result::Fail;
1548-
15491554
// TODO: bail out?
15501555
if (!executorAuto && mSettings.useSingleJob())
15511556
mLogger.printMessage("'--executor' has no effect as only a single job will be used.");
@@ -1669,13 +1674,15 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
16691674
return Result::Success;
16701675
}
16711676

1672-
void CmdLineParser::printHelp() const
1677+
void CmdLineParser::printHelp(bool premium) const
16731678
{
1674-
const std::string manualUrl(isCppcheckPremium() ?
1675-
"https://cppcheck.sourceforge.io/manual.pdf" :
1676-
"https://files.cppchecksolutions.com/manual.pdf");
1679+
// TODO: fetch URL from config like product name?
1680+
const std::string manualUrl(premium ?
1681+
"https://files.cppchecksolutions.com/manual.pdf" :
1682+
"https://cppcheck.sourceforge.io/manual.pdf");
16771683

16781684
std::ostringstream oss;
1685+
// TODO: display product name
16791686
oss << "Cppcheck - A tool for static C/C++ code analysis\n"
16801687
"\n"
16811688
"Syntax:\n"
@@ -1876,7 +1883,7 @@ void CmdLineParser::printHelp() const
18761883
" --plist-output=<path>\n"
18771884
" Generate Clang-plist output files in folder.\n";
18781885

1879-
if (isCppcheckPremium()) {
1886+
if (premium) {
18801887
oss <<
18811888
" --premium=<option>\n"
18821889
" Coding standards:\n"
@@ -2059,6 +2066,7 @@ void CmdLineParser::printHelp() const
20592066
}
20602067

20612068
std::string CmdLineParser::getVersion() const {
2069+
// TODO: this should not contain the version - it should set the extraVersion
20622070
if (!mSettings.cppcheckCfgProductName.empty())
20632071
return mSettings.cppcheckCfgProductName;
20642072
const char * const extraVersion = CppCheck::extraVersion();
@@ -2067,12 +2075,6 @@ std::string CmdLineParser::getVersion() const {
20672075
return std::string("Cppcheck ") + CppCheck::version();
20682076
}
20692077

2070-
bool CmdLineParser::isCppcheckPremium() const {
2071-
if (mSettings.cppcheckCfgProductName.empty())
2072-
Settings::loadCppcheckCfg(mSettings, mSuppressions, mSettings.debuglookup || mSettings.debuglookupConfig);
2073-
return startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
2074-
}
2075-
20762078
bool CmdLineParser::tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename, bool debug)
20772079
{
20782080
const Library::Error err = destination.load(basepath.c_str(), filename, debug);
@@ -2165,13 +2167,19 @@ bool CmdLineParser::loadAddons(Settings& settings)
21652167

21662168
bool CmdLineParser::loadCppcheckCfg()
21672169
{
2168-
if (!mSettings.cppcheckCfgProductName.empty())
2169-
return true;
2170+
if (!mSettings.settingsFiles.empty())
2171+
{
2172+
// should never happen - programming error
2173+
mLogger.printError("cppcheck.cfg has already been loaded from " + mSettings.settingsFiles[0]);
2174+
return false;
2175+
}
21702176
const std::string cfgErr = Settings::loadCppcheckCfg(mSettings, mSuppressions, mSettings.debuglookup || mSettings.debuglookupConfig);
21712177
if (!cfgErr.empty()) {
2178+
// TODO: log full path
21722179
mLogger.printError("could not load cppcheck.cfg - " + cfgErr);
21732180
return false;
21742181
}
2182+
mSettings.premium = startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
21752183
return true;
21762184
}
21772185

‎cli/cmdlineparser.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,9 @@ class CmdLineParser {
124124
/**
125125
* Print help text to the console.
126126
*/
127-
void printHelp() const;
127+
void printHelp(bool premium) const;
128128

129129
private:
130-
bool isCppcheckPremium() const;
131-
132130
template<typename T>
133131
bool parseNumberArg(const char* const arg, std::size_t offset, T& num, bool mustBePositive = false)
134132
{

‎gui/main.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ static void ShowUsage()
124124

125125
static void ShowVersion()
126126
{
127+
// TODO: should only *not* show a dialog when we are on a commnd-line
127128
#if defined(_WIN32)
128129
AboutDialog *dlg = new AboutDialog(CppCheck::version(), CppCheck::extraVersion(), 0);
129130
dlg->exec();

‎gui/mainwindow.cpp‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1091,6 +1091,8 @@ bool MainWindow::getCppcheckSettings(Settings& settings, Suppressions& supprs)
10911091
return false;
10921092
}
10931093

1094+
settings.premium = startsWith(settings.cppcheckCfgProductName, "Cppcheck Premium");
1095+
10941096
const auto cfgAddons = settings.addons;
10951097
settings.addons.clear();
10961098
for (const std::string& addon : cfgAddons) {
@@ -1754,6 +1756,7 @@ void MainWindow::formatAndSetTitle(const QString &text)
17541756
nameWithVersion += " (" + extraVersion + ")";
17551757
}
17561758

1759+
// TODO: should not contain the version
17571760
if (!mCppcheckCfgProductName.isEmpty())
17581761
nameWithVersion = mCppcheckCfgProductName;
17591762

@@ -2282,7 +2285,9 @@ void MainWindow::replyFinished(QNetworkReply *reply) {
22822285
const QString str = reply->readAll();
22832286
qDebug() << "Response: " << str;
22842287
if (reply->url().fileName() == "version.txt") {
2288+
// TODO: lacks extra version
22852289
QString nameWithVersion = QString("Cppcheck %1").arg(CppCheck::version());
2290+
// TODO: this should not contain the version
22862291
if (!mCppcheckCfgProductName.isEmpty())
22872292
nameWithVersion = mCppcheckCfgProductName;
22882293
const int appVersion = getVersion(nameWithVersion);

‎gui/xmlreportv2.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ void XmlReportV2::writeHeader()
9494
{
9595
const auto nameAndVersion = Settings::getNameAndVersion(mProductName.toStdString());
9696
const QString name = QString::fromStdString(nameAndVersion.first);
97+
// TODO: lacks extraVersion
9798
const QString version = nameAndVersion.first.empty() ? CppCheck::version() : QString::fromStdString(nameAndVersion.second);
9899

99100
mXmlWriter->setAutoFormatting(true);

‎lib/errorlogger.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,7 @@ std::string ErrorMessage::getXMLHeader(std::string productName, int xmlVersion)
437437
{
438438
const auto nameAndVersion = Settings::getNameAndVersion(productName);
439439
productName = nameAndVersion.first;
440+
// TODO: lacks extra version
440441
const std::string version = nameAndVersion.first.empty() ? CppCheck::version() : nameAndVersion.second;
441442

442443
tinyxml2::XMLPrinter printer;

‎lib/settings.cpp‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ Settings::Settings()
6767

6868
std::string Settings::loadCppcheckCfg(Settings& settings, Suppressions& suppressions, bool debug)
6969
{
70-
// TODO: this always needs to be run *after* the Settings has been filled
7170
static const std::string cfgFilename = "cppcheck.cfg";
7271
std::string fileName;
7372
#ifdef FILESDIR
@@ -82,7 +81,7 @@ std::string Settings::loadCppcheckCfg(Settings& settings, Suppressions& suppress
8281
// cppcheck-suppress knownConditionTrueFalse
8382
if (fileName.empty()) {
8483
// TODO: make sure that exename is set
85-
fileName = Path::getPathFromFilename(settings.exename) + cfgFilename;
84+
fileName = Path::join(Path::getPathFromFilename(settings.exename), cfgFilename);
8685
if (debug)
8786
std::cout << "looking for '" << fileName << "'" << std::endl;
8887
if (!Path::isFile(fileName))
@@ -167,6 +166,8 @@ std::string Settings::loadCppcheckCfg(Settings& settings, Suppressions& suppress
167166
}
168167
}
169168

169+
settings.settingsFiles.emplace_back(std::move(fileName));
170+
170171
return "";
171172
}
172173

‎lib/settings.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
312312
/** @brief plist output (--plist-output=&lt;dir&gt;) */
313313
std::string plistOutput;
314314

315+
/** @brief Are we Cppcheck Premium */
316+
bool premium{};
317+
315318
/** @brief Extra arguments for Cppcheck Premium addon */
316319
std::string premiumArgs;
317320

@@ -398,6 +401,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
398401

399402
SafeChecks safeChecks;
400403

404+
/** @brief the files we successfully loaded settings from */
405+
std::vector<std::string> settingsFiles;
406+
401407
SimpleEnableGroup<Severity> severity;
402408
SimpleEnableGroup<Certainty> certainty;
403409
SimpleEnableGroup<Checks> checks;

‎test/cli/lookup_test.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -858,6 +858,7 @@ def test_config_lookup(tmpdir):
858858
exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=config', test_file], cwd=tmpdir, cppcheck_exe=tmp_cppcheck_exe)
859859
exepath = os.path.dirname(exe)
860860
exepath_sep = exepath + os.path.sep
861+
exepath_sep = exepath_sep.replace('\\', '/')
861862
assert exitcode == 0, stdout if stdout else stderr
862863
lines = stdout.splitlines()
863864
assert lines == [
@@ -874,6 +875,7 @@ def test_config_lookup_notfound(tmpdir):
874875
exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=config', test_file])
875876
exepath = os.path.dirname(exe)
876877
exepath_sep = exepath + os.path.sep
878+
exepath_sep = exepath_sep.replace('\\', '/')
877879
assert exitcode == 0, stdout if stdout else stderr
878880
lines = stdout.splitlines()
879881
assert lines == [
@@ -902,6 +904,7 @@ def test_config_invalid(tmpdir):
902904
exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=config', test_file], cwd=tmpdir, cppcheck_exe=tmp_cppcheck_exe)
903905
exepath = os.path.dirname(exe)
904906
exepath_sep = exepath + os.path.sep
907+
exepath_sep = exepath_sep.replace('\\', '/')
905908
assert exitcode == 1, stdout if stdout else stderr
906909
lines = stdout.splitlines()
907910
assert lines == [

‎test/cli/other_test.py‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
import glob
88
import json
99
import subprocess
10+
import shutil
1011

11-
from testutils import cppcheck, assert_cppcheck
12+
from testutils import cppcheck, assert_cppcheck, cppcheck_ex, __lookup_cppcheck_exe
1213
from xml.etree import ElementTree
1314

1415

@@ -1701,6 +1702,26 @@ def test_cpp_probe_2(tmpdir):
17011702
assert_cppcheck(args, ec_exp=0, err_exp=[], out_exp=[])
17021703

17031704

1705+
def test_config_invalid(tmpdir):
1706+
# cppcheck.cfg needs to be next to executable
1707+
exe = shutil.copy2(__lookup_cppcheck_exe(), tmpdir)
1708+
shutil.copytree(os.path.join(os.path.dirname(__lookup_cppcheck_exe()), 'cfg'), os.path.join(tmpdir, 'cfg'))
1709+
1710+
test_file = os.path.join(tmpdir, 'test.c')
1711+
with open(test_file, 'wt'):
1712+
pass
1713+
1714+
config_file = os.path.join(tmpdir, 'cppcheck.cfg')
1715+
with open(config_file, 'wt'):
1716+
pass
1717+
1718+
exitcode, stdout, stderr, exe = cppcheck_ex([test_file], cwd=tmpdir, cppcheck_exe=exe)
1719+
assert exitcode == 1, stdout if stdout else stderr
1720+
assert stdout.splitlines() == [
1721+
'cppcheck: error: could not load cppcheck.cfg - not a valid JSON - syntax error at line 1 near: '
1722+
]
1723+
1724+
17041725
def test_checkers_report(tmpdir):
17051726
test_file = os.path.join(tmpdir, 'test.c')
17061727
with open(test_file, 'wt') as f:

0 commit comments

Comments
 (0)