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