Skip to content

Commit 66c9938

Browse files
firewavefirewave
authored
refs #13532 - reworked --debug* options and output (danmar#7258)
1 parent 646b422 commit 66c9938

File tree

8 files changed

+365
-55
lines changed

8 files changed

+365
-55
lines changed

‎cli/cmdlineparser.cpp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,9 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
647647
mSettings.cppHeaderProbe = true;
648648
}
649649

650+
else if (std::strcmp(argv[i], "--debug-ast") == 0)
651+
mSettings.debugast = true;
652+
650653
// Show debug warnings for lookup for configuration files
651654
else if (std::strcmp(argv[i], "--debug-clang-output") == 0)
652655
mSettings.debugClangOutput = true;
@@ -687,10 +690,16 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
687690
else if (std::strcmp(argv[i], "--debug-simplified") == 0)
688691
mSettings.debugSimplified = true;
689692

693+
else if (std::strcmp(argv[i], "--debug-symdb") == 0)
694+
mSettings.debugsymdb = true;
695+
690696
// Show template information
691697
else if (std::strcmp(argv[i], "--debug-template") == 0)
692698
mSettings.debugtemplate = true;
693699

700+
else if (std::strcmp(argv[i], "--debug-valueflow") == 0)
701+
mSettings.debugvalueflow = true;
702+
694703
// Show debug warnings
695704
else if (std::strcmp(argv[i], "--debug-warnings") == 0)
696705
mSettings.debugwarnings = true;

‎lib/cppcheck.cpp‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -725,8 +725,7 @@ unsigned int CppCheck::checkClang(const FileWithDetails &file)
725725
mErrorLogger,
726726
mSettings,
727727
&s_timerResults);
728-
if (mSettings.debugnormal)
729-
tokenizer.printDebugOutput(1, std::cout);
728+
tokenizer.printDebugOutput(std::cout);
730729
checkNormalTokens(tokenizer, nullptr); // TODO: provide analyzer information
731730

732731
// create dumpfile

‎lib/settings.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
188188
/** @brief Are we running from DACA script? */
189189
bool daca{};
190190

191+
/** @brief Is --debug-ast given? */
192+
bool debugast{};
193+
191194
/** @brief Is --debug-clang-output given? */
192195
bool debugClangOutput{};
193196

@@ -215,9 +218,15 @@ class CPPCHECKLIB WARN_UNUSED Settings {
215218
/** @brief Is --debug-simplified given? */
216219
bool debugSimplified{};
217220

221+
/** @brief Is --debug-symdb given? */
222+
bool debugsymdb{};
223+
218224
/** @brief Is --debug-template given? */
219225
bool debugtemplate{};
220226

227+
/** @brief Is --debug-valueflow given? */
228+
bool debugvalueflow{};
229+
221230
/** @brief Is --debug-warnings given? */
222231
bool debugwarnings{};
223232

‎lib/tokenize.cpp‎

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3441,7 +3441,7 @@ bool Tokenizer::simplifyTokens1(const std::string &configuration)
34413441
mSymbolDatabase->setArrayDimensionsUsingValueFlow();
34423442
}
34433443

3444-
printDebugOutput(1, std::cout);
3444+
printDebugOutput(std::cout);
34453445

34463446
return true;
34473447
}
@@ -5890,39 +5890,39 @@ bool Tokenizer::simplifyTokenList1(const char FileName[])
58905890
}
58915891
//---------------------------------------------------------------------------
58925892

5893-
void Tokenizer::printDebugOutput(int simplification, std::ostream &out) const
5893+
// TODO: do not depend on --verbose
5894+
void Tokenizer::printDebugOutput(std::ostream &out) const
58945895
{
5895-
const bool debug = (simplification != 1U && mSettings.debugSimplified) ||
5896-
(simplification != 2U && mSettings.debugnormal);
5896+
if (!list.front())
5897+
return;
58975898

5898-
if (debug && list.front()) {
5899-
const bool xml = (mSettings.outputFormat == Settings::OutputFormat::xml);
5899+
const bool debug = mSettings.debugSimplified || mSettings.debugnormal || mSettings.debugsymdb || mSettings.debugast || mSettings.debugvalueflow;
5900+
if (!debug)
5901+
return;
59005902

5901-
if (!xml)
5902-
list.front()->printOut(out, xml, nullptr, list.getFiles());
5903+
const bool xml = (mSettings.outputFormat == Settings::OutputFormat::xml);
59035904

5904-
if (xml)
5905-
{
5906-
out << "<debug>" << std::endl;
5907-
list.front()->printOut(out, xml, nullptr, list.getFiles());
5908-
}
5905+
if (xml)
5906+
out << "<debug>" << std::endl;
59095907

5910-
if (mSymbolDatabase) {
5911-
if (xml)
5912-
mSymbolDatabase->printXml(out);
5913-
else if (mSettings.verbose) {
5914-
mSymbolDatabase->printOut("Symbol database");
5915-
}
5916-
}
5908+
if (mSettings.debugSimplified || mSettings.debugnormal)
5909+
list.front()->printOut(out, xml, nullptr, list.getFiles());
5910+
5911+
if (mSymbolDatabase) {
5912+
if (xml)
5913+
mSymbolDatabase->printXml(out);
5914+
else if (mSettings.debugsymdb || (mSettings.debugnormal && mSettings.verbose))
5915+
mSymbolDatabase->printOut("Symbol database");
5916+
}
59175917

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

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

5923-
if (xml)
5924-
out << "</debug>" << std::endl;
5925-
}
5924+
if (xml)
5925+
out << "</debug>" << std::endl;
59265926
}
59275927

