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. Additionally, tig(1) can also act
24 * as a pager for output of various git commands.
26 * When browsing repositories, tig(1) uses the underlying git commands
27 * to present the user with various views, such as summarized commit log
28 * and showing the commit with the log message, diffstat, and the diff.
30 * Using tig(1) as a pager, it will display input from stdin and try
35 #define VERSION "tig-0.3"
55 static void die(const char *err, ...);
56 static void report(const char *msg, ...);
57 static void set_nonblocking_input(bool loading);
58 static size_t utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed);
60 #define ABS(x) ((x) >= 0 ? (x) : -(x))
61 #define MIN(x, y) ((x) < (y) ? (x) : (y))
63 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
64 #define STRING_SIZE(x) (sizeof(x) - 1)
66 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
67 #define SIZEOF_CMD 1024 /* Size of command buffer. */
69 /* This color name can be used to refer to the default term colors. */
70 #define COLOR_DEFAULT (-1)
72 #define TIG_HELP "(d)iff, (l)og, (m)ain, (q)uit, (h)elp"
74 /* The format and size of the date column in the main view. */
75 #define DATE_FORMAT "%Y-%m-%d %H:%M"
76 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
78 #define AUTHOR_COLS 20
80 /* The default interval between line numbers. */
81 #define NUMBER_INTERVAL 1
85 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
87 /* Some ascii-shorthands fitted into the ncurses namespace. */
89 #define KEY_RETURN '\r'
93 /* User action requests. */
95 /* Offset all requests to avoid conflicts with ncurses getch values. */
96 REQ_OFFSET = KEY_MAX + 1,
98 /* XXX: Keep the view request first and in sync with views[]. */
113 REQ_TOGGLE_LINE_NUMBERS,
127 REQ_SCROLL_LINE_DOWN,
129 REQ_SCROLL_PAGE_DOWN,
133 char *name; /* Ref name; tag or head names are shortened. */
134 char id[41]; /* Commit SHA1 ID */
135 unsigned int tag:1; /* Is it a tag? */
136 unsigned int next:1; /* For ref lists: are there more refs? */
140 char id[41]; /* SHA1 ID. */
141 char title[75]; /* The first line of the commit message. */
142 char author[75]; /* The author of the commit. */
143 struct tm time; /* Date from the author ident. */
144 struct ref **refs; /* Repository references; tags & branch heads. */
153 string_ncopy(char *dst, const char *src, int dstlen)
155 strncpy(dst, src, dstlen - 1);
160 /* Shorthand for safely copying into a fixed buffer. */
161 #define string_copy(dst, src) \
162 string_ncopy(dst, src, sizeof(dst))
167 * NOTE: The following is a slightly modified copy of the git project's shell
168 * quoting routines found in the quote.c file.
170 * Help to copy the thing properly quoted for the shell safety. any single
171 * quote is replaced with '\'', any exclamation point is replaced with '\!',
172 * and the whole thing is enclosed in a
175 * original sq_quote result
176 * name ==> name ==> 'name'
177 * a b ==> a b ==> 'a b'
178 * a'b ==> a'\''b ==> 'a'\''b'
179 * a!b ==> a'\!'b ==> 'a'\!'b'
183 sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
187 #define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0)
190 while ((c = *src++)) {
191 if (c == '\'' || c == '!') {
211 static const char usage[] =
212 VERSION " (" __DATE__ ")\n"
214 "Usage: tig [options]\n"
215 " or: tig [options] [--] [git log options]\n"
216 " or: tig [options] log [git log options]\n"
217 " or: tig [options] diff [git diff options]\n"
218 " or: tig [options] show [git show options]\n"
219 " or: tig [options] < [git command output]\n"
222 " -l Start up in log view\n"
223 " -d Start up in diff view\n"
224 " -n[I], --line-number[=I] Show line numbers with given interval\n"
225 " -t[N], --tab-size[=N] Set number of spaces for tab expansion\n"
226 " -- Mark end of tig options\n"
227 " -v, --version Show version and exit\n"
228 " -h, --help Show help message and exit\n";
230 /* Option and state variables. */
231 static bool opt_line_number = FALSE;
232 static int opt_num_interval = NUMBER_INTERVAL;
233 static int opt_tab_size = TABSIZE;
234 static enum request opt_request = REQ_VIEW_MAIN;
235 static char opt_cmd[SIZEOF_CMD] = "";
236 static FILE *opt_pipe = NULL;
238 /* Returns the index of log or diff command or -1 to exit. */
240 parse_options(int argc, char *argv[])
244 for (i = 1; i < argc; i++) {
249 * Start up in log view using the internal log command.
251 if (!strcmp(opt, "-l")) {
252 opt_request = REQ_VIEW_LOG;
258 * Start up in diff view using the internal diff command.
260 if (!strcmp(opt, "-d")) {
261 opt_request = REQ_VIEW_DIFF;
266 * -n[INTERVAL], --line-number[=INTERVAL]::
267 * Prefix line numbers in log and diff view.
268 * Optionally, with interval different than each line.
270 if (!strncmp(opt, "-n", 2) ||
271 !strncmp(opt, "--line-number", 13)) {
277 } else if (opt[STRING_SIZE("--line-number")] == '=') {
278 num = opt + STRING_SIZE("--line-number=");
282 opt_num_interval = atoi(num);
284 opt_line_number = TRUE;
289 * -t[NSPACES], --tab-size[=NSPACES]::
290 * Set the number of spaces tabs should be expanded to.
292 if (!strncmp(opt, "-t", 2) ||
293 !strncmp(opt, "--tab-size", 10)) {
299 } else if (opt[STRING_SIZE("--tab-size")] == '=') {
300 num = opt + STRING_SIZE("--tab-size=");
304 opt_tab_size = MIN(atoi(num), TABSIZE);
310 * Show version and exit.
312 if (!strcmp(opt, "-v") ||
313 !strcmp(opt, "--version")) {
314 printf("tig version %s\n", VERSION);
320 * Show help message and exit.
322 if (!strcmp(opt, "-h") ||
323 !strcmp(opt, "--help")) {
330 * End of tig(1) options. Useful when specifying command
331 * options for the main view. Example:
333 * $ tig -- --since=1.month
335 if (!strcmp(opt, "--")) {
341 * log [git log options]::
342 * Open log view using the given git log options.
344 * diff [git diff options]::
345 * Open diff view using the given git diff options.
347 * show [git show options]::
348 * Open diff view using the given git show options.
350 if (!strcmp(opt, "log") ||
351 !strcmp(opt, "diff") ||
352 !strcmp(opt, "show")) {
353 opt_request = opt[0] == 'l'
354 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
359 * [git log options]::
360 * tig(1) will stop the option parsing when the first
361 * command line parameter not starting with "-" is
362 * encountered. All options including this one will be
363 * passed to git log when loading the main view.
364 * This makes it possible to say:
366 * $ tig tag-1.0..HEAD
368 if (opt[0] && opt[0] != '-')
371 die("unknown command '%s'", opt);
374 if (!isatty(STDIN_FILENO)) {
378 * If stdin is a pipe, any log or diff options will be ignored and the
379 * pager view will be opened loading data from stdin. The pager mode
380 * can be used for colorizing output from various git commands.
382 * Example on how to colorize the output of git-show(1):
386 opt_request = REQ_VIEW_PAGER;
389 } else if (i < argc) {
393 * Git command options
394 * ~~~~~~~~~~~~~~~~~~~
395 * All git command options specified on the command line will
396 * be passed to the given command and all will be shell quoted
397 * before they are passed to the shell.
399 * NOTE: If you specify options for the main view, you should
400 * not use the `--pretty` option as this option will be set
401 * automatically to the format expected by the main view.
403 * Example on how to open the log view and show both author and
404 * committer information:
406 * $ tig log --pretty=fuller
408 * See the <<refspec, "Specifying revisions">> section below
409 * for an introduction to revision options supported by the git
410 * commands. For details on specific git command options, refer
411 * to the man page of the command in question.
414 if (opt_request == REQ_VIEW_MAIN)
415 /* XXX: This is vulnerable to the user overriding
416 * options required for the main view parser. */
417 string_copy(opt_cmd, "git log --stat --pretty=raw");
419 string_copy(opt_cmd, "git");
420 buf_size = strlen(opt_cmd);
422 while (buf_size < sizeof(opt_cmd) && i < argc) {
423 opt_cmd[buf_size++] = ' ';
424 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
427 if (buf_size >= sizeof(opt_cmd))
428 die("command too long");
430 opt_cmd[buf_size] = 0;
439 * Line-oriented content detection.
443 /* Line type String to match Foreground Background Attributes
444 * --------- --------------- ---------- ---------- ---------- */ \
446 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
447 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
448 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
449 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
450 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
451 LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
452 LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
453 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
454 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
455 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
456 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
457 /* Pretty print commit header */ \
458 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
459 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
460 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
461 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
462 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
463 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
464 /* Raw commit header */ \
465 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
466 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
467 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
468 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
469 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
471 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
472 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
474 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
475 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
476 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
477 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
478 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
479 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
480 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
481 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
482 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
483 LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
484 LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
487 #define LINE(type, line, fg, bg, attr) \
494 const char *line; /* The start of line to match. */
495 int linelen; /* Size of string to match. */
496 int fg, bg, attr; /* Color and text attributes for the lines. */
499 static struct line_info line_info[] = {
500 #define LINE(type, line, fg, bg, attr) \
501 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
506 static enum line_type
507 get_line_type(char *line)
509 int linelen = strlen(line);
512 for (type = 0; type < ARRAY_SIZE(line_info); type++)
513 /* Case insensitive search matches Signed-off-by lines better. */
514 if (linelen >= line_info[type].linelen &&
515 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
522 get_line_attr(enum line_type type)
524 assert(type < ARRAY_SIZE(line_info));
525 return COLOR_PAIR(type) | line_info[type].attr;
531 int default_bg = COLOR_BLACK;
532 int default_fg = COLOR_WHITE;
537 if (use_default_colors() != ERR) {
542 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
543 struct line_info *info = &line_info[type];
544 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
545 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
547 init_pair(type, fg, bg);
553 * ENVIRONMENT VARIABLES
554 * ---------------------
555 * Several options related to the interface with git can be configured
556 * via environment options.
558 * Repository references
559 * ~~~~~~~~~~~~~~~~~~~~~
560 * Commits that are referenced by tags and branch heads will be marked
561 * by the reference name surrounded by '[' and ']':
563 * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
565 * If you want to filter out certain directories under `.git/refs/`, say
566 * `tmp` you can do it by setting the following variable:
568 * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
570 * Or set the variable permanently in your environment.
573 * Set command for retrieving all repository references. The command
574 * should output data in the same format as git-ls-remote(1).
577 #define TIG_LS_REMOTE \
578 "git ls-remote . 2>/dev/null"
584 * It is possible to alter which commands are used for the different views.
585 * If for example you prefer commits in the main view to be sorted by date
586 * and only show 500 commits, use:
588 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
590 * Or set the variable permanently in your environment.
592 * Notice, how `%s` is used to specify the commit reference. There can
593 * be a maximum of 5 `%s` ref specifications.
596 * The command used for the diff view. By default, git show is used
600 * The command used for the log view. If you prefer to have both
601 * author and committer shown in the log view be sure to pass
602 * `--pretty=fuller` to git log.
605 * The command used for the main view. Note, you must always specify
606 * the option: `--pretty=raw` since the main view parser expects to
610 #define TIG_DIFF_CMD \
611 "git show --patch-with-stat --find-copies-harder -B -C %s"
613 #define TIG_LOG_CMD \
614 "git log --cc --stat -n100 %s"
616 #define TIG_MAIN_CMD \
617 "git log --topo-order --stat --pretty=raw %s"
619 /* ... silently ignore that the following are also exported. */
621 #define TIG_HELP_CMD \
622 "man tig 2>/dev/null"
624 #define TIG_PAGER_CMD \
631 * The display consists of a status window on the last line of the screen and
632 * one or more views. The default is to only show one view at the time but it
633 * is possible to split both the main and log view to also show the commit
636 * If you are in the log view and press 'Enter' when the current line is a
637 * commit line, such as:
639 * commit 4d55caff4cc89335192f3e566004b4ceef572521
641 * You will split the view so that the log view is displayed in the top window
642 * and the diff view in the bottom window. You can switch between the two
643 * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
648 /* The display array of active views and the index of the current view. */
649 static struct view *display[2];
650 static unsigned int current_view;
652 #define foreach_view(view, i) \
653 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
657 * Current head and commit ID
658 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
659 * The viewer keeps track of both what head and commit ID you are currently
660 * viewing. The commit ID will follow the cursor line and change everytime time
661 * you highlight a different commit. Whenever you reopen the diff view it
662 * will be reloaded, if the commit ID changed.
664 * The head ID is used when opening the main and log view to indicate from
665 * what revision to show history.
668 static char ref_commit[SIZEOF_REF] = "HEAD";
669 static char ref_head[SIZEOF_REF] = "HEAD";
673 const char *name; /* View name */
674 const char *cmd_fmt; /* Default command line format */
675 const char *cmd_env; /* Command line set via environment */
676 const char *id; /* Points to either of ref_{head,commit} */
679 /* What type of content being displayed. Used in the
682 /* Draw one line; @lineno must be < view->height. */
683 bool (*draw)(struct view *view, unsigned int lineno);
684 /* Read one line; updates view->line. */
685 bool (*read)(struct view *view, char *line);
686 /* Depending on view, change display based on current line. */
687 bool (*enter)(struct view *view);
690 char cmd[SIZEOF_CMD]; /* Command buffer */
691 char ref[SIZEOF_REF]; /* Hovered commit reference */
692 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
694 int height, width; /* The width and height of the main window */
695 WINDOW *win; /* The main window */
696 WINDOW *title; /* The title window living below the main window */
699 unsigned long offset; /* Offset of the window top */
700 unsigned long lineno; /* Current line number */
703 unsigned long lines; /* Total number of lines */
704 void **line; /* Line index; each line contains user data */
705 unsigned int digits; /* Number of digits in the lines member. */
712 static struct view_ops pager_ops;
713 static struct view_ops main_ops;
715 #define VIEW_STR(name, cmd, env, ref, ops) \
716 { name, cmd, #env, ref, ops }
718 #define VIEW_(id, name, ops, ref) \
719 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops)
724 * tig(1) presents various 'views' of a repository. Each view is based on output
725 * from an external command, most often 'git log', 'git diff', or 'git show'.
728 * Is the default view, and it shows a one line summary of each commit
729 * in the chosen list of revisions. The summary includes commit date,
730 * author, and the first line of the log message. Additionally, any
731 * repository references, such as tags, will be shown.
734 * Presents a more rich view of the revision log showing the whole log
735 * message and the diffstat.
738 * Shows either the diff of the current working tree, that is, what
739 * has changed since the last commit, or the commit diff complete
740 * with log message, diffstat and diff.
743 * Is used for displaying both input from stdin and output from git
744 * commands entered in the internal prompt.
747 * Displays the information from the tig(1) man page. For the help view
748 * to work you need to have the tig(1) man page installed.
751 static struct view views[] = {
752 VIEW_(MAIN, "main", &main_ops, ref_head),
753 VIEW_(DIFF, "diff", &pager_ops, ref_commit),
754 VIEW_(LOG, "log", &pager_ops, ref_head),
755 VIEW_(HELP, "help", &pager_ops, "static"),
756 VIEW_(PAGER, "pager", &pager_ops, "static"),
759 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
763 redraw_view_from(struct view *view, int lineno)
765 assert(0 <= lineno && lineno < view->height);
767 for (; lineno < view->height; lineno++) {
768 if (!view->ops->draw(view, lineno))
772 redrawwin(view->win);
777 redraw_view(struct view *view)
780 redraw_view_from(view, 0);
787 * Each view has a title window which shows the name of the view, current
788 * commit ID if available, and where the view is positioned:
790 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
792 * By default, the title of the current view is highlighted using bold font.
796 update_view_title(struct view *view)
798 if (view == display[current_view])
799 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
801 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
804 wmove(view->title, 0, 0);
807 wprintw(view->title, "[%s] %s", view->name, view->ref);
809 wprintw(view->title, "[%s]", view->name);
812 wprintw(view->title, " - %s %d of %d (%d%%)",
816 (view->lineno + 1) * 100 / view->lines);
819 wrefresh(view->title);
826 struct view *base = display[0];
827 struct view *view = display[1] ? display[1] : display[0];
829 /* Setup window dimensions */
831 getmaxyx(stdscr, base->height, base->width);
833 /* Make room for the status window. */
837 /* Horizontal split. */
838 view->width = base->width;
839 view->height = SCALE_SPLIT_VIEW(base->height);
840 base->height -= view->height;
842 /* Make room for the title bar. */
846 /* Make room for the title bar. */
851 foreach_view (view, i) {
852 /* Keep the height of all view->win windows one larger than is
853 * required so that the cursor can wrap-around on the last line
854 * without scrolling the window. */
856 view->win = newwin(view->height + 1, 0, offset, 0);
858 die("Failed to create %s view", view->name);
860 scrollok(view->win, TRUE);
862 view->title = newwin(1, 0, offset + view->height, 0);
864 die("Failed to create title window");
867 wresize(view->win, view->height + 1, view->width);
868 mvwin(view->win, offset, 0);
869 mvwin(view->title, offset + view->height, 0);
873 offset += view->height + 1;
883 foreach_view (view, i) {
885 update_view_title(view);
894 /* Scrolling backend */
896 do_scroll_view(struct view *view, int lines)
898 /* The rendering expects the new offset. */
899 view->offset += lines;
901 assert(0 <= view->offset && view->offset < view->lines);
904 /* Redraw the whole screen if scrolling is pointless. */
905 if (view->height < ABS(lines)) {
909 int line = lines > 0 ? view->height - lines : 0;
910 int end = line + ABS(lines);
912 wscrl(view->win, lines);
914 for (; line < end; line++) {
915 if (!view->ops->draw(view, line))
920 /* Move current line into the view. */
921 if (view->lineno < view->offset) {
922 view->lineno = view->offset;
923 view->ops->draw(view, 0);
925 } else if (view->lineno >= view->offset + view->height) {
926 if (view->lineno == view->offset + view->height) {
927 /* Clear the hidden line so it doesn't show if the view
929 wmove(view->win, view->height, 0);
930 wclrtoeol(view->win);
932 view->lineno = view->offset + view->height - 1;
933 view->ops->draw(view, view->lineno - view->offset);
936 assert(view->offset <= view->lineno && view->lineno < view->lines);
938 redrawwin(view->win);
943 /* Scroll frontend */
945 scroll_view(struct view *view, enum request request)
950 case REQ_SCROLL_PAGE_DOWN:
951 lines = view->height;
952 case REQ_SCROLL_LINE_DOWN:
953 if (view->offset + lines > view->lines)
954 lines = view->lines - view->offset;
956 if (lines == 0 || view->offset + view->height >= view->lines) {
957 report("Cannot scroll beyond the last line");
962 case REQ_SCROLL_PAGE_UP:
963 lines = view->height;
964 case REQ_SCROLL_LINE_UP:
965 if (lines > view->offset)
966 lines = view->offset;
969 report("Cannot scroll beyond the first line");
977 die("request %d not handled in switch", request);
980 do_scroll_view(view, lines);
985 move_view(struct view *view, enum request request)
990 case REQ_MOVE_FIRST_LINE:
991 steps = -view->lineno;
994 case REQ_MOVE_LAST_LINE:
995 steps = view->lines - view->lineno - 1;
998 case REQ_MOVE_PAGE_UP:
999 steps = view->height > view->lineno
1000 ? -view->lineno : -view->height;
1003 case REQ_MOVE_PAGE_DOWN:
1004 steps = view->lineno + view->height >= view->lines
1005 ? view->lines - view->lineno - 1 : view->height;
1009 case REQ_MOVE_UP_ENTER:
1014 case REQ_MOVE_DOWN_ENTER:
1019 die("request %d not handled in switch", request);
1022 if (steps <= 0 && view->lineno == 0) {
1023 report("Cannot move beyond the first line");
1026 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1027 report("Cannot move beyond the last line");
1031 /* Move the current line */
1032 view->lineno += steps;
1033 assert(0 <= view->lineno && view->lineno < view->lines);
1035 /* Repaint the old "current" line if we be scrolling */
1036 if (ABS(steps) < view->height) {
1037 int prev_lineno = view->lineno - steps - view->offset;
1039 wmove(view->win, prev_lineno, 0);
1040 wclrtoeol(view->win);
1041 view->ops->draw(view, prev_lineno);
1044 /* Check whether the view needs to be scrolled */
1045 if (view->lineno < view->offset ||
1046 view->lineno >= view->offset + view->height) {
1047 if (steps < 0 && -steps > view->offset) {
1048 steps = -view->offset;
1050 } else if (steps > 0) {
1051 if (view->lineno == view->lines - 1 &&
1052 view->lines > view->height) {
1053 steps = view->lines - view->offset - 1;
1054 if (steps >= view->height)
1055 steps -= view->height - 1;
1059 do_scroll_view(view, steps);
1063 /* Draw the current line */
1064 view->ops->draw(view, view->lineno - view->offset);
1066 redrawwin(view->win);
1067 wrefresh(view->win);
1073 * Incremental updating
1077 begin_update(struct view *view)
1079 const char *id = view->id;
1082 string_copy(view->cmd, opt_cmd);
1084 /* When running random commands, the view ref could have become
1085 * invalid so clear it. */
1088 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1090 if (snprintf(view->cmd, sizeof(view->cmd), format,
1091 id, id, id, id, id) >= sizeof(view->cmd))
1095 /* Special case for the pager view. */
1097 view->pipe = opt_pipe;
1100 view->pipe = popen(view->cmd, "r");
1106 set_nonblocking_input(TRUE);
1111 string_copy(view->vid, id);
1116 for (i = 0; i < view->lines; i++)
1118 free(view->line[i]);
1124 view->start_time = time(NULL);
1130 end_update(struct view *view)
1134 set_nonblocking_input(FALSE);
1135 if (view->pipe == stdin)
1143 update_view(struct view *view)
1145 char buffer[BUFSIZ];
1148 /* The number of lines to read. If too low it will cause too much
1149 * redrawing (and possible flickering), if too high responsiveness
1151 unsigned long lines = view->height;
1152 int redraw_from = -1;
1157 /* Only redraw if lines are visible. */
1158 if (view->offset + view->height >= view->lines)
1159 redraw_from = view->lines - view->offset;
1161 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1167 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1168 int linelen = strlen(line);
1171 line[linelen - 1] = 0;
1173 if (!view->ops->read(view, line))
1183 lines = view->lines;
1184 for (digits = 0; lines; digits++)
1187 /* Keep the displayed view in sync with line number scaling. */
1188 if (digits != view->digits) {
1189 view->digits = digits;
1194 if (redraw_from >= 0) {
1195 /* If this is an incremental update, redraw the previous line
1196 * since for commits some members could have changed when
1197 * loading the main view. */
1198 if (redraw_from > 0)
1201 /* Incrementally draw avoids flickering. */
1202 redraw_view_from(view, redraw_from);
1205 /* Update the title _after_ the redraw so that if the redraw picks up a
1206 * commit reference in view->ref it'll be available here. */
1207 update_view_title(view);
1209 if (ferror(view->pipe)) {
1210 report("Failed to read: %s", strerror(errno));
1213 } else if (feof(view->pipe)) {
1214 time_t secs = time(NULL) - view->start_time;
1216 if (view == VIEW(REQ_VIEW_HELP)) {
1217 const char *msg = TIG_HELP;
1219 if (view->lines == 0) {
1220 /* Slightly ugly, but abusing view->ref keeps
1221 * the error message. */
1222 string_copy(view->ref, "No help available");
1223 msg = "The tig(1) manpage is not installed";
1230 report("Loaded %d lines in %ld second%s", view->lines, secs,
1231 secs == 1 ? "" : "s");
1238 report("Allocation failure");
1246 OPEN_DEFAULT = 0, /* Use default view switching. */
1247 OPEN_SPLIT = 1, /* Split current view. */
1248 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1249 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1253 open_view(struct view *prev, enum request request, enum open_flags flags)
1255 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1256 bool split = !!(flags & OPEN_SPLIT);
1257 bool reload = !!(flags & OPEN_RELOAD);
1258 struct view *view = VIEW(request);
1259 struct view *displayed;
1262 /* Cycle between displayed views and count the views. */
1263 foreach_view (displayed, nviews) {
1265 view == displayed &&
1266 !strcmp(view->vid, prev->vid)) {
1267 current_view = nviews;
1268 /* Blur out the title of the previous view. */
1269 update_view_title(prev);
1275 if (view == prev && nviews == 1 && !reload) {
1276 report("Already in %s view", view->name);
1280 if ((reload || strcmp(view->vid, view->id)) &&
1281 !begin_update(view)) {
1282 report("Failed to load %s view", view->name);
1287 display[current_view + 1] = view;
1291 /* Maximize the current view. */
1292 memset(display, 0, sizeof(display));
1294 display[current_view] = view;
1299 if (split && prev->lineno - prev->offset >= prev->height) {
1300 /* Take the title line into account. */
1301 int lines = prev->lineno - prev->offset - prev->height + 1;
1303 /* Scroll the view that was split if the current line is
1304 * outside the new limited view. */
1305 do_scroll_view(prev, lines);
1308 if (prev && view != prev) {
1309 /* "Blur" the previous view. */
1311 update_view_title(prev);
1313 /* Continue loading split views in the background. */
1319 /* Clear the old view and let the incremental updating refill
1322 report("Loading...");
1325 if (view == VIEW(REQ_VIEW_HELP))
1326 report("%s", TIG_HELP);
1331 /* If the view is backgrounded the above calls to report()
1332 * won't redraw the view title. */
1334 update_view_title(view);
1339 * User request switch noodle
1343 view_driver(struct view *view, enum request request)
1350 case REQ_MOVE_PAGE_UP:
1351 case REQ_MOVE_PAGE_DOWN:
1352 case REQ_MOVE_FIRST_LINE:
1353 case REQ_MOVE_LAST_LINE:
1354 move_view(view, request);
1357 case REQ_SCROLL_LINE_DOWN:
1358 case REQ_SCROLL_LINE_UP:
1359 case REQ_SCROLL_PAGE_DOWN:
1360 case REQ_SCROLL_PAGE_UP:
1361 scroll_view(view, request);
1368 case REQ_VIEW_PAGER:
1369 open_view(view, request, OPEN_DEFAULT);
1372 case REQ_MOVE_UP_ENTER:
1373 case REQ_MOVE_DOWN_ENTER:
1374 move_view(view, request);
1379 report("Nothing to enter");
1382 return view->ops->enter(view);
1386 int nviews = display[1] ? 2 : 1;
1387 int next_view = (current_view + 1) % nviews;
1389 if (next_view == current_view) {
1390 report("Only one view is displayed");
1394 current_view = next_view;
1395 /* Blur out the title of the previous view. */
1396 update_view_title(view);
1400 case REQ_TOGGLE_LINE_NUMBERS:
1401 opt_line_number = !opt_line_number;
1406 /* Always reload^Wrerun commands from the prompt. */
1407 open_view(view, opt_request, OPEN_RELOAD);
1410 case REQ_STOP_LOADING:
1411 foreach_view (view, i) {
1413 report("Stopped loaded the %s view", view->name),
1418 case REQ_SHOW_VERSION:
1419 report("%s (built %s)", VERSION, __DATE__);
1422 case REQ_SCREEN_RESIZE:
1425 case REQ_SCREEN_REDRAW:
1429 case REQ_SCREEN_UPDATE:
1433 case REQ_VIEW_CLOSE:
1435 view = display[(current_view + 1) % ARRAY_SIZE(display)];
1436 memset(display, 0, sizeof(display));
1438 display[current_view] = view;
1448 /* An unknown key will show most commonly used commands. */
1449 report("Unknown key, press 'h' for help");
1458 * View backend handlers
1462 pager_draw(struct view *view, unsigned int lineno)
1464 enum line_type type;
1469 if (view->offset + lineno >= view->lines)
1472 line = view->line[view->offset + lineno];
1473 type = get_line_type(line);
1475 wmove(view->win, lineno, 0);
1477 if (view->offset + lineno == view->lineno) {
1478 if (type == LINE_COMMIT) {
1479 string_copy(view->ref, line + 7);
1480 string_copy(ref_commit, view->ref);
1484 wchgat(view->win, -1, 0, type, NULL);
1487 attr = get_line_attr(type);
1488 wattrset(view->win, attr);
1490 linelen = strlen(line);
1492 if (opt_line_number || opt_tab_size < TABSIZE) {
1493 static char spaces[] = " ";
1494 int col_offset = 0, col = 0;
1496 if (opt_line_number) {
1497 unsigned long real_lineno = view->offset + lineno + 1;
1499 if (real_lineno == 1 ||
1500 (real_lineno % opt_num_interval) == 0) {
1501 wprintw(view->win, "%.*d", view->digits, real_lineno);
1504 waddnstr(view->win, spaces,
1505 MIN(view->digits, STRING_SIZE(spaces)));
1507 waddstr(view->win, ": ");
1508 col_offset = view->digits + 2;
1511 while (line && col_offset + col < view->width) {
1512 int cols_max = view->width - col_offset - col;
1516 if (*line == '\t') {
1517 assert(sizeof(spaces) > TABSIZE);
1520 cols = opt_tab_size - (col % opt_tab_size);
1523 line = strchr(line, '\t');
1524 cols = line ? line - text : strlen(text);
1527 waddnstr(view->win, text, MIN(cols, cols_max));
1532 int col = 0, pos = 0;
1534 for (; pos < linelen && col < view->width; pos++, col++)
1535 if (line[pos] == '\t')
1536 col += TABSIZE - (col % TABSIZE) - 1;
1538 waddnstr(view->win, line, pos);
1545 pager_read(struct view *view, char *line)
1547 /* Compress empty lines in the help view. */
1548 if (view == VIEW(REQ_VIEW_HELP) &&
1551 !*((char *) view->line[view->lines - 1]))
1554 view->line[view->lines] = strdup(line);
1555 if (!view->line[view->lines])
1563 pager_enter(struct view *view)
1565 char *line = view->line[view->lineno];
1568 if ((view == VIEW(REQ_VIEW_LOG) ||
1569 view == VIEW(REQ_VIEW_LOG)) &&
1570 get_line_type(line) == LINE_COMMIT) {
1571 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1575 /* Always scroll the view even if it was split. That way
1576 * you can use Enter to scroll through the log view and
1577 * split open each commit diff. */
1578 scroll_view(view, REQ_SCROLL_LINE_DOWN);
1580 /* FIXME: A minor workaround. Scrolling the view will call report("")
1581 * but if we are scolling a non-current view this won't properly update
1582 * the view title. */
1584 update_view_title(view);
1589 static struct view_ops pager_ops = {
1597 static struct ref **get_refs(char *id);
1600 main_draw(struct view *view, unsigned int lineno)
1602 char buf[DATE_COLS + 1];
1603 struct commit *commit;
1604 enum line_type type;
1610 if (view->offset + lineno >= view->lines)
1613 commit = view->line[view->offset + lineno];
1614 if (!*commit->author)
1617 wmove(view->win, lineno, col);
1619 if (view->offset + lineno == view->lineno) {
1620 string_copy(view->ref, commit->id);
1621 string_copy(ref_commit, view->ref);
1623 wattrset(view->win, get_line_attr(type));
1624 wchgat(view->win, -1, 0, type, NULL);
1627 type = LINE_MAIN_COMMIT;
1628 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1631 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1632 waddnstr(view->win, buf, timelen);
1633 waddstr(view->win, " ");
1636 wmove(view->win, lineno, col);
1637 if (type != LINE_CURSOR)
1638 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1640 /* FIXME: Make this optional, and add i18n.commitEncoding support. */
1641 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1644 waddnstr(view->win, commit->author, authorlen);
1645 if (type != LINE_CURSOR)
1646 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1647 waddch(view->win, '~');
1649 waddstr(view->win, commit->author);
1653 if (type != LINE_CURSOR)
1654 wattrset(view->win, A_NORMAL);
1656 mvwaddch(view->win, lineno, col, ACS_LTEE);
1657 wmove(view->win, lineno, col + 2);
1664 if (type == LINE_CURSOR)
1666 else if (commit->refs[i]->tag)
1667 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1669 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1670 waddstr(view->win, "[");
1671 waddstr(view->win, commit->refs[i]->name);
1672 waddstr(view->win, "]");
1673 if (type != LINE_CURSOR)
1674 wattrset(view->win, A_NORMAL);
1675 waddstr(view->win, " ");
1676 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1677 } while (commit->refs[i++]->next);
1680 if (type != LINE_CURSOR)
1681 wattrset(view->win, get_line_attr(type));
1684 int titlelen = strlen(commit->title);
1686 if (col + titlelen > view->width)
1687 titlelen = view->width - col;
1689 waddnstr(view->win, commit->title, titlelen);
1695 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1697 main_read(struct view *view, char *line)
1699 enum line_type type = get_line_type(line);
1700 struct commit *commit;
1704 commit = calloc(1, sizeof(struct commit));
1708 line += STRING_SIZE("commit ");
1710 view->line[view->lines++] = commit;
1711 string_copy(commit->id, line);
1712 commit->refs = get_refs(commit->id);
1717 char *ident = line + STRING_SIZE("author ");
1718 char *end = strchr(ident, '<');
1721 for (; end > ident && isspace(end[-1]); end--) ;
1725 commit = view->line[view->lines - 1];
1726 string_copy(commit->author, ident);
1728 /* Parse epoch and timezone */
1730 char *secs = strchr(end + 1, '>');
1734 if (!secs || secs[1] != ' ')
1738 time = (time_t) atol(secs);
1739 zone = strchr(secs, ' ');
1740 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1744 tz = ('0' - zone[1]) * 60 * 60 * 10;
1745 tz += ('0' - zone[2]) * 60 * 60;
1746 tz += ('0' - zone[3]) * 60;
1747 tz += ('0' - zone[4]) * 60;
1754 gmtime_r(&time, &commit->time);
1759 /* We should only ever end up here if there has already been a
1760 * commit line, however, be safe. */
1761 if (view->lines == 0)
1764 /* Fill in the commit title if it has not already been set. */
1765 commit = view->line[view->lines - 1];
1766 if (commit->title[0])
1769 /* Require titles to start with a non-space character at the
1770 * offset used by git log. */
1771 /* FIXME: More gracefull handling of titles; append "..." to
1772 * shortened titles, etc. */
1773 if (strncmp(line, " ", 4) ||
1777 string_copy(commit->title, line + 4);
1784 main_enter(struct view *view)
1786 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1790 static struct view_ops main_ops = {
1801 * Below the default key bindings are shown.
1809 static struct keymap keymap[] = {
1814 * Switch to main view.
1816 * Switch to diff view.
1818 * Switch to log view.
1820 * Switch to pager view.
1824 * Close view if multiple views are open, else quit.
1826 * This key is "context sensitive" depending on what view you are
1827 * currently in. When in log view on a commit line or in the main
1828 * view, split the view and show the commit diff. In the diff view
1829 * pressing Enter will simply scroll the view one line down.
1831 * Switch to next view.
1833 { 'm', REQ_VIEW_MAIN },
1834 { 'd', REQ_VIEW_DIFF },
1835 { 'l', REQ_VIEW_LOG },
1836 { 'p', REQ_VIEW_PAGER },
1837 { 'h', REQ_VIEW_HELP },
1839 { 'q', REQ_VIEW_CLOSE },
1840 { KEY_TAB, REQ_VIEW_NEXT },
1841 { KEY_RETURN, REQ_ENTER },
1847 * Move cursor one line up.
1849 * Move cursor one line down.
1851 * Move cursor one line up and enter. When used in the main view
1852 * this will always show the diff of the current commit in the
1855 * Move cursor one line down and enter.
1859 * Move cursor one page up.
1862 * Move cursor one page down.
1864 * Jump to first line.
1866 * Jump to last line.
1868 { KEY_UP, REQ_MOVE_UP },
1869 { KEY_DOWN, REQ_MOVE_DOWN },
1870 { 'k', REQ_MOVE_UP_ENTER },
1871 { 'j', REQ_MOVE_DOWN_ENTER },
1872 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1873 { KEY_END, REQ_MOVE_LAST_LINE },
1874 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1875 { ' ', REQ_MOVE_PAGE_DOWN },
1876 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1877 { 'b', REQ_MOVE_PAGE_UP },
1878 { '-', REQ_MOVE_PAGE_UP },
1884 * Scroll view one line up.
1886 * Scroll view one line down.
1888 * Scroll view one page up.
1890 * Scroll view one page down.
1892 { KEY_IC, REQ_SCROLL_LINE_UP },
1893 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1894 { 'w', REQ_SCROLL_PAGE_UP },
1895 { 's', REQ_SCROLL_PAGE_DOWN },
1905 * Stop all background loading. This can be useful if you use
1906 * tig(1) in a repository with a long history without limiting
1911 * Toggle line numbers on/off.
1913 * Open prompt. This allows you to specify what git command
1919 { 'z', REQ_STOP_LOADING },
1920 { 'v', REQ_SHOW_VERSION },
1921 { 'r', REQ_SCREEN_REDRAW },
1922 { 'n', REQ_TOGGLE_LINE_NUMBERS },
1923 { ':', REQ_PROMPT },
1925 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
1926 { ERR, REQ_SCREEN_UPDATE },
1928 /* Use the ncurses SIGWINCH handler. */
1929 { KEY_RESIZE, REQ_SCREEN_RESIZE },
1933 get_request(int key)
1937 for (i = 0; i < ARRAY_SIZE(keymap); i++)
1938 if (keymap[i].alias == key)
1939 return keymap[i].request;
1941 return (enum request) key;
1946 * Unicode / UTF-8 handling
1948 * NOTE: Much of the following code for dealing with unicode is derived from
1949 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
1950 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
1953 /* I've (over)annotated a lot of code snippets because I am not entirely
1954 * confident that the approach taken by this small UTF-8 interface is correct.
1958 unicode_width(unsigned long c)
1961 (c <= 0x115f /* Hangul Jamo */
1964 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
1966 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
1967 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
1968 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
1969 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
1970 || (c >= 0xffe0 && c <= 0xffe6)
1971 || (c >= 0x20000 && c <= 0x2fffd)
1972 || (c >= 0x30000 && c <= 0x3fffd)))
1978 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
1979 * Illegal bytes are set one. */
1980 static const unsigned char utf8_bytes[256] = {
1981 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,
1982 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,
1983 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,
1984 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,
1985 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,
1986 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,
1987 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,
1988 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,
1991 /* Decode UTF-8 multi-byte representation into a unicode character. */
1992 static inline unsigned long
1993 utf8_to_unicode(const char *string, size_t length)
1995 unsigned long unicode;
1999 unicode = string[0];
2002 unicode = (string[0] & 0x1f) << 6;
2003 unicode += (string[1] & 0x3f);
2006 unicode = (string[0] & 0x0f) << 12;
2007 unicode += ((string[1] & 0x3f) << 6);
2008 unicode += (string[2] & 0x3f);
2011 unicode = (string[0] & 0x0f) << 18;
2012 unicode += ((string[1] & 0x3f) << 12);
2013 unicode += ((string[2] & 0x3f) << 6);
2014 unicode += (string[3] & 0x3f);
2017 unicode = (string[0] & 0x0f) << 24;
2018 unicode += ((string[1] & 0x3f) << 18);
2019 unicode += ((string[2] & 0x3f) << 12);
2020 unicode += ((string[3] & 0x3f) << 6);
2021 unicode += (string[4] & 0x3f);
2024 unicode = (string[0] & 0x01) << 30;
2025 unicode += ((string[1] & 0x3f) << 24);
2026 unicode += ((string[2] & 0x3f) << 18);
2027 unicode += ((string[3] & 0x3f) << 12);
2028 unicode += ((string[4] & 0x3f) << 6);
2029 unicode += (string[5] & 0x3f);
2032 die("Invalid unicode length");
2035 /* Invalid characters could return the special 0xfffd value but NUL
2036 * should be just as good. */
2037 return unicode > 0xffff ? 0 : unicode;
2040 /* Calculates how much of string can be shown within the given maximum width
2041 * and sets trimmed parameter to non-zero value if all of string could not be
2044 * Additionally, adds to coloffset how many many columns to move to align with
2045 * the expected position. Takes into account how multi-byte and double-width
2046 * characters will effect the cursor position.
2048 * Returns the number of bytes to output from string to satisfy max_width. */
2050 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2052 const char *start = string;
2053 const char *end = strchr(string, '\0');
2059 while (string < end) {
2060 int c = *(unsigned char *) string;
2061 unsigned char bytes = utf8_bytes[c];
2063 unsigned long unicode;
2065 if (string + bytes > end)
2068 /* Change representation to figure out whether
2069 * it is a single- or double-width character. */
2071 unicode = utf8_to_unicode(string, bytes);
2072 /* FIXME: Graceful handling of invalid unicode character. */
2076 ucwidth = unicode_width(unicode);
2078 if (width > max_width) {
2083 /* The column offset collects the differences between the
2084 * number of bytes encoding a character and the number of
2085 * columns will be used for rendering said character.
2087 * So if some character A is encoded in 2 bytes, but will be
2088 * represented on the screen using only 1 byte this will and up
2089 * adding 1 to the multi-byte column offset.
2091 * Assumes that no double-width character can be encoding in
2092 * less than two bytes. */
2093 if (bytes > ucwidth)
2094 mbwidth += bytes - ucwidth;
2099 *coloffset += mbwidth;
2101 return string - start;
2109 /* Whether or not the curses interface has been initialized. */
2110 static bool cursed = FALSE;
2112 /* The status window is used for polling keystrokes. */
2113 static WINDOW *status_win;
2115 /* Update status and title window. */
2117 report(const char *msg, ...)
2119 static bool empty = TRUE;
2120 struct view *view = display[current_view];
2122 if (!empty || *msg) {
2125 va_start(args, msg);
2128 wmove(status_win, 0, 0);
2130 vwprintw(status_win, msg, args);
2135 wrefresh(status_win);
2140 update_view_title(view);
2142 /* Move the cursor to the right-most column of the cursor line.
2144 * XXX: This could turn out to be a bit expensive, but it ensures that
2145 * the cursor does not jump around. */
2147 wmove(view->win, view->lineno - view->offset, view->width - 1);
2148 wrefresh(view->win);
2152 /* Controls when nodelay should be in effect when polling user input. */
2154 set_nonblocking_input(bool loading)
2156 static unsigned int loading_views;
2158 if ((loading == FALSE && loading_views-- == 1) ||
2159 (loading == TRUE && loading_views++ == 0))
2160 nodelay(status_win, loading);
2168 /* Initialize the curses library */
2169 if (isatty(STDIN_FILENO)) {
2170 cursed = !!initscr();
2172 /* Leave stdin and stdout alone when acting as a pager. */
2173 FILE *io = fopen("/dev/tty", "r+");
2175 cursed = !!newterm(NULL, io, io);
2179 die("Failed to initialize curses");
2181 nonl(); /* Tell curses not to do NL->CR/NL on output */
2182 cbreak(); /* Take input chars one at a time, no wait for \n */
2183 noecho(); /* Don't echo input */
2184 leaveok(stdscr, TRUE);
2189 getmaxyx(stdscr, y, x);
2190 status_win = newwin(1, 0, y - 1, 0);
2192 die("Failed to create status window");
2194 /* Enable keyboard mapping */
2195 keypad(status_win, TRUE);
2196 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2201 * Repository references
2204 static struct ref *refs;
2205 static size_t refs_size;
2207 static struct ref **
2210 struct ref **id_refs = NULL;
2211 size_t id_refs_size = 0;
2214 for (i = 0; i < refs_size; i++) {
2217 if (strcmp(id, refs[i].id))
2220 tmp = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2228 if (id_refs_size > 0)
2229 id_refs[id_refs_size - 1]->next = 1;
2230 id_refs[id_refs_size] = &refs[i];
2232 /* XXX: The properties of the commit chains ensures that we can
2233 * safely modify the shared ref. The repo references will
2234 * always be similar for the same id. */
2235 id_refs[id_refs_size]->next = 0;
2245 const char *cmd_env = getenv("TIG_LS_REMOTE");
2246 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2247 FILE *pipe = popen(cmd, "r");
2248 char buffer[BUFSIZ];
2254 while ((line = fgets(buffer, sizeof(buffer), pipe))) {
2255 char *name = strchr(line, '\t');
2259 bool tag_commit = FALSE;
2265 namelen = strlen(name) - 1;
2267 /* Commits referenced by tags has "^{}" appended. */
2268 if (name[namelen - 1] == '}') {
2269 while (namelen > 0 && name[namelen] != '^')
2276 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2279 name += STRING_SIZE("refs/tags/");
2282 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2283 name += STRING_SIZE("refs/heads/");
2285 } else if (!strcmp(name, "HEAD")) {
2289 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2293 ref = &refs[refs_size++];
2295 ref->name = strdup(name);
2299 string_copy(ref->id, line);
2308 die("Not a git repository");
2318 #define __NORETURN __attribute__((__noreturn__))
2323 static void __NORETURN
2326 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2332 static void __NORETURN
2333 die(const char *err, ...)
2339 va_start(args, err);
2340 fputs("tig: ", stderr);
2341 vfprintf(stderr, err, args);
2342 fputs("\n", stderr);
2349 main(int argc, char *argv[])
2352 enum request request;
2355 signal(SIGINT, quit);
2357 if (!parse_options(argc, argv))
2360 if (load_refs() == ERR)
2361 die("Failed to load refs.");
2363 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2364 view->cmd_env = getenv(view->cmd_env);
2366 request = opt_request;
2370 while (view_driver(display[current_view], request)) {
2374 foreach_view (view, i)
2377 /* Refresh, accept single keystroke of input */
2378 key = wgetch(status_win);
2379 request = get_request(key);
2381 /* Some low-level request handling. This keeps access to
2382 * status_win restricted. */
2386 /* Temporarily switch to line-oriented and echoed
2391 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2392 memcpy(opt_cmd, "git ", 4);
2393 opt_request = REQ_VIEW_PAGER;
2402 case REQ_SCREEN_RESIZE:
2406 getmaxyx(stdscr, height, width);
2408 /* Resize the status view and let the view driver take
2409 * care of resizing the displayed views. */
2410 wresize(status_win, 1, width);
2411 mvwin(status_win, height - 1, 0);
2412 wrefresh(status_win);
2427 * Revision specification
2428 * ----------------------
2429 * This section describes various ways to specify what revisions to display
2430 * or otherwise limit the view to. tig(1) does not itself parse the described
2431 * revision options so refer to the relevant git man pages for futher
2432 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2435 * You can tune the interaction with git by making use of the options
2436 * explained in this section. For example, by configuring the environment
2437 * variables described in the <<view-commands, "View commands">> section.
2439 * Limit by path name
2440 * ~~~~~~~~~~~~~~~~~~
2441 * If you are interested only in those revisions that made changes to a
2442 * specific file (or even several files) list the files like this:
2444 * $ tig log Makefile README
2446 * To avoid ambiguity with repository references such as tag name, be sure
2447 * to separate file names from other git options using "\--". So if you
2448 * have a file named 'master' it will clash with the reference named
2449 * 'master', and thus you will have to use:
2451 * $ tig log -- master
2453 * NOTE: For the main view, avoiding ambiguity will in some cases require
2454 * you to specify two "\--" options. The first will make tig(1) stop
2455 * option processing and the latter will be passed to git log.
2457 * Limit by date or number
2458 * ~~~~~~~~~~~~~~~~~~~~~~~
2459 * To speed up interaction with git, you can limit the amount of commits
2460 * to show both for the log and main view. Either limit by date using
2461 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2463 * If you are only interested in changed that happened between two dates
2466 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2468 * NOTE: If you want to avoid having to quote dates containing spaces you
2469 * can use "." instead, e.g. `--after=May.5th`.
2471 * Limiting by commit ranges
2472 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2473 * Alternatively, commits can be limited to a specific range, such as
2474 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2476 * $ tig log tag-1.0..tag-2.0
2478 * This way of commit limiting makes it trivial to only browse the commits
2479 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2480 * upstream remote branch, using:
2482 * $ tig log origin..HEAD
2484 * will list what will be pushed to the remote branch. Optionally, the ending
2485 * 'HEAD' can be left out since it is implied.
2487 * Limiting by reachability
2488 * ~~~~~~~~~~~~~~~~~~~~~~~~
2489 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2490 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2491 * Where reachability refers to what commits are ancestors (or part of the
2492 * history) of the branch or tagged revision in question.
2494 * If you prefer to specify which commit to preview in this way use the
2497 * $ tig log tag-2.0 ^tag-1.0
2499 * You can think of '^' as a negation operator. Using this alternate syntax,
2500 * it is possible to further prune commits by specifying multiple branch
2503 * Combining revisions specification
2504 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2505 * Revisions options can to some degree be combined, which makes it possible
2506 * to say "show at most 20 commits from within the last month that changed
2507 * files under the Documentation/ directory."
2509 * $ tig -- --since=1.month -n20 -- Documentation/
2511 * Examining all repository references
2512 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2513 * In some cases, it can be useful to query changes across all references
2514 * in a repository. An example is to ask "did any line of development in
2515 * this repository change a particular file within the last week". This
2516 * can be accomplished using:
2518 * $ tig -- --all --since=1.week -- Makefile
2522 * Known bugs and problems:
2524 * - In it's current state tig is pretty much UTF-8 only.
2526 * - If the screen width is very small the main view can draw
2527 * outside the current view causing bad wrapping. Same goes
2528 * for title and status windows.
2532 * Features that should be explored.
2540 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
2542 * This program is free software; you can redistribute it and/or modify
2543 * it under the terms of the GNU General Public License as published by
2544 * the Free Software Foundation; either version 2 of the License, or
2545 * (at your option) any later version.
2550 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2551 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2552 * gitk(1): git repository browser written using tcl/tk,
2553 * qgit(1): git repository browser written using c++/Qt,
2554 * gitview(1): git repository browser written using python/gtk.