2 * UCW Library -- Table printer
4 * (c) 2014 Robert Kessl <robert.kessl@economia.cz>
10 #include <ucw/fastbuf.h>
11 #include <ucw/mempool.h>
25 #define TBL_COL_STR(_name, _width) { .name = _name, .width = _width, .fmt = "%s", .type = COL_TYPE_STR }
26 #define TBL_COL_INT(_name, _width) { .name = _name, .width = _width, .fmt = "%d", .type = COL_TYPE_INT }
27 #define TBL_COL_UINT(_name, _width) { .name = _name, .width = _width, .fmt = "%u", .type = COL_TYPE_UINT }
28 #define TBL_COL_INTMAX(_name, _width) { .name = _name, .width = _width, .fmt = "%jd", .type = COL_TYPE_INTMAX }
29 #define TBL_COL_UINTMAX(_name, _width) { .name = _name, .width = _width, .fmt = "%ju", .type = COL_TYPE_UINTMAX }
30 #define TBL_COL_HEXUINT(_name, _width) { .name = _name, .width = _width, .fmt = "0x%x", .type = COL_TYPE_UINT }
31 #define TBL_COL_DOUBLE(_name, _width, _prec) { .name = _name, .width = _width, .fmt = "%." #_prec "lf", .type = COL_TYPE_DOUBLE }
32 #define TBL_COL_BOOL(_name, _width) { .name = _name, .width = _width, .fmt = "%s", .type = COL_TYPE_BOOL }
33 #define TBL_COL_ANY(_name, _width) { .name = _name, .width = _width, .fmt = 0, .type = COL_TYPE_ANY }
35 #define TBL_COL_STR_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_STR }
36 #define TBL_COL_INT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_INT }
37 #define TBL_COL_UINT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_UINT }
38 #define TBL_COL_INTMAX_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_INTMAX }
39 #define TBL_COL_UINTMAX_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_UINTMAX }
40 #define TBL_COL_HEXUINT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_UINT }
41 #define TBL_COL_BOOL_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type = COL_TYPE_BOOL }
43 #define TBL_COL_END { .name = 0, .width = 0, .fmt = 0, .type = COL_TYPE_LAST }
45 #define TBL_COLUMNS .columns = (struct table_column [])
46 #define TBL_COL_ORDER(order) .column_order = (int *) order, .cols_to_output = ARRAY_SIZE(order)
47 #define TBL_COL_DELIMITER(_delimiter_) .col_delimiter = _delimiter_
48 #define TBL_APPEND_DELIMITER(_delimiter_) .append_delimiter = _delimiter_
50 #define TBL_OUTPUT_HUMAN_READABLE .formatter = &table_fmt_human_readable
51 #define TBL_OUTPUT_MACHINE_READABLE .formatter = &table_fmt_machine_readable
55 * The table works as follows:
56 * The table can be used after table_init is called. Then at the beginning of each printing, the
57 * table_start function must be called. After printing, the table_end must be called. The
58 * table_start MUST be paired with table_end. Inbetween table_start/table_end the user can set the
59 * cells of one row and one row is finished and printed using table_end_row. The pairs
60 * table_start/table_end can be used multiple-times for one table. The table is deallocated using
61 * table_cleanup. After table_cleanup is called it is not possible to further use the struct table.
62 * The struct table must be reinitialized.
64 * Default behaviour of the table_set_col_* is replacement of already set data. To append, the user
65 * must use table_append_*
68 * 1) @table_init is called;
69 * 2) @table_start is called following by table_set_xxx functions and @table_end.
70 * table_start/table_end forms 1-level parenthesis structure. Some of the table
71 * settings can be changed only between table_init and @table_start or after table_end
72 * is called (but before next table_start.
73 * 3) the table is deallocated using @table_cleanup. After the cleanup
74 * is done, the struct table is unusable and must be initialized.
77 * An example of the procedure is following sequence of calls:
87 * The tableprinter supports user-specified callback for each row and table-print (i.e., a callback
88 * that is called in table_end).
90 * The table is initialized by defining a table struct using the following macros:
91 * o TBL_START_COLUMNS indicates start of definition of columns
92 * o TBL_COL_XXX macros specify the column types with some default formatting the column is specified using a column
93 * name (which should be C identifier) and a prefix. the column name is the a string with the column
94 * name. The prefix is used for discriminating between columns from different tables. The column index
95 * should be taken from an enum. The enum identifier is prefix concatenated with the column name identifier.
96 * o TBL_COL_XXX_F macros specify column types with user supplied formatting
97 * o TBL_COL_END indicates end of column definitions
98 * o TBL_COL_ORDER specify the column order
99 * o TBL_COL_DELIMITER specify the in-between cell delimiter
101 * The table cells have strict type control, with the exception of type TBL_COL_ANY. In the case of
102 * TBL_COL_ANY, the type is not tested and an arbitrary value can be printed into the cell.
103 * It is also possible to print string to an arbitrary cell.
106 * * user supplied callback functions can be used for modifying the output format.
108 * Non-tested features:
109 * * computing statistics of columns via the table_start_callback/table_end_callback.
110 * TODO: is it better to have callback for each cell with the original value supplied by the caller of the table_set_* functions?
112 * * unsupported: (dynamic) alignment of cells which is computed in table_end
114 * TODO: table_set_col_fmt: this functin takes the format string and the value. But I'm not able to
115 * test whether the format string and the type match !!!
117 * TODO: Return value of the parser should be a string allocated on the mempool of the table. But:
118 * is the return value really necessary? The error should be show to the user on the terminal
120 * TODO: all macros prefix TBL_ should be changed to TABLE_ ?
121 * TODO: how to print column which is aligned to the left flag for alignment: 1) left; 2) right;
122 * 3) decimal point alignment; 4) arbitrary separator alignment
127 /** Specification of a single table column */
128 struct table_column {
129 const char *name; // [*] Name of the column displayed in table header
130 int width; // [*] Width of the column (in characters). Negative number indicates alignment to left.
131 // FIXME: Request left alignment by a flag.
132 const char *fmt; // [*] Default format of each cell in the column
133 enum column_type type; // Type of the cells in the column
136 /** The definition of a table. Contains column definitions plus internal data. */
138 struct table_column *columns; // [*] Definition of columns
139 int column_count; // [*] Number of columns (calculated by table_init())
140 struct mempool *pool; // Memory pool used for storing table data. Contains global state
141 // and data of the current row.
142 struct mempool_state pool_state; // State of the pool after the table is initialized, i.e., before
143 // per-row data have been allocated.
145 char **col_str_ptrs; // Values of cells in the current row (allocated from the pool)
147 uint *column_order; // [*] Order of the columns in the print-out of the table
148 uint cols_to_output; // [*] Number of columns that are printed
149 const char *col_delimiter; // [*] Delimiter that is placed between columns
150 const char *append_delimiter; // [*] Separator of multiple values in a single cell (see table_append_...())
151 uint print_header; // [*] 0 indicates that table header should not be printed
153 struct fastbuf *out; // Fastbuffer to which the table is printed
154 int last_printed_col; // Index of the last column which was set. -1 indicates start of row.
155 // Used for example for appending to the current column.
156 int row_printing_started; // Indicates that a row has been started. Duplicates last_printed_col, but harmlessly.
157 struct fbpool fb_col_out; // Per-cell fastbuf, see table_col_fbstart()
158 int col_out; // Index of the column that is currently printed using fb_col_out
160 // Back-end used for table formatting and its private data
161 struct table_formatter *formatter;
167 * table_init serves for initialization of the table. The @tbl parameter should have set the columns member of
168 * the table structure. The @out parameter is supplied by the caller and can be deallocated after table_deinit
171 * FIXME: Why the fastbuf is set there? It would make sense to pass it to table_start(), so that
172 * different instances of the table can be printed to different destinations. Also, the remark
173 * about deallocation does not make much sense, the fastbuf is definitely not copied, only
176 void table_init(struct table *tbl);
177 void table_cleanup(struct table *tbl);
180 * table_start is called before the cells of the table are set. After the table_start is called, the user can
181 * call the table_set_* functions. The table_end_row function can be called after the table_start is called
182 * (but before the table_end is called)
184 void table_start(struct table *tbl);
187 * This function must be called after all the rows of the current table are printed. The table_set_*
188 * functions can be called in between table_start and table_end calls.
190 void table_end(struct table *tbl);
193 * Sets the order in which the columns are printed. The @col_order parameter is used until the table_end or
194 * table_cleanup is called. The table stores the pointer only and the memory pointed to by @col_order is
195 * allocated and deallocated by the caller.
197 void table_col_order(struct table *tbl, int *col_order, int col_order_size);
200 * Sets the order in which the columns are printed. The specification is a string with comma-separated column
201 * names. Returns NULL for success and an error message otherwise.
203 const char * table_col_order_by_name(struct table *tbl, const char *col_order);
206 * Called when all the cells have filled values. The function the prints a table row into the output stream.
207 * The table row has newline at the end.
209 void table_end_row(struct table *tbl);
212 * Prints a string that is printf-like formated into a particular column. This function does not check the
213 * type of the column, i.e., it can be used to print double into an int column
215 void table_set_printf(struct table *tbl, int col, const char *fmt, ...) FORMAT_CHECK(printf, 3, 4);
218 * Appends a string that is printf-like formated to the last printed column. This function does not check the
219 * type of the column, i.e., it can be used to print double into an int column.
221 void table_append_printf(struct table *tbl, const char *fmt, ...) FORMAT_CHECK(printf, 2, 3);
224 * Find the index of a column with name @col_name and returns it. Returns -1 if the column was not found.
226 int table_get_col_idx(struct table *tbl, const char *col_name);
229 * Returns comma-and-space-separated list of column names, allocated from table's internal
232 const char * table_get_col_list(struct table *tbl);
235 * Opens a fastbuf stream that can be used for creating a cell content. The @sz parameter is the initial size
236 * allocated on the memory pool.
238 struct fastbuf *table_col_fbstart(struct table *tbl, int col);
239 // FIXME: test table_col_fbstart/table_col_fbend
242 * Closes the stream that is used for printing of the last column.
244 void table_col_fbend(struct table *tbl);
247 * Sets table formatter for @tbl.
249 void table_set_formatter(struct table *tbl, struct table_formatter *fmt);
251 /** Definition of a formatter back-end. **/
252 struct table_formatter {
253 void (*row_output)(struct table *tbl); // [*] Function that outputs one row
254 void (*table_start)(struct table *tbl); // [*] table_start callback (optional)
255 void (*table_end)(struct table *tbl); // [*] table_end callback (optional)
256 bool (*process_option)(struct table *tbl, const char *key, const char *value, const char **err);
257 // [*] Process table option and possibly return an error message (optional)
260 // Standard formatters
261 extern struct table_formatter table_fmt_human_readable;
262 extern struct table_formatter table_fmt_machine_readable;
265 * Process the table one option and sets the values in @tbl according to the command-line parameters.
266 * The option has the following format: a) "<key>:<value>"; b) "<key>" (currently not used).
268 * Possible key-value pairs:
269 * header:[0|1] - 1 indicates that the header should be printed, 0 otherwise
270 * noheader - equivalent to header:0
271 * cols:<string-with-col-names> - comma-separated list of columns that will be printed (in the order specified on the cmd-line)
272 * fmt:[human|machine|...] - output type
273 * col-delim:<char> - column delimiter
275 * Returns NULL on success or an error string otherwise.
277 const char *table_set_option(struct table *tbl, const char *opt);
278 const char *table_set_option_value(struct table *tbl, const char *key, const char *value);
279 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts);
281 #define TABLE_SET_COL_PROTO(_name_, _type_) void table_set_##_name_(struct table *tbl, int col, _type_ val);\
282 void table_set_##_name_##_name(struct table *tbl, const char *col_name, _type_ val);\
283 void table_set_##_name_##_fmt(struct table *tbl, int col, const char *fmt, _type_ val) FORMAT_CHECK(printf, 3, 0);
285 // table_set_<type>_fmt has one disadvantage: it is not possible to
286 // check whether fmt contains format that contains formatting that is
287 // compatible with _type_
289 TABLE_SET_COL_PROTO(int, int);
290 TABLE_SET_COL_PROTO(uint, uint);
291 TABLE_SET_COL_PROTO(double, double);
292 TABLE_SET_COL_PROTO(str, const char *);
293 TABLE_SET_COL_PROTO(intmax, intmax_t);
294 TABLE_SET_COL_PROTO(uintmax, uintmax_t);
296 void table_set_bool(struct table *tbl, int col, uint val);
297 void table_set_bool_name(struct table *tbl, const char *col_name, uint val);
298 void table_set_bool_fmt(struct table *tbl, int col, const char *fmt, uint val);
299 #undef TABLE_SET_COL_PROTO
301 #define TABLE_APPEND_PROTO(_name_, _type_) void table_append_##_name_(struct table *tbl, _type_ val)
302 TABLE_APPEND_PROTO(int, int);
303 TABLE_APPEND_PROTO(uint, uint);
304 TABLE_APPEND_PROTO(double, double);
305 TABLE_APPEND_PROTO(str, const char *);
306 TABLE_APPEND_PROTO(intmax, intmax_t);
307 TABLE_APPEND_PROTO(uintmax, uintmax_t);
308 void table_append_bool(struct table *tbl, int val);
309 #undef TABLE_APPEND_PROTO