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