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? */
139 static struct ref **get_refs(char *id);
147 string_ncopy(char *dst, const char *src, int dstlen)
149 strncpy(dst, src, dstlen - 1);
154 /* Shorthand for safely copying into a fixed buffer. */
155 #define string_copy(dst, src) \
156 string_ncopy(dst, src, sizeof(dst))
161 * NOTE: The following is a slightly modified copy of the git project's shell
162 * quoting routines found in the quote.c file.
164 * Help to copy the thing properly quoted for the shell safety. any single
165 * quote is replaced with '\'', any exclamation point is replaced with '\!',
166 * and the whole thing is enclosed in a
169 * original sq_quote result
170 * name ==> name ==> 'name'
171 * a b ==> a b ==> 'a b'
172 * a'b ==> a'\''b ==> 'a'\''b'
173 * a!b ==> a'\!'b ==> 'a'\!'b'
177 sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
181 #define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0)
184 while ((c = *src++)) {
185 if (c == '\'' || c == '!') {
205 static const char usage[] =
206 VERSION " (" __DATE__ ")\n"
208 "Usage: tig [options]\n"
209 " or: tig [options] [--] [git log options]\n"
210 " or: tig [options] log [git log options]\n"
211 " or: tig [options] diff [git diff options]\n"
212 " or: tig [options] show [git show options]\n"
213 " or: tig [options] < [git command output]\n"
216 " -l Start up in log view\n"
217 " -d Start up in diff view\n"
218 " -n[I], --line-number[=I] Show line numbers with given interval\n"
219 " -t[N], --tab-size[=N] Set number of spaces for tab expansion\n"
220 " -- Mark end of tig options\n"
221 " -v, --version Show version and exit\n"
222 " -h, --help Show help message and exit\n";
224 /* Option and state variables. */
225 static bool opt_line_number = FALSE;
226 static int opt_num_interval = NUMBER_INTERVAL;
227 static int opt_tab_size = TABSIZE;
228 static enum request opt_request = REQ_VIEW_MAIN;
229 static char opt_cmd[SIZEOF_CMD] = "";
230 static FILE *opt_pipe = NULL;
232 /* Returns the index of log or diff command or -1 to exit. */
234 parse_options(int argc, char *argv[])
238 for (i = 1; i < argc; i++) {
243 * Start up in log view using the internal log command.
245 if (!strcmp(opt, "-l")) {
246 opt_request = REQ_VIEW_LOG;
252 * Start up in diff view using the internal diff command.
254 if (!strcmp(opt, "-d")) {
255 opt_request = REQ_VIEW_DIFF;
260 * -n[INTERVAL], --line-number[=INTERVAL]::
261 * Prefix line numbers in log and diff view.
262 * Optionally, with interval different than each line.
264 if (!strncmp(opt, "-n", 2) ||
265 !strncmp(opt, "--line-number", 13)) {
271 } else if (opt[STRING_SIZE("--line-number")] == '=') {
272 num = opt + STRING_SIZE("--line-number=");
276 opt_num_interval = atoi(num);
278 opt_line_number = TRUE;
283 * -t[NSPACES], --tab-size[=NSPACES]::
284 * Set the number of spaces tabs should be expanded to.
286 if (!strncmp(opt, "-t", 2) ||
287 !strncmp(opt, "--tab-size", 10)) {
293 } else if (opt[STRING_SIZE("--tab-size")] == '=') {
294 num = opt + STRING_SIZE("--tab-size=");
298 opt_tab_size = MIN(atoi(num), TABSIZE);
304 * Show version and exit.
306 if (!strcmp(opt, "-v") ||
307 !strcmp(opt, "--version")) {
308 printf("tig version %s\n", VERSION);
314 * Show help message and exit.
316 if (!strcmp(opt, "-h") ||
317 !strcmp(opt, "--help")) {
324 * End of tig(1) options. Useful when specifying command
325 * options for the main view. Example:
327 * $ tig -- --since=1.month
329 if (!strcmp(opt, "--")) {
335 * log [git log options]::
336 * Open log view using the given git log options.
338 * diff [git diff options]::
339 * Open diff view using the given git diff options.
341 * show [git show options]::
342 * Open diff view using the given git show options.
344 if (!strcmp(opt, "log") ||
345 !strcmp(opt, "diff") ||
346 !strcmp(opt, "show")) {
347 opt_request = opt[0] == 'l'
348 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
353 * [git log options]::
354 * tig(1) will stop the option parsing when the first
355 * command line parameter not starting with "-" is
356 * encountered. All options including this one will be
357 * passed to git log when loading the main view.
358 * This makes it possible to say:
360 * $ tig tag-1.0..HEAD
362 if (opt[0] && opt[0] != '-')
365 die("unknown command '%s'", opt);
368 if (!isatty(STDIN_FILENO)) {
372 * If stdin is a pipe, any log or diff options will be ignored and the
373 * pager view will be opened loading data from stdin. The pager mode
374 * can be used for colorizing output from various git commands.
376 * Example on how to colorize the output of git-show(1):
380 opt_request = REQ_VIEW_PAGER;
383 } else if (i < argc) {
387 * Git command options
388 * ~~~~~~~~~~~~~~~~~~~
389 * All git command options specified on the command line will
390 * be passed to the given command and all will be shell quoted
391 * before they are passed to the shell.
393 * NOTE: If you specify options for the main view, you should
394 * not use the `--pretty` option as this option will be set
395 * automatically to the format expected by the main view.
397 * Example on how to open the log view and show both author and
398 * committer information:
400 * $ tig log --pretty=fuller
402 * See the <<refspec, "Specifying revisions">> section below
403 * for an introduction to revision options supported by the git
404 * commands. For details on specific git command options, refer
405 * to the man page of the command in question.
408 if (opt_request == REQ_VIEW_MAIN)
409 /* XXX: This is vulnerable to the user overriding
410 * options required for the main view parser. */
411 string_copy(opt_cmd, "git log --stat --pretty=raw");
413 string_copy(opt_cmd, "git");
414 buf_size = strlen(opt_cmd);
416 while (buf_size < sizeof(opt_cmd) && i < argc) {
417 opt_cmd[buf_size++] = ' ';
418 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
421 if (buf_size >= sizeof(opt_cmd))
422 die("command too long");
424 opt_cmd[buf_size] = 0;
433 * Line-oriented content detection.
437 /* Line type String to match Foreground Background Attributes
438 * --------- --------------- ---------- ---------- ---------- */ \
440 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
441 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
442 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
443 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
444 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
445 LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
446 LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
447 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
448 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
449 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
450 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
451 /* Pretty print commit header */ \
452 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
453 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
454 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
455 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
456 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
457 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
458 /* Raw commit header */ \
459 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
460 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
461 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
462 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
463 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
465 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
466 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
468 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
469 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
470 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
471 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
472 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
473 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
474 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
475 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
476 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
477 LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
478 LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
481 #define LINE(type, line, fg, bg, attr) \
488 const char *line; /* The start of line to match. */
489 int linelen; /* Size of string to match. */
490 int fg, bg, attr; /* Color and text attributes for the lines. */
493 static struct line_info line_info[] = {
494 #define LINE(type, line, fg, bg, attr) \
495 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
500 static enum line_type
501 get_line_type(char *line)
503 int linelen = strlen(line);
506 for (type = 0; type < ARRAY_SIZE(line_info); type++)
507 /* Case insensitive search matches Signed-off-by lines better. */
508 if (linelen >= line_info[type].linelen &&
509 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
516 get_line_attr(enum line_type type)
518 assert(type < ARRAY_SIZE(line_info));
519 return COLOR_PAIR(type) | line_info[type].attr;
525 int default_bg = COLOR_BLACK;
526 int default_fg = COLOR_WHITE;
531 if (use_default_colors() != ERR) {
536 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
537 struct line_info *info = &line_info[type];
538 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
539 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
541 init_pair(type, fg, bg);
547 * ENVIRONMENT VARIABLES
548 * ---------------------
549 * Several options related to the interface with git can be configured
550 * via environment options.
552 * Repository references
553 * ~~~~~~~~~~~~~~~~~~~~~
554 * Commits that are referenced by tags and branch heads will be marked
555 * by the reference name surrounded by '[' and ']':
557 * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
559 * If you want to filter out certain directories under `.git/refs/`, say
560 * `tmp` you can do it by setting the following variable:
562 * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
564 * Or set the variable permanently in your environment.
567 * Set command for retrieving all repository references. The command
568 * should output data in the same format as git-ls-remote(1).
571 #define TIG_LS_REMOTE \
572 "git ls-remote . 2>/dev/null"
578 * It is possible to alter which commands are used for the different views.
579 * If for example you prefer commits in the main view to be sorted by date
580 * and only show 500 commits, use:
582 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
584 * Or set the variable permanently in your environment.
586 * Notice, how `%s` is used to specify the commit reference. There can
587 * be a maximum of 5 `%s` ref specifications.
590 * The command used for the diff view. By default, git show is used
594 * The command used for the log view. If you prefer to have both
595 * author and committer shown in the log view be sure to pass
596 * `--pretty=fuller` to git log.
599 * The command used for the main view. Note, you must always specify
600 * the option: `--pretty=raw` since the main view parser expects to
604 #define TIG_DIFF_CMD \
605 "git show --patch-with-stat --find-copies-harder -B -C %s"
607 #define TIG_LOG_CMD \
608 "git log --cc --stat -n100 %s"
610 #define TIG_MAIN_CMD \
611 "git log --topo-order --stat --pretty=raw %s"
613 /* ... silently ignore that the following are also exported. */
615 #define TIG_HELP_CMD \
616 "man tig 2>/dev/null"
618 #define TIG_PAGER_CMD \
625 * The display consists of a status window on the last line of the screen and
626 * one or more views. The default is to only show one view at the time but it
627 * is possible to split both the main and log view to also show the commit
630 * If you are in the log view and press 'Enter' when the current line is a
631 * commit line, such as:
633 * commit 4d55caff4cc89335192f3e566004b4ceef572521
635 * You will split the view so that the log view is displayed in the top window
636 * and the diff view in the bottom window. You can switch between the two
637 * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
642 /* The display array of active views and the index of the current view. */
643 static struct view *display[2];
644 static unsigned int current_view;
646 #define foreach_view(view, i) \
647 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
651 * Current head and commit ID
652 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
653 * The viewer keeps track of both what head and commit ID you are currently
654 * viewing. The commit ID will follow the cursor line and change everytime time
655 * you highlight a different commit. Whenever you reopen the diff view it
656 * will be reloaded, if the commit ID changed.
658 * The head ID is used when opening the main and log view to indicate from
659 * what revision to show history.
662 static char ref_commit[SIZEOF_REF] = "HEAD";
663 static char ref_head[SIZEOF_REF] = "HEAD";
667 const char *name; /* View name */
668 const char *cmd_fmt; /* Default command line format */
669 const char *cmd_env; /* Command line set via environment */
670 const char *id; /* Points to either of ref_{head,commit} */
673 /* What type of content being displayed. Used in the
676 /* Draw one line; @lineno must be < view->height. */
677 bool (*draw)(struct view *view, unsigned int lineno);
678 /* Read one line; updates view->line. */
679 bool (*read)(struct view *view, char *line);
680 /* Depending on view, change display based on current line. */
681 bool (*enter)(struct view *view);
684 char cmd[SIZEOF_CMD]; /* Command buffer */
685 char ref[SIZEOF_REF]; /* Hovered commit reference */
686 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
688 int height, width; /* The width and height of the main window */
689 WINDOW *win; /* The main window */
690 WINDOW *title; /* The title window living below the main window */
693 unsigned long offset; /* Offset of the window top */
694 unsigned long lineno; /* Current line number */
696 /* If non-NULL, points to the view that opened this view. If this view
697 * is closed tig will switch back to the parent view. */
701 unsigned long lines; /* Total number of lines */
702 void **line; /* Line index; each line contains user data */
703 unsigned int digits; /* Number of digits in the lines member. */
710 static struct view_ops pager_ops;
711 static struct view_ops main_ops;
713 #define VIEW_STR(name, cmd, env, ref, ops) \
714 { name, cmd, #env, ref, ops }
716 #define VIEW_(id, name, ops, ref) \
717 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops)
722 * tig(1) presents various 'views' of a repository. Each view is based on output
723 * from an external command, most often 'git log', 'git diff', or 'git show'.
726 * Is the default view, and it shows a one line summary of each commit
727 * in the chosen list of revisions. The summary includes commit date,
728 * author, and the first line of the log message. Additionally, any
729 * repository references, such as tags, will be shown.
732 * Presents a more rich view of the revision log showing the whole log
733 * message and the diffstat.
736 * Shows either the diff of the current working tree, that is, what
737 * has changed since the last commit, or the commit diff complete
738 * with log message, diffstat and diff.
741 * Is used for displaying both input from stdin and output from git
742 * commands entered in the internal prompt.
745 * Displays the information from the tig(1) man page. For the help view
746 * to work you need to have the tig(1) man page installed.
749 static struct view views[] = {
750 VIEW_(MAIN, "main", &main_ops, ref_head),
751 VIEW_(DIFF, "diff", &pager_ops, ref_commit),
752 VIEW_(LOG, "log", &pager_ops, ref_head),
753 VIEW_(HELP, "help", &pager_ops, "static"),
754 VIEW_(PAGER, "pager", &pager_ops, "static"),
757 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
761 redraw_view_from(struct view *view, int lineno)
763 assert(0 <= lineno && lineno < view->height);
765 for (; lineno < view->height; lineno++) {
766 if (!view->ops->draw(view, lineno))
770 redrawwin(view->win);
775 redraw_view(struct view *view)
778 redraw_view_from(view, 0);
785 * Each view has a title window which shows the name of the view, current
786 * commit ID if available, and where the view is positioned:
788 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
790 * By default, the title of the current view is highlighted using bold font.
794 update_view_title(struct view *view)
796 if (view == display[current_view])
797 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
799 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
802 wmove(view->title, 0, 0);
805 wprintw(view->title, "[%s] %s", view->name, view->ref);
807 wprintw(view->title, "[%s]", view->name);
810 wprintw(view->title, " - %s %d of %d (%d%%)",
814 (view->lineno + 1) * 100 / view->lines);
817 wrefresh(view->title);
824 struct view *base = display[0];
825 struct view *view = display[1] ? display[1] : display[0];
827 /* Setup window dimensions */
829 getmaxyx(stdscr, base->height, base->width);
831 /* Make room for the status window. */
835 /* Horizontal split. */
836 view->width = base->width;
837 view->height = SCALE_SPLIT_VIEW(base->height);
838 base->height -= view->height;
840 /* Make room for the title bar. */
844 /* Make room for the title bar. */
849 foreach_view (view, i) {
850 /* Keep the height of all view->win windows one larger than is
851 * required so that the cursor can wrap-around on the last line
852 * without scrolling the window. */
854 view->win = newwin(view->height + 1, 0, offset, 0);
856 die("Failed to create %s view", view->name);
858 scrollok(view->win, TRUE);
860 view->title = newwin(1, 0, offset + view->height, 0);
862 die("Failed to create title window");
865 wresize(view->win, view->height + 1, view->width);
866 mvwin(view->win, offset, 0);
867 mvwin(view->title, offset + view->height, 0);
871 offset += view->height + 1;
881 foreach_view (view, i) {
883 update_view_title(view);
892 /* Scrolling backend */
894 do_scroll_view(struct view *view, int lines, bool redraw)
896 /* The rendering expects the new offset. */
897 view->offset += lines;
899 assert(0 <= view->offset && view->offset < view->lines);
902 /* Redraw the whole screen if scrolling is pointless. */
903 if (view->height < ABS(lines)) {
907 int line = lines > 0 ? view->height - lines : 0;
908 int end = line + ABS(lines);
910 wscrl(view->win, lines);
912 for (; line < end; line++) {
913 if (!view->ops->draw(view, line))
918 /* Move current line into the view. */
919 if (view->lineno < view->offset) {
920 view->lineno = view->offset;
921 view->ops->draw(view, 0);
923 } else if (view->lineno >= view->offset + view->height) {
924 if (view->lineno == view->offset + view->height) {
925 /* Clear the hidden line so it doesn't show if the view
927 wmove(view->win, view->height, 0);
928 wclrtoeol(view->win);
930 view->lineno = view->offset + view->height - 1;
931 view->ops->draw(view, view->lineno - view->offset);
934 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, TRUE);
986 move_view(struct view *view, enum request request, bool redraw)
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;
1018 die("request %d not handled in switch", request);
1021 if (steps <= 0 && view->lineno == 0) {
1022 report("Cannot move beyond the first line");
1025 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1026 report("Cannot move beyond the last line");
1030 /* Move the current line */
1031 view->lineno += steps;
1032 assert(0 <= view->lineno && view->lineno < view->lines);
1034 /* Repaint the old "current" line if we be scrolling */
1035 if (ABS(steps) < view->height) {
1036 int prev_lineno = view->lineno - steps - view->offset;
1038 wmove(view->win, prev_lineno, 0);
1039 wclrtoeol(view->win);
1040 view->ops->draw(view, prev_lineno);
1043 /* Check whether the view needs to be scrolled */
1044 if (view->lineno < view->offset ||
1045 view->lineno >= view->offset + view->height) {
1046 if (steps < 0 && -steps > view->offset) {
1047 steps = -view->offset;
1049 } else if (steps > 0) {
1050 if (view->lineno == view->lines - 1 &&
1051 view->lines > view->height) {
1052 steps = view->lines - view->offset - 1;
1053 if (steps >= view->height)
1054 steps -= view->height - 1;
1058 do_scroll_view(view, steps, redraw);
1062 /* Draw the current line */
1063 view->ops->draw(view, view->lineno - view->offset);
1068 redrawwin(view->win);
1069 wrefresh(view->win);
1075 * Incremental updating
1079 begin_update(struct view *view)
1081 const char *id = view->id;
1084 string_copy(view->cmd, opt_cmd);
1086 /* When running random commands, the view ref could have become
1087 * invalid so clear it. */
1090 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1092 if (snprintf(view->cmd, sizeof(view->cmd), format,
1093 id, id, id, id, id) >= sizeof(view->cmd))
1097 /* Special case for the pager view. */
1099 view->pipe = opt_pipe;
1102 view->pipe = popen(view->cmd, "r");
1108 set_nonblocking_input(TRUE);
1113 string_copy(view->vid, id);
1118 for (i = 0; i < view->lines; i++)
1120 free(view->line[i]);
1126 view->start_time = time(NULL);
1132 end_update(struct view *view)
1136 set_nonblocking_input(FALSE);
1137 if (view->pipe == stdin)
1145 update_view(struct view *view)
1147 char buffer[BUFSIZ];
1150 /* The number of lines to read. If too low it will cause too much
1151 * redrawing (and possible flickering), if too high responsiveness
1153 unsigned long lines = view->height;
1154 int redraw_from = -1;
1159 /* Only redraw if lines are visible. */
1160 if (view->offset + view->height >= view->lines)
1161 redraw_from = view->lines - view->offset;
1163 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1169 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1170 int linelen = strlen(line);
1173 line[linelen - 1] = 0;
1175 if (!view->ops->read(view, line))
1185 lines = view->lines;
1186 for (digits = 0; lines; digits++)
1189 /* Keep the displayed view in sync with line number scaling. */
1190 if (digits != view->digits) {
1191 view->digits = digits;
1196 if (redraw_from >= 0) {
1197 /* If this is an incremental update, redraw the previous line
1198 * since for commits some members could have changed when
1199 * loading the main view. */
1200 if (redraw_from > 0)
1203 /* Incrementally draw avoids flickering. */
1204 redraw_view_from(view, redraw_from);
1207 /* Update the title _after_ the redraw so that if the redraw picks up a
1208 * commit reference in view->ref it'll be available here. */
1209 update_view_title(view);
1211 if (ferror(view->pipe)) {
1212 report("Failed to read: %s", strerror(errno));
1215 } else if (feof(view->pipe)) {
1216 time_t secs = time(NULL) - view->start_time;
1218 if (view == VIEW(REQ_VIEW_HELP)) {
1219 const char *msg = TIG_HELP;
1221 if (view->lines == 0) {
1222 /* Slightly ugly, but abusing view->ref keeps
1223 * the error message. */
1224 string_copy(view->ref, "No help available");
1225 msg = "The tig(1) manpage is not installed";
1232 report("Loaded %d lines in %ld second%s", view->lines, secs,
1233 secs == 1 ? "" : "s");
1240 report("Allocation failure");
1248 OPEN_DEFAULT = 0, /* Use default view switching. */
1249 OPEN_SPLIT = 1, /* Split current view. */
1250 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1251 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1255 open_view(struct view *prev, enum request request, enum open_flags flags)
1257 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1258 bool split = !!(flags & OPEN_SPLIT);
1259 bool reload = !!(flags & OPEN_RELOAD);
1260 struct view *view = VIEW(request);
1261 int nviews = display[1] ? 2 : 1;
1263 if (view == prev && nviews == 1 && !reload) {
1264 report("Already in %s view", view->name);
1268 if ((reload || strcmp(view->vid, view->id)) &&
1269 !begin_update(view)) {
1270 report("Failed to load %s view", view->name);
1275 display[current_view + 1] = view;
1279 /* Maximize the current view. */
1280 memset(display, 0, sizeof(display));
1282 display[current_view] = view;
1287 if (split && prev->lineno - prev->offset >= prev->height) {
1288 /* Take the title line into account. */
1289 int lines = prev->lineno - prev->offset - prev->height + 1;
1291 /* Scroll the view that was split if the current line is
1292 * outside the new limited view. */
1293 do_scroll_view(prev, lines, TRUE);
1296 if (prev && view != prev) {
1297 /* "Blur" the previous view. */
1299 update_view_title(prev);
1301 /* Continue loading split views in the background. */
1304 view->parent = prev;
1308 /* Clear the old view and let the incremental updating refill
1311 report("Loading...");
1314 if (view == VIEW(REQ_VIEW_HELP))
1315 report("%s", TIG_HELP);
1320 /* If the view is backgrounded the above calls to report()
1321 * won't redraw the view title. */
1323 update_view_title(view);
1328 * User request switch noodle
1332 view_driver(struct view *view, enum request request)
1339 case REQ_MOVE_PAGE_UP:
1340 case REQ_MOVE_PAGE_DOWN:
1341 case REQ_MOVE_FIRST_LINE:
1342 case REQ_MOVE_LAST_LINE:
1343 move_view(view, request, TRUE);
1346 case REQ_SCROLL_LINE_DOWN:
1347 case REQ_SCROLL_LINE_UP:
1348 case REQ_SCROLL_PAGE_DOWN:
1349 case REQ_SCROLL_PAGE_UP:
1350 scroll_view(view, request);
1357 case REQ_VIEW_PAGER:
1358 open_view(view, request, OPEN_DEFAULT);
1363 request = request == REQ_NEXT ? REQ_MOVE_DOWN : REQ_MOVE_UP;
1365 if (view == VIEW(REQ_VIEW_DIFF) &&
1366 view->parent == VIEW(REQ_VIEW_MAIN)) {
1367 bool redraw = display[0] == VIEW(REQ_VIEW_MAIN);
1369 view = view->parent;
1370 move_view(view, request, redraw);
1371 update_view_title(view);
1373 move_view(view, request, TRUE);
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 memset(display, 0, sizeof(display));
1438 display[current_view] = view->parent;
1439 view->parent = NULL;
1449 /* An unknown key will show most commonly used commands. */
1450 report("Unknown key, press 'h' for help");
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_PAGER)) &&
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 = {
1603 char id[41]; /* SHA1 ID. */
1604 char title[75]; /* The first line of the commit message. */
1605 char author[75]; /* The author of the commit. */
1606 struct tm time; /* Date from the author ident. */
1607 struct ref **refs; /* Repository references; tags & branch heads. */
1611 main_draw(struct view *view, unsigned int lineno)
1613 char buf[DATE_COLS + 1];
1614 struct commit *commit;
1615 enum line_type type;
1621 if (view->offset + lineno >= view->lines)
1624 commit = view->line[view->offset + lineno];
1625 if (!*commit->author)
1628 wmove(view->win, lineno, col);
1630 if (view->offset + lineno == view->lineno) {
1631 string_copy(view->ref, commit->id);
1632 string_copy(ref_commit, view->ref);
1634 wattrset(view->win, get_line_attr(type));
1635 wchgat(view->win, -1, 0, type, NULL);
1638 type = LINE_MAIN_COMMIT;
1639 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1642 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1643 waddnstr(view->win, buf, timelen);
1644 waddstr(view->win, " ");
1647 wmove(view->win, lineno, col);
1648 if (type != LINE_CURSOR)
1649 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1651 /* FIXME: Make this optional, and add i18n.commitEncoding support. */
1652 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1655 waddnstr(view->win, commit->author, authorlen);
1656 if (type != LINE_CURSOR)
1657 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1658 waddch(view->win, '~');
1660 waddstr(view->win, commit->author);
1664 if (type != LINE_CURSOR)
1665 wattrset(view->win, A_NORMAL);
1667 mvwaddch(view->win, lineno, col, ACS_LTEE);
1668 wmove(view->win, lineno, col + 2);
1675 if (type == LINE_CURSOR)
1677 else if (commit->refs[i]->tag)
1678 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1680 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1681 waddstr(view->win, "[");
1682 waddstr(view->win, commit->refs[i]->name);
1683 waddstr(view->win, "]");
1684 if (type != LINE_CURSOR)
1685 wattrset(view->win, A_NORMAL);
1686 waddstr(view->win, " ");
1687 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1688 } while (commit->refs[i++]->next);
1691 if (type != LINE_CURSOR)
1692 wattrset(view->win, get_line_attr(type));
1695 int titlelen = strlen(commit->title);
1697 if (col + titlelen > view->width)
1698 titlelen = view->width - col;
1700 waddnstr(view->win, commit->title, titlelen);
1706 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1708 main_read(struct view *view, char *line)
1710 enum line_type type = get_line_type(line);
1711 struct commit *commit;
1715 commit = calloc(1, sizeof(struct commit));
1719 line += STRING_SIZE("commit ");
1721 view->line[view->lines++] = commit;
1722 string_copy(commit->id, line);
1723 commit->refs = get_refs(commit->id);
1728 char *ident = line + STRING_SIZE("author ");
1729 char *end = strchr(ident, '<');
1732 for (; end > ident && isspace(end[-1]); end--) ;
1736 commit = view->line[view->lines - 1];
1737 string_copy(commit->author, ident);
1739 /* Parse epoch and timezone */
1741 char *secs = strchr(end + 1, '>');
1745 if (!secs || secs[1] != ' ')
1749 time = (time_t) atol(secs);
1750 zone = strchr(secs, ' ');
1751 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1755 tz = ('0' - zone[1]) * 60 * 60 * 10;
1756 tz += ('0' - zone[2]) * 60 * 60;
1757 tz += ('0' - zone[3]) * 60;
1758 tz += ('0' - zone[4]) * 60;
1765 gmtime_r(&time, &commit->time);
1770 /* We should only ever end up here if there has already been a
1771 * commit line, however, be safe. */
1772 if (view->lines == 0)
1775 /* Fill in the commit title if it has not already been set. */
1776 commit = view->line[view->lines - 1];
1777 if (commit->title[0])
1780 /* Require titles to start with a non-space character at the
1781 * offset used by git log. */
1782 /* FIXME: More gracefull handling of titles; append "..." to
1783 * shortened titles, etc. */
1784 if (strncmp(line, " ", 4) ||
1788 string_copy(commit->title, line + 4);
1795 main_enter(struct view *view)
1797 enum open_flags flags = display[0] == view ? OPEN_SPLIT : OPEN_DEFAULT;
1799 open_view(view, REQ_VIEW_DIFF, flags);
1803 static struct view_ops main_ops = {
1814 * Below the default key bindings are shown.
1822 static struct keymap keymap[] = {
1827 * Switch to main view.
1829 * Switch to diff view.
1831 * Switch to log view.
1833 * Switch to pager view.
1837 { 'm', REQ_VIEW_MAIN },
1838 { 'd', REQ_VIEW_DIFF },
1839 { 'l', REQ_VIEW_LOG },
1840 { 'p', REQ_VIEW_PAGER },
1841 { 'h', REQ_VIEW_HELP },
1847 * Close view, if multiple views are open it will jump back to the
1848 * previous view in the view stack. If it is the last open view it
1849 * will quit. Use 'Q' to quit all views at once.
1851 * This key is "context sensitive" depending on what view you are
1852 * currently in. When in log view on a commit line or in the main
1853 * view, split the view and show the commit diff. In the diff view
1854 * pressing Enter will simply scroll the view one line down.
1856 * Switch to next view.
1858 * This key is "context sensitive" and will move the cursor one
1859 * line up. However, uf you opened a diff view from the main view
1860 * (split- or full-screen) it will change the cursor to point to
1861 * the previous commit in the main view and update the diff view
1864 * Similar to 'Up' but will move down.
1866 { 'q', REQ_VIEW_CLOSE },
1867 { KEY_TAB, REQ_VIEW_NEXT },
1868 { KEY_RETURN, REQ_ENTER },
1869 { KEY_UP, REQ_PREVIOUS },
1870 { KEY_DOWN, REQ_NEXT },
1876 * Move cursor one line up.
1878 * Move cursor one line down.
1882 * Move cursor one page up.
1885 * Move cursor one page down.
1887 * Jump to first line.
1889 * Jump to last line.
1891 { 'k', REQ_MOVE_UP },
1892 { 'j', REQ_MOVE_DOWN },
1893 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1894 { KEY_END, REQ_MOVE_LAST_LINE },
1895 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1896 { ' ', REQ_MOVE_PAGE_DOWN },
1897 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1898 { 'b', REQ_MOVE_PAGE_UP },
1899 { '-', REQ_MOVE_PAGE_UP },
1905 * Scroll view one line up.
1907 * Scroll view one line down.
1909 * Scroll view one page up.
1911 * Scroll view one page down.
1913 { KEY_IC, REQ_SCROLL_LINE_UP },
1914 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1915 { 'w', REQ_SCROLL_PAGE_UP },
1916 { 's', REQ_SCROLL_PAGE_DOWN },
1926 * Stop all background loading. This can be useful if you use
1927 * tig(1) in a repository with a long history without limiting
1932 * Toggle line numbers on/off.
1934 * Open prompt. This allows you to specify what git command
1940 { 'z', REQ_STOP_LOADING },
1941 { 'v', REQ_SHOW_VERSION },
1942 { 'r', REQ_SCREEN_REDRAW },
1943 { 'n', REQ_TOGGLE_LINE_NUMBERS },
1944 { ':', REQ_PROMPT },
1946 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
1947 { ERR, REQ_SCREEN_UPDATE },
1949 /* Use the ncurses SIGWINCH handler. */
1950 { KEY_RESIZE, REQ_SCREEN_RESIZE },
1954 get_request(int key)
1958 for (i = 0; i < ARRAY_SIZE(keymap); i++)
1959 if (keymap[i].alias == key)
1960 return keymap[i].request;
1962 return (enum request) key;
1967 * Unicode / UTF-8 handling
1969 * NOTE: Much of the following code for dealing with unicode is derived from
1970 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
1971 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
1974 /* I've (over)annotated a lot of code snippets because I am not entirely
1975 * confident that the approach taken by this small UTF-8 interface is correct.
1979 unicode_width(unsigned long c)
1982 (c <= 0x115f /* Hangul Jamo */
1985 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
1987 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
1988 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
1989 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
1990 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
1991 || (c >= 0xffe0 && c <= 0xffe6)
1992 || (c >= 0x20000 && c <= 0x2fffd)
1993 || (c >= 0x30000 && c <= 0x3fffd)))
1999 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
2000 * Illegal bytes are set one. */
2001 static const unsigned char utf8_bytes[256] = {
2002 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,
2003 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,
2004 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,
2005 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,
2006 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,
2007 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,
2008 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,
2009 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,
2012 /* Decode UTF-8 multi-byte representation into a unicode character. */
2013 static inline unsigned long
2014 utf8_to_unicode(const char *string, size_t length)
2016 unsigned long unicode;
2020 unicode = string[0];
2023 unicode = (string[0] & 0x1f) << 6;
2024 unicode += (string[1] & 0x3f);
2027 unicode = (string[0] & 0x0f) << 12;
2028 unicode += ((string[1] & 0x3f) << 6);
2029 unicode += (string[2] & 0x3f);
2032 unicode = (string[0] & 0x0f) << 18;
2033 unicode += ((string[1] & 0x3f) << 12);
2034 unicode += ((string[2] & 0x3f) << 6);
2035 unicode += (string[3] & 0x3f);
2038 unicode = (string[0] & 0x0f) << 24;
2039 unicode += ((string[1] & 0x3f) << 18);
2040 unicode += ((string[2] & 0x3f) << 12);
2041 unicode += ((string[3] & 0x3f) << 6);
2042 unicode += (string[4] & 0x3f);
2045 unicode = (string[0] & 0x01) << 30;
2046 unicode += ((string[1] & 0x3f) << 24);
2047 unicode += ((string[2] & 0x3f) << 18);
2048 unicode += ((string[3] & 0x3f) << 12);
2049 unicode += ((string[4] & 0x3f) << 6);
2050 unicode += (string[5] & 0x3f);
2053 die("Invalid unicode length");
2056 /* Invalid characters could return the special 0xfffd value but NUL
2057 * should be just as good. */
2058 return unicode > 0xffff ? 0 : unicode;
2061 /* Calculates how much of string can be shown within the given maximum width
2062 * and sets trimmed parameter to non-zero value if all of string could not be
2065 * Additionally, adds to coloffset how many many columns to move to align with
2066 * the expected position. Takes into account how multi-byte and double-width
2067 * characters will effect the cursor position.
2069 * Returns the number of bytes to output from string to satisfy max_width. */
2071 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2073 const char *start = string;
2074 const char *end = strchr(string, '\0');
2080 while (string < end) {
2081 int c = *(unsigned char *) string;
2082 unsigned char bytes = utf8_bytes[c];
2084 unsigned long unicode;
2086 if (string + bytes > end)
2089 /* Change representation to figure out whether
2090 * it is a single- or double-width character. */
2092 unicode = utf8_to_unicode(string, bytes);
2093 /* FIXME: Graceful handling of invalid unicode character. */
2097 ucwidth = unicode_width(unicode);
2099 if (width > max_width) {
2104 /* The column offset collects the differences between the
2105 * number of bytes encoding a character and the number of
2106 * columns will be used for rendering said character.
2108 * So if some character A is encoded in 2 bytes, but will be
2109 * represented on the screen using only 1 byte this will and up
2110 * adding 1 to the multi-byte column offset.
2112 * Assumes that no double-width character can be encoding in
2113 * less than two bytes. */
2114 if (bytes > ucwidth)
2115 mbwidth += bytes - ucwidth;
2120 *coloffset += mbwidth;
2122 return string - start;
2130 /* Whether or not the curses interface has been initialized. */
2131 static bool cursed = FALSE;
2133 /* The status window is used for polling keystrokes. */
2134 static WINDOW *status_win;
2136 /* Update status and title window. */
2138 report(const char *msg, ...)
2140 static bool empty = TRUE;
2141 struct view *view = display[current_view];
2143 if (!empty || *msg) {
2146 va_start(args, msg);
2149 wmove(status_win, 0, 0);
2151 vwprintw(status_win, msg, args);
2156 wrefresh(status_win);
2161 update_view_title(view);
2163 /* Move the cursor to the right-most column of the cursor line.
2165 * XXX: This could turn out to be a bit expensive, but it ensures that
2166 * the cursor does not jump around. */
2168 wmove(view->win, view->lineno - view->offset, view->width - 1);
2169 wrefresh(view->win);
2173 /* Controls when nodelay should be in effect when polling user input. */
2175 set_nonblocking_input(bool loading)
2177 static unsigned int loading_views;
2179 if ((loading == FALSE && loading_views-- == 1) ||
2180 (loading == TRUE && loading_views++ == 0))
2181 nodelay(status_win, loading);
2189 /* Initialize the curses library */
2190 if (isatty(STDIN_FILENO)) {
2191 cursed = !!initscr();
2193 /* Leave stdin and stdout alone when acting as a pager. */
2194 FILE *io = fopen("/dev/tty", "r+");
2196 cursed = !!newterm(NULL, io, io);
2200 die("Failed to initialize curses");
2202 nonl(); /* Tell curses not to do NL->CR/NL on output */
2203 cbreak(); /* Take input chars one at a time, no wait for \n */
2204 noecho(); /* Don't echo input */
2205 leaveok(stdscr, TRUE);
2210 getmaxyx(stdscr, y, x);
2211 status_win = newwin(1, 0, y - 1, 0);
2213 die("Failed to create status window");
2215 /* Enable keyboard mapping */
2216 keypad(status_win, TRUE);
2217 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2222 * Repository references
2225 static struct ref *refs;
2226 static size_t refs_size;
2228 /* Id <-> ref store */
2229 static struct ref ***id_refs;
2230 static size_t id_refs_size;
2232 static struct ref **
2235 struct ref ***tmp_id_refs;
2236 struct ref **ref_list = NULL;
2237 size_t ref_list_size = 0;
2240 for (i = 0; i < id_refs_size; i++)
2241 if (!strcmp(id, id_refs[i][0]->id))
2244 tmp_id_refs = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2248 id_refs = tmp_id_refs;
2250 for (i = 0; i < refs_size; i++) {
2253 if (strcmp(id, refs[i].id))
2256 tmp = realloc(ref_list, (ref_list_size + 1) * sizeof(*ref_list));
2264 if (ref_list_size > 0)
2265 ref_list[ref_list_size - 1]->next = 1;
2266 ref_list[ref_list_size] = &refs[i];
2268 /* XXX: The properties of the commit chains ensures that we can
2269 * safely modify the shared ref. The repo references will
2270 * always be similar for the same id. */
2271 ref_list[ref_list_size]->next = 0;
2276 id_refs[id_refs_size++] = ref_list;
2284 const char *cmd_env = getenv("TIG_LS_REMOTE");
2285 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2286 FILE *pipe = popen(cmd, "r");
2287 char buffer[BUFSIZ];
2293 while ((line = fgets(buffer, sizeof(buffer), pipe))) {
2294 char *name = strchr(line, '\t');
2298 bool tag_commit = FALSE;
2304 namelen = strlen(name) - 1;
2306 /* Commits referenced by tags has "^{}" appended. */
2307 if (name[namelen - 1] == '}') {
2308 while (namelen > 0 && name[namelen] != '^')
2315 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2318 name += STRING_SIZE("refs/tags/");
2321 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2322 name += STRING_SIZE("refs/heads/");
2324 } else if (!strcmp(name, "HEAD")) {
2328 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2332 ref = &refs[refs_size++];
2334 ref->name = strdup(name);
2338 string_copy(ref->id, line);
2354 #define __NORETURN __attribute__((__noreturn__))
2359 static void __NORETURN
2362 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2368 static void __NORETURN
2369 die(const char *err, ...)
2375 va_start(args, err);
2376 fputs("tig: ", stderr);
2377 vfprintf(stderr, err, args);
2378 fputs("\n", stderr);
2385 main(int argc, char *argv[])
2388 enum request request;
2391 signal(SIGINT, quit);
2393 if (!parse_options(argc, argv))
2396 if (load_refs() == ERR)
2397 die("Failed to load refs.");
2399 /* Require a git repository unless when running in pager mode. */
2400 if (refs_size == 0 && opt_request != REQ_VIEW_PAGER)
2401 die("Not a git repository");
2403 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2404 view->cmd_env = getenv(view->cmd_env);
2406 request = opt_request;
2410 while (view_driver(display[current_view], request)) {
2414 foreach_view (view, i)
2417 /* Refresh, accept single keystroke of input */
2418 key = wgetch(status_win);
2419 request = get_request(key);
2421 /* Some low-level request handling. This keeps access to
2422 * status_win restricted. */
2426 /* Temporarily switch to line-oriented and echoed
2431 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2432 memcpy(opt_cmd, "git ", 4);
2433 opt_request = REQ_VIEW_PAGER;
2442 case REQ_SCREEN_RESIZE:
2446 getmaxyx(stdscr, height, width);
2448 /* Resize the status view and let the view driver take
2449 * care of resizing the displayed views. */
2450 wresize(status_win, 1, width);
2451 mvwin(status_win, height - 1, 0);
2452 wrefresh(status_win);
2467 * Revision specification
2468 * ----------------------
2469 * This section describes various ways to specify what revisions to display
2470 * or otherwise limit the view to. tig(1) does not itself parse the described
2471 * revision options so refer to the relevant git man pages for futher
2472 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2475 * You can tune the interaction with git by making use of the options
2476 * explained in this section. For example, by configuring the environment
2477 * variables described in the <<view-commands, "View commands">> section.
2479 * Limit by path name
2480 * ~~~~~~~~~~~~~~~~~~
2481 * If you are interested only in those revisions that made changes to a
2482 * specific file (or even several files) list the files like this:
2484 * $ tig log Makefile README
2486 * To avoid ambiguity with repository references such as tag name, be sure
2487 * to separate file names from other git options using "\--". So if you
2488 * have a file named 'master' it will clash with the reference named
2489 * 'master', and thus you will have to use:
2491 * $ tig log -- master
2493 * NOTE: For the main view, avoiding ambiguity will in some cases require
2494 * you to specify two "\--" options. The first will make tig(1) stop
2495 * option processing and the latter will be passed to git log.
2497 * Limit by date or number
2498 * ~~~~~~~~~~~~~~~~~~~~~~~
2499 * To speed up interaction with git, you can limit the amount of commits
2500 * to show both for the log and main view. Either limit by date using
2501 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2503 * If you are only interested in changed that happened between two dates
2506 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2508 * NOTE: If you want to avoid having to quote dates containing spaces you
2509 * can use "." instead, e.g. `--after=May.5th`.
2511 * Limiting by commit ranges
2512 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2513 * Alternatively, commits can be limited to a specific range, such as
2514 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2516 * $ tig log tag-1.0..tag-2.0
2518 * This way of commit limiting makes it trivial to only browse the commits
2519 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2520 * upstream remote branch, using:
2522 * $ tig log origin..HEAD
2524 * will list what will be pushed to the remote branch. Optionally, the ending
2525 * 'HEAD' can be left out since it is implied.
2527 * Limiting by reachability
2528 * ~~~~~~~~~~~~~~~~~~~~~~~~
2529 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2530 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2531 * Where reachability refers to what commits are ancestors (or part of the
2532 * history) of the branch or tagged revision in question.
2534 * If you prefer to specify which commit to preview in this way use the
2537 * $ tig log tag-2.0 ^tag-1.0
2539 * You can think of '^' as a negation operator. Using this alternate syntax,
2540 * it is possible to further prune commits by specifying multiple branch
2543 * Combining revisions specification
2544 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2545 * Revisions options can to some degree be combined, which makes it possible
2546 * to say "show at most 20 commits from within the last month that changed
2547 * files under the Documentation/ directory."
2549 * $ tig -- --since=1.month -n20 -- Documentation/
2551 * Examining all repository references
2552 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2553 * In some cases, it can be useful to query changes across all references
2554 * in a repository. An example is to ask "did any line of development in
2555 * this repository change a particular file within the last week". This
2556 * can be accomplished using:
2558 * $ tig -- --all --since=1.week -- Makefile
2562 * Known bugs and problems:
2564 * - In it's current state tig is pretty much UTF-8 only.
2566 * - If the screen width is very small the main view can draw
2567 * outside the current view causing bad wrapping. Same goes
2568 * for title and status windows.
2572 * Features that should be explored.
2580 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
2582 * This program is free software; you can redistribute it and/or modify
2583 * it under the terms of the GNU General Public License as published by
2584 * the Free Software Foundation; either version 2 of the License, or
2585 * (at your option) any later version.
2590 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2591 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2592 * gitk(1): git repository browser written using tcl/tk,
2593 * qgit(1): git repository browser written using c++/Qt,
2594 * gitview(1): git repository browser written using python/gtk.