Skip to content

Commit da20e5e

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

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
@@ -324,8 +324,37 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
324324
// default to --check-level=normal from CLI for now
325325
mSettings.setCheckLevel(Settings::CheckLevel::normal);
326326

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

@@ -349,8 +378,6 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
349378

350379
// print all possible error messages..
351380
if (std::strcmp(argv[i], "--errorlist") == 0) {
352-
if (!loadCppcheckCfg())
353-
return Result::Fail;
354381
{
355382
XMLErrorMessagesLogger xmlLogger;
356383
std::cout << ErrorMessage::getXMLHeader(mSettings.cppcheckCfgProductName, 2);
@@ -362,7 +389,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
362389

363390
// Print help
364391
if (std::strcmp(argv[i], "-h") == 0 || std::strcmp(argv[i], "--help") == 0) {
365-
printHelp();
392+
printHelp(mSettings.premium);
366393
return Result::Exit;
367394
}
368395

@@ -374,8 +401,6 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
374401
}
375402

376403
if (std::strcmp(argv[i], "--version") == 0) {
377-
if (!loadCppcheckCfg())
378-
return Result::Fail;
379404
const std::string version = getVersion();
380405
mLogger.printRaw(version); // TODO: should not include newline
381406
return Result::Exit;
@@ -617,28 +642,11 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
617642
std::strcmp(argv[i], "--debug-normal") == 0)
618643
debug = true;
619644

620-
// Show debug warnings for lookup for configuration files
621645
else if (std::strcmp(argv[i], "--debug-lookup") == 0)
622-
mSettings.debuglookup = true;
646+
continue; // already handled above
623647

624-
else if (std::strncmp(argv[i], "--debug-lookup=", 15) == 0) {
625-
const std::string lookup = argv[i] + 15;
626-
if (lookup == "all")
627-
mSettings.debuglookup = true;
628-
else if (lookup == "addon")
629-
mSettings.debuglookupAddon = true;
630-
else if (lookup == "config")
631-
mSettings.debuglookupConfig = true;
632-
else if (lookup == "library")
633-
mSettings.debuglookupLibrary = true;
634-
else if (lookup == "platform")
635-
mSettings.debuglookupPlatform = true;
636-
else
637-
{
638-
mLogger.printError("unknown lookup '" + lookup + "'");
639-
return Result::Fail;
640-
}
641-
}
648+
else if (std::strncmp(argv[i], "--debug-lookup=", 15) == 0)
649+
continue; // already handled above
642650

643651
// Flag used for various purposes during debugging
644652
else if (std::strcmp(argv[i], "--debug-simplified") == 0)
@@ -1090,7 +1098,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
10901098
}
10911099

