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