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 <ucw/fastbuf.h>
  11 #include <ucw/mempool.h>
  12 #include <ucw/xtypes.h>
  13
  14 // FIXME: update these macros
  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 // FIXME: update documentation according to the changes made in recent commits!
  79
  80 /** Types of columns. These are seldom used explicitly, using a column definition macro is preferred. **/
  81
  82 #define COL_TYPE_STR      &xt_str
  83 #define COL_TYPE_INT      &xt_int
  84 #define COL_TYPE_S64      &xt_s64
  85 #define COL_TYPE_INTMAX   &xt_intmax
  86 #define COL_TYPE_UINT     &xt_uint
  87 #define COL_TYPE_U64      &xt_u64
  88 #define COL_TYPE_UINTMAX  &xt_uintmax
  89 #define COL_TYPE_BOOL     &xt_bool
  90 #define COL_TYPE_DOUBLE   &xt_double
  91 #define COL_TYPE_ANY      NULL
  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 struct table;
 102
 103 /**
 104  * Definition of a single table column.
 105  * Usually, this is generated using the `TABLE_COL_`'type' macros.
 106  * Fields marked with `[*]` are user-accessible.
 107  **/
 108 struct table_column {
 109   const char *name;             // [*] Name of the column displayed in table header
 110   int width;                    // [*] Width of the column (in characters) OR'ed with column flags
 111   enum xtype_fmt fmt;
 112   const struct xtype *type_def;
 113
 114   bool (*set_col_instance_option)(struct table *tbl, uint col, const char *value, char **err);
 115        // [*] process table option for a column instance
 116 };
 117
 118 // FIXME: is it correct to have idx and col_def? idx is sufficient and in fact a duplicity of idx
 119 // idx is used only for initialization and col_def is used in other cases
 120 struct table_col_instance {
 121   uint idx;                            // idx is a index into struct table::columns
 122   const struct table_column *col_def;  // this is pointer to the column definition, located in the array struct table::columns
 123   const char *cell_content;            // content of the cell of the current row
 124   int next_column;                     // index of next column in linked list of columns of the same type
 125   enum xtype_fmt output_type;          // format of this column
 126 };
 127
 128 /**
 129  * Definition of a table. Contains column definitions, and some per-table settings.
 130  * Please use only fields marked with `[*]`.
 131  **/
 132 struct table_template {
 133   const struct table_column *columns;       // [*] Definition of columns
 134   struct table_col_instance *column_order;  // [*] Order of the columns in the print-out of the table
 135   uint cols_to_output;                      // [*] Number of columns that are printed
 136   const char *col_delimiter;                // [*] Delimiter that is placed between columns
 137   // Back-end used for table formatting and its private data
 138   struct table_formatter *formatter;
 139 };
 140
 141 /**
 142  * Handle of a table. Contains column definitions, per-table settings
 143  * and internal data. To change the table definition, please use only
 144  * fields marked with `[*]`.
 145  **/
 146 struct table {
 147   const struct table_column *columns;   // [*] Definition of columns
 148   int column_count;                     // [*] Number of columns (calculated by table_init())
 149   int *ll_headers;                      // headers of linked lists that connects column instances
 150   struct mempool *pool;                 // Memory pool used for storing table data. Contains global state
 151                                         // and data of the current row.
 152   struct mempool_state pool_state;      // State of the pool after the table is initialized, i.e., before
 153                                         // per-row data have been allocated.
 154
 155   struct table_col_instance *column_order;  // [*] Order of the columns in the print-out of the table
 156   uint cols_to_output;                  // [*] Number of columns that are printed
 157   const char *col_delimiter;            // [*] Delimiter that is placed between columns
 158   uint print_header;                    // [*] 0 indicates that table header should not be printed
 159
 160   struct fastbuf *out;                  // [*] Fastbuffer to which the table is printed
 161   int last_printed_col;                 // Index of the last column which was set. -1 indicates start of row.
 162                                         // Used for example for appending to the current column.
 163   int row_printing_started;             // Indicates that a row has been started. Duplicates last_printed_col, but harmlessly.
 164   struct fbpool fb_col_out;             // Per-cell fastbuf, see table_col_fbstart()
 165   int col_out;                          // Index of the column that is currently printed using fb_col_out
 166
 167   // Back-end used for table formatting and its private data
 168   struct table_formatter *formatter;
 169   void *data;
 170 };
 171
 172 /****
 173  * In most cases, table descriptions are constructed using the following macros.
 174  * See the examples above for more details.
 175  *
 176  *  * `TBL_COLUMNS` indicates the start of definition of columns
 177  *  * `TBL_COL_`'type'`(name, width)` defines a column of a given type
 178  *  * `TBL_COL_`'type'`_FMT(name, width, fmt)` defines a column with a custom format string
 179  *  * `TBL_COL_END` ends the column definitions
 180  *  * `TBL_COL_ORDER` specifies custom ordering of columns in the output
 181  *  * `TBL_COL_DELIMITER` and `TBL_APPEND_DELIMITER` override default delimiters
 182  *  * `TBL_OUTPUT_HUMAN_READABLE` requests human-readable formatting (this is the default)
 183  *  * `TBL_OUTPUT_MACHINE_READABLE` requests machine-readable TSV output
 184  *  * `TBL_OUTPUT_BLOCKLINE` requests block formatting (each cell printed a pair of a key and value on its own line)
 185  *
 186  ***/
 187
 188 #define TBL_COL_STR(_name, _width)            { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_STR }
 189 #define TBL_COL_INT(_name, _width)            { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_INT }
 190 #define TBL_COL_S64(_name, _width)            { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_S64 }
 191 #define TBL_COL_UINT(_name, _width)           { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_UINT }
 192 #define TBL_COL_U64(_name, _width)            { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_U64 }
 193 #define TBL_COL_INTMAX(_name, _width)         { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_INTMAX }
 194 #define TBL_COL_UINTMAX(_name, _width)        { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_UINTMAX }
 195 #define TBL_COL_HEXUINT(_name, _width)        { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_UINT }
 196 #define TBL_COL_DOUBLE(_name, _width)         { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_DOUBLE }
 197 #define TBL_COL_BOOL(_name, _width)           { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_BOOL }
 198 #define TBL_COL_ANY(_name, _width)            { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_ANY }
 199 #define TBL_COL_CUSTOM(_name, _width, _xtype) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = _xtype }
 200
 201 #define TBL_COL_STR_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_STR }
 202 #define TBL_COL_INT_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_INT }
 203 #define TBL_COL_S64_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_S64 }
 204 #define TBL_COL_UINT_FMT(_name, _width, _fmt)           { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_UINT }
 205 #define TBL_COL_U64_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_U64 }
 206 #define TBL_COL_INTMAX_FMT(_name, _width, _fmt)         { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_INTMAX }
 207 #define TBL_COL_UINTMAX_FMT(_name, _width, _fmt)        { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_UINTMAX }
 208 #define TBL_COL_HEXUINT_FMT(_name, _width, _fmt)        { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_UINT }
 209 #define TBL_COL_BOOL_FMT(_name, _width, _fmt)           { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_BOOL }
 210 #define TBL_COL_ANY_FMT(_name, _width, _fmt)            { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_ANY }
 211 #define TBL_COL_DOUBLE_FMT(_name, _width, _fmt)         { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_DOUBLE }
 212
 213 #define TBL_COL_END { .name = 0, .width = 0, .fmt = 0, .type_def = NULL }
 214
 215 #define TBL_COLUMNS  .columns = (struct table_column [])
 216 #define TBL_COL_ORDER(order) .column_order = (struct table_col_instance *) order, .cols_to_output = ARRAY_SIZE(order)
 217 #define TBL_COL_DELIMITER(_delimiter_) .col_delimiter = _delimiter_
 218 #define TBL_COL(_idx) { .idx = _idx, .output_type = XTYPE_FMT_DEFAULT, .next_column = -1 }
 219 #define TBL_COL_FMT(_idx, _fmt) { .idx = _idx, .output_type = _fmt, .next_column = -1 }
 220 #define TBL_COL_TYPE(_idx, _type) { .idx = _idx, .output_type = _type, .next_column = -1 }
 221
 222 #define TBL_OUTPUT_HUMAN_READABLE     .formatter = &table_fmt_human_readable
 223 #define TBL_OUTPUT_BLOCKLINE          .formatter = &table_fmt_blockline
 224 #define TBL_OUTPUT_MACHINE_READABLE   .formatter = &table_fmt_machine_readable
 225
 226 #define TBL_COL_ITER_START(_tbl, _colidx, _var, _idxval) { struct table_col_instance *_var = NULL; int _idxval = _tbl->ll_headers[_colidx]; \
 227   for(_idxval = _tbl->ll_headers[_colidx], _var = _tbl->column_order + _idxval; _idxval != -1; _idxval = _tbl->column_order[_idxval].next_column, _var = _tbl->column_order + _idxval)
 228
 229 #define TBL_COL_ITER_END }
 230
 231 /**
 232  * Creates a new table from a table template. The template should already contain
 233  * the definitions of columns.
 234  **/
 235 struct table *table_init(const struct table_template *tbl_template);
 236
 237 /** Destroy a table definition, freeing all memory used by it. **/
 238 void table_cleanup(struct table *tbl);
 239
 240 /**
 241  * Start printing of a table. This is a prerequisite to setting of column values.
 242  * After @table_start() is called, it is no longer possible to change parameters
 243  * of the table by `table_set_`'something' nor by direct access to the table structure.
 244  **/
 245 void table_start(struct table *tbl, struct fastbuf *out);
 246
 247 /**
 248  * This function must be called after all the rows of the current table are printed,
 249  * making the table structure ready for the next table. You can call `table_set_`'something'
 250  * between @table_end() and @table_start().
 251  **/
 252 void table_end(struct table *tbl);
 253
 254 /***
 255  * Filling tables with data
 256  * ------------------------
 257  *
 258  * For each column type, there are functions for filling of cells
 259  * of the particular type:
 260  *
 261  *   * `table_col_`'type'`(table, idx, value)` sets the cell in column `idx`
 262  *     to the `value`
 263  *   * `table_col_`'type'`_fmt(table, idx, fmt, ...)` does the same with
 264  *     a custom printf-like format string
 265  *   * `table_col_`'type'`_name(table, name, value)` refers to the column
 266  *     by its name instead of its index.
 267  *   * `table_append_`'type'`(table, value)` appends a value to the most
 268  *     recently accessed cell.
 269  ***/
 270
 271
 272 #define TABLE_COL_PROTO(_name_, _type_) void table_col_##_name_(struct table *tbl, int col, _type_ val);
 273
 274 // table_col_<type>_fmt has one disadvantage: it is not possible to
 275 // check whether fmt contains format that contains formatting that is
 276 // compatible with _type_
 277
 278 TABLE_COL_PROTO(int, int)
 279 TABLE_COL_PROTO(uint, uint)
 280 TABLE_COL_PROTO(double, double)
 281 TABLE_COL_PROTO(intmax, intmax_t)
 282 TABLE_COL_PROTO(uintmax, uintmax_t)
 283 TABLE_COL_PROTO(s64, s64)
 284 TABLE_COL_PROTO(u64, u64)
 285 TABLE_COL_PROTO(bool, bool)
 286
 287 void table_col_str(struct table *tbl, int col, const char * val);
 288
 289 /** macros that enables easy definitions of bodies of table_col_<something> functions **/
 290
 291 #define TABLE_COL_BODY(_name_, _type_) void table_col_##_name_(struct table *tbl, int col, _type_ val) {\
 292     table_col_generic_format(tbl, col, (void*)&val, &xt_##_name_);\
 293   }
 294
 295 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type);
 296
 297 /**
 298  * Set a particular cell of the current row to a string formatted
 299  * by sprintf(). This function can set a column of an arbitrary type.
 300  **/
 301 void table_col_printf(struct table *tbl, int col, const char *fmt, ...) FORMAT_CHECK(printf, 3, 4);
 302
 303 /**
 304  * Alternatively, a string cell can be constructed as a stream.
 305  * This function creates a fastbuf stream connected to the contents
 306  * of the particular cell. Before you close the stream by @table_col_fbend(),
 307  * no other operations with cells are allowed.
 308  **/
 309 struct fastbuf *table_col_fbstart(struct table *tbl, int col);
 310
 311 /**
 312  * Close the stream that is used for printing of the current column.
 313  **/
 314 void table_col_fbend(struct table *tbl);
 315
 316 /**
 317  * Called when all cells of the current row have their values filled in.
 318  * It sends the completed row to the output stream.
 319  **/
 320 void table_end_row(struct table *tbl);
 321
 322 /**
 323  * Resets data in current row.
 324  **/
 325 void table_reset_row(struct table *tbl);
 326
 327 /***
 328  * Configuration functions
 329  * -----------------------
 330  ***/
 331
 332 /**
 333  * Find the index of a column with name @col_name. Returns -1 if there is no such column.
 334  **/
 335 int table_get_col_idx(struct table *tbl, const char *col_name);
 336
 337
 338 /**
 339  * Sets a string argument to a column instance
 340  **/
 341 bool table_set_col_opt_default(struct table *tbl, int col_idx, const char *col_arg, char ** err);
 342
 343 /**
 344  * Returns a comma-and-space-separated list of column names, allocated from table's internal
 345  * memory pool.
 346  **/
 347 const char *table_get_col_list(struct table *tbl);
 348
 349 /**
 350  * Sets the order in which the columns are printed. The @col_order parameter is used until @table_end() or
 351  * @table_cleanup() is called. The table stores only the pointer and the memory pointed to by @col_order is
 352  * allocated and deallocated by the caller.
 353  **/
 354 void table_set_col_order(struct table *tbl, int *col_order, int col_order_size);
 355
 356 /**
 357  * Returns 1 if col_idx will be printed, 0 otherwise.
 358  **/
 359 bool table_col_is_printed(struct table *tbl, uint col_idx);
 360
 361 /**
 362  * Sets the order in which the columns are printed. The specification is a string with comma-separated column
 363  * names. Returns NULL for success and an error message otherwise. The string is not referenced after
 364  * this function returns.
 365  *
 366  * The format of the col_order string is the following:
 367  * <col-order-string> := <col-def>[,<col-def>]*
 368  *
 369  * <col-def> := <col-name> '[' <col-opt> ']'
 370  *
 371  * <col-name> is a string that does not contain comma ',' or '[',']' brackets
 372  *
 373  * <col-opt> is currently only one string.
 374  *
 375  * FIXME In the future, we should allow <col-opt> to be a comma(,) separated list of identifiers
 376  **/
 377 const char *table_set_col_order_by_name(struct table *tbl, const char *col_order);
 378
 379 /**
 380  * Sets table formatter. See below for the list of formatters.
 381  **/
 382 void table_set_formatter(struct table *tbl, struct table_formatter *fmt);
 383
 384 /**
 385  * Set a table option. All options have a key and a value. Currently,
 386  * the following keys are defined (other keys can be accepted by formatters):
 387  *
 388  * [options="header"]
 389  * |===================================================================================================
 390  * | key        | value                         | meaning
 391  * | `header`   | 0 or 1                        | set whether a table header should be printed
 392  * | `noheader` | 'none'                        | equivalent to `header`=0
 393  * | `cols`     | comma-separated column list   | set order of columns
 394  * | `fmt`      | `human`/`machine`/`block`     | set table formatter to one of the built-in formatters
 395  * | `col-delim`| string                        | set column delimiter
 396  * |===================================================================================================
 397  **/
 398 const char *table_set_option_value(struct table *tbl, const char *key, const char *value);
 399
 400 /**
 401  * Sets a table option given as 'key'`:`'value' or 'key' (with no value).
 402  **/
 403 const char *table_set_option(struct table *tbl, const char *opt);
 404
 405 /**
 406  * Sets several table option in 'key'`:`'value' form, stored in a growing array.
 407  * This is frequently used for options given on the command line.
 408  **/
 409 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts);
 410
 411 /***
 412  * Formatters
 413  * ----------
 414  *
 415  * Transformation of abstract cell data to the characters in the output stream
 416  * is under control of a formatter (which serves as a back-end of the table printer).
 417  * There are several built-in formatters, but you can define your own.
 418  *
 419  * A formatter is described by a structure, which contains pointers to several
 420  * call-back functions, which are called by the table printer at specific occasions.
 421  *
 422  * The formatter can keep its internal state in the `data` field of `struct table`
 423  * and allocate temporary data from the table's memory pool. Memory allocated in
 424  * the `row_output` call-back is freed before the next row begins. Memory allocated
 425  * between the beginning of `table_start` and the end of `table_end` is freed after
 426  * `table_end`. Memory allocated by `process_option` when no table is started
 427  * is kept until @table_cleanup().
 428  ***/
 429
 430 /** Definition of a formatter back-end. **/
 431 struct table_formatter {
 432   void (*row_output)(struct table *tbl);        // [*] Function that outputs one row
 433   void (*table_start)(struct table *tbl);       // [*] table_start callback (optional)
 434   void (*table_end)(struct table *tbl);         // [*] table_end callback (optional)
 435   bool (*process_option)(struct table *tbl, const char *key, const char *value, const char **err);
 436         // [*] Process table option and possibly return an error message (optional)
 437 };
 438
 439 /** Standard formatter for human-readable output. **/
 440 extern struct table_formatter table_fmt_human_readable;
 441
 442 /** Standard formatter for machine-readable output (tab-separated values). **/
 443 extern struct table_formatter table_fmt_machine_readable;
 444
 445 /**
 446  * Standard formatter for block output. Each cell is output on its own line
 447  * of the form `column_name: value`. Rows are separated by blank lines.
 448  **/
 449 extern struct table_formatter table_fmt_blockline;
 450
 451 #endif