Fix #13952 (dumpfile: the action and yield for container methods) (cppcheck-opensource#7609)

Author: danmar

lib/library.cpp

@@ -310,6 +310,66 @@ Library::Container::Action Library::Container::actionFrom(const std::string& act
     return Container::Action::NO_ACTION;
 }
 
+std::string Library::Container::toString(Library::Container::Yield yield)
+{
+    switch (yield) {
+    case Library::Container::Yield::AT_INDEX:
+        return "at_index";
+    case Library::Container::Yield::ITEM:
+        return "item";
+    case Library::Container::Yield::BUFFER:
+        return "buffer";
+    case Library::Container::Yield::BUFFER_NT:
+        return "buffer-nt";
+    case Library::Container::Yield::START_ITERATOR:
+        return "start-iterator";
+    case Library::Container::Yield::END_ITERATOR:
+        return "end-iterator";
+    case Library::Container::Yield::ITERATOR:
+        return "iterator";
+    case Library::Container::Yield::SIZE:
+        return "size";
+    case Library::Container::Yield::EMPTY:
+        return "empty";
+    case Library::Container::Yield::NO_YIELD:
+        break;
+    }
+    return "";
+}
+
+std::string Library::Container::toString(Library::Container::Action action)
+{
+    switch (action) {
+    case Library::Container::Action::RESIZE:
+        return "resize";
+    case Library::Container::Action::CLEAR:
+        return "clear";
+    case Library::Container::Action::PUSH:
+        return "push";
+    case Library::Container::Action::POP:
+        return "pop";
+    case Library::Container::Action::FIND:
+        return "find";
+    case Library::Container::Action::FIND_CONST:
+        return "find-const";
+    case Library::Container::Action::INSERT:
+        return "insert";
+    case Library::Container::Action::ERASE:
+        return "erase";
+    case Library::Container::Action::APPEND:
+        return "append";
+    case Library::Container::Action::CHANGE_CONTENT:
+        return "change-content";
+    case Library::Container::Action::CHANGE:
+        return "change";
+    case Library::Container::Action::CHANGE_INTERNAL:
+        return "change-internal";
+    case Library::Container::Action::NO_ACTION:
+        break;
+    }
+    return "";
+}
+
 Library::Error Library::load(const tinyxml2::XMLDocument &doc)
 {
     const tinyxml2::XMLElement * const rootnode = doc.FirstChildElement();

lib/library.h

@@ -259,8 +259,10 @@ class CPPCHECKLIB Library {
             return (i != functions.end()) ? i->second.returnType : mEmptyString;
         }
 
-        static Yield yieldFrom(const std::string& yieldName);
-        static Action actionFrom(const std::string& actionName);
+        CPPCHECKLIB static Yield yieldFrom(const std::string& yieldName);
+        CPPCHECKLIB static Action actionFrom(const std::string& actionName);
+        CPPCHECKLIB static std::string toString(Yield yield);
+        CPPCHECKLIB static std::string toString(Action action);
     };
     const std::unordered_map<std::string, Container>& containers() const;
     const Container* detectContainer(const Token* typeStart) const;

lib/tokenize.cpp

@@ -6202,8 +6202,23 @@ void Tokenizer::dump(std::ostream &out) const
             outs += "\" ";
             outs += "std-string-like=\"";
             outs += bool_to_string(c->stdStringLike);
-            outs += "\"/>";
-            outs += '\n';
+            outs += "\"";
+            if (c->functions.empty()) {
+                outs += "/>\n";
+                continue;
+            }
+            outs += ">\n";
+            for (const auto& fp: c->functions) {
+                std::string action;
+                std::string yield;
+                if (fp.second.action != Library::Container::Action::NO_ACTION)
+                    action = " action=\"" + Library::Container::toString(fp.second.action) + "\"";
+                if (fp.second.yield != Library::Container::Yield::NO_YIELD)
+                    yield = " yield=\"" + Library::Container::toString(fp.second.yield) + "\"";
+                if (!action.empty() || !yield.empty())
+                    outs += "      <f name=\"" + fp.first + "\"" + action + yield + "/>\n";
+            }
+            outs += "    </container>\n";
         }
         outs += "  </containers>";
         outs += '\n';

test/cli/dumpfile_test.py

@@ -119,3 +119,16 @@ def test_duplicate_file_entries(tmpdir):  #13333
     assert os.path.isfile(test_file + '.dump')
     assert os.path.isfile(test_file + '.1.dump')
 
+
+def test_container_methods(tmpdir):
+    test_file = str(tmpdir / 'test.cpp')
+    with open(test_file, 'wt') as f:
+        f.write('std::string s;\n')
+
+    exitcode, _, stderr = cppcheck(['--dump', '.'], cwd=str(tmpdir))
+    assert exitcode == 0, stderr
+
+    dumpfile = test_file + '.dump'
+    with open(dumpfile, 'rt') as f:
+        dump = f.read()
+    assert '<f name="emplace" action="push" yield="iterator"/>' in dump

test/testlibrary.cpp

@@ -64,6 +64,8 @@ class TestLibrary : public TestFixture {
         TEST_CASE(resource);
         TEST_CASE(podtype);
         TEST_CASE(container);
+        TEST_CASE(containerActionToFromString);
+        TEST_CASE(containerYieldToFromString);
         TEST_CASE(version);
         TEST_CASE(loadLibErrors);
         TEST_CASE(loadLibCombinations);
@@ -1036,6 +1038,22 @@ class TestLibrary : public TestFixture {
         }
     }
 
+    void containerActionToFromString() const {
+        for (uint16_t i = 0; i < static_cast<uint16_t>(Library::Container::Action::NO_ACTION); ++i) {
+            const auto a = static_cast<Library::Container::Action>(i);
+            const std::string& s = Library::Container::toString(a);
+            ASSERT_EQUALS(i, static_cast<uint16_t>(Library::Container::actionFrom(s)));
+        }
+    }
+
+    void containerYieldToFromString() const {
+        for (uint16_t i = 0; i < static_cast<uint16_t>(Library::Container::Yield::NO_YIELD); ++i) {
+            const auto y = static_cast<Library::Container::Yield>(i);
+            const std::string& s = Library::Container::toString(y);
+            ASSERT_EQUALS(i, static_cast<uint16_t>(Library::Container::yieldFrom(s)));
+        }
+    }
+
     template<std::size_t size>
     void loadLibError(const char (&xmldata)[size], Library::ErrorCode errorcode, const char* file, unsigned line) const {
         Library library;