59285928
void Tokenizer::dump(std::ostream &out) const
@@ -8077,27 +8077,31 @@ bool Tokenizer::isScopeNoReturn(const Token *endScopeToken, bool *unknown) const
80778077

80788078
void Tokenizer::syntaxError(const Token *tok, const std::string &code) const
80798079
{
8080-
printDebugOutput(0, std::cout);
8080+
if (mSettings.debugSimplified || mSettings.debugnormal)
8081+
printDebugOutput(std::cout);
80818082
throw InternalError(tok, code.empty() ? "syntax error" : "syntax error: " + code, InternalError::SYNTAX);
80828083
}
80838084

80848085
void Tokenizer::unmatchedToken(const Token *tok) const
80858086
{
8086-
printDebugOutput(0, std::cout);
8087+
if (mSettings.debugSimplified || mSettings.debugnormal)
8088+
printDebugOutput(std::cout);
80878089
throw InternalError(tok,
80888090
"Unmatched '" + tok->str() + "'. Configuration: '" + mConfiguration + "'.",
80898091
InternalError::SYNTAX);
80908092
}
80918093

80928094
void Tokenizer::syntaxErrorC(const Token *tok, const std::string &what) const
80938095
{
8094-
printDebugOutput(0, std::cout);
8096+
if (mSettings.debugSimplified || mSettings.debugnormal)
8097+
printDebugOutput(std::cout);
80958098
throw InternalError(tok, "Code '"+what+"' is invalid C code.", "Use --std, -x or --language to enforce C++. Or --cpp-header-probe to identify C++ headers via the Emacs marker.", InternalError::SYNTAX);
80968099
}
80978100

80988101
void Tokenizer::unknownMacroError(const Token *tok1) const
80998102
{
8100-
printDebugOutput(0, std::cout);
8103+
if (mSettings.debugSimplified || mSettings.debugnormal)
8104+
printDebugOutput(std::cout);
81018105
throw InternalError(tok1, "There is an unknown macro here somewhere. Configuration is required. If " + tok1->str() + " is a macro then please configure it.", InternalError::UNKNOWN_MACRO);
81028106
}
81038107

@@ -8131,7 +8135,7 @@ void Tokenizer::invalidConstFunctionTypeError(const Token *tok) const
81318135

81328136
void Tokenizer::cppcheckError(const Token *tok) const
81338137
{
8134-
printDebugOutput(0, std::cout);
8138+
printDebugOutput(std::cout);
81358139
throw InternalError(tok, "Analysis failed. If the code is valid then please report this failure.", InternalError::INTERNAL);
81368140
}
81378141

‎lib/tokenize.h‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -558,11 +558,8 @@ class CPPCHECKLIB Tokenizer {
558558
void createSymbolDatabase();
559559

560560
/** print --debug output if debug flags match the simplification:
561-
* 0=unknown/both simplifications
562-
* 1=1st simplifications
563-
* 2=2nd simplifications
564561
*/
565-
void printDebugOutput(int simplification, std::ostream &out) const;
562+
void printDebugOutput(std::ostream &out) const;
566563

567564
void dump(std::ostream &out) const;
568565

‎test/cli/clang-import_test.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ def __check_symbol_database(tmpdir, code):
4747
testfile = os.path.join(tmpdir, 'test.cpp')
4848
with open(testfile, 'w+t') as f:
4949
f.write(code)
50-
ret1, stdout1, _ = cppcheck(['--clang', '--debug', '-v', testfile])
51-
ret2, stdout2, _ = cppcheck(['--debug', '-v', testfile])
50+
ret1, stdout1, _ = cppcheck(['--clang', '--debug-symdb', testfile])
51+
ret2, stdout2, _ = cppcheck(['--debug-symdb', testfile])
5252
assert 0 == ret1, stdout1
5353
assert 0 == ret2, stdout2
5454
assert __get_debug_section('### Symbol database', stdout1) == __get_debug_section('### Symbol database', stdout2)
@@ -58,8 +58,8 @@ def __check_ast(tmpdir, code):
5858
testfile = os.path.join(tmpdir, 'test.cpp')
5959
with open(testfile, 'w+t') as f:
6060
f.write(code)
61-
ret1, stdout1, _ = cppcheck(['--clang', '--debug', '-v', testfile])
62-
ret2, stdout2, _ = cppcheck(['--debug', '-v', testfile])
61+
ret1, stdout1, _ = cppcheck(['--clang', '--debug-ast', testfile])
62+
ret2, stdout2, _ = cppcheck(['--debug-ast', testfile])
6363
assert 0 == ret1, stdout1
6464
assert 0 == ret2, stdout1
6565
assert __get_debug_section('##AST', stdout1) == __get_debug_section('##AST', stdout2)

0 commit comments

Comments
 (0)