git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 03/11] clean: do not use strbuf_split*() [part 1]

From
Junio C Hamano <gitster@pobox.com>
Date
Jul 31, 2025, 22:54 UTC
Message-ID
<20250731225433.4028872-4-gitster@pobox.com>
In-Reply-To
<20250731225433.4028872-1-gitster@pobox.com>

builtin/clean.c:parse_choice() is fed a single line of input, which is space or comma separated list of tokens, and a list of menu items. It parses the tokens into number ranges (e.g. 1-3 that means the first three items) or string prefix (e.g. 's' to choose the menu item "(s)elect") that specify the elements in the menu item list, and tells the caller which ones are chosen.

For parsing the input string, it uses strbuf_split() to split it into bunch of strbufs. Instead use string_list_split_in_place(), for a few reasons.

 * strbuf_split() is a bad API function to use, that yields an array
   of strbuf that is a bad data structure to use in general.
 * string_list_split_in_place() allows you to split with "comma or
   space"; the current code has to preprocess the input string to
   replace comma with space because strbuf_split() does not allow
   this.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 builtin/clean.c | 50 +++++++++++++++++++++++--------------------------
 1 file changed, 23 insertions(+), 27 deletions(-)
diff --git a/builtin/clean.c b/builtin/clean.c
index 224551537e..708cd9344c 100644
--- a/builtin/clean.c
+++ b/builtin/clean.c
@@ -480,40 +480,36 @@ static int parse_choice(struct menu_stuff *menu_stuff,
 			struct strbuf *input,
 			int **chosen)
 {
-	struct strbuf **choice_list, **ptr;
+	struct string_list choice = STRING_LIST_INIT_NODUP;
+	struct string_list_item *item;
 	int nr = 0;
 	int i;
 
-	if (is_single) {
-		choice_list = strbuf_split_max(input, '\n', 0);
-	} else {
-		char *p = input->buf;
-		do {
-			if (*p == ',')
-				*p = ' ';
-		} while (*p++);
-		choice_list = strbuf_split_max(input, ' ', 0);
-	}
+	string_list_split_in_place_f(&choice, input->buf,
+				     is_single ? "\n" : ", ", -1,
+				     STRING_LIST_SPLIT_TRIM);
 
-	for (ptr = choice_list; *ptr; ptr++) {
-		char *p;
-		int choose = 1;
+	for_each_string_list_item(item, &choice) {
+		const char *string;
+		int choose;
 		int bottom = 0, top = 0;
 		int is_range, is_number;
 
-		strbuf_trim(*ptr);
-		if (!(*ptr)->len)
+		string = item->string;
+		if (!*string)
 			continue;
 
 		/* Input that begins with '-'; unchoose */
-		if (*(*ptr)->buf == '-') {
+		if (string[0] == '-') {
 			choose = 0;
-			strbuf_remove((*ptr), 0, 1);
+			string++;
+		} else {
+			choose = 1;
 		}
 
 		is_range = 0;
 		is_number = 1;
-		for (p = (*ptr)->buf; *p; p++) {
+		for (const char *p = string; *p; p++) {
 			if ('-' == *p) {
 				if (!is_range) {
 					is_range = 1;
@@ -531,27 +527,27 @@ static int parse_choice(struct menu_stuff *menu_stuff,
 		}
 
 		if (is_number) {
-			bottom = atoi((*ptr)->buf);
+			bottom = atoi(string);
 			top = bottom;
 		} else if (is_range) {
-			bottom = atoi((*ptr)->buf);
+			bottom = atoi(string);
 			/* a range can be specified like 5-7 or 5- */
-			if (!*(strchr((*ptr)->buf, '-') + 1))
+			if (!*(strchr(string, '-') + 1))
 				top = menu_stuff->nr;
 			else
-				top = atoi(strchr((*ptr)->buf, '-') + 1);
-		} else if (!strcmp((*ptr)->buf, "*")) {
+				top = atoi(strchr(string, '-') + 1);
+		} else if (!strcmp(string, "*")) {
 			bottom = 1;
 			top = menu_stuff->nr;
 		} else {
-			bottom = find_unique((*ptr)->buf, menu_stuff);
+			bottom = find_unique(string, menu_stuff);
 			top = bottom;
 		}
 
 		if (top <= 0 || bottom <= 0 || top > menu_stuff->nr || bottom > top ||
 		    (is_single && bottom != top)) {
 			clean_print_color(CLEAN_COLOR_ERROR);
-			printf(_("Huh (%s)?\n"), (*ptr)->buf);
+			printf(_("Huh (%s)?\n"), string);
 			clean_print_color(CLEAN_COLOR_RESET);
 			continue;
 		}
@@ -560,7 +556,7 @@ static int parse_choice(struct menu_stuff *menu_stuff,
 			(*chosen)[i-1] = choose;
 	}
 
-	strbuf_list_free(choice_list);
+	string_list_clear(&choice, 0);
 
 	for (i = 0; i < menu_stuff->nr; i++)
 		nr += (*chosen)[i];
-- 
2.50.1-618-g45d530d26b
Previous: Jeff KingNext: Junio C Hamano
Message 21 of 33 in “do not overuse strbuf_split*()”
  1. 0/9 do not overuse strbuf_split*()Junio C Hamano, Jul 31, 2025
  2. 1/9 wt-status: avoid strbuf_split*()Junio C Hamano, Jul 31, 2025
  3. 2/9 clean: do not pass strbuf by valueJunio C Hamano, Jul 31, 2025
  4. 3/9 clean: do not use strbuf_split*() [part 1]Junio C Hamano, Jul 31, 2025
  5. 4/9 clean: do not use strbuf_split*() [part 2]Junio C Hamano, Jul 31, 2025
  6. 5/9 merge-tree: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  7. 6/9 notes: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  8. Eric SunshineJul 31, 2025
  9. 7/9 config: do not use strbuf_split()Junio C Hamano, Jul 31, 2025
  10. Eric SunshineJul 31, 2025
  11. 8/9 environment: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  12. 9/9 sub-process: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  13. Christian CouderJul 31, 2025
  14. Junio C HamanoJul 31, 2025
  15. 00/11 do not overuse strbuf_split*()Junio C Hamano, Jul 31, 2025
  16. 01/11 wt-status: avoid strbuf_split*()Junio C Hamano, Jul 31, 2025
  17. 02/11 clean: do not pass strbuf by valueJunio C Hamano, Jul 31, 2025
  18. Jeff KingAug 2, 2025
  19. Junio C HamanoAug 2, 2025
  20. Jeff KingAug 2, 2025
  21. 03/11 clean: do not use strbuf_split*() [part 1]Junio C Hamano, Jul 31, 2025
  22. 04/11 clean: do not use strbuf_split*() [part 2]Junio C Hamano, Jul 31, 2025
  23. 05/11 merge-tree: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  24. Jeff KingAug 2, 2025
  25. 06/11 notes: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  26. 07/11 config: do not use strbuf_split()Junio C Hamano, Jul 31, 2025
  27. 08/11 environment: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  28. 09/11 sub-process: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  29. 10/11 trace2: trim_trailing_newline followed by trim is a no-opJunio C Hamano, Jul 31, 2025
  30. 11/11 trace2: do not use strbuf_split*()Junio C Hamano, Jul 31, 2025
  31. Jeff KingAug 2, 2025
  32. Junio C HamanoAug 2, 2025
  33. Jeff KingAug 2, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.