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