1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011 Free Software Foundation, Inc.
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.
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.
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/>. */
20 /* Simple table class.
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.
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:
28 - The title. The title (or caption, actually) is a property of the
29 table_item (see output/table-item.h) in which a table is embedded,
30 not a property of the table itself.
32 - Row and columns offsets (via tab_offset(), tab_next_row()). This
33 feature simply isn't used enough to justify keeping it.
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
41 #include "libpspp/compiler.h"
42 #include "output/table.h"
43 #include "data/format.h"
58 struct pool *container;
60 /* Table title, or a null pointer if no title has been set.
62 The table title is properly part of struct table_item, not struc*/
64 int cf; /* Column factor for indexing purposes. */
68 Each array element in cc[] is ordinarily a "char *" pointer to a
69 string. If TAB_JOIN (defined in tab.c) is set in ct[] for the element,
70 however, it is a joined cell and the corresponding element of cc[]
71 points to a struct tab_joined_cell. */
72 void **cc; /* Cell contents; void *[nr][nc]. */
73 unsigned char *ct; /* Cell types; unsigned char[nr][nc]. */
76 unsigned char *rh; /* Horiz rules; unsigned char[nr+1][nc]. */
77 unsigned char *rv; /* Vert rules; unsigned char[nr][nc+1]. */
79 /* X and Y offsets. */
82 struct fmt_spec fmtmap [n_RC];
85 struct tab_table *tab_cast (const struct table *);
87 /* Number of rows or columns in TABLE. */
88 static inline int tab_nr (const struct tab_table *table)
89 { return table_nr (&table->table); }
90 static inline int tab_nc (const struct tab_table *table)
91 { return table_nc (&table->table); }
93 /* Number of left/right/top/bottom header columns/rows in TABLE. */
94 static inline int tab_l (const struct tab_table *table)
95 { return table_hl (&table->table); }
96 static inline int tab_r (const struct tab_table *table)
97 { return table_hr (&table->table); }
98 static inline int tab_t (const struct tab_table *table)
99 { return table_ht (&table->table); }
100 static inline int tab_b (const struct tab_table *table)
101 { return table_hb (&table->table); }
104 struct tab_table *tab_create (int nc, int nr);
105 void tab_resize (struct tab_table *, int nc, int nr);
106 void tab_realloc (struct tab_table *, int nc, int nr);
107 void tab_headers (struct tab_table *, int l, int r, int t, int b);
108 void tab_title (struct tab_table *, const char *, ...)
109 PRINTF_FORMAT (2, 3);
110 void tab_submit (struct tab_table *);
113 void tab_hline (struct tab_table *, int style, int x1, int x2, int y);
114 void tab_vline (struct tab_table *, int style, int x, int y1, int y2);
115 void tab_box (struct tab_table *, int f_h, int f_v, int i_h, int i_v,
116 int x1, int y1, int x2, int y2);
118 /* Obsolete cell options. */
119 #define TAT_TITLE TAB_EMPH /* Title attributes. */
121 void tab_set_format (struct tab_table *, enum result_class, const struct fmt_spec *);
128 void tab_value (struct tab_table *, int c, int r, unsigned char opt,
129 const union value *, const struct variable *,
130 const struct fmt_spec *);
132 void tab_double (struct tab_table *, int c, int r, unsigned char opt,
133 double v, const struct fmt_spec *, enum result_class );
135 void tab_text (struct tab_table *, int c, int r, unsigned opt, const char *);
136 void tab_text_format (struct tab_table *, int c, int r, unsigned opt,
138 PRINTF_FORMAT (5, 6);
140 void tab_joint_text (struct tab_table *, int x1, int y1, int x2, int y2,
141 unsigned opt, const char *);
142 void tab_joint_text_format (struct tab_table *, int x1, int y1, int x2, int y2,
143 unsigned opt, const char *, ...)
144 PRINTF_FORMAT (7, 8);
146 bool tab_cell_is_empty (const struct tab_table *, int c, int r);
149 void tab_offset (struct tab_table *, int col, int row);
150 void tab_next_row (struct tab_table *);
152 /* Current row/column offset. */
153 #define tab_row(TABLE) ((TABLE)->row_ofs)
154 #define tab_col(TABLE) ((TABLE)->col_ofs)
157 void tab_output_text (int options, const char *string);
158 void tab_output_text_format (int options, const char *, ...)
159 PRINTF_FORMAT (2, 3);
161 #endif /* output/tab.h */