Only pass on properies with non-zero length names
[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 wrefresh(view->win);
910 }
911
912 offset += view->height + 1;
913 }
914 }
915
916 static void
917 redraw_display(void)
918 {
919 struct view *view;
920 int i;
921
922 foreach_view (view, i) {
923 redraw_view(view);
924 update_view_title(view);
925 }
926 }
927
928
929 /*
930 * Navigation
931 */
932
933 /* Scrolling backend */
934 static void
935 do_scroll_view(struct view *view, int lines, bool redraw)
936 {
937 /* The rendering expects the new offset. */
938 view->offset += lines;
939
940 assert(0 <= view->offset && view->offset < view->lines);
941 assert(lines);
942
943 /* Redraw the whole screen if scrolling is pointless. */
944 if (view->height < ABS(lines)) {
945 redraw_view(view);
946
947 } else {
948 int line = lines > 0 ? view->height - lines : 0;
949 int end = line + ABS(lines);
950
951 wscrl(view->win, lines);
952
953 for (; line < end; line++) {
954 if (!draw_view_line(view, line))
955 break;
956 }
957 }
958
959 /* Move current line into the view. */
960 if (view->lineno < view->offset) {
961 view->lineno = view->offset;
962 draw_view_line(view, 0);
963
964 } else if (view->lineno >= view->offset + view->height) {
965 if (view->lineno == view->offset + view->height) {
966 /* Clear the hidden line so it doesn't show if the view
967 * is scrolled up. */
968 wmove(view->win, view->height, 0);
969 wclrtoeol(view->win);
970 }
971 view->lineno = view->offset + view->height - 1;
972 draw_view_line(view, view->lineno - view->offset);
973 }
974
975 assert(view->offset <= view->lineno && view->lineno < view->lines);
976
977 if (!redraw)
978 return;
979
980 redrawwin(view->win);
981 wrefresh(view->win);
982 report("");
983 }
984
985 /* Scroll frontend */
986 static void
987 scroll_view(struct view *view, enum request request)
988 {
989 int lines = 1;
990
991 switch (request) {
992 case REQ_SCROLL_PAGE_DOWN:
993 lines = view->height;
994 case REQ_SCROLL_LINE_DOWN:
995 if (view->offset + lines > view->lines)
996 lines = view->lines - view->offset;
997
998 if (lines == 0 || view->offset + view->height >= view->lines) {
999 report("Cannot scroll beyond the last line");
1000 return;
1001 }
1002 break;
1003
1004 case REQ_SCROLL_PAGE_UP:
1005 lines = view->height;
1006 case REQ_SCROLL_LINE_UP:
1007 if (lines > view->offset)
1008 lines = view->offset;
1009
1010 if (lines == 0) {
1011 report("Cannot scroll beyond the first line");
1012 return;
1013 }
1014
1015 lines = -lines;
1016 break;
1017
1018 default:
1019 die("request %d not handled in switch", request);
1020 }
1021
1022 do_scroll_view(view, lines, TRUE);
1023 }
1024
1025 /* Cursor moving */
1026 static void
1027 move_view(struct view *view, enum request request, bool redraw)
1028 {
1029 int steps;
1030
1031 switch (request) {
1032 case REQ_MOVE_FIRST_LINE:
1033 steps = -view->lineno;
1034 break;
1035
1036 case REQ_MOVE_LAST_LINE:
1037 steps = view->lines - view->lineno - 1;
1038 break;
1039
1040 case REQ_MOVE_PAGE_UP:
1041 steps = view->height > view->lineno
1042 ? -view->lineno : -view->height;
1043 break;
1044
1045 case REQ_MOVE_PAGE_DOWN:
1046 steps = view->lineno + view->height >= view->lines
1047 ? view->lines - view->lineno - 1 : view->height;
1048 break;
1049
1050 case REQ_MOVE_UP:
1051 steps = -1;
1052 break;
1053
1054 case REQ_MOVE_DOWN:
1055 steps = 1;
1056 break;
1057
1058 default:
1059 die("request %d not handled in switch", request);
1060 }
1061
1062 if (steps <= 0 && view->lineno == 0) {
1063 report("Cannot move beyond the first line");
1064 return;
1065
1066 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
1067 report("Cannot move beyond the last line");
1068 return;
1069 }
1070
1071 /* Move the current line */
1072 view->lineno += steps;
1073 assert(0 <= view->lineno && view->lineno < view->lines);
1074
1075 /* Repaint the old "current" line if we be scrolling */
1076 if (ABS(steps) < view->height) {
1077 int prev_lineno = view->lineno - steps - view->offset;
1078
1079 wmove(view->win, prev_lineno, 0);
1080 wclrtoeol(view->win);
1081 draw_view_line(view, prev_lineno);
1082 }
1083
1084 /* Check whether the view needs to be scrolled */
1085 if (view->lineno < view->offset ||
1086 view->lineno >= view->offset + view->height) {
1087 if (steps < 0 && -steps > view->offset) {
1088 steps = -view->offset;
1089
1090 } else if (steps > 0) {
1091 if (view->lineno == view->lines - 1 &&
1092 view->lines > view->height) {
1093 steps = view->lines - view->offset - 1;
1094 if (steps >= view->height)
1095 steps -= view->height - 1;
1096 }
1097 }
1098
1099 do_scroll_view(view, steps, redraw);
1100 return;
1101 }
1102
1103 /* Draw the current line */
1104 draw_view_line(view, view->lineno - view->offset);
1105
1106 if (!redraw)
1107 return;
1108
1109 redrawwin(view->win);
1110 wrefresh(view->win);
1111 report("");
1112 }
1113
1114
1115 /*
1116 * Incremental updating
1117 */
1118
1119 static void
1120 end_update(struct view *view)
1121 {
1122 if (!view->pipe)
1123 return;
1124 set_nonblocking_input(FALSE);
1125 if (view->pipe == stdin)
1126 fclose(view->pipe);
1127 else
1128 pclose(view->pipe);
1129 view->pipe = NULL;
1130 }
1131
1132 static bool
1133 begin_update(struct view *view)
1134 {
1135 const char *id = view->id;
1136
1137 if (view->pipe)
1138 end_update(view);
1139
1140 if (opt_cmd[0]) {
1141 string_copy(view->cmd, opt_cmd);
1142 opt_cmd[0] = 0;
1143 /* When running random commands, the view ref could have become
1144 * invalid so clear it. */
1145 view->ref[0] = 0;
1146 } else {
1147 const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1148
1149 if (snprintf(view->cmd, sizeof(view->cmd), format,
1150 id, id, id, id, id) >= sizeof(view->cmd))
1151 return FALSE;
1152 }
1153
1154 /* Special case for the pager view. */
1155 if (opt_pipe) {
1156 view->pipe = opt_pipe;
1157 opt_pipe = NULL;
1158 } else {
1159 view->pipe = popen(view->cmd, "r");
1160 }
1161
1162 if (!view->pipe)
1163 return FALSE;
1164
1165 set_nonblocking_input(TRUE);
1166
1167 view->offset = 0;
1168 view->lines = 0;
1169 view->lineno = 0;
1170 string_copy(view->vid, id);
1171
1172 if (view->line) {
1173 int i;
1174
1175 for (i = 0; i < view->lines; i++)
1176 if (view->line[i].data)
1177 free(view->line[i].data);
1178
1179 free(view->line);
1180 view->line = NULL;
1181 }
1182
1183 view->start_time = time(NULL);
1184
1185 return TRUE;
1186 }
1187
1188 static bool
1189 update_view(struct view *view)
1190 {
1191 char buffer[BUFSIZ];
1192 char *line;
1193 struct line *tmp;
1194 /* The number of lines to read. If too low it will cause too much
1195 * redrawing (and possible flickering), if too high responsiveness
1196 * will suffer. */
1197 unsigned long lines = view->height;
1198 int redraw_from = -1;
1199
1200 if (!view->pipe)
1201 return TRUE;
1202
1203 /* Only redraw if lines are visible. */
1204 if (view->offset + view->height >= view->lines)
1205 redraw_from = view->lines - view->offset;
1206
1207 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1208 if (!tmp)
1209 goto alloc_error;
1210
1211 view->line = tmp;
1212
1213 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
1214 int linelen = strlen(line);
1215
1216 struct line *prev = view->lines
1217 ? &view->line[view->lines - 1]
1218 : NULL;
1219
1220 if (linelen)
1221 line[linelen - 1] = 0;
1222
1223 if (!view->ops->read(view, prev, line))
1224 goto alloc_error;
1225
1226 if (lines-- == 1)
1227 break;
1228 }
1229
1230 {
1231 int digits;
1232
1233 lines = view->lines;
1234 for (digits = 0; lines; digits++)
1235 lines /= 10;
1236
1237 /* Keep the displayed view in sync with line number scaling. */
1238 if (digits != view->digits) {
1239 view->digits = digits;
1240 redraw_from = 0;
1241 }
1242 }
1243
1244 if (redraw_from >= 0) {
1245 /* If this is an incremental update, redraw the previous line
1246 * since for commits some members could have changed when
1247 * loading the main view. */
1248 if (redraw_from > 0)
1249 redraw_from--;
1250
1251 /* Incrementally draw avoids flickering. */
1252 redraw_view_from(view, redraw_from);
1253 }
1254
1255 /* Update the title _after_ the redraw so that if the redraw picks up a
1256 * commit reference in view->ref it'll be available here. */
1257 update_view_title(view);
1258
1259 if (ferror(view->pipe)) {
1260 report("Failed to read: %s", strerror(errno));
1261 goto end;
1262
1263 } else if (feof(view->pipe)) {
1264 if (view == VIEW(REQ_VIEW_HELP)) {
1265 const char *msg = TIG_HELP;
1266
1267 if (view->lines == 0) {
1268 /* Slightly ugly, but abusing view->ref keeps
1269 * the error message. */
1270 string_copy(view->ref, "No help available");
1271 msg = "The tig(1) manpage is not installed";
1272 }
1273
1274 report("%s", msg);
1275 goto end;
1276 }
1277
1278 report("");
1279 goto end;
1280 }
1281
1282 return TRUE;
1283
1284 alloc_error:
1285 report("Allocation failure");
1286
1287 end:
1288 end_update(view);
1289 return FALSE;
1290 }
1291
1292 enum open_flags {
1293 OPEN_DEFAULT = 0, /* Use default view switching. */
1294 OPEN_SPLIT = 1, /* Split current view. */
1295 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1296 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1297 };
1298
1299 static void
1300 open_view(struct view *prev, enum request request, enum open_flags flags)
1301 {
1302 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1303 bool split = !!(flags & OPEN_SPLIT);
1304 bool reload = !!(flags & OPEN_RELOAD);
1305 struct view *view = VIEW(request);
1306 int nviews = displayed_views();
1307 struct view *base_view = display[0];
1308
1309 if (view == prev && nviews == 1 && !reload) {
1310 report("Already in %s view", view->name);
1311 return;
1312 }
1313
1314 if ((reload || strcmp(view->vid, view->id)) &&
1315 !begin_update(view)) {
1316 report("Failed to load %s view", view->name);
1317 return;
1318 }
1319
1320 if (split) {
1321 display[current_view + 1] = view;
1322 if (!backgrounded)
1323 current_view++;
1324 } else {
1325 /* Maximize the current view. */
1326 memset(display, 0, sizeof(display));
1327 current_view = 0;
1328 display[current_view] = view;
1329 }
1330
1331 /* Resize the view when switching between split- and full-screen,
1332 * or when switching between two different full-screen views. */
1333 if (nviews != displayed_views() ||
1334 (nviews == 1 && base_view != display[0]))
1335 resize_display();
1336
1337 if (split && prev->lineno - prev->offset >= prev->height) {
1338 /* Take the title line into account. */
1339 int lines = prev->lineno - prev->offset - prev->height + 1;
1340
1341 /* Scroll the view that was split if the current line is
1342 * outside the new limited view. */
1343 do_scroll_view(prev, lines, TRUE);
1344 }
1345
1346 if (prev && view != prev) {
1347 /* Continue loading split views in the background. */
1348 if (!split)
1349 end_update(prev);
1350 else if (!backgrounded)
1351 /* "Blur" the previous view. */
1352 update_view_title(prev);
1353
1354 view->parent = prev;
1355 }
1356
1357 if (view->pipe) {
1358 /* Clear the old view and let the incremental updating refill
1359 * the screen. */
1360 wclear(view->win);
1361 report("");
1362 } else {
1363 redraw_view(view);
1364 if (view == VIEW(REQ_VIEW_HELP))
1365 report("%s", TIG_HELP);
1366 else
1367 report("");
1368 }
1369
1370 /* If the view is backgrounded the above calls to report()
1371 * won't redraw the view title. */
1372 if (backgrounded)
1373 update_view_title(view);
1374 }
1375
1376
1377 /*
1378 * User request switch noodle
1379 */
1380
1381 static int
1382 view_driver(struct view *view, enum request request)
1383 {
1384 int i;
1385
1386 switch (request) {
1387 case REQ_MOVE_UP:
1388 case REQ_MOVE_DOWN:
1389 case REQ_MOVE_PAGE_UP:
1390 case REQ_MOVE_PAGE_DOWN:
1391 case REQ_MOVE_FIRST_LINE:
1392 case REQ_MOVE_LAST_LINE:
1393 move_view(view, request, TRUE);
1394 break;
1395
1396 case REQ_SCROLL_LINE_DOWN:
1397 case REQ_SCROLL_LINE_UP:
1398 case REQ_SCROLL_PAGE_DOWN:
1399 case REQ_SCROLL_PAGE_UP:
1400 scroll_view(view, request);
1401 break;
1402
1403 case REQ_VIEW_MAIN:
1404 case REQ_VIEW_DIFF:
1405 case REQ_VIEW_LOG:
1406 case REQ_VIEW_HELP:
1407 case REQ_VIEW_PAGER:
1408 open_view(view, request, OPEN_DEFAULT);
1409 break;
1410
1411 case REQ_NEXT:
1412 case REQ_PREVIOUS:
1413 request = request == REQ_NEXT ? REQ_MOVE_DOWN : REQ_MOVE_UP;
1414
1415 if (view == VIEW(REQ_VIEW_DIFF) &&
1416 view->parent == VIEW(REQ_VIEW_MAIN)) {
1417 bool redraw = display[1] == view;
1418
1419 view = view->parent;
1420 move_view(view, request, redraw);
1421 if (redraw)
1422 update_view_title(view);
1423 } else {
1424 move_view(view, request, TRUE);
1425 break;
1426 }
1427 /* Fall-through */
1428
1429 case REQ_ENTER:
1430 if (!view->lines) {
1431 report("Nothing to enter");
1432 break;
1433 }
1434 return view->ops->enter(view, &view->line[view->lineno]);
1435
1436 case REQ_VIEW_NEXT:
1437 {
1438 int nviews = displayed_views();
1439 int next_view = (current_view + 1) % nviews;
1440
1441 if (next_view == current_view) {
1442 report("Only one view is displayed");
1443 break;
1444 }
1445
1446 current_view = next_view;
1447 /* Blur out the title of the previous view. */
1448 update_view_title(view);
1449 report("");
1450 break;
1451 }
1452 case REQ_TOGGLE_LINE_NUMBERS:
1453 opt_line_number = !opt_line_number;
1454 redraw_display();
1455 break;
1456
1457 case REQ_PROMPT:
1458 /* Always reload^Wrerun commands from the prompt. */
1459 open_view(view, opt_request, OPEN_RELOAD);
1460 break;
1461
1462 case REQ_STOP_LOADING:
1463 foreach_view (view, i) {
1464 if (view->pipe)
1465 report("Stopped loaded the %s view", view->name),
1466 end_update(view);
1467 }
1468 break;
1469
1470 case REQ_SHOW_VERSION:
1471 report("%s (built %s)", VERSION, __DATE__);
1472 return TRUE;
1473
1474 case REQ_SCREEN_RESIZE:
1475 resize_display();
1476 /* Fall-through */
1477 case REQ_SCREEN_REDRAW:
1478 redraw_display();
1479 break;
1480
1481 case REQ_SCREEN_UPDATE:
1482 doupdate();
1483 return TRUE;
1484
1485 case REQ_VIEW_CLOSE:
1486 if (view->parent) {
1487 memset(display, 0, sizeof(display));
1488 current_view = 0;
1489 display[current_view] = view->parent;
1490 view->parent = NULL;
1491 resize_display();
1492 redraw_display();
1493 break;
1494 }
1495 /* Fall-through */
1496 case REQ_QUIT:
1497 return FALSE;
1498
1499 default:
1500 /* An unknown key will show most commonly used commands. */
1501 report("Unknown key, press 'h' for help");
1502 return TRUE;
1503 }
1504
1505 return TRUE;
1506 }
1507
1508
1509 /*
1510 * Pager backend
1511 */
1512
1513 static bool
1514 pager_draw(struct view *view, struct line *line, unsigned int lineno)
1515 {
1516 char *text = line->data;
1517 enum line_type type = line->type;
1518 int textlen = strlen(text);
1519 int attr;
1520
1521 wmove(view->win, lineno, 0);
1522
1523 if (view->offset + lineno == view->lineno) {
1524 if (type == LINE_COMMIT) {
1525 string_copy(view->ref, text + 7);
1526 string_copy(ref_commit, view->ref);
1527 }
1528
1529 type = LINE_CURSOR;
1530 wchgat(view->win, -1, 0, type, NULL);
1531 }
1532
1533 attr = get_line_attr(type);
1534 wattrset(view->win, attr);
1535
1536 if (opt_line_number || opt_tab_size < TABSIZE) {
1537 static char spaces[] = " ";
1538 int col_offset = 0, col = 0;
1539
1540 if (opt_line_number) {
1541 unsigned long real_lineno = view->offset + lineno + 1;
1542
1543 if (real_lineno == 1 ||
1544 (real_lineno % opt_num_interval) == 0) {
1545 wprintw(view->win, "%.*d", view->digits, real_lineno);
1546
1547 } else {
1548 waddnstr(view->win, spaces,
1549 MIN(view->digits, STRING_SIZE(spaces)));
1550 }
1551 waddstr(view->win, ": ");
1552 col_offset = view->digits + 2;
1553 }
1554
1555 while (text && col_offset + col < view->width) {
1556 int cols_max = view->width - col_offset - col;
1557 char *pos = text;
1558 int cols;
1559
1560 if (*text == '\t') {
1561 text++;
1562 assert(sizeof(spaces) > TABSIZE);
1563 pos = spaces;
1564 cols = opt_tab_size - (col % opt_tab_size);
1565
1566 } else {
1567 text = strchr(text, '\t');
1568 cols = line ? text - pos : strlen(pos);
1569 }
1570
1571 waddnstr(view->win, pos, MIN(cols, cols_max));
1572 col += cols;
1573 }
1574
1575 } else {
1576 int col = 0, pos = 0;
1577
1578 for (; pos < textlen && col < view->width; pos++, col++)
1579 if (text[pos] == '\t')
1580 col += TABSIZE - (col % TABSIZE) - 1;
1581
1582 waddnstr(view->win, text, pos);
1583 }
1584
1585 return TRUE;
1586 }
1587
1588 static bool
1589 pager_read(struct view *view, struct line *prev, char *line)
1590 {
1591 /* Compress empty lines in the help view. */
1592 if (view == VIEW(REQ_VIEW_HELP) &&
1593 !*line && prev && !*((char *) prev->data))
1594 return TRUE;
1595
1596 view->line[view->lines].data = strdup(line);
1597 if (!view->line[view->lines].data)
1598 return FALSE;
1599
1600 view->line[view->lines].type = get_line_type(line);
1601
1602 view->lines++;
1603 return TRUE;
1604 }
1605
1606 static bool
1607 pager_enter(struct view *view, struct line *line)
1608 {
1609 int split = 0;
1610
1611 if (line->type == LINE_COMMIT &&
1612 (view == VIEW(REQ_VIEW_LOG) ||
1613 view == VIEW(REQ_VIEW_PAGER))) {
1614 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT);
1615 split = 1;
1616 }
1617
1618 /* Always scroll the view even if it was split. That way
1619 * you can use Enter to scroll through the log view and
1620 * split open each commit diff. */
1621 scroll_view(view, REQ_SCROLL_LINE_DOWN);
1622
1623 /* FIXME: A minor workaround. Scrolling the view will call report("")
1624 * but if we are scrolling a non-current view this won't properly
1625 * update the view title. */
1626 if (split)
1627 update_view_title(view);
1628
1629 return TRUE;
1630 }
1631
1632 static struct view_ops pager_ops = {
1633 "line",
1634 pager_draw,
1635 pager_read,
1636 pager_enter,
1637 };
1638
1639
1640 /*
1641 * Main view backend
1642 */
1643
1644 struct commit {
1645 char id[41]; /* SHA1 ID. */
1646 char title[75]; /* The first line of the commit message. */
1647 char author[75]; /* The author of the commit. */
1648 struct tm time; /* Date from the author ident. */
1649 struct ref **refs; /* Repository references; tags & branch heads. */
1650 };
1651
1652 static bool
1653 main_draw(struct view *view, struct line *line, unsigned int lineno)
1654 {
1655 char buf[DATE_COLS + 1];
1656 struct commit *commit = line->data;
1657 enum line_type type;
1658 int col = 0;
1659 size_t timelen;
1660 size_t authorlen;
1661 int trimmed = 1;
1662
1663 if (!*commit->author)
1664 return FALSE;
1665
1666 wmove(view->win, lineno, col);
1667
1668 if (view->offset + lineno == view->lineno) {
1669 string_copy(view->ref, commit->id);
1670 string_copy(ref_commit, view->ref);
1671 type = LINE_CURSOR;
1672 wattrset(view->win, get_line_attr(type));
1673 wchgat(view->win, -1, 0, type, NULL);
1674
1675 } else {
1676 type = LINE_MAIN_COMMIT;
1677 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1678 }
1679
1680 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
1681 waddnstr(view->win, buf, timelen);
1682 waddstr(view->win, " ");
1683
1684 col += DATE_COLS;
1685 wmove(view->win, lineno, col);
1686 if (type != LINE_CURSOR)
1687 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1688
1689 if (opt_utf8) {
1690 authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed);
1691 } else {
1692 authorlen = strlen(commit->author);
1693 if (authorlen > AUTHOR_COLS - 2) {
1694 authorlen = AUTHOR_COLS - 2;
1695 trimmed = 1;
1696 }
1697 }
1698
1699 if (trimmed) {
1700 waddnstr(view->win, commit->author, authorlen);
1701 if (type != LINE_CURSOR)
1702 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1703 waddch(view->win, '~');
1704 } else {
1705 waddstr(view->win, commit->author);
1706 }
1707
1708 col += AUTHOR_COLS;
1709 if (type != LINE_CURSOR)
1710 wattrset(view->win, A_NORMAL);
1711
1712 mvwaddch(view->win, lineno, col, ACS_LTEE);
1713 wmove(view->win, lineno, col + 2);
1714 col += 2;
1715
1716 if (commit->refs) {
1717 size_t i = 0;
1718
1719 do {
1720 if (type == LINE_CURSOR)
1721 ;
1722 else if (commit->refs[i]->tag)
1723 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1724 else
1725 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1726 waddstr(view->win, "[");
1727 waddstr(view->win, commit->refs[i]->name);
1728 waddstr(view->win, "]");
1729 if (type != LINE_CURSOR)
1730 wattrset(view->win, A_NORMAL);
1731 waddstr(view->win, " ");
1732 col += strlen(commit->refs[i]->name) + STRING_SIZE("[] ");
1733 } while (commit->refs[i++]->next);
1734 }
1735
1736 if (type != LINE_CURSOR)
1737 wattrset(view->win, get_line_attr(type));
1738
1739 {
1740 int titlelen = strlen(commit->title);
1741
1742 if (col + titlelen > view->width)
1743 titlelen = view->width - col;
1744
1745 waddnstr(view->win, commit->title, titlelen);
1746 }
1747
1748 return TRUE;
1749 }
1750
1751 /* Reads git log --pretty=raw output and parses it into the commit struct. */
1752 static bool
1753 main_read(struct view *view, struct line *prev, char *line)
1754 {
1755 enum line_type type = get_line_type(line);
1756 struct commit *commit;
1757
1758 switch (type) {
1759 case LINE_COMMIT:
1760 commit = calloc(1, sizeof(struct commit));
1761 if (!commit)
1762 return FALSE;
1763
1764 line += STRING_SIZE("commit ");
1765
1766 view->line[view->lines++].data = commit;
1767 string_copy(commit->id, line);
1768 commit->refs = get_refs(commit->id);
1769 break;
1770
1771 case LINE_AUTHOR:
1772 {
1773 char *ident = line + STRING_SIZE("author ");
1774 char *end = strchr(ident, '<');
1775
1776 if (!prev)
1777 break;
1778
1779 commit = prev->data;
1780
1781 if (end) {
1782 for (; end > ident && isspace(end[-1]); end--) ;
1783 *end = 0;
1784 }
1785
1786 string_copy(commit->author, ident);
1787
1788 /* Parse epoch and timezone */
1789 if (end) {
1790 char *secs = strchr(end + 1, '>');
1791 char *zone;
1792 time_t time;
1793
1794 if (!secs || secs[1] != ' ')
1795 break;
1796
1797 secs += 2;
1798 time = (time_t) atol(secs);
1799 zone = strchr(secs, ' ');
1800 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
1801 long tz;
1802
1803 zone++;
1804 tz = ('0' - zone[1]) * 60 * 60 * 10;
1805 tz += ('0' - zone[2]) * 60 * 60;
1806 tz += ('0' - zone[3]) * 60;
1807 tz += ('0' - zone[4]) * 60;
1808
1809 if (zone[0] == '-')
1810 tz = -tz;
1811
1812 time -= tz;
1813 }
1814 gmtime_r(&time, &commit->time);
1815 }
1816 break;
1817 }
1818 default:
1819 if (!prev)
1820 break;
1821
1822 commit = prev->data;
1823
1824 /* Fill in the commit title if it has not already been set. */
1825 if (commit->title[0])
1826 break;
1827
1828 /* Require titles to start with a non-space character at the
1829 * offset used by git log. */
1830 /* FIXME: More gracefull handling of titles; append "..." to
1831 * shortened titles, etc. */
1832 if (strncmp(line, " ", 4) ||
1833 isspace(line[4]))
1834 break;
1835
1836 string_copy(commit->title, line + 4);
1837 }
1838
1839 return TRUE;
1840 }
1841
1842 static bool
1843 main_enter(struct view *view, struct line *line)
1844 {
1845 enum open_flags flags = display[0] == view ? OPEN_SPLIT : OPEN_DEFAULT;
1846
1847 open_view(view, REQ_VIEW_DIFF, flags);
1848 return TRUE;
1849 }
1850
1851 static struct view_ops main_ops = {
1852 "commit",
1853 main_draw,
1854 main_read,
1855 main_enter,
1856 };
1857
1858
1859 /**
1860 * KEYS
1861 * ----
1862 * Below the default key bindings are shown.
1863 **/
1864
1865 struct keymap {
1866 int alias;
1867 int request;
1868 };
1869
1870 static struct keymap keymap[] = {
1871 /**
1872 * View switching
1873 * ~~~~~~~~~~~~~~
1874 * m::
1875 * Switch to main view.
1876 * d::
1877 * Switch to diff view.
1878 * l::
1879 * Switch to log view.
1880 * p::
1881 * Switch to pager view.
1882 * h::
1883 * Show man page.
1884 **/
1885 { 'm', REQ_VIEW_MAIN },
1886 { 'd', REQ_VIEW_DIFF },
1887 { 'l', REQ_VIEW_LOG },
1888 { 'p', REQ_VIEW_PAGER },
1889 { 'h', REQ_VIEW_HELP },
1890
1891 /**
1892 * View manipulation
1893 * ~~~~~~~~~~~~~~~~~
1894 * q::
1895 * Close view, if multiple views are open it will jump back to the
1896 * previous view in the view stack. If it is the last open view it
1897 * will quit. Use 'Q' to quit all views at once.
1898 * Enter::
1899 * This key is "context sensitive" depending on what view you are
1900 * currently in. When in log view on a commit line or in the main
1901 * view, split the view and show the commit diff. In the diff view
1902 * pressing Enter will simply scroll the view one line down.
1903 * Tab::
1904 * Switch to next view.
1905 * Up::
1906 * This key is "context sensitive" and will move the cursor one
1907 * line up. However, uf you opened a diff view from the main view
1908 * (split- or full-screen) it will change the cursor to point to
1909 * the previous commit in the main view and update the diff view
1910 * to display it.
1911 * Down::
1912 * Similar to 'Up' but will move down.
1913 **/
1914 { 'q', REQ_VIEW_CLOSE },
1915 { KEY_TAB, REQ_VIEW_NEXT },
1916 { KEY_RETURN, REQ_ENTER },
1917 { KEY_UP, REQ_PREVIOUS },
1918 { KEY_DOWN, REQ_NEXT },
1919
1920 /**
1921 * Cursor navigation
1922 * ~~~~~~~~~~~~~~~~~
1923 * j::
1924 * Move cursor one line up.
1925 * k::
1926 * Move cursor one line down.
1927 * PgUp::
1928 * b::
1929 * -::
1930 * Move cursor one page up.
1931 * PgDown::
1932 * Space::
1933 * Move cursor one page down.
1934 * Home::
1935 * Jump to first line.
1936 * End::
1937 * Jump to last line.
1938 **/
1939 { 'k', REQ_MOVE_UP },
1940 { 'j', REQ_MOVE_DOWN },
1941 { KEY_HOME, REQ_MOVE_FIRST_LINE },
1942 { KEY_END, REQ_MOVE_LAST_LINE },
1943 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
1944 { ' ', REQ_MOVE_PAGE_DOWN },
1945 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
1946 { 'b', REQ_MOVE_PAGE_UP },
1947 { '-', REQ_MOVE_PAGE_UP },
1948
1949 /**
1950 * Scrolling
1951 * ~~~~~~~~~
1952 * Insert::
1953 * Scroll view one line up.
1954 * Delete::
1955 * Scroll view one line down.
1956 * w::
1957 * Scroll view one page up.
1958 * s::
1959 * Scroll view one page down.
1960 **/
1961 { KEY_IC, REQ_SCROLL_LINE_UP },
1962 { KEY_DC, REQ_SCROLL_LINE_DOWN },
1963 { 'w', REQ_SCROLL_PAGE_UP },
1964 { 's', REQ_SCROLL_PAGE_DOWN },
1965
1966 /**
1967 * Misc
1968 * ~~~~
1969 * Q::
1970 * Quit.
1971 * r::
1972 * Redraw screen.
1973 * z::
1974 * Stop all background loading. This can be useful if you use
1975 * tig(1) in a repository with a long history without limiting
1976 * the revision log.
1977 * v::
1978 * Show version.
1979 * n::
1980 * Toggle line numbers on/off.
1981 * ':'::
1982 * Open prompt. This allows you to specify what git command
1983 * to run. Example:
1984 *
1985 * :log -p
1986 **/
1987 { 'Q', REQ_QUIT },
1988 { 'z', REQ_STOP_LOADING },
1989 { 'v', REQ_SHOW_VERSION },
1990 { 'r', REQ_SCREEN_REDRAW },
1991 { 'n', REQ_TOGGLE_LINE_NUMBERS },
1992 { ':', REQ_PROMPT },
1993
1994 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
1995 { ERR, REQ_SCREEN_UPDATE },
1996
1997 /* Use the ncurses SIGWINCH handler. */
1998 { KEY_RESIZE, REQ_SCREEN_RESIZE },
1999 };
2000
2001 static enum request
2002 get_request(int key)
2003 {
2004 int i;
2005
2006 for (i = 0; i < ARRAY_SIZE(keymap); i++)
2007 if (keymap[i].alias == key)
2008 return keymap[i].request;
2009
2010 return (enum request) key;
2011 }
2012
2013
2014 /*
2015 * Unicode / UTF-8 handling
2016 *
2017 * NOTE: Much of the following code for dealing with unicode is derived from
2018 * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. Origin file is
2019 * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28.
2020 */
2021
2022 /* I've (over)annotated a lot of code snippets because I am not entirely
2023 * confident that the approach taken by this small UTF-8 interface is correct.
2024 * --jonas */
2025
2026 static inline int
2027 unicode_width(unsigned long c)
2028 {
2029 if (c >= 0x1100 &&
2030 (c <= 0x115f /* Hangul Jamo */
2031 || c == 0x2329
2032 || c == 0x232a
2033 || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f)
2034 /* CJK ... Yi */
2035 || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */
2036 || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */
2037 || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */
2038 || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */
2039 || (c >= 0xffe0 && c <= 0xffe6)
2040 || (c >= 0x20000 && c <= 0x2fffd)
2041 || (c >= 0x30000 && c <= 0x3fffd)))
2042 return 2;
2043
2044 return 1;
2045 }
2046
2047 /* Number of bytes used for encoding a UTF-8 character indexed by first byte.
2048 * Illegal bytes are set one. */
2049 static const unsigned char utf8_bytes[256] = {
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 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,
2054 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,
2055 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,
2056 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,
2057 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,
2058 };
2059
2060 /* Decode UTF-8 multi-byte representation into a unicode character. */
2061 static inline unsigned long
2062 utf8_to_unicode(const char *string, size_t length)
2063 {
2064 unsigned long unicode;
2065
2066 switch (length) {
2067 case 1:
2068 unicode = string[0];
2069 break;
2070 case 2:
2071 unicode = (string[0] & 0x1f) << 6;
2072 unicode += (string[1] & 0x3f);
2073 break;
2074 case 3:
2075 unicode = (string[0] & 0x0f) << 12;
2076 unicode += ((string[1] & 0x3f) << 6);
2077 unicode += (string[2] & 0x3f);
2078 break;
2079 case 4:
2080 unicode = (string[0] & 0x0f) << 18;
2081 unicode += ((string[1] & 0x3f) << 12);
2082 unicode += ((string[2] & 0x3f) << 6);
2083 unicode += (string[3] & 0x3f);
2084 break;
2085 case 5:
2086 unicode = (string[0] & 0x0f) << 24;
2087 unicode += ((string[1] & 0x3f) << 18);
2088 unicode += ((string[2] & 0x3f) << 12);
2089 unicode += ((string[3] & 0x3f) << 6);
2090 unicode += (string[4] & 0x3f);
2091 break;
2092 case 6:
2093 unicode = (string[0] & 0x01) << 30;
2094 unicode += ((string[1] & 0x3f) << 24);
2095 unicode += ((string[2] & 0x3f) << 18);
2096 unicode += ((string[3] & 0x3f) << 12);
2097 unicode += ((string[4] & 0x3f) << 6);
2098 unicode += (string[5] & 0x3f);
2099 break;
2100 default:
2101 die("Invalid unicode length");
2102 }
2103
2104 /* Invalid characters could return the special 0xfffd value but NUL
2105 * should be just as good. */
2106 return unicode > 0xffff ? 0 : unicode;
2107 }
2108
2109 /* Calculates how much of string can be shown within the given maximum width
2110 * and sets trimmed parameter to non-zero value if all of string could not be
2111 * shown.
2112 *
2113 * Additionally, adds to coloffset how many many columns to move to align with
2114 * the expected position. Takes into account how multi-byte and double-width
2115 * characters will effect the cursor position.
2116 *
2117 * Returns the number of bytes to output from string to satisfy max_width. */
2118 static size_t
2119 utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed)
2120 {
2121 const char *start = string;
2122 const char *end = strchr(string, '\0');
2123 size_t mbwidth = 0;
2124 size_t width = 0;
2125
2126 *trimmed = 0;
2127
2128 while (string < end) {
2129 int c = *(unsigned char *) string;
2130 unsigned char bytes = utf8_bytes[c];
2131 size_t ucwidth;
2132 unsigned long unicode;
2133
2134 if (string + bytes > end)
2135 break;
2136
2137 /* Change representation to figure out whether
2138 * it is a single- or double-width character. */
2139
2140 unicode = utf8_to_unicode(string, bytes);
2141 /* FIXME: Graceful handling of invalid unicode character. */
2142 if (!unicode)
2143 break;
2144
2145 ucwidth = unicode_width(unicode);
2146 width += ucwidth;
2147 if (width > max_width) {
2148 *trimmed = 1;
2149 break;
2150 }
2151
2152 /* The column offset collects the differences between the
2153 * number of bytes encoding a character and the number of
2154 * columns will be used for rendering said character.
2155 *
2156 * So if some character A is encoded in 2 bytes, but will be
2157 * represented on the screen using only 1 byte this will and up
2158 * adding 1 to the multi-byte column offset.
2159 *
2160 * Assumes that no double-width character can be encoding in
2161 * less than two bytes. */
2162 if (bytes > ucwidth)
2163 mbwidth += bytes - ucwidth;
2164
2165 string += bytes;
2166 }
2167
2168 *coloffset += mbwidth;
2169
2170 return string - start;
2171 }
2172
2173
2174 /*
2175 * Status management
2176 */
2177
2178 /* Whether or not the curses interface has been initialized. */
2179 static bool cursed = FALSE;
2180
2181 /* The status window is used for polling keystrokes. */
2182 static WINDOW *status_win;
2183
2184 /* Update status and title window. */
2185 static void
2186 report(const char *msg, ...)
2187 {
2188 static bool empty = TRUE;
2189 struct view *view = display[current_view];
2190
2191 if (!empty || *msg) {
2192 va_list args;
2193
2194 va_start(args, msg);
2195
2196 werase(status_win);
2197 wmove(status_win, 0, 0);
2198 if (*msg) {
2199 vwprintw(status_win, msg, args);
2200 empty = FALSE;
2201 } else {
2202 empty = TRUE;
2203 }
2204 wrefresh(status_win);
2205
2206 va_end(args);
2207 }
2208
2209 update_view_title(view);
2210
2211 /* Move the cursor to the right-most column of the cursor line.
2212 *
2213 * XXX: This could turn out to be a bit expensive, but it ensures that
2214 * the cursor does not jump around. */
2215 if (view->lines) {
2216 wmove(view->win, view->lineno - view->offset, view->width - 1);
2217 wrefresh(view->win);
2218 }
2219 }
2220
2221 /* Controls when nodelay should be in effect when polling user input. */
2222 static void
2223 set_nonblocking_input(bool loading)
2224 {
2225 static unsigned int loading_views;
2226
2227 if ((loading == FALSE && loading_views-- == 1) ||
2228 (loading == TRUE && loading_views++ == 0))
2229 nodelay(status_win, loading);
2230 }
2231
2232 static void
2233 init_display(void)
2234 {
2235 int x, y;
2236
2237 /* Initialize the curses library */
2238 if (isatty(STDIN_FILENO)) {
2239 cursed = !!initscr();
2240 } else {
2241 /* Leave stdin and stdout alone when acting as a pager. */
2242 FILE *io = fopen("/dev/tty", "r+");
2243
2244 cursed = !!newterm(NULL, io, io);
2245 }
2246
2247 if (!cursed)
2248 die("Failed to initialize curses");
2249
2250 nonl(); /* Tell curses not to do NL->CR/NL on output */
2251 cbreak(); /* Take input chars one at a time, no wait for \n */
2252 noecho(); /* Don't echo input */
2253 leaveok(stdscr, TRUE);
2254
2255 if (has_colors())
2256 init_colors();
2257
2258 getmaxyx(stdscr, y, x);
2259 status_win = newwin(1, 0, y - 1, 0);
2260 if (!status_win)
2261 die("Failed to create status window");
2262
2263 /* Enable keyboard mapping */
2264 keypad(status_win, TRUE);
2265 wbkgdset(status_win, get_line_attr(LINE_STATUS));
2266 }
2267
2268
2269 /*
2270 * Repository references
2271 */
2272
2273 static struct ref *refs;
2274 static size_t refs_size;
2275
2276 /* Id <-> ref store */
2277 static struct ref ***id_refs;
2278 static size_t id_refs_size;
2279
2280 static struct ref **
2281 get_refs(char *id)
2282 {
2283 struct ref ***tmp_id_refs;
2284 struct ref **ref_list = NULL;
2285 size_t ref_list_size = 0;
2286 size_t i;
2287
2288 for (i = 0; i < id_refs_size; i++)
2289 if (!strcmp(id, id_refs[i][0]->id))
2290 return id_refs[i];
2291
2292 tmp_id_refs = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
2293 if (!tmp_id_refs)
2294 return NULL;
2295
2296 id_refs = tmp_id_refs;
2297
2298 for (i = 0; i < refs_size; i++) {
2299 struct ref **tmp;
2300
2301 if (strcmp(id, refs[i].id))
2302 continue;
2303
2304 tmp = realloc(ref_list, (ref_list_size + 1) * sizeof(*ref_list));
2305 if (!tmp) {
2306 if (ref_list)
2307 free(ref_list);
2308 return NULL;
2309 }
2310
2311 ref_list = tmp;
2312 if (ref_list_size > 0)
2313 ref_list[ref_list_size - 1]->next = 1;
2314 ref_list[ref_list_size] = &refs[i];
2315
2316 /* XXX: The properties of the commit chains ensures that we can
2317 * safely modify the shared ref. The repo references will
2318 * always be similar for the same id. */
2319 ref_list[ref_list_size]->next = 0;
2320 ref_list_size++;
2321 }
2322
2323 if (ref_list)
2324 id_refs[id_refs_size++] = ref_list;
2325
2326 return ref_list;
2327 }
2328
2329 static int
2330 read_ref(char *id, int idlen, char *name, int namelen)
2331 {
2332 struct ref *ref;
2333 bool tag = FALSE;
2334 bool tag_commit = FALSE;
2335
2336 /* Commits referenced by tags has "^{}" appended. */
2337 if (name[namelen - 1] == '}') {
2338 while (namelen > 0 && name[namelen] != '^')
2339 namelen--;
2340 if (namelen > 0)
2341 tag_commit = TRUE;
2342 name[namelen] = 0;
2343 }
2344
2345 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
2346 if (!tag_commit)
2347 return OK;
2348 name += STRING_SIZE("refs/tags/");
2349 tag = TRUE;
2350
2351 } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
2352 name += STRING_SIZE("refs/heads/");
2353
2354 } else if (!strcmp(name, "HEAD")) {
2355 return OK;
2356 }
2357
2358 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
2359 if (!refs)
2360 return ERR;
2361
2362 ref = &refs[refs_size++];
2363 ref->name = strdup(name);
2364 if (!ref->name)
2365 return ERR;
2366
2367 ref->tag = tag;
2368 string_copy(ref->id, id);
2369
2370 return OK;
2371 }
2372
2373 static int
2374 load_refs(void)
2375 {
2376 const char *cmd_env = getenv("TIG_LS_REMOTE");
2377 const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
2378
2379 return read_properties(cmd, '\t', read_ref);
2380 }
2381
2382 static int
2383 read_config_option(char *name, int namelen, char *value, int valuelen)
2384 {
2385 if (!strcmp(name, "i18n.commitencoding")) {
2386 string_copy(opt_encoding, value);
2387 }
2388
2389 return OK;
2390 }
2391
2392 static int
2393 load_config(void)
2394 {
2395 return read_properties("git repo-config --list", '=',
2396 read_config_option);
2397 }
2398
2399 static int
2400 read_properties(const char *cmd, int separator,
2401 int (*read_property)(char *, int, char *, int))
2402 {
2403 FILE *pipe = popen(cmd, "r");
2404 char buffer[BUFSIZ];
2405 char *name;
2406 int state = OK;
2407
2408 if (!pipe)
2409 return ERR;
2410
2411 while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) {
2412 char *value = strchr(name, separator);
2413 int namelen;
2414 int valuelen;
2415
2416 if (value) {
2417 namelen = value - name;
2418 *value++ = 0;
2419 valuelen = strlen(value);
2420 if (valuelen > 0)
2421 value[valuelen - 1] = 0;
2422
2423 } else {
2424 namelen = strlen(name);
2425 value = "";
2426 valuelen = 0;
2427 }
2428
2429 if (namelen)
2430 state = read_property(name, namelen, value, valuelen);
2431 }
2432
2433 if (state != ERR && ferror(pipe))
2434 state = ERR;
2435
2436 pclose(pipe);
2437
2438 return state;
2439 }
2440
2441
2442 /*
2443 * Main
2444 */
2445
2446 #if __GNUC__ >= 3
2447 #define __NORETURN __attribute__((__noreturn__))
2448 #else
2449 #define __NORETURN
2450 #endif
2451
2452 static void __NORETURN
2453 quit(int sig)
2454 {
2455 /* XXX: Restore tty modes and let the OS cleanup the rest! */
2456 if (cursed)
2457 endwin();
2458 exit(0);
2459 }
2460
2461 static void __NORETURN
2462 die(const char *err, ...)
2463 {
2464 va_list args;
2465
2466 endwin();
2467
2468 va_start(args, err);
2469 fputs("tig: ", stderr);
2470 vfprintf(stderr, err, args);
2471 fputs("\n", stderr);
2472 va_end(args);
2473
2474 exit(1);
2475 }
2476
2477 int
2478 main(int argc, char *argv[])
2479 {
2480 struct view *view;
2481 enum request request;
2482 size_t i;
2483
2484 signal(SIGINT, quit);
2485
2486 /* Load the repo config file first so options can be overwritten from
2487 * the command line. */
2488 if (load_config() == ERR)
2489 die("Failed to load repo config.");
2490
2491 if (!parse_options(argc, argv))
2492 return 0;
2493
2494 if (load_refs() == ERR)
2495 die("Failed to load refs.");
2496
2497 /* Require a git repository unless when running in pager mode. */
2498 if (refs_size == 0 && opt_request != REQ_VIEW_PAGER)
2499 die("Not a git repository");
2500
2501 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
2502 view->cmd_env = getenv(view->cmd_env);
2503
2504 request = opt_request;
2505
2506 init_display();
2507
2508 while (view_driver(display[current_view], request)) {
2509 int key;
2510 int i;
2511
2512 foreach_view (view, i)
2513 update_view(view);
2514
2515 /* Refresh, accept single keystroke of input */
2516 key = wgetch(status_win);
2517 request = get_request(key);
2518
2519 /* Some low-level request handling. This keeps access to
2520 * status_win restricted. */
2521 switch (request) {
2522 case REQ_PROMPT:
2523 report(":");
2524 /* Temporarily switch to line-oriented and echoed
2525 * input. */
2526 nocbreak();
2527 echo();
2528
2529 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
2530 memcpy(opt_cmd, "git ", 4);
2531 opt_request = REQ_VIEW_PAGER;
2532 } else {
2533 request = ERR;
2534 }
2535
2536 noecho();
2537 cbreak();
2538 break;
2539
2540 case REQ_SCREEN_RESIZE:
2541 {
2542 int height, width;
2543
2544 getmaxyx(stdscr, height, width);
2545
2546 /* Resize the status view and let the view driver take
2547 * care of resizing the displayed views. */
2548 wresize(status_win, 1, width);
2549 mvwin(status_win, height - 1, 0);
2550 wrefresh(status_win);
2551 break;
2552 }
2553 default:
2554 break;
2555 }
2556 }
2557
2558 quit(0);
2559
2560 return 0;
2561 }
2562
2563 /**
2564 * [[refspec]]
2565 * Revision specification
2566 * ----------------------
2567 * This section describes various ways to specify what revisions to display
2568 * or otherwise limit the view to. tig(1) does not itself parse the described
2569 * revision options so refer to the relevant git man pages for futher
2570 * information. Relevant man pages besides git-log(1) are git-diff(1) and
2571 * git-rev-list(1).
2572 *
2573 * You can tune the interaction with git by making use of the options
2574 * explained in this section. For example, by configuring the environment
2575 * variables described in the <<view-commands, "View commands">> section.
2576 *
2577 * Limit by path name
2578 * ~~~~~~~~~~~~~~~~~~
2579 * If you are interested only in those revisions that made changes to a
2580 * specific file (or even several files) list the files like this:
2581 *
2582 * $ tig log Makefile README
2583 *
2584 * To avoid ambiguity with repository references such as tag name, be sure
2585 * to separate file names from other git options using "\--". So if you
2586 * have a file named 'master' it will clash with the reference named
2587 * 'master', and thus you will have to use:
2588 *
2589 * $ tig log -- master
2590 *
2591 * NOTE: For the main view, avoiding ambiguity will in some cases require
2592 * you to specify two "\--" options. The first will make tig(1) stop
2593 * option processing and the latter will be passed to git log.
2594 *
2595 * Limit by date or number
2596 * ~~~~~~~~~~~~~~~~~~~~~~~
2597 * To speed up interaction with git, you can limit the amount of commits
2598 * to show both for the log and main view. Either limit by date using
2599 * e.g. `--since=1.month` or limit by the number of commits using `-n400`.
2600 *
2601 * If you are only interested in changed that happened between two dates
2602 * you can use:
2603 *
2604 * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
2605 *
2606 * NOTE: If you want to avoid having to quote dates containing spaces you
2607 * can use "." instead, e.g. `--after=May.5th`.
2608 *
2609 * Limiting by commit ranges
2610 * ~~~~~~~~~~~~~~~~~~~~~~~~~
2611 * Alternatively, commits can be limited to a specific range, such as
2612 * "all commits between 'tag-1.0' and 'tag-2.0'". For example:
2613 *
2614 * $ tig log tag-1.0..tag-2.0
2615 *
2616 * This way of commit limiting makes it trivial to only browse the commits
2617 * which haven't been pushed to a remote branch. Assuming 'origin' is your
2618 * upstream remote branch, using:
2619 *
2620 * $ tig log origin..HEAD
2621 *
2622 * will list what will be pushed to the remote branch. Optionally, the ending
2623 * 'HEAD' can be left out since it is implied.
2624 *
2625 * Limiting by reachability
2626 * ~~~~~~~~~~~~~~~~~~~~~~~~
2627 * Git interprets the range specifier "tag-1.0..tag-2.0" as
2628 * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
2629 * Where reachability refers to what commits are ancestors (or part of the
2630 * history) of the branch or tagged revision in question.
2631 *
2632 * If you prefer to specify which commit to preview in this way use the
2633 * following:
2634 *
2635 * $ tig log tag-2.0 ^tag-1.0
2636 *
2637 * You can think of '^' as a negation operator. Using this alternate syntax,
2638 * it is possible to further prune commits by specifying multiple branch
2639 * cut offs.
2640 *
2641 * Combining revisions specification
2642 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2643 * Revisions options can to some degree be combined, which makes it possible
2644 * to say "show at most 20 commits from within the last month that changed
2645 * files under the Documentation/ directory."
2646 *
2647 * $ tig -- --since=1.month -n20 -- Documentation/
2648 *
2649 * Examining all repository references
2650 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2651 * In some cases, it can be useful to query changes across all references
2652 * in a repository. An example is to ask "did any line of development in
2653 * this repository change a particular file within the last week". This
2654 * can be accomplished using:
2655 *
2656 * $ tig -- --all --since=1.week -- Makefile
2657 *
2658 * BUGS
2659 * ----
2660 * Known bugs and problems:
2661 *
2662 * - In it's current state tig is pretty much UTF-8 only.
2663 *
2664 * - If the screen width is very small the main view can draw
2665 * outside the current view causing bad wrapping. Same goes
2666 * for title and status windows.
2667 *
2668 * - The cursor can wrap-around on the last line and cause the
2669 * window to scroll.
2670 *
2671 * TODO
2672 * ----
2673 * Features that should be explored.
2674 *
2675 * - Searching.
2676 *
2677 * - Locale support.
2678 *
2679 * COPYRIGHT
2680 * ---------
2681 * Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2682 *
2683 * This program is free software; you can redistribute it and/or modify
2684 * it under the terms of the GNU General Public License as published by
2685 * the Free Software Foundation; either version 2 of the License, or
2686 * (at your option) any later version.
2687 *
2688 * SEE ALSO
2689 * --------
2690 * - link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
2691 * - link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
2692 *
2693 * Other git repository browsers:
2694 *
2695 * - gitk(1)
2696 * - qgit(1)
2697 * - gitview(1)
2698 **/