Get rid of Debugger::FormatPrompt() and replace it with the new FormatEntity class.

Why? Debugger::FormatPrompt() would run through the format prompt every time and parse it and emit it piece by piece. It also did formatting differently depending on which key/value pair it was parsing. 

The new code improves on this with the following features:
1 - Allow format strings to be parsed into a FormatEntity::Entry which can contain multiple child FormatEntity::Entry objects. This FormatEntity::Entry is a parsed version of what was previously always done in Debugger::FormatPrompt() so it is more efficient to emit formatted strings using the new parsed FormatEntity::Entry.
2 - Allows errors in format strings to be shown immediately when setting the settings (frame-format, thread-format, disassembly-format
3 - Allows auto completion by implementing a new OptionValueFormatEntity and switching frame-format, thread-format, and disassembly-format settings over to using it.
4 - The FormatEntity::Entry for each of the frame-format, thread-format, disassembly-format settings only replaces the old one if the format parses correctly
5 - Combines all consecutive string values together for efficient output. This means all "${ansi.*}" keys and all desensitized characters like "\n" "\t" "\0721" "\x23" will get combined with their previous strings
6 - ${*.script:} (like "${var.script:mymodule.my_var_function}") have all been switched over to use ${script.*:} "${script.var:mymodule.my_var_function}") to make the format easier to parse as I don't believe anyone was using these format string power user features.
7 - All key values pairs are defined in simple C arrays of entries so it is much easier to add new entries.

These changes pave the way for subsequent modifications where we can modify formats to do more (like control the width of value strings can do more and add more functionality more easily like string formatting to control the width, printf formats and more).

llvm-svn: 228207

4 files changed, 191 insertions, 23 deletions

diff --git a/lldb/source/Interpreter/OptionValue.cpp b/lldb/source/Interpreter/OptionValue.cpp
index a08a6127db1..1e4ea23cc07 100644
--- a/lldb/source/Interpreter/OptionValue.cpp
+++ b/lldb/source/Interpreter/OptionValue.cpp
@@ -222,6 +222,22 @@ OptionValue::GetAsFormat () const
     return nullptr;
 }
 
+OptionValueFormatEntity *
+OptionValue::GetAsFormatEntity ()
+{
+    if (GetType () == OptionValue::eTypeFormatEntity)
+        return static_cast<OptionValueFormatEntity *>(this);
+    return nullptr;
+}
+
+const OptionValueFormatEntity *
+OptionValue::GetAsFormatEntity () const
+{
+    if (GetType () == OptionValue::eTypeFormatEntity)
+        return static_cast<const OptionValueFormatEntity *>(this);
+    return nullptr;
+}
+
 OptionValuePathMappings *
 OptionValue::GetAsPathMappings ()
 {
@@ -452,6 +468,15 @@ OptionValue::SetFormatValue (lldb::Format new_value)
     return false;
 }
 
