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.
27 #define VERSION "tig-0.1"
47 static void die(const char *err
, ...);
48 static void report(const char *msg
, ...);
49 static void set_nonblocking_input(int boolean
);
51 #define ABS(x) ((x) >= 0 ? (x) : -(x))
52 #define MIN(x, y) ((x) < (y) ? (x) : (y))
54 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
55 #define STRING_SIZE(x) (sizeof(x) - 1)
57 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
58 #define SIZEOF_CMD 1024 /* Size of command buffer. */
60 /* This color name can be used to refer to the default term colors. */
61 #define COLOR_DEFAULT (-1)
63 /* The format and size of the date column in the main view. */
64 #define DATE_FORMAT "%Y-%m-%d %H:%M"
65 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
67 /* The default interval between line numbers. */
68 #define NUMBER_INTERVAL 1
70 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
72 /* Some ascii-shorthands fitted into the ncurses namespace. */
74 #define KEY_RETURN '\r'
77 /* User action requests. */
79 /* Offset all requests to avoid conflicts with ncurses getch values. */
80 REQ_OFFSET
= KEY_MAX
+ 1,
82 /* XXX: Keep the view request first and in sync with views[]. */
96 REQ_TOGGLE_LINE_NUMBERS
,
107 REQ_SCROLL_LINE_DOWN
,
109 REQ_SCROLL_PAGE_DOWN
,
113 char id
[41]; /* SHA1 ID. */
114 char title
[75]; /* The first line of the commit message. */
115 char author
[75]; /* The author of the commit. */
116 struct tm time
; /* Date from the author ident. */
124 string_ncopy(char *dst
, char *src
, int dstlen
)
126 strncpy(dst
, src
, dstlen
- 1);
131 /* Shorthand for safely copying into a fixed buffer. */
132 #define string_copy(dst, src) \
133 string_ncopy(dst, src, sizeof(dst))
137 * NOTE: The following is a slightly modified copy of the git project's shell
138 * quoting routines found in the quote.c file.
140 * Help to copy the thing properly quoted for the shell safety. any single
141 * quote is replaced with '\'', any exclamation point is replaced with '\!',
142 * and the whole thing is enclosed in a
145 * original sq_quote result
146 * name ==> name ==> 'name'
147 * a b ==> a b ==> 'a b'
148 * a'b ==> a'\''b ==> 'a'\''b'
149 * a!b ==> a'\!'b ==> 'a'\!'b'
153 sq_quote(char buf
[SIZEOF_CMD
], size_t bufsize
, const char *src
)
157 #define BUFPUT(x) ( (bufsize < SIZEOF_CMD) && (buf[bufsize++] = (x)) )
160 while ((c
= *src
++)) {
161 if (c
== '\'' || c
== '!') {
181 static int opt_line_number
= FALSE
;
182 static int opt_num_interval
= NUMBER_INTERVAL
;
183 static enum request opt_request
= REQ_VIEW_MAIN
;
184 static char opt_cmd
[SIZEOF_CMD
] = "";
185 static FILE *opt_pipe
= NULL
;
187 /* Returns the index of log or diff command or -1 to exit. */
189 parse_options(int argc
, char *argv
[])
193 for (i
= 1; i
< argc
; i
++) {
198 * Start up in log view.
200 if (!strcmp(opt
, "-l")) {
201 opt_request
= REQ_VIEW_LOG
;
207 * Start up in diff view.
209 if (!strcmp(opt
, "-d")) {
210 opt_request
= REQ_VIEW_DIFF
;
215 * -n[INTERVAL], --line-number[=INTERVAL]::
216 * Prefix line numbers in log and diff view.
217 * Optionally, with interval different than each line.
219 if (!strncmp(opt
, "-n", 2) ||
220 !strncmp(opt
, "--line-number", 13)) {
226 } else if (opt
[STRING_SIZE("--line-number")] == '=') {
227 num
= opt
+ STRING_SIZE("--line-number=");
231 opt_num_interval
= atoi(num
);
233 opt_line_number
= TRUE
;
239 * Show version and exit.
241 if (!strcmp(opt
, "-v") ||
242 !strcmp(opt
, "--version")) {
243 printf("tig version %s\n", VERSION
);
249 * End of tig(1) options. Useful when specifying commands
250 * for the main view. Example:
252 * $ tig -- --since=1.month
254 if (!strcmp(opt
, "--")) {
261 * Open log view using the given git log options.
264 * Open diff view using the given git diff options.
267 * Open diff view using the given git show options.
269 if (!strcmp(opt
, "log") ||
270 !strcmp(opt
, "diff") ||
271 !strcmp(opt
, "show")) {
272 opt_request
= opt
[0] == 'l'
273 ? REQ_VIEW_LOG
: REQ_VIEW_DIFF
;
279 * $ tig tag-1.0..HEAD
282 if (opt
[0] && opt
[0] != '-')
285 die("unknown command '%s'", opt
);
288 if (!isatty(STDIN_FILENO
)) {
292 * If stdin is a pipe, any log or diff options will be ignored and the
293 * pager view will be opened loading data from stdin. The pager mode
294 * can be used for colorizing output from various git commands.
296 * Example on how to colorize the output of git-show(1):
300 opt_request
= REQ_VIEW_PAGER
;
303 } else if (i
< argc
) {
307 * Git command options
308 * ~~~~~~~~~~~~~~~~~~~
309 * All git command options specified on the command line will
310 * be passed to the given command and all will be shell quoted
313 * NOTE: It is possible to specify options even for the main
314 * view. If doing this you should not touch the `--pretty`
317 * Example on how to open the log view and show both author and
318 * committer information:
320 * $ tig log --pretty=fuller
323 if (opt_request
== REQ_VIEW_MAIN
)
324 /* XXX: This is vulnerable to the user overriding
325 * options required for the main view parser. */
326 string_copy(opt_cmd
, "git log --stat --pretty=raw");
328 string_copy(opt_cmd
, "git");
329 buf_size
= strlen(opt_cmd
);
331 while (buf_size
< sizeof(opt_cmd
) && i
< argc
) {
332 opt_cmd
[buf_size
++] = ' ';
333 buf_size
= sq_quote(opt_cmd
, buf_size
, argv
[i
++]);
336 if (buf_size
>= sizeof(opt_cmd
))
337 die("command too long");
339 opt_cmd
[buf_size
] = 0;
352 #define HELP "(d)iff, (l)og, (m)ain, (q)uit, (v)ersion, (h)elp"
359 struct keymap keymap
[] = {
364 * Switch to diff view.
366 * Switch to log view.
368 * Switch to main view.
370 * Switch to pager view.
374 * If in main view split the view
375 * and show the diff in the bottom view.
377 * Switch to next view.
379 { 'm', REQ_VIEW_MAIN
},
380 { 'd', REQ_VIEW_DIFF
},
381 { 'l', REQ_VIEW_LOG
},
382 { 'p', REQ_VIEW_PAGER
},
383 { 'h', REQ_VIEW_HELP
},
385 { KEY_TAB
, REQ_VIEW_NEXT
},
386 { KEY_RETURN
, REQ_ENTER
},
392 * Move curser one line up.
394 * Move cursor one line down.
396 * Move curser one page up.
398 * Move cursor one page down.
400 * Jump to first line.
404 { KEY_UP
, REQ_MOVE_UP
},
405 { 'k', REQ_MOVE_UP
},
406 { KEY_DOWN
, REQ_MOVE_DOWN
},
407 { 'j', REQ_MOVE_DOWN
},
408 { KEY_HOME
, REQ_MOVE_FIRST_LINE
},
409 { KEY_END
, REQ_MOVE_LAST_LINE
},
410 { KEY_NPAGE
, REQ_MOVE_PAGE_DOWN
},
411 { KEY_PPAGE
, REQ_MOVE_PAGE_UP
},
417 * Scroll view one line up.
419 * Scroll view one line down.
421 * Scroll view one page up.
423 * Scroll view one page down.
425 { KEY_IC
, REQ_SCROLL_LINE_UP
},
426 { KEY_DC
, REQ_SCROLL_LINE_DOWN
},
427 { 'w', REQ_SCROLL_PAGE_UP
},
428 { 's', REQ_SCROLL_PAGE_DOWN
},
438 * Stop all background loading.
442 * Toggle line numbers on/off.
444 * Open prompt. This allows you to specify what git command to run.
450 { KEY_ESC
, REQ_QUIT
},
452 { 'z', REQ_STOP_LOADING
},
453 { 'v', REQ_SHOW_VERSION
},
454 { 'r', REQ_SCREEN_REDRAW
},
455 { 'n', REQ_TOGGLE_LINE_NUMBERS
},
458 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
459 { ERR
, REQ_SCREEN_UPDATE
},
467 for (i
= 0; i
< ARRAY_SIZE(keymap
); i
++)
468 if (keymap
[i
].alias
== key
)
469 return keymap
[i
].request
;
471 return (enum request
) key
;
476 * Line-oriented content detection.
480 /* Line type String to match Foreground Background Attributes
481 * --------- --------------- ---------- ---------- ---------- */ \
483 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
484 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
485 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
486 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
487 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
488 LINE(DIFF_OLDMODE, "old mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
489 LINE(DIFF_NEWMODE, "new mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
490 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
491 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
492 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
493 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
494 /* Pretty print commit header */ \
495 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
496 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
497 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
498 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
499 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
500 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
501 /* Raw commit header */ \
502 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
503 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
504 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
505 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
506 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
508 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
509 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
511 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
512 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
513 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
514 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
515 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
516 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
517 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
518 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
519 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0),
522 #define LINE(type, line, fg, bg, attr) \
529 char *line
; /* The start of line to match. */
530 int linelen
; /* Size of string to match. */
531 int fg
, bg
, attr
; /* Color and text attributes for the lines. */
534 static struct line_info line_info
[] = {
535 #define LINE(type, line, fg, bg, attr) \
536 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
541 static enum line_type
542 get_line_type(char *line
)
544 int linelen
= strlen(line
);
547 for (type
= 0; type
< ARRAY_SIZE(line_info
); type
++)
548 /* Case insensitive search matches Signed-off-by lines better. */
549 if (linelen
>= line_info
[type
].linelen
&&
550 !strncasecmp(line_info
[type
].line
, line
, line_info
[type
].linelen
))
557 get_line_attr(enum line_type type
)
559 assert(type
< ARRAY_SIZE(line_info
));
560 return COLOR_PAIR(type
) | line_info
[type
].attr
;
566 int default_bg
= COLOR_BLACK
;
567 int default_fg
= COLOR_WHITE
;
572 if (use_default_colors() != ERR
) {
577 for (type
= 0; type
< ARRAY_SIZE(line_info
); type
++) {
578 struct line_info
*info
= &line_info
[type
];
579 int bg
= info
->bg
== COLOR_DEFAULT ? default_bg
: info
->bg
;
580 int fg
= info
->fg
== COLOR_DEFAULT ? default_fg
: info
->fg
;
582 init_pair(type
, fg
, bg
);
592 const char *name
; /* View name */
593 const char *cmdfmt
; /* Default command line format */
594 char *id
; /* Points to either of ref_{head,commit} */
595 size_t objsize
; /* Size of objects in the line index */
598 /* Draw one line; @lineno must be < view->height. */
599 bool (*draw
)(struct view
*view
, unsigned int lineno
);
600 /* Read one line; updates view->line. */
601 bool (*read
)(struct view
*view
, char *line
);
602 /* Depending on view, change display based on current line. */
603 bool (*enter
)(struct view
*view
);
606 char cmd
[SIZEOF_CMD
]; /* Command buffer */
607 char ref
[SIZEOF_REF
]; /* Hovered commit reference */
608 char vid
[SIZEOF_REF
]; /* View ID. Set to id member when updating. */
610 int height
, width
; /* The width and height of the main window */
611 WINDOW
*win
; /* The main window */
612 WINDOW
*title
; /* The title window living below the main window */
615 unsigned long offset
; /* Offset of the window top */
616 unsigned long lineno
; /* Current line number */
619 unsigned long lines
; /* Total number of lines */
620 void **line
; /* Line index; each line contains user data */
621 unsigned int digits
; /* Number of digits in the lines member. */
628 static struct view_ops pager_ops
;
629 static struct view_ops main_ops
;
632 "git show --patch-with-stat --find-copies-harder -B -C %s"
635 "git log --cc --stat -n100 %s"
638 "git log --topo-order --stat --pretty=raw %s"
641 "man tig 2> /dev/null"
643 char ref_head
[SIZEOF_REF
] = "HEAD";
644 char ref_commit
[SIZEOF_REF
] = "HEAD";
646 static struct view views
[] = {
647 { "main", MAIN_CMD
, ref_head
, sizeof(struct commit
), &main_ops
},
648 { "diff", DIFF_CMD
, ref_commit
, sizeof(char), &pager_ops
},
649 { "log", LOG_CMD
, ref_head
, sizeof(char), &pager_ops
},
650 { "help", HELP_CMD
, ref_head
, sizeof(char), &pager_ops
},
651 { "pager", "", "static", sizeof(char), &pager_ops
},
654 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
656 /* The display array of active views and the index of the current view. */
657 static struct view
*display
[2];
658 static unsigned int current_view
;
660 #define foreach_view(view, i) \
661 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
665 redraw_view_from(struct view
*view
, int lineno
)
667 assert(0 <= lineno
&& lineno
< view
->height
);
669 for (; lineno
< view
->height
; lineno
++) {
670 if (!view
->ops
->draw(view
, lineno
))
674 redrawwin(view
->win
);
679 redraw_view(struct view
*view
)
682 redraw_view_from(view
, 0);
689 struct view
*base
= display
[0];
690 struct view
*view
= display
[1] ? display
[1] : display
[0];
692 /* Setup window dimensions */
694 getmaxyx(stdscr
, base
->height
, base
->width
);
696 /* Make room for the status window. */
700 /* Horizontal split. */
701 view
->width
= base
->width
;
702 view
->height
= SCALE_SPLIT_VIEW(base
->height
);
703 base
->height
-= view
->height
;
705 /* Make room for the title bar. */
709 /* Make room for the title bar. */
714 foreach_view (view
, i
) {
716 view
->win
= newwin(view
->height
, 0, offset
, 0);
718 die("Failed to create %s view", view
->name
);
720 scrollok(view
->win
, TRUE
);
722 view
->title
= newwin(1, 0, offset
+ view
->height
, 0);
724 die("Failed to create title window");
727 wresize(view
->win
, view
->height
, view
->width
);
728 mvwin(view
->win
, offset
, 0);
729 mvwin(view
->title
, offset
+ view
->height
, 0);
733 offset
+= view
->height
+ 1;
738 update_view_title(struct view
*view
)
740 if (view
== display
[current_view
])
741 wbkgdset(view
->title
, get_line_attr(LINE_TITLE_FOCUS
));
743 wbkgdset(view
->title
, get_line_attr(LINE_TITLE_BLUR
));
746 wmove(view
->title
, 0, 0);
748 /* [main] ref: 334b506... - commit 6 of 4383 (0%) */
751 wprintw(view
->title
, "[%s] ref: %s", view
->name
, view
->ref
);
753 wprintw(view
->title
, "[%s]", view
->name
);
756 char *type
= view
== VIEW(REQ_VIEW_MAIN
) ?
"commit" : "line";
758 wprintw(view
->title
, " - %s %d of %d (%d%%)",
762 (view
->lineno
+ 1) * 100 / view
->lines
);
765 wrefresh(view
->title
);
772 /* Scrolling backend */
774 do_scroll_view(struct view
*view
, int lines
)
776 /* The rendering expects the new offset. */
777 view
->offset
+= lines
;
779 assert(0 <= view
->offset
&& view
->offset
< view
->lines
);
782 /* Redraw the whole screen if scrolling is pointless. */
783 if (view
->height
< ABS(lines
)) {
787 int line
= lines
> 0 ? view
->height
- lines
: 0;
788 int end
= line
+ ABS(lines
);
790 wscrl(view
->win
, lines
);
792 for (; line
< end
; line
++) {
793 if (!view
->ops
->draw(view
, line
))
798 /* Move current line into the view. */
799 if (view
->lineno
< view
->offset
) {
800 view
->lineno
= view
->offset
;
801 view
->ops
->draw(view
, 0);
803 } else if (view
->lineno
>= view
->offset
+ view
->height
) {
804 view
->lineno
= view
->offset
+ view
->height
- 1;
805 view
->ops
->draw(view
, view
->lineno
- view
->offset
);
808 assert(view
->offset
<= view
->lineno
&& view
->lineno
< view
->lines
);
810 redrawwin(view
->win
);
815 /* Scroll frontend */
817 scroll_view(struct view
*view
, enum request request
)
822 case REQ_SCROLL_PAGE_DOWN
:
823 lines
= view
->height
;
824 case REQ_SCROLL_LINE_DOWN
:
825 if (view
->offset
+ lines
> view
->lines
)
826 lines
= view
->lines
- view
->offset
;
828 if (lines
== 0 || view
->offset
+ view
->height
>= view
->lines
) {
829 report("Cannot scroll beyond the last line");
834 case REQ_SCROLL_PAGE_UP
:
835 lines
= view
->height
;
836 case REQ_SCROLL_LINE_UP
:
837 if (lines
> view
->offset
)
838 lines
= view
->offset
;
841 report("Cannot scroll beyond the first line");
849 die("request %d not handled in switch", request
);
852 do_scroll_view(view
, lines
);
857 move_view(struct view
*view
, enum request request
)
862 case REQ_MOVE_FIRST_LINE
:
863 steps
= -view
->lineno
;
866 case REQ_MOVE_LAST_LINE
:
867 steps
= view
->lines
- view
->lineno
- 1;
870 case REQ_MOVE_PAGE_UP
:
871 steps
= view
->height
> view
->lineno
872 ?
-view
->lineno
: -view
->height
;
875 case REQ_MOVE_PAGE_DOWN
:
876 steps
= view
->lineno
+ view
->height
>= view
->lines
877 ? view
->lines
- view
->lineno
- 1 : view
->height
;
889 die("request %d not handled in switch", request
);
892 if (steps
<= 0 && view
->lineno
== 0) {
893 report("Cannot move beyond the first line");
896 } else if (steps
>= 0 && view
->lineno
+ 1 >= view
->lines
) {
897 report("Cannot move beyond the last line");
901 /* Move the current line */
902 view
->lineno
+= steps
;
903 assert(0 <= view
->lineno
&& view
->lineno
< view
->lines
);
905 /* Repaint the old "current" line if we be scrolling */
906 if (ABS(steps
) < view
->height
) {
907 int prev_lineno
= view
->lineno
- steps
- view
->offset
;
909 wmove(view
->win
, prev_lineno
, 0);
910 wclrtoeol(view
->win
);
911 view
->ops
->draw(view
, prev_lineno
);
914 /* Check whether the view needs to be scrolled */
915 if (view
->lineno
< view
->offset
||
916 view
->lineno
>= view
->offset
+ view
->height
) {
917 if (steps
< 0 && -steps
> view
->offset
) {
918 steps
= -view
->offset
;
920 } else if (steps
> 0) {
921 if (view
->lineno
== view
->lines
- 1 &&
922 view
->lines
> view
->height
) {
923 steps
= view
->lines
- view
->offset
- 1;
924 if (steps
>= view
->height
)
925 steps
-= view
->height
- 1;
929 do_scroll_view(view
, steps
);
933 /* Draw the current line */
934 view
->ops
->draw(view
, view
->lineno
- view
->offset
);
936 redrawwin(view
->win
);
943 * Incremental updating
947 begin_update(struct view
*view
)
952 string_copy(view
->cmd
, opt_cmd
);
954 /* When running random commands, the view ref could have become
955 * invalid so clear it. */
958 if (snprintf(view
->cmd
, sizeof(view
->cmd
), view
->cmdfmt
,
959 id
, id
, id
) >= sizeof(view
->cmd
))
963 /* Special case for the pager view. */
965 view
->pipe
= opt_pipe
;
968 view
->pipe
= popen(view
->cmd
, "r");
974 set_nonblocking_input(TRUE
);
979 string_copy(view
->vid
, id
);
984 for (i
= 0; i
< view
->lines
; i
++)
992 view
->start_time
= time(NULL
);
998 end_update(struct view
*view
)
1002 set_nonblocking_input(FALSE
);
1003 if (view
->pipe
== stdin
)
1011 update_view(struct view
*view
)
1013 char buffer
[BUFSIZ
];
1016 /* The number of lines to read. If too low it will cause too much
1017 * redrawing (and possible flickering), if too high responsiveness
1019 unsigned long lines
= view
->height
;
1020 int redraw_from
= -1;
1025 /* Only redraw if lines are visible. */
1026 if (view
->offset
+ view
->height
>= view
->lines
)
1027 redraw_from
= view
->lines
- view
->offset
;
1029 tmp
= realloc(view
->line
, sizeof(*view
->line
) * (view
->lines
+ lines
));
1035 while ((line
= fgets(buffer
, sizeof(buffer
), view
->pipe
))) {
1038 linelen
= strlen(line
);
1040 line
[linelen
- 1] = 0;
1042 if (!view
->ops
->read(view
, line
))
1052 lines
= view
->lines
;
1053 for (digits
= 0; lines
; digits
++)
1056 /* Keep the displayed view in sync with line number scaling. */
1057 if (digits
!= view
->digits
) {
1058 view
->digits
= digits
;
1063 if (redraw_from
>= 0) {
1064 /* If this is an incremental update, redraw the previous line
1065 * since for commits some members could have changed when
1066 * loading the main view. */
1067 if (redraw_from
> 0)
1070 /* Incrementally draw avoids flickering. */
1071 redraw_view_from(view
, redraw_from
);
1074 /* Update the title _after_ the redraw so that if the redraw picks up a
1075 * commit reference in view->ref it'll be available here. */
1076 update_view_title(view
);
1078 if (ferror(view
->pipe
)) {
1079 report("Failed to read: %s", strerror(errno
));
1082 } else if (feof(view
->pipe
)) {
1083 time_t secs
= time(NULL
) - view
->start_time
;
1085 if (view
== VIEW(REQ_VIEW_HELP
)) {
1090 report("Loaded %d lines in %ld second%s", view
->lines
, secs
,
1091 secs
== 1 ?
"" : "s");
1098 report("Allocation failure");
1106 OPEN_DEFAULT
= 0, /* Use default view switching. */
1107 OPEN_SPLIT
= 1, /* Split current view. */
1108 OPEN_BACKGROUNDED
= 2, /* Backgrounded. */
1109 OPEN_RELOAD
= 4, /* Reload view even if it is the current. */
1113 open_view(struct view
*prev
, enum request request
, enum open_flags flags
)
1115 bool backgrounded
= !!(flags
& OPEN_BACKGROUNDED
);
1116 bool split
= !!(flags
& OPEN_SPLIT
);
1117 bool reload
= !!(flags
& OPEN_RELOAD
);
1118 struct view
*view
= VIEW(request
);
1119 struct view
*displayed
;
1122 /* Cycle between displayed views and count the views. */
1123 foreach_view (displayed
, nviews
) {
1125 view
== displayed
&&
1126 !strcmp(view
->vid
, prev
->vid
)) {
1127 current_view
= nviews
;
1128 /* Blur out the title of the previous view. */
1129 update_view_title(prev
);
1130 report("Switching to %s view", view
->name
);
1135 if (view
== prev
&& nviews
== 1 && !reload
) {
1136 report("Already in %s view", view
->name
);
1140 if ((reload
|| strcmp(view
->vid
, view
->id
)) &&
1141 !begin_update(view
)) {
1142 report("Failed to load %s view", view
->name
);
1147 display
[current_view
+ 1] = view
;
1151 /* Maximize the current view. */
1152 memset(display
, 0, sizeof(display
));
1154 display
[current_view
] = view
;
1159 if (split
&& prev
->lineno
- prev
->offset
>= prev
->height
) {
1160 /* Take the title line into account. */
1161 int lines
= prev
->lineno
- prev
->offset
- prev
->height
+ 1;
1163 /* Scroll the view that was split if the current line is
1164 * outside the new limited view. */
1165 do_scroll_view(prev
, lines
);
1168 if (prev
&& view
!= prev
) {
1169 /* "Blur" the previous view. */
1170 update_view_title(prev
);
1172 /* Continue loading split views in the background. */
1178 /* Clear the old view and let the incremental updating refill
1181 report("Loading...");
1190 * User request switch noodle
1194 view_driver(struct view
*view
, enum request request
)
1201 case REQ_MOVE_PAGE_UP
:
1202 case REQ_MOVE_PAGE_DOWN
:
1203 case REQ_MOVE_FIRST_LINE
:
1204 case REQ_MOVE_LAST_LINE
:
1205 move_view(view
, request
);
1208 case REQ_SCROLL_LINE_DOWN
:
1209 case REQ_SCROLL_LINE_UP
:
1210 case REQ_SCROLL_PAGE_DOWN
:
1211 case REQ_SCROLL_PAGE_UP
:
1212 scroll_view(view
, request
);
1219 case REQ_VIEW_PAGER
:
1220 open_view(view
, request
, OPEN_DEFAULT
);
1225 report("Nothing to enter");
1228 return view
->ops
->enter(view
);
1232 int nviews
= display
[1] ?
2 : 1;
1233 int next_view
= (current_view
+ 1) % nviews
;
1235 if (next_view
== current_view
) {
1236 report("Only one view is displayed");
1240 current_view
= next_view
;
1241 /* Blur out the title of the previous view. */
1242 update_view_title(view
);
1243 report("Switching to %s view", display
[current_view
]->name
);
1246 case REQ_TOGGLE_LINE_NUMBERS
:
1247 opt_line_number
= !opt_line_number
;
1252 /* Always reload^Wrerun commands from the prompt. */
1253 open_view(view
, opt_request
, OPEN_RELOAD
);
1256 case REQ_STOP_LOADING
:
1257 foreach_view (view
, i
) {
1259 report("Stopped loaded of %s view", view
->name
),
1264 case REQ_SHOW_VERSION
:
1265 report("Version: %s", VERSION
);
1268 case REQ_SCREEN_REDRAW
:
1269 foreach_view (view
, i
) {
1271 update_view_title(view
);
1275 case REQ_SCREEN_UPDATE
:
1283 /* An unknown key will show most commonly used commands. */
1293 * View backend handlers
1297 pager_draw(struct view
*view
, unsigned int lineno
)
1299 enum line_type type
;
1304 if (view
->offset
+ lineno
>= view
->lines
)
1307 line
= view
->line
[view
->offset
+ lineno
];
1308 type
= get_line_type(line
);
1310 if (view
->offset
+ lineno
== view
->lineno
) {
1311 if (type
== LINE_COMMIT
) {
1312 string_copy(view
->ref
, line
+ 7);
1313 string_copy(ref_commit
, view
->ref
);
1319 attr
= get_line_attr(type
);
1320 wattrset(view
->win
, attr
);
1322 linelen
= strlen(line
);
1323 linelen
= MIN(linelen
, view
->width
);
1325 if (opt_line_number
) {
1326 static char indent
[] = " ";
1327 unsigned long real_lineno
= view
->offset
+ lineno
+ 1;
1330 if (real_lineno
== 1 || (real_lineno
% opt_num_interval
) == 0)
1331 mvwprintw(view
->win
, lineno
, 0, "%.*d", view
->digits
, real_lineno
);
1333 else if (view
->digits
< sizeof(indent
))
1334 mvwaddnstr(view
->win
, lineno
, 0, indent
, view
->digits
);
1336 waddstr(view
->win
, ": ");
1339 if (*line
== '\t') {
1340 waddnstr(view
->win
, " ", 8 - (col
% 8));
1341 col
+= 8 - (col
% 8);
1345 char *tab
= strchr(line
, '\t');
1348 waddnstr(view
->win
, line
, tab
- line
);
1350 waddstr(view
->win
, line
);
1355 waddstr(view
->win
, line
);
1359 /* NOTE: Code for only highlighting the text on the cursor line.
1360 * Kept since I've not yet decided whether to highlight the
1361 * entire line or not. --fonseca */
1362 /* No empty lines makes cursor drawing and clearing implicit. */
1364 line
= " ", linelen
= 1;
1366 mvwaddnstr(view
->win
, lineno
, 0, line
, linelen
);
1369 /* Paint the rest of the line if it's the cursor line. */
1370 if (type
== LINE_CURSOR
)
1371 wchgat(view
->win
, -1, 0, type
, NULL
);
1377 pager_read(struct view
*view
, char *line
)
1379 /* For some reason the piped man page has many empty lines
1380 * so skip successive emptys lines to work around it. */
1381 if (view
== VIEW(REQ_VIEW_HELP
) &&
1384 !*((char *) view
->line
[view
->lines
- 1]))
1387 view
->line
[view
->lines
] = strdup(line
);
1388 if (!view
->line
[view
->lines
])
1396 pager_enter(struct view
*view
)
1398 char *line
= view
->line
[view
->lineno
];
1400 if (get_line_type(line
) == LINE_COMMIT
) {
1401 open_view(view
, REQ_VIEW_DIFF
, OPEN_DEFAULT
);
1407 static struct view_ops pager_ops
= {
1415 main_draw(struct view
*view
, unsigned int lineno
)
1417 char buf
[DATE_COLS
+ 1];
1418 struct commit
*commit
;
1419 enum line_type type
;
1423 if (view
->offset
+ lineno
>= view
->lines
)
1426 commit
= view
->line
[view
->offset
+ lineno
];
1427 if (!*commit
->author
)
1430 if (view
->offset
+ lineno
== view
->lineno
) {
1431 string_copy(view
->ref
, commit
->id
);
1432 string_copy(ref_commit
, view
->ref
);
1435 type
= LINE_MAIN_COMMIT
;
1438 wmove(view
->win
, lineno
, cols
);
1439 wattrset(view
->win
, get_line_attr(LINE_MAIN_DATE
));
1441 timelen
= strftime(buf
, sizeof(buf
), DATE_FORMAT
, &commit
->time
);
1442 waddnstr(view
->win
, buf
, timelen
);
1443 waddstr(view
->win
, " ");
1446 wmove(view
->win
, lineno
, cols
);
1447 wattrset(view
->win
, get_line_attr(LINE_MAIN_AUTHOR
));
1449 if (strlen(commit
->author
) > 19) {
1450 waddnstr(view
->win
, commit
->author
, 18);
1451 wattrset(view
->win
, get_line_attr(LINE_MAIN_DELIM
));
1452 waddch(view
->win
, '~');
1454 waddstr(view
->win
, commit
->author
);
1458 wattrset(view
->win
, A_NORMAL
);
1459 mvwaddch(view
->win
, lineno
, cols
, ACS_LTEE
);
1460 wattrset(view
->win
, get_line_attr(type
));
1461 mvwaddstr(view
->win
, lineno
, cols
+ 2, commit
->title
);
1462 wattrset(view
->win
, A_NORMAL
);
1467 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1469 main_read(struct view
*view
, char *line
)
1471 enum line_type type
= get_line_type(line
);
1472 struct commit
*commit
;
1476 commit
= calloc(1, sizeof(struct commit
));
1480 line
+= STRING_SIZE("commit ");
1482 view
->line
[view
->lines
++] = commit
;
1483 string_copy(commit
->id
, line
);
1488 char *ident
= line
+ STRING_SIZE("author ");
1489 char *end
= strchr(ident
, '<');
1492 for (; end
> ident
&& isspace(end
[-1]); end
--) ;
1496 commit
= view
->line
[view
->lines
- 1];
1497 string_copy(commit
->author
, ident
);
1499 /* Parse epoch and timezone */
1501 char *secs
= strchr(end
+ 1, '>');
1505 if (!secs
|| secs
[1] != ' ')
1509 time
= (time_t) atol(secs
);
1510 zone
= strchr(secs
, ' ');
1511 if (zone
&& strlen(zone
) == STRING_SIZE(" +0700")) {
1515 tz
= ('0' - zone
[1]) * 60 * 60 * 10;
1516 tz
+= ('0' - zone
[2]) * 60 * 60;
1517 tz
+= ('0' - zone
[3]) * 60;
1518 tz
+= ('0' - zone
[4]) * 60;
1525 gmtime_r(&time
, &commit
->time
);
1530 /* We should only ever end up here if there has already been a
1531 * commit line, however, be safe. */
1532 if (view
->lines
== 0)
1535 /* Fill in the commit title if it has not already been set. */
1536 commit
= view
->line
[view
->lines
- 1];
1537 if (commit
->title
[0])
1540 /* Require titles to start with a non-space character at the
1541 * offset used by git log. */
1542 /* FIXME: More gracefull handling of titles; append "..." to
1543 * shortened titles, etc. */
1544 if (strncmp(line
, " ", 4) ||
1548 string_copy(commit
->title
, line
+ 4);
1555 main_enter(struct view
*view
)
1557 open_view(view
, REQ_VIEW_DIFF
, OPEN_SPLIT
| OPEN_BACKGROUNDED
);
1561 static struct view_ops main_ops
= {
1571 /* Whether or not the curses interface has been initialized. */
1572 bool cursed
= FALSE
;
1574 /* The status window is used for polling keystrokes. */
1575 static WINDOW
*status_win
;
1577 /* Update status and title window. */
1579 report(const char *msg
, ...)
1583 va_start(args
, msg
);
1585 /* Update the title window first, so the cursor ends up in the status
1587 update_view_title(display
[current_view
]);
1590 wmove(status_win
, 0, 0);
1591 vwprintw(status_win
, msg
, args
);
1592 wrefresh(status_win
);
1597 /* Controls when nodelay should be in effect when polling user input. */
1599 set_nonblocking_input(int loading
)
1601 /* The number of loading views. */
1602 static unsigned int nloading
;
1604 if (loading
== TRUE
) {
1605 if (nloading
++ == 0)
1606 nodelay(status_win
, TRUE
);
1610 if (nloading
-- == 1)
1611 nodelay(status_win
, FALSE
);
1619 /* Initialize the curses library */
1620 if (isatty(STDIN_FILENO
)) {
1621 cursed
= !!initscr();
1623 /* Leave stdin and stdout alone when acting as a pager. */
1624 FILE *io
= fopen("/dev/tty", "r+");
1626 cursed
= !!newterm(NULL
, io
, io
);
1630 die("Failed to initialize curses");
1632 nonl(); /* Tell curses not to do NL->CR/NL on output */
1633 cbreak(); /* Take input chars one at a time, no wait for \n */
1634 noecho(); /* Don't echo input */
1635 leaveok(stdscr
, TRUE
);
1640 getmaxyx(stdscr
, y
, x
);
1641 status_win
= newwin(1, 0, y
- 1, 0);
1643 die("Failed to create status window");
1645 /* Enable keyboard mapping */
1646 keypad(status_win
, TRUE
);
1647 wbkgdset(status_win
, get_line_attr(LINE_STATUS
));
1657 /* XXX: Restore tty modes and let the OS cleanup the rest! */
1663 static void die(const char *err
, ...)
1669 va_start(args
, err
);
1670 fputs("tig: ", stderr
);
1671 vfprintf(stderr
, err
, args
);
1672 fputs("\n", stderr
);
1679 main(int argc
, char *argv
[])
1681 enum request request
;
1683 signal(SIGINT
, quit
);
1685 if (!parse_options(argc
, argv
))
1688 request
= opt_request
;
1692 while (view_driver(display
[current_view
], request
)) {
1697 foreach_view (view
, i
)
1700 /* Refresh, accept single keystroke of input */
1701 key
= wgetch(status_win
);
1702 request
= get_request(key
);
1704 if (request
== REQ_PROMPT
) {
1706 /* Temporarily switch to line-oriented and echoed
1711 if (wgetnstr(status_win
, opt_cmd
+ 4, sizeof(opt_cmd
) - 4) == OK
) {
1712 memcpy(opt_cmd
, "git ", 4);
1713 opt_request
= REQ_VIEW_PAGER
;
1731 * Features that should be explored.
1733 * - Terminal resizing support. I am yet to figure out whether catching
1734 * SIGWINCH is preferred over using ncurses' built-in support for resizing.
1740 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
1742 * This program is free software; you can redistribute it and/or modify
1743 * it under the terms of the GNU General Public License as published by
1744 * the Free Software Foundation; either version 2 of the License, or
1745 * (at your option) any later version.
1750 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
1751 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
1752 * gitk(1): git repository browser written using tcl/tk,
1753 * gitview(1): git repository browser written using python/gtk.