git.oblomov.eu Git - git/blob - pager.c

   1 #include "cache.h"
   2 #include "config.h"
   3 #include "run-command.h"
   4 #include "sigchain.h"
   5 #include "alias.h"
   6
   7 #ifndef DEFAULT_PAGER
   8 #define DEFAULT_PAGER "less"
   9 #endif
  10
  11 static struct child_process pager_process = CHILD_PROCESS_INIT;
  12 static const char *pager_program;
  13
  14 static void close_pager_fds(void)
  15 {
  16         /* signal EOF to pager */
  17         close(1);
  18         close(2);
  19 }
  20
  21 static void wait_for_pager_atexit(void)
  22 {
  23         fflush(stdout);
  24         fflush(stderr);
  25         close_pager_fds();
  26         finish_command(&pager_process);
  27 }
  28
  29 static void wait_for_pager_signal(int signo)
  30 {
  31         close_pager_fds();
  32         finish_command_in_signal(&pager_process);
  33         sigchain_pop(signo);
  34         raise(signo);
  35 }
  36
  37 static int core_pager_config(const char *var, const char *value, void *data)
  38 {
  39         if (!strcmp(var, "core.pager"))
  40                 return git_config_string(&pager_program, var, value);
  41         return 0;
  42 }
  43
  44 const char *git_pager(int stdout_is_tty)
  45 {
  46         const char *pager;
  47
  48         if (!stdout_is_tty)
  49                 return NULL;
  50
  51         pager = getenv("GIT_PAGER");
  52         if (!pager) {
  53                 if (!pager_program)
  54                         read_early_config(core_pager_config, NULL);
  55                 pager = pager_program;
  56         }
  57         if (!pager)
  58                 pager = getenv("PAGER");
  59         if (!pager)
  60                 pager = DEFAULT_PAGER;
  61         if (!*pager || !strcmp(pager, "cat"))
  62                 pager = NULL;
  63
  64         return pager;
  65 }
  66
  67 static void setup_pager_env(struct strvec *env)
  68 {
  69         const char **argv;
  70         int i;
  71         char *pager_env = xstrdup(PAGER_ENV);
  72         int n = split_cmdline(pager_env, &argv);
  73
  74         if (n < 0)
  75                 die("malformed build-time PAGER_ENV: %s",
  76                         split_cmdline_strerror(n));
  77
  78         for (i = 0; i < n; i++) {
  79                 char *cp = strchr(argv[i], '=');
  80
  81                 if (!cp)
  82                         die("malformed build-time PAGER_ENV");
  83
  84                 *cp = '\0';
  85                 if (!getenv(argv[i])) {
  86                         *cp = '=';
  87                         strvec_push(env, argv[i]);
  88                 }
  89         }
  90         free(pager_env);
  91         free(argv);
  92 }
  93
  94 void prepare_pager_args(struct child_process *pager_process, const char *pager)
  95 {
  96         strvec_push(&pager_process->args, pager);
  97         pager_process->use_shell = 1;
  98         setup_pager_env(&pager_process->env_array);
  99         pager_process->trace2_child_class = "pager";
 100 }
 101
 102 void setup_pager(void)
 103 {
 104         const char *pager = git_pager(isatty(1));
 105
 106         if (!pager)
 107                 return;
 108
 109         /*
 110          * After we redirect standard output, we won't be able to use an ioctl
 111          * to get the terminal size. Let's grab it now, and then set $COLUMNS
 112          * to communicate it to any sub-processes.
 113          */
 114 #if !defined(WIN32) || defined(TIOCGWINSZ)
 115         {
 116                 char buf[64];
 117                 xsnprintf(buf, sizeof(buf), "%d", term_columns());
 118                 setenv("COLUMNS", buf, 0);
 119         }
 120 #endif
 121
 122         setenv("GIT_PAGER_IN_USE", "true", 1);
 123
 124         /* spawn the pager */
 125         prepare_pager_args(&pager_process, pager);
 126         pager_process.in = -1;
 127         strvec_push(&pager_process.env_array, "GIT_PAGER_IN_USE");
 128         if (start_command(&pager_process))
 129                 return;
 130
 131         /* original process continues, but writes to the pipe */
 132         dup2(pager_process.in, 1);
 133         if (isatty(2))
 134                 dup2(pager_process.in, 2);
 135         close(pager_process.in);
 136
 137         /* this makes sure that the parent terminates after the pager */
 138         sigchain_push_common(wait_for_pager_signal);
 139         atexit(wait_for_pager_atexit);
 140 }
 141
 142 int pager_in_use(void)
 143 {
 144         return git_env_bool("GIT_PAGER_IN_USE", 0);
 145 }
 146
 147 /*
 148  * Return cached value (if set) or $COLUMNS environment variable (if
 149  * set and positive) or ioctl(1, TIOCGWINSZ).ws_col (if positive),
 150  * and default to 80 if all else fails.
 151  */
 152 int term_columns(void)
 153 {
 154         static int term_columns_at_startup;
 155
 156         char *col_string;
 157         int n_cols;
 158
 159         if (term_columns_at_startup)
 160                 return term_columns_at_startup;
 161
 162         term_columns_at_startup = 80;
 163
 164         col_string = getenv("COLUMNS");
 165         if (col_string && (n_cols = atoi(col_string)) > 0)
 166                 term_columns_at_startup = n_cols;
 167 #ifdef TIOCGWINSZ
 168         else {
 169                 struct winsize ws;
 170                 if (!ioctl(1, TIOCGWINSZ, &ws) && ws.ws_col)
 171                         term_columns_at_startup = ws.ws_col;
 172         }
 173 #endif
 174
 175         return term_columns_at_startup;
 176 }
 177
 178 /*
 179  * Clear the entire line, leave cursor in first column.
 180  */
 181 void term_clear_line(void)
 182 {
 183         if (is_terminal_dumb())
 184                 /*
 185                  * Fall back to print a terminal width worth of space
 186                  * characters (hoping that the terminal is still as wide
 187                  * as it was upon the first call to term_columns()).
 188                  */
 189                 fprintf(stderr, "\r%*s\r", term_columns(), "");
 190         else
 191                 /*
 192                  * On non-dumb terminals use an escape sequence to clear
 193                  * the whole line, no matter how wide the terminal.
 194                  */
 195                 fputs("\r\033[K", stderr);
 196 }
 197
 198 /*
 199  * How many columns do we need to show this number in decimal?
 200  */
 201 int decimal_width(uintmax_t number)
 202 {
 203         int width;
 204
 205         for (width = 1; number >= 10; width++)
 206                 number /= 10;
 207         return width;
 208 }
 209
 210 struct pager_command_config_data {
 211         const char *cmd;
 212         int want;
 213         char *value;
 214 };
 215
 216 static int pager_command_config(const char *var, const char *value, void *vdata)
 217 {
 218         struct pager_command_config_data *data = vdata;
 219         const char *cmd;
 220
 221         if (skip_prefix(var, "pager.", &cmd) && !strcmp(cmd, data->cmd)) {
 222                 int b = git_parse_maybe_bool(value);
 223                 if (b >= 0)
 224                         data->want = b;
 225                 else {
 226                         data->want = 1;
 227                         data->value = xstrdup(value);
 228                 }
 229         }
 230
 231         return 0;
 232 }
 233
 234 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
 235 int check_pager_config(const char *cmd)
 236 {
 237         struct pager_command_config_data data;
 238
 239         data.cmd = cmd;
 240         data.want = -1;
 241         data.value = NULL;
 242
 243         read_early_config(pager_command_config, &data);
 244
 245         if (data.value)
 246                 pager_program = data.value;
 247         return data.want;
 248 }