Re: [PATCH 1/2] pretty.c: refactor trailer logic to `format_set_trailers_options()`
- From
René Scharfe <l.s.r@web.de>
- Date
- Sep 5, 2020, 21:59 UTC
- Message-ID
- <bf4423d5-c0ee-6bef-59ff-fcde003ec463@web.de>
- In-Reply-To
- <4180f54c1de51a3b9e29ef42b035bb31215875e3.1599335291.git.gitgitgadget@gmail.com>
Am 05.09.20 um 21:48 schrieb Hariom Verma via GitGitGadget:
Show 9 quoted lines
> From: Hariom Verma <hariom18599@gmail.com> > > Refactored trailers formatting logic inside pretty.c to a new function > `format_set_trailers_options()`. > > Also, introduced a code to get invalid trailer arguments. As we would > like to use same logic in ref-filter, it's nice to get invalid trailer > argument. This will allow us to print accurate error message, while > using `format_set_trailers_options()` in ref-filter.
This error reporting feature is probably worth its own separate commit.
Show 27 quoted lines
> > Mentored-by: Christian Couder <chriscool@tuxfamily.org> > Mentored-by: Heba Waly <heba.waly@gmail.com> > Signed-off-by: Hariom Verma <hariom18599@gmail.com> > --- > Hariom Verma via GitGitGadget | 0 > pretty.c | 83 ++++++++++++++++++++++------------- > pretty.h | 11 +++++ > 3 files changed, 64 insertions(+), 30 deletions(-) > create mode 100644 Hariom Verma via GitGitGadget > > diff --git a/Hariom Verma via GitGitGadget b/Hariom Verma via GitGitGadget > new file mode 100644 > index 0000000000..e69de29bb2 > diff --git a/pretty.c b/pretty.c > index 2a3d46bf42..bd8d38e27b 100644 > --- a/pretty.c > +++ b/pretty.c > @@ -1147,6 +1147,55 @@ static int format_trailer_match_cb(const struct strbuf *key, void *ud) > return 0; > } > > +int format_set_trailers_options(struct process_trailer_options *opts, > + struct string_list *filter_list, > + struct strbuf *sepbuf, > + const char **arg, > + const char **err)
This function is supposed to allocate *err, so it shouldn't be const.
Show 8 quoted lines
> +{
> + for (;;) {
> + const char *argval;
> + size_t arglen;
> +
> + if (**arg != ')') {
> + size_t vallen = strcspn(*arg, "=,)");
> + const char *valstart = xstrndup(*arg, vallen);This is owned by this block and released a few lines down, so it shouldn't be const.
Show 5 quoted lines
> + if (strcmp(valstart, "key") &&
> + strcmp(valstart, "separator") &&
> + strcmp(valstart, "only") &&
> + strcmp(valstart, "valueonly") &&
> + strcmp(valstart, "unfold")) {Weird indentation of the second and later strcmp() calls. And they duplicate the checks done by the parsing code below, right?
> + *err = xstrdup(valstart);
Here's the *err allocation mentioned above.
Show 13 quoted lines
> + return 1;
> + }
> + free((char *)valstart);
> + }
> + if (match_placeholder_arg_value(*arg, "key", arg, &argval, &arglen)) {
> + uintptr_t len = arglen;
> +
> + if (!argval)
> + return 1;
> +
> + if (len && argval[len - 1] == ':')
> + len--;
> + string_list_append(filter_list, argval)->util = (char *)len;You didn't add this, but I wonder what's up with the arglen-in-util trickery here -- strcasecmp() might even be faster.
And also why all this expensive-looking %(trailers) parsing is done for each commit and not just once.
(Both outside the scope of this series, unless you want to address them as well.)
Show 12 quoted lines
> +
> + opts->filter = format_trailer_match_cb;
> + opts->filter_data = filter_list;
> + opts->only_trailers = 1;
> + } else if (match_placeholder_arg_value(*arg, "separator", arg, &argval, &arglen)) {
> + char *fmt = xstrndup(argval, arglen);
> + strbuf_expand(sepbuf, fmt, strbuf_expand_literal_cb, NULL);
> + free(fmt);
> + opts->separator = sepbuf;
> + } 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, "valueonly", arg, &opts->value_only))Weird indentation of the second and third match_placeholder_bool_arg() calls.
> + break;
If you need to capture an invalid argument value, you can do that here without adding duplicate checks.
Show 12 quoted lines
> + } > + return 0; > +} > + > static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ > const char *placeholder, > void *context) > @@ -1417,41 +1466,14 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ > struct string_list filter_list = STRING_LIST_INIT_NODUP; > struct strbuf sepbuf = STRBUF_INIT; > size_t ret = 0; > + const char *unused = NULL;
This function is going to free() unused later, so it shouldn't be const.
Show 33 quoted lines
>
> opts.no_divider = 1;
>
> if (*arg == ':') {
> arg++;
> - for (;;) {
> - const char *argval;
> - size_t arglen;
> -
> - if (match_placeholder_arg_value(arg, "key", &arg, &argval, &arglen)) {
> - uintptr_t len = arglen;
> -
> - if (!argval)
> - goto trailer_out;
> -
> - if (len && argval[len - 1] == ':')
> - len--;
> - string_list_append(&filter_list, argval)->util = (char *)len;
> -
> - opts.filter = format_trailer_match_cb;
> - opts.filter_data = &filter_list;
> - opts.only_trailers = 1;
> - } else if (match_placeholder_arg_value(arg, "separator", &arg, &argval, &arglen)) {
> - char *fmt;
> -
> - strbuf_reset(&sepbuf);
> - fmt = xstrndup(argval, arglen);
> - strbuf_expand(&sepbuf, fmt, strbuf_expand_literal_cb, NULL);
> - free(fmt);
> - opts.separator = &sepbuf;
> - } 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, "valueonly", &arg, &opts.value_only))The match_placeholder_bool_arg() calls were still properly indented here.
Show 12 quoted lines
> - break;
> - }
> + if (format_set_trailers_options(&opts, &filter_list, &sepbuf, &arg, &unused))
> + goto trailer_out;
> }
> if (*arg == ')') {
> format_trailers_from_commit(sb, msg + c->subject_off, &opts);
> @@ -1460,6 +1482,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
> trailer_out:
> string_list_clear(&filter_list, 0);
> strbuf_release(&sepbuf);
> + free((char *)unused);Here is the free() call I mentioned above.
Show 31 quoted lines
> return ret;
> }
>
> diff --git a/pretty.h b/pretty.h
> index 071f2fb8e4..cfe2e8b39b 100644
> --- a/pretty.h
> +++ b/pretty.h
> @@ -6,6 +6,7 @@
>
> struct commit;
> struct strbuf;
> +struct process_trailer_options;
>
> /* Commit formats */
> enum cmit_fmt {
> @@ -139,4 +140,14 @@ const char *format_subject(struct strbuf *sb, const char *msg,
> /* Check if "cmit_fmt" will produce an empty output. */
> int commit_format_is_empty(enum cmit_fmt);
>
> +/*
> + * Set values of fields in "struct process_trailer_options"
> + * according to trailers arguments.
> + */
> +int format_set_trailers_options(struct process_trailer_options *opts,
> + struct string_list *filter_list,
> + struct strbuf *sepbuf,
> + const char **arg,
> + const char **err);
> +
> #endif /* PRETTY_H */
>