1 /* Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
3 * This program is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU General Public License as
5 * published by the Free Software Foundation; either version 2 of
6 * the License, or (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
19 * tig - text-mode interface for git
25 * tig [options] [--] [git log options]
26 * tig [options] log [git log options]
27 * tig [options] diff [git diff options]
28 * tig [options] show [git show options]
29 * tig [options] < [git command output]
33 * Browse changes in a git repository. Additionally, tig(1) can also act
34 * as a pager for output of various git commands.
36 * When browsing repositories, tig(1) uses the underlying git commands
37 * to present the user with various views, such as summarized commit log
38 * and showing the commit with the log message, diffstat, and the diff.
40 * Using tig(1) as a pager, it will display input from stdin and try
45 #define VERSION "tig-0.3"
65 static void die(const char *err, ...);
66 static void report(const char *msg, ...);
67 static int read_properties(const char *cmd, int separator, int (*read)(char *, int, char *, int));
68 static void set_nonblocking_input(bool loading);
69 static size_t utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed);
71 #define ABS(x) ((x) >= 0 ? (x) : -(x))
72 #define MIN(x, y) ((x) < (y) ? (x) : (y))
74 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
75 #define STRING_SIZE(x) (sizeof(x) - 1)
77 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
78 #define SIZEOF_CMD 1024 /* Size of command buffer. */
80 /* This color name can be used to refer to the default term colors. */
81 #define COLOR_DEFAULT (-1)
83 #define TIG_HELP "(d)iff, (l)og, (m)ain, (q)uit, (h)elp"
85 /* The format and size of the date column in the main view. */
86 #define DATE_FORMAT "%Y-%m-%d %H:%M"
87 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
89 #define AUTHOR_COLS 20
91 /* The default interval between line numbers. */
92 #define NUMBER_INTERVAL 1
96 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
98 /* Some ascii-shorthands fitted into the ncurses namespace. */
100 #define KEY_RETURN '\r'
104 /* User action requests. */
106 /* Offset all requests to avoid conflicts with ncurses getch values. */
107 REQ_OFFSET = KEY_MAX + 1,
109 /* XXX: Keep the view request first and in sync with views[]. */
124 REQ_TOGGLE_LINE_NUMBERS,
138 REQ_SCROLL_LINE_DOWN,
140 REQ_SCROLL_PAGE_DOWN,
144 char *name; /* Ref name; tag or head names are shortened. */
145 char id[41]; /* Commit SHA1 ID */
146 unsigned int tag:1; /* Is it a tag? */
147 unsigned int next:1; /* For ref lists: are there more refs? */
150 static struct ref **get_refs(char *id);
158 string_ncopy(char *dst, const char *src, int dstlen)
160 strncpy(dst, src, dstlen - 1);
165 /* Shorthand for safely copying into a fixed buffer. */
166 #define string_copy(dst, src) \
167 string_ncopy(dst, src, sizeof(dst))
172 * NOTE: The following is a slightly modified copy of the git project's shell
173 * quoting routines found in the quote.c file.
175 * Help to copy the thing properly quoted for the shell safety. any single
176 * quote is replaced with '\'', any exclamation point is replaced with '\!',
177 * and the whole thing is enclosed in a
180 * original sq_quote result
181 * name ==> name ==> 'name'
182 * a b ==> a b ==> 'a b'
183 * a'b ==> a'\''b ==> 'a'\''b'
184 * a!b ==> a'\!'b ==> 'a'\!'b'
188 sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
192 #define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0)
195 while ((c = *src++)) {
196 if (c == '\'' || c == '!') {
216 static const char usage[] =
217 VERSION " (" __DATE__ ")\n"
219 "Usage: tig [options]\n"
220 " or: tig [options] [--] [git log options]\n"
221 " or: tig [options] log [git log options]\n"
222 " or: tig [options] diff [git diff options]\n"
223 " or: tig [options] show [git show options]\n"
224 " or: tig [options] < [git command output]\n"
227 " -l Start up in log view\n"
228 " -d Start up in diff view\n"
229 " -n[I], --line-number[=I] Show line numbers with given interval\n"
230 " -t[N], --tab-size[=N] Set number of spaces for tab expansion\n"
231 " -- Mark end of tig options\n"
232 " -v, --version Show version and exit\n"
233 " -h, --help Show help message and exit\n";
235 /* Option and state variables. */
236 static bool opt_line_number = FALSE;
237 static int opt_num_interval = NUMBER_INTERVAL;
238 static int opt_tab_size = TABSIZE;
239 static enum request opt_request = REQ_VIEW_MAIN;
240 static char opt_cmd[SIZEOF_CMD] = "";
241 static char opt_encoding[20] = "";
242 static bool opt_utf8 = TRUE;
243 static FILE *opt_pipe = NULL;
245 /* Returns the index of log or diff command or -1 to exit. */
247 parse_options(int argc, char *argv[])
251 for (i = 1; i < argc; i++) {
256 * Start up in log view using the internal log command.
258 if (!strcmp(opt, "-l")) {
259 opt_request = REQ_VIEW_LOG;
265 * Start up in diff view using the internal diff command.
267 if (!strcmp(opt, "-d")) {
268 opt_request = REQ_VIEW_DIFF;
273 * -n[INTERVAL], --line-number[=INTERVAL]::
274 * Prefix line numbers in log and diff view.
275 * Optionally, with interval different than each line.
277 if (!strncmp(opt, "-n", 2) ||
278 !strncmp(opt, "--line-number", 13)) {
284 } else if (opt[STRING_SIZE("--line-number")] == '=') {
285 num = opt + STRING_SIZE("--line-number=");
289 opt_num_interval = atoi(num);
291 opt_line_number = TRUE;
296 * -b[NSPACES], --tab-size[=NSPACES]::
297 * Set the number of spaces tabs should be expanded to.
299 if (!strncmp(opt, "-b", 2) ||
300 !strncmp(opt, "--tab-size", 10)) {
306 } else if (opt[STRING_SIZE("--tab-size")] == '=') {
307 num = opt + STRING_SIZE("--tab-size=");
311 opt_tab_size = MIN(atoi(num), TABSIZE);
317 * Show version and exit.
319 if (!strcmp(opt, "-v") ||
320 !strcmp(opt, "--version")) {
321 printf("tig version %s\n", VERSION);
327 * Show help message and exit.
329 if (!strcmp(opt, "-h") ||
330 !strcmp(opt, "--help")) {
337 * End of tig(1) options. Useful when specifying command
338 * options for the main view. Example:
340 * $ tig -- --since=1.month
342 if (!strcmp(opt, "--")) {
348 * log [git log options]::
349 * Open log view using the given git log options.
351 * diff [git diff options]::
352 * Open diff view using the given git diff options.
354 * show [git show options]::
355 * Open diff view using the given git show options.
357 if (!strcmp(opt, "log") ||
358 !strcmp(opt, "diff") ||
359 !strcmp(opt, "show")) {
360 opt_request = opt[0] == 'l'
361 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
366 * [git log options]::
367 * tig(1) will stop the option parsing when the first
368 * command line parameter not starting with "-" is
369 * encountered. All options including this one will be
370 * passed to git log when loading the main view.
371 * This makes it possible to say:
373 * $ tig tag-1.0..HEAD
375 if (opt[0] && opt[0] != '-')
378 die("unknown command '%s'", opt);
381 if (!isatty(STDIN_FILENO)) {
385 * If stdin is a pipe, any log or diff options will be ignored and the
386 * pager view will be opened loading data from stdin. The pager mode
387 * can be used for colorizing output from various git commands.
389 * Example on how to colorize the output of git-show(1):
393 opt_request = REQ_VIEW_PAGER;
396 } else if (i < argc) {
400 * Git command options
401 * ~~~~~~~~~~~~~~~~~~~
402 * All git command options specified on the command line will
403 * be passed to the given command and all will be shell quoted
404 * before they are passed to the shell.
406 * NOTE: If you specify options for the main view, you should
407 * not use the `--pretty` option as this option will be set
408 * automatically to the format expected by the main view.
410 * Example on how to open the log view and show both author and
411 * committer information:
413 * $ tig log --pretty=fuller
415 * See the <<refspec, "Specifying revisions">> section below
416 * for an introduction to revision options supported by the git
417 * commands. For details on specific git command options, refer
418 * to the man page of the command in question.
421 if (opt_request == REQ_VIEW_MAIN)
422 /* XXX: This is vulnerable to the user overriding
423 * options required for the main view parser. */
424 string_copy(opt_cmd, "git log --stat --pretty=raw");
426 string_copy(opt_cmd, "git");
427 buf_size = strlen(opt_cmd);
429 while (buf_size < sizeof(opt_cmd) && i < argc) {
430 opt_cmd[buf_size++] = ' ';
431 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
434 if (buf_size >= sizeof(opt_cmd))
435 die("command too long");
437 opt_cmd[buf_size] = 0;
441 if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8"))
449 * ENVIRONMENT VARIABLES
450 * ---------------------
451 * Several options related to the interface with git can be configured
452 * via environment options.
454 * Repository references
455 * ~~~~~~~~~~~~~~~~~~~~~
456 * Commits that are referenced by tags and branch heads will be marked
457 * by the reference name surrounded by '[' and ']':
459 * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
461 * If you want to filter out certain directories under `.git/refs/`, say
462 * `tmp` you can do it by setting the following variable:
464 * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
466 * Or set the variable permanently in your environment.
469 * Set command for retrieving all repository references. The command
470 * should output data in the same format as git-ls-remote(1).
473 #define TIG_LS_REMOTE \
474 "git ls-remote . 2>/dev/null"
477 * [[history-commands]]
480 * It is possible to alter which commands are used for the different views.
481 * If for example you prefer commits in the main view to be sorted by date
482 * and only show 500 commits, use:
484 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
486 * Or set the variable permanently in your environment.
488 * Notice, how `%s` is used to specify the commit reference. There can
489 * be a maximum of 5 `%s` ref specifications.
492 * The command used for the diff view. By default, git show is used
496 * The command used for the log view. If you prefer to have both
497 * author and committer shown in the log view be sure to pass
498 * `--pretty=fuller` to git log.
501 * The command used for the main view. Note, you must always specify
502 * the option: `--pretty=raw` since the main view parser expects to
506 #define TIG_DIFF_CMD \
507 "git show --patch-with-stat --find-copies-harder -B -C %s"
509 #define TIG_LOG_CMD \
510 "git log --cc --stat -n100 %s"
512 #define TIG_MAIN_CMD \
513 "git log --topo-order --stat --pretty=raw %s"
515 /* ... silently ignore that the following are also exported. */
517 #define TIG_HELP_CMD \
518 "man tig 2>/dev/null"
520 #define TIG_PAGER_CMD \
525 * Line-oriented content detection.
529 /* Line type String to match Foreground Background Attributes
530 * --------- --------------- ---------- ---------- ---------- */ \
532 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
533 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
534 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
535 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
536 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
537 LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
538 LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
539 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
540 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
541 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
542 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
543 /* Pretty print commit header */ \
544 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
545 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
546 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
547 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
548 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
549 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
550 /* Raw commit header */ \
551 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
552 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
553 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
554 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
555 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
557 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
558 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
560 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
561 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
562 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
563 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
564 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
565 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
566 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
567 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
568 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
569 LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
570 LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
573 #define LINE(type, line, fg, bg, attr) \
580 const char *line; /* The start of line to match. */
581 int linelen; /* Size of string to match. */
582 int fg, bg, attr; /* Color and text attributes for the lines. */
585 static struct line_info line_info[] = {
586 #define LINE(type, line, fg, bg, attr) \
587 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
592 static enum line_type
593 get_line_type(char *line)
595 int linelen = strlen(line);
598 for (type = 0; type < ARRAY_SIZE(line_info); type++)
599 /* Case insensitive search matches Signed-off-by lines better. */
600 if (linelen >= line_info[type].linelen &&
601 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
608 get_line_attr(enum line_type type)
610 assert(type < ARRAY_SIZE(line_info));
611 return COLOR_PAIR(type) | line_info[type].attr;
617 int default_bg = COLOR_BLACK;
618 int default_fg = COLOR_WHITE;
623 if (use_default_colors() != ERR) {
628 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
629 struct line_info *info = &line_info[type];
630 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
631 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
633 init_pair(type, fg, bg);
639 void *data; /* User data */
646 * The display consists of a status window on the last line of the screen and
647 * one or more views. The default is to only show one view at the time but it
648 * is possible to split both the main and log view to also show the commit
651 * If you are in the log view and press 'Enter' when the current line is a
652 * commit line, such as:
654 * commit 4d55caff4cc89335192f3e566004b4ceef572521
656 * You will split the view so that the log view is displayed in the top window
657 * and the diff view in the bottom window. You can switch between the two
658 * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
664 /* The display array of active views and the index of the current view. */
665 static struct view *display[2];
666 static unsigned int current_view;
668 #define foreach_view(view, i) \
669 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
671 #define displayed_views() (display[1] != NULL ? 2 : 1)
674 * Current head and commit ID
675 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
676 * The viewer keeps track of both what head and commit ID you are currently
677 * viewing. The commit ID will follow the cursor line and change everytime time
678 * you highlight a different commit. Whenever you reopen the diff view it
679 * will be reloaded, if the commit ID changed.
681 * The head ID is used when opening the main and log view to indicate from
682 * what revision to show history.
685 static char ref_commit[SIZEOF_REF] = "HEAD";
686 static char ref_head[SIZEOF_REF] = "HEAD";
689 const char *name; /* View name */
690 const char *cmd_fmt; /* Default command line format */
691 const char *cmd_env; /* Command line set via environment */
692 const char *id; /* Points to either of ref_{head,commit} */
694 struct view_ops *ops; /* View operations */
696 char cmd[SIZEOF_CMD]; /* Command buffer */
697 char ref[SIZEOF_REF]; /* Hovered commit reference */
698 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
700 int height, width; /* The width and height of the main window */
701 WINDOW *win; /* The main window */
702 WINDOW *title; /* The title window living below the main window */
705 unsigned long offset; /* Offset of the window top */
706 unsigned long lineno; /* Current line number */
708 /* If non-NULL, points to the view that opened this view. If this view
709 * is closed tig will switch back to the parent view. */
713 unsigned long lines; /* Total number of lines */
714 struct line *line; /* Line index */
715 unsigned int digits; /* Number of digits in the lines member. */
723 /* What type of content being displayed. Used in the title bar. */
725 /* Draw one line; @lineno must be < view->height. */
726 bool (*draw)(struct view *view, struct line *line, unsigned int lineno);
727 /* Read one line; updates view->line. */
728 bool (*read)(struct view *view, struct line *prev, char *data);
729 /* Depending on view, change display based on current line. */
730 bool (*enter)(struct view *view, struct line *line);
733 static struct view_ops pager_ops;
734 static struct view_ops main_ops;
736 #define VIEW_STR(name, cmd, env, ref, ops) \
737 { name, cmd, #env, ref, ops }
739 #define VIEW_(id, name, ops, ref) \
740 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops)
745 * tig(1) presents various 'views' of a repository. Each view is based on output
746 * from an external command, most often 'git log', 'git diff', or 'git show'.
749 * Is the default view, and it shows a one line summary of each commit
750 * in the chosen list of revisions. The summary includes commit date,
751 * author, and the first line of the log message. Additionally, any
752 * repository references, such as tags, will be shown.
755 * Presents a more rich view of the revision log showing the whole log
756 * message and the diffstat.
759 * Shows either the diff of the current working tree, that is, what
760 * has changed since the last commit, or the commit diff complete
761 * with log message, diffstat and diff.
764 * Is used for displaying both input from stdin and output from git
765 * commands entered in the internal prompt.
768 * Displays the information from the tig(1) man page. For the help view
769 * to work you need to have the tig(1) man page installed.
772 static struct view views[] = {
773 VIEW_(MAIN, "main", &main_ops, ref_head),
774 VIEW_(DIFF, "diff", &pager_ops, ref_commit),
775 VIEW_(LOG, "log", &pager_ops, ref_head),
776 VIEW_(HELP, "help", &pager_ops, "static"),
777 VIEW_(PAGER, "pager", &pager_ops, "static"),
780 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
784 draw_view_line(struct view *view, unsigned int lineno)
786 if (view->offset + lineno >= view->lines)
789 return view->ops->draw(view, &view->line[view->offset + lineno], lineno);
793 redraw_view_from(struct view *view, int lineno)
795 assert(0 <= lineno && lineno < view->height);
797 for (; lineno < view->height; lineno++) {
798 if (!draw_view_line(view, lineno))
802 redrawwin(view->win);
807 redraw_view(struct view *view)
810 redraw_view_from(view, 0);
817 * Each view has a title window which shows the name of the view, current
818 * commit ID if available, and where the view is positioned:
820 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
822 * By default, the title of the current view is highlighted using bold font.
826 update_view_title(struct view *view)
828 if (view == display[current_view])
829 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
831 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
834 wmove(view->title, 0, 0);
837 wprintw(view->title, "[%s] %s", view->name, view->ref);
839 wprintw(view->title, "[%s]", view->name);
841 if (view->lines || view->pipe) {
842 unsigned int lines = view->lines
843 ? (view->lineno + 1) * 100 / view->lines
846 wprintw(view->title, " - %s %d of %d (%d%%)",
854 time_t secs = time(NULL) - view->start_time;
856 /* Three git seconds are a long time ... */
858 wprintw(view->title, " %lds", secs);
861 wmove(view->title, 0, view->width - 1);
862 wrefresh(view->title);
869 struct view *base = display[0];
870 struct view *view = display[1] ? display[1] : display[0];
872 /* Setup window dimensions */
874 getmaxyx(stdscr, base->height, base->width);
876 /* Make room for the status window. */
880 /* Horizontal split. */
881 view->width = base->width;
882 view->height = SCALE_SPLIT_VIEW(base->height);
883 base->height -= view->height;
885 /* Make room for the title bar. */
889 /* Make room for the title bar. */
894 foreach_view (view, i) {
896 view->win = newwin(view->height, 0, offset, 0);
898 die("Failed to create %s view", view->name);
900 scrollok(view->win, TRUE);
902 view->title = newwin(1, 0, offset + view->height, 0);
904 die("Failed to create title window");
907 wresize(view->win, view->height, view->width);
908 mvwin(view->win, offset, 0);
909 mvwin(view->title, offset + view->height, 0);
912 offset += view->height + 1;
922 foreach_view (view, i) {
924 update_view_title(view);
929 update_display_cursor(void)
931 struct view *view = display[current_view];
933 /* Move the cursor to the right-most column of the cursor line.
935 * XXX: This could turn out to be a bit expensive, but it ensures that
936 * the cursor does not jump around. */
938 wmove(view->win, view->lineno - view->offset, view->width - 1);
947 /* Scrolling backend */
949 do_scroll_view(struct view *view, int lines, bool redraw)
951 /* The rendering expects the new offset. */
952 view->offset += lines;
954 assert(0 <= view->offset && view->offset < view->lines);
957 /* Redraw the whole screen if scrolling is pointless. */
958 if (view->height < ABS(lines)) {
962 int line = lines > 0 ? view->height - lines : 0;
963 int end = line + ABS(lines);
965 wscrl(view->win, lines);
967 for (; line < end; line++) {
968 if (!draw_view_line(view, line))
973 /* Move current line into the view. */
974 if (view->lineno < view->offset) {
975 view->lineno = view->offset;
976 draw_view_line(view, 0);
978 } else if (view->lineno >= view->offset + view->height) {
979 if (view->lineno == view->offset + view->height) {
980 /* Clear the hidden line so it doesn't show if the view
982 wmove(view->win, view->height, 0);
983 wclrtoeol(view->win);
985 view->lineno = view->offset + view->height - 1;
986 draw_view_line(view, view->lineno - view->offset);
989 assert(view->offset <= view->lineno && view->lineno < view->lines);
994 redrawwin(view->win);
999 /* Scroll frontend */
1001 scroll_view(struct view *view, enum request request)
1006 case REQ_SCROLL_PAGE_DOWN:
1007 lines = view->height;
1008 case REQ_SCROLL_LINE_DOWN:
1009 if (view->offset + lines > view->lines)
1010 lines = view->lines - view->offset;
1012 if (lines == 0 || view->offset + view->height >= view->lines) {
1013 report("Cannot scroll beyond the last line");
1018 case REQ_SCROLL_PAGE_UP:
1019 lines = view->height;
1020 case REQ_SCROLL_LINE_UP:
1021 if (lines > view->offset)
1022 lines = view->offset;
1025 report("Cannot scroll beyond the first line");
1033 die("request %d not handled in switch", request);
1036 do_scroll_view(view, lines, TRUE);
1041 move_view(struct view *view, enum request request, bool redraw)
1046 case REQ_MOVE_FIRST_LINE:
1047 steps = -view->lineno;
1050 case REQ_MOVE_LAST_LINE:
1051 steps = view->lines - view->lineno - 1;
1054 case REQ_MOVE_PAGE_UP:
1055 steps = view->height > view->lineno
1056 ? -view->lineno : -view->height;
1059 case REQ_MOVE_PAGE_DOWN:
1060 steps = view->lineno + view->height >= view->lines
1061 ? view->lines - view->lineno - 1 : view->height;
1073 die("request %d not handled in switch", request);
1076 if (steps <= 0 && view->lineno == 0) {
1077 report("Cannot move beyond the first line");
1080 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1081 report("Cannot move beyond the last line");
1085 /* Move the current line */
1086 view->lineno += steps;
1087 assert(0 <= view->lineno && view->lineno < view->lines);
1089 /* Repaint the old "current" line if we be scrolling */
1090 if (ABS(steps) < view->height) {
1091 int prev_lineno = view->lineno - steps - view->offset;
1093 wmove(view->win, prev_lineno, 0);
1094 wclrtoeol(view->win);
1095 draw_view_line(view, prev_lineno);
1098 /* Check whether the view needs to be scrolled */
1099 if (view->lineno < view->offset ||
1100 view->lineno >= view->offset + view->height) {
1101 if (steps < 0 && -steps > view->offset) {
1102 steps = -view->offset;
1104 } else if (steps > 0) {
1105 if (view->lineno == view->lines - 1 &&
1106 view->lines > view->height) {
1107 steps = view->lines - view->offset - 1;
1108 if (steps >= view->height)
1109 steps -= view->height - 1;
1113 do_scroll_view(view, steps, redraw);
1117 /* Draw the current line */
1118 draw_view_line(view, view->lineno - view->offset);
1123 redrawwin(view->win);
1124 wrefresh(view->win);
1130 * Incremental updating
1134 end_update(struct view *view)
1138 set_nonblocking_input(FALSE);
1139 if (view->pipe == stdin)
1147 begin_update(struct view *view)
1149 const char *id = view->id;
1155 string_copy(view->cmd, opt_cmd);
1157 /* When running random commands, the view ref could have become
1158 * invalid so clear it. */
1161 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1163 if (snprintf(view->cmd, sizeof(view->cmd), format,
1164 id, id, id, id, id) >= sizeof(view->cmd))
1168 /* Special case for the pager view. */
1170 view->pipe = opt_pipe;
1173 view->pipe = popen(view->cmd, "r");
1179 set_nonblocking_input(TRUE);
1184 string_copy(view->vid, id);
1189 for (i = 0; i < view->lines; i++)
1190 if (view->line[i].data)
1191 free(view->line[i].data);
1197 view->start_time = time(NULL);
1203 update_view(struct view *view)
1205 char buffer[BUFSIZ];
1208 /* The number of lines to read. If too low it will cause too much
1209 * redrawing (and possible flickering), if too high responsiveness
1211 unsigned long lines = view->height;
1212 int redraw_from = -1;
1217 /* Only redraw if lines are visible. */
1218 if (view->offset + view->height >= view->lines)
1219 redraw_from = view->lines - view->offset;
1221 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1227 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1228 int linelen = strlen(line);
1230 struct line *prev = view->lines
1231 ? &view->line[view->lines - 1]
1235 line[linelen - 1] = 0;
1237 if (!view->ops->read(view, prev, line))
1247 lines = view->lines;
1248 for (digits = 0; lines; digits++)
1251 /* Keep the displayed view in sync with line number scaling. */
1252 if (digits != view->digits) {
1253 view->digits = digits;
1258 if (redraw_from >= 0) {
1259 /* If this is an incremental update, redraw the previous line
1260 * since for commits some members could have changed when
1261 * loading the main view. */
1262 if (redraw_from > 0)
1265 /* Incrementally draw avoids flickering. */
1266 redraw_view_from(view, redraw_from);
1269 /* Update the title _after_ the redraw so that if the redraw picks up a
1270 * commit reference in view->ref it'll be available here. */
1271 update_view_title(view);
1273 if (ferror(view->pipe)) {
1274 report("Failed to read: %s", strerror(errno));
1277 } else if (feof(view->pipe)) {
1278 if (view == VIEW(REQ_VIEW_HELP)) {
1279 const char *msg = TIG_HELP;
1281 if (view->lines == 0) {
1282 /* Slightly ugly, but abusing view->ref keeps
1283 * the error message. */
1284 string_copy(view->ref, "No help available");
1285 msg = "The tig(1) manpage is not installed";
1299 report("Allocation failure");
1307 OPEN_DEFAULT = 0, /* Use default view switching. */
1308 OPEN_SPLIT = 1, /* Split current view. */
1309 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1310 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1314 open_view(struct view *prev, enum request request, enum open_flags flags)
1316 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1317 bool split = !!(flags & OPEN_SPLIT);
1318 bool reload = !!(flags & OPEN_RELOAD);
1319 struct view *view = VIEW(request);
1320 int nviews = displayed_views();
1321 struct view *base_view = display[0];
1323 if (view == prev && nviews == 1 && !reload) {
1324 report("Already in %s view", view->name);
1328 if ((reload || strcmp(view->vid, view->id)) &&
1329 !begin_update(view)) {
1330 report("Failed to load %s view", view->name);
1335 display[current_view + 1] = view;
1339 /* Maximize the current view. */
1340 memset(display, 0, sizeof(display));
1342 display[current_view] = view;
1345 /* Resize the view when switching between split- and full-screen,
1346 * or when switching between two different full-screen views. */
1347 if (nviews != displayed_views() ||
1348 (nviews == 1 && base_view != display[0]))
1351 if (split && prev->lineno - prev->offset >= prev->height) {
1352 /* Take the title line into account. */
1353 int lines = prev->lineno - prev->offset - prev->height + 1;
1355 /* Scroll the view that was split if the current line is
1356 * outside the new limited view. */
1357 do_scroll_view(prev, lines, TRUE);
1360 if (prev && view != prev) {
1361 if (split && !backgrounded) {
1362 /* "Blur" the previous view. */
1363 update_view_title(prev);
1366 view->parent = prev;
1369 if (view->pipe && view->lines == 0) {
1370 /* Clear the old view and let the incremental updating refill
1376 if (view == VIEW(REQ_VIEW_HELP))
1377 report("%s", TIG_HELP);
1382 /* If the view is backgrounded the above calls to report()
1383 * won't redraw the view title. */
1385 update_view_title(view);
1390 * User request switch noodle
1394 view_driver(struct view *view, enum request request)
1401 case REQ_MOVE_PAGE_UP:
1402 case REQ_MOVE_PAGE_DOWN:
1403 case REQ_MOVE_FIRST_LINE:
1404 case REQ_MOVE_LAST_LINE:
1405 move_view(view, request, TRUE);
1408 case REQ_SCROLL_LINE_DOWN:
1409 case REQ_SCROLL_LINE_UP:
1410 case REQ_SCROLL_PAGE_DOWN:
1411 case REQ_SCROLL_PAGE_UP:
1412 scroll_view(view, request);
1419 case REQ_VIEW_PAGER:
1420 open_view(view, request, OPEN_DEFAULT);
1425 request = request == REQ_NEXT ? REQ_MOVE_DOWN : REQ_MOVE_UP;
1427 if (view == VIEW(REQ_VIEW_DIFF) &&
1428 view->parent == VIEW(REQ_VIEW_MAIN)) {
1429 bool redraw = display[1] == view;
1431 view = view->parent;
1432 move_view(view, request, redraw);
1434 update_view_title(view);
1436 move_view(view, request, TRUE);
1443 report("Nothing to enter");
1446 return view->ops->enter(view, &view->line[view->lineno]);
1450 int nviews = displayed_views();
1451 int next_view = (current_view + 1) % nviews;
1453 if (next_view == current_view) {
1454 report("Only one view is displayed");
1458 current_view = next_view;
1459 /* Blur out the title of the previous view. */
1460 update_view_title(view);
1464 case REQ_TOGGLE_LINE_NUMBERS:
1465 opt_line_number = !opt_line_number;
1470 /* Always reload^Wrerun commands from the prompt. */
1471 open_view(view, opt_request, OPEN_RELOAD);
1474 case REQ_STOP_LOADING:
1475 for (i = 0; i < ARRAY_SIZE(views); i++) {
1478 report("Stopped loading the %s view", view->name),
1483 case REQ_SHOW_VERSION:
1484 report("%s (built %s)", VERSION, __DATE__);
1487 case REQ_SCREEN_RESIZE:
1490 case REQ_SCREEN_REDRAW:
1494 case REQ_SCREEN_UPDATE:
1498 case REQ_VIEW_CLOSE:
1499 /* XXX: Mark closed views by letting view->parent point to the
1500 * view itself. Parents to closed view should never be
1503 view->parent->parent != view->parent) {
1504 memset(display, 0, sizeof(display));
1506 display[current_view] = view->parent;
1507 view->parent = view;
1517 /* An unknown key will show most commonly used commands. */
1518 report("Unknown key, press 'h' for help");
1531 pager_draw(struct view *view, struct line *line, unsigned int lineno)
1533 char *text = line->data;
1534 enum line_type type = line->type;
1535 int textlen = strlen(text);
1538 wmove(view->win, lineno, 0);
1540 if (view->offset + lineno == view->lineno) {
1541 if (type == LINE_COMMIT) {
1542 string_copy(view->ref, text + 7);
1543 string_copy(ref_commit, view->ref);
1547 wchgat(view->win, -1, 0, type, NULL);
1550 attr = get_line_attr(type);
1551 wattrset(view->win, attr);
1553 if (opt_line_number || opt_tab_size < TABSIZE) {
1554 static char spaces[] = " ";
1555 int col_offset = 0, col = 0;
1557 if (opt_line_number) {
1558 unsigned long real_lineno = view->offset + lineno + 1;
1560 if (real_lineno == 1 ||
1561 (real_lineno % opt_num_interval) == 0) {
1562 wprintw(view->win, "%.*d", view->digits, real_lineno);
1565 waddnstr(view->win, spaces,
1566 MIN(view->digits, STRING_SIZE(spaces)));
1568 waddstr(view->win, ": ");
1569 col_offset = view->digits + 2;
1572 while (text && col_offset + col < view->width) {
1573 int cols_max = view->width - col_offset - col;
1577 if (*text == '\t') {
1579 assert(sizeof(spaces) > TABSIZE);
1581 cols = opt_tab_size - (col % opt_tab_size);
1584 text = strchr(text, '\t');
1585 cols = line ? text - pos : strlen(pos);
1588 waddnstr(view->win, pos, MIN(cols, cols_max));
1593 int col = 0, pos = 0;
1595 for (; pos < textlen && col < view->width; pos++, col++)
1596 if (text[pos] == '\t')
1597 col += TABSIZE - (col % TABSIZE) - 1;
1599 waddnstr(view->win, text, pos);
1606 pager_read(struct view *view, struct line *prev, char *line)
1608 /* Compress empty lines in the help view. */
1609 if (view == VIEW(REQ_VIEW_HELP) &&
1610 !*line && prev && !*((char *) prev->data))
1613 view->line[view->lines].data = strdup(line);
1614 if (!view->line[view->lines].data)
1617 view->line[view->lines].type = get_line_type(line);
1624 pager_enter(struct view *view, struct line *line)
1628 if (line->type == LINE_COMMIT &&
1629 (view == VIEW(REQ_VIEW_LOG) ||
1630 view == VIEW(REQ_VIEW_PAGER))) {
1631 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1635 /* Always scroll the view even if it was split. That way
1636 * you can use Enter to scroll through the log view and
1637 * split open each commit diff. */
1638 scroll_view(view, REQ_SCROLL_LINE_DOWN);
1640 /* FIXME: A minor workaround. Scrolling the view will call report("")
1641 * but if we are scrolling a non-current view this won't properly
1642 * update the view title. */
1644 update_view_title(view);
1649 static struct view_ops pager_ops = {
1662 char id[41]; /* SHA1 ID. */
1663 char title[75]; /* The first line of the commit message. */
1664 char author[75]; /* The author of the commit. */
1665 struct tm time; /* Date from the author ident. */
1666 struct ref **refs; /* Repository references; tags & branch heads. */
1670 main_draw(struct view *view, struct line *line, unsigned int lineno)
1672 char buf[DATE_COLS + 1];
1673 struct commit *commit = line->data;
1674 enum line_type type;
1680 if (!*commit->author)
1683 wmove(view->win, lineno, col);
1685 if (view->offset + lineno == view->lineno) {
1686 string_copy(view->ref, commit->id);
1687 string_copy(ref_commit, view->ref);
1689 wattrset(view->win, get_line_attr(type));
1690 wchgat(view->win, -1, 0, type, NULL);
1693 type = LINE_MAIN_COMMIT;
1694 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1697 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1698 waddnstr(view->win, buf, timelen);
1699 waddstr(view->win, " ");
1702 wmove(view->win, lineno, col);
1703 if (type != LINE_CURSOR)
1704 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1707 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1709 authorlen = strlen(commit->author);
1710 if (authorlen > AUTHOR_COLS - 2) {
1711 authorlen = AUTHOR_COLS - 2;
1717 waddnstr(view->win, commit->author, authorlen);
1718 if (type != LINE_CURSOR)
1719 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1720 waddch(view->win, '~');
1722 waddstr(view->win, commit->author);
1726 if (type != LINE_CURSOR)
1727 wattrset(view->win, A_NORMAL);
1729 mvwaddch(view->win, lineno, col, ACS_LTEE);
1730 wmove(view->win, lineno, col + 2);
1737 if (type == LINE_CURSOR)
1739 else if (commit->refs[i]->tag)
1740 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1742 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1743 waddstr(view->win, "[");
1744 waddstr(view->win, commit->refs[i]->name);
1745 waddstr(view->win, "]");
1746 if (type != LINE_CURSOR)
1747 wattrset(view->win, A_NORMAL);
1748 waddstr(view->win, " ");
1749 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1750 } while (commit->refs[i++]->next);
1753 if (type != LINE_CURSOR)
1754 wattrset(view->win, get_line_attr(type));
1757 int titlelen = strlen(commit->title);
1759 if (col + titlelen > view->width)
1760 titlelen = view->width - col;
1762 waddnstr(view->win, commit->title, titlelen);
1768 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1770 main_read(struct view *view, struct line *prev, char *line)
1772 enum line_type type = get_line_type(line);
1773 struct commit *commit;
1777 commit = calloc(1, sizeof(struct commit));
1781 line += STRING_SIZE("commit ");
1783 view->line[view->lines++].data = commit;
1784 string_copy(commit->id, line);
1785 commit->refs = get_refs(commit->id);
1790 char *ident = line + STRING_SIZE("author ");
1791 char *end = strchr(ident, '<');
1796 commit = prev->data;
1799 for (; end > ident && isspace(end[-1]); end--) ;
1803 string_copy(commit->author, ident);
1805 /* Parse epoch and timezone */
1807 char *secs = strchr(end + 1, '>');
1811 if (!secs || secs[1] != ' ')
1815 time = (time_t) atol(secs);
1816 zone = strchr(secs, ' ');
1817 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1821 tz = ('0' - zone[1]) * 60 * 60 * 10;
1822 tz += ('0' - zone[2]) * 60 * 60;
1823 tz += ('0' - zone[3]) * 60;
1824 tz += ('0' - zone[4]) * 60;
1831 gmtime_r(&time, &commit->time);
1839 commit = prev->data;
1841 /* Fill in the commit title if it has not already been set. */
1842 if (commit->title[0])
1845 /* Require titles to start with a non-space character at the
1846 * offset used by git log. */
1847 /* FIXME: More gracefull handling of titles; append "..." to
1848 * shortened titles, etc. */
1849 if (strncmp(line, " ", 4) ||
1853 string_copy(commit->title, line + 4);
1860 main_enter(struct view *view, struct line *line)
1862 enum open_flags flags = display[0] == view ? OPEN_SPLIT : OPEN_DEFAULT;
1864 open_view(view, REQ_VIEW_DIFF, flags);
1868 static struct view_ops main_ops = {
1879 * Below the default key bindings are shown.
1887 static struct keymap keymap[] = {
1892 * Switch to main view.
1894 * Switch to diff view.
1896 * Switch to log view.
1898 * Switch to pager view.
1902 { 'm', REQ_VIEW_MAIN },
1903 { 'd', REQ_VIEW_DIFF },
1904 { 'l', REQ_VIEW_LOG },
1905 { 'p', REQ_VIEW_PAGER },
1906 { 'h', REQ_VIEW_HELP },
1912 * Close view, if multiple views are open it will jump back to the
1913 * previous view in the view stack. If it is the last open view it
1914 * will quit. Use 'Q' to quit all views at once.
1916 * This key is "context sensitive" depending on what view you are
1917 * currently in. When in log view on a commit line or in the main
1918 * view, split the view and show the commit diff. In the diff view
1919 * pressing Enter will simply scroll the view one line down.
1921 * Switch to next view.
1923 * This key is "context sensitive" and will move the cursor one
1924 * line up. However, uf you opened a diff view from the main view
1925 * (split- or full-screen) it will change the cursor to point to
1926 * the previous commit in the main view and update the diff view
1929 * Similar to 'Up' but will move down.
1931 { 'q', REQ_VIEW_CLOSE },
1932 { KEY_TAB, REQ_VIEW_NEXT },
1933 { KEY_RETURN, REQ_ENTER },
1934 { KEY_UP, REQ_PREVIOUS },
1935 { KEY_DOWN, REQ_NEXT },
1941 * Move cursor one line up.
1943 * Move cursor one line down.
1947 * Move cursor one page up.
1950 * Move cursor one page down.
1952 * Jump to first line.
1954 * Jump to last line.
1956 { 'k', REQ_MOVE_UP },
1957 { 'j', REQ_MOVE_DOWN },
1958 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1959 { KEY_END, REQ_MOVE_LAST_LINE },
1960 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1961 { ' ', REQ_MOVE_PAGE_DOWN },
1962 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1963 { 'b', REQ_MOVE_PAGE_UP },
1964 { '-', REQ_MOVE_PAGE_UP },
1970 * Scroll view one line up.
1972 * Scroll view one line down.
1974 * Scroll view one page up.
1976 * Scroll view one page down.
1978 { KEY_IC, REQ_SCROLL_LINE_UP },
1979 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1980 { 'w', REQ_SCROLL_PAGE_UP },
1981 { 's', REQ_SCROLL_PAGE_DOWN },
1991 * Stop all background loading. This can be useful if you use
1992 * tig(1) in a repository with a long history without limiting
1997 * Toggle line numbers on/off.
1999 * Open prompt. This allows you to specify what git command
2005 { 'z', REQ_STOP_LOADING },
2006 { 'v', REQ_SHOW_VERSION },
2007 { 'r', REQ_SCREEN_REDRAW },
2008 { 'n', REQ_TOGGLE_LINE_NUMBERS },
2009 { ':', REQ_PROMPT },
2011 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
2012 { ERR, REQ_SCREEN_UPDATE },
2014 /* Use the ncurses SIGWINCH handler. */
2015 { KEY_RESIZE, REQ_SCREEN_RESIZE },
2019 get_request(int key)
2023 for (i = 0; i < ARRAY_SIZE(keymap); i++)
2024 if (keymap[i].alias == key)
2025 return keymap[i].request;
2027 return (enum request) key;
2032 * Unicode / UTF-8 handling
2034 * NOTE: Much of the following code for dealing with unicode is derived from
2035 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
2036 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
2039 /* I've (over)annotated a lot of code snippets because I am not entirely
2040 * confident that the approach taken by this small UTF-8 interface is correct.
2044 unicode_width(unsigned long c)
2047 (c <= 0x115f /* Hangul Jamo */
2050 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
2052 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
2053 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
2054 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
2055 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
2056 || (c >= 0xffe0 && c <= 0xffe6)
2057 || (c >= 0x20000 && c <= 0x2fffd)
2058 || (c >= 0x30000 && c <= 0x3fffd)))
2064 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
2065 * Illegal bytes are set one. */
2066 static const unsigned char utf8_bytes[256] = {
2067 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2068 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2069 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2070 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2071 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2072 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2073 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2,
2074 3,3,3,3,3,3,3,3, 3,3,3,3,3,3,3,3, 4,4,4,4,4,4,4,4, 5,5,5,5,6,6,1,1,
2077 /* Decode UTF-8 multi-byte representation into a unicode character. */
2078 static inline unsigned long
2079 utf8_to_unicode(const char *string, size_t length)
2081 unsigned long unicode;
2085 unicode = string[0];
2088 unicode = (string[0] & 0x1f) << 6;
2089 unicode += (string[1] & 0x3f);
2092 unicode = (string[0] & 0x0f) << 12;
2093 unicode += ((string[1] & 0x3f) << 6);
2094 unicode += (string[2] & 0x3f);
2097 unicode = (string[0] & 0x0f) << 18;
2098 unicode += ((string[1] & 0x3f) << 12);
2099 unicode += ((string[2] & 0x3f) << 6);
2100 unicode += (string[3] & 0x3f);
2103 unicode = (string[0] & 0x0f) << 24;
2104 unicode += ((string[1] & 0x3f) << 18);
2105 unicode += ((string[2] & 0x3f) << 12);
2106 unicode += ((string[3] & 0x3f) << 6);
2107 unicode += (string[4] & 0x3f);
2110 unicode = (string[0] & 0x01) << 30;
2111 unicode += ((string[1] & 0x3f) << 24);
2112 unicode += ((string[2] & 0x3f) << 18);
2113 unicode += ((string[3] & 0x3f) << 12);
2114 unicode += ((string[4] & 0x3f) << 6);
2115 unicode += (string[5] & 0x3f);
2118 die("Invalid unicode length");
2121 /* Invalid characters could return the special 0xfffd value but NUL
2122 * should be just as good. */
2123 return unicode > 0xffff ? 0 : unicode;
2126 /* Calculates how much of string can be shown within the given maximum width
2127 * and sets trimmed parameter to non-zero value if all of string could not be
2130 * Additionally, adds to coloffset how many many columns to move to align with
2131 * the expected position. Takes into account how multi-byte and double-width
2132 * characters will effect the cursor position.
2134 * Returns the number of bytes to output from string to satisfy max_width. */
2136 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2138 const char *start = string;
2139 const char *end = strchr(string, '\0');
2145 while (string < end) {
2146 int c = *(unsigned char *) string;
2147 unsigned char bytes = utf8_bytes[c];
2149 unsigned long unicode;
2151 if (string + bytes > end)
2154 /* Change representation to figure out whether
2155 * it is a single- or double-width character. */
2157 unicode = utf8_to_unicode(string, bytes);
2158 /* FIXME: Graceful handling of invalid unicode character. */
2162 ucwidth = unicode_width(unicode);
2164 if (width > max_width) {
2169 /* The column offset collects the differences between the
2170 * number of bytes encoding a character and the number of
2171 * columns will be used for rendering said character.
2173 * So if some character A is encoded in 2 bytes, but will be
2174 * represented on the screen using only 1 byte this will and up
2175 * adding 1 to the multi-byte column offset.
2177 * Assumes that no double-width character can be encoding in
2178 * less than two bytes. */
2179 if (bytes > ucwidth)
2180 mbwidth += bytes - ucwidth;
2185 *coloffset += mbwidth;
2187 return string - start;
2195 /* Whether or not the curses interface has been initialized. */
2196 static bool cursed = FALSE;
2198 /* The status window is used for polling keystrokes. */
2199 static WINDOW *status_win;
2201 /* Update status and title window. */
2203 report(const char *msg, ...)
2205 static bool empty = TRUE;
2206 struct view *view = display[current_view];
2208 if (!empty || *msg) {
2211 va_start(args, msg);
2214 wmove(status_win, 0, 0);
2216 vwprintw(status_win, msg, args);
2221 wrefresh(status_win);
2226 update_view_title(view);
2227 update_display_cursor();
2230 /* Controls when nodelay should be in effect when polling user input. */
2232 set_nonblocking_input(bool loading)
2234 static unsigned int loading_views;
2236 if ((loading == FALSE && loading_views-- == 1) ||
2237 (loading == TRUE && loading_views++ == 0))
2238 nodelay(status_win, loading);
2246 /* Initialize the curses library */
2247 if (isatty(STDIN_FILENO)) {
2248 cursed = !!initscr();
2250 /* Leave stdin and stdout alone when acting as a pager. */
2251 FILE *io = fopen("/dev/tty", "r+");
2253 cursed = !!newterm(NULL, io, io);
2257 die("Failed to initialize curses");
2259 nonl(); /* Tell curses not to do NL->CR/NL on output */
2260 cbreak(); /* Take input chars one at a time, no wait for \n */
2261 noecho(); /* Don't echo input */
2262 leaveok(stdscr, TRUE);
2267 getmaxyx(stdscr, y, x);
2268 status_win = newwin(1, 0, y - 1, 0);
2270 die("Failed to create status window");
2272 /* Enable keyboard mapping */
2273 keypad(status_win, TRUE);
2274 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2279 * Repository references
2282 static struct ref *refs;
2283 static size_t refs_size;
2285 /* Id <-> ref store */
2286 static struct ref ***id_refs;
2287 static size_t id_refs_size;
2289 static struct ref **
2292 struct ref ***tmp_id_refs;
2293 struct ref **ref_list = NULL;
2294 size_t ref_list_size = 0;
2297 for (i = 0; i < id_refs_size; i++)
2298 if (!strcmp(id, id_refs[i][0]->id))
2301 tmp_id_refs = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2305 id_refs = tmp_id_refs;
2307 for (i = 0; i < refs_size; i++) {
2310 if (strcmp(id, refs[i].id))
2313 tmp = realloc(ref_list, (ref_list_size + 1) * sizeof(*ref_list));
2321 if (ref_list_size > 0)
2322 ref_list[ref_list_size - 1]->next = 1;
2323 ref_list[ref_list_size] = &refs[i];
2325 /* XXX: The properties of the commit chains ensures that we can
2326 * safely modify the shared ref. The repo references will
2327 * always be similar for the same id. */
2328 ref_list[ref_list_size]->next = 0;
2333 id_refs[id_refs_size++] = ref_list;
2339 read_ref(char *id, int idlen, char *name, int namelen)
2343 bool tag_commit = FALSE;
2345 /* Commits referenced by tags has "^{}" appended. */
2346 if (name[namelen - 1] == '}') {
2347 while (namelen > 0 && name[namelen] != '^')
2354 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2357 name += STRING_SIZE("refs/tags/");
2360 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2361 name += STRING_SIZE("refs/heads/");
2363 } else if (!strcmp(name, "HEAD")) {
2367 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2371 ref = &refs[refs_size++];
2372 ref->name = strdup(name);
2377 string_copy(ref->id, id);
2385 const char *cmd_env = getenv("TIG_LS_REMOTE");
2386 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2388 return read_properties(cmd, '\t', read_ref);
2392 read_config_option(char *name, int namelen, char *value, int valuelen)
2394 if (!strcmp(name, "i18n.commitencoding")) {
2395 string_copy(opt_encoding, value);
2404 return read_properties("git repo-config --list", '=',
2405 read_config_option);
2409 read_properties(const char *cmd, int separator,
2410 int (*read_property)(char *, int, char *, int))
2412 FILE *pipe = popen(cmd, "r");
2413 char buffer[BUFSIZ];
2420 while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) {
2421 char *value = strchr(name, separator);
2426 namelen = value - name;
2428 valuelen = strlen(value);
2431 value[valuelen] = 0;
2435 namelen = strlen(name);
2441 state = read_property(name, namelen, value, valuelen);
2444 if (state != ERR && ferror(pipe))
2458 #define __NORETURN __attribute__((__noreturn__))
2463 static void __NORETURN
2466 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2472 static void __NORETURN
2473 die(const char *err, ...)
2479 va_start(args, err);
2480 fputs("tig: ", stderr);
2481 vfprintf(stderr, err, args);
2482 fputs("\n", stderr);
2489 main(int argc, char *argv[])
2492 enum request request;
2495 signal(SIGINT, quit);
2497 /* Load the repo config file first so options can be overwritten from
2498 * the command line. */
2499 if (load_config() == ERR)
2500 die("Failed to load repo config.");
2502 if (!parse_options(argc, argv))
2505 if (load_refs() == ERR)
2506 die("Failed to load refs.");
2508 /* Require a git repository unless when running in pager mode. */
2509 if (refs_size == 0 && opt_request != REQ_VIEW_PAGER)
2510 die("Not a git repository");
2512 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2513 view->cmd_env = getenv(view->cmd_env);
2515 request = opt_request;
2519 while (view_driver(display[current_view], request)) {
2523 foreach_view (view, i)
2526 /* Refresh, accept single keystroke of input */
2527 key = wgetch(status_win);
2528 request = get_request(key);
2530 /* Some low-level request handling. This keeps access to
2531 * status_win restricted. */
2535 /* Temporarily switch to line-oriented and echoed
2540 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2541 memcpy(opt_cmd, "git ", 4);
2542 opt_request = REQ_VIEW_PAGER;
2544 report("Prompt interrupted by loading view, "
2545 "press 'z' to stop loading views");
2546 request = REQ_SCREEN_UPDATE;
2553 case REQ_SCREEN_RESIZE:
2557 getmaxyx(stdscr, height, width);
2559 /* Resize the status view and let the view driver take
2560 * care of resizing the displayed views. */
2561 wresize(status_win, 1, width);
2562 mvwin(status_win, height - 1, 0);
2563 wrefresh(status_win);
2578 * Revision specification
2579 * ----------------------
2580 * This section describes various ways to specify what revisions to display
2581 * or otherwise limit the view to. tig(1) does not itself parse the described
2582 * revision options so refer to the relevant git man pages for futher
2583 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2586 * You can tune the interaction with git by making use of the options
2587 * explained in this section. For example, by configuring the environment
2588 * variables described in the <<history-commands, "History commands">>
2591 * Limit by path name
2592 * ~~~~~~~~~~~~~~~~~~
2593 * If you are interested only in those revisions that made changes to a
2594 * specific file (or even several files) list the files like this:
2596 * $ tig log Makefile README
2598 * To avoid ambiguity with repository references such as tag name, be sure
2599 * to separate file names from other git options using "\--". So if you
2600 * have a file named 'master' it will clash with the reference named
2601 * 'master', and thus you will have to use:
2603 * $ tig log -- master
2605 * NOTE: For the main view, avoiding ambiguity will in some cases require
2606 * you to specify two "\--" options. The first will make tig(1) stop
2607 * option processing and the latter will be passed to git log.
2609 * Limit by date or number
2610 * ~~~~~~~~~~~~~~~~~~~~~~~
2611 * To speed up interaction with git, you can limit the amount of commits
2612 * to show both for the log and main view. Either limit by date using
2613 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2615 * If you are only interested in changed that happened between two dates
2618 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2620 * NOTE: If you want to avoid having to quote dates containing spaces you
2621 * can use "." instead, e.g. `--after=May.5th`.
2623 * Limiting by commit ranges
2624 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2625 * Alternatively, commits can be limited to a specific range, such as
2626 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2628 * $ tig log tag-1.0..tag-2.0
2630 * This way of commit limiting makes it trivial to only browse the commits
2631 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2632 * upstream remote branch, using:
2634 * $ tig log origin..HEAD
2636 * will list what will be pushed to the remote branch. Optionally, the ending
2637 * 'HEAD' can be left out since it is implied.
2639 * Limiting by reachability
2640 * ~~~~~~~~~~~~~~~~~~~~~~~~
2641 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2642 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2643 * Where reachability refers to what commits are ancestors (or part of the
2644 * history) of the branch or tagged revision in question.
2646 * If you prefer to specify which commit to preview in this way use the
2649 * $ tig log tag-2.0 ^tag-1.0
2651 * You can think of '^' as a negation operator. Using this alternate syntax,
2652 * it is possible to further prune commits by specifying multiple branch
2655 * Combining revisions specification
2656 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2657 * Revisions options can to some degree be combined, which makes it possible
2658 * to say "show at most 20 commits from within the last month that changed
2659 * files under the Documentation/ directory."
2661 * $ tig -- --since=1.month -n20 -- Documentation/
2663 * Examining all repository references
2664 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2665 * In some cases, it can be useful to query changes across all references
2666 * in a repository. An example is to ask "did any line of development in
2667 * this repository change a particular file within the last week". This
2668 * can be accomplished using:
2670 * $ tig -- --all --since=1.week -- Makefile
2674 * Known bugs and problems:
2676 * - In it's current state tig is pretty much UTF-8 only.
2678 * - If the screen width is very small the main view can draw
2679 * outside the current view causing bad wrapping. Same goes
2680 * for title and status windows.
2682 * - The cursor can wrap-around on the last line and cause the
2685 * - The prompt doesn't work while loading.
2689 * Features that should be explored.
2697 * Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2699 * This program is free software; you can redistribute it and/or modify
2700 * it under the terms of the GNU General Public License as published by
2701 * the Free Software Foundation; either version 2 of the License, or
2702 * (at your option) any later version.
2706 * - link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2707 * - link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2709 * Other git repository browsers: