refs #13532 - reworked --debug* output [skip ci]

Author: firewave

cli/cmdlineparser.cpp

@@ -614,6 +614,9 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
                 mSettings.cppHeaderProbe = true;
             }
 
+            else if (std::strcmp(argv[i], "--debug-ast") == 0)
+                mSettings.debugsymdb = true;
+
             // Show debug warnings for lookup for configuration files
             else if (std::strcmp(argv[i], "--debug-clang-output") == 0)
                 mSettings.debugClangOutput = true;
@@ -650,6 +653,9 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
             else if (std::strcmp(argv[i], "--debug-simplified") == 0)
                 mSettings.debugSimplified = true;
 
+            else if (std::strcmp(argv[i], "--debug-symdb") == 0)
+                mSettings.debugsymdb = true;
+
             // Show template information
             else if (std::strcmp(argv[i], "--debug-template") == 0)
                 mSettings.debugtemplate = true;

lib/cppcheck.cpp

@@ -722,8 +722,7 @@ unsigned int CppCheck::checkClang(const FileWithDetails &file)
                              mErrorLogger,
                              mSettings,
                              &s_timerResults);
-        if (mSettings.debugnormal)
-            tokenizer.printDebugOutput(1, std::cout);
+        tokenizer.printDebugOutput(1, std::cout);
         checkNormalTokens(tokenizer, nullptr); // TODO: provide analyzer information
 
         // create dumpfile

lib/settings.h

@@ -182,6 +182,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
     /** @brief Are we running from DACA script? */
     bool daca{};
 
+    /** @brief Is --debug-ast given? */
+    bool debugast{};
+
     /** @brief Is --debug-clang-output given? */
     bool debugClangOutput{};
 
@@ -206,6 +209,9 @@ class CPPCHECKLIB WARN_UNUSED Settings {
     /** @brief Is --debug-simplified given? */
     bool debugSimplified{};
 
+    /** @brief Is --debug-symdb given? */
+    bool debugsymdb{};
+
     /** @brief Is --debug-template given? */
     bool debugtemplate{};
 

lib/tokenize.cpp

@@ -3490,6 +3490,8 @@ bool Tokenizer::simplifyTokens1(const std::string &configuration)
         mSymbolDatabase->setArrayDimensionsUsingValueFlow();
     }
 
+    validateTypes();
+
     printDebugOutput(1, std::cout);
 
     return true;
@@ -5924,52 +5926,58 @@ bool Tokenizer::simplifyTokenList1(const char FileName[])
 }
 //---------------------------------------------------------------------------
 
-void Tokenizer::printDebugOutput(int simplification, std::ostream &out) const
+void Tokenizer::printDebugOutput(bool simplified, std::ostream &out) const
 {
-    const bool debug = (simplification != 1U && mSettings.debugSimplified) ||
-                       (simplification != 2U && mSettings.debugnormal);
+    const bool debug = (simplified && (mSettings.debugSimplified||mSettings.debugast||mSettings.debugsymdb)) ||
+                       (!simplified && (mSettings.debugnormal||mSettings.debugast||mSettings.debugsymdb));
 
     if (debug && list.front()) {
-        list.front()->printOut(out, nullptr, list.getFiles());
+        if (mSettings.debugSimplified || mSettings.debugnormal)
+            list.front()->printOut(out, nullptr, list.getFiles());
 
         if (mSettings.xml)
             out << "<debug>" << std::endl;
 
         if (mSymbolDatabase) {
             if (mSettings.xml)
                 mSymbolDatabase->printXml(out);
-            else if (mSettings.verbose) {
+            else if (mSettings.debugsymdb) {
                 mSymbolDatabase->printOut("Symbol database");
             }
         }
 
-        if (mSettings.verbose)
-            list.front()->printAst(mSettings.verbose, mSettings.xml, list.getFiles(), out);
+        if (mSettings.xml || mSettings.debugast)
+            list.front()->printAst(mSettings.verbose, mSettings.xml, list.getFiles(), out); // TODO: do not depend on --verbose
 
+        // TODO: add option
         list.front()->printValueFlow(mSettings.xml, out);
 
         if (mSettings.xml)
             out << "</debug>" << std::endl;
     }
+}
 
-    if (mSymbolDatabase && simplification == 2U && mSettings.debugwarnings) {
-        printUnknownTypes();
+void Tokenizer::validateTypes() const
+{
+    if (!mSymbolDatabase || !mSettings.debugwarnings)
+        return;
 
-        // the typeStartToken() should come before typeEndToken()
-        for (const Variable *var : mSymbolDatabase->variableList()) {
-            if (!var)
-                continue;
+    printUnknownTypes();
 
-            const Token * typetok = var->typeStartToken();
-            while (typetok && typetok != var->typeEndToken())
-                typetok = typetok->next();
+    // the typeStartToken() should come before typeEndToken()
+    for (const Variable *var : mSymbolDatabase->variableList()) {
+        if (!var)
+            continue;
 
-            if (typetok != var->typeEndToken()) {
-                reportError(var->typeStartToken(),
-                            Severity::debug,
-                            "debug",
-                            "Variable::typeStartToken() of variable '" + var->name() + "' is not located before Variable::typeEndToken(). The location of the typeStartToken() is '" + var->typeStartToken()->str() + "' at line " + std::to_string(var->typeStartToken()->linenr()));
-            }
+        const Token * typetok = var->typeStartToken();
+        while (typetok && typetok != var->typeEndToken())
+            typetok = typetok->next();
+
+        if (typetok != var->typeEndToken()) {
+            reportError(var->typeStartToken(),
+                        Severity::debug,
+                        "debug",
+                        "Variable::typeStartToken() of variable '" + var->name() + "' is not located before Variable::typeEndToken(). The location of the typeStartToken() is '" + var->typeStartToken()->str() + "' at line " + std::to_string(var->typeStartToken()->linenr()));
         }
     }
 }

lib/tokenize.h

@@ -564,18 +564,17 @@ class CPPCHECKLIB Tokenizer {
 
     static bool operatorEnd(const Token * tok);
 
+    void validateTypes() const;
+
 public:
     const SymbolDatabase *getSymbolDatabase() const {
         return mSymbolDatabase;
     }
     void createSymbolDatabase();
 
     /** print --debug output if debug flags match the simplification:
-     * 0=unknown/both simplifications
-     * 1=1st simplifications
-     * 2=2nd simplifications
      */
-    void printDebugOutput(int simplification, std::ostream &out) const;
+    void printDebugOutput(int simplified, std::ostream &out) const;
 
     void dump(std::ostream &out) const;
 

test/cli/clang-import_test.py

@@ -47,8 +47,8 @@ def __check_symbol_database(tmpdir, code):
     testfile = os.path.join(tmpdir, 'test.cpp')
     with open(testfile, 'w+t') as f:
         f.write(code)
-    ret1, stdout1, _ = cppcheck(['--clang', '--debug', '-v', testfile])
-    ret2, stdout2, _ = cppcheck(['--debug', '-v', testfile])
+    ret1, stdout1, _ = cppcheck(['--clang', '--debug-symdb', testfile])
+    ret2, stdout2, _ = cppcheck(['--debug-symdb', testfile])
     assert 0 == ret1, stdout1
     assert 0 == ret2, stdout2
     assert __get_debug_section('### Symbol database', stdout1) == __get_debug_section('### Symbol database', stdout2)
@@ -58,8 +58,8 @@ def __check_ast(tmpdir, code):
     testfile = os.path.join(tmpdir, 'test.cpp')
     with open(testfile, 'w+t') as f:
         f.write(code)
-    ret1, stdout1, _ = cppcheck(['--clang', '--debug', '-v', testfile])
-    ret2, stdout2, _ = cppcheck(['--debug', '-v', testfile])
+    ret1, stdout1, _ = cppcheck(['--clang', '--debug-ast', testfile])
+    ret2, stdout2, _ = cppcheck(['--debug-ast', testfile])
     assert 0 == ret1, stdout1
     assert 0 == ret2, stdout1
     assert __get_debug_section('##AST', stdout1) == __get_debug_section('##AST', stdout2)

test/cli/other_test.py

@@ -2869,3 +2869,118 @@ def test_ctu_builddir(tmp_path):  # #11883
     assert stderr.splitlines() == [
         '{}:2:19: error: Null pointer dereference: p [ctunullpointer]'.format(test_file)
     ]
+
+
+# TODO: test with --xml
+
+def test_debug_normal(tmp_path):
+    test_file = tmp_path / 'test.c'
+    with open(test_file, "w") as f:
+        f.write(
+            """
+    void f
+    {
+        (void)*((int*)0);
+    }
+    """)
+
+    args = [
+        '--debug-normal',
+        str(test_file)
+    ]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    assert stdout.find('##file ') != -1
+    assert stdout.find('##Value flow') != -1
+    assert stderr.splitlines() == []
+
+
+# TODO: simplification = 2
+def test_debug_simplified(tmp_path):
+    test_file = tmp_path / 'test.c'
+    with open(test_file, "w") as f:
+        f.write(
+            """
+    void f
+    {
+        (void)*((int*)0);
+    }
+    """)
+
+    args = [
+        '--debug-simplified',
+        str(test_file)
+    ]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    assert stdout.find('##file ') != -1
+    assert stderr.splitlines() == []
+
+
+def test_debug_symdb(tmp_path):
+    test_file = tmp_path / 'test.c'
+    with open(test_file, "w") as f:
+        f.write(
+            """
+    void f
+    {
+        (void)*((int*)0);
+    }
+    """)
+
+    args = [
+        '--debug-simplified',
+        str(test_file)
+    ]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    assert stdout.find('### Symbol database ###') != -1
+    assert stderr.splitlines() == []
+
+
+def test_debug_ast(tmp_path):
+    test_file = tmp_path / 'test.c'
+    with open(test_file, "w") as f:
+        f.write(
+            """
+    void f
+    {
+        (void)*((int*)0);
+    }
+    """)
+
+    args = [
+        '--debug-ast',
+        str(test_file)
+    ]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    assert stdout == ''
+    assert stderr.splitlines() == []
+
+
+@pytest.mark.skip
+def test_debug_valueflow(tmp_path):
+    test_file = tmp_path / 'test.c'
+    with open(test_file, "w") as f:
+        f.write(
+            """
+    void f
+    {
+        (void)*((int*)0);
+    }
+    """)
+
+    args = [
+        '--debug-valueflow',
+        str(test_file)
+    ]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    assert stdout.find('##Value flow') != -1
+    assert stderr.splitlines() == []

test/testcmdlineparser.cpp

@@ -423,6 +423,8 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(maxTemplateRecursionMissingCount);
         TEST_CASE(emitDuplicates);
         TEST_CASE(debugClangOutput);
+        TEST_CASE(debugSymdb);
+        TEST_CASE(debugAst);
 
         TEST_CASE(ignorepaths1);
         TEST_CASE(ignorepaths2);
@@ -2925,6 +2927,20 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS(true, settings->debugClangOutput);
     }
 
+    void debugSymdb() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--debug-symdb", "file.cpp"};
+        ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parser->parseFromArgs(3, argv));
+        ASSERT_EQUALS(true, settings->debugsymdb);
+    }
+
+    void debugAst() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--debug-ast", "file.cpp"};
+        ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parser->parseFromArgs(3, argv));
+        ASSERT_EQUALS(true, settings->debugast);
+    }
+
     void ignorepaths1() {
         REDIRECT;
         const char * const argv[] = {"cppcheck", "-isrc", "file.cpp"};