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