From: Slavica Djukic <slavicadj.ip2018@gmail.com>
To: Junio C Hamano <gitster@pobox.com>,
Slavica Djukic via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Phillip Wood" <phillip.wood@dunelm.org.uk>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: Re: [PATCH v5 04/10] add-interactive.c: implement list_and_choose
Date: Fri, 1 Mar 2019 12:20:57 +0100 [thread overview]
Message-ID: <25f71e47-acad-e985-4f3f-ecde77f883d6@gmail.com> (raw)
In-Reply-To: <xmqqd0njpkd5.fsf@gitster-ct.c.googlers.com>
On 22-Feb-19 10:46 PM, Junio C Hamano wrote:
> "Slavica Djukic via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> +#define HEADER_INDENT " "
>> +
>> enum collection_phase {
>> WORKTREE,
>> INDEX
>> @@ -27,6 +29,61 @@ struct collection_status {
>> struct hashmap file_map;
>> };
>>
>> +struct list_and_choose_options {
>> + int column_n;
>> + unsigned singleton:1;
>> + unsigned list_flat:1;
>> + unsigned list_only:1;
>> + unsigned list_only_file_names:1;
>> + unsigned immediate:1;
>> + char *header;
>> + const char *prompt;
> Makes a reader wonder if "header" can also be const (not to be taken
> as a suggestion to bend backwards to make it so).
>
>> + void (*on_eof_fn)(void);
>> +};
>> +
>> +struct choice {
>> + struct hashmap_entry e;
>> + char type;
> If this is for choosing among the member of union, possible value(s)
> for the type member and which value corresponds to which union
> member must be documented somewhere, perhaps as a comment around
> here.
>
>> + union {
>> + void (*command_fn)(void);
>> + struct {
>> + struct {
>> + uintmax_t added, deleted;
>> + } index, worktree;
>> + } file;
>> + } u;
>> + size_t prefix_length;
>> + const char *name;
>> +};
>> +
>> +struct choices {
>> + struct choice **choices;
> In general, do not name an array in plural. An exception is when
> the code mostly refers to the array as a whole.
>
> When most accesses are to individual elements, then it would be a
> big win to be able to see choice[2] and pronounce it "the second
> choice" (you do not say "the second choices").
>
>> + size_t alloc, nr;
>> +};
>> +#define CHOICES_INIT { NULL, 0, 0 }
>> +
>> +static int use_color = -1;
>> +enum color_add_i {
>> + COLOR_PROMPT,
>> + COLOR_HEADER,
>> + COLOR_HELP,
>> + COLOR_ERROR
>> +};
>> +
>> +static char colors[][COLOR_MAXLEN] = {
> Do not be overly selfish to assume that this will stay to be the
> only color pallette in this file. If this is the color palette for
> list_and_choose, then have it in its name, e.g. list_and_choose_color[]
> or something like that.
>
>> + GIT_COLOR_BOLD_BLUE, /* Prompt */
>> + GIT_COLOR_BOLD, /* Header */
>> + GIT_COLOR_BOLD_RED, /* Help */
>> + GIT_COLOR_RESET /* Reset */
>> +};
> Is the above list of values and comments correct?
>
> Doesn't each member of enum correspond to each element in
> list_and_choose_color[][COLOR_MAXLEN] array? It does not exactly
> match my intuition to have help text in red and error messages in
> plain color.
I noticed I didn't add colors in corresponding commits, but list is
correct -- later
on in patch series there is
GIT_COLOR_BOLD_RED, /* Error*/
added so that error messages are shown in red.
Help text is also in red following up what is happening in
git-add--interactive.perl.
>> @@ -186,3 +243,73 @@ static struct collection_status *list_modified(struct repository *r, const char
>> free(files);
>> return s;
>> }
>> +
>> +static struct choices *list_and_choose(struct choices *data,
>> + struct list_and_choose_options *opts)
>> +{
>> + if (!data)
>> + return NULL;
>> +
>> + while (1) {
>> + int last_lf = 0;
>> +
>> + if (opts->header) {
>> + const char *header_color = get_color(COLOR_HEADER);
>> + if (!opts->list_flat)
>> + printf(HEADER_INDENT);
> I won't complain if this is sufficient for the application, but the
> above would not allow different level of indentation depending on
> what header is being shown. It may make sense to get rid of list_flat
> boolean and instead allow a new "const char *header_indent" member
> in the opts structure supplied by the caller.
>
> Don't use printf() when you _know_ you want to show a simple string
> without any % interpolation. fputs(HEADER_INDENT, stdout) would suffice.
>
>> + color_fprintf_ln(stdout, header_color, "%s", opts->header);
>> + }
>> +
>> + for (int i = 0; i < data->nr; i++) {
> We do not say "for (int i" (see a previous review).
>
>> + struct choice *c = data->choices[i];
>> + char *print;
>> + const char *modified_fmt = _("%12s %12s %s");
>> + char worktree_changes[50];
>> + char index_changes[50];
>> + char print_buf[100];
> It appears that many of these variables are only needed inside "we
> are showing 'f' and not just names" block. Can their scope be
> narrowed?
Yes, I will change this.
>
>> + print = (char *)c->name;
> Yuck. Stuff c->name into print_buf[] instead and get rid of "print"
> pointer.
>
>> + if ((data->choices[i]->type == 'f') && (!opts->list_only_file_names)) {
>> + uintmax_t worktree_added = c->u.file.worktree.added;
>> + uintmax_t worktree_deleted = c->u.file.worktree.deleted;
>> + uintmax_t index_added = c->u.file.index.added;
>> + uintmax_t index_deleted = c->u.file.index.deleted;
>> +
>> + if (worktree_added || worktree_deleted)
>> + snprintf(worktree_changes, 50, "+%"PRIuMAX"/-%"PRIuMAX,
>> + worktree_added, worktree_deleted);
>> + else
>> + snprintf(worktree_changes, 50, "%s", _("nothing"));
>> + if (index_added || index_deleted)
>> + snprintf(index_changes, 50, "+%"PRIuMAX"/-%"PRIuMAX,
>> + index_added, index_deleted);
>> + else
>> + snprintf(index_changes, 50, "%s", _("unchanged"));
>> +
>> + snprintf(print_buf, 100, modified_fmt, index_changes,
>> + worktree_changes, print);
> All of the above look overly repetitious; a helper function that
> takes a pointer to "struct { uintmax_t a, d; }" and populates
> changes[] buffer would cut them down by half, but other than that
> I do not see a room for drastic improvement here X-<.
>
> Oh, it would greatly help to use two strbuf for wt/ix_changes that
> are defined outside the loop that is strbuf_reset() after each
> iteration and use things like strbuf_addf().
>
>> + print = xmalloc(strlen(print_buf) + 1);
>> + snprintf(print, 100, "%s", print_buf);
> Likewise.
>
>> + }
>> +
>> + printf(" %2d: %s", i + 1, print);
>> + if ((opts->list_flat) && ((i + 1) % (opts->column_n))) {
>> + printf("\t");
>> + last_lf = 0;
>> + }
>> + else {
>> + printf("\n");
>> + last_lf = 1;
>> + }
>> +
>> + }
>> +
>> + if (!last_lf)
>> + printf("\n");
>> +
>> + return NULL;
>> + }
>> +}
> This obviously only lists but does not let you choose at this step
> in the series, but that is OK.
>
> But I see a deeper problem with the design of this helper. The
> things this helper can list is quite limited.
>
> The original was designed so that the shown strings are prepared by
> the caller and this helper is solely responsible for showing the
> choices, giving prompt, and accepting choice (in various abbreviated
> forms), all _WITHOUT_ having to know the meaning of what is in the
> list. It gave us a much better separation of labor and
> responsibility between the caller and the callee, I would think.
>
Thanks for pointing this out. I talked to my mentor and I'm now working on
making list_and_choose more "type-independent".
I didn't reply to all suggestions in this message, but I did apply them
in the code.
>
next prev parent reply other threads:[~2019-03-01 11:21 UTC|newest]
Thread overview: 76+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-20 12:34 [PATCH 0/7] Turn git add-i into built-in Johannes Schindelin
2018-12-20 12:09 ` [PATCH 1/7] diff: export diffstat interface Daniel Ferreira via GitGitGadget
2018-12-20 12:09 ` [PATCH 2/7] add--helper: create builtin helper for interactive add Daniel Ferreira via GitGitGadget
2018-12-20 12:09 ` [PATCH 3/7] add-interactive.c: implement status command Daniel Ferreira via GitGitGadget
2018-12-20 12:09 ` [PATCH 4/7] add--interactive.perl: use add--helper --status for status_cmd Daniel Ferreira via GitGitGadget
2018-12-20 12:09 ` [PATCH 5/7] add-interactive.c: implement show-help command Slavica Djukic via GitGitGadget
2019-01-14 11:12 ` Phillip Wood
2018-12-20 12:09 ` [PATCH 6/7] Git.pm: introduce environment variable GIT_TEST_PRETEND_TTY Slavica Djukic via GitGitGadget
2019-01-14 11:13 ` Phillip Wood
2019-01-15 12:45 ` Slavica Djukic
2019-01-15 13:50 ` Johannes Schindelin
2019-01-15 16:09 ` Phillip Wood
2018-12-20 12:09 ` [PATCH 7/7] add--interactive.perl: use add--helper --show-help for help_cmd Slavica Djukic via GitGitGadget
2019-01-14 11:17 ` Phillip Wood
2018-12-20 12:37 ` [PATCH 0/7] Turn git add-i into built-in Johannes Schindelin
2019-01-11 14:09 ` Slavica Djukic
2019-01-18 7:47 ` [PATCH v2 " Slavica Đukić via GitGitGadget
2019-01-18 7:47 ` [PATCH v2 1/7] diff: export diffstat interface Daniel Ferreira via GitGitGadget
2019-01-18 7:47 ` [PATCH v2 2/7] add--helper: create builtin helper for interactive add Daniel Ferreira via GitGitGadget
2019-01-18 7:47 ` [PATCH v2 3/7] add-interactive.c: implement status command Daniel Ferreira via GitGitGadget
2019-01-18 7:47 ` [PATCH v2 4/7] add--interactive.perl: use add--helper --status for status_cmd Daniel Ferreira via GitGitGadget
2019-01-18 7:47 ` [PATCH v2 5/7] add-interactive.c: implement show-help command Slavica Djukic via GitGitGadget
2019-01-18 11:20 ` Phillip Wood
2019-01-18 12:19 ` Slavica Djukic
[not found] ` <VI1PR05MB577331CCE110D2EAE325927CA69C0@VI1PR05MB5773.eurprd05.prod.outlook.com>
2019-01-18 14:25 ` Phillip Wood
2019-01-18 20:40 ` Johannes Schindelin
2019-01-18 7:47 ` [PATCH v2 6/7] t3701-add-interactive: test add_i_show_help() Slavica Djukic via GitGitGadget
2019-01-18 11:23 ` Phillip Wood
2019-01-18 7:47 ` [PATCH v2 7/7] add--interactive.perl: use add--helper --show-help for help_cmd Slavica Djukic via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 0/7] Turn git add-i into built-in Slavica Đukić via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 1/7] diff: export diffstat interface Daniel Ferreira via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 3/7] add-interactive.c: implement status command Daniel Ferreira via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 2/7] add--helper: create builtin helper for interactive add Daniel Ferreira via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 4/7] add--interactive.perl: use add--helper --status for status_cmd Daniel Ferreira via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 5/7] add-interactive.c: implement show-help command Slavica Djukic via GitGitGadget
2019-01-21 9:13 ` [PATCH v3 6/7] t3701-add-interactive: test add_i_show_help() Slavica Djukic via GitGitGadget
2019-01-25 11:01 ` Phillip Wood
2019-01-25 11:36 ` Slavica Djukic
2019-01-21 9:13 ` [PATCH v3 7/7] add--interactive.perl: use add--helper --show-help for help_cmd Slavica Djukic via GitGitGadget
2019-01-21 9:59 ` Ævar Arnfjörð Bjarmason
2019-01-21 11:59 ` Slavica Djukic
2019-01-25 12:23 ` [PATCH v4 0/7] Turn git add-i into built-in Slavica Đukić via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 1/7] diff: export diffstat interface Daniel Ferreira via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 2/7] add--helper: create builtin helper for interactive add Daniel Ferreira via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 3/7] add-interactive.c: implement status command Daniel Ferreira via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 4/7] add--interactive.perl: use add--helper --status for status_cmd Daniel Ferreira via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 6/7] t3701-add-interactive: test add_i_show_help() Slavica Djukic via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 5/7] add-interactive.c: implement show-help command Slavica Djukic via GitGitGadget
2019-01-25 12:23 ` [PATCH v4 7/7] add--interactive.perl: use add--helper --show-help for help_cmd Slavica Djukic via GitGitGadget
2019-01-25 12:37 ` [PATCH v4 0/7] Turn git add-i into built-in Slavica Djukic
2019-02-01 14:37 ` Phillip Wood
2019-02-20 11:41 ` [PATCH v5 00/10] " Slavica Đukić via GitGitGadget
2019-02-20 11:41 ` [PATCH v5 02/10] add--helper: create builtin helper for interactive add Daniel Ferreira via GitGitGadget
2019-02-21 17:56 ` Junio C Hamano
2019-03-08 20:48 ` Johannes Schindelin
2019-02-20 11:41 ` [PATCH v5 01/10] diff: export diffstat interface Daniel Ferreira via GitGitGadget
2019-02-21 17:53 ` Junio C Hamano
2019-02-22 9:03 ` Slavica Djukic
2019-02-20 11:41 ` [PATCH v5 03/10] add-interactive.c: implement list_modified Slavica Djukic via GitGitGadget
2019-02-21 19:06 ` Junio C Hamano
2019-02-21 20:27 ` Junio C Hamano
2019-02-22 12:18 ` Slavica Djukic
2019-02-22 11:35 ` Slavica Djukic
2019-02-20 11:41 ` [PATCH v5 04/10] add-interactive.c: implement list_and_choose Slavica Djukic via GitGitGadget
2019-02-22 21:46 ` Junio C Hamano
2019-03-01 11:20 ` Slavica Djukic [this message]
2019-02-20 11:41 ` [PATCH v5 05/10] add-interactive.c: implement status command Slavica Djukic via GitGitGadget
2019-02-22 22:11 ` Junio C Hamano
2019-03-01 11:08 ` Slavica Djukic
2019-02-20 11:41 ` [PATCH v5 06/10] add--interactive.perl: use add--helper --status for status_cmd Daniel Ferreira via GitGitGadget
2019-02-20 11:41 ` [PATCH v5 07/10] add-interactive.c: add support for list_only option Slavica Djukic via GitGitGadget
2019-02-20 11:41 ` [PATCH v5 08/10] add-interactive.c: implement show-help command Slavica Djukic via GitGitGadget
2019-02-20 11:41 ` [PATCH v5 10/10] add--interactive.perl: use add--helper --show-help for help_cmd Slavica Djukic via GitGitGadget
2019-02-20 11:41 ` [PATCH v5 09/10] t3701-add-interactive: test add_i_show_help() Slavica Djukic via GitGitGadget
2019-02-22 4:53 ` [PATCH v5 00/10] Turn git add-i into built-in Junio C Hamano
2019-03-04 10:49 ` End of Outreachy internship Slavica Djukic
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=25f71e47-acad-e985-4f3f-ecde77f883d6@gmail.com \
--to=slavicadj.ip2018@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=phillip.wood@dunelm.org.uk \
/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.
Code repositories for project(s) associated with this public 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).