Skip to content

fixed #13618 - cleaned up --debug meaning and dependencies #7592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

fixed #13618 - cleaned up --debug meaning and dependencies #7592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
169bc78
moved some `--debug --verbose` logic out of `Tokenizer`
firewave Jun 13, 2025
cdbea28
always print verbose AST with `--debug-ast`
firewave Jun 13, 2025
e18dd0b
token.h: avoid `unusedFunction` selfcheck warning [skip ci]
firewave Jun 13, 2025
7ced203
s [skip ci]
firewave Jun 13, 2025
036e529
s [skip ci]
firewave Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions cli/cmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a

bool def = false;
bool maxconfigs = false;
bool debug = false;

ImportProject::Type projectType = ImportProject::Type::NONE;
ImportProject project;
Expand Down Expand Up @@ -651,6 +652,9 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
mSettings.cppHeaderProbe = true;
}

else if (std::strcmp(argv[i], "--debug") == 0)
debug = true;

else if (std::strcmp(argv[i], "--debug-ast") == 0)
mSettings.debugast = true;

Expand All @@ -663,8 +667,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
mSettings.debugignore = true;

// Show --debug output after the first simplifications
else if (std::strcmp(argv[i], "--debug") == 0 ||
std::strcmp(argv[i], "--debug-normal") == 0)
else if (std::strcmp(argv[i], "--debug-normal") == 0)
mSettings.debugnormal = true;

// Show debug warnings for lookup for configuration files
Expand Down Expand Up @@ -1610,10 +1613,18 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a

if (mSettings.force)
mSettings.maxConfigs = INT_MAX;

else if ((def || mSettings.preprocessOnly) && !maxconfigs)
mSettings.maxConfigs = 1U;

if (debug) {
mSettings.debugnormal = true;
mSettings.debugvalueflow = true;
if (mSettings.verbose) {
mSettings.debugast = true;
mSettings.debugsymdb = true;
}
}

if (mSettings.jobs > 1 && mSettings.buildDir.empty()) {
// TODO: bail out instead?
if (mSettings.checks.isEnabled(Checks::unusedFunction))
Expand Down
6 changes: 2 additions & 4 deletions lib/token.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1655,7 +1655,7 @@ static void astStringXml(const Token *tok, nonneg int indent, std::ostream &out)
}
}

void Token::printAst(bool verbose, bool xml, const std::vector<std::string> &fileNames, std::ostream &out) const
void Token::printAst(bool xml, const std::vector<std::string> &fileNames, std::ostream &out) const
{
if (!xml)
out << "\n\n##AST" << std::endl;
Expand All @@ -1672,10 +1672,8 @@ void Token::printAst(bool verbose, bool xml, const std::vector<std::string> &fil
<< "\" column=\"" << tok->column() << "\">" << std::endl;
astStringXml(tok, 2U, out);
out << "</ast>" << std::endl;
} else if (verbose)
} else
out << "[" << fileNames[tok->fileIndex()] << ":" << tok->linenr() << "]" << std::endl << tok->astStringVerbose() << std::endl;
else
out << tok->astString(" ") << std::endl;
if (tok->str() == "(")
tok = tok->link();
}
Expand Down
3 changes: 2 additions & 1 deletion lib/token.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1544,6 +1544,7 @@ class CPPCHECKLIB Token {
mImpl->mValues = nullptr;
}

// cppcheck-suppress unusedFunction - used in tests only
std::string astString(const char *sep = "") const {
std::string ret;
if (mImpl->mAstOperand1)
Expand All @@ -1559,7 +1560,7 @@ class CPPCHECKLIB Token {

std::string expressionString() const;

void printAst(bool verbose, bool xml, const std::vector<std::string> &fileNames, std::ostream &out) const;
void printAst(bool xml, const std::vector<std::string> &fileNames, std::ostream &out) const;

void printValueFlow(const std::vector<std::string>& files, bool xml, std::ostream &out) const;

Expand Down
9 changes: 4 additions & 5 deletions lib/tokenize.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5938,7 +5938,6 @@ bool Tokenizer::simplifyTokenList1(const char FileName[])
}
//---------------------------------------------------------------------------

// TODO: do not depend on --verbose
void Tokenizer::printDebugOutput(std::ostream &out) const
{
if (!list.front())
Expand All @@ -5959,14 +5958,14 @@ void Tokenizer::printDebugOutput(std::ostream &out) const
if (mSymbolDatabase) {
if (xml)
mSymbolDatabase->printXml(out);
else if (mSettings.debugsymdb || (mSettings.debugnormal && mSettings.verbose))
else if (mSettings.debugsymdb)
mSymbolDatabase->printOut("Symbol database");
}

if (mSettings.debugast || (mSettings.debugnormal && mSettings.verbose))
list.front()->printAst(mSettings.verbose, xml, list.getFiles(), out);
if (mSettings.debugast)
list.front()->printAst(xml, list.getFiles(), out);

if (mSettings.debugnormal || mSettings.debugvalueflow)
if (mSettings.debugvalueflow)
list.front()->printValueFlow(list.getFiles(), xml, out);

if (xml)
Expand Down
1 change: 0 additions & 1 deletion test/cli/other_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3467,7 +3467,6 @@ def test_debug_ast(tmp_path):
__test_debug_ast(tmp_path, False)


@pytest.mark.xfail(strict=True) # TODO: remove dependency on --verbose
def test_debug_ast_verbose_nodiff(tmp_path):
# make sure --verbose does not change the output
assert __test_debug_ast(tmp_path, False) == __test_debug_ast(tmp_path, True)
Expand Down
32 changes: 32 additions & 0 deletions test/testcmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,9 @@ class TestCmdlineParser : public TestFixture {
TEST_CASE(debugSymdb);
TEST_CASE(debugAst);
TEST_CASE(debugValueflow);
TEST_CASE(debugNormal);
TEST_CASE(debug);
TEST_CASE(debugVerbose);

TEST_CASE(ignorepaths1);
TEST_CASE(ignorepaths2);
Expand Down Expand Up @@ -3173,6 +3176,35 @@ class TestCmdlineParser : public TestFixture {
ASSERT_EQUALS(true, settings->debugvalueflow);
}

void debugNormal() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--debug-normal", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS(true, settings->debugnormal);
}

void debug() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--debug", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS(true, settings->debugnormal);
ASSERT_EQUALS(true, settings->debugSimplified);
ASSERT_EQUALS(true, settings->debugvalueflow);
ASSERT_EQUALS(false, settings->debugast);
ASSERT_EQUALS(false, settings->debugsymdb);
}

void debugVerbose() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--debug", "--verbose", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS(true, settings->debugnormal);
ASSERT_EQUALS(true, settings->debugSimplified);
ASSERT_EQUALS(true, settings->debugvalueflow);
ASSERT_EQUALS(true, settings->debugast);
ASSERT_EQUALS(true, settings->debugsymdb);
}

void ignorepaths1() {
REDIRECT;
const char * const argv[] = {"cppcheck", "-isrc", "file.cpp"};
Expand Down