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)); // FIXME: update allocation to the weird schema made by pchar and mj?
28 new_inst->pool = mp_new(4096);
30 // initialize column definitions
31 int 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 = mp_alloc_zero(new_inst->pool, sizeof(struct table_column) * new_inst->column_count);
45 memcpy(new_inst->columns, tbl_template->columns, sizeof(struct table_column) * new_inst->column_count);
47 // initialize column_order
48 if(tbl_template->column_order) {
49 new_inst->column_order = mp_alloc_zero(new_inst->pool, sizeof(struct table_col_instance) * tbl_template->cols_to_output);
50 memcpy(new_inst->column_order, tbl_template->column_order, sizeof(struct table_col_instance) * tbl_template->cols_to_output);
51 for(uint i = 0; i < new_inst->cols_to_output; i++) {
52 new_inst->column_order[i].cell_content = NULL;
53 int col_idx = new_inst->column_order[i].idx;
54 new_inst->column_order[i].col_def = new_inst->columns + col_idx;
55 new_inst->column_order[i].output_type = tbl_template->columns[col_idx].fmt;
58 new_inst->cols_to_output = tbl_template->cols_to_output;
61 new_inst->col_delimiter = tbl_template->col_delimiter;
62 new_inst->print_header = 1;
64 new_inst->last_printed_col = -1;
65 new_inst->row_printing_started = 0;
66 new_inst->col_out = -1;
67 new_inst->formatter = tbl_template->formatter;
68 new_inst->data = NULL;
72 struct table *table_init(const struct table_template *tbl_template)
74 struct table *tbl = table_make_instance(tbl_template);
77 tbl->formatter = &table_fmt_human_readable;
80 tbl->print_header = 1; // by default, print header
84 void table_cleanup(struct table *tbl)
87 memset(tbl, 0, sizeof(struct table));
90 // TODO: test default column order
91 static void table_make_default_column_order(struct table *tbl)
93 int *col_order_int = mp_alloc_zero(tbl->pool, sizeof(int) * tbl->column_count); // FIXME: use stack instead of memory pool
94 for(int i = 0; i < tbl->column_count; i++) {
97 table_set_col_order(tbl, col_order_int, tbl->column_count);
100 void table_start(struct table *tbl, struct fastbuf *out)
102 tbl->last_printed_col = -1;
103 tbl->row_printing_started = 0;
106 ASSERT_MSG(tbl->out, "Output fastbuf not specified.");
108 if(tbl->column_order == NULL) table_make_default_column_order(tbl);
110 // update linked lists
111 table_update_ll(tbl);
113 if(tbl->formatter->table_start != NULL) tbl->formatter->table_start(tbl);
115 mp_save(tbl->pool, &tbl->pool_state);
117 ASSERT_MSG(tbl->col_delimiter, "In-between column delimiter not specified.");
120 void table_end(struct table *tbl)
122 tbl->last_printed_col = -1;
123 tbl->row_printing_started = 0;
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, 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->columns[i].first_column = -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 first = tbl->column_order[i].col_def->first_column;
173 tbl->column_order[i].col_def->first_column = i;
176 tbl->column_order[i].next_column = first;
178 tbl->column_order[i].next_column = -1;
183 void table_set_col_order(struct table *tbl, int *col_order, int cols_to_output)
185 for(int i = 0; i < cols_to_output; i++) {
186 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);
189 tbl->cols_to_output = cols_to_output;
190 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * cols_to_output);
191 for(int i = 0; i < cols_to_output; i++) {
192 int col_idx = col_order[i];
193 tbl->column_order[i].idx = col_idx;
194 tbl->column_order[i].col_def = tbl->columns + col_idx;
195 tbl->column_order[i].cell_content = NULL;
196 tbl->column_order[i].output_type = tbl->columns[col_idx].fmt;
198 table_update_ll(tbl);
201 bool table_col_is_printed(struct table *tbl, uint col_idx)
203 if(tbl->columns[col_idx].first_column == -1) return 0;
208 static char * table_parse_col_arg(char *col_def)
210 // FIXME: should be switched to str_sepsplit
211 char * left_br = strchr(col_def, '[');
212 if(left_br == NULL) return NULL;
215 char *right_br = strchr(left_br, ']');
221 * Setting options for basic table types (as defined in table.h)
223 bool table_set_col_opt_default(struct table *tbl, int col_idx, const char *col_arg, char **err)
225 struct table_column *col_def = tbl->column_order[col_idx].col_def;
227 if(col_def->type_def == COL_TYPE_DOUBLE) {
229 const char *tmp_err = str_to_uint(&precision, col_arg, NULL, 0);
231 *err = mp_printf(tbl->pool, "An error occured while parsing precision: %s", tmp_err);
234 tbl->column_order[col_idx].output_type = precision; // FIXME: shift the value of precision
238 *err = mp_printf(tbl->pool, "Invalid column format option: '%s' for column %d.", col_arg, col_idx);
243 * TODO: This function deliberately leaks memory. When it is called multiple times,
244 * previous column orders still remain allocated in the table's memory pool.
246 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
248 if(col_order_str[0] == '*') {
249 int *col_order_int = alloca(sizeof(int) * tbl->column_count);
250 for(int i = 0; i < tbl->column_count; i++) {
251 col_order_int[i] = i;
253 table_set_col_order(tbl, col_order_int, tbl->column_count);
258 if(!col_order_str[0]) {
259 tbl->column_order = mp_alloc(tbl->pool, 0);
260 tbl->cols_to_output = 0;
264 char *tmp_col_order = stk_strdup(col_order_str);
267 for(int i = 0; col_order_str[i] != 0; i++) {
268 if(col_order_str[i] == ',') {
273 tbl->cols_to_output = col_count;
274 tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
276 int curr_col_idx = 0;
277 char *name_start = tmp_col_order;
279 char *next = strchr(name_start, ',');
284 char *arg = table_parse_col_arg(name_start); // this sets 0 on the '['
285 int col_idx = table_get_col_idx(tbl, name_start);
288 return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
290 tbl->column_order[curr_col_idx].col_def = tbl->columns + col_idx;
291 tbl->column_order[curr_col_idx].idx = col_idx;
292 tbl->column_order[curr_col_idx].cell_content = NULL;
293 tbl->column_order[curr_col_idx].output_type = tbl->columns[col_idx].fmt;
294 if(tbl->columns[col_idx].type_def && tbl->columns[col_idx].set_col_instance_option) {
296 tbl->columns[col_idx].set_col_instance_option(tbl, curr_col_idx, arg, &err);
297 if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
304 table_update_ll(tbl);
309 /*** Table cells ***/
311 static void table_set_all_inst_content(struct table *tbl, int col_templ, const char *col_content)
313 TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
314 curr_col_ptr->cell_content = col_content;
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 = 1;
325 char *cell_content = mp_vprintf(tbl->pool, fmt, args);
326 table_set_all_inst_content(tbl, col, cell_content);
330 TABLE_COL_BODIES(int, int, COL_TYPE_INT)
331 TABLE_COL_BODIES(uint, uint, COL_TYPE_UINT)
332 TABLE_COL_BODIES(str, const char *, COL_TYPE_STR)
333 TABLE_COL_BODIES(intmax, intmax_t, COL_TYPE_INTMAX)
334 TABLE_COL_BODIES(uintmax, uintmax_t, COL_TYPE_UINTMAX)
335 TABLE_COL_BODIES(s64, s64, COL_TYPE_S64)
336 TABLE_COL_BODIES(u64, u64, COL_TYPE_U64)
337 TABLE_COL_BODIES(double, double, COL_TYPE_DOUBLE)
339 TABLE_COL(bool, bool, COL_TYPE_BOOL)
340 TABLE_COL_STR(bool, bool, COL_TYPE_BOOL)
341 TABLE_COL_FMT(bool, bool, COL_TYPE_BOOL)
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->last_printed_col = -1;
350 tbl->row_printing_started = 0;
353 void table_end_row(struct table *tbl)
355 ASSERT(tbl->formatter->row_output);
356 if(tbl->row_printing_started == 0) return;
357 tbl->formatter->row_output(tbl);
358 table_reset_row(tbl);
361 /* Construction of a cell using a fastbuf */
363 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
365 fbpool_init(&tbl->fb_col_out);
366 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
368 return &tbl->fb_col_out.fb;
371 void table_col_fbend(struct table *tbl)
373 char *cell_content = fbpool_end(&tbl->fb_col_out);
374 table_set_all_inst_content(tbl, tbl->col_out, cell_content);
378 /*** Option parsing ***/
380 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
382 // Options with no value
383 if(value == NULL || (value != NULL && strlen(value) == 0)) {
384 if(strcmp(key, "noheader") == 0) {
385 tbl->print_header = 0;
390 // Options with a value
392 if(strcmp(key, "header") == 0) {
394 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
395 uint tmp = value[0] - '0';
397 return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
398 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, "cell-fmt") == 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].output_type = fmt;
418 } else if(strcmp(key, "col-delim") == 0) {
419 char * d = mp_printf(tbl->pool, "%s", value);
420 tbl->col_delimiter = d;
426 if(tbl->formatter && tbl->formatter->process_option) {
427 const char *err = NULL;
428 if(tbl->formatter->process_option(tbl, key, value, &err)) {
433 // Unrecognized option
434 return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
437 const char *table_set_option(struct table *tbl, const char *opt)
439 char *key = stk_strdup(opt);
440 char *value = strchr(key, ':');
444 return table_set_option_value(tbl, key, value);
447 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
449 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
450 const char *rv = table_set_option(tbl, gary_table_opts[i]);
458 /*** Default formatter for human-readable output ***/
460 static void table_row_human_readable(struct table *tbl)
462 for(uint i = 0; i < tbl->cols_to_output; i++) {
463 struct table_column *col_def = tbl->column_order[i].col_def;
465 bputs(tbl->out, tbl->col_delimiter);
467 int col_width = col_def->width & CELL_WIDTH_MASK;
468 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
469 bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
471 bputc(tbl->out, '\n');
474 static void table_write_header(struct table *tbl)
476 for(uint i = 0; i < tbl->cols_to_output; i++) {
477 struct table_column *col_def = tbl->column_order[i].col_def;
479 bputs(tbl->out, tbl->col_delimiter);
481 int col_width = col_def->width & CELL_WIDTH_MASK;
482 if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
483 bprintf(tbl->out, "%*s", col_width, col_def->name);
485 bputc(tbl->out, '\n');
488 static void table_start_human_readable(struct table *tbl)
490 if(tbl->col_delimiter == NULL) {
491 tbl->col_delimiter = " ";
494 if(tbl->print_header != 0) {
495 table_write_header(tbl);
499 struct table_formatter table_fmt_human_readable = {
500 .row_output = table_row_human_readable,
501 .table_start = table_start_human_readable,
504 /*** Default formatter for machine-readable output ***/
506 static void table_row_machine_readable(struct table *tbl)
508 for(uint i = 0; i < tbl->cols_to_output; i++) {
510 bputs(tbl->out, tbl->col_delimiter);
512 bputs(tbl->out, tbl->column_order[i].cell_content);
514 bputc(tbl->out, '\n');
517 static void table_start_machine_readable(struct table *tbl)
519 if(tbl->col_delimiter == NULL) {
520 tbl->col_delimiter = "\t";
523 if(tbl->print_header != 0 && tbl->cols_to_output > 0) {
524 bputs(tbl->out, tbl->column_order[0].col_def->name);
525 for(uint i = 1; i < tbl->cols_to_output; i++) {
526 bputs(tbl->out, tbl->col_delimiter);
527 bputs(tbl->out, tbl->column_order[i].col_def->name);
529 bputc(tbl->out, '\n');
533 struct table_formatter table_fmt_machine_readable = {
534 .row_output = table_row_machine_readable,
535 .table_start = table_start_machine_readable,
539 /*** Blockline formatter ***/
541 static void table_row_blockline_output(struct table *tbl)
543 for(uint i = 0; i < tbl->cols_to_output; i++) {
544 struct table_column *col_def = tbl->column_order[i].col_def;
545 bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
547 bputc(tbl->out, '\n');
550 static void table_start_blockline(struct table *tbl)
552 if(tbl->col_delimiter == NULL) {
553 tbl->col_delimiter = "\n";
557 struct table_formatter table_fmt_blockline = {
558 .row_output = table_row_blockline_output,
559 .table_start = table_start_blockline
568 enum test_table_cols {
569 test_col0_str, test_col1_int, test_col2_uint, test_col3_bool, test_col4_double
572 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) };
574 static struct table_template test_tbl = {
576 [test_col0_str] = TBL_COL_STR("col0_str", 20),
577 [test_col1_int] = TBL_COL_INT("col1_int", 8),
578 [test_col2_uint] = TBL_COL_UINT("col2_uint", 9),
579 [test_col3_bool] = TBL_COL_BOOL("col3_bool", 9),
580 [test_col4_double] = TBL_COL_DOUBLE("col4_double", 11),
583 TBL_COL_ORDER(test_column_order),
584 TBL_OUTPUT_HUMAN_READABLE,
585 TBL_COL_DELIMITER("\t"),
589 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
591 static void do_print1(struct table *test_tbl)
593 table_col_str(test_tbl, test_col0_str, "sdsdf");
594 table_col_int(test_tbl, test_col1_int, -10);
595 table_col_int(test_tbl, test_col1_int, 10000);
596 table_col_uint(test_tbl, test_col2_uint, 10);
597 table_col_printf(test_tbl, test_col2_uint, "XXX-%u", 22222);
598 table_col_bool(test_tbl, test_col3_bool, 1);
599 table_col_double(test_tbl, test_col4_double, 1.5);
600 table_col_printf(test_tbl, test_col4_double, "AAA");
601 table_end_row(test_tbl);
603 table_col_str(test_tbl, test_col0_str, "test");
604 table_col_int(test_tbl, test_col1_int, -100);
605 table_col_uint(test_tbl, test_col2_uint, 100);
606 table_col_bool(test_tbl, test_col3_bool, 0);
607 table_col_printf(test_tbl, test_col4_double, "%.2lf", 1.5);
608 table_end_row(test_tbl);
611 static void test_simple1(struct fastbuf *out)
613 struct table *tbl = table_init(&test_tbl);
615 // print table with header
616 table_set_col_order_by_name(tbl, "col3_bool");
617 table_start(tbl, out);
621 // print the same table as in the previous case without header
622 table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
623 table_start(tbl, out);
627 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
628 tbl->print_header = 0;
629 table_start(tbl, out);
632 tbl->print_header = 1;
634 table_set_col_order_by_name(tbl, "col3_bool");
635 table_start(tbl, out);
639 table_set_col_order_by_name(tbl, "col3_bool,col0_str");
640 table_start(tbl, out);
644 table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
645 table_start(tbl, out);
649 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");
650 table_start(tbl, out);
654 table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
655 table_start(tbl, out);
662 enum test_any_table_cols {
663 TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
666 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) };
668 static struct table_template test_any_tbl = {
670 [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
671 [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
674 TBL_COL_ORDER(test_any_column_order),
675 TBL_OUTPUT_HUMAN_READABLE,
676 TBL_COL_DELIMITER("\t"),
679 static void test_any_type(struct fastbuf *out)
681 struct table *tbl = table_init(&test_any_tbl);
683 tbl->columns[TEST_ANY_COL1_ANY].fmt = XTYPE_FMT_PRETTY;
685 table_start(tbl, out);
687 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
688 table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
691 table_col_int(tbl, TEST_ANY_COL0_INT, -10);
692 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
695 table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
696 table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
703 int main(int argc UNUSED, char **argv UNUSED)
706 out = bfdopen_shared(1, 4096);