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 struct table *table_init(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 void table_cleanup(struct table *tbl)
82 // TODO: test default column order
83 static void table_make_default_column_order(struct table *tbl)
85 int *col_order_int = alloca(sizeof(int) * tbl->column_count);
87 for(int i = 0; i < tbl->column_count; i++) {
90 table_set_col_order(tbl, col_order_int, tbl->column_count);
93 void table_start(struct table *tbl, struct fastbuf *out)
95 tbl->row_printing_started = false;
98 ASSERT_MSG(tbl->out, "Output fastbuf not specified.");
100 if(tbl->column_order == NULL) table_make_default_column_order(tbl);
102 // update linked lists
103 table_update_ll(tbl);
105 if(tbl->formatter->table_start != NULL) tbl->formatter->table_start(tbl);
107 mp_save(tbl->pool, &tbl->pool_state);
109 ASSERT_MSG(tbl->col_delimiter, "Column delimiter not specified.");
112 void table_end(struct table *tbl)
114 tbl->row_printing_started = false;
116 mp_restore(tbl->pool, &tbl->pool_state);
118 if(tbl->formatter->table_end) tbl->formatter->table_end(tbl);
121 /*** Configuration ***/
123 void table_set_formatter(struct table *tbl, const struct table_formatter *fmt)
125 tbl->formatter = fmt;
128 int table_get_col_idx(struct table *tbl, const char *col_name)
130 for(int i = 0; i < tbl->column_count; i++) {
131 if(strcmp(tbl->columns[i].name, col_name) == 0) return i;
136 const char * table_get_col_list(struct table *tbl)
138 if(tbl->column_count == 0) return "";
140 char *tmp = mp_strdup(tbl->pool, tbl->columns[0].name);
142 for(int i = 1; i < tbl->column_count; i++) {
143 tmp = mp_printf_append(tbl->pool, tmp, ", %s", tbl->columns[i].name);
149 static void table_update_ll(struct table *tbl)
151 int cols_to_output = tbl->cols_to_output;
153 for(int i = 0; i < tbl->column_count; i++) {
154 tbl->ll_headers[i] = -1;
157 for(int i = 0; i < cols_to_output; i++) {
158 int idx = tbl->column_order[i].idx;
159 tbl->column_order[i].col_def = tbl->columns + idx;
162 for(int i = 0; i < cols_to_output; i++) {
163 int col_def_idx = tbl->column_order[i].idx;
164 int first = tbl->ll_headers[col_def_idx];
165 tbl->ll_headers[col_def_idx] = i;
166 tbl->column_order[i].next_column = first;
170 void table_set_col_order(struct table *tbl, int *col_order, int cols_to_output)
172 for(int i = 0; i < cols_to_output; i++) {
173 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);
176 tbl->cols_to_output = cols_to_output;
177 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * cols_to_output);
178 for(int i = 0; i < cols_to_output; i++) {
179 int col_idx = col_order[i];
180 tbl->column_order[i].idx = col_idx;
181 tbl->column_order[i].col_def = tbl->columns + col_idx;
182 tbl->column_order[i].cell_content = NULL; // it is in fact initialized by mp_alloc_zero, but for completeness ...
183 tbl->column_order[i].next_column = -1;
184 tbl->column_order[i].fmt = tbl->columns[col_idx].fmt;
186 table_update_ll(tbl);
189 bool table_col_is_printed(struct table *tbl, uint col_idx)
191 if(tbl->ll_headers[col_idx] == -1) return 0;
196 static char * table_parse_col_arg(char *col_def)
198 // FIXME: should be switched to str_sepsplit
199 char * left_br = strchr(col_def, '[');
200 if(left_br == NULL) return NULL;
203 char *right_br = strchr(left_br, ']');
208 const char *table_set_col_opt(struct table *tbl, uint col_inst_idx, const char *col_opt)
210 const struct table_column *col_def = tbl->column_order[col_inst_idx].col_def;
212 // Make sure that we do not call table_set_col_opt, which would
213 // result in an infinite recursion.
214 if(col_def && col_def->set_col_opt) {
215 if(col_def->set_col_opt == table_set_col_opt) {
216 die("table_set_col_opt should not be used as a struct table_column::set_col_opt hook");
218 return col_def->set_col_opt(tbl, col_inst_idx, col_opt);
221 if(col_def && col_def->type_def && col_def->type_def->parse_fmt) {
223 const char *tmp_err = col_def->type_def->parse_fmt(col_opt, &fmt, tbl->pool);
224 if(tmp_err) return tmp_err;
225 tbl->column_order[col_inst_idx].fmt = fmt;
229 return mp_printf(tbl->pool, "Invalid column format option: '%s' for column %d.", col_opt, col_inst_idx);
233 * TODO: This function deliberately leaks memory. When it is called multiple times,
234 * previous column orders still remain allocated in the table's memory pool.
236 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
238 if(col_order_str[0] == '*') {
239 table_make_default_column_order(tbl);
243 if(!col_order_str[0]) {
244 tbl->column_order = mp_alloc(tbl->pool, 0);
245 tbl->cols_to_output = 0;
249 char *tmp_col_order = stk_strdup(col_order_str);
252 for(int i = 0; col_order_str[i] != 0; i++) {
253 if(col_order_str[i] == ',') {
258 tbl->cols_to_output = col_count;
259 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
261 int curr_col_idx = 0;
262 char *name_start = tmp_col_order;
264 char *next = strchr(name_start, ',');
269 char *arg = table_parse_col_arg(name_start); // this sets 0 on the '['
270 int col_idx = table_get_col_idx(tbl, name_start);
273 return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
275 tbl->column_order[curr_col_idx].col_def = tbl->columns + col_idx;
276 tbl->column_order[curr_col_idx].idx = col_idx;
277 tbl->column_order[curr_col_idx].fmt = tbl->columns[col_idx].fmt;
278 if(tbl->columns[col_idx].type_def && tbl->columns[col_idx].set_col_opt) {
279 const char *err = NULL;
280 err = tbl->columns[col_idx].set_col_opt(tbl, curr_col_idx, arg);
281 if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
288 table_update_ll(tbl);
293 /*** Table cells ***/
295 static void table_col_raw(struct table *tbl, int col_templ, const char *col_content)
297 TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
298 curr_col_ptr->cell_content = col_content;
302 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type)
304 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
305 ASSERT(tbl->columns[col].type_def == COL_TYPE_ANY || expected_type == tbl->columns[col].type_def);
306 tbl->row_printing_started = true;
307 TBL_COL_ITER_START(tbl, col, curr_col, curr_col_idx) {
308 enum xtype_fmt fmt = curr_col->fmt;
309 curr_col->cell_content = expected_type->format(value, fmt, tbl->pool);
313 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
315 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
316 tbl->row_printing_started = true;
319 char *cell_content = mp_vprintf(tbl->pool, fmt, args);
320 table_col_raw(tbl, col, cell_content);
324 TABLE_COL_BODY(int, int)
325 TABLE_COL_BODY(uint, uint)
326 TABLE_COL_BODY(double, double)
327 TABLE_COL_BODY(intmax, intmax_t)
328 TABLE_COL_BODY(uintmax, uintmax_t)
329 TABLE_COL_BODY(s64, s64)
330 TABLE_COL_BODY(u64, u64)
331 TABLE_COL_BODY(bool, bool)
332 TABLE_COL_BODY(str, const char *)
334 void table_reset_row(struct table *tbl)
336 for(uint i = 0; i < tbl->cols_to_output; i++) {
337 tbl->column_order[i].cell_content = NULL;
339 mp_restore(tbl->pool, &tbl->pool_state);
340 tbl->row_printing_started = false;
343 void table_end_row(struct table *tbl)
345 ASSERT(tbl->formatter->row_output);
346 if(tbl->row_printing_started == false) return;
347 tbl->formatter->row_output(tbl);
348 table_reset_row(tbl);
351 /* Construction of a cell using a fastbuf */
353 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
355 fbpool_init(&tbl->fb_col_out);
356 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
358 return &tbl->fb_col_out.fb;
361 void table_col_fbend(struct table *tbl)
363 char *cell_content = fbpool_end(&tbl->fb_col_out);
364 table_col_raw(tbl, tbl->col_out, cell_content);
368 /*** Option parsing ***/
370 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
372 // Options with no value
373 if(value == NULL || (value != NULL && strlen(value) == 0)) {
374 if(strcmp(key, "noheader") == 0) {
375 tbl->print_header = false;
380 // Options with a value
382 if(strcmp(key, "header") == 0) {
384 const char *err = xt_bool.parse(value, &tmp, tbl->pool);
386 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
388 tbl->print_header = tmp;
391 } else if(strcmp(key, "cols") == 0) {
392 return table_set_col_order_by_name(tbl, value);
393 } else if(strcmp(key, "fmt") == 0) {
394 if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
395 else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
396 else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
398 return "Invalid argument to output-type option.";
401 } else if(strcmp(key, "cells") == 0) {
403 const char *err = xtype_parse_fmt(NULL, value, &fmt, tbl->pool);
404 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
405 for(uint i = 0; i < tbl->cols_to_output; i++) {
406 tbl->column_order[i].fmt = fmt;
409 } else if(strcmp(key, "raw") == 0 || strcmp(key, "pretty") == 0) {
411 const char *err = xtype_parse_fmt(NULL, key, &fmt, tbl->pool);
412 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
413 for(uint i = 0; i < tbl->cols_to_output; i++) {
414 tbl->column_order[i].fmt = fmt;
417 } else if(strcmp(key, "col-delim") == 0) {
418 char * d = mp_printf(tbl->pool, "%s", value);
419 tbl->col_delimiter = d;
425 if(tbl->formatter && tbl->formatter->process_option) {
426 const char *err = NULL;
427 if(tbl->formatter->process_option(tbl, key, value, &err)) {
432 // Unrecognized option
433 return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
436 const char *table_set_option(struct table *tbl, const char *opt)
438 char *key = stk_strdup(opt);
439 char *value = strchr(key, ':');
443 return table_set_option_value(tbl, key, value);
446 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
448 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
449 const char *rv = table_set_option(tbl, gary_table_opts[i]);
457 /*** Default formatter for human-readable output ***/
459 static void table_row_human_readable(struct table *tbl)
461 for(uint i = 0; i < tbl->cols_to_output; i++) {
462 const struct table_column *col_def = tbl->column_order[i].col_def;
464 bputs(tbl->out, tbl->col_delimiter);
466 int col_width = col_def->width & CELL_WIDTH_MASK;
467 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
468 bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
470 bputc(tbl->out, '\n');
473 static void table_write_header(struct table *tbl)
475 for(uint i = 0; i < tbl->cols_to_output; i++) {
476 const struct table_column *col_def = tbl->column_order[i].col_def;
478 bputs(tbl->out, tbl->col_delimiter);
480 int col_width = col_def->width & CELL_WIDTH_MASK;
481 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
482 bprintf(tbl->out, "%*s", col_width, col_def->name);
484 bputc(tbl->out, '\n');
487 static void table_start_human_readable(struct table *tbl)
489 if(tbl->col_delimiter == NULL) {
490 tbl->col_delimiter = " ";
493 if(tbl->print_header != false) {
494 table_write_header(tbl);
498 const struct table_formatter table_fmt_human_readable = {
499 .row_output = table_row_human_readable,
500 .table_start = table_start_human_readable,
503 /*** Default formatter for machine-readable output ***/
505 static void table_row_machine_readable(struct table *tbl)
507 for(uint i = 0; i < tbl->cols_to_output; i++) {
509 bputs(tbl->out, tbl->col_delimiter);
511 bputs(tbl->out, tbl->column_order[i].cell_content);
513 bputc(tbl->out, '\n');
516 static void table_start_machine_readable(struct table *tbl)
518 if(tbl->col_delimiter == NULL) {
519 tbl->col_delimiter = "\t";
522 if(tbl->print_header != false && tbl->cols_to_output > 0) {
523 bputs(tbl->out, tbl->column_order[0].col_def->name);
524 for(uint i = 1; i < tbl->cols_to_output; i++) {
525 bputs(tbl->out, tbl->col_delimiter);
526 bputs(tbl->out, tbl->column_order[i].col_def->name);
528 bputc(tbl->out, '\n');
532 const struct table_formatter table_fmt_machine_readable = {
533 .row_output = table_row_machine_readable,
534 .table_start = table_start_machine_readable,
538 /*** Blockline formatter ***/
540 static void table_row_blockline_output(struct table *tbl)
542 for(uint i = 0; i < tbl->cols_to_output; i++) {
543 const struct table_column *col_def = tbl->column_order[i].col_def;
544 bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
546 bputc(tbl->out, '\n');
549 static void table_start_blockline(struct table *tbl)
551 if(tbl->col_delimiter == NULL) {
552 tbl->col_delimiter = "\n";
556 const struct table_formatter table_fmt_blockline = {
557 .row_output = table_row_blockline_output,
558 .table_start = table_start_blockline
567 enum test_table_cols {
568 TEST_COL0_STR, TEST_COL1_INT, TEST_COL2_UINT, TEST_COL3_BOOL, TEST_COL4_DOUBLE
571 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) };
573 static struct table_template test_tbl = {
575 [TEST_COL0_STR] = TBL_COL_STR("col0_str", 20),
576 [TEST_COL1_INT] = TBL_COL_INT("col1_int", 8),
577 [TEST_COL2_UINT] = TBL_COL_UINT("col2_uint", 9),
578 [TEST_COL3_BOOL] = TBL_COL_BOOL_FMT("col3_bool", 9, XTYPE_FMT_PRETTY),
579 [TEST_COL4_DOUBLE] = TBL_COL_DOUBLE("col4_double", 11),
582 TBL_COL_ORDER(test_column_order),
583 TBL_FMT_HUMAN_READABLE,
584 TBL_COL_DELIMITER("\t"),
588 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
590 static void do_print1(struct table *test_tbl)
592 table_col_str(test_tbl, TEST_COL0_STR, "sdsdf");
593 table_col_int(test_tbl, TEST_COL1_INT, -10);
594 table_col_int(test_tbl, TEST_COL1_INT, 10000);
595 table_col_uint(test_tbl, TEST_COL2_UINT, 10);
596 table_col_printf(test_tbl, TEST_COL2_UINT, "XXX-%u", 22222);
597 table_col_bool(test_tbl, TEST_COL3_BOOL, true);
598 table_col_double(test_tbl, TEST_COL4_DOUBLE, 1.5);
599 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "AAA");
600 table_end_row(test_tbl);
602 table_col_str(test_tbl, TEST_COL0_STR, "test");
603 table_col_int(test_tbl, TEST_COL1_INT, -100);
604 table_col_uint(test_tbl, TEST_COL2_UINT, 100);
605 table_col_bool(test_tbl, TEST_COL3_BOOL, false);
606 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "%.2lf", 1.5);
607 table_end_row(test_tbl);
610 static void test_simple1(struct fastbuf *out)
612 struct table *tbl = table_init(&test_tbl);
614 // print table with header
615 table_set_col_order_by_name(tbl, "col3_bool");
616 table_start(tbl, out);
620 // print the same table as in the previous case without header
621 table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
622 table_start(tbl, out);
626 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
627 tbl->print_header = false;
628 table_start(tbl, out);
631 tbl->print_header = true;
633 table_set_col_order_by_name(tbl, "col3_bool");
634 table_start(tbl, out);
638 table_set_col_order_by_name(tbl, "col3_bool,col0_str");
639 table_start(tbl, out);
643 table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
644 table_start(tbl, out);
648 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");
649 table_start(tbl, out);
653 table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
654 table_start(tbl, out);
661 enum test_any_table_cols {
662 TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
665 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) };
667 static struct table_template test_any_tbl = {
669 [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
670 [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
673 TBL_COL_ORDER(test_any_column_order),
674 TBL_FMT_HUMAN_READABLE,
675 TBL_COL_DELIMITER("\t"),
678 static void test_any_type(struct fastbuf *out)
680 struct table *tbl = table_init(&test_any_tbl);
682 table_start(tbl, out);
684 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
685 table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
688 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
689 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
692 table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
693 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
700 int main(int argc UNUSED, char **argv UNUSED)
703 out = bfdopen_shared(1, 4096);