1 /* Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2 * See license info at the bottom. */
9 * tig - text-mode interface for git
15 * tig [options] [--] [git log options]
16 * tig [options] log [git log options]
17 * tig [options] diff [git diff options]
18 * tig [options] show [git show options]
19 * tig [options] < [git command output]
23 * Browse changes in a git repository.
27 #define VERSION "tig-0.1"
47 static void die(const char *err, ...);
48 static void report(const char *msg, ...);
49 static void set_nonblocking_input(bool loading);
51 #define ABS(x) ((x) >= 0 ? (x) : -(x))
52 #define MIN(x, y) ((x) < (y) ? (x) : (y))
54 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
55 #define STRING_SIZE(x) (sizeof(x) - 1)
57 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
58 #define SIZEOF_CMD 1024 /* Size of command buffer. */
60 /* This color name can be used to refer to the default term colors. */
61 #define COLOR_DEFAULT (-1)
63 /* The format and size of the date column in the main view. */
64 #define DATE_FORMAT "%Y-%m-%d %H:%M"
65 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
67 /* The default interval between line numbers. */
68 #define NUMBER_INTERVAL 1
70 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
72 /* Some ascii-shorthands fitted into the ncurses namespace. */
74 #define KEY_RETURN '\r'
77 /* User action requests. */
79 /* Offset all requests to avoid conflicts with ncurses getch values. */
80 REQ_OFFSET = KEY_MAX + 1,
82 /* XXX: Keep the view request first and in sync with views[]. */
97 REQ_TOGGLE_LINE_NUMBERS,
108 REQ_SCROLL_LINE_DOWN,
110 REQ_SCROLL_PAGE_DOWN,
114 char id[41]; /* SHA1 ID. */
115 char title[75]; /* The first line of the commit message. */
116 char author[75]; /* The author of the commit. */
117 struct tm time; /* Date from the author ident. */
125 string_ncopy(char *dst, char *src, int dstlen)
127 strncpy(dst, src, dstlen - 1);
132 /* Shorthand for safely copying into a fixed buffer. */
133 #define string_copy(dst, src) \
134 string_ncopy(dst, src, sizeof(dst))
138 * NOTE: The following is a slightly modified copy of the git project's shell
139 * quoting routines found in the quote.c file.
141 * Help to copy the thing properly quoted for the shell safety. any single
142 * quote is replaced with '\'', any exclamation point is replaced with '\!',
143 * and the whole thing is enclosed in a
146 * original sq_quote result
147 * name ==> name ==> 'name'
148 * a b ==> a b ==> 'a b'
149 * a'b ==> a'\''b ==> 'a'\''b'
150 * a!b ==> a'\!'b ==> 'a'\!'b'
154 sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
158 #define BUFPUT(x) ( (bufsize < SIZEOF_CMD) && (buf[bufsize++] = (x)) )
161 while ((c = *src++)) {
162 if (c == '\'' || c == '!') {
182 static int opt_line_number = FALSE;
183 static int opt_num_interval = NUMBER_INTERVAL;
184 static enum request opt_request = REQ_VIEW_MAIN;
185 static char opt_cmd[SIZEOF_CMD] = "";
186 static FILE *opt_pipe = NULL;
188 /* Returns the index of log or diff command or -1 to exit. */
190 parse_options(int argc, char *argv[])
194 for (i = 1; i < argc; i++) {
199 * Start up in log view using the internal log command.
201 if (!strcmp(opt, "-l")) {
202 opt_request = REQ_VIEW_LOG;
208 * Start up in diff view using the internal diff command.
210 if (!strcmp(opt, "-d")) {
211 opt_request = REQ_VIEW_DIFF;
216 * -n[INTERVAL], --line-number[=INTERVAL]::
217 * Prefix line numbers in log and diff view.
218 * Optionally, with interval different than each line.
220 if (!strncmp(opt, "-n", 2) ||
221 !strncmp(opt, "--line-number", 13)) {
227 } else if (opt[STRING_SIZE("--line-number")] == '=') {
228 num = opt + STRING_SIZE("--line-number=");
232 opt_num_interval = atoi(num);
234 opt_line_number = TRUE;
240 * Show version and exit.
242 if (!strcmp(opt, "-v") ||
243 !strcmp(opt, "--version")) {
244 printf("tig version %s\n", VERSION);
250 * End of tig(1) options. Useful when specifying commands
251 * for the main view. Example:
253 * $ tig -- --since=1.month
255 if (!strcmp(opt, "--")) {
262 * Open log view using the given git log options.
265 * Open diff view using the given git diff options.
268 * Open diff view using the given git show options.
270 if (!strcmp(opt, "log") ||
271 !strcmp(opt, "diff") ||
272 !strcmp(opt, "show")) {
273 opt_request = opt[0] == 'l'
274 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
280 * $ tig tag-1.0..HEAD
283 if (opt[0] && opt[0] != '-')
286 die("unknown command '%s'", opt);
289 if (!isatty(STDIN_FILENO)) {
293 * If stdin is a pipe, any log or diff options will be ignored and the
294 * pager view will be opened loading data from stdin. The pager mode
295 * can be used for colorizing output from various git commands.
297 * Example on how to colorize the output of git-show(1):
301 opt_request = REQ_VIEW_PAGER;
304 } else if (i < argc) {
308 * Git command options
309 * ~~~~~~~~~~~~~~~~~~~
310 * All git command options specified on the command line will
311 * be passed to the given command and all will be shell quoted
314 * NOTE: It is possible to specify options even for the main
315 * view. If doing this you should not touch the `--pretty`
318 * Example on how to open the log view and show both author and
319 * committer information:
321 * $ tig log --pretty=fuller
324 if (opt_request == REQ_VIEW_MAIN)
325 /* XXX: This is vulnerable to the user overriding
326 * options required for the main view parser. */
327 string_copy(opt_cmd, "git log --stat --pretty=raw");
329 string_copy(opt_cmd, "git");
330 buf_size = strlen(opt_cmd);
332 while (buf_size < sizeof(opt_cmd) && i < argc) {
333 opt_cmd[buf_size++] = ' ';
334 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
337 if (buf_size >= sizeof(opt_cmd))
338 die("command too long");
340 opt_cmd[buf_size] = 0;
353 #define HELP "(d)iff, (l)og, (m)ain, (q)uit, (v)ersion, (h)elp"
360 struct keymap keymap[] = {
365 * Switch to diff view.
367 * Switch to log view.
369 * Switch to main view.
371 * Switch to pager view.
375 * If in main view split the view
376 * and show the diff in the bottom view.
378 * Switch to next view.
380 { 'm', REQ_VIEW_MAIN },
381 { 'd', REQ_VIEW_DIFF },
382 { 'l', REQ_VIEW_LOG },
383 { 'p', REQ_VIEW_PAGER },
384 { 'h', REQ_VIEW_HELP },
386 { KEY_TAB, REQ_VIEW_NEXT },
387 { KEY_RETURN, REQ_ENTER },
393 * Move curser one line up.
395 * Move cursor one line down.
397 * Move curser one page up.
399 * Move cursor one page down.
401 * Jump to first line.
405 { KEY_UP, REQ_MOVE_UP },
406 { 'k', REQ_MOVE_UP },
407 { KEY_DOWN, REQ_MOVE_DOWN },
408 { 'j', REQ_MOVE_DOWN },
409 { KEY_HOME, REQ_MOVE_FIRST_LINE },
410 { KEY_END, REQ_MOVE_LAST_LINE },
411 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
412 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
418 * Scroll view one line up.
420 * Scroll view one line down.
422 * Scroll view one page up.
424 * Scroll view one page down.
426 { KEY_IC, REQ_SCROLL_LINE_UP },
427 { KEY_DC, REQ_SCROLL_LINE_DOWN },
428 { 'w', REQ_SCROLL_PAGE_UP },
429 { 's', REQ_SCROLL_PAGE_DOWN },
439 * Stop all background loading.
443 * Toggle line numbers on/off.
445 * Open prompt. This allows you to specify what git command to run.
451 { KEY_ESC, REQ_QUIT },
453 { 'z', REQ_STOP_LOADING },
454 { 'v', REQ_SHOW_VERSION },
455 { 'r', REQ_SCREEN_REDRAW },
456 { 'n', REQ_TOGGLE_LINE_NUMBERS },
459 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
460 { ERR, REQ_SCREEN_UPDATE },
462 /* Use the ncurses SIGWINCH handler. */
463 { KEY_RESIZE, REQ_SCREEN_RESIZE },
471 for (i = 0; i < ARRAY_SIZE(keymap); i++)
472 if (keymap[i].alias == key)
473 return keymap[i].request;
475 return (enum request) key;
480 * Line-oriented content detection.
484 /* Line type String to match Foreground Background Attributes
485 * --------- --------------- ---------- ---------- ---------- */ \
487 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
488 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
489 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
490 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
491 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
492 LINE(DIFF_OLDMODE, "old mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
493 LINE(DIFF_NEWMODE, "new mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
494 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
495 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
496 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
497 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
498 /* Pretty print commit header */ \
499 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
500 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
501 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
502 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
503 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
504 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
505 /* Raw commit header */ \
506 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
507 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
508 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
509 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
510 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
512 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
513 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
515 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
516 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
517 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
518 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
519 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
520 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
521 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
522 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
523 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0),
526 #define LINE(type, line, fg, bg, attr) \
533 char *line; /* The start of line to match. */
534 int linelen; /* Size of string to match. */
535 int fg, bg, attr; /* Color and text attributes for the lines. */
538 static struct line_info line_info[] = {
539 #define LINE(type, line, fg, bg, attr) \
540 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
545 static enum line_type
546 get_line_type(char *line)
548 int linelen = strlen(line);
551 for (type = 0; type < ARRAY_SIZE(line_info); type++)
552 /* Case insensitive search matches Signed-off-by lines better. */
553 if (linelen >= line_info[type].linelen &&
554 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
561 get_line_attr(enum line_type type)
563 assert(type < ARRAY_SIZE(line_info));
564 return COLOR_PAIR(type) | line_info[type].attr;
570 int default_bg = COLOR_BLACK;
571 int default_fg = COLOR_WHITE;
576 if (use_default_colors() != ERR) {
581 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
582 struct line_info *info = &line_info[type];
583 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
584 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
586 init_pair(type, fg, bg);
592 * ENVIRONMENT VARIABLES
593 * ---------------------
594 * It is possible to alter which commands are used for the different views.
595 * If for example you prefer commits in the main to be sorted by date and
596 * only show 500 commits, use:
598 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
600 * Or set the variable permanently in your environment.
602 * Notice, how `%s` is used to specify the commit reference. There can
603 * be a maximum of 5 `%s` ref specifications.
606 * The command used for the diff view. By default, git show is used
610 * The command used for the log view.
613 * The command used for the main view. Note, you must always specify
614 * the option: `--pretty=raw` since the main view parser expects to
618 #define TIG_DIFF_CMD \
619 "git show --patch-with-stat --find-copies-harder -B -C %s"
621 #define TIG_LOG_CMD \
622 "git log --cc --stat -n100 %s"
624 #define TIG_MAIN_CMD \
625 "git log --topo-order --stat --pretty=raw %s"
627 /* We silently ignore that the following are also exported. */
629 #define TIG_HELP_CMD \
630 "man tig 2> /dev/null"
632 #define TIG_PAGER_CMD \
641 const char *name; /* View name */
642 char *cmd_fmt; /* Default command line format */
643 char *cmd_env; /* Command line set via environment */
644 char *id; /* Points to either of ref_{head,commit} */
645 size_t objsize; /* Size of objects in the line index */
648 /* Draw one line; @lineno must be < view->height. */
649 bool (*draw)(struct view *view, unsigned int lineno);
650 /* Read one line; updates view->line. */
651 bool (*read)(struct view *view, char *line);
652 /* Depending on view, change display based on current line. */
653 bool (*enter)(struct view *view);
656 char cmd[SIZEOF_CMD]; /* Command buffer */
657 char ref[SIZEOF_REF]; /* Hovered commit reference */
658 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
660 int height, width; /* The width and height of the main window */
661 WINDOW *win; /* The main window */
662 WINDOW *title; /* The title window living below the main window */
665 unsigned long offset; /* Offset of the window top */
666 unsigned long lineno; /* Current line number */
669 unsigned long lines; /* Total number of lines */
670 void **line; /* Line index; each line contains user data */
671 unsigned int digits; /* Number of digits in the lines member. */
678 static struct view_ops pager_ops;
679 static struct view_ops main_ops;
681 char ref_head[SIZEOF_REF] = "HEAD";
682 char ref_commit[SIZEOF_REF] = "HEAD";
684 #define VIEW_STR(name, cmd, env, ref, objsize, ops) \
685 { name, cmd, #env, ref, objsize, ops }
687 #define VIEW_(id, name, ops, ref, objsize) \
688 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, objsize, ops)
690 static struct view views[] = {
691 VIEW_(MAIN, "main", &main_ops, ref_head, sizeof(struct commit)),
692 VIEW_(DIFF, "diff", &pager_ops, ref_commit, sizeof(char)),
693 VIEW_(LOG, "log", &pager_ops, ref_head, sizeof(char)),
694 VIEW_(HELP, "help", &pager_ops, ref_head, sizeof(char)),
695 VIEW_(PAGER, "pager", &pager_ops, "static", sizeof(char)),
698 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
700 /* The display array of active views and the index of the current view. */
701 static struct view *display[2];
702 static unsigned int current_view;
704 #define foreach_view(view, i) \
705 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
709 redraw_view_from(struct view *view, int lineno)
711 assert(0 <= lineno && lineno < view->height);
713 for (; lineno < view->height; lineno++) {
714 if (!view->ops->draw(view, lineno))
718 redrawwin(view->win);
723 redraw_view(struct view *view)
726 redraw_view_from(view, 0);
733 struct view *base = display[0];
734 struct view *view = display[1] ? display[1] : display[0];
736 /* Setup window dimensions */
738 getmaxyx(stdscr, base->height, base->width);
740 /* Make room for the status window. */
744 /* Horizontal split. */
745 view->width = base->width;
746 view->height = SCALE_SPLIT_VIEW(base->height);
747 base->height -= view->height;
749 /* Make room for the title bar. */
753 /* Make room for the title bar. */
758 foreach_view (view, i) {
760 view->win = newwin(view->height, 0, offset, 0);
762 die("Failed to create %s view", view->name);
764 scrollok(view->win, TRUE);
766 view->title = newwin(1, 0, offset + view->height, 0);
768 die("Failed to create title window");
771 wresize(view->win, view->height, view->width);
772 mvwin(view->win, offset, 0);
773 mvwin(view->title, offset + view->height, 0);
777 offset += view->height + 1;
782 update_view_title(struct view *view)
784 if (view == display[current_view])
785 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
787 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
790 wmove(view->title, 0, 0);
792 /* [main] ref: 334b506... - commit 6 of 4383 (0%) */
795 wprintw(view->title, "[%s] ref: %s", view->name, view->ref);
797 wprintw(view->title, "[%s]", view->name);
800 char *type = view == VIEW(REQ_VIEW_MAIN) ? "commit" : "line";
802 wprintw(view->title, " - %s %d of %d (%d%%)",
806 (view->lineno + 1) * 100 / view->lines);
809 wrefresh(view->title);
816 /* Scrolling backend */
818 do_scroll_view(struct view *view, int lines)
820 /* The rendering expects the new offset. */
821 view->offset += lines;
823 assert(0 <= view->offset && view->offset < view->lines);
826 /* Redraw the whole screen if scrolling is pointless. */
827 if (view->height < ABS(lines)) {
831 int line = lines > 0 ? view->height - lines : 0;
832 int end = line + ABS(lines);
834 wscrl(view->win, lines);
836 for (; line < end; line++) {
837 if (!view->ops->draw(view, line))
842 /* Move current line into the view. */
843 if (view->lineno < view->offset) {
844 view->lineno = view->offset;
845 view->ops->draw(view, 0);
847 } else if (view->lineno >= view->offset + view->height) {
848 view->lineno = view->offset + view->height - 1;
849 view->ops->draw(view, view->lineno - view->offset);
852 assert(view->offset <= view->lineno && view->lineno < view->lines);
854 redrawwin(view->win);
859 /* Scroll frontend */
861 scroll_view(struct view *view, enum request request)
866 case REQ_SCROLL_PAGE_DOWN:
867 lines = view->height;
868 case REQ_SCROLL_LINE_DOWN:
869 if (view->offset + lines > view->lines)
870 lines = view->lines - view->offset;
872 if (lines == 0 || view->offset + view->height >= view->lines) {
873 report("Cannot scroll beyond the last line");
878 case REQ_SCROLL_PAGE_UP:
879 lines = view->height;
880 case REQ_SCROLL_LINE_UP:
881 if (lines > view->offset)
882 lines = view->offset;
885 report("Cannot scroll beyond the first line");
893 die("request %d not handled in switch", request);
896 do_scroll_view(view, lines);
901 move_view(struct view *view, enum request request)
906 case REQ_MOVE_FIRST_LINE:
907 steps = -view->lineno;
910 case REQ_MOVE_LAST_LINE:
911 steps = view->lines - view->lineno - 1;
914 case REQ_MOVE_PAGE_UP:
915 steps = view->height > view->lineno
916 ? -view->lineno : -view->height;
919 case REQ_MOVE_PAGE_DOWN:
920 steps = view->lineno + view->height >= view->lines
921 ? view->lines - view->lineno - 1 : view->height;
933 die("request %d not handled in switch", request);
936 if (steps <= 0 && view->lineno == 0) {
937 report("Cannot move beyond the first line");
940 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
941 report("Cannot move beyond the last line");
945 /* Move the current line */
946 view->lineno += steps;
947 assert(0 <= view->lineno && view->lineno < view->lines);
949 /* Repaint the old "current" line if we be scrolling */
950 if (ABS(steps) < view->height) {
951 int prev_lineno = view->lineno - steps - view->offset;
953 wmove(view->win, prev_lineno, 0);
954 wclrtoeol(view->win);
955 view->ops->draw(view, prev_lineno);
958 /* Check whether the view needs to be scrolled */
959 if (view->lineno < view->offset ||
960 view->lineno >= view->offset + view->height) {
961 if (steps < 0 && -steps > view->offset) {
962 steps = -view->offset;
964 } else if (steps > 0) {
965 if (view->lineno == view->lines - 1 &&
966 view->lines > view->height) {
967 steps = view->lines - view->offset - 1;
968 if (steps >= view->height)
969 steps -= view->height - 1;
973 do_scroll_view(view, steps);
977 /* Draw the current line */
978 view->ops->draw(view, view->lineno - view->offset);
980 redrawwin(view->win);
987 * Incremental updating
991 begin_update(struct view *view)
996 string_copy(view->cmd, opt_cmd);
998 /* When running random commands, the view ref could have become
999 * invalid so clear it. */
1002 char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1004 if (snprintf(view->cmd, sizeof(view->cmd), format,
1005 id, id, id, id, id) >= sizeof(view->cmd))
1009 /* Special case for the pager view. */
1011 view->pipe = opt_pipe;
1014 view->pipe = popen(view->cmd, "r");
1020 set_nonblocking_input(TRUE);
1025 string_copy(view->vid, id);
1030 for (i = 0; i < view->lines; i++)
1032 free(view->line[i]);
1038 view->start_time = time(NULL);
1044 end_update(struct view *view)
1048 set_nonblocking_input(FALSE);
1049 if (view->pipe == stdin)
1057 update_view(struct view *view)
1059 char buffer[BUFSIZ];
1062 /* The number of lines to read. If too low it will cause too much
1063 * redrawing (and possible flickering), if too high responsiveness
1065 unsigned long lines = view->height;
1066 int redraw_from = -1;
1071 /* Only redraw if lines are visible. */
1072 if (view->offset + view->height >= view->lines)
1073 redraw_from = view->lines - view->offset;
1075 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1081 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1084 linelen = strlen(line);
1086 line[linelen - 1] = 0;
1088 if (!view->ops->read(view, line))
1098 lines = view->lines;
1099 for (digits = 0; lines; digits++)
1102 /* Keep the displayed view in sync with line number scaling. */
1103 if (digits != view->digits) {
1104 view->digits = digits;
1109 if (redraw_from >= 0) {
1110 /* If this is an incremental update, redraw the previous line
1111 * since for commits some members could have changed when
1112 * loading the main view. */
1113 if (redraw_from > 0)
1116 /* Incrementally draw avoids flickering. */
1117 redraw_view_from(view, redraw_from);
1120 /* Update the title _after_ the redraw so that if the redraw picks up a
1121 * commit reference in view->ref it'll be available here. */
1122 update_view_title(view);
1124 if (ferror(view->pipe)) {
1125 report("Failed to read: %s", strerror(errno));
1128 } else if (feof(view->pipe)) {
1129 time_t secs = time(NULL) - view->start_time;
1131 if (view == VIEW(REQ_VIEW_HELP)) {
1136 report("Loaded %d lines in %ld second%s", view->lines, secs,
1137 secs == 1 ? "" : "s");
1144 report("Allocation failure");
1152 OPEN_DEFAULT = 0, /* Use default view switching. */
1153 OPEN_SPLIT = 1, /* Split current view. */
1154 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1155 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1159 open_view(struct view *prev, enum request request, enum open_flags flags)
1161 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1162 bool split = !!(flags & OPEN_SPLIT);
1163 bool reload = !!(flags & OPEN_RELOAD);
1164 struct view *view = VIEW(request);
1165 struct view *displayed;
1168 /* Cycle between displayed views and count the views. */
1169 foreach_view (displayed, nviews) {
1171 view == displayed &&
1172 !strcmp(view->vid, prev->vid)) {
1173 current_view = nviews;
1174 /* Blur out the title of the previous view. */
1175 update_view_title(prev);
1176 report("Switching to %s view", view->name);
1181 if (view == prev && nviews == 1 && !reload) {
1182 report("Already in %s view", view->name);
1186 if ((reload || strcmp(view->vid, view->id)) &&
1187 !begin_update(view)) {
1188 report("Failed to load %s view", view->name);
1193 display[current_view + 1] = view;
1197 /* Maximize the current view. */
1198 memset(display, 0, sizeof(display));
1200 display[current_view] = view;
1205 if (split && prev->lineno - prev->offset >= prev->height) {
1206 /* Take the title line into account. */
1207 int lines = prev->lineno - prev->offset - prev->height + 1;
1209 /* Scroll the view that was split if the current line is
1210 * outside the new limited view. */
1211 do_scroll_view(prev, lines);
1214 if (prev && view != prev) {
1215 /* "Blur" the previous view. */
1216 update_view_title(prev);
1218 /* Continue loading split views in the background. */
1224 /* Clear the old view and let the incremental updating refill
1227 report("Loading...");
1236 * User request switch noodle
1240 view_driver(struct view *view, enum request request)
1247 case REQ_MOVE_PAGE_UP:
1248 case REQ_MOVE_PAGE_DOWN:
1249 case REQ_MOVE_FIRST_LINE:
1250 case REQ_MOVE_LAST_LINE:
1251 move_view(view, request);
1254 case REQ_SCROLL_LINE_DOWN:
1255 case REQ_SCROLL_LINE_UP:
1256 case REQ_SCROLL_PAGE_DOWN:
1257 case REQ_SCROLL_PAGE_UP:
1258 scroll_view(view, request);
1265 case REQ_VIEW_PAGER:
1266 open_view(view, request, OPEN_DEFAULT);
1271 report("Nothing to enter");
1274 return view->ops->enter(view);
1278 int nviews = display[1] ? 2 : 1;
1279 int next_view = (current_view + 1) % nviews;
1281 if (next_view == current_view) {
1282 report("Only one view is displayed");
1286 current_view = next_view;
1287 /* Blur out the title of the previous view. */
1288 update_view_title(view);
1289 report("Switching to %s view", display[current_view]->name);
1292 case REQ_TOGGLE_LINE_NUMBERS:
1293 opt_line_number = !opt_line_number;
1298 /* Always reload^Wrerun commands from the prompt. */
1299 open_view(view, opt_request, OPEN_RELOAD);
1302 case REQ_STOP_LOADING:
1303 foreach_view (view, i) {
1305 report("Stopped loaded of %s view", view->name),
1310 case REQ_SHOW_VERSION:
1311 report("Version: %s", VERSION);
1314 case REQ_SCREEN_RESIZE:
1317 case REQ_SCREEN_REDRAW:
1318 foreach_view (view, i) {
1320 update_view_title(view);
1324 case REQ_SCREEN_UPDATE:
1332 /* An unknown key will show most commonly used commands. */
1342 * View backend handlers
1346 pager_draw(struct view *view, unsigned int lineno)
1348 enum line_type type;
1353 if (view->offset + lineno >= view->lines)
1356 line = view->line[view->offset + lineno];
1357 type = get_line_type(line);
1359 if (view->offset + lineno == view->lineno) {
1360 if (type == LINE_COMMIT) {
1361 string_copy(view->ref, line + 7);
1362 string_copy(ref_commit, view->ref);
1368 attr = get_line_attr(type);
1369 wattrset(view->win, attr);
1371 linelen = strlen(line);
1372 linelen = MIN(linelen, view->width);
1374 if (opt_line_number) {
1375 static char indent[] = " ";
1376 unsigned long real_lineno = view->offset + lineno + 1;
1379 if (real_lineno == 1 || (real_lineno % opt_num_interval) == 0)
1380 mvwprintw(view->win, lineno, 0, "%.*d", view->digits, real_lineno);
1382 else if (view->digits < sizeof(indent))
1383 mvwaddnstr(view->win, lineno, 0, indent, view->digits);
1385 waddstr(view->win, ": ");
1388 if (*line == '\t') {
1389 waddnstr(view->win, " ", 8 - (col % 8));
1390 col += 8 - (col % 8);
1394 char *tab = strchr(line, '\t');
1397 waddnstr(view->win, line, tab - line);
1399 waddstr(view->win, line);
1404 waddstr(view->win, line);
1408 /* NOTE: Code for only highlighting the text on the cursor line.
1409 * Kept since I've not yet decided whether to highlight the
1410 * entire line or not. --fonseca */
1411 /* No empty lines makes cursor drawing and clearing implicit. */
1413 line = " ", linelen = 1;
1415 mvwaddnstr(view->win, lineno, 0, line, linelen);
1418 /* Paint the rest of the line if it's the cursor line. */
1419 if (type == LINE_CURSOR)
1420 wchgat(view->win, -1, 0, type, NULL);
1426 pager_read(struct view *view, char *line)
1428 view->line[view->lines] = strdup(line);
1429 if (!view->line[view->lines])
1437 pager_enter(struct view *view)
1439 char *line = view->line[view->lineno];
1441 if (get_line_type(line) == LINE_COMMIT) {
1442 open_view(view, REQ_VIEW_DIFF, OPEN_DEFAULT);
1448 static struct view_ops pager_ops = {
1456 main_draw(struct view *view, unsigned int lineno)
1458 char buf[DATE_COLS + 1];
1459 struct commit *commit;
1460 enum line_type type;
1464 if (view->offset + lineno >= view->lines)
1467 commit = view->line[view->offset + lineno];
1468 if (!*commit->author)
1471 if (view->offset + lineno == view->lineno) {
1472 string_copy(view->ref, commit->id);
1473 string_copy(ref_commit, view->ref);
1476 type = LINE_MAIN_COMMIT;
1479 wmove(view->win, lineno, cols);
1480 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1482 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1483 waddnstr(view->win, buf, timelen);
1484 waddstr(view->win, " ");
1487 wmove(view->win, lineno, cols);
1488 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1490 if (strlen(commit->author) > 19) {
1491 waddnstr(view->win, commit->author, 18);
1492 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1493 waddch(view->win, '~');
1495 waddstr(view->win, commit->author);
1499 wattrset(view->win, A_NORMAL);
1500 mvwaddch(view->win, lineno, cols, ACS_LTEE);
1501 wattrset(view->win, get_line_attr(type));
1502 mvwaddstr(view->win, lineno, cols + 2, commit->title);
1503 wattrset(view->win, A_NORMAL);
1508 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1510 main_read(struct view *view, char *line)
1512 enum line_type type = get_line_type(line);
1513 struct commit *commit;
1517 commit = calloc(1, sizeof(struct commit));
1521 line += STRING_SIZE("commit ");
1523 view->line[view->lines++] = commit;
1524 string_copy(commit->id, line);
1529 char *ident = line + STRING_SIZE("author ");
1530 char *end = strchr(ident, '<');
1533 for (; end > ident && isspace(end[-1]); end--) ;
1537 commit = view->line[view->lines - 1];
1538 string_copy(commit->author, ident);
1540 /* Parse epoch and timezone */
1542 char *secs = strchr(end + 1, '>');
1546 if (!secs || secs[1] != ' ')
1550 time = (time_t) atol(secs);
1551 zone = strchr(secs, ' ');
1552 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1556 tz = ('0' - zone[1]) * 60 * 60 * 10;
1557 tz += ('0' - zone[2]) * 60 * 60;
1558 tz += ('0' - zone[3]) * 60;
1559 tz += ('0' - zone[4]) * 60;
1566 gmtime_r(&time, &commit->time);
1571 /* We should only ever end up here if there has already been a
1572 * commit line, however, be safe. */
1573 if (view->lines == 0)
1576 /* Fill in the commit title if it has not already been set. */
1577 commit = view->line[view->lines - 1];
1578 if (commit->title[0])
1581 /* Require titles to start with a non-space character at the
1582 * offset used by git log. */
1583 /* FIXME: More gracefull handling of titles; append "..." to
1584 * shortened titles, etc. */
1585 if (strncmp(line, " ", 4) ||
1589 string_copy(commit->title, line + 4);
1596 main_enter(struct view *view)
1598 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED);
1602 static struct view_ops main_ops = {
1612 /* Whether or not the curses interface has been initialized. */
1613 bool cursed = FALSE;
1615 /* The status window is used for polling keystrokes. */
1616 static WINDOW *status_win;
1618 /* Update status and title window. */
1620 report(const char *msg, ...)
1624 /* Update the title window first, so the cursor ends up in the status
1626 update_view_title(display[current_view]);
1628 va_start(args, msg);
1631 wmove(status_win, 0, 0);
1633 vwprintw(status_win, msg, args);
1634 wrefresh(status_win);
1639 /* Controls when nodelay should be in effect when polling user input. */
1641 set_nonblocking_input(bool loading)
1643 /* The number of loading views. */
1644 static unsigned int nloading;
1646 if ((loading == FALSE && nloading-- == 1) ||
1647 (loading == TRUE && nloading++ == 0))
1648 nodelay(status_win, loading);
1656 /* Initialize the curses library */
1657 if (isatty(STDIN_FILENO)) {
1658 cursed = !!initscr();
1660 /* Leave stdin and stdout alone when acting as a pager. */
1661 FILE *io = fopen("/dev/tty", "r+");
1663 cursed = !!newterm(NULL, io, io);
1667 die("Failed to initialize curses");
1669 nonl(); /* Tell curses not to do NL->CR/NL on output */
1670 cbreak(); /* Take input chars one at a time, no wait for \n */
1671 noecho(); /* Don't echo input */
1672 leaveok(stdscr, TRUE);
1677 getmaxyx(stdscr, y, x);
1678 status_win = newwin(1, 0, y - 1, 0);
1680 die("Failed to create status window");
1682 /* Enable keyboard mapping */
1683 keypad(status_win, TRUE);
1684 wbkgdset(status_win, get_line_attr(LINE_STATUS));
1694 /* XXX: Restore tty modes and let the OS cleanup the rest! */
1700 static void die(const char *err, ...)
1706 va_start(args, err);
1707 fputs("tig: ", stderr);
1708 vfprintf(stderr, err, args);
1709 fputs("\n", stderr);
1715 #include <readline/readline.h>
1718 main(int argc, char *argv[])
1721 enum request request;
1724 signal(SIGINT, quit);
1726 if (!parse_options(argc, argv))
1729 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
1730 view->cmd_env = getenv(view->cmd_env);
1732 request = opt_request;
1736 while (view_driver(display[current_view], request)) {
1740 foreach_view (view, i)
1743 /* Refresh, accept single keystroke of input */
1744 key = wgetch(status_win);
1745 request = get_request(key);
1747 /* Some low-level request handling. This keeps handling of
1748 * status_win restricted. */
1752 /* Temporarily switch to line-oriented and echoed
1757 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
1758 memcpy(opt_cmd, "git ", 4);
1759 opt_request = REQ_VIEW_PAGER;
1768 case REQ_SCREEN_RESIZE:
1772 getmaxyx(stdscr, height, width);
1774 /* Resize the status view and let the view driver take
1775 * care of resizing the displayed views. */
1776 wresize(status_win, 1, width);
1777 mvwin(status_win, height - 1, 0);
1778 wrefresh(status_win);
1794 * Features that should be explored.
1802 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
1804 * This program is free software; you can redistribute it and/or modify
1805 * it under the terms of the GNU General Public License as published by
1806 * the Free Software Foundation; either version 2 of the License, or
1807 * (at your option) any later version.
1812 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
1813 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
1814 * gitk(1): git repository browser written using tcl/tk,
1815 * gitview(1): git repository browser written using python/gtk.