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 == (uint) ~0) 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 == (uint) ~0) 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_zero(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 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 @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 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 && col_def->type_def->parse_fmt) {
 219     uint fmt = 0;
 220     const char *tmp_err = col_def->type_def->parse_fmt(col_opt, &fmt, tbl->pool);
 221     if(tmp_err) return 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     *GARY_PUSH(result) = col_opt;
 254
 255     col_opt = next;
 256   }
 257   *GARY_PUSH(result) = col_opt;
 258
 259   return result;
 260 }
 261
 262 /**
 263  * TODO: This function deliberately leaks memory. When it is called multiple times,
 264  * previous column orders still remain allocated in the table's memory pool.
 265  **/
 266 const char * table_set_col_order_by_name(struct table *tbl, const char *col_order_str)
 267 {
 268   if(col_order_str[0] == '*') {
 269     table_make_default_column_order(tbl);
 270     return NULL;
 271   }
 272
 273   if(!col_order_str[0]) {
 274     tbl->column_order = mp_alloc(tbl->pool, 0);
 275     tbl->cols_to_output = 0;
 276     return NULL;
 277   }
 278
 279   char *tmp_col_order = stk_strdup(col_order_str);
 280
 281   int col_count = 1;
 282   bool inside_brackets = false;
 283   for(int i = 0; col_order_str[i] != 0; i++) {
 284     if(col_order_str[i] == '[')  inside_brackets = true;
 285     if(col_order_str[i] == ']')  inside_brackets = false;
 286     if(!inside_brackets && col_order_str[i] == ',') {
 287       col_count++;
 288     }
 289   }
 290
 291   tbl->cols_to_output = col_count;
 292   tbl->column_order = mp_alloc_zero(tbl->pool, sizeof(struct table_col_instance) * col_count);
 293
 294   int curr_col_inst_idx = 0;
 295   char *name_start = tmp_col_order;
 296   while(name_start) {
 297     char *next = strpbrk(name_start, "[,");
 298     if(next && *next == '[') {
 299       next = strchr(next, ']');
 300       if(!next) return mp_printf(tbl->pool, "Invalid column definition, missing ']'.");
 301       *next++ = 0;
 302       next = *next == 0 ? NULL : next + 1; // if next points to the last \0 => end the computation
 303     } else if(next) {
 304       *next++ = 0;
 305     }
 306
 307     char **args = table_parse_col_arg2(name_start); // this sets 0 on the '['
 308     int col_def_idx = table_get_col_idx(tbl, name_start);
 309
 310     if(col_def_idx == -1) {
 311       return mp_printf(tbl->pool, "Unknown table column '%s', possible column names are: %s.", name_start, table_get_col_list(tbl));
 312     }
 313     tbl->column_order[curr_col_inst_idx].col_def = tbl->columns + col_def_idx;
 314     tbl->column_order[curr_col_inst_idx].idx = col_def_idx;
 315     tbl->column_order[curr_col_inst_idx].fmt = tbl->columns[col_def_idx].fmt;
 316     if(args) {
 317       for(uint i = 0; i < GARY_SIZE(args); i++) {
 318         const char *err = NULL;
 319         err = table_set_col_opt(tbl, curr_col_inst_idx, args[i]);
 320         if(err) return mp_printf(tbl->pool, "Error occured while setting column option: %s.", err);
 321       }
 322       GARY_FREE(args);
 323    }
 324
 325     name_start = next;
 326     curr_col_inst_idx++;
 327   }
 328
 329   return NULL;
 330 }
 331
 332 /*** Table cells ***/
 333
 334 /**
 335  * The TBL_COL_ITER_START macro are used for iterating over all instances of a particular column in
 336  * table _tbl.  _colidx is the column index in _tbl, _instptr is the pointer to the column instance
 337  * (struct table_col_instance *), _idxval is the index of current column index. The variables are
 338  * enclosed in a block, so they do not introduce variable name collisions.
 339  *
 340  * The TBL_COL_ITER_END macro must close the block started with TBL_COL_ITER_START.
 341  *
 342  * These macros are usually used to hide the implementation details of the column instances linked
 343  * list. This is usefull for definition of new types.
 344  **/
 345 #define TBL_COL_ITER_START(_tbl, _colidx, _instptr, _idxval) { struct table_col_instance *_instptr = NULL; int _idxval = _tbl->ll_headers[_colidx]; \
 346   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)
 347
 348 #define TBL_COL_ITER_END }
 349
 350 static void table_col_raw(struct table *tbl, int col_templ, const char *col_content)
 351 {
 352   TBL_COL_ITER_START(tbl, col_templ, curr_col_ptr, curr_col) {
 353     curr_col_ptr->cell_content = col_content;
 354   } TBL_COL_ITER_END
 355 }
 356
 357 void table_col_generic_format(struct table *tbl, int col, void *value, const struct xtype *expected_type)
 358 {
 359   ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
 360   ASSERT(tbl->columns[col].type_def == COL_TYPE_ANY || expected_type == tbl->columns[col].type_def);
 361   tbl->row_printing_started = true;
 362   TBL_COL_ITER_START(tbl, col, curr_col, curr_col_inst_idx) {
 363     enum xtype_fmt fmt = curr_col->fmt;
 364     curr_col->cell_content = expected_type->format(value, fmt, tbl->pool);
 365   } TBL_COL_ITER_END
 366 }
 367
 368 #undef TBL_COL_ITER_START
 369 #undef TBL_COL_ITER_END
 370
 371 void table_col_printf(struct table *tbl, int col, const char *fmt, ...)
 372 {
 373   ASSERT_MSG(col < tbl->column_count && col >= 0, "Table column %d does not exist.", col);
 374   tbl->row_printing_started = true;
 375   va_list args;
 376   va_start(args, fmt);
 377   char *cell_content = mp_vprintf(tbl->pool, fmt, args);
 378   table_col_raw(tbl, col, cell_content);
 379   va_end(args);
 380 }
 381
 382 TABLE_COL_BODY(int, int)
 383 TABLE_COL_BODY(uint, uint)
 384 TABLE_COL_BODY(double, double)
 385 TABLE_COL_BODY(intmax, intmax_t)
 386 TABLE_COL_BODY(uintmax, uintmax_t)
 387 TABLE_COL_BODY(s64, s64)
 388 TABLE_COL_BODY(u64, u64)
 389 TABLE_COL_BODY(bool, bool)
 390 TABLE_COL_BODY(str, const char *)
 391
 392 void table_reset_row(struct table *tbl)
 393 {
 394   for(uint i = 0; i < tbl->cols_to_output; i++) {
 395     tbl->column_order[i].cell_content = NULL;
 396   }
 397   mp_restore(tbl->pool, &tbl->pool_state);
 398   tbl->row_printing_started = false;
 399 }
 400
 401 void table_end_row(struct table *tbl)
 402 {
 403   ASSERT(tbl->formatter->row_output);
 404   if(tbl->row_printing_started == false) return;
 405   tbl->formatter->row_output(tbl);
 406   table_reset_row(tbl);
 407 }
 408
 409 /* Construction of a cell using a fastbuf */
 410
 411 struct fastbuf *table_col_fbstart(struct table *tbl, int col)
 412 {
 413   fbpool_init(&tbl->fb_col_out);
 414   fbpool_start(&tbl->fb_col_out, tbl->pool, 1);
 415   tbl->col_out = col;
 416   return &tbl->fb_col_out.fb;
 417 }
 418
 419 void table_col_fbend(struct table *tbl)
 420 {
 421   char *cell_content = fbpool_end(&tbl->fb_col_out);
 422   table_col_raw(tbl, tbl->col_out, cell_content);
 423   tbl->col_out = -1;
 424 }
 425
 426 /*** Option parsing ***/
 427
 428 const char *table_set_option_value(struct table *tbl, const char *key, const char *value)
 429 {
 430   // Options with no value
 431   if(value == NULL || (value != NULL && strlen(value) == 0)) {
 432     if(strcmp(key, "noheader") == 0) {
 433       tbl->print_header = false;
 434       return NULL;
 435     }
 436   }
 437
 438   // Options with a value
 439   if(value) {
 440     if(strcmp(key, "header") == 0) {
 441       bool tmp;
 442       const char *err = xt_bool.parse(value, &tmp, tbl->pool);
 443       if(err)
 444         return mp_printf(tbl->pool, "Invalid header parameter: '%s' has invalid value: '%s'.", key, value);
 445
 446       tbl->print_header = tmp;
 447
 448       return NULL;
 449     } else if(strcmp(key, "cols") == 0) {
 450       return table_set_col_order_by_name(tbl, value);
 451     } else if(strcmp(key, "fmt") == 0) {
 452       if(strcmp(value, "human") == 0) table_set_formatter(tbl, &table_fmt_human_readable);
 453       else if(strcmp(value, "machine") == 0) table_set_formatter(tbl, &table_fmt_machine_readable);
 454       else if(strcmp(value, "blockline") == 0) table_set_formatter(tbl, &table_fmt_blockline);
 455       else {
 456         return "Invalid argument to output-type option.";
 457       }
 458       return NULL;
 459     } else if(strcmp(key, "cells") == 0) {
 460       u32 fmt = 0;
 461       const char *err = xtype_parse_fmt(NULL, value, &fmt, tbl->pool);
 462       if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
 463       for(uint i = 0; i < tbl->cols_to_output; i++) {
 464         tbl->column_order[i].fmt = fmt;
 465       }
 466       return NULL;
 467     } else if(strcmp(key, "raw") == 0 || strcmp(key, "pretty") == 0) {
 468       u32 fmt = 0;
 469       const char *err = xtype_parse_fmt(NULL, key, &fmt, tbl->pool);
 470       if(err) return mp_printf(tbl->pool, "Invalid cell format: '%s'.", err);
 471       for(uint i = 0; i < tbl->cols_to_output; i++) {
 472         tbl->column_order[i].fmt = fmt;
 473       }
 474       return NULL;
 475     } else if(strcmp(key, "col-delim") == 0) {
 476       char * d = mp_printf(tbl->pool, "%s", value);
 477       tbl->col_delimiter = d;
 478       return NULL;
 479     }
 480   }
 481
 482   // Formatter options
 483   if(tbl->formatter && tbl->formatter->process_option) {
 484     const char *err = NULL;
 485     if(tbl->formatter->process_option(tbl, key, value, &err)) {
 486       return err;
 487     }
 488   }
 489
 490   // Unrecognized option
 491   return mp_printf(tbl->pool, "Invalid option: '%s%s%s'.", key, (value ? ":" : ""), (value ? : ""));
 492 }
 493
 494 const char *table_set_option(struct table *tbl, const char *opt)
 495 {
 496   char *key = stk_strdup(opt);
 497   char *value = strchr(key, ':');
 498   if(value) {
 499     *value++ = 0;
 500   }
 501   return table_set_option_value(tbl, key, value);
 502 }
 503
 504 const char *table_set_gary_options(struct table *tbl, char **gary_table_opts)
 505 {
 506   for(uint i = 0; i < GARY_SIZE(gary_table_opts); i++) {
 507     const char *rv = table_set_option(tbl, gary_table_opts[i]);
 508     if(rv != NULL) {
 509       return rv;
 510     }
 511   }
 512   return NULL;
 513 }
 514
 515 /*** Default formatter for human-readable output ***/
 516
 517 static void table_row_human_readable(struct table *tbl)
 518 {
 519   for(uint i = 0; i < tbl->cols_to_output; i++) {
 520     const struct table_column *col_def = tbl->column_order[i].col_def;
 521     if(i) {
 522       bputs(tbl->out, tbl->col_delimiter);
 523     }
 524     int col_width = col_def->width & CELL_WIDTH_MASK;
 525     if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
 526     bprintf(tbl->out, "%*s", col_width, tbl->column_order[i].cell_content);
 527   }
 528   bputc(tbl->out, '\n');
 529 }
 530
 531 static void table_write_header(struct table *tbl)
 532 {
 533   for(uint i = 0; i < tbl->cols_to_output; i++) {
 534     const struct table_column *col_def = tbl->column_order[i].col_def;
 535     if(i) {
 536       bputs(tbl->out, tbl->col_delimiter);
 537     }
 538     int col_width = col_def->width & CELL_WIDTH_MASK;
 539     if(col_def->width & CELL_ALIGN_LEFT) col_width = -1 * col_width;
 540     bprintf(tbl->out, "%*s", col_width, col_def->name);
 541   }
 542   bputc(tbl->out, '\n');
 543 }
 544
 545 static void table_start_human_readable(struct table *tbl)
 546 {
 547   if(tbl->col_delimiter == NULL) {
 548     tbl->col_delimiter = " ";
 549   }
 550
 551   if(tbl->print_header != false) {
 552     table_write_header(tbl);
 553   }
 554 }
 555
 556 const struct table_formatter table_fmt_human_readable = {
 557   .row_output = table_row_human_readable,
 558   .table_start = table_start_human_readable,
 559 };
 560
 561 /*** Default formatter for machine-readable output ***/
 562
 563 static void table_row_machine_readable(struct table *tbl)
 564 {
 565   for(uint i = 0; i < tbl->cols_to_output; i++) {
 566     if(i) {
 567       bputs(tbl->out, tbl->col_delimiter);
 568     }
 569     bputs(tbl->out, tbl->column_order[i].cell_content);
 570   }
 571   bputc(tbl->out, '\n');
 572 }
 573
 574 static void table_start_machine_readable(struct table *tbl)
 575 {
 576   if(tbl->col_delimiter == NULL) {
 577     tbl->col_delimiter = "\t";
 578   }
 579
 580   if(tbl->print_header != false && tbl->cols_to_output > 0) {
 581     bputs(tbl->out, tbl->column_order[0].col_def->name);
 582     for(uint i = 1; i < tbl->cols_to_output; i++) {
 583       bputs(tbl->out, tbl->col_delimiter);
 584       bputs(tbl->out, tbl->column_order[i].col_def->name);
 585     }
 586     bputc(tbl->out, '\n');
 587   }
 588 }
 589
 590 const struct table_formatter table_fmt_machine_readable = {
 591   .row_output = table_row_machine_readable,
 592   .table_start = table_start_machine_readable,
 593 };
 594
 595
 596 /*** Blockline formatter ***/
 597
 598 static void table_row_blockline_output(struct table *tbl)
 599 {
 600   for(uint i = 0; i < tbl->cols_to_output; i++) {
 601     const struct table_column *col_def = tbl->column_order[i].col_def;
 602     bprintf(tbl->out, "%s: %s\n", col_def->name, tbl->column_order[i].cell_content);
 603   }
 604   bputc(tbl->out, '\n');
 605 }
 606
 607 static void table_start_blockline(struct table *tbl)
 608 {
 609   if(tbl->col_delimiter == NULL) {
 610     tbl->col_delimiter = "\n";
 611   }
 612 }
 613
 614 const struct table_formatter table_fmt_blockline = {
 615   .row_output = table_row_blockline_output,
 616   .table_start = table_start_blockline
 617 };
 618
 619 /*** Tests ***/
 620
 621 #ifdef TEST
 622
 623 #include <stdio.h>
 624
 625 enum test_table_cols {
 626   TEST_COL0_STR, TEST_COL1_INT, TEST_COL2_UINT, TEST_COL3_BOOL, TEST_COL4_DOUBLE
 627 };
 628
 629 static struct table_col_instance test_column_order[] = { TBL_COL(TEST_COL3_BOOL), TBL_COL(TEST_COL4_DOUBLE),
 630                       TBL_COL(TEST_COL2_UINT), TBL_COL(TEST_COL1_INT), TBL_COL(TEST_COL0_STR), TBL_COL_ORDER_END };
 631
 632 static struct table_template test_tbl = {
 633   TBL_COLUMNS {
 634     [TEST_COL0_STR] = TBL_COL_STR("col0_str", 20),
 635     [TEST_COL1_INT] = TBL_COL_INT("col1_int", 8),
 636     [TEST_COL2_UINT] = TBL_COL_UINT("col2_uint", 9),
 637     [TEST_COL3_BOOL] = TBL_COL_BOOL_FMT("col3_bool", 9, XTYPE_FMT_PRETTY),
 638     [TEST_COL4_DOUBLE] = TBL_COL_DOUBLE("col4_double", 11),
 639     TBL_COL_END
 640   },
 641   TBL_COL_ORDER(test_column_order),
 642   TBL_FMT_HUMAN_READABLE,
 643   TBL_COL_DELIMITER("\t"),
 644 };
 645
 646 /**
 647  * tests: table_set_nt, table_set_uint, table_set_bool, table_set_double, table_set_printf
 648  **/
 649 static void do_print1(struct table *test_tbl)
 650 {
 651   table_col_str(test_tbl, TEST_COL0_STR, "sdsdf");
 652   table_col_int(test_tbl, TEST_COL1_INT, -10);
 653   table_col_int(test_tbl, TEST_COL1_INT, 10000);
 654   table_col_uint(test_tbl, TEST_COL2_UINT, 10);
 655   table_col_printf(test_tbl, TEST_COL2_UINT, "XXX-%u", 22222);
 656   table_col_bool(test_tbl, TEST_COL3_BOOL, true);
 657   table_col_double(test_tbl, TEST_COL4_DOUBLE, 1.5);
 658   table_col_printf(test_tbl, TEST_COL4_DOUBLE, "AAA");
 659   table_end_row(test_tbl);
 660
 661   table_col_str(test_tbl, TEST_COL0_STR, "test");
 662   table_col_int(test_tbl, TEST_COL1_INT, -100);
 663   table_col_uint(test_tbl, TEST_COL2_UINT, 100);
 664   table_col_bool(test_tbl, TEST_COL3_BOOL, false);
 665   table_col_printf(test_tbl, TEST_COL4_DOUBLE, "%.2lf", 1.5);
 666   table_end_row(test_tbl);
 667 }
 668
 669 static void test_simple1(struct fastbuf *out)
 670 {
 671   struct table *tbl = table_init(&test_tbl);
 672
 673   // print table with header
 674   table_set_col_order_by_name(tbl, "col3_bool");
 675   table_start(tbl, out);
 676   do_print1(tbl);
 677   table_end(tbl);
 678
 679   // print the same table as in the previous case without header
 680   table_set_col_order_by_name(tbl, "col0_str,col2_uint,col1_int,col3_bool");
 681   table_start(tbl, out);
 682   do_print1(tbl);
 683   table_end(tbl);
 684
 685   // this also tests whether there is need to call table_set_col_order_by_name after table_end was called
 686   tbl->print_header = false;
 687   table_start(tbl, out);
 688   do_print1(tbl);
 689   table_end(tbl);
 690   tbl->print_header = true;
 691
 692   table_set_col_order_by_name(tbl, "col3_bool");
 693   table_start(tbl, out);
 694   do_print1(tbl);
 695   table_end(tbl);
 696
 697   table_set_col_order_by_name(tbl, "col3_bool,col0_str");
 698   table_start(tbl, out);
 699   do_print1(tbl);
 700   table_end(tbl);
 701
 702   table_set_col_order_by_name(tbl, "col0_str,col3_bool,col2_uint");
 703   table_start(tbl, out);
 704   do_print1(tbl);
 705   table_end(tbl);
 706
 707   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");
 708   table_start(tbl, out);
 709   do_print1(tbl);
 710   table_end(tbl);
 711
 712   table_set_col_order_by_name(tbl, "col0_str,col1_int,col2_uint,col3_bool,col4_double");
 713   table_start(tbl, out);
 714   do_print1(tbl);
 715   table_end(tbl);
 716
 717
 718   // test table_col_order_fmt
 719   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 };
 720   table_set_col_order(tbl, col_order);
 721   table_start(tbl, out);
 722
 723   table_col_str(tbl, TEST_COL0_STR, "test");
 724   table_col_double(tbl, TEST_COL4_DOUBLE, 1.23456789);
 725   table_end_row(tbl);
 726
 727   table_col_str(tbl, TEST_COL0_STR, "test");
 728   table_col_double(tbl, TEST_COL4_DOUBLE, 1.23456789);
 729   table_end_row(tbl);
 730
 731   table_end(tbl);
 732
 733   table_cleanup(tbl);
 734 }
 735
 736 enum test_any_table_cols {
 737   TEST_ANY_COL0_INT, TEST_ANY_COL1_ANY
 738 };
 739
 740 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 };
 741
 742 static struct table_template test_any_tbl = {
 743   TBL_COLUMNS {
 744     [TEST_ANY_COL0_INT] = TBL_COL_INT("col0_int", 8),
 745     [TEST_ANY_COL1_ANY] = TBL_COL_ANY_FMT("col1_any", 9, XTYPE_FMT_PRETTY),
 746     TBL_COL_END
 747   },
 748   TBL_COL_ORDER(test_any_column_order),
 749   TBL_FMT_HUMAN_READABLE,
 750   TBL_COL_DELIMITER("\t"),
 751 };
 752
 753 static void test_any_type(struct fastbuf *out)
 754 {
 755   struct table *tbl = table_init(&test_any_tbl);
 756
 757   table_start(tbl, out);
 758
 759   table_col_int(tbl, TEST_ANY_COL0_INT, -10);
 760   table_col_int(tbl, TEST_ANY_COL1_ANY, 10000);
 761   table_end_row(tbl);
 762
 763   table_col_int(tbl, TEST_ANY_COL0_INT, -10);
 764   table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
 765   table_end_row(tbl);
 766
 767   table_col_printf(tbl, TEST_ANY_COL0_INT, "%d", 10);
 768   table_col_double(tbl, TEST_ANY_COL1_ANY, 1.4);
 769   table_end_row(tbl);
 770
 771   table_end(tbl);
 772   table_cleanup(tbl);
 773 }
 774
 775 int main(int argc UNUSED, char **argv UNUSED)
 776 {
 777   struct fastbuf *out;
 778   out = bfdopen_shared(1, 4096);
 779
 780   test_simple1(out);
 781
 782   test_any_type(out);
 783
 784   bclose(out);
 785   return 0;
 786 }
 787
 788 #endif