1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009 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/dictionary.h>
31 #include <libpspp/assertion.h>
32 #include <libpspp/compiler.h>
33 #include <libpspp/misc.h>
34 #include <libpspp/pool.h>
35 #include <output/driver.h>
36 #include <output/table-item.h>
37 #include <output/table-provider.h>
38 #include <output/text-item.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 /* Creates and returns a new table with NC columns and NR rows and initially no
60 header rows or columns. The table's cells are initially empty. */
62 tab_create (int nc, int nr)
66 t = pool_create_container (struct tab_table, container);
67 table_init (&t->table, &tab_table_class);
68 table_set_nc (&t->table, nc);
69 table_set_nr (&t->table, nr);
73 t->cc = pool_calloc (t->container, nr * nc, sizeof *t->cc);
74 t->ct = pool_malloc (t->container, nr * nc);
75 memset (t->ct, 0, nc * nr);
77 t->rh = pool_nmalloc (t->container, nc, nr + 1);
78 memset (t->rh, 0, nc * (nr + 1));
80 t->rv = pool_nmalloc (t->container, nr, nc + 1);
81 memset (t->rv, TAL_GAP, nr * (nc + 1));
83 t->col_ofs = t->row_ofs = 0;
88 /* Sets the width and height of a table, in columns and rows,
89 respectively. Use only to reduce the size of a table, since it
90 does not change the amount of allocated memory.
92 This function is obsolete. Please do not add new uses of it. (Instead, use
93 table_select() or one of its helper functions.) */
95 tab_resize (struct tab_table *t, int nc, int nr)
100 assert (nc + t->col_ofs <= t->cf);
101 table_set_nc (&t->table, nc + t->col_ofs);
105 assert (nr + t->row_ofs <= tab_nr (t));
106 table_set_nr (&t->table, nr + t->row_ofs);
110 /* Changes either or both dimensions of a table and reallocates memory as
113 This function is obsolete. Please do not add new uses of it. (Instead, use
114 table_paste() or one of its helper functions to paste multiple tables
115 together into a larger one.) */
117 tab_realloc (struct tab_table *t, int nc, int nr)
125 tab_offset (t, 0, 0);
132 assert (nc == tab_nc (t));
136 int mr1 = MIN (nr, tab_nr (t));
137 int mc1 = MIN (nc, tab_nc (t));
140 unsigned char *new_ct;
143 new_cc = pool_calloc (t->container, nr * nc, sizeof *new_cc);
144 new_ct = pool_malloc (t->container, nr * nc);
145 for (r = 0; r < mr1; r++)
147 memcpy (&new_cc[r * nc], &t->cc[r * tab_nc (t)], mc1 * sizeof *t->cc);
148 memcpy (&new_ct[r * nc], &t->ct[r * tab_nc (t)], mc1);
149 memset (&new_ct[r * nc + tab_nc (t)], 0, nc - tab_nc (t));
151 pool_free (t->container, t->cc);
152 pool_free (t->container, t->ct);
157 else if (nr != tab_nr (t))
159 t->cc = pool_nrealloc (t->container, t->cc, nr * nc, sizeof *t->cc);
160 t->ct = pool_realloc (t->container, t->ct, nr * nc);
162 t->rh = pool_nrealloc (t->container, t->rh, nc, nr + 1);
163 t->rv = pool_nrealloc (t->container, t->rv, nr, nc + 1);
167 memset (&t->rh[nc * (tab_nr (t) + 1)], TAL_0, (nr - tab_nr (t)) * nc);
168 memset (&t->rv[(nc + 1) * tab_nr (t)], TAL_GAP,
169 (nr - tab_nr (t)) * (nc + 1));
173 memset (&t->ct[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)));
174 memset (&t->cc[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)) * sizeof *t->cc);
176 table_set_nr (&t->table, nr);
177 table_set_nc (&t->table, nc);
180 tab_offset (t, co, ro);
183 /* Sets the number of header rows on each side of TABLE to L on the
184 left, R on the right, T on the top, B on the bottom. Header rows
185 are repeated when a table is broken across multiple columns or
188 tab_headers (struct tab_table *table, int l, int r, int t, int b)
190 table_set_hl (&table->table, l);
191 table_set_hr (&table->table, r);
192 table_set_ht (&table->table, t);
193 table_set_hb (&table->table, b);
198 /* Draws a vertical line to the left of cells at horizontal position X
199 from Y1 to Y2 inclusive in style STYLE, if style is not -1. */
201 tab_vline (struct tab_table *t, int style, int x, int y1, int y2)
206 if (x + t->col_ofs < 0 || x + t->col_ofs > tab_nc (t)
207 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
208 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
210 printf (_("bad vline: x=%d+%d=%d y=(%d+%d=%d,%d+%d=%d) in "
211 "table size (%d,%d)\n"),
212 x, t->col_ofs, x + t->col_ofs,
213 y1, t->row_ofs, y1 + t->row_ofs,
214 y2, t->row_ofs, y2 + t->row_ofs,
215 tab_nc (t), tab_nr (t));
225 assert (x <= tab_nc (t));
228 assert (y2 <= tab_nr (t));
233 for (y = y1; y <= y2; y++)
234 t->rv[x + (t->cf + 1) * y] = style;
238 /* Draws a horizontal line above cells at vertical position Y from X1
239 to X2 inclusive in style STYLE, if style is not -1. */
241 tab_hline (struct tab_table * t, int style, int x1, int x2, int y)
250 assert (y <= tab_nr (t));
253 assert (x2 < tab_nc (t));
258 for (x = x1; x <= x2; x++)
259 t->rh[x + t->cf * y] = style;
263 /* Draws a box around cells (X1,Y1)-(X2,Y2) inclusive with horizontal
264 lines of style F_H and vertical lines of style F_V. Fills the
265 interior of the box with horizontal lines of style I_H and vertical
266 lines of style I_V. Any of the line styles may be -1 to avoid
267 drawing those lines. This is distinct from 0, which draws a null
270 tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
271 int x1, int y1, int x2, int y2)
276 if (x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
277 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t)
278 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
279 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
281 printf (_("bad box: (%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) "
282 "in table size (%d,%d)\n"),
283 x1, t->col_ofs, x1 + t->col_ofs,
284 y1, t->row_ofs, y1 + t->row_ofs,
285 x2, t->col_ofs, x2 + t->col_ofs,
286 y2, t->row_ofs, y2 + t->row_ofs,
287 tab_nc (t), tab_nr (t));
301 assert (x2 < tab_nc (t));
302 assert (y2 < tab_nr (t));
307 for (x = x1; x <= x2; x++)
309 t->rh[x + t->cf * y1] = f_h;
310 t->rh[x + t->cf * (y2 + 1)] = f_h;
316 for (y = y1; y <= y2; y++)
318 t->rv[x1 + (t->cf + 1) * y] = f_v;
319 t->rv[(x2 + 1) + (t->cf + 1) * y] = f_v;
327 for (y = y1 + 1; y <= y2; y++)
331 for (x = x1; x <= x2; x++)
332 t->rh[x + t->cf * y] = i_h;
339 for (x = x1 + 1; x <= x2; x++)
343 for (y = y1; y <= y2; y++)
344 t->rv[x + (t->cf + 1) * y] = i_v;
351 /* Sets cell (C,R) in TABLE, with options OPT, to have a value taken
352 from V, displayed with format spec F. */
354 tab_value (struct tab_table *table, int c, int r, unsigned char opt,
355 const union value *v, const struct dictionary *dict,
356 const struct fmt_spec *f)
360 assert (table != NULL && v != NULL && f != NULL);
362 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
363 || c + table->col_ofs >= tab_nc (table)
364 || r + table->row_ofs >= tab_nr (table))
366 printf ("tab_value(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
368 c, table->col_ofs, c + table->col_ofs,
369 r, table->row_ofs, r + table->row_ofs,
370 tab_nc (table), tab_nr (table));
375 contents = data_out_pool (v, dict_get_encoding (dict), f, table->container);
377 table->cc[c + r * table->cf] = contents;
378 table->ct[c + r * table->cf] = opt;
381 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL
382 with NDEC decimal places. */
384 tab_fixed (struct tab_table *table, int c, int r, unsigned char opt,
385 double val, int w, int d)
388 union value double_value;
392 assert (c < tab_nc (table));
394 assert (r < tab_nr (table));
396 f = fmt_for_output (FMT_F, w, d);
399 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
400 || c + table->col_ofs >= tab_nc (table)
401 || r + table->row_ofs >= tab_nr (table))
403 printf ("tab_fixed(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
405 c, table->col_ofs, c + table->col_ofs,
406 r, table->row_ofs, r + table->row_ofs,
407 tab_nc (table), tab_nr (table));
412 double_value.f = val;
413 s = data_out_pool (&double_value, LEGACY_NATIVE, &f, table->container);
415 table->cc[c + r * table->cf] = s + strspn (s, " ");
416 table->ct[c + r * table->cf] = opt;
419 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL as
421 If FMT is null, then the default print format will be used.
424 tab_double (struct tab_table *table, int c, int r, unsigned char opt,
425 double val, const struct fmt_spec *fmt)
427 union value double_value ;
430 assert (table != NULL);
433 assert (c < tab_nc (table));
435 assert (r < tab_nr (table));
438 fmt = settings_get_format ();
440 fmt_check_output (fmt);
443 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
444 || c + table->col_ofs >= tab_nc (table)
445 || r + table->row_ofs >= tab_nr (table))
447 printf ("tab_double(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
449 c, table->col_ofs, c + table->col_ofs,
450 r, table->row_ofs, r + table->row_ofs,
451 tab_nc (table), tab_nr (table));
456 double_value.f = val;
457 s = data_out_pool (&double_value, LEGACY_NATIVE, fmt, table->container);
458 table->cc[c + r * table->cf] = s + strspn (s, " ");
459 table->ct[c + r * table->cf] = opt;
464 do_tab_text (struct tab_table *table, int c, int r, unsigned opt, char *text)
468 assert (c < tab_nc (table));
469 assert (r < tab_nr (table));
472 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
473 || c + table->col_ofs >= tab_nc (table)
474 || r + table->row_ofs >= tab_nr (table))
476 printf ("tab_text(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
478 c, table->col_ofs, c + table->col_ofs,
479 r, table->row_ofs, r + table->row_ofs,
480 tab_nc (table), tab_nr (table));
485 table->cc[c + r * table->cf] = text;
486 table->ct[c + r * table->cf] = opt;
489 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
492 tab_text (struct tab_table *table, int c, int r, unsigned opt,
495 do_tab_text (table, c, r, opt, pool_strdup (table->container, text));
498 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
499 FORMAT, which is formatted as if passed to printf. */
501 tab_text_format (struct tab_table *table, int c, int r, unsigned opt,
502 const char *format, ...)
506 va_start (args, format);
507 do_tab_text (table, c, r, opt,
508 pool_vasprintf (table->container, format, args));
513 do_tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
514 unsigned opt, char *text)
516 struct tab_joined_cell *j;
518 assert (x1 + table->col_ofs >= 0);
519 assert (y1 + table->row_ofs >= 0);
522 assert (y2 + table->row_ofs < tab_nr (table));
523 assert (x2 + table->col_ofs < tab_nc (table));
526 if (x1 + table->col_ofs < 0 || x1 + table->col_ofs >= tab_nc (table)
527 || y1 + table->row_ofs < 0 || y1 + table->row_ofs >= tab_nr (table)
528 || x2 < x1 || x2 + table->col_ofs >= tab_nc (table)
529 || y2 < y2 || y2 + table->row_ofs >= tab_nr (table))
531 printf ("tab_joint_text(): bad cell "
532 "(%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) in table size (%d,%d)\n",
533 x1, table->col_ofs, x1 + table->col_ofs,
534 y1, table->row_ofs, y1 + table->row_ofs,
535 x2, table->col_ofs, x2 + table->col_ofs,
536 y2, table->row_ofs, y2 + table->row_ofs,
537 tab_nc (table), tab_nr (table));
542 tab_box (table, -1, -1, TAL_0, TAL_0, x1, y1, x2, y2);
544 j = pool_alloc (table->container, sizeof *j);
545 j->d[TABLE_HORZ][0] = x1 + table->col_ofs;
546 j->d[TABLE_VERT][0] = y1 + table->row_ofs;
547 j->d[TABLE_HORZ][1] = ++x2 + table->col_ofs;
548 j->d[TABLE_VERT][1] = ++y2 + table->row_ofs;
554 void **cc = &table->cc[x1 + y1 * table->cf];
555 unsigned char *ct = &table->ct[x1 + y1 * table->cf];
556 const int ofs = table->cf - (x2 - x1);
560 for (y = y1; y < y2; y++)
564 for (x = x1; x < x2; x++)
576 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them with
577 options OPT to have text value TEXT. */
579 tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
580 unsigned opt, const char *text)
582 do_tab_joint_text (table, x1, y1, x2, y2, opt,
583 pool_strdup (table->container, text));
586 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them
587 with options OPT to have text value FORMAT, which is formatted
588 as if passed to printf. */
590 tab_joint_text_format (struct tab_table *table, int x1, int y1, int x2, int y2,
591 unsigned opt, const char *format, ...)
595 va_start (args, format);
596 do_tab_joint_text (table, x1, y1, x2, y2, opt,
597 pool_vasprintf (table->container, format, args));
602 tab_cell_is_empty (const struct tab_table *table, int c, int r)
604 return table->cc[c + r * table->cf] == NULL;
609 /* Set the title of table T to TITLE, which is formatted as if
610 passed to printf(). */
612 tab_title (struct tab_table *t, const char *title, ...)
617 va_start (args, title);
618 t->title = xvasprintf (title, args);
622 /* Easy, type-safe way to submit a tab table to som. */
624 tab_submit (struct tab_table *t)
626 table_item_submit (table_item_create (&t->table, t->title));
631 /* Set table row and column offsets for all functions that affect
634 tab_offset (struct tab_table *t, int col, int row)
640 if (row < -1 || row > tab_nr (t))
642 printf ("tab_offset(): row=%d in %d-row table\n", row, tab_nr (t));
645 if (col < -1 || col > tab_nc (t))
647 printf ("tab_offset(): col=%d in %d-column table\n", col, tab_nc (t));
653 diff += (row - t->row_ofs) * t->cf, t->row_ofs = row;
655 diff += (col - t->col_ofs), t->col_ofs = col;
661 /* Increment the row offset by one. If the table is too small,
662 increase its size. */
664 tab_next_row (struct tab_table *t)
669 if (++t->row_ofs >= tab_nr (t))
670 tab_realloc (t, -1, tab_nr (t) * 4 / 3);
673 /* Writes STRING to the output. OPTIONS may be any valid combination of TAB_*
676 This function is obsolete. Please do not add new uses of it. Instead, use
677 a text_item (see output/text-item.h). */
679 tab_output_text (int options, const char *string)
681 enum text_item_type type = (options & TAB_EMPH ? TEXT_ITEM_SUBHEAD
682 : options & TAB_FIX ? TEXT_ITEM_MONOSPACE
683 : TEXT_ITEM_PARAGRAPH);
684 text_item_submit (text_item_create (type, string));
687 /* Same as tab_output_text(), but FORMAT is passed through printf-like
688 formatting before output. */
690 tab_output_text_format (int options, const char *format, ...)
695 va_start (args, format);
696 text = xvasprintf (format, args);
699 tab_output_text (options, text);
704 /* Table class implementation. */
707 tab_destroy (struct table *table)
709 struct tab_table *t = tab_cast (table);
710 pool_destroy (t->container);
714 tab_get_cell (const struct table *table, int x, int y, struct table_cell *cell)
716 const struct tab_table *t = tab_cast (table);
717 int index = x + y * t->cf;
718 unsigned char opt = t->ct[index];
719 const void *content = t->cc[index];
724 const struct tab_joined_cell *jc = content;
725 cell->d[TABLE_HORZ][0] = jc->d[TABLE_HORZ][0];
726 cell->d[TABLE_HORZ][1] = jc->d[TABLE_HORZ][1];
727 cell->d[TABLE_VERT][0] = jc->d[TABLE_VERT][0];
728 cell->d[TABLE_VERT][1] = jc->d[TABLE_VERT][1];
729 cell->contents = jc->contents;
733 cell->d[TABLE_HORZ][0] = x;
734 cell->d[TABLE_HORZ][1] = x + 1;
735 cell->d[TABLE_VERT][0] = y;
736 cell->d[TABLE_VERT][1] = y + 1;
737 cell->contents = content != NULL ? content : "";
739 cell->destructor = NULL;
743 tab_get_rule (const struct table *table, enum table_axis axis, int x, int y)
745 const struct tab_table *t = tab_cast (table);
746 return (axis == TABLE_VERT
747 ? t->rh[x + t->cf * y]
748 : t->rv[x + (t->cf + 1) * y]);
751 static const struct table_class tab_table_class =
761 tab_cast (const struct table *table)
763 assert (table->class == &tab_table_class);
764 return UP_CAST (table, struct tab_table, table);