1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010 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)
99 assert (nc + t->col_ofs <= t->cf);
100 table_set_nc (&t->table, nc + t->col_ofs);
104 assert (nr + t->row_ofs <= tab_nr (t));
105 table_set_nr (&t->table, nr + t->row_ofs);
109 /* Changes either or both dimensions of a table and reallocates memory as
112 This function is obsolete. Please do not add new uses of it. (Instead, use
113 table_paste() or one of its helper functions to paste multiple tables
114 together into a larger one.) */
116 tab_realloc (struct tab_table *t, int nc, int nr)
123 tab_offset (t, 0, 0);
130 assert (nc == tab_nc (t));
134 int mr1 = MIN (nr, tab_nr (t));
135 int mc1 = MIN (nc, tab_nc (t));
138 unsigned char *new_ct;
141 new_cc = pool_calloc (t->container, nr * nc, sizeof *new_cc);
142 new_ct = pool_malloc (t->container, nr * nc);
143 for (r = 0; r < mr1; r++)
145 memcpy (&new_cc[r * nc], &t->cc[r * tab_nc (t)], mc1 * sizeof *t->cc);
146 memcpy (&new_ct[r * nc], &t->ct[r * tab_nc (t)], mc1);
147 memset (&new_ct[r * nc + tab_nc (t)], 0, nc - tab_nc (t));
149 pool_free (t->container, t->cc);
150 pool_free (t->container, t->ct);
155 else if (nr != tab_nr (t))
157 t->cc = pool_nrealloc (t->container, t->cc, nr * nc, sizeof *t->cc);
158 t->ct = pool_realloc (t->container, t->ct, nr * nc);
160 t->rh = pool_nrealloc (t->container, t->rh, nc, nr + 1);
161 t->rv = pool_nrealloc (t->container, t->rv, nr, nc + 1);
165 memset (&t->rh[nc * (tab_nr (t) + 1)], TAL_0, (nr - tab_nr (t)) * nc);
166 memset (&t->rv[(nc + 1) * tab_nr (t)], TAL_GAP,
167 (nr - tab_nr (t)) * (nc + 1));
171 memset (&t->ct[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)));
172 memset (&t->cc[nc * tab_nr (t)], 0, nc * (nr - tab_nr (t)) * sizeof *t->cc);
174 table_set_nr (&t->table, nr);
175 table_set_nc (&t->table, nc);
178 tab_offset (t, co, ro);
181 /* Sets the number of header rows on each side of TABLE to L on the
182 left, R on the right, T on the top, B on the bottom. Header rows
183 are repeated when a table is broken across multiple columns or
186 tab_headers (struct tab_table *table, int l, int r, int t, int b)
188 table_set_hl (&table->table, l);
189 table_set_hr (&table->table, r);
190 table_set_ht (&table->table, t);
191 table_set_hb (&table->table, b);
196 /* Draws a vertical line to the left of cells at horizontal position X
197 from Y1 to Y2 inclusive in style STYLE, if style is not -1. */
199 tab_vline (struct tab_table *t, int style, int x, int y1, int y2)
202 if (x + t->col_ofs < 0 || x + t->col_ofs > tab_nc (t)
203 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
204 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
206 printf (_("bad vline: x=%d+%d=%d y=(%d+%d=%d,%d+%d=%d) in "
207 "table size (%d,%d)\n"),
208 x, t->col_ofs, x + t->col_ofs,
209 y1, t->row_ofs, y1 + t->row_ofs,
210 y2, t->row_ofs, y2 + t->row_ofs,
211 tab_nc (t), tab_nr (t));
221 assert (x <= tab_nc (t));
224 assert (y2 <= tab_nr (t));
229 for (y = y1; y <= y2; y++)
230 t->rv[x + (t->cf + 1) * y] = style;
234 /* Draws a horizontal line above cells at vertical position Y from X1
235 to X2 inclusive in style STYLE, if style is not -1. */
237 tab_hline (struct tab_table * t, int style, int x1, int x2, int y)
240 if (y + t->row_ofs < 0 || y + t->row_ofs > tab_nr (t)
241 || x1 + t->col_ofs < 0 || x1 + t->col_ofs >= tab_nc (t)
242 || x2 + t->col_ofs < 0 || x2 + t->col_ofs >= tab_nc (t))
244 printf (_("bad hline: x=(%d+%d=%d,%d+%d=%d) y=%d+%d=%d in "
245 "table size (%d,%d)\n"),
246 x1, t->col_ofs, x1 + t->col_ofs,
247 x2, t->col_ofs, x2 + t->col_ofs,
248 y, t->row_ofs, y + t->row_ofs,
249 tab_nc (t), tab_nr (t));
259 assert (y <= tab_nr (t));
262 assert (x2 < tab_nc (t));
267 for (x = x1; x <= x2; x++)
268 t->rh[x + t->cf * y] = style;
272 /* Draws a box around cells (X1,Y1)-(X2,Y2) inclusive with horizontal
273 lines of style F_H and vertical lines of style F_V. Fills the
274 interior of the box with horizontal lines of style I_H and vertical
275 lines of style I_V. Any of the line styles may be -1 to avoid
276 drawing those lines. This is distinct from 0, which draws a null
279 tab_box (struct tab_table *t, int f_h, int f_v, int i_h, int i_v,
280 int x1, int y1, int x2, int y2)
283 if (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)
285 || y1 + t->row_ofs < 0 || y1 + t->row_ofs >= tab_nr (t)
286 || y2 + t->row_ofs < 0 || y2 + t->row_ofs >= tab_nr (t))
288 printf (_("bad box: (%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) "
289 "in table size (%d,%d)\n"),
290 x1, t->col_ofs, x1 + t->col_ofs,
291 y1, t->row_ofs, y1 + t->row_ofs,
292 x2, t->col_ofs, x2 + t->col_ofs,
293 y2, t->row_ofs, y2 + t->row_ofs,
294 tab_nc (t), tab_nr (t));
308 assert (x2 < tab_nc (t));
309 assert (y2 < tab_nr (t));
314 for (x = x1; x <= x2; x++)
316 t->rh[x + t->cf * y1] = f_h;
317 t->rh[x + t->cf * (y2 + 1)] = f_h;
323 for (y = y1; y <= y2; y++)
325 t->rv[x1 + (t->cf + 1) * y] = f_v;
326 t->rv[(x2 + 1) + (t->cf + 1) * y] = f_v;
334 for (y = y1 + 1; y <= y2; y++)
338 for (x = x1; x <= x2; x++)
339 t->rh[x + t->cf * y] = i_h;
346 for (x = x1 + 1; x <= x2; x++)
350 for (y = y1; y <= y2; y++)
351 t->rv[x + (t->cf + 1) * y] = i_v;
358 /* Sets cell (C,R) in TABLE, with options OPT, to have a value taken
359 from V, displayed with format spec F. */
361 tab_value (struct tab_table *table, int c, int r, unsigned char opt,
362 const union value *v, const struct dictionary *dict,
363 const struct fmt_spec *f)
368 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
369 || c + table->col_ofs >= tab_nc (table)
370 || r + table->row_ofs >= tab_nr (table))
372 printf ("tab_value(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
374 c, table->col_ofs, c + table->col_ofs,
375 r, table->row_ofs, r + table->row_ofs,
376 tab_nc (table), tab_nr (table));
381 contents = data_out_pool (v, dict_get_encoding (dict), f, table->container);
383 table->cc[c + r * table->cf] = contents;
384 table->ct[c + r * table->cf] = opt;
387 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL
388 with NDEC decimal places. */
390 tab_fixed (struct tab_table *table, int c, int r, unsigned char opt,
391 double val, int w, int d)
394 union value double_value;
398 assert (c < tab_nc (table));
400 assert (r < tab_nr (table));
402 f = fmt_for_output (FMT_F, w, d);
405 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
406 || c + table->col_ofs >= tab_nc (table)
407 || r + table->row_ofs >= tab_nr (table))
409 printf ("tab_fixed(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
411 c, table->col_ofs, c + table->col_ofs,
412 r, table->row_ofs, r + table->row_ofs,
413 tab_nc (table), tab_nr (table));
418 double_value.f = val;
419 s = data_out_pool (&double_value, LEGACY_NATIVE, &f, table->container);
421 table->cc[c + r * table->cf] = s + strspn (s, " ");
422 table->ct[c + r * table->cf] = opt;
425 /* Sets cell (C,R) in TABLE, with options OPT, to have value VAL as
427 If FMT is null, then the default print format will be used.
430 tab_double (struct tab_table *table, int c, int r, unsigned char opt,
431 double val, const struct fmt_spec *fmt)
433 union value double_value ;
437 assert (c < tab_nc (table));
439 assert (r < tab_nr (table));
442 fmt = settings_get_format ();
444 fmt_check_output (fmt);
447 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
448 || c + table->col_ofs >= tab_nc (table)
449 || r + table->row_ofs >= tab_nr (table))
451 printf ("tab_double(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
453 c, table->col_ofs, c + table->col_ofs,
454 r, table->row_ofs, r + table->row_ofs,
455 tab_nc (table), tab_nr (table));
460 double_value.f = val;
461 s = data_out_pool (&double_value, LEGACY_NATIVE, fmt, table->container);
462 table->cc[c + r * table->cf] = s + strspn (s, " ");
463 table->ct[c + r * table->cf] = opt;
468 do_tab_text (struct tab_table *table, int c, int r, unsigned opt, char *text)
472 assert (c < tab_nc (table));
473 assert (r < tab_nr (table));
476 if (c + table->col_ofs < 0 || r + table->row_ofs < 0
477 || c + table->col_ofs >= tab_nc (table)
478 || r + table->row_ofs >= tab_nr (table))
480 printf ("tab_text(): bad cell (%d+%d=%d,%d+%d=%d) in table size "
482 c, table->col_ofs, c + table->col_ofs,
483 r, table->row_ofs, r + table->row_ofs,
484 tab_nc (table), tab_nr (table));
489 table->cc[c + r * table->cf] = text;
490 table->ct[c + r * table->cf] = opt;
493 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
496 tab_text (struct tab_table *table, int c, int r, unsigned opt,
499 do_tab_text (table, c, r, opt, pool_strdup (table->container, text));
502 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
503 FORMAT, which is formatted as if passed to printf. */
505 tab_text_format (struct tab_table *table, int c, int r, unsigned opt,
506 const char *format, ...)
510 va_start (args, format);
511 do_tab_text (table, c, r, opt,
512 pool_vasprintf (table->container, format, args));
517 do_tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
518 unsigned opt, char *text)
520 struct tab_joined_cell *j;
522 assert (x1 + table->col_ofs >= 0);
523 assert (y1 + table->row_ofs >= 0);
526 assert (y2 + table->row_ofs < tab_nr (table));
527 assert (x2 + table->col_ofs < tab_nc (table));
530 if (x1 + table->col_ofs < 0 || x1 + table->col_ofs >= tab_nc (table)
531 || y1 + table->row_ofs < 0 || y1 + table->row_ofs >= tab_nr (table)
532 || x2 < x1 || x2 + table->col_ofs >= tab_nc (table)
533 || y2 < y2 || y2 + table->row_ofs >= tab_nr (table))
535 printf ("tab_joint_text(): bad cell "
536 "(%d+%d=%d,%d+%d=%d)-(%d+%d=%d,%d+%d=%d) in table size (%d,%d)\n",
537 x1, table->col_ofs, x1 + table->col_ofs,
538 y1, table->row_ofs, y1 + table->row_ofs,
539 x2, table->col_ofs, x2 + table->col_ofs,
540 y2, table->row_ofs, y2 + table->row_ofs,
541 tab_nc (table), tab_nr (table));
546 tab_box (table, -1, -1, TAL_0, TAL_0, x1, y1, x2, y2);
548 j = pool_alloc (table->container, sizeof *j);
549 j->d[TABLE_HORZ][0] = x1 + table->col_ofs;
550 j->d[TABLE_VERT][0] = y1 + table->row_ofs;
551 j->d[TABLE_HORZ][1] = ++x2 + table->col_ofs;
552 j->d[TABLE_VERT][1] = ++y2 + table->row_ofs;
558 void **cc = &table->cc[x1 + y1 * table->cf];
559 unsigned char *ct = &table->ct[x1 + y1 * table->cf];
560 const int ofs = table->cf - (x2 - x1);
564 for (y = y1; y < y2; y++)
568 for (x = x1; x < x2; x++)
580 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them with
581 options OPT to have text value TEXT. */
583 tab_joint_text (struct tab_table *table, int x1, int y1, int x2, int y2,
584 unsigned opt, const char *text)
586 do_tab_joint_text (table, x1, y1, x2, y2, opt,
587 pool_strdup (table->container, text));
590 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them
591 with options OPT to have text value FORMAT, which is formatted
592 as if passed to printf. */
594 tab_joint_text_format (struct tab_table *table, int x1, int y1, int x2, int y2,
595 unsigned opt, const char *format, ...)
599 va_start (args, format);
600 do_tab_joint_text (table, x1, y1, x2, y2, opt,
601 pool_vasprintf (table->container, format, args));
606 tab_cell_is_empty (const struct tab_table *table, int c, int r)
608 return table->cc[c + r * table->cf] == NULL;
613 /* Set the title of table T to TITLE, which is formatted as if
614 passed to printf(). */
616 tab_title (struct tab_table *t, const char *title, ...)
621 va_start (args, title);
622 t->title = xvasprintf (title, args);
626 /* Easy, type-safe way to submit a tab table to som. */
628 tab_submit (struct tab_table *t)
630 table_item_submit (table_item_create (&t->table, t->title));
635 /* Set table row and column offsets for all functions that affect
638 tab_offset (struct tab_table *t, int col, int row)
643 if (row < -1 || row > tab_nr (t))
645 printf ("tab_offset(): row=%d in %d-row table\n", row, tab_nr (t));
648 if (col < -1 || col > tab_nc (t))
650 printf ("tab_offset(): col=%d in %d-column table\n", col, tab_nc (t));
656 diff += (row - t->row_ofs) * t->cf, t->row_ofs = row;
658 diff += (col - t->col_ofs), t->col_ofs = col;
664 /* Increment the row offset by one. If the table is too small,
665 increase its size. */
667 tab_next_row (struct tab_table *t)
671 if (++t->row_ofs >= tab_nr (t))
672 tab_realloc (t, -1, tab_nr (t) * 4 / 3);
675 /* Writes STRING to the output. OPTIONS may be any valid combination of TAB_*
678 This function is obsolete. Please do not add new uses of it. Instead, use
679 a text_item (see output/text-item.h). */
681 tab_output_text (int options, const char *string)
683 enum text_item_type type = (options & TAB_EMPH ? TEXT_ITEM_SUBHEAD
684 : options & TAB_FIX ? TEXT_ITEM_MONOSPACE
685 : TEXT_ITEM_PARAGRAPH);
686 text_item_submit (text_item_create (type, string));
689 /* Same as tab_output_text(), but FORMAT is passed through printf-like
690 formatting before output. */
692 tab_output_text_format (int options, const char *format, ...)
697 va_start (args, format);
698 text = xvasprintf (format, args);
701 tab_output_text (options, text);
706 /* Table class implementation. */
709 tab_destroy (struct table *table)
711 struct tab_table *t = tab_cast (table);
712 pool_destroy (t->container);
716 tab_get_cell (const struct table *table, int x, int y, struct table_cell *cell)
718 const struct tab_table *t = tab_cast (table);
719 int index = x + y * t->cf;
720 unsigned char opt = t->ct[index];
721 const void *content = t->cc[index];
726 const struct tab_joined_cell *jc = content;
727 cell->d[TABLE_HORZ][0] = jc->d[TABLE_HORZ][0];
728 cell->d[TABLE_HORZ][1] = jc->d[TABLE_HORZ][1];
729 cell->d[TABLE_VERT][0] = jc->d[TABLE_VERT][0];
730 cell->d[TABLE_VERT][1] = jc->d[TABLE_VERT][1];
731 cell->contents = jc->contents;
735 cell->d[TABLE_HORZ][0] = x;
736 cell->d[TABLE_HORZ][1] = x + 1;
737 cell->d[TABLE_VERT][0] = y;
738 cell->d[TABLE_VERT][1] = y + 1;
739 cell->contents = content != NULL ? content : "";
741 cell->destructor = NULL;
745 tab_get_rule (const struct table *table, enum table_axis axis, int x, int y)
747 const struct tab_table *t = tab_cast (table);
748 return (axis == TABLE_VERT
749 ? t->rh[x + t->cf * y]
750 : t->rv[x + (t->cf + 1) * y]);
753 static const struct table_class tab_table_class =
763 tab_cast (const struct table *table)
765 assert (table->class == &tab_table_class);
766 return UP_CAST (table, struct tab_table, table);