Move to a unified function for the kind name

Author: Jlalond

lldb/include/lldb/DataFormatters/TypeSummary.h

@@ -264,7 +264,7 @@ class TypeSummaryImpl {
 
   /// Get the name of the kind of Summary Provider, either c++, summary string,
   /// script or python.
-  virtual std::string GetSummaryKindName() = 0;
+  virtual std::string GetSummaryKindName();
 
   uint32_t &GetRevision() { return m_my_revision; }
 
@@ -302,7 +302,6 @@ struct StringSummaryFormat : public TypeSummaryImpl {
   std::string GetDescription() override;
 
   std::string GetName() override;
-  std::string GetSummaryKindName() override;
 
   static bool classof(const TypeSummaryImpl *S) {
     return S->GetKind() == Kind::eSummaryString;
@@ -352,7 +351,6 @@ struct CXXFunctionSummaryFormat : public TypeSummaryImpl {
   }
 
   std::string GetName() override;
-  std::string GetSummaryKindName() override;
 
   typedef std::shared_ptr<CXXFunctionSummaryFormat> SharedPointer;
 
@@ -400,7 +398,6 @@ struct ScriptSummaryFormat : public TypeSummaryImpl {
   std::string GetDescription() override;
 
   std::string GetName() override;
-  std::string GetSummaryKindName() override;
 
   static bool classof(const TypeSummaryImpl *S) {
     return S->GetKind() == Kind::eScript;

lldb/include/lldb/Target/Statistics.h

@@ -28,6 +28,9 @@ namespace lldb_private {
 
 using StatsClock = std::chrono::high_resolution_clock;
 using StatsTimepoint = std::chrono::time_point<StatsClock>;
+class SummaryStatistics;
+// Declaring here as there is no private forward
+typedef std::shared_ptr<SummaryStatistics> SummaryStatisticsSP;
 
 class StatsDuration {
 public:
@@ -201,7 +204,7 @@ class SummaryStatistics {
   /// Basic RAII class to increment the summary count when the call is complete.
   class SummaryInvocation {
   public:
-    SummaryInvocation(std::shared_ptr<SummaryStatistics> summary_stats)
+    SummaryInvocation(SummaryStatisticsSP summary_stats)
         : m_stats(summary_stats),
           m_elapsed_time(summary_stats->GetDurationReference()) {}
     ~SummaryInvocation() { m_stats->OnInvoked(); }
@@ -214,7 +217,7 @@ class SummaryStatistics {
     /// @}
 
   private:
-    std::shared_ptr<SummaryStatistics> m_stats;
+    SummaryStatisticsSP m_stats;
     ElapsedTime m_elapsed_time;
   };
 
@@ -226,9 +229,6 @@ class SummaryStatistics {
   std::atomic<uint64_t> m_count;
 };
 
-// Declaring here as there is no private forward
-typedef std::shared_ptr<SummaryStatistics> SummaryStatisticsSP;
-
 /// A class that wraps a std::map of SummaryStatistics objects behind a mutex.
 class SummaryStatisticsCache {
 public:

lldb/source/DataFormatters/TypeSummary.cpp

@@ -48,6 +48,19 @@ TypeSummaryOptions::SetCapping(lldb::TypeSummaryCapping cap) {
 TypeSummaryImpl::TypeSummaryImpl(Kind kind, const TypeSummaryImpl::Flags &flags)
     : m_flags(flags), m_kind(kind) {}
 
+std::string TypeSummaryImpl::GetSummaryKindName() {
+  switch (m_kind) {
+  case Kind::eSummaryString:
+    return "string";
+  case Kind::eCallback:
+    return "callback";
+  case Kind::eScript:
+    return "python";
+  case Kind::eInternal:
+    return "c++";
+  }
+}
+
 StringSummaryFormat::StringSummaryFormat(const TypeSummaryImpl::Flags &flags,
                                          const char *format_cstr)
     : TypeSummaryImpl(Kind::eSummaryString, flags), m_format_str() {
@@ -117,7 +130,6 @@ std::string StringSummaryFormat::GetDescription() {
 }
 
 std::string StringSummaryFormat::GetName() { return m_format_str; }
-std::string StringSummaryFormat::GetSummaryKindName() { return "string"; }
 
 CXXFunctionSummaryFormat::CXXFunctionSummaryFormat(
     const TypeSummaryImpl::Flags &flags, Callback impl, const char *description)
@@ -150,8 +162,6 @@ std::string CXXFunctionSummaryFormat::GetDescription() {
 
 std::string CXXFunctionSummaryFormat::GetName() { return m_description; }
 
-std::string CXXFunctionSummaryFormat::GetSummaryKindName() { return "c++"; }
-
 ScriptSummaryFormat::ScriptSummaryFormat(const TypeSummaryImpl::Flags &flags,
                                          const char *function_name,
                                          const char *python_script)
@@ -220,10 +230,3 @@ std::string ScriptSummaryFormat::GetDescription() {
 }
 
 std::string ScriptSummaryFormat::GetName() { return m_script_formatter_name; }
-
-std::string ScriptSummaryFormat::GetSummaryKindName() {
-  if (!m_python_script.empty())
-    return "python";
-
-  return "script";
-}

lldb/test/API/commands/statistics/basic/TestStats.py

@@ -943,7 +943,8 @@ def test_summary_statistics_providers(self):
         self.assertIn("'count': 1", summary_provider_str)
         self.assertIn("'totalTime':", summary_provider_str)
         # We may hit the std::string C++ provider, or a summary provider string
-        self.assertRegex(r"'type': '(c++|string)'", summary_provider_str)
+        self.assertIn("'type':", summary_provider_str)
+        self.assertTrue("c++" in summary_provider_str or "string" in summary_provider_str)
 
         self.runCmd("continue")
         self.runCmd("command script import BoxFormatter.py")
@@ -952,7 +953,7 @@ def test_summary_statistics_providers(self):
         self.assertIn("summaryProviderStatistics", stats)
         summary_providers = stats["summaryProviderStatistics"]
         summary_provider_str = str(summary_providers)
-        self.assertRegex("'name': 'BoxFormatter.summary'", summary_provider_str)
+        self.assertIn("'name': 'BoxFormatter.summary'", summary_provider_str)
         self.assertIn("'count': 1", summary_provider_str)
         self.assertIn("'totalTime':", summary_provider_str)
         self.assertIn("'type': 'python'", summary_provider_str)
@@ -977,7 +978,7 @@ def test_summary_statistics_providers_vec(self):
         summary_provider_str = str(summary_providers)
         self.assertIn("'count': 2", summary_provider_str)
         self.assertIn("'totalTime':", summary_provider_str)
-        self.assertRegex(r"'type': '(c++|string)'", summary_provider_str)
+        self.assertIn("'type':", summary_provider_str)
         # We may hit the std::vector C++ provider, or a summary provider string
         if "c++" in summary_provider_str:
             self.assertIn("std::vector", summary_provider_str)