1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011, 2013, 2014 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/>. */
19 #include "output/tab.h"
26 #include "data/data-out.h"
27 #include "data/format.h"
28 #include "data/settings.h"
29 #include "data/value.h"
30 #include "data/variable.h"
31 #include "libpspp/assertion.h"
32 #include "libpspp/compiler.h"
33 #include "libpspp/i18n.h"
34 #include "libpspp/misc.h"
35 #include "libpspp/pool.h"
36 #include "output/driver.h"
37 #include "output/table-item.h"
38 #include "output/table-provider.h"
39 #include "output/text-item.h"
41 #include "gl/minmax.h"
42 #include "gl/xalloc.h"
45 #define _(msgid) gettext (msgid)
47 /* Set in the options field of cells that */
48 #define TAB_JOIN (1u << TAB_FIRST_AVAILABLE)
51 struct tab_joined_cell
53 int d[TABLE_N_AXES][2]; /* Table region, same as struct table_cell. */
57 static const struct table_class tab_table_class;
59 struct fmt_spec ugly [n_RC] =
61 {FMT_F, 8, 0}, /* INTEGER */
62 {FMT_F, 8, 3}, /* WEIGHT (ignored) */
63 {FMT_F, 8, 3}, /* PVALUE */
64 {FMT_F, 8, 3} /* OTHER (ignored) */
68 /* Creates and returns a new table with NC columns and NR rows and initially no
69 header rows or columns. The table's cells are initially empty. */
71 tab_create (int nc, int nr)
75 t = pool_create_container (struct tab_table, container);
76 table_init (&t->table, &tab_table_class);
77 table_set_nc (&t->table, nc);
78 table_set_nr (&t->table, nr);
82 t->cc = pool_calloc (t->container, nr * nc, sizeof *t->cc);
83 t->ct = pool_malloc (t->container, nr * nc);
84 memset (t->ct, 0, nc * nr);
86 t->rh = pool_nmalloc (t->container, nc, nr + 1);
87 memset (t->rh, 0, nc * (nr + 1));
89 t->rv = pool_nmalloc (t->container, nr, nc + 1);
90 memset (t->fmtmap, 0, sizeof (*t->fmtmap) * n_RC);
92 memset (t->rv, TAL_GAP, nr * (nc + 1));
94 t->fmtmap[RC_PVALUE] = ugly[RC_PVALUE];
95 t->fmtmap[RC_INTEGER] = ugly[RC_INTEGER];
96 t->fmtmap[RC_OTHER] = *settings_get_format ();
98 t->col_ofs = t->row_ofs = 0;
105 tab_set_format (struct tab_table *t, enum result_class rc, const struct fmt_spec *fmt)
107 t->fmtmap[rc] = *fmt;
111 /* Sets the width and height of a table, in columns and rows,
112 respectively. Use only to reduce the size of a table, since it
113 does not change the amount of allocated memory.
115 This function is obsolete. Please do not add new uses of it. (Instead, use
116 table_select() or one of its helper functions.) */
118 tab_resize (struct tab_table *t, int nc, int nr)
122 assert (nc + t->col_ofs <= t->cf);
123 table_set_nc (&t->table, nc + t->col_ofs);
127 assert (nr + t->row_ofs <= tab_nr (t));
128 table_set_nr (&t->table, nr + t->row_ofs);
132 /* Changes either or both dimensions of a table and reallocates memory as
135 This function is obsolete. Please do not add new uses of it. (Instead, use
136 table_paste() or one of its helper functions to paste multiple tables
137 together into a larger one.) */
139 tab_realloc (struct tab_table *t, int nc, int nr)
146 tab_offset (t, 0, 0);
153 assert (nc == tab_nc (t));
157 int mr1 = MIN (nr, tab_nr (t));
158 int mc1 = MIN (nc, tab_nc (t));
161 unsigned char *new_ct;
164 new_cc = pool_calloc (t->container, nr * nc, sizeof *new_cc);
165 new_ct = pool_malloc (t->container, nr * nc);
166 for (r = 0; r < mr1; r++)
168 memcpy (&new_cc[r * nc], &t->cc[r * tab_nc (t)], mc1 * sizeof *t->cc);
169 memcpy (&new_ct[r * nc], &t->ct[r * tab_nc (t)], mc1);
170 memset (&new_ct[r * nc + tab_nc (t)], 0, nc - tab_nc (t));
172 pool_free (t->container, t->cc);
173 pool_free (t->container, t->ct);
178 else if (nr != tab_nr (t))
180 t->cc = pool_nrealloc (t->container, t->cc, nr * nc, sizeof *t->cc);
181 t->ct = pool_realloc (t->container, t->ct, nr * nc);
183 t->rh = pool_nrealloc (t->container, t->rh, nc, nr + 1);
184 t->rv = pool_nrealloc (t->container, t->rv, nr, nc + 1);
188 memset (&t->rh[nc * (tab_nr (t) + 1)], TAL_0, (nr - tab_nr (t)) * nc);
189 memset (&t->rv[(nc + 1) * tab_nr (t)], TAL_GAP,
190 (nr - tab_nr (t)) * (nc + 1));
194 memset (&t->ct[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)));
195 memset (&t->cc[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)) * sizeof *t->cc);
197 table_set_nr (&t->table, nr);
198 table_set_nc (&t->table, nc);
201 tab_offset (t, co, ro);
204 /* Sets the number of header rows on each side of TABLE to L on the
205 left, R on the right, T on the top, B on the bottom. Header rows
206 are repeated when a table is broken across multiple columns or
209 tab_headers (struct tab_table *table, int l, int r, int t, int b)
211 table_set_hl (&table->table, l);
212 table_set_hr (&table->table, r);
213 table_set_ht (&table->table, t);
214 table_set_hb (&table->table, b);
219 /* Draws a vertical line to the left of cells at horizontal position X
220 from Y1 to Y2 inclusive in style STYLE, if style is not -1. */
222 tab_vline (struct tab_table *t, int style, int x, int y1, int y2)
225 if (x + t->col_ofs < 0 || x + t->col_ofs > tab_nc (t)
226 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
227 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
229 printf (_("bad vline: x=%d+%d=%d y=(%d+%d=%d,%d+%d=%d) in "
230 "table size (%d,%d)\n"),
231 x, t->col_ofs, x + t->col_ofs,
232 y1, t->row_ofs, y1 + t->row_ofs,
233 y2, t->row_ofs, y2 + t->row_ofs,
234 tab_nc (t), tab_nr (t));
244 assert (x <= tab_nc (t));
247 assert (y2 <= tab_nr (t));
252 for (y = y1; y <= y2; y++)
253 t->rv[x + (t->cf + 1) * y] = style;
257 /* Draws a horizontal line above cells at vertical position Y from X1
258 to X2 inclusive in style STYLE, if style is not -1. */
260 tab_hline (struct tab_table * t, int style, int x1, int x2, int y)
263 if (y + t->row_ofs < 0 || y + t->row_ofs > tab_nr (t)
264 || x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
265 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t))
267 printf (_("bad hline: x=(%d+%d=%d,%d+%d=%d) y=%d+%d=%d in "
268 "table size (%d,%d)\n"),
269 x1, t->col_ofs, x1 + t->col_ofs,
270 x2, t->col_ofs, x2 + t->col_ofs,
271 y, t->row_ofs, y + t->row_ofs,
272 tab_nc (t), tab_nr (t));
282 assert (y <= tab_nr (t));
285 assert (x2 < tab_nc (t));
290 for (x = x1; x <= x2; x++)
291 t->rh[x + t->cf * y] = style;
295 /* Draws a box around cells (X1,Y1)-(X2,Y2) inclusive with horizontal
296 lines of style F_H and vertical lines of style F_V. Fills the
297 interior of the box with horizontal lines of style I_H and vertical
298 lines of style I_V. Any of the line styles may be -1 to avoid
299 drawing those lines. This is distinct from 0, which draws a null
302 tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
303 int x1, int y1, int x2, int y2)
306 if (x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
307 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t)
308 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
309 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
311 printf (_("bad box: (%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) "
312 "in table size (%d,%d)\n"),
313 x1, t->col_ofs, x1 + t->col_ofs,
314 y1, t->row_ofs, y1 + t->row_ofs,
315 x2, t->col_ofs, x2 + t->col_ofs,
316 y2, t->row_ofs, y2 + t->row_ofs,
317 tab_nc (t), tab_nr (t));
331 assert (x2 < tab_nc (t));
332 assert (y2 < tab_nr (t));
337 for (x = x1; x <= x2; x++)
339 t->rh[x + t->cf * y1] = f_h;
340 t->rh[x + t->cf * (y2 + 1)] = f_h;
346 for (y = y1; y <= y2; y++)
348 t->rv[x1 + (t->cf + 1) * y] = f_v;
349 t->rv[(x2 + 1) + (t->cf + 1) * y] = f_v;
357 for (y = y1 + 1; y <= y2; y++)
361 for (x = x1; x <= x2; x++)
362 t->rh[x + t->cf * y] = i_h;
369 for (x = x1 + 1; x <= x2; x++)
373 for (y = y1; y <= y2; y++)
374 t->rv[x + (t->cf + 1) * y] = i_v;
381 /* Sets cell (C,R) in TABLE, with options OPT, to have a value taken
382 from V, displayed with format spec F. */
384 tab_value (struct tab_table *table, int c, int r, unsigned char opt,
385 const union value *v, const struct variable *var,
386 const struct fmt_spec *f)
391 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
392 || c + table->col_ofs >= tab_nc (table)
393 || r + table->row_ofs >= tab_nr (table))
395 printf ("tab_value(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
397 c, table->col_ofs, c + table->col_ofs,
398 r, table->row_ofs, r + table->row_ofs,
399 tab_nc (table), tab_nr (table));
404 contents = data_out_stretchy (v, var_get_encoding (var),
405 f != NULL ? f : var_get_print_format (var),
408 table->cc[c + r * table->cf] = contents;
409 table->ct[c + r * table->cf] = opt;
412 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL as
414 If FMT is null, then the default print format will be used.
417 tab_double (struct tab_table *table, int c, int r, unsigned char opt,
418 double val, const struct fmt_spec *fmt, enum result_class rc)
420 union value double_value ;
424 assert (c < tab_nc (table));
426 assert (r < tab_nr (table));
429 fmt = &table->fmtmap[rc];
431 fmt_check_output (fmt);
434 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
435 || c + table->col_ofs >= tab_nc (table)
436 || r + table->row_ofs >= tab_nr (table))
438 printf ("tab_double(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
440 c, table->col_ofs, c + table->col_ofs,
441 r, table->row_ofs, r + table->row_ofs,
442 tab_nc (table), tab_nr (table));
447 double_value.f = val;
448 s = data_out_stretchy (&double_value, C_ENCODING, fmt, table->container);
449 table->cc[c + r * table->cf] = s + strspn (s, " ");
450 table->ct[c + r * table->cf] = opt;
455 do_tab_text (struct tab_table *table, int c, int r, unsigned opt, char *text)
459 assert (c < tab_nc (table));
460 assert (r < tab_nr (table));
463 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
464 || c + table->col_ofs >= tab_nc (table)
465 || r + table->row_ofs >= tab_nr (table))
467 printf ("tab_text(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
469 c, table->col_ofs, c + table->col_ofs,
470 r, table->row_ofs, r + table->row_ofs,
471 tab_nc (table), tab_nr (table));
476 table->cc[c + r * table->cf] = text;
477 table->ct[c + r * table->cf] = opt;
480 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
483 tab_text (struct tab_table *table, int c, int r, unsigned opt,
486 do_tab_text (table, c, r, opt, pool_strdup (table->container, text));
489 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
490 FORMAT, which is formatted as if passed to printf. */
492 tab_text_format (struct tab_table *table, int c, int r, unsigned opt,
493 const char *format, ...)
497 va_start (args, format);
498 do_tab_text (table, c, r, opt,
499 pool_vasprintf (table->container, format, args));
504 do_tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
505 unsigned opt, char *text)
507 struct tab_joined_cell *j;
509 assert (x1 + table->col_ofs >= 0);
510 assert (y1 + table->row_ofs >= 0);
513 assert (y2 + table->row_ofs < tab_nr (table));
514 assert (x2 + table->col_ofs < tab_nc (table));
517 if (x1 + table->col_ofs < 0 || x1 + table->col_ofs >= tab_nc (table)
518 || y1 + table->row_ofs < 0 || y1 + table->row_ofs >= tab_nr (table)
519 || x2 < x1 || x2 + table->col_ofs >= tab_nc (table)
520 || y2 < y2 || y2 + table->row_ofs >= tab_nr (table))
522 printf ("tab_joint_text(): bad cell "
523 "(%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) in table size (%d,%d)\n",
524 x1, table->col_ofs, x1 + table->col_ofs,
525 y1, table->row_ofs, y1 + table->row_ofs,
526 x2, table->col_ofs, x2 + table->col_ofs,
527 y2, table->row_ofs, y2 + table->row_ofs,
528 tab_nc (table), tab_nr (table));
533 tab_box (table, -1, -1, TAL_0, TAL_0, x1, y1, x2, y2);
535 j = pool_alloc (table->container, sizeof *j);
536 j->d[TABLE_HORZ][0] = x1 + table->col_ofs;
537 j->d[TABLE_VERT][0] = y1 + table->row_ofs;
538 j->d[TABLE_HORZ][1] = ++x2 + table->col_ofs;
539 j->d[TABLE_VERT][1] = ++y2 + table->row_ofs;
545 void **cc = &table->cc[x1 + y1 * table->cf];
546 unsigned char *ct = &table->ct[x1 + y1 * table->cf];
547 const int ofs = table->cf - (x2 - x1);
551 for (y = y1; y < y2; y++)
555 for (x = x1; x < x2; x++)
567 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them with
568 options OPT to have text value TEXT. */
570 tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
571 unsigned opt, const char *text)
573 do_tab_joint_text (table, x1, y1, x2, y2, opt,
574 pool_strdup (table->container, text));
577 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them
578 with options OPT to have text value FORMAT, which is formatted
579 as if passed to printf. */
581 tab_joint_text_format (struct tab_table *table, int x1, int y1, int x2, int y2,
582 unsigned opt, const char *format, ...)
586 va_start (args, format);
587 do_tab_joint_text (table, x1, y1, x2, y2, opt,
588 pool_vasprintf (table->container, format, args));
593 tab_cell_is_empty (const struct tab_table *table, int c, int r)
595 return table->cc[c + r * table->cf] == NULL;
600 /* Set the title of table T to TITLE, which is formatted as if
601 passed to printf(). */
603 tab_title (struct tab_table *t, const char *title, ...)
608 va_start (args, title);
609 t->title = xvasprintf (title, args);
613 /* Easy, type-safe way to submit a tab table to som. */
615 tab_submit (struct tab_table *t)
617 table_item_submit (table_item_create (&t->table, t->title));
622 /* Set table row and column offsets for all functions that affect
625 tab_offset (struct tab_table *t, int col, int row)
630 if (row < -1 || row > tab_nr (t))
632 printf ("tab_offset(): row=%d in %d-row table\n", row, tab_nr (t));
635 if (col < -1 || col > tab_nc (t))
637 printf ("tab_offset(): col=%d in %d-column table\n", col, tab_nc (t));
643 diff += (row - t->row_ofs) * t->cf, t->row_ofs = row;
645 diff += (col - t->col_ofs), t->col_ofs = col;
651 /* Increment the row offset by one. If the table is too small,
652 increase its size. */
654 tab_next_row (struct tab_table *t)
658 if (++t->row_ofs >= tab_nr (t))
659 tab_realloc (t, -1, tab_nr (t) * 4 / 3);
662 /* Writes STRING to the output. OPTIONS may be any valid combination of TAB_*
665 This function is obsolete. Please do not add new uses of it. Instead, use
666 a text_item (see output/text-item.h). */
668 tab_output_text (int options, const char *string)
670 enum text_item_type type = (options & TAB_EMPH ? TEXT_ITEM_SUBHEAD
671 : options & TAB_FIX ? TEXT_ITEM_MONOSPACE
672 : TEXT_ITEM_PARAGRAPH);
673 text_item_submit (text_item_create (type, string));
676 /* Same as tab_output_text(), but FORMAT is passed through printf-like
677 formatting before output. */
679 tab_output_text_format (int options, const char *format, ...)
684 va_start (args, format);
685 text = xvasprintf (format, args);
688 tab_output_text (options, text);
693 /* Table class implementation. */
696 tab_destroy (struct table *table)
698 struct tab_table *t = tab_cast (table);
701 pool_destroy (t->container);
705 tab_get_cell (const struct table *table, int x, int y, struct table_cell *cell)
707 const struct tab_table *t = tab_cast (table);
708 int index = x + y * t->cf;
709 unsigned char opt = t->ct[index];
710 const void *content = t->cc[index];
715 const struct tab_joined_cell *jc = content;
716 cell->d[TABLE_HORZ][0] = jc->d[TABLE_HORZ][0];
717 cell->d[TABLE_HORZ][1] = jc->d[TABLE_HORZ][1];
718 cell->d[TABLE_VERT][0] = jc->d[TABLE_VERT][0];
719 cell->d[TABLE_VERT][1] = jc->d[TABLE_VERT][1];
720 cell->contents = jc->contents;
724 cell->d[TABLE_HORZ][0] = x;
725 cell->d[TABLE_HORZ][1] = x + 1;
726 cell->d[TABLE_VERT][0] = y;
727 cell->d[TABLE_VERT][1] = y + 1;
728 cell->contents = content != NULL ? content : "";
730 cell->destructor = NULL;
734 tab_get_rule (const struct table *table, enum table_axis axis, int x, int y)
736 const struct tab_table *t = tab_cast (table);
737 return (axis == TABLE_VERT
738 ? t->rh[x + t->cf * y]
739 : t->rv[x + (t->cf + 1) * y]);
742 static const struct table_class tab_table_class =
752 tab_cast (const struct table *table)
754 assert (table->klass == &tab_table_class);
755 return UP_CAST (table, struct tab_table, table);