36669b165d7c81c3b1db309d0edc80b0520522b2
[tig] / tig.c
1 /* Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 as
5 * published by the Free Software Foundation.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 */
12 /**
13 * TIG(1)
14 * ======
15 *
16 * NAME
17 * ----
18 * tig - text-mode interface for git
19 *
20 * SYNOPSIS
21 * --------
22 * [verse]
23 * tig [options]
24 * tig [options] [--] [git log options]
25 * tig [options] log [git log options]
26 * tig [options] diff [git diff options]
27 * tig [options] show [git show options]
28 * tig [options] < [git command output]
29 *
30 * DESCRIPTION
31 * -----------
32 * Browse changes in a git repository. Additionally, tig(1) can also act
33 * as a pager for output of various git commands.
34 *
35 * When browsing repositories, tig(1) uses the underlying git commands
36 * to present the user with various views, such as summarized commit log
37 * and showing the commit with the log message, diffstat, and the diff.
38 *
39 * Using tig(1) as a pager, it will display input from stdin and try
40 * to colorize it.
41 **/
42
43 #ifndef VERSION
44 #define VERSION "tig-0.3"
45 #endif
46
47 #ifndef DEBUG
48 #define NDEBUG
49 #endif
50
51 #include <assert.h>
52 #include <errno.h>
53 #include <ctype.h>
54 #include <signal.h>
55 #include <stdarg.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <unistd.h>
60 #include <time.h>
61
62 #include <curses.h>
63
64 static void die(const char *err, ...);
65 static void report(const char *msg, ...);
66 static int read_properties(const char *cmd, int separator, int (*read)(char *, int, char *, int));
67 static void set_nonblocking_input(bool loading);
68 static size_t utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed);
69
70 #define ABS(x) ((x) >= 0 ? (x) : -(x))
71 #define MIN(x, y) ((x) < (y) ? (x) : (y))
72
73 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
74 #define STRING_SIZE(x) (sizeof(x) - 1)
75
76 #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
77 #define SIZEOF_CMD 1024 /* Size of command buffer. */
78
79 /* This color name can be used to refer to the default term colors. */
80 #define COLOR_DEFAULT (-1)
81
82 #define TIG_HELP "(d)iff, (l)og, (m)ain, (q)uit, (h)elp"
83
84 /* The format and size of the date column in the main view. */
85 #define DATE_FORMAT "%Y-%m-%d %H:%M"
86 #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
87
88 #define AUTHOR_COLS 20
89
90 /* The default interval between line numbers. */
91 #define NUMBER_INTERVAL 1
92
93 #define TABSIZE 8
94
95 #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
96
97 /* Some ascii-shorthands fitted into the ncurses namespace. */
98 #define KEY_TAB '\t'
99 #define KEY_RETURN '\r'
100 #define KEY_ESC 27
101
102
103 /* User action requests. */
104 enum request {
105 /* Offset all requests to avoid conflicts with ncurses getch values. */
106 REQ_OFFSET = KEY_MAX + 1,
107
108 /* XXX: Keep the view request first and in sync with views[]. */
109 REQ_VIEW_MAIN,
110 REQ_VIEW_DIFF,
111 REQ_VIEW_LOG,
112 REQ_VIEW_HELP,
113 REQ_VIEW_PAGER,
114
115 REQ_ENTER,
116 REQ_QUIT,
117 REQ_PROMPT,
118 REQ_SCREEN_REDRAW,
119 REQ_SCREEN_RESIZE,
120 REQ_SCREEN_UPDATE,
121 REQ_SHOW_VERSION,
122 REQ_STOP_LOADING,
123 REQ_TOGGLE_LINE_NUMBERS,
124 REQ_VIEW_NEXT,
125 REQ_VIEW_CLOSE,
126 REQ_NEXT,
127 REQ_PREVIOUS,
128
129 REQ_MOVE_UP,
130 REQ_MOVE_DOWN,
131 REQ_MOVE_PAGE_UP,
132 REQ_MOVE_PAGE_DOWN,
133 REQ_MOVE_FIRST_LINE,
134 REQ_MOVE_LAST_LINE,
135
136 REQ_SCROLL_LINE_UP,
137 REQ_SCROLL_LINE_DOWN,
138 REQ_SCROLL_PAGE_UP,
139 REQ_SCROLL_PAGE_DOWN,
140 };
141
142 struct ref {
143 char *name; /* Ref name; tag or head names are shortened. */
144 char id[41]; /* Commit SHA1 ID */
145 unsigned int tag:1; /* Is it a tag? */
146 unsigned int next:1; /* For ref lists: are there more refs? */
147 };
148
149 static struct ref **get_refs(char *id);
150
151
152 /*
153 * String helpers
154 */
155
156 static inline void
157 string_ncopy(char *dst, const char *src, int dstlen)
158 {
159 strncpy(dst, src, dstlen - 1);
160 dst[dstlen - 1] = 0;
161
162 }
163
164 /* Shorthand for safely copying into a fixed buffer. */
165 #define string_copy(dst, src) \
166 string_ncopy(dst, src, sizeof(dst))
167
168
169 /* Shell quoting
170 *
171 * NOTE: The following is a slightly modified copy of the git project's shell
172 * quoting routines found in the quote.c file.
173 *
174 * Help to copy the thing properly quoted for the shell safety. any single
175 * quote is replaced with '\'', any exclamation point is replaced with '\!',
176 * and the whole thing is enclosed in a
177 *
178 * E.g.
179 * original sq_quote result
180 * name ==> name ==> 'name'
181 * a b ==> a b ==> 'a b'
182 * a'b ==> a'\''b ==> 'a'\''b'
183 * a!b ==> a'\!'b ==> 'a'\!'b'
184 */
185
186 static size_t
187 sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
188 {
189 char c;
190
191 #define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0)
192
193 BUFPUT('\'');
194 while ((c = *src++)) {
195 if (c == '\'' || c == '!') {
196 BUFPUT('\'');
197 BUFPUT('\\');
198 BUFPUT(c);
199 BUFPUT('\'');
200 } else {
201 BUFPUT(c);
202 }
203 }
204 BUFPUT('\'');
205
206 return bufsize;
207 }
208
209
210 /**
211 * OPTIONS
212 * -------
213 **/
214
215 static const char usage[] =
216 VERSION " (" __DATE__ ")\n"
217 "\n"
218 "Usage: tig [options]\n"
219 " or: tig [options] [--] [git log options]\n"
220 " or: tig [options] log [git log options]\n"
221 " or: tig [options] diff [git diff options]\n"
222 " or: tig [options] show [git show options]\n"
223 " or: tig [options] < [git command output]\n"
224 "\n"
225 "Options:\n"
226 " -l Start up in log view\n"
227 " -d Start up in diff view\n"
228 " -n[I], --line-number[=I] Show line numbers with given interval\n"
229 " -t[N], --tab-size[=N] Set number of spaces for tab expansion\n"
230 " -- Mark end of tig options\n"
231 " -v, --version Show version and exit\n"
232 " -h, --help Show help message and exit\n";
233
234 /* Option and state variables. */
235 static bool opt_line_number = FALSE;
236 static int opt_num_interval = NUMBER_INTERVAL;
237 static int opt_tab_size = TABSIZE;
238 static enum request opt_request = REQ_VIEW_MAIN;
239 static char opt_cmd[SIZEOF_CMD] = "";
240 static char opt_encoding[20] = "";
241 static bool opt_utf8 = TRUE;
242 static FILE *opt_pipe = NULL;
243
244 /* Returns the index of log or diff command or -1 to exit. */
245 static bool
246 parse_options(int argc, char *argv[])
247 {
248 int i;
249
250 for (i = 1; i < argc; i++) {
251 char *opt = argv[i];
252
253 /**
254 * -l::
255 * Start up in log view using the internal log command.
256 **/
257 if (!strcmp(opt, "-l")) {
258 opt_request = REQ_VIEW_LOG;
259 continue;
260 }
261
262 /**
263 * -d::
264 * Start up in diff view using the internal diff command.
265 **/
266 if (!strcmp(opt, "-d")) {
267 opt_request = REQ_VIEW_DIFF;
268 continue;
269 }
270
271 /**
272 * -n[INTERVAL], --line-number[=INTERVAL]::
273 * Prefix line numbers in log and diff view.
274 * Optionally, with interval different than each line.
275 **/
276 if (!strncmp(opt, "-n", 2) ||
277 !strncmp(opt, "--line-number", 13)) {
278 char *num = opt;
279
280 if (opt[1] == 'n') {
281 num = opt + 2;
282
283 } else if (opt[STRING_SIZE("--line-number")] == '=') {
284 num = opt + STRING_SIZE("--line-number=");
285 }
286
287 if (isdigit(*num))
288 opt_num_interval = atoi(num);
289
290 opt_line_number = TRUE;
291 continue;
292 }
293
294 /**
295 * -t[NSPACES], --tab-size[=NSPACES]::
296 * Set the number of spaces tabs should be expanded to.
297 **/
298 if (!strncmp(opt, "-t", 2) ||
299 !strncmp(opt, "--tab-size", 10)) {
300 char *num = opt;
301
302 if (opt[1] == 't') {
303 num = opt + 2;
304
305 } else if (opt[STRING_SIZE("--tab-size")] == '=') {
306 num = opt + STRING_SIZE("--tab-size=");
307 }
308
309 if (isdigit(*num))
310 opt_tab_size = MIN(atoi(num), TABSIZE);
311 continue;
312 }
313
314 /**
315 * -v, --version::
316 * Show version and exit.
317 **/
318 if (!strcmp(opt, "-v") ||
319 !strcmp(opt, "--version")) {
320 printf("tig version %s\n", VERSION);
321 return FALSE;
322 }
323
324 /**
325 * -h, --help::
326 * Show help message and exit.
327 **/
328 if (!strcmp(opt, "-h") ||
329 !strcmp(opt, "--help")) {
330 printf(usage);
331 return FALSE;
332 }
333
334 /**
335 * \--::
336 * End of tig(1) options. Useful when specifying command
337 * options for the main view. Example:
338 *
339 * $ tig -- --since=1.month
340 **/
341 if (!strcmp(opt, "--")) {
342 i++;
343 break;
344 }
345
346 /**
347 * log [git log options]::
348 * Open log view using the given git log options.
349 *
350 * diff [git diff options]::
351 * Open diff view using the given git diff options.
352 *
353 * show [git show options]::
354 * Open diff view using the given git show options.
355 **/
356 if (!strcmp(opt, "log") ||
357 !strcmp(opt, "diff") ||
358 !strcmp(opt, "show")) {
359 opt_request = opt[0] == 'l'
360 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
361 break;
362 }
363
364 /**
365 * [git log options]::
366 * tig(1) will stop the option parsing when the first
367 * command line parameter not starting with "-" is
368 * encountered. All options including this one will be
369 * passed to git log when loading the main view.
370 * This makes it possible to say:
371 *
372 * $ tig tag-1.0..HEAD
373 **/
374 if (opt[0] && opt[0] != '-')
375 break;
376
377 die("unknown command '%s'", opt);
378 }
379
380 if (!isatty(STDIN_FILENO)) {
381 /**
382 * Pager mode
383 * ~~~~~~~~~~
384 * If stdin is a pipe, any log or diff options will be ignored and the
385 * pager view will be opened loading data from stdin. The pager mode
386 * can be used for colorizing output from various git commands.
387 *
388 * Example on how to colorize the output of git-show(1):
389 *
390 * $ git show | tig
391 **/
392 opt_request = REQ_VIEW_PAGER;
393 opt_pipe = stdin;
394
395 } else if (i < argc) {
396 size_t buf_size;
397
398 /**
399 * Git command options
400 * ~~~~~~~~~~~~~~~~~~~
401 * All git command options specified on the command line will
402 * be passed to the given command and all will be shell quoted
403 * before they are passed to the shell.
404 *
405 * NOTE: If you specify options for the main view, you should
406 * not use the `--pretty` option as this option will be set
407 * automatically to the format expected by the main view.
408 *
409 * Example on how to open the log view and show both author and
410 * committer information:
411 *
412 * $ tig log --pretty=fuller
413 *
414 * See the <<refspec, "Specifying revisions">> section below
415 * for an introduction to revision options supported by the git
416 * commands. For details on specific git command options, refer
417 * to the man page of the command in question.
418 **/
419
420 if (opt_request == REQ_VIEW_MAIN)
421 /* XXX: This is vulnerable to the user overriding
422 * options required for the main view parser. */
423 string_copy(opt_cmd, "git log --stat --pretty=raw");
424 else
425 string_copy(opt_cmd, "git");
426 buf_size = strlen(opt_cmd);
427
428 while (buf_size < sizeof(opt_cmd) && i < argc) {
429 opt_cmd[buf_size++] = ' ';
430 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
431 }
432
433 if (buf_size >= sizeof(opt_cmd))
434 die("command too long");
435
436 opt_cmd[buf_size] = 0;
437
438 }
439
440 if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8"))
441 opt_utf8 = FALSE;
442
443 return TRUE;
444 }
445
446
447 /**
448 * ENVIRONMENT VARIABLES
449 * ---------------------
450 * Several options related to the interface with git can be configured
451 * via environment options.
452 *
453 * Repository references
454 * ~~~~~~~~~~~~~~~~~~~~~
455 * Commits that are referenced by tags and branch heads will be marked
456 * by the reference name surrounded by '[' and ']':
457 *
458 * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
459 *
460 * If you want to filter out certain directories under `.git/refs/`, say
461 * `tmp` you can do it by setting the following variable:
462 *
463 * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
464 *
465 * Or set the variable permanently in your environment.
466 *
467 * TIG_LS_REMOTE::
468 * Set command for retrieving all repository references. The command
469 * should output data in the same format as git-ls-remote(1).
470 **/
471
472 #define TIG_LS_REMOTE \
473 "git ls-remote . 2>/dev/null"
474
475 /**
476 * [[view-commands]]
477 * View commands
478 * ~~~~~~~~~~~~~
479 * It is possible to alter which commands are used for the different views.
480 * If for example you prefer commits in the main view to be sorted by date
481 * and only show 500 commits, use:
482 *
483 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
484 *
485 * Or set the variable permanently in your environment.
486 *
487 * Notice, how `%s` is used to specify the commit reference. There can
488 * be a maximum of 5 `%s` ref specifications.
489 *
490 * TIG_DIFF_CMD::
491 * The command used for the diff view. By default, git show is used
492 * as a backend.
493 *
494 * TIG_LOG_CMD::
495 * The command used for the log view. If you prefer to have both
496 * author and committer shown in the log view be sure to pass
497 * `--pretty=fuller` to git log.
498 *
499 * TIG_MAIN_CMD::
500 * The command used for the main view. Note, you must always specify
501 * the option: `--pretty=raw` since the main view parser expects to
502 * read that format.
503 **/
504
505 #define TIG_DIFF_CMD \
506 "git show --patch-with-stat --find-copies-harder -B -C %s"
507
508 #define TIG_LOG_CMD \
509 "git log --cc --stat -n100 %s"
510
511 #define TIG_MAIN_CMD \
512 "git log --topo-order --stat --pretty=raw %s"
513
514 /* ... silently ignore that the following are also exported. */
515
516 #define TIG_HELP_CMD \
517 "man tig 2>/dev/null"
518
519 #define TIG_PAGER_CMD \
520 ""
521
522
523 /*
524 * Line-oriented content detection.
525 */
526
527 #define LINE_INFO \
528 /* Line type String to match Foreground Background Attributes
529 * --------- --------------- ---------- ---------- ---------- */ \
530 /* Diff markup */ \
531 LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
532 LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
533 LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
534 LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
535 LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
536 LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
537 LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
538 LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
539 LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
540 LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
541 LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
542 /* Pretty print commit header */ \
543 LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
544 LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
545 LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
546 LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
547 LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
548 LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
549 /* Raw commit header */ \
550 LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
551 LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
552 LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
553 LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
554 LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
555 /* Misc */ \
556 LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
557 LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
558 /* UI colors */ \
559 LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
560 LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
561 LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
562 LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
563 LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
564 LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
565 LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
566 LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
567 LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
568 LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
569 LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
570
571 enum line_type {
572 #define LINE(type, line, fg, bg, attr) \
573 LINE_##type
574 LINE_INFO
575 #undef LINE
576 };
577
578 struct line_info {
579 const char *line; /* The start of line to match. */
580 int linelen; /* Size of string to match. */
581 int fg, bg, attr; /* Color and text attributes for the lines. */
582 };
583
584 static struct line_info line_info[] = {
585 #define LINE(type, line, fg, bg, attr) \
586 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
587 LINE_INFO
588 #undef LINE
589 };
590
591 static enum line_type
592 get_line_type(char *line)
593 {
594 int linelen = strlen(line);
595 enum line_type type;
596
597 for (type = 0; type < ARRAY_SIZE(line_info); type++)
598 /* Case insensitive search matches Signed-off-by lines better. */
599 if (linelen >= line_info[type].linelen &&
600 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
601 return type;
602
603 return LINE_DEFAULT;
604 }
605
606 static inline int
607 get_line_attr(enum line_type type)
608 {
609 assert(type < ARRAY_SIZE(line_info));
610 return COLOR_PAIR(type) | line_info[type].attr;
611 }
612
613 static void
614 init_colors(void)
615 {
616 int default_bg = COLOR_BLACK;
617 int default_fg = COLOR_WHITE;
618 enum line_type type;
619
620 start_color();
621
622 if (use_default_colors() != ERR) {
623 default_bg = -1;
624 default_fg = -1;
625 }
626
627 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
628 struct line_info *info = &line_info[type];
629 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
630 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
631
632 init_pair(type, fg, bg);
633 }
634 }
635
636 struct line {
637 enum line_type type;
638 void *data; /* User data */
639 };
640
641
642 /**
643 * The viewer
644 * ----------
645 * The display consists of a status window on the last line of the screen and
646 * one or more views. The default is to only show one view at the time but it
647 * is possible to split both the main and log view to also show the commit
648 * diff.
649 *
650 * If you are in the log view and press 'Enter' when the current line is a
651 * commit line, such as:
652 *
653 * commit 4d55caff4cc89335192f3e566004b4ceef572521
654 *
655 * You will split the view so that the log view is displayed in the top window
656 * and the diff view in the bottom window. You can switch between the two
657 * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
658 **/
659
660 struct view;
661 struct view_ops;
662
663 /* The display array of active views and the index of the current view. */
664 static struct view *display[2];
665 static unsigned int current_view;
666
667 #define foreach_view(view, i) \
668 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
669
670 #define displayed_views() (display[1] != NULL ? 2 : 1)
671
672 /**
673 * Current head and commit ID
674 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
675 * The viewer keeps track of both what head and commit ID you are currently
676 * viewing. The commit ID will follow the cursor line and change everytime time
677 * you highlight a different commit. Whenever you reopen the diff view it
678 * will be reloaded, if the commit ID changed.
679 *
680 * The head ID is used when opening the main and log view to indicate from
681 * what revision to show history.
682 **/
683
684 static char ref_commit[SIZEOF_REF] = "HEAD";
685 static char ref_head[SIZEOF_REF] = "HEAD";
686
687 struct view {
688 const char *name; /* View name */
689 const char *cmd_fmt; /* Default command line format */
690 const char *cmd_env; /* Command line set via environment */
691 const char *id; /* Points to either of ref_{head,commit} */
692
693 struct view_ops *ops; /* View operations */
694
695 char cmd[SIZEOF_CMD]; /* Command buffer */
696 char ref[SIZEOF_REF]; /* Hovered commit reference */
697 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
698
699 int height, width; /* The width and height of the main window */
700 WINDOW *win; /* The main window */
701 WINDOW *title; /* The title window living below the main window */
702
703 /* Navigation */
704 unsigned long offset; /* Offset of the window top */
705 unsigned long lineno; /* Current line number */
706
707 /* If non-NULL, points to the view that opened this view. If this view
708 * is closed tig will switch back to the parent view. */
709 struct view *parent;
710
711 /* Buffering */
712 unsigned long lines; /* Total number of lines */
713 struct line *line; /* Line index */
714 unsigned int digits; /* Number of digits in the lines member. */
715
716 /* Loading */
717 FILE *pipe;
718 time_t start_time;
719 };
720
721 struct view_ops {
722 /* What type of content being displayed. Used in the title bar. */
723 const char *type;
724 /* Draw one line; @lineno must be < view->height. */
725 bool (*draw)(struct view *view, struct line *line, unsigned int lineno);
726 /* Read one line; updates view->line. */
727 bool (*read)(struct view *view, struct line *prev, char *data);
728 /* Depending on view, change display based on current line. */
729 bool (*enter)(struct view *view, struct line *line);
730 };
731
732 static struct view_ops pager_ops;
733 static struct view_ops main_ops;
734
735 #define VIEW_STR(name, cmd, env, ref, ops) \
736 { name, cmd, #env, ref, ops }
737
738 #define VIEW_(id, name, ops, ref) \
739 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops)
740
741 /**
742 * Views
743 * ~~~~~
744 * tig(1) presents various 'views' of a repository. Each view is based on output
745 * from an external command, most often 'git log', 'git diff', or 'git show'.
746 *
747 * The main view::
748 * Is the default view, and it shows a one line summary of each commit
749 * in the chosen list of revisions. The summary includes commit date,
750 * author, and the first line of the log message. Additionally, any
751 * repository references, such as tags, will be shown.
752 *
753 * The log view::
754 * Presents a more rich view of the revision log showing the whole log
755 * message and the diffstat.
756 *
757 * The diff view::
758 * Shows either the diff of the current working tree, that is, what
759 * has changed since the last commit, or the commit diff complete
760 * with log message, diffstat and diff.
761 *
762 * The pager view::
763 * Is used for displaying both input from stdin and output from git
764 * commands entered in the internal prompt.
765 *
766 * The help view::
767 * Displays the information from the tig(1) man page. For the help view
768 * to work you need to have the tig(1) man page installed.
769 **/
770
771 static struct view views[] = {
772 VIEW_(MAIN, "main", &main_ops, ref_head),
773 VIEW_(DIFF, "diff", &pager_ops, ref_commit),
774 VIEW_(LOG, "log", &pager_ops, ref_head),
775 VIEW_(HELP, "help", &pager_ops, "static"),
776 VIEW_(PAGER, "pager", &pager_ops, "static"),
777 };
778
779 #define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
780
781
782 static bool
783 draw_view_line(struct view *view, unsigned int lineno)
784 {
785 if (view->offset + lineno >= view->lines)
786 return FALSE;
787
788 return view->ops->draw(view, &view->line[view->offset + lineno], lineno);
789 }
790
791 static void
792 redraw_view_from(struct view *view, int lineno)
793 {
794 assert(0 <= lineno && lineno < view->height);
795
796 for (; lineno < view->height; lineno++) {
797 if (!draw_view_line(view, lineno))
798 break;
799 }
800
801 redrawwin(view->win);
802 wrefresh(view->win);
803 }
804
805 static void
806 redraw_view(struct view *view)
807 {
808 wclear(view->win);
809 redraw_view_from(view, 0);
810 }
811
812
813 /**
814 * Title windows
815 * ~~~~~~~~~~~~~
816 * Each view has a title window which shows the name of the view, current
817 * commit ID if available, and where the view is positioned:
818 *
819 * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
820 *
821 * By default, the title of the current view is highlighted using bold font.
822 **/
823
824 static void
825 update_view_title(struct view *view)
826 {
827 if (view == display[current_view])
828 wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS));
829 else
830 wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR));
831
832 werase(view->title);
833 wmove(view->title, 0, 0);
834
835 if (*view->ref)
836 wprintw(view->title, "[%s] %s", view->name, view->ref);
837 else
838 wprintw(view->title, "[%s]", view->name);
839
840 if (view->lines || view->pipe) {
841 unsigned int lines = view->lines
842 ? (view->lineno + 1) * 100 / view->lines
843 : 0;
844
845 wprintw(view->title, " - %s %d of %d (%d%%)",
846 view->ops->type,
847 view->lineno + 1,
848 view->lines,
849 lines);
850 }
851
852 if (view->pipe) {
853 time_t secs = time(NULL) - view->start_time;
854
855 /* Three git seconds are a long time ... */
856 if (secs > 2)
857 wprintw(view->title, " %lds", secs);
858 }
859
860
861 wrefresh(view->title);
862 }
863
864 static void
865 resize_display(void)
866 {
867 int offset, i;
868 struct view *base = display[0];
869 struct view *view = display[1] ? display[1] : display[0];
870
871 /* Setup window dimensions */
872
873 getmaxyx(stdscr, base->height, base->width);
874
875 /* Make room for the status window. */
876 base->height -= 1;
877
878 if (view != base) {
879 /* Horizontal split. */
880 view->width = base->width;
881 view->height = SCALE_SPLIT_VIEW(base->height);
882 base->height -= view->height;
883
884 /* Make room for the title bar. */
885 view->height -= 1;
886 }
887
888 /* Make room for the title bar. */
889 base->height -= 1;
890
891 offset = 0;
892
893 foreach_view (view, i) {
894 if (!view->win) {
895 view->win = newwin(view->height, 0, offset, 0);
896 if (!view->win)
897 die("Failed to create %s view", view->name);
898
899 scrollok(view->win, TRUE);
900
901 view->title = newwin(1, 0, offset + view->height, 0);
902 if (!view->title)
903 die("Failed to create title window");
904
905 } else {
906 wresize(view->win, view->height, view->width);
907 mvwin(view->win, offset, 0);
908 mvwin(view->title, offset + view->height, 0);
909 }
910
911 offset += view->height + 1;
912 }
913 }
914
915 static void
916 redraw_display(void)
917 {
918 struct view *view;
919 int i;
920
921 foreach_view (view, i) {
922 redraw_view(view);
923 update_view_title(view);
924 }
925 }
926
927
928 /*
929 * Navigation
930 */
931
932 /* Scrolling backend */
933 static void
934 do_scroll_view(struct view *view, int lines, bool redraw)
935 {
936 /* The rendering expects the new offset. */
937 view->offset += lines;
938
939 assert(0 <= view->offset && view->offset < view->lines);
940 assert(lines);
941
942 /* Redraw the whole screen if scrolling is pointless. */
943 if (view->height < ABS(lines)) {
944 redraw_view(view);
945
946 } else {
947 int line = lines > 0 ? view->height - lines : 0;
948 int end = line + ABS(lines);
949
950 wscrl(view->win, lines);
951
952 for (; line < end; line++) {
953 if (!draw_view_line(view, line))
954 break;
955 }
956 }
957
958 /* Move current line into the view. */
959 if (view->lineno < view->offset) {
960 view->lineno = view->offset;
961 draw_view_line(view, 0);
962
963 } else if (view->lineno >= view->offset + view->height) {
964 if (view->lineno == view->offset + view->height) {
965 /* Clear the hidden line so it doesn't show if the view
966 * is scrolled up. */
967 wmove(view->win, view->height, 0);
968 wclrtoeol(view->win);
969 }
970 view->lineno = view->offset + view->height - 1;
971 draw_view_line(view, view->lineno - view->offset);
972 }
973
974 assert(view->offset <= view->lineno && view->lineno < view->lines);
975
976 if (!redraw)
977 return;
978
979 redrawwin(view->win);
980 wrefresh(view->win);
981 report("");
982 }
983
984 /* Scroll frontend */
985 static void
986 scroll_view(struct view *view, enum request request)
987 {
988 int lines = 1;
989
990 switch (request) {
991 case REQ_SCROLL_PAGE_DOWN:
992 lines = view->height;
993 case REQ_SCROLL_LINE_DOWN:
994 if (view->offset + lines > view->lines)
995 lines = view->lines - view->offset;
996
997 if (lines == 0 || view->offset + view->height >= view->lines) {
998 report("Cannot scroll beyond the last line");
999 return;
1000 }
1001 break;
1002
1003 case REQ_SCROLL_PAGE_UP:
1004 lines = view->height;
1005 case REQ_SCROLL_LINE_UP:
1006 if (lines > view->offset)
1007 lines = view->offset;
1008
1009 if (lines == 0) {
1010 report("Cannot scroll beyond the first line");
1011 return;
1012 }
1013
1014 lines = -lines;
1015 break;
1016
1017 default:
1018 die("request %d not handled in switch", request);
1019 }
1020
1021 do_scroll_view(view, lines, TRUE);
1022 }
1023
1024 /* Cursor moving */
1025 static void
1026 move_view(struct view *view, enum request request, bool redraw)
1027 {
1028 int steps;
1029
1030 switch (request) {
1031 case REQ_MOVE_FIRST_LINE:
1032 steps = -view->lineno;
1033 break;
1034
1035 case REQ_MOVE_LAST_LINE:
1036 steps = view->lines - view->lineno - 1;
1037 break;
1038
1039 case REQ_MOVE_PAGE_UP:
1040 steps = view->height > view->lineno
1041 ? -view->lineno : -view->height;
1042 break;
1043
1044 case REQ_MOVE_PAGE_DOWN:
1045 steps = view->lineno + view->height >= view->lines
1046 ? view->lines - view->lineno - 1 : view->height;
1047 break;
1048
1049 case REQ_MOVE_UP:
1050 steps = -1;
1051 break;
1052
1053 case REQ_MOVE_DOWN:
1054 steps = 1;
1055 break;
1056
1057 default:
1058 die("request %d not handled in switch", request);
1059 }
1060
1061 if (steps <= 0 && view->lineno == 0) {
1062 report("Cannot move beyond the first line");
1063 return;
1064
1065 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1066 report("Cannot move beyond the last line");
1067 return;
1068 }
1069
1070 /* Move the current line */
1071 view->lineno += steps;
1072 assert(0 <= view->lineno && view->lineno < view->lines);
1073
1074 /* Repaint the old "current" line if we be scrolling */
1075 if (ABS(steps) < view->height) {
1076 int prev_lineno = view->lineno - steps - view->offset;
1077
1078 wmove(view->win, prev_lineno, 0);
1079 wclrtoeol(view->win);
1080 draw_view_line(view, prev_lineno);
1081 }
1082
1083 /* Check whether the view needs to be scrolled */
1084 if (view->lineno < view->offset ||
1085 view->lineno >= view->offset + view->height) {
1086 if (steps < 0 && -steps > view->offset) {
1087 steps = -view->offset;
1088
1089 } else if (steps > 0) {
1090 if (view->lineno == view->lines - 1 &&
1091 view->lines > view->height) {
1092 steps = view->lines - view->offset - 1;
1093 if (steps >= view->height)
1094 steps -= view->height - 1;
1095 }
1096 }
1097
1098 do_scroll_view(view, steps, redraw);
1099 return;
1100 }
1101
1102 /* Draw the current line */
1103 draw_view_line(view, view->lineno - view->offset);
1104
1105 if (!redraw)
1106 return;
1107
1108 redrawwin(view->win);
1109 wrefresh(view->win);
1110 report("");
1111 }
1112
1113
1114 /*
1115 * Incremental updating
1116 */
1117
1118 static void
1119 end_update(struct view *view)
1120 {
1121 if (!view->pipe)
1122 return;
1123 set_nonblocking_input(FALSE);
1124 if (view->pipe == stdin)
1125 fclose(view->pipe);
1126 else
1127 pclose(view->pipe);
1128 view->pipe = NULL;
1129 }
1130
1131 static bool
1132 begin_update(struct view *view)
1133 {
1134 const char *id = view->id;
1135
1136 if (view->pipe)
1137 end_update(view);
1138
1139 if (opt_cmd[0]) {
1140 string_copy(view->cmd, opt_cmd);
1141 opt_cmd[0] = 0;
1142 /* When running random commands, the view ref could have become
1143 * invalid so clear it. */
1144 view->ref[0] = 0;
1145 } else {
1146 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1147
1148 if (snprintf(view->cmd, sizeof(view->cmd), format,
1149 id, id, id, id, id) >= sizeof(view->cmd))
1150 return FALSE;
1151 }
1152
1153 /* Special case for the pager view. */
1154 if (opt_pipe) {
1155 view->pipe = opt_pipe;
1156 opt_pipe = NULL;
1157 } else {
1158 view->pipe = popen(view->cmd, "r");
1159 }
1160
1161 if (!view->pipe)
1162 return FALSE;
1163
1164 set_nonblocking_input(TRUE);
1165
1166 view->offset = 0;
1167 view->lines = 0;
1168 view->lineno = 0;
1169 string_copy(view->vid, id);
1170
1171 if (view->line) {
1172 int i;
1173
1174 for (i = 0; i < view->lines; i++)
1175 if (view->line[i].data)
1176 free(view->line[i].data);
1177
1178 free(view->line);
1179 view->line = NULL;
1180 }
1181
1182 view->start_time = time(NULL);
1183
1184 return TRUE;
1185 }
1186
1187 static bool
1188 update_view(struct view *view)
1189 {
1190 char buffer[BUFSIZ];
1191 char *line;
1192 struct line *tmp;
1193 /* The number of lines to read. If too low it will cause too much
1194 * redrawing (and possible flickering), if too high responsiveness
1195 * will suffer. */
1196 unsigned long lines = view->height;
1197 int redraw_from = -1;
1198
1199 if (!view->pipe)
1200 return TRUE;
1201
1202 /* Only redraw if lines are visible. */
1203 if (view->offset + view->height >= view->lines)
1204 redraw_from = view->lines - view->offset;
1205
1206 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1207 if (!tmp)
1208 goto alloc_error;
1209
1210 view->line = tmp;
1211
1212 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1213 int linelen = strlen(line);
1214
1215 struct line *prev = view->lines
1216 ? &view->line[view->lines - 1]
1217 : NULL;
1218
1219 if (linelen)
1220 line[linelen - 1] = 0;
1221
1222 if (!view->ops->read(view, prev, line))
1223 goto alloc_error;
1224
1225 if (lines-- == 1)
1226 break;
1227 }
1228
1229 {
1230 int digits;
1231
1232 lines = view->lines;
1233 for (digits = 0; lines; digits++)
1234 lines /= 10;
1235
1236 /* Keep the displayed view in sync with line number scaling. */
1237 if (digits != view->digits) {
1238 view->digits = digits;
1239 redraw_from = 0;
1240 }
1241 }
1242
1243 if (redraw_from >= 0) {
1244 /* If this is an incremental update, redraw the previous line
1245 * since for commits some members could have changed when
1246 * loading the main view. */
1247 if (redraw_from > 0)
1248 redraw_from--;
1249
1250 /* Incrementally draw avoids flickering. */
1251 redraw_view_from(view, redraw_from);
1252 }
1253
1254 /* Update the title _after_ the redraw so that if the redraw picks up a
1255 * commit reference in view->ref it'll be available here. */
1256 update_view_title(view);
1257
1258 if (ferror(view->pipe)) {
1259 report("Failed to read: %s", strerror(errno));
1260 goto end;
1261
1262 } else if (feof(view->pipe)) {
1263 if (view == VIEW(REQ_VIEW_HELP)) {
1264 const char *msg = TIG_HELP;
1265
1266 if (view->lines == 0) {
1267 /* Slightly ugly, but abusing view->ref keeps
1268 * the error message. */
1269 string_copy(view->ref, "No help available");
1270 msg = "The tig(1) manpage is not installed";
1271 }
1272
1273 report("%s", msg);
1274 goto end;
1275 }
1276
1277 report("");
1278 goto end;
1279 }
1280
1281 return TRUE;
1282
1283 alloc_error:
1284 report("Allocation failure");
1285
1286 end:
1287 end_update(view);
1288 return FALSE;
1289 }
1290
1291 enum open_flags {
1292 OPEN_DEFAULT = 0, /* Use default view switching. */
1293 OPEN_SPLIT = 1, /* Split current view. */
1294 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1295 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1296 };
1297
1298 static void
1299 open_view(struct view *prev, enum request request, enum open_flags flags)
1300 {
1301 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1302 bool split = !!(flags & OPEN_SPLIT);
1303 bool reload = !!(flags & OPEN_RELOAD);
1304 struct view *view = VIEW(request);
1305 int nviews = displayed_views();
1306 struct view *base_view = display[0];
1307
1308 if (view == prev && nviews == 1 && !reload) {
1309 report("Already in %s view", view->name);
1310 return;
1311 }
1312
1313 if ((reload || strcmp(view->vid, view->id)) &&
1314 !begin_update(view)) {
1315 report("Failed to load %s view", view->name);
1316 return;
1317 }
1318
1319 if (split) {
1320 display[current_view + 1] = view;
1321 if (!backgrounded)
1322 current_view++;
1323 } else {
1324 /* Maximize the current view. */
1325 memset(display, 0, sizeof(display));
1326 current_view = 0;
1327 display[current_view] = view;
1328 }
1329
1330 /* Resize the view when switching between split- and full-screen,
1331 * or when switching between two different full-screen views. */
1332 if (nviews != displayed_views() ||
1333 (nviews == 1 && base_view != display[0]))
1334 resize_display();
1335
1336 if (split && prev->lineno - prev->offset >= prev->height) {
1337 /* Take the title line into account. */
1338 int lines = prev->lineno - prev->offset - prev->height + 1;
1339
1340 /* Scroll the view that was split if the current line is
1341 * outside the new limited view. */
1342 do_scroll_view(prev, lines, TRUE);
1343 }
1344
1345 if (prev && view != prev) {
1346 if (split && !backgrounded) {
1347 /* "Blur" the previous view. */
1348 update_view_title(prev);
1349 }
1350
1351 view->parent = prev;
1352 }
1353
1354 if (view->pipe && view->lines == 0) {
1355 /* Clear the old view and let the incremental updating refill
1356 * the screen. */
1357 wclear(view->win);
1358 report("");
1359 } else {
1360 redraw_view(view);
1361 if (view == VIEW(REQ_VIEW_HELP))
1362 report("%s", TIG_HELP);
1363 else
1364 report("");
1365 }
1366
1367 /* If the view is backgrounded the above calls to report()
1368 * won't redraw the view title. */
1369 if (backgrounded)
1370 update_view_title(view);
1371 }
1372
1373
1374 /*
1375 * User request switch noodle
1376 */
1377
1378 static int
1379 view_driver(struct view *view, enum request request)
1380 {
1381 int i;
1382
1383 switch (request) {
1384 case REQ_MOVE_UP:
1385 case REQ_MOVE_DOWN:
1386 case REQ_MOVE_PAGE_UP:
1387 case REQ_MOVE_PAGE_DOWN:
1388 case REQ_MOVE_FIRST_LINE:
1389 case REQ_MOVE_LAST_LINE:
1390 move_view(view, request, TRUE);
1391 break;
1392
1393 case REQ_SCROLL_LINE_DOWN:
1394 case REQ_SCROLL_LINE_UP:
1395 case REQ_SCROLL_PAGE_DOWN:
1396 case REQ_SCROLL_PAGE_UP:
1397 scroll_view(view, request);
1398 break;
1399
1400 case REQ_VIEW_MAIN:
1401 case REQ_VIEW_DIFF:
1402 case REQ_VIEW_LOG:
1403 case REQ_VIEW_HELP:
1404 case REQ_VIEW_PAGER:
1405 open_view(view, request, OPEN_DEFAULT);
1406 break;
1407
1408 case REQ_NEXT:
1409 case REQ_PREVIOUS:
1410 request = request == REQ_NEXT ? REQ_MOVE_DOWN : REQ_MOVE_UP;
1411
1412 if (view == VIEW(REQ_VIEW_DIFF) &&
1413 view->parent == VIEW(REQ_VIEW_MAIN)) {
1414 bool redraw = display[1] == view;
1415
1416 view = view->parent;
1417 move_view(view, request, redraw);
1418 if (redraw)
1419 update_view_title(view);
1420 } else {
1421 move_view(view, request, TRUE);
1422 break;
1423 }
1424 /* Fall-through */
1425
1426 case REQ_ENTER:
1427 if (!view->lines) {
1428 report("Nothing to enter");
1429 break;
1430 }
1431 return view->ops->enter(view, &view->line[view->lineno]);
1432
1433 case REQ_VIEW_NEXT:
1434 {
1435 int nviews = displayed_views();
1436 int next_view = (current_view + 1) % nviews;
1437
1438 if (next_view == current_view) {
1439 report("Only one view is displayed");
1440 break;
1441 }
1442
1443 current_view = next_view;
1444 /* Blur out the title of the previous view. */
1445 update_view_title(view);
1446 report("");
1447 break;
1448 }
1449 case REQ_TOGGLE_LINE_NUMBERS:
1450 opt_line_number = !opt_line_number;
1451 redraw_display();
1452 break;
1453
1454 case REQ_PROMPT:
1455 /* Always reload^Wrerun commands from the prompt. */
1456 open_view(view, opt_request, OPEN_RELOAD);
1457 break;
1458
1459 case REQ_STOP_LOADING:
1460 foreach_view (view, i) {
1461 if (view->pipe)
1462 report("Stopped loaded the %s view", view->name),
1463 end_update(view);
1464 }
1465 break;
1466
1467 case REQ_SHOW_VERSION:
1468 report("%s (built %s)", VERSION, __DATE__);
1469 return TRUE;
1470
1471 case REQ_SCREEN_RESIZE:
1472 resize_display();
1473 /* Fall-through */
1474 case REQ_SCREEN_REDRAW:
1475 redraw_display();
1476 break;
1477
1478 case REQ_SCREEN_UPDATE:
1479 doupdate();
1480 return TRUE;
1481
1482 case REQ_VIEW_CLOSE:
1483 if (view->parent) {
1484 memset(display, 0, sizeof(display));
1485 current_view = 0;
1486 display[current_view] = view->parent;
1487 view->parent = NULL;
1488 resize_display();
1489 redraw_display();
1490 break;
1491 }
1492 /* Fall-through */
1493 case REQ_QUIT:
1494 return FALSE;
1495
1496 default:
1497 /* An unknown key will show most commonly used commands. */
1498 report("Unknown key, press 'h' for help");
1499 return TRUE;
1500 }
1501
1502 return TRUE;
1503 }
1504
1505
1506 /*
1507 * Pager backend
1508 */
1509
1510 static bool
1511 pager_draw(struct view *view, struct line *line, unsigned int lineno)
1512 {
1513 char *text = line->data;
1514 enum line_type type = line->type;
1515 int textlen = strlen(text);
1516 int attr;
1517
1518 wmove(view->win, lineno, 0);
1519
1520 if (view->offset + lineno == view->lineno) {
1521 if (type == LINE_COMMIT) {
1522 string_copy(view->ref, text + 7);
1523 string_copy(ref_commit, view->ref);
1524 }
1525
1526 type = LINE_CURSOR;
1527 wchgat(view->win, -1, 0, type, NULL);
1528 }
1529
1530 attr = get_line_attr(type);
1531 wattrset(view->win, attr);
1532
1533 if (opt_line_number || opt_tab_size < TABSIZE) {
1534 static char spaces[] = " ";
1535 int col_offset = 0, col = 0;
1536
1537 if (opt_line_number) {
1538 unsigned long real_lineno = view->offset + lineno + 1;
1539
1540 if (real_lineno == 1 ||
1541 (real_lineno % opt_num_interval) == 0) {
1542 wprintw(view->win, "%.*d", view->digits, real_lineno);
1543
1544 } else {
1545 waddnstr(view->win, spaces,
1546 MIN(view->digits, STRING_SIZE(spaces)));
1547 }
1548 waddstr(view->win, ": ");
1549 col_offset = view->digits + 2;
1550 }
1551
1552 while (text && col_offset + col < view->width) {
1553 int cols_max = view->width - col_offset - col;
1554 char *pos = text;
1555 int cols;
1556
1557 if (*text == '\t') {
1558 text++;
1559 assert(sizeof(spaces) > TABSIZE);
1560 pos = spaces;
1561 cols = opt_tab_size - (col % opt_tab_size);
1562
1563 } else {
1564 text = strchr(text, '\t');
1565 cols = line ? text - pos : strlen(pos);
1566 }
1567
1568 waddnstr(view->win, pos, MIN(cols, cols_max));
1569 col += cols;
1570 }
1571
1572 } else {
1573 int col = 0, pos = 0;
1574
1575 for (; pos < textlen && col < view->width; pos++, col++)
1576 if (text[pos] == '\t')
1577 col += TABSIZE - (col % TABSIZE) - 1;
1578
1579 waddnstr(view->win, text, pos);
1580 }
1581
1582 return TRUE;
1583 }
1584
1585 static bool
1586 pager_read(struct view *view, struct line *prev, char *line)
1587 {
1588 /* Compress empty lines in the help view. */
1589 if (view == VIEW(REQ_VIEW_HELP) &&
1590 !*line && prev && !*((char *) prev->data))
1591 return TRUE;
1592
1593 view->line[view->lines].data = strdup(line);
1594 if (!view->line[view->lines].data)
1595 return FALSE;
1596
1597 view->line[view->lines].type = get_line_type(line);
1598
1599 view->lines++;
1600 return TRUE;
1601 }
1602
1603 static bool
1604 pager_enter(struct view *view, struct line *line)
1605 {
1606 int split = 0;
1607
1608 if (line->type == LINE_COMMIT &&
1609 (view == VIEW(REQ_VIEW_LOG) ||
1610 view == VIEW(REQ_VIEW_PAGER))) {
1611 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1612 split = 1;
1613 }
1614
1615 /* Always scroll the view even if it was split. That way
1616 * you can use Enter to scroll through the log view and
1617 * split open each commit diff. */
1618 scroll_view(view, REQ_SCROLL_LINE_DOWN);
1619
1620 /* FIXME: A minor workaround. Scrolling the view will call report("")
1621 * but if we are scrolling a non-current view this won't properly
1622 * update the view title. */
1623 if (split)
1624 update_view_title(view);
1625
1626 return TRUE;
1627 }
1628
1629 static struct view_ops pager_ops = {
1630 "line",
1631 pager_draw,
1632 pager_read,
1633 pager_enter,
1634 };
1635
1636
1637 /*
1638 * Main view backend
1639 */
1640
1641 struct commit {
1642 char id[41]; /* SHA1 ID. */
1643 char title[75]; /* The first line of the commit message. */
1644 char author[75]; /* The author of the commit. */
1645 struct tm time; /* Date from the author ident. */
1646 struct ref **refs; /* Repository references; tags & branch heads. */
1647 };
1648
1649 static bool
1650 main_draw(struct view *view, struct line *line, unsigned int lineno)
1651 {
1652 char buf[DATE_COLS + 1];
1653 struct commit *commit = line->data;
1654 enum line_type type;
1655 int col = 0;
1656 size_t timelen;
1657 size_t authorlen;
1658 int trimmed = 1;
1659
1660 if (!*commit->author)
1661 return FALSE;
1662
1663 wmove(view->win, lineno, col);
1664
1665 if (view->offset + lineno == view->lineno) {
1666 string_copy(view->ref, commit->id);
1667 string_copy(ref_commit, view->ref);
1668 type = LINE_CURSOR;
1669 wattrset(view->win, get_line_attr(type));
1670 wchgat(view->win, -1, 0, type, NULL);
1671
1672 } else {
1673 type = LINE_MAIN_COMMIT;
1674 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1675 }
1676
1677 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1678 waddnstr(view->win, buf, timelen);
1679 waddstr(view->win, " ");
1680
1681 col += DATE_COLS;
1682 wmove(view->win, lineno, col);
1683 if (type != LINE_CURSOR)
1684 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1685
1686 if (opt_utf8) {
1687 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1688 } else {
1689 authorlen = strlen(commit->author);
1690 if (authorlen > AUTHOR_COLS - 2) {
1691 authorlen = AUTHOR_COLS - 2;
1692 trimmed = 1;
1693 }
1694 }
1695
1696 if (trimmed) {
1697 waddnstr(view->win, commit->author, authorlen);
1698 if (type != LINE_CURSOR)
1699 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1700 waddch(view->win, '~');
1701 } else {
1702 waddstr(view->win, commit->author);
1703 }
1704
1705 col += AUTHOR_COLS;
1706 if (type != LINE_CURSOR)
1707 wattrset(view->win, A_NORMAL);
1708
1709 mvwaddch(view->win, lineno, col, ACS_LTEE);
1710 wmove(view->win, lineno, col + 2);
1711 col += 2;
1712
1713 if (commit->refs) {
1714 size_t i = 0;
1715
1716 do {
1717 if (type == LINE_CURSOR)
1718 ;
1719 else if (commit->refs[i]->tag)
1720 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1721 else
1722 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1723 waddstr(view->win, "[");
1724 waddstr(view->win, commit->refs[i]->name);
1725 waddstr(view->win, "]");
1726 if (type != LINE_CURSOR)
1727 wattrset(view->win, A_NORMAL);
1728 waddstr(view->win, " ");
1729 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1730 } while (commit->refs[i++]->next);
1731 }
1732
1733 if (type != LINE_CURSOR)
1734 wattrset(view->win, get_line_attr(type));
1735
1736 {
1737 int titlelen = strlen(commit->title);
1738
1739 if (col + titlelen > view->width)
1740 titlelen = view->width - col;
1741
1742 waddnstr(view->win, commit->title, titlelen);
1743 }
1744
1745 return TRUE;
1746 }
1747
1748 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1749 static bool
1750 main_read(struct view *view, struct line *prev, char *line)
1751 {
1752 enum line_type type = get_line_type(line);
1753 struct commit *commit;
1754
1755 switch (type) {
1756 case LINE_COMMIT:
1757 commit = calloc(1, sizeof(struct commit));
1758 if (!commit)
1759 return FALSE;
1760
1761 line += STRING_SIZE("commit ");
1762
1763 view->line[view->lines++].data = commit;
1764 string_copy(commit->id, line);
1765 commit->refs = get_refs(commit->id);
1766 break;
1767
1768 case LINE_AUTHOR:
1769 {
1770 char *ident = line + STRING_SIZE("author ");
1771 char *end = strchr(ident, '<');
1772
1773 if (!prev)
1774 break;
1775
1776 commit = prev->data;
1777
1778 if (end) {
1779 for (; end > ident && isspace(end[-1]); end--) ;
1780 *end = 0;
1781 }
1782
1783 string_copy(commit->author, ident);
1784
1785 /* Parse epoch and timezone */
1786 if (end) {
1787 char *secs = strchr(end + 1, '>');
1788 char *zone;
1789 time_t time;
1790
1791 if (!secs || secs[1] != ' ')
1792 break;
1793
1794 secs += 2;
1795 time = (time_t) atol(secs);
1796 zone = strchr(secs, ' ');
1797 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1798 long tz;
1799
1800 zone++;
1801 tz = ('0' - zone[1]) * 60 * 60 * 10;
1802 tz += ('0' - zone[2]) * 60 * 60;
1803 tz += ('0' - zone[3]) * 60;
1804 tz += ('0' - zone[4]) * 60;
1805
1806 if (zone[0] == '-')
1807 tz = -tz;
1808
1809 time -= tz;
1810 }
1811 gmtime_r(&time, &commit->time);
1812 }
1813 break;
1814 }
1815 default:
1816 if (!prev)
1817 break;
1818
1819 commit = prev->data;
1820
1821 /* Fill in the commit title if it has not already been set. */
1822 if (commit->title[0])
1823 break;
1824
1825 /* Require titles to start with a non-space character at the
1826 * offset used by git log. */
1827 /* FIXME: More gracefull handling of titles; append "..." to
1828 * shortened titles, etc. */
1829 if (strncmp(line, " ", 4) ||
1830 isspace(line[4]))
1831 break;
1832
1833 string_copy(commit->title, line + 4);
1834 }
1835
1836 return TRUE;
1837 }
1838
1839 static bool
1840 main_enter(struct view *view, struct line *line)
1841 {
1842 enum open_flags flags = display[0] == view ? OPEN_SPLIT : OPEN_DEFAULT;
1843
1844 open_view(view, REQ_VIEW_DIFF, flags);
1845 return TRUE;
1846 }
1847
1848 static struct view_ops main_ops = {
1849 "commit",
1850 main_draw,
1851 main_read,
1852 main_enter,
1853 };
1854
1855
1856 /**
1857 * KEYS
1858 * ----
1859 * Below the default key bindings are shown.
1860 **/
1861
1862 struct keymap {
1863 int alias;
1864 int request;
1865 };
1866
1867 static struct keymap keymap[] = {
1868 /**
1869 * View switching
1870 * ~~~~~~~~~~~~~~
1871 * m::
1872 * Switch to main view.
1873 * d::
1874 * Switch to diff view.
1875 * l::
1876 * Switch to log view.
1877 * p::
1878 * Switch to pager view.
1879 * h::
1880 * Show man page.
1881 **/
1882 { 'm', REQ_VIEW_MAIN },
1883 { 'd', REQ_VIEW_DIFF },
1884 { 'l', REQ_VIEW_LOG },
1885 { 'p', REQ_VIEW_PAGER },
1886 { 'h', REQ_VIEW_HELP },
1887
1888 /**
1889 * View manipulation
1890 * ~~~~~~~~~~~~~~~~~
1891 * q::
1892 * Close view, if multiple views are open it will jump back to the
1893 * previous view in the view stack. If it is the last open view it
1894 * will quit. Use 'Q' to quit all views at once.
1895 * Enter::
1896 * This key is "context sensitive" depending on what view you are
1897 * currently in. When in log view on a commit line or in the main
1898 * view, split the view and show the commit diff. In the diff view
1899 * pressing Enter will simply scroll the view one line down.
1900 * Tab::
1901 * Switch to next view.
1902 * Up::
1903 * This key is "context sensitive" and will move the cursor one
1904 * line up. However, uf you opened a diff view from the main view
1905 * (split- or full-screen) it will change the cursor to point to
1906 * the previous commit in the main view and update the diff view
1907 * to display it.
1908 * Down::
1909 * Similar to 'Up' but will move down.
1910 **/
1911 { 'q', REQ_VIEW_CLOSE },
1912 { KEY_TAB, REQ_VIEW_NEXT },
1913 { KEY_RETURN, REQ_ENTER },
1914 { KEY_UP, REQ_PREVIOUS },
1915 { KEY_DOWN, REQ_NEXT },
1916
1917 /**
1918 * Cursor navigation
1919 * ~~~~~~~~~~~~~~~~~
1920 * j::
1921 * Move cursor one line up.
1922 * k::
1923 * Move cursor one line down.
1924 * PgUp::
1925 * b::
1926 * -::
1927 * Move cursor one page up.
1928 * PgDown::
1929 * Space::
1930 * Move cursor one page down.
1931 * Home::
1932 * Jump to first line.
1933 * End::
1934 * Jump to last line.
1935 **/
1936 { 'k', REQ_MOVE_UP },
1937 { 'j', REQ_MOVE_DOWN },
1938 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1939 { KEY_END, REQ_MOVE_LAST_LINE },
1940 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1941 { ' ', REQ_MOVE_PAGE_DOWN },
1942 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1943 { 'b', REQ_MOVE_PAGE_UP },
1944 { '-', REQ_MOVE_PAGE_UP },
1945
1946 /**
1947 * Scrolling
1948 * ~~~~~~~~~
1949 * Insert::
1950 * Scroll view one line up.
1951 * Delete::
1952 * Scroll view one line down.
1953 * w::
1954 * Scroll view one page up.
1955 * s::
1956 * Scroll view one page down.
1957 **/
1958 { KEY_IC, REQ_SCROLL_LINE_UP },
1959 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1960 { 'w', REQ_SCROLL_PAGE_UP },
1961 { 's', REQ_SCROLL_PAGE_DOWN },
1962
1963 /**
1964 * Misc
1965 * ~~~~
1966 * Q::
1967 * Quit.
1968 * r::
1969 * Redraw screen.
1970 * z::
1971 * Stop all background loading. This can be useful if you use
1972 * tig(1) in a repository with a long history without limiting
1973 * the revision log.
1974 * v::
1975 * Show version.
1976 * n::
1977 * Toggle line numbers on/off.
1978 * ':'::
1979 * Open prompt. This allows you to specify what git command
1980 * to run. Example:
1981 *
1982 * :log -p
1983 **/
1984 { 'Q', REQ_QUIT },
1985 { 'z', REQ_STOP_LOADING },
1986 { 'v', REQ_SHOW_VERSION },
1987 { 'r', REQ_SCREEN_REDRAW },
1988 { 'n', REQ_TOGGLE_LINE_NUMBERS },
1989 { ':', REQ_PROMPT },
1990
1991 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
1992 { ERR, REQ_SCREEN_UPDATE },
1993
1994 /* Use the ncurses SIGWINCH handler. */
1995 { KEY_RESIZE, REQ_SCREEN_RESIZE },
1996 };
1997
1998 static enum request
1999 get_request(int key)
2000 {
2001 int i;
2002
2003 for (i = 0; i < ARRAY_SIZE(keymap); i++)
2004 if (keymap[i].alias == key)
2005 return keymap[i].request;
2006
2007 return (enum request) key;
2008 }
2009
2010
2011 /*
2012 * Unicode / UTF-8 handling
2013 *
2014 * NOTE: Much of the following code for dealing with unicode is derived from
2015 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
2016 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
2017 */
2018
2019 /* I've (over)annotated a lot of code snippets because I am not entirely
2020 * confident that the approach taken by this small UTF-8 interface is correct.
2021 * --jonas */
2022
2023 static inline int
2024 unicode_width(unsigned long c)
2025 {
2026 if (c >= 0x1100 &&
2027 (c <= 0x115f /* Hangul Jamo */
2028 || c == 0x2329
2029 || c == 0x232a
2030 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
2031 /* CJK ... Yi */
2032 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
2033 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
2034 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
2035 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
2036 || (c >= 0xffe0 && c <= 0xffe6)
2037 || (c >= 0x20000 && c <= 0x2fffd)
2038 || (c >= 0x30000 && c <= 0x3fffd)))
2039 return 2;
2040
2041 return 1;
2042 }
2043
2044 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
2045 * Illegal bytes are set one. */
2046 static const unsigned char utf8_bytes[256] = {
2047 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,
2048 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,
2049 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,
2050 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,
2051 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,
2052 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,
2053 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,
2054 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,
2055 };
2056
2057 /* Decode UTF-8 multi-byte representation into a unicode character. */
2058 static inline unsigned long
2059 utf8_to_unicode(const char *string, size_t length)
2060 {
2061 unsigned long unicode;
2062
2063 switch (length) {
2064 case 1:
2065 unicode = string[0];
2066 break;
2067 case 2:
2068 unicode = (string[0] & 0x1f) << 6;
2069 unicode += (string[1] & 0x3f);
2070 break;
2071 case 3:
2072 unicode = (string[0] & 0x0f) << 12;
2073 unicode += ((string[1] & 0x3f) << 6);
2074 unicode += (string[2] & 0x3f);
2075 break;
2076 case 4:
2077 unicode = (string[0] & 0x0f) << 18;
2078 unicode += ((string[1] & 0x3f) << 12);
2079 unicode += ((string[2] & 0x3f) << 6);
2080 unicode += (string[3] & 0x3f);
2081 break;
2082 case 5:
2083 unicode = (string[0] & 0x0f) << 24;
2084 unicode += ((string[1] & 0x3f) << 18);
2085 unicode += ((string[2] & 0x3f) << 12);
2086 unicode += ((string[3] & 0x3f) << 6);
2087 unicode += (string[4] & 0x3f);
2088 break;
2089 case 6:
2090 unicode = (string[0] & 0x01) << 30;
2091 unicode += ((string[1] & 0x3f) << 24);
2092 unicode += ((string[2] & 0x3f) << 18);
2093 unicode += ((string[3] & 0x3f) << 12);
2094 unicode += ((string[4] & 0x3f) << 6);
2095 unicode += (string[5] & 0x3f);
2096 break;
2097 default:
2098 die("Invalid unicode length");
2099 }
2100
2101 /* Invalid characters could return the special 0xfffd value but NUL
2102 * should be just as good. */
2103 return unicode > 0xffff ? 0 : unicode;
2104 }
2105
2106 /* Calculates how much of string can be shown within the given maximum width
2107 * and sets trimmed parameter to non-zero value if all of string could not be
2108 * shown.
2109 *
2110 * Additionally, adds to coloffset how many many columns to move to align with
2111 * the expected position. Takes into account how multi-byte and double-width
2112 * characters will effect the cursor position.
2113 *
2114 * Returns the number of bytes to output from string to satisfy max_width. */
2115 static size_t
2116 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2117 {
2118 const char *start = string;
2119 const char *end = strchr(string, '\0');
2120 size_t mbwidth = 0;
2121 size_t width = 0;
2122
2123 *trimmed = 0;
2124
2125 while (string < end) {
2126 int c = *(unsigned char *) string;
2127 unsigned char bytes = utf8_bytes[c];
2128 size_t ucwidth;
2129 unsigned long unicode;
2130
2131 if (string + bytes > end)
2132 break;
2133
2134 /* Change representation to figure out whether
2135 * it is a single- or double-width character. */
2136
2137 unicode = utf8_to_unicode(string, bytes);
2138 /* FIXME: Graceful handling of invalid unicode character. */
2139 if (!unicode)
2140 break;
2141
2142 ucwidth = unicode_width(unicode);
2143 width += ucwidth;
2144 if (width > max_width) {
2145 *trimmed = 1;
2146 break;
2147 }
2148
2149 /* The column offset collects the differences between the
2150 * number of bytes encoding a character and the number of
2151 * columns will be used for rendering said character.
2152 *
2153 * So if some character A is encoded in 2 bytes, but will be
2154 * represented on the screen using only 1 byte this will and up
2155 * adding 1 to the multi-byte column offset.
2156 *
2157 * Assumes that no double-width character can be encoding in
2158 * less than two bytes. */
2159 if (bytes > ucwidth)
2160 mbwidth += bytes - ucwidth;
2161
2162 string += bytes;
2163 }
2164
2165 *coloffset += mbwidth;
2166
2167 return string - start;
2168 }
2169
2170
2171 /*
2172 * Status management
2173 */
2174
2175 /* Whether or not the curses interface has been initialized. */
2176 static bool cursed = FALSE;
2177
2178 /* The status window is used for polling keystrokes. */
2179 static WINDOW *status_win;
2180
2181 /* Update status and title window. */
2182 static void
2183 report(const char *msg, ...)
2184 {
2185 static bool empty = TRUE;
2186 struct view *view = display[current_view];
2187
2188 if (!empty || *msg) {
2189 va_list args;
2190
2191 va_start(args, msg);
2192
2193 werase(status_win);
2194 wmove(status_win, 0, 0);
2195 if (*msg) {
2196 vwprintw(status_win, msg, args);
2197 empty = FALSE;
2198 } else {
2199 empty = TRUE;
2200 }
2201 wrefresh(status_win);
2202
2203 va_end(args);
2204 }
2205
2206 update_view_title(view);
2207
2208 /* Move the cursor to the right-most column of the cursor line.
2209 *
2210 * XXX: This could turn out to be a bit expensive, but it ensures that
2211 * the cursor does not jump around. */
2212 if (view->lines) {
2213 wmove(view->win, view->lineno - view->offset, view->width - 1);
2214 wrefresh(view->win);
2215 }
2216 }
2217
2218 /* Controls when nodelay should be in effect when polling user input. */
2219 static void
2220 set_nonblocking_input(bool loading)
2221 {
2222 static unsigned int loading_views;
2223
2224 if ((loading == FALSE && loading_views-- == 1) ||
2225 (loading == TRUE && loading_views++ == 0))
2226 nodelay(status_win, loading);
2227 }
2228
2229 static void
2230 init_display(void)
2231 {
2232 int x, y;
2233
2234 /* Initialize the curses library */
2235 if (isatty(STDIN_FILENO)) {
2236 cursed = !!initscr();
2237 } else {
2238 /* Leave stdin and stdout alone when acting as a pager. */
2239 FILE *io = fopen("/dev/tty", "r+");
2240
2241 cursed = !!newterm(NULL, io, io);
2242 }
2243
2244 if (!cursed)
2245 die("Failed to initialize curses");
2246
2247 nonl(); /* Tell curses not to do NL->CR/NL on output */
2248 cbreak(); /* Take input chars one at a time, no wait for \n */
2249 noecho(); /* Don't echo input */
2250 leaveok(stdscr, TRUE);
2251
2252 if (has_colors())
2253 init_colors();
2254
2255 getmaxyx(stdscr, y, x);
2256 status_win = newwin(1, 0, y - 1, 0);
2257 if (!status_win)
2258 die("Failed to create status window");
2259
2260 /* Enable keyboard mapping */
2261 keypad(status_win, TRUE);
2262 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2263 }
2264
2265
2266 /*
2267 * Repository references
2268 */
2269
2270 static struct ref *refs;
2271 static size_t refs_size;
2272
2273 /* Id <-> ref store */
2274 static struct ref ***id_refs;
2275 static size_t id_refs_size;
2276
2277 static struct ref **
2278 get_refs(char *id)
2279 {
2280 struct ref ***tmp_id_refs;
2281 struct ref **ref_list = NULL;
2282 size_t ref_list_size = 0;
2283 size_t i;
2284
2285 for (i = 0; i < id_refs_size; i++)
2286 if (!strcmp(id, id_refs[i][0]->id))
2287 return id_refs[i];
2288
2289 tmp_id_refs = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2290 if (!tmp_id_refs)
2291 return NULL;
2292
2293 id_refs = tmp_id_refs;
2294
2295 for (i = 0; i < refs_size; i++) {
2296 struct ref **tmp;
2297
2298 if (strcmp(id, refs[i].id))
2299 continue;
2300
2301 tmp = realloc(ref_list, (ref_list_size + 1) * sizeof(*ref_list));
2302 if (!tmp) {
2303 if (ref_list)
2304 free(ref_list);
2305 return NULL;
2306 }
2307
2308 ref_list = tmp;
2309 if (ref_list_size > 0)
2310 ref_list[ref_list_size - 1]->next = 1;
2311 ref_list[ref_list_size] = &refs[i];
2312
2313 /* XXX: The properties of the commit chains ensures that we can
2314 * safely modify the shared ref. The repo references will
2315 * always be similar for the same id. */
2316 ref_list[ref_list_size]->next = 0;
2317 ref_list_size++;
2318 }
2319
2320 if (ref_list)
2321 id_refs[id_refs_size++] = ref_list;
2322
2323 return ref_list;
2324 }
2325
2326 static int
2327 read_ref(char *id, int idlen, char *name, int namelen)
2328 {
2329 struct ref *ref;
2330 bool tag = FALSE;
2331 bool tag_commit = FALSE;
2332
2333 /* Commits referenced by tags has "^{}" appended. */
2334 if (name[namelen - 1] == '}') {
2335 while (namelen > 0 && name[namelen] != '^')
2336 namelen--;
2337 if (namelen > 0)
2338 tag_commit = TRUE;
2339 name[namelen] = 0;
2340 }
2341
2342 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2343 if (!tag_commit)
2344 return OK;
2345 name += STRING_SIZE("refs/tags/");
2346 tag = TRUE;
2347
2348 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2349 name += STRING_SIZE("refs/heads/");
2350
2351 } else if (!strcmp(name, "HEAD")) {
2352 return OK;
2353 }
2354
2355 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2356 if (!refs)
2357 return ERR;
2358
2359 ref = &refs[refs_size++];
2360 ref->name = strdup(name);
2361 if (!ref->name)
2362 return ERR;
2363
2364 ref->tag = tag;
2365 string_copy(ref->id, id);
2366
2367 return OK;
2368 }
2369
2370 static int
2371 load_refs(void)
2372 {
2373 const char *cmd_env = getenv("TIG_LS_REMOTE");
2374 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2375
2376 return read_properties(cmd, '\t', read_ref);
2377 }
2378
2379 static int
2380 read_config_option(char *name, int namelen, char *value, int valuelen)
2381 {
2382 if (!strcmp(name, "i18n.commitencoding")) {
2383 string_copy(opt_encoding, value);
2384 }
2385
2386 return OK;
2387 }
2388
2389 static int
2390 load_config(void)
2391 {
2392 return read_properties("git repo-config --list", '=',
2393 read_config_option);
2394 }
2395
2396 static int
2397 read_properties(const char *cmd, int separator,
2398 int (*read_property)(char *, int, char *, int))
2399 {
2400 FILE *pipe = popen(cmd, "r");
2401 char buffer[BUFSIZ];
2402 char *name;
2403 int state = OK;
2404
2405 if (!pipe)
2406 return ERR;
2407
2408 while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) {
2409 char *value = strchr(name, separator);
2410 int namelen;
2411 int valuelen;
2412
2413 if (value) {
2414 namelen = value - name;
2415 *value++ = 0;
2416 valuelen = strlen(value);
2417 if (valuelen > 0)
2418 value[valuelen - 1] = 0;
2419
2420 } else {
2421 namelen = strlen(name);
2422 value = "";
2423 valuelen = 0;
2424 }
2425
2426 if (namelen)
2427 state = read_property(name, namelen, value, valuelen);
2428 }
2429
2430 if (state != ERR && ferror(pipe))
2431 state = ERR;
2432
2433 pclose(pipe);
2434
2435 return state;
2436 }
2437
2438
2439 /*
2440 * Main
2441 */
2442
2443 #if __GNUC__ >= 3
2444 #define __NORETURN __attribute__((__noreturn__))
2445 #else
2446 #define __NORETURN
2447 #endif
2448
2449 static void __NORETURN
2450 quit(int sig)
2451 {
2452 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2453 if (cursed)
2454 endwin();
2455 exit(0);
2456 }
2457
2458 static void __NORETURN
2459 die(const char *err, ...)
2460 {
2461 va_list args;
2462
2463 endwin();
2464
2465 va_start(args, err);
2466 fputs("tig: ", stderr);
2467 vfprintf(stderr, err, args);
2468 fputs("\n", stderr);
2469 va_end(args);
2470
2471 exit(1);
2472 }
2473
2474 int
2475 main(int argc, char *argv[])
2476 {
2477 struct view *view;
2478 enum request request;
2479 size_t i;
2480
2481 signal(SIGINT, quit);
2482
2483 /* Load the repo config file first so options can be overwritten from
2484 * the command line. */
2485 if (load_config() == ERR)
2486 die("Failed to load repo config.");
2487
2488 if (!parse_options(argc, argv))
2489 return 0;
2490
2491 if (load_refs() == ERR)
2492 die("Failed to load refs.");
2493
2494 /* Require a git repository unless when running in pager mode. */
2495 if (refs_size == 0 && opt_request != REQ_VIEW_PAGER)
2496 die("Not a git repository");
2497
2498 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2499 view->cmd_env = getenv(view->cmd_env);
2500
2501 request = opt_request;
2502
2503 init_display();
2504
2505 while (view_driver(display[current_view], request)) {
2506 int key;
2507 int i;
2508
2509 foreach_view (view, i)
2510 update_view(view);
2511
2512 /* Refresh, accept single keystroke of input */
2513 key = wgetch(status_win);
2514 request = get_request(key);
2515
2516 /* Some low-level request handling. This keeps access to
2517 * status_win restricted. */
2518 switch (request) {
2519 case REQ_PROMPT:
2520 report(":");
2521 /* Temporarily switch to line-oriented and echoed
2522 * input. */
2523 nocbreak();
2524 echo();
2525
2526 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2527 memcpy(opt_cmd, "git ", 4);
2528 opt_request = REQ_VIEW_PAGER;
2529 } else {
2530 request = ERR;
2531 }
2532
2533 noecho();
2534 cbreak();
2535 break;
2536
2537 case REQ_SCREEN_RESIZE:
2538 {
2539 int height, width;
2540
2541 getmaxyx(stdscr, height, width);
2542
2543 /* Resize the status view and let the view driver take
2544 * care of resizing the displayed views. */
2545 wresize(status_win, 1, width);
2546 mvwin(status_win, height - 1, 0);
2547 wrefresh(status_win);
2548 break;
2549 }
2550 default:
2551 break;
2552 }
2553 }
2554
2555 quit(0);
2556
2557 return 0;
2558 }
2559
2560 /**
2561 * [[refspec]]
2562 * Revision specification
2563 * ----------------------
2564 * This section describes various ways to specify what revisions to display
2565 * or otherwise limit the view to. tig(1) does not itself parse the described
2566 * revision options so refer to the relevant git man pages for futher
2567 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2568 * git-rev-list(1).
2569 *
2570 * You can tune the interaction with git by making use of the options
2571 * explained in this section. For example, by configuring the environment
2572 * variables described in the <<view-commands, "View commands">> section.
2573 *
2574 * Limit by path name
2575 * ~~~~~~~~~~~~~~~~~~
2576 * If you are interested only in those revisions that made changes to a
2577 * specific file (or even several files) list the files like this:
2578 *
2579 * $ tig log Makefile README
2580 *
2581 * To avoid ambiguity with repository references such as tag name, be sure
2582 * to separate file names from other git options using "\--". So if you
2583 * have a file named 'master' it will clash with the reference named
2584 * 'master', and thus you will have to use:
2585 *
2586 * $ tig log -- master
2587 *
2588 * NOTE: For the main view, avoiding ambiguity will in some cases require
2589 * you to specify two "\--" options. The first will make tig(1) stop
2590 * option processing and the latter will be passed to git log.
2591 *
2592 * Limit by date or number
2593 * ~~~~~~~~~~~~~~~~~~~~~~~
2594 * To speed up interaction with git, you can limit the amount of commits
2595 * to show both for the log and main view. Either limit by date using
2596 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2597 *
2598 * If you are only interested in changed that happened between two dates
2599 * you can use:
2600 *
2601 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2602 *
2603 * NOTE: If you want to avoid having to quote dates containing spaces you
2604 * can use "." instead, e.g. `--after=May.5th`.
2605 *
2606 * Limiting by commit ranges
2607 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2608 * Alternatively, commits can be limited to a specific range, such as
2609 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2610 *
2611 * $ tig log tag-1.0..tag-2.0
2612 *
2613 * This way of commit limiting makes it trivial to only browse the commits
2614 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2615 * upstream remote branch, using:
2616 *
2617 * $ tig log origin..HEAD
2618 *
2619 * will list what will be pushed to the remote branch. Optionally, the ending
2620 * 'HEAD' can be left out since it is implied.
2621 *
2622 * Limiting by reachability
2623 * ~~~~~~~~~~~~~~~~~~~~~~~~
2624 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2625 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2626 * Where reachability refers to what commits are ancestors (or part of the
2627 * history) of the branch or tagged revision in question.
2628 *
2629 * If you prefer to specify which commit to preview in this way use the
2630 * following:
2631 *
2632 * $ tig log tag-2.0 ^tag-1.0
2633 *
2634 * You can think of '^' as a negation operator. Using this alternate syntax,
2635 * it is possible to further prune commits by specifying multiple branch
2636 * cut offs.
2637 *
2638 * Combining revisions specification
2639 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2640 * Revisions options can to some degree be combined, which makes it possible
2641 * to say "show at most 20 commits from within the last month that changed
2642 * files under the Documentation/ directory."
2643 *
2644 * $ tig -- --since=1.month -n20 -- Documentation/
2645 *
2646 * Examining all repository references
2647 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2648 * In some cases, it can be useful to query changes across all references
2649 * in a repository. An example is to ask "did any line of development in
2650 * this repository change a particular file within the last week". This
2651 * can be accomplished using:
2652 *
2653 * $ tig -- --all --since=1.week -- Makefile
2654 *
2655 * BUGS
2656 * ----
2657 * Known bugs and problems:
2658 *
2659 * - In it's current state tig is pretty much UTF-8 only.
2660 *
2661 * - If the screen width is very small the main view can draw
2662 * outside the current view causing bad wrapping. Same goes
2663 * for title and status windows.
2664 *
2665 * - The cursor can wrap-around on the last line and cause the
2666 * window to scroll.
2667 *
2668 * TODO
2669 * ----
2670 * Features that should be explored.
2671 *
2672 * - Searching.
2673 *
2674 * - Locale support.
2675 *
2676 * COPYRIGHT
2677 * ---------
2678 * Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2679 *
2680 * This program is free software; you can redistribute it and/or modify
2681 * it under the terms of the GNU General Public License as published by
2682 * the Free Software Foundation; either version 2 of the License, or
2683 * (at your option) any later version.
2684 *
2685 * SEE ALSO
2686 * --------
2687 * - link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2688 * - link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2689 *
2690 * Other git repository browsers:
2691 *
2692 * - gitk(1)
2693 * - qgit(1)
2694 * - gitview(1)
2695 **/