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} */
677 size_t objsize; /* Size of objects in the line index */
680 /* What type of content being displayed. Used in the
683 /* Draw one line; @lineno must be < view->height. */
684 bool (*draw)(struct view *view, unsigned int lineno);
685 /* Read one line; updates view->line. */
686 bool (*read)(struct view *view, char *line);
687 /* Depending on view, change display based on current line. */
688 bool (*enter)(struct view *view);
691 char cmd[SIZEOF_CMD]; /* Command buffer */
692 char ref[SIZEOF_REF]; /* Hovered commit reference */
693 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
695 int height, width; /* The width and height of the main window */
696 WINDOW *win; /* The main window */
697 WINDOW *title; /* The title window living below the main window */
700 unsigned long offset; /* Offset of the window top */
701 unsigned long lineno; /* Current line number */
704 unsigned long lines; /* Total number of lines */
705 void **line; /* Line index; each line contains user data */
706 unsigned int digits; /* Number of digits in the lines member. */
713 static struct view_ops pager_ops;
714 static struct view_ops main_ops;
716 #define VIEW_STR(name, cmd, env, ref, objsize, ops) \
717 { name, cmd, #env, ref, objsize, ops }
719 #define VIEW_(id, name, ops, ref, objsize) \
720 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, objsize, ops)
725 * tig(1) presents various 'views' of a repository. Each view is based on output
726 * from an external command, most often 'git log', 'git diff', or 'git show'.
729 * Is the default view, and it shows a one line summary of each commit
730 * in the chosen list of revisions. The summary includes commit date,
731 * author, and the first line of the log message. Additionally, any
732 * repository references, such as tags, will be shown.
735 * Presents a more rich view of the revision log showing the whole log
736 * message and the diffstat.
739 * Shows either the diff of the current working tree, that is, what
740 * has changed since the last commit, or the commit diff complete
741 * with log message, diffstat and diff.
744 * Is used for displaying both input from stdin and output from git
745 * commands entered in the internal prompt.
748 * Displays the information from the tig(1) man page. For the help view
749 * to work you need to have the tig(1) man page installed.
752 static struct view views[] = {
753 VIEW_(MAIN, "main", &main_ops, ref_head, sizeof(struct commit)),
754 VIEW_(DIFF, "diff", &pager_ops, ref_commit, sizeof(char)),
755 VIEW_(LOG, "log", &pager_ops, ref_head, sizeof(char)),
756 VIEW_(HELP, "help", &pager_ops, "static", sizeof(char)),
757 VIEW_(PAGER, "pager", &pager_ops, "static", sizeof(char)),
760 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
764 redraw_view_from(struct view *view, int lineno)
766 assert(0 <= lineno && lineno < view->height);
768 for (; lineno < view->height; lineno++) {
769 if (!view->ops->draw(view, lineno))
773 redrawwin(view->win);
778 redraw_view(struct view *view)
781 redraw_view_from(view, 0);
788 * Each view has a title window which shows the name of the view, current
789 * commit ID if available, and where the view is positioned:
791 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
793 * By default, the title of the current view is highlighted using bold font.
797 update_view_title(struct view *view)
799 if (view == display[current_view])
800 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
802 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
805 wmove(view->title, 0, 0);
808 wprintw(view->title, "[%s] %s", view->name, view->ref);
810 wprintw(view->title, "[%s]", view->name);
813 wprintw(view->title, " - %s %d of %d (%d%%)",
817 (view->lineno + 1) * 100 / view->lines);
820 wrefresh(view->title);
827 struct view *base = display[0];
828 struct view *view = display[1] ? display[1] : display[0];
830 /* Setup window dimensions */
832 getmaxyx(stdscr, base->height, base->width);
834 /* Make room for the status window. */
838 /* Horizontal split. */
839 view->width = base->width;
840 view->height = SCALE_SPLIT_VIEW(base->height);
841 base->height -= view->height;
843 /* Make room for the title bar. */
847 /* Make room for the title bar. */
852 foreach_view (view, i) {
853 /* Keep the height of all view->win windows one larger than is
854 * required so that the cursor can wrap-around on the last line
855 * without scrolling the window. */
857 view->win = newwin(view->height + 1, 0, offset, 0);
859 die("Failed to create %s view", view->name);
861 scrollok(view->win, TRUE);
863 view->title = newwin(1, 0, offset + view->height, 0);
865 die("Failed to create title window");
868 wresize(view->win, view->height + 1, view->width);
869 mvwin(view->win, offset, 0);
870 mvwin(view->title, offset + view->height, 0);
874 offset += view->height + 1;
884 foreach_view (view, i) {
886 update_view_title(view);
895 /* Scrolling backend */
897 do_scroll_view(struct view *view, int lines)
899 /* The rendering expects the new offset. */
900 view->offset += lines;
902 assert(0 <= view->offset && view->offset < view->lines);
905 /* Redraw the whole screen if scrolling is pointless. */
906 if (view->height < ABS(lines)) {
910 int line = lines > 0 ? view->height - lines : 0;
911 int end = line + ABS(lines);
913 wscrl(view->win, lines);
915 for (; line < end; line++) {
916 if (!view->ops->draw(view, line))
921 /* Move current line into the view. */
922 if (view->lineno < view->offset) {
923 view->lineno = view->offset;
924 view->ops->draw(view, 0);
926 } else if (view->lineno >= view->offset + view->height) {
927 if (view->lineno == view->offset + view->height) {
928 /* Clear the hidden line so it doesn't show if the view
930 wmove(view->win, view->height, 0);
931 wclrtoeol(view->win);
933 view->lineno = view->offset + view->height - 1;
934 view->ops->draw(view, view->lineno - view->offset);
937 assert(view->offset <= view->lineno && view->lineno < view->lines);
939 redrawwin(view->win);
944 /* Scroll frontend */
946 scroll_view(struct view *view, enum request request)
951 case REQ_SCROLL_PAGE_DOWN:
952 lines = view->height;
953 case REQ_SCROLL_LINE_DOWN:
954 if (view->offset + lines > view->lines)
955 lines = view->lines - view->offset;
957 if (lines == 0 || view->offset + view->height >= view->lines) {
958 report("Cannot scroll beyond the last line");
963 case REQ_SCROLL_PAGE_UP:
964 lines = view->height;
965 case REQ_SCROLL_LINE_UP:
966 if (lines > view->offset)
967 lines = view->offset;
970 report("Cannot scroll beyond the first line");
978 die("request %d not handled in switch", request);
981 do_scroll_view(view, lines);
986 move_view(struct view *view, enum request request)
991 case REQ_MOVE_FIRST_LINE:
992 steps = -view->lineno;
995 case REQ_MOVE_LAST_LINE:
996 steps = view->lines - view->lineno - 1;
999 case REQ_MOVE_PAGE_UP:
1000 steps = view->height > view->lineno
1001 ? -view->lineno : -view->height;
1004 case REQ_MOVE_PAGE_DOWN:
1005 steps = view->lineno + view->height >= view->lines
1006 ? view->lines - view->lineno - 1 : view->height;
1010 case REQ_MOVE_UP_ENTER:
1015 case REQ_MOVE_DOWN_ENTER:
1020 die("request %d not handled in switch", request);
1023 if (steps <= 0 && view->lineno == 0) {
1024 report("Cannot move beyond the first line");
1027 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1028 report("Cannot move beyond the last line");
1032 /* Move the current line */
1033 view->lineno += steps;
1034 assert(0 <= view->lineno && view->lineno < view->lines);
1036 /* Repaint the old "current" line if we be scrolling */
1037 if (ABS(steps) < view->height) {
1038 int prev_lineno = view->lineno - steps - view->offset;
1040 wmove(view->win, prev_lineno, 0);
1041 wclrtoeol(view->win);
1042 view->ops->draw(view, prev_lineno);
1045 /* Check whether the view needs to be scrolled */
1046 if (view->lineno < view->offset ||
1047 view->lineno >= view->offset + view->height) {
1048 if (steps < 0 && -steps > view->offset) {
1049 steps = -view->offset;
1051 } else if (steps > 0) {
1052 if (view->lineno == view->lines - 1 &&
1053 view->lines > view->height) {
1054 steps = view->lines - view->offset - 1;
1055 if (steps >= view->height)
1056 steps -= view->height - 1;
1060 do_scroll_view(view, steps);
1064 /* Draw the current line */
1065 view->ops->draw(view, view->lineno - view->offset);
1067 redrawwin(view->win);
1068 wrefresh(view->win);
1074 * Incremental updating
1078 begin_update(struct view *view)
1080 const char *id = view->id;
1083 string_copy(view->cmd, opt_cmd);
1085 /* When running random commands, the view ref could have become
1086 * invalid so clear it. */
1089 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1091 if (snprintf(view->cmd, sizeof(view->cmd), format,
1092 id, id, id, id, id) >= sizeof(view->cmd))
1096 /* Special case for the pager view. */
1098 view->pipe = opt_pipe;
1101 view->pipe = popen(view->cmd, "r");
1107 set_nonblocking_input(TRUE);
1112 string_copy(view->vid, id);
1117 for (i = 0; i < view->lines; i++)
1119 free(view->line[i]);
1125 view->start_time = time(NULL);
1131 end_update(struct view *view)
1135 set_nonblocking_input(FALSE);
1136 if (view->pipe == stdin)
1144 update_view(struct view *view)
1146 char buffer[BUFSIZ];
1149 /* The number of lines to read. If too low it will cause too much
1150 * redrawing (and possible flickering), if too high responsiveness
1152 unsigned long lines = view->height;
1153 int redraw_from = -1;
1158 /* Only redraw if lines are visible. */
1159 if (view->offset + view->height >= view->lines)
1160 redraw_from = view->lines - view->offset;
1162 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1168 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1169 int linelen = strlen(line);
1172 line[linelen - 1] = 0;
1174 if (!view->ops->read(view, line))
1184 lines = view->lines;
1185 for (digits = 0; lines; digits++)
1188 /* Keep the displayed view in sync with line number scaling. */
1189 if (digits != view->digits) {
1190 view->digits = digits;
1195 if (redraw_from >= 0) {
1196 /* If this is an incremental update, redraw the previous line
1197 * since for commits some members could have changed when
1198 * loading the main view. */
1199 if (redraw_from > 0)
1202 /* Incrementally draw avoids flickering. */
1203 redraw_view_from(view, redraw_from);
1206 /* Update the title _after_ the redraw so that if the redraw picks up a
1207 * commit reference in view->ref it'll be available here. */
1208 update_view_title(view);
1210 if (ferror(view->pipe)) {
1211 report("Failed to read: %s", strerror(errno));
1214 } else if (feof(view->pipe)) {
1215 time_t secs = time(NULL) - view->start_time;
1217 if (view == VIEW(REQ_VIEW_HELP)) {
1218 const char *msg = TIG_HELP;
1220 if (view->lines == 0) {
1221 /* Slightly ugly, but abusing view->ref keeps
1222 * the error message. */
1223 string_copy(view->ref, "No help available");
1224 msg = "The tig(1) manpage is not installed";
1231 report("Loaded %d lines in %ld second%s", view->lines, secs,
1232 secs == 1 ? "" : "s");
1239 report("Allocation failure");
1247 OPEN_DEFAULT = 0, /* Use default view switching. */
1248 OPEN_SPLIT = 1, /* Split current view. */
1249 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1250 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1254 open_view(struct view *prev, enum request request, enum open_flags flags)
1256 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1257 bool split = !!(flags & OPEN_SPLIT);
1258 bool reload = !!(flags & OPEN_RELOAD);
1259 struct view *view = VIEW(request);
1260 struct view *displayed;
1263 /* Cycle between displayed views and count the views. */
1264 foreach_view (displayed, nviews) {
1266 view == displayed &&
1267 !strcmp(view->vid, prev->vid)) {
1268 current_view = nviews;
1269 /* Blur out the title of the previous view. */
1270 update_view_title(prev);
1276 if (view == prev && nviews == 1 && !reload) {
1277 report("Already in %s view", view->name);
1281 if ((reload || strcmp(view->vid, view->id)) &&
1282 !begin_update(view)) {
1283 report("Failed to load %s view", view->name);
1288 display[current_view + 1] = view;
1292 /* Maximize the current view. */
1293 memset(display, 0, sizeof(display));
1295 display[current_view] = view;
1300 if (split && prev->lineno - prev->offset >= prev->height) {
1301 /* Take the title line into account. */
1302 int lines = prev->lineno - prev->offset - prev->height + 1;
1304 /* Scroll the view that was split if the current line is
1305 * outside the new limited view. */
1306 do_scroll_view(prev, lines);
1309 if (prev && view != prev) {
1310 /* "Blur" the previous view. */
1312 update_view_title(prev);
1314 /* Continue loading split views in the background. */
1320 /* Clear the old view and let the incremental updating refill
1323 report("Loading...");
1326 if (view == VIEW(REQ_VIEW_HELP))
1327 report("%s", TIG_HELP);
1332 /* If the view is backgrounded the above calls to report()
1333 * won't redraw the view title. */
1335 update_view_title(view);
1340 * User request switch noodle
1344 view_driver(struct view *view, enum request request)
1351 case REQ_MOVE_PAGE_UP:
1352 case REQ_MOVE_PAGE_DOWN:
1353 case REQ_MOVE_FIRST_LINE:
1354 case REQ_MOVE_LAST_LINE:
1355 move_view(view, request);
1358 case REQ_SCROLL_LINE_DOWN:
1359 case REQ_SCROLL_LINE_UP:
1360 case REQ_SCROLL_PAGE_DOWN:
1361 case REQ_SCROLL_PAGE_UP:
1362 scroll_view(view, request);
1369 case REQ_VIEW_PAGER:
1370 open_view(view, request, OPEN_DEFAULT);
1373 case REQ_MOVE_UP_ENTER:
1374 case REQ_MOVE_DOWN_ENTER:
1375 move_view(view, request);
1380 report("Nothing to enter");
1383 return view->ops->enter(view);
1387 int nviews = display[1] ? 2 : 1;
1388 int next_view = (current_view + 1) % nviews;
1390 if (next_view == current_view) {
1391 report("Only one view is displayed");
1395 current_view = next_view;
1396 /* Blur out the title of the previous view. */
1397 update_view_title(view);
1401 case REQ_TOGGLE_LINE_NUMBERS:
1402 opt_line_number = !opt_line_number;
1407 /* Always reload^Wrerun commands from the prompt. */
1408 open_view(view, opt_request, OPEN_RELOAD);
1411 case REQ_STOP_LOADING:
1412 foreach_view (view, i) {
1414 report("Stopped loaded the %s view", view->name),
1419 case REQ_SHOW_VERSION:
1420 report("%s (built %s)", VERSION, __DATE__);
1423 case REQ_SCREEN_RESIZE:
1426 case REQ_SCREEN_REDRAW:
1430 case REQ_SCREEN_UPDATE:
1434 case REQ_VIEW_CLOSE:
1436 view = display[(current_view + 1) % ARRAY_SIZE(display)];
1437 memset(display, 0, sizeof(display));
1439 display[current_view] = view;
1449 /* An unknown key will show most commonly used commands. */
1450 report("Unknown key, press 'h' for help");
1459 * View backend handlers
1463 pager_draw(struct view *view, unsigned int lineno)
1465 enum line_type type;
1470 if (view->offset + lineno >= view->lines)
1473 line = view->line[view->offset + lineno];
1474 type = get_line_type(line);
1476 wmove(view->win, lineno, 0);
1478 if (view->offset + lineno == view->lineno) {
1479 if (type == LINE_COMMIT) {
1480 string_copy(view->ref, line + 7);
1481 string_copy(ref_commit, view->ref);
1485 wchgat(view->win, -1, 0, type, NULL);
1488 attr = get_line_attr(type);
1489 wattrset(view->win, attr);
1491 linelen = strlen(line);
1493 if (opt_line_number || opt_tab_size < TABSIZE) {
1494 static char spaces[] = " ";
1495 int col_offset = 0, col = 0;
1497 if (opt_line_number) {
1498 unsigned long real_lineno = view->offset + lineno + 1;
1500 if (real_lineno == 1 ||
1501 (real_lineno % opt_num_interval) == 0) {
1502 wprintw(view->win, "%.*d", view->digits, real_lineno);
1505 waddnstr(view->win, spaces,
1506 MIN(view->digits, STRING_SIZE(spaces)));
1508 waddstr(view->win, ": ");
1509 col_offset = view->digits + 2;
1512 while (line && col_offset + col < view->width) {
1513 int cols_max = view->width - col_offset - col;
1517 if (*line == '\t') {
1518 assert(sizeof(spaces) > TABSIZE);
1521 cols = opt_tab_size - (col % opt_tab_size);
1524 line = strchr(line, '\t');
1525 cols = line ? line - text : strlen(text);
1528 waddnstr(view->win, text, MIN(cols, cols_max));
1533 int col = 0, pos = 0;
1535 for (; pos < linelen && col < view->width; pos++, col++)
1536 if (line[pos] == '\t')
1537 col += TABSIZE - (col % TABSIZE) - 1;
1539 waddnstr(view->win, line, pos);
1546 pager_read(struct view *view, char *line)
1548 /* Compress empty lines in the help view. */
1549 if (view == VIEW(REQ_VIEW_HELP) &&
1552 !*((char *) view->line[view->lines - 1]))
1555 view->line[view->lines] = strdup(line);
1556 if (!view->line[view->lines])
1564 pager_enter(struct view *view)
1566 char *line = view->line[view->lineno];
1569 if ((view == VIEW(REQ_VIEW_LOG) ||
1570 view == VIEW(REQ_VIEW_LOG)) &&
1571 get_line_type(line) == LINE_COMMIT) {
1572 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1576 /* Always scroll the view even if it was split. That way
1577 * you can use Enter to scroll through the log view and
1578 * split open each commit diff. */
1579 scroll_view(view, REQ_SCROLL_LINE_DOWN);
1581 /* FIXME: A minor workaround. Scrolling the view will call report("")
1582 * but if we are scolling a non-current view this won't properly update
1583 * the view title. */
1585 update_view_title(view);
1590 static struct view_ops pager_ops = {
1598 static struct ref **get_refs(char *id);
1601 main_draw(struct view *view, unsigned int lineno)
1603 char buf[DATE_COLS + 1];
1604 struct commit *commit;
1605 enum line_type type;
1611 if (view->offset + lineno >= view->lines)
1614 commit = view->line[view->offset + lineno];
1615 if (!*commit->author)
1618 wmove(view->win, lineno, col);
1620 if (view->offset + lineno == view->lineno) {
1621 string_copy(view->ref, commit->id);
1622 string_copy(ref_commit, view->ref);
1624 wattrset(view->win, get_line_attr(type));
1625 wchgat(view->win, -1, 0, type, NULL);
1628 type = LINE_MAIN_COMMIT;
1629 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1632 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1633 waddnstr(view->win, buf, timelen);
1634 waddstr(view->win, " ");
1637 wmove(view->win, lineno, col);
1638 if (type != LINE_CURSOR)
1639 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1641 /* FIXME: Make this optional, and add i18n.commitEncoding support. */
1642 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1645 waddnstr(view->win, commit->author, authorlen);
1646 if (type != LINE_CURSOR)
1647 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1648 waddch(view->win, '~');
1650 waddstr(view->win, commit->author);
1654 if (type != LINE_CURSOR)
1655 wattrset(view->win, A_NORMAL);
1657 mvwaddch(view->win, lineno, col, ACS_LTEE);
1658 wmove(view->win, lineno, col + 2);
1665 if (type == LINE_CURSOR)
1667 else if (commit->refs[i]->tag)
1668 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1670 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1671 waddstr(view->win, "[");
1672 waddstr(view->win, commit->refs[i]->name);
1673 waddstr(view->win, "]");
1674 if (type != LINE_CURSOR)
1675 wattrset(view->win, A_NORMAL);
1676 waddstr(view->win, " ");
1677 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1678 } while (commit->refs[i++]->next);
1681 if (type != LINE_CURSOR)
1682 wattrset(view->win, get_line_attr(type));
1685 int titlelen = strlen(commit->title);
1687 if (col + titlelen > view->width)
1688 titlelen = view->width - col;
1690 waddnstr(view->win, commit->title, titlelen);
1696 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1698 main_read(struct view *view, char *line)
1700 enum line_type type = get_line_type(line);
1701 struct commit *commit;
1705 commit = calloc(1, sizeof(struct commit));
1709 line += STRING_SIZE("commit ");
1711 view->line[view->lines++] = commit;
1712 string_copy(commit->id, line);
1713 commit->refs = get_refs(commit->id);
1718 char *ident = line + STRING_SIZE("author ");
1719 char *end = strchr(ident, '<');
1722 for (; end > ident && isspace(end[-1]); end--) ;
1726 commit = view->line[view->lines - 1];
1727 string_copy(commit->author, ident);
1729 /* Parse epoch and timezone */
1731 char *secs = strchr(end + 1, '>');
1735 if (!secs || secs[1] != ' ')
1739 time = (time_t) atol(secs);
1740 zone = strchr(secs, ' ');
1741 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1745 tz = ('0' - zone[1]) * 60 * 60 * 10;
1746 tz += ('0' - zone[2]) * 60 * 60;
1747 tz += ('0' - zone[3]) * 60;
1748 tz += ('0' - zone[4]) * 60;
1755 gmtime_r(&time, &commit->time);
1760 /* We should only ever end up here if there has already been a
1761 * commit line, however, be safe. */
1762 if (view->lines == 0)
1765 /* Fill in the commit title if it has not already been set. */
1766 commit = view->line[view->lines - 1];
1767 if (commit->title[0])
1770 /* Require titles to start with a non-space character at the
1771 * offset used by git log. */
1772 /* FIXME: More gracefull handling of titles; append "..." to
1773 * shortened titles, etc. */
1774 if (strncmp(line, " ", 4) ||
1778 string_copy(commit->title, line + 4);
1785 main_enter(struct view *view)
1787 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1791 static struct view_ops main_ops = {
1802 * Below the default key bindings are shown.
1810 static struct keymap keymap[] = {
1815 * Switch to main view.
1817 * Switch to diff view.
1819 * Switch to log view.
1821 * Switch to pager view.
1825 * Close view if multiple views are open, else quit.
1827 * This key is "context sensitive" depending on what view you are
1828 * currently in. When in log view on a commit line or in the main
1829 * view, split the view and show the commit diff. In the diff view
1830 * pressing Enter will simply scroll the view one line down.
1832 * Switch to next view.
1834 { 'm', REQ_VIEW_MAIN },
1835 { 'd', REQ_VIEW_DIFF },
1836 { 'l', REQ_VIEW_LOG },
1837 { 'p', REQ_VIEW_PAGER },
1838 { 'h', REQ_VIEW_HELP },
1840 { 'q', REQ_VIEW_CLOSE },
1841 { KEY_TAB, REQ_VIEW_NEXT },
1842 { KEY_RETURN, REQ_ENTER },
1848 * Move cursor one line up.
1850 * Move cursor one line down.
1852 * Move cursor one line up and enter. When used in the main view
1853 * this will always show the diff of the current commit in the
1856 * Move cursor one line down and enter.
1860 * Move cursor one page up.
1863 * Move cursor one page down.
1865 * Jump to first line.
1867 * Jump to last line.
1869 { KEY_UP, REQ_MOVE_UP },
1870 { KEY_DOWN, REQ_MOVE_DOWN },
1871 { 'k', REQ_MOVE_UP_ENTER },
1872 { 'j', REQ_MOVE_DOWN_ENTER },
1873 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1874 { KEY_END, REQ_MOVE_LAST_LINE },
1875 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1876 { ' ', REQ_MOVE_PAGE_DOWN },
1877 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1878 { 'b', REQ_MOVE_PAGE_UP },
1879 { '-', REQ_MOVE_PAGE_UP },
1885 * Scroll view one line up.
1887 * Scroll view one line down.
1889 * Scroll view one page up.
1891 * Scroll view one page down.
1893 { KEY_IC, REQ_SCROLL_LINE_UP },
1894 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1895 { 'w', REQ_SCROLL_PAGE_UP },
1896 { 's', REQ_SCROLL_PAGE_DOWN },
1906 * Stop all background loading. This can be useful if you use
1907 * tig(1) in a repository with a long history without limiting
1912 * Toggle line numbers on/off.
1914 * Open prompt. This allows you to specify what git command
1920 { 'z', REQ_STOP_LOADING },
1921 { 'v', REQ_SHOW_VERSION },
1922 { 'r', REQ_SCREEN_REDRAW },
1923 { 'n', REQ_TOGGLE_LINE_NUMBERS },
1924 { ':', REQ_PROMPT },
1926 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
1927 { ERR, REQ_SCREEN_UPDATE },
1929 /* Use the ncurses SIGWINCH handler. */
1930 { KEY_RESIZE, REQ_SCREEN_RESIZE },
1934 get_request(int key)
1938 for (i = 0; i < ARRAY_SIZE(keymap); i++)
1939 if (keymap[i].alias == key)
1940 return keymap[i].request;
1942 return (enum request) key;
1947 * Unicode / UTF-8 handling
1949 * NOTE: Much of the following code for dealing with unicode is derived from
1950 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
1951 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
1954 /* I've (over)annotated a lot of code snippets because I am not entirely
1955 * confident that the approach taken by this small UTF-8 interface is correct.
1959 unicode_width(unsigned long c)
1962 (c <= 0x115f /* Hangul Jamo */
1965 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
1967 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
1968 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
1969 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
1970 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
1971 || (c >= 0xffe0 && c <= 0xffe6)
1972 || (c >= 0x20000 && c <= 0x2fffd)
1973 || (c >= 0x30000 && c <= 0x3fffd)))
1979 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
1980 * Illegal bytes are set one. */
1981 static const unsigned char utf8_bytes[256] = {
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 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,
1988 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,
1989 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,
1992 /* Decode UTF-8 multi-byte representation into a unicode character. */
1993 static inline unsigned long
1994 utf8_to_unicode(const char *string, size_t length)
1996 unsigned long unicode;
2000 unicode = string[0];
2003 unicode = (string[0] & 0x1f) << 6;
2004 unicode += (string[1] & 0x3f);
2007 unicode = (string[0] & 0x0f) << 12;
2008 unicode += ((string[1] & 0x3f) << 6);
2009 unicode += (string[2] & 0x3f);
2012 unicode = (string[0] & 0x0f) << 18;
2013 unicode += ((string[1] & 0x3f) << 12);
2014 unicode += ((string[2] & 0x3f) << 6);
2015 unicode += (string[3] & 0x3f);
2018 unicode = (string[0] & 0x0f) << 24;
2019 unicode += ((string[1] & 0x3f) << 18);
2020 unicode += ((string[2] & 0x3f) << 12);
2021 unicode += ((string[3] & 0x3f) << 6);
2022 unicode += (string[4] & 0x3f);
2025 unicode = (string[0] & 0x01) << 30;
2026 unicode += ((string[1] & 0x3f) << 24);
2027 unicode += ((string[2] & 0x3f) << 18);
2028 unicode += ((string[3] & 0x3f) << 12);
2029 unicode += ((string[4] & 0x3f) << 6);
2030 unicode += (string[5] & 0x3f);
2033 die("Invalid unicode length");
2036 /* Invalid characters could return the special 0xfffd value but NUL
2037 * should be just as good. */
2038 return unicode > 0xffff ? 0 : unicode;
2041 /* Calculates how much of string can be shown within the given maximum width
2042 * and sets trimmed parameter to non-zero value if all of string could not be
2045 * Additionally, adds to coloffset how many many columns to move to align with
2046 * the expected position. Takes into account how multi-byte and double-width
2047 * characters will effect the cursor position.
2049 * Returns the number of bytes to output from string to satisfy max_width. */
2051 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2053 const char *start = string;
2054 const char *end = strchr(string, '\0');
2060 while (string < end) {
2061 int c = *(unsigned char *) string;
2062 unsigned char bytes = utf8_bytes[c];
2064 unsigned long unicode;
2066 if (string + bytes > end)
2069 /* Change representation to figure out whether
2070 * it is a single- or double-width character. */
2072 unicode = utf8_to_unicode(string, bytes);
2073 /* FIXME: Graceful handling of invalid unicode character. */
2077 ucwidth = unicode_width(unicode);
2079 if (width > max_width) {
2084 /* The column offset collects the differences between the
2085 * number of bytes encoding a character and the number of
2086 * columns will be used for rendering said character.
2088 * So if some character A is encoded in 2 bytes, but will be
2089 * represented on the screen using only 1 byte this will and up
2090 * adding 1 to the multi-byte column offset.
2092 * Assumes that no double-width character can be encoding in
2093 * less than two bytes. */
2094 if (bytes > ucwidth)
2095 mbwidth += bytes - ucwidth;
2100 *coloffset += mbwidth;
2102 return string - start;
2110 /* Whether or not the curses interface has been initialized. */
2111 static bool cursed = FALSE;
2113 /* The status window is used for polling keystrokes. */
2114 static WINDOW *status_win;
2116 /* Update status and title window. */
2118 report(const char *msg, ...)
2120 static bool empty = TRUE;
2121 struct view *view = display[current_view];
2123 if (!empty || *msg) {
2126 va_start(args, msg);
2129 wmove(status_win, 0, 0);
2131 vwprintw(status_win, msg, args);
2136 wrefresh(status_win);
2141 update_view_title(view);
2143 /* Move the cursor to the right-most column of the cursor line.
2145 * XXX: This could turn out to be a bit expensive, but it ensures that
2146 * the cursor does not jump around. */
2148 wmove(view->win, view->lineno - view->offset, view->width - 1);
2149 wrefresh(view->win);
2153 /* Controls when nodelay should be in effect when polling user input. */
2155 set_nonblocking_input(bool loading)
2157 static unsigned int loading_views;
2159 if ((loading == FALSE && loading_views-- == 1) ||
2160 (loading == TRUE && loading_views++ == 0))
2161 nodelay(status_win, loading);
2169 /* Initialize the curses library */
2170 if (isatty(STDIN_FILENO)) {
2171 cursed = !!initscr();
2173 /* Leave stdin and stdout alone when acting as a pager. */
2174 FILE *io = fopen("/dev/tty", "r+");
2176 cursed = !!newterm(NULL, io, io);
2180 die("Failed to initialize curses");
2182 nonl(); /* Tell curses not to do NL->CR/NL on output */
2183 cbreak(); /* Take input chars one at a time, no wait for \n */
2184 noecho(); /* Don't echo input */
2185 leaveok(stdscr, TRUE);
2190 getmaxyx(stdscr, y, x);
2191 status_win = newwin(1, 0, y - 1, 0);
2193 die("Failed to create status window");
2195 /* Enable keyboard mapping */
2196 keypad(status_win, TRUE);
2197 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2202 * Repository references
2205 static struct ref *refs;
2206 static size_t refs_size;
2208 static struct ref **
2211 struct ref **id_refs = NULL;
2212 size_t id_refs_size = 0;
2215 for (i = 0; i < refs_size; i++) {
2218 if (strcmp(id, refs[i].id))
2221 tmp = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2229 if (id_refs_size > 0)
2230 id_refs[id_refs_size - 1]->next = 1;
2231 id_refs[id_refs_size] = &refs[i];
2233 /* XXX: The properties of the commit chains ensures that we can
2234 * safely modify the shared ref. The repo references will
2235 * always be similar for the same id. */
2236 id_refs[id_refs_size]->next = 0;
2246 const char *cmd_env = getenv("TIG_LS_REMOTE");
2247 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2248 FILE *pipe = popen(cmd, "r");
2249 char buffer[BUFSIZ];
2255 while ((line = fgets(buffer, sizeof(buffer), pipe))) {
2256 char *name = strchr(line, '\t');
2260 bool tag_commit = FALSE;
2266 namelen = strlen(name) - 1;
2268 /* Commits referenced by tags has "^{}" appended. */
2269 if (name[namelen - 1] == '}') {
2270 while (namelen > 0 && name[namelen] != '^')
2277 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2280 name += STRING_SIZE("refs/tags/");
2283 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2284 name += STRING_SIZE("refs/heads/");
2286 } else if (!strcmp(name, "HEAD")) {
2290 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2294 ref = &refs[refs_size++];
2296 ref->name = strdup(name);
2300 string_copy(ref->id, line);
2309 die("Not a git repository");
2319 #define __NORETURN __attribute__((__noreturn__))
2324 static void __NORETURN
2327 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2333 static void __NORETURN
2334 die(const char *err, ...)
2340 va_start(args, err);
2341 fputs("tig: ", stderr);
2342 vfprintf(stderr, err, args);
2343 fputs("\n", stderr);
2350 main(int argc, char *argv[])
2353 enum request request;
2356 signal(SIGINT, quit);
2358 if (!parse_options(argc, argv))
2361 if (load_refs() == ERR)
2362 die("Failed to load refs.");
2364 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2365 view->cmd_env = getenv(view->cmd_env);
2367 request = opt_request;
2371 while (view_driver(display[current_view], request)) {
2375 foreach_view (view, i)
2378 /* Refresh, accept single keystroke of input */
2379 key = wgetch(status_win);
2380 request = get_request(key);
2382 /* Some low-level request handling. This keeps access to
2383 * status_win restricted. */
2387 /* Temporarily switch to line-oriented and echoed
2392 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2393 memcpy(opt_cmd, "git ", 4);
2394 opt_request = REQ_VIEW_PAGER;
2403 case REQ_SCREEN_RESIZE:
2407 getmaxyx(stdscr, height, width);
2409 /* Resize the status view and let the view driver take
2410 * care of resizing the displayed views. */
2411 wresize(status_win, 1, width);
2412 mvwin(status_win, height - 1, 0);
2413 wrefresh(status_win);
2428 * Revision specification
2429 * ----------------------
2430 * This section describes various ways to specify what revisions to display
2431 * or otherwise limit the view to. tig(1) does not itself parse the described
2432 * revision options so refer to the relevant git man pages for futher
2433 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2436 * You can tune the interaction with git by making use of the options
2437 * explained in this section. For example, by configuring the environment
2438 * variables described in the <<view-commands, "View commands">> section.
2440 * Limit by path name
2441 * ~~~~~~~~~~~~~~~~~~
2442 * If you are interested only in those revisions that made changes to a
2443 * specific file (or even several files) list the files like this:
2445 * $ tig log Makefile README
2447 * To avoid ambiguity with repository references such as tag name, be sure
2448 * to separate file names from other git options using "\--". So if you
2449 * have a file named 'master' it will clash with the reference named
2450 * 'master', and thus you will have to use:
2452 * $ tig log -- master
2454 * NOTE: For the main view, avoiding ambiguity will in some cases require
2455 * you to specify two "\--" options. The first will make tig(1) stop
2456 * option processing and the latter will be passed to git log.
2458 * Limit by date or number
2459 * ~~~~~~~~~~~~~~~~~~~~~~~
2460 * To speed up interaction with git, you can limit the amount of commits
2461 * to show both for the log and main view. Either limit by date using
2462 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2464 * If you are only interested in changed that happened between two dates
2467 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2469 * NOTE: If you want to avoid having to quote dates containing spaces you
2470 * can use "." instead, e.g. `--after=May.5th`.
2472 * Limiting by commit ranges
2473 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2474 * Alternatively, commits can be limited to a specific range, such as
2475 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2477 * $ tig log tag-1.0..tag-2.0
2479 * This way of commit limiting makes it trivial to only browse the commits
2480 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2481 * upstream remote branch, using:
2483 * $ tig log origin..HEAD
2485 * will list what will be pushed to the remote branch. Optionally, the ending
2486 * 'HEAD' can be left out since it is implied.
2488 * Limiting by reachability
2489 * ~~~~~~~~~~~~~~~~~~~~~~~~
2490 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2491 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2492 * Where reachability refers to what commits are ancestors (or part of the
2493 * history) of the branch or tagged revision in question.
2495 * If you prefer to specify which commit to preview in this way use the
2498 * $ tig log tag-2.0 ^tag-1.0
2500 * You can think of '^' as a negation operator. Using this alternate syntax,
2501 * it is possible to further prune commits by specifying multiple branch
2504 * Combining revisions specification
2505 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2506 * Revisions options can to some degree be combined, which makes it possible
2507 * to say "show at most 20 commits from within the last month that changed
2508 * files under the Documentation/ directory."
2510 * $ tig -- --since=1.month -n20 -- Documentation/
2512 * Examining all repository references
2513 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2514 * In some cases, it can be useful to query changes across all references
2515 * in a repository. An example is to ask "did any line of development in
2516 * this repository change a particular file within the last week". This
2517 * can be accomplished using:
2519 * $ tig -- --all --since=1.week -- Makefile
2523 * Known bugs and problems:
2525 * - In it's current state tig is pretty much UTF-8 only.
2527 * - If the screen width is very small the main view can draw
2528 * outside the current view causing bad wrapping. Same goes
2529 * for title and status windows.
2533 * Features that should be explored.
2541 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
2543 * This program is free software; you can redistribute it and/or modify
2544 * it under the terms of the GNU General Public License as published by
2545 * the Free Software Foundation; either version 2 of the License, or
2546 * (at your option) any later version.
2551 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2552 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2553 * gitk(1): git repository browser written using tcl/tk,
2554 * qgit(1): git repository browser written using c++/Qt,
2555 * gitview(1): git repository browser written using python/gtk.