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