+const FormatEntity::Entry *
+OptionValue::GetFormatEntity () const
+{
+    const OptionValueFormatEntity *option_value = GetAsFormatEntity();
+    if (option_value)
+        return &option_value->GetCurrentValue();
+    return nullptr;
+}
+
 const RegularExpression *
 OptionValue::GetRegexValue () const
 {
@@ -563,6 +588,7 @@ OptionValue::GetBuiltinTypeAsCString (Type t)
         case eTypeFileSpec:     return "file";
         case eTypeFileSpecList: return "file-list";
         case eTypeFormat:       return "format";
+        case eTypeFormatEntity: return "format-string";
         case eTypePathMap:      return "path-map";
         case eTypeProperties:   return "properties";
         case eTypeRegex:        return "regex";
@@ -583,15 +609,16 @@ OptionValue::CreateValueFromCStringForTypeMask (const char *value_cstr, uint32_t
     lldb::OptionValueSP value_sp;
     switch (type_mask)
     {
-    case 1u << eTypeArch:       value_sp.reset(new OptionValueArch()); break;
-    case 1u << eTypeBoolean:    value_sp.reset(new OptionValueBoolean(false)); break;
-    case 1u << eTypeChar:       value_sp.reset(new OptionValueChar('\0')); break;
-    case 1u << eTypeFileSpec:   value_sp.reset(new OptionValueFileSpec()); break;
-    case 1u << eTypeFormat:     value_sp.reset(new OptionValueFormat(eFormatInvalid));    break;
-    case 1u << eTypeSInt64:     value_sp.reset(new OptionValueSInt64()); break;
-    case 1u << eTypeString:     value_sp.reset(new OptionValueString()); break;
-    case 1u << eTypeUInt64:     value_sp.reset(new OptionValueUInt64()); break;
-    case 1u << eTypeUUID:       value_sp.reset(new OptionValueUUID()); break;
+    case 1u << eTypeArch:           value_sp.reset(new OptionValueArch()); break;
+    case 1u << eTypeBoolean:        value_sp.reset(new OptionValueBoolean(false)); break;
+    case 1u << eTypeChar:           value_sp.reset(new OptionValueChar('\0')); break;
+    case 1u << eTypeFileSpec:       value_sp.reset(new OptionValueFileSpec()); break;
+    case 1u << eTypeFormat:         value_sp.reset(new OptionValueFormat(eFormatInvalid));    break;
+    case 1u << eTypeFormatEntity:   value_sp.reset(new OptionValueFormatEntity(NULL));    break;
+    case 1u << eTypeSInt64:         value_sp.reset(new OptionValueSInt64()); break;
+    case 1u << eTypeString:         value_sp.reset(new OptionValueString()); break;
+    case 1u << eTypeUInt64:         value_sp.reset(new OptionValueUInt64()); break;
+    case 1u << eTypeUUID:           value_sp.reset(new OptionValueUUID()); break;
     }
 
     if (value_sp)
diff --git a/lldb/source/Interpreter/OptionValueFormatEntity.cpp b/lldb/source/Interpreter/OptionValueFormatEntity.cpp
new file mode 100644
index 00000000000..fb8c682a03f
--- /dev/null
+++ b/lldb/source/Interpreter/OptionValueFormatEntity.cpp
@@ -0,0 +1,124 @@
+//===-- OptionValueFormatEntity.cpp -----------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "lldb/lldb-python.h"
+
+#include "lldb/Interpreter/OptionValueFormatEntity.h"
+
+// C Includes
+// C++ Includes
+// Other libraries and framework includes
+// Project includes
+#include "lldb/Core/Module.h"
+#include "lldb/Core/Stream.h"
+#include "lldb/Core/StringList.h"
+#include "lldb/Interpreter/CommandInterpreter.h"
+using namespace lldb;
+using namespace lldb_private;
+
+
+OptionValueFormatEntity::OptionValueFormatEntity (const char *default_format) :
+    OptionValue(),
+    m_current_format (),
+    m_default_format (),
+    m_current_entry (),
+    m_default_entry ()
+{
+    if (default_format && default_format[0])
+    {
+        llvm::StringRef default_format_str(default_format);
+        Error error = FormatEntity::Parse(default_format_str, m_default_entry);
+        if (error.Success())
+        {
+            m_default_format = default_format;
+            m_current_format = default_format;
+            m_current_entry = m_default_entry;
+        }
+    }
+}
+
+bool
+OptionValueFormatEntity::Clear ()
+{
+    m_current_entry = m_default_entry;
+    m_current_format = m_default_format;
+    m_value_was_set = false;
+    return true;
+}
+
+
+void
+OptionValueFormatEntity::DumpValue (const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask)
+{
+    if (dump_mask & eDumpOptionType)
+        strm.Printf ("(%s)", GetTypeAsCString ());
+    if (dump_mask & eDumpOptionValue)
+    {
+        if (dump_mask & eDumpOptionType)
+            strm.PutCString (" = \"");
+        strm << m_current_format.c_str() << '"';
+    }
+}
+
+Error
+OptionValueFormatEntity::SetValueFromCString (const char *value_cstr,
+                                      VarSetOperationType op)
+{
+    Error error;
+    switch (op)
+    {
+        case eVarSetOperationClear:
+            Clear();
+            NotifyValueChanged();
+            break;
+            
+        case eVarSetOperationReplace:
+        case eVarSetOperationAssign:
+            {
+                FormatEntity::Entry entry;
+                llvm::StringRef value_str(value_cstr);
+                error = FormatEntity::Parse(value_str, entry);
+                if (error.Success())
+                {
+                    m_current_entry = std::move(entry);
+                    m_current_format = value_cstr;
+                    m_value_was_set = true;
+                    NotifyValueChanged();
+                }
+            }
+            break;
+            
+        case eVarSetOperationInsertBefore:
+        case eVarSetOperationInsertAfter:
+        case eVarSetOperationRemove:
+        case eVarSetOperationAppend:
+        case eVarSetOperationInvalid:
+            error = OptionValue::SetValueFromCString (value_cstr, op);
+            break;
+    }
+    return error;
+}
+
+lldb::OptionValueSP
+OptionValueFormatEntity::DeepCopy () const
+{
+    return OptionValueSP(new OptionValueFormatEntity(*this));
+}
+
+size_t
+OptionValueFormatEntity::AutoComplete (CommandInterpreter &interpreter,
+                                       const char *s,
+                                       int match_start_point,
+                                       int max_return_elements,
+                                       bool &word_complete,
+                                       StringList &matches)
+{
+    return FormatEntity::AutoComplete (s, match_start_point, max_return_elements, word_complete, matches);
+}
+
diff --git a/lldb/source/Interpreter/OptionValueProperties.cpp b/lldb/source/Interpreter/OptionValueProperties.cpp
index 6ec2aa569fa..cf7abaa6ac2 100644
--- a/lldb/source/Interpreter/OptionValueProperties.cpp
+++ b/lldb/source/Interpreter/OptionValueProperties.cpp
@@ -421,6 +421,18 @@ OptionValueProperties::SetPropertyAtIndexAsEnumeration (const ExecutionContext *
     return false;
 }
 
+const FormatEntity::Entry *
+OptionValueProperties::GetPropertyAtIndexAsFormatEntity (const ExecutionContext *exe_ctx, uint32_t idx)
+{
+    const Property *property = GetPropertyAtIndex (exe_ctx, true, idx);
+    if (property)
+    {
+        OptionValue *value = property->GetValue().get();
+        if (value)
+            return value->GetFormatEntity();
+    }
+    return nullptr;
+}
 
 OptionValueFileSpec *
 OptionValueProperties::GetPropertyAtIndexAsOptionValueFileSpec (const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const
diff --git a/lldb/source/Interpreter/Property.cpp b/lldb/source/Interpreter/Property.cpp
index 7fcc9d2d96e..5679ef8dd3b 100644
--- a/lldb/source/Interpreter/Property.cpp
+++ b/lldb/source/Interpreter/Property.cpp
@@ -109,16 +109,21 @@ Property::Property (const PropertyDefinition &definition) :
             // "definition.default_cstr_value" is NULL, otherwise interpret
             // "definition.default_cstr_value" as a string value that represents the default
             // value.
-        {
-            Format new_format = eFormatInvalid;
-            if (definition.default_cstr_value)
-                Args::StringToFormat (definition.default_cstr_value, new_format, nullptr);
-            else
-                new_format = (Format)definition.default_uint_value;
-            m_value_sp.reset (new OptionValueFormat(new_format));
-        }
+            {
+                Format new_format = eFormatInvalid;
+                if (definition.default_cstr_value)
+                    Args::StringToFormat (definition.default_cstr_value, new_format, nullptr);
+                else
+                    new_format = (Format)definition.default_uint_value;
+                m_value_sp.reset (new OptionValueFormat(new_format));
+            }
             break;
             
+        case OptionValue::eTypeFormatEntity:
+            // "definition.default_cstr_value" as a string value that represents the default
+            m_value_sp.reset (new OptionValueFormatEntity(definition.default_cstr_value));
+            break;
+
         case OptionValue::eTypePathMap:
             // "definition.default_uint_value" tells us if notifications should occur for
             // path mappings
@@ -151,12 +156,12 @@ Property::Property (const PropertyDefinition &definition) :
         case OptionValue::eTypeUUID:
             // "definition.default_uint_value" is not used for a OptionValue::eTypeUUID
             // "definition.default_cstr_value" can contain a default UUID value
-        {
-            UUID uuid;
-            if (definition.default_cstr_value)
-                uuid.SetFromCString (definition.default_cstr_value);
-            m_value_sp.reset (new OptionValueUUID(uuid));
-        }
+            {
+                UUID uuid;
+                if (definition.default_cstr_value)
+                    uuid.SetFromCString (definition.default_cstr_value);
+                m_value_sp.reset (new OptionValueUUID(uuid));
+            }
             break;
             
         case OptionValue::eTypeString: