ucw/table.h

   1 /*
   2  *      UCW Library -- Table printer
   3  *
   4  *      (c) 2014 Robert Kessl <robert.kessl@economia.cz>
   5  */
   6
   7 #ifndef _UCW_TABLE_H
   8 #define _UCW_TABLE_H
   9
  10 #include <inttypes.h>
  11
  12 #include <ucw/fastbuf.h>
  13 #include <ucw/mempool.h>
  14
  15 #ifdef CONFIG_UCW_CLEAN_ABI
  16 #define table_append_bool ucw_table_append_bool
  17 #define table_append_double ucw_table_append_double
  18 #define table_append_int ucw_table_append_int
  19 #define table_append_intmax ucw_table_append_intmax
  20 #define table_append_printf ucw_table_append_printf
  21 #define table_append_str ucw_table_append_str
  22 #define table_append_u64 ucw_table_append_u64
  23 #define table_append_uint ucw_table_append_uint
  24 #define table_append_uintmax ucw_table_append_uintmax
  25 #define table_cleanup ucw_table_cleanup
  26 #define table_col_bool ucw_table_col_bool
  27 #define table_col_bool_fmt ucw_table_col_bool_fmt
  28 #define table_col_bool_name ucw_table_col_bool_name
  29 #define table_col_double ucw_table_col_double
  30 #define table_col_double_fmt ucw_table_col_double_fmt
  31 #define table_col_double_name ucw_table_col_double_name
  32 #define table_col_fbend ucw_table_col_fbend
  33 #define table_col_fbstart ucw_table_col_fbstart
  34 #define table_col_int ucw_table_col_int
  35 #define table_col_int_fmt ucw_table_col_int_fmt
  36 #define table_col_int_name ucw_table_col_int_name
  37 #define table_col_intmax ucw_table_col_intmax
  38 #define table_col_intmax_fmt ucw_table_col_intmax_fmt
  39 #define table_col_intmax_name ucw_table_col_intmax_name
  40 #define table_col_printf ucw_table_col_printf
  41 #define table_col_s64 ucw_table_col_s64
  42 #define table_col_s64_fmt ucw_table_col_s64_fmt
  43 #define table_col_s64_name ucw_table_col_s64_name
  44 #define table_col_str ucw_table_col_str
  45 #define table_col_str_fmt ucw_table_col_str_fmt
  46 #define table_col_str_name ucw_table_col_str_name
  47 #define table_col_u64 ucw_table_col_u64
  48 #define table_col_u64_fmt ucw_table_col_u64_fmt
  49 #define table_col_u64_name ucw_table_col_u64_name
  50 #define table_col_uint ucw_table_col_uint
  51 #define table_col_uint_fmt ucw_table_col_uint_fmt
  52 #define table_col_uint_name ucw_table_col_uint_name
  53 #define table_col_uintmax ucw_table_col_uintmax
  54 #define table_col_uintmax_fmt ucw_table_col_uintmax_fmt
  55 #define table_col_uintmax_name ucw_table_col_uintmax_name
  56 #define table_end ucw_table_end
  57 #define table_end_row ucw_table_end_row
  58 #define table_fmt_blockline ucw_table_fmt_blockline
  59 #define table_fmt_human_readable ucw_table_fmt_human_readable
  60 #define table_fmt_machine_readable ucw_table_fmt_machine_readable
  61 #define table_get_col_idx ucw_table_get_col_idx
  62 #define table_get_col_list ucw_table_get_col_list
  63 #define table_init ucw_table_init
  64 #define table_set_col_order ucw_table_set_col_order
  65 #define table_set_col_order_by_name ucw_table_set_col_order_by_name
  66 #define table_set_formatter ucw_table_set_formatter
  67 #define table_set_gary_options ucw_table_set_gary_options
  68 #define table_set_option ucw_table_set_option
  69 #define table_set_option_value ucw_table_set_option_value
  70 #define table_start ucw_table_start
  71 #endif
  72
  73 /***
  74  * Table definitions
  75  * -----------------
  76  ***/
  77
  78 /** Types of columns. These are seldom used explicitly, using a column definition macro is preferred. **/
  79 enum column_type {
  80   COL_TYPE_STR,         // String
  81   COL_TYPE_INT,         // int
  82   COL_TYPE_S64,         // Signed 64-bit integer
  83   COL_TYPE_INTMAX,      // intmax_t
  84   COL_TYPE_UINT,        // unsigned int
  85   COL_TYPE_U64,         // Unsigned 64-bit integer
  86   COL_TYPE_UINTMAX,     // uintmax_t
  87   COL_TYPE_BOOL,        // bool
  88   COL_TYPE_DOUBLE,      // double
  89   COL_TYPE_ANY,         // Any type
  90   COL_TYPE_LAST
  91 };
  92
  93 /** Justify cell contents to the left. **/
  94 #define CELL_ALIGN_LEFT     (1U << 31)
  95
  96 // CELL_FLAG_MASK has 1's in bits used for column flags,
  97 // CELL_WIDTH_MASK has 1's in bits used for column width.
  98 #define CELL_FLAG_MASK  (CELL_ALIGN_LEFT)
  99 #define CELL_WIDTH_MASK (~CELL_FLAG_MASK)
 100
 101 /**
 102  * Definition of a single table column.
 103  * Usually, this is generated using the `TABLE_COL_`'type' macros.
 104  * Fields marked with `[*]` are user-accessible.
 105  **/
 106 struct table_column {
 107   const char *name;             // [*] Name of the column displayed in table header
 108   int width;                    // [*] Width of the column (in characters) OR'ed with column flags
 109   const char *fmt;              // [*] Default format of each cell in the column
 110   enum column_type type;        // [*] Type of the cells in the column
 111 };
 112
 113 /**
 114  * Definition of a table. Contains column definitions, per-table settings
 115  * and internal data. Please use only fields marked with `[*]`.
 116  **/
 117 struct table {
 118   struct table_column *columns;         // [*] Definition of columns
 119   int column_count;                     // [*] Number of columns (calculated by table_init())
 120   struct mempool *pool;                 // Memory pool used for storing table data. Contains global state
 121                                         // and data of the current row.
 122   struct mempool_state pool_state;      // State of the pool after the table is initialized, i.e., before
 123                                         // per-row data have been allocated.
 124
 125   char **col_str_ptrs;                  // Values of cells in the current row (allocated from the pool)
 126
 127   uint *column_order;                   // [*] Order of the columns in the print-out of the table
 128   uint cols_to_output;                  // [*] Number of columns that are printed
 129   const char *col_delimiter;            // [*] Delimiter that is placed between columns
 130   const char *append_delimiter;         // [*] Separator of multiple values in a single cell (see table_append_...())
 131   uint print_header;                    // [*] 0 indicates that table header should not be printed
 132
 133   struct fastbuf *out;                  // [*] Fastbuffer to which the table is printed
 134   int last_printed_col;                 // Index of the last column which was set. -1 indicates start of row.
 135                                         // Used for example for appending to the current column.
 136   int row_printing_started;             // Indicates that a row has been started. Duplicates last_printed_col, but harmlessly.
 137   struct fbpool fb_col_out;             // Per-cell fastbuf, see table_col_fbstart()
 138   int col_out;                          // Index of the column that is currently printed using fb_col_out
 139
 140   // Back-end used for table formatting and its private data
 141   struct table_formatter *formatter;
 142   void *data;
 143 };
 144
 145 /****
 146  * In most cases, table descriptions are constructed using the following macros.
 147  * See the examples above for more details.
 148  *
 149  *  * `TBL_COLUMNS` indicates the start of definition of columns
 150  *  * `TBL_COL_`'type'`(name, width)` defines a column of a given type
 151  *  * `TBL_COL_`'type'`_FMT(name, width, fmt)` defines a column with a custom format string
 152  *  * `TBL_COL_END` ends the column definitions
 153  *  * `TBL_COL_ORDER` specifies custom ordering of columns in the output
 154  *  * `TBL_COL_DELIMITER` and `TBL_APPEND_DELIMITER` override default delimiters
 155  *  * `TBL_OUTPUT_HUMAN_READABLE` requests human-readable formatting (this is the default)
 156  *  * `TBL_OUTPUT_MACHINE_READABLE` requests machine-readable TSV output
 157  *  * `TBL_OUTPUT_BLOCKLINE` requests block formatting (each cell printed a pair of a key and value on its own line)
 158  *
 159  ***/
 160
 161 #define TBL_COL_STR(_name, _width)            { .name = _name, .width = _width, .fmt = "%s", .type = COL_TYPE_STR }
 162 #define TBL_COL_INT(_name, _width)            { .name = _name, .width = _width, .fmt = "%d", .type = COL_TYPE_INT }
 163 #define TBL_COL_S64(_name, _width)            { .name = _name, .width = _width, .fmt = "%" PRId64, .type = COL_TYPE_S64 }
 164 #define TBL_COL_UINT(_name, _width)           { .name = _name, .width = _width, .fmt = "%u", .type = COL_TYPE_UINT }
 165 #define TBL_COL_U64(_name, _width)            { .name = _name, .width = _width, .fmt = "%" PRIu64, .type = COL_TYPE_U64 }
 166 #define TBL_COL_INTMAX(_name, _width)         { .name = _name, .width = _width, .fmt = "%jd", .type = COL_TYPE_INTMAX }
 167 #define TBL_COL_UINTMAX(_name, _width)        { .name = _name, .width = _width, .fmt = "%ju", .type = COL_TYPE_UINTMAX }
 168 #define TBL_COL_HEXUINT(_name, _width)        { .name = _name, .width = _width, .fmt = "0x%x", .type = COL_TYPE_UINT }
 169 #define TBL_COL_DOUBLE(_name, _width, _prec)  { .name = _name, .width = _width, .fmt = "%." #_prec "lf", .type = COL_TYPE_DOUBLE }
 170 #define TBL_COL_BOOL(_name, _width)           { .name = _name, .width = _width, .fmt = "%s", .type = COL_TYPE_BOOL }
 171 #define TBL_COL_ANY(_name, _width)            { .name = _name, .width = _width, .fmt = 0, .type = COL_TYPE_ANY }
 172
 173 #define TBL_COL_STR_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_STR }
 174 #define TBL_COL_INT_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_INT }
 175 #define TBL_COL_S64_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_S64 }
 176 #define TBL_COL_UINT_FMT(_name, _width, _fmt)           { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_UINT }
 177 #define TBL_COL_U64_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_U64 }
 178 #define TBL_COL_INTMAX_FMT(_name, _width, _fmt)         { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_INTMAX }
 179 #define TBL_COL_UINTMAX_FMT(_name, _width, _fmt)        { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_UINTMAX }
 180 #define TBL_COL_HEXUINT_FMT(_name, _width, _fmt)        { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_UINT }
 181 #define TBL_COL_BOOL_FMT(_name, _width, _fmt)           { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_BOOL }
 182
 183 #define TBL_COL_END { .name = 0, .width = 0, .fmt = 0, .type = COL_TYPE_LAST }
 184
 185 #define TBL_COLUMNS  .columns = (struct table_column [])
 186 #define TBL_COL_ORDER(order) .column_order = (int *) order, .cols_to_output = ARRAY_SIZE(order)
 187 #define TBL_COL_DELIMITER(_delimiter_) .col_delimiter = _delimiter_
 188 #define TBL_APPEND_DELIMITER(_delimiter_) .append_delimiter = _delimiter_
 189
 190 #define TBL_OUTPUT_HUMAN_READABLE     .formatter = &table_fmt_human_readable
 191 #define TBL_OUTPUT_BLOCKLINE          .formatter = &table_fmt_blockline
 192 #define TBL_OUTPUT_MACHINE_READABLE   .formatter = &table_fmt_machine_readable
 193
 194 /**
 195  * Initialize a table definition. The structure should already contain
 196  * the definitions of columns.
 197  **/
 198 void table_init(struct table *tbl);
 199
 200 /** Destroy a table definition, freeing all memory used by it. **/
 201 void table_cleanup(struct table *tbl);
 202
 203 /**
 204  * Start printing of a table. This is a prerequisite to setting of column values.
 205  * After @table_start() is called, it is no longer possible to change parameters
 206  * of the table by `table_set_`'something' nor by direct access to the table structure.
 207  **/
 208 void table_start(struct table *tbl, struct fastbuf *out);
 209
 210 /**
 211  * This function must be called after all the rows of the current table are printed,
 212  * making the table structure ready for the next table. You can call `table_set_`'something'
 213  * between @table_end() and @table_start().
 214  **/
 215 void table_end(struct table *tbl);
 216
 217 /***
 218  * Filling tables with data
 219  * ------------------------
 220  *
 221  * For each column type, there are functions for filling of cells
 222  * of the particular type:
 223  *
 224  *   * `table_col_`'type'`(table, idx, value)` sets the cell in column `idx`
 225  *     to the `value`
 226  *   * `table_col_`'type'`_fmt(table, idx, fmt, ...)` does the same with
 227  *     a custom printf-like format string
 228  *   * `table_col_`'type'`_name(table, name, value)` refers to the column
 229  *     by its name instead of its index.
 230  *   * `table_append_`'type'`(table, value)` appends a value to the most
 231  *     recently accessed cell.
 232  ***/
 233
 234 #define TABLE_COL_PROTO(_name_, _type_) void table_col_##_name_(struct table *tbl, int col, _type_ val);\
 235   void table_col_##_name_##_name(struct table *tbl, const char *col_name, _type_ val);\
 236   void table_col_##_name_##_fmt(struct table *tbl, int col, const char *fmt, _type_ val) FORMAT_CHECK(printf, 3, 0);
 237
 238 // table_col_<type>_fmt has one disadvantage: it is not possible to
 239 // check whether fmt contains format that contains formatting that is
 240 // compatible with _type_
 241
 242 TABLE_COL_PROTO(int, int);
 243 TABLE_COL_PROTO(uint, uint);
 244 TABLE_COL_PROTO(double, double);
 245 TABLE_COL_PROTO(str, const char *);
 246 TABLE_COL_PROTO(intmax, intmax_t);
 247 TABLE_COL_PROTO(uintmax, uintmax_t);
 248 TABLE_COL_PROTO(s64, s64);
 249 TABLE_COL_PROTO(u64, u64);
 250
 251 void table_col_bool(struct table *tbl, int col, uint val);
 252 void table_col_bool_name(struct table *tbl, const char *col_name, uint val);
 253 void table_col_bool_fmt(struct table *tbl, int col, const char *fmt, uint val);
 254 #undef TABLE_COL_PROTO
 255
 256 #define TABLE_APPEND_PROTO(_name_, _type_) void table_append_##_name_(struct table *tbl, _type_ val)
 257 TABLE_APPEND_PROTO(int, int);
 258 TABLE_APPEND_PROTO(uint, uint);
 259 TABLE_APPEND_PROTO(double, double);
 260 TABLE_APPEND_PROTO(str, const char *);
 261 TABLE_APPEND_PROTO(intmax, intmax_t);
 262 TABLE_APPEND_PROTO(uintmax, uintmax_t);
 263 TABLE_APPEND_PROTO(s64, s64);
 264 TABLE_APPEND_PROTO(u64, u64);
 265 void table_append_bool(struct table *tbl, int val);
 266 #undef TABLE_APPEND_PROTO
 267
 268 /**
 269  * Set a particular cell of the current row to a string formatted
 270  * by sprintf(). This function can set a column of an arbitrary type.
 271  **/
 272 void table_col_printf(struct table *tbl, int col, const char *fmt, ...) FORMAT_CHECK(printf, 3, 4);
 273
 274 /**
 275  * Append a string formatted by sprintf() to the most recently filled cell.
 276  * This function can work with columns of an arbitrary type.
 277  **/
 278 void table_append_printf(struct table *tbl, const char *fmt, ...) FORMAT_CHECK(printf, 2, 3);
 279
 280 /**
 281  * Alternatively, a string cell can be constructed as a stream.
 282  * This function creates a fastbuf stream connected to the contents
 283  * of the particular cell. Before you close the stream by @table_col_fbend(),
 284  * no other operations with cells are allowed.
 285  **/
 286 struct fastbuf *table_col_fbstart(struct table *tbl, int col);
 287
 288 /**
 289  * Close the stream that is used for printing of the current column.
 290  **/
 291 void table_col_fbend(struct table *tbl);
 292
 293 /**
 294  * Called when all cells of the current row have their values filled in.
 295  * It sends the completed row to the output stream.
 296  **/
 297 void table_end_row(struct table *tbl);
 298
 299 /**
 300  * Resets data in current row.
 301  **/
 302 void table_reset_row(struct table *tbl);
 303
 304 /***
 305  * Configuration functions
 306  * -----------------------
 307  ***/
 308
 309 /**
 310  * Find the index of a column with name @col_name. Returns -1 if there is no such column.
 311  **/
 312 int table_get_col_idx(struct table *tbl, const char *col_name);
 313
 314 /**
 315  * Returns a comma-and-space-separated list of column names, allocated from table's internal
 316  * memory pool.
 317  **/
 318 const char *table_get_col_list(struct table *tbl);
 319
 320 /**
 321  * Sets the order in which the columns are printed. The @col_order parameter is used until @table_end() or
 322  * @table_cleanup() is called. The table stores only the pointer and the memory pointed to by @col_order is
 323  * allocated and deallocated by the caller.
 324  **/
 325 void table_set_col_order(struct table *tbl, int *col_order, int col_order_size);
 326
 327 /**
 328  * Returns 1 if col_idx will be printed, 0 otherwise.
 329  **/
 330 bool table_col_is_printed(struct table *tbl, uint col_idx);
 331
 332 /**
 333  * Sets the order in which the columns are printed. The specification is a string with comma-separated column
 334  * names. Returns NULL for success and an error message otherwise. The string is not referenced after
 335  * this function returns.
 336  **/
 337 const char *table_set_col_order_by_name(struct table *tbl, const char *col_order);
 338
 339 /**
 340  * Sets table formatter. See below for the list of formatters.
 341  **/
 342 void table_set_formatter(struct table *tbl, struct table_formatter *fmt);
 343
 344 /**
 345  * Set a table option. All options have a key and a value. Currently,
 346  * the following keys are defined (other keys can be accepted by formatters):
 347  *
 348  * [options="header"]
 349  * |===================================================================================================
 350  * | key        | value                         | meaning
 351  * | `header`   | 0 or 1                        | set whether a table header should be printed
 352  * | `noheader` | 'none'                        | equivalent to `header`=0
 353  * | `cols`     | comma-separated column list   | set order of columns
 354  * | `fmt`      | `human`/`machine`/`block`     | set table formatter to one of the built-in formatters
 355  * | `col-delim`| string                        | set column delimiter
 356  * |===================================================================================================
 357  **/
 358 const char *table_set_option_value(struct table *tbl, const char *key, const char *value);
 359
 360 /**
 361  * Sets a table option given as 'key'`:`'value' or 'key' (with no value).
 362  **/
 363 const char *table_set_option(struct table *tbl, const char *opt);
 364
 365 /**
 366  * Sets several table option in 'key'`:`'value' form, stored in a growing array.
 367  * This is frequently used for options given on the command line.
 368  **/
 369 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts);
 370
 371 /***
 372  * Formatters
 373  * ----------
 374  *
 375  * Transformation of abstract cell data to the characters in the output stream
 376  * is under control of a formatter (which serves as a back-end of the table printer).
 377  * There are several built-in formatters, but you can define your own.
 378  *
 379  * A formatter is described by a structure, which contains pointers to several
 380  * call-back functions, which are called by the table printer at specific occasions.
 381  *
 382  * The formatter can keep its internal state in the `data` field of `struct table`
 383  * and allocate temporary data from the table's memory pool. Memory allocated in
 384  * the `row_output` call-back is freed before the next row begins. Memory allocated
 385  * between the beginning of `table_start` and the end of `table_end` is freed after
 386  * `table_end`. Memory allocated by `process_option` when no table is started
 387  * is kept until @table_cleanup().
 388  ***/
 389
 390 /** Definition of a formatter back-end. **/
 391 struct table_formatter {
 392   void (*row_output)(struct table *tbl);        // [*] Function that outputs one row
 393   void (*table_start)(struct table *tbl);       // [*] table_start callback (optional)
 394   void (*table_end)(struct table *tbl);         // [*] table_end callback (optional)
 395   bool (*process_option)(struct table *tbl, const char *key, const char *value, const char **err);
 396         // [*] Process table option and possibly return an error message (optional)
 397 };
 398
 399 /** Standard formatter for human-readable output. **/
 400 extern struct table_formatter table_fmt_human_readable;
 401
 402 /** Standard formatter for machine-readable output (tab-separated values). **/
 403 extern struct table_formatter table_fmt_machine_readable;
 404
 405 /**
 406  * Standard formatter for block output. Each cell is output on its own line
 407  * of the form `column_name: value`. Rows are separated by blank lines.
 408  **/
 409 extern struct table_formatter table_fmt_blockline;
 410
 411 #endif