walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

streamlined message/error printing of CmdLineParser (#3524) 

* cmdlineparser.cpp: removed message about deprecated --std=posix

* streamlined message/error printing of CmdLineParser

* test-helloworld.py: adjusted expected test result
This commit is contained in:
Oliver Stöneberg 2021-10-30 13:30:48 +02:00 committed by GitHub
parent b4704ba065
commit 61a2b89034
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 57 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
cli/cmdlineparser.cpp
View File

@ -106,12 +106,12 @@ CmdLineParser::CmdLineParser(Settings *settings)
void CmdLineParser::printMessage(const std::string &message) void CmdLineParser::printMessage(const std::string &message)
{ {
std::cout << message << std::endl; std::cout << "cppcheck: " << message << std::endl;
} }
void CmdLineParser::printMessage(const char* message) void CmdLineParser::printError(const std::string &message)
{ {
std::cout << message << std::endl; printMessage("error: " + message);
} }
bool CmdLineParser::parseFromArgs(int argc, const char* const argv[]) bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
@ -133,7 +133,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
if (std::strcmp(argv[i], "-D") == 0) { if (std::strcmp(argv[i], "-D") == 0) {
++i; ++i;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: argument to '-D' is missing."); printError("argument to '-D' is missing.");
return false; return false;
} }
@ -169,7 +169,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
if (std::strcmp(argv[i], "-I") == 0) { if (std::strcmp(argv[i], "-I") == 0) {
++i; ++i;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: argument to '-I' is missing."); printError("argument to '-I' is missing.");
return false; return false;
} }
path = argv[i]; path = argv[i];
@ -197,7 +197,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
if (std::strcmp(argv[i], "-U") == 0) { if (std::strcmp(argv[i], "-U") == 0) {
++i; ++i;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: argument to '-U' is missing."); printError("argument to '-U' is missing.");
return false; return false;
} }
@ -250,7 +250,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
// open this file and read every input file (1 file name per line) // open this file and read every input file (1 file name per line)
const std::string cfgExcludesFile(23 + argv[i]); const std::string cfgExcludesFile(23 + argv[i]);
if (!addPathsToSet(cfgExcludesFile, &mSettings->configExcludePaths)) { if (!addPathsToSet(cfgExcludesFile, &mSettings->configExcludePaths)) {
printMessage("Cppcheck: unable to open config excludes file at '" + cfgExcludesFile + "'"); printError("unable to open config excludes file at '" + cfgExcludesFile + "'");
return false; return false;
} }
} }
@ -306,7 +306,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
else if (std::strncmp(argv[i], "--enable=", 9) == 0) { else if (std::strncmp(argv[i], "--enable=", 9) == 0) {
const std::string errmsg = mSettings->addEnabled(argv[i] + 9); const std::string errmsg = mSettings->addEnabled(argv[i] + 9);
if (!errmsg.empty()) { if (!errmsg.empty()) {
printMessage(errmsg); printError(errmsg);
return false; return false;
} }
// when "style" is enabled, also enable "warning", "performance" and "portability" // when "style" is enabled, also enable "warning", "performance" and "portability"
@ -330,7 +330,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::istringstream iss(temp); std::istringstream iss(temp);
if (!(iss >> mSettings->exitCode)) { if (!(iss >> mSettings->exitCode)) {
mSettings->exitCode = 0; mSettings->exitCode = 0;
printMessage("cppcheck: Argument must be an integer. Try something like '--error-exitcode=1'."); printError("argument must be an integer. Try something like '--error-exitcode=1'.");
return false; return false;
} }
} }
@ -352,12 +352,12 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::ifstream f(filename); std::ifstream f(filename);
if (!f.is_open()) { if (!f.is_open()) {
printMessage("cppcheck: Couldn't open the file: \"" + filename + "\"."); printError("couldn't open the file: \"" + filename + "\".");
return false; return false;
} }
const std::string errmsg(mSettings->nofail.parseFile(f)); const std::string errmsg(mSettings->nofail.parseFile(f));
if (!errmsg.empty()) { if (!errmsg.empty()) {
printMessage(errmsg); printError(errmsg);
return false; return false;
} }
} }
@ -391,7 +391,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
if (std::strcmp(argv[i], "-i") == 0) { if (std::strcmp(argv[i], "-i") == 0) {
++i; ++i;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: argument to '-i' is missing."); printError("argument to '-i' is missing.");
return false; return false;
} }
path = argv[i]; path = argv[i];
@ -424,7 +424,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
// open this file and read every input file (1 file name per line) // open this file and read every input file (1 file name per line)
const std::string includesFile(16 + argv[i]); const std::string includesFile(16 + argv[i]);
if (!addIncludePathsToList(includesFile, &mSettings->includePaths)) { if (!addIncludePathsToList(includesFile, &mSettings->includePaths)) {
printMessage("Cppcheck: unable to open includes file at '" + includesFile + "'"); printError("unable to open includes file at '" + includesFile + "'");
return false; return false;
} }
} }
@ -445,7 +445,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
if (std::strcmp(argv[i], "-j") == 0) { if (std::strcmp(argv[i], "-j") == 0) {
++i; ++i;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: argument to '-j' is missing."); printError("argument to '-j' is missing.");
return false; return false;
} }
@ -458,14 +458,14 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::istringstream iss(numberString); std::istringstream iss(numberString);
if (!(iss >> mSettings->jobs)) { if (!(iss >> mSettings->jobs)) {
printMessage("cppcheck: argument to '-j' is not a number."); printError("argument to '-j' is not a number.");
return false; return false;
} }
if (mSettings->jobs > 10000) { if (mSettings->jobs > 10000) {
// This limit is here just to catch typos. If someone has // This limit is here just to catch typos. If someone has
// need for more jobs, this value should be increased. // need for more jobs, this value should be increased.
printMessage("cppcheck: argument for '-j' is allowed to be 10000 at max."); printError("argument for '-j' is allowed to be 10000 at max.");
return false; return false;
} }
} }
@ -477,7 +477,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
if (std::strcmp(argv[i], "-l") == 0) { if (std::strcmp(argv[i], "-l") == 0) {
++i; ++i;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: argument to '-l' is missing."); printError("argument to '-l' is missing.");
return false; return false;
} }
@ -490,7 +490,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::istringstream iss(numberString); std::istringstream iss(numberString);
if (!(iss >> mSettings->loadAverage)) { if (!(iss >> mSettings->loadAverage)) {
printMessage("cppcheck: argument to '-l' is not a number."); printError("argument to '-l' is not a number.");
return false; return false;
} }
} }
@ -503,7 +503,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
} else { } else {
i++; i++;
if (i >= argc || argv[i][0] == '-') { if (i >= argc || argv[i][0] == '-') {
printMessage("cppcheck: No language given to '-x' option."); printError("no language given to '-x' option.");
return false; return false;
} }
str = argv[i]; str = argv[i];
@ -514,7 +514,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
else if (str == "c++") else if (str == "c++")
mSettings->enforcedLang = Settings::CPP; mSettings->enforcedLang = Settings::CPP;
else { else {
printMessage("cppcheck: Unknown language '" + str + "' enforced."); printError("unknown language '" + str + "' enforced.");
return false; return false;
} }
} }
@ -530,12 +530,12 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::istringstream iss(14+argv[i]); std::istringstream iss(14+argv[i]);
if (!(iss >> mSettings->maxConfigs)) { if (!(iss >> mSettings->maxConfigs)) {
printMessage("cppcheck: argument to '--max-configs=' is not a number."); printError("argument to '--max-configs=' is not a number.");
return false; return false;
} }
if (mSettings->maxConfigs < 1) { if (mSettings->maxConfigs < 1) {
printMessage("cppcheck: argument to '--max-configs=' must be greater than 0."); printError("argument to '--max-configs=' must be greater than 0.");
return false; return false;
} }
@ -569,10 +569,10 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
else if (platform == "unspecified") else if (platform == "unspecified")
mSettings->platform(Settings::Unspecified); mSettings->platform(Settings::Unspecified);
else if (!mSettings->loadPlatformFile(argv[0], platform)) { else if (!mSettings->loadPlatformFile(argv[0], platform)) {
std::string message("cppcheck: error: unrecognized platform: \""); std::string message("unrecognized platform: \"");
message += platform; message += platform;
message += "\"."; message += "\".";
printMessage(message); printError(message);
return false; return false;
} }
} }
@ -587,10 +587,10 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
const std::string plistOutput = Path::toNativeSeparators(mSettings->plistOutput); const std::string plistOutput = Path::toNativeSeparators(mSettings->plistOutput);
if (!FileLister::isDirectory(plistOutput)) { if (!FileLister::isDirectory(plistOutput)) {
std::string message("cppcheck: error: plist folder does not exist: \""); std::string message("plist folder does not exist: \"");
message += plistOutput; message += plistOutput;
message += "\"."; message += "\".";
printMessage(message); printError(message);
return false; return false;
} }
} }
@ -626,10 +626,10 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
else if (platform == "unspecified" || platform == "Unspecified" || platform == "") else if (platform == "unspecified" || platform == "Unspecified" || platform == "")
; ;
else if (!mSettings->loadPlatformFile(projectFile.c_str(), platform) && !mSettings->loadPlatformFile(argv[0], platform)) { else if (!mSettings->loadPlatformFile(projectFile.c_str(), platform) && !mSettings->loadPlatformFile(argv[0], platform)) {
std::string message("cppcheck: error: unrecognized platform: \""); std::string message("unrecognized platform: \"");
message += platform; message += platform;
message += "\"."; message += "\".";
printMessage(message); printError(message);
return false; return false;
} }
@ -641,16 +641,16 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
mSettings->project.selectOneVsConfig(mSettings->platformType); mSettings->project.selectOneVsConfig(mSettings->platformType);
if (!CppCheckExecutor::tryLoadLibrary(mSettings->library, argv[0], "windows.cfg")) { if (!CppCheckExecutor::tryLoadLibrary(mSettings->library, argv[0], "windows.cfg")) {
// This shouldn't happen normally. // This shouldn't happen normally.
printMessage("cppcheck: Failed to load 'windows.cfg'. Your Cppcheck installation is broken. Please re-install."); printError("failed to load 'windows.cfg'. Your Cppcheck installation is broken. Please re-install.");
return false; return false;
} }
} }
if (projType == ImportProject::Type::MISSING) { if (projType == ImportProject::Type::MISSING) {
printMessage("cppcheck: Failed to open project '" + projectFile + "'."); printError("failed to open project '" + projectFile + "'.");
return false; return false;
} }
if (projType == ImportProject::Type::UNKNOWN) { if (projType == ImportProject::Type::UNKNOWN) {
printMessage("cppcheck: Failed to load project '" + projectFile + "'. The format is unknown."); printError("failed to load project '" + projectFile + "'. The format is unknown.");
return false; return false;
} }
} }
@ -683,7 +683,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
paths.erase(0, pos + 1); paths.erase(0, pos + 1);
} }
} else { } else {
printMessage("cppcheck: No paths specified for the '" + std::string(argv[i]) + "' option."); printError("no paths specified for the '" + std::string(argv[i]) + "' option.");
return false; return false;
} }
} }
@ -737,7 +737,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
mSettings->rules.emplace_back(rule); mSettings->rules.emplace_back(rule);
} }
} else { } else {
printMessage("cppcheck: error: unable to load rule-file: " + std::string(12+argv[i])); printError("unable to load rule-file: " + std::string(12+argv[i]));
return false; return false;
} }
} }
@ -755,15 +755,13 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
else if (showtimeMode.empty()) else if (showtimeMode.empty())
mSettings->showtime = SHOWTIME_MODES::SHOWTIME_NONE; mSettings->showtime = SHOWTIME_MODES::SHOWTIME_NONE;
else { else {
printMessage("cppcheck: error: unrecognized showtime mode: \"" + showtimeMode + "\". Supported modes: file, summary, top5."); printError("unrecognized showtime mode: \"" + showtimeMode + "\". Supported modes: file, summary, top5.");
return false; return false;
} }
} }
// --std // --std
else if (std::strcmp(argv[i], "--std=posix") == 0) { else if (std::strcmp(argv[i], "--std=c89") == 0) {
printMessage("cppcheck: Option --std=posix is deprecated and will be removed in 2.05.");
} else if (std::strcmp(argv[i], "--std=c89") == 0) {
mSettings->standards.c = Standards::C89; mSettings->standards.c = Standards::C89;
} else if (std::strcmp(argv[i], "--std=c99") == 0) { } else if (std::strcmp(argv[i], "--std=c99") == 0) {
mSettings->standards.c = Standards::C99; mSettings->standards.c = Standards::C99;
@ -785,7 +783,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
const std::string suppression = argv[i]+11; const std::string suppression = argv[i]+11;
const std::string errmsg(mSettings->nomsg.addSuppressionLine(suppression)); const std::string errmsg(mSettings->nomsg.addSuppressionLine(suppression));
if (!errmsg.empty()) { if (!errmsg.empty()) {
printMessage(errmsg); printError(errmsg);
return false; return false;
} }
} }
@ -795,7 +793,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::string filename = argv[i]+20; std::string filename = argv[i]+20;
std::ifstream f(filename); std::ifstream f(filename);
if (!f.is_open()) { if (!f.is_open()) {
std::string message("cppcheck: Couldn't open the file: \""); std::string message("couldn't open the file: \"");
message += filename; message += filename;
message += "\"."; message += "\".";
if (std::count(filename.begin(), filename.end(), ',') > 0 || if (std::count(filename.begin(), filename.end(), ',') > 0 ||
@ -807,12 +805,12 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
message += "\n cppcheck --suppressions-list=a.txt --suppressions-list=b.txt file.cpp"; message += "\n cppcheck --suppressions-list=a.txt --suppressions-list=b.txt file.cpp";
} }
printMessage(message); printError(message);
return false; return false;
} }
const std::string errmsg(mSettings->nomsg.parseFile(f)); const std::string errmsg(mSettings->nomsg.parseFile(f));
if (!errmsg.empty()) { if (!errmsg.empty()) {
printMessage(errmsg); printError(errmsg);
return false; return false;
} }
} }
@ -821,7 +819,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
const char * filename = argv[i] + 15; const char * filename = argv[i] + 15;
const std::string errmsg(mSettings->nomsg.parseXmlFile(filename)); const std::string errmsg(mSettings->nomsg.parseXmlFile(filename));
if (!errmsg.empty()) { if (!errmsg.empty()) {
printMessage(errmsg); printError(errmsg);
return false; return false;
} }
} }
@ -836,7 +834,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
++i; ++i;
mSettings->templateFormat = argv[i]; mSettings->templateFormat = argv[i];
} else { } else {
printMessage("cppcheck: argument to '--template' is missing."); printError("argument to '--template' is missing.");
return false; return false;
} }
@ -869,7 +867,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
++i; ++i;
mSettings->templateLocation = argv[i]; mSettings->templateLocation = argv[i];
} else { } else {
printMessage("cppcheck: argument to '--template' is missing."); printError("argument to '--template' is missing.");
return false; return false;
} }
} }
@ -893,13 +891,13 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
std::istringstream iss(numberString); std::istringstream iss(numberString);
if (!(iss >> mSettings->xml_version)) { if (!(iss >> mSettings->xml_version)) {
printMessage("cppcheck: argument to '--xml-version' is not a number."); printError("argument to '--xml-version' is not a number.");
return false; return false;
} }
if (mSettings->xml_version != 2) { if (mSettings->xml_version != 2) {
// We only have xml version 2 // We only have xml version 2
printMessage("cppcheck: '--xml-version' can only be 2."); printError("'--xml-version' can only be 2.");
return false; return false;
} }
@ -908,10 +906,10 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
} }
else { else {
std::string message("cppcheck: error: unrecognized command line option: \""); std::string message("unrecognized command line option: \"");
message += argv[i]; message += argv[i];
message += "\"."; message += "\".";
printMessage(message); printError(message);
return false; return false;
} }
} }
@ -940,7 +938,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
mSettings->maxConfigs = 1U; mSettings->maxConfigs = 1U;
if (mSettings->checks.isEnabled(Checks::unusedFunction) && mSettings->jobs > 1) { if (mSettings->checks.isEnabled(Checks::unusedFunction) && mSettings->jobs > 1) {
printMessage("cppcheck: unusedFunction check can't be used with '-j' option. Disabling unusedFunction check."); printMessage("unusedFunction check can't be used with '-j' option. Disabling unusedFunction check.");
} }
if (argc <= 1) { if (argc <= 1) {
@ -955,7 +953,7 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
// Print error only if we have "real" command and expect files // Print error only if we have "real" command and expect files
if (!mExitAfterPrint && mPathNames.empty() && mSettings->project.fileSettings.empty()) { if (!mExitAfterPrint && mPathNames.empty() && mSettings->project.fileSettings.empty()) {
printMessage("cppcheck: No C or C++ source files found."); printError("no C or C++ source files found.");
return false; return false;
} }

8
cli/cmdlineparser.h
View File

@ -101,10 +101,14 @@ protected:
static void printHelp(); static void printHelp();
/** /**
* Print message (to console?). * Print message (to stdout).
*/ */
static void printMessage(const std::string &message); static void printMessage(const std::string &message);
static void printMessage(const char* message);
/**
* Print error message (to stdout).
*/
static void printError(const std::string &message);
private: private:
std::vector<std::string> mPathNames; std::vector<std::string> mPathNames;

4
lib/settings.cpp
View File

@ -109,7 +109,7 @@ std::string Settings::addEnabled(const std::string &str)
std::string::size_type pos = 0; std::string::size_type pos = 0;
while ((pos = str.find(',', pos)) != std::string::npos) { while ((pos = str.find(',', pos)) != std::string::npos) {
if (pos == prevPos) if (pos == prevPos)
return std::string("cppcheck: --enable parameter is empty"); return std::string("--enable parameter is empty");
const std::string errmsg(addEnabled(str.substr(prevPos, pos - prevPos))); const std::string errmsg(addEnabled(str.substr(prevPos, pos - prevPos)));
if (!errmsg.empty()) if (!errmsg.empty())
return errmsg; return errmsg;
@ -117,7 +117,7 @@ std::string Settings::addEnabled(const std::string &str)
prevPos = pos; prevPos = pos;
} }
if (prevPos >= str.length()) if (prevPos >= str.length())
return std::string("cppcheck: --enable parameter is empty"); return std::string("--enable parameter is empty");
return addEnabled(str.substr(prevPos)); return addEnabled(str.substr(prevPos));
} }

2
test/cli/test-helloworld.py
View File

@ -175,6 +175,6 @@ def test_exclude():
prjpath = getRelativeProjectPath() prjpath = getRelativeProjectPath()
ret, stdout, _ = cppcheck(['-i' + prjpath, '--platform=win64', '--project=' + os.path.join(prjpath, 'helloworld.cppcheck')]) ret, stdout, _ = cppcheck(['-i' + prjpath, '--platform=win64', '--project=' + os.path.join(prjpath, 'helloworld.cppcheck')])
assert ret == 1 assert ret == 1
assert stdout == 'cppcheck: No C or C++ source files found.\n' assert stdout == 'cppcheck: error: no C or C++ source files found.\n'