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>
15 /*** Management of tables ***/
17 void table_init(struct table *tbl)
19 int col_count = 0; // count the number of columns in the struct table
22 if(tbl->columns[col_count].name == NULL &&
23 tbl->columns[col_count].fmt == NULL &&
24 tbl->columns[col_count].width == 0 &&
25 tbl->columns[col_count].type == COL_TYPE_LAST)
27 ASSERT(tbl->columns[col_count].name != NULL);
28 ASSERT(tbl->columns[col_count].type == COL_TYPE_ANY || tbl->columns[col_count].fmt != NULL);
29 ASSERT(tbl->columns[col_count].width != 0);
30 ASSERT(tbl->columns[col_count].type < COL_TYPE_LAST);
33 tbl->pool = mp_new(4096);
35 tbl->column_count = col_count;
38 tbl->formatter = &table_fmt_human_readable;
41 tbl->print_header = 1; // by default, print header
44 void table_cleanup(struct table *tbl)
47 memset(tbl, 0, sizeof(struct table));
50 // TODO: test default column order
51 static void table_make_default_column_order(struct table *tbl)
53 int *col_order_int = mp_alloc_zero(tbl->pool, sizeof(int) * tbl->column_count);
54 for(int i = 0; i < tbl->column_count; i++) {
57 table_set_col_order(tbl, col_order_int, tbl->column_count);
60 void table_start(struct table *tbl, struct fastbuf *out)
62 tbl->last_printed_col = -1;
63 tbl->row_printing_started = 0;
66 ASSERT_MSG(tbl->out, "Output fastbuf not specified.");
68 if(!tbl->col_str_ptrs) {
69 tbl->col_str_ptrs = mp_alloc_zero(tbl->pool, sizeof(char *) * tbl->column_count);
72 if(tbl->column_order == NULL) table_make_default_column_order(tbl);
74 if(tbl->formatter->table_start != NULL) tbl->formatter->table_start(tbl);
76 mp_save(tbl->pool, &tbl->pool_state);
78 ASSERT_MSG(tbl->col_delimiter, "In-between column delimiter not specified.");
79 ASSERT_MSG(tbl->append_delimiter, "Append delimiter not specified.");
82 void table_end(struct table *tbl)
84 tbl->last_printed_col = -1;
85 tbl->row_printing_started = 0;
87 mp_restore(tbl->pool, &tbl->pool_state);
89 if(tbl->formatter->table_end) tbl->formatter->table_end(tbl);
92 /*** Configuration ***/
94 void table_set_formatter(struct table *tbl, struct table_formatter *fmt)
99 int table_get_col_idx(struct table *tbl, const char *col_name)
101 for(int i = 0; i < tbl->column_count; i++) {
102 if(strcmp(tbl->columns[i].name, col_name) == 0) return i;
107 const char * table_get_col_list(struct table *tbl)
109 if(tbl->column_count == 0) return "";
111 char *tmp = mp_strdup(tbl->pool, tbl->columns[0].name);
113 for(int i = 1; i < tbl->column_count; i++) {
114 tmp = mp_printf_append(tbl->pool, tmp, ", %s", tbl->columns[i].name);
120 void table_set_col_order(struct table *tbl, int *col_order, int cols_to_output)
122 for(int i = 0; i < cols_to_output; i++) {
123 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);
126 tbl->column_order = col_order;
127 tbl->cols_to_output = cols_to_output;
131 bool table_col_is_printed(struct table *tbl, uint col_idx)
133 for(uint i = 0; i < tbl->cols_to_output; i++) {
134 if(tbl->column_order[i] == col_idx) return 1;
141 * TODO: This function deliberately leaks memory. When it is called multiple times,
142 * previous column orders still remain allocated in the table's memory pool.
144 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
146 if(col_order_str[0] == '*') {
147 tbl->column_order = mp_alloc(tbl->pool, sizeof(int) * tbl->column_count);
148 tbl->cols_to_output = tbl->column_count;
149 for(uint i = 0; i < tbl->cols_to_output; i++) tbl->column_order[i] = i;
154 if(!col_order_str[0]) {
155 tbl->column_order = mp_alloc(tbl->pool, 0);
156 tbl->cols_to_output = 0;
160 char *tmp_col_order = stk_strdup(col_order_str);
163 for(int i = 0; col_order_str[i] != 0; i++) {
164 if(col_order_str[i] == ',') {
169 int *col_order_int = mp_alloc_zero(tbl->pool, sizeof(int) * col_count);
170 int curr_col_order_int = 0;
171 const char *name_start = tmp_col_order;
173 char *next = strchr(name_start, ',');
178 int idx = table_get_col_idx(tbl, name_start);
180 return mp_printf(tbl->pool, "Unknown table column '%s'", name_start);
182 col_order_int[curr_col_order_int++] = idx;
187 tbl->column_order = col_order_int;
188 tbl->cols_to_output = curr_col_order_int;
192 /*** Table cells ***/
194 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
196 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
197 tbl->last_printed_col = col;
198 tbl->row_printing_started = 1;
201 tbl->col_str_ptrs[col] = mp_vprintf(tbl->pool, fmt, args);
205 static const char *table_col_default_fmts[] = {
206 [COL_TYPE_STR] = "%s",
207 [COL_TYPE_INT] = "%d",
208 [COL_TYPE_S64] = "%lld",
209 [COL_TYPE_INTMAX] = "%jd",
210 [COL_TYPE_UINT] = "%u",
211 [COL_TYPE_U64] = "%llu",
212 [COL_TYPE_UINTMAX] = "%ju",
213 [COL_TYPE_BOOL] = "%d",
214 [COL_TYPE_DOUBLE] = "%.2lf",
215 [COL_TYPE_ANY] = NULL,
216 [COL_TYPE_LAST] = NULL
219 #define TABLE_COL(_name_, _type_, _typeconst_) void table_col_##_name_(struct table *tbl, int col, _type_ val) \
221 const char *fmt = tbl->columns[col].fmt;\
222 if(tbl->columns[col].type == COL_TYPE_ANY) {\
223 fmt = table_col_default_fmts[_typeconst_];\
225 table_col_##_name_##_fmt(tbl, col, fmt, val);\
228 #define TABLE_COL_STR(_name_, _type_, _typeconst_) void table_col_##_name_##_name(struct table *tbl, const char *col_name, _type_ val) \
230 int col = table_get_col_idx(tbl, col_name);\
231 table_col_##_name_(tbl, col, val);\
234 #define TABLE_COL_FMT(_name_, _type_, _typeconst_) void table_col_##_name_##_fmt(struct table *tbl, int col, const char *fmt, _type_ val)\
236 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);\
237 ASSERT(tbl->columns[col].type == COL_TYPE_ANY || _typeconst_ == tbl->columns[col].type);\
238 ASSERT(fmt != NULL);\
239 tbl->last_printed_col = col;\
240 tbl->row_printing_started = 1;\
241 tbl->col_str_ptrs[col] = mp_printf(tbl->pool, fmt, val);\
244 #define TABLE_COL_BODIES(_name_, _type_, _typeconst_) TABLE_COL(_name_, _type_, _typeconst_);\
245 TABLE_COL_STR(_name_, _type_, _typeconst_);\
246 TABLE_COL_FMT(_name_, _type_, _typeconst_);
248 TABLE_COL_BODIES(int, int, COL_TYPE_INT)
249 TABLE_COL_BODIES(uint, uint, COL_TYPE_UINT)
250 TABLE_COL_BODIES(double, double, COL_TYPE_DOUBLE)
251 TABLE_COL_BODIES(str, const char *, COL_TYPE_STR)
252 TABLE_COL_BODIES(intmax, intmax_t, COL_TYPE_INTMAX)
253 TABLE_COL_BODIES(uintmax, uintmax_t, COL_TYPE_UINTMAX)
254 TABLE_COL_BODIES(s64, s64, COL_TYPE_S64)
255 TABLE_COL_BODIES(u64, u64, COL_TYPE_U64)
259 #undef TABLE_COL_BODIES
261 void table_col_bool(struct table *tbl, int col, uint val)
263 table_col_bool_fmt(tbl, col, tbl->columns[col].fmt, val);
266 void table_col_bool_name(struct table *tbl, const char *col_name, uint val)
268 int col = table_get_col_idx(tbl, col_name);
269 table_col_bool(tbl, col, val);
272 void table_col_bool_fmt(struct table *tbl, int col, const char *fmt, uint val)
274 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
275 ASSERT(COL_TYPE_BOOL == tbl->columns[col].type);
277 tbl->last_printed_col = col;
278 tbl->row_printing_started = 1;
279 tbl->col_str_ptrs[col] = mp_printf(tbl->pool, fmt, val ? "true" : "false");
282 #define TABLE_APPEND(_name_, _type_, _typeconst_) void table_append_##_name_(struct table *tbl, _type_ val) \
284 ASSERT(tbl->last_printed_col != -1 || tbl->row_printing_started != 0);\
285 ASSERT(_typeconst_ == tbl->columns[tbl->last_printed_col].type);\
286 int col = tbl->last_printed_col;\
287 mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], "%s", tbl->append_delimiter);\
288 tbl->col_str_ptrs[col] = mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], tbl->columns[col].fmt, val);\
291 TABLE_APPEND(int, int, COL_TYPE_INT)
292 TABLE_APPEND(uint, uint, COL_TYPE_UINT)
293 TABLE_APPEND(double, double, COL_TYPE_DOUBLE)
294 TABLE_APPEND(str, const char *, COL_TYPE_STR)
295 TABLE_APPEND(intmax, intmax_t, COL_TYPE_INTMAX)
296 TABLE_APPEND(uintmax, uintmax_t, COL_TYPE_UINTMAX)
297 TABLE_APPEND(u64, u64, COL_TYPE_U64)
300 void table_append_bool(struct table *tbl, int val)
302 ASSERT(tbl->last_printed_col != -1 || tbl->row_printing_started != 0);
303 ASSERT(COL_TYPE_BOOL == tbl->columns[tbl->last_printed_col].type);
305 int col = tbl->last_printed_col;
307 mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], "%s", tbl->append_delimiter);
309 tbl->col_str_ptrs[col] = mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], tbl->columns[col].fmt, val ? "true" : "false");
312 void table_append_printf(struct table *tbl, const char *fmt, ...)
314 ASSERT(tbl->last_printed_col != -1 || tbl->row_printing_started != 0);
315 int col = tbl->last_printed_col;
320 mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], "%s", tbl->append_delimiter);
321 tbl->col_str_ptrs[col] = mp_vprintf_append(tbl->pool, tbl->col_str_ptrs[col], fmt, args);
326 void table_reset_row(struct table *tbl)
328 memset(tbl->col_str_ptrs, 0, sizeof(char *) * tbl->column_count);
329 mp_restore(tbl->pool, &tbl->pool_state);
330 tbl->last_printed_col = -1;
331 tbl->row_printing_started = 0;
334 void table_end_row(struct table *tbl)
336 ASSERT(tbl->formatter->row_output);
337 if(tbl->row_printing_started == 0) return;
338 tbl->formatter->row_output(tbl);
339 table_reset_row(tbl);
342 /* Construction of a cell using a fastbuf */
344 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
346 fbpool_init(&tbl->fb_col_out);
347 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
349 return &tbl->fb_col_out.fb;
352 void table_col_fbend(struct table *tbl)
354 tbl->col_str_ptrs[tbl->col_out] = fbpool_end(&tbl->fb_col_out);
358 /*** Option parsing ***/
360 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
362 // Options with no value
363 if(value == NULL || (value != NULL && strlen(value) == 0)) {
364 if(strcmp(key, "noheader") == 0) {
365 tbl->print_header = 0;
370 // Options with a value
372 if(strcmp(key, "header") == 0) {
374 return mp_printf(tbl->pool, "Tableprinter: invalid option: '%s' has invalid value: '%s'.", key, value);
375 uint tmp = value[0] - '0';
377 return mp_printf(tbl->pool, "Tableprinter: invalid option: '%s' has invalid value: '%s'.", key, value);
378 tbl->print_header = tmp;
380 } else if(strcmp(key, "cols") == 0) {
381 const char *err = table_set_col_order_by_name(tbl, value);
383 return mp_printf(tbl->pool, "%s, possible column names are: %s.", err, table_get_col_list(tbl));
386 } else if(strcmp(key, "fmt") == 0) {
387 if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
388 else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
389 else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
391 return "Tableprinter: invalid argument to output-type option.";
394 } else if(strcmp(key, "col-delim") == 0) {
395 char * d = mp_printf(tbl->pool, "%s", value);
396 tbl->col_delimiter = d;
402 if(tbl->formatter && tbl->formatter->process_option) {
403 const char *err = NULL;
404 if (tbl->formatter->process_option(tbl, key, value, &err)) {
409 // Unrecognized option
410 return mp_printf(tbl->pool, "Tableprinter: invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
413 const char *table_set_option(struct table *tbl, const char *opt)
415 char *key = stk_strdup(opt);
416 char *value = strchr(key, ':');
420 return table_set_option_value(tbl, key, value);
423 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
425 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
426 const char *rv = table_set_option(tbl, gary_table_opts[i]);
434 /*** Default formatter for human-readable output ***/
436 static void table_row_human_readable(struct table *tbl)
438 for(uint i = 0; i < tbl->cols_to_output; i++) {
439 int col_idx = tbl->column_order[i];
441 bputs(tbl->out, tbl->col_delimiter);
443 int col_width = tbl->columns[col_idx].width & CELL_WIDTH_MASK;
444 if(tbl->columns[col_idx].width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
445 bprintf(tbl->out, "%*s", col_width, tbl->col_str_ptrs[col_idx]);
447 bputc(tbl->out, '\n');
450 static void table_write_header(struct table *tbl)
452 for(uint i = 0; i < tbl->cols_to_output; i++) {
453 int col_idx = tbl->column_order[i];
455 bputs(tbl->out, tbl->col_delimiter);
457 int col_width = tbl->columns[col_idx].width & CELL_WIDTH_MASK;
458 if(tbl->columns[col_idx].width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
459 bprintf(tbl->out, "%*s", col_width, tbl->columns[col_idx].name);
461 bputc(tbl->out, '\n');
464 static void table_start_human_readable(struct table *tbl)
466 if(tbl->col_delimiter == NULL) {
467 tbl->col_delimiter = " ";
470 if(tbl->append_delimiter == NULL) {
471 tbl->append_delimiter = ",";
474 if(tbl->print_header != 0) {
475 table_write_header(tbl);
479 struct table_formatter table_fmt_human_readable = {
480 .row_output = table_row_human_readable,
481 .table_start = table_start_human_readable,
484 /*** Default formatter for machine-readable output ***/
486 static void table_row_machine_readable(struct table *tbl)
488 for(uint i = 0; i < tbl->cols_to_output; i++) {
489 int col_idx = tbl->column_order[i];
491 bputs(tbl->out, tbl->col_delimiter);
493 bputs(tbl->out, tbl->col_str_ptrs[col_idx]);
495 bputc(tbl->out, '\n');
498 static void table_start_machine_readable(struct table *tbl)
500 if(tbl->col_delimiter == NULL) {
501 tbl->col_delimiter = ";";
504 if(tbl->append_delimiter == NULL) {
505 tbl->append_delimiter = ",";
508 if(tbl->print_header != 0) {
509 uint col_idx = tbl->column_order[0];
510 bputs(tbl->out, tbl->columns[col_idx].name);
511 for(uint i = 1; i < tbl->cols_to_output; i++) {
512 col_idx = tbl->column_order[i];
513 bputs(tbl->out, tbl->col_delimiter);
514 bputs(tbl->out, tbl->columns[col_idx].name);
516 bputc(tbl->out, '\n');
520 struct table_formatter table_fmt_machine_readable = {
521 .row_output = table_row_machine_readable,
522 .table_start = table_start_machine_readable,
526 /*** Blockline formatter ***/
528 static void table_row_blockline_output(struct table *tbl)
530 for(uint i = 0; i < tbl->cols_to_output; i++) {
531 int col_idx = tbl->column_order[i];
532 bprintf(tbl->out, "%s: %s\n", tbl->columns[col_idx].name, tbl->col_str_ptrs[col_idx]);
534 bputc(tbl->out, '\n');
537 static void table_start_blockline(struct table *tbl)
539 if(tbl->col_delimiter == NULL) {
540 tbl->col_delimiter = " ";
543 if(tbl->append_delimiter == NULL) {
544 tbl->append_delimiter = ",";
548 struct table_formatter table_fmt_blockline = {
549 .row_output = table_row_blockline_output,
550 .table_start = table_start_blockline
561 enum test_table_cols {
562 test_col0_str, test_col1_int, test_col2_uint, test_col3_bool, test_col4_double
565 static uint test_column_order[] = {test_col3_bool, test_col4_double, test_col2_uint,test_col1_int, test_col0_str};
567 static struct table test_tbl = {
569 [test_col0_str] = TBL_COL_STR("col0_str", 20),
570 [test_col1_int] = TBL_COL_INT("col1_int", 8),
571 [test_col2_uint] = TBL_COL_UINT("col2_uint", 9),
572 [test_col3_bool] = TBL_COL_BOOL("col3_bool", 9),
573 [test_col4_double] = TBL_COL_DOUBLE("col4_double", 11, 2),
576 TBL_COL_ORDER(test_column_order),
577 TBL_OUTPUT_HUMAN_READABLE,
578 TBL_COL_DELIMITER("\t"),
579 TBL_APPEND_DELIMITER(",")
583 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
585 static void do_print1(struct table *test_tbl)
587 table_col_str(test_tbl, test_col0_str, "sdsdf");
588 table_append_str(test_tbl, "aaaaa");
589 table_col_int(test_tbl, test_col1_int, -10);
590 table_col_int(test_tbl, test_col1_int, 10000);
591 table_col_uint(test_tbl, test_col2_uint, 10);
592 table_col_printf(test_tbl, test_col2_uint, "XXX-%u", 22222);
593 table_col_bool(test_tbl, test_col3_bool, 1);
594 table_col_double(test_tbl, test_col4_double, 1.5);
595 table_col_printf(test_tbl, test_col4_double, "AAA");
596 table_end_row(test_tbl);
598 table_col_str(test_tbl, test_col0_str, "test");
599 table_append_str(test_tbl, "bbbbb");
600 table_col_int(test_tbl, test_col1_int, -100);
601 table_col_uint(test_tbl, test_col2_uint, 100);
602 table_col_bool(test_tbl, test_col3_bool, 0);
603 table_col_printf(test_tbl, test_col4_double, "%.2lf", 1.5);
604 table_end_row(test_tbl);
607 static void test_simple1(struct fastbuf *out)
609 table_init(&test_tbl);
611 // print table with header
612 table_set_col_order_by_name(&test_tbl, "col3_bool");
613 table_start(&test_tbl, out);
614 do_print1(&test_tbl);
615 table_end(&test_tbl);
617 // print the same table as in the previous case without header
618 table_set_col_order_by_name(&test_tbl, "col0_str,col2_uint,col1_int,col3_bool");
619 table_start(&test_tbl, out);
620 do_print1(&test_tbl);
621 table_end(&test_tbl);
623 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
624 test_tbl.print_header = 0;
625 table_start(&test_tbl, out);
626 do_print1(&test_tbl);
627 table_end(&test_tbl);
628 test_tbl.print_header = 1;
630 table_set_col_order_by_name(&test_tbl, "col3_bool");
631 table_start(&test_tbl, out);
632 do_print1(&test_tbl);
633 table_end(&test_tbl);
635 table_set_col_order_by_name(&test_tbl, "col3_bool,col0_str");
636 table_start(&test_tbl, out);
637 do_print1(&test_tbl);
638 table_end(&test_tbl);
640 table_set_col_order_by_name(&test_tbl, "col0_str,col3_bool,col2_uint");
641 table_start(&test_tbl, out);
642 do_print1(&test_tbl);
643 table_end(&test_tbl);
645 table_set_col_order_by_name(&test_tbl, "col0_str,col3_bool,col2_uint,col0_str,col3_bool,col2_uint,col0_str,col3_bool,col2_uint");
646 table_start(&test_tbl, out);
647 do_print1(&test_tbl);
648 table_end(&test_tbl);
650 table_set_col_order_by_name(&test_tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
651 table_start(&test_tbl, out);
652 do_print1(&test_tbl);
653 table_end(&test_tbl);
655 table_cleanup(&test_tbl);
658 enum test_any_table_cols {
659 test_any_col0_int, test_any_col1_any
662 static uint test_any_column_order[] = { test_any_col0_int, test_any_col1_any };
664 static struct table test_any_tbl = {
666 [test_any_col0_int] = TBL_COL_INT("col0_int", 8),
667 [test_any_col1_any] = TBL_COL_ANY("col1_any", 9),
670 TBL_COL_ORDER(test_any_column_order),
671 TBL_OUTPUT_HUMAN_READABLE,
672 TBL_COL_DELIMITER("\t"),
673 TBL_APPEND_DELIMITER(",")
676 static void test_any_type(struct fastbuf *out)
678 table_init(&test_any_tbl);
680 table_start(&test_any_tbl, out);
682 table_col_int(&test_any_tbl, test_any_col0_int, -10);
683 table_col_int(&test_any_tbl, test_any_col1_any, 10000);
684 table_end_row(&test_any_tbl);
686 table_col_int(&test_any_tbl, test_any_col0_int, -10);
687 table_col_double(&test_any_tbl, test_any_col1_any, 1.4);
688 table_end_row(&test_any_tbl);
690 table_col_printf(&test_any_tbl, test_any_col0_int, "%d", 10);
691 table_append_printf(&test_any_tbl, "%d", 20);
692 table_append_printf(&test_any_tbl, "%d", 30);
693 table_col_double(&test_any_tbl, test_any_col1_any, 1.4);
694 table_append_printf(&test_any_tbl, "%.2lf", 1.5);
695 table_append_printf(&test_any_tbl, "%.2lf", 1.6);
696 table_end_row(&test_any_tbl);
698 table_end(&test_any_tbl);
699 table_cleanup(&test_any_tbl);
702 int main(int argc UNUSED, char **argv UNUSED)
705 out = bfdopen_shared(1, 4096);