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 = 1;
67 new_inst->last_printed_col = -1;
68 new_inst->row_printing_started = 0;
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 = 1; // 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 = 0;
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 = 0;
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, ']');
219 * Setting options for basic table types (as defined in table.h)
221 int table_set_col_opt_default(struct table *tbl, int col_idx, const char *col_arg, char **err)
223 const struct table_column *col_def = tbl->column_order[col_idx].col_def;
225 if(col_def->type_def == &xt_double) {
227 const char *tmp_err = str_to_uint(&precision, col_arg, NULL, 0);
229 *err = mp_printf(tbl->pool, "An error occured while parsing precision: %s.", tmp_err);
232 tbl->column_order[col_idx].fmt = precision; // FIXME: shift the value of precision
236 *err = mp_printf(tbl->pool, "Invalid column format option: '%s' for column %d.", col_arg, col_idx);
241 * TODO: This function deliberately leaks memory. When it is called multiple times,
242 * previous column orders still remain allocated in the table's memory pool.
244 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
246 if(col_order_str[0] == '*') {
247 table_make_default_column_order(tbl);
251 if(!col_order_str[0]) {
252 tbl->column_order = mp_alloc(tbl->pool, 0);
253 tbl->cols_to_output = 0;
257 char *tmp_col_order = stk_strdup(col_order_str);
260 for(int i = 0; col_order_str[i] != 0; i++) {
261 if(col_order_str[i] == ',') {
266 tbl->cols_to_output = col_count;
267 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
269 int curr_col_idx = 0;
270 char *name_start = tmp_col_order;
272 char *next = strchr(name_start, ',');
277 char *arg = table_parse_col_arg(name_start); // this sets 0 on the '['
278 int col_idx = table_get_col_idx(tbl, name_start);
281 return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
283 tbl->column_order[curr_col_idx].col_def = tbl->columns + col_idx;
284 tbl->column_order[curr_col_idx].idx = col_idx;
285 tbl->column_order[curr_col_idx].fmt = tbl->columns[col_idx].fmt;
286 if(tbl->columns[col_idx].type_def && tbl->columns[col_idx].set_col_instance_option) {
288 tbl->columns[col_idx].set_col_instance_option(tbl, curr_col_idx, arg, &err);
289 if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
296 table_update_ll(tbl);
301 /*** Table cells ***/
303 static void table_set_all_inst_content(struct table *tbl, int col_templ, const char *col_content)
305 TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
306 curr_col_ptr->cell_content = col_content;
310 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type)
312 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
313 ASSERT(tbl->columns[col].type_def == COL_TYPE_ANY || expected_type == tbl->columns[col].type_def);
314 tbl->last_printed_col = col;
315 tbl->row_printing_started = 1;
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->last_printed_col = col;
326 tbl->row_printing_started = 1;
329 char *cell_content = mp_vprintf(tbl->pool, fmt, args);
330 table_set_all_inst_content(tbl, col, cell_content);
334 TABLE_COL_BODY(int, int)
335 TABLE_COL_BODY(uint, uint)
336 TABLE_COL_BODY(double, double)
337 TABLE_COL_BODY(intmax, intmax_t)
338 TABLE_COL_BODY(uintmax, uintmax_t)
339 TABLE_COL_BODY(s64, s64)
340 TABLE_COL_BODY(u64, u64)
341 TABLE_COL_BODY(bool, bool)
342 TABLE_COL_BODY(str, const char *)
344 void table_reset_row(struct table *tbl)
346 for(uint i = 0; i < tbl->cols_to_output; i++) {
347 tbl->column_order[i].cell_content = NULL;
349 mp_restore(tbl->pool, &tbl->pool_state);
350 tbl->last_printed_col = -1;
351 tbl->row_printing_started = 0;
354 void table_end_row(struct table *tbl)
356 ASSERT(tbl->formatter->row_output);
357 if(tbl->row_printing_started == 0) return;
358 tbl->formatter->row_output(tbl);
359 table_reset_row(tbl);
362 /* Construction of a cell using a fastbuf */
364 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
366 fbpool_init(&tbl->fb_col_out);
367 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
369 return &tbl->fb_col_out.fb;
372 void table_col_fbend(struct table *tbl)
374 char *cell_content = fbpool_end(&tbl->fb_col_out);
375 table_set_all_inst_content(tbl, tbl->col_out, cell_content);
379 /*** Option parsing ***/
381 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
383 // Options with no value
384 if(value == NULL || (value != NULL && strlen(value) == 0)) {
385 if(strcmp(key, "noheader") == 0) {
386 tbl->print_header = 0;
391 // Options with a value
393 if(strcmp(key, "header") == 0) {
395 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
396 uint tmp = value[0] - '0';
398 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
399 tbl->print_header = tmp;
401 } else if(strcmp(key, "cols") == 0) {
402 return table_set_col_order_by_name(tbl, value);
403 } else if(strcmp(key, "fmt") == 0) {
404 if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
405 else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
406 else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
408 return "Invalid argument to output-type option.";
411 } else if(strcmp(key, "cells") == 0) {
413 const char *err = xtype_parse_fmt(NULL, value, &fmt, tbl->pool);
414 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
415 for(uint i = 0; i < tbl->cols_to_output; i++) {
416 tbl->column_order[i].fmt = fmt;
419 } else if(strcmp(key, "raw") == 0 || strcmp(key, "pretty") == 0) {
421 const char *err = xtype_parse_fmt(NULL, key, &fmt, tbl->pool);
422 if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
423 for(uint i = 0; i < tbl->cols_to_output; i++) {
424 tbl->column_order[i].fmt = fmt;
427 } else if(strcmp(key, "col-delim") == 0) {
428 char * d = mp_printf(tbl->pool, "%s", value);
429 tbl->col_delimiter = d;
435 if(tbl->formatter && tbl->formatter->process_option) {
436 const char *err = NULL;
437 if(tbl->formatter->process_option(tbl, key, value, &err)) {
442 // Unrecognized option
443 return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
446 const char *table_set_option(struct table *tbl, const char *opt)
448 char *key = stk_strdup(opt);
449 char *value = strchr(key, ':');
453 return table_set_option_value(tbl, key, value);
456 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
458 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
459 const char *rv = table_set_option(tbl, gary_table_opts[i]);
467 /*** Default formatter for human-readable output ***/
469 static void table_row_human_readable(struct table *tbl)
471 for(uint i = 0; i < tbl->cols_to_output; i++) {
472 const struct table_column *col_def = tbl->column_order[i].col_def;
474 bputs(tbl->out, tbl->col_delimiter);
476 int col_width = col_def->width & CELL_WIDTH_MASK;
477 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
478 bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
480 bputc(tbl->out, '\n');
483 static void table_write_header(struct table *tbl)
485 for(uint i = 0; i < tbl->cols_to_output; i++) {
486 const struct table_column *col_def = tbl->column_order[i].col_def;
488 bputs(tbl->out, tbl->col_delimiter);
490 int col_width = col_def->width & CELL_WIDTH_MASK;
491 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
492 bprintf(tbl->out, "%*s", col_width, col_def->name);
494 bputc(tbl->out, '\n');
497 static void table_start_human_readable(struct table *tbl)
499 if(tbl->col_delimiter == NULL) {
500 tbl->col_delimiter = " ";
503 if(tbl->print_header != 0) {
504 table_write_header(tbl);
508 const struct table_formatter table_fmt_human_readable = {
509 .row_output = table_row_human_readable,
510 .table_start = table_start_human_readable,
513 /*** Default formatter for machine-readable output ***/
515 static void table_row_machine_readable(struct table *tbl)
517 for(uint i = 0; i < tbl->cols_to_output; i++) {
519 bputs(tbl->out, tbl->col_delimiter);
521 bputs(tbl->out, tbl->column_order[i].cell_content);
523 bputc(tbl->out, '\n');
526 static void table_start_machine_readable(struct table *tbl)
528 if(tbl->col_delimiter == NULL) {
529 tbl->col_delimiter = "\t";
532 if(tbl->print_header != 0 && tbl->cols_to_output > 0) {
533 bputs(tbl->out, tbl->column_order[0].col_def->name);
534 for(uint i = 1; i < tbl->cols_to_output; i++) {
535 bputs(tbl->out, tbl->col_delimiter);
536 bputs(tbl->out, tbl->column_order[i].col_def->name);
538 bputc(tbl->out, '\n');
542 const struct table_formatter table_fmt_machine_readable = {
543 .row_output = table_row_machine_readable,
544 .table_start = table_start_machine_readable,
548 /*** Blockline formatter ***/
550 static void table_row_blockline_output(struct table *tbl)
552 for(uint i = 0; i < tbl->cols_to_output; i++) {
553 const struct table_column *col_def = tbl->column_order[i].col_def;
554 bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
556 bputc(tbl->out, '\n');
559 static void table_start_blockline(struct table *tbl)
561 if(tbl->col_delimiter == NULL) {
562 tbl->col_delimiter = "\n";
566 const struct table_formatter table_fmt_blockline = {
567 .row_output = table_row_blockline_output,
568 .table_start = table_start_blockline
577 enum test_table_cols {
578 TEST_COL0_STR, TEST_COL1_INT, TEST_COL2_UINT, TEST_COL3_BOOL, TEST_COL4_DOUBLE
581 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) };
583 static struct table_template test_tbl = {
585 [TEST_COL0_STR] = TBL_COL_STR("col0_str", 20),
586 [TEST_COL1_INT] = TBL_COL_INT("col1_int", 8),
587 [TEST_COL2_UINT] = TBL_COL_UINT("col2_uint", 9),
588 [TEST_COL3_BOOL] = TBL_COL_BOOL_FMT("col3_bool", 9, XTYPE_FMT_PRETTY),
589 [TEST_COL4_DOUBLE] = TBL_COL_DOUBLE("col4_double", 11),
592 TBL_COL_ORDER(test_column_order),
593 TBL_FMT_HUMAN_READABLE,
594 TBL_COL_DELIMITER("\t"),
598 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
600 static void do_print1(struct table *test_tbl)
602 table_col_str(test_tbl, TEST_COL0_STR, "sdsdf");
603 table_col_int(test_tbl, TEST_COL1_INT, -10);
604 table_col_int(test_tbl, TEST_COL1_INT, 10000);
605 table_col_uint(test_tbl, TEST_COL2_UINT, 10);
606 table_col_printf(test_tbl, TEST_COL2_UINT, "XXX-%u", 22222);
607 table_col_bool(test_tbl, TEST_COL3_BOOL, true);
608 table_col_double(test_tbl, TEST_COL4_DOUBLE, 1.5);
609 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "AAA");
610 table_end_row(test_tbl);
612 table_col_str(test_tbl, TEST_COL0_STR, "test");
613 table_col_int(test_tbl, TEST_COL1_INT, -100);
614 table_col_uint(test_tbl, TEST_COL2_UINT, 100);
615 table_col_bool(test_tbl, TEST_COL3_BOOL, false);
616 table_col_printf(test_tbl, TEST_COL4_DOUBLE, "%.2lf", 1.5);
617 table_end_row(test_tbl);
620 static void test_simple1(struct fastbuf *out)
622 struct table *tbl = table_init(&test_tbl);
624 // print table with header
625 table_set_col_order_by_name(tbl, "col3_bool");
626 table_start(tbl, out);
630 // print the same table as in the previous case without header
631 table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
632 table_start(tbl, out);
636 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
637 tbl->print_header = 0;
638 table_start(tbl, out);
641 tbl->print_header = 1;
643 table_set_col_order_by_name(tbl, "col3_bool");
644 table_start(tbl, out);
648 table_set_col_order_by_name(tbl, "col3_bool,col0_str");
649 table_start(tbl, out);
653 table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
654 table_start(tbl, out);
658 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");
659 table_start(tbl, out);
663 table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
664 table_start(tbl, out);
671 enum test_any_table_cols {
672 TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
675 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) };
677 static struct table_template test_any_tbl = {
679 [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
680 [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
683 TBL_COL_ORDER(test_any_column_order),
684 TBL_FMT_HUMAN_READABLE,
685 TBL_COL_DELIMITER("\t"),
688 static void test_any_type(struct fastbuf *out)
690 struct table *tbl = table_init(&test_any_tbl);
692 table_start(tbl, out);
694 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
695 table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
698 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
699 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
702 table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
703 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
710 int main(int argc UNUSED, char **argv UNUSED)
713 out = bfdopen_shared(1, 4096);