Skip to contentSkip to conversation

menuconfig: Allow sorting the entries alphabetically

PATCH In review Ivan Orlov 2 participants 2 messages Aug 16, 2024 – Aug 17, 2024

Subsystems (2)
lore
Share & tools
lore

Ivan Orlov

author
#0 lore raw

PATCH 1/1 menuconfig: Allow sorting the entries alphabetically

Implement the functionality which allows to sort the Kconfig entries alphabetically if user decides to. It may help finding the desired entry faster, so the user will spend less time looking through the list.

The sorting is done on the dialog_list elements in the 'dialog_menu' function, so on the option "representation" layer. The sorting could be enabled/disabled by pressing the '>' key. The labels are sorted in the following way:

1. Put all entries into the array (from the linked list)
2. Sort them alphabetically using qsort and custom comparator
3. Restore the items linked list structure

I know that this modification includes the ugly heruistics for
extracting the actual label text from " [ ] Some-option"-like
expressions (to be able to alphabetically compare the labels), and I would be happy to discuss alternative solutions.

---
 scripts/kconfig/lxdialog/dialog.h  |  5 +-
 scripts/kconfig/lxdialog/menubox.c |  7 ++-
 scripts/kconfig/lxdialog/util.c    | 79 ++++++++++++++++++++++++++++++
 scripts/kconfig/mconf.c            |  9 +++-
 4 files changed, 97 insertions(+), 3 deletions(-)
scripts/kconfig/lxdialog/dialog.h +4 -1
index f6c2ebe6d1f9..a036ed8cb43c 100644
@@ -58,6 +58,8 @@
 #define ACS_DARROW 'v'
 #endif
 
+#define KEY_ACTION_SORT 11
+
 /* error return codes */
 #define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
 
@@ -127,6 +129,7 @@ void item_set_selected(int val);
 int item_activate_selected(void);
 void *item_data(void);
 char item_tag(void);
+void sort_items(void);
 
 /* item list manipulation for lxdialog use */
 #define MAXITEMSTR 200
@@ -196,7 +199,7 @@ int dialog_textbox(const char *title, const char *tbuf, int initial_height,
 		   int initial_width, int *_vscroll, int *_hscroll,
 		   int (*extra_key_cb)(int, size_t, size_t, void *), void *data);
 int dialog_menu(const char *title, const char *prompt,
-		const void *selected, int *s_scroll);
+		const void *selected, int *s_scroll, bool sort);
 int dialog_checklist(const char *title, const char *prompt, int height,
 		     int width, int list_height);
 int dialog_inputbox(const char *title, const char *prompt, int height,
scripts/kconfig/lxdialog/menubox.c +6 -1
index 6e6244df0c56..4cba15f967c5 100644
@@ -161,7 +161,7 @@ static void do_scroll(WINDOW *win, int *scroll, int n)
  * Display a menu for choosing among a number of options
  */
 int dialog_menu(const char *title, const char *prompt,
-		const void *selected, int *s_scroll)
+		const void *selected, int *s_scroll, bool sort)
 {
 	int i, j, x, y, box_x, box_y;
 	int height, width, menu_height;
@@ -181,6 +181,9 @@ int dialog_menu(const char *title, const char *prompt,
 
 	max_choice = MIN(menu_height, item_count());
 
+	if (sort)
+		sort_items();
+
 	/* center dialog box on screen */
 	x = (getmaxx(stdscr) - width) / 2;
 	y = (getmaxy(stdscr) - height) / 2;
@@ -408,6 +411,8 @@ int dialog_menu(const char *title, const char *prompt,
 			delwin(menu);
 			delwin(dialog);
 			goto do_resize;
+		case '>':
+			return KEY_ACTION_SORT;
 		}
 	}
 	delwin(menu);
scripts/kconfig/lxdialog/util.c +79 -0

85 lines not on this page · raw message

scripts/kconfig/mconf.c +8 -1
index 3887eac75289..8a961a41cae4 100644
@@ -749,6 +749,7 @@ static void conf_save(void)
 	}
 }
 
+static bool should_sort;
 static void conf(struct menu *menu, struct menu *active_menu)
 {
 	struct menu *submenu;
@@ -774,9 +775,15 @@ static void conf(struct menu *menu, struct menu *active_menu)
 		dialog_clear();
 		res = dialog_menu(prompt ? prompt : "Main Menu",
 				  menu_instructions,
-				  active_menu, &s_scroll);
+				  active_menu, &s_scroll, should_sort);
 		if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
 			break;
+
+		if (res == KEY_ACTION_SORT) {
+			should_sort = !should_sort;
+			continue;
+		}
+
 		if (item_count() != 0) {
 			if (!item_activate_selected())
 				continue;
Signature · 1 line
2.34.1
#1 lore raw

Hello Ivan,

Quoted 3 lines · Ivan Orlov

Implement the functionality which allows to sort the Kconfig entries alphabetically if user decides to. It may help finding the desired entry faster, so the user will spend less time looking through the list.

Awesome, I love this new feature! Thank you for the patch.

Quoted 13 lines

The sorting is done on the dialog_list elements in the 'dialog_menu' function, so on the option "representation" layer. The sorting could be enabled/disabled by pressing the '>' key. The labels are sorted in the following way:

1. Put all entries into the array (from the linked list)
2. Sort them alphabetically using qsort and custom comparator
3. Restore the items linked list structure

I know that this modification includes the ugly heruistics for
extracting the actual label text from " [ ] Some-option"-like
expressions (to be able to alphabetically compare the labels), and I would be happy to discuss alternative solutions.