libvirt/tools/vsh-table.c
Michal Privoznik 74c6c8e679 vsh-table: Hide vshTableRow typedef
There's no need for any caller to know vshTableRow typedef.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
2021-12-17 15:05:49 +01:00

437 lines
10 KiB
C

/*
* vsh-table.c: table printing helper
*
* Copyright (C) 2018 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include "vsh-table.h"
#include <stdarg.h>
#include <stddef.h>
#include <wchar.h>
#include <wctype.h>
#include "viralloc.h"
#include "virbuffer.h"
#define HEX_ENCODE_LENGTH 4 /* represents length of '\xNN' */
typedef struct _vshTableRow vshTableRow;
struct _vshTableRow {
char **cells;
size_t ncells;
};
struct _vshTable {
vshTableRow **rows;
size_t nrows;
};
static void
vshTableRowFree(vshTableRow *row)
{
size_t i;
if (!row)
return;
for (i = 0; i < row->ncells; i++)
g_free(row->cells[i]);
g_free(row->cells);
g_free(row);
}
void
vshTableFree(vshTable *table)
{
size_t i;
if (!table)
return;
for (i = 0; i < table->nrows; i++)
vshTableRowFree(table->rows[i]);
g_free(table->rows);
g_free(table);
}
/**
* vshTableRowNew:
* @arg: the first argument.
* @ap: list of variadic arguments
*
* Create a new row in the table. Each argument passed
* represents a cell in the row.
*
* Return: pointer to vshTableRow *row or NULL.
*/
static vshTableRow *
vshTableRowNew(const char *arg, va_list ap)
{
vshTableRow *row = NULL;
if (!arg) {
virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
_("Table row cannot be empty"));
goto error;
}
row = g_new0(vshTableRow, 1);
while (arg) {
g_autofree char *tmp = NULL;
tmp = g_strdup(arg);
VIR_APPEND_ELEMENT(row->cells, row->ncells, tmp);
arg = va_arg(ap, const char *);
}
return row;
error:
vshTableRowFree(row);
return NULL;
}
/**
* vshTableNew:
* @arg: List of column names (NULL terminated)
*
* Create a new table.
*
* Returns: pointer to table or NULL.
*/
vshTable *
vshTableNew(const char *arg, ...)
{
vshTable *table = NULL;
vshTableRow *header = NULL;
va_list ap;
table = g_new0(vshTable, 1);
va_start(ap, arg);
header = vshTableRowNew(arg, ap);
va_end(ap);
if (!header)
goto error;
VIR_APPEND_ELEMENT(table->rows, table->nrows, header);
return table;
error:
vshTableRowFree(header);
vshTableFree(table);
return NULL;
}
/**
* vshTableRowAppend:
* @table: table to append to
* @arg: cells of the row (NULL terminated)
*
* Append new row into the @table. The number of cells in the row has
* to be equal to the number of cells in the table header.
*
* Returns: 0 if succeeded, -1 if failed.
*/
int
vshTableRowAppend(vshTable *table, const char *arg, ...)
{
vshTableRow *row = NULL;
size_t ncolumns = table->rows[0]->ncells;
va_list ap;
int ret = -1;
va_start(ap, arg);
row = vshTableRowNew(arg, ap);
va_end(ap);
if (!row)
goto cleanup;
if (ncolumns != row->ncells) {
virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
_("Incorrect number of cells in a table row"));
goto cleanup;
}
VIR_APPEND_ELEMENT(table->rows, table->nrows, row);
ret = 0;
cleanup:
vshTableRowFree(row);
return ret;
}
/**
* Function pulled from util-linux
*
* Function's name in util-linux: mbs_safe_encode_to_buffer
*
* Returns allocated string where all control and non-printable chars are
* replaced with \x?? hex sequence, or NULL.
*/
static char *
vshTableSafeEncode(const char *s, size_t *width)
{
const char *p = s;
size_t sz = s ? strlen(s) : 0;
char *buf;
char *ret;
mbstate_t st;
memset(&st, 0, sizeof(st));
buf = g_new0(char, (sz * HEX_ENCODE_LENGTH) + 1);
ret = buf;
*width = 0;
while (p && *p) {
if ((*p == '\\' && *(p + 1) == 'x') ||
g_ascii_iscntrl(*p)) {
g_snprintf(buf, HEX_ENCODE_LENGTH + 1, "\\x%02x", *p);
buf += HEX_ENCODE_LENGTH;
*width += HEX_ENCODE_LENGTH;
p++;
} else {
wchar_t wc;
size_t len = mbrtowc(&wc, p, MB_CUR_MAX, &st);
if (len == 0)
break; /* end of string */
if (len == (size_t) -1 || len == (size_t) -2) {
len = 1;
/*
* Not valid multibyte sequence -- maybe it's
* printable char according to the current locales.
*/
if (!g_ascii_isprint(*p)) {
g_snprintf(buf, HEX_ENCODE_LENGTH + 1, "\\x%02x", *p);
buf += HEX_ENCODE_LENGTH;
*width += HEX_ENCODE_LENGTH;
} else {
*buf++ = *p;
(*width)++;
}
} else if (!iswprint(wc)) {
size_t i;
for (i = 0; i < len; i++) {
g_snprintf(buf, HEX_ENCODE_LENGTH + 1, "\\x%02x", p[i]);
buf += HEX_ENCODE_LENGTH;
*width += HEX_ENCODE_LENGTH;
}
} else {
memcpy(buf, p, len);
buf += len;
*width += g_unichar_iszerowidth(wc) ? 0 : (g_unichar_iswide(wc) ? 2 : 1);
}
p += len;
}
}
*buf = '\0';
return ret;
}
/**
* vshTableGetColumnsWidths:
* @table: table
* @maxwidths: maximum count of characters for each columns
* @widths: count of characters for each cell in the table
*
* Fill passed @maxwidths and @widths arrays with maximum number
* of characters for columns and number of character per each
* table cell, respectively.
* Handle unicode strings (user must have multibyte locale)
*
* Return 0 in case of success, -1 otherwise.
*/
static int
vshTableGetColumnsWidths(vshTable *table,
size_t *maxwidths,
size_t **widths,
bool header)
{
size_t i;
i = header? 0 : 1;
for (; i < table->nrows; i++) {
vshTableRow *row = table->rows[i];
size_t j;
for (j = 0; j < row->ncells; j++) {
size_t size = 0;
/* need to replace nonprintable and control characters,
* because width of some of those characters (e.g. \t, \v, \b ...)
* cannot be counted properly */
char *tmp = vshTableSafeEncode(row->cells[j], &size);
if (!tmp)
return -1;
VIR_FREE(row->cells[j]);
row->cells[j] = tmp;
widths[i][j] = size;
if (widths[i][j] > maxwidths[j])
maxwidths[j] = widths[i][j];
}
}
return 0;
}
/**
* vshTableRowPrint:
* @row: table to append to
* @maxwidths: maximum count of characters for each columns
* @widths: count of character for each cell in this row
* @buf: buffer to store table (only if @toStdout == true)
*/
static void
vshTableRowPrint(vshTableRow *row,
size_t *maxwidths,
size_t *widths,
virBuffer *buf)
{
size_t i;
size_t j;
for (i = 0; i < row->ncells; i++) {
virBufferAsprintf(buf, " %s", row->cells[i]);
if (i < (row->ncells - 1)) {
for (j = 0; j < maxwidths[i] - widths[i] + 2; j++)
virBufferAddChar(buf, ' ');
}
}
virBufferAddChar(buf, '\n');
}
/**
* vshTablePrint:
* @table: table to print
* @header: whetever to print to header (true) or not (false)
* this argument is relevant only if @ctl == NULL
*
* Get table. To get an alignment of columns right, function
* fills 2d array @widths with count of characters in each cell and
* array @maxwidths maximum count of character in each column.
* Function then prints tables header and content.
*
* Return string containing table, or NULL
*/
static char *
vshTablePrint(vshTable *table, bool header)
{
size_t i;
size_t j;
g_autofree size_t *maxwidths = NULL;
size_t **widths;
g_auto(virBuffer) buf = VIR_BUFFER_INITIALIZER;
char *ret = NULL;
maxwidths = g_new0(size_t, table->rows[0]->ncells);
widths = g_new0(size_t *, table->nrows);
/* retrieve widths of columns */
for (i = 0; i < table->nrows; i++)
widths[i] = g_new0(size_t, table->rows[0]->ncells);
if (vshTableGetColumnsWidths(table, maxwidths, widths, header) < 0)
goto cleanup;
if (header) {
/* print header */
vshTableRowPrint(table->rows[0], maxwidths, widths[0], &buf);
/* print dividing line */
for (i = 0; i < table->rows[0]->ncells; i++) {
for (j = 0; j < maxwidths[i] + 3; j++)
virBufferAddChar(&buf, '-');
}
virBufferAddChar(&buf, '\n');
}
/* print content */
for (i = 1; i < table->nrows; i++)
vshTableRowPrint(table->rows[i], maxwidths, widths[i], &buf);
ret = virBufferContentAndReset(&buf);
cleanup:
for (i = 0; i < table->nrows; i++)
VIR_FREE(widths[i]);
VIR_FREE(widths);
return ret;
}
/**
* vshTablePrintToStdout:
* @table: table to print
* @ctl virtshell control structure
*
* Print table returned in string to stdout.
* If effect on vshControl structure on printing function changes in future
* (apart from quiet mode) this code may need update
*/
void
vshTablePrintToStdout(vshTable *table, vshControl *ctl)
{
bool header;
g_autofree char *out = NULL;
header = ctl ? !ctl->quiet : true;
out = vshTablePrintToString(table, header);
if (out)
vshPrint(ctl, "%s", out);
}
/**
* vshTablePrintToString:
* @table: table to print
* @header: whetever to print to header (true) or not (false)
*
* Return string containing table, or NULL if table was printed to
* stdout. User will have to free returned string.
*/
char *
vshTablePrintToString(vshTable *table, bool header)
{
return vshTablePrint(table, header);
}