1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011, 2013, 2014, 2016 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)
49 static const bool debugging = true;
51 static const bool debugging = false;
55 #define TAB_JOIN (1u << TAB_FIRST_AVAILABLE)
58 struct tab_joined_cell
60 int d[TABLE_N_AXES][2]; /* Table region, same as struct table_cell. */
64 struct table_item *subtable;
72 static const struct table_class tab_table_class;
74 struct fmt_spec ugly[n_RC] = {
75 {FMT_F, 8, 0}, /* INTEGER */
76 {FMT_F, 8, 3}, /* WEIGHT (ignored) */
77 {FMT_F, 8, 3}, /* PVALUE */
78 {FMT_F, 8, 3} /* OTHER (ignored) */
82 /* Creates and returns a new table with NC columns and NR rows and initially no
83 header rows or columns. The table's cells are initially empty. */
85 tab_create (int nc, int nr)
89 t = pool_create_container (struct tab_table, container);
90 table_init (&t->table, &tab_table_class);
91 table_set_nc (&t->table, nc);
92 table_set_nr (&t->table, nr);
97 t->cc = pool_calloc (t->container, nr * nc, sizeof *t->cc);
98 t->ct = pool_malloc (t->container, nr * nc);
99 memset (t->ct, 0, nc * nr);
101 t->rh = pool_nmalloc (t->container, nc, nr + 1);
102 memset (t->rh, 0, nc * (nr + 1));
104 t->rv = pool_nmalloc (t->container, nr, nc + 1);
105 memset (t->fmtmap, 0, sizeof (*t->fmtmap) * n_RC);
107 memset (t->rv, TAL_GAP, nr * (nc + 1));
109 t->fmtmap[RC_PVALUE] = ugly[RC_PVALUE];
110 t->fmtmap[RC_INTEGER] = ugly[RC_INTEGER];
111 t->fmtmap[RC_OTHER] = *settings_get_format ();
113 t->col_ofs = t->row_ofs = 0;
120 tab_set_format (struct tab_table *t, enum result_class rc,
121 const struct fmt_spec *fmt)
123 t->fmtmap[rc] = *fmt;
127 /* Sets the width and height of a table, in columns and rows,
128 respectively. Use only to reduce the size of a table, since it
129 does not change the amount of allocated memory.
131 This function is obsolete. Please do not add new uses of it. (Instead, use
132 table_select() or one of its helper functions.) */
134 tab_resize (struct tab_table *t, int nc, int nr)
138 assert (nc + t->col_ofs <= t->cf);
139 table_set_nc (&t->table, nc + t->col_ofs);
143 assert (nr + t->row_ofs <= tab_nr (t));
144 table_set_nr (&t->table, nr + t->row_ofs);
148 /* Changes either or both dimensions of a table and reallocates memory as
151 This function is obsolete. Please do not add new uses of it. (Instead, use
152 table_paste() or one of its helper functions to paste multiple tables
153 together into a larger one.) */
155 tab_realloc (struct tab_table *t, int nc, int nr)
162 tab_offset (t, 0, 0);
169 assert (nc == tab_nc (t));
173 int mr1 = MIN (nr, tab_nr (t));
174 int mc1 = MIN (nc, tab_nc (t));
177 unsigned char *new_ct;
180 new_cc = pool_calloc (t->container, nr * nc, sizeof *new_cc);
181 new_ct = pool_malloc (t->container, nr * nc);
182 for (r = 0; r < mr1; r++)
184 memcpy (&new_cc[r * nc], &t->cc[r * tab_nc (t)],
185 mc1 * sizeof *t->cc);
186 memcpy (&new_ct[r * nc], &t->ct[r * tab_nc (t)], mc1);
187 memset (&new_ct[r * nc + tab_nc (t)], 0, nc - tab_nc (t));
189 pool_free (t->container, t->cc);
190 pool_free (t->container, t->ct);
195 else if (nr != tab_nr (t))
197 t->cc = pool_nrealloc (t->container, t->cc, nr * nc, sizeof *t->cc);
198 t->ct = pool_realloc (t->container, t->ct, nr * nc);
200 t->rh = pool_nrealloc (t->container, t->rh, nc, nr + 1);
201 t->rv = pool_nrealloc (t->container, t->rv, nr, nc + 1);
205 memset (&t->rh[nc * (tab_nr (t) + 1)], TAL_0,
206 (nr - tab_nr (t)) * nc);
207 memset (&t->rv[(nc + 1) * tab_nr (t)], TAL_GAP,
208 (nr - tab_nr (t)) * (nc + 1));
212 memset (&t->ct[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)));
213 memset (&t->cc[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)) * sizeof *t->cc);
215 table_set_nr (&t->table, nr);
216 table_set_nc (&t->table, nc);
219 tab_offset (t, co, ro);
222 /* Sets the number of header rows on each side of TABLE to L on the
223 left, R on the right, T on the top, B on the bottom. Header rows
224 are repeated when a table is broken across multiple columns or
227 tab_headers (struct tab_table *table, int l, int r, int t, int b)
229 table_set_hl (&table->table, l);
230 table_set_hr (&table->table, r);
231 table_set_ht (&table->table, t);
232 table_set_hb (&table->table, b);
237 /* Draws a vertical line to the left of cells at horizontal position X
238 from Y1 to Y2 inclusive in style STYLE, if style is not -1. */
240 tab_vline (struct tab_table *t, int style, int x, int y1, int y2)
244 if (x + t->col_ofs < 0 || x + t->col_ofs > tab_nc (t)
245 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
246 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
248 printf (_("bad vline: x=%d+%d=%d y=(%d+%d=%d,%d+%d=%d) in "
249 "table size (%d,%d)\n"),
250 x, t->col_ofs, x + t->col_ofs,
251 y1, t->row_ofs, y1 + t->row_ofs,
252 y2, t->row_ofs, y2 + t->row_ofs, tab_nc (t), tab_nr (t));
262 assert (x <= tab_nc (t));
265 assert (y2 <= tab_nr (t));
270 for (y = y1; y <= y2; y++)
271 t->rv[x + (t->cf + 1) * y] = style;
275 /* Draws a horizontal line above cells at vertical position Y from X1
276 to X2 inclusive in style STYLE, if style is not -1. */
278 tab_hline (struct tab_table *t, int style, int x1, int x2, int y)
282 if (y + t->row_ofs < 0 || y + t->row_ofs > tab_nr (t)
283 || x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
284 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t))
286 printf (_("bad hline: x=(%d+%d=%d,%d+%d=%d) y=%d+%d=%d in "
287 "table size (%d,%d)\n"),
288 x1, t->col_ofs, x1 + t->col_ofs,
289 x2, t->col_ofs, x2 + t->col_ofs,
290 y, t->row_ofs, y + t->row_ofs, tab_nc (t), tab_nr (t));
300 assert (y <= tab_nr (t));
303 assert (x2 < tab_nc (t));
308 for (x = x1; x <= x2; x++)
309 t->rh[x + t->cf * y] = style;
313 /* Draws a box around cells (X1,Y1)-(X2,Y2) inclusive with horizontal
314 lines of style F_H and vertical lines of style F_V. Fills the
315 interior of the box with horizontal lines of style I_H and vertical
316 lines of style I_V. Any of the line styles may be -1 to avoid
317 drawing those lines. This is distinct from 0, which draws a null
320 tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
321 int x1, int y1, int x2, int y2)
325 if (x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
326 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t)
327 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
328 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
330 printf (_("bad box: (%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) "
331 "in table size (%d,%d)\n"),
332 x1, t->col_ofs, x1 + t->col_ofs,
333 y1, t->row_ofs, y1 + t->row_ofs,
334 x2, t->col_ofs, x2 + t->col_ofs,
335 y2, t->row_ofs, y2 + t->row_ofs, tab_nc (t), tab_nr (t));
349 assert (x2 < tab_nc (t));
350 assert (y2 < tab_nr (t));
355 for (x = x1; x <= x2; x++)
357 t->rh[x + t->cf * y1] = f_h;
358 t->rh[x + t->cf * (y2 + 1)] = f_h;
364 for (y = y1; y <= y2; y++)
366 t->rv[x1 + (t->cf + 1) * y] = f_v;
367 t->rv[(x2 + 1) + (t->cf + 1) * y] = f_v;
375 for (y = y1 + 1; y <= y2; y++)
379 for (x = x1; x <= x2; x++)
380 t->rh[x + t->cf * y] = i_h;
387 for (x = x1 + 1; x <= x2; x++)
391 for (y = y1; y <= y2; y++)
392 t->rv[x + (t->cf + 1) * y] = i_v;
399 /* Sets cell (C,R) in TABLE, with options OPT, to have a value taken
400 from V, displayed with format spec F. */
402 tab_value (struct tab_table *table, int c, int r, unsigned char opt,
403 const union value *v, const struct variable *var,
404 const struct fmt_spec *f)
410 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
411 || c + table->col_ofs >= tab_nc (table)
412 || r + table->row_ofs >= tab_nr (table))
414 printf ("tab_value(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
416 c, table->col_ofs, c + table->col_ofs,
417 r, table->row_ofs, r + table->row_ofs,
418 tab_nc (table), tab_nr (table));
423 contents = data_out_stretchy (v, var_get_encoding (var),
424 f != NULL ? f : var_get_print_format (var),
427 table->cc[c + r * table->cf] = contents;
428 table->ct[c + r * table->cf] = opt;
431 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL as
433 If FMT is null, then the default print format will be used.
436 tab_double (struct tab_table *table, int c, int r, unsigned char opt,
437 double val, const struct fmt_spec *fmt, enum result_class rc)
439 union value double_value;
443 assert (c < tab_nc (table));
445 assert (r < tab_nr (table));
448 fmt = &table->fmtmap[rc];
450 fmt_check_output (fmt);
454 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
455 || c + table->col_ofs >= tab_nc (table)
456 || r + table->row_ofs >= tab_nr (table))
458 printf ("tab_double(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
460 c, table->col_ofs, c + table->col_ofs,
461 r, table->row_ofs, r + table->row_ofs,
462 tab_nc (table), tab_nr (table));
467 double_value.f = val;
468 s = data_out_stretchy (&double_value, C_ENCODING, fmt, table->container);
469 table->cc[c + r * table->cf] = s + strspn (s, " ");
470 table->ct[c + r * table->cf] = opt;
475 do_tab_text (struct tab_table *table, int c, int r, unsigned opt, char *text)
479 assert (c < tab_nc (table));
480 assert (r < tab_nr (table));
484 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
485 || c + table->col_ofs >= tab_nc (table)
486 || r + table->row_ofs >= tab_nr (table))
488 printf ("tab_text(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
490 c, table->col_ofs, c + table->col_ofs,
491 r, table->row_ofs, r + table->row_ofs,
492 tab_nc (table), tab_nr (table));
497 table->cc[c + r * table->cf] = text;
498 table->ct[c + r * table->cf] = opt;
501 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
504 tab_text (struct tab_table *table, int c, int r, unsigned opt,
507 do_tab_text (table, c, r, opt, pool_strdup (table->container, text));
510 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
511 FORMAT, which is formatted as if passed to printf. */
513 tab_text_format (struct tab_table *table, int c, int r, unsigned opt,
514 const char *format, ...)
518 va_start (args, format);
519 do_tab_text (table, c, r, opt,
520 pool_vasprintf (table->container, format, args));
524 static struct tab_joined_cell *
525 add_joined_cell (struct tab_table *table, int x1, int y1, int x2, int y2,
528 struct tab_joined_cell *j;
530 assert (x1 + table->col_ofs >= 0);
531 assert (y1 + table->row_ofs >= 0);
534 assert (y2 + table->row_ofs < tab_nr (table));
535 assert (x2 + table->col_ofs < tab_nc (table));
539 if (x1 + table->col_ofs < 0 || x1 + table->col_ofs >= tab_nc (table)
540 || y1 + table->row_ofs < 0 || y1 + table->row_ofs >= tab_nr (table)
541 || x2 < x1 || x2 + table->col_ofs >= tab_nc (table)
542 || y2 < y1 || y2 + table->row_ofs >= tab_nr (table))
544 printf ("tab_joint_text(): bad cell "
545 "(%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) in table size (%d,%d)\n",
546 x1, table->col_ofs, x1 + table->col_ofs,
547 y1, table->row_ofs, y1 + table->row_ofs,
548 x2, table->col_ofs, x2 + table->col_ofs,
549 y2, table->row_ofs, y2 + table->row_ofs,
550 tab_nc (table), tab_nr (table));
555 tab_box (table, -1, -1, TAL_0, TAL_0, x1, y1, x2, y2);
557 j = pool_alloc (table->container, sizeof *j);
558 j->d[TABLE_HORZ][0] = x1 + table->col_ofs;
559 j->d[TABLE_VERT][0] = y1 + table->row_ofs;
560 j->d[TABLE_HORZ][1] = ++x2 + table->col_ofs;
561 j->d[TABLE_VERT][1] = ++y2 + table->row_ofs;
566 void **cc = &table->cc[x1 + y1 * table->cf];
567 unsigned char *ct = &table->ct[x1 + y1 * table->cf];
568 const int ofs = table->cf - (x2 - x1);
572 for (y = y1; y < y2; y++)
576 for (x = x1; x < x2; x++)
579 *ct++ = opt | TAB_JOIN;
590 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them with
591 options OPT to have text value TEXT. */
593 tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
594 unsigned opt, const char *text)
596 char *s = pool_strdup (table->container, text);
597 add_joined_cell (table, x1, y1, x2, y2, opt)->u.text = s;
600 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them
601 with options OPT to have text value FORMAT, which is formatted
602 as if passed to printf. */
604 tab_joint_text_format (struct tab_table *table, int x1, int y1, int x2,
605 int y2, unsigned opt, const char *format, ...)
610 va_start (args, format);
611 s = pool_vasprintf (table->container, format, args);
614 add_joined_cell (table, x1, y1, x2, y2, opt)->u.text = s;
618 tab_footnote (struct tab_table *table, int x, int y, const char *format, ...)
620 int index = x + y * table->cf;
621 unsigned char opt = table->ct[index];
622 struct tab_joined_cell *j;
626 j = table->cc[index];
629 char *text = table->cc[index];
631 j = add_joined_cell (table, x, y, x, y, table->ct[index]);
632 j->u.text = text ? text : xstrdup ("");
635 j->footnotes = xrealloc (j->footnotes,
636 (j->n_footnotes + 1) * sizeof *j->footnotes);
638 va_start (args, format);
639 j->footnotes[j->n_footnotes++] =
640 pool_vasprintf (table->container, format, args);
645 tab_cell_is_empty (const struct tab_table *table, int c, int r)
647 return table->cc[c + r * table->cf] == NULL;
652 /* Set the title of table T to TITLE, which is formatted as if
653 passed to printf(). */
655 tab_title (struct tab_table *t, const char *title, ...)
660 va_start (args, title);
661 t->title = xvasprintf (title, args);
665 /* Set the caption of table T to CAPTION, which is formatted as if
666 passed to printf(). */
668 tab_caption (struct tab_table *t, const char *caption, ...)
673 va_start (args, caption);
674 t->caption = xvasprintf (caption, args);
678 /* Easy, type-safe way to submit a tab table to som. */
680 tab_submit (struct tab_table *t)
682 table_item_submit (table_item_create (&t->table, t->title, t->caption));
687 /* Set table row and column offsets for all functions that affect
690 tab_offset (struct tab_table *t, int col, int row)
696 if (row < -1 || row > tab_nr (t))
698 printf ("tab_offset(): row=%d in %d-row table\n", row, tab_nr (t));
701 if (col < -1 || col > tab_nc (t))
703 printf ("tab_offset(): col=%d in %d-column table\n", col,
710 diff += (row - t->row_ofs) * t->cf, t->row_ofs = row;
712 diff += (col - t->col_ofs), t->col_ofs = col;
718 /* Increment the row offset by one. If the table is too small,
719 increase its size. */
721 tab_next_row (struct tab_table *t)
725 if (++t->row_ofs >= tab_nr (t))
726 tab_realloc (t, -1, tab_nr (t) * 4 / 3);
729 /* Writes STRING to the output. OPTIONS may be any valid combination of TAB_*
732 This function is obsolete. Please do not add new uses of it. Instead, use
733 a text_item (see output/text-item.h). */
735 tab_output_text (int options, const char *string)
737 enum text_item_type type = (options & TAB_EMPH ? TEXT_ITEM_SUBHEAD
738 : options & TAB_FIX ? TEXT_ITEM_MONOSPACE
739 : TEXT_ITEM_PARAGRAPH);
740 text_item_submit (text_item_create (type, string));
743 /* Same as tab_output_text(), but FORMAT is passed through printf-like
744 formatting before output. */
746 tab_output_text_format (int options, const char *format, ...)
751 va_start (args, format);
752 text = xvasprintf (format, args);
755 tab_output_text (options, text);
760 /* Table class implementation. */
763 tab_destroy (struct table *table)
765 struct tab_table *t = tab_cast (table);
770 pool_destroy (t->container);
774 tab_get_cell (const struct table *table, int x, int y,
775 struct table_cell *cell)
777 const struct tab_table *t = tab_cast (table);
778 int index = x + y * t->cf;
779 unsigned char opt = t->ct[index];
780 const void *cc = t->cc[index];
782 cell->inline_contents.options = opt;
783 cell->inline_contents.n_footnotes = 0;
784 cell->destructor = NULL;
788 const struct tab_joined_cell *jc = cc;
789 cell->contents = &cell->inline_contents;
790 cell->n_contents = 1;
791 cell->inline_contents.text = jc->u.text;
793 cell->inline_contents.footnotes = jc->footnotes;
794 cell->inline_contents.n_footnotes = jc->n_footnotes;
796 cell->d[TABLE_HORZ][0] = jc->d[TABLE_HORZ][0];
797 cell->d[TABLE_HORZ][1] = jc->d[TABLE_HORZ][1];
798 cell->d[TABLE_VERT][0] = jc->d[TABLE_VERT][0];
799 cell->d[TABLE_VERT][1] = jc->d[TABLE_VERT][1];
803 cell->d[TABLE_HORZ][0] = x;
804 cell->d[TABLE_HORZ][1] = x + 1;
805 cell->d[TABLE_VERT][0] = y;
806 cell->d[TABLE_VERT][1] = y + 1;
809 cell->contents = &cell->inline_contents;
810 cell->n_contents = 1;
811 cell->inline_contents.text = CONST_CAST (char *, cc);
815 cell->contents = NULL;
816 cell->n_contents = 0;
822 tab_get_rule (const struct table *table, enum table_axis axis, int x, int y)
824 const struct tab_table *t = tab_cast (table);
825 return (axis == TABLE_VERT
826 ? t->rh[x + t->cf * y] : t->rv[x + (t->cf + 1) * y]);
829 static const struct table_class tab_table_class = {
838 tab_cast (const struct table *table)
840 assert (table->klass == &tab_table_class);
841 return UP_CAST (table, struct tab_table, table);