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->row_printing_started = false;
68 new_inst->col_out = -1;
69 new_inst->formatter = tbl_template->formatter;
70 if(!new_inst->formatter) {
71 new_inst->formatter = &table_fmt_human_readable;
73 new_inst->formatter_data = NULL;
77 struct table *table_init(const struct table_template *tbl_template)
79 struct table *tbl = table_make_instance(tbl_template);
80 // FIXME: What remains of table_init()? Just combine it with table_make_instance()
86 void table_cleanup(struct table *tbl)
91 // TODO: test default column order
92 static void table_make_default_column_order(struct table *tbl)
94 int *col_order_int = alloca(sizeof(int) * tbl->column_count);
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->row_printing_started = false;
107 ASSERT_MSG(tbl->out, "Output fastbuf not specified.");
109 if(tbl->column_order == NULL) table_make_default_column_order(tbl);
111 // update linked lists
112 table_update_ll(tbl);
114 if(tbl->formatter->table_start != NULL) tbl->formatter->table_start(tbl);
116 mp_save(tbl->pool, &tbl->pool_state);
118 ASSERT_MSG(tbl->col_delimiter, "Column delimiter not specified.");
121 void table_end(struct table *tbl)
123 tbl->row_printing_started = false;
125 mp_restore(tbl->pool, &tbl->pool_state);
127 if(tbl->formatter->table_end) tbl->formatter->table_end(tbl);
130 /*** Configuration ***/
132 void table_set_formatter(struct table *tbl, const struct table_formatter *fmt)
134 tbl->formatter = fmt;
137 int table_get_col_idx(struct table *tbl, const char *col_name)
139 for(int i = 0; i < tbl->column_count; i++) {
140 if(strcmp(tbl->columns[i].name, col_name) == 0) return i;
145 const char * table_get_col_list(struct table *tbl)
147 if(tbl->column_count == 0) return "";
149 char *tmp = mp_strdup(tbl->pool, tbl->columns[0].name);
151 for(int i = 1; i < tbl->column_count; i++) {
152 tmp = mp_printf_append(tbl->pool, tmp, ", %s", tbl->columns[i].name);
158 static void table_update_ll(struct table *tbl)
160 int cols_to_output = tbl->cols_to_output;
162 for(int i = 0; i < tbl->column_count; i++) {
163 tbl->ll_headers[i] = -1;
166 for(int i = 0; i < cols_to_output; i++) {
167 int idx = tbl->column_order[i].idx;
168 tbl->column_order[i].col_def = tbl->columns + idx;
171 for(int i = 0; i < cols_to_output; i++) {
172 int col_def_idx = tbl->column_order[i].idx;
173 int first = tbl->ll_headers[col_def_idx];
174 tbl->ll_headers[col_def_idx] = i;
175 tbl->column_order[i].next_column = first;
179 void table_set_col_order(struct table *tbl, int *col_order, int cols_to_output)
181 for(int i = 0; i < cols_to_output; i++) {
182 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);
185 tbl->cols_to_output = cols_to_output;
186 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * cols_to_output);
187 for(int i = 0; i < cols_to_output; i++) {
188 int col_idx = col_order[i];
189 tbl->column_order[i].idx = col_idx;
190 tbl->column_order[i].col_def = tbl->columns + col_idx;
191 tbl->column_order[i].cell_content = NULL; // it is in fact initialized by mp_alloc_zero, but for completeness ...
192 tbl->column_order[i].next_column = -1;
193 tbl->column_order[i].fmt = tbl->columns[col_idx].fmt;
195 table_update_ll(tbl);
198 bool table_col_is_printed(struct table *tbl, uint col_idx)
200 if(tbl->ll_headers[col_idx] == -1) return 0;
205 static char * table_parse_col_arg(char *col_def)
207 // FIXME: should be switched to str_sepsplit
208 char * left_br = strchr(col_def, '[');
209 if(left_br == NULL) return NULL;
212 char *right_br = strchr(left_br, ']');
217 const char *table_set_col_opt(struct table *tbl, uint col_inst_idx, const char *col_opt)
219 const struct table_column *col_def = tbl->column_order[col_inst_idx].col_def;
221 // Make sure that we do not call table_set_col_opt, which would
222 // result in an infinite recursion.
223 if(col_def && col_def->set_col_opt) {
224 if(col_def->set_col_opt == table_set_col_opt) {
225 die("table_set_col_opt should not be used as a struct table_column::set_col_opt hook");
227 return col_def->set_col_opt(tbl, col_inst_idx, col_opt);
230 if(col_def && col_def->type_def && col_def->type_def->parse_fmt) {
232 const char *tmp_err = col_def->type_def->parse_fmt(col_opt, &fmt, tbl->pool);
233 if(tmp_err) return tmp_err;
234 tbl->column_order[col_inst_idx].fmt = fmt;
238 return mp_printf(tbl->pool, "Invalid column format option: '%s' for column %d.", col_opt, col_inst_idx);
242 * TODO: This function deliberately leaks memory. When it is called multiple times,
243 * previous column orders still remain allocated in the table's memory pool.
245 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
247 if(col_order_str[0] == '*') {
248 table_make_default_column_order(tbl);
252 if(!col_order_str[0]) {
253 tbl->column_order = mp_alloc(tbl->pool, 0);
254 tbl->cols_to_output = 0;
258 char *tmp_col_order = stk_strdup(col_order_str);
261 for(int i = 0; col_order_str[i] != 0; i++) {
262 if(col_order_str[i] == ',') {
267 tbl->cols_to_output = col_count;
268 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
270 int curr_col_idx = 0;
271 char *name_start = tmp_col_order;
273 char *next = strchr(name_start, ',');
278 char *arg = table_parse_col_arg(name_start); // this sets 0 on the '['
279 int col_idx = table_get_col_idx(tbl, name_start);
282 return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
284 tbl->column_order[curr_col_idx].col_def = tbl->columns + col_idx;
285 tbl->column_order[curr_col_idx].idx = col_idx;
286 tbl->column_order[curr_col_idx].fmt = tbl->columns[col_idx].fmt;
287 if(tbl->columns[col_idx].type_def && tbl->columns[col_idx].set_col_opt) {
288 const char *err = NULL;
289 err = tbl->columns[col_idx].set_col_opt(tbl, curr_col_idx, arg);
290 if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
297 table_update_ll(tbl);
302 /*** Table cells ***/
304 static void table_col_raw(struct table *tbl, int col_templ, const char *col_content)
306 TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
307 curr_col_ptr->cell_content = col_content;
311 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type)
313 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
314 ASSERT(tbl->columns[col].type_def == COL_TYPE_ANY || expected_type == tbl->columns[col].type_def);
315 tbl->row_printing_started = true;
316 TBL_COL_ITER_START(tbl, col, curr_col, curr_col_idx) {
317 enum xtype_fmt fmt = curr_col->fmt;
318 curr_col->cell_content = expected_type->format(value, fmt, tbl->pool);
322 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
324 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
325 tbl->row_printing_started = true;
328 char *cell_content = mp_vprintf(tbl->pool, fmt, args);
329 table_col_raw(tbl, col, cell_content);
333 TABLE_COL_BODY(int, int)
334 TABLE_COL_BODY(uint, uint)
335 TABLE_COL_BODY(double, double)
336 TABLE_COL_BODY(intmax, intmax_t)
337 TABLE_COL_BODY(uintmax, uintmax_t)
338 TABLE_COL_BODY(s64, s64)
339 TABLE_COL_BODY(u64, u64)
340 TABLE_COL_BODY(bool, bool)
341 TABLE_COL_BODY(str, const char *)
343 void table_reset_row(struct table *tbl)
345 for(uint i = 0; i < tbl->cols_to_output; i++) {
346 tbl->column_order[i].cell_content = NULL;
348 mp_restore(tbl->pool, &tbl->pool_state);
349 tbl->row_printing_started = false;
352 void table_end_row(struct table *tbl)
354 ASSERT(tbl->formatter->row_output);
355 if(tbl->row_printing_started == false) return;
356 tbl->formatter->row_output(tbl);
357 table_reset_row(tbl);
360 /* Construction of a cell using a fastbuf */
362 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
364 fbpool_init(&tbl->fb_col_out);
365 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
367 return &tbl->fb_col_out.fb;
370 void table_col_fbend(struct table *tbl)
372 char *cell_content = fbpool_end(&tbl->fb_col_out);
373 table_col_raw(tbl, tbl->col_out, cell_content);
377 /*** Option parsing ***/
379 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
381 // Options with no value
382 if(value == NULL || (value != NULL && strlen(value) == 0)) {
383 if(strcmp(key, "noheader") == 0) {
384 tbl->print_header = false;
389 // Options with a value
391 if(strcmp(key, "header") == 0) {
393 const char *err = xt_bool.parse(value, &tmp, tbl->pool);
395 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
397 tbl->print_header = tmp;
400 } else if(strcmp(key, "cols") == 0) {
401 return table_set_col_order_by_name(tbl, value);
402 } else if(strcmp(key, "fmt") == 0) {
403 if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
404 else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
405 else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
407 return "Invalid argument to output-type option.";
410 } else if(strcmp(key, "cells") == 0) {
412 const char *err = xtype_parse_fmt(NULL, value, &fmt, tbl->pool);
413 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
414 for(uint i = 0; i < tbl->cols_to_output; i++) {
415 tbl->column_order[i].fmt = fmt;
418 } else if(strcmp(key, "raw") == 0 || strcmp(key, "pretty") == 0) {
420 const char *err = xtype_parse_fmt(NULL, key, &fmt, tbl->pool);
421 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
422 for(uint i = 0; i < tbl->cols_to_output; i++) {
423 tbl->column_order[i].fmt = fmt;
426 } else if(strcmp(key, "col-delim") == 0) {
427 char * d = mp_printf(tbl->pool, "%s", value);
428 tbl->col_delimiter = d;
434 if(tbl->formatter && tbl->formatter->process_option) {
435 const char *err = NULL;
436 if(tbl->formatter->process_option(tbl, key, value, &err)) {
441 // Unrecognized option
442 return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
445 const char *table_set_option(struct table *tbl, const char *opt)
447 char *key = stk_strdup(opt);
448 char *value = strchr(key, ':');
452 return table_set_option_value(tbl, key, value);
455 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
457 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
458 const char *rv = table_set_option(tbl, gary_table_opts[i]);
466 /*** Default formatter for human-readable output ***/
468 static void table_row_human_readable(struct table *tbl)
470 for(uint i = 0; i < tbl->cols_to_output; i++) {
471 const struct table_column *col_def = tbl->column_order[i].col_def;
473 bputs(tbl->out, tbl->col_delimiter);
475 int col_width = col_def->width & CELL_WIDTH_MASK;
476 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
477 bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
479 bputc(tbl->out, '\n');
482 static void table_write_header(struct table *tbl)
484 for(uint i = 0; i < tbl->cols_to_output; i++) {
485 const struct table_column *col_def = tbl->column_order[i].col_def;
487 bputs(tbl->out, tbl->col_delimiter);
489 int col_width = col_def->width & CELL_WIDTH_MASK;
490 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
491 bprintf(tbl->out, "%*s", col_width, col_def->name);
493 bputc(tbl->out, '\n');
496 static void table_start_human_readable(struct table *tbl)
498 if(tbl->col_delimiter == NULL) {
499 tbl->col_delimiter = " ";
502 if(tbl->print_header != false) {
503 table_write_header(tbl);
507 const struct table_formatter table_fmt_human_readable = {
508 .row_output = table_row_human_readable,
509 .table_start = table_start_human_readable,
512 /*** Default formatter for machine-readable output ***/
514 static void table_row_machine_readable(struct table *tbl)
516 for(uint i = 0; i < tbl->cols_to_output; i++) {
518 bputs(tbl->out, tbl->col_delimiter);
520 bputs(tbl->out, tbl->column_order[i].cell_content);
522 bputc(tbl->out, '\n');
525 static void table_start_machine_readable(struct table *tbl)
527 if(tbl->col_delimiter == NULL) {
528 tbl->col_delimiter = "\t";
531 if(tbl->print_header != false && tbl->cols_to_output > 0) {
532 bputs(tbl->out, tbl->column_order[0].col_def->name);
533 for(uint i = 1; i < tbl->cols_to_output; i++) {
534 bputs(tbl->out, tbl->col_delimiter);
535 bputs(tbl->out, tbl->column_order[i].col_def->name);
537 bputc(tbl->out, '\n');
541 const struct table_formatter table_fmt_machine_readable = {
542 .row_output = table_row_machine_readable,
543 .table_start = table_start_machine_readable,
547 /*** Blockline formatter ***/
549 static void table_row_blockline_output(struct table *tbl)
551 for(uint i = 0; i < tbl->cols_to_output; i++) {
552 const struct table_column *col_def = tbl->column_order[i].col_def;
553 bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
555 bputc(tbl->out, '\n');
558 static void table_start_blockline(struct table *tbl)
560 if(tbl->col_delimiter == NULL) {
561 tbl->col_delimiter = "\n";
565 const struct table_formatter table_fmt_blockline = {
566 .row_output = table_row_blockline_output,
567 .table_start = table_start_blockline
576 enum test_table_cols {
577 TEST_COL0_STR, TEST_COL1_INT, TEST_COL2_UINT, TEST_COL3_BOOL, TEST_COL4_DOUBLE
580 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) };
582 static struct table_template test_tbl = {
584 [TEST_COL0_STR] = TBL_COL_STR("col0_str", 20),
585 [TEST_COL1_INT] = TBL_COL_INT("col1_int", 8),
586 [TEST_COL2_UINT] = TBL_COL_UINT("col2_uint", 9),
587 [TEST_COL3_BOOL] = TBL_COL_BOOL_FMT("col3_bool", 9, XTYPE_FMT_PRETTY),
588 [TEST_COL4_DOUBLE] = TBL_COL_DOUBLE("col4_double", 11),
591 TBL_COL_ORDER(test_column_order),
592 TBL_FMT_HUMAN_READABLE,
593 TBL_COL_DELIMITER("\t"),
597 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
599 static void do_print1(struct table *test_tbl)
601 table_col_str(test_tbl, TEST_COL0_STR, "sdsdf");
602 table_col_int(test_tbl, TEST_COL1_INT, -10);
603 table_col_int(test_tbl, TEST_COL1_INT, 10000);
604 table_col_uint(test_tbl, TEST_COL2_UINT, 10);
605 table_col_printf(test_tbl, TEST_COL2_UINT, "XXX-%u", 22222);
606 table_col_bool(test_tbl, TEST_COL3_BOOL, true);
607 table_col_double(test_tbl, TEST_COL4_DOUBLE, 1.5);
608 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "AAA");
609 table_end_row(test_tbl);
611 table_col_str(test_tbl, TEST_COL0_STR, "test");
612 table_col_int(test_tbl, TEST_COL1_INT, -100);
613 table_col_uint(test_tbl, TEST_COL2_UINT, 100);
614 table_col_bool(test_tbl, TEST_COL3_BOOL, false);
615 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "%.2lf", 1.5);
616 table_end_row(test_tbl);
619 static void test_simple1(struct fastbuf *out)
621 struct table *tbl = table_init(&test_tbl);
623 // print table with header
624 table_set_col_order_by_name(tbl, "col3_bool");
625 table_start(tbl, out);
629 // print the same table as in the previous case without header
630 table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
631 table_start(tbl, out);
635 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
636 tbl->print_header = false;
637 table_start(tbl, out);
640 tbl->print_header = true;
642 table_set_col_order_by_name(tbl, "col3_bool");
643 table_start(tbl, out);
647 table_set_col_order_by_name(tbl, "col3_bool,col0_str");
648 table_start(tbl, out);
652 table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
653 table_start(tbl, out);
657 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");
658 table_start(tbl, out);
662 table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
663 table_start(tbl, out);
670 enum test_any_table_cols {
671 TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
674 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) };
676 static struct table_template test_any_tbl = {
678 [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
679 [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
682 TBL_COL_ORDER(test_any_column_order),
683 TBL_FMT_HUMAN_READABLE,
684 TBL_COL_DELIMITER("\t"),
687 static void test_any_type(struct fastbuf *out)
689 struct table *tbl = table_init(&test_any_tbl);
691 table_start(tbl, out);
693 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
694 table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
697 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
698 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
701 table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
702 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
709 int main(int argc UNUSED, char **argv UNUSED)
712 out = bfdopen_shared(1, 4096);