From: Eric Sunshine <sunshine@sunshineco.com>
To: Karthik Nayak <karthik.188@gmail.com>
Cc: Git List <git@vger.kernel.org>,
Christian Couder <christian.couder@gmail.com>,
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>,
Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v9 02/11] ref-filter: introduce ref_formatting_state
Date: Thu, 6 Aug 2015 20:19:00 -0400 [thread overview]
Message-ID: <CAPig+cQftyjKFi0Qkg_ZVEJ9A+zGSAmFtHwQ-8hCnf8xtU_PEA@mail.gmail.com> (raw)
In-Reply-To: <1438692188-14367-2-git-send-email-Karthik.188@gmail.com>
On Tue, Aug 4, 2015 at 8:42 AM, Karthik Nayak <karthik.188@gmail.com> wrote:
> Introduce a ref_formatting_state which will eventually hold the values
> of modifier atoms. Implement this within ref-filter.
>
> Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
> ---
> +static void apply_formatting_state(struct ref_formatting_state *state, struct strbuf *final)
> +{
> + /* More formatting options to be evetually added */
> + strbuf_addbuf(final, state->output);
> + strbuf_release(state->output);
I guess the idea here is that you intend state->output to be re-used
and it is convenient to "clear" it here rather than making that the
responsibility of each caller. For re-use, it is more typical to use
strbuf_reset() than strbuf_release() (though Junio may disagree[1]).
[1]: http://article.gmane.org/gmane.comp.version-control.git/273094
> +}
> +
> void show_ref_array_item(struct ref_array_item *info, const char *format, int quote_style)
> {
> const char *cp, *sp, *ep;
> - struct strbuf output = STRBUF_INIT;
> + struct strbuf value = STRBUF_INIT;
> + struct strbuf final_buf = STRBUF_INIT;
> + struct ref_formatting_state state;
> int i;
>
> + memset(&state, 0, sizeof(state));
> + state.quote_style = quote_style;
> + state.output = &value;
It feels strange to assign a local variable reference to state.output,
and there's no obvious reason why you should need to do so. I would
have instead expected ref_format_state to be declared as:
struct ref_formatting_state {
int quote_style;
struct strbuf output;
};
and initialized as so:
memset(&state, 0, sizeof(state));
state.quote_style = quote_style;
strbuf_init(&state.output, 0);
(In fact, the memset() isn't even necessary here since you're
initializing all fields explicitly, though perhaps you want the
memset() because a future patch adds more fields which are not
initialized explicitly?)
This still allows re-use via strbuf_reset() mentioned above.
And, of course, you'd want to strbuf_release() it at the end of this
function where you're already releasing final_buf.
> for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
> - struct atom_value *atomv;
> + struct atom_value *atomv = NULL;
What is this change about?
> ep = strchr(sp, ')');
> - if (cp < sp)
> - emit(cp, sp, &output);
> + if (cp < sp) {
> + emit(cp, sp, &state);
> + apply_formatting_state(&state, &final_buf);
> + }
> get_ref_atom_value(info, parse_ref_filter_atom(sp + 2, ep), &atomv);
> - print_value(atomv, quote_style, &output);
> + process_formatting_state(atomv, &state);
> + print_value(atomv, &state);
> + apply_formatting_state(&state, &final_buf);
> }
> if (*cp) {
> sp = cp + strlen(cp);
> - emit(cp, sp, &output);
> + emit(cp, sp, &state);
> + apply_formatting_state(&state, &final_buf);
I'm getting the feeling that these functions
(process_formatting_state, print_value, emit, apply_formatting_state)
are becoming misnamed (again) with the latest structural changes (but
perhaps I haven't read far enough into the series yet?).
process_formatting_state() is rather generic.
print_value() and emit() both imply outputting something, but neither
does so anymore.
apply_formatting_state() seems to be more about finalizing the
already-formatted output.
next prev parent reply other threads:[~2015-08-07 0:19 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-04 12:39 [PATCH v9 0/11] Port tag.c over to use ref-filter APIs Karthik Nayak
2015-08-04 12:42 ` [PATCH v9 01/11] ref-filter: print output to strbuf for formatting Karthik Nayak
2015-08-04 12:42 ` [PATCH v9 02/11] ref-filter: introduce ref_formatting_state Karthik Nayak
2015-08-07 0:19 ` Eric Sunshine [this message]
2015-08-07 3:53 ` Karthik Nayak
2015-08-07 4:43 ` Eric Sunshine
2015-08-07 11:37 ` Karthik Nayak
2015-08-07 17:30 ` Eric Sunshine
2015-08-07 17:50 ` Karthik Nayak
2015-08-07 3:36 ` Eric Sunshine
2015-08-04 12:43 ` [PATCH v9 03/11] ref-filter: implement an `align` atom Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 04/11] ref-filter: add option to filter only tags Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 05/11] ref-filter: support printing N lines from tag annotation Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 06/11] ref-filter: add support to sort by version Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 07/11] ref-filter: add option to match literal pattern Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 08/11] tag.c: use 'ref-filter' data structures Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 09/11] tag.c: use 'ref-filter' APIs Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 10/11] tag.c: implement '--format' option Karthik Nayak
2015-08-04 12:43 ` [PATCH v9 11/11] tag.c: implement '--merged' and '--no-merged' options Karthik Nayak
2015-08-06 22:21 ` [PATCH v9 01/11] ref-filter: print output to strbuf for formatting Eric Sunshine
2015-08-07 3:24 ` Karthik Nayak
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAPig+cQftyjKFi0Qkg_ZVEJ9A+zGSAmFtHwQ-8hCnf8xtU_PEA@mail.gmail.com \
--to=sunshine@sunshineco.com \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=karthik.188@gmail.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).