Add support for repository references
[tig] / tig.c
CommitLineData
4a2909a7
JF
1/* Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
2 * See license info at the bottom. */
b801d8b2
JF
3/**
4 * TIG(1)
5 * ======
6 *
7 * NAME
8 * ----
9 * tig - text-mode interface for git
10 *
11 * SYNOPSIS
12 * --------
13 * [verse]
03a93dbb
JF
14 * tig [options]
15 * tig [options] [--] [git log options]
b76c2afc
JF
16 * tig [options] log [git log options]
17 * tig [options] diff [git diff options]
8855ada4
JF
18 * tig [options] show [git show options]
19 * tig [options] < [git command output]
b801d8b2
JF
20 *
21 * DESCRIPTION
22 * -----------
23 * Browse changes in a git repository.
b801d8b2
JF
24 **/
25
b76c2afc
JF
26#ifndef VERSION
27#define VERSION "tig-0.1"
28#endif
29
8855ada4
JF
30#ifndef DEBUG
31#define NDEBUG
32#endif
33
22f66b0a 34#include <assert.h>
4c6fabc2 35#include <errno.h>
22f66b0a
JF
36#include <ctype.h>
37#include <signal.h>
b801d8b2 38#include <stdarg.h>
b801d8b2 39#include <stdio.h>
22f66b0a 40#include <stdlib.h>
b801d8b2 41#include <string.h>
6908bdbd 42#include <unistd.h>
b76c2afc 43#include <time.h>
b801d8b2
JF
44
45#include <curses.h>
b801d8b2
JF
46
47static void die(const char *err, ...);
48static void report(const char *msg, ...);
1ba2ae4b 49static void set_nonblocking_input(bool loading);
6b161b31
JF
50
51#define ABS(x) ((x) >= 0 ? (x) : -(x))
52#define MIN(x, y) ((x) < (y) ? (x) : (y))
53
54#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
55#define STRING_SIZE(x) (sizeof(x) - 1)
b76c2afc 56
2e8488b4
JF
57#define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */
58#define SIZEOF_CMD 1024 /* Size of command buffer. */
b801d8b2 59
82e78006
JF
60/* This color name can be used to refer to the default term colors. */
61#define COLOR_DEFAULT (-1)
78c70acd 62
82e78006 63/* The format and size of the date column in the main view. */
4c6fabc2 64#define DATE_FORMAT "%Y-%m-%d %H:%M"
6b161b31 65#define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
4c6fabc2 66
a28bcc22 67/* The default interval between line numbers. */
4a2909a7 68#define NUMBER_INTERVAL 1
82e78006 69
a28bcc22
JF
70#define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
71
8855ada4 72/* Some ascii-shorthands fitted into the ncurses namespace. */
a28bcc22
JF
73#define KEY_TAB '\t'
74#define KEY_RETURN '\r'
4a2909a7
JF
75#define KEY_ESC 27
76
a28bcc22 77/* User action requests. */
4a2909a7 78enum request {
a28bcc22
JF
79 /* Offset all requests to avoid conflicts with ncurses getch values. */
80 REQ_OFFSET = KEY_MAX + 1,
81
4a2909a7 82 /* XXX: Keep the view request first and in sync with views[]. */
2e8488b4 83 REQ_VIEW_MAIN,
4a2909a7
JF
84 REQ_VIEW_DIFF,
85 REQ_VIEW_LOG,
2e8488b4 86 REQ_VIEW_HELP,
6908bdbd 87 REQ_VIEW_PAGER,
4a2909a7 88
6b161b31 89 REQ_ENTER,
03a93dbb
JF
90 REQ_QUIT,
91 REQ_PROMPT,
4a2909a7 92 REQ_SCREEN_REDRAW,
fac7db6c 93 REQ_SCREEN_RESIZE,
4a2909a7 94 REQ_SCREEN_UPDATE,
03a93dbb
JF
95 REQ_SHOW_VERSION,
96 REQ_STOP_LOADING,
4a2909a7 97 REQ_TOGGLE_LINE_NUMBERS,
03a93dbb 98 REQ_VIEW_NEXT,
4a2909a7
JF
99
100 REQ_MOVE_UP,
101 REQ_MOVE_DOWN,
102 REQ_MOVE_PAGE_UP,
103 REQ_MOVE_PAGE_DOWN,
104 REQ_MOVE_FIRST_LINE,
105 REQ_MOVE_LAST_LINE,
106
107 REQ_SCROLL_LINE_UP,
108 REQ_SCROLL_LINE_DOWN,
109 REQ_SCROLL_PAGE_UP,
110 REQ_SCROLL_PAGE_DOWN,
111};
112
c34d9c9f
JF
113struct ref {
114 char *name;
115 char id[41];
116 unsigned int tag:1;
117 unsigned int next:1;
118};
119
4c6fabc2 120struct commit {
a28bcc22 121 char id[41]; /* SHA1 ID. */
6b161b31 122 char title[75]; /* The first line of the commit message. */
a28bcc22
JF
123 char author[75]; /* The author of the commit. */
124 struct tm time; /* Date from the author ident. */
c34d9c9f 125 struct ref **refs; /* Repository references; tags & branch heads. */
4c6fabc2
JF
126};
127
03a93dbb
JF
128/*
129 * String helpers
130 */
78c70acd 131
82e78006
JF
132static inline void
133string_ncopy(char *dst, char *src, int dstlen)
134{
135 strncpy(dst, src, dstlen - 1);
136 dst[dstlen - 1] = 0;
03a93dbb 137
82e78006
JF
138}
139
140/* Shorthand for safely copying into a fixed buffer. */
141#define string_copy(dst, src) \
142 string_ncopy(dst, src, sizeof(dst))
143
03a93dbb
JF
144/* Shell quoting
145 *
146 * NOTE: The following is a slightly modified copy of the git project's shell
147 * quoting routines found in the quote.c file.
148 *
149 * Help to copy the thing properly quoted for the shell safety. any single
150 * quote is replaced with '\'', any exclamation point is replaced with '\!',
151 * and the whole thing is enclosed in a
152 *
153 * E.g.
154 * original sq_quote result
155 * name ==> name ==> 'name'
156 * a b ==> a b ==> 'a b'
157 * a'b ==> a'\''b ==> 'a'\''b'
158 * a!b ==> a'\!'b ==> 'a'\!'b'
159 */
160
161static size_t
162sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
163{
164 char c;
165
166#define BUFPUT(x) ( (bufsize < SIZEOF_CMD) && (buf[bufsize++] = (x)) )
167
168 BUFPUT('\'');
169 while ((c = *src++)) {
170 if (c == '\'' || c == '!') {
171 BUFPUT('\'');
172 BUFPUT('\\');
173 BUFPUT(c);
174 BUFPUT('\'');
175 } else {
176 BUFPUT(c);
177 }
178 }
179 BUFPUT('\'');
180
181 return bufsize;
182}
183
82e78006 184
b76c2afc
JF
185/**
186 * OPTIONS
187 * -------
188 **/
189
2e8488b4
JF
190static int opt_line_number = FALSE;
191static int opt_num_interval = NUMBER_INTERVAL;
6b161b31 192static enum request opt_request = REQ_VIEW_MAIN;
03a93dbb 193static char opt_cmd[SIZEOF_CMD] = "";
6908bdbd 194static FILE *opt_pipe = NULL;
b76c2afc 195
b76c2afc 196/* Returns the index of log or diff command or -1 to exit. */
8855ada4 197static bool
b76c2afc
JF
198parse_options(int argc, char *argv[])
199{
200 int i;
201
202 for (i = 1; i < argc; i++) {
203 char *opt = argv[i];
204
205 /**
b76c2afc 206 * -l::
1ba2ae4b 207 * Start up in log view using the internal log command.
b76c2afc 208 **/
6b161b31 209 if (!strcmp(opt, "-l")) {
4a2909a7 210 opt_request = REQ_VIEW_LOG;
6b161b31
JF
211 continue;
212 }
b76c2afc
JF
213
214 /**
215 * -d::
1ba2ae4b 216 * Start up in diff view using the internal diff command.
b76c2afc 217 **/
6b161b31 218 if (!strcmp(opt, "-d")) {
4a2909a7 219 opt_request = REQ_VIEW_DIFF;
6b161b31
JF
220 continue;
221 }
b76c2afc
JF
222
223 /**
2e8488b4 224 * -n[INTERVAL], --line-number[=INTERVAL]::
b76c2afc 225 * Prefix line numbers in log and diff view.
2e8488b4 226 * Optionally, with interval different than each line.
b76c2afc 227 **/
6b161b31 228 if (!strncmp(opt, "-n", 2) ||
8855ada4 229 !strncmp(opt, "--line-number", 13)) {
2e8488b4
JF
230 char *num = opt;
231
232 if (opt[1] == 'n') {
233 num = opt + 2;
234
235 } else if (opt[STRING_SIZE("--line-number")] == '=') {
236 num = opt + STRING_SIZE("--line-number=");
237 }
238
239 if (isdigit(*num))
240 opt_num_interval = atoi(num);
241
6b161b31
JF
242 opt_line_number = TRUE;
243 continue;
244 }
b76c2afc
JF
245
246 /**
247 * -v, --version::
248 * Show version and exit.
249 **/
6b161b31 250 if (!strcmp(opt, "-v") ||
8855ada4 251 !strcmp(opt, "--version")) {
b76c2afc 252 printf("tig version %s\n", VERSION);
8855ada4 253 return FALSE;
6b161b31 254 }
b76c2afc
JF
255
256 /**
03a93dbb 257 * \--::
889cb462 258 * End of tig(1) options. Useful when specifying commands
03a93dbb
JF
259 * for the main view. Example:
260 *
889cb462 261 * $ tig -- --since=1.month
b76c2afc 262 **/
6908bdbd
JF
263 if (!strcmp(opt, "--")) {
264 i++;
265 break;
266 }
03a93dbb 267
8855ada4
JF
268 /**
269 * log [options]::
270 * Open log view using the given git log options.
271 *
272 * diff [options]::
273 * Open diff view using the given git diff options.
274 *
275 * show [options]::
276 * Open diff view using the given git show options.
277 **/
278 if (!strcmp(opt, "log") ||
279 !strcmp(opt, "diff") ||
280 !strcmp(opt, "show")) {
281 opt_request = opt[0] == 'l'
282 ? REQ_VIEW_LOG : REQ_VIEW_DIFF;
283 break;
284 }
285
286 /* Make stuff like:
889cb462 287 *
03a93dbb
JF
288 * $ tig tag-1.0..HEAD
289 *
8855ada4 290 * work. */
03a93dbb 291 if (opt[0] && opt[0] != '-')
6908bdbd 292 break;
6b161b31
JF
293
294 die("unknown command '%s'", opt);
b76c2afc
JF
295 }
296
6908bdbd 297 if (!isatty(STDIN_FILENO)) {
8855ada4
JF
298 /**
299 * Pager mode
300 * ~~~~~~~~~~
301 * If stdin is a pipe, any log or diff options will be ignored and the
302 * pager view will be opened loading data from stdin. The pager mode
303 * can be used for colorizing output from various git commands.
304 *
305 * Example on how to colorize the output of git-show(1):
306 *
307 * $ git show | tig
308 **/
6908bdbd
JF
309 opt_request = REQ_VIEW_PAGER;
310 opt_pipe = stdin;
311
312 } else if (i < argc) {
313 size_t buf_size;
314
8855ada4
JF
315 /**
316 * Git command options
317 * ~~~~~~~~~~~~~~~~~~~
8855ada4
JF
318 * All git command options specified on the command line will
319 * be passed to the given command and all will be shell quoted
320 * before used.
321 *
322 * NOTE: It is possible to specify options even for the main
eb98559e 323 * view. If doing this you should not touch the `--pretty`
8855ada4
JF
324 * option.
325 *
326 * Example on how to open the log view and show both author and
327 * committer information:
328 *
329 * $ tig log --pretty=fuller
330 **/
331
6908bdbd 332 if (opt_request == REQ_VIEW_MAIN)
8855ada4
JF
333 /* XXX: This is vulnerable to the user overriding
334 * options required for the main view parser. */
6908bdbd
JF
335 string_copy(opt_cmd, "git log --stat --pretty=raw");
336 else
337 string_copy(opt_cmd, "git");
338 buf_size = strlen(opt_cmd);
339
340 while (buf_size < sizeof(opt_cmd) && i < argc) {
341 opt_cmd[buf_size++] = ' ';
342 buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
343 }
344
345 if (buf_size >= sizeof(opt_cmd))
346 die("command too long");
347
348 opt_cmd[buf_size] = 0;
349
350 }
351
8855ada4 352 return TRUE;
b76c2afc
JF
353}
354
355
4a2909a7
JF
356/**
357 * KEYS
358 * ----
4a2909a7
JF
359 **/
360
361#define HELP "(d)iff, (l)og, (m)ain, (q)uit, (v)ersion, (h)elp"
362
363struct keymap {
364 int alias;
365 int request;
366};
367
368struct keymap keymap[] = {
6b161b31
JF
369 /**
370 * View switching
371 * ~~~~~~~~~~~~~~
372 * d::
373 * Switch to diff view.
374 * l::
375 * Switch to log view.
376 * m::
377 * Switch to main view.
8855ada4
JF
378 * p::
379 * Switch to pager view.
6b161b31
JF
380 * h::
381 * Show man page.
382 * Return::
383 * If in main view split the view
384 * and show the diff in the bottom view.
03a93dbb
JF
385 * Tab::
386 * Switch to next view.
6b161b31
JF
387 **/
388 { 'm', REQ_VIEW_MAIN },
389 { 'd', REQ_VIEW_DIFF },
390 { 'l', REQ_VIEW_LOG },
8855ada4 391 { 'p', REQ_VIEW_PAGER },
6b161b31
JF
392 { 'h', REQ_VIEW_HELP },
393
03a93dbb 394 { KEY_TAB, REQ_VIEW_NEXT },
6b161b31
JF
395 { KEY_RETURN, REQ_ENTER },
396
397 /**
398 * Cursor navigation
399 * ~~~~~~~~~~~~~~~~~
400 * Up, k::
401 * Move curser one line up.
402 * Down, j::
403 * Move cursor one line down.
404 * Page Up::
405 * Move curser one page up.
406 * Page Down::
407 * Move cursor one page down.
408 * Home::
409 * Jump to first line.
410 * End::
411 * Jump to last line.
412 **/
4a2909a7
JF
413 { KEY_UP, REQ_MOVE_UP },
414 { 'k', REQ_MOVE_UP },
415 { KEY_DOWN, REQ_MOVE_DOWN },
416 { 'j', REQ_MOVE_DOWN },
417 { KEY_HOME, REQ_MOVE_FIRST_LINE },
418 { KEY_END, REQ_MOVE_LAST_LINE },
419 { KEY_NPAGE, REQ_MOVE_PAGE_DOWN },
420 { KEY_PPAGE, REQ_MOVE_PAGE_UP },
421
6b161b31
JF
422 /**
423 * Scrolling
424 * ~~~~~~~~~
425 * Insert::
426 * Scroll view one line up.
427 * Delete::
428 * Scroll view one line down.
429 * w::
430 * Scroll view one page up.
431 * s::
432 * Scroll view one page down.
433 **/
a28bcc22
JF
434 { KEY_IC, REQ_SCROLL_LINE_UP },
435 { KEY_DC, REQ_SCROLL_LINE_DOWN },
436 { 'w', REQ_SCROLL_PAGE_UP },
437 { 's', REQ_SCROLL_PAGE_DOWN },
438
6b161b31
JF
439 /**
440 * Misc
441 * ~~~~
442 * q, Escape::
443 * Quit
444 * r::
445 * Redraw screen.
446 * z::
447 * Stop all background loading.
448 * v::
449 * Show version.
450 * n::
451 * Toggle line numbers on/off.
03a93dbb 452 * ':'::
8855ada4
JF
453 * Open prompt. This allows you to specify what git command to run.
454 * Example:
455 *
456 * :log -p
457 *
6b161b31 458 **/
4a2909a7
JF
459 { KEY_ESC, REQ_QUIT },
460 { 'q', REQ_QUIT },
461 { 'z', REQ_STOP_LOADING },
462 { 'v', REQ_SHOW_VERSION },
463 { 'r', REQ_SCREEN_REDRAW },
464 { 'n', REQ_TOGGLE_LINE_NUMBERS },
03a93dbb 465 { ':', REQ_PROMPT },
4a2909a7
JF
466
467 /* wgetch() with nodelay() enabled returns ERR when there's no input. */
468 { ERR, REQ_SCREEN_UPDATE },
4b76734f 469
fac7db6c
JF
470 /* Use the ncurses SIGWINCH handler. */
471 { KEY_RESIZE, REQ_SCREEN_RESIZE },
4a2909a7
JF
472};
473
6b161b31
JF
474static enum request
475get_request(int key)
4a2909a7
JF
476{
477 int i;
478
479 for (i = 0; i < ARRAY_SIZE(keymap); i++)
6b161b31 480 if (keymap[i].alias == key)
4a2909a7
JF
481 return keymap[i].request;
482
6b161b31 483 return (enum request) key;
4a2909a7
JF
484}
485
486
b76c2afc
JF
487/*
488 * Line-oriented content detection.
6b161b31
JF
489 */
490
2e8488b4 491#define LINE_INFO \
6b161b31
JF
492/* Line type String to match Foreground Background Attributes
493 * --------- --------------- ---------- ---------- ---------- */ \
a28bcc22
JF
494/* Diff markup */ \
495LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
8855ada4 496LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
a28bcc22
JF
497LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
498LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
499LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
500LINE(DIFF_OLDMODE, "old mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
501LINE(DIFF_NEWMODE, "new mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
502LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
503LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
504LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
505LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
506/* Pretty print commit header */ \
6908bdbd 507LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
8855ada4 508LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
6908bdbd
JF
509LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
510LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
8855ada4
JF
511LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
512LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
a28bcc22
JF
513/* Raw commit header */ \
514LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
515LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
516LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
8855ada4 517LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
a28bcc22
JF
518LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
519/* Misc */ \
520LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
521LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
522/* UI colors */ \
523LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
524LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
525LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
6b161b31
JF
526LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \
527LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \
a28bcc22
JF
528LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \
529LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
530LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
c34d9c9f
JF
531LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
532LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
533LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
2e8488b4 534
78c70acd 535enum line_type {
2e8488b4
JF
536#define LINE(type, line, fg, bg, attr) \
537 LINE_##type
538 LINE_INFO
539#undef LINE
78c70acd
JF
540};
541
542struct line_info {
2e8488b4
JF
543 char *line; /* The start of line to match. */
544 int linelen; /* Size of string to match. */
545 int fg, bg, attr; /* Color and text attributes for the lines. */
78c70acd
JF
546};
547
2e8488b4 548static struct line_info line_info[] = {
78c70acd 549#define LINE(type, line, fg, bg, attr) \
a28bcc22 550 { (line), STRING_SIZE(line), (fg), (bg), (attr) }
2e8488b4
JF
551 LINE_INFO
552#undef LINE
78c70acd
JF
553};
554
2e8488b4
JF
555static enum line_type
556get_line_type(char *line)
78c70acd
JF
557{
558 int linelen = strlen(line);
a28bcc22 559 enum line_type type;
78c70acd 560
a28bcc22 561 for (type = 0; type < ARRAY_SIZE(line_info); type++)
2e8488b4 562 /* Case insensitive search matches Signed-off-by lines better. */
a28bcc22
JF
563 if (linelen >= line_info[type].linelen &&
564 !strncasecmp(line_info[type].line, line, line_info[type].linelen))
565 return type;
78c70acd 566
2e8488b4 567 return LINE_DEFAULT;
78c70acd
JF
568}
569
2e8488b4 570static inline int
78c70acd
JF
571get_line_attr(enum line_type type)
572{
2e8488b4
JF
573 assert(type < ARRAY_SIZE(line_info));
574 return COLOR_PAIR(type) | line_info[type].attr;
78c70acd
JF
575}
576
577static void
578init_colors(void)
579{
82e78006
JF
580 int default_bg = COLOR_BLACK;
581 int default_fg = COLOR_WHITE;
a28bcc22 582 enum line_type type;
78c70acd
JF
583
584 start_color();
585
586 if (use_default_colors() != ERR) {
82e78006
JF
587 default_bg = -1;
588 default_fg = -1;
78c70acd
JF
589 }
590
a28bcc22
JF
591 for (type = 0; type < ARRAY_SIZE(line_info); type++) {
592 struct line_info *info = &line_info[type];
82e78006
JF
593 int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg;
594 int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg;
78c70acd 595
a28bcc22 596 init_pair(type, fg, bg);
78c70acd
JF
597 }
598}
599
600
1ba2ae4b
JF
601/**
602 * ENVIRONMENT VARIABLES
603 * ---------------------
c34d9c9f
JF
604 * Several options related to the interface with git can be configured
605 * via environment options.
606 *
607 * Repository references
608 * ~~~~~~~~~~~~~~~~~~~~~
609 * Commits that are referenced by tags and branch heads will be marked
610 * by the reference name surrounded by '[' and ']':
611 *
612 * 2006-04-18 23:12 Jonas Fonseca | [tig-0.2] tig version 0.2
613 *
614 * If you want to filter out certain directories under `.git/refs/`, say
615 * `tmp` you can do it by setting the following variable:
616 *
617 * $ TIG_LS_REMOTE="git ls-remote | sed '/\/tmp\//d'"
618 *
619 * Or set the variable permanently in your environment.
620 *
621 * TIG_LS_REMOTE::
622 * Set command for retrieving all repository references.private
623 **/
624
625#define TIG_LS_REMOTE \
626 "git ls-remote ."
627
628/**
629 * View commands
630 * ~~~~~~~~~~~~~
1ba2ae4b
JF
631 * It is possible to alter which commands are used for the different views.
632 * If for example you prefer commits in the main to be sorted by date and
633 * only show 500 commits, use:
634 *
635 * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
636 *
637 * Or set the variable permanently in your environment.
638 *
639 * Notice, how `%s` is used to specify the commit reference. There can
640 * be a maximum of 5 `%s` ref specifications.
641 *
642 * TIG_DIFF_CMD::
643 * The command used for the diff view. By default, git show is used
644 * as a backend.
645 *
646 * TIG_LOG_CMD::
647 * The command used for the log view.
648 *
649 * TIG_MAIN_CMD::
650 * The command used for the main view. Note, you must always specify
651 * the option: `--pretty=raw` since the main view parser expects to
652 * read that format.
653 **/
654
655#define TIG_DIFF_CMD \
656 "git show --patch-with-stat --find-copies-harder -B -C %s"
657
658#define TIG_LOG_CMD \
659 "git log --cc --stat -n100 %s"
660
661#define TIG_MAIN_CMD \
662 "git log --topo-order --stat --pretty=raw %s"
663
664/* We silently ignore that the following are also exported. */
665
666#define TIG_HELP_CMD \
667 "man tig 2> /dev/null"
668
669#define TIG_PAGER_CMD \
670 ""
671
672
b801d8b2
JF
673/*
674 * Viewer
675 */
676
677struct view {
03a93dbb 678 const char *name; /* View name */
1ba2ae4b
JF
679 char *cmd_fmt; /* Default command line format */
680 char *cmd_env; /* Command line set via environment */
03a93dbb
JF
681 char *id; /* Points to either of ref_{head,commit} */
682 size_t objsize; /* Size of objects in the line index */
6b161b31
JF
683
684 struct view_ops {
8855ada4 685 /* Draw one line; @lineno must be < view->height. */
6b161b31 686 bool (*draw)(struct view *view, unsigned int lineno);
8855ada4 687 /* Read one line; updates view->line. */
6b161b31 688 bool (*read)(struct view *view, char *line);
8855ada4 689 /* Depending on view, change display based on current line. */
6b161b31
JF
690 bool (*enter)(struct view *view);
691 } *ops;
22f66b0a 692
03a93dbb 693 char cmd[SIZEOF_CMD]; /* Command buffer */
49f2b43f
JF
694 char ref[SIZEOF_REF]; /* Hovered commit reference */
695 char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */
2e8488b4 696
8855ada4
JF
697 int height, width; /* The width and height of the main window */
698 WINDOW *win; /* The main window */
699 WINDOW *title; /* The title window living below the main window */
b801d8b2
JF
700
701 /* Navigation */
702 unsigned long offset; /* Offset of the window top */
703 unsigned long lineno; /* Current line number */
704
705 /* Buffering */
706 unsigned long lines; /* Total number of lines */
8855ada4
JF
707 void **line; /* Line index; each line contains user data */
708 unsigned int digits; /* Number of digits in the lines member. */
b801d8b2
JF
709
710 /* Loading */
711 FILE *pipe;
2e8488b4 712 time_t start_time;
b801d8b2
JF
713};
714
6b161b31
JF
715static struct view_ops pager_ops;
716static struct view_ops main_ops;
a28bcc22 717
49f2b43f
JF
718char ref_head[SIZEOF_REF] = "HEAD";
719char ref_commit[SIZEOF_REF] = "HEAD";
720
1ba2ae4b
JF
721#define VIEW_STR(name, cmd, env, ref, objsize, ops) \
722 { name, cmd, #env, ref, objsize, ops }
723
724#define VIEW_(id, name, ops, ref, objsize) \
725 VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, objsize, ops)
726
b801d8b2 727static struct view views[] = {
1ba2ae4b
JF
728 VIEW_(MAIN, "main", &main_ops, ref_head, sizeof(struct commit)),
729 VIEW_(DIFF, "diff", &pager_ops, ref_commit, sizeof(char)),
730 VIEW_(LOG, "log", &pager_ops, ref_head, sizeof(char)),
731 VIEW_(HELP, "help", &pager_ops, ref_head, sizeof(char)),
732 VIEW_(PAGER, "pager", &pager_ops, "static", sizeof(char)),
b801d8b2
JF
733};
734
a28bcc22
JF
735#define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
736
4c6fabc2 737/* The display array of active views and the index of the current view. */
6b161b31 738static struct view *display[2];
4c6fabc2 739static unsigned int current_view;
22f66b0a 740
b801d8b2 741#define foreach_view(view, i) \
6b161b31 742 for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++)
b801d8b2 743
4c6fabc2 744
b801d8b2 745static void
82e78006 746redraw_view_from(struct view *view, int lineno)
b801d8b2 747{
82e78006 748 assert(0 <= lineno && lineno < view->height);
b801d8b2 749
82e78006 750 for (; lineno < view->height; lineno++) {
6b161b31 751 if (!view->ops->draw(view, lineno))
fd85fef1 752 break;
b801d8b2
JF
753 }
754
755 redrawwin(view->win);
756 wrefresh(view->win);
757}
758
b76c2afc 759static void
82e78006
JF
760redraw_view(struct view *view)
761{
762 wclear(view->win);
763 redraw_view_from(view, 0);
764}
765
6b161b31
JF
766static void
767resize_display(void)
b76c2afc 768{
03a93dbb 769 int offset, i;
6b161b31
JF
770 struct view *base = display[0];
771 struct view *view = display[1] ? display[1] : display[0];
b76c2afc 772
6b161b31 773 /* Setup window dimensions */
b76c2afc 774
03a93dbb 775 getmaxyx(stdscr, base->height, base->width);
b76c2afc 776
6b161b31 777 /* Make room for the status window. */
03a93dbb 778 base->height -= 1;
6b161b31
JF
779
780 if (view != base) {
03a93dbb
JF
781 /* Horizontal split. */
782 view->width = base->width;
6b161b31
JF
783 view->height = SCALE_SPLIT_VIEW(base->height);
784 base->height -= view->height;
785
786 /* Make room for the title bar. */
787 view->height -= 1;
788 }
789
790 /* Make room for the title bar. */
791 base->height -= 1;
792
793 offset = 0;
794
795 foreach_view (view, i) {
b76c2afc 796 if (!view->win) {
6b161b31
JF
797 view->win = newwin(view->height, 0, offset, 0);
798 if (!view->win)
799 die("Failed to create %s view", view->name);
800
801 scrollok(view->win, TRUE);
802
803 view->title = newwin(1, 0, offset + view->height, 0);
804 if (!view->title)
805 die("Failed to create title window");
806
807 } else {
808 wresize(view->win, view->height, view->width);
809 mvwin(view->win, offset, 0);
810 mvwin(view->title, offset + view->height, 0);
811 wrefresh(view->win);
a28bcc22 812 }
a28bcc22 813
6b161b31 814 offset += view->height + 1;
b76c2afc 815 }
6b161b31 816}
b76c2afc 817
6b161b31
JF
818static void
819update_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));
a28bcc22 825
6b161b31
JF
826 werase(view->title);
827 wmove(view->title, 0, 0);
b76c2afc 828
6b161b31 829 /* [main] ref: 334b506... - commit 6 of 4383 (0%) */
6908bdbd
JF
830
831 if (*view->ref)
832 wprintw(view->title, "[%s] ref: %s", view->name, view->ref);
833 else
834 wprintw(view->title, "[%s]", view->name);
835
6b161b31
JF
836 if (view->lines) {
837 char *type = view == VIEW(REQ_VIEW_MAIN) ? "commit" : "line";
838
839 wprintw(view->title, " - %s %d of %d (%d%%)",
840 type,
841 view->lineno + 1,
842 view->lines,
843 (view->lineno + 1) * 100 / view->lines);
844 }
845
846 wrefresh(view->title);
847}
78c70acd 848
2e8488b4
JF
849/*
850 * Navigation
851 */
852
4a2909a7 853/* Scrolling backend */
b801d8b2 854static void
4a2909a7 855do_scroll_view(struct view *view, int lines)
b801d8b2 856{
fd85fef1
JF
857 /* The rendering expects the new offset. */
858 view->offset += lines;
859
860 assert(0 <= view->offset && view->offset < view->lines);
861 assert(lines);
b801d8b2 862
82e78006 863 /* Redraw the whole screen if scrolling is pointless. */
4c6fabc2 864 if (view->height < ABS(lines)) {
b76c2afc
JF
865 redraw_view(view);
866
867 } else {
22f66b0a 868 int line = lines > 0 ? view->height - lines : 0;
82e78006 869 int end = line + ABS(lines);
fd85fef1
JF
870
871 wscrl(view->win, lines);
872
22f66b0a 873 for (; line < end; line++) {
6b161b31 874 if (!view->ops->draw(view, line))
fd85fef1
JF
875 break;
876 }
877 }
878
879 /* Move current line into the view. */
880 if (view->lineno < view->offset) {
881 view->lineno = view->offset;
6b161b31 882 view->ops->draw(view, 0);
fd85fef1
JF
883
884 } else if (view->lineno >= view->offset + view->height) {
885 view->lineno = view->offset + view->height - 1;
6b161b31 886 view->ops->draw(view, view->lineno - view->offset);
fd85fef1
JF
887 }
888
4c6fabc2 889 assert(view->offset <= view->lineno && view->lineno < view->lines);
fd85fef1
JF
890
891 redrawwin(view->win);
892 wrefresh(view->win);
9d3f5834 893 report("");
fd85fef1 894}
78c70acd 895
4a2909a7 896/* Scroll frontend */
fd85fef1 897static void
6b161b31 898scroll_view(struct view *view, enum request request)
fd85fef1
JF
899{
900 int lines = 1;
b801d8b2
JF
901
902 switch (request) {
4a2909a7 903 case REQ_SCROLL_PAGE_DOWN:
fd85fef1 904 lines = view->height;
4a2909a7 905 case REQ_SCROLL_LINE_DOWN:
b801d8b2 906 if (view->offset + lines > view->lines)
bde3653a 907 lines = view->lines - view->offset;
b801d8b2 908
fd85fef1 909 if (lines == 0 || view->offset + view->height >= view->lines) {
eb98559e 910 report("Cannot scroll beyond the last line");
b801d8b2
JF
911 return;
912 }
913 break;
914
4a2909a7 915 case REQ_SCROLL_PAGE_UP:
fd85fef1 916 lines = view->height;
4a2909a7 917 case REQ_SCROLL_LINE_UP:
b801d8b2
JF
918 if (lines > view->offset)
919 lines = view->offset;
920
921 if (lines == 0) {
eb98559e 922 report("Cannot scroll beyond the first line");
b801d8b2
JF
923 return;
924 }
925
fd85fef1 926 lines = -lines;
b801d8b2 927 break;
03a93dbb 928
6b161b31
JF
929 default:
930 die("request %d not handled in switch", request);
b801d8b2
JF
931 }
932
4a2909a7 933 do_scroll_view(view, lines);
fd85fef1 934}
b801d8b2 935
4a2909a7 936/* Cursor moving */
fd85fef1 937static void
6b161b31 938move_view(struct view *view, enum request request)
fd85fef1
JF
939{
940 int steps;
b801d8b2 941
fd85fef1 942 switch (request) {
4a2909a7 943 case REQ_MOVE_FIRST_LINE:
78c70acd
JF
944 steps = -view->lineno;
945 break;
946
4a2909a7 947 case REQ_MOVE_LAST_LINE:
78c70acd
JF
948 steps = view->lines - view->lineno - 1;
949 break;
950
4a2909a7 951 case REQ_MOVE_PAGE_UP:
78c70acd
JF
952 steps = view->height > view->lineno
953 ? -view->lineno : -view->height;
954 break;
955
4a2909a7 956 case REQ_MOVE_PAGE_DOWN:
78c70acd
JF
957 steps = view->lineno + view->height >= view->lines
958 ? view->lines - view->lineno - 1 : view->height;
959 break;
960
4a2909a7 961 case REQ_MOVE_UP:
fd85fef1
JF
962 steps = -1;
963 break;
b801d8b2 964
4a2909a7 965 case REQ_MOVE_DOWN:
fd85fef1
JF
966 steps = 1;
967 break;
6b161b31
JF
968
969 default:
970 die("request %d not handled in switch", request);
78c70acd 971 }
b801d8b2 972
4c6fabc2 973 if (steps <= 0 && view->lineno == 0) {
eb98559e 974 report("Cannot move beyond the first line");
78c70acd 975 return;
b801d8b2 976
6908bdbd 977 } else if (steps >= 0 && view->lineno + 1 >= view->lines) {
eb98559e 978 report("Cannot move beyond the last line");
78c70acd 979 return;
fd85fef1
JF
980 }
981
4c6fabc2 982 /* Move the current line */
fd85fef1 983 view->lineno += steps;
4c6fabc2
JF
984 assert(0 <= view->lineno && view->lineno < view->lines);
985
986 /* Repaint the old "current" line if we be scrolling */
2e8488b4
JF
987 if (ABS(steps) < view->height) {
988 int prev_lineno = view->lineno - steps - view->offset;
989
990 wmove(view->win, prev_lineno, 0);
991 wclrtoeol(view->win);
03a93dbb 992 view->ops->draw(view, prev_lineno);
2e8488b4 993 }
fd85fef1 994
4c6fabc2 995 /* Check whether the view needs to be scrolled */
fd85fef1
JF
996 if (view->lineno < view->offset ||
997 view->lineno >= view->offset + view->height) {
998 if (steps < 0 && -steps > view->offset) {
999 steps = -view->offset;
b76c2afc
JF
1000
1001 } else if (steps > 0) {
1002 if (view->lineno == view->lines - 1 &&
1003 view->lines > view->height) {
1004 steps = view->lines - view->offset - 1;
1005 if (steps >= view->height)
1006 steps -= view->height - 1;
1007 }
b801d8b2 1008 }
78c70acd 1009
4a2909a7 1010 do_scroll_view(view, steps);
fd85fef1 1011 return;
b801d8b2
JF
1012 }
1013
4c6fabc2 1014 /* Draw the current line */
6b161b31 1015 view->ops->draw(view, view->lineno - view->offset);
fd85fef1 1016
b801d8b2
JF
1017 redrawwin(view->win);
1018 wrefresh(view->win);
9d3f5834 1019 report("");
b801d8b2
JF
1020}
1021
b801d8b2 1022
2e8488b4
JF
1023/*
1024 * Incremental updating
1025 */
b801d8b2 1026
03a93dbb 1027static bool
b801d8b2
JF
1028begin_update(struct view *view)
1029{
2e8488b4 1030 char *id = view->id;
fd85fef1 1031
03a93dbb
JF
1032 if (opt_cmd[0]) {
1033 string_copy(view->cmd, opt_cmd);
1034 opt_cmd[0] = 0;
8855ada4
JF
1035 /* When running random commands, the view ref could have become
1036 * invalid so clear it. */
1037 view->ref[0] = 0;
03a93dbb 1038 } else {
1ba2ae4b
JF
1039 char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
1040
1041 if (snprintf(view->cmd, sizeof(view->cmd), format,
1042 id, id, id, id, id) >= sizeof(view->cmd))
03a93dbb
JF
1043 return FALSE;
1044 }
b801d8b2 1045
6908bdbd
JF
1046 /* Special case for the pager view. */
1047 if (opt_pipe) {
1048 view->pipe = opt_pipe;
1049 opt_pipe = NULL;
1050 } else {
1051 view->pipe = popen(view->cmd, "r");
1052 }
1053
2e8488b4
JF
1054 if (!view->pipe)
1055 return FALSE;
b801d8b2 1056
6b161b31 1057 set_nonblocking_input(TRUE);
b801d8b2
JF
1058
1059 view->offset = 0;
1060 view->lines = 0;
1061 view->lineno = 0;
49f2b43f 1062 string_copy(view->vid, id);
b801d8b2 1063
2e8488b4
JF
1064 if (view->line) {
1065 int i;
1066
1067 for (i = 0; i < view->lines; i++)
1068 if (view->line[i])
1069 free(view->line[i]);
1070
1071 free(view->line);
1072 view->line = NULL;
1073 }
1074
1075 view->start_time = time(NULL);
1076
b801d8b2
JF
1077 return TRUE;
1078}
1079
1080static void
1081end_update(struct view *view)
1082{
03a93dbb
JF
1083 if (!view->pipe)
1084 return;
6b161b31 1085 set_nonblocking_input(FALSE);
80ce96ea
JF
1086 if (view->pipe == stdin)
1087 fclose(view->pipe);
1088 else
1089 pclose(view->pipe);
2e8488b4 1090 view->pipe = NULL;
b801d8b2
JF
1091}
1092
03a93dbb 1093static bool
b801d8b2
JF
1094update_view(struct view *view)
1095{
1096 char buffer[BUFSIZ];
1097 char *line;
22f66b0a 1098 void **tmp;
82e78006
JF
1099 /* The number of lines to read. If too low it will cause too much
1100 * redrawing (and possible flickering), if too high responsiveness
1101 * will suffer. */
8855ada4 1102 unsigned long lines = view->height;
82e78006 1103 int redraw_from = -1;
b801d8b2
JF
1104
1105 if (!view->pipe)
1106 return TRUE;
1107
82e78006
JF
1108 /* Only redraw if lines are visible. */
1109 if (view->offset + view->height >= view->lines)
1110 redraw_from = view->lines - view->offset;
b801d8b2
JF
1111
1112 tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
1113 if (!tmp)
1114 goto alloc_error;
1115
1116 view->line = tmp;
1117
1118 while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
c34d9c9f 1119 int linelen = strlen(line);
b801d8b2 1120
b801d8b2
JF
1121 if (linelen)
1122 line[linelen - 1] = 0;
1123
6b161b31 1124 if (!view->ops->read(view, line))
b801d8b2 1125 goto alloc_error;
fd85fef1
JF
1126
1127 if (lines-- == 1)
1128 break;
b801d8b2
JF
1129 }
1130
8855ada4
JF
1131 {
1132 int digits;
1133
1134 lines = view->lines;
1135 for (digits = 0; lines; digits++)
1136 lines /= 10;
1137
1138 /* Keep the displayed view in sync with line number scaling. */
1139 if (digits != view->digits) {
1140 view->digits = digits;
1141 redraw_from = 0;
1142 }
1143 }
1144
82e78006
JF
1145 if (redraw_from >= 0) {
1146 /* If this is an incremental update, redraw the previous line
a28bcc22
JF
1147 * since for commits some members could have changed when
1148 * loading the main view. */
82e78006
JF
1149 if (redraw_from > 0)
1150 redraw_from--;
1151
1152 /* Incrementally draw avoids flickering. */
1153 redraw_view_from(view, redraw_from);
4c6fabc2 1154 }
b801d8b2 1155
eb98559e
JF
1156 /* Update the title _after_ the redraw so that if the redraw picks up a
1157 * commit reference in view->ref it'll be available here. */
1158 update_view_title(view);
1159
b801d8b2 1160 if (ferror(view->pipe)) {
03a93dbb 1161 report("Failed to read: %s", strerror(errno));
b801d8b2
JF
1162 goto end;
1163
1164 } else if (feof(view->pipe)) {
2e8488b4
JF
1165 time_t secs = time(NULL) - view->start_time;
1166
a28bcc22
JF
1167 if (view == VIEW(REQ_VIEW_HELP)) {
1168 report("%s", HELP);
2e8488b4
JF
1169 goto end;
1170 }
1171
1172 report("Loaded %d lines in %ld second%s", view->lines, secs,
1173 secs == 1 ? "" : "s");
b801d8b2
JF
1174 goto end;
1175 }
1176
1177 return TRUE;
1178
1179alloc_error:
2e8488b4 1180 report("Allocation failure");
b801d8b2
JF
1181
1182end:
1183 end_update(view);
1184 return FALSE;
1185}
1186
49f2b43f
JF
1187enum open_flags {
1188 OPEN_DEFAULT = 0, /* Use default view switching. */
1189 OPEN_SPLIT = 1, /* Split current view. */
1190 OPEN_BACKGROUNDED = 2, /* Backgrounded. */
1191 OPEN_RELOAD = 4, /* Reload view even if it is the current. */
1192};
1193
6b161b31 1194static void
49f2b43f 1195open_view(struct view *prev, enum request request, enum open_flags flags)
b801d8b2 1196{
49f2b43f
JF
1197 bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
1198 bool split = !!(flags & OPEN_SPLIT);
1199 bool reload = !!(flags & OPEN_RELOAD);
a28bcc22 1200 struct view *view = VIEW(request);
b801d8b2 1201 struct view *displayed;
6b161b31
JF
1202 int nviews;
1203
03a93dbb 1204 /* Cycle between displayed views and count the views. */
6b161b31 1205 foreach_view (displayed, nviews) {
03a93dbb
JF
1206 if (prev != view &&
1207 view == displayed &&
8855ada4 1208 !strcmp(view->vid, prev->vid)) {
6b161b31
JF
1209 current_view = nviews;
1210 /* Blur out the title of the previous view. */
1211 update_view_title(prev);
1212 report("Switching to %s view", view->name);
1213 return;
a28bcc22 1214 }
6b161b31 1215 }
b801d8b2 1216
49f2b43f 1217 if (view == prev && nviews == 1 && !reload) {
6b161b31
JF
1218 report("Already in %s view", view->name);
1219 return;
1220 }
b801d8b2 1221
8855ada4 1222 if ((reload || strcmp(view->vid, view->id)) &&
03a93dbb 1223 !begin_update(view)) {
6b161b31
JF
1224 report("Failed to load %s view", view->name);
1225 return;
1226 }
a28bcc22 1227
6b161b31
JF
1228 if (split) {
1229 display[current_view + 1] = view;
1230 if (!backgrounded)
a28bcc22 1231 current_view++;
6b161b31
JF
1232 } else {
1233 /* Maximize the current view. */
1234 memset(display, 0, sizeof(display));
1235 current_view = 0;
1236 display[current_view] = view;
a28bcc22 1237 }
b801d8b2 1238
6b161b31 1239 resize_display();
b801d8b2 1240
a8891802 1241 if (split && prev->lineno - prev->offset >= prev->height) {
03a93dbb 1242 /* Take the title line into account. */
eb98559e 1243 int lines = prev->lineno - prev->offset - prev->height + 1;
03a93dbb
JF
1244
1245 /* Scroll the view that was split if the current line is
1246 * outside the new limited view. */
1247 do_scroll_view(prev, lines);
1248 }
1249
6b161b31
JF
1250 if (prev && view != prev) {
1251 /* "Blur" the previous view. */
1252 update_view_title(prev);
1253
1254 /* Continue loading split views in the background. */
03a93dbb 1255 if (!split)
6b161b31 1256 end_update(prev);
b801d8b2
JF
1257 }
1258
03a93dbb
JF
1259 if (view->pipe) {
1260 /* Clear the old view and let the incremental updating refill
1261 * the screen. */
1262 wclear(view->win);
1263 report("Loading...");
1264 } else {
1265 redraw_view(view);
1266 report("");
1267 }
b801d8b2
JF
1268}
1269
1270
6b161b31
JF
1271/*
1272 * User request switch noodle
1273 */
1274
b801d8b2 1275static int
6b161b31 1276view_driver(struct view *view, enum request request)
b801d8b2 1277{
b801d8b2
JF
1278 int i;
1279
1280 switch (request) {
4a2909a7
JF
1281 case REQ_MOVE_UP:
1282 case REQ_MOVE_DOWN:
1283 case REQ_MOVE_PAGE_UP:
1284 case REQ_MOVE_PAGE_DOWN:
1285 case REQ_MOVE_FIRST_LINE:
1286 case REQ_MOVE_LAST_LINE:
a28bcc22 1287 move_view(view, request);
fd85fef1
JF
1288 break;
1289
4a2909a7
JF
1290 case REQ_SCROLL_LINE_DOWN:
1291 case REQ_SCROLL_LINE_UP:
1292 case REQ_SCROLL_PAGE_DOWN:
1293 case REQ_SCROLL_PAGE_UP:
a28bcc22 1294 scroll_view(view, request);
b801d8b2
JF
1295 break;
1296
4a2909a7 1297 case REQ_VIEW_MAIN:
4a2909a7 1298 case REQ_VIEW_DIFF:
2e8488b4
JF
1299 case REQ_VIEW_LOG:
1300 case REQ_VIEW_HELP:
6908bdbd 1301 case REQ_VIEW_PAGER:
49f2b43f 1302 open_view(view, request, OPEN_DEFAULT);
b801d8b2
JF
1303 break;
1304
6b161b31 1305 case REQ_ENTER:
6908bdbd
JF
1306 if (!view->lines) {
1307 report("Nothing to enter");
1308 break;
1309 }
6b161b31
JF
1310 return view->ops->enter(view);
1311
03a93dbb
JF
1312 case REQ_VIEW_NEXT:
1313 {
1314 int nviews = display[1] ? 2 : 1;
1315 int next_view = (current_view + 1) % nviews;
1316
1317 if (next_view == current_view) {
1318 report("Only one view is displayed");
1319 break;
1320 }
1321
1322 current_view = next_view;
1323 /* Blur out the title of the previous view. */
1324 update_view_title(view);
1325 report("Switching to %s view", display[current_view]->name);
1326 break;
1327 }
4a2909a7 1328 case REQ_TOGGLE_LINE_NUMBERS:
b76c2afc 1329 opt_line_number = !opt_line_number;
a28bcc22 1330 redraw_view(view);
b801d8b2
JF
1331 break;
1332
03a93dbb 1333 case REQ_PROMPT:
8855ada4 1334 /* Always reload^Wrerun commands from the prompt. */
49f2b43f 1335 open_view(view, opt_request, OPEN_RELOAD);
03a93dbb
JF
1336 break;
1337
4a2909a7 1338 case REQ_STOP_LOADING:
03a93dbb 1339 foreach_view (view, i) {
2e8488b4 1340 if (view->pipe)
03a93dbb
JF
1341 report("Stopped loaded of %s view", view->name),
1342 end_update(view);
1343 }
b801d8b2
JF
1344 break;
1345
4a2909a7 1346 case REQ_SHOW_VERSION:
2e8488b4 1347 report("Version: %s", VERSION);
b801d8b2
JF
1348 return TRUE;
1349
fac7db6c
JF
1350 case REQ_SCREEN_RESIZE:
1351 resize_display();
1352 /* Fall-through */
4a2909a7 1353 case REQ_SCREEN_REDRAW:
eb98559e
JF
1354 foreach_view (view, i) {
1355 redraw_view(view);
1356 update_view_title(view);
1357 }
4a2909a7
JF
1358 break;
1359
1360 case REQ_SCREEN_UPDATE:
b801d8b2
JF
1361 doupdate();
1362 return TRUE;
1363
1364 case REQ_QUIT:
1365 return FALSE;
1366
1367 default:
2e8488b4 1368 /* An unknown key will show most commonly used commands. */
a28bcc22 1369 report("%s", HELP);
b801d8b2
JF
1370 return TRUE;
1371 }
1372
1373 return TRUE;
1374}
1375
1376
1377/*
6b161b31 1378 * View backend handlers
b801d8b2
JF
1379 */
1380
6b161b31 1381static bool
22f66b0a 1382pager_draw(struct view *view, unsigned int lineno)
b801d8b2 1383{
78c70acd 1384 enum line_type type;
b801d8b2 1385 char *line;
4c6fabc2 1386 int linelen;
78c70acd 1387 int attr;
b801d8b2 1388
fd85fef1
JF
1389 if (view->offset + lineno >= view->lines)
1390 return FALSE;
1391
b801d8b2 1392 line = view->line[view->offset + lineno];
78c70acd 1393 type = get_line_type(line);
b801d8b2 1394
fd85fef1 1395 if (view->offset + lineno == view->lineno) {
8855ada4 1396 if (type == LINE_COMMIT) {
03a93dbb
JF
1397 string_copy(view->ref, line + 7);
1398 string_copy(ref_commit, view->ref);
1399 }
8855ada4 1400
78c70acd 1401 type = LINE_CURSOR;
fd85fef1
JF
1402 }
1403
78c70acd 1404 attr = get_line_attr(type);
b801d8b2 1405 wattrset(view->win, attr);
b76c2afc 1406
4c6fabc2
JF
1407 linelen = strlen(line);
1408 linelen = MIN(linelen, view->width);
1409
b76c2afc 1410 if (opt_line_number) {
8855ada4
JF
1411 static char indent[] = " ";
1412 unsigned long real_lineno = view->offset + lineno + 1;
a28bcc22 1413 int col = 0;
82e78006 1414
2e8488b4 1415 if (real_lineno == 1 || (real_lineno % opt_num_interval) == 0)
8855ada4
JF
1416 mvwprintw(view->win, lineno, 0, "%.*d", view->digits, real_lineno);
1417
1418 else if (view->digits < sizeof(indent))
1419 mvwaddnstr(view->win, lineno, 0, indent, view->digits);
1420
1421 waddstr(view->win, ": ");
4c6fabc2 1422
b76c2afc
JF
1423 while (line) {
1424 if (*line == '\t') {
82e78006
JF
1425 waddnstr(view->win, " ", 8 - (col % 8));
1426 col += 8 - (col % 8);
b76c2afc 1427 line++;
82e78006 1428
b76c2afc
JF
1429 } else {
1430 char *tab = strchr(line, '\t');
1431
1432 if (tab)
1433 waddnstr(view->win, line, tab - line);
1434 else
1435 waddstr(view->win, line);
82e78006 1436 col += tab - line;
b76c2afc
JF
1437 line = tab;
1438 }
1439 }
1440 waddstr(view->win, line);
1441
1442 } else {
2e8488b4
JF
1443#if 0
1444 /* NOTE: Code for only highlighting the text on the cursor line.
1445 * Kept since I've not yet decided whether to highlight the
1446 * entire line or not. --fonseca */
b76c2afc
JF
1447 /* No empty lines makes cursor drawing and clearing implicit. */
1448 if (!*line)
4c6fabc2 1449 line = " ", linelen = 1;
2e8488b4 1450#endif
4c6fabc2 1451 mvwaddnstr(view->win, lineno, 0, line, linelen);
b76c2afc 1452 }
b801d8b2 1453
2e8488b4
JF
1454 /* Paint the rest of the line if it's the cursor line. */
1455 if (type == LINE_CURSOR)
1456 wchgat(view->win, -1, 0, type, NULL);
1457
b801d8b2
JF
1458 return TRUE;
1459}
1460
6b161b31 1461static bool
22f66b0a
JF
1462pager_read(struct view *view, char *line)
1463{
1464 view->line[view->lines] = strdup(line);
1465 if (!view->line[view->lines])
1466 return FALSE;
1467
1468 view->lines++;
1469 return TRUE;
1470}
1471
6b161b31
JF
1472static bool
1473pager_enter(struct view *view)
1474{
1475 char *line = view->line[view->lineno];
1476
1477 if (get_line_type(line) == LINE_COMMIT) {
49f2b43f 1478 open_view(view, REQ_VIEW_DIFF, OPEN_DEFAULT);
6b161b31
JF
1479 }
1480
1481 return TRUE;
1482}
1483
6b161b31
JF
1484static struct view_ops pager_ops = {
1485 pager_draw,
1486 pager_read,
1487 pager_enter,
1488};
1489
80ce96ea 1490
c34d9c9f
JF
1491static struct ref **get_refs(char *id);
1492
6b161b31 1493static bool
22f66b0a
JF
1494main_draw(struct view *view, unsigned int lineno)
1495{
2e8488b4 1496 char buf[DATE_COLS + 1];
22f66b0a 1497 struct commit *commit;
78c70acd 1498 enum line_type type;
b76c2afc
JF
1499 int cols = 0;
1500 size_t timelen;
22f66b0a
JF
1501
1502 if (view->offset + lineno >= view->lines)
1503 return FALSE;
1504
1505 commit = view->line[view->offset + lineno];
4c6fabc2
JF
1506 if (!*commit->author)
1507 return FALSE;
22f66b0a 1508
22f66b0a 1509 if (view->offset + lineno == view->lineno) {
03a93dbb 1510 string_copy(view->ref, commit->id);
49f2b43f 1511 string_copy(ref_commit, view->ref);
78c70acd
JF
1512 type = LINE_CURSOR;
1513 } else {
b76c2afc
JF
1514 type = LINE_MAIN_COMMIT;
1515 }
1516
1517 wmove(view->win, lineno, cols);
1518 wattrset(view->win, get_line_attr(LINE_MAIN_DATE));
1519
4c6fabc2 1520 timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time);
b76c2afc 1521 waddnstr(view->win, buf, timelen);
4c6fabc2 1522 waddstr(view->win, " ");
b76c2afc 1523
4c6fabc2 1524 cols += DATE_COLS;
b76c2afc
JF
1525 wmove(view->win, lineno, cols);
1526 wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
1527
1528 if (strlen(commit->author) > 19) {
1529 waddnstr(view->win, commit->author, 18);
1530 wattrset(view->win, get_line_attr(LINE_MAIN_DELIM));
1531 waddch(view->win, '~');
1532 } else {
1533 waddstr(view->win, commit->author);
22f66b0a
JF
1534 }
1535
b76c2afc
JF
1536 cols += 20;
1537 wattrset(view->win, A_NORMAL);
1538 mvwaddch(view->win, lineno, cols, ACS_LTEE);
c34d9c9f
JF
1539 wmove(view->win, lineno, cols + 2);
1540
1541 if (commit->refs) {
1542 size_t i = 0;
1543
1544 do {
1545 if (commit->refs[i]->tag)
1546 wattrset(view->win, get_line_attr(LINE_MAIN_TAG));
1547 else
1548 wattrset(view->win, get_line_attr(LINE_MAIN_REF));
1549 waddstr(view->win, "[");
1550 waddstr(view->win, commit->refs[i]->name);
1551 waddstr(view->win, "]");
1552 wattrset(view->win, A_NORMAL);
1553 waddstr(view->win, " ");
1554 } while (commit->refs[i++]->next);
1555 }
1556
78c70acd 1557 wattrset(view->win, get_line_attr(type));
c34d9c9f 1558 waddstr(view->win, commit->title);
22f66b0a
JF
1559 wattrset(view->win, A_NORMAL);
1560
1561 return TRUE;
1562}
1563
4c6fabc2 1564/* Reads git log --pretty=raw output and parses it into the commit struct. */
6b161b31 1565static bool
22f66b0a
JF
1566main_read(struct view *view, char *line)
1567{
78c70acd
JF
1568 enum line_type type = get_line_type(line);
1569 struct commit *commit;
22f66b0a 1570
78c70acd
JF
1571 switch (type) {
1572 case LINE_COMMIT:
22f66b0a
JF
1573 commit = calloc(1, sizeof(struct commit));
1574 if (!commit)
1575 return FALSE;
1576
4c6fabc2 1577 line += STRING_SIZE("commit ");
b76c2afc 1578
22f66b0a 1579 view->line[view->lines++] = commit;
82e78006 1580 string_copy(commit->id, line);
c34d9c9f 1581 commit->refs = get_refs(commit->id);
78c70acd 1582 break;
22f66b0a 1583
8855ada4 1584 case LINE_AUTHOR:
b76c2afc 1585 {
4c6fabc2 1586 char *ident = line + STRING_SIZE("author ");
b76c2afc
JF
1587 char *end = strchr(ident, '<');
1588
1589 if (end) {
1590 for (; end > ident && isspace(end[-1]); end--) ;
1591 *end = 0;
1592 }
1593
1594 commit = view->line[view->lines - 1];
82e78006 1595 string_copy(commit->author, ident);
b76c2afc 1596
4c6fabc2 1597 /* Parse epoch and timezone */
b76c2afc
JF
1598 if (end) {
1599 char *secs = strchr(end + 1, '>');
1600 char *zone;
1601 time_t time;
1602
1603 if (!secs || secs[1] != ' ')
1604 break;
1605
1606 secs += 2;
1607 time = (time_t) atol(secs);
1608 zone = strchr(secs, ' ');
4c6fabc2 1609 if (zone && strlen(zone) == STRING_SIZE(" +0700")) {
b76c2afc
JF
1610 long tz;
1611
1612 zone++;
1613 tz = ('0' - zone[1]) * 60 * 60 * 10;
1614 tz += ('0' - zone[2]) * 60 * 60;
1615 tz += ('0' - zone[3]) * 60;
1616 tz += ('0' - zone[4]) * 60;
1617
1618 if (zone[0] == '-')
1619 tz = -tz;
1620
1621 time -= tz;
1622 }
1623 gmtime_r(&time, &commit->time);
1624 }
1625 break;
1626 }
78c70acd 1627 default:
2e8488b4
JF
1628 /* We should only ever end up here if there has already been a
1629 * commit line, however, be safe. */
1630 if (view->lines == 0)
1631 break;
1632
1633 /* Fill in the commit title if it has not already been set. */
78c70acd 1634 commit = view->line[view->lines - 1];
2e8488b4
JF
1635 if (commit->title[0])
1636 break;
1637
1638 /* Require titles to start with a non-space character at the
1639 * offset used by git log. */
eb98559e
JF
1640 /* FIXME: More gracefull handling of titles; append "..." to
1641 * shortened titles, etc. */
2e8488b4 1642 if (strncmp(line, " ", 4) ||
eb98559e 1643 isspace(line[4]))
82e78006
JF
1644 break;
1645
1646 string_copy(commit->title, line + 4);
22f66b0a
JF
1647 }
1648
1649 return TRUE;
1650}
1651
6b161b31
JF
1652static bool
1653main_enter(struct view *view)
b801d8b2 1654{
49f2b43f 1655 open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED);
6b161b31 1656 return TRUE;
b801d8b2
JF
1657}
1658
6b161b31
JF
1659static struct view_ops main_ops = {
1660 main_draw,
1661 main_read,
1662 main_enter,
1663};
2e8488b4 1664
c34d9c9f 1665
6b161b31
JF
1666/*
1667 * Status management
1668 */
2e8488b4 1669
8855ada4
JF
1670/* Whether or not the curses interface has been initialized. */
1671bool cursed = FALSE;
1672
6b161b31
JF
1673/* The status window is used for polling keystrokes. */
1674static WINDOW *status_win;
4a2909a7 1675
2e8488b4 1676/* Update status and title window. */
4a2909a7
JF
1677static void
1678report(const char *msg, ...)
1679{
1680 va_list args;
b76c2afc 1681
2e8488b4
JF
1682 /* Update the title window first, so the cursor ends up in the status
1683 * window. */
6b161b31 1684 update_view_title(display[current_view]);
4a2909a7 1685
4b76734f
JF
1686 va_start(args, msg);
1687
b801d8b2
JF
1688 werase(status_win);
1689 wmove(status_win, 0, 0);
4b76734f
JF
1690 if (*msg)
1691 vwprintw(status_win, msg, args);
b801d8b2
JF
1692 wrefresh(status_win);
1693
1694 va_end(args);
b801d8b2
JF
1695}
1696
6b161b31
JF
1697/* Controls when nodelay should be in effect when polling user input. */
1698static void
1ba2ae4b 1699set_nonblocking_input(bool loading)
b801d8b2 1700{
6b161b31
JF
1701 /* The number of loading views. */
1702 static unsigned int nloading;
b801d8b2 1703
1ba2ae4b
JF
1704 if ((loading == FALSE && nloading-- == 1) ||
1705 (loading == TRUE && nloading++ == 0))
1706 nodelay(status_win, loading);
6b161b31
JF
1707}
1708
1709static void
1710init_display(void)
1711{
1712 int x, y;
b76c2afc 1713
6908bdbd
JF
1714 /* Initialize the curses library */
1715 if (isatty(STDIN_FILENO)) {
8855ada4 1716 cursed = !!initscr();
6908bdbd
JF
1717 } else {
1718 /* Leave stdin and stdout alone when acting as a pager. */
1719 FILE *io = fopen("/dev/tty", "r+");
1720
8855ada4 1721 cursed = !!newterm(NULL, io, io);
6908bdbd
JF
1722 }
1723
8855ada4
JF
1724 if (!cursed)
1725 die("Failed to initialize curses");
1726
2e8488b4
JF
1727 nonl(); /* Tell curses not to do NL->CR/NL on output */
1728 cbreak(); /* Take input chars one at a time, no wait for \n */
1729 noecho(); /* Don't echo input */
b801d8b2 1730 leaveok(stdscr, TRUE);
b801d8b2
JF
1731
1732 if (has_colors())
1733 init_colors();
1734
1735 getmaxyx(stdscr, y, x);
1736 status_win = newwin(1, 0, y - 1, 0);
1737 if (!status_win)
1738 die("Failed to create status window");
1739
1740 /* Enable keyboard mapping */
1741 keypad(status_win, TRUE);
78c70acd 1742 wbkgdset(status_win, get_line_attr(LINE_STATUS));
6b161b31
JF
1743}
1744
c34d9c9f
JF
1745
1746/*
1747 * Repository references
1748 */
1749
1750static struct ref *refs;
1751size_t refs_size;
1752
1753static struct ref **
1754get_refs(char *id)
1755{
1756 struct ref **id_refs = NULL;
1757 size_t id_refs_size = 0;
1758 size_t i;
1759
1760 for (i = 0; i < refs_size; i++) {
1761 struct ref **tmp;
1762
1763 if (strcmp(id, refs[i].id))
1764 continue;
1765
1766 tmp = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs));
1767 if (!tmp) {
1768 if (id_refs)
1769 free(id_refs);
1770 return NULL;
1771 }
1772
1773 id_refs = tmp;
1774 id_refs[id_refs_size++] = &refs[i];
1775 if (id_refs_size > 1)
1776 id_refs[id_refs_size - 1]->next = 1;
1777 }
1778
1779 return id_refs;
1780}
1781
1782static int
1783load_refs(void)
1784{
1785 char *cmd_env = getenv("TIG_LS_REMOTE");
1786 char *cmd = cmd_env ? cmd_env : TIG_LS_REMOTE;
1787 FILE *pipe = popen(cmd, "r");
1788 char buffer[BUFSIZ];
1789 char *line;
1790
1791 if (!pipe)
1792 return ERR;
1793
1794 while ((line = fgets(buffer, sizeof(buffer), pipe))) {
1795 char *name = strchr(line, '\t');
1796 struct ref *ref;
1797 int namelen;
1798 bool tag = FALSE;
1799
1800 if (!name)
1801 continue;
1802
1803 *name++ = 0;
1804 namelen = strlen(name) - 1;
1805 if (name[namelen - 1] == '}') {
1806 while (namelen > 0 && name[namelen] != '^')
1807 namelen--;
1808 }
1809 name[namelen] = 0;
1810
1811 if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
1812 name += STRING_SIZE("refs/tags/");
1813 tag = TRUE;
1814 }
1815
1816 refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
1817 if (!refs)
1818 return ERR;
1819
1820 ref = &refs[refs_size++];
1821 ref->tag = tag;
1822 ref->name = strdup(name);
1823 if (!ref->name)
1824 return ERR;
1825
1826 string_copy(ref->id, line);
1827 }
1828
1829 if (ferror(pipe))
1830 return ERR;
1831
1832 pclose(pipe);
1833
1834 return OK;
1835}
1836
6b161b31
JF
1837/*
1838 * Main
1839 */
1840
1841static void
1842quit(int sig)
1843{
8855ada4
JF
1844 /* XXX: Restore tty modes and let the OS cleanup the rest! */
1845 if (cursed)
1846 endwin();
6b161b31
JF
1847 exit(0);
1848}
1849
1850static void die(const char *err, ...)
1851{
1852 va_list args;
1853
1854 endwin();
1855
1856 va_start(args, err);
1857 fputs("tig: ", stderr);
1858 vfprintf(stderr, err, args);
1859 fputs("\n", stderr);
1860 va_end(args);
1861
1862 exit(1);
1863}
1864
1865int
1866main(int argc, char *argv[])
1867{
1ba2ae4b 1868 struct view *view;
6b161b31 1869 enum request request;
1ba2ae4b 1870 size_t i;
6b161b31
JF
1871
1872 signal(SIGINT, quit);
1873
8855ada4 1874 if (!parse_options(argc, argv))
6b161b31
JF
1875 return 0;
1876
c34d9c9f
JF
1877 if (load_refs() == ERR)
1878 die("Failed to load refs.");
1879
1ba2ae4b
JF
1880 for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++)
1881 view->cmd_env = getenv(view->cmd_env);
1882
6b161b31
JF
1883 request = opt_request;
1884
1885 init_display();
b801d8b2
JF
1886
1887 while (view_driver(display[current_view], request)) {
6b161b31 1888 int key;
b801d8b2
JF
1889 int i;
1890
6b161b31
JF
1891 foreach_view (view, i)
1892 update_view(view);
b801d8b2
JF
1893
1894 /* Refresh, accept single keystroke of input */
6b161b31
JF
1895 key = wgetch(status_win);
1896 request = get_request(key);
03a93dbb 1897
fac7db6c
JF
1898 /* Some low-level request handling. This keeps handling of
1899 * status_win restricted. */
1900 switch (request) {
1901 case REQ_PROMPT:
6908bdbd
JF
1902 report(":");
1903 /* Temporarily switch to line-oriented and echoed
1904 * input. */
03a93dbb
JF
1905 nocbreak();
1906 echo();
49f2b43f
JF
1907
1908 if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) {
1909 memcpy(opt_cmd, "git ", 4);
1910 opt_request = REQ_VIEW_PAGER;
1911 } else {
1912 request = ERR;
1913 }
1914
6908bdbd
JF
1915 noecho();
1916 cbreak();
fac7db6c
JF
1917 break;
1918
1919 case REQ_SCREEN_RESIZE:
1920 {
1921 int height, width;
1922
1923 getmaxyx(stdscr, height, width);
1924
1925 /* Resize the status view and let the view driver take
1926 * care of resizing the displayed views. */
1927 wresize(status_win, 1, width);
1928 mvwin(status_win, height - 1, 0);
1929 wrefresh(status_win);
1930 break;
1931 }
1932 default:
1933 break;
03a93dbb 1934 }
b801d8b2
JF
1935 }
1936
1937 quit(0);
1938
1939 return 0;
1940}
1941
1942/**
4c6fabc2
JF
1943 * TODO
1944 * ----
1945 * Features that should be explored.
1946 *
fac7db6c 1947 * - Searching.
4c6fabc2
JF
1948 *
1949 * - Locale support.
1950 *
b801d8b2
JF
1951 * COPYRIGHT
1952 * ---------
4a2909a7 1953 * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
b801d8b2
JF
1954 *
1955 * This program is free software; you can redistribute it and/or modify
1956 * it under the terms of the GNU General Public License as published by
1957 * the Free Software Foundation; either version 2 of the License, or
1958 * (at your option) any later version.
1959 *
1960 * SEE ALSO
1961 * --------
4c6fabc2 1962 * [verse]
b801d8b2
JF
1963 * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
1964 * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
4c6fabc2
JF
1965 * gitk(1): git repository browser written using tcl/tk,
1966 * gitview(1): git repository browser written using python/gtk.
b801d8b2 1967 **/