lib/termtable.h

   1 /*
   2  * ASCII table generator.
   3  * Copyright (C) 2017  Cumulus Networks
   4  * Quentin Young
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; either version 2 of the License, or (at your option)
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20 #ifndef _TERMTABLE_H_
  21 #define _TERMTABLE_H_
  22
  23 #include <zebra.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 enum ttable_align {
  30         LEFT,
  31         RIGHT,
  32         TOP,
  33         BOTTOM,
  34 };
  35
  36 struct ttable_border {
  37         char top;
  38         char bottom;
  39         char left;
  40         char right;
  41
  42         bool top_on;
  43         bool bottom_on;
  44         bool left_on;
  45         bool right_on;
  46 };
  47
  48 /* cell style and cell */
  49 struct ttable_cellstyle {
  50         short lpad;
  51         short rpad;
  52         enum ttable_align align;
  53         struct ttable_border border;
  54 };
  55
  56 struct ttable_cell {
  57         char *text;
  58         struct ttable_cellstyle style;
  59 };
  60
  61 /* table style and table */
  62 struct ttable_style {
  63         char corner;     /* intersection */
  64         int indent;      /* left table indent */
  65         bool rownums_on; /* show row numbers; unimplemented */
  66
  67         struct ttable_border border;
  68         struct ttable_cellstyle cell;
  69 };
  70
  71 struct ttable {
  72         int nrows;                  /* number of rows */
  73         int ncols;                  /* number of cols */
  74         struct ttable_cell **table; /* table, row x col */
  75         size_t size;                /* size */
  76         struct ttable_style style;  /* style */
  77 };
  78
  79 /* some predefined styles */
  80 #define TTSTYLE_ASCII 0
  81 #define TTSTYLE_BLANK 1
  82
  83 extern const struct ttable_style ttable_styles[2];
  84
  85 /**
  86  * Creates a new table with the default style, which looks like this:
  87  *
  88  * +----------+----------+
  89  * | column 1 | column 2 |
  90  * +----------+----------+
  91  * | data...  | data!!   |
  92  * +----------+----------+
  93  * | datums   | 12345    |
  94  * +----------+----------+
  95  *
  96  * @return the created table
  97  */
  98 struct ttable *ttable_new(const struct ttable_style *tts);
  99
 100 /**
 101  * Deletes a table and releases all associated resources.
 102  *
 103  * @param tt the table to destroy
 104  */
 105 void ttable_del(struct ttable *tt);
 106
 107 /**
 108  * Inserts a new row at the given index.
 109  *
 110  * The row contents are determined by a format string. The format string has
 111  * the same form as a regular printf format string, except that columns are
 112  * delimited by '|'. For example, to make the first column of the table above,
 113  * the call is:
 114  *
 115  *   ttable_insert_row(<tt>, <n>, "%s|%s", "column 1", "column 2");
 116  *
 117  * All features of printf format strings are permissible here.
 118  *
 119  * Caveats:
 120  *  - At present you cannot insert '|' into a cell's contents.
 121  *  - If there are N columns, '|' must appear n-1 times or the row will not be
 122  *    created
 123  *
 124  * @param tt table to insert row into
 125  * @param row the row number (begins at 0)
 126  * @param format column-separated format string
 127  * @param ... arguments to format string
 128  *
 129  * @return pointer to the first cell in the created row, or NULL if not enough
 130  * columns were specified
 131  */
 132 struct ttable_cell *ttable_insert_row(struct ttable *tt, unsigned int row,
 133                                       const char *format, ...) PRINTFRR(3, 4);
 134 /**
 135  * Inserts a new row at the end of the table.
 136  *
 137  * The row contents are determined by a format string. The format string has
 138  * the same form as a regular printf format string, except that columns are
 139  * delimited by '|'. For example, to make the first column of the table above,
 140  * the call is:
 141  *
 142  *   ttable_add_row(<tt>, "%s|%s", "column 1", "column 2");
 143  *
 144  * All features of printf format strings are permissible here.
 145  *
 146  * Caveats:
 147  *  - At present you cannot insert '|' into a cell's contents.
 148  *  - If there are N columns, '|' must appear n-1 times or the row will not be
 149  *    created
 150  *
 151  * @param tt table to insert row into
 152  * @param format column-separated format string
 153  * @param ... arguments to format string
 154  *
 155  * @return pointer to the first cell in the created row, or NULL if not enough
 156  * columns were specified
 157  */
 158 struct ttable_cell *ttable_add_row(struct ttable *tt, const char *format, ...)
 159         PRINTFRR(2, 3);
 160
 161 /**
 162  * Removes a row from the table.
 163  *
 164  * @param tt table to delete row from
 165  * @param row the row number (begins at 0)
 166  */
 167 void ttable_del_row(struct ttable *tt, unsigned int row);
 168
 169 /**
 170  * Sets alignment for a range of cells.
 171  *
 172  * Available alignments are LEFT and RIGHT. Cell contents will be aligned
 173  * accordingly, while respecting padding (if any). Suppose a cell has:
 174  *
 175  * lpad = 1
 176  * rpad = 1
 177  * align = RIGHT
 178  * text = 'datums'
 179  *
 180  * The cell would look like:
 181  *
 182  *  +-------------------+
 183  *  |            datums |
 184  *  +-------------------+
 185  *
 186  * On the other hand:
 187  *
 188  * lpad = 1
 189  * rpad = 10
 190  * align = RIGHT
 191  * text = 'datums'
 192  *
 193  *  +-------------------+
 194  *  |   datums          |
 195  *  +-------------------+
 196  *
 197  * The default alignment is LEFT.
 198  *
 199  * @param tt the table to set alignment on
 200  * @param srow starting row index
 201  * @param scol starting column index
 202  * @param nrow # rows to align
 203  * @param ncol # cols to align
 204  * @param align the alignment to set
 205  */
 206 void ttable_align(struct ttable *tt, unsigned int srow, unsigned int scol,
 207                   unsigned int erow, unsigned int ecol,
 208                   enum ttable_align align);
 209
 210 /**
 211  * Sets padding for a range of cells.
 212  *
 213  * Available padding options are LEFT and RIGHT (the alignment enum is reused).
 214  * Both options may be set. Padding is treated as though it is stuck to the
 215  * walls of the cell. Suppose a cell has:
 216  *
 217  * lpad = 4
 218  * rpad = 2
 219  * align = RIGHT
 220  * text = 'datums'
 221  *
 222  * The cell padding, marked by '.', would look like:
 223  *
 224  *  +--------------+
 225  *  |    .datums.  |
 226  *  +--------------+
 227  *
 228  * If the column is wider than the cell, the cell contents are aligned in an
 229  * additional padded field according to the cell alignment.
 230  *
 231  *  +--------------------+
 232  *  | Data!!!11!~~~~~:-) |
 233  *  +--------------------+
 234  *  |    .      datums.  |
 235  *  +--------------------+
 236  *
 237  * @param tt the table to set padding on
 238  * @param srow starting row index
 239  * @param scol starting column index
 240  * @param nrow # rows to pad
 241  * @param ncol # cols to pad
 242  * @param align LEFT or RIGHT
 243  * @param pad # spaces to pad with
 244  */
 245 void ttable_pad(struct ttable *tt, unsigned int srow, unsigned int scol,
 246                 unsigned int nrow, unsigned int ncol, enum ttable_align align,
 247                 short pad);
 248
 249 /**
 250  * Restyle all cells according to table.cell.style.
 251  *
 252  * @param tt table to restyle
 253  */
 254 void ttable_restyle(struct ttable *tt);
 255
 256 /**
 257  * Turn left/right column separators on or off for specified column.
 258  *
 259  * @param tt table
 260  * @param col column index
 261  * @param align left or right separators
 262  * @param on true/false for on/off
 263  * @param sep character to use
 264  */
 265 void ttable_colseps(struct ttable *tt, unsigned int col,
 266                     enum ttable_align align, bool on, char sep);
 267
 268 /**
 269  * Turn bottom row separators on or off for specified row.
 270  *
 271  * @param tt table
 272  * @param row row index
 273  * @param align left or right separators
 274  * @param on true/false for on/off
 275  * @param sep character to use
 276  */
 277 void ttable_rowseps(struct ttable *tt, unsigned int row,
 278                     enum ttable_align align, bool on, char sep);
 279
 280 /**
 281  * Dumps a table to a heap-allocated string.
 282  *
 283  * Caller must free this string after use with
 284  *
 285  *   XFREE (MTYPE_TMP, str);
 286  *
 287  * @param tt the table to dump
 288  * @param newline the desired newline sequence to use, null terminated.
 289  * @return table in text form
 290  */
 291 char *ttable_dump(struct ttable *tt, const char *newline);
 292
 293 #ifdef __cplusplus
 294 }
 295 #endif
 296
 297 #endif /* _TERMTABLE_H */