2 * UCW Library -- Table printer
4 * (c) 2014 Robert Kessl <robert.kessl@economia.cz>
8 #include <ucw/string.h>
9 #include <ucw/stkstring.h>
11 #include <ucw/table.h>
12 #include <ucw/strtonum.h>
17 /* Forward declarations */
19 static void table_update_ll(struct table *tbl);
21 /*** Management of tables ***/
23 static struct table *table_make_instance(const struct table_template *tbl_template)
25 struct mempool *pool = mp_new(4096);
26 struct table *new_inst = mp_alloc_zero(pool, sizeof(struct table));
28 new_inst->pool = pool;
30 // initialize column definitions
31 uint col_count = 0; // count the number of columns in the struct table
33 if(tbl_template->columns[col_count].name == NULL &&
34 tbl_template->columns[col_count].width == 0 &&
35 tbl_template->columns[col_count].type_def == COL_TYPE_ANY)
37 ASSERT(tbl_template->columns[col_count].name != NULL);
38 ASSERT(tbl_template->columns[col_count].width != 0);
42 new_inst->column_count = col_count;
44 new_inst->columns = tbl_template->columns;
45 new_inst->ll_headers = mp_alloc(new_inst->pool, sizeof(int) * col_count);
46 for(uint i = 0; i < col_count; i++) {
47 new_inst->ll_headers[i] = -1;
50 // initialize column_order
51 if(tbl_template->column_order) {
52 new_inst->column_order = mp_alloc_zero(new_inst->pool, sizeof(struct table_col_instance) * tbl_template->cols_to_output);
53 memcpy(new_inst->column_order, tbl_template->column_order, sizeof(struct table_col_instance) * tbl_template->cols_to_output);
54 for(uint i = 0; i < new_inst->cols_to_output; i++) {
55 new_inst->column_order[i].cell_content = NULL;
56 int col_idx = new_inst->column_order[i].idx;
57 new_inst->column_order[i].col_def = new_inst->columns + col_idx;
58 new_inst->column_order[i].fmt = tbl_template->columns[col_idx].fmt;
61 new_inst->cols_to_output = tbl_template->cols_to_output;
64 new_inst->col_delimiter = tbl_template->col_delimiter;
65 new_inst->print_header = true;
67 new_inst->last_printed_col = -1;
68 new_inst->row_printing_started = false;
69 new_inst->col_out = -1;
70 new_inst->formatter = tbl_template->formatter;
71 new_inst->data = NULL;
75 struct table *table_init(const struct table_template *tbl_template)
77 struct table *tbl = table_make_instance(tbl_template);
80 tbl->formatter = &table_fmt_human_readable;
83 tbl->print_header = true; // by default, print header
87 void table_cleanup(struct table *tbl)
92 // TODO: test default column order
93 static void table_make_default_column_order(struct table *tbl)
95 int *col_order_int = mp_alloc_zero(tbl->pool, sizeof(int) * tbl->column_count); // FIXME: use stack instead of memory pool
96 for(int i = 0; i < tbl->column_count; i++) {
99 table_set_col_order(tbl, col_order_int, tbl->column_count);
102 void table_start(struct table *tbl, struct fastbuf *out)
104 tbl->last_printed_col = -1;
105 tbl->row_printing_started = false;
108 ASSERT_MSG(tbl->out, "Output fastbuf not specified.");
110 if(tbl->column_order == NULL) table_make_default_column_order(tbl);
112 // update linked lists
113 table_update_ll(tbl);
115 if(tbl->formatter->table_start != NULL) tbl->formatter->table_start(tbl);
117 mp_save(tbl->pool, &tbl->pool_state);
119 ASSERT_MSG(tbl->col_delimiter, "In-between column delimiter not specified.");
122 void table_end(struct table *tbl)
124 tbl->last_printed_col = -1;
125 tbl->row_printing_started = false;
127 mp_restore(tbl->pool, &tbl->pool_state);
129 if(tbl->formatter->table_end) tbl->formatter->table_end(tbl);
132 /*** Configuration ***/
134 void table_set_formatter(struct table *tbl, const struct table_formatter *fmt)
136 tbl->formatter = fmt;
139 int table_get_col_idx(struct table *tbl, const char *col_name)
141 for(int i = 0; i < tbl->column_count; i++) {
142 if(strcmp(tbl->columns[i].name, col_name) == 0) return i;
147 const char * table_get_col_list(struct table *tbl)
149 if(tbl->column_count == 0) return "";
151 char *tmp = mp_strdup(tbl->pool, tbl->columns[0].name);
153 for(int i = 1; i < tbl->column_count; i++) {
154 tmp = mp_printf_append(tbl->pool, tmp, ", %s", tbl->columns[i].name);
160 static void table_update_ll(struct table *tbl)
162 int cols_to_output = tbl->cols_to_output;
164 for(int i = 0; i < tbl->column_count; i++) {
165 tbl->ll_headers[i] = -1;
168 for(int i = 0; i < cols_to_output; i++) {
169 int idx = tbl->column_order[i].idx;
170 tbl->column_order[i].col_def = tbl->columns + idx;
173 for(int i = 0; i < cols_to_output; i++) {
174 int col_def_idx = tbl->column_order[i].idx;
175 int first = tbl->ll_headers[col_def_idx];
176 tbl->ll_headers[col_def_idx] = i;
177 tbl->column_order[i].next_column = first;
181 void table_set_col_order(struct table *tbl, int *col_order, int cols_to_output)
183 for(int i = 0; i < cols_to_output; i++) {
184 ASSERT_MSG(col_order[i] >= 0 && col_order[i] < tbl->column_count, "Column %d does not exist (column number should be between 0 and %d).", col_order[i], tbl->column_count - 1);
187 tbl->cols_to_output = cols_to_output;
188 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * cols_to_output);
189 for(int i = 0; i < cols_to_output; i++) {
190 int col_idx = col_order[i];
191 tbl->column_order[i].idx = col_idx;
192 tbl->column_order[i].col_def = tbl->columns + col_idx;
193 tbl->column_order[i].cell_content = NULL;
194 tbl->column_order[i].fmt = tbl->columns[col_idx].fmt;
196 table_update_ll(tbl);
199 bool table_col_is_printed(struct table *tbl, uint col_idx)
201 if(tbl->ll_headers[col_idx] == -1) return 0;
206 static char * table_parse_col_arg(char *col_def)
208 // FIXME: should be switched to str_sepsplit
209 char * left_br = strchr(col_def, '[');
210 if(left_br == NULL) return NULL;
213 char *right_br = strchr(left_br, ']');
218 const char *table_set_col_opt(struct table *tbl, uint col_idx, const char *col_opt)
220 const struct table_column *col_def = tbl->column_order[col_idx].col_def;
221 if(col_def && col_def->set_col_opt && col_def->set_col_opt != table_set_col_opt) {
222 return col_def->set_col_opt(tbl, col_idx, col_opt);
225 if(col_def && col_def->type_def && col_def->type_def->parse_fmt) {
227 const char *tmp_err = col_def->type_def->parse_fmt(col_opt, &fmt, tbl->pool);
228 if(tmp_err) return tmp_err;
229 tbl->column_order[col_idx].fmt = fmt;
233 return mp_printf(tbl->pool, "Invalid column format option: '%s' for column %d.", col_opt, col_idx);
237 * TODO: This function deliberately leaks memory. When it is called multiple times,
238 * previous column orders still remain allocated in the table's memory pool.
240 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
242 if(col_order_str[0] == '*') {
243 table_make_default_column_order(tbl);
247 if(!col_order_str[0]) {
248 tbl->column_order = mp_alloc(tbl->pool, 0);
249 tbl->cols_to_output = 0;
253 char *tmp_col_order = stk_strdup(col_order_str);
256 for(int i = 0; col_order_str[i] != 0; i++) {
257 if(col_order_str[i] == ',') {
262 tbl->cols_to_output = col_count;
263 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
265 int curr_col_idx = 0;
266 char *name_start = tmp_col_order;
268 char *next = strchr(name_start, ',');
273 char *arg = table_parse_col_arg(name_start); // this sets 0 on the '['
274 int col_idx = table_get_col_idx(tbl, name_start);
277 return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
279 tbl->column_order[curr_col_idx].col_def = tbl->columns + col_idx;
280 tbl->column_order[curr_col_idx].idx = col_idx;
281 tbl->column_order[curr_col_idx].fmt = tbl->columns[col_idx].fmt;
282 if(tbl->columns[col_idx].type_def && tbl->columns[col_idx].set_col_opt) {
283 const char *err = NULL;
284 err = tbl->columns[col_idx].set_col_opt(tbl, curr_col_idx, arg);
285 if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
292 table_update_ll(tbl);
297 /*** Table cells ***/
299 static void table_set_all_inst_content(struct table *tbl, int col_templ, const char *col_content)
301 TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
302 curr_col_ptr->cell_content = col_content;
306 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type)
308 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
309 ASSERT(tbl->columns[col].type_def == COL_TYPE_ANY || expected_type == tbl->columns[col].type_def);
310 tbl->last_printed_col = col;
311 tbl->row_printing_started = true;
312 TBL_COL_ITER_START(tbl, col, curr_col, curr_col_idx) {
313 enum xtype_fmt fmt = curr_col->fmt;
314 curr_col->cell_content = expected_type->format(value, fmt, tbl->pool);
318 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
320 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
321 tbl->last_printed_col = col;
322 tbl->row_printing_started = true;
325 char *cell_content = mp_vprintf(tbl->pool, fmt, args);
326 table_set_all_inst_content(tbl, col, cell_content);
330 TABLE_COL_BODY(int, int)
331 TABLE_COL_BODY(uint, uint)
332 TABLE_COL_BODY(double, double)
333 TABLE_COL_BODY(intmax, intmax_t)
334 TABLE_COL_BODY(uintmax, uintmax_t)
335 TABLE_COL_BODY(s64, s64)
336 TABLE_COL_BODY(u64, u64)
337 TABLE_COL_BODY(bool, bool)
338 TABLE_COL_BODY(str, const char *)
340 void table_reset_row(struct table *tbl)
342 for(uint i = 0; i < tbl->cols_to_output; i++) {
343 tbl->column_order[i].cell_content = NULL;
345 mp_restore(tbl->pool, &tbl->pool_state);
346 tbl->last_printed_col = -1;
347 tbl->row_printing_started = false;
350 void table_end_row(struct table *tbl)
352 ASSERT(tbl->formatter->row_output);
353 if(tbl->row_printing_started == false) return;
354 tbl->formatter->row_output(tbl);
355 table_reset_row(tbl);
358 /* Construction of a cell using a fastbuf */
360 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
362 fbpool_init(&tbl->fb_col_out);
363 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
365 return &tbl->fb_col_out.fb;
368 void table_col_fbend(struct table *tbl)
370 char *cell_content = fbpool_end(&tbl->fb_col_out);
371 table_set_all_inst_content(tbl, tbl->col_out, cell_content);
375 /*** Option parsing ***/
377 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
379 // Options with no value
380 if(value == NULL || (value != NULL && strlen(value) == 0)) {
381 if(strcmp(key, "noheader") == 0) {
382 tbl->print_header = false;
387 // Options with a value
389 if(strcmp(key, "header") == 0) {
391 const char *err = xt_bool.parse(value, &tmp, tbl->pool);
393 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
395 tbl->print_header = tmp;
398 } else if(strcmp(key, "cols") == 0) {
399 return table_set_col_order_by_name(tbl, value);
400 } else if(strcmp(key, "fmt") == 0) {
401 if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
402 else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
403 else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
405 return "Invalid argument to output-type option.";
408 } else if(strcmp(key, "cells") == 0) {
410 const char *err = xtype_parse_fmt(NULL, value, &fmt, tbl->pool);
411 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
412 for(uint i = 0; i < tbl->cols_to_output; i++) {
413 tbl->column_order[i].fmt = fmt;
416 } else if(strcmp(key, "raw") == 0 || strcmp(key, "pretty") == 0) {
418 const char *err = xtype_parse_fmt(NULL, key, &fmt, tbl->pool);
419 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
420 for(uint i = 0; i < tbl->cols_to_output; i++) {
421 tbl->column_order[i].fmt = fmt;
424 } else if(strcmp(key, "col-delim") == 0) {
425 char * d = mp_printf(tbl->pool, "%s", value);
426 tbl->col_delimiter = d;
432 if(tbl->formatter && tbl->formatter->process_option) {
433 const char *err = NULL;
434 if(tbl->formatter->process_option(tbl, key, value, &err)) {
439 // Unrecognized option
440 return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
443 const char *table_set_option(struct table *tbl, const char *opt)
445 char *key = stk_strdup(opt);
446 char *value = strchr(key, ':');
450 return table_set_option_value(tbl, key, value);
453 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
455 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
456 const char *rv = table_set_option(tbl, gary_table_opts[i]);
464 /*** Default formatter for human-readable output ***/
466 static void table_row_human_readable(struct table *tbl)
468 for(uint i = 0; i < tbl->cols_to_output; i++) {
469 const struct table_column *col_def = tbl->column_order[i].col_def;
471 bputs(tbl->out, tbl->col_delimiter);
473 int col_width = col_def->width & CELL_WIDTH_MASK;
474 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
475 bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
477 bputc(tbl->out, '\n');
480 static void table_write_header(struct table *tbl)
482 for(uint i = 0; i < tbl->cols_to_output; i++) {
483 const struct table_column *col_def = tbl->column_order[i].col_def;
485 bputs(tbl->out, tbl->col_delimiter);
487 int col_width = col_def->width & CELL_WIDTH_MASK;
488 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
489 bprintf(tbl->out, "%*s", col_width, col_def->name);
491 bputc(tbl->out, '\n');
494 static void table_start_human_readable(struct table *tbl)
496 if(tbl->col_delimiter == NULL) {
497 tbl->col_delimiter = " ";
500 if(tbl->print_header != false) {
501 table_write_header(tbl);
505 const struct table_formatter table_fmt_human_readable = {
506 .row_output = table_row_human_readable,
507 .table_start = table_start_human_readable,
510 /*** Default formatter for machine-readable output ***/
512 static void table_row_machine_readable(struct table *tbl)
514 for(uint i = 0; i < tbl->cols_to_output; i++) {
516 bputs(tbl->out, tbl->col_delimiter);
518 bputs(tbl->out, tbl->column_order[i].cell_content);
520 bputc(tbl->out, '\n');
523 static void table_start_machine_readable(struct table *tbl)
525 if(tbl->col_delimiter == NULL) {
526 tbl->col_delimiter = "\t";
529 if(tbl->print_header != false && tbl->cols_to_output > 0) {
530 bputs(tbl->out, tbl->column_order[0].col_def->name);
531 for(uint i = 1; i < tbl->cols_to_output; i++) {
532 bputs(tbl->out, tbl->col_delimiter);
533 bputs(tbl->out, tbl->column_order[i].col_def->name);
535 bputc(tbl->out, '\n');
539 const struct table_formatter table_fmt_machine_readable = {
540 .row_output = table_row_machine_readable,
541 .table_start = table_start_machine_readable,
545 /*** Blockline formatter ***/
547 static void table_row_blockline_output(struct table *tbl)
549 for(uint i = 0; i < tbl->cols_to_output; i++) {
550 const struct table_column *col_def = tbl->column_order[i].col_def;
551 bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
553 bputc(tbl->out, '\n');
556 static void table_start_blockline(struct table *tbl)
558 if(tbl->col_delimiter == NULL) {
559 tbl->col_delimiter = "\n";
563 const struct table_formatter table_fmt_blockline = {
564 .row_output = table_row_blockline_output,
565 .table_start = table_start_blockline
574 enum test_table_cols {
575 TEST_COL0_STR, TEST_COL1_INT, TEST_COL2_UINT, TEST_COL3_BOOL, TEST_COL4_DOUBLE
578 static struct table_col_instance test_column_order[] = { TBL_COL(TEST_COL3_BOOL), TBL_COL(TEST_COL4_DOUBLE), TBL_COL(TEST_COL2_UINT), TBL_COL(TEST_COL1_INT), TBL_COL(TEST_COL0_STR) };
580 static struct table_template test_tbl = {
582 [TEST_COL0_STR] = TBL_COL_STR("col0_str", 20),
583 [TEST_COL1_INT] = TBL_COL_INT("col1_int", 8),
584 [TEST_COL2_UINT] = TBL_COL_UINT("col2_uint", 9),
585 [TEST_COL3_BOOL] = TBL_COL_BOOL_FMT("col3_bool", 9, XTYPE_FMT_PRETTY),
586 [TEST_COL4_DOUBLE] = TBL_COL_DOUBLE("col4_double", 11),
589 TBL_COL_ORDER(test_column_order),
590 TBL_FMT_HUMAN_READABLE,
591 TBL_COL_DELIMITER("\t"),
595 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
597 static void do_print1(struct table *test_tbl)
599 table_col_str(test_tbl, TEST_COL0_STR, "sdsdf");
600 table_col_int(test_tbl, TEST_COL1_INT, -10);
601 table_col_int(test_tbl, TEST_COL1_INT, 10000);
602 table_col_uint(test_tbl, TEST_COL2_UINT, 10);
603 table_col_printf(test_tbl, TEST_COL2_UINT, "XXX-%u", 22222);
604 table_col_bool(test_tbl, TEST_COL3_BOOL, true);
605 table_col_double(test_tbl, TEST_COL4_DOUBLE, 1.5);
606 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "AAA");
607 table_end_row(test_tbl);
609 table_col_str(test_tbl, TEST_COL0_STR, "test");
610 table_col_int(test_tbl, TEST_COL1_INT, -100);
611 table_col_uint(test_tbl, TEST_COL2_UINT, 100);
612 table_col_bool(test_tbl, TEST_COL3_BOOL, false);
613 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "%.2lf", 1.5);
614 table_end_row(test_tbl);
617 static void test_simple1(struct fastbuf *out)
619 struct table *tbl = table_init(&test_tbl);
621 // print table with header
622 table_set_col_order_by_name(tbl, "col3_bool");
623 table_start(tbl, out);
627 // print the same table as in the previous case without header
628 table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
629 table_start(tbl, out);
633 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
634 tbl->print_header = false;
635 table_start(tbl, out);
638 tbl->print_header = true;
640 table_set_col_order_by_name(tbl, "col3_bool");
641 table_start(tbl, out);
645 table_set_col_order_by_name(tbl, "col3_bool,col0_str");
646 table_start(tbl, out);
650 table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
651 table_start(tbl, out);
655 table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint,col0_str,col3_bool,col2_uint,col0_str,col3_bool,col2_uint");
656 table_start(tbl, out);
660 table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
661 table_start(tbl, out);
668 enum test_any_table_cols {
669 TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
672 static struct table_col_instance test_any_column_order[] = { TBL_COL(TEST_ANY_COL0_INT), TBL_COL_FMT(TEST_ANY_COL1_ANY, XTYPE_FMT_PRETTY) };
674 static struct table_template test_any_tbl = {
676 [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
677 [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
680 TBL_COL_ORDER(test_any_column_order),
681 TBL_FMT_HUMAN_READABLE,
682 TBL_COL_DELIMITER("\t"),
685 static void test_any_type(struct fastbuf *out)
687 struct table *tbl = table_init(&test_any_tbl);
689 table_start(tbl, out);
691 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
692 table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
695 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
696 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
699 table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
700 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
707 int main(int argc UNUSED, char **argv UNUSED)
710 out = bfdopen_shared(1, 4096);