Merge branch 'jk/dotgit-case-maint-1.8.5' into maint-1.8.5
[git/git.git] / pager.c
CommitLineData
f67b45f8 1#include "cache.h"
ea27a18c 2#include "run-command.h"
a3da8821 3#include "sigchain.h"
f67b45f8 4
a3d023d0
JH
5#ifndef DEFAULT_PAGER
6#define DEFAULT_PAGER "less"
7#endif
8
4914c962
NTND
9struct pager_config {
10 const char *cmd;
11 int want;
12 char *value;
13};
14
f67b45f8 15/*
bfdd9ffd
JS
16 * This is split up from the rest of git so that we can do
17 * something different on Windows.
f67b45f8
LT
18 */
19
ac0ba18d 20static const char *pager_argv[] = { NULL, NULL };
ea27a18c
JK
21static struct child_process pager_process;
22
bfdd9ffd
JS
23static void wait_for_pager(void)
24{
25 fflush(stdout);
26 fflush(stderr);
27 /* signal EOF to pager */
28 close(1);
29 close(2);
30 finish_command(&pager_process);
31}
f67b45f8 32
a3da8821
JK
33static void wait_for_pager_signal(int signo)
34{
35 wait_for_pager();
36 sigchain_pop(signo);
37 raise(signo);
38}
39
64778d24 40const char *git_pager(int stdout_is_tty)
f67b45f8 41{
63618245 42 const char *pager;
f67b45f8 43
64778d24 44 if (!stdout_is_tty)
63618245
JN
45 return NULL;
46
47 pager = getenv("GIT_PAGER");
cad3a205
JH
48 if (!pager) {
49 if (!pager_program)
ef90d6d4 50 git_config(git_default_config, NULL);
54adf370 51 pager = pager_program;
cad3a205 52 }
c27d205a
ML
53 if (!pager)
54 pager = getenv("PAGER");
402461aa 55 if (!pager)
a3d023d0 56 pager = DEFAULT_PAGER;
ed016612 57 if (!*pager || !strcmp(pager, "cat"))
63618245
JN
58 pager = NULL;
59
60 return pager;
61}
62
63void setup_pager(void)
64{
64778d24 65 const char *pager = git_pager(isatty(1));
63618245 66
88e8f908 67 if (!pager || pager_in_use())
402461aa
JS
68 return;
69
ad6c3739
ZJS
70 /*
71 * force computing the width of the terminal before we redirect
72 * the standard output to the pager.
73 */
74 (void) term_columns();
75
2e6c012e 76 setenv("GIT_PAGER_IN_USE", "true", 1);
85fb65ed 77
bfdd9ffd 78 /* spawn the pager */
ac0ba18d
JK
79 pager_argv[0] = pager;
80 pager_process.use_shell = 1;
ea27a18c
JK
81 pager_process.argv = pager_argv;
82 pager_process.in = -1;
25fc1786
JS
83 if (!getenv("LESS")) {
84 static const char *env[] = { "LESS=FRSX", NULL };
85 pager_process.env = env;
86 }
bfdd9ffd
JS
87 if (start_command(&pager_process))
88 return;
89
90 /* original process continues, but writes to the pipe */
91 dup2(pager_process.in, 1);
a8335024
JH
92 if (isatty(2))
93 dup2(pager_process.in, 2);
bfdd9ffd
JS
94 close(pager_process.in);
95
96 /* this makes sure that the parent terminates after the pager */
a3da8821 97 sigchain_push_common(wait_for_pager_signal);
bfdd9ffd 98 atexit(wait_for_pager);
f67b45f8 99}
6e9af863
JK
100
101int pager_in_use(void)
102{
103 const char *env;
6e9af863
JK
104 env = getenv("GIT_PAGER_IN_USE");
105 return env ? git_config_bool("GIT_PAGER_IN_USE", env) : 0;
106}
ad6c3739
ZJS
107
108/*
109 * Return cached value (if set) or $COLUMNS environment variable (if
110 * set and positive) or ioctl(1, TIOCGWINSZ).ws_col (if positive),
111 * and default to 80 if all else fails.
112 */
113int term_columns(void)
114{
115 static int term_columns_at_startup;
116
117 char *col_string;
118 int n_cols;
119
120 if (term_columns_at_startup)
121 return term_columns_at_startup;
122
123 term_columns_at_startup = 80;
124
125 col_string = getenv("COLUMNS");
126 if (col_string && (n_cols = atoi(col_string)) > 0)
127 term_columns_at_startup = n_cols;
128#ifdef TIOCGWINSZ
129 else {
130 struct winsize ws;
131 if (!ioctl(1, TIOCGWINSZ, &ws) && ws.ws_col)
132 term_columns_at_startup = ws.ws_col;
133 }
134#endif
135
136 return term_columns_at_startup;
137}
4d9e079e 138
ec7ff5ba
ZJS
139/*
140 * How many columns do we need to show this number in decimal?
141 */
142int decimal_width(int number)
143{
144 int i, width;
145
146 for (width = 1, i = 10; i <= number; width++)
147 i *= 10;
148 return width;
149}
4914c962
NTND
150
151static int pager_command_config(const char *var, const char *value, void *data)
152{
153 struct pager_config *c = data;
154 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd)) {
155 int b = git_config_maybe_bool(var, value);
156 if (b >= 0)
157 c->want = b;
158 else {
159 c->want = 1;
160 c->value = xstrdup(value);
161 }
162 }
163 return 0;
164}
165
166/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
167int check_pager_config(const char *cmd)
168{
169 struct pager_config c;
170 c.cmd = cmd;
171 c.want = -1;
172 c.value = NULL;
173 git_config(pager_command_config, &c);
174 if (c.value)
175 pager_program = c.value;
176 return c.want;
177}