ucw/table.c

   1 /*
   2  *      UCW Library -- Table printer
   3  *
   4  *      (c) 2014 Robert Kessl <robert.kessl@economia.cz>
   5  */
   6
   7 #include <ucw/lib.h>
   8 #include <ucw/string.h>
   9 #include <ucw/stkstring.h>
  10 #include <ucw/gary.h>
  11 #include <ucw/table.h>
  12 #include <ucw/strtonum.h>
  13
  14 #include <stdlib.h>
  15 #include <stdio.h>
  16
  17 /* Forward declarations */
  18
  19 static void table_update_ll(struct table *tbl);
  20
  21 /*** Management of tables ***/
  22
  23 struct table *table_init(const struct table_template *tbl_template)
  24 {
  25   struct mempool *pool = mp_new(4096);
  26   struct table *new_inst = mp_alloc_zero(pool, sizeof(struct table));
  27
  28   new_inst->pool = pool;
  29
  30   // initialize column definitions
  31   uint col_count = 0; // count the number of columns in the struct table
  32   for(;;) {
  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)
  36       break;
  37     ASSERT(tbl_template->columns[col_count].name != NULL);
  38     ASSERT(tbl_template->columns[col_count].width != 0);
  39
  40     col_count++;
  41   }
  42   new_inst->column_count = col_count;
  43
  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;
  48   }
  49
  50   // initialize column_order
  51   if(tbl_template->column_order) {
  52     int cols_to_output = 0;
  53     for(; ; cols_to_output++) {
  54       if(tbl_template->column_order[cols_to_output].idx == ~0U) break;
  55     }
  56
  57     new_inst->column_order = mp_alloc_zero(new_inst->pool, sizeof(struct table_col_instance) * cols_to_output);
  58     memcpy(new_inst->column_order, tbl_template->column_order, sizeof(struct table_col_instance) * cols_to_output);
  59     for(uint i = 0; i < new_inst->cols_to_output; i++) {
  60       new_inst->column_order[i].cell_content = NULL;
  61       int col_def_idx = new_inst->column_order[i].idx;
  62       new_inst->column_order[i].col_def = new_inst->columns + col_def_idx;
  63       new_inst->column_order[i].fmt = tbl_template->columns[col_def_idx].fmt;
  64     }
  65
  66     new_inst->cols_to_output = cols_to_output;
  67   }
  68
  69   new_inst->col_delimiter = tbl_template->col_delimiter;
  70   new_inst->print_header = true;
  71   new_inst->out = 0;
  72   new_inst->row_printing_started = false;
  73   new_inst->col_out = -1;
  74   new_inst->formatter = tbl_template->formatter;
  75   if(!new_inst->formatter) {
  76     new_inst->formatter = &table_fmt_human_readable;
  77   }
  78   new_inst->formatter_data = NULL;
  79   return new_inst;
  80 }
  81
  82 void table_cleanup(struct table *tbl)
  83 {
  84   mp_delete(tbl->pool);
  85 }
  86
  87 // TODO: test default column order
  88 static void table_make_default_column_order(struct table *tbl)
  89 {
  90   struct table_col_instance *col_order = alloca(sizeof(struct table_col_instance) * (tbl->column_count + 1));
  91   bzero(col_order, sizeof(struct table_col_instance) * tbl->column_count);
  92
  93   for(int i = 0; i < tbl->column_count; i++) {
  94     col_order[i].idx = (uint) i;
  95     // currently, XTYPE_FMT_DEFAULT is 0, so bzero actually sets it correctly. This makes it more explicit.
  96     col_order[i].fmt = XTYPE_FMT_DEFAULT;
  97   }
  98   struct table_col_instance tbl_col_order_end = TBL_COL_ORDER_END;
  99   col_order[tbl->column_count] = tbl_col_order_end;
 100
 101   table_set_col_order(tbl, col_order);
 102 }
 103
 104 void table_start(struct table *tbl, struct fastbuf *out)
 105 {
 106   tbl->row_printing_started = false;
 107   tbl->out = out;
 108
 109   ASSERT_MSG(tbl->out, "Output fastbuf not specified.");
 110
 111   if(tbl->column_order == NULL) table_make_default_column_order(tbl);
 112   // update linked lists
 113   table_update_ll(tbl);
 114   if(tbl->formatter->table_start != NULL) tbl->formatter->table_start(tbl);
 115
 116   mp_save(tbl->pool, &tbl->pool_state);
 117
 118   ASSERT_MSG(tbl->col_delimiter, "Column delimiter not specified.");
 119 }
 120
 121 void table_end(struct table *tbl)
 122 {
 123   tbl->row_printing_started = false;
 124
 125   mp_restore(tbl->pool, &tbl->pool_state);
 126
 127   if(tbl->formatter->table_end) tbl->formatter->table_end(tbl);
 128 }
 129
 130 /*** Configuration ***/
 131
 132 void table_set_formatter(struct table *tbl, const struct table_formatter *fmt)
 133 {
 134   tbl->formatter = fmt;
 135 }
 136
 137 int table_get_col_idx(struct table *tbl, const char *col_name)
 138 {
 139   for(int i = 0; i < tbl->column_count; i++) {
 140     if(strcmp(tbl->columns[i].name, col_name) == 0) return i;
 141   }
 142   return -1;
 143 }
 144
 145 const char * table_get_col_list(struct table *tbl)
 146 {
 147   if(tbl->column_count == 0) return "";
 148
 149   char *tmp = mp_strdup(tbl->pool, tbl->columns[0].name);
 150
 151   for(int i = 1; i < tbl->column_count; i++) {
 152     tmp = mp_printf_append(tbl->pool, tmp, ", %s", tbl->columns[i].name);
 153   }
 154
 155   return tmp;
 156 }
 157
 158 static void table_update_ll(struct table *tbl)
 159 {
 160   int cols_to_output = tbl->cols_to_output;
 161
 162   for(int i = 0; i < tbl->column_count; i++) {
 163     tbl->ll_headers[i] = -1;
 164   }
 165
 166   for(int i = 0; i < cols_to_output; i++) {
 167     int col_def_idx = tbl->column_order[i].idx;
 168     tbl->column_order[i].col_def = tbl->columns + col_def_idx;
 169   }
 170
 171   for(int i = 0; i < cols_to_output; i++) {
 172     int col_def_idx = tbl->column_order[i].idx;
 173     int first = tbl->ll_headers[col_def_idx];
 174     tbl->ll_headers[col_def_idx] = i;
 175     tbl->column_order[i].next_column = first;
 176   }
 177 }
 178
 179 void table_set_col_order(struct table *tbl, const struct table_col_instance *col_order)
 180 {
 181   uint cols_to_output = 0;
 182   for(; ; cols_to_output++) {
 183     if(col_order[cols_to_output].idx == ~0U) break;
 184     ASSERT_MSG(col_order[cols_to_output].idx < (uint) tbl->column_count,
 185                "Column %d does not exist; column number should be between 0 and %d(including).", col_order[cols_to_output].idx, tbl->column_count - 1);
 186   }
 187
 188   tbl->cols_to_output = cols_to_output;
 189   tbl->column_order = mp_alloc(tbl->pool, sizeof(struct table_col_instance) * cols_to_output);
 190   memcpy(tbl->column_order, col_order, sizeof(struct table_col_instance) * cols_to_output);
 191   for(uint i = 0; i < cols_to_output; i++) {
 192     int col_def_idx = tbl->column_order[i].idx; // this is given in arg @col_order
 193     tbl->column_order[i].col_def = tbl->columns + col_def_idx;
 194     tbl->column_order[i].cell_content = NULL; // cell_content is copied from arg @col_order, so make sure that it is NULL
 195     tbl->column_order[i].next_column = -1;
 196     // tbl->column_order[i].fmt should be untouched (copied from arg @col_order)
 197   }
 198 }
 199
 200 bool table_col_is_printed(struct table *tbl, uint col_def_idx)
 201 {
 202   if(tbl->ll_headers[col_def_idx] == -1) return false;
 203
 204   return true;
 205 }
 206
 207 const char *table_set_col_opt(struct table *tbl, uint col_inst_idx, const char *col_opt)
 208 {
 209   const struct table_column *col_def = tbl->column_order[col_inst_idx].col_def;
 210
 211   // Make sure that we do not call table_set_col_opt, which would
 212   // result in an infinite recursion.
 213   if(col_def && col_def->set_col_opt) {
 214     ASSERT_MSG(col_def->set_col_opt != table_set_col_opt,"table_set_col_opt should not be used as a struct table_column::set_col_opt hook");
 215     return col_def->set_col_opt(tbl, col_inst_idx, col_opt);
 216   }
 217
 218   if(col_def && col_def->type_def) {
 219     u32 fmt = 0;
 220     const char *tmp_err = xtype_parse_fmt(col_def->type_def, col_opt, &fmt, tbl->pool);
 221     if(tmp_err) return mp_printf(tbl->pool, "Invalid column format; xtypes error: '%s'.", tmp_err);
 222     tbl->column_order[col_inst_idx].fmt = fmt;
 223     return NULL;
 224   }
 225
 226   return mp_printf(tbl->pool, "Invalid column format option: '%s' for column %d.", col_opt, col_inst_idx);
 227 }
 228
 229 /**
 230  * the input is a null-terminated string that contains: "<col-name>'['<param1>','<param2>\0
 231  * i.e., the ']' is missing and is replaced by \0.
 232  * the function replace the '[' by \0 and then parses the rest of the string.
 233  **/
 234 static char **table_parse_col_arg2(char *col_def)
 235 {
 236   char * left_br = strchr(col_def, '[');
 237   if(left_br == NULL) return NULL;
 238
 239   *left_br = 0;
 240   left_br++;
 241
 242   char *col_opt = left_br;
 243
 244   char *next = NULL;
 245   char **result = NULL;
 246   GARY_INIT(result, 0);
 247   for(;;) {
 248     next = strchr(col_opt, ',');
 249     if(!next) break;
 250     if(*next == 0) break;
 251     *next = 0;
 252     next++;
 253     if(*col_opt)
 254       *GARY_PUSH(result) = col_opt;
 255
 256     col_opt = next;
 257   }
 258   if(*col_opt)
 259     *GARY_PUSH(result) = col_opt;
 260
 261   return result;
 262 }
 263
 264 /**
 265  * TODO: This function deliberately leaks memory. When it is called multiple times,
 266  * previous column orders still remain allocated in the table's memory pool.
 267  **/
 268 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
 269 {
 270   if(col_order_str[0] == '*') {
 271     table_make_default_column_order(tbl);
 272     return NULL;
 273   }
 274
 275   if(!col_order_str[0]) {
 276     tbl->column_order = mp_alloc(tbl->pool, 0);
 277     tbl->cols_to_output = 0;
 278     return NULL;
 279   }
 280
 281   char *tmp_col_order = stk_strdup(col_order_str);
 282
 283   int col_count = 1;
 284   bool inside_brackets = false;
 285   for(int i = 0; col_order_str[i] != 0; i++) {
 286     if(col_order_str[i] == '[')  inside_brackets = true;
 287     if(col_order_str[i] == ']')  inside_brackets = false;
 288     if(!inside_brackets && col_order_str[i] == ',') {
 289       col_count++;
 290     }
 291   }
 292
 293   tbl->cols_to_output = col_count;
 294   tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
 295
 296   int curr_col_inst_idx = 0;
 297   char *name_start = tmp_col_order;
 298   while(name_start) {
 299     char *next = strpbrk(name_start, "[,");
 300     if(next && *next == '[') {
 301       next = strchr(next, ']');
 302       if(!next) return mp_printf(tbl->pool, "Invalid column definition, missing ']'.");
 303       *next++ = 0;
 304       next = *next == 0 ? NULL : next + 1; // if next points to the last \0 => end the computation
 305     } else if(next) {
 306       *next++ = 0;
 307     }
 308
 309     char **args = table_parse_col_arg2(name_start); // this sets 0 on the '['
 310     int col_def_idx = table_get_col_idx(tbl, name_start);
 311
 312     if(col_def_idx == -1) {
 313       return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
 314     }
 315     tbl->column_order[curr_col_inst_idx].col_def = tbl->columns + col_def_idx;
 316     tbl->column_order[curr_col_inst_idx].idx = col_def_idx;
 317     tbl->column_order[curr_col_inst_idx].fmt = tbl->columns[col_def_idx].fmt;
 318     if(args) {
 319       for(uint i = 0; i < GARY_SIZE(args); i++) {
 320         const char *err = NULL;
 321         err = table_set_col_opt(tbl, curr_col_inst_idx, args[i]);
 322         if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
 323       }
 324       GARY_FREE(args);
 325    }
 326
 327     name_start = next;
 328     curr_col_inst_idx++;
 329   }
 330
 331   return NULL;
 332 }
 333
 334 /*** Table cells ***/
 335
 336 /**
 337  * The TBL_COL_ITER_START macro are used for iterating over all instances of a particular column in
 338  * table _tbl.  _colidx is the column index in _tbl, _instptr is the pointer to the column instance
 339  * (struct table_col_instance *), _idxval is the index of current column index. The variables are
 340  * enclosed in a block, so they do not introduce variable name collisions.
 341  *
 342  * The TBL_COL_ITER_END macro must close the block started with TBL_COL_ITER_START.
 343  *
 344  * These macros are usually used to hide the implementation details of the column instances linked
 345  * list. This is usefull for definition of new types.
 346  **/
 347 #define TBL_COL_ITER_START(_tbl, _colidx, _instptr, _idxval) { struct table_col_instance *_instptr = NULL; int _idxval = _tbl->ll_headers[_colidx]; \
 348   for(_idxval = _tbl->ll_headers[_colidx], _instptr = _tbl->column_order + _idxval; _idxval != -1; _idxval = _tbl->column_order[_idxval].next_column, _instptr = _tbl->column_order + _idxval)
 349
 350 #define TBL_COL_ITER_END }
 351
 352 static void table_col_raw(struct table *tbl, int col_templ, const char *col_content)
 353 {
 354   TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
 355     curr_col_ptr->cell_content = col_content;
 356   } TBL_COL_ITER_END
 357 }
 358
 359 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type)
 360 {
 361   ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
 362   ASSERT(tbl->columns[col].type_def == COL_TYPE_ANY || expected_type == tbl->columns[col].type_def);
 363   tbl->row_printing_started = true;
 364   TBL_COL_ITER_START(tbl, col, curr_col, curr_col_inst_idx) {
 365     enum xtype_fmt fmt = curr_col->fmt;
 366     curr_col->cell_content = expected_type->format(value, fmt, tbl->pool);
 367   } TBL_COL_ITER_END
 368 }
 369
 370 #undef TBL_COL_ITER_START
 371 #undef TBL_COL_ITER_END
 372
 373 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
 374 {
 375   ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
 376   tbl->row_printing_started = true;
 377   va_list args;
 378   va_start(args, fmt);
 379   char *cell_content = mp_vprintf(tbl->pool, fmt, args);
 380   table_col_raw(tbl, col, cell_content);
 381   va_end(args);
 382 }
 383
 384 TABLE_COL_BODY(int, int)
 385 TABLE_COL_BODY(uint, uint)
 386 TABLE_COL_BODY(double, double)
 387 TABLE_COL_BODY(intmax, intmax_t)
 388 TABLE_COL_BODY(uintmax, uintmax_t)
 389 TABLE_COL_BODY(s64, s64)
 390 TABLE_COL_BODY(u64, u64)
 391 TABLE_COL_BODY(bool, bool)
 392 TABLE_COL_BODY(str, const char *)
 393
 394 void table_reset_row(struct table *tbl)
 395 {
 396   for(uint i = 0; i < tbl->cols_to_output; i++) {
 397     tbl->column_order[i].cell_content = NULL;
 398   }
 399   mp_restore(tbl->pool, &tbl->pool_state);
 400   tbl->row_printing_started = false;
 401 }
 402
 403 void table_end_row(struct table *tbl)
 404 {
 405   ASSERT(tbl->formatter->row_output);
 406   if(tbl->row_printing_started == false) return;
 407   tbl->formatter->row_output(tbl);
 408   table_reset_row(tbl);
 409 }
 410
 411 /* Construction of a cell using a fastbuf */
 412
 413 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
 414 {
 415   fbpool_init(&tbl->fb_col_out);
 416   fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
 417   tbl->col_out = col;
 418   return &tbl->fb_col_out.fb;
 419 }
 420
 421 void table_col_fbend(struct table *tbl)
 422 {
 423   char *cell_content = fbpool_end(&tbl->fb_col_out);
 424   table_col_raw(tbl, tbl->col_out, cell_content);
 425   tbl->col_out = -1;
 426 }
 427
 428 /*** Option parsing ***/
 429
 430 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
 431 {
 432   // Options with no value
 433   if(value == NULL || (value != NULL && strlen(value) == 0)) {
 434     if(strcmp(key, "noheader") == 0) {
 435       tbl->print_header = false;
 436       return NULL;
 437     }
 438   }
 439
 440   // Options with a value
 441   if(value) {
 442     if(strcmp(key, "header") == 0) {
 443       bool tmp;
 444       const char *err = xt_bool.parse(value, &tmp, tbl->pool);
 445       if(err)
 446         return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
 447
 448       tbl->print_header = tmp;
 449
 450       return NULL;
 451     } else if(strcmp(key, "cols") == 0) {
 452       return table_set_col_order_by_name(tbl, value);
 453     } else if(strcmp(key, "fmt") == 0) {
 454       if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
 455       else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
 456       else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
 457       else {
 458         return "Invalid argument to output-type option.";
 459       }
 460       return NULL;
 461     } else if(strcmp(key, "cells") == 0) {
 462       u32 fmt = 0;
 463       const char *err = xtype_parse_fmt(NULL, value, &fmt, tbl->pool);
 464       if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
 465       for(uint i = 0; i < tbl->cols_to_output; i++) {
 466         tbl->column_order[i].fmt = fmt;
 467       }
 468       return NULL;
 469     } else if(strcmp(key, "raw") == 0 || strcmp(key, "pretty") == 0) {
 470       u32 fmt = 0;
 471       const char *err = xtype_parse_fmt(NULL, key, &fmt, tbl->pool);
 472       if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
 473       for(uint i = 0; i < tbl->cols_to_output; i++) {
 474         tbl->column_order[i].fmt = fmt;
 475       }
 476       return NULL;
 477     } else if(strcmp(key, "col-delim") == 0) {
 478       char * d = mp_printf(tbl->pool, "%s", value);
 479       tbl->col_delimiter = d;
 480       return NULL;
 481     }
 482   }
 483
 484   // Formatter options
 485   if(tbl->formatter && tbl->formatter->process_option) {
 486     const char *err = NULL;
 487     if(tbl->formatter->process_option(tbl, key, value, &err)) {
 488       return err;
 489     }
 490   }
 491
 492   // Unrecognized option
 493   return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
 494 }
 495
 496 const char *table_set_option(struct table *tbl, const char *opt)
 497 {
 498   char *key = stk_strdup(opt);
 499   char *value = strchr(key, ':');
 500   if(value) {
 501     *value++ = 0;
 502   }
 503   return table_set_option_value(tbl, key, value);
 504 }
 505
 506 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
 507 {
 508   for(uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
 509     const char *rv = table_set_option(tbl, gary_table_opts[i]);
 510     if(rv != NULL) {
 511       return rv;
 512     }
 513   }
 514   return NULL;
 515 }
 516
 517 /*** Default formatter for human-readable output ***/
 518
 519 static void table_row_human_readable(struct table *tbl)
 520 {
 521   for(uint i = 0; i < tbl->cols_to_output; i++) {
 522     const struct table_column *col_def = tbl->column_order[i].col_def;
 523     if(i) {
 524       bputs(tbl->out, tbl->col_delimiter);
 525     }
 526     int col_width = col_def->width & CELL_WIDTH_MASK;
 527     if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
 528     bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
 529   }
 530   bputc(tbl->out, '\n');
 531 }
 532
 533 static void table_write_header(struct table *tbl)
 534 {
 535   for(uint i = 0; i < tbl->cols_to_output; i++) {
 536     const struct table_column *col_def = tbl->column_order[i].col_def;
 537     if(i) {
 538       bputs(tbl->out, tbl->col_delimiter);
 539     }
 540     int col_width = col_def->width & CELL_WIDTH_MASK;
 541     if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
 542     bprintf(tbl->out, "%*s", col_width, col_def->name);
 543   }
 544   bputc(tbl->out, '\n');
 545 }
 546
 547 static void table_start_human_readable(struct table *tbl)
 548 {
 549   if(tbl->col_delimiter == NULL) {
 550     tbl->col_delimiter = " ";
 551   }
 552
 553   if(tbl->print_header != false) {
 554     table_write_header(tbl);
 555   }
 556 }
 557
 558 const struct table_formatter table_fmt_human_readable = {
 559   .row_output = table_row_human_readable,
 560   .table_start = table_start_human_readable,
 561 };
 562
 563 /*** Default formatter for machine-readable output ***/
 564
 565 static void table_row_machine_readable(struct table *tbl)
 566 {
 567   for(uint i = 0; i < tbl->cols_to_output; i++) {
 568     if(i) {
 569       bputs(tbl->out, tbl->col_delimiter);
 570     }
 571     bputs(tbl->out, tbl->column_order[i].cell_content);
 572   }
 573   bputc(tbl->out, '\n');
 574 }
 575
 576 static void table_start_machine_readable(struct table *tbl)
 577 {
 578   if(tbl->col_delimiter == NULL) {
 579     tbl->col_delimiter = "\t";
 580   }
 581
 582   if(tbl->print_header != false && tbl->cols_to_output > 0) {
 583     bputs(tbl->out, tbl->column_order[0].col_def->name);
 584     for(uint i = 1; i < tbl->cols_to_output; i++) {
 585       bputs(tbl->out, tbl->col_delimiter);
 586       bputs(tbl->out, tbl->column_order[i].col_def->name);
 587     }
 588     bputc(tbl->out, '\n');
 589   }
 590 }
 591
 592 const struct table_formatter table_fmt_machine_readable = {
 593   .row_output = table_row_machine_readable,
 594   .table_start = table_start_machine_readable,
 595 };
 596
 597
 598 /*** Blockline formatter ***/
 599
 600 static void table_row_blockline_output(struct table *tbl)
 601 {
 602   for(uint i = 0; i < tbl->cols_to_output; i++) {
 603     const struct table_column *col_def = tbl->column_order[i].col_def;
 604     bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
 605   }
 606   bputc(tbl->out, '\n');
 607 }
 608
 609 static void table_start_blockline(struct table *tbl)
 610 {
 611   if(tbl->col_delimiter == NULL) {
 612     tbl->col_delimiter = "\n";
 613   }
 614 }
 615
 616 const struct table_formatter table_fmt_blockline = {
 617   .row_output = table_row_blockline_output,
 618   .table_start = table_start_blockline
 619 };
 620
 621 /*** Tests ***/
 622
 623 #ifdef TEST
 624
 625 #include <stdio.h>
 626
 627 enum test_table_cols {
 628   TEST_COL0_STR, TEST_COL1_INT, TEST_COL2_UINT, TEST_COL3_BOOL, TEST_COL4_DOUBLE
 629 };
 630
 631 static struct table_col_instance test_column_order[] = { TBL_COL(TEST_COL3_BOOL), TBL_COL(TEST_COL4_DOUBLE),
 632                       TBL_COL(TEST_COL2_UINT), TBL_COL(TEST_COL1_INT), TBL_COL(TEST_COL0_STR), TBL_COL_ORDER_END };
 633
 634 static struct table_template test_tbl = {
 635   TBL_COLUMNS {
 636     [TEST_COL0_STR] = TBL_COL_STR("col0_str", 20),
 637     [TEST_COL1_INT] = TBL_COL_INT("col1_int", 8),
 638     [TEST_COL2_UINT] = TBL_COL_UINT("col2_uint", 9),
 639     [TEST_COL3_BOOL] = TBL_COL_BOOL_FMT("col3_bool", 9, XTYPE_FMT_PRETTY),
 640     [TEST_COL4_DOUBLE] = TBL_COL_DOUBLE("col4_double", 11),
 641     TBL_COL_END
 642   },
 643   TBL_COL_ORDER(test_column_order),
 644   TBL_FMT_HUMAN_READABLE,
 645   TBL_COL_DELIMITER("\t"),
 646 };
 647
 648 /**
 649  * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
 650  **/
 651 static void do_print1(struct table *test_tbl)
 652 {
 653   table_col_str(test_tbl, TEST_COL0_STR, "sdsdf");
 654   table_col_int(test_tbl, TEST_COL1_INT, -10);
 655   table_col_int(test_tbl, TEST_COL1_INT, 10000);
 656   table_col_uint(test_tbl, TEST_COL2_UINT, 10);
 657   table_col_printf(test_tbl, TEST_COL2_UINT, "XXX-%u", 22222);
 658   table_col_bool(test_tbl, TEST_COL3_BOOL, true);
 659   table_col_double(test_tbl, TEST_COL4_DOUBLE, 1.5);
 660   table_col_printf(test_tbl, TEST_COL4_DOUBLE, "AAA");
 661   table_end_row(test_tbl);
 662
 663   table_col_str(test_tbl, TEST_COL0_STR, "test");
 664   table_col_int(test_tbl, TEST_COL1_INT, -100);
 665   table_col_uint(test_tbl, TEST_COL2_UINT, 100);
 666   table_col_bool(test_tbl, TEST_COL3_BOOL, false);
 667   table_col_printf(test_tbl, TEST_COL4_DOUBLE, "%.2lf", 1.5);
 668   table_end_row(test_tbl);
 669 }
 670
 671 static void test_simple1(struct fastbuf *out)
 672 {
 673   struct table *tbl = table_init(&test_tbl);
 674
 675   // print table with header
 676   table_set_col_order_by_name(tbl, "col3_bool");
 677   table_start(tbl, out);
 678   do_print1(tbl);
 679   table_end(tbl);
 680
 681   // print the same table as in the previous case without header
 682   table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
 683   table_start(tbl, out);
 684   do_print1(tbl);
 685   table_end(tbl);
 686
 687   // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
 688   tbl->print_header = false;
 689   table_start(tbl, out);
 690   do_print1(tbl);
 691   table_end(tbl);
 692   tbl->print_header = true;
 693
 694   table_set_col_order_by_name(tbl, "col3_bool");
 695   table_start(tbl, out);
 696   do_print1(tbl);
 697   table_end(tbl);
 698
 699   table_set_col_order_by_name(tbl, "col3_bool,col0_str");
 700   table_start(tbl, out);
 701   do_print1(tbl);
 702   table_end(tbl);
 703
 704   table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
 705   table_start(tbl, out);
 706   do_print1(tbl);
 707   table_end(tbl);
 708
 709   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");
 710   table_start(tbl, out);
 711   do_print1(tbl);
 712   table_end(tbl);
 713
 714   table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
 715   table_start(tbl, out);
 716   do_print1(tbl);
 717   table_end(tbl);
 718
 719
 720   // test table_col_order_fmt
 721   struct table_col_instance col_order[] = { TBL_COL(TEST_COL0_STR), TBL_COL_FMT(TEST_COL4_DOUBLE, XTYPE_FMT_PRETTY), TBL_COL_FMT(TEST_COL4_DOUBLE, XTYPE_FMT_RAW), TBL_COL_ORDER_END };
 722   table_set_col_order(tbl, col_order);
 723   table_start(tbl, out);
 724
 725   table_col_str(tbl, TEST_COL0_STR, "test");
 726   table_col_double(tbl, TEST_COL4_DOUBLE, 1.23456789);
 727   table_end_row(tbl);
 728
 729   table_col_str(tbl, TEST_COL0_STR, "test");
 730   table_col_double(tbl, TEST_COL4_DOUBLE, 1.23456789);
 731   table_end_row(tbl);
 732
 733   table_end(tbl);
 734
 735   table_cleanup(tbl);
 736 }
 737
 738 enum test_any_table_cols {
 739   TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
 740 };
 741
 742 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), TBL_COL_ORDER_END };
 743
 744 static struct table_template test_any_tbl = {
 745   TBL_COLUMNS {
 746     [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
 747     [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
 748     TBL_COL_END
 749   },
 750   TBL_COL_ORDER(test_any_column_order),
 751   TBL_FMT_HUMAN_READABLE,
 752   TBL_COL_DELIMITER("\t"),
 753 };
 754
 755 static void test_any_type(struct fastbuf *out)
 756 {
 757   struct table *tbl = table_init(&test_any_tbl);
 758
 759   table_start(tbl, out);
 760
 761   table_col_int(tbl, TEST_ANY_COL0_INT, -10);
 762   table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
 763   table_end_row(tbl);
 764
 765   table_col_int(tbl, TEST_ANY_COL0_INT, -10);
 766   table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
 767   table_end_row(tbl);
 768
 769   table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
 770   table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
 771   table_end_row(tbl);
 772
 773   table_end(tbl);
 774   table_cleanup(tbl);
 775 }
 776
 777 int main(int argc UNUSED, char **argv UNUSED)
 778 {
 779   struct fastbuf *out;
 780   out = bfdopen_shared(1, 4096);
 781
 782   test_simple1(out);
 783
 784   test_any_type(out);
 785
 786   bclose(out);
 787   return 0;
 788 }
 789
 790 #endif