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>

diff --git a/pretty.c b/pretty.c
index 59cefdddf674818423d484fc2a5b765b690bc68b..ed16b32df92296c255f76fc8e9a41fb387ef8e1e 100644 (file)
--- a/pretty.c
+++ b/pretty.c
@@ -1152,12 +1152,16 @@ int format_set_trailers_options(struct process_trailer_options *opts,
                                struct string_list *filter_list,
                                struct strbuf *sepbuf,
                                struct strbuf *kvsepbuf,
-                               const char **arg)
+                               const char **arg,
+                               char **invalid_arg)
 {
        for (;;) {
                const char *argval;
                size_t arglen;
 
+               if (**arg == ')')
+                       break;
+
                if (match_placeholder_arg_value(*arg, "key", arg, &argval, &arglen)) {
                        uintptr_t len = arglen;
 
@@ -1190,8 +1194,13 @@ int format_set_trailers_options(struct process_trailer_options *opts,
                } else if (!match_placeholder_bool_arg(*arg, "only", arg, &opts->only_trailers) &&
                           !match_placeholder_bool_arg(*arg, "unfold", arg, &opts->unfold) &&
                           !match_placeholder_bool_arg(*arg, "keyonly", arg, &opts->key_only) &&
-                          !match_placeholder_bool_arg(*arg, "valueonly", arg, &opts->value_only))
-                       break;
+                          !match_placeholder_bool_arg(*arg, "valueonly", arg, &opts->value_only)) {
+                       if (invalid_arg) {
+                               size_t len = strcspn(*arg, ",)");
+                               *invalid_arg = xstrndup(*arg, len);
+                       }
+                       return -1;
+               }
        }
        return 0;
 }
@@ -1473,7 +1482,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
 
                if (*arg == ':') {
                        arg++;
-                       if (format_set_trailers_options(&opts, &filter_list, &sepbuf, &kvsepbuf, &arg))
+                       if (format_set_trailers_options(&opts, &filter_list, &sepbuf, &kvsepbuf, &arg, NULL))
                                goto trailer_out;
                }
                if (*arg == ')') {

diff --git a/pretty.h b/pretty.h
index 7369cf7e14843092a00bdae3b302fc1394ca7512..d902cdd70a956c39bf319b9f027a6a73a4c173ef 100644 (file)
--- a/pretty.h
+++ b/pretty.h
@@ -151,6 +151,7 @@ int format_set_trailers_options(struct process_trailer_options *opts,
                        struct string_list *filter_list,
                        struct strbuf *sepbuf,
                        struct strbuf *kvsepbuf,
-                       const char **arg);
+                       const char **arg,
+                       char **invalid_arg);
 
 #endif /* PRETTY_H */