[lldb-mi] Simplify MICmnMIResultRecord implementation.

[brucem]

Summary

• Remove extraneous members that were just storing temporary values.
• Correct some comments to not say that veType was a reference.
• ResultClass_e parameters don't need to be const as they are scalars.
• Switch from a map with CMIUtilString values to an indexable array of const char*.
• Make BuildRecordResult a static function rather than a private member function so that we can construct the result text correctly and avoid having extra stuff in the header.

[lldb-mi] Simplify MICmnMIResultRecord implementation.

[brucem]

This is an example of what I'd like to do more widely. In this case, the generated code is about half the size (not that it really matters, but just a demonstration of the bloat removed).

[ki.stfu]

tools/lldb-mi/MICmnMIResultRecord.cpp

14–51

Revert please. It will not give us any speed-up, but it does an addition of new ResultRecords harder. + It's much simpler to shift all enums by mistake.

68

(R) means 'readonly' variable. i.e. you will not plan to return anything through that variable.

81

(R) means 'readonly' variable. i.e. you will not plan to return anything through that variable.

86–87

Why did you remove the const qualifier?

tools/lldb-mi/MICmnMIResultRecord.h

62–64

What is wrong with const for scalar types? It does a expression stricter.

[brucem]

This restores the (R) to some comments and handles the mapping of
the result class to a string in a better way that will generate
compiler warnings if a new result class is added.

The const qualifiers haven't been re-added after the discussion on
D11049.

[ki.stfu]

Looks good, but how about returning NULL before exiting from MapResultClassToResultClassText?

tools/lldb-mi/MICmnMIResultRecord.cpp

35

here:

assert(0 && "unknown CMICmnMIResultRecord::ResultClass_e");
return NULL;

[brucem]

Updated per review comment.

[brucem]

Minor update for formatting and to change (void) parameter lists.

tools/lldb-mi/MICmnMIResultRecord.h

 //===-- MICmnMIResultRecord.h -----------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #pragma once
 
-// Third party headers:
-#include <map>
-
 // In-house headers:
 #include "MICmnBase.h"
 #include "MIUtilString.h"
 #include "MICmnMIValueResult.h"
 
 //++ ============================================================================
 // Details: MI common code MI Result Record class. A class that encapsulates
 //          MI result record data and the forming/format of data added to it.
public:
     // Details: Enumeration of the result class for *this result record
     //--
     enum ResultClass_e
     {
         eResultClass_Done = 0,
         eResultClass_Running,
         eResultClass_Connected,
         eResultClass_Error,
-        eResultClass_Exit,
-        eResultClass_count // Always the last one
+        eResultClass_Exit
     };
 
-    // Typedefs:
-  public:
-    typedef std::map<ResultClass_e, CMIUtilString> MapResultClassToResultClassText_t;
-
     // Methods:
   public:
     /* ctor */ CMICmnMIResultRecord(void);
-    /* ctor */ CMICmnMIResultRecord(const CMIUtilString &vrToken, const ResultClass_e veType);
-    /* ctor */ CMICmnMIResultRecord(const CMIUtilString &vrToken, const ResultClass_e veType, const CMICmnMIValueResult &vValue);
+    /* ctor */ CMICmnMIResultRecord(const CMIUtilString &vrToken, ResultClass_e veType);
+    /* ctor */ CMICmnMIResultRecord(const CMIUtilString &vrToken, ResultClass_e veType, const CMICmnMIValueResult &vValue);
     //
     const CMIUtilString &GetString(void) const;
     bool Add(const CMICmnMIValue &vMIValue);
 
     // Overridden:
   public:
     // From CMICmnBase
     /* dtor */ ~CMICmnMIResultRecord(void) override;
 
-    // Methods:
-  private:
-    bool BuildResultRecord(void);
-
     // Attributes:
   private:
-    static const CMIUtilString ms_constStrResultRecordHat;
-    static MapResultClassToResultClassText_t ms_constMapResultClassToResultClassText;
-    //
-    CMIUtilString m_strResultRecordToken;
-    ResultClass_e m_eResultRecordResultClass;
     CMIUtilString m_strResultRecord; // Holds the text version of the result record to date
-    CMICmnMIValueResult m_partResult;
 };

tools/lldb-mi/MICmnMIResultRecord.cpp

 //===-- Platform.cpp --------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 // In-house headers:
 #include "MICmnMIResultRecord.h"
 #include "MICmnResources.h"
 
