git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: "René Scharfe" <l.s.r@web.de>
To: Hariom Verma via GitGitGadget <gitgitgadget@gmail.com>,
	git@vger.kernel.org
Cc: Hariom Verma <hariom18599@gmail.com>
Subject: Re: [PATCH 1/2] pretty.c: refactor trailer logic to `format_set_trailers_options()`
Date: Sat, 5 Sep 2020 23:59:46 +0200	[thread overview]
Message-ID: <bf4423d5-c0ee-6bef-59ff-fcde003ec463@web.de> (raw)
In-Reply-To: <4180f54c1de51a3b9e29ef42b035bb31215875e3.1599335291.git.gitgitgadget@gmail.com>

Am 05.09.20 um 21:48 schrieb Hariom Verma via GitGitGadget:
> 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.

>
> 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.

> +{
> +	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.

> +			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.

> +					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.)

> +
> +			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.

> +	}
> +	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.

>
>  		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.

> -					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.

>  		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 */
>


  reply	other threads:[~2020-09-05 21:59 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-05 19:48 [PATCH 0/2] Unify trailers formatting logic for pretty.c and ref-filter.c Hariom Verma via GitGitGadget
2020-09-05 19:48 ` [PATCH 1/2] pretty.c: refactor trailer logic to `format_set_trailers_options()` Hariom Verma via GitGitGadget
2020-09-05 21:59   ` René Scharfe [this message]
2020-09-05 19:48 ` [PATCH 2/2] ref-filter: using pretty.c logic for trailers Hariom Verma via GitGitGadget
2021-01-29 21:09 ` [PATCH v2 0/3] Unify trailers formatting logic for pretty.c and ref-filter.c Hariom Verma via GitGitGadget
2021-01-29 21:09   ` [PATCH v2 1/3] pretty.c: refactor trailer logic to `format_set_trailers_options()` Hariom Verma via GitGitGadget
2021-01-29 23:49     ` Junio C Hamano
2021-01-29 21:09   ` [PATCH v2 2/3] pretty.c: capture invalid trailer argument Hariom Verma via GitGitGadget
2021-01-29 22:28     ` Christian Couder
2021-01-30 19:16       ` Hariom verma
2021-01-30  0:01     ` Junio C Hamano
2021-01-30 19:00       ` Hariom verma
2021-01-30  0:07     ` Junio C Hamano
2021-01-30 19:06       ` Hariom verma
2021-01-29 21:09   ` [PATCH v2 3/3] ref-filter: use pretty.c logic for trailers Hariom Verma via GitGitGadget
2021-01-30 20:45     ` Ævar Arnfjörð Bjarmason
2021-02-04 18:46       ` Hariom verma
2021-02-04 20:53         ` Ævar Arnfjörð Bjarmason
2021-01-30  1:17   ` [PATCH v2 0/3] Unify trailers formatting logic for pretty.c and ref-filter.c Junio C Hamano
2021-01-30  1:28   ` Junio C Hamano
2021-01-30 19:15     ` Hariom verma
2021-01-30 20:20     ` Junio C Hamano
2021-02-06  9:15   ` [PATCH v3 " Hariom Verma via GitGitGadget
2021-02-06  9:15     ` [PATCH v3 1/3] pretty.c: refactor trailer logic to `format_set_trailers_options()` Hariom Verma via GitGitGadget
2021-02-06  9:15     ` [PATCH v3 2/3] pretty.c: capture invalid trailer argument Hariom Verma via GitGitGadget
2021-02-06  9:15     ` [PATCH v3 3/3] ref-filter: use pretty.c logic for trailers Hariom Verma via GitGitGadget
2021-02-07  5:45       ` Junio C Hamano
2021-02-07 12:06         ` Hariom verma
2021-02-07 18:19           ` Junio C Hamano
2021-02-07 19:38             ` Hariom verma
2021-02-07 20:09               ` Junio C Hamano
2021-02-08 17:07                 ` Hariom verma
2021-02-08 18:29                   ` Junio C Hamano
     [not found]                     ` <xmqqlfby5o9h.fsf@gitster.c.googlers.com>
2021-02-08 23:43                       ` brian m. carlson
2021-02-09  3:04                       ` brian m. carlson
2021-02-09 20:54                         ` Junio C Hamano
2021-02-07  3:33     ` [PATCH v3 0/3] Unify trailers formatting logic for pretty.c and ref-filter.c Junio C Hamano
2021-02-07  5:06       ` Junio C Hamano
2021-02-13  1:52     ` [PATCH v4 0/4] " Hariom Verma via GitGitGadget
2021-02-13  1:52       ` [PATCH v4 1/4] t6300: use function to test trailer options Hariom Verma via GitGitGadget
2021-02-13  1:52       ` [PATCH v4 2/4] pretty.c: refactor trailer logic to `format_set_trailers_options()` Hariom Verma via GitGitGadget
2021-02-13  1:52       ` [PATCH v4 3/4] pretty.c: capture invalid trailer argument Hariom Verma via GitGitGadget
2021-02-13  1:52       ` [PATCH v4 4/4] ref-filter: use pretty.c logic for trailers Hariom Verma via GitGitGadget

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bf4423d5-c0ee-6bef-59ff-fcde003ec463@web.de \
    --to=l.s.r@web.de \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=hariom18599@gmail.com \
    --subject='Re: [PATCH 1/2] pretty.c: refactor trailer logic to `format_set_trailers_options()`' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).