]> git.ipfire.org Git - thirdparty/git.git/commit - notes.c
string-list: multi-delimiter `string_list_split_in_place()`
authorTaylor Blau <me@ttaylorr.com>
Mon, 24 Apr 2023 22:20:10 +0000 (18:20 -0400)
committerJunio C Hamano <gitster@pobox.com>
Mon, 24 Apr 2023 23:01:28 +0000 (16:01 -0700)
commit52acddf36c8cb3778ab2098a0d95cc2e375a4069
treedbd7ee8cff346ef7cc39f7aba4f23db6211b46b6
parent9857273be005833c71e2d16ba48e193113e12276
string-list: multi-delimiter `string_list_split_in_place()`

Enhance `string_list_split_in_place()` to accept multiple characters as
delimiters instead of a single character.

Instead of using `strchr(2)` to locate the first occurrence of the given
delimiter character, `string_list_split_in_place_multi()` uses
`strcspn(2)` to move past the initial segment of characters comprised of
any characters in the delimiting set.

When only a single delimiting character is provided, `strpbrk(2)` (which
is implemented with `strcspn(2)`) has equivalent performance to
`strchr(2)`. Modern `strcspn(2)` implementations treat an empty
delimiter or the singleton delimiter as a special case and fall back to
calling strchrnul(). Both glibc[1] and musl[2] implement `strcspn(2)`
this way.

This change is one step to removing `strtok(2)` from the tree. Note that
`string_list_split_in_place()` is not a strict replacement for
`strtok()`, since it will happily turn sequential delimiter characters
into empty entries in the resulting string_list. For example:

    string_list_split_in_place(&xs, "foo:;:bar:;:baz", ":;", -1)

would yield a string list of:

    ["foo", "", "", "bar", "", "", "baz"]

Callers that wish to emulate the behavior of strtok(2) more directly
should call `string_list_remove_empty_items()` after splitting.

To avoid regressions for the new multi-character delimter cases, update
t0063 in this patch as well.

[1]: https://sourceware.org/git/?p=glibc.git;a=blob;f=string/strcspn.c;hb=glibc-2.37#l35
[2]: https://git.musl-libc.org/cgit/musl/tree/src/string/strcspn.c?h=v1.2.3#n11

Signed-off-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/gc.c
diff.c
notes.c
refs/packed-backend.c
string-list.c
string-list.h
t/helper/test-string-list.c
t/t0063-string-list.sh