-// Instantiations:
-CMICmnMIResultRecord::MapResultClassToResultClassText_t ms_MapResultClassToResultClassText = {
-    {CMICmnMIResultRecord::eResultClass_Done, "done"},
-    {CMICmnMIResultRecord::eResultClass_Running, "running"},
-    {CMICmnMIResultRecord::eResultClass_Connected, "connected"},
-    {CMICmnMIResultRecord::eResultClass_Error, "error"},
-    {CMICmnMIResultRecord::eResultClass_Exit, "exit"}};
-const CMIUtilString CMICmnMIResultRecord::ms_constStrResultRecordHat("^");
+//++ ------------------------------------------------------------------------------------
+// Details: Map a result class to the corresponding string.
+// Args:    veType      - (R) A MI result class enumeration.
+// Return:  const char* - The string corresponding to the result class.
+// Throws:  None.
+//--
+static const char*
+MapResultClassToResultClassText(CMICmnMIResultRecord::ResultClass_e veType)
+{
+    switch (veType) {
+      case CMICmnMIResultRecord::eResultClass_Done:
+        return "done";
+      case CMICmnMIResultRecord::eResultClass_Running:
+        return "running";
+      case CMICmnMIResultRecord::eResultClass_Connected:
+        return "connected";
+      case CMICmnMIResultRecord::eResultClass_Error:
+        return "error";
+      case CMICmnMIResultRecord::eResultClass_Exit:
+        return "exit";
+    }
+}
+
+//++ ------------------------------------------------------------------------------------
+// Details: Build the result record's mandatory data part. The part up to the first
+//          (additional) result i.e. result-record ==>  [ token ] "^" result-class.
+// Args:    vrToken     - (R) The command's transaction ID or token.
+//          veType      - (R) A MI result class enumeration.
+// Return:  CMIUtilString & - MI result record mandatory data
+// Throws:  None.
+//--
+static const CMIUtilString
+BuildResultRecord(const CMIUtilString &vrToken, CMICmnMIResultRecord::ResultClass_e veType)
+{
+    const char *pStrResultRecord = MapResultClassToResultClassText(veType);
+    return CMIUtilString::Format("%s^%s", vrToken.c_str(), pStrResultRecord);
+}
 
 //++ ------------------------------------------------------------------------------------
 // Details: CMICmnMIResultRecord constructor.
 // Type:    Method.
 // Args:    None.
 // Return:  None.
 // Throws:  None.
 //--
 CMICmnMIResultRecord::CMICmnMIResultRecord(void)
     : m_strResultRecord(MIRSRC(IDS_CMD_ERR_CMD_RUN_BUT_NO_ACTION))
 {
 }
 
 //++ ------------------------------------------------------------------------------------
 // Details: CMICmnMIResultRecord constructor.
 // Type:    Method.
 // Args:    vrToken - (R) The command's transaction ID or token.
 //          veType  - (R) A MI result class enumeration.
 // Return:  None.
 // Throws:  None.
 //--
-CMICmnMIResultRecord::CMICmnMIResultRecord(const CMIUtilString &vrToken, const ResultClass_e veType)
-    : m_strResultRecordToken(vrToken)
-    , m_eResultRecordResultClass(veType)
-    , m_strResultRecord(MIRSRC(IDS_CMD_ERR_CMD_RUN_BUT_NO_ACTION))
+CMICmnMIResultRecord::CMICmnMIResultRecord(const CMIUtilString &vrToken, ResultClass_e veType)
+    : m_strResultRecord(BuildResultRecord(vrToken, veType))
 {
-    BuildResultRecord();
 }
 
 //++ ------------------------------------------------------------------------------------
 // Details: CMICmnMIResultRecord constructor.
 // Type:    Method.
 // Args:    vrToken     - (R) The command's transaction ID or token.
 //          veType      - (R) A MI result class enumeration.
 //          vMIResult   - (R) A MI result object.
 // Return:  None.
 // Throws:  None.
 //--
-CMICmnMIResultRecord::CMICmnMIResultRecord(const CMIUtilString &vrToken, const ResultClass_e veType, const CMICmnMIValueResult &vValue)
-    : m_strResultRecordToken(vrToken)
-    , m_eResultRecordResultClass(veType)
-    , m_strResultRecord(MIRSRC(IDS_CMD_ERR_CMD_RUN_BUT_NO_ACTION))
-    , m_partResult(vValue)
+CMICmnMIResultRecord::CMICmnMIResultRecord(const CMIUtilString &vrToken, ResultClass_e veType, const CMICmnMIValueResult &vValue)
+    : m_strResultRecord(BuildResultRecord(vrToken, veType))
 {
-    BuildResultRecord();
-    Add(m_partResult);
+    Add(vValue);
 }
 
 //++ ------------------------------------------------------------------------------------
 // Details: CMICmnMIResultRecord destructor.
 // Type:    Overrideable.
 // Args:    None.
 // Return:  None.
 // Throws:  None.

 //--
 const CMIUtilString &
 CMICmnMIResultRecord::GetString(void) const
 {
     return m_strResultRecord;
 }
 
 //++ ------------------------------------------------------------------------------------
-// Details: Build the result record's mandatory data part. The part up to the first
-//          (additional) result i.e. result-record ==>  [ token ] "^" result-class.
-// Type:    Method.
-// Args:    None.
-// Return:  MIstatus::success - Functional succeeded.
-//          MIstatus::failure - Functional failed.
-// Throws:  None.
-//--
-bool
-CMICmnMIResultRecord::BuildResultRecord(void)
-{
-    const char *pFormat = "%s%s%s";
-    const CMIUtilString &rStrResultRecord(ms_MapResultClassToResultClassText[m_eResultRecordResultClass]);
-    m_strResultRecord =
-        CMIUtilString::Format(pFormat, m_strResultRecordToken.c_str(), ms_constStrResultRecordHat.c_str(), rStrResultRecord.c_str());
-
-    return MIstatus::success;
-}
-
-//++ ------------------------------------------------------------------------------------
 // Details: Add to *this result record additional information.
 // Type:    Method.
 // Args:    vMIValue    - (R) A MI value derived object.
 // Return:  MIstatus::success - Functional succeeded.
 //          MIstatus::failure - Functional failed.
 // Throws:  None.
 //--
 bool
 CMICmnMIResultRecord::Add(const CMICmnMIValue &vMIValue)
 {
     m_strResultRecord += ",";
     m_strResultRecord += vMIValue.GetString();
 
     return MIstatus::success;
 }