Google Git
Sign in
third-party-mirror / systemd / 2398d87694e8af48e92ff8fb5f9cf273f706fb00 / . / src / shared / format-table.c
blob: 4c4e4593d859fbac5bb712412ed56590252858ee [file] [log] [blame]
/* SPDX-License-Identifier: LGPL-2.1-or-later */
#include <ctype.h>
#include <net/if.h>
#include <unistd.h>
#include "sd-id128.h"
#include "alloc-util.h"
#include "fd-util.h"
#include "fileio.h"
#include "format-table.h"
#include "format-util.h"
#include "gunicode.h"
#include "id128-util.h"
#include "in-addr-util.h"
#include "locale-util.h"
#include "memory-util.h"
#include "pager.h"
#include "parse-util.h"
#include "path-util.h"
#include "pretty-print.h"
#include "process-util.h"
#include "signal-util.h"
#include "sort-util.h"
#include "string-util.h"
#include "strxcpyx.h"
#include "terminal-util.h"
#include "time-util.h"
#include "user-util.h"
#include "utf8.h"
#include "util.h"
#define DEFAULT_WEIGHT 100
/*
A few notes on implementation details:
- TableCell is a 'fake' structure, it's just used as data type to pass references to specific cell positions in the
table. It can be easily converted to an index number and back.
- TableData is where the actual data is stored: it encapsulates the data and formatting for a specific cell. It's
'pseudo-immutable' and ref-counted. When a cell's data's formatting is to be changed, we duplicate the object if the
ref-counting is larger than 1. Note that TableData and its ref-counting is mostly not visible to the outside. The
outside only sees Table and TableCell.
- The Table object stores a simple one-dimensional array of references to TableData objects, one row after the
previous one.
- There's no special concept of a "row" or "column" in the table, and no special concept of the "header" row. It's all
derived from the cell index: we know how many cells are to be stored in a row, and can determine the rest from
that. The first row is always the header row. If header display is turned off we simply skip outputting the first
row. Also, when sorting rows we always leave the first row where it is, as the header shouldn't move.
- Note because there's no row and no column object some properties that might be appropriate as row/column properties
are exposed as cell properties instead. For example, the "weight" of a column (which is used to determine where to
add/remove space preferable when expanding/compressing tables horizontally) is actually made the "weight" of a
cell. Given that we usually need it per-column though we will calculate the average across every cell of the column
instead.
- To make things easy, when cells are added without any explicit configured formatting, then we'll copy the formatting
from the same cell in the previous cell. This is particularly useful for the "weight" of the cell (see above), as
this means setting the weight of the cells of the header row will nicely propagate to all cells in the other rows.
*/
typedef struct TableData {
unsigned n_ref;
TableDataType type;
size_t minimum_width; /* minimum width for the column */
size_t maximum_width; /* maximum width for the column */
size_t formatted_for_width; /* the width we tried to format for */
unsigned weight; /* the horizontal weight for this column, in case the table is expanded/compressed */
unsigned ellipsize_percent; /* 0 … 100, where to place the ellipsis when compression is needed */
unsigned align_percent; /* 0 … 100, where to pad with spaces when expanding is needed. 0: left-aligned, 100: right-aligned */
bool uppercase; /* Uppercase string on display */
const char *color; /* ANSI color string to use for this cell. When written to terminal should not move cursor. Will automatically be reset after the cell */
const char *rgap_color; /* The ANSI color to use for the gap right of this cell. Usually used to underline entire rows in a gapless fashion */
char *url; /* A URL to use for a clickable hyperlink */
char *formatted; /* A cached textual representation of the cell data, before ellipsation/alignment */
union {
uint8_t data[0]; /* data is generic array */
bool boolean;
usec_t timestamp;
usec_t timespan;
uint64_t size;
char string[0];
char **strv;
int int_val;
int8_t int8;
int16_t int16;
int32_t int32;
int64_t int64;
unsigned uint_val;
uint8_t uint8;
uint16_t uint16;
uint32_t uint32;
uint64_t uint64;
int percent; /* we use 'int' as datatype for percent values in order to match the result of parse_percent() */
int ifindex;
union in_addr_union address;
sd_id128_t id128;
uid_t uid;
gid_t gid;
pid_t pid;
/* … add more here as we start supporting more cell data types … */
};
} TableData;
static size_t TABLE_CELL_TO_INDEX(TableCell *cell) {
size_t i;
assert(cell);
i = PTR_TO_SIZE(cell);
assert(i > 0);
return i-1;
}
static TableCell* TABLE_INDEX_TO_CELL(size_t index) {
assert(index != SIZE_MAX);
return SIZE_TO_PTR(index + 1);
}
struct Table {
size_t n_columns;
size_t n_cells;
bool header; /* Whether to show the header row? */
size_t width; /* If == 0 format this as wide as necessary. If SIZE_MAX format this to console
* width or less wide, but not wider. Otherwise the width to format this table in. */
size_t cell_height_max; /* Maximum number of lines per cell. (If there are more, ellipsis is shown. If SIZE_MAX then no limit is set, the default. == 0 is not allowed.) */
TableData **data;
size_t *display_map; /* List of columns to show (by their index). It's fine if columns are listed multiple times or not at all */
size_t n_display_map;
size_t *sort_map; /* The columns to order rows by, in order of preference. */
size_t n_sort_map;
bool *reverse_map;
char *empty_string;
};
Table *table_new_raw(size_t n_columns) {
_cleanup_(table_unrefp) Table *t = NULL;
assert(n_columns > 0);
t = new(Table, 1);
if (!t)
return NULL;
*t = (struct Table) {
.n_columns = n_columns,
.header = true,
.width = SIZE_MAX,
.cell_height_max = SIZE_MAX,
};
return TAKE_PTR(t);
}
Table *table_new_internal(const char *first_header, ...) {
_cleanup_(table_unrefp) Table *t = NULL;
size_t n_columns = 1;
va_list ap;
int r;
assert(first_header);
va_start(ap, first_header);
for (;;) {
if (!va_arg(ap, const char*))
break;
n_columns++;
}
va_end(ap);
t = table_new_raw(n_columns);
if (!t)
return NULL;
va_start(ap, first_header);
for (const char *h = first_header; h; h = va_arg(ap, const char*)) {
TableCell *cell;
r = table_add_cell(t, &cell, TABLE_STRING, h);
if (r < 0) {
va_end(ap);
return NULL;
}
/* Make the table header uppercase */
r = table_set_uppercase(t, cell, true);
if (r < 0) {
va_end(ap);
return NULL;
}
}
va_end(ap);
assert(t->n_columns == t->n_cells);
return TAKE_PTR(t);
}
static TableData *table_data_free(TableData *d) {
assert(d);
free(d->formatted);
free(d->url);
if (IN_SET(d->type, TABLE_STRV, TABLE_STRV_WRAPPED))
strv_free(d->strv);
return mfree(d);
}
DEFINE_PRIVATE_TRIVIAL_REF_UNREF_FUNC(TableData, table_data, table_data_free);
DEFINE_TRIVIAL_CLEANUP_FUNC(TableData*, table_data_unref);
Table *table_unref(Table *t) {
if (!t)
return NULL;
for (size_t i = 0; i < t->n_cells; i++)
table_data_unref(t->data[i]);
free(t->data);
free(t->display_map);
free(t->sort_map);
free(t->reverse_map);
free(t->empty_string);
return mfree(t);
}
static size_t table_data_size(TableDataType type, const void *data) {
switch (type) {
case TABLE_EMPTY:
return 0;
case TABLE_STRING:
case TABLE_PATH:
return strlen(data) + 1;
case TABLE_STRV:
case TABLE_STRV_WRAPPED:
return sizeof(char **);
case TABLE_BOOLEAN:
return sizeof(bool);
case TABLE_TIMESTAMP:
case TABLE_TIMESTAMP_UTC:
case TABLE_TIMESTAMP_RELATIVE:
case TABLE_TIMESPAN:
case TABLE_TIMESPAN_MSEC:
return sizeof(usec_t);
case TABLE_SIZE:
case TABLE_INT64:
case TABLE_UINT64:
case TABLE_BPS:
return sizeof(uint64_t);
case TABLE_INT32:
case TABLE_UINT32:
return sizeof(uint32_t);
case TABLE_INT16:
case TABLE_UINT16:
return sizeof(uint16_t);
case TABLE_INT8:
case TABLE_UINT8:
return sizeof(uint8_t);
case TABLE_INT:
case TABLE_UINT:
case TABLE_PERCENT:
case TABLE_IFINDEX:
case TABLE_SIGNAL:
return sizeof(int);
case TABLE_IN_ADDR:
return sizeof(struct in_addr);
case TABLE_IN6_ADDR:
return sizeof(struct in6_addr);
case TABLE_UUID:
case TABLE_ID128:
return sizeof(sd_id128_t);
case TABLE_UID:
return sizeof(uid_t);
case TABLE_GID:
return sizeof(gid_t);
case TABLE_PID:
return sizeof(pid_t);
default:
assert_not_reached("Uh? Unexpected cell type");
}
}
static bool table_data_matches(
TableData *d,
TableDataType type,
const void *data,
size_t minimum_width,
size_t maximum_width,
unsigned weight,
unsigned align_percent,
unsigned ellipsize_percent) {
size_t k, l;
assert(d);
if (d->type != type)
return false;
if (d->minimum_width != minimum_width)
return false;
if (d->maximum_width != maximum_width)
return false;
if (d->weight != weight)
return false;
if (d->align_percent != align_percent)
return false;
if (d->ellipsize_percent != ellipsize_percent)
return false;
/* If a color/url/uppercase flag is set, refuse to merge */
if (d->color || d->rgap_color)
return false;
if (d->url)
return false;
if (d->uppercase)
return false;
k = table_data_size(type, data);
l = table_data_size(d->type, d->data);
if (k != l)
return false;
return memcmp_safe(data, d->data, l) == 0;
}
static TableData *table_data_new(
TableDataType type,
const void *data,
size_t minimum_width,
size_t maximum_width,
unsigned weight,
unsigned align_percent,
unsigned ellipsize_percent) {
_cleanup_free_ TableData *d = NULL;
size_t data_size;
data_size = table_data_size(type, data);
d = malloc0(offsetof(TableData, data) + data_size);
if (!d)
return NULL;
d->n_ref = 1;
d->type = type;
d->minimum_width = minimum_width;
d->maximum_width = maximum_width;
d->weight = weight;
d->align_percent = align_percent;
d->ellipsize_percent = ellipsize_percent;
if (IN_SET(type, TABLE_STRV, TABLE_STRV_WRAPPED)) {
d->strv = strv_copy(data);
if (!d->strv)
return NULL;
} else
memcpy_safe(d->data, data, data_size);
return TAKE_PTR(d);
}
int table_add_cell_full(
Table *t,
TableCell **ret_cell,
TableDataType type,
const void *data,
size_t minimum_width,
size_t maximum_width,
unsigned weight,
unsigned align_percent,
unsigned ellipsize_percent) {
_cleanup_(table_data_unrefp) TableData *d = NULL;
TableData *p;
assert(t);
assert(type >= 0);
assert(type < _TABLE_DATA_TYPE_MAX);
/* Special rule: patch NULL data fields to the empty field */
if (!data)
type = TABLE_EMPTY;
/* Determine the cell adjacent to the current one, but one row up */
if (t->n_cells >= t->n_columns)
assert_se(p = t->data[t->n_cells - t->n_columns]);
else
p = NULL;
/* If formatting parameters are left unspecified, copy from the previous row */
if (minimum_width == SIZE_MAX)
minimum_width = p ? p->minimum_width : 1;
if (weight == UINT_MAX)
weight = p ? p->weight : DEFAULT_WEIGHT;
if (align_percent == UINT_MAX)
align_percent = p ? p->align_percent : 0;
if (ellipsize_percent == UINT_MAX)
ellipsize_percent = p ? p->ellipsize_percent : 100;
assert(align_percent <= 100);
assert(ellipsize_percent <= 100);
/* Small optimization: Pretty often adjacent cells in two subsequent lines have the same data and
* formatting. Let's see if we can reuse the cell data and ref it once more. */
if (p && table_data_matches(p, type, data, minimum_width, maximum_width, weight, align_percent, ellipsize_percent))
d = table_data_ref(p);
else {
d = table_data_new(type, data, minimum_width, maximum_width, weight, align_percent, ellipsize_percent);
if (!d)
return -ENOMEM;
}
if (!GREEDY_REALLOC(t->data, MAX(t->n_cells + 1, t->n_columns)))
return -ENOMEM;
if (ret_cell)
*ret_cell = TABLE_INDEX_TO_CELL(t->n_cells);
t->data[t->n_cells++] = TAKE_PTR(d);
return 0;
}
int table_add_cell_stringf(Table *t, TableCell **ret_cell, const char *format, ...) {
_cleanup_free_ char *buffer = NULL;
va_list ap;
int r;
va_start(ap, format);
r = vasprintf(&buffer, format, ap);
va_end(ap);
if (r < 0)
return -ENOMEM;
return table_add_cell(t, ret_cell, TABLE_STRING, buffer);
}
int table_fill_empty(Table *t, size_t until_column) {
int r;
assert(t);
/* Fill the rest of the current line with empty cells until we reach the specified column. Will add
* at least one cell. Pass 0 in order to fill a line to the end or insert an empty line. */
if (until_column >= t->n_columns)
return -EINVAL;
do {
r = table_add_cell(t, NULL, TABLE_EMPTY, NULL);
if (r < 0)
return r;
} while ((t->n_cells % t->n_columns) != until_column);
return 0;
}
int table_dup_cell(Table *t, TableCell *cell) {
size_t i;
assert(t);
/* Add the data of the specified cell a second time as a new cell to the end. */
i = TABLE_CELL_TO_INDEX(cell);
if (i >= t->n_cells)
return -ENXIO;
if (!GREEDY_REALLOC(t->data, MAX(t->n_cells + 1, t->n_columns)))
return -ENOMEM;
t->data[t->n_cells++] = table_data_ref(t->data[i]);
return 0;
}
static int table_dedup_cell(Table *t, TableCell *cell) {
_cleanup_free_ char *curl = NULL;
TableData *nd, *od;
size_t i;
assert(t);
/* Helper call that ensures the specified cell's data object has a ref count of 1, which we can use before
* changing a cell's formatting without effecting every other cell's formatting that shares the same data */
i = TABLE_CELL_TO_INDEX(cell);
if (i >= t->n_cells)
return -ENXIO;
assert_se(od = t->data[i]);
if (od->n_ref == 1)
return 0;
assert(od->n_ref > 1);
if (od->url) {
curl = strdup(od->url);
if (!curl)
return -ENOMEM;
}
nd = table_data_new(
od->type,
od->data,
od->minimum_width,
od->maximum_width,
od->weight,
od->align_percent,
od->ellipsize_percent);
if (!nd)
return -ENOMEM;
nd->color = od->color;
nd->rgap_color = od->rgap_color;
nd->url = TAKE_PTR(curl);
nd->uppercase = od->uppercase;
table_data_unref(od);
t->data[i] = nd;
assert(nd->n_ref == 1);
return 1;
}
static TableData *table_get_data(Table *t, TableCell *cell) {
size_t i;
assert(t);
assert(cell);
/* Get the data object of the specified cell, or NULL if it doesn't exist */
i = TABLE_CELL_TO_INDEX(cell);
if (i >= t->n_cells)
return NULL;
assert(t->data[i]);
assert(t->data[i]->n_ref > 0);
return t->data[i];
}
int table_set_minimum_width(Table *t, TableCell *cell, size_t minimum_width) {
int r;
assert(t);
assert(cell);
if (minimum_width == SIZE_MAX)
minimum_width = 1;
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->minimum_width = minimum_width;
return 0;
}
int table_set_maximum_width(Table *t, TableCell *cell, size_t maximum_width) {
int r;
assert(t);
assert(cell);
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->maximum_width = maximum_width;
return 0;
}
int table_set_weight(Table *t, TableCell *cell, unsigned weight) {
int r;
assert(t);
assert(cell);
if (weight == UINT_MAX)
weight = DEFAULT_WEIGHT;
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->weight = weight;
return 0;
}
int table_set_align_percent(Table *t, TableCell *cell, unsigned percent) {
int r;
assert(t);
assert(cell);
if (percent == UINT_MAX)
percent = 0;
assert(percent <= 100);
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->align_percent = percent;
return 0;
}
int table_set_ellipsize_percent(Table *t, TableCell *cell, unsigned percent) {
int r;
assert(t);
assert(cell);
if (percent == UINT_MAX)
percent = 100;
assert(percent <= 100);
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->ellipsize_percent = percent;
return 0;
}
int table_set_color(Table *t, TableCell *cell, const char *color) {
int r;
assert(t);
assert(cell);
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->color = empty_to_null(color);
return 0;
}
int table_set_rgap_color(Table *t, TableCell *cell, const char *color) {
int r;
assert(t);
assert(cell);
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
table_get_data(t, cell)->rgap_color = empty_to_null(color);
return 0;
}
int table_set_url(Table *t, TableCell *cell, const char *url) {
_cleanup_free_ char *copy = NULL;
int r;
assert(t);
assert(cell);
if (url) {
copy = strdup(url);
if (!copy)
return -ENOMEM;
}
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
return free_and_replace(table_get_data(t, cell)->url, copy);
}
int table_set_uppercase(Table *t, TableCell *cell, bool b) {
TableData *d;
int r;
assert(t);
assert(cell);
r = table_dedup_cell(t, cell);
if (r < 0)
return r;
assert_se(d = table_get_data(t, cell));
if (d->uppercase == b)
return 0;
d->formatted = mfree(d->formatted);
d->uppercase = b;
return 1;
}
int table_update(Table *t, TableCell *cell, TableDataType type, const void *data) {
_cleanup_free_ char *curl = NULL;
TableData *nd, *od;
size_t i;
assert(t);
assert(cell);
i = TABLE_CELL_TO_INDEX(cell);
if (i >= t->n_cells)
return -ENXIO;
assert_se(od = t->data[i]);
if (od->url) {
curl = strdup(od->url);
if (!curl)
return -ENOMEM;
}
nd = table_data_new(
type,
data,
od->minimum_width,
od->maximum_width,
od->weight,
od->align_percent,
od->ellipsize_percent);
if (!nd)
return -ENOMEM;
nd->color = od->color;
nd->rgap_color = od->rgap_color;
nd->url = TAKE_PTR(curl);
nd->uppercase = od->uppercase;
table_data_unref(od);
t->data[i] = nd;
return 0;
}
int table_add_many_internal(Table *t, TableDataType first_type, ...) {
TableCell *last_cell = NULL;
va_list ap;
int r;
assert(t);
assert(first_type >= 0);
assert(first_type < _TABLE_DATA_TYPE_MAX);
va_start(ap, first_type);
for (TableDataType type = first_type;; type = va_arg(ap, TableDataType)) {
const void *data;
union {
uint64_t size;
usec_t usec;
int int_val;
int8_t int8;
int16_t int16;
int32_t int32;
int64_t int64;
unsigned uint_val;
uint8_t uint8;
uint16_t uint16;
uint32_t uint32;
uint64_t uint64;
int percent;
int ifindex;
bool b;
union in_addr_union address;
sd_id128_t id128;
uid_t uid;
gid_t gid;
pid_t pid;
} buffer;
switch (type) {
case TABLE_EMPTY:
data = NULL;
break;
case TABLE_STRING:
case TABLE_PATH:
data = va_arg(ap, const char *);
break;
case TABLE_STRV:
case TABLE_STRV_WRAPPED:
data = va_arg(ap, char * const *);
break;
case TABLE_BOOLEAN:
buffer.b = va_arg(ap, int);
data = &buffer.b;
break;
case TABLE_TIMESTAMP:
case TABLE_TIMESTAMP_UTC:
case TABLE_TIMESTAMP_RELATIVE:
case TABLE_TIMESPAN:
case TABLE_TIMESPAN_MSEC:
buffer.usec = va_arg(ap, usec_t);
data = &buffer.usec;
break;
case TABLE_SIZE:
case TABLE_BPS:
buffer.size = va_arg(ap, uint64_t);
data = &buffer.size;
break;
case TABLE_INT:
case TABLE_SIGNAL:
buffer.int_val = va_arg(ap, int);
data = &buffer.int_val;
break;
case TABLE_INT8: {
int x = va_arg(ap, int);
assert(x >= INT8_MIN && x <= INT8_MAX);
buffer.int8 = x;
data = &buffer.int8;
break;
}
case TABLE_INT16: {
int x = va_arg(ap, int);
assert(x >= INT16_MIN && x <= INT16_MAX);
buffer.int16 = x;
data = &buffer.int16;
break;
}
case TABLE_INT32:
buffer.int32 = va_arg(ap, int32_t);
data = &buffer.int32;
break;
case TABLE_INT64:
buffer.int64 = va_arg(ap, int64_t);
data = &buffer.int64;
break;
case TABLE_UINT:
buffer.uint_val = va_arg(ap, unsigned);
data = &buffer.uint_val;
break;
case TABLE_UINT8: {
unsigned x = va_arg(ap, unsigned);
assert(x <= UINT8_MAX);
buffer.uint8 = x;
data = &buffer.uint8;
break;
}
case TABLE_UINT16: {
unsigned x = va_arg(ap, unsigned);
assert(x <= UINT16_MAX);
buffer.uint16 = x;
data = &buffer.uint16;
break;
}
case TABLE_UINT32:
buffer.uint32 = va_arg(ap, uint32_t);
data = &buffer.uint32;
break;
case TABLE_UINT64:
buffer.uint64 = va_arg(ap, uint64_t);
data = &buffer.uint64;
break;
case TABLE_PERCENT:
buffer.percent = va_arg(ap, int);
data = &buffer.percent;
break;
case TABLE_IFINDEX:
buffer.ifindex = va_arg(ap, int);
data = &buffer.ifindex;
break;
case TABLE_IN_ADDR:
buffer.address = *va_arg(ap, union in_addr_union *);
data = &buffer.address.in;
break;
case TABLE_IN6_ADDR:
buffer.address = *va_arg(ap, union in_addr_union *);
data = &buffer.address.in6;
break;
case TABLE_UUID:
case TABLE_ID128:
buffer.id128 = va_arg(ap, sd_id128_t);
data = &buffer.id128;
break;
case TABLE_UID:
buffer.uid = va_arg(ap, uid_t);
data = &buffer.uid;
break;
case TABLE_GID:
buffer.gid = va_arg(ap, gid_t);
data = &buffer.gid;
break;
case TABLE_PID:
buffer.pid = va_arg(ap, pid_t);
data = &buffer.pid;
break;
case TABLE_SET_MINIMUM_WIDTH: {
size_t w = va_arg(ap, size_t);
r = table_set_minimum_width(t, last_cell, w);
goto check;
}
case TABLE_SET_MAXIMUM_WIDTH: {
size_t w = va_arg(ap, size_t);
r = table_set_maximum_width(t, last_cell, w);
goto check;
}
case TABLE_SET_WEIGHT: {
unsigned w = va_arg(ap, unsigned);
r = table_set_weight(t, last_cell, w);
goto check;
}
case TABLE_SET_ALIGN_PERCENT: {
unsigned p = va_arg(ap, unsigned);
r = table_set_align_percent(t, last_cell, p);
goto check;
}
case TABLE_SET_ELLIPSIZE_PERCENT: {
unsigned p = va_arg(ap, unsigned);
r = table_set_ellipsize_percent(t, last_cell, p);
goto check;
}
case TABLE_SET_COLOR: {
const char *c = va_arg(ap, const char*);
r = table_set_color(t, last_cell, c);
goto check;
}
case TABLE_SET_RGAP_COLOR: {
const char *c = va_arg(ap, const char*);
r = table_set_rgap_color(t, last_cell, c);
goto check;
}
case TABLE_SET_BOTH_COLORS: {
const char *c = va_arg(ap, const char*);
r = table_set_color(t, last_cell, c);
if (r < 0) {
va_end(ap);
return r;
}
r = table_set_rgap_color(t, last_cell, c);
goto check;
}
case TABLE_SET_URL: {
const char *u = va_arg(ap, const char*);
r = table_set_url(t, last_cell, u);
goto check;
}
case TABLE_SET_UPPERCASE: {
int u = va_arg(ap, int);
r = table_set_uppercase(t, last_cell, u);
goto check;
}
case _TABLE_DATA_TYPE_MAX:
/* Used as end marker */
va_end(ap);
return 0;
default:
assert_not_reached("Uh? Unexpected data type.");
}
r = table_add_cell(t, &last_cell, type, data);
check:
if (r < 0) {
va_end(ap);
return r;
}
}
}
void table_set_header(Table *t, bool b) {
assert(t);
t->header = b;
}
void table_set_width(Table *t, size_t width) {
assert(t);
t->width = width;
}
void table_set_cell_height_max(Table *t, size_t height) {
assert(t);
assert(height >= 1 || height == SIZE_MAX);
t->cell_height_max = height;
}
int table_set_empty_string(Table *t, const char *empty) {
assert(t);
return free_and_strdup(&t->empty_string, empty);
}
static int table_set_display_all(Table *t) {
size_t *d;
assert(t);
/* Initialize the display map to the identity */
d = reallocarray(t->display_map, t->n_columns, sizeof(size_t));
if (!d)
return -ENOMEM;
for (size_t i = 0; i < t->n_columns; i++)
d[i] = i;
t->display_map = d;
t->n_display_map = t->n_columns;
return 0;
}
int table_set_display_internal(Table *t, size_t first_column, ...) {
size_t column;
va_list ap;
assert(t);
column = first_column;
va_start(ap, first_column);
for (;;) {
assert(column < t->n_columns);
if (!GREEDY_REALLOC(t->display_map, MAX(t->n_columns, t->n_display_map+1))) {
va_end(ap);
return -ENOMEM;
}
t->display_map[t->n_display_map++] = column;
column = va_arg(ap, size_t);
if (column == SIZE_MAX)
break;
}
va_end(ap);
return 0;
}
int table_set_sort_internal(Table *t, size_t first_column, ...) {
size_t column;
va_list ap;
assert(t);
column = first_column;
va_start(ap, first_column);
for (;;) {
assert(column < t->n_columns);
if (!GREEDY_REALLOC(t->sort_map, MAX(t->n_columns, t->n_sort_map+1))) {
va_end(ap);
return -ENOMEM;
}
t->sort_map[t->n_sort_map++] = column;
column = va_arg(ap, size_t);
if (column == SIZE_MAX)
break;
}
va_end(ap);
return 0;
}
int table_hide_column_from_display(Table *t, size_t column) {
int r;
assert(t);
assert(column < t->n_columns);
/* If the display map is empty, initialize it with all available columns */
if (!t->display_map) {
r = table_set_display_all(t);
if (r < 0)
return r;
}
size_t allocated = t->n_display_map, cur = 0;
for (size_t i = 0; i < allocated; i++) {
if (t->display_map[i] == column)
continue;
t->display_map[cur++] = t->display_map[i];
}
t->n_display_map = cur;
return 0;
}
static int cell_data_compare(TableData *a, size_t index_a, TableData *b, size_t index_b) {
assert(a);
assert(b);
if (a->type == b->type) {
/* We only define ordering for cells of the same data type. If cells with different data types are
* compared we follow the order the cells were originally added in */
switch (a->type) {
case TABLE_STRING:
return strcmp(a->string, b->string);
case TABLE_PATH:
return path_compare(a->string, b->string);
case TABLE_STRV:
case TABLE_STRV_WRAPPED:
return strv_compare(a->strv, b->strv);
case TABLE_BOOLEAN:
if (!a->boolean && b->boolean)
return -1;
if (a->boolean && !b->boolean)
return 1;
return 0;
case TABLE_TIMESTAMP:
case TABLE_TIMESTAMP_UTC:
case TABLE_TIMESTAMP_RELATIVE:
return CMP(a->timestamp, b->timestamp);
case TABLE_TIMESPAN:
case TABLE_TIMESPAN_MSEC:
return CMP(a->timespan, b->timespan);
case TABLE_SIZE:
case TABLE_BPS:
return CMP(a->size, b->size);
case TABLE_INT:
case TABLE_SIGNAL:
return CMP(a->int_val, b->int_val);
case TABLE_INT8:
return CMP(a->int8, b->int8);
case TABLE_INT16:
return CMP(a->int16, b->int16);
case TABLE_INT32:
return CMP(a->int32, b->int32);
case TABLE_INT64:
return CMP(a->int64, b->int64);
case TABLE_UINT:
return CMP(a->uint_val, b->uint_val);
case TABLE_UINT8:
return CMP(a->uint8, b->uint8);
case TABLE_UINT16:
return CMP(a->uint16, b->uint16);
case TABLE_UINT32:
return CMP(a->uint32, b->uint32);
case TABLE_UINT64:
return CMP(a->uint64, b->uint64);
case TABLE_PERCENT:
return CMP(a->percent, b->percent);
case TABLE_IFINDEX:
return CMP(a->ifindex, b->ifindex);
case TABLE_IN_ADDR:
return CMP(a->address.in.s_addr, b->address.in.s_addr);
case TABLE_IN6_ADDR:
return memcmp(&a->address.in6, &b->address.in6, FAMILY_ADDRESS_SIZE(AF_INET6));
case TABLE_UUID:
case TABLE_ID128:
return memcmp(&a->id128, &b->id128, sizeof(sd_id128_t));
case TABLE_UID:
return CMP(a->uid, b->uid);
case TABLE_GID:
return CMP(a->gid, b->gid);
case TABLE_PID:
return CMP(a->pid, b->pid);
default:
;
}
}
/* Generic fallback using the original order in which the cells where added. */
return CMP(index_a, index_b);
}
static int table_data_compare(const size_t *a, const size_t *b, Table *t) {
int r;
assert(t);
assert(t->sort_map);
/* Make sure the header stays at the beginning */
if (*a < t->n_columns && *b < t->n_columns)
return 0;
if (*a < t->n_columns)
return -1;
if (*b < t->n_columns)
return 1;
/* Order other lines by the sorting map */
for (size_t i = 0; i < t->n_sort_map; i++) {
TableData *d, *dd;
d = t->data[*a + t->sort_map[i]];
dd = t->data[*b + t->sort_map[i]];
r = cell_data_compare(d, *a, dd, *b);
if (r != 0)
return t->reverse_map && t->reverse_map[t->sort_map[i]] ? -r : r;
}
/* Order identical lines by the order there were originally added in */
return CMP(*a, *b);
}
static char* format_strv_width(char **strv, size_t column_width) {
_cleanup_free_ char *buf = NULL; /* buf must be freed after f */
_cleanup_fclose_ FILE *f = NULL;
size_t sz = 0;
f = open_memstream_unlocked(&buf, &sz);
if (!f)
return NULL;
size_t position = 0;
char **p;
STRV_FOREACH(p, strv) {
size_t our_len = utf8_console_width(*p); /* This returns -1 on invalid utf-8 (which shouldn't happen).
* If that happens, we'll just print one item per line. */
if (position == 0) {
fputs(*p, f);
position = our_len;
} else if (size_add(size_add(position, 1), our_len) <= column_width) {
fprintf(f, " %s", *p);
position = size_add(size_add(position, 1), our_len);
} else {
fprintf(f, "\n%s", *p);
position = our_len;
}
}
if (fflush_and_check(f) < 0)
return NULL;
f = safe_fclose(f);
return TAKE_PTR(buf);
}
static const char *table_data_format(Table *t, TableData *d, bool avoid_uppercasing, size_t column_width, bool *have_soft) {
assert(d);
if (d->formatted &&
/* Only TABLE_STRV_WRAPPED adjust based on column_width so far… */
(d->type != TABLE_STRV_WRAPPED || d->formatted_for_width == column_width))
return d->formatted;
switch (d->type) {
case TABLE_EMPTY:
return strempty(t->empty_string);
case TABLE_STRING:
case TABLE_PATH:
if (d->uppercase && !avoid_uppercasing) {
d->formatted = new(char, strlen(d->string) + 1);
if (!d->formatted)
return NULL;
char *q = d->formatted;
for (char *p = d->string; *p; p++, q++)
*q = (char) toupper((unsigned char) *p);
*q = 0;
return d->formatted;
}
return d->string;
case TABLE_STRV:
if (strv_isempty(d->strv))
return strempty(t->empty_string);
d->formatted = strv_join(d->strv, "\n");
if (!d->formatted)
return NULL;
break;
case TABLE_STRV_WRAPPED: {
if (strv_isempty(d->strv))
return strempty(t->empty_string);
char *buf = format_strv_width(d->strv, column_width);
if (!buf)
return NULL;
free_and_replace(d->formatted, buf);
d->formatted_for_width = column_width;
if (have_soft)
*have_soft = true;
break;
}
case TABLE_BOOLEAN:
return yes_no(d->boolean);
case TABLE_TIMESTAMP:
case TABLE_TIMESTAMP_UTC:
case TABLE_TIMESTAMP_RELATIVE: {
_cleanup_free_ char *p = NULL;
char *ret;
p = new(char, d->type == TABLE_TIMESTAMP_RELATIVE ? FORMAT_TIMESTAMP_RELATIVE_MAX : FORMAT_TIMESTAMP_MAX);
if (!p)
return NULL;
if (d->type == TABLE_TIMESTAMP)
ret = format_timestamp(p, FORMAT_TIMESTAMP_MAX, d->timestamp);
else if (d->type == TABLE_TIMESTAMP_UTC)
ret = format_timestamp_style(p, FORMAT_TIMESTAMP_MAX, d->timestamp, TIMESTAMP_UTC);
else
ret = format_timestamp_relative(p, FORMAT_TIMESTAMP_RELATIVE_MAX, d->timestamp);
if (!ret)
return "n/a";
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_TIMESPAN:
case TABLE_TIMESPAN_MSEC: {
_cleanup_free_ char *p = NULL;
p = new(char, FORMAT_TIMESPAN_MAX);
if (!p)
return NULL;
if (!format_timespan(p, FORMAT_TIMESPAN_MAX, d->timespan,
d->type == TABLE_TIMESPAN ? 0 : USEC_PER_MSEC))
return "n/a";
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_SIZE: {
_cleanup_free_ char *p = NULL;
p = new(char, FORMAT_BYTES_MAX);
if (!p)
return NULL;
if (!format_bytes(p, FORMAT_BYTES_MAX, d->size))
return "n/a";
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_BPS: {
_cleanup_free_ char *p = NULL;
size_t n;
p = new(char, FORMAT_BYTES_MAX+2);
if (!p)
return NULL;
if (!format_bytes_full(p, FORMAT_BYTES_MAX, d->size, 0))
return "n/a";
n = strlen(p);
strscpy(p + n, FORMAT_BYTES_MAX + 2 - n, "bps");
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_INT: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->int_val) + 1);
if (!p)
return NULL;
sprintf(p, "%i", d->int_val);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_INT8: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->int8) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIi8, d->int8);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_INT16: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->int16) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIi16, d->int16);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_INT32: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->int32) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIi32, d->int32);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_INT64: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->int64) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIi64, d->int64);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_UINT: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->uint_val) + 1);
if (!p)
return NULL;
sprintf(p, "%u", d->uint_val);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_UINT8: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->uint8) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIu8, d->uint8);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_UINT16: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->uint16) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIu16, d->uint16);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_UINT32: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->uint32) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIu32, d->uint32);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_UINT64: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->uint64) + 1);
if (!p)
return NULL;
sprintf(p, "%" PRIu64, d->uint64);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_PERCENT: {
_cleanup_free_ char *p = NULL;
p = new(char, DECIMAL_STR_WIDTH(d->percent) + 2);
if (!p)
return NULL;
sprintf(p, "%i%%" , d->percent);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_IFINDEX: {
_cleanup_free_ char *p = NULL;
char name[IF_NAMESIZE + 1];
if (format_ifname(d->ifindex, name)) {
p = strdup(name);
if (!p)
return NULL;
} else {
if (asprintf(&p, "%i" , d->ifindex) < 0)
return NULL;
}
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_IN_ADDR:
case TABLE_IN6_ADDR: {
_cleanup_free_ char *p = NULL;
if (in_addr_to_string(d->type == TABLE_IN_ADDR ? AF_INET : AF_INET6,
&d->address, &p) < 0)
return NULL;
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_ID128: {
char *p;
p = new(char, SD_ID128_STRING_MAX);
if (!p)
return NULL;
d->formatted = sd_id128_to_string(d->id128, p);
break;
}
case TABLE_UUID: {
char *p;
p = new(char, ID128_UUID_STRING_MAX);
if (!p)
return NULL;
d->formatted = id128_to_uuid_string(d->id128, p);
break;
}
case TABLE_UID: {
_cleanup_free_ char *p = NULL;
if (!uid_is_valid(d->uid))
return "n/a";
p = new(char, DECIMAL_STR_WIDTH(d->uid) + 1);
if (!p)
return NULL;
sprintf(p, UID_FMT, d->uid);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_GID: {
_cleanup_free_ char *p = NULL;
if (!gid_is_valid(d->gid))
return "n/a";
p = new(char, DECIMAL_STR_WIDTH(d->gid) + 1);
if (!p)
return NULL;
sprintf(p, GID_FMT, d->gid);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_PID: {
_cleanup_free_ char *p = NULL;
if (!pid_is_valid(d->pid))
return "n/a";
p = new(char, DECIMAL_STR_WIDTH(d->pid) + 1);
if (!p)
return NULL;
sprintf(p, PID_FMT, d->pid);
d->formatted = TAKE_PTR(p);
break;
}
case TABLE_SIGNAL: {
_cleanup_free_ char *p = NULL;
const char *suffix;
suffix = signal_to_string(d->int_val);
if (!suffix)
return "n/a";
p = strjoin("SIG", suffix);
if (!p)
return NULL;
d->formatted = TAKE_PTR(p);
break;
}
default:
assert_not_reached("Unexpected type?");
}
return d->formatted;
}
static int console_width_height(
const char *s,
size_t *ret_width,
size_t *ret_height) {
size_t max_width = 0, height = 0;
const char *p;
assert(s);
/* Determine the width and height in console character cells the specified string needs. */
do {
size_t k;
p = strchr(s, '\n');
if (p) {
_cleanup_free_ char *c = NULL;
c = strndup(s, p - s);
if (!c)
return -ENOMEM;
k = utf8_console_width(c);
s = p + 1;
} else {
k = utf8_console_width(s);
s = NULL;
}
if (k == SIZE_MAX)
return -EINVAL;
if (k > max_width)
max_width = k;
height++;
} while (!isempty(s));
if (ret_width)
*ret_width = max_width;
if (ret_height)
*ret_height = height;
return 0;
}
static int table_data_requested_width_height(
Table *table,
TableData *d,
size_t available_width,
size_t *ret_width,
size_t *ret_height,
bool *have_soft) {
_cleanup_free_ char *truncated = NULL;
bool truncation_applied = false;
size_t width, height;
const char *t;
int r;
bool soft = false;
t = table_data_format(table, d, false, available_width, &soft);
if (!t)
return -ENOMEM;
if (table->cell_height_max != SIZE_MAX) {
r = string_truncate_lines(t, table->cell_height_max, &truncated);
if (r < 0)
return r;
if (r > 0)
truncation_applied = true;
t = truncated;
}
r = console_width_height(t, &width, &height);
if (r < 0)
return r;
if (d->maximum_width != SIZE_MAX && width > d->maximum_width)
width = d->maximum_width;
if (width < d->minimum_width)
width = d->minimum_width;
if (ret_width)
*ret_width = width;
if (ret_height)
*ret_height = height;
if (have_soft && soft)
*have_soft = true;
return truncation_applied;
}
static char *align_string_mem(const char *str, const char *url, size_t new_length, unsigned percent) {
size_t w = 0, space, lspace, old_length, clickable_length;
_cleanup_free_ char *clickable = NULL;
const char *p;
char *ret;
int r;
/* As with ellipsize_mem(), 'old_length' is a byte size while 'new_length' is a width in character cells */
assert(str);
assert(percent <= 100);
old_length = strlen(str);
if (url) {
r = terminal_urlify(url, str, &clickable);
if (r < 0)
return NULL;
clickable_length = strlen(clickable);
} else
clickable_length = old_length;
/* Determine current width on screen */
p = str;
while (p < str + old_length) {
char32_t c;
if (utf8_encoded_to_unichar(p, &c) < 0) {
p++, w++; /* count invalid chars as 1 */
continue;
}
p = utf8_next_char(p);
w += unichar_iswide(c) ? 2 : 1;
}
/* Already wider than the target, if so, don't do anything */
if (w >= new_length)
return clickable ? TAKE_PTR(clickable) : strdup(str);
/* How much spaces shall we add? An how much on the left side? */
space = new_length - w;
lspace = space * percent / 100U;
ret = new(char, space + clickable_length + 1);
if (!ret)
return NULL;
for (size_t i = 0; i < lspace; i++)
ret[i] = ' ';
memcpy(ret + lspace, clickable ?: str, clickable_length);
for (size_t i = lspace + clickable_length; i < space + clickable_length; i++)
ret[i] = ' ';
ret[space + clickable_length] = 0;
return ret;
}
static bool table_data_isempty(TableData *d) {
assert(d);
if (d->type == TABLE_EMPTY)
return true;
/* Let's also consider an empty strv as truly empty. */
if (IN_SET(d->type, TABLE_STRV, TABLE_STRV_WRAPPED))
return strv_isempty(d->strv);
/* Note that an empty string we do not consider empty here! */
return false;
}
static const char* table_data_color(TableData *d) {
assert(d);
if (d->color)
return d->color;
/* Let's implicitly color all "empty" cells in grey, in case an "empty_string" is set that is not empty */
if (table_data_isempty(d))
return ansi_grey();
return NULL;
}
static const char* table_data_rgap_color(TableData *d) {
assert(d);
if (d->rgap_color)
return d->rgap_color;
return NULL;
}
int table_print(Table *t, FILE *f) {
size_t n_rows, *minimum_width, *maximum_width, display_columns, *requested_width,
table_minimum_width, table_maximum_width, table_requested_width, table_effective_width,
*width = NULL;
_cleanup_free_ size_t *sorted = NULL;
uint64_t *column_weight, weight_sum;
int r;
assert(t);
if (!f)
f = stdout;
/* Ensure we have no incomplete rows */
assert(t->n_cells % t->n_columns == 0);
n_rows = t->n_cells / t->n_columns;
assert(n_rows > 0); /* at least the header row must be complete */
if (t->sort_map) {
/* If sorting is requested, let's calculate an index table we use to lookup the actual index to display with. */
sorted = new(size_t, n_rows);
if (!sorted)
return -ENOMEM;
for (size_t i = 0; i < n_rows; i++)
sorted[i] = i * t->n_columns;
typesafe_qsort_r(sorted, n_rows, table_data_compare, t);
}
if (t->display_map)
display_columns = t->n_display_map;
else
display_columns = t->n_columns;
assert(display_columns > 0);
minimum_width = newa(size_t, display_columns);
maximum_width = newa(size_t, display_columns);
requested_width = newa(size_t, display_columns);
column_weight = newa0(uint64_t, display_columns);
for (size_t j = 0; j < display_columns; j++) {
minimum_width[j] = 1;
maximum_width[j] = SIZE_MAX;
}
for (unsigned pass = 0; pass < 2; pass++) {
/* First pass: determine column sizes */
for (size_t j = 0; j < display_columns; j++)
requested_width[j] = SIZE_MAX;
bool any_soft = false;
for (size_t i = t->header ? 0 : 1; i < n_rows; i++) {
TableData **row;
/* Note that we don't care about ordering at this time, as we just want to determine column sizes,
* hence we don't care for sorted[] during the first pass. */
row = t->data + i * t->n_columns;
for (size_t j = 0; j < display_columns; j++) {
TableData *d;
size_t req_width, req_height;
assert_se(d = row[t->display_map ? t->display_map[j] : j]);
r = table_data_requested_width_height(t, d,
width ? width[j] : SIZE_MAX,
&req_width, &req_height, &any_soft);
if (r < 0)
return r;
if (r > 0) { /* Truncated because too many lines? */
_cleanup_free_ char *last = NULL;
const char *field;
/* If we are going to show only the first few lines of a cell that has
* multiple make sure that we have enough space horizontally to show an
* ellipsis. Hence, let's figure out the last line, and account for its
* length plus ellipsis. */
field = table_data_format(t, d, false,
width ? width[j] : SIZE_MAX,
&any_soft);
if (!field)
return -ENOMEM;
assert_se(t->cell_height_max > 0);
r = string_extract_line(field, t->cell_height_max-1, &last);
if (r < 0)
return r;
req_width = MAX(req_width,
utf8_console_width(last) +
utf8_console_width(special_glyph(SPECIAL_GLYPH_ELLIPSIS)));
}
/* Determine the biggest width that any cell in this column would like to have */
if (requested_width[j] == SIZE_MAX ||
requested_width[j] < req_width)
requested_width[j] = req_width;
/* Determine the minimum width any cell in this column needs */
if (minimum_width[j] < d->minimum_width)
minimum_width[j] = d->minimum_width;
/* Determine the maximum width any cell in this column needs */
if (d->maximum_width != SIZE_MAX &&
(maximum_width[j] == SIZE_MAX ||
maximum_width[j] > d->maximum_width))
maximum_width[j] = d->maximum_width;
/* Determine the full columns weight */
column_weight[j] += d->weight;
}
}
/* One space between each column */
table_requested_width = table_minimum_width = table_maximum_width = display_columns - 1;
/* Calculate the total weight for all columns, plus the minimum, maximum and requested width for the table. */
weight_sum = 0;
for (size_t j = 0; j < display_columns; j++) {
weight_sum += column_weight[j];
table_minimum_width += minimum_width[j];
if (maximum_width[j] == SIZE_MAX)
table_maximum_width = SIZE_MAX;
else
table_maximum_width += maximum_width[j];
table_requested_width += requested_width[j];
}
/* Calculate effective table width */
if (t->width != 0 && t->width != SIZE_MAX)
table_effective_width = t->width;
else if (t->width == 0 ||
((pass > 0 || !any_soft) && (pager_have() || !isatty(STDOUT_FILENO))))
table_effective_width = table_requested_width;
else
table_effective_width = MIN(table_requested_width, columns());
if (table_maximum_width != SIZE_MAX && table_effective_width > table_maximum_width)
table_effective_width = table_maximum_width;
if (table_effective_width < table_minimum_width)
table_effective_width = table_minimum_width;
if (!width)
width = newa(size_t, display_columns);
if (table_effective_width >= table_requested_width) {
size_t extra;
/* We have extra room, let's distribute it among columns according to their weights. We first provide
* each column with what it asked for and the distribute the rest. */
extra = table_effective_width - table_requested_width;
for (size_t j = 0; j < display_columns; j++) {
size_t delta;
if (weight_sum == 0)
width[j] = requested_width[j] + extra / (display_columns - j); /* Avoid division by zero */
else
width[j] = requested_width[j] + (extra * column_weight[j]) / weight_sum;
if (maximum_width[j] != SIZE_MAX && width[j] > maximum_width[j])
width[j] = maximum_width[j];
if (width[j] < minimum_width[j])
width[j] = minimum_width[j];
delta = LESS_BY(width[j], requested_width[j]);
/* Subtract what we just added from the rest */
if (extra > delta)
extra -= delta;
else
extra = 0;
assert(weight_sum >= column_weight[j]);
weight_sum -= column_weight[j];
}
break; /* Every column should be happy, no need to repeat calculations. */
} else {
/* We need to compress the table, columns can't get what they asked for. We first provide each column
* with the minimum they need, and then distribute anything left. */
bool finalize = false;
size_t extra;
extra = table_effective_width - table_minimum_width;
for (size_t j = 0; j < display_columns; j++)
width[j] = SIZE_MAX;
for (;;) {
bool restart = false;
for (size_t j = 0; j < display_columns; j++) {
size_t delta, w;
/* Did this column already get something assigned? If so, let's skip to the next */
if (width[j] != SIZE_MAX)
continue;
if (weight_sum == 0)
w = minimum_width[j] + extra / (display_columns - j); /* avoid division by zero */
else
w = minimum_width[j] + (extra * column_weight[j]) / weight_sum;
if (w >= requested_width[j]) {
/* Never give more than requested. If we hit a column like this, there's more
* space to allocate to other columns which means we need to restart the
* iteration. However, if we hit a column like this, let's assign it the space
* it wanted for good early. */
w = requested_width[j];
restart = true;
} else if (!finalize)
continue;
width[j] = w;
assert(w >= minimum_width[j]);
delta = w - minimum_width[j];
assert(delta <= extra);
extra -= delta;
assert(weight_sum >= column_weight[j]);
weight_sum -= column_weight[j];
if (restart && !finalize)
break;
}
if (finalize)
break;
if (!restart)
finalize = true;
}
if (!any_soft) /* Some columns got less than requested. If some cells were "soft",
* let's try to reformat them with the new widths. Otherwise, let's
* move on. */
break;
}
}
/* Second pass: show output */
for (size_t i = t->header ? 0 : 1; i < n_rows; i++) {
size_t n_subline = 0;
bool more_sublines;
TableData **row;
if (sorted)
row = t->data + sorted[i];
else
row = t->data + i * t->n_columns;
do {
const char *gap_color = NULL;
more_sublines = false;
for (size_t j = 0; j < display_columns; j++) {
_cleanup_free_ char *buffer = NULL, *extracted = NULL;
bool lines_truncated = false;
const char *field, *color = NULL;
TableData *d;
size_t l;
assert_se(d = row[t->display_map ? t->display_map[j] : j]);
field = table_data_format(t, d, false, width[j], NULL);
if (!field)
return -ENOMEM;
r = string_extract_line(field, n_subline, &extracted);
if (r < 0)
return r;
if (r > 0) {
/* There are more lines to come */
if ((t->cell_height_max == SIZE_MAX || n_subline + 1 < t->cell_height_max))
more_sublines = true; /* There are more lines to come */
else
lines_truncated = true;
}
if (extracted)
field = extracted;
l = utf8_console_width(field);
if (l > width[j]) {
/* Field is wider than allocated space. Let's ellipsize */
buffer = ellipsize(field, width[j], /* ellipsize at the end if we truncated coming lines, otherwise honour configuration */
lines_truncated ? 100 : d->ellipsize_percent);
if (!buffer)
return -ENOMEM;
field = buffer;
} else {
if (lines_truncated) {
_cleanup_free_ char *padded = NULL;
/* We truncated more lines of this cell, let's add an
* ellipsis. We first append it, but that might make our
* string grow above what we have space for, hence ellipsize
* right after. This will truncate the ellipsis and add a new
* one. */
padded = strjoin(field, special_glyph(SPECIAL_GLYPH_ELLIPSIS));
if (!padded)
return -ENOMEM;
buffer = ellipsize(padded, width[j], 100);
if (!buffer)
return -ENOMEM;
field = buffer;
l = utf8_console_width(field);
}
if (l < width[j]) {
_cleanup_free_ char *aligned = NULL;
/* Field is shorter than allocated space. Let's align with spaces */
aligned = align_string_mem(field, d->url, width[j], d->align_percent);
if (!aligned)
return -ENOMEM;
/* Drop trailing white spaces of last column when no cosmetics is set. */
if (j == display_columns - 1 &&
(!colors_enabled() || (!table_data_color(d) && row != t->data)) &&
(!urlify_enabled() || !d->url))
delete_trailing_chars(aligned, NULL);
free_and_replace(buffer, aligned);
field = buffer;
}
}
if (l >= width[j] && d->url) {
_cleanup_free_ char *clickable = NULL;
r = terminal_urlify(d->url, field, &clickable);
if (r < 0)
return r;
free_and_replace(buffer, clickable);
field = buffer;
}
if (colors_enabled()) {
if (gap_color)
fputs(gap_color, f);
else if (row == t->data) /* underline header line fully, including the column separator */
fputs(ansi_underline(), f);
}
if (j > 0)
fputc(' ', f); /* column separator left of cell */
if (colors_enabled()) {
color = table_data_color(d);
/* Undo gap color */
if (gap_color || (color && row == t->data))
fputs(ANSI_NORMAL, f);
if (color)
fputs(color, f);
else if (gap_color && row == t->data) /* underline header line cell */
fputs(ansi_underline(), f);
}
fputs(field, f);
if (colors_enabled() && (color || row == t->data))
fputs(ANSI_NORMAL, f);
gap_color = table_data_rgap_color(d);
}
fputc('\n', f);
n_subline ++;
} while (more_sublines);
}
return fflush_and_check(f);
}
int table_format(Table *t, char **ret) {
_cleanup_free_ char *buf = NULL;
_cleanup_fclose_ FILE *f = NULL;
size_t sz = 0;
int r;
f = open_memstream_unlocked(&buf, &sz);
if (!f)
return -ENOMEM;
r = table_print(t, f);
if (r < 0)
return r;
f = safe_fclose(f);
*ret = TAKE_PTR(buf);
return 0;
}
size_t table_get_rows(Table *t) {
if (!t)
return 0;
assert(t->n_columns > 0);
return t->n_cells / t->n_columns;
}
size_t table_get_columns(Table *t) {
if (!t)
return 0;
assert(t->n_columns > 0);
return t->n_columns;
}
int table_set_reverse(Table *t, size_t column, bool b) {
assert(t);
assert(column < t->n_columns);
if (!t->reverse_map) {
if (!b)
return 0;
t->reverse_map = new0(bool, t->n_columns);
if (!t->reverse_map)
return -ENOMEM;
}
t->reverse_map[column] = b;
return 0;
}
TableCell *table_get_cell(Table *t, size_t row, size_t column) {
size_t i;
assert(t);
if (column >= t->n_columns)
return NULL;
i = row * t->n_columns + column;
if (i >= t->n_cells)
return NULL;
return TABLE_INDEX_TO_CELL(i);
}
const void *table_get(Table *t, TableCell *cell) {
TableData *d;
assert(t);
d = table_get_data(t, cell);
if (!d)
return NULL;
return d->data;
}
const void* table_get_at(Table *t, size_t row, size_t column) {
TableCell *cell;
cell = table_get_cell(t, row, column);
if (!cell)
return NULL;
return table_get(t, cell);
}
static int table_data_to_json(TableData *d, JsonVariant **ret) {
switch (d->type) {
case TABLE_EMPTY:
return json_variant_new_null(ret);
case TABLE_STRING:
case TABLE_PATH:
return json_variant_new_string(ret, d->string);
case TABLE_STRV:
case TABLE_STRV_WRAPPED:
return json_variant_new_array_strv(ret, d->strv);
case TABLE_BOOLEAN:
return json_variant_new_boolean(ret, d->boolean);
case TABLE_TIMESTAMP:
case TABLE_TIMESTAMP_UTC:
case TABLE_TIMESTAMP_RELATIVE:
if (d->timestamp == USEC_INFINITY)
return json_variant_new_null(ret);
return json_variant_new_unsigned(ret, d->timestamp);
case TABLE_TIMESPAN:
case TABLE_TIMESPAN_MSEC:
if (d->timespan == USEC_INFINITY)
return json_variant_new_null(ret);
return json_variant_new_unsigned(ret, d->timespan);
case TABLE_SIZE:
case TABLE_BPS:
if (d->size == UINT64_MAX)
return json_variant_new_null(ret);
return json_variant_new_unsigned(ret, d->size);
case TABLE_INT:
return json_variant_new_integer(ret, d->int_val);
case TABLE_INT8:
return json_variant_new_integer(ret, d->int8);
case TABLE_INT16:
return json_variant_new_integer(ret, d->int16);
case TABLE_INT32:
return json_variant_new_integer(ret, d->int32);
case TABLE_INT64:
return json_variant_new_integer(ret, d->int64);
case TABLE_UINT:
return json_variant_new_unsigned(ret, d->uint_val);
case TABLE_UINT8:
return json_variant_new_unsigned(ret, d->uint8);
case TABLE_UINT16:
return json_variant_new_unsigned(ret, d->uint16);
case TABLE_UINT32:
return json_variant_new_unsigned(ret, d->uint32);
case TABLE_UINT64:
return json_variant_new_unsigned(ret, d->uint64);
case TABLE_PERCENT:
return json_variant_new_integer(ret, d->percent);
case TABLE_IFINDEX:
if (d->ifindex <= 0)
return json_variant_new_null(ret);
return json_variant_new_integer(ret, d->ifindex);
case TABLE_IN_ADDR:
return json_variant_new_array_bytes(ret, &d->address, FAMILY_ADDRESS_SIZE(AF_INET));
case TABLE_IN6_ADDR:
return json_variant_new_array_bytes(ret, &d->address, FAMILY_ADDRESS_SIZE(AF_INET6));
case TABLE_ID128: {
char buf[SD_ID128_STRING_MAX];
return json_variant_new_string(ret, sd_id128_to_string(d->id128, buf));
}
case TABLE_UUID: {
char buf[ID128_UUID_STRING_MAX];
return json_variant_new_string(ret, id128_to_uuid_string(d->id128, buf));
}
case TABLE_UID:
if (!uid_is_valid(d->uid))
return json_variant_new_null(ret);
return json_variant_new_integer(ret, d->uid);
case TABLE_GID:
if (!gid_is_valid(d->gid))
return json_variant_new_null(ret);
return json_variant_new_integer(ret, d->gid);
case TABLE_PID:
if (!pid_is_valid(d->pid))
return json_variant_new_null(ret);
return json_variant_new_integer(ret, d->pid);
case TABLE_SIGNAL:
if (!SIGNAL_VALID(d->int_val))
return json_variant_new_null(ret);
return json_variant_new_integer(ret, d->int_val);
default:
return -EINVAL;
}
}
static char* string_to_json_field_name(const char *f) {
/* Tries to make a string more suitable as JSON field name. There are no strict rules defined what a
* field name can be hence this is a bit vague and black magic. Right now we only convert spaces to
* underscores and leave everything as is. */
char *c = strdup(f);
if (!c)
return NULL;
for (char *x = c; *x; x++)
if (isspace(*x))
*x = '_';
return c;
}
int table_to_json(Table *t, JsonVariant **ret) {
JsonVariant **rows = NULL, **elements = NULL;
_cleanup_free_ size_t *sorted = NULL;
size_t n_rows, display_columns;
int r;
assert(t);
/* Ensure we have no incomplete rows */
assert(t->n_cells % t->n_columns == 0);
n_rows = t->n_cells / t->n_columns;
assert(n_rows > 0); /* at least the header row must be complete */
if (t->sort_map) {
/* If sorting is requested, let's calculate an index table we use to lookup the actual index to display with. */
sorted = new(size_t, n_rows);
if (!sorted) {
r = -ENOMEM;
goto finish;
}
for (size_t i = 0; i < n_rows; i++)
sorted[i] = i * t->n_columns;
typesafe_qsort_r(sorted, n_rows, table_data_compare, t);
}
if (t->display_map)
display_columns = t->n_display_map;
else
display_columns = t->n_columns;
assert(display_columns > 0);
elements = new0(JsonVariant*, display_columns * 2);
if (!elements) {
r = -ENOMEM;
goto finish;
}
for (size_t j = 0; j < display_columns; j++) {
_cleanup_free_ char *mangled = NULL;
const char *formatted;
TableData *d;
assert_se(d = t->data[t->display_map ? t->display_map[j] : j]);
/* Field names must be strings, hence format whatever we got here as a string first */
formatted = table_data_format(t, d, true, SIZE_MAX, NULL);
if (!formatted) {
r = -ENOMEM;
goto finish;
}
/* Arbitrary strings suck as field names, try to mangle them into something more suitable hence */
mangled = string_to_json_field_name(formatted);
if (!mangled) {
r = -ENOMEM;
goto finish;
}
r = json_variant_new_string(elements + j*2, mangled);
if (r < 0)
goto finish;
}
rows = new0(JsonVariant*, n_rows-1);
if (!rows) {
r = -ENOMEM;
goto finish;
}
for (size_t i = 1; i < n_rows; i++) {
TableData **row;
if (sorted)
row = t->data + sorted[i];
else
row = t->data + i * t->n_columns;
for (size_t j = 0; j < display_columns; j++) {
TableData *d;
size_t k;
assert_se(d = row[t->display_map ? t->display_map[j] : j]);
k = j*2+1;
elements[k] = json_variant_unref(elements[k]);
r = table_data_to_json(d, elements + k);
if (r < 0)
goto finish;
}
r = json_variant_new_object(rows + i - 1, elements, display_columns * 2);
if (r < 0)
goto finish;
}
r = json_variant_new_array(ret, rows, n_rows - 1);
finish:
if (rows) {
json_variant_unref_many(rows, n_rows-1);
free(rows);
}
if (elements) {
json_variant_unref_many(elements, display_columns*2);
free(elements);
}
return r;
}
int table_print_json(Table *t, FILE *f, JsonFormatFlags flags) {
_cleanup_(json_variant_unrefp) JsonVariant *v = NULL;
int r;
assert(t);
if (flags & JSON_FORMAT_OFF) /* If JSON output is turned off, use regular output */
return table_print(t, f);
if (!f)
f = stdout;
r = table_to_json(t, &v);
if (r < 0)
return r;
json_variant_dump(v, flags, f, NULL);
return fflush_and_check(f);
}
int table_print_with_pager(
Table *t,
JsonFormatFlags json_format_flags,
PagerFlags pager_flags,
bool show_header) {
bool saved_header;
int r;
assert(t);
/* An all-in-one solution for showing tables, and turning on a pager first. Also optionally suppresses
* the table header and logs about any error. */
if (json_format_flags & (JSON_FORMAT_OFF|JSON_FORMAT_PRETTY|JSON_FORMAT_PRETTY_AUTO))
(void) pager_open(pager_flags);
saved_header = t->header;
t->header = show_header;
r = table_print_json(t, stdout, json_format_flags);
t->header = saved_header;
if (r < 0)
return table_log_print_error(r);
return 0;
}