2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <sys/queue.h>
20 #define _XOPEN_SOURCE_EXTENDED
22 #undef _XOPEN_SOURCE_EXTENDED
35 #include "got_error.h"
36 #include "got_object.h"
37 #include "got_reference.h"
38 #include "got_repository.h"
40 #include "got_opentemp.h"
41 #include "got_commit_graph.h"
45 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
49 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
54 const struct got_error *(*cmd_main)(int, char *[]);
55 void (*cmd_usage)(void);
59 __dead static void usage(void);
60 __dead static void usage_log(void);
61 __dead static void usage_diff(void);
62 __dead static void usage_blame(void);
64 static const struct got_error* cmd_log(int, char *[]);
65 static const struct got_error* cmd_diff(int, char *[]);
66 static const struct got_error* cmd_blame(int, char *[]);
68 static struct tog_cmd tog_commands[] = {
69 { "log", cmd_log, usage_log,
70 "show repository history" },
71 { "diff", cmd_diff, usage_diff,
72 "compare files and directories" },
73 { "blame", cmd_blame, usage_blame,
74 "show line-by-line file history" },
77 static struct tog_view {
80 } tog_log_view, tog_diff_view;
82 static const struct got_error *
83 show_diff_view(struct got_object *, struct got_object *,
84 struct got_repository *);
85 static const struct got_error *
86 show_log_view(struct got_object_id *, struct got_repository *);
92 fprintf(stderr, "usage: %s log [-c commit] [repository-path]\n",
97 /* Create newly allocated wide-character string equivalent to a byte string. */
98 static const struct got_error *
99 mbs2ws(wchar_t **ws, size_t *wlen, const char *s)
102 const struct got_error *err = NULL;
105 *wlen = mbstowcs(NULL, s, 0);
106 if (*wlen == (size_t)-1) {
109 return got_error_from_errno();
111 /* byte string invalid in current encoding; try to "fix" it */
112 err = got_mbsavis(&vis, &vislen, s);
115 *wlen = mbstowcs(NULL, vis, 0);
116 if (*wlen == (size_t)-1) {
117 err = got_error_from_errno(); /* give up */
122 *ws = calloc(*wlen + 1, sizeof(*ws));
124 err = got_error_from_errno();
128 if (mbstowcs(*ws, vis ? vis : s, *wlen) != *wlen)
129 err = got_error_from_errno();
140 /* Format a line for display, ensuring that it won't overflow a width limit. */
141 static const struct got_error *
142 format_line(wchar_t **wlinep, int *widthp, char *line, int wlimit)
144 const struct got_error *err = NULL;
146 wchar_t *wline = NULL;
152 err = mbs2ws(&wline, &wlen, line);
157 while (i < wlen && cols <= wlimit) {
158 int width = wcwidth(wline[i]);
167 if (wline[i] == L'\t')
171 err = got_error_from_errno();
189 static const struct got_error *
190 draw_commit(struct got_commit_object *commit, struct got_object_id *id)
192 const struct got_error *err = NULL;
193 char *logmsg0 = NULL, *logmsg = NULL;
194 char *author0 = NULL, *author = NULL;
195 wchar_t *wlogmsg = NULL, *wauthor = NULL;
196 int author_width, logmsg_width;
197 char *newline, *smallerthan;
202 static const size_t id_display_cols = 8;
203 static const size_t author_display_cols = 16;
204 const int avail = COLS;
206 err = got_object_id_str(&id_str, id);
209 id_len = strlen(id_str);
210 if (avail < id_display_cols) {
211 limit = MIN(id_len, avail);
212 waddnstr(tog_log_view.window, id_str, limit);
214 limit = MIN(id_display_cols, id_len);
215 waddnstr(tog_log_view.window, id_str, limit);
218 while (col <= avail && col < id_display_cols + 2) {
219 waddch(tog_log_view.window, ' ');
225 author0 = strdup(commit->author);
226 if (author0 == NULL) {
227 err = got_error_from_errno();
231 smallerthan = strchr(author, '<');
235 char *at = strchr(author, '@');
239 limit = MIN(avail, author_display_cols);
240 err = format_line(&wauthor, &author_width, author, limit);
243 waddwstr(tog_log_view.window, wauthor);
245 while (col <= avail && author_width < author_display_cols + 1) {
246 waddch(tog_log_view.window, ' ');
253 logmsg0 = strdup(commit->logmsg);
254 if (logmsg0 == NULL) {
255 err = got_error_from_errno();
259 while (*logmsg == '\n')
261 newline = strchr(logmsg, '\n');
265 err = format_line(&wlogmsg, &logmsg_width, logmsg, limit);
268 waddwstr(tog_log_view.window, wlogmsg);
270 while (col <= avail) {
271 waddch(tog_log_view.window, ' ');
284 struct commit_queue_entry {
285 TAILQ_ENTRY(commit_queue_entry) entry;
286 struct got_object_id *id;
287 struct got_commit_object *commit;
289 TAILQ_HEAD(commit_queue, commit_queue_entry);
291 static struct commit_queue_entry *
292 alloc_commit_queue_entry(struct got_commit_object *commit,
293 struct got_object_id *id)
295 struct commit_queue_entry *entry;
297 entry = calloc(1, sizeof(*entry));
302 entry->commit = commit;
307 pop_commit(struct commit_queue *commits)
309 struct commit_queue_entry *entry;
311 entry = TAILQ_FIRST(commits);
312 TAILQ_REMOVE(commits, entry, entry);
313 got_object_commit_close(entry->commit);
314 /* Don't free entry->id! It is owned by the commit graph. */
319 free_commits(struct commit_queue *commits)
321 while (!TAILQ_EMPTY(commits))
325 static const struct got_error *
326 queue_commits(struct got_commit_graph *graph, struct commit_queue *commits,
327 struct got_object_id *start_id, struct got_repository *repo)
329 const struct got_error *err = NULL;
330 struct got_object_id *id;
331 struct commit_queue_entry *entry;
333 err = got_commit_graph_iter_start(graph, start_id);
337 entry = TAILQ_LAST(commits, commit_queue);
338 if (entry && got_object_id_cmp(entry->id, start_id) == 0) {
341 /* Start ID's commit is already on the queue; skip over it. */
342 err = got_commit_graph_iter_next(&id, graph);
343 if (err && err->code != GOT_ERR_ITER_NEED_MORE)
346 err = got_commit_graph_fetch_commits(&nfetched, graph, 1, repo);
352 struct got_commit_object *commit;
354 err = got_commit_graph_iter_next(&id, graph);
356 if (err->code == GOT_ERR_ITER_NEED_MORE)
361 err = got_object_open_as_commit(&commit, repo, id);
365 entry = alloc_commit_queue_entry(commit, id);
367 err = got_error_from_errno();
371 TAILQ_INSERT_TAIL(commits, entry, entry);
377 static const struct got_error *
378 fetch_next_commit(struct commit_queue_entry **pentry,
379 struct commit_queue_entry *entry, struct commit_queue *commits,
380 struct got_commit_graph *graph, struct got_repository *repo)
382 const struct got_error *err = NULL;
383 struct got_object_qid *qid;
387 /* Populate commit graph with entry's parent commits. */
388 SIMPLEQ_FOREACH(qid, &entry->commit->parent_ids, entry) {
390 err = got_commit_graph_fetch_commits_up_to(&nfetched,
391 graph, qid->id, repo);
396 /* Append outstanding commits to queue in graph sort order. */
397 err = queue_commits(graph, commits, entry->id, repo);
399 if (err->code == GOT_ERR_ITER_COMPLETED)
404 /* Next entry to display should now be available. */
405 *pentry = TAILQ_NEXT(entry, entry);
407 return got_error(GOT_ERR_NO_OBJ);
412 static const struct got_error *
413 get_head_commit_id(struct got_object_id **head_id, struct got_repository *repo)
415 const struct got_error *err = NULL;
416 struct got_reference *head_ref;
420 err = got_ref_open(&head_ref, repo, GOT_REF_HEAD);
424 err = got_ref_resolve(head_id, repo, head_ref);
425 got_ref_close(head_ref);
434 static const struct got_error *
435 draw_commits(struct commit_queue_entry **last, struct commit_queue_entry **selected,
436 struct commit_queue_entry *first, int selected_idx, int limit)
438 const struct got_error *err = NULL;
439 struct commit_queue_entry *entry;
442 werase(tog_log_view.window);
447 if (ncommits == limit)
449 if (ncommits == selected_idx) {
450 wstandout(tog_log_view.window);
453 err = draw_commit(entry->commit, entry->id);
454 if (ncommits == selected_idx)
455 wstandend(tog_log_view.window);
460 entry = TAILQ_NEXT(entry, entry);
470 scroll_up(struct commit_queue_entry **first_displayed_entry, int maxscroll,
471 struct commit_queue *commits)
473 struct commit_queue_entry *entry;
476 entry = TAILQ_FIRST(commits);
477 if (*first_displayed_entry == entry)
480 entry = *first_displayed_entry;
481 while (entry && nscrolled < maxscroll) {
482 entry = TAILQ_PREV(entry, commit_queue, entry);
484 *first_displayed_entry = entry;
490 static const struct got_error *
491 scroll_down(struct commit_queue_entry **first_displayed_entry, int maxscroll,
492 struct commit_queue_entry *last_displayed_entry,
493 struct commit_queue *commits, struct got_commit_graph *graph,
494 struct got_repository *repo)
496 const struct got_error *err = NULL;
497 struct commit_queue_entry *pentry;
501 pentry = TAILQ_NEXT(last_displayed_entry, entry);
502 if (pentry == NULL) {
503 err = fetch_next_commit(&pentry, last_displayed_entry,
504 commits, graph, repo);
505 if (err || pentry == NULL)
508 last_displayed_entry = pentry;
510 pentry = TAILQ_NEXT(*first_displayed_entry, entry);
513 *first_displayed_entry = pentry;
514 } while (++nscrolled < maxscroll);
520 num_parents(struct commit_queue_entry *entry)
525 entry = TAILQ_NEXT(entry, entry);
532 static const struct got_error *
533 show_commit(struct commit_queue_entry *entry, struct got_repository *repo)
535 const struct got_error *err;
536 struct got_object *obj1 = NULL, *obj2 = NULL;
537 struct got_object_qid *parent_id;
539 err = got_object_open(&obj2, repo, entry->id);
543 parent_id = SIMPLEQ_FIRST(&entry->commit->parent_ids);
545 err = got_object_open(&obj1, repo, parent_id->id);
550 err = show_diff_view(obj1, obj2, repo);
553 got_object_close(obj1);
555 got_object_close(obj2);
559 static const struct got_error *
560 show_log_view(struct got_object_id *start_id, struct got_repository *repo)
562 const struct got_error *err = NULL;
563 struct got_object_id *head_id = NULL;
564 int ch, done = 0, selected = 0, nparents, nfetched;
565 struct got_commit_graph *graph;
566 struct commit_queue commits;
567 struct commit_queue_entry *entry = NULL;
568 struct commit_queue_entry *first_displayed_entry = NULL;
569 struct commit_queue_entry *last_displayed_entry = NULL;
570 struct commit_queue_entry *selected_entry = NULL;
572 if (tog_log_view.window == NULL) {
573 tog_log_view.window = newwin(0, 0, 0, 0);
574 if (tog_log_view.window == NULL)
575 return got_error_from_errno();
576 keypad(tog_log_view.window, TRUE);
578 if (tog_log_view.panel == NULL) {
579 tog_log_view.panel = new_panel(tog_log_view.window);
580 if (tog_log_view.panel == NULL)
581 return got_error_from_errno();
583 show_panel(tog_log_view.panel);
585 err = get_head_commit_id(&head_id, repo);
589 TAILQ_INIT(&commits);
591 err = got_commit_graph_open(&graph, head_id, 0, repo);
595 /* Populate commit graph with a sufficient number of commits. */
596 err = got_commit_graph_fetch_commits_up_to(&nfetched, graph, start_id,
600 err = got_commit_graph_fetch_commits(&nfetched, graph, LINES, repo);
605 * Open the initial batch of commits, sorted in commit graph order.
606 * We keep all commits open throughout the lifetime of the log view
607 * in order to avoid having to re-fetch commits from disk while
608 * updating the display.
610 err = queue_commits(graph, &commits, head_id, repo);
611 if (err && err->code != GOT_ERR_ITER_COMPLETED)
614 /* Find entry corresponding to the first commit to display. */
615 TAILQ_FOREACH(entry, &commits, entry) {
616 if (got_object_id_cmp(entry->id, start_id) == 0) {
617 first_displayed_entry = entry;
621 if (first_displayed_entry == NULL) {
622 err = got_error(GOT_ERR_NO_OBJ);
627 err = draw_commits(&last_displayed_entry, &selected_entry,
628 first_displayed_entry, selected, LINES);
632 nodelay(stdscr, FALSE);
633 ch = wgetch(tog_log_view.window);
634 nodelay(stdscr, TRUE);
638 err = got_error_from_errno();
651 scroll_up(&first_displayed_entry, 1, &commits);
654 if (TAILQ_FIRST(&commits) ==
655 first_displayed_entry) {
659 scroll_up(&first_displayed_entry, LINES,
664 nparents = num_parents(first_displayed_entry);
665 if (selected < LINES - 1 &&
666 selected < nparents - 1) {
670 err = scroll_down(&first_displayed_entry, 1,
671 last_displayed_entry, &commits, graph,
677 err = scroll_down(&first_displayed_entry, LINES,
678 last_displayed_entry, &commits, graph,
682 if (last_displayed_entry->commit->nparents > 0)
684 /* can't scroll any further; move cursor down */
685 nparents = num_parents(first_displayed_entry);
686 if (selected < LINES - 1 ||
687 selected < nparents - 1)
688 selected = MIN(LINES - 1, nparents - 1);
691 if (selected > LINES)
692 selected = LINES - 1;
696 err = show_commit(selected_entry, repo);
699 show_panel(tog_log_view.panel);
708 got_commit_graph_close(graph);
709 free_commits(&commits);
713 static const struct got_error *
714 cmd_log(int argc, char *argv[])
716 const struct got_error *error;
717 struct got_repository *repo;
718 struct got_object_id *start_id = NULL;
719 char *repo_path = NULL;
720 char *start_commit = NULL;
724 if (pledge("stdio rpath wpath cpath flock proc tty", NULL) == -1)
728 while ((ch = getopt(argc, argv, "c:")) != -1) {
731 start_commit = optarg;
743 repo_path = getcwd(NULL, 0);
744 if (repo_path == NULL)
745 return got_error_from_errno();
746 } else if (argc == 1) {
747 repo_path = realpath(argv[0], NULL);
748 if (repo_path == NULL)
749 return got_error_from_errno();
753 error = got_repo_open(&repo, repo_path);
758 if (start_commit == NULL) {
759 error = get_head_commit_id(&start_id, repo);
763 struct got_object *obj;
764 error = got_object_open_by_id_str(&obj, repo, start_commit);
766 start_id = got_object_get_id(obj);
767 if (start_id == NULL)
768 error = got_error_from_errno();
773 error = show_log_view(start_id, repo);
775 got_repo_close(repo);
783 fprintf(stderr, "usage: %s diff [repository-path] object1 object2\n",
789 parse_next_line(FILE *f, size_t *len)
794 const char delim[3] = { '\0', '\0', '\0'};
796 line = fparseln(f, &linelen, &lineno, delim, 0);
802 static const struct got_error *
803 draw_diff(FILE *f, int *first_displayed_line, int *last_displayed_line,
804 int *eof, int max_lines)
806 const struct got_error *err;
807 int nlines = 0, nprinted = 0;
814 werase(tog_diff_view.window);
817 while (nprinted < max_lines) {
818 line = parse_next_line(f, &len);
823 if (++nlines < *first_displayed_line) {
828 err = format_line(&wline, &width, line, COLS);
833 waddwstr(tog_diff_view.window, wline);
835 waddch(tog_diff_view.window, '\n');
837 *first_displayed_line = nlines;
840 *last_displayed_line = nlines;
848 static const struct got_error *
849 show_diff_view(struct got_object *obj1, struct got_object *obj2,
850 struct got_repository *repo)
852 const struct got_error *err;
854 int ch, done = 0, first_displayed_line = 1, last_displayed_line = LINES;
857 if (obj1 != NULL && obj2 != NULL &&
858 got_object_get_type(obj1) != got_object_get_type(obj2))
859 return got_error(GOT_ERR_OBJ_TYPE);
863 return got_error_from_errno();
865 switch (got_object_get_type(obj1 ? obj1 : obj2)) {
866 case GOT_OBJ_TYPE_BLOB:
867 err = got_diff_objects_as_blobs(obj1, obj2, repo, f);
869 case GOT_OBJ_TYPE_TREE:
870 err = got_diff_objects_as_trees(obj1, obj2, repo, f);
872 case GOT_OBJ_TYPE_COMMIT:
873 err = got_diff_objects_as_commits(obj1, obj2, repo, f);
876 return got_error(GOT_ERR_OBJ_TYPE);
881 if (tog_diff_view.window == NULL) {
882 tog_diff_view.window = newwin(0, 0, 0, 0);
883 if (tog_diff_view.window == NULL)
884 return got_error_from_errno();
885 keypad(tog_diff_view.window, TRUE);
887 if (tog_diff_view.panel == NULL) {
888 tog_diff_view.panel = new_panel(tog_diff_view.window);
889 if (tog_diff_view.panel == NULL)
890 return got_error_from_errno();
892 show_panel(tog_diff_view.panel);
895 err = draw_diff(f, &first_displayed_line, &last_displayed_line,
899 nodelay(stdscr, FALSE);
900 ch = wgetch(tog_diff_view.window);
901 nodelay(stdscr, TRUE);
909 if (first_displayed_line > 1)
910 first_displayed_line--;
914 while (i++ < LINES - 1 &&
915 first_displayed_line > 1)
916 first_displayed_line--;
923 first_displayed_line++;
928 while (!eof && i++ < LINES - 1) {
929 char *line = parse_next_line(f, NULL);
930 first_displayed_line++;
943 static const struct got_error *
944 cmd_diff(int argc, char *argv[])
946 const struct got_error *error = NULL;
947 struct got_repository *repo = NULL;
948 struct got_object *obj1 = NULL, *obj2 = NULL;
949 char *repo_path = NULL;
950 char *obj_id_str1 = NULL, *obj_id_str2 = NULL;
954 if (pledge("stdio rpath wpath cpath flock proc tty", NULL) == -1)
958 while ((ch = getopt(argc, argv, "")) != -1) {
970 usage_diff(); /* TODO show local worktree changes */
971 } else if (argc == 2) {
972 repo_path = getcwd(NULL, 0);
973 if (repo_path == NULL)
974 return got_error_from_errno();
975 obj_id_str1 = argv[0];
976 obj_id_str2 = argv[1];
977 } else if (argc == 3) {
978 repo_path = realpath(argv[0], NULL);
979 if (repo_path == NULL)
980 return got_error_from_errno();
981 obj_id_str1 = argv[1];
982 obj_id_str2 = argv[2];
986 error = got_repo_open(&repo, repo_path);
991 error = got_object_open_by_id_str(&obj1, repo, obj_id_str1);
995 error = got_object_open_by_id_str(&obj2, repo, obj_id_str2);
999 error = show_diff_view(obj1, obj2, repo);
1001 got_repo_close(repo);
1003 got_object_close(obj1);
1005 got_object_close(obj2);
1013 fprintf(stderr, "usage: %s blame [repository-path] blob-object\n",
1018 static const struct got_error *
1019 cmd_blame(int argc, char *argv[])
1021 return got_error(GOT_ERR_NOT_IMPL);
1031 intrflush(stdscr, FALSE);
1032 keypad(stdscr, TRUE);
1041 fprintf(stderr, "usage: %s [-h] [command] [arg ...]\n\n"
1042 "Available commands:\n", getprogname());
1043 for (i = 0; i < nitems(tog_commands); i++) {
1044 struct tog_cmd *cmd = &tog_commands[i];
1045 fprintf(stderr, " %s: %s\n", cmd->name, cmd->descr);
1051 make_argv(const char *arg0, const char *arg1)
1054 int argc = (arg1 == NULL ? 1 : 2);
1056 argv = calloc(argc, sizeof(char *));
1059 argv[0] = strdup(arg0);
1060 if (argv[0] == NULL)
1063 argv[1] = strdup(arg1);
1064 if (argv[1] == NULL)
1072 main(int argc, char *argv[])
1074 const struct got_error *error = NULL;
1075 struct tog_cmd *cmd = NULL;
1077 char **cmd_argv = NULL;
1079 setlocale(LC_ALL, "");
1081 while ((ch = getopt(argc, argv, "h")) != -1) {
1098 /* Build an argument vector which runs a default command. */
1099 cmd = &tog_commands[0];
1100 cmd_argv = make_argv(cmd->name, NULL);
1105 /* Did the user specific a command? */
1106 for (i = 0; i < nitems(tog_commands); i++) {
1107 if (strncmp(tog_commands[i].name, argv[0],
1108 strlen(argv[0])) == 0) {
1109 cmd = &tog_commands[i];
1111 tog_commands[i].cmd_usage();
1116 /* Did the user specify a repository? */
1117 char *repo_path = realpath(argv[0], NULL);
1119 struct got_repository *repo;
1120 error = got_repo_open(&repo, repo_path);
1122 got_repo_close(repo);
1124 error = got_error_from_errno();
1126 fprintf(stderr, "%s: '%s' is neither a known "
1127 "command nor a path to a repository\n",
1128 getprogname(), argv[0]);
1132 cmd = &tog_commands[0];
1133 cmd_argv = make_argv(cmd->name, repo_path);
1141 error = cmd->cmd_main(argc, cmd_argv ? cmd_argv : argv);
1148 fprintf(stderr, "%s: %s\n", getprogname(), error->msg);