command-list.txt: add the common groups block
[git] / column.c
1 #include "cache.h"
2 #include "column.h"
3 #include "string-list.h"
4 #include "parse-options.h"
5 #include "run-command.h"
6 #include "utf8.h"
7
8 #define XY2LINEAR(d, x, y) (COL_LAYOUT((d)->colopts) == COL_COLUMN ? \
9                             (x) * (d)->rows + (y) : \
10                             (y) * (d)->cols + (x))
11
12 struct column_data {
13         const struct string_list *list;
14         unsigned int colopts;
15         struct column_options opts;
16
17         int rows, cols;
18         int *len;               /* cell length */
19         int *width;           /* index to the longest row in column */
20 };
21
22 /* return length of 's' in letters, ANSI escapes stripped */
23 static int item_length(unsigned int colopts, const char *s)
24 {
25         int len, i = 0;
26         struct strbuf str = STRBUF_INIT;
27
28         strbuf_addstr(&str, s);
29         while ((s = strstr(str.buf + i, "\033[")) != NULL) {
30                 int len = strspn(s + 2, "0123456789;");
31                 i = s - str.buf;
32                 strbuf_remove(&str, i, len + 3); /* \033[<len><func char> */
33         }
34         len = utf8_strwidth(str.buf);
35         strbuf_release(&str);
36         return len;
37 }
38
39 /*
40  * Calculate cell width, rows and cols for a table of equal cells, given
41  * table width and how many spaces between cells.
42  */
43 static void layout(struct column_data *data, int *width)
44 {
45         int i;
46
47         *width = 0;
48         for (i = 0; i < data->list->nr; i++)
49                 if (*width < data->len[i])
50                         *width = data->len[i];
51
52         *width += data->opts.padding;
53
54         data->cols = (data->opts.width - strlen(data->opts.indent)) / *width;
55         if (data->cols == 0)
56                 data->cols = 1;
57
58         data->rows = DIV_ROUND_UP(data->list->nr, data->cols);
59 }
60
61 static void compute_column_width(struct column_data *data)
62 {
63         int i, x, y;
64         for (x = 0; x < data->cols; x++) {
65                 data->width[x] = XY2LINEAR(data, x, 0);
66                 for (y = 0; y < data->rows; y++) {
67                         i = XY2LINEAR(data, x, y);
68                         if (i < data->list->nr &&
69                             data->len[data->width[x]] < data->len[i])
70                                 data->width[x] = i;
71                 }
72         }
73 }
74
75 /*
76  * Shrink all columns by shortening them one row each time (and adding
77  * more columns along the way). Hopefully the longest cell will be
78  * moved to the next column, column is shrunk so we have more space
79  * for new columns. The process ends when the whole thing no longer
80  * fits in data->total_width.
81  */
82 static void shrink_columns(struct column_data *data)
83 {
84         REALLOC_ARRAY(data->width, data->cols);
85         while (data->rows > 1) {
86                 int x, total_width, cols, rows;
87                 rows = data->rows;
88                 cols = data->cols;
89
90                 data->rows--;
91                 data->cols = DIV_ROUND_UP(data->list->nr, data->rows);
92                 if (data->cols != cols)
93                         REALLOC_ARRAY(data->width, data->cols);
94                 compute_column_width(data);
95
96                 total_width = strlen(data->opts.indent);
97                 for (x = 0; x < data->cols; x++) {
98                         total_width += data->len[data->width[x]];
99                         total_width += data->opts.padding;
100                 }
101                 if (total_width > data->opts.width) {
102                         data->rows = rows;
103                         data->cols = cols;
104                         break;
105                 }
106         }
107         compute_column_width(data);
108 }
109
110 /* Display without layout when not enabled */
111 static void display_plain(const struct string_list *list,
112                           const char *indent, const char *nl)
113 {
114         int i;
115
116         for (i = 0; i < list->nr; i++)
117                 printf("%s%s%s", indent, list->items[i].string, nl);
118 }
119
120 /* Print a cell to stdout with all necessary leading/traling space */
121 static int display_cell(struct column_data *data, int initial_width,
122                         const char *empty_cell, int x, int y)
123 {
124         int i, len, newline;
125
126         i = XY2LINEAR(data, x, y);
127         if (i >= data->list->nr)
128                 return -1;
129
130         len = data->len[i];
131         if (data->width && data->len[data->width[x]] < initial_width) {
132                 /*
133                  * empty_cell has initial_width chars, if real column
134                  * is narrower, increase len a bit so we fill less
135                  * space.
136                  */
137                 len += initial_width - data->len[data->width[x]];
138                 len -= data->opts.padding;
139         }
140
141         if (COL_LAYOUT(data->colopts) == COL_COLUMN)
142                 newline = i + data->rows >= data->list->nr;
143         else
144                 newline = x == data->cols - 1 || i == data->list->nr - 1;
145
146         printf("%s%s%s",
147                x == 0 ? data->opts.indent : "",
148                data->list->items[i].string,
149                newline ? data->opts.nl : empty_cell + len);
150         return 0;
151 }
152
153 /* Display COL_COLUMN or COL_ROW */
154 static void display_table(const struct string_list *list,
155                           unsigned int colopts,
156                           const struct column_options *opts)
157 {
158         struct column_data data;
159         int x, y, i, initial_width;
160         char *empty_cell;
161
162         memset(&data, 0, sizeof(data));
163         data.list = list;
164         data.colopts = colopts;
165         data.opts = *opts;
166
167         data.len = xmalloc(sizeof(*data.len) * list->nr);
168         for (i = 0; i < list->nr; i++)
169                 data.len[i] = item_length(colopts, list->items[i].string);
170
171         layout(&data, &initial_width);
172
173         if (colopts & COL_DENSE)
174                 shrink_columns(&data);
175
176         empty_cell = xmalloc(initial_width + 1);
177         memset(empty_cell, ' ', initial_width);
178         empty_cell[initial_width] = '\0';
179         for (y = 0; y < data.rows; y++) {
180                 for (x = 0; x < data.cols; x++)
181                         if (display_cell(&data, initial_width, empty_cell, x, y))
182                                 break;
183         }
184
185         free(data.len);
186         free(data.width);
187         free(empty_cell);
188 }
189
190 void print_columns(const struct string_list *list, unsigned int colopts,
191                    const struct column_options *opts)
192 {
193         struct column_options nopts;
194
195         if (!list->nr)
196                 return;
197         assert((colopts & COL_ENABLE_MASK) != COL_AUTO);
198
199         memset(&nopts, 0, sizeof(nopts));
200         nopts.indent = opts && opts->indent ? opts->indent : "";
201         nopts.nl = opts && opts->nl ? opts->nl : "\n";
202         nopts.padding = opts ? opts->padding : 1;
203         nopts.width = opts && opts->width ? opts->width : term_columns() - 1;
204         if (!column_active(colopts)) {
205                 display_plain(list, "", "\n");
206                 return;
207         }
208         switch (COL_LAYOUT(colopts)) {
209         case COL_PLAIN:
210                 display_plain(list, nopts.indent, nopts.nl);
211                 break;
212         case COL_ROW:
213         case COL_COLUMN:
214                 display_table(list, colopts, &nopts);
215                 break;
216         default:
217                 die("BUG: invalid layout mode %d", COL_LAYOUT(colopts));
218         }
219 }
220
221 int finalize_colopts(unsigned int *colopts, int stdout_is_tty)
222 {
223         if ((*colopts & COL_ENABLE_MASK) == COL_AUTO) {
224                 if (stdout_is_tty < 0)
225                         stdout_is_tty = isatty(1);
226                 *colopts &= ~COL_ENABLE_MASK;
227                 if (stdout_is_tty)
228                         *colopts |= COL_ENABLED;
229         }
230         return 0;
231 }
232
233 struct colopt {
234         const char *name;
235         unsigned int value;
236         unsigned int mask;
237 };
238
239 #define LAYOUT_SET 1
240 #define ENABLE_SET 2
241
242 static int parse_option(const char *arg, int len, unsigned int *colopts,
243                         int *group_set)
244 {
245         struct colopt opts[] = {
246                 { "always", COL_ENABLED,  COL_ENABLE_MASK },
247                 { "never",  COL_DISABLED, COL_ENABLE_MASK },
248                 { "auto",   COL_AUTO,     COL_ENABLE_MASK },
249                 { "plain",  COL_PLAIN,    COL_LAYOUT_MASK },
250                 { "column", COL_COLUMN,   COL_LAYOUT_MASK },
251                 { "row",    COL_ROW,      COL_LAYOUT_MASK },
252                 { "dense",  COL_DENSE,    0 },
253         };
254         int i;
255
256         for (i = 0; i < ARRAY_SIZE(opts); i++) {
257                 int set = 1, arg_len = len, name_len;
258                 const char *arg_str = arg;
259
260                 if (!opts[i].mask) {
261                         if (arg_len > 2 && !strncmp(arg_str, "no", 2)) {
262                                 arg_str += 2;
263                                 arg_len -= 2;
264                                 set = 0;
265                         }
266                 }
267
268                 name_len = strlen(opts[i].name);
269                 if (arg_len != name_len ||
270                     strncmp(arg_str, opts[i].name, name_len))
271                         continue;
272
273                 switch (opts[i].mask) {
274                 case COL_ENABLE_MASK:
275                         *group_set |= ENABLE_SET;
276                         break;
277                 case COL_LAYOUT_MASK:
278                         *group_set |= LAYOUT_SET;
279                         break;
280                 }
281
282                 if (opts[i].mask)
283                         *colopts = (*colopts & ~opts[i].mask) | opts[i].value;
284                 else {
285                         if (set)
286                                 *colopts |= opts[i].value;
287                         else
288                                 *colopts &= ~opts[i].value;
289                 }
290                 return 0;
291         }
292
293         return error("unsupported option '%s'", arg);
294 }
295
296 static int parse_config(unsigned int *colopts, const char *value)
297 {
298         const char *sep = " ,";
299         int group_set = 0;
300
301         while (*value) {
302                 int len = strcspn(value, sep);
303                 if (len) {
304                         if (parse_option(value, len, colopts, &group_set))
305                                 return -1;
306
307                         value += len;
308                 }
309                 value += strspn(value, sep);
310         }
311         /*
312          * If none of "always", "never", and "auto" is specified, then setting
313          * layout implies "always".
314          *
315          * Current value in COL_ENABLE_MASK is disregarded. This means if
316          * you set column.ui = auto and pass --column=row, then "auto"
317          * will become "always".
318          */
319         if ((group_set & LAYOUT_SET) && !(group_set & ENABLE_SET))
320                 *colopts = (*colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
321         return 0;
322 }
323
324 static int column_config(const char *var, const char *value,
325                          const char *key, unsigned int *colopts)
326 {
327         if (!value)
328                 return config_error_nonbool(var);
329         if (parse_config(colopts, value))
330                 return error("invalid column.%s mode %s", key, value);
331         return 0;
332 }
333
334 int git_column_config(const char *var, const char *value,
335                       const char *command, unsigned int *colopts)
336 {
337         const char *it;
338
339         if (!skip_prefix(var, "column.", &it))
340                 return 0;
341
342         if (!strcmp(it, "ui"))
343                 return column_config(var, value, "ui", colopts);
344
345         if (command && !strcmp(it, command))
346                 return column_config(var, value, it, colopts);
347
348         return 0;
349 }
350
351 int parseopt_column_callback(const struct option *opt,
352                              const char *arg, int unset)
353 {
354         unsigned int *colopts = opt->value;
355         *colopts |= COL_PARSEOPT;
356         *colopts &= ~COL_ENABLE_MASK;
357         if (unset)              /* --no-column == never */
358                 return 0;
359         /* --column == always unless "arg" states otherwise */
360         *colopts |= COL_ENABLED;
361         if (arg)
362                 return parse_config(colopts, arg);
363
364         return 0;
365 }
366
367 static int fd_out = -1;
368 static struct child_process column_process = CHILD_PROCESS_INIT;
369
370 int run_column_filter(int colopts, const struct column_options *opts)
371 {
372         struct argv_array *argv;
373
374         if (fd_out != -1)
375                 return -1;
376
377         child_process_init(&column_process);
378         argv = &column_process.args;
379
380         argv_array_push(argv, "column");
381         argv_array_pushf(argv, "--raw-mode=%d", colopts);
382         if (opts && opts->width)
383                 argv_array_pushf(argv, "--width=%d", opts->width);
384         if (opts && opts->indent)
385                 argv_array_pushf(argv, "--indent=%s", opts->indent);
386         if (opts && opts->padding)
387                 argv_array_pushf(argv, "--padding=%d", opts->padding);
388
389         fflush(stdout);
390         column_process.in = -1;
391         column_process.out = dup(1);
392         column_process.git_cmd = 1;
393
394         if (start_command(&column_process))
395                 return -2;
396
397         fd_out = dup(1);
398         close(1);
399         dup2(column_process.in, 1);
400         close(column_process.in);
401         return 0;
402 }
403
404 int stop_column_filter(void)
405 {
406         if (fd_out == -1)
407                 return -1;
408
409         fflush(stdout);
410         close(1);
411         finish_command(&column_process);
412         dup2(fd_out, 1);
413         close(fd_out);
414         fd_out = -1;
415         return 0;
416 }