Address David's feedback

Author: JDevlieghere

lldb/packages/Python/lldbsuite/test/lldbtest.py

@@ -765,14 +765,15 @@ def setUpCommands(cls):
             # Disable fix-its by default so that incorrect expressions in tests don't
             # pass just because Clang thinks it has a fix-it.
             "settings set target.auto-apply-fixits false",
-            # Disable the statusline in PExpect tests.
-            "settings set show-statusline false",
             # Testsuite runs in parallel and the host can have also other load.
             "settings set plugin.process.gdb-remote.packet-timeout 60",
             'settings set symbols.clang-modules-cache-path "{}"'.format(
                 configuration.lldb_module_cache_dir
             ),
+            # Disable colors by default.
             "settings set use-color false",
+            # Disable the statusline by default.
+            "settings set show-statusline false",
         ]
 
         # Set any user-overridden settings.

lldb/source/Core/CoreProperties.td

@@ -179,7 +179,7 @@ let Definition = "debugger" in {
   def StatuslineFormat: Property<"statusline-format", "FormatEntity">,
     Global,
     DefaultStringValue<"${ansi.bg.blue}${ansi.fg.black}{${target.file.basename}}{ | ${line.file.basename}:${line.number}:${line.column}}{ | ${thread.stop-reason}}{ | {${progress.count} }${progress.message}}">,
-    Desc<"List of statusline format entities.">;
+    Desc<"The default statusline format string.">;
   def UseSourceCache: Property<"use-source-cache", "Boolean">,
     Global,
     DefaultTrue,

lldb/source/Core/FormatEntity.cpp

@@ -1922,8 +1922,7 @@ bool FormatEntity::Format(const Entry &entry, Stream &s,
 
   case Entry::Type::ProgressCount:
     if (Target *target = Target::GetTargetFromContexts(exe_ctx, sc)) {
-      Debugger &debugger = target->GetDebugger();
-      if (auto progress = debugger.GetCurrentProgressReport()) {
+      if (auto progress = target->GetDebugger().GetCurrentProgressReport()) {
         if (progress->total != UINT64_MAX) {
           s.Format("[{0}/{1}]", progress->completed, progress->total);
           return true;
@@ -1934,8 +1933,7 @@ bool FormatEntity::Format(const Entry &entry, Stream &s,
 
   case Entry::Type::ProgressMessage:
     if (Target *target = Target::GetTargetFromContexts(exe_ctx, sc)) {
-      Debugger &debugger = target->GetDebugger();
-      if (auto progress = debugger.GetCurrentProgressReport()) {
+      if (auto progress = target->GetDebugger().GetCurrentProgressReport()) {
         s.PutCString(progress->message);
         return true;
       }

lldb/source/Core/Statusline.cpp

@@ -71,46 +71,50 @@ void Statusline::Disable() {
 }
 
 void Statusline::Draw(std::string str) {
-  static constexpr const size_t g_ellipsis = 3;
+  lldb::LockableStreamFileSP stream_sp = m_debugger.GetOutputStreamSP();
+  if (!stream_sp)
+    return;
+
+  static constexpr const size_t g_ellipsis_len = 3;
 
   UpdateTerminalProperties();
 
   m_last_str = str;
 
   size_t column_width = ColumnWidth(str);
 
-  if (column_width + g_ellipsis >= m_terminal_width) {
+  if (column_width + g_ellipsis_len >= m_terminal_width) {
     // FIXME: If there are hidden characters (e.g. UTF-8, ANSI escape
     // characters), this will strip the string more than necessary. Ideally we
     // want to strip until column_width == m_terminal_width.
     str = str.substr(0, m_terminal_width);
-    str.replace(m_terminal_width - g_ellipsis, g_ellipsis, "...");
+    str.replace(m_terminal_width - g_ellipsis_len, g_ellipsis_len, "...");
     column_width = ColumnWidth(str);
   }
 
-  if (lldb::LockableStreamFileSP stream_sp = m_debugger.GetOutputStreamSP()) {
-    LockedStreamFile locked_stream = stream_sp->Lock();
-    locked_stream << ANSI_SAVE_CURSOR;
-    locked_stream.Printf(ANSI_TO_START_OF_ROW,
-                         static_cast<unsigned>(m_terminal_height));
-    locked_stream << ANSI_CLEAR_LINE;
-    locked_stream << str;
-    if (column_width < m_terminal_width)
-      locked_stream << std::string(m_terminal_width - column_width, ' ');
-    locked_stream << ANSI_NORMAL;
-    locked_stream << ANSI_RESTORE_CURSOR;
-  }
+  LockedStreamFile locked_stream = stream_sp->Lock();
+  locked_stream << ANSI_SAVE_CURSOR;
+  locked_stream.Printf(ANSI_TO_START_OF_ROW,
+                       static_cast<unsigned>(m_terminal_height));
+  locked_stream << ANSI_CLEAR_LINE;
+  locked_stream << str;
+  if (column_width < m_terminal_width)
+    locked_stream << std::string(m_terminal_width - column_width, ' ');
+  locked_stream << ANSI_NORMAL;
+  locked_stream << ANSI_RESTORE_CURSOR;
 }
 
 void Statusline::Reset() {
-  if (lldb::LockableStreamFileSP stream_sp = m_debugger.GetOutputStreamSP()) {
-    LockedStreamFile locked_stream = stream_sp->Lock();
-    locked_stream << ANSI_SAVE_CURSOR;
-    locked_stream.Printf(ANSI_TO_START_OF_ROW,
-                         static_cast<unsigned>(m_terminal_height));
-    locked_stream << ANSI_CLEAR_LINE;
-    locked_stream << ANSI_RESTORE_CURSOR;
-  }
+  lldb::LockableStreamFileSP stream_sp = m_debugger.GetOutputStreamSP();
+  if (!stream_sp)
+    return;
+
+  LockedStreamFile locked_stream = stream_sp->Lock();
+  locked_stream << ANSI_SAVE_CURSOR;
+  locked_stream.Printf(ANSI_TO_START_OF_ROW,
+                       static_cast<unsigned>(m_terminal_height));
+  locked_stream << ANSI_CLEAR_LINE;
+  locked_stream << ANSI_RESTORE_CURSOR;
 }
 
 void Statusline::UpdateTerminalProperties() {

lldb/test/API/functionalities/statusline/TestStatusline.py

@@ -36,13 +36,13 @@ def test(self):
             "set set show-statusline true",
             [
                 "\x1b[0;{}r".format(terminal_height - 1),
-                "a.out | main.c:4:15 | breakpoint 1.1                        ",
+                "a.out | main.c:2:11 | breakpoint 1.1                        ",
             ],
         )
 
         # Change the terminal dimensions and make sure it's reflected immediately.
         self.child.setwinsize(terminal_height, 20)
-        self.child.expect(re.escape("a.out | main.c:4:..."))
+        self.child.expect(re.escape("a.out | main.c:2:..."))
         self.child.setwinsize(terminal_height, terminal_width)
 
         # Change the format.

lldb/test/API/functionalities/statusline/main.c

@@ -1,7 +1,5 @@
-int bar(int b) { return b * b; }
-
 int foo(int f) {
-  int b = bar(f); // Break here
+  int b = f * f; // Break here
   return b;
 }