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 * TODO: This function deliberately leaks memory. When it is called multiple times,
132 * previous column orders still remain allocated in the table's memory pool.
134 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
136 if(!col_order_str[0]) {
137 tbl->column_order = mp_alloc(tbl->pool, 0);
138 tbl->cols_to_output = 0;
142 char *tmp_col_order = stk_strdup(col_order_str);
145 for(int i = 0; col_order_str[i] != 0; i++) {
146 if(col_order_str[i] == ',') {
151 int *col_order_int = mp_alloc_zero(tbl->pool, sizeof(int) * col_count);
152 int curr_col_order_int = 0;
153 const char *name_start = tmp_col_order;
155 char *next = strchr(name_start, ',');
160 int idx = table_get_col_idx(tbl, name_start);
162 return mp_printf(tbl->pool, "Unknown table column '%s'", name_start);
164 col_order_int[curr_col_order_int++] = idx;
169 tbl->column_order = col_order_int;
170 tbl->cols_to_output = curr_col_order_int;
174 /*** Table cells ***/
176 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
178 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
179 tbl->last_printed_col = col;
180 tbl->row_printing_started = 1;
183 tbl->col_str_ptrs[col] = mp_vprintf(tbl->pool, fmt, args);
187 static const char *table_col_default_fmts[] = {
188 [COL_TYPE_STR] = "%s",
189 [COL_TYPE_INT] = "%d",
190 [COL_TYPE_INTMAX] = "%jd",
191 [COL_TYPE_UINT] = "%u",
192 [COL_TYPE_UINTMAX] = "%ju",
193 [COL_TYPE_BOOL] = "%d",
194 [COL_TYPE_DOUBLE] = "%.2lf",
195 [COL_TYPE_ANY] = NULL,
196 [COL_TYPE_LAST] = NULL
199 #define TABLE_COL(_name_, _type_, _typeconst_) void table_col_##_name_(struct table *tbl, int col, _type_ val) \
201 const char *fmt = tbl->columns[col].fmt;\
202 if(tbl->columns[col].type == COL_TYPE_ANY) {\
203 fmt = table_col_default_fmts[_typeconst_];\
205 table_col_##_name_##_fmt(tbl, col, fmt, val);\
208 #define TABLE_COL_STR(_name_, _type_, _typeconst_) void table_col_##_name_##_name(struct table *tbl, const char *col_name, _type_ val) \
210 int col = table_get_col_idx(tbl, col_name);\
211 table_col_##_name_(tbl, col, val);\
214 #define TABLE_COL_FMT(_name_, _type_, _typeconst_) void table_col_##_name_##_fmt(struct table *tbl, int col, const char *fmt, _type_ val)\
216 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);\
217 ASSERT(tbl->columns[col].type == COL_TYPE_ANY || _typeconst_ == tbl->columns[col].type);\
218 ASSERT(fmt != NULL);\
219 tbl->last_printed_col = col;\
220 tbl->row_printing_started = 1;\
221 tbl->col_str_ptrs[col] = mp_printf(tbl->pool, fmt, val);\
224 #define TABLE_COL_BODIES(_name_, _type_, _typeconst_) TABLE_COL(_name_, _type_, _typeconst_);\
225 TABLE_COL_STR(_name_, _type_, _typeconst_);\
226 TABLE_COL_FMT(_name_, _type_, _typeconst_);
228 TABLE_COL_BODIES(int, int, COL_TYPE_INT)
229 TABLE_COL_BODIES(uint, uint, COL_TYPE_UINT)
230 TABLE_COL_BODIES(double, double, COL_TYPE_DOUBLE)
231 TABLE_COL_BODIES(str, const char *, COL_TYPE_STR)
232 TABLE_COL_BODIES(intmax, intmax_t, COL_TYPE_INTMAX)
233 TABLE_COL_BODIES(uintmax, uintmax_t, COL_TYPE_UINTMAX)
234 TABLE_COL_BODIES(s64, s64, COL_TYPE_S64)
235 TABLE_COL_BODIES(u64, u64, COL_TYPE_U64)
239 #undef TABLE_COL_BODIES
241 void table_col_bool(struct table *tbl, int col, uint val)
243 table_col_bool_fmt(tbl, col, tbl->columns[col].fmt, val);
246 void table_col_bool_name(struct table *tbl, const char *col_name, uint val)
248 int col = table_get_col_idx(tbl, col_name);
249 table_col_bool(tbl, col, val);
252 void table_col_bool_fmt(struct table *tbl, int col, const char *fmt, uint val)
254 ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
255 ASSERT(COL_TYPE_BOOL == tbl->columns[col].type);
257 tbl->last_printed_col = col;
258 tbl->row_printing_started = 1;
259 tbl->col_str_ptrs[col] = mp_printf(tbl->pool, fmt, val ? "true" : "false");
262 #define TABLE_APPEND(_name_, _type_, _typeconst_) void table_append_##_name_(struct table *tbl, _type_ val) \
264 ASSERT(tbl->last_printed_col != -1 || tbl->row_printing_started != 0);\
265 ASSERT(_typeconst_ == tbl->columns[tbl->last_printed_col].type);\
266 int col = tbl->last_printed_col;\
267 mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], "%s", tbl->append_delimiter);\
268 tbl->col_str_ptrs[col] = mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], tbl->columns[col].fmt, val);\
271 TABLE_APPEND(int, int, COL_TYPE_INT)
272 TABLE_APPEND(uint, uint, COL_TYPE_UINT)
273 TABLE_APPEND(double, double, COL_TYPE_DOUBLE)
274 TABLE_APPEND(str, const char *, COL_TYPE_STR)
275 TABLE_APPEND(intmax, intmax_t, COL_TYPE_INTMAX)
276 TABLE_APPEND(uintmax, uintmax_t, COL_TYPE_UINTMAX)
277 TABLE_APPEND(u64, u64, COL_TYPE_U64)
280 void table_append_bool(struct table *tbl, int val)
282 ASSERT(tbl->last_printed_col != -1 || tbl->row_printing_started != 0);
283 ASSERT(COL_TYPE_BOOL == tbl->columns[tbl->last_printed_col].type);
285 int col = tbl->last_printed_col;
287 mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], "%s", tbl->append_delimiter);
289 tbl->col_str_ptrs[col] = mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], tbl->columns[col].fmt, val ? "true" : "false");
292 void table_append_printf(struct table *tbl, const char *fmt, ...)
294 ASSERT(tbl->last_printed_col != -1 || tbl->row_printing_started != 0);
295 int col = tbl->last_printed_col;
300 mp_printf_append(tbl->pool, tbl->col_str_ptrs[col], "%s", tbl->append_delimiter);
301 tbl->col_str_ptrs[col] = mp_vprintf_append(tbl->pool, tbl->col_str_ptrs[col], fmt, args);
306 void table_end_row(struct table *tbl)
308 ASSERT(tbl->formatter->row_output);
309 tbl->formatter->row_output(tbl);
310 memset(tbl->col_str_ptrs, 0, sizeof(char *) * tbl->column_count);
311 mp_restore(tbl->pool, &tbl->pool_state);
312 tbl->last_printed_col = -1;
313 tbl->row_printing_started = 0;
316 /* Construction of a cell using a fastbuf */
318 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
320 fbpool_init(&tbl->fb_col_out);
321 fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
323 return &tbl->fb_col_out.fb;
326 void table_col_fbend(struct table *tbl)
328 tbl->col_str_ptrs[tbl->col_out] = fbpool_end(&tbl->fb_col_out);
332 /*** Option parsing ***/
334 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
336 // Options with no value
337 if(value == NULL || (value != NULL && strlen(value) == 0)) {
338 if(strcmp(key, "noheader") == 0) {
339 tbl->print_header = 0;
344 // Options with a value
346 if(strcmp(key, "header") == 0) {
348 return mp_printf(tbl->pool, "Tableprinter: invalid option: '%s' has invalid value: '%s'.", key, value);
349 uint tmp = value[0] - '0';
351 return mp_printf(tbl->pool, "Tableprinter: invalid option: '%s' has invalid value: '%s'.", key, value);
352 tbl->print_header = tmp;
354 } else if(strcmp(key, "cols") == 0) {
355 const char *err = table_set_col_order_by_name(tbl, value);
357 return mp_printf(tbl->pool, "%s, possible column names are: %s.", err, table_get_col_list(tbl));
360 } else if(strcmp(key, "fmt") == 0) {
361 if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
362 else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
364 return "Tableprinter: invalid argument to output-type option.";
367 } else if(strcmp(key, "col-delim") == 0) {
368 char * d = mp_printf(tbl->pool, "%s", value);
369 tbl->col_delimiter = d;
375 if(tbl->formatter && tbl->formatter->process_option) {
376 const char *err = NULL;
377 if (tbl->formatter->process_option(tbl, key, value, &err)) {
382 // Unrecognized option
383 return mp_printf(tbl->pool, "Tableprinter: invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
386 const char *table_set_option(struct table *tbl, const char *opt)
388 char *key = stk_strdup(opt);
389 char *value = strchr(key, ':');
393 return table_set_option_value(tbl, key, value);
396 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
398 for (uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
399 const char *rv = table_set_option(tbl, gary_table_opts[i]);
407 /*** Default formatter for human-readable output ***/
409 static void table_row_human_readable(struct table *tbl)
411 for(uint i = 0; i < tbl->cols_to_output; i++) {
412 int col_idx = tbl->column_order[i];
414 bputs(tbl->out, tbl->col_delimiter);
416 int col_width = tbl->columns[col_idx].width & CELL_ALIGN_MASK;
417 if(tbl->columns[col_idx].width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
418 bprintf(tbl->out, "%*s", col_width, tbl->col_str_ptrs[col_idx]);
420 bputc(tbl->out, '\n');
423 static void table_write_header(struct table *tbl)
425 for(uint i = 0; i < tbl->cols_to_output; i++) {
426 int col_idx = tbl->column_order[i];
428 bputs(tbl->out, tbl->col_delimiter);
430 int col_width = tbl->columns[col_idx].width & CELL_ALIGN_MASK;
431 if(tbl->columns[col_idx].width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
432 bprintf(tbl->out, "%*s", col_width, tbl->columns[col_idx].name);
434 bputc(tbl->out, '\n');
437 static void table_start_human_readable(struct table *tbl)
439 if(tbl->col_delimiter == NULL) {
440 tbl->col_delimiter = " ";
443 if(tbl->append_delimiter == NULL) {
444 tbl->append_delimiter = ",";
447 if(tbl->print_header != 0) {
448 table_write_header(tbl);
452 struct table_formatter table_fmt_human_readable = {
453 .row_output = table_row_human_readable,
454 .table_start = table_start_human_readable,
457 /*** Default formatter for machine-readable output ***/
459 static void table_row_machine_readable(struct table *tbl)
461 for(uint i = 0; i < tbl->cols_to_output; i++) {
462 int col_idx = tbl->column_order[i];
464 bputs(tbl->out, tbl->col_delimiter);
466 bputs(tbl->out, tbl->col_str_ptrs[col_idx]);
468 bputc(tbl->out, '\n');
471 static void table_start_machine_readable(struct table *tbl)
473 if(tbl->col_delimiter == NULL) {
474 tbl->col_delimiter = ";";
477 if(tbl->append_delimiter == NULL) {
478 tbl->append_delimiter = ",";
481 if(tbl->print_header != 0) {
482 uint col_idx = tbl->column_order[0];
483 bputs(tbl->out, tbl->columns[col_idx].name);
484 for(uint i = 1; i < tbl->cols_to_output; i++) {
485 col_idx = tbl->column_order[i];
486 bputs(tbl->out, tbl->col_delimiter);
487 bputs(tbl->out, tbl->columns[col_idx].name);
489 bputc(tbl->out, '\n');
493 struct table_formatter table_fmt_machine_readable = {
494 .row_output = table_row_machine_readable,
495 .table_start = table_start_machine_readable,
504 enum test_table_cols {
505 test_col0_str, test_col1_int, test_col2_uint, test_col3_bool, test_col4_double
508 static uint test_column_order[] = {test_col3_bool, test_col4_double, test_col2_uint,test_col1_int, test_col0_str};
510 static struct table test_tbl = {
512 [test_col0_str] = TBL_COL_STR("col0_str", 20),
513 [test_col1_int] = TBL_COL_INT("col1_int", 8),
514 [test_col2_uint] = TBL_COL_UINT("col2_uint", 9),
515 [test_col3_bool] = TBL_COL_BOOL("col3_bool", 9),
516 [test_col4_double] = TBL_COL_DOUBLE("col4_double", 11, 2),
519 TBL_COL_ORDER(test_column_order),
520 TBL_OUTPUT_HUMAN_READABLE,
521 TBL_COL_DELIMITER("\t"),
522 TBL_APPEND_DELIMITER(",")
526 * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
528 static void do_print1(struct table *test_tbl)
530 table_col_str(test_tbl, test_col0_str, "sdsdf");
531 table_append_str(test_tbl, "aaaaa");
532 table_col_int(test_tbl, test_col1_int, -10);
533 table_col_int(test_tbl, test_col1_int, 10000);
534 table_col_uint(test_tbl, test_col2_uint, 10);
535 table_col_printf(test_tbl, test_col2_uint, "XXX-%u", 22222);
536 table_col_bool(test_tbl, test_col3_bool, 1);
537 table_col_double(test_tbl, test_col4_double, 1.5);
538 table_col_printf(test_tbl, test_col4_double, "AAA");
539 table_end_row(test_tbl);
541 table_col_str(test_tbl, test_col0_str, "test");
542 table_append_str(test_tbl, "bbbbb");
543 table_col_int(test_tbl, test_col1_int, -100);
544 table_col_uint(test_tbl, test_col2_uint, 100);
545 table_col_bool(test_tbl, test_col3_bool, 0);
546 table_col_printf(test_tbl, test_col4_double, "%.2lf", 1.5);
547 table_end_row(test_tbl);
550 static void test_simple1(struct fastbuf *out)
552 table_init(&test_tbl);
554 // print table with header
555 table_set_col_order_by_name(&test_tbl, "col3_bool");
556 table_start(&test_tbl, out);
557 do_print1(&test_tbl);
558 table_end(&test_tbl);
560 // print the same table as in the previous case without header
561 table_set_col_order_by_name(&test_tbl, "col0_str,col2_uint,col1_int,col3_bool");
562 table_start(&test_tbl, out);
563 do_print1(&test_tbl);
564 table_end(&test_tbl);
566 // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
567 test_tbl.print_header = 0;
568 table_start(&test_tbl, out);
569 do_print1(&test_tbl);
570 table_end(&test_tbl);
571 test_tbl.print_header = 1;
573 table_set_col_order_by_name(&test_tbl, "col3_bool");
574 table_start(&test_tbl, out);
575 do_print1(&test_tbl);
576 table_end(&test_tbl);
578 table_set_col_order_by_name(&test_tbl, "col3_bool,col0_str");
579 table_start(&test_tbl, out);
580 do_print1(&test_tbl);
581 table_end(&test_tbl);
583 table_set_col_order_by_name(&test_tbl, "col0_str,col3_bool,col2_uint");
584 table_start(&test_tbl, out);
585 do_print1(&test_tbl);
586 table_end(&test_tbl);
588 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");
589 table_start(&test_tbl, out);
590 do_print1(&test_tbl);
591 table_end(&test_tbl);
593 table_set_col_order_by_name(&test_tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
594 table_start(&test_tbl, out);
595 do_print1(&test_tbl);
596 table_end(&test_tbl);
598 table_cleanup(&test_tbl);
601 enum test_any_table_cols {
602 test_any_col0_int, test_any_col1_any
605 static uint test_any_column_order[] = { test_any_col0_int, test_any_col1_any };
607 static struct table test_any_tbl = {
609 [test_any_col0_int] = TBL_COL_INT("col0_int", 8),
610 [test_any_col1_any] = TBL_COL_ANY("col1_any", 9),
613 TBL_COL_ORDER(test_any_column_order),
614 TBL_OUTPUT_HUMAN_READABLE,
615 TBL_COL_DELIMITER("\t"),
616 TBL_APPEND_DELIMITER(",")
619 static void test_any_type(struct fastbuf *out)
621 table_init(&test_any_tbl);
623 table_start(&test_any_tbl, out);
625 table_col_int(&test_any_tbl, test_any_col0_int, -10);
626 table_col_int(&test_any_tbl, test_any_col1_any, 10000);
627 table_end_row(&test_any_tbl);
629 table_col_int(&test_any_tbl, test_any_col0_int, -10);
630 table_col_double(&test_any_tbl, test_any_col1_any, 1.4);
631 table_end_row(&test_any_tbl);
633 table_col_printf(&test_any_tbl, test_any_col0_int, "%d", 10);
634 table_append_printf(&test_any_tbl, "%d", 20);
635 table_append_printf(&test_any_tbl, "%d", 30);
636 table_col_double(&test_any_tbl, test_any_col1_any, 1.4);
637 table_append_printf(&test_any_tbl, "%.2lf", 1.5);
638 table_append_printf(&test_any_tbl, "%.2lf", 1.6);
639 table_end_row(&test_any_tbl);
641 table_end(&test_any_tbl);
642 table_cleanup(&test_any_tbl);
645 int main(int argc UNUSED, char **argv UNUSED)
648 out = bfdopen_shared(1, 4096);