[thirdparty/git.git] / column.c

#include "cache.h"
#include "column.h"
#include "string-list.h"
#include "parse-options.h"
#include "utf8.h"

#define XY2LINEAR(d, x, y) (COL_LAYOUT((d)->colopts) == COL_COLUMN ? \
			    (x) * (d)->rows + (y) : \
			    (y) * (d)->cols + (x))

struct column_data {
	const struct string_list *list;
	unsigned int colopts;
	struct column_options opts;

	int rows, cols;
	int *len;		/* cell length */
	int *width;	      /* index to the longest row in column */
};

/* return length of 's' in letters, ANSI escapes stripped */
static int item_length(unsigned int colopts, const char *s)
{
	int len, i = 0;
	struct strbuf str = STRBUF_INIT;

	strbuf_addstr(&str, s);
	while ((s = strstr(str.buf + i, "\033[")) != NULL) {
		int len = strspn(s + 2, "0123456789;");
		i = s - str.buf;
		strbuf_remove(&str, i, len + 3); /* \033[<len><func char> */
	}
	len = utf8_strwidth(str.buf);
	strbuf_release(&str);
	return len;
}

/*
 * Calculate cell width, rows and cols for a table of equal cells, given
 * table width and how many spaces between cells.
 */
static void layout(struct column_data *data, int *width)
{
	int i;

	*width = 0;
	for (i = 0; i < data->list->nr; i++)
		if (*width < data->len[i])
			*width = data->len[i];

	*width += data->opts.padding;

	data->cols = (data->opts.width - strlen(data->opts.indent)) / *width;
	if (data->cols == 0)
		data->cols = 1;

	data->rows = DIV_ROUND_UP(data->list->nr, data->cols);
}

static void compute_column_width(struct column_data *data)
{
	int i, x, y;
	for (x = 0; x < data->cols; x++) {
		data->width[x] = XY2LINEAR(data, x, 0);
		for (y = 0; y < data->rows; y++) {
			i = XY2LINEAR(data, x, y);
			if (i < data->list->nr &&
			    data->len[data->width[x]] < data->len[i])
				data->width[x] = i;
		}
	}
}

/*
 * Shrink all columns by shortening them one row each time (and adding
 * more columns along the way). Hopefully the longest cell will be
 * moved to the next column, column is shrunk so we have more space
 * for new columns. The process ends when the whole thing no longer
 * fits in data->total_width.
 */
static void shrink_columns(struct column_data *data)
{
	data->width = xrealloc(data->width,
			       sizeof(*data->width) * data->cols);
	while (data->rows > 1) {
		int x, total_width, cols, rows;
		rows = data->rows;
		cols = data->cols;

		data->rows--;
		data->cols = DIV_ROUND_UP(data->list->nr, data->rows);
		if (data->cols != cols)
			data->width = xrealloc(data->width,
					       sizeof(*data->width) * data->cols);
		compute_column_width(data);

		total_width = strlen(data->opts.indent);
		for (x = 0; x < data->cols; x++) {
			total_width += data->len[data->width[x]];
			total_width += data->opts.padding;
		}
		if (total_width > data->opts.width) {
			data->rows = rows;
			data->cols = cols;
			break;
		}
	}
	compute_column_width(data);
}

/* Display without layout when not enabled */
static void display_plain(const struct string_list *list,
			  const char *indent, const char *nl)
{
	int i;

	for (i = 0; i < list->nr; i++)
		printf("%s%s%s", indent, list->items[i].string, nl);
}

/* Print a cell to stdout with all necessary leading/traling space */
static int display_cell(struct column_data *data, int initial_width,
			const char *empty_cell, int x, int y)
{
	int i, len, newline;

	i = XY2LINEAR(data, x, y);
	if (i >= data->list->nr)
		return -1;

	len = data->len[i];
	if (data->width && data->len[data->width[x]] < initial_width) {
		/*
		 * empty_cell has initial_width chars, if real column
		 * is narrower, increase len a bit so we fill less
		 * space.
		 */
		len += initial_width - data->len[data->width[x]];
		len -= data->opts.padding;
	}

	if (COL_LAYOUT(data->colopts) == COL_COLUMN)
		newline = i + data->rows >= data->list->nr;
	else
		newline = x == data->cols - 1 || i == data->list->nr - 1;

	printf("%s%s%s",
	       x == 0 ? data->opts.indent : "",
	       data->list->items[i].string,
	       newline ? data->opts.nl : empty_cell + len);
	return 0;
}

/* Display COL_COLUMN or COL_ROW */
static void display_table(const struct string_list *list,
			  unsigned int colopts,
			  const struct column_options *opts)
{
	struct column_data data;
	int x, y, i, initial_width;
	char *empty_cell;

	memset(&data, 0, sizeof(data));
	data.list = list;
	data.colopts = colopts;
	data.opts = *opts;

	data.len = xmalloc(sizeof(*data.len) * list->nr);
	for (i = 0; i < list->nr; i++)
		data.len[i] = item_length(colopts, list->items[i].string);

	layout(&data, &initial_width);

	if (colopts & COL_DENSE)
		shrink_columns(&data);

	empty_cell = xmalloc(initial_width + 1);
	memset(empty_cell, ' ', initial_width);
	empty_cell[initial_width] = '\0';
	for (y = 0; y < data.rows; y++) {
		for (x = 0; x < data.cols; x++)
			if (display_cell(&data, initial_width, empty_cell, x, y))
				break;
	}

	free(data.len);
	free(data.width);
	free(empty_cell);
}

