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
);
59 #define ABS(x) ((x) >= 0 ? (x) : -(x))
60 #define MIN(x, y) ((x) < (y) ? (x) : (y))
62 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
63 #define STRING_SIZE(x) (sizeof(x) - 1)
65 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
66 #define SIZEOF_CMD 1024 /* Size of command buffer. */
68 /* This color name can be used to refer to the default term colors. */
69 #define COLOR_DEFAULT (-1)
71 #define TIG_HELP "(d)iff, (l)og, (m)ain, (q)uit, (h)elp"
73 /* The format and size of the date column in the main view. */
74 #define DATE_FORMAT "%Y-%m-%d %H:%M"
75 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
77 /* The default interval between line numbers. */
78 #define NUMBER_INTERVAL 1
82 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
84 /* Some ascii-shorthands fitted into the ncurses namespace. */
86 #define KEY_RETURN '\r'
90 /* User action requests. */
92 /* Offset all requests to avoid conflicts with ncurses getch values. */
93 REQ_OFFSET
= KEY_MAX
+ 1,
95 /* XXX: Keep the view request first and in sync with views[]. */
110 REQ_TOGGLE_LINE_NUMBERS
,
123 REQ_SCROLL_LINE_DOWN
,
125 REQ_SCROLL_PAGE_DOWN
,
129 char *name
; /* Ref name; tag or head names are shortened. */
130 char id
[41]; /* Commit SHA1 ID */
131 unsigned int tag
:1; /* Is it a tag? */
132 unsigned int next
:1; /* For ref lists: are there more refs? */
136 char id
[41]; /* SHA1 ID. */
137 char title
[75]; /* The first line of the commit message. */
138 char author
[75]; /* The author of the commit. */
139 struct tm time
; /* Date from the author ident. */
140 struct ref
**refs
; /* Repository references; tags & branch heads. */
149 string_ncopy(char *dst
, const char *src
, int dstlen
)
151 strncpy(dst
, src
, dstlen
- 1);
156 /* Shorthand for safely copying into a fixed buffer. */
157 #define string_copy(dst, src) \
158 string_ncopy(dst, src, sizeof(dst))
163 * NOTE: The following is a slightly modified copy of the git project's shell
164 * quoting routines found in the quote.c file.
166 * Help to copy the thing properly quoted for the shell safety. any single
167 * quote is replaced with '\'', any exclamation point is replaced with '\!',
168 * and the whole thing is enclosed in a
171 * original sq_quote result
172 * name ==> name ==> 'name'
173 * a b ==> a b ==> 'a b'
174 * a'b ==> a'\''b ==> 'a'\''b'
175 * a!b ==> a'\!'b ==> 'a'\!'b'
179 sq_quote(char buf
[SIZEOF_CMD
], size_t bufsize
, const char *src
)
183 #define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0)
186 while ((c
= *src
++)) {
187 if (c
== '\'' || c
== '!') {
207 /* Option and state variables. */
208 static bool opt_line_number
= FALSE
;
209 static int opt_num_interval
= NUMBER_INTERVAL
;
210 static int opt_tab_size
= TABSIZE
;
211 static enum request opt_request
= REQ_VIEW_MAIN
;
212 static char opt_cmd
[SIZEOF_CMD
] = "";
213 static FILE *opt_pipe
= NULL
;
215 /* Returns the index of log or diff command or -1 to exit. */
217 parse_options(int argc
, char *argv
[])
221 for (i
= 1; i
< argc
; i
++) {
226 * Start up in log view using the internal log command.
228 if (!strcmp(opt
, "-l")) {
229 opt_request
= REQ_VIEW_LOG
;
235 * Start up in diff view using the internal diff command.
237 if (!strcmp(opt
, "-d")) {
238 opt_request
= REQ_VIEW_DIFF
;
243 * -n[INTERVAL], --line-number[=INTERVAL]::
244 * Prefix line numbers in log and diff view.
245 * Optionally, with interval different than each line.
247 if (!strncmp(opt
, "-n", 2) ||
248 !strncmp(opt
, "--line-number", 13)) {
254 } else if (opt
[STRING_SIZE("--line-number")] == '=') {
255 num
= opt
+ STRING_SIZE("--line-number=");
259 opt_num_interval
= atoi(num
);
261 opt_line_number
= TRUE
;
266 * -t[NSPACES], --tab-size[=NSPACES]::
267 * Set the number of spaces tabs should be expanded to.
269 if (!strncmp(opt
, "-t", 2) ||
270 !strncmp(opt
, "--tab-size", 10)) {
276 } else if (opt
[STRING_SIZE("--tab-size")] == '=') {
277 num
= opt
+ STRING_SIZE("--tab-size=");
281 opt_tab_size
= MIN(atoi(num
), TABSIZE
);
287 * Show version and exit.
289 if (!strcmp(opt
, "-v") ||
290 !strcmp(opt
, "--version")) {
291 printf("tig version %s\n", VERSION
);
297 * End of tig(1) options. Useful when specifying command
298 * options for the main view. Example:
300 * $ tig -- --since=1.month
302 if (!strcmp(opt
, "--")) {
308 * log [git log options]::
309 * Open log view using the given git log options.
311 * diff [git diff options]::
312 * Open diff view using the given git diff options.
314 * show [git show options]::
315 * Open diff view using the given git show options.
317 if (!strcmp(opt
, "log") ||
318 !strcmp(opt
, "diff") ||
319 !strcmp(opt
, "show")) {
320 opt_request
= opt
[0] == 'l'
321 ? REQ_VIEW_LOG
: REQ_VIEW_DIFF
;
326 * [git log options]::
327 * tig(1) will stop the option parsing when the first
328 * command line parameter not starting with "-" is
329 * encountered. All options including this one will be
330 * passed to git log when loading the main view.
331 * This makes it possible to say:
333 * $ tig tag-1.0..HEAD
335 if (opt
[0] && opt
[0] != '-')
338 die("unknown command '%s'", opt
);
341 if (!isatty(STDIN_FILENO
)) {
345 * If stdin is a pipe, any log or diff options will be ignored and the
346 * pager view will be opened loading data from stdin. The pager mode
347 * can be used for colorizing output from various git commands.
349 * Example on how to colorize the output of git-show(1):
353 opt_request
= REQ_VIEW_PAGER
;
356 } else if (i
< argc
) {
360 * Git command options
361 * ~~~~~~~~~~~~~~~~~~~
362 * All git command options specified on the command line will
363 * be passed to the given command and all will be shell quoted
364 * before they are passed to the shell.
366 * NOTE: If you specify options for the main view, you should
367 * not use the `--pretty` option as this option will be set
368 * automatically to the format expected by the main view.
370 * Example on how to open the log view and show both author and
371 * committer information:
373 * $ tig log --pretty=fuller
375 * See the <<refspec, "Specifying revisions">> section below
376 * for an introduction to revision options supported by the git
377 * commands. For details on specific git command options, refer
378 * to the man page of the command in question.
381 if (opt_request
== REQ_VIEW_MAIN
)
382 /* XXX: This is vulnerable to the user overriding
383 * options required for the main view parser. */
384 string_copy(opt_cmd
, "git log --stat --pretty=raw");
386 string_copy(opt_cmd
, "git");
387 buf_size
= strlen(opt_cmd
);
389 while (buf_size
< sizeof(opt_cmd
) && i
< argc
) {
390 opt_cmd
[buf_size
++] = ' ';
391 buf_size
= sq_quote(opt_cmd
, buf_size
, argv
[i
++]);
394 if (buf_size
>= sizeof(opt_cmd
))
395 die("command too long");
397 opt_cmd
[buf_size
] = 0;
406 * Line-oriented content detection.
410 /* Line type String to match Foreground Background Attributes
411 * --------- --------------- ---------- ---------- ---------- */ \
413 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
414 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
415 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
416 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
417 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
418 LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
419 LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
420 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
421 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
422 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
423 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
424 /* Pretty print commit header */ \
425 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
426 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
427 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
428 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
429 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
430 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
431 /* Raw commit header */ \
432 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
433 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
434 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
435 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
436 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
438 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
439 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
441 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
442 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
443 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
444 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
445 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
446 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
447 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
448 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
449 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
450 LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
451 LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
454 #define LINE(type, line, fg, bg, attr) \
461 const char *line
; /* The start of line to match. */
462 int linelen
; /* Size of string to match. */
463 int fg
, bg
, attr
; /* Color and text attributes for the lines. */
466 static struct line_info line_info
[] = {
467 #define LINE(type, line, fg, bg, attr) \
468 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
473 static enum line_type
474 get_line_type(char *line
)
476 int linelen
= strlen(line
);
479 for (type
= 0; type
< ARRAY_SIZE(line_info
); type
++)
480 /* Case insensitive search matches Signed-off-by lines better. */
481 if (linelen
>= line_info
[type
].linelen
&&
482 !strncasecmp(line_info
[type
].line
, line
, line_info
[type
].linelen
))
489 get_line_attr(enum line_type type
)
491 assert(type
< ARRAY_SIZE(line_info
));
492 return COLOR_PAIR(type
) | line_info
[type
].attr
;
498 int default_bg
= COLOR_BLACK
;
499 int default_fg
= COLOR_WHITE
;
504 if (use_default_colors() != ERR
) {
509 for (type
= 0; type
< ARRAY_SIZE(line_info
); type
++) {
510 struct line_info
*info
= &line_info
[type
];
511 int bg
= info
->bg
== COLOR_DEFAULT ? default_bg
: info
->bg
;
512 int fg
= info
->fg
== COLOR_DEFAULT ? default_fg
: info
->fg
;
514 init_pair(type
, fg
, bg
);
520 * ENVIRONMENT VARIABLES
521 * ---------------------
522 * Several options related to the interface with git can be configured
523 * via environment options.
525 * Repository references
526 * ~~~~~~~~~~~~~~~~~~~~~
527 * Commits that are referenced by tags and branch heads will be marked
528 * by the reference name surrounded by '[' and ']':
530 * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
532 * If you want to filter out certain directories under `.git/refs/`, say
533 * `tmp` you can do it by setting the following variable:
535 * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
537 * Or set the variable permanently in your environment.
540 * Set command for retrieving all repository references. The command
541 * should output data in the same format as git-ls-remote(1).
544 #define TIG_LS_REMOTE \
545 "git ls-remote . 2>/dev/null"
551 * It is possible to alter which commands are used for the different views.
552 * If for example you prefer commits in the main view to be sorted by date
553 * and only show 500 commits, use:
555 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
557 * Or set the variable permanently in your environment.
559 * Notice, how `%s` is used to specify the commit reference. There can
560 * be a maximum of 5 `%s` ref specifications.
563 * The command used for the diff view. By default, git show is used
567 * The command used for the log view. If you prefer to have both
568 * author and committer shown in the log view be sure to pass
569 * `--pretty=fuller` to git log.
572 * The command used for the main view. Note, you must always specify
573 * the option: `--pretty=raw` since the main view parser expects to
577 #define TIG_DIFF_CMD \
578 "git show --patch-with-stat --find-copies-harder -B -C %s"
580 #define TIG_LOG_CMD \
581 "git log --cc --stat -n100 %s"
583 #define TIG_MAIN_CMD \
584 "git log --topo-order --stat --pretty=raw %s"
586 /* ... silently ignore that the following are also exported. */
588 #define TIG_HELP_CMD \
589 "man tig 2>/dev/null"
591 #define TIG_PAGER_CMD \
598 * The display consists of a status window on the last line of the screen and
599 * one or more views. The default is to only show one view at the time but it
600 * is possible to split both the main and log view to also show the commit
603 * If you are in the log view and press 'Enter' when the current line is a
604 * commit line, such as:
606 * commit 4d55caff4cc89335192f3e566004b4ceef572521
608 * You will split the view so that the log view is displayed in the top window
609 * and the diff view in the bottom window. You can switch between the two
610 * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
615 /* The display array of active views and the index of the current view. */
616 static struct view
*display
[2];
617 static unsigned int current_view
;
619 #define foreach_view(view, i) \
620 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
624 * Current head and commit ID
625 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
626 * The viewer keeps track of both what head and commit ID you are currently
627 * viewing. The commit ID will follow the cursor line and change everytime time
628 * you highlight a different commit. Whenever you reopen the diff view it
629 * will be reloaded, if the commit ID changed.
631 * The head ID is used when opening the main and log view to indicate from
632 * what revision to show history.
635 static char ref_commit
[SIZEOF_REF
] = "HEAD";
636 static char ref_head
[SIZEOF_REF
] = "HEAD";
640 const char *name
; /* View name */
641 const char *cmd_fmt
; /* Default command line format */
642 const char *cmd_env
; /* Command line set via environment */
643 const char *id
; /* Points to either of ref_{head,commit} */
644 size_t objsize
; /* Size of objects in the line index */
647 /* What type of content being displayed. Used in the
650 /* Draw one line; @lineno must be < view->height. */
651 bool (*draw
)(struct view
*view
, unsigned int lineno
);
652 /* Read one line; updates view->line. */
653 bool (*read
)(struct view
*view
, char *line
);
654 /* Depending on view, change display based on current line. */
655 bool (*enter
)(struct view
*view
);
658 char cmd
[SIZEOF_CMD
]; /* Command buffer */
659 char ref
[SIZEOF_REF
]; /* Hovered commit reference */
660 char vid
[SIZEOF_REF
]; /* View ID. Set to id member when updating. */
662 int height
, width
; /* The width and height of the main window */
663 WINDOW
*win
; /* The main window */
664 WINDOW
*title
; /* The title window living below the main window */
667 unsigned long offset
; /* Offset of the window top */
668 unsigned long lineno
; /* Current line number */
671 unsigned long lines
; /* Total number of lines */
672 void **line
; /* Line index; each line contains user data */
673 unsigned int digits
; /* Number of digits in the lines member. */
680 static struct view_ops pager_ops
;
681 static struct view_ops main_ops
;
683 #define VIEW_STR(name, cmd, env, ref, objsize, ops) \
684 { name, cmd, #env, ref, objsize, ops }
686 #define VIEW_(id, name, ops, ref, objsize) \
687 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, objsize, ops)
692 * tig(1) presents various 'views' of a repository. Each view is based on output
693 * from an external command, most often 'git log', 'git diff', or 'git show'.
696 * Is the default view, and it shows a one line summary of each commit
697 * in the chosen list of revisions. The summary includes commit date,
698 * author, and the first line of the log message. Additionally, any
699 * repository references, such as tags, will be shown.
702 * Presents a more rich view of the revision log showing the whole log
703 * message and the diffstat.
706 * Shows either the diff of the current working tree, that is, what
707 * has changed since the last commit, or the commit diff complete
708 * with log message, diffstat and diff.
711 * Is used for displaying both input from stdin and output from git
712 * commands entered in the internal prompt.
715 * Displays the information from the tig(1) man page. For the help view
716 * to work you need to have the tig(1) man page installed.
719 static struct view views
[] = {
720 VIEW_(MAIN
, "main", &main_ops
, ref_head
, sizeof(struct commit
)),
721 VIEW_(DIFF
, "diff", &pager_ops
, ref_commit
, sizeof(char)),
722 VIEW_(LOG
, "log", &pager_ops
, ref_head
, sizeof(char)),
723 VIEW_(HELP
, "help", &pager_ops
, "static", sizeof(char)),
724 VIEW_(PAGER
, "pager", &pager_ops
, "static", sizeof(char)),
727 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
731 redraw_view_from(struct view
*view
, int lineno
)
733 assert(0 <= lineno
&& lineno
< view
->height
);
735 for (; lineno
< view
->height
; lineno
++) {
736 if (!view
->ops
->draw(view
, lineno
))
740 redrawwin(view
->win
);
745 redraw_view(struct view
*view
)
748 redraw_view_from(view
, 0);
755 * Each view has a title window which shows the name of the view, current
756 * commit ID if available, and where the view is positioned:
758 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
760 * By default, the title of the current view is highlighted using bold font.
764 update_view_title(struct view
*view
)
766 if (view
== display
[current_view
])
767 wbkgdset(view
->title
, get_line_attr(LINE_TITLE_FOCUS
));
769 wbkgdset(view
->title
, get_line_attr(LINE_TITLE_BLUR
));
772 wmove(view
->title
, 0, 0);
775 wprintw(view
->title
, "[%s] %s", view
->name
, view
->ref
);
777 wprintw(view
->title
, "[%s]", view
->name
);
780 wprintw(view
->title
, " - %s %d of %d (%d%%)",
784 (view
->lineno
+ 1) * 100 / view
->lines
);
787 wrefresh(view
->title
);
794 struct view
*base
= display
[0];
795 struct view
*view
= display
[1] ? display
[1] : display
[0];
797 /* Setup window dimensions */
799 getmaxyx(stdscr
, base
->height
, base
->width
);
801 /* Make room for the status window. */
805 /* Horizontal split. */
806 view
->width
= base
->width
;
807 view
->height
= SCALE_SPLIT_VIEW(base
->height
);
808 base
->height
-= view
->height
;
810 /* Make room for the title bar. */
814 /* Make room for the title bar. */
819 foreach_view (view
, i
) {
820 /* Keep the height of all view->win windows one larger than is
821 * required so that the cursor can wrap-around on the last line
822 * without scrolling the window. */
824 view
->win
= newwin(view
->height
+ 1, 0, offset
, 0);
826 die("Failed to create %s view", view
->name
);
828 scrollok(view
->win
, TRUE
);
830 view
->title
= newwin(1, 0, offset
+ view
->height
, 0);
832 die("Failed to create title window");
835 wresize(view
->win
, view
->height
+ 1, view
->width
);
836 mvwin(view
->win
, offset
, 0);
837 mvwin(view
->title
, offset
+ view
->height
, 0);
841 offset
+= view
->height
+ 1;
851 foreach_view (view
, i
) {
853 update_view_title(view
);
862 /* Scrolling backend */
864 do_scroll_view(struct view
*view
, int lines
)
866 /* The rendering expects the new offset. */
867 view
->offset
+= lines
;
869 assert(0 <= view
->offset
&& view
->offset
< view
->lines
);
872 /* Redraw the whole screen if scrolling is pointless. */
873 if (view
->height
< ABS(lines
)) {
877 int line
= lines
> 0 ? view
->height
- lines
: 0;
878 int end
= line
+ ABS(lines
);
880 wscrl(view
->win
, lines
);
882 for (; line
< end
; line
++) {
883 if (!view
->ops
->draw(view
, line
))
888 /* Move current line into the view. */
889 if (view
->lineno
< view
->offset
) {
890 view
->lineno
= view
->offset
;
891 view
->ops
->draw(view
, 0);
893 } else if (view
->lineno
>= view
->offset
+ view
->height
) {
894 if (view
->lineno
== view
->offset
+ view
->height
) {
895 /* Clear the hidden line so it doesn't show if the view
897 wmove(view
->win
, view
->height
, 0);
898 wclrtoeol(view
->win
);
900 view
->lineno
= view
->offset
+ view
->height
- 1;
901 view
->ops
->draw(view
, view
->lineno
- view
->offset
);
904 assert(view
->offset
<= view
->lineno
&& view
->lineno
< view
->lines
);
906 redrawwin(view
->win
);
911 /* Scroll frontend */
913 scroll_view(struct view
*view
, enum request request
)
918 case REQ_SCROLL_PAGE_DOWN
:
919 lines
= view
->height
;
920 case REQ_SCROLL_LINE_DOWN
:
921 if (view
->offset
+ lines
> view
->lines
)
922 lines
= view
->lines
- view
->offset
;
924 if (lines
== 0 || view
->offset
+ view
->height
>= view
->lines
) {
925 report("Cannot scroll beyond the last line");
930 case REQ_SCROLL_PAGE_UP
:
931 lines
= view
->height
;
932 case REQ_SCROLL_LINE_UP
:
933 if (lines
> view
->offset
)
934 lines
= view
->offset
;
937 report("Cannot scroll beyond the first line");
945 die("request %d not handled in switch", request
);
948 do_scroll_view(view
, lines
);
953 move_view(struct view
*view
, enum request request
)
958 case REQ_MOVE_FIRST_LINE
:
959 steps
= -view
->lineno
;
962 case REQ_MOVE_LAST_LINE
:
963 steps
= view
->lines
- view
->lineno
- 1;
966 case REQ_MOVE_PAGE_UP
:
967 steps
= view
->height
> view
->lineno
968 ?
-view
->lineno
: -view
->height
;
971 case REQ_MOVE_PAGE_DOWN
:
972 steps
= view
->lineno
+ view
->height
>= view
->lines
973 ? view
->lines
- view
->lineno
- 1 : view
->height
;
977 case REQ_MOVE_UP_ENTER
:
982 case REQ_MOVE_DOWN_ENTER
:
987 die("request %d not handled in switch", request
);
990 if (steps
<= 0 && view
->lineno
== 0) {
991 report("Cannot move beyond the first line");
994 } else if (steps
>= 0 && view
->lineno
+ 1 >= view
->lines
) {
995 report("Cannot move beyond the last line");
999 /* Move the current line */
1000 view
->lineno
+= steps
;
1001 assert(0 <= view
->lineno
&& view
->lineno
< view
->lines
);
1003 /* Repaint the old "current" line if we be scrolling */
1004 if (ABS(steps
) < view
->height
) {
1005 int prev_lineno
= view
->lineno
- steps
- view
->offset
;
1007 wmove(view
->win
, prev_lineno
, 0);
1008 wclrtoeol(view
->win
);
1009 view
->ops
->draw(view
, prev_lineno
);
1012 /* Check whether the view needs to be scrolled */
1013 if (view
->lineno
< view
->offset
||
1014 view
->lineno
>= view
->offset
+ view
->height
) {
1015 if (steps
< 0 && -steps
> view
->offset
) {
1016 steps
= -view
->offset
;
1018 } else if (steps
> 0) {
1019 if (view
->lineno
== view
->lines
- 1 &&
1020 view
->lines
> view
->height
) {
1021 steps
= view
->lines
- view
->offset
- 1;
1022 if (steps
>= view
->height
)
1023 steps
-= view
->height
- 1;
1027 do_scroll_view(view
, steps
);
1031 /* Draw the current line */
1032 view
->ops
->draw(view
, view
->lineno
- view
->offset
);
1034 redrawwin(view
->win
);
1035 wrefresh(view
->win
);
1041 * Incremental updating
1045 begin_update(struct view
*view
)
1047 const char *id
= view
->id
;
1050 string_copy(view
->cmd
, opt_cmd
);
1052 /* When running random commands, the view ref could have become
1053 * invalid so clear it. */
1056 const char *format
= view
->cmd_env ? view
->cmd_env
: view
->cmd_fmt
;
1058 if (snprintf(view
->cmd
, sizeof(view
->cmd
), format
,
1059 id
, id
, id
, id
, id
) >= sizeof(view
->cmd
))
1063 /* Special case for the pager view. */
1065 view
->pipe
= opt_pipe
;
1068 view
->pipe
= popen(view
->cmd
, "r");
1074 set_nonblocking_input(TRUE
);
1079 string_copy(view
->vid
, id
);
1084 for (i
= 0; i
< view
->lines
; i
++)
1086 free(view
->line
[i
]);
1092 view
->start_time
= time(NULL
);
1098 end_update(struct view
*view
)
1102 set_nonblocking_input(FALSE
);
1103 if (view
->pipe
== stdin
)
1111 update_view(struct view
*view
)
1113 char buffer
[BUFSIZ
];
1116 /* The number of lines to read. If too low it will cause too much
1117 * redrawing (and possible flickering), if too high responsiveness
1119 unsigned long lines
= view
->height
;
1120 int redraw_from
= -1;
1125 /* Only redraw if lines are visible. */
1126 if (view
->offset
+ view
->height
>= view
->lines
)
1127 redraw_from
= view
->lines
- view
->offset
;
1129 tmp
= realloc(view
->line
, sizeof(*view
->line
) * (view
->lines
+ lines
));
1135 while ((line
= fgets(buffer
, sizeof(buffer
), view
->pipe
))) {
1136 int linelen
= strlen(line
);
1139 line
[linelen
- 1] = 0;
1141 if (!view
->ops
->read(view
, line
))
1151 lines
= view
->lines
;
1152 for (digits
= 0; lines
; digits
++)
1155 /* Keep the displayed view in sync with line number scaling. */
1156 if (digits
!= view
->digits
) {
1157 view
->digits
= digits
;
1162 if (redraw_from
>= 0) {
1163 /* If this is an incremental update, redraw the previous line
1164 * since for commits some members could have changed when
1165 * loading the main view. */
1166 if (redraw_from
> 0)
1169 /* Incrementally draw avoids flickering. */
1170 redraw_view_from(view
, redraw_from
);
1173 /* Update the title _after_ the redraw so that if the redraw picks up a
1174 * commit reference in view->ref it'll be available here. */
1175 update_view_title(view
);
1177 if (ferror(view
->pipe
)) {
1178 report("Failed to read: %s", strerror(errno
));
1181 } else if (feof(view
->pipe
)) {
1182 time_t secs
= time(NULL
) - view
->start_time
;
1184 if (view
== VIEW(REQ_VIEW_HELP
)) {
1185 const char *msg
= TIG_HELP
;
1187 if (view
->lines
== 0) {
1188 /* Slightly ugly, but abusing view->ref keeps
1189 * the error message. */
1190 string_copy(view
->ref
, "No help available");
1191 msg
= "The tig(1) manpage is not installed";
1198 report("Loaded %d lines in %ld second%s", view
->lines
, secs
,
1199 secs
== 1 ?
"" : "s");
1206 report("Allocation failure");
1214 OPEN_DEFAULT
= 0, /* Use default view switching. */
1215 OPEN_SPLIT
= 1, /* Split current view. */
1216 OPEN_BACKGROUNDED
= 2, /* Backgrounded. */
1217 OPEN_RELOAD
= 4, /* Reload view even if it is the current. */
1221 open_view(struct view
*prev
, enum request request
, enum open_flags flags
)
1223 bool backgrounded
= !!(flags
& OPEN_BACKGROUNDED
);
1224 bool split
= !!(flags
& OPEN_SPLIT
);
1225 bool reload
= !!(flags
& OPEN_RELOAD
);
1226 struct view
*view
= VIEW(request
);
1227 struct view
*displayed
;
1230 /* Cycle between displayed views and count the views. */
1231 foreach_view (displayed
, nviews
) {
1233 view
== displayed
&&
1234 !strcmp(view
->vid
, prev
->vid
)) {
1235 current_view
= nviews
;
1236 /* Blur out the title of the previous view. */
1237 update_view_title(prev
);
1243 if (view
== prev
&& nviews
== 1 && !reload
) {
1244 report("Already in %s view", view
->name
);
1248 if ((reload
|| strcmp(view
->vid
, view
->id
)) &&
1249 !begin_update(view
)) {
1250 report("Failed to load %s view", view
->name
);
1255 display
[current_view
+ 1] = view
;
1259 /* Maximize the current view. */
1260 memset(display
, 0, sizeof(display
));
1262 display
[current_view
] = view
;
1267 if (split
&& prev
->lineno
- prev
->offset
>= prev
->height
) {
1268 /* Take the title line into account. */
1269 int lines
= prev
->lineno
- prev
->offset
- prev
->height
+ 1;
1271 /* Scroll the view that was split if the current line is
1272 * outside the new limited view. */
1273 do_scroll_view(prev
, lines
);
1276 if (prev
&& view
!= prev
) {
1277 /* "Blur" the previous view. */
1279 update_view_title(prev
);
1281 /* Continue loading split views in the background. */
1287 /* Clear the old view and let the incremental updating refill
1290 report("Loading...");
1293 if (view
== VIEW(REQ_VIEW_HELP
))
1294 report("%s", TIG_HELP
);
1299 /* If the view is backgrounded the above calls to report()
1300 * won't redraw the view title. */
1302 update_view_title(view
);
1307 * User request switch noodle
1311 view_driver(struct view
*view
, enum request request
)
1318 case REQ_MOVE_PAGE_UP
:
1319 case REQ_MOVE_PAGE_DOWN
:
1320 case REQ_MOVE_FIRST_LINE
:
1321 case REQ_MOVE_LAST_LINE
:
1322 move_view(view
, request
);
1325 case REQ_SCROLL_LINE_DOWN
:
1326 case REQ_SCROLL_LINE_UP
:
1327 case REQ_SCROLL_PAGE_DOWN
:
1328 case REQ_SCROLL_PAGE_UP
:
1329 scroll_view(view
, request
);
1336 case REQ_VIEW_PAGER
:
1337 open_view(view
, request
, OPEN_DEFAULT
);
1340 case REQ_MOVE_UP_ENTER
:
1341 case REQ_MOVE_DOWN_ENTER
:
1342 move_view(view
, request
);
1347 report("Nothing to enter");
1350 return view
->ops
->enter(view
);
1354 int nviews
= display
[1] ?
2 : 1;
1355 int next_view
= (current_view
+ 1) % nviews
;
1357 if (next_view
== current_view
) {
1358 report("Only one view is displayed");
1362 current_view
= next_view
;
1363 /* Blur out the title of the previous view. */
1364 update_view_title(view
);
1368 case REQ_TOGGLE_LINE_NUMBERS
:
1369 opt_line_number
= !opt_line_number
;
1374 /* Always reload^Wrerun commands from the prompt. */
1375 open_view(view
, opt_request
, OPEN_RELOAD
);
1378 case REQ_STOP_LOADING
:
1379 foreach_view (view
, i
) {
1381 report("Stopped loaded the %s view", view
->name
),
1386 case REQ_SHOW_VERSION
:
1387 report("Version: %s", VERSION
);
1390 case REQ_SCREEN_RESIZE
:
1393 case REQ_SCREEN_REDRAW
:
1397 case REQ_SCREEN_UPDATE
:
1405 /* An unknown key will show most commonly used commands. */
1406 report("Unknown key, press 'h' for help");
1415 * View backend handlers
1419 pager_draw(struct view
*view
, unsigned int lineno
)
1421 enum line_type type
;
1426 if (view
->offset
+ lineno
>= view
->lines
)
1429 line
= view
->line
[view
->offset
+ lineno
];
1430 type
= get_line_type(line
);
1432 wmove(view
->win
, lineno
, 0);
1434 if (view
->offset
+ lineno
== view
->lineno
) {
1435 if (type
== LINE_COMMIT
) {
1436 string_copy(view
->ref
, line
+ 7);
1437 string_copy(ref_commit
, view
->ref
);
1441 wchgat(view
->win
, -1, 0, type
, NULL
);
1444 attr
= get_line_attr(type
);
1445 wattrset(view
->win
, attr
);
1447 linelen
= strlen(line
);
1449 if (opt_line_number
|| opt_tab_size
< TABSIZE
) {
1450 static char spaces
[] = " ";
1451 int col_offset
= 0, col
= 0;
1453 if (opt_line_number
) {
1454 unsigned long real_lineno
= view
->offset
+ lineno
+ 1;
1456 if (real_lineno
== 1 ||
1457 (real_lineno
% opt_num_interval
) == 0) {
1458 wprintw(view
->win
, "%.*d", view
->digits
, real_lineno
);
1461 waddnstr(view
->win
, spaces
,
1462 MIN(view
->digits
, STRING_SIZE(spaces
)));
1464 waddstr(view
->win
, ": ");
1465 col_offset
= view
->digits
+ 2;
1468 while (line
&& col_offset
+ col
< view
->width
) {
1469 int cols_max
= view
->width
- col_offset
- col
;
1473 if (*line
== '\t') {
1474 assert(sizeof(spaces
) > TABSIZE
);
1477 cols
= opt_tab_size
- (col
% opt_tab_size
);
1480 line
= strchr(line
, '\t');
1481 cols
= line ? line
- text
: strlen(text
);
1484 waddnstr(view
->win
, text
, MIN(cols
, cols_max
));
1489 int col
= 0, pos
= 0;
1491 for (; pos
< linelen
&& col
< view
->width
; pos
++, col
++)
1492 if (line
[pos
] == '\t')
1493 col
+= TABSIZE
- (col
% TABSIZE
) - 1;
1495 waddnstr(view
->win
, line
, pos
);
1502 pager_read(struct view
*view
, char *line
)
1504 /* Compress empty lines in the help view. */
1505 if (view
== VIEW(REQ_VIEW_HELP
) &&
1508 !*((char *) view
->line
[view
->lines
- 1]))
1511 view
->line
[view
->lines
] = strdup(line
);
1512 if (!view
->line
[view
->lines
])
1520 pager_enter(struct view
*view
)
1522 char *line
= view
->line
[view
->lineno
];
1524 if (view
== VIEW(REQ_VIEW_DIFF
)) {
1525 scroll_view(view
, REQ_SCROLL_LINE_DOWN
);
1529 if (get_line_type(line
) == LINE_COMMIT
) {
1530 if (view
== VIEW(REQ_VIEW_LOG
))
1531 open_view(view
, REQ_VIEW_DIFF
, OPEN_SPLIT
| OPEN_BACKGROUNDED
);
1533 open_view(view
, REQ_VIEW_DIFF
, OPEN_DEFAULT
);
1539 static struct view_ops pager_ops
= {
1547 static struct ref
**get_refs(char *id
);
1550 main_draw(struct view
*view
, unsigned int lineno
)
1552 char buf
[DATE_COLS
+ 1];
1553 struct commit
*commit
;
1554 enum line_type type
;
1558 if (view
->offset
+ lineno
>= view
->lines
)
1561 commit
= view
->line
[view
->offset
+ lineno
];
1562 if (!*commit
->author
)
1565 wmove(view
->win
, lineno
, col
);
1567 if (view
->offset
+ lineno
== view
->lineno
) {
1568 string_copy(view
->ref
, commit
->id
);
1569 string_copy(ref_commit
, view
->ref
);
1571 wattrset(view
->win
, get_line_attr(type
));
1572 wchgat(view
->win
, -1, 0, type
, NULL
);
1575 type
= LINE_MAIN_COMMIT
;
1576 wattrset(view
->win
, get_line_attr(LINE_MAIN_DATE
));
1579 timelen
= strftime(buf
, sizeof(buf
), DATE_FORMAT
, &commit
->time
);
1580 waddnstr(view
->win
, buf
, timelen
);
1581 waddstr(view
->win
, " ");
1584 wmove(view
->win
, lineno
, col
);
1585 if (type
!= LINE_CURSOR
)
1586 wattrset(view
->win
, get_line_attr(LINE_MAIN_AUTHOR
));
1588 if (strlen(commit
->author
) > 19) {
1589 waddnstr(view
->win
, commit
->author
, 18);
1590 if (type
!= LINE_CURSOR
)
1591 wattrset(view
->win
, get_line_attr(LINE_MAIN_DELIM
));
1592 waddch(view
->win
, '~');
1594 waddstr(view
->win
, commit
->author
);
1598 if (type
!= LINE_CURSOR
)
1599 wattrset(view
->win
, A_NORMAL
);
1601 mvwaddch(view
->win
, lineno
, col
, ACS_LTEE
);
1602 wmove(view
->win
, lineno
, col
+ 2);
1609 if (type
== LINE_CURSOR
)
1611 else if (commit
->refs
[i
]->tag
)
1612 wattrset(view
->win
, get_line_attr(LINE_MAIN_TAG
));
1614 wattrset(view
->win
, get_line_attr(LINE_MAIN_REF
));
1615 waddstr(view
->win
, "[");
1616 waddstr(view
->win
, commit
->refs
[i
]->name
);
1617 waddstr(view
->win
, "]");
1618 if (type
!= LINE_CURSOR
)
1619 wattrset(view
->win
, A_NORMAL
);
1620 waddstr(view
->win
, " ");
1621 col
+= strlen(commit
->refs
[i
]->name
) + STRING_SIZE("[] ");
1622 } while (commit
->refs
[i
++]->next
);
1625 if (type
!= LINE_CURSOR
)
1626 wattrset(view
->win
, get_line_attr(type
));
1629 int titlelen
= strlen(commit
->title
);
1631 if (col
+ titlelen
> view
->width
)
1632 titlelen
= view
->width
- col
;
1634 waddnstr(view
->win
, commit
->title
, titlelen
);
1640 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1642 main_read(struct view
*view
, char *line
)
1644 enum line_type type
= get_line_type(line
);
1645 struct commit
*commit
;
1649 commit
= calloc(1, sizeof(struct commit
));
1653 line
+= STRING_SIZE("commit ");
1655 view
->line
[view
->lines
++] = commit
;
1656 string_copy(commit
->id
, line
);
1657 commit
->refs
= get_refs(commit
->id
);
1662 char *ident
= line
+ STRING_SIZE("author ");
1663 char *end
= strchr(ident
, '<');
1666 for (; end
> ident
&& isspace(end
[-1]); end
--) ;
1670 commit
= view
->line
[view
->lines
- 1];
1671 string_copy(commit
->author
, ident
);
1673 /* Parse epoch and timezone */
1675 char *secs
= strchr(end
+ 1, '>');
1679 if (!secs
|| secs
[1] != ' ')
1683 time
= (time_t) atol(secs
);
1684 zone
= strchr(secs
, ' ');
1685 if (zone
&& strlen(zone
) == STRING_SIZE(" +0700")) {
1689 tz
= ('0' - zone
[1]) * 60 * 60 * 10;
1690 tz
+= ('0' - zone
[2]) * 60 * 60;
1691 tz
+= ('0' - zone
[3]) * 60;
1692 tz
+= ('0' - zone
[4]) * 60;
1699 gmtime_r(&time
, &commit
->time
);
1704 /* We should only ever end up here if there has already been a
1705 * commit line, however, be safe. */
1706 if (view
->lines
== 0)
1709 /* Fill in the commit title if it has not already been set. */
1710 commit
= view
->line
[view
->lines
- 1];
1711 if (commit
->title
[0])
1714 /* Require titles to start with a non-space character at the
1715 * offset used by git log. */
1716 /* FIXME: More gracefull handling of titles; append "..." to
1717 * shortened titles, etc. */
1718 if (strncmp(line
, " ", 4) ||
1722 string_copy(commit
->title
, line
+ 4);
1729 main_enter(struct view
*view
)
1731 open_view(view
, REQ_VIEW_DIFF
, OPEN_SPLIT
| OPEN_BACKGROUNDED
);
1735 static struct view_ops main_ops
= {
1746 * Below the default key bindings are shown.
1754 static struct keymap keymap
[] = {
1759 * Switch to main view.
1761 * Switch to diff view.
1763 * Switch to log view.
1765 * Switch to pager view.
1769 * This key is "context sensitive" depending on what view you are
1770 * currently in. When in log view on a commit line or in the main
1771 * view, split the view and show the commit diff. In the diff view
1772 * pressing Enter will simply scroll the view one line down.
1774 * Switch to next view.
1776 { 'm', REQ_VIEW_MAIN
},
1777 { 'd', REQ_VIEW_DIFF
},
1778 { 'l', REQ_VIEW_LOG
},
1779 { 'p', REQ_VIEW_PAGER
},
1780 { 'h', REQ_VIEW_HELP
},
1782 { KEY_TAB
, REQ_VIEW_NEXT
},
1783 { KEY_RETURN
, REQ_ENTER
},
1789 * Move cursor one line up.
1791 * Move cursor one line down.
1793 * Move cursor one line up and enter. When used in the main view
1794 * this will always show the diff of the current commit in the
1797 * Move cursor one line down and enter.
1800 * Move cursor one page up.
1803 * Move cursor one page down.
1805 * Jump to first line.
1807 * Jump to last line.
1809 { KEY_UP
, REQ_MOVE_UP
},
1810 { KEY_DOWN
, REQ_MOVE_DOWN
},
1811 { 'k', REQ_MOVE_UP_ENTER
},
1812 { 'j', REQ_MOVE_DOWN_ENTER
},
1813 { KEY_HOME
, REQ_MOVE_FIRST_LINE
},
1814 { KEY_END
, REQ_MOVE_LAST_LINE
},
1815 { KEY_NPAGE
, REQ_MOVE_PAGE_DOWN
},
1816 { ' ', REQ_MOVE_PAGE_DOWN
},
1817 { KEY_PPAGE
, REQ_MOVE_PAGE_UP
},
1818 { 'b', REQ_MOVE_PAGE_UP
},
1824 * Scroll view one line up.
1826 * Scroll view one line down.
1828 * Scroll view one page up.
1830 * Scroll view one page down.
1832 { KEY_IC
, REQ_SCROLL_LINE_UP
},
1833 { KEY_DC
, REQ_SCROLL_LINE_DOWN
},
1834 { 'w', REQ_SCROLL_PAGE_UP
},
1835 { 's', REQ_SCROLL_PAGE_DOWN
},
1845 * Stop all background loading. This can be useful if you use
1846 * tig(1) in a repository with a long history without limiting
1851 * Toggle line numbers on/off.
1853 * Open prompt. This allows you to specify what git command
1859 { 'z', REQ_STOP_LOADING
},
1860 { 'v', REQ_SHOW_VERSION
},
1861 { 'r', REQ_SCREEN_REDRAW
},
1862 { 'n', REQ_TOGGLE_LINE_NUMBERS
},
1863 { ':', REQ_PROMPT
},
1865 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
1866 { ERR
, REQ_SCREEN_UPDATE
},
1868 /* Use the ncurses SIGWINCH handler. */
1869 { KEY_RESIZE
, REQ_SCREEN_RESIZE
},
1873 get_request(int key
)
1877 for (i
= 0; i
< ARRAY_SIZE(keymap
); i
++)
1878 if (keymap
[i
].alias
== key
)
1879 return keymap
[i
].request
;
1881 return (enum request
) key
;
1889 /* Whether or not the curses interface has been initialized. */
1890 bool cursed
= FALSE
;
1892 /* The status window is used for polling keystrokes. */
1893 static WINDOW
*status_win
;
1895 /* Update status and title window. */
1897 report(const char *msg
, ...)
1899 static bool empty
= TRUE
;
1900 struct view
*view
= display
[current_view
];
1902 if (!empty
|| *msg
) {
1905 va_start(args
, msg
);
1908 wmove(status_win
, 0, 0);
1910 vwprintw(status_win
, msg
, args
);
1915 wrefresh(status_win
);
1920 update_view_title(view
);
1922 /* Move the cursor to the right-most column of the cursor line.
1924 * XXX: This could turn out to be a bit expensive, but it ensures that
1925 * the cursor does not jump around. */
1927 wmove(view
->win
, view
->lineno
- view
->offset
, view
->width
- 1);
1928 wrefresh(view
->win
);
1932 /* Controls when nodelay should be in effect when polling user input. */
1934 set_nonblocking_input(bool loading
)
1936 static unsigned int loading_views
;
1938 if ((loading
== FALSE
&& loading_views
-- == 1) ||
1939 (loading
== TRUE
&& loading_views
++ == 0))
1940 nodelay(status_win
, loading
);
1948 /* Initialize the curses library */
1949 if (isatty(STDIN_FILENO
)) {
1950 cursed
= !!initscr();
1952 /* Leave stdin and stdout alone when acting as a pager. */
1953 FILE *io
= fopen("/dev/tty", "r+");
1955 cursed
= !!newterm(NULL
, io
, io
);
1959 die("Failed to initialize curses");
1961 nonl(); /* Tell curses not to do NL->CR/NL on output */
1962 cbreak(); /* Take input chars one at a time, no wait for \n */
1963 noecho(); /* Don't echo input */
1964 leaveok(stdscr
, TRUE
);
1969 getmaxyx(stdscr
, y
, x
);
1970 status_win
= newwin(1, 0, y
- 1, 0);
1972 die("Failed to create status window");
1974 /* Enable keyboard mapping */
1975 keypad(status_win
, TRUE
);
1976 wbkgdset(status_win
, get_line_attr(LINE_STATUS
));
1981 * Repository references
1984 static struct ref
*refs
;
1985 static size_t refs_size
;
1987 static struct ref
**
1990 struct ref
**id_refs
= NULL
;
1991 size_t id_refs_size
= 0;
1994 for (i
= 0; i
< refs_size
; i
++) {
1997 if (strcmp(id
, refs
[i
].id
))
2000 tmp
= realloc(id_refs
, (id_refs_size
+ 1) * sizeof(*id_refs
));
2008 if (id_refs_size
> 0)
2009 id_refs
[id_refs_size
- 1]->next
= 1;
2010 id_refs
[id_refs_size
] = &refs
[i
];
2012 /* XXX: The properties of the commit chains ensures that we can
2013 * safely modify the shared ref. The repo references will
2014 * always be similar for the same id. */
2015 id_refs
[id_refs_size
]->next
= 0;
2025 const char *cmd_env
= getenv("TIG_LS_REMOTE");
2026 const char *cmd
= cmd_env
&& *cmd_env ? cmd_env
: TIG_LS_REMOTE
;
2027 FILE *pipe
= popen(cmd
, "r");
2028 char buffer
[BUFSIZ
];
2034 while ((line
= fgets(buffer
, sizeof(buffer
), pipe
))) {
2035 char *name
= strchr(line
, '\t');
2039 bool tag_commit
= FALSE
;
2045 namelen
= strlen(name
) - 1;
2047 /* Commits referenced by tags has "^{}" appended. */
2048 if (name
[namelen
- 1] == '}') {
2049 while (namelen
> 0 && name
[namelen
] != '^')
2056 if (!strncmp(name
, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2059 name
+= STRING_SIZE("refs/tags/");
2062 } else if (!strncmp(name
, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2063 name
+= STRING_SIZE("refs/heads/");
2065 } else if (!strcmp(name
, "HEAD")) {
2069 refs
= realloc(refs
, sizeof(*refs
) * (refs_size
+ 1));
2073 ref
= &refs
[refs_size
++];
2075 ref
->name
= strdup(name
);
2079 string_copy(ref
->id
, line
);
2088 die("Not a git repository");
2098 #define __NORETURN __attribute__((__noreturn__))
2103 static void __NORETURN
2106 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2112 static void __NORETURN
2113 die(const char *err
, ...)
2119 va_start(args
, err
);
2120 fputs("tig: ", stderr
);
2121 vfprintf(stderr
, err
, args
);
2122 fputs("\n", stderr
);
2129 main(int argc
, char *argv
[])
2132 enum request request
;
2135 signal(SIGINT
, quit
);
2137 if (!parse_options(argc
, argv
))
2140 if (load_refs() == ERR
)
2141 die("Failed to load refs.");
2143 for (i
= 0; i
< ARRAY_SIZE(views
) && (view
= &views
[i
]); i
++)
2144 view
->cmd_env
= getenv(view
->cmd_env
);
2146 request
= opt_request
;
2150 while (view_driver(display
[current_view
], request
)) {
2154 foreach_view (view
, i
)
2157 /* Refresh, accept single keystroke of input */
2158 key
= wgetch(status_win
);
2159 request
= get_request(key
);
2161 /* Some low-level request handling. This keeps access to
2162 * status_win restricted. */
2166 /* Temporarily switch to line-oriented and echoed
2171 if (wgetnstr(status_win
, opt_cmd
+ 4, sizeof(opt_cmd
) - 4) == OK
) {
2172 memcpy(opt_cmd
, "git ", 4);
2173 opt_request
= REQ_VIEW_PAGER
;
2182 case REQ_SCREEN_RESIZE
:
2186 getmaxyx(stdscr
, height
, width
);
2188 /* Resize the status view and let the view driver take
2189 * care of resizing the displayed views. */
2190 wresize(status_win
, 1, width
);
2191 mvwin(status_win
, height
- 1, 0);
2192 wrefresh(status_win
);
2207 * Revision specification
2208 * ----------------------
2209 * This section describes various ways to specify what revisions to display
2210 * or otherwise limit the view to. tig(1) does not itself parse the described
2211 * revision options so refer to the relevant git man pages for futher
2212 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2215 * You can tune the interaction with git by making use of the options
2216 * explained in this section. For example, by configuring the environment
2217 * variables described in the <<view-commands, "View commands">> section.
2219 * Limit by path name
2220 * ~~~~~~~~~~~~~~~~~~
2221 * If you are interested only in those revisions that made changes to a
2222 * specific file (or even several files) list the files like this:
2224 * $ tig log Makefile README
2226 * To avoid ambiguity with repository references such as tag name, be sure
2227 * to separate file names from other git options using "\--". So if you
2228 * have a file named 'master' it will clash with the reference named
2229 * 'master', and thus you will have to use:
2231 * $ tig log -- master
2233 * NOTE: For the main view, avoiding ambiguity will in some cases require
2234 * you to specify two "\--" options. The first will make tig(1) stop
2235 * option processing and the latter will be passed to git log.
2237 * Limit by date or number
2238 * ~~~~~~~~~~~~~~~~~~~~~~~
2239 * To speed up interaction with git, you can limit the amount of commits
2240 * to show both for the log and main view. Either limit by date using
2241 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2243 * If you are only interested in changed that happened between two dates
2246 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2248 * NOTE: If you want to avoid having to quote dates containing spaces you
2249 * can use "." instead, e.g. `--after=May.5th`.
2251 * Limiting by commit ranges
2252 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2253 * Alternatively, commits can be limited to a specific range, such as
2254 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2256 * $ tig log tag-1.0..tag-2.0
2258 * This way of commit limiting makes it trivial to only browse the commits
2259 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2260 * upstream remote branch, using:
2262 * $ tig log origin..HEAD
2264 * will list what will be pushed to the remote branch. Optionally, the ending
2265 * 'HEAD' can be left out since it is implied.
2267 * Limiting by reachability
2268 * ~~~~~~~~~~~~~~~~~~~~~~~~
2269 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2270 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2271 * Where reachability refers to what commits are ancestors (or part of the
2272 * history) of the branch or tagged revision in question.
2274 * If you prefer to specify which commit to preview in this way use the
2277 * $ tig log tag-2.0 ^tag-1.0
2279 * You can think of '^' as a negation operator. Using this alternate syntax,
2280 * it is possible to further prune commits by specifying multiple branch
2283 * Combining revisions specification
2284 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2285 * Revisions options can to some degree be combined, which makes it possible
2286 * to say "show at most 20 commits from within the last month that changed
2287 * files under the Documentation/ directory."
2289 * $ tig -- --since=1.month -n20 -- Documentation/
2291 * Examining all repository references
2292 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2293 * In some cases, it can be useful to query changes across all references
2294 * in a repository. An example is to ask "did any line of development in
2295 * this repository change a particular file within the last week". This
2296 * can be accomplished using:
2298 * $ tig -- --all --since=1.week -- Makefile
2302 * Known bugs and problems:
2304 * - If the screen width is very small the main view can draw
2305 * outside the current view causing bad wrapping. Same goes
2306 * for title and status windows.
2310 * Features that should be explored.
2318 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
2320 * This program is free software; you can redistribute it and/or modify
2321 * it under the terms of the GNU General Public License as published by
2322 * the Free Software Foundation; either version 2 of the License, or
2323 * (at your option) any later version.
2328 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2329 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2330 * gitk(1): git repository browser written using tcl/tk,
2331 * qgit(1): git repository browser written using c++/Qt,
2332 * gitview(1): git repository browser written using python/gtk.