10921100
// Special Cppcheck Premium options
1093-
else if ((std::strncmp(argv[i], "--premium=", 10) == 0 || std::strncmp(argv[i], "--premium-", 10) == 0) && isCppcheckPremium()) {
1101+
else if ((std::strncmp(argv[i], "--premium=", 10) == 0 || std::strncmp(argv[i], "--premium-", 10) == 0) && mSettings.premium) {
10941102
// valid options --premium=..
10951103
const std::set<std::string> valid{
10961104
"autosar",
@@ -1151,7 +1159,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
11511159

11521160
mSettings.checkAllConfigurations = false; // Can be overridden with --max-configs or --force
11531161
std::string projectFile = argv[i]+10;
1154-
projectType = project.import(projectFile, &mSettings, &mSuppressions, isCppcheckPremium());
1162+
projectType = project.import(projectFile, &mSettings, &mSuppressions, mSettings.premium);
11551163
if (projectType == ImportProject::Type::CPPCHECK_GUI) {
11561164
for (const std::string &lib : project.guiProject.libraries)
11571165
mSettings.libraries.emplace_back(lib);
@@ -1564,9 +1572,6 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
15641572
}
15651573
}
15661574

1567-
if (!loadCppcheckCfg())
1568-
return Result::Fail;
1569-
15701575
// TODO: bail out?
15711576
if (!executorAuto && mSettings.useSingleJob())
15721577
mLogger.printMessage("'--executor' has no effect as only a single job will be used.");
@@ -1690,13 +1695,15 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
16901695
return Result::Success;
16911696
}
16921697

1693-
void CmdLineParser::printHelp() const
1698+
void CmdLineParser::printHelp(bool premium) const
16941699
{
1695-
const std::string manualUrl(isCppcheckPremium() ?
1696-
"https://cppcheck.sourceforge.io/manual.pdf" :
1697-
"https://files.cppchecksolutions.com/manual.pdf");
1700+
// TODO: fetch URL from config like product name?
1701+
const std::string manualUrl(premium ?
1702+
"https://files.cppchecksolutions.com/manual.pdf" :
1703+
"https://cppcheck.sourceforge.io/manual.pdf");
16981704

16991705
std::ostringstream oss;
1706+
// TODO: display product name
17001707
oss << "Cppcheck - A tool for static C/C++ code analysis\n"
17011708
"\n"
17021709
"Syntax:\n"
@@ -1890,7 +1897,7 @@ void CmdLineParser::printHelp() const
18901897
" --plist-output=<path>\n"
18911898
" Generate Clang-plist output files in folder.\n";
18921899

1893-
if (isCppcheckPremium()) {
1900+
if (premium) {
18941901
oss <<
18951902
" --premium=<option>\n"
18961903
" Coding standards:\n"
@@ -2073,6 +2080,7 @@ void CmdLineParser::printHelp() const
20732080
}
20742081

20752082
std::string CmdLineParser::getVersion() const {
2083+
// TODO: this should not contain the version - it should set the extraVersion
20762084
if (!mSettings.cppcheckCfgProductName.empty())
20772085
return mSettings.cppcheckCfgProductName;
20782086
const char * const extraVersion = CppCheck::extraVersion();
@@ -2081,12 +2089,6 @@ std::string CmdLineParser::getVersion() const {
20812089
return std::string("Cppcheck ") + CppCheck::version();
20822090
}
20832091

2084-
bool CmdLineParser::isCppcheckPremium() const {
2085-
if (mSettings.cppcheckCfgProductName.empty())
2086-
Settings::loadCppcheckCfg(mSettings, mSuppressions, mSettings.debuglookup || mSettings.debuglookupConfig);
2087-
return startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
2088-
}
2089-
20902092
bool CmdLineParser::tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename, bool debug)
20912093
{
20922094
const Library::Error err = destination.load(basepath.c_str(), filename, debug);
@@ -2179,13 +2181,19 @@ bool CmdLineParser::loadAddons(Settings& settings)
21792181

21802182
bool CmdLineParser::loadCppcheckCfg()
21812183
{
2182-
if (!mSettings.cppcheckCfgProductName.empty())
2183-
return true;
2184+
if (!mSettings.settingsFiles.empty())
2185+
{
2186+
// should never happen - programming error
2187+
mLogger.printError("cppcheck.cfg has already been loaded from " + mSettings.settingsFiles[0]);
2188+
return false;
2189+
}
21842190
const std::string cfgErr = Settings::loadCppcheckCfg(mSettings, mSuppressions, mSettings.debuglookup || mSettings.debuglookupConfig);
21852191
if (!cfgErr.empty()) {
2192+
// TODO: log full path
21862193
mLogger.printError("could not load cppcheck.cfg - " + cfgErr);
21872194
return false;
21882195
}
2196+
mSettings.premium = startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
21892197
return true;
21902198
}
21912199

‎cli/cmdlineparser.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,7 @@ class CmdLineParser {
109109
/**
110110
* Print help text to the console.
111111
*/
112-
void printHelp() const;
113-
114-
bool isCppcheckPremium() const;
112+
void printHelp(bool premium) const;
115113

116114
template<typename T>
117115
bool parseNumberArg(const char* const arg, std::size_t offset, T& num, bool mustBePositive = false)

‎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) {
@@ -1757,6 +1759,7 @@ void MainWindow::formatAndSetTitle(const QString &text)
17571759
nameWithVersion += " (" + extraVersion + ")";
17581760
}
17591761

1762+
// TODO: should not contain the version
17601763
if (!mCppcheckCfgProductName.isEmpty())
17611764
nameWithVersion = mCppcheckCfgProductName;
17621765

@@ -2285,7 +2288,9 @@ void MainWindow::replyFinished(QNetworkReply *reply) {
22852288
const QString str = reply->readAll();
22862289
qDebug() << "Response: " << str;
22872290
if (reply->url().fileName() == "version.txt") {
2291+
// TODO: lacks extra version
22882292
QString nameWithVersion = QString("Cppcheck %1").arg(CppCheck::version());
2293+
// TODO: this should not contain the version
22892294
if (!mCppcheckCfgProductName.isEmpty())
22902295
nameWithVersion = mCppcheckCfgProductName;
22912296
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
@@ -318,6 +318,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
318318
/** @brief plist output (--plist-output=&lt;dir&gt;) */
319319
std::string plistOutput;
320320

321+
/** @brief Are we Cppcheck Premium */
322+
bool premium{};
323+
321324
/** @brief Extra arguments for Cppcheck Premium addon */
322325
std::string premiumArgs;
323326

@@ -405,6 +408,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
405408

406409
SafeChecks safeChecks;
407410

411+
/** @brief the files we successfully loaded settings from */
412+
std::vector<std::string> settingsFiles;
413+
408414
SimpleEnableGroup<Severity> severity;
409415
SimpleEnableGroup<Certainty> certainty;
410416
SimpleEnableGroup<Checks> checks;

‎test/cli/lookup_test.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,7 @@ def test_config_lookup(tmpdir):
843843
exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=config', test_file], cwd=tmpdir, cppcheck_exe=tmp_cppcheck_exe)
844844
exepath = os.path.dirname(exe)
845845
exepath_sep = exepath + os.path.sep
846+
exepath_sep = exepath_sep.replace('\\', '/')
846847
assert exitcode == 0, stdout if stdout else stderr
847848
lines = stdout.splitlines()
848849
assert lines == [
@@ -859,6 +860,7 @@ def test_config_lookup_notfound(tmpdir):
859860
exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=config', test_file])
860861
exepath = os.path.dirname(exe)
861862
exepath_sep = exepath + os.path.sep
863+
exepath_sep = exepath_sep.replace('\\', '/')
862864
assert exitcode == 0, stdout if stdout else stderr
863865
lines = stdout.splitlines()
864866
assert lines == [
@@ -887,6 +889,7 @@ def test_config_invalid(tmpdir):
887889
exitcode, stdout, stderr, exe = cppcheck_ex(['--debug-lookup=config', test_file], cwd=tmpdir, cppcheck_exe=tmp_cppcheck_exe)
888890
exepath = os.path.dirname(exe)
889891
exepath_sep = exepath + os.path.sep
892+
exepath_sep = exepath_sep.replace('\\', '/')
890893
assert exitcode == 1, stdout if stdout else stderr
891894
lines = stdout.splitlines()
892895
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

@@ -1722,6 +1723,26 @@ def test_cpp_probe_2(tmpdir):
17221723
assert_cppcheck(args, ec_exp=0, err_exp=[], out_exp=[])
17231724

17241725

1726+
def test_config_invalid(tmpdir):
1727+
# cppcheck.cfg needs to be next to executable
1728+
exe = shutil.copy2(__lookup_cppcheck_exe(), tmpdir)
1729+
shutil.copytree(os.path.join(os.path.dirname(__lookup_cppcheck_exe()), 'cfg'), os.path.join(tmpdir, 'cfg'))
1730+
1731+
test_file = os.path.join(tmpdir, 'test.c')
1732+
with open(test_file, 'wt'):
1733+
pass
1734+
1735+
config_file = os.path.join(tmpdir, 'cppcheck.cfg')
1736+
with open(config_file, 'wt'):
1737+
pass
1738+
1739+
exitcode, stdout, stderr, exe = cppcheck_ex([test_file], cwd=tmpdir, cppcheck_exe=exe)
1740+
assert exitcode == 1, stdout if stdout else stderr
1741+
assert stdout.splitlines() == [
1742+
'cppcheck: error: could not load cppcheck.cfg - not a valid JSON - syntax error at line 1 near: '
1743+
]
1744+
1745+
17251746
def test_checkers_report(tmpdir):
17261747
test_file = os.path.join(tmpdir, 'test.c')
17271748
with open(test_file, 'wt') as f:

0 commit comments

Comments
 (0)