pretty.c: capture invalid trailer argument

As we would like to use this trailers logic in the ref-filter, it's nice to get an invalid trailer argument. This will allow us to print precise error message while using `format_set_trailers_options()` in ref-filter. For capturing the invalid argument, we changed the working of `format_set_trailers_options()` a little bit. Original logic does "break" and fell through in mainly 2 cases - 1. unknown/invalid argument 2. end of the arg string But now instead of "break", we capture invalid argument and return non-zero. And non-zero is handled by the caller. (We prepared the caller to handle non-zero in the previous commit). Capturing invalid arguments this way will also affects the working of current logic. As at the end of the arg string it will return non-zero. So in order to make things correct, introduced an additional conditional statement i.e if encounter ")", do 'break'. Mentored-by: Christian Couder <chriscool@tuxfamily.org> Mentored-by: Heba Waly <heba.waly@gmail.com> Signed-off-by: Hariom Verma <hariom18599@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Hariom Verma committed Feb 13, 2021 at 01:52 UTC 636a0aeedfee5f3cce2ebf1fcc174a49ab9bb0c3
2 files changed +15 -5
pretty.c
+13 -4
@@ -1152,12 +1152,16 @@ int format_set_trailers_options(struct process_trailer_options *opts,
1152 struct string_list *filter_list,
1153 struct strbuf *sepbuf,
1154 struct strbuf *kvsepbuf,
1155 - const char **arg)
1155 + const char **arg,
1156 + char **invalid_arg)
1157 {
1158 for (;;) {
1159 const char *argval;
1160 size_t arglen;
1161
1162 + if (**arg == ')')
1163 + break;
1164 +
1165 if (match_placeholder_arg_value(*arg, "key", arg, &argval, &arglen)) {
1166 uintptr_t len = arglen;
1167
@@ -1190,8 +1194,13 @@ int format_set_trailers_options(struct process_trailer_options *opts,
1194 } else if (!match_placeholder_bool_arg(*arg, "only", arg, &opts->only_trailers) &&
1195 !match_placeholder_bool_arg(*arg, "unfold", arg, &opts->unfold) &&
1196 !match_placeholder_bool_arg(*arg, "keyonly", arg, &opts->key_only) &&
1193 - !match_placeholder_bool_arg(*arg, "valueonly", arg, &opts->value_only))
1194 - break;
1197 + !match_placeholder_bool_arg(*arg, "valueonly", arg, &opts->value_only)) {
1198 + if (invalid_arg) {
1199 + size_t len = strcspn(*arg, ",)");
1200 + *invalid_arg = xstrndup(*arg, len);
1201 + }
1202 + return -1;
1203 + }
1204 }
1205 return 0;
1206 }
@@ -1473,7 +1482,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
1482
1483 if (*arg == ':') {
1484 arg++;
1476 - if (format_set_trailers_options(&opts, &filter_list, &sepbuf, &kvsepbuf, &arg))
1485 + if (format_set_trailers_options(&opts, &filter_list, &sepbuf, &kvsepbuf, &arg, NULL))
1486 goto trailer_out;
1487 }
1488 if (*arg == ')') {
pretty.h
+2 -1
@@ -151,6 +151,7 @@ int format_set_trailers_options(struct process_trailer_options *opts,
151 struct string_list *filter_list,
152 struct strbuf *sepbuf,
153 struct strbuf *kvsepbuf,
154 - const char **arg);
154 + const char **arg,
155 + char **invalid_arg);
156
157 #endif /* PRETTY_H */