[llvm-branch-commits] [lldb] [lldb] Add column sorting to IOHandlerPicker (PR #237515)
Med Ismail Bennani via llvm-branch-commits
llvm-branch-commits at lists.llvm.org
Fri Nov 13 17:54:44 PST 2026
https://github.com/medismailben updated https://github.com/llvm/llvm-project/pull/237515
>From fb4eefe17150ebe3a2d6a67b56c55e159ad4c59c Mon Sep 17 00:00:00 2001
From: Med Ismail Bennani <ismail at bennani.ma>
Date: Mon, 5 Oct 2026 17:45:20 -0700
Subject: [PATCH] [lldb] Add column sorting to IOHandlerPicker
This patch lets the user sort the picker's rows by pressing `s`, which
cycles through each column in ascending then descending order before
returning to the original order. A column whose values are all integers
compares numerically, and other columns compare as strings. Ties keep
their original relative order, and the cursor moves back to the top after
each sort so the new order is visible.
The column header shows which column is sorted and in which direction, and
each column reserves room for that indicator so it doesn't shift the
layout.
Assisted-by: Claude
Signed-off-by: Med Ismail Bennani <ismail at bennani.ma>
---
lldb/include/lldb/Core/IOHandlerPicker.h | 17 +++-
lldb/source/Core/IOHandlerPicker.cpp | 99 +++++++++++++++++--
.../iohandler/picker/TestIOHandlerPicker.py | 17 ++++
3 files changed, 122 insertions(+), 11 deletions(-)
diff --git a/lldb/include/lldb/Core/IOHandlerPicker.h b/lldb/include/lldb/Core/IOHandlerPicker.h
index bac8b00589f0e..797e09e39e5b2 100644
--- a/lldb/include/lldb/Core/IOHandlerPicker.h
+++ b/lldb/include/lldb/Core/IOHandlerPicker.h
@@ -68,12 +68,18 @@ class IOHandlerPicker : public IOHandler {
End,
Space,
Enter,
+ Sort,
/// A byte arrived on m_wakeup_pipe.
Wakeup,
Escape,
Unknown,
};
+ struct SortOrder {
+ size_t column;
+ bool ascending;
+ };
+
enum class Input { Ready, Wakeup, Error };
bool EnterRawMode();
@@ -91,6 +97,9 @@ class IOHandlerPicker : public IOHandler {
/// Redraw the screen without the dialog.
void RestoreScreen();
void ScrollToCursor();
+ void CycleSort();
+ void UpdateVisibleIndices();
+ void SortVisibleIndices(SortOrder order);
void ComputeColumnWidths();
void UpdateLayout();
llvm::StringRef GetHelpText() const;
@@ -106,12 +115,18 @@ class IOHandlerPicker : public IOHandler {
PickerMode m_mode;
PickerResult m_result;
+ /// Index into m_visible_indices of the row under the cursor.
size_t m_cursor_index = 0;
- /// Index of the first row on screen.
+ /// Index into m_visible_indices of the first row on screen.
size_t m_viewport_start = 0;
/// Bit i is set if m_items[i] is checked.
llvm::BitVector m_checked;
+ /// Indices into m_items of the rows to show, in display order.
+ llvm::SmallVector<size_t, 0> m_visible_indices;
+ /// Sort column and direction, or std::nullopt for the original order.
+ std::optional<SortOrder> m_sort_order;
+
llvm::SmallVector<size_t> m_column_widths;
/// Cached with the layout below so a frame never mixes two terminal sizes.
diff --git a/lldb/source/Core/IOHandlerPicker.cpp b/lldb/source/Core/IOHandlerPicker.cpp
index 86fe93919260b..532ca78c04a0f 100644
--- a/lldb/source/Core/IOHandlerPicker.cpp
+++ b/lldb/source/Core/IOHandlerPicker.cpp
@@ -26,6 +26,7 @@
#include <algorithm>
#include <cassert>
#include <chrono>
+#include <numeric>
using namespace lldb;
using namespace lldb_private;
@@ -37,6 +38,11 @@ static constexpr llvm::StringLiteral g_unchecked_prefix = " [ ] ";
static constexpr llvm::StringLiteral g_cursor_prefix = " > ";
static constexpr llvm::StringLiteral g_no_cursor_prefix = " ";
+static constexpr llvm::StringLiteral g_ascending_indicator = " ^";
+static constexpr llvm::StringLiteral g_descending_indicator = " v";
+static_assert(g_ascending_indicator.size() == g_descending_indicator.size(),
+ "both sort indicators must take the same width");
+
/// Reverse video gives the dialog a solid background in any color scheme.
static constexpr llvm::StringLiteral g_dialog_style =
ANSI_ESCAPE1(ANSI_CTRL_IMAGE_NEGATIVE);
@@ -85,6 +91,8 @@ IOHandlerPicker::IOHandlerPicker(Debugger &debugger, llvm::StringRef header,
if (item.initially_selected)
m_checked.set(i);
+ UpdateVisibleIndices();
+
// Without the pipe, resizes and cross-thread cancels wait for a key press.
if (Status error = m_wakeup_pipe.CreateNew(); error.Fail())
LLDB_LOG(GetLog(LLDBLog::Host), "IOHandlerPicker: {0}", error);
@@ -99,15 +107,16 @@ size_t IOHandlerPicker::GetPrefixWidth() const {
llvm::StringRef IOHandlerPicker::GetHelpText() const {
return m_mode == PickerMode::SingleSelect
- ? " jk: navigate Enter: select ESC: cancel"
- : " jk: navigate Space: toggle Enter: confirm ESC: cancel";
+ ? " jk: navigate Enter: select s: sort ESC: cancel"
+ : " jk: navigate Space: toggle Enter: confirm s: sort "
+ "ESC: cancel";
}
void IOHandlerPicker::ComputeColumnWidths() {
m_column_widths.clear();
size_t row_width = GetPrefixWidth();
for (size_t i = 0; i < m_columns.size(); ++i) {
- size_t width = GetColumnWidth(m_columns[i]);
+ size_t width = GetColumnWidth(m_columns[i]) + g_ascending_indicator.size();
for (const PickerItem &item : m_items)
width = std::max(width, GetColumnWidth(item.values[i]));
m_column_widths.push_back(width);
@@ -279,6 +288,9 @@ IOHandlerPicker::Key IOHandlerPicker::DecodeByte(char c) {
return Key::Up;
case 'j':
return Key::Down;
+ case 's':
+ case 'S':
+ return Key::Sort;
case g_ctrl_c: // Raw mode disables SIGINT, so Ctrl+C arrives as a byte.
return Key::Escape;
default:
@@ -319,6 +331,56 @@ void IOHandlerPicker::ScrollToCursor() {
m_viewport_start = m_cursor_index - viewport + 1;
}
+void IOHandlerPicker::CycleSort() {
+ // unsorted -> col0 asc -> col0 desc -> col1 asc -> ... -> unsorted
+ if (m_columns.empty())
+ return;
+ if (!m_sort_order)
+ m_sort_order = SortOrder{0, /*ascending=*/true};
+ else if (m_sort_order->ascending)
+ m_sort_order->ascending = false;
+ else if (m_sort_order->column + 1 < m_columns.size())
+ m_sort_order = SortOrder{m_sort_order->column + 1, /*ascending=*/true};
+ else
+ m_sort_order.reset();
+ UpdateVisibleIndices();
+}
+
+void IOHandlerPicker::UpdateVisibleIndices() {
+ // Start from the item order, which the stable sort keeps for ties.
+ m_visible_indices.resize(m_items.size());
+ std::iota(m_visible_indices.begin(), m_visible_indices.end(), 0);
+ if (m_sort_order)
+ SortVisibleIndices(*m_sort_order);
+
+ // Jump to the top so the new order is visible.
+ m_cursor_index = 0;
+ m_viewport_start = 0;
+}
+
+void IOHandlerPicker::SortVisibleIndices(SortOrder order) {
+ size_t col = order.column;
+ // Compare as integers if every value in the column is one, so that "9"
+ // sorts before "10".
+ llvm::SmallVector<int64_t, 0> numbers;
+ numbers.reserve(m_items.size());
+ for (const PickerItem &item : m_items) {
+ int64_t number;
+ if (llvm::StringRef(item.values[col]).getAsInteger(10, number))
+ break;
+ numbers.push_back(number);
+ }
+ bool numeric = numbers.size() == m_items.size();
+ auto less = [&](size_t a, size_t b) {
+ if (numeric)
+ return numbers[a] < numbers[b];
+ return m_items[a].values[col] < m_items[b].values[col];
+ };
+ llvm::stable_sort(m_visible_indices, [&](size_t a, size_t b) {
+ return order.ascending ? less(a, b) : less(b, a);
+ });
+}
+
void IOHandlerPicker::RestoreScreen() {
// Only clear the lines above the statusline.
std::string screen;
@@ -377,16 +439,30 @@ void IOHandlerPicker::Render() {
std::string column_names(GetPrefixWidth(), ' ');
for (size_t i = 0; i < m_columns.size(); ++i) {
- const std::string &name = m_columns[i];
+ std::string name = m_columns[i];
+ bool is_sort_col = m_sort_order && m_sort_order->column == i;
+ if (is_sort_col) {
+ name += m_sort_order->ascending ? g_ascending_indicator
+ : g_descending_indicator;
+ column_names +=
+ ANSI_ESCAPE1(ANSI_CTRL_BOLD) ANSI_ESCAPE1(ANSI_CTRL_UNDERLINE);
+ }
column_names += name;
+ // Resetting the style also resets the dialog's, so restore it.
+ if (is_sort_col) {
+ column_names += ANSI_ESCAPE1(ANSI_CTRL_NORMAL);
+ column_names += g_dialog_style;
+ }
column_names.append(
m_column_widths[i] - GetColumnWidth(name) + g_column_gap, ' ');
}
write_line("", column_names);
- size_t end = std::min(m_viewport_start + GetViewportHeight(), m_items.size());
- for (size_t item_idx = m_viewport_start; item_idx < end; ++item_idx) {
- bool is_cursor = item_idx == m_cursor_index;
+ size_t end = std::min(m_viewport_start + GetViewportHeight(),
+ m_visible_indices.size());
+ for (size_t i = m_viewport_start; i < end; ++i) {
+ size_t item_idx = m_visible_indices[i];
+ bool is_cursor = i == m_cursor_index;
std::string row;
if (m_mode == PickerMode::MultiSelect)
@@ -409,7 +485,7 @@ void IOHandlerPicker::Render() {
.str()
: llvm::formatv(" {0}/{1}", m_cursor_index + 1, m_items.size())
.str();
- if (end < m_items.size())
+ if (end < m_visible_indices.size())
footer += " [more below]";
if (m_viewport_start > 0)
footer += " [more above]";
@@ -462,6 +538,9 @@ void IOHandlerPicker::Run() {
case Key::End:
m_cursor_index = m_items.size() - 1;
break;
+ case Key::Sort:
+ CycleSort();
+ break;
case Key::Wakeup:
// A resize, the statusline, or async output may have drawn over us.
UpdateLayout();
@@ -469,11 +548,11 @@ void IOHandlerPicker::Run() {
break;
case Key::Space:
if (m_mode == PickerMode::MultiSelect)
- m_checked.flip(m_cursor_index);
+ m_checked.flip(m_visible_indices[m_cursor_index]);
break;
case Key::Enter:
if (m_mode == PickerMode::SingleSelect) {
- m_result.selected_indices.push_back(m_cursor_index);
+ m_result.selected_indices.push_back(m_visible_indices[m_cursor_index]);
} else {
for (unsigned i : m_checked.set_bits())
m_result.selected_indices.push_back(i);
diff --git a/lldb/test/API/iohandler/picker/TestIOHandlerPicker.py b/lldb/test/API/iohandler/picker/TestIOHandlerPicker.py
index 8692fcbe22697..b90bd5aabf5be 100644
--- a/lldb/test/API/iohandler/picker/TestIOHandlerPicker.py
+++ b/lldb/test/API/iohandler/picker/TestIOHandlerPicker.py
@@ -80,6 +80,23 @@ def test_multi_select_cancel(self):
self.child.send(self.escape_key)
self.finish("canceled")
+ def test_sort_ascending(self):
+ """The first s sorts by the first column, ascending."""
+ self.start_picker("test-picker single 5", "Select an item:")
+ self.child.send("s")
+ self.child.expect_exact("ID ^")
+ self.child.send("j\r")
+ self.finish("selected: 2")
+
+ def test_sort_cycle(self):
+ """Each s advances the sort: ID asc, ID desc, NAME asc, NAME desc."""
+ self.start_picker("test-picker single 5", "Select an item:")
+ self.child.send("ssss")
+ self.child.expect_exact("NAME v")
+ # NAME descending: echo (5), delta (4), ...
+ self.child.send("j\r")
+ self.finish("selected: 4")
+
def test_small_terminal_scrolls(self):
"""Moving past the viewport scrolls the list."""
self.start_picker(
More information about the llvm-branch-commits
mailing list