1 /* Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
3 * This program is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU General Public License as
5 * published by the Free Software Foundation; either version 2 of
6 * the License, or (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
19 * tig - text-mode interface for git
25 * tig [options] [--] [git log options]
26 * tig [options] log [git log options]
27 * tig [options] diff [git diff options]
28 * tig [options] show [git show options]
29 * tig [options] < [git command output]
33 * Browse changes in a git repository. Additionally, tig(1) can also act
34 * as a pager for output of various git commands.
36 * When browsing repositories, tig(1) uses the underlying git commands
37 * to present the user with various views, such as summarized commit log
38 * and showing the commit with the log message, diffstat, and the diff.
40 * Using tig(1) as a pager, it will display input from stdin and try
45 #define VERSION "tig-0.3"
65 static void die(const char *err, ...);
66 static void report(const char *msg, ...);
67 static int read_properties(FILE *pipe, int separator, int (*read)(char *, int, char *, int));
68 static void set_nonblocking_input(bool loading);
69 static size_t utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed);
71 #define ABS(x) ((x) >= 0 ? (x) : -(x))
72 #define MIN(x, y) ((x) < (y) ? (x) : (y))
74 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
75 #define STRING_SIZE(x) (sizeof(x) - 1)
77 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
78 #define SIZEOF_CMD 1024 /* Size of command buffer. */
80 /* This color name can be used to refer to the default term colors. */
81 #define COLOR_DEFAULT (-1)
83 #define TIG_HELP "(d)iff, (l)og, (m)ain, (q)uit, (h)elp"
85 /* The format and size of the date column in the main view. */
86 #define DATE_FORMAT "%Y-%m-%d %H:%M"
87 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
89 #define AUTHOR_COLS 20
91 /* The default interval between line numbers. */
92 #define NUMBER_INTERVAL 1
96 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
98 /* Some ascii-shorthands fitted into the ncurses namespace. */
100 #define KEY_RETURN '\r'
104 /* User action requests. */
106 /* Offset all requests to avoid conflicts with ncurses getch values. */
107 REQ_OFFSET = KEY_MAX + 1,
109 /* XXX: Keep the view request first and in sync with views[]. */
124 REQ_TOGGLE_LINE_NUMBERS,
138 REQ_SCROLL_LINE_DOWN,
140 REQ_SCROLL_PAGE_DOWN,
144 char *name; /* Ref name; tag or head names are shortened. */
145 char id[41]; /* Commit SHA1 ID */
146 unsigned int tag:1; /* Is it a tag? */
147 unsigned int next:1; /* For ref lists: are there more refs? */
150 static struct ref **get_refs(char *id);
158 string_ncopy(char *dst, const char *src, int dstlen)
160 strncpy(dst, src, dstlen - 1);
165 /* Shorthand for safely copying into a fixed buffer. */
166 #define string_copy(dst, src) \
167 string_ncopy(dst, src, sizeof(dst))
172 * NOTE: The following is a slightly modified copy of the git project's shell
173 * quoting routines found in the quote.c file.
175 * Help to copy the thing properly quoted for the shell safety. any single
176 * quote is replaced with '\'', any exclamation point is replaced with '\!',
177 * and the whole thing is enclosed in a
180 * original sq_quote result
181 * name ==> name ==> 'name'
182 * a b ==> a b ==> 'a b'
183 * a'b ==> a'\''b ==> 'a'\''b'
184 * a!b ==> a'\!'b ==> 'a'\!'b'
188 sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
192 #define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0)
195 while ((c = *src++)) {
196 if (c == '\'' || c == '!') {
216 static const char usage[] =
217 VERSION " (" __DATE__ ")\n"
219 "Usage: tig [options]\n"
220 " or: tig [options] [--] [git log options]\n"
221 " or: tig [options] log [git log options]\n"
222 " or: tig [options] diff [git diff options]\n"
223 " or: tig [options] show [git show options]\n"
224 " or: tig [options] < [git command output]\n"
227 " -l Start up in log view\n"
228 " -d Start up in diff view\n"
229 " -n[I], --line-number[=I] Show line numbers with given interval\n"
230 " -t[N], --tab-size[=N] Set number of spaces for tab expansion\n"
231 " -- Mark end of tig options\n"
232 " -v, --version Show version and exit\n"
233 " -h, --help Show help message and exit\n";
235 /* Option and state variables. */
236 static bool opt_line_number = FALSE;
237 static int opt_num_interval = NUMBER_INTERVAL;
238 static int opt_tab_size = TABSIZE;
239 static enum request opt_request = REQ_VIEW_MAIN;
240 static char opt_cmd[SIZEOF_CMD] = "";
241 static char opt_encoding[20] = "";
242 static bool opt_utf8 = TRUE;
243 static FILE *opt_pipe = NULL;
245 /* Returns the index of log or diff command or -1 to exit. */
247 parse_options(int argc, char *argv[])
251 for (i = 1; i < argc; i++) {
256 * Start up in log view using the internal log command.
258 if (!strcmp(opt, "-l")) {
259 opt_request = REQ_VIEW_LOG;
265 * Start up in diff view using the internal diff command.
267 if (!strcmp(opt, "-d")) {
268 opt_request = REQ_VIEW_DIFF;
273 * -n[INTERVAL], --line-number[=INTERVAL]::
274 * Prefix line numbers in log and diff view.
275 * Optionally, with interval different than each line.
277 if (!strncmp(opt, "-n", 2) ||
278 !strncmp(opt, "--line-number", 13)) {
284 } else if (opt[STRING_SIZE("--line-number")] == '=') {
285 num = opt + STRING_SIZE("--line-number=");
289 opt_num_interval = atoi(num);
291 opt_line_number = TRUE;
296 * -b[NSPACES], --tab-size[=NSPACES]::
297 * Set the number of spaces tabs should be expanded to.
299 if (!strncmp(opt, "-b", 2) ||
300 !strncmp(opt, "--tab-size", 10)) {
306 } else if (opt[STRING_SIZE("--tab-size")] == '=') {
307 num = opt + STRING_SIZE("--tab-size=");
311 opt_tab_size = MIN(atoi(num), TABSIZE);
317 * Show version and exit.
319 if (!strcmp(opt, "-v") ||
320 !strcmp(opt, "--version")) {
321 printf("tig version %s\n", VERSION);
327 * Show help message and exit.
329 if (!strcmp(opt, "-h") ||
330 !strcmp(opt, "--help")) {
337 * End of tig(1) options. Useful when specifying command
338 * options for the main view. Example:
340 * $ tig -- --since=1.month
342 if (!strcmp(opt, "--")) {
348 * log [git log options]::
349 * Open log view using the given git log options.
351 * diff [git diff options]::
352 * Open diff view using the given git diff options.
354 * show [git show options]::
355 * Open diff view using the given git show options.
357 if (!strcmp(opt, "log") ||
358 !strcmp(opt, "diff") ||
359 !strcmp(opt, "show")) {
360 opt_request = opt[0] == 'l'
361 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
366 * [git log options]::
367 * tig(1) will stop the option parsing when the first
368 * command line parameter not starting with "-" is
369 * encountered. All options including this one will be
370 * passed to git log when loading the main view.
371 * This makes it possible to say:
373 * $ tig tag-1.0..HEAD
375 if (opt[0] && opt[0] != '-')
378 die("unknown command '%s'", opt);
381 if (!isatty(STDIN_FILENO)) {
385 * If stdin is a pipe, any log or diff options will be ignored and the
386 * pager view will be opened loading data from stdin. The pager mode
387 * can be used for colorizing output from various git commands.
389 * Example on how to colorize the output of git-show(1):
393 opt_request = REQ_VIEW_PAGER;
396 } else if (i < argc) {
400 * Git command options
401 * ~~~~~~~~~~~~~~~~~~~
402 * All git command options specified on the command line will
403 * be passed to the given command and all will be shell quoted
404 * before they are passed to the shell.
406 * NOTE: If you specify options for the main view, you should
407 * not use the `--pretty` option as this option will be set
408 * automatically to the format expected by the main view.
410 * Example on how to open the log view and show both author and
411 * committer information:
413 * $ tig log --pretty=fuller
415 * See the <<refspec, "Specifying revisions">> section below
416 * for an introduction to revision options supported by the git
417 * commands. For details on specific git command options, refer
418 * to the man page of the command in question.
421 if (opt_request == REQ_VIEW_MAIN)
422 /* XXX: This is vulnerable to the user overriding
423 * options required for the main view parser. */
424 string_copy(opt_cmd, "git log --stat --pretty=raw");
426 string_copy(opt_cmd, "git");
427 buf_size = strlen(opt_cmd);
429 while (buf_size < sizeof(opt_cmd) && i < argc) {
430 opt_cmd[buf_size++] = ' ';
431 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
434 if (buf_size >= sizeof(opt_cmd))
435 die("command too long");
437 opt_cmd[buf_size] = 0;
441 if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8"))
449 * ENVIRONMENT VARIABLES
450 * ---------------------
451 * Several options related to the interface with git can be configured
452 * via environment options.
454 * Repository references
455 * ~~~~~~~~~~~~~~~~~~~~~
456 * Commits that are referenced by tags and branch heads will be marked
457 * by the reference name surrounded by '[' and ']':
459 * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
461 * If you want to filter out certain directories under `.git/refs/`, say
462 * `tmp` you can do it by setting the following variable:
464 * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
466 * Or set the variable permanently in your environment.
469 * Set command for retrieving all repository references. The command
470 * should output data in the same format as git-ls-remote(1).
473 #define TIG_LS_REMOTE \
474 "git ls-remote . 2>/dev/null"
477 * [[history-commands]]
480 * It is possible to alter which commands are used for the different views.
481 * If for example you prefer commits in the main view to be sorted by date
482 * and only show 500 commits, use:
484 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
486 * Or set the variable permanently in your environment.
488 * Notice, how `%s` is used to specify the commit reference. There can
489 * be a maximum of 5 `%s` ref specifications.
492 * The command used for the diff view. By default, git show is used
496 * The command used for the log view. If you prefer to have both
497 * author and committer shown in the log view be sure to pass
498 * `--pretty=fuller` to git log.
501 * The command used for the main view. Note, you must always specify
502 * the option: `--pretty=raw` since the main view parser expects to
506 #define TIG_DIFF_CMD \
507 "git show --patch-with-stat --find-copies-harder -B -C %s"
509 #define TIG_LOG_CMD \
510 "git log --cc --stat -n100 %s"
512 #define TIG_MAIN_CMD \
513 "git log --topo-order --stat --pretty=raw %s"
515 /* ... silently ignore that the following are also exported. */
517 #define TIG_HELP_CMD \
518 "man tig 2>/dev/null"
520 #define TIG_PAGER_CMD \
525 * Line-oriented content detection.
529 /* Line type String to match Foreground Background Attributes
530 * --------- --------------- ---------- ---------- ---------- */ \
532 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
533 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
534 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
535 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
536 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
537 LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
538 LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
539 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
540 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
541 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
542 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
543 /* Pretty print commit header */ \
544 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
545 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
546 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
547 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
548 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
549 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
550 /* Raw commit header */ \
551 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
552 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
553 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
554 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
555 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
557 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
558 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
560 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
561 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
562 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
563 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
564 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
565 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
566 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
567 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
568 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
569 LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
570 LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
573 #define LINE(type, line, fg, bg, attr) \
580 const char *line; /* The start of line to match. */
581 int linelen; /* Size of string to match. */
582 int fg, bg, attr; /* Color and text attributes for the lines. */
585 static struct line_info line_info[] = {
586 #define LINE(type, line, fg, bg, attr) \
587 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
592 static enum line_type
593 get_line_type(char *line)
595 int linelen = strlen(line);
598 for (type = 0; type < ARRAY_SIZE(line_info); type++)
599 /* Case insensitive search matches Signed-off-by lines better. */
600 if (linelen >= line_info[type].linelen &&
601 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
608 get_line_attr(enum line_type type)
610 assert(type < ARRAY_SIZE(line_info));
611 return COLOR_PAIR(type) | line_info[type].attr;
617 int default_bg = COLOR_BLACK;
618 int default_fg = COLOR_WHITE;
623 if (use_default_colors() != ERR) {
628 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
629 struct line_info *info = &line_info[type];
630 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
631 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
633 init_pair(type, fg, bg);
639 void *data; /* User data */
646 * The display consists of a status window on the last line of the screen and
647 * one or more views. The default is to only show one view at the time but it
648 * is possible to split both the main and log view to also show the commit
651 * If you are in the log view and press 'Enter' when the current line is a
652 * commit line, such as:
654 * commit 4d55caff4cc89335192f3e566004b4ceef572521
656 * You will split the view so that the log view is displayed in the top window
657 * and the diff view in the bottom window. You can switch between the two
658 * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
664 /* The display array of active views and the index of the current view. */
665 static struct view *display[2];
666 static unsigned int current_view;
668 #define foreach_view(view, i) \
669 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
671 #define displayed_views() (display[1] != NULL ? 2 : 1)
674 * Current head and commit ID
675 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
676 * The viewer keeps track of both what head and commit ID you are currently
677 * viewing. The commit ID will follow the cursor line and change everytime time
678 * you highlight a different commit. Whenever you reopen the diff view it
679 * will be reloaded, if the commit ID changed.
681 * The head ID is used when opening the main and log view to indicate from
682 * what revision to show history.
685 static char ref_commit[SIZEOF_REF] = "HEAD";
686 static char ref_head[SIZEOF_REF] = "HEAD";
689 const char *name; /* View name */
690 const char *cmd_fmt; /* Default command line format */
691 const char *cmd_env; /* Command line set via environment */
692 const char *id; /* Points to either of ref_{head,commit} */
694 struct view_ops *ops; /* View operations */
696 char cmd[SIZEOF_CMD]; /* Command buffer */
697 char ref[SIZEOF_REF]; /* Hovered commit reference */
698 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
700 int height, width; /* The width and height of the main window */
701 WINDOW *win; /* The main window */
702 WINDOW *title; /* The title window living below the main window */
705 unsigned long offset; /* Offset of the window top */
706 unsigned long lineno; /* Current line number */
708 /* If non-NULL, points to the view that opened this view. If this view
709 * is closed tig will switch back to the parent view. */
713 unsigned long lines; /* Total number of lines */
714 struct line *line; /* Line index */
715 unsigned int digits; /* Number of digits in the lines member. */
723 /* What type of content being displayed. Used in the title bar. */
725 /* Draw one line; @lineno must be < view->height. */
726 bool (*draw)(struct view *view, struct line *line, unsigned int lineno);
727 /* Read one line; updates view->line. */
728 bool (*read)(struct view *view, struct line *prev, char *data);
729 /* Depending on view, change display based on current line. */
730 bool (*enter)(struct view *view, struct line *line);
733 static struct view_ops pager_ops;
734 static struct view_ops main_ops;
736 #define VIEW_STR(name, cmd, env, ref, ops) \
737 { name, cmd, #env, ref, ops }
739 #define VIEW_(id, name, ops, ref) \
740 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops)
745 * tig(1) presents various 'views' of a repository. Each view is based on output
746 * from an external command, most often 'git log', 'git diff', or 'git show'.
749 * Is the default view, and it shows a one line summary of each commit
750 * in the chosen list of revisions. The summary includes commit date,
751 * author, and the first line of the log message. Additionally, any
752 * repository references, such as tags, will be shown.
755 * Presents a more rich view of the revision log showing the whole log
756 * message and the diffstat.
759 * Shows either the diff of the current working tree, that is, what
760 * has changed since the last commit, or the commit diff complete
761 * with log message, diffstat and diff.
764 * Is used for displaying both input from stdin and output from git
765 * commands entered in the internal prompt.
768 * Displays the information from the tig(1) man page. For the help view
769 * to work you need to have the tig(1) man page installed.
772 static struct view views[] = {
773 VIEW_(MAIN, "main", &main_ops, ref_head),
774 VIEW_(DIFF, "diff", &pager_ops, ref_commit),
775 VIEW_(LOG, "log", &pager_ops, ref_head),
776 VIEW_(HELP, "help", &pager_ops, "static"),
777 VIEW_(PAGER, "pager", &pager_ops, "static"),
780 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
784 draw_view_line(struct view *view, unsigned int lineno)
786 if (view->offset + lineno >= view->lines)
789 return view->ops->draw(view, &view->line[view->offset + lineno], lineno);
793 redraw_view_from(struct view *view, int lineno)
795 assert(0 <= lineno && lineno < view->height);
797 for (; lineno < view->height; lineno++) {
798 if (!draw_view_line(view, lineno))
802 redrawwin(view->win);
807 redraw_view(struct view *view)
810 redraw_view_from(view, 0);
817 * Each view has a title window which shows the name of the view, current
818 * commit ID if available, and where the view is positioned:
820 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
822 * By default, the title of the current view is highlighted using bold font.
823 * For long loading views (taking over 3 seconds) the time since loading
824 * started will be appended:
826 * [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
830 update_view_title(struct view *view)
832 if (view == display[current_view])
833 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
835 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
838 wmove(view->title, 0, 0);
841 wprintw(view->title, "[%s] %s", view->name, view->ref);
843 wprintw(view->title, "[%s]", view->name);
845 if (view->lines || view->pipe) {
846 unsigned int lines = view->lines
847 ? (view->lineno + 1) * 100 / view->lines
850 wprintw(view->title, " - %s %d of %d (%d%%)",
858 time_t secs = time(NULL) - view->start_time;
860 /* Three git seconds are a long time ... */
862 wprintw(view->title, " %lds", secs);
865 wmove(view->title, 0, view->width - 1);
866 wrefresh(view->title);
873 struct view *base = display[0];
874 struct view *view = display[1] ? display[1] : display[0];
876 /* Setup window dimensions */
878 getmaxyx(stdscr, base->height, base->width);
880 /* Make room for the status window. */
884 /* Horizontal split. */
885 view->width = base->width;
886 view->height = SCALE_SPLIT_VIEW(base->height);
887 base->height -= view->height;
889 /* Make room for the title bar. */
893 /* Make room for the title bar. */
898 foreach_view (view, i) {
900 view->win = newwin(view->height, 0, offset, 0);
902 die("Failed to create %s view", view->name);
904 scrollok(view->win, TRUE);
906 view->title = newwin(1, 0, offset + view->height, 0);
908 die("Failed to create title window");
911 wresize(view->win, view->height, view->width);
912 mvwin(view->win, offset, 0);
913 mvwin(view->title, offset + view->height, 0);
916 offset += view->height + 1;
926 foreach_view (view, i) {
928 update_view_title(view);
933 update_display_cursor(void)
935 struct view *view = display[current_view];
937 /* Move the cursor to the right-most column of the cursor line.
939 * XXX: This could turn out to be a bit expensive, but it ensures that
940 * the cursor does not jump around. */
942 wmove(view->win, view->lineno - view->offset, view->width - 1);
951 /* Scrolling backend */
953 do_scroll_view(struct view *view, int lines, bool redraw)
955 /* The rendering expects the new offset. */
956 view->offset += lines;
958 assert(0 <= view->offset && view->offset < view->lines);
961 /* Redraw the whole screen if scrolling is pointless. */
962 if (view->height < ABS(lines)) {
966 int line = lines > 0 ? view->height - lines : 0;
967 int end = line + ABS(lines);
969 wscrl(view->win, lines);
971 for (; line < end; line++) {
972 if (!draw_view_line(view, line))
977 /* Move current line into the view. */
978 if (view->lineno < view->offset) {
979 view->lineno = view->offset;
980 draw_view_line(view, 0);
982 } else if (view->lineno >= view->offset + view->height) {
983 if (view->lineno == view->offset + view->height) {
984 /* Clear the hidden line so it doesn't show if the view
986 wmove(view->win, view->height, 0);
987 wclrtoeol(view->win);
989 view->lineno = view->offset + view->height - 1;
990 draw_view_line(view, view->lineno - view->offset);
993 assert(view->offset <= view->lineno && view->lineno < view->lines);
998 redrawwin(view->win);
1003 /* Scroll frontend */
1005 scroll_view(struct view *view, enum request request)
1010 case REQ_SCROLL_PAGE_DOWN:
1011 lines = view->height;
1012 case REQ_SCROLL_LINE_DOWN:
1013 if (view->offset + lines > view->lines)
1014 lines = view->lines - view->offset;
1016 if (lines == 0 || view->offset + view->height >= view->lines) {
1017 report("Cannot scroll beyond the last line");
1022 case REQ_SCROLL_PAGE_UP:
1023 lines = view->height;
1024 case REQ_SCROLL_LINE_UP:
1025 if (lines > view->offset)
1026 lines = view->offset;
1029 report("Cannot scroll beyond the first line");
1037 die("request %d not handled in switch", request);
1040 do_scroll_view(view, lines, TRUE);
1045 move_view(struct view *view, enum request request, bool redraw)
1050 case REQ_MOVE_FIRST_LINE:
1051 steps = -view->lineno;
1054 case REQ_MOVE_LAST_LINE:
1055 steps = view->lines - view->lineno - 1;
1058 case REQ_MOVE_PAGE_UP:
1059 steps = view->height > view->lineno
1060 ? -view->lineno : -view->height;
1063 case REQ_MOVE_PAGE_DOWN:
1064 steps = view->lineno + view->height >= view->lines
1065 ? view->lines - view->lineno - 1 : view->height;
1077 die("request %d not handled in switch", request);
1080 if (steps <= 0 && view->lineno == 0) {
1081 report("Cannot move beyond the first line");
1084 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1085 report("Cannot move beyond the last line");
1089 /* Move the current line */
1090 view->lineno += steps;
1091 assert(0 <= view->lineno && view->lineno < view->lines);
1093 /* Repaint the old "current" line if we be scrolling */
1094 if (ABS(steps) < view->height) {
1095 int prev_lineno = view->lineno - steps - view->offset;
1097 wmove(view->win, prev_lineno, 0);
1098 wclrtoeol(view->win);
1099 draw_view_line(view, prev_lineno);
1102 /* Check whether the view needs to be scrolled */
1103 if (view->lineno < view->offset ||
1104 view->lineno >= view->offset + view->height) {
1105 if (steps < 0 && -steps > view->offset) {
1106 steps = -view->offset;
1108 } else if (steps > 0) {
1109 if (view->lineno == view->lines - 1 &&
1110 view->lines > view->height) {
1111 steps = view->lines - view->offset - 1;
1112 if (steps >= view->height)
1113 steps -= view->height - 1;
1117 do_scroll_view(view, steps, redraw);
1121 /* Draw the current line */
1122 draw_view_line(view, view->lineno - view->offset);
1127 redrawwin(view->win);
1128 wrefresh(view->win);
1134 * Incremental updating
1138 end_update(struct view *view)
1142 set_nonblocking_input(FALSE);
1143 if (view->pipe == stdin)
1151 begin_update(struct view *view)
1153 const char *id = view->id;
1159 string_copy(view->cmd, opt_cmd);
1161 /* When running random commands, the view ref could have become
1162 * invalid so clear it. */
1165 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1167 if (snprintf(view->cmd, sizeof(view->cmd), format,
1168 id, id, id, id, id) >= sizeof(view->cmd))
1172 /* Special case for the pager view. */
1174 view->pipe = opt_pipe;
1177 view->pipe = popen(view->cmd, "r");
1183 set_nonblocking_input(TRUE);
1188 string_copy(view->vid, id);
1193 for (i = 0; i < view->lines; i++)
1194 if (view->line[i].data)
1195 free(view->line[i].data);
1201 view->start_time = time(NULL);
1207 update_view(struct view *view)
1209 char buffer[BUFSIZ];
1212 /* The number of lines to read. If too low it will cause too much
1213 * redrawing (and possible flickering), if too high responsiveness
1215 unsigned long lines = view->height;
1216 int redraw_from = -1;
1221 /* Only redraw if lines are visible. */
1222 if (view->offset + view->height >= view->lines)
1223 redraw_from = view->lines - view->offset;
1225 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1231 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1232 int linelen = strlen(line);
1234 struct line *prev = view->lines
1235 ? &view->line[view->lines - 1]
1239 line[linelen - 1] = 0;
1241 if (!view->ops->read(view, prev, line))
1251 lines = view->lines;
1252 for (digits = 0; lines; digits++)
1255 /* Keep the displayed view in sync with line number scaling. */
1256 if (digits != view->digits) {
1257 view->digits = digits;
1262 if (redraw_from >= 0) {
1263 /* If this is an incremental update, redraw the previous line
1264 * since for commits some members could have changed when
1265 * loading the main view. */
1266 if (redraw_from > 0)
1269 /* Incrementally draw avoids flickering. */
1270 redraw_view_from(view, redraw_from);
1273 /* Update the title _after_ the redraw so that if the redraw picks up a
1274 * commit reference in view->ref it'll be available here. */
1275 update_view_title(view);
1277 if (ferror(view->pipe)) {
1278 report("Failed to read: %s", strerror(errno));
1281 } else if (feof(view->pipe)) {
1282 if (view == VIEW(REQ_VIEW_HELP)) {
1283 const char *msg = TIG_HELP;
1285 if (view->lines == 0) {
1286 /* Slightly ugly, but abusing view->ref keeps
1287 * the error message. */
1288 string_copy(view->ref, "No help available");
1289 msg = "The tig(1) manpage is not installed";
1303 report("Allocation failure");
1311 OPEN_DEFAULT = 0, /* Use default view switching. */
1312 OPEN_SPLIT = 1, /* Split current view. */
1313 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1314 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1318 open_view(struct view *prev, enum request request, enum open_flags flags)
1320 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1321 bool split = !!(flags & OPEN_SPLIT);
1322 bool reload = !!(flags & OPEN_RELOAD);
1323 struct view *view = VIEW(request);
1324 int nviews = displayed_views();
1325 struct view *base_view = display[0];
1327 if (view == prev && nviews == 1 && !reload) {
1328 report("Already in %s view", view->name);
1332 if ((reload || strcmp(view->vid, view->id)) &&
1333 !begin_update(view)) {
1334 report("Failed to load %s view", view->name);
1339 display[current_view + 1] = view;
1343 /* Maximize the current view. */
1344 memset(display, 0, sizeof(display));
1346 display[current_view] = view;
1349 /* Resize the view when switching between split- and full-screen,
1350 * or when switching between two different full-screen views. */
1351 if (nviews != displayed_views() ||
1352 (nviews == 1 && base_view != display[0]))
1355 if (split && prev->lineno - prev->offset >= prev->height) {
1356 /* Take the title line into account. */
1357 int lines = prev->lineno - prev->offset - prev->height + 1;
1359 /* Scroll the view that was split if the current line is
1360 * outside the new limited view. */
1361 do_scroll_view(prev, lines, TRUE);
1364 if (prev && view != prev) {
1365 if (split && !backgrounded) {
1366 /* "Blur" the previous view. */
1367 update_view_title(prev);
1370 view->parent = prev;
1373 if (view->pipe && view->lines == 0) {
1374 /* Clear the old view and let the incremental updating refill
1380 if (view == VIEW(REQ_VIEW_HELP))
1381 report("%s", TIG_HELP);
1386 /* If the view is backgrounded the above calls to report()
1387 * won't redraw the view title. */
1389 update_view_title(view);
1394 * User request switch noodle
1398 view_driver(struct view *view, enum request request)
1405 case REQ_MOVE_PAGE_UP:
1406 case REQ_MOVE_PAGE_DOWN:
1407 case REQ_MOVE_FIRST_LINE:
1408 case REQ_MOVE_LAST_LINE:
1409 move_view(view, request, TRUE);
1412 case REQ_SCROLL_LINE_DOWN:
1413 case REQ_SCROLL_LINE_UP:
1414 case REQ_SCROLL_PAGE_DOWN:
1415 case REQ_SCROLL_PAGE_UP:
1416 scroll_view(view, request);
1423 case REQ_VIEW_PAGER:
1424 open_view(view, request, OPEN_DEFAULT);
1429 request = request == REQ_NEXT ? REQ_MOVE_DOWN : REQ_MOVE_UP;
1431 if (view == VIEW(REQ_VIEW_DIFF) &&
1432 view->parent == VIEW(REQ_VIEW_MAIN)) {
1433 bool redraw = display[1] == view;
1435 view = view->parent;
1436 move_view(view, request, redraw);
1438 update_view_title(view);
1440 move_view(view, request, TRUE);
1447 report("Nothing to enter");
1450 return view->ops->enter(view, &view->line[view->lineno]);
1454 int nviews = displayed_views();
1455 int next_view = (current_view + 1) % nviews;
1457 if (next_view == current_view) {
1458 report("Only one view is displayed");
1462 current_view = next_view;
1463 /* Blur out the title of the previous view. */
1464 update_view_title(view);
1468 case REQ_TOGGLE_LINE_NUMBERS:
1469 opt_line_number = !opt_line_number;
1474 /* Always reload^Wrerun commands from the prompt. */
1475 open_view(view, opt_request, OPEN_RELOAD);
1478 case REQ_STOP_LOADING:
1479 for (i = 0; i < ARRAY_SIZE(views); i++) {
1482 report("Stopped loading the %s view", view->name),
1487 case REQ_SHOW_VERSION:
1488 report("%s (built %s)", VERSION, __DATE__);
1491 case REQ_SCREEN_RESIZE:
1494 case REQ_SCREEN_REDRAW:
1498 case REQ_SCREEN_UPDATE:
1502 case REQ_VIEW_CLOSE:
1503 /* XXX: Mark closed views by letting view->parent point to the
1504 * view itself. Parents to closed view should never be
1507 view->parent->parent != view->parent) {
1508 memset(display, 0, sizeof(display));
1510 display[current_view] = view->parent;
1511 view->parent = view;
1521 /* An unknown key will show most commonly used commands. */
1522 report("Unknown key, press 'h' for help");
1535 pager_draw(struct view *view, struct line *line, unsigned int lineno)
1537 char *text = line->data;
1538 enum line_type type = line->type;
1539 int textlen = strlen(text);
1542 wmove(view->win, lineno, 0);
1544 if (view->offset + lineno == view->lineno) {
1545 if (type == LINE_COMMIT) {
1546 string_copy(view->ref, text + 7);
1547 string_copy(ref_commit, view->ref);
1551 wchgat(view->win, -1, 0, type, NULL);
1554 attr = get_line_attr(type);
1555 wattrset(view->win, attr);
1557 if (opt_line_number || opt_tab_size < TABSIZE) {
1558 static char spaces[] = " ";
1559 int col_offset = 0, col = 0;
1561 if (opt_line_number) {
1562 unsigned long real_lineno = view->offset + lineno + 1;
1564 if (real_lineno == 1 ||
1565 (real_lineno % opt_num_interval) == 0) {
1566 wprintw(view->win, "%.*d", view->digits, real_lineno);
1569 waddnstr(view->win, spaces,
1570 MIN(view->digits, STRING_SIZE(spaces)));
1572 waddstr(view->win, ": ");
1573 col_offset = view->digits + 2;
1576 while (text && col_offset + col < view->width) {
1577 int cols_max = view->width - col_offset - col;
1581 if (*text == '\t') {
1583 assert(sizeof(spaces) > TABSIZE);
1585 cols = opt_tab_size - (col % opt_tab_size);
1588 text = strchr(text, '\t');
1589 cols = line ? text - pos : strlen(pos);
1592 waddnstr(view->win, pos, MIN(cols, cols_max));
1597 int col = 0, pos = 0;
1599 for (; pos < textlen && col < view->width; pos++, col++)
1600 if (text[pos] == '\t')
1601 col += TABSIZE - (col % TABSIZE) - 1;
1603 waddnstr(view->win, text, pos);
1610 pager_read(struct view *view, struct line *prev, char *line)
1612 /* Compress empty lines in the help view. */
1613 if (view == VIEW(REQ_VIEW_HELP) &&
1614 !*line && prev && !*((char *) prev->data))
1617 view->line[view->lines].data = strdup(line);
1618 if (!view->line[view->lines].data)
1621 view->line[view->lines].type = get_line_type(line);
1628 pager_enter(struct view *view, struct line *line)
1632 if (line->type == LINE_COMMIT &&
1633 (view == VIEW(REQ_VIEW_LOG) ||
1634 view == VIEW(REQ_VIEW_PAGER))) {
1635 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1639 /* Always scroll the view even if it was split. That way
1640 * you can use Enter to scroll through the log view and
1641 * split open each commit diff. */
1642 scroll_view(view, REQ_SCROLL_LINE_DOWN);
1644 /* FIXME: A minor workaround. Scrolling the view will call report("")
1645 * but if we are scrolling a non-current view this won't properly
1646 * update the view title. */
1648 update_view_title(view);
1653 static struct view_ops pager_ops = {
1666 char id[41]; /* SHA1 ID. */
1667 char title[75]; /* The first line of the commit message. */
1668 char author[75]; /* The author of the commit. */
1669 struct tm time; /* Date from the author ident. */
1670 struct ref **refs; /* Repository references; tags & branch heads. */
1674 main_draw(struct view *view, struct line *line, unsigned int lineno)
1676 char buf[DATE_COLS + 1];
1677 struct commit *commit = line->data;
1678 enum line_type type;
1684 if (!*commit->author)
1687 wmove(view->win, lineno, col);
1689 if (view->offset + lineno == view->lineno) {
1690 string_copy(view->ref, commit->id);
1691 string_copy(ref_commit, view->ref);
1693 wattrset(view->win, get_line_attr(type));
1694 wchgat(view->win, -1, 0, type, NULL);
1697 type = LINE_MAIN_COMMIT;
1698 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1701 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1702 waddnstr(view->win, buf, timelen);
1703 waddstr(view->win, " ");
1706 wmove(view->win, lineno, col);
1707 if (type != LINE_CURSOR)
1708 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1711 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1713 authorlen = strlen(commit->author);
1714 if (authorlen > AUTHOR_COLS - 2) {
1715 authorlen = AUTHOR_COLS - 2;
1721 waddnstr(view->win, commit->author, authorlen);
1722 if (type != LINE_CURSOR)
1723 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1724 waddch(view->win, '~');
1726 waddstr(view->win, commit->author);
1730 if (type != LINE_CURSOR)
1731 wattrset(view->win, A_NORMAL);
1733 mvwaddch(view->win, lineno, col, ACS_LTEE);
1734 wmove(view->win, lineno, col + 2);
1741 if (type == LINE_CURSOR)
1743 else if (commit->refs[i]->tag)
1744 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1746 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1747 waddstr(view->win, "[");
1748 waddstr(view->win, commit->refs[i]->name);
1749 waddstr(view->win, "]");
1750 if (type != LINE_CURSOR)
1751 wattrset(view->win, A_NORMAL);
1752 waddstr(view->win, " ");
1753 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1754 } while (commit->refs[i++]->next);
1757 if (type != LINE_CURSOR)
1758 wattrset(view->win, get_line_attr(type));
1761 int titlelen = strlen(commit->title);
1763 if (col + titlelen > view->width)
1764 titlelen = view->width - col;
1766 waddnstr(view->win, commit->title, titlelen);
1772 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1774 main_read(struct view *view, struct line *prev, char *line)
1776 enum line_type type = get_line_type(line);
1777 struct commit *commit;
1781 commit = calloc(1, sizeof(struct commit));
1785 line += STRING_SIZE("commit ");
1787 view->line[view->lines++].data = commit;
1788 string_copy(commit->id, line);
1789 commit->refs = get_refs(commit->id);
1794 char *ident = line + STRING_SIZE("author ");
1795 char *end = strchr(ident, '<');
1800 commit = prev->data;
1803 for (; end > ident && isspace(end[-1]); end--) ;
1807 string_copy(commit->author, ident);
1809 /* Parse epoch and timezone */
1811 char *secs = strchr(end + 1, '>');
1815 if (!secs || secs[1] != ' ')
1819 time = (time_t) atol(secs);
1820 zone = strchr(secs, ' ');
1821 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1825 tz = ('0' - zone[1]) * 60 * 60 * 10;
1826 tz += ('0' - zone[2]) * 60 * 60;
1827 tz += ('0' - zone[3]) * 60;
1828 tz += ('0' - zone[4]) * 60;
1835 gmtime_r(&time, &commit->time);
1843 commit = prev->data;
1845 /* Fill in the commit title if it has not already been set. */
1846 if (commit->title[0])
1849 /* Require titles to start with a non-space character at the
1850 * offset used by git log. */
1851 /* FIXME: More gracefull handling of titles; append "..." to
1852 * shortened titles, etc. */
1853 if (strncmp(line, " ", 4) ||
1857 string_copy(commit->title, line + 4);
1864 main_enter(struct view *view, struct line *line)
1866 enum open_flags flags = display[0] == view ? OPEN_SPLIT : OPEN_DEFAULT;
1868 open_view(view, REQ_VIEW_DIFF, flags);
1872 static struct view_ops main_ops = {
1883 * Below the default key bindings are shown.
1891 static struct keymap keymap[] = {
1896 * Switch to main view.
1898 * Switch to diff view.
1900 * Switch to log view.
1902 * Switch to pager view.
1906 { 'm', REQ_VIEW_MAIN },
1907 { 'd', REQ_VIEW_DIFF },
1908 { 'l', REQ_VIEW_LOG },
1909 { 'p', REQ_VIEW_PAGER },
1910 { 'h', REQ_VIEW_HELP },
1916 * Close view, if multiple views are open it will jump back to the
1917 * previous view in the view stack. If it is the last open view it
1918 * will quit. Use 'Q' to quit all views at once.
1920 * This key is "context sensitive" depending on what view you are
1921 * currently in. When in log view on a commit line or in the main
1922 * view, split the view and show the commit diff. In the diff view
1923 * pressing Enter will simply scroll the view one line down.
1925 * Switch to next view.
1927 * This key is "context sensitive" and will move the cursor one
1928 * line up. However, uf you opened a diff view from the main view
1929 * (split- or full-screen) it will change the cursor to point to
1930 * the previous commit in the main view and update the diff view
1933 * Similar to 'Up' but will move down.
1935 { 'q', REQ_VIEW_CLOSE },
1936 { KEY_TAB, REQ_VIEW_NEXT },
1937 { KEY_RETURN, REQ_ENTER },
1938 { KEY_UP, REQ_PREVIOUS },
1939 { KEY_DOWN, REQ_NEXT },
1945 * Move cursor one line up.
1947 * Move cursor one line down.
1951 * Move cursor one page up.
1954 * Move cursor one page down.
1956 * Jump to first line.
1958 * Jump to last line.
1960 { 'k', REQ_MOVE_UP },
1961 { 'j', REQ_MOVE_DOWN },
1962 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1963 { KEY_END, REQ_MOVE_LAST_LINE },
1964 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1965 { ' ', REQ_MOVE_PAGE_DOWN },
1966 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1967 { 'b', REQ_MOVE_PAGE_UP },
1968 { '-', REQ_MOVE_PAGE_UP },
1974 * Scroll view one line up.
1976 * Scroll view one line down.
1978 * Scroll view one page up.
1980 * Scroll view one page down.
1982 { KEY_IC, REQ_SCROLL_LINE_UP },
1983 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1984 { 'w', REQ_SCROLL_PAGE_UP },
1985 { 's', REQ_SCROLL_PAGE_DOWN },
1995 * Stop all background loading. This can be useful if you use
1996 * tig(1) in a repository with a long history without limiting
2001 * Toggle line numbers on/off.
2003 * Open prompt. This allows you to specify what git command
2009 { 'z', REQ_STOP_LOADING },
2010 { 'v', REQ_SHOW_VERSION },
2011 { 'r', REQ_SCREEN_REDRAW },
2012 { 'n', REQ_TOGGLE_LINE_NUMBERS },
2013 { ':', REQ_PROMPT },
2015 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
2016 { ERR, REQ_SCREEN_UPDATE },
2018 /* Use the ncurses SIGWINCH handler. */
2019 { KEY_RESIZE, REQ_SCREEN_RESIZE },
2023 get_request(int key)
2027 for (i = 0; i < ARRAY_SIZE(keymap); i++)
2028 if (keymap[i].alias == key)
2029 return keymap[i].request;
2031 return (enum request) key;
2036 * Unicode / UTF-8 handling
2038 * NOTE: Much of the following code for dealing with unicode is derived from
2039 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
2040 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
2043 /* I've (over)annotated a lot of code snippets because I am not entirely
2044 * confident that the approach taken by this small UTF-8 interface is correct.
2048 unicode_width(unsigned long c)
2051 (c <= 0x115f /* Hangul Jamo */
2054 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
2056 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
2057 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
2058 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
2059 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
2060 || (c >= 0xffe0 && c <= 0xffe6)
2061 || (c >= 0x20000 && c <= 0x2fffd)
2062 || (c >= 0x30000 && c <= 0x3fffd)))
2068 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
2069 * Illegal bytes are set one. */
2070 static const unsigned char utf8_bytes[256] = {
2071 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2072 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1,
2073 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,
2074 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,
2075 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,
2076 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,
2077 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,
2078 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,
2081 /* Decode UTF-8 multi-byte representation into a unicode character. */
2082 static inline unsigned long
2083 utf8_to_unicode(const char *string, size_t length)
2085 unsigned long unicode;
2089 unicode = string[0];
2092 unicode = (string[0] & 0x1f) << 6;
2093 unicode += (string[1] & 0x3f);
2096 unicode = (string[0] & 0x0f) << 12;
2097 unicode += ((string[1] & 0x3f) << 6);
2098 unicode += (string[2] & 0x3f);
2101 unicode = (string[0] & 0x0f) << 18;
2102 unicode += ((string[1] & 0x3f) << 12);
2103 unicode += ((string[2] & 0x3f) << 6);
2104 unicode += (string[3] & 0x3f);
2107 unicode = (string[0] & 0x0f) << 24;
2108 unicode += ((string[1] & 0x3f) << 18);
2109 unicode += ((string[2] & 0x3f) << 12);
2110 unicode += ((string[3] & 0x3f) << 6);
2111 unicode += (string[4] & 0x3f);
2114 unicode = (string[0] & 0x01) << 30;
2115 unicode += ((string[1] & 0x3f) << 24);
2116 unicode += ((string[2] & 0x3f) << 18);
2117 unicode += ((string[3] & 0x3f) << 12);
2118 unicode += ((string[4] & 0x3f) << 6);
2119 unicode += (string[5] & 0x3f);
2122 die("Invalid unicode length");
2125 /* Invalid characters could return the special 0xfffd value but NUL
2126 * should be just as good. */
2127 return unicode > 0xffff ? 0 : unicode;
2130 /* Calculates how much of string can be shown within the given maximum width
2131 * and sets trimmed parameter to non-zero value if all of string could not be
2134 * Additionally, adds to coloffset how many many columns to move to align with
2135 * the expected position. Takes into account how multi-byte and double-width
2136 * characters will effect the cursor position.
2138 * Returns the number of bytes to output from string to satisfy max_width. */
2140 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2142 const char *start = string;
2143 const char *end = strchr(string, '\0');
2149 while (string < end) {
2150 int c = *(unsigned char *) string;
2151 unsigned char bytes = utf8_bytes[c];
2153 unsigned long unicode;
2155 if (string + bytes > end)
2158 /* Change representation to figure out whether
2159 * it is a single- or double-width character. */
2161 unicode = utf8_to_unicode(string, bytes);
2162 /* FIXME: Graceful handling of invalid unicode character. */
2166 ucwidth = unicode_width(unicode);
2168 if (width > max_width) {
2173 /* The column offset collects the differences between the
2174 * number of bytes encoding a character and the number of
2175 * columns will be used for rendering said character.
2177 * So if some character A is encoded in 2 bytes, but will be
2178 * represented on the screen using only 1 byte this will and up
2179 * adding 1 to the multi-byte column offset.
2181 * Assumes that no double-width character can be encoding in
2182 * less than two bytes. */
2183 if (bytes > ucwidth)
2184 mbwidth += bytes - ucwidth;
2189 *coloffset += mbwidth;
2191 return string - start;
2199 /* Whether or not the curses interface has been initialized. */
2200 static bool cursed = FALSE;
2202 /* The status window is used for polling keystrokes. */
2203 static WINDOW *status_win;
2205 /* Update status and title window. */
2207 report(const char *msg, ...)
2209 static bool empty = TRUE;
2210 struct view *view = display[current_view];
2212 if (!empty || *msg) {
2215 va_start(args, msg);
2218 wmove(status_win, 0, 0);
2220 vwprintw(status_win, msg, args);
2225 wrefresh(status_win);
2230 update_view_title(view);
2231 update_display_cursor();
2234 /* Controls when nodelay should be in effect when polling user input. */
2236 set_nonblocking_input(bool loading)
2238 static unsigned int loading_views;
2240 if ((loading == FALSE && loading_views-- == 1) ||
2241 (loading == TRUE && loading_views++ == 0))
2242 nodelay(status_win, loading);
2250 /* Initialize the curses library */
2251 if (isatty(STDIN_FILENO)) {
2252 cursed = !!initscr();
2254 /* Leave stdin and stdout alone when acting as a pager. */
2255 FILE *io = fopen("/dev/tty", "r+");
2257 cursed = !!newterm(NULL, io, io);
2261 die("Failed to initialize curses");
2263 nonl(); /* Tell curses not to do NL->CR/NL on output */
2264 cbreak(); /* Take input chars one at a time, no wait for \n */
2265 noecho(); /* Don't echo input */
2266 leaveok(stdscr, TRUE);
2271 getmaxyx(stdscr, y, x);
2272 status_win = newwin(1, 0, y - 1, 0);
2274 die("Failed to create status window");
2276 /* Enable keyboard mapping */
2277 keypad(status_win, TRUE);
2278 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2283 * Repository references
2286 static struct ref *refs;
2287 static size_t refs_size;
2289 /* Id <-> ref store */
2290 static struct ref ***id_refs;
2291 static size_t id_refs_size;
2293 static struct ref **
2296 struct ref ***tmp_id_refs;
2297 struct ref **ref_list = NULL;
2298 size_t ref_list_size = 0;
2301 for (i = 0; i < id_refs_size; i++)
2302 if (!strcmp(id, id_refs[i][0]->id))
2305 tmp_id_refs = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2309 id_refs = tmp_id_refs;
2311 for (i = 0; i < refs_size; i++) {
2314 if (strcmp(id, refs[i].id))
2317 tmp = realloc(ref_list, (ref_list_size + 1) * sizeof(*ref_list));
2325 if (ref_list_size > 0)
2326 ref_list[ref_list_size - 1]->next = 1;
2327 ref_list[ref_list_size] = &refs[i];
2329 /* XXX: The properties of the commit chains ensures that we can
2330 * safely modify the shared ref. The repo references will
2331 * always be similar for the same id. */
2332 ref_list[ref_list_size]->next = 0;
2337 id_refs[id_refs_size++] = ref_list;
2343 read_ref(char *id, int idlen, char *name, int namelen)
2347 bool tag_commit = FALSE;
2349 /* Commits referenced by tags has "^{}" appended. */
2350 if (name[namelen - 1] == '}') {
2351 while (namelen > 0 && name[namelen] != '^')
2358 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2361 name += STRING_SIZE("refs/tags/");
2364 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2365 name += STRING_SIZE("refs/heads/");
2367 } else if (!strcmp(name, "HEAD")) {
2371 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2375 ref = &refs[refs_size++];
2376 ref->name = strdup(name);
2381 string_copy(ref->id, id);
2389 const char *cmd_env = getenv("TIG_LS_REMOTE");
2390 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2392 return read_properties(popen(cmd, "r"), '\t', read_ref);
2396 read_config_option(char *name, int namelen, char *value, int valuelen)
2398 if (!strcmp(name, "i18n.commitencoding")) {
2399 string_copy(opt_encoding, value);
2408 return read_properties(popen("git repo-config --list", "r"),
2409 '=', read_config_option);
2413 read_properties(FILE *pipe, int separator,
2414 int (*read_property)(char *, int, char *, int))
2416 char buffer[BUFSIZ];
2423 while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) {
2424 char *value = strchr(name, separator);
2429 namelen = value - name;
2431 valuelen = strlen(value);
2434 value[valuelen] = 0;
2438 namelen = strlen(name);
2444 state = read_property(name, namelen, value, valuelen);
2447 if (state != ERR && ferror(pipe))
2461 #define __NORETURN __attribute__((__noreturn__))
2466 static void __NORETURN
2469 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2475 static void __NORETURN
2476 die(const char *err, ...)
2482 va_start(args, err);
2483 fputs("tig: ", stderr);
2484 vfprintf(stderr, err, args);
2485 fputs("\n", stderr);
2492 main(int argc, char *argv[])
2495 enum request request;
2498 signal(SIGINT, quit);
2500 /* Load the repo config file first so options can be overwritten from
2501 * the command line. */
2502 if (load_config() == ERR)
2503 die("Failed to load repo config.");
2505 if (!parse_options(argc, argv))
2508 if (load_refs() == ERR)
2509 die("Failed to load refs.");
2511 /* Require a git repository unless when running in pager mode. */
2512 if (refs_size == 0 && opt_request != REQ_VIEW_PAGER)
2513 die("Not a git repository");
2515 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2516 view->cmd_env = getenv(view->cmd_env);
2518 request = opt_request;
2522 while (view_driver(display[current_view], request)) {
2526 foreach_view (view, i)
2529 /* Refresh, accept single keystroke of input */
2530 key = wgetch(status_win);
2531 request = get_request(key);
2533 /* Some low-level request handling. This keeps access to
2534 * status_win restricted. */
2538 /* Temporarily switch to line-oriented and echoed
2543 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2544 memcpy(opt_cmd, "git ", 4);
2545 opt_request = REQ_VIEW_PAGER;
2547 report("Prompt interrupted by loading view, "
2548 "press 'z' to stop loading views");
2549 request = REQ_SCREEN_UPDATE;
2556 case REQ_SCREEN_RESIZE:
2560 getmaxyx(stdscr, height, width);
2562 /* Resize the status view and let the view driver take
2563 * care of resizing the displayed views. */
2564 wresize(status_win, 1, width);
2565 mvwin(status_win, height - 1, 0);
2566 wrefresh(status_win);
2581 * Revision specification
2582 * ----------------------
2583 * This section describes various ways to specify what revisions to display
2584 * or otherwise limit the view to. tig(1) does not itself parse the described
2585 * revision options so refer to the relevant git man pages for futher
2586 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2589 * You can tune the interaction with git by making use of the options
2590 * explained in this section. For example, by configuring the environment
2591 * variables described in the <<history-commands, "History commands">>
2594 * Limit by path name
2595 * ~~~~~~~~~~~~~~~~~~
2596 * If you are interested only in those revisions that made changes to a
2597 * specific file (or even several files) list the files like this:
2599 * $ tig log Makefile README
2601 * To avoid ambiguity with repository references such as tag name, be sure
2602 * to separate file names from other git options using "\--". So if you
2603 * have a file named 'master' it will clash with the reference named
2604 * 'master', and thus you will have to use:
2606 * $ tig log -- master
2608 * NOTE: For the main view, avoiding ambiguity will in some cases require
2609 * you to specify two "\--" options. The first will make tig(1) stop
2610 * option processing and the latter will be passed to git log.
2612 * Limit by date or number
2613 * ~~~~~~~~~~~~~~~~~~~~~~~
2614 * To speed up interaction with git, you can limit the amount of commits
2615 * to show both for the log and main view. Either limit by date using
2616 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2618 * If you are only interested in changed that happened between two dates
2621 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2623 * NOTE: If you want to avoid having to quote dates containing spaces you
2624 * can use "." instead, e.g. `--after=May.5th`.
2626 * Limiting by commit ranges
2627 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2628 * Alternatively, commits can be limited to a specific range, such as
2629 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2631 * $ tig log tag-1.0..tag-2.0
2633 * This way of commit limiting makes it trivial to only browse the commits
2634 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2635 * upstream remote branch, using:
2637 * $ tig log origin..HEAD
2639 * will list what will be pushed to the remote branch. Optionally, the ending
2640 * 'HEAD' can be left out since it is implied.
2642 * Limiting by reachability
2643 * ~~~~~~~~~~~~~~~~~~~~~~~~
2644 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2645 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2646 * Where reachability refers to what commits are ancestors (or part of the
2647 * history) of the branch or tagged revision in question.
2649 * If you prefer to specify which commit to preview in this way use the
2652 * $ tig log tag-2.0 ^tag-1.0
2654 * You can think of '^' as a negation operator. Using this alternate syntax,
2655 * it is possible to further prune commits by specifying multiple branch
2658 * Combining revisions specification
2659 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2660 * Revisions options can to some degree be combined, which makes it possible
2661 * to say "show at most 20 commits from within the last month that changed
2662 * files under the Documentation/ directory."
2664 * $ tig -- --since=1.month -n20 -- Documentation/
2666 * Examining all repository references
2667 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2668 * In some cases, it can be useful to query changes across all references
2669 * in a repository. An example is to ask "did any line of development in
2670 * this repository change a particular file within the last week". This
2671 * can be accomplished using:
2673 * $ tig -- --all --since=1.week -- Makefile
2677 * Known bugs and problems:
2679 * - In it's current state tig is pretty much UTF-8 only.
2681 * - If the screen width is very small the main view can draw
2682 * outside the current view causing bad wrapping. Same goes
2683 * for title and status windows.
2685 * - The cursor can wrap-around on the last line and cause the
2688 * - The prompt doesn't work while loading.
2692 * Features that should be explored.
2700 * Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2702 * This program is free software; you can redistribute it and/or modify
2703 * it under the terms of the GNU General Public License as published by
2704 * the Free Software Foundation; either version 2 of the License, or
2705 * (at your option) any later version.
2709 * - link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2710 * - link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2712 * Other git repository browsers: