#include <ucw/mempool.h>
#include <ucw/xtypes.h>
-// FIXME: update these macros
#ifdef CONFIG_UCW_CLEAN_ABI
-#define table_append_bool ucw_table_append_bool
-#define table_append_double ucw_table_append_double
-#define table_append_int ucw_table_append_int
-#define table_append_intmax ucw_table_append_intmax
-#define table_append_printf ucw_table_append_printf
-#define table_append_str ucw_table_append_str
-#define table_append_u64 ucw_table_append_u64
-#define table_append_uint ucw_table_append_uint
-#define table_append_uintmax ucw_table_append_uintmax
#define table_cleanup ucw_table_cleanup
#define table_col_bool ucw_table_col_bool
-#define table_col_bool_fmt ucw_table_col_bool_fmt
-#define table_col_bool_name ucw_table_col_bool_name
#define table_col_double ucw_table_col_double
-#define table_col_double_fmt ucw_table_col_double_fmt
-#define table_col_double_name ucw_table_col_double_name
#define table_col_fbend ucw_table_col_fbend
#define table_col_fbstart ucw_table_col_fbstart
+#define table_col_generic_format ucw_table_col_generic_format
#define table_col_int ucw_table_col_int
-#define table_col_int_fmt ucw_table_col_int_fmt
-#define table_col_int_name ucw_table_col_int_name
#define table_col_intmax ucw_table_col_intmax
-#define table_col_intmax_fmt ucw_table_col_intmax_fmt
-#define table_col_intmax_name ucw_table_col_intmax_name
+#define table_col_is_printed ucw_table_col_is_printed
#define table_col_printf ucw_table_col_printf
#define table_col_s64 ucw_table_col_s64
-#define table_col_s64_fmt ucw_table_col_s64_fmt
-#define table_col_s64_name ucw_table_col_s64_name
#define table_col_str ucw_table_col_str
-#define table_col_str_fmt ucw_table_col_str_fmt
-#define table_col_str_name ucw_table_col_str_name
+#define table_col_str ucw_table_col_str
#define table_col_u64 ucw_table_col_u64
-#define table_col_u64_fmt ucw_table_col_u64_fmt
-#define table_col_u64_name ucw_table_col_u64_name
#define table_col_uint ucw_table_col_uint
-#define table_col_uint_fmt ucw_table_col_uint_fmt
-#define table_col_uint_name ucw_table_col_uint_name
#define table_col_uintmax ucw_table_col_uintmax
-#define table_col_uintmax_fmt ucw_table_col_uintmax_fmt
-#define table_col_uintmax_name ucw_table_col_uintmax_name
#define table_end ucw_table_end
#define table_end_row ucw_table_end_row
#define table_fmt_blockline ucw_table_fmt_blockline
#define table_get_col_idx ucw_table_get_col_idx
#define table_get_col_list ucw_table_get_col_list
#define table_init ucw_table_init
+#define table_reset_row ucw_table_reset_row
+#define table_set_col_opt ucw_table_set_col_opt
#define table_set_col_order ucw_table_set_col_order
#define table_set_col_order_by_name ucw_table_set_col_order_by_name
#define table_set_formatter ucw_table_set_formatter
struct table;
-enum table_option_state {
- TABLE_OPT_PROCESSED,
- TABLE_OPT_UNKNOWN,
- TABLE_OPT_ERR
-};
-
/**
* Definition of a single table column.
* Usually, this is generated using the `TABLE_COL_`'type' macros.
uint fmt; // [*] default format of the column
const struct xtype *type_def; // [*] pointer to xtype of this column
- int (*set_col_instance_option)(struct table *tbl, uint col, const char *value, char **err);
- // [*] process table option for a column instance
+ const char * (*set_col_opt)(struct table *tbl, uint col_inst_idx, const char *col_opt);
+ // [*] process table option for a column instance. @col_inst_idx is the index of the column
+ // instance to which the @col_opt is set. Return value is the error string.
};
-// FIXME: is it correct to have idx and col_def? idx is sufficient and in fact a duplicity of idx
-// idx is used only for initialization and col_def is used in other cases
+/**
+ * Definition of a column instance. The table_col_instance belongs to a struct table. col_def is
+ * pointing to a definition of the column in struct table::columns. The user can fill only the @idx
+ * and @fmt. The @col_def, @cell_content, @next_column are private fields.
+ *
+ * Please use only fields marked with `[*]`.
+ **/
struct table_col_instance {
- uint idx; // idx is a index into struct table::columns
+ uint idx; // [*] idx is a index into struct table::columns
const struct table_column *col_def; // this is pointer to the column definition, located in the array struct table::columns
const char *cell_content; // content of the cell of the current row
int next_column; // index of next column in linked list of columns of the same type
- uint output_type; // format of this column
+ uint fmt; // [*] format of this column
};
/**
struct table_template {
const struct table_column *columns; // [*] Definition of columns
struct table_col_instance *column_order; // [*] Order of the columns in the print-out of the table
- uint cols_to_output; // [*] Number of columns that are printed
const char *col_delimiter; // [*] Delimiter that is placed between columns
// Back-end used for table formatting and its private data
- const struct table_formatter *formatter; // FIXME: should be const?
+ const struct table_formatter *formatter;
};
/**
struct table_col_instance *column_order; // [*] Order of the columns in the print-out of the table
uint cols_to_output; // [*] Number of columns that are printed
const char *col_delimiter; // [*] Delimiter that is placed between columns
- uint print_header; // [*] 0 indicates that table header should not be printed
+ bool print_header; // [*] false indicates that table header should not be printed
struct fastbuf *out; // [*] Fastbuffer to which the table is printed
- int last_printed_col; // Index of the last column which was set. -1 indicates start of row.
- // Used for example for appending to the current column.
- int row_printing_started; // Indicates that a row has been started. Duplicates last_printed_col, but harmlessly.
+ bool row_printing_started; // Indicates that a row has been started.
struct fbpool fb_col_out; // Per-cell fastbuf, see table_col_fbstart()
int col_out; // Index of the column that is currently printed using fb_col_out
// Back-end used for table formatting and its private data
const struct table_formatter *formatter;
- void *data;
+ void *formatter_data;
};
/****
* * `TBL_COL_`'type'`_FMT(name, width, fmt)` defines a column with a custom format string
* * `TBL_COL_END` ends the column definitions
* * `TBL_COL_ORDER` specifies custom ordering of columns in the output
- * * `TBL_COL_DELIMITER` and `TBL_APPEND_DELIMITER` override default delimiters
- * * `TBL_FMT__HUMAN_READABLE` requests human-readable formatting (this is the default)
+ * * `TBL_COL_DELIMITER` overrides the default delimiter
+ * * `TBL_FMT_HUMAN_READABLE` requests human-readable formatting (this is the default)
* * `TBL_FMT_MACHINE_READABLE` requests machine-readable TSV output
* * `TBL_FMT_BLOCKLINE` requests block formatting (each cell printed a pair of a key and value on its own line)
*
#define TBL_COL_DOUBLE(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_double }
#define TBL_COL_BOOL(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = &xt_bool }
#define TBL_COL_ANY(_name, _width) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = COL_TYPE_ANY }
-#define TBL_COL_CUSTOM(_name, _width, _xtype) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = _xtype }
+#define TBL_COL_XTYPE(_name, _width, _xtype) { .name = _name, .width = _width, .fmt = XTYPE_FMT_DEFAULT, .type_def = _xtype }
#define TBL_COL_STR_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_str }
#define TBL_COL_INT_FMT(_name, _width, _fmt) { .name = _name, .width = _width, .fmt = _fmt, .type_def = &xt_int }
#define TBL_COL_END { .name = 0, .width = 0, .fmt = 0, .type_def = NULL }
#define TBL_COLUMNS .columns = (struct table_column [])
-#define TBL_COL_ORDER(order) .column_order = (struct table_col_instance *) order, .cols_to_output = ARRAY_SIZE(order)
+#define TBL_COL_ORDER(order) .column_order = (struct table_col_instance *) order
#define TBL_COL_DELIMITER(_delimiter) .col_delimiter = _delimiter
/**
* These macros are used for definition of column order
**/
-#define TBL_COL(_idx) { .idx = _idx, .output_type = XTYPE_FMT_DEFAULT, .next_column = -1 }
-#define TBL_COL_FMT(_idx, _fmt) { .idx = _idx, .output_type = _fmt, .next_column = -1 }
+#define TBL_COL(_idx) { .idx = _idx, .fmt = XTYPE_FMT_DEFAULT, .next_column = -1 }
+#define TBL_COL_FMT(_idx, _fmt) { .idx = _idx, .fmt = _fmt, .next_column = -1 }
+#define TBL_COL_ORDER_END { .col_def = 0, .idx = ~0U, .fmt = 0, .next_column = -1 }
+/**
+ * These macros are aliases to various kinds of table formats.
+ **/
#define TBL_FMT_HUMAN_READABLE .formatter = &table_fmt_human_readable
#define TBL_FMT_BLOCKLINE .formatter = &table_fmt_blockline
#define TBL_FMT_MACHINE_READABLE .formatter = &table_fmt_machine_readable
-
-/**
- * The TBL_COL_ITER_START macro are used for iterating over all instances of a particular column in
- * table _tbl. _colidx is the column index in _tbl, _instptr is the pointer to the column instance
- * (struct table_col_instance *), _idxval is the index of current column index. The variables are
- * enclosed in a block, so they do not introduce variable name collisions.
- *
- * The TBL_COL_ITER_END macro must close the block started with TBL_COL_ITER_START.
- **/
-#define TBL_COL_ITER_START(_tbl, _colidx, _instptr, _idxval) { struct table_col_instance *_instptr = NULL; int _idxval = _tbl->ll_headers[_colidx]; \
- 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)
-
-#define TBL_COL_ITER_END }
+#define TBL_FMT(_fmt) .formatter = _fmt
/**
* Creates a new table from a table template. The template should already contain
**/
struct table *table_init(const struct table_template *tbl_template);
-/** Destroy a table definition, freeing all memory used by it. **/
+/** Destroy a table instance, freeing all memory used by it. **/
void table_cleanup(struct table *tbl);
/**
* For each column type, there are functions for filling of cells
* of the particular type:
*
- * * `table_col_`'type'`(table, idx, value)` sets the cell in column `idx`
+ * * `table_col_`'type'`(table, col_def_idx, value)` sets the cell in column `col_def_idx`
* to the `value`
- * * `table_col_`'type'`_fmt(table, idx, fmt, ...)` does the same with
- * a custom printf-like format string
- * * `table_col_`'type'`_name(table, name, value)` refers to the column
- * by its name instead of its index.
***/
-
#define TABLE_COL_PROTO(_name, _type) void table_col_##_name(struct table *tbl, int col, _type val);
TABLE_COL_PROTO(int, int)
TABLE_COL_PROTO(s64, s64)
TABLE_COL_PROTO(u64, u64)
TABLE_COL_PROTO(bool, bool)
-
-void table_col_str(struct table *tbl, int col, const char * val);
+TABLE_COL_PROTO(str, const char *)
/** TABLE_COL_BODY macro enables easy definitions of bodies of table_col_<something> functions **/
#define TABLE_COL_BODY(_name, _type) void table_col_##_name(struct table *tbl, int col, _type val) {\
void table_end_row(struct table *tbl);
/**
- * Resets data in current row.
+ * Resets data in the current row.
**/
void table_reset_row(struct table *tbl);
***/
/**
- * Find the index of a column with name @col_name. Returns -1 if there is no such column.
+ * Find the index of a column definition with name @col_name. Returns -1 if there is no such column.
**/
int table_get_col_idx(struct table *tbl, const char *col_name);
-
/**
- * Sets a string argument to a column instance
+ * Sets a string option on a column instance.
+ *
+ * By default, the option is parsed as a formatting mode of the corresponding <<xtypes:,xtype>>
+ * using <<xtypes:fun_xtype_parse_fmt,`xtype_parse_fmt()`>>.
+ *
+ * As special cases might require special handling (e.g., column decoration, post-processing, etc.),
+ * a column can define a `set_col_opt` hook, which takes over option parsing. (Beware, the hook must
+ * not be called directly and it must not call this function.)
+ *
+ * See <<ucw-tableprinter.5:,the list of options>> for more.
**/
-int table_set_col_opt_default(struct table *tbl, int col_idx, const char *col_arg, char ** err);
+const char *table_set_col_opt(struct table *tbl, uint col_inst_idx, const char *col_opt);
/**
* Returns a comma-and-space-separated list of column names, allocated from table's internal
const char *table_get_col_list(struct table *tbl);
/**
- * Sets the order in which the columns are printed. The @col_order parameter is used until @table_end() or
- * @table_cleanup() is called. The table stores only the pointer and the memory pointed to by @col_order is
- * allocated and deallocated by the caller.
- **/
-void table_set_col_order(struct table *tbl, int *col_order, int col_order_size);
-
-/**
- * Returns 1 if col_idx will be printed, 0 otherwise.
+ * Sets the order in which the columns are printed. The columns are specified by array of struct
+ * @table_col_instance. This allows specification of format. The user should make an array of struct
+ * @table_col_instance and fill the array using the TBL_COL and TBL_COL_FMT. The array has a special
+ * last element: @TBL_COL_ORDER_END.
+ *
+ * The table copies content of @col_order into an internal representation stored
+ * in `column_order`. Options to column instances can be set using @table_set_col_opt().
**/
-bool table_col_is_printed(struct table *tbl, uint col_idx);
+void table_set_col_order(struct table *tbl, const struct table_col_instance *col_order);
/**
* Sets the order in which the columns are printed. The specification is a string with comma-separated column
* names. Returns NULL for success and an error message otherwise. The string is not referenced after
* this function returns.
*
- * The format of the col_order string is the following:
- * <col-order-string> := <col-def>[,<col-def>]*
- *
- * <col-def> := <col-name> '[' <col-opt> ']'
- *
- * <col-name> is a string that does not contain comma ',' or '[',']' brackets
- *
- * <col-opt> is currently only one string.
- *
- * FIXME In the future, we should allow <col-opt> to be a comma(,) separated list of identifiers
+ * See <<ucw-tableprinter.5:,the list of options>> for full syntax.
**/
const char *table_set_col_order_by_name(struct table *tbl, const char *col_order);
+/**
+ * Returns true if @col_def_idx will be printed, false otherwise.
+ **/
+bool table_col_is_printed(struct table *tbl, uint col_def_idx);
+
/**
* Sets table formatter. See below for the list of formatters.
**/
void table_set_formatter(struct table *tbl, const struct table_formatter *fmt);
/**
- * Set a table option. All options have a key and a value. Currently,
- * the following keys are defined (other keys can be accepted by formatters):
- *
- * [options="header"]
- * |===================================================================================================
- * | key | value | meaning
- * | `header` | 0 or 1 | set whether a table header should be printed
- * | `noheader` | 'none' | equivalent to `header`=0
- * | `cols` | comma-separated column list | set order of columns
- * | `fmt` | `human`/`machine`/`block` | set table formatter to one of the built-in formatters
- * | `col-delim`| string | set column delimiter
-* | `cells` | string | set column format mode
- * |===================================================================================================
+ * Set a table option. All options have a key and a value.
+ * See <<ucw-tableprinter.5:,the list of options>>.
**/
const char *table_set_option_value(struct table *tbl, const char *key, const char *value);