[lldb] add a marker before skipped frames

Author: charles-zablit

lldb/include/lldb/Target/StackFrame.h

@@ -335,11 +335,16 @@ class StackFrame : public ExecutionContextScope,
   /// \param[in] frame_marker
   ///   Optional string that will be prepended to the frame output description.
   ///
+  /// \param[in] skipped_frame_marker
+  ///   Optional string that will be prepended to the first or last non skipped
+  ///   frame output description.
+  ///
   /// \return
   ///   \b true if and only if dumping with the given \p format worked.
   bool DumpUsingFormat(Stream &strm,
                        const lldb_private::FormatEntity::Entry *format,
-                       llvm::StringRef frame_marker = {});
+                       llvm::StringRef frame_marker = {},
+                       llvm::StringRef skipped_frame_marker = {});
 
   /// Print a description for this frame using the frame-format formatter
   /// settings. If the current frame-format settings are invalid, then the
@@ -353,8 +358,13 @@ class StackFrame : public ExecutionContextScope,
   ///
   /// \param [in] frame_marker
   ///   Optional string that will be prepended to the frame output description.
+  ///
+  /// \param[in] skipped_frame_marker
+  ///   Optional string that will be prepended to the first or last non skipped
+  ///   frame output description.
   void DumpUsingSettingsFormat(Stream *strm, bool show_unique = false,
-                               const char *frame_marker = nullptr);
+                               const char *frame_marker = nullptr,
+                               const std::wstring skipped_frame_marker = L"");
 
   /// Print a description for this frame using a default format.
   ///
@@ -387,10 +397,15 @@ class StackFrame : public ExecutionContextScope,
   /// \param[in] frame_marker
   ///   Passed to DumpUsingSettingsFormat() for the frame info printing.
   ///
+  ///
+  /// \param[in] skipped_frame_marker
+  ///   Optional string that will be prepended to the first or last non skipped
+  ///   frame output description.
   /// \return
   ///   Returns true if successful.
   bool GetStatus(Stream &strm, bool show_frame_info, bool show_source,
-                 bool show_unique = false, const char *frame_marker = nullptr);
+                 bool show_unique = false, const char *frame_marker = nullptr,
+                 const std::wstring skipped_frame_marker = L"");
 
   /// Query whether this frame is a concrete frame on the call stack, or if it
   /// is an inlined frame derived from the debug information and presented by

lldb/include/lldb/Target/StackFrameList.h

@@ -49,6 +49,14 @@ class StackFrameList {
   /// Resets the selected frame index of this object.
   void ClearSelectedFrameIndex();
 
+  /// Return \code true if the next frame is hidden. False otherwise or if it's
+  /// the last frame.
+  bool IsNextFrameHidden(lldb_private::StackFrame &frame);
+
+  /// Return \code true if the previous frame is hidden. False otherwise or if
+  /// it's the first frame.
+  bool IsPreviousFrameHidden(lldb_private::StackFrame &frame);
+
   /// Get the currently selected frame index.
   /// We should only call SelectMostRelevantFrame if (a) the user hasn't already
   /// selected a frame, and (b) if this really is a user facing

lldb/source/Target/StackFrame.cpp

@@ -37,6 +37,7 @@
 #include "lldb/ValueObject/ValueObjectConstResult.h"
 #include "lldb/ValueObject/ValueObjectMemory.h"
 #include "lldb/ValueObject/ValueObjectVariable.h"
+#include "llvm/Support/ConvertUTF.h"
 
 #include "lldb/lldb-enumerations.h"
 
@@ -1920,11 +1921,13 @@ void StackFrame::CalculateExecutionContext(ExecutionContext &exe_ctx) {
 
 bool StackFrame::DumpUsingFormat(Stream &strm,
                                  const FormatEntity::Entry *format,
-                                 llvm::StringRef frame_marker) {
+                                 llvm::StringRef frame_marker,
+                                 llvm::StringRef skipped_frame_marker) {
   GetSymbolContext(eSymbolContextEverything);
   ExecutionContext exe_ctx(shared_from_this());
   StreamString s;
   s.PutCString(frame_marker);
+  s.PutCString(skipped_frame_marker);
 
   if (format && FormatEntity::Format(*format, s, &m_sc, &exe_ctx, nullptr,
                                      nullptr, false, false)) {
@@ -1934,8 +1937,9 @@ bool StackFrame::DumpUsingFormat(Stream &strm,
   return false;
 }
 
-void StackFrame::DumpUsingSettingsFormat(Stream *strm, bool show_unique,
-                                         const char *frame_marker) {
+void StackFrame::DumpUsingSettingsFormat(
+    Stream *strm, bool show_unique, const char *frame_marker,
+    const std::wstring skipped_frame_marker) {
   if (strm == nullptr)
     return;
 
@@ -1953,7 +1957,11 @@ void StackFrame::DumpUsingSettingsFormat(Stream *strm, bool show_unique,
       frame_format = &format_entry;
     }
   }
-  if (!DumpUsingFormat(*strm, frame_format, frame_marker)) {
+
+  std::string skipped_frame_delimiter_utf8;
+  llvm::convertWideToUTF8(skipped_frame_marker, skipped_frame_delimiter_utf8);
+  if (!DumpUsingFormat(*strm, frame_format, frame_marker,
+                       skipped_frame_delimiter_utf8)) {
     Dump(strm, true, false);
     strm->EOL();
   }
@@ -2034,10 +2042,12 @@ bool StackFrame::HasCachedData() const {
 }
 
 bool StackFrame::GetStatus(Stream &strm, bool show_frame_info, bool show_source,
-                           bool show_unique, const char *frame_marker) {
+                           bool show_unique, const char *frame_marker,
+                           const std::wstring skipped_frame_marker) {
   if (show_frame_info) {
     strm.Indent();
-    DumpUsingSettingsFormat(&strm, show_unique, frame_marker);
+    DumpUsingSettingsFormat(&strm, show_unique, frame_marker,
+                            skipped_frame_marker);
   }
 
   if (show_source) {

lldb/source/Target/StackFrameList.cpp

@@ -879,6 +879,24 @@ StackFrameList::GetStackFrameSPForStackFramePtr(StackFrame *stack_frame_ptr) {
   return ret_sp;
 }
 
+bool StackFrameList::IsNextFrameHidden(lldb_private::StackFrame &frame) {
+  uint32_t frame_idx = frame.GetFrameIndex();
+  StackFrameSP frame_sp = GetFrameAtIndex(frame_idx + 1);
+  if (!frame_sp)
+    return false;
+  return frame_sp->IsHidden();
+}
+
+bool StackFrameList::IsPreviousFrameHidden(lldb_private::StackFrame &frame) {
+  uint32_t frame_idx = frame.GetFrameIndex();
+  if (frame_idx == 0)
+    return false;
+  StackFrameSP frame_sp = GetFrameAtIndex(frame_idx - 1);
+  if (!frame_sp)
+    return false;
+  return frame_sp->IsHidden();
+}
+
 size_t StackFrameList::GetStatus(Stream &strm, uint32_t first_frame,
                                  uint32_t num_frames, bool show_frame_info,
                                  uint32_t num_frames_with_source,
@@ -920,6 +938,11 @@ size_t StackFrameList::GetStatus(Stream &strm, uint32_t first_frame,
       else
         marker = unselected_marker;
     }
+    std::wstring skipped_frame_marker = L"　";
+    if (IsPreviousFrameHidden(*frame_sp))
+      skipped_frame_marker = L"﹈";
+    else if (IsNextFrameHidden(*frame_sp))
+      skipped_frame_marker = L"﹇";
 
     // Hide uninteresting frames unless it's the selected frame.
     if (!show_hidden && frame_sp != selected_frame_sp && frame_sp->IsHidden())
@@ -933,10 +956,9 @@ size_t StackFrameList::GetStatus(Stream &strm, uint32_t first_frame,
             m_thread.GetID(), num_frames_displayed))
       break;
 
-
     if (!frame_sp->GetStatus(strm, show_frame_info,
                              num_frames_with_source > (first_frame - frame_idx),
-                             show_unique, marker))
+                             show_unique, marker, skipped_frame_marker))
       break;
     ++num_frames_displayed;
   }