pintos-os.org Git - pspp/blob - src/output/tab.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011, 2014 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 #ifndef OUTPUT_TAB_H
  18 #define OUTPUT_TAB_H
  19
  20 /* Simple table class.
  21
  22    This is a type of table (see output/table.h) whose content is composed
  23    manually by the code that generates it, by filling in cells one by one.
  24
  25    Some of the features of this type of table are obsolete but have not yet
  26    been removed, because some code still uses them.  These features are:
  27
  28        - The title and caption.  These are properties of the table_item (see
  29          output/table-item.h) in which a table is embedded, not properties of
  30          the table itself.
  31
  32        - Row and columns offsets (via tab_offset(), tab_next_row()).  This
  33          feature simply isn't used enough to justify keeping it.
  34
  35        - Table resizing.  The code that does use this feature is just as well
  36          served by creating multiple tables and pasting them together with
  37          table_paste().  Eliminating this feature would also slightly simplify
  38          the table code here.
  39 */
  40
  41 #include "libpspp/compiler.h"
  42 #include "output/table.h"
  43 #include "data/format.h"
  44
  45 enum result_class
  46   {
  47     RC_INTEGER,
  48     RC_WEIGHT,
  49     RC_PVALUE,
  50     RC_OTHER,
  51     n_RC
  52   };
  53
  54 #define TAB_STYLE_MASK (7u << (TAB_FIRST_AVAILABLE + 3))
  55 #define TAB_STYLE_SHIFT (TAB_FIRST_AVAILABLE + 3)
  56
  57 /* A table. */
  58 struct tab_table
  59   {
  60     struct table table;
  61     struct pool *container;
  62
  63     /* Table title and caption, or null. */
  64     char *title, *caption;
  65     int cf;                     /* Column factor for indexing purposes. */
  66
  67     /* Table contents.
  68
  69        Each array element in cc[] is ordinarily a "char *" pointer to a
  70        string.  If TAB_JOIN (defined in tab.c) is set in ct[] for the element,
  71        however, it is a joined cell and the corresponding element of cc[]
  72        points to a struct tab_joined_cell. */
  73     void **cc;                  /* Cell contents; void *[nr][nc]. */
  74     unsigned short *ct;         /* Cell types; unsigned short[nr][nc]. */
  75
  76     /* Rules. */
  77     unsigned char *rh;          /* Horiz rules; unsigned char[nr+1][nc]. */
  78     unsigned char *rv;          /* Vert rules; unsigned char[nr][nc+1]. */
  79
  80     /* Cell styles. */
  81     struct cell_style *styles[8];
  82
  83     /* X and Y offsets. */
  84     int col_ofs, row_ofs;
  85
  86     struct fmt_spec fmtmap [n_RC];
  87   };
  88
  89 struct tab_table *tab_cast (const struct table *);
  90
  91 /* Number of rows or columns in TABLE. */
  92 static inline int tab_nr (const struct tab_table *table)
  93         { return table_nr (&table->table); }
  94 static inline int tab_nc (const struct tab_table *table)
  95         { return table_nc (&table->table); }
  96
  97 /* Number of left/right/top/bottom header columns/rows in TABLE. */
  98 static inline int tab_l (const struct tab_table *table)
  99         { return table_hl (&table->table); }
 100 static inline int tab_r (const struct tab_table *table)
 101         { return table_hr (&table->table); }
 102 static inline int tab_t (const struct tab_table *table)
 103         { return table_ht (&table->table); }
 104 static inline int tab_b (const struct tab_table *table)
 105         { return table_hb (&table->table); }
 106
 107 /* Tables. */
 108 struct tab_table *tab_create (int nc, int nr);
 109 void tab_resize (struct tab_table *, int nc, int nr);
 110 void tab_realloc (struct tab_table *, int nc, int nr);
 111 void tab_headers (struct tab_table *, int l, int r, int t, int b);
 112 void tab_title (struct tab_table *, const char *, ...)
 113      PRINTF_FORMAT (2, 3);
 114 void tab_caption (struct tab_table *, const char *, ...)
 115      PRINTF_FORMAT (2, 3);
 116 void tab_submit (struct tab_table *);
 117
 118 /* Rules. */
 119 void tab_hline (struct tab_table *, int style, int x1, int x2, int y);
 120 void tab_vline (struct tab_table *, int style, int x, int y1, int y2);
 121 void tab_box (struct tab_table *, int f_h, int f_v, int i_h, int i_v,
 122               int x1, int y1, int x2, int y2);
 123
 124 /* Obsolete cell options. */
 125 #define TAT_TITLE TAB_EMPH      /* Title attributes. */
 126
 127 void tab_set_format (struct tab_table *, enum result_class, const struct fmt_spec *);
 128
 129
 130 /* Cells. */
 131 struct fmt_spec;
 132 struct dictionary;
 133 union value;
 134 void tab_value (struct tab_table *, int c, int r, unsigned short opt,
 135                 const union value *, const struct variable *,
 136                 const struct fmt_spec *);
 137
 138 void tab_double (struct tab_table *, int c, int r, unsigned short opt,
 139                  double v, const struct fmt_spec *, enum result_class );
 140
 141 void tab_text (struct tab_table *, int c, int r, unsigned opt, const char *);
 142 void tab_text_format (struct tab_table *, int c, int r, unsigned opt,
 143                       const char *, ...)
 144      PRINTF_FORMAT (5, 6);
 145
 146 void tab_joint_text (struct tab_table *, int x1, int y1, int x2, int y2,
 147                      unsigned opt, const char *);
 148 void tab_joint_text_format (struct tab_table *, int x1, int y1, int x2, int y2,
 149                             unsigned opt, const char *, ...)
 150      PRINTF_FORMAT (7, 8);
 151
 152 struct footnote *tab_create_footnote (struct tab_table *, size_t idx,
 153                                       const char *content, const char *marker);
 154 void tab_add_footnote (struct tab_table *, int x, int y,
 155                        const struct footnote *);
 156
 157 bool tab_cell_is_empty (const struct tab_table *, int c, int r);
 158
 159 /* Editing. */
 160 void tab_offset (struct tab_table *, int col, int row);
 161 void tab_next_row (struct tab_table *);
 162
 163 /* Current row/column offset. */
 164 #define tab_row(TABLE) ((TABLE)->row_ofs)
 165 #define tab_col(TABLE) ((TABLE)->col_ofs)
 166
 167 /* Simple output. */
 168 void tab_output_text (int options, const char *string);
 169 void tab_output_text_format (int options, const char *, ...)
 170      PRINTF_FORMAT (2, 3);
 171
 172 #endif /* output/tab.h */
 173