void print_columns(const struct string_list *list, unsigned int colopts,
		   const struct column_options *opts)
{
	struct column_options nopts;

	if (!list->nr)
		return;
	assert((colopts & COL_ENABLE_MASK) != COL_AUTO);

	memset(&nopts, 0, sizeof(nopts));
	nopts.indent = opts && opts->indent ? opts->indent : "";
	nopts.nl = opts && opts->nl ? opts->nl : "\n";
	nopts.padding = opts ? opts->padding : 1;
	nopts.width = opts && opts->width ? opts->width : term_columns() - 1;
	if (!column_active(colopts)) {
		display_plain(list, "", "\n");
		return;
	}
	switch (COL_LAYOUT(colopts)) {
	case COL_PLAIN:
		display_plain(list, nopts.indent, nopts.nl);
		break;
	case COL_ROW:
	case COL_COLUMN:
		display_table(list, colopts, &nopts);
		break;
	default:
		die("BUG: invalid layout mode %d", COL_LAYOUT(colopts));
	}
}

int finalize_colopts(unsigned int *colopts, int stdout_is_tty)
{
	if ((*colopts & COL_ENABLE_MASK) == COL_AUTO) {
		if (stdout_is_tty < 0)
			stdout_is_tty = isatty(1);
		*colopts &= ~COL_ENABLE_MASK;
		if (stdout_is_tty)
			*colopts |= COL_ENABLED;
	}
	return 0;
}

struct colopt {
	const char *name;
	unsigned int value;
	unsigned int mask;
};

#define LAYOUT_SET 1
#define ENABLE_SET 2

static int parse_option(const char *arg, int len, unsigned int *colopts,
			int *group_set)
{
	struct colopt opts[] = {
		{ "always", COL_ENABLED,  COL_ENABLE_MASK },
		{ "never",  COL_DISABLED, COL_ENABLE_MASK },
		{ "auto",   COL_AUTO,     COL_ENABLE_MASK },
		{ "plain",  COL_PLAIN,    COL_LAYOUT_MASK },
		{ "column", COL_COLUMN,   COL_LAYOUT_MASK },
		{ "row",    COL_ROW,      COL_LAYOUT_MASK },
		{ "dense",  COL_DENSE,    0 },
	};
	int i;

	for (i = 0; i < ARRAY_SIZE(opts); i++) {
		int set = 1, arg_len = len, name_len;
		const char *arg_str = arg;

		if (!opts[i].mask) {
			if (arg_len > 2 && !strncmp(arg_str, "no", 2)) {
				arg_str += 2;
				arg_len -= 2;
				set = 0;
			}
		}

		name_len = strlen(opts[i].name);
		if (arg_len != name_len ||
		    strncmp(arg_str, opts[i].name, name_len))
			continue;

		switch (opts[i].mask) {
		case COL_ENABLE_MASK:
			*group_set |= ENABLE_SET;
			break;
		case COL_LAYOUT_MASK:
			*group_set |= LAYOUT_SET;
			break;
		}

		if (opts[i].mask)
			*colopts = (*colopts & ~opts[i].mask) | opts[i].value;
		else {
			if (set)
				*colopts |= opts[i].value;
			else
				*colopts &= ~opts[i].value;
		}
		return 0;
	}

	return error("unsupported option '%s'", arg);
}

static int parse_config(unsigned int *colopts, const char *value)
{
	const char *sep = " ,";
	int group_set = 0;

	while (*value) {
		int len = strcspn(value, sep);
		if (len) {
			if (parse_option(value, len, colopts, &group_set))
				return -1;

			value += len;
		}
		value += strspn(value, sep);
	}
	/*
	 * Setting layout implies "always" if neither always, never
	 * nor auto is specified.
	 *
	 * Current value in COL_ENABLE_MASK is disregarded. This means if
	 * you set column.ui = auto and pass --column=row, then "auto"
	 * will become "always".
	 */
	if ((group_set & LAYOUT_SET) && !(group_set & ENABLE_SET))
		*colopts = (*colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
	return 0;
}

static int column_config(const char *var, const char *value,
			 const char *key, unsigned int *colopts)
{
	if (!value)
		return config_error_nonbool(var);
	if (parse_config(colopts, value))
		return error("invalid column.%s mode %s", key, value);
	return 0;
}

int git_column_config(const char *var, const char *value,
		      const char *command, unsigned int *colopts)
{
	const char *it = skip_prefix(var, "column.");
	if (!it)
		return 0;

	if (!strcmp(it, "ui"))
		return column_config(var, value, "ui", colopts);

	if (command && !strcmp(it, command))
		return column_config(var, value, it, colopts);

	return 0;
}

int parseopt_column_callback(const struct option *opt,
			     const char *arg, int unset)
{
	unsigned int *colopts = opt->value;
	*colopts |= COL_PARSEOPT;
	*colopts &= ~COL_ENABLE_MASK;
	if (unset)		/* --no-column == never */
		return 0;
	/* --column == always unless "arg" states otherwise */
	*colopts |= COL_ENABLED;
	if (arg)
		return parse_config(colopts, arg);

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