2 * UCW Library -- Table printer
4 * (c) 2014 Robert Kessl <robert.kessl@economia.cz>
12 #include <ucw/fastbuf.h>
13 #include <ucw/mempool.h>
14 #include <ucw/xtypes.h>
16 #ifdef CONFIG_UCW_CLEAN_ABI
17 #define table_cleanup ucw_table_cleanup
18 #define table_col_bool ucw_table_col_bool
19 #define table_col_double ucw_table_col_double
20 #define table_col_fbend ucw_table_col_fbend
21 #define table_col_fbstart ucw_table_col_fbstart
22 #define table_col_generic_format ucw_table_col_generic_format
23 #define table_col_int ucw_table_col_int
24 #define table_col_intmax ucw_table_col_intmax
25 #define table_col_is_printed ucw_table_col_is_printed
26 #define table_col_printf ucw_table_col_printf
27 #define table_col_s64 ucw_table_col_s64
28 #define table_col_str ucw_table_col_str
29 #define table_col_str ucw_table_col_str
30 #define table_col_u64 ucw_table_col_u64
31 #define table_col_uint ucw_table_col_uint
32 #define table_col_uintmax ucw_table_col_uintmax
33 #define table_end ucw_table_end
34 #define table_end_row ucw_table_end_row
35 #define table_fmt_blockline ucw_table_fmt_blockline
36 #define table_fmt_human_readable ucw_table_fmt_human_readable
37 #define table_fmt_machine_readable ucw_table_fmt_machine_readable
38 #define table_get_col_idx ucw_table_get_col_idx
39 #define table_get_col_list ucw_table_get_col_list
40 #define table_init ucw_table_init
41 #define table_reset_row ucw_table_reset_row
42 #define table_set_col_opt ucw_table_set_col_opt
43 #define table_set_col_order ucw_table_set_col_order
44 #define table_set_col_order_by_name ucw_table_set_col_order_by_name
45 #define table_set_formatter ucw_table_set_formatter
46 #define table_set_gary_options ucw_table_set_gary_options
47 #define table_set_option ucw_table_set_option
48 #define table_set_option_value ucw_table_set_option_value
49 #define table_start ucw_table_start
57 // FIXME: update documentation according to the changes made in recent commits!
59 /** The COL_TYPE_ANY macro specifies a column type which can be filled with arbitrary type. **/
61 #define COL_TYPE_ANY NULL
63 /** Justify cell contents to the left. **/
64 #define CELL_ALIGN_LEFT (1U << 31)
66 // CELL_FLAG_MASK has 1's in bits used for column flags,
67 // CELL_WIDTH_MASK has 1's in bits used for column width.
68 #define CELL_FLAG_MASK (CELL_ALIGN_LEFT)
69 #define CELL_WIDTH_MASK (~CELL_FLAG_MASK)
74 * Definition of a single table column.
75 * Usually, this is generated using the `TABLE_COL_`'type' macros.
76 * Fields marked with `[*]` are user-accessible.
79 const char *name; // [*] Name of the column displayed in table header
80 uint width; // [*] Width of the column (in characters) OR'ed with column flags
81 uint fmt; // [*] default format of the column
82 const struct xtype *type_def; // [*] pointer to xtype of this column
84 const char * (*set_col_opt)(struct table *tbl, uint col, const char *value);
85 // [*] process table option for a column instance
88 // FIXME: is it correct to have idx and col_def? idx is sufficient and in fact a duplicity of idx
89 // idx is used only for initialization and col_def is used in other cases
90 struct table_col_instance {
91 uint idx; // idx is a index into struct table::columns
92 const struct table_column *col_def; // this is pointer to the column definition, located in the array struct table::columns
93 const char *cell_content; // content of the cell of the current row
94 int next_column; // index of next column in linked list of columns of the same type
95 uint fmt; // format of this column
99 * Definition of a table. Contains column definitions, and some per-table settings.
100 * Please use only fields marked with `[*]`.
102 struct table_template {
103 const struct table_column *columns; // [*] Definition of columns
104 struct table_col_instance *column_order; // [*] Order of the columns in the print-out of the table
105 uint cols_to_output; // [*] Number of columns that are printed
106 const char *col_delimiter; // [*] Delimiter that is placed between columns
107 // Back-end used for table formatting and its private data
108 const struct table_formatter *formatter; // FIXME: should be const?
112 * Handle of a table. Contains column definitions, per-table settings
113 * and internal data. To change the table definition, please use only
114 * fields marked with `[*]`.
117 const struct table_column *columns; // [*] Definition of columns
118 int column_count; // [*] Number of columns (calculated by table_init())
119 int *ll_headers; // headers of linked lists that connects column instances
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.
125 struct table_col_instance *column_order; // [*] Order of the columns in the print-out of the table
126 uint cols_to_output; // [*] Number of columns that are printed
127 const char *col_delimiter; // [*] Delimiter that is placed between columns
128 bool print_header; // [*] false indicates that table header should not be printed
130 struct fastbuf *out; // [*] Fastbuffer to which the table is printed
131 int last_printed_col; // Index of the last column which was set. -1 indicates start of row.
132 // Used for example for appending to the current column.
133 bool row_printing_started; // Indicates that a row has been started. Duplicates last_printed_col, but harmlessly.
134 struct fbpool fb_col_out; // Per-cell fastbuf, see table_col_fbstart()
135 int col_out; // Index of the column that is currently printed using fb_col_out
137 // Back-end used for table formatting and its private data
138 const struct table_formatter *formatter;
139 void *formatter_data;
143 * In most cases, table descriptions are constructed using the following macros.
144 * See the examples above for more details.
146 * * `TBL_COLUMNS` indicates the start of definition of columns
147 * * `TBL_COL_`'type'`(name, width)` defines a column of a given type
148 * * `TBL_COL_`'type'`_FMT(name, width, fmt)` defines a column with a custom format string
149 * * `TBL_COL_END` ends the column definitions
150 * * `TBL_COL_ORDER` specifies custom ordering of columns in the output
151 * * `TBL_COL_DELIMITER` and `TBL_APPEND_DELIMITER` override default delimiters
152 * * `TBL_FMT_HUMAN_READABLE` requests human-readable formatting (this is the default)
153 * * `TBL_FMT_MACHINE_READABLE` requests machine-readable TSV output
154 * * `TBL_FMT_BLOCKLINE` requests block formatting (each cell printed a pair of a key and value on its own line)
158 #define TBL_COL_STR(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_str }
159 #define TBL_COL_INT(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_int }
160 #define TBL_COL_S64(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_s64 }
161 #define TBL_COL_UINT(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_uint }
162 #define TBL_COL_U64(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_u64 }
163 #define TBL_COL_INTMAX(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_intmax }
164 #define TBL_COL_UINTMAX(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_uintmax }
165 #define TBL_COL_HEXUINT(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_uint }
166 #define TBL_COL_DOUBLE(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_double }
167 #define TBL_COL_BOOL(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_bool }
168 #define TBL_COL_ANY(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_ANY }
169 #define TBL_COL_XTYPE(_name, _width, _xtype) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = _xtype }
171 #define TBL_COL_STR_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_str }
172 #define TBL_COL_INT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_int }
173 #define TBL_COL_S64_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_s64 }
174 #define TBL_COL_UINT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_uint }
175 #define TBL_COL_U64_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_u64 }
176 #define TBL_COL_INTMAX_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_intmax }
177 #define TBL_COL_UINTMAX_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_uintmax }
178 #define TBL_COL_HEXUINT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_uint }
179 #define TBL_COL_BOOL_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_bool }
180 #define TBL_COL_ANY_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = COL_TYPE_ANY }
181 #define TBL_COL_DOUBLE_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_double }
183 #define TBL_COL_END { .name = 0, .width = 0, .fmt = 0, .type_def = NULL }
185 #define TBL_COLUMNS .columns = (struct table_column [])
186 #define TBL_COL_ORDER(order) .column_order = (struct table_col_instance *) order, .cols_to_output = ARRAY_SIZE(order)
187 #define TBL_COL_DELIMITER(_delimiter) .col_delimiter = _delimiter
190 * These macros are used for definition of column order
192 #define TBL_COL(_idx) { .idx = _idx, .fmt = XTYPE_FMT_DEFAULT, .next_column = -1 }
193 #define TBL_COL_FMT(_idx, _fmt) { .idx = _idx, .fmt = _fmt, .next_column = -1 }
196 * These macros are aliases to various kinds of table formats.
198 #define TBL_FMT_HUMAN_READABLE .formatter = &table_fmt_human_readable
199 #define TBL_FMT_BLOCKLINE .formatter = &table_fmt_blockline
200 #define TBL_FMT_MACHINE_READABLE .formatter = &table_fmt_machine_readable
203 * The TBL_COL_ITER_START macro are used for iterating over all instances of a particular column in
204 * table _tbl. _colidx is the column index in _tbl, _instptr is the pointer to the column instance
205 * (struct table_col_instance *), _idxval is the index of current column index. The variables are
206 * enclosed in a block, so they do not introduce variable name collisions.
208 * The TBL_COL_ITER_END macro must close the block started with TBL_COL_ITER_START.
210 * These macros are usually used to hide the implementation details of the column instances linked
211 * list. This is usefull for definition of new types.
213 #define TBL_COL_ITER_START(_tbl, _colidx, _instptr, _idxval) { struct table_col_instance *_instptr = NULL; int _idxval = _tbl->ll_headers[_colidx]; \
214 for(_idxval = _tbl->ll_headers[_colidx], _instptr = _tbl->column_order + _idxval; _idxval != -1; _idxval = _tbl->column_order[_idxval].next_column, _instptr = _tbl->column_order + _idxval)
216 #define TBL_COL_ITER_END }
219 * Creates a new table from a table template. The template should already contain
220 * the definitions of columns.
222 struct table *table_init(const struct table_template *tbl_template);
224 /** Destroy a table instance, freeing all memory used by it. **/
225 void table_cleanup(struct table *tbl);
228 * Start printing of a table. This is a prerequisite to setting of column values.
229 * After @table_start() is called, it is no longer possible to change parameters
230 * of the table by `table_set_`'something' nor by direct access to the table structure.
232 void table_start(struct table *tbl, struct fastbuf *out);
235 * This function must be called after all the rows of the current table are printed,
236 * making the table structure ready for the next table. You can call `table_set_`'something'
237 * between @table_end() and @table_start().
239 void table_end(struct table *tbl);
242 * Filling tables with data
243 * ------------------------
245 * For each column type, there are functions for filling of cells
246 * of the particular type:
248 * * `table_col_`'type'`(table, idx, value)` sets the cell in column `idx`
253 #define TABLE_COL_PROTO(_name, _type) void table_col_##_name(struct table *tbl, int col, _type val);
255 TABLE_COL_PROTO(int, int)
256 TABLE_COL_PROTO(uint, uint)
257 TABLE_COL_PROTO(double, double)
258 TABLE_COL_PROTO(intmax, intmax_t)
259 TABLE_COL_PROTO(uintmax, uintmax_t)
260 TABLE_COL_PROTO(s64, s64)
261 TABLE_COL_PROTO(u64, u64)
262 TABLE_COL_PROTO(bool, bool)
264 void table_col_str(struct table *tbl, int col, const char * val);
266 /** TABLE_COL_BODY macro enables easy definitions of bodies of table_col_<something> functions **/
267 #define TABLE_COL_BODY(_name, _type) void table_col_##_name(struct table *tbl, int col, _type val) {\
268 table_col_generic_format(tbl, col, (void*)&val, &xt_##_name);\
272 * The table_col_generic_format performs all the checks necessary while filling cell with value,
273 * calls the format function from expected_type and stores its result as a cell value. The function
274 * guarantees that each column instance is printed with its format.
276 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type);
279 * Set a particular cell of the current row to a string formatted
280 * by sprintf(). This function can set a column of an arbitrary type.
282 void table_col_printf(struct table *tbl, int col, const char *fmt, ...) FORMAT_CHECK(printf, 3, 4);
285 * Alternatively, a string cell can be constructed as a stream.
286 * This function creates a fastbuf stream connected to the contents
287 * of the particular cell. Before you close the stream by @table_col_fbend(),
288 * no other operations with cells are allowed.
290 struct fastbuf *table_col_fbstart(struct table *tbl, int col);
293 * Close the stream that is used for printing of the current column.
295 void table_col_fbend(struct table *tbl);
298 * Called when all cells of the current row have their values filled in.
299 * It sends the completed row to the output stream.
301 void table_end_row(struct table *tbl);
304 * Resets data in the current row.
306 void table_reset_row(struct table *tbl);
309 * Configuration functions
310 * -----------------------
314 * Find the index of a column with name @col_name. Returns -1 if there is no such column.
316 int table_get_col_idx(struct table *tbl, const char *col_name);
320 * Sets a string option to an instance of a columnt type. This is the default version that checks
321 * whether the xtype::parse_fmt can be called and calls it. However, there are situation in which
322 * the xtype::parse_fmt is not sufficient, e.g., column decoration, post-processing, etc.
324 * Each struct table_column has a pointer to a customized version of table_set_col_opt which is
325 * called instead of this (default) version of table_set_col_opt
327 const char *table_set_col_opt(struct table *tbl, uint col_idx, const char *col_opt);
330 * Returns a comma-and-space-separated list of column names, allocated from table's internal
333 const char *table_get_col_list(struct table *tbl);
336 * Sets the order in which the columns are printed. The @col_order parameter is used until
337 * @table_end() or @table_cleanup() is called. The table converts the integers in @col_order into
338 * internal representation stored in @column_order. Options to column instances can be set using
339 * @table_set_col_opt.
341 void table_set_col_order(struct table *tbl, int *col_order, int col_order_size);
344 * Returns true if col_idx will be printed, false otherwise.
346 bool table_col_is_printed(struct table *tbl, uint col_idx);
349 * Sets the order in which the columns are printed. The specification is a string with comma-separated column
350 * names. Returns NULL for success and an error message otherwise. The string is not referenced after
351 * this function returns.
353 * The format of the col_order string is the following:
354 * <col-order-string> := <col-def>[,<col-def>]*
356 * <col-def> := <col-name> '[' <col-opt> ']'
358 * <col-name> is a string that does not contain comma ',' or '[',']' brackets
360 * <col-opt> is currently only one string without commas. In the future the format can be <str1>,<str2>,... .
362 * FIXME In the future, we should allow <col-opt> to be a comma(,) separated list of identifiers
364 const char *table_set_col_order_by_name(struct table *tbl, const char *col_order);
367 * Sets table formatter. See below for the list of formatters.
369 void table_set_formatter(struct table *tbl, const struct table_formatter *fmt);
372 * Set a table option. All options have a key and a value. Currently,
373 * the following keys are defined (other keys can be accepted by formatters):
376 * |===================================================================================================
377 * | key | value | meaning
378 * | `header` | 0 or 1 | set whether a table header should be printed
379 * | `noheader` | 'none' | equivalent to `header`=0
380 * | `cols` | comma-separated column list | set order of columns
381 * | `fmt` | `human`/`machine`/`block` | set table formatter to one of the built-in formatters
382 * | `col-delim`| string | set column delimiter
383 * | `cells` | string | set column format mode
384 * |===================================================================================================
386 const char *table_set_option_value(struct table *tbl, const char *key, const char *value);
389 * Sets a table option given as 'key'`:`'value' or 'key' (with no value).
391 const char *table_set_option(struct table *tbl, const char *opt);
394 * Sets several table option in 'key'`:`'value' form, stored in a growing array.
395 * This is frequently used for options given on the command line.
397 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts);
403 * Transformation of abstract cell data to the characters in the output stream
404 * is under control of a formatter (which serves as a back-end of the table printer).
405 * There are several built-in formatters, but you can define your own.
407 * A formatter is described by a structure, which contains pointers to several
408 * call-back functions, which are called by the table printer at specific occasions.
410 * The formatter can keep its internal state in the `data` field of `struct table`
411 * and allocate temporary data from the table's memory pool. Memory allocated in
412 * the `row_output` call-back is freed before the next row begins. Memory allocated
413 * between the beginning of `table_start` and the end of `table_end` is freed after
414 * `table_end`. Memory allocated by `process_option` when no table is started
415 * is kept until @table_cleanup().
418 /** Definition of a formatter back-end. **/
419 struct table_formatter {
420 void (*row_output)(struct table *tbl); // [*] Function that outputs one row
421 void (*table_start)(struct table *tbl); // [*] table_start callback (optional)
422 void (*table_end)(struct table *tbl); // [*] table_end callback (optional)
423 bool (*process_option)(struct table *tbl, const char *key, const char *value, const char **err);
424 // [*] Process table option and possibly return an error message (optional)
427 /** Standard formatter for human-readable output. **/
428 extern const struct table_formatter table_fmt_human_readable;
430 /** Standard formatter for machine-readable output (tab-separated values). **/
431 extern const struct table_formatter table_fmt_machine_readable;
434 * Standard formatter for block output. Each cell is output on its own line
435 * of the form `column_name: value`. Rows are separated by blank lines.
437 extern const struct table_formatter table_fmt_blockline;