pager.c 4.59 KB
Newer Older
1
#include "cache.h"
2
#include "config.h"
3
#include "run-command.h"
4
#include "sigchain.h"
5
#include "alias.h"
6

7 8 9 10
#ifndef DEFAULT_PAGER
#define DEFAULT_PAGER "less"
#endif

11
static struct child_process pager_process = CHILD_PROCESS_INIT;
12
static const char *pager_program;
13

14
static void wait_for_pager(int in_signal)
15
{
16 17 18 19
	if (!in_signal) {
		fflush(stdout);
		fflush(stderr);
	}
20 21 22
	/* signal EOF to pager */
	close(1);
	close(2);
23 24 25 26 27 28 29 30 31
	if (in_signal)
		finish_command_in_signal(&pager_process);
	else
		finish_command(&pager_process);
}

static void wait_for_pager_atexit(void)
{
	wait_for_pager(0);
32
}
33

34 35
static void wait_for_pager_signal(int signo)
{
36
	wait_for_pager(1);
37 38 39 40
	sigchain_pop(signo);
	raise(signo);
}

41 42 43 44 45 46 47
static int core_pager_config(const char *var, const char *value, void *data)
{
	if (!strcmp(var, "core.pager"))
		return git_config_string(&pager_program, var, value);
	return 0;
}

48
const char *git_pager(int stdout_is_tty)
49
{
50
	const char *pager;
51

52
	if (!stdout_is_tty)
53 54 55
		return NULL;

	pager = getenv("GIT_PAGER");
56 57
	if (!pager) {
		if (!pager_program)
Jeff King's avatar
Jeff King committed
58
			read_early_config(core_pager_config, NULL);
59
		pager = pager_program;
60
	}
61 62
	if (!pager)
		pager = getenv("PAGER");
63
	if (!pager)
64
		pager = DEFAULT_PAGER;
65
	if (!*pager || !strcmp(pager, "cat"))
66 67 68 69 70
		pager = NULL;

	return pager;
}

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
static void setup_pager_env(struct argv_array *env)
{
	const char **argv;
	int i;
	char *pager_env = xstrdup(PAGER_ENV);
	int n = split_cmdline(pager_env, &argv);

	if (n < 0)
		die("malformed build-time PAGER_ENV: %s",
			split_cmdline_strerror(n));

	for (i = 0; i < n; i++) {
		char *cp = strchr(argv[i], '=');

		if (!cp)
			die("malformed build-time PAGER_ENV");

		*cp = '\0';
		if (!getenv(argv[i])) {
			*cp = '=';
			argv_array_push(env, argv[i]);
		}
	}
	free(pager_env);
	free(argv);
}

98 99 100 101
void prepare_pager_args(struct child_process *pager_process, const char *pager)
{
	argv_array_push(&pager_process->args, pager);
	pager_process->use_shell = 1;
102
	setup_pager_env(&pager_process->env_array);
103
	pager_process->trace2_child_class = "pager";
104 105
}

106 107
void setup_pager(void)
{
108
	const char *pager = git_pager(isatty(1));
109

110
	if (!pager)
111 112
		return;

113
	/*
114 115 116
	 * After we redirect standard output, we won't be able to use an ioctl
	 * to get the terminal size. Let's grab it now, and then set $COLUMNS
	 * to communicate it to any sub-processes.
117
	 */
118 119 120 121 122
	{
		char buf[64];
		xsnprintf(buf, sizeof(buf), "%d", term_columns());
		setenv("COLUMNS", buf, 0);
	}
123

124
	setenv("GIT_PAGER_IN_USE", "true", 1);
125

126
	/* spawn the pager */
127
	prepare_pager_args(&pager_process, pager);
128
	pager_process.in = -1;
129
	argv_array_push(&pager_process.env_array, "GIT_PAGER_IN_USE");
130 131 132 133 134
	if (start_command(&pager_process))
		return;

	/* original process continues, but writes to the pipe */
	dup2(pager_process.in, 1);
135 136
	if (isatty(2))
		dup2(pager_process.in, 2);
137 138 139
	close(pager_process.in);

	/* this makes sure that the parent terminates after the pager */
140
	sigchain_push_common(wait_for_pager_signal);
141
	atexit(wait_for_pager_atexit);
142
}
143 144 145

int pager_in_use(void)
{
146
	return git_env_bool("GIT_PAGER_IN_USE", 0);
147
}
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

/*
 * Return cached value (if set) or $COLUMNS environment variable (if
 * set and positive) or ioctl(1, TIOCGWINSZ).ws_col (if positive),
 * and default to 80 if all else fails.
 */
int term_columns(void)
{
	static int term_columns_at_startup;

	char *col_string;
	int n_cols;

	if (term_columns_at_startup)
		return term_columns_at_startup;

	term_columns_at_startup = 80;

	col_string = getenv("COLUMNS");
	if (col_string && (n_cols = atoi(col_string)) > 0)
		term_columns_at_startup = n_cols;
#ifdef TIOCGWINSZ
	else {
		struct winsize ws;
		if (!ioctl(1, TIOCGWINSZ, &ws) && ws.ws_col)
			term_columns_at_startup = ws.ws_col;
	}
#endif

	return term_columns_at_startup;
}
179

180 181 182
/*
 * How many columns do we need to show this number in decimal?
 */
183
int decimal_width(uintmax_t number)
184
{
185
	int width;
186

187 188
	for (width = 1; number >= 10; width++)
		number /= 10;
189 190
	return width;
}
191

192 193 194 195 196 197 198
struct pager_command_config_data {
	const char *cmd;
	int want;
	char *value;
};

static int pager_command_config(const char *var, const char *value, void *vdata)
199
{
200 201 202 203
	struct pager_command_config_data *data = vdata;
	const char *cmd;

	if (skip_prefix(var, "pager.", &cmd) && !strcmp(cmd, data->cmd)) {
204
		int b = git_parse_maybe_bool(value);
205
		if (b >= 0)
206
			data->want = b;
207
		else {
208 209
			data->want = 1;
			data->value = xstrdup(value);
210 211
		}
	}
212 213 214 215 216 217 218 219 220 221 222 223 224

	return 0;
}

/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
int check_pager_config(const char *cmd)
{
	struct pager_command_config_data data;

	data.cmd = cmd;
	data.want = -1;
	data.value = NULL;

Jeff King's avatar
Jeff King committed
225
	read_early_config(pager_command_config, &data);
226 227 228 229

	if (data.value)
		pager_program = data.value;
	return data.want;
230
}