src/output/table.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #if !tab_h
  18 #define tab_h 1
  19
  20 #include <limits.h>
  21 #include <libpspp/str.h>
  22
  23 /* Cell options. */
  24 enum
  25   {
  26     TAB_NONE = 0,
  27
  28     TAB_ALIGN_MASK = 03,        /* Alignment mask. */
  29     TAB_RIGHT = 00,             /* Right justify. */
  30     TAB_LEFT = 01,              /* Left justify. */
  31     TAB_CENTER = 02,            /* Center. */
  32
  33     /* Cell types. */
  34     TAB_JOIN = 004,             /* Joined cell. */
  35     TAB_EMPTY = 010,            /* Empty cell. */
  36
  37     /* Flags. */
  38     TAB_EMPH = 020,             /* Emphasize cell contents. */
  39     TAB_FIX = 040,              /* Use fixed font. */
  40   };
  41
  42 /* Line styles. */
  43 enum
  44   {
  45     TAL_0 = 0,                  /* No line. */
  46     TAL_1 = 1,                  /* Single line. */
  47     TAL_2 = 2,                  /* Double line. */
  48     TAL_GAP = 3,                /* Spacing but no line. */
  49     TAL_COUNT,                  /* Number of line styles. */
  50   };
  51
  52 /* Column styles.  Must correspond to SOM_COL_*. */
  53 enum
  54   {
  55     TAB_COL_NONE,                       /* No columns. */
  56     TAB_COL_DOWN                        /* Columns down first. */
  57   };
  58
  59 /* Joined cell. */
  60 struct tab_joined_cell
  61   {
  62     int x1, y1;
  63     int x2, y2;
  64     int hit;
  65     struct substring contents;
  66   };
  67
  68 struct outp_driver;
  69 struct tab_table;
  70 struct tab_rendering;
  71
  72 typedef void tab_dim_func (struct tab_rendering *, void *aux);
  73
  74 /* A table. */
  75 struct tab_table
  76   {
  77     struct pool *container;
  78
  79     /* Contents. */
  80     int col_style;              /* Columns: One of TAB_COL_*. */
  81     int col_group;              /* Number of rows per column group. */
  82     char *title;                /* Table title. */
  83     unsigned flags;             /* SOMF_*. */
  84     int nc, nr;                 /* Number of columns, rows. */
  85     int cf;                     /* Column factor for indexing purposes. */
  86     int l, r, t, b;             /* Number of header rows on each side. */
  87     struct substring *cc;       /* Cell contents; substring *[nr][nc]. */
  88     unsigned char *ct;          /* Cell types; unsigned char[nr][nc]. */
  89     unsigned char *rh;          /* Horiz rules; unsigned char[nr+1][nc]. */
  90     unsigned char *rv;          /* Vert rules; unsigned char[nr][nc+1]. */
  91     tab_dim_func *dim;          /* Calculates cell widths and heights. */
  92     void *dim_aux;              /* Auxiliary data for dim function. */
  93
  94     /* Editing info. */
  95     int col_ofs, row_ofs;       /* X and Y offsets. */
  96   };
  97
  98 /* Number of rows or columns in TABLE. */
  99 static inline int tab_nr (const struct tab_table *table) { return table->nr; }
 100 static inline int tab_nc (const struct tab_table *table) { return table->nc; }
 101
 102 /* Number of left/right/top/bottom header columns/rows in TABLE. */
 103 static inline int tab_l (const struct tab_table *table) { return table->l; }
 104 static inline int tab_r (const struct tab_table *table) { return table->r; }
 105 static inline int tab_t (const struct tab_table *table) { return table->t; }
 106 static inline int tab_b (const struct tab_table *table) { return table->b; }
 107
 108 struct tab_rendering
 109   {
 110     const struct tab_table *table;
 111     struct outp_driver *driver;
 112
 113     int *w;                     /* Column widths; [nc]. */
 114     int *h;                     /* Row heights; [nr]. */
 115     int *hrh;                   /* Heights of horizontal rules; [nr+1]. */
 116     int *wrv;                   /* Widths of vertical rules; [nc+1]. */
 117
 118     /* These fields would be redundant with those in struct tab_table, except
 119        that a table will be rendered with fewer header rows or columns than
 120        requested when we are pressed for space. */
 121     int l, r, t, b;             /* Number of header rows/columns. */
 122     int wl, wr, ht, hb;         /* Width/height of header rows/columns. */
 123   };
 124
 125 /* Tables. */
 126 struct tab_table *tab_create (int nc, int nr, int reallocable);
 127 void tab_destroy (struct tab_table *);
 128 void tab_resize (struct tab_table *, int nc, int nr);
 129 void tab_realloc (struct tab_table *, int nc, int nr);
 130 void tab_headers (struct tab_table *, int l, int r, int t, int b);
 131 void tab_columns (struct tab_table *, int style, int group);
 132 void tab_title (struct tab_table *, const char *, ...)
 133      PRINTF_FORMAT (2, 3);
 134 void tab_flags (struct tab_table *, unsigned);
 135 void tab_submit (struct tab_table *);
 136
 137 /* Dimensioning. */
 138 tab_dim_func tab_natural_dimensions;
 139 int tab_natural_width (const struct tab_rendering *, int c);
 140 int tab_natural_height (const struct tab_rendering *, int r);
 141 void tab_dim (struct tab_table *, tab_dim_func *, void *aux);
 142
 143 /* Rules. */
 144 void tab_hline (struct tab_table *, int style, int x1, int x2, int y);
 145 void tab_vline (struct tab_table *, int style, int x, int y1, int y2);
 146 void tab_box (struct tab_table *, int f_h, int f_v, int i_h, int i_v,
 147               int x1, int y1, int x2, int y2);
 148
 149 /* Text options, passed in the `opt' argument. */
 150 enum
 151   {
 152     TAT_NONE = 0,               /* No options. */
 153     TAT_PRINTF = 0x0100,        /* Format the text string with sprintf. */
 154     TAT_TITLE = 0x0200 | TAB_EMPH, /* Title attributes. */
 155     TAT_NOWRAP = 0x0800         /* No text wrap (tab_output_text() only). */
 156   };
 157
 158 /* Cells. */
 159 struct fmt_spec;
 160 union value;
 161 void tab_value (struct tab_table *, int c, int r, unsigned char opt,
 162                 const union value *, const struct fmt_spec *);
 163
 164 void tab_fixed (struct tab_table *, int c, int r, unsigned char opt,
 165                 double v, int w, int d);
 166
 167 void tab_double (struct tab_table *, int c, int r, unsigned char opt,
 168                 double v, const struct fmt_spec *);
 169
 170 void tab_text (struct tab_table *, int c, int r, unsigned opt,
 171                const char *, ...)
 172      PRINTF_FORMAT (5, 6);
 173 void tab_joint_text (struct tab_table *, int x1, int y1, int x2, int y2,
 174                      unsigned opt, const char *, ...)
 175      PRINTF_FORMAT (7, 8);
 176
 177 /* Cell low-level access. */
 178 #define tab_alloc(TABLE, AMT) pool_alloc ((TABLE)->container, (AMT))
 179 void tab_raw (struct tab_table *, int c, int r, unsigned opt,
 180               struct substring *);
 181
 182 /* Editing. */
 183 void tab_offset (struct tab_table *, int col, int row);
 184 void tab_next_row (struct tab_table *);
 185
 186 /* Current row/column offset. */
 187 #define tab_row(TABLE) ((TABLE)->row_ofs)
 188 #define tab_col(TABLE) ((TABLE)->col_ofs)
 189
 190 /* Simple output. */
 191 void tab_output_text (int options, const char *string, ...)
 192      PRINTF_FORMAT (2, 3);
 193
 194 /* Embedding the command name in the output. */
 195 void tab_set_command_name (const char *);
 196
 197 #endif /* tab_h */
 198