src/shared/format-table.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5 #include <stdio.h>
   6 #include <sys/types.h>
   7
   8 #include "json.h"
   9 #include "macro.h"
  10
  11 typedef enum TableDataType {
  12         TABLE_EMPTY,
  13         TABLE_STRING,
  14         TABLE_BOOLEAN,
  15         TABLE_TIMESTAMP,
  16         TABLE_TIMESTAMP_UTC,
  17         TABLE_TIMESTAMP_RELATIVE,
  18         TABLE_TIMESPAN,
  19         TABLE_TIMESPAN_MSEC,
  20         TABLE_SIZE,
  21         TABLE_BPS,
  22         TABLE_INT,
  23         TABLE_INT32,
  24         TABLE_INT64,
  25         TABLE_UINT,
  26         TABLE_UINT32,
  27         TABLE_UINT64,
  28         TABLE_PERCENT,
  29         TABLE_IFINDEX,
  30         _TABLE_DATA_TYPE_MAX,
  31
  32         /* The following are not really data types, but commands for table_add_cell_many() to make changes to
  33          * a cell just added. */
  34         TABLE_SET_MINIMUM_WIDTH,
  35         TABLE_SET_MAXIMUM_WIDTH,
  36         TABLE_SET_WEIGHT,
  37         TABLE_SET_ALIGN_PERCENT,
  38         TABLE_SET_ELLIPSIZE_PERCENT,
  39         TABLE_SET_COLOR,
  40         TABLE_SET_URL,
  41         TABLE_SET_UPPERCASE,
  42
  43         _TABLE_DATA_TYPE_INVALID = -1,
  44 } TableDataType;
  45
  46 typedef struct Table Table;
  47 typedef struct TableCell TableCell;
  48
  49 Table *table_new_internal(const char *first_header, ...) _sentinel_;
  50 #define table_new(...) table_new_internal(__VA_ARGS__, NULL)
  51 Table *table_new_raw(size_t n_columns);
  52 Table *table_unref(Table *t);
  53
  54 DEFINE_TRIVIAL_CLEANUP_FUNC(Table*, table_unref);
  55
  56 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);
  57 static inline int table_add_cell(Table *t, TableCell **ret_cell, TableDataType type, const void *data) {
  58         return table_add_cell_full(t, ret_cell, type, data, (size_t) -1, (size_t) -1, (unsigned) -1, (unsigned) -1, (unsigned) -1);
  59 }
  60 int table_add_cell_stringf(Table *t, TableCell **ret_cell, const char *format, ...) _printf_(3, 4);
  61
  62 int table_dup_cell(Table *t, TableCell *cell);
  63
  64 int table_set_minimum_width(Table *t, TableCell *cell, size_t minimum_width);
  65 int table_set_maximum_width(Table *t, TableCell *cell, size_t maximum_width);
  66 int table_set_weight(Table *t, TableCell *cell, unsigned weight);
  67 int table_set_align_percent(Table *t, TableCell *cell, unsigned percent);
  68 int table_set_ellipsize_percent(Table *t, TableCell *cell, unsigned percent);
  69 int table_set_color(Table *t, TableCell *cell, const char *color);
  70 int table_set_url(Table *t, TableCell *cell, const char *url);
  71 int table_set_uppercase(Table *t, TableCell *cell, bool b);
  72
  73 int table_update(Table *t, TableCell *cell, TableDataType type, const void *data);
  74
  75 int table_add_many_internal(Table *t, TableDataType first_type, ...);
  76 #define table_add_many(t, ...) table_add_many_internal(t, __VA_ARGS__, _TABLE_DATA_TYPE_MAX)
  77
  78 void table_set_header(Table *table, bool b);
  79 void table_set_width(Table *t, size_t width);
  80 int table_set_display(Table *t, size_t first_column, ...);
  81 int table_set_sort(Table *t, size_t first_column, ...);
  82 int table_set_reverse(Table *t, size_t column, bool b);
  83
  84 int table_print(Table *t, FILE *f);
  85 int table_format(Table *t, char **ret);
  86
  87 static inline TableCell* TABLE_HEADER_CELL(size_t i) {
  88         return SIZE_TO_PTR(i + 1);
  89 }
  90
  91 size_t table_get_rows(Table *t);
  92 size_t table_get_columns(Table *t);
  93
  94 TableCell *table_get_cell(Table *t, size_t row, size_t column);
  95
  96 const void *table_get(Table *t, TableCell *cell);
  97 const void *table_get_at(Table *t, size_t row, size_t column);
  98
  99 int table_to_json(Table *t, JsonVariant **ret);
 100 int table_print_json(Table *t, FILE *f, JsonFormatFlags json_flags);