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;
69 const struct footnote **footnotes;
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, TAL_0, nc * (nr + 1));
104 t->rv = pool_nmalloc (t->container, nr, nc + 1);
105 memset (t->rv, TAL_0, nr * (nc + 1));
107 memset (t->fmtmap, 0, sizeof (*t->fmtmap) * n_RC);
108 t->fmtmap[RC_PVALUE] = ugly[RC_PVALUE];
109 t->fmtmap[RC_INTEGER] = ugly[RC_INTEGER];
110 t->fmtmap[RC_OTHER] = *settings_get_format ();
112 t->col_ofs = t->row_ofs = 0;
119 tab_set_format (struct tab_table *t, enum result_class rc,
120 const struct fmt_spec *fmt)
122 t->fmtmap[rc] = *fmt;
126 /* Sets the width and height of a table, in columns and rows,
127 respectively. Use only to reduce the size of a table, since it
128 does not change the amount of allocated memory.
130 This function is obsolete. Please do not add new uses of it. (Instead, use
131 table_select() or one of its helper functions.) */
133 tab_resize (struct tab_table *t, int nc, int nr)
137 assert (nc + t->col_ofs <= t->cf);
138 table_set_nc (&t->table, nc + t->col_ofs);
142 assert (nr + t->row_ofs <= tab_nr (t));
143 table_set_nr (&t->table, nr + t->row_ofs);
147 /* Changes either or both dimensions of a table and reallocates memory as
150 This function is obsolete. Please do not add new uses of it. (Instead, use
151 table_paste() or one of its helper functions to paste multiple tables
152 together into a larger one.) */
154 tab_realloc (struct tab_table *t, int nc, int nr)
161 tab_offset (t, 0, 0);
168 assert (nc == tab_nc (t));
172 int mr1 = MIN (nr, tab_nr (t));
173 int mc1 = MIN (nc, tab_nc (t));
176 unsigned char *new_ct;
179 new_cc = pool_calloc (t->container, nr * nc, sizeof *new_cc);
180 new_ct = pool_malloc (t->container, nr * nc);
181 for (r = 0; r < mr1; r++)
183 memcpy (&new_cc[r * nc], &t->cc[r * tab_nc (t)],
184 mc1 * sizeof *t->cc);
185 memcpy (&new_ct[r * nc], &t->ct[r * tab_nc (t)], mc1);
186 memset (&new_ct[r * nc + tab_nc (t)], 0, nc - tab_nc (t));
188 pool_free (t->container, t->cc);
189 pool_free (t->container, t->ct);
194 else if (nr != tab_nr (t))
196 t->cc = pool_nrealloc (t->container, t->cc, nr * nc, sizeof *t->cc);
197 t->ct = pool_realloc (t->container, t->ct, nr * nc);
199 t->rh = pool_nrealloc (t->container, t->rh, nc, nr + 1);
200 t->rv = pool_nrealloc (t->container, t->rv, nr, nc + 1);
204 memset (&t->rh[nc * (tab_nr (t) + 1)], TAL_0,
205 (nr - tab_nr (t)) * nc);
206 memset (&t->rv[(nc + 1) * tab_nr (t)], TAL_0,
207 (nr - tab_nr (t)) * (nc + 1));
211 memset (&t->ct[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)));
212 memset (&t->cc[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)) * sizeof *t->cc);
214 table_set_nr (&t->table, nr);
215 table_set_nc (&t->table, nc);
218 tab_offset (t, co, ro);
221 /* Sets the number of header rows on each side of TABLE to L on the
222 left, R on the right, T on the top, B on the bottom. Header rows
223 are repeated when a table is broken across multiple columns or
226 tab_headers (struct tab_table *table, int l, int r, int t, int b)
228 table_set_hl (&table->table, l);
229 table_set_hr (&table->table, r);
230 table_set_ht (&table->table, t);
231 table_set_hb (&table->table, b);
236 /* Draws a vertical line to the left of cells at horizontal position X
237 from Y1 to Y2 inclusive in style STYLE, if style is not -1. */
239 tab_vline (struct tab_table *t, int style, int x, int y1, int y2)
243 if (x + t->col_ofs < 0 || x + t->col_ofs > tab_nc (t)
244 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
245 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
247 printf (_("bad vline: x=%d+%d=%d y=(%d+%d=%d,%d+%d=%d) in "
248 "table size (%d,%d)\n"),
249 x, t->col_ofs, x + t->col_ofs,
250 y1, t->row_ofs, y1 + t->row_ofs,
251 y2, t->row_ofs, y2 + t->row_ofs, tab_nc (t), tab_nr (t));
261 assert (x <= tab_nc (t));
264 assert (y2 <= tab_nr (t));
269 for (y = y1; y <= y2; y++)
270 t->rv[x + (t->cf + 1) * y] = style;
274 /* Draws a horizontal line above cells at vertical position Y from X1
275 to X2 inclusive in style STYLE, if style is not -1. */
277 tab_hline (struct tab_table *t, int style, int x1, int x2, int y)
281 if (y + t->row_ofs < 0 || y + t->row_ofs > tab_nr (t)
282 || x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
283 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t))
285 printf (_("bad hline: x=(%d+%d=%d,%d+%d=%d) y=%d+%d=%d in "
286 "table size (%d,%d)\n"),
287 x1, t->col_ofs, x1 + t->col_ofs,
288 x2, t->col_ofs, x2 + t->col_ofs,
289 y, t->row_ofs, y + t->row_ofs, tab_nc (t), tab_nr (t));
299 assert (y <= tab_nr (t));
302 assert (x2 < tab_nc (t));
307 for (x = x1; x <= x2; x++)
308 t->rh[x + t->cf * y] = style;
312 /* Draws a box around cells (X1,Y1)-(X2,Y2) inclusive with horizontal
313 lines of style F_H and vertical lines of style F_V. Fills the
314 interior of the box with horizontal lines of style I_H and vertical
315 lines of style I_V. Any of the line styles may be -1 to avoid
316 drawing those lines. This is distinct from 0, which draws a null
319 tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
320 int x1, int y1, int x2, int y2)
324 if (x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
325 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t)
326 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
327 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
329 printf (_("bad box: (%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) "
330 "in table size (%d,%d)\n"),
331 x1, t->col_ofs, x1 + t->col_ofs,
332 y1, t->row_ofs, y1 + t->row_ofs,
333 x2, t->col_ofs, x2 + t->col_ofs,
334 y2, t->row_ofs, y2 + t->row_ofs, tab_nc (t), tab_nr (t));
348 assert (x2 < tab_nc (t));
349 assert (y2 < tab_nr (t));
354 for (x = x1; x <= x2; x++)
356 t->rh[x + t->cf * y1] = f_h;
357 t->rh[x + t->cf * (y2 + 1)] = f_h;
363 for (y = y1; y <= y2; y++)
365 t->rv[x1 + (t->cf + 1) * y] = f_v;
366 t->rv[(x2 + 1) + (t->cf + 1) * y] = f_v;
374 for (y = y1 + 1; y <= y2; y++)
378 for (x = x1; x <= x2; x++)
379 t->rh[x + t->cf * y] = i_h;
386 for (x = x1 + 1; x <= x2; x++)
390 for (y = y1; y <= y2; y++)
391 t->rv[x + (t->cf + 1) * y] = i_v;
398 /* Sets cell (C,R) in TABLE, with options OPT, to have a value taken
399 from V, displayed with format spec F. */
401 tab_value (struct tab_table *table, int c, int r, unsigned char opt,
402 const union value *v, const struct variable *var,
403 const struct fmt_spec *f)
409 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
410 || c + table->col_ofs >= tab_nc (table)
411 || r + table->row_ofs >= tab_nr (table))
413 printf ("tab_value(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
415 c, table->col_ofs, c + table->col_ofs,
416 r, table->row_ofs, r + table->row_ofs,
417 tab_nc (table), tab_nr (table));
422 contents = data_out_stretchy (v, var_get_encoding (var),
423 f != NULL ? f : var_get_print_format (var),
426 table->cc[c + r * table->cf] = contents;
427 table->ct[c + r * table->cf] = opt;
430 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL as
432 If FMT is null, then the default print format will be used.
435 tab_double (struct tab_table *table, int c, int r, unsigned char opt,
436 double val, const struct fmt_spec *fmt, enum result_class rc)
438 union value double_value;
442 assert (c < tab_nc (table));
444 assert (r < tab_nr (table));
447 fmt = &table->fmtmap[rc];
449 fmt_check_output (fmt);
453 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
454 || c + table->col_ofs >= tab_nc (table)
455 || r + table->row_ofs >= tab_nr (table))
457 printf ("tab_double(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
459 c, table->col_ofs, c + table->col_ofs,
460 r, table->row_ofs, r + table->row_ofs,
461 tab_nc (table), tab_nr (table));
466 double_value.f = val;
467 s = data_out_stretchy (&double_value, C_ENCODING, fmt, table->container);
468 table->cc[c + r * table->cf] = s + strspn (s, " ");
469 table->ct[c + r * table->cf] = opt;
474 do_tab_text (struct tab_table *table, int c, int r, unsigned opt, char *text)
478 assert (c < tab_nc (table));
479 assert (r < tab_nr (table));
483 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
484 || c + table->col_ofs >= tab_nc (table)
485 || r + table->row_ofs >= tab_nr (table))
487 printf ("tab_text(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
489 c, table->col_ofs, c + table->col_ofs,
490 r, table->row_ofs, r + table->row_ofs,
491 tab_nc (table), tab_nr (table));
496 table->cc[c + r * table->cf] = text;
497 table->ct[c + r * table->cf] = opt;
500 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
503 tab_text (struct tab_table *table, int c, int r, unsigned opt,
506 do_tab_text (table, c, r, opt, pool_strdup (table->container, text));
509 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
510 FORMAT, which is formatted as if passed to printf. */
512 tab_text_format (struct tab_table *table, int c, int r, unsigned opt,
513 const char *format, ...)
517 va_start (args, format);
518 do_tab_text (table, c, r, opt,
519 pool_vasprintf (table->container, format, args));
523 static struct tab_joined_cell *
524 add_joined_cell (struct tab_table *table, int x1, int y1, int x2, int y2,
527 struct tab_joined_cell *j;
529 assert (x1 + table->col_ofs >= 0);
530 assert (y1 + table->row_ofs >= 0);
533 assert (y2 + table->row_ofs < tab_nr (table));
534 assert (x2 + table->col_ofs < tab_nc (table));
538 if (x1 + table->col_ofs < 0 || x1 + table->col_ofs >= tab_nc (table)
539 || y1 + table->row_ofs < 0 || y1 + table->row_ofs >= tab_nr (table)
540 || x2 < x1 || x2 + table->col_ofs >= tab_nc (table)
541 || y2 < y1 || y2 + table->row_ofs >= tab_nr (table))
543 printf ("tab_joint_text(): bad cell "
544 "(%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) in table size (%d,%d)\n",
545 x1, table->col_ofs, x1 + table->col_ofs,
546 y1, table->row_ofs, y1 + table->row_ofs,
547 x2, table->col_ofs, x2 + table->col_ofs,
548 y2, table->row_ofs, y2 + table->row_ofs,
549 tab_nc (table), tab_nr (table));
554 tab_box (table, -1, -1, TAL_0, TAL_0, x1, y1, x2, y2);
556 j = pool_alloc (table->container, sizeof *j);
557 j->d[TABLE_HORZ][0] = x1 + table->col_ofs;
558 j->d[TABLE_VERT][0] = y1 + table->row_ofs;
559 j->d[TABLE_HORZ][1] = ++x2 + table->col_ofs;
560 j->d[TABLE_VERT][1] = ++y2 + table->row_ofs;
565 void **cc = &table->cc[x1 + y1 * table->cf];
566 unsigned char *ct = &table->ct[x1 + y1 * table->cf];
567 const int ofs = table->cf - (x2 - x1);
571 for (y = y1; y < y2; y++)
575 for (x = x1; x < x2; x++)
578 *ct++ = opt | TAB_JOIN;
589 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them with
590 options OPT to have text value TEXT. */
592 tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
593 unsigned opt, const char *text)
595 char *s = pool_strdup (table->container, text);
596 if (x1 == x2 && y1 == y2)
597 do_tab_text (table, x1, y1, opt, s);
599 add_joined_cell (table, x1, y1, x2, y2, opt)->u.text = s;
602 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them
603 with options OPT to have text value FORMAT, which is formatted
604 as if passed to printf. */
606 tab_joint_text_format (struct tab_table *table, int x1, int y1, int x2,
607 int y2, unsigned opt, const char *format, ...)
612 va_start (args, format);
613 s = pool_vasprintf (table->container, format, args);
616 add_joined_cell (table, x1, y1, x2, y2, opt)->u.text = s;
620 tab_create_footnote (struct tab_table *table, size_t idx, const char *content,
623 struct footnote *f = pool_alloc (table->container, sizeof *f);
625 f->content = pool_strdup (table->container, content);
626 f->marker = pool_strdup (table->container, marker);
631 tab_add_footnote (struct tab_table *table, int x, int y,
632 const struct footnote *f)
634 int index = x + y * table->cf;
635 unsigned char opt = table->ct[index];
636 struct tab_joined_cell *j;
639 j = table->cc[index];
642 char *text = table->cc[index];
644 j = add_joined_cell (table, x, y, x, y, table->ct[index]);
645 j->u.text = text ? text : xstrdup ("");
648 j->footnotes = pool_realloc (table->container, j->footnotes,
649 (j->n_footnotes + 1) * sizeof *j->footnotes);
651 j->footnotes[j->n_footnotes++] = f;
655 tab_cell_is_empty (const struct tab_table *table, int c, int r)
657 return table->cc[c + r * table->cf] == NULL;
662 /* Set the title of table T to TITLE, which is formatted as if
663 passed to printf(). */
665 tab_title (struct tab_table *t, const char *title, ...)
670 va_start (args, title);
671 t->title = xvasprintf (title, args);
675 /* Set the caption of table T to CAPTION, which is formatted as if
676 passed to printf(). */
678 tab_caption (struct tab_table *t, const char *caption, ...)
683 va_start (args, caption);
684 t->caption = xvasprintf (caption, args);
688 /* Easy, type-safe way to submit a tab table to som. */
690 tab_submit (struct tab_table *t)
692 table_item_submit (table_item_create (&t->table, t->title, t->caption));
697 /* Set table row and column offsets for all functions that affect
700 tab_offset (struct tab_table *t, int col, int row)
706 if (row < -1 || row > tab_nr (t))
708 printf ("tab_offset(): row=%d in %d-row table\n", row, tab_nr (t));
711 if (col < -1 || col > tab_nc (t))
713 printf ("tab_offset(): col=%d in %d-column table\n", col,
720 diff += (row - t->row_ofs) * t->cf, t->row_ofs = row;
722 diff += (col - t->col_ofs), t->col_ofs = col;
728 /* Increment the row offset by one. If the table is too small,
729 increase its size. */
731 tab_next_row (struct tab_table *t)
735 if (++t->row_ofs >= tab_nr (t))
736 tab_realloc (t, -1, tab_nr (t) * 4 / 3);
739 /* Writes STRING to the output. OPTIONS may be any valid combination of TAB_*
742 This function is obsolete. Please do not add new uses of it. Instead, use
743 a text_item (see output/text-item.h). */
745 tab_output_text (int options, const char *string)
747 enum text_item_type type = (options & TAB_EMPH ? TEXT_ITEM_SUBHEAD
748 : options & TAB_FIX ? TEXT_ITEM_MONOSPACE
749 : TEXT_ITEM_PARAGRAPH);
750 text_item_submit (text_item_create (type, string));
753 /* Same as tab_output_text(), but FORMAT is passed through printf-like
754 formatting before output. */
756 tab_output_text_format (int options, const char *format, ...)
761 va_start (args, format);
762 text = xvasprintf (format, args);
765 tab_output_text (options, text);
770 /* Table class implementation. */
773 tab_destroy (struct table *table)
775 struct tab_table *t = tab_cast (table);
780 pool_destroy (t->container);
784 tab_get_cell (const struct table *table, int x, int y,
785 struct table_cell *cell)
787 const struct tab_table *t = tab_cast (table);
788 int index = x + y * t->cf;
789 unsigned char opt = t->ct[index];
790 const void *cc = t->cc[index];
792 cell->inline_contents.options = opt;
793 cell->inline_contents.n_footnotes = 0;
794 cell->destructor = NULL;
798 const struct tab_joined_cell *jc = cc;
799 cell->contents = &cell->inline_contents;
800 cell->n_contents = 1;
801 cell->inline_contents.text = jc->u.text;
803 cell->inline_contents.footnotes = jc->footnotes;
804 cell->inline_contents.n_footnotes = jc->n_footnotes;
806 cell->d[TABLE_HORZ][0] = jc->d[TABLE_HORZ][0];
807 cell->d[TABLE_HORZ][1] = jc->d[TABLE_HORZ][1];
808 cell->d[TABLE_VERT][0] = jc->d[TABLE_VERT][0];
809 cell->d[TABLE_VERT][1] = jc->d[TABLE_VERT][1];
813 cell->d[TABLE_HORZ][0] = x;
814 cell->d[TABLE_HORZ][1] = x + 1;
815 cell->d[TABLE_VERT][0] = y;
816 cell->d[TABLE_VERT][1] = y + 1;
819 cell->contents = &cell->inline_contents;
820 cell->n_contents = 1;
821 cell->inline_contents.text = CONST_CAST (char *, cc);
825 cell->contents = NULL;
826 cell->n_contents = 0;
832 tab_get_rule (const struct table *table, enum table_axis axis, int x, int y)
834 const struct tab_table *t = tab_cast (table);
835 return (axis == TABLE_VERT
836 ? t->rh[x + t->cf * y] : t->rv[x + (t->cf + 1) * y]);
839 static const struct table_class tab_table_class = {
848 tab_cast (const struct table *table)
850 assert (table->klass == &tab_table_class);
851 return UP_CAST (table, struct tab_table, table);