1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2011, 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/table.h"
20 #include "output/table-provider.h"
26 #include "data/format.h"
27 #include "libpspp/assertion.h"
28 #include "libpspp/cast.h"
29 #include "libpspp/compiler.h"
30 #include "libpspp/pool.h"
31 #include "libpspp/str.h"
32 #include "output/table-item.h"
33 #include "output/table.h"
34 #include "output/text-item.h"
36 #include "gl/xalloc.h"
38 /* Increases TABLE's reference count, indicating that it has an additional
39 owner. An table that is shared among multiple owners must not be
42 table_ref (const struct table *table_)
44 struct table *table = CONST_CAST (struct table *, table_);
49 /* Decreases TABLE's reference count, indicating that it has one fewer owner.
50 If TABLE no longer has any owners, it is freed. */
52 table_unref (struct table *table)
56 assert (table->ref_cnt > 0);
57 if (--table->ref_cnt == 0)
58 pool_destroy (table->container);
62 /* Returns true if TABLE has more than one owner. A table item that is shared
63 among multiple owners must not be modified. */
65 table_is_shared (const struct table *table)
67 return table->ref_cnt > 1;
70 struct table_area_style *
71 table_area_style_clone (struct pool *pool, const struct table_area_style *old)
73 struct table_area_style *new = pool_malloc (pool, sizeof *new);
75 if (new->font_style.typeface)
76 new->font_style.typeface = pool_strdup (pool, new->font_style.typeface);
81 table_area_style_free (struct table_area_style *style)
85 free (style->font_style.typeface);
91 table_cell_format_footnote_markers (const struct table_cell *cell,
94 for (size_t i = 0; i < cell->n_footnotes; i++)
98 ds_put_cstr (s, cell->footnotes[i]->marker);
102 static const struct footnote **
103 add_footnotes (const struct footnote **refs, size_t n_refs,
104 const struct footnote **footnotes, size_t *allocated, size_t *n)
106 for (size_t i = 0; i < n_refs; i++)
108 const struct footnote *f = refs[i];
109 if (f->idx >= *allocated)
111 size_t new_allocated = (f->idx + 1) * 2;
112 footnotes = xrealloc (footnotes, new_allocated * sizeof *footnotes);
113 while (*allocated < new_allocated)
114 footnotes[(*allocated)++] = NULL;
116 footnotes[f->idx] = f;
124 table_collect_footnotes (const struct table_item *item,
125 const struct footnote ***footnotesp)
127 const struct footnote **footnotes = NULL;
128 size_t allocated = 0;
131 struct table *t = item->table;
132 for (int y = 0; y < table_nr (t); y++)
134 struct table_cell cell;
135 for (int x = 0; x < table_nc (t); x = cell.d[TABLE_HORZ][1])
137 table_get_cell (t, x, y, &cell);
139 if (x == cell.d[TABLE_HORZ][0] && y == cell.d[TABLE_VERT][0])
140 footnotes = add_footnotes (cell.footnotes, cell.n_footnotes,
141 footnotes, &allocated, &n);
145 const struct table_item_text *title = table_item_get_title (item);
147 footnotes = add_footnotes (title->footnotes, title->n_footnotes,
148 footnotes, &allocated, &n);
150 const struct table_item_layers *layers = table_item_get_layers (item);
153 for (size_t i = 0; i < layers->n_layers; i++)
154 footnotes = add_footnotes (layers->layers[i].footnotes,
155 layers->layers[i].n_footnotes,
156 footnotes, &allocated, &n);
159 const struct table_item_text *caption = table_item_get_caption (item);
161 footnotes = add_footnotes (caption->footnotes, caption->n_footnotes,
162 footnotes, &allocated, &n);
164 size_t n_nonnull = 0;
165 for (size_t i = 0; i < n; i++)
167 footnotes[n_nonnull++] = footnotes[i];
169 *footnotesp = footnotes;
173 /* Returns a table that contains a single cell, whose contents are the
174 left-aligned TEXT. */
176 table_from_string (const char *text)
178 struct table *t = table_create (1, 1, 0, 0, 0, 0);
179 t->styles[0] = pool_alloc (t->container, sizeof *t->styles[0]);
180 *t->styles[0] = (struct table_area_style) {
181 TABLE_AREA_STYLE_INITIALIZER__,
182 .cell_style.halign = TABLE_HALIGN_LEFT,
183 .cell_style.valign = TABLE_VALIGN_TOP
185 table_text (t, 0, 0, 0 << TAB_STYLE_SHIFT, text);
190 table_halign_to_string (enum table_halign halign)
194 case TABLE_HALIGN_LEFT: return "left";
195 case TABLE_HALIGN_CENTER: return "center";
196 case TABLE_HALIGN_RIGHT: return "right";
197 case TABLE_HALIGN_DECIMAL: return "decimal";
198 case TABLE_HALIGN_MIXED: return "mixed";
199 default: return "**error**";
204 table_valign_to_string (enum table_valign valign)
208 case TABLE_VALIGN_TOP: return "top";
209 case TABLE_VALIGN_CENTER: return "center";
210 case TABLE_VALIGN_BOTTOM: return "bottom";
211 default: return "**error**";
216 table_halign_interpret (enum table_halign halign, bool numeric)
220 case TABLE_HALIGN_LEFT:
221 case TABLE_HALIGN_CENTER:
222 case TABLE_HALIGN_RIGHT:
225 case TABLE_HALIGN_MIXED:
226 return numeric ? TABLE_HALIGN_RIGHT : TABLE_HALIGN_LEFT;
228 case TABLE_HALIGN_DECIMAL:
229 return TABLE_HALIGN_DECIMAL;
237 font_style_copy (struct pool *container,
238 struct font_style *dst, const struct font_style *src)
242 dst->typeface = pool_strdup (container, dst->typeface);
246 font_style_uninit (struct font_style *font)
249 free (font->typeface);
253 table_area_style_copy (struct pool *container, struct table_area_style *dst,
254 const struct table_area_style *src)
256 font_style_copy (container, &dst->font_style, &src->font_style);
257 dst->cell_style = src->cell_style;
261 table_area_style_uninit (struct table_area_style *area)
264 font_style_uninit (&area->font_style);
268 table_stroke_to_string (enum table_stroke stroke)
272 case TABLE_STROKE_NONE: return "none";
273 case TABLE_STROKE_SOLID: return "solid";
274 case TABLE_STROKE_DASHED: return "dashed";
275 case TABLE_STROKE_THICK: return "thick";
276 case TABLE_STROKE_THIN: return "thin";
277 case TABLE_STROKE_DOUBLE: return "double";
284 cell_color_dump (const struct cell_color *c)
287 printf ("rgba(%d, %d, %d, %d)", c->r, c->g, c->b, c->alpha);
289 printf ("#%02"PRIx8"%02"PRIx8"%02"PRIx8, c->r, c->g, c->b);
293 font_style_dump (const struct font_style *f)
295 printf ("%s %dpx ", f->typeface, f->size);
296 cell_color_dump (&f->fg[0]);
298 cell_color_dump (&f->bg[0]);
299 if (!cell_color_equal (&f->fg[0], &f->fg[1])
300 || !cell_color_equal (&f->bg[0], &f->bg[1]))
303 cell_color_dump (&f->fg[1]);
305 cell_color_dump (&f->bg[1]);
308 fputs (" bold", stdout);
310 fputs (" italic", stdout);
312 fputs (" underline", stdout);
316 cell_style_dump (const struct cell_style *c)
318 fputs (table_halign_to_string (c->halign), stdout);
319 if (c->halign == TABLE_HALIGN_DECIMAL)
320 printf ("(%.2gpx)", c->decimal_offset);
321 printf (" %s", table_valign_to_string (c->valign));
322 printf (" %d,%d,%d,%dpx",
323 c->margin[TABLE_HORZ][0], c->margin[TABLE_HORZ][1],
324 c->margin[TABLE_VERT][0], c->margin[TABLE_VERT][1]);
328 static const bool debugging = true;
330 /* Creates and returns a new table with NC columns and NR rows and initially no
331 header rows or columns.
333 Sets the number of header rows on each side of TABLE to HL on the
334 left, HR on the right, HT on the top, HB on the bottom. Header rows
335 are repeated when a table is broken across multiple columns or
338 The table's cells are initially empty. */
340 table_create (int nc, int nr, int hl, int hr, int ht, int hb)
344 t = pool_create_container (struct table, container);
345 t->n[TABLE_HORZ] = nc;
346 t->n[TABLE_VERT] = nr;
347 t->h[TABLE_HORZ][0] = hl;
348 t->h[TABLE_HORZ][1] = hr;
349 t->h[TABLE_VERT][0] = ht;
350 t->h[TABLE_VERT][1] = hb;
353 t->cc = pool_calloc (t->container, nr * nc, sizeof *t->cc);
354 t->ct = pool_calloc (t->container, nr * nc, sizeof *t->ct);
356 t->rh = pool_nmalloc (t->container, nc, nr + 1);
357 memset (t->rh, TABLE_STROKE_NONE, nc * (nr + 1));
359 t->rv = pool_nmalloc (t->container, nr, nc + 1);
360 memset (t->rv, TABLE_STROKE_NONE, nr * (nc + 1));
362 memset (t->styles, 0, sizeof t->styles);
363 memset (t->rule_colors, 0, sizeof t->rule_colors);
370 /* Draws a vertical line to the left of cells at horizontal position X
371 from Y1 to Y2 inclusive in style STYLE, if style is not -1. */
373 table_vline (struct table *t, int style, int x, int y1, int y2)
377 if (x < 0 || x > table_nc (t)
378 || y1 < 0 || y1 >= table_nr (t)
379 || y2 < 0 || y2 >= table_nr (t))
381 printf ("bad vline: x=%d y=(%d,%d) in table size (%d,%d)\n",
382 x, y1, y2, table_nc (t), table_nr (t));
388 assert (x <= table_nc (t));
391 assert (y2 <= table_nr (t));
396 for (y = y1; y <= y2; y++)
397 t->rv[x + (table_nc (t) + 1) * y] = style;
401 /* Draws a horizontal line above cells at vertical position Y from X1
402 to X2 inclusive in style STYLE, if style is not -1. */
404 table_hline (struct table *t, int style, int x1, int x2, int y)
408 if (y < 0 || y > table_nr (t)
409 || x1 < 0 || x1 >= table_nc (t)
410 || x2 < 0 || x2 >= table_nc (t))
412 printf ("bad hline: x=(%d,%d) y=%d in table size (%d,%d)\n",
413 x1, x2, y, table_nc (t), table_nr (t));
419 assert (y <= table_nr (t));
422 assert (x2 < table_nc (t));
427 for (x = x1; x <= x2; x++)
428 t->rh[x + table_nc (t) * y] = style;
432 /* Draws a box around cells (X1,Y1)-(X2,Y2) inclusive with horizontal
433 lines of style F_H and vertical lines of style F_V. Fills the
434 interior of the box with horizontal lines of style I_H and vertical
435 lines of style I_V. Any of the line styles may be -1 to avoid
436 drawing those lines. This is distinct from 0, which draws a null
439 table_box (struct table *t, int f_h, int f_v, int i_h, int i_v,
440 int x1, int y1, int x2, int y2)
444 if (x1 < 0 || x1 >= table_nc (t)
445 || x2 < 0 || x2 >= table_nc (t)
446 || y1 < 0 || y1 >= table_nr (t)
447 || y2 < 0 || y2 >= table_nr (t))
449 printf ("bad box: (%d,%d)-(%d,%d) in table size (%d,%d)\n",
450 x1, y1, x2, y2, table_nc (t), table_nr (t));
459 assert (x2 < table_nc (t));
460 assert (y2 < table_nr (t));
465 for (x = x1; x <= x2; x++)
467 t->rh[x + table_nc (t) * y1] = f_h;
468 t->rh[x + table_nc (t) * (y2 + 1)] = f_h;
474 for (y = y1; y <= y2; y++)
476 t->rv[x1 + (table_nc (t) + 1) * y] = f_v;
477 t->rv[(x2 + 1) + (table_nc (t) + 1) * y] = f_v;
485 for (y = y1 + 1; y <= y2; y++)
489 for (x = x1; x <= x2; x++)
490 t->rh[x + table_nc (t) * y] = i_h;
497 for (x = x1 + 1; x <= x2; x++)
501 for (y = y1; y <= y2; y++)
502 t->rv[x + (table_nc (t) + 1) * y] = i_v;
510 do_table_text (struct table *table, int c, int r, unsigned opt, char *text)
514 assert (c < table_nc (table));
515 assert (r < table_nr (table));
519 if (c < 0 || r < 0 || c >= table_nc (table) || r >= table_nr (table))
521 printf ("table_text(): bad cell (%d,%d) in table size (%d,%d)\n",
522 c, r, table_nc (table), table_nr (table));
527 table->cc[c + r * table_nc (table)] = text;
528 table->ct[c + r * table_nc (table)] = opt;
531 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
534 table_text (struct table *table, int c, int r, unsigned opt,
537 do_table_text (table, c, r, opt, pool_strdup (table->container, text));
540 /* Sets cell (C,R) in TABLE, with options OPT, to have text value
541 FORMAT, which is formatted as if passed to printf. */
543 table_text_format (struct table *table, int c, int r, unsigned opt,
544 const char *format, ...)
548 va_start (args, format);
549 do_table_text (table, c, r, opt,
550 pool_vasprintf (table->container, format, args));
554 static struct table_cell *
555 add_joined_cell (struct table *table, int x1, int y1, int x2, int y2,
562 assert (y2 < table_nr (table));
563 assert (x2 < table_nc (table));
567 if (x1 < 0 || x1 >= table_nc (table)
568 || y1 < 0 || y1 >= table_nr (table)
569 || x2 < x1 || x2 >= table_nc (table)
570 || y2 < y1 || y2 >= table_nr (table))
572 printf ("table_joint_text(): bad cell "
573 "(%d,%d)-(%d,%d) in table size (%d,%d)\n",
574 x1, y1, x2, y2, table_nc (table), table_nr (table));
579 table_box (table, -1, -1, TABLE_STROKE_NONE, TABLE_STROKE_NONE,
582 struct table_cell *cell = pool_alloc (table->container, sizeof *cell);
583 *cell = (struct table_cell) {
584 .d = { [TABLE_HORZ] = { x1, ++x2 },
585 [TABLE_VERT] = { y1, ++y2 } },
589 void **cc = &table->cc[x1 + y1 * table_nc (table)];
590 unsigned short *ct = &table->ct[x1 + y1 * table_nc (table)];
591 const int ofs = table_nc (table) - (x2 - x1);
592 for (int y = y1; y < y2; y++)
594 for (int x = x1; x < x2; x++)
597 *ct++ = opt | TAB_JOIN;
607 /* Joins cells (X1,X2)-(Y1,Y2) inclusive in TABLE, and sets them with
608 options OPT to have text value TEXT. */
610 table_joint_text (struct table *table, int x1, int y1, int x2, int y2,
611 unsigned opt, const char *text)
613 char *s = pool_strdup (table->container, text);
614 if (x1 == x2 && y1 == y2)
615 do_table_text (table, x1, y1, opt, s);
617 add_joined_cell (table, x1, y1, x2, y2, opt)->text = s;
620 static struct table_cell *
621 get_joined_cell (struct table *table, int x, int y)
623 int index = x + y * table_nc (table);
624 unsigned short opt = table->ct[index];
625 struct table_cell *cell;
628 cell = table->cc[index];
631 char *text = table->cc[index];
633 cell = add_joined_cell (table, x, y, x, y, table->ct[index]);
634 cell->text = text ? text : pool_strdup (table->container, "");
639 /* Sets the subscripts for column X, row Y in TABLE. */
641 table_add_subscripts (struct table *table, int x, int y,
642 char **subscripts, size_t n_subscripts)
644 struct table_cell *cell = get_joined_cell (table, x, y);
646 cell->n_subscripts = n_subscripts;
647 cell->subscripts = pool_nalloc (table->container, n_subscripts,
648 sizeof *cell->subscripts);
649 for (size_t i = 0; i < n_subscripts; i++)
650 cell->subscripts[i] = pool_strdup (table->container, subscripts[i]);
653 /* Sets the superscript for column X, row Y in TABLE. */
655 table_add_superscript (struct table *table, int x, int y,
656 const char *superscript)
658 get_joined_cell (table, x, y)->superscript
659 = pool_strdup (table->container, superscript);
662 /* Create a footnote in TABLE with MARKER (e.g. "a") as its marker and CONTENT
663 as its content. The footnote will be styled as STYLE, which is mandatory.
664 IDX must uniquely identify the footnote within TABLE.
666 Returns the new footnote. The return value is the only way to get to the
667 footnote later, so it is important for the caller to remember it. */
669 table_create_footnote (struct table *table, size_t idx, const char *content,
670 const char *marker, struct table_area_style *style)
674 struct footnote *f = pool_alloc (table->container, sizeof *f);
676 f->content = pool_strdup (table->container, content);
677 f->marker = pool_strdup (table->container, marker);
682 /* Attaches a reference to footnote F to the cell at column X, row Y in
685 table_add_footnote (struct table *table, int x, int y,
686 const struct footnote *f)
690 struct table_cell *cell = get_joined_cell (table, x, y);
692 cell->footnotes = pool_realloc (
693 table->container, cell->footnotes,
694 (cell->n_footnotes + 1) * sizeof *cell->footnotes);
696 cell->footnotes[cell->n_footnotes++] = f;
699 /* Overrides the style for column X, row Y in TABLE with STYLE.
700 Does not make a copy of STYLE, so it should either be allocated from
701 TABLE->container or have a lifetime that will outlive TABLE. */
703 table_add_style (struct table *table, int x, int y,
704 const struct table_area_style *style)
706 get_joined_cell (table, x, y)->style = style;
709 /* Returns true if column C, row R has no contents, otherwise false. */
711 table_cell_is_empty (const struct table *table, int c, int r)
713 return table->cc[c + r * table_nc (table)] == NULL;
718 /* Writes STRING to the output. OPTIONS may be any valid combination of TAB_*
721 This function is obsolete. Please do not add new uses of it. Instead, use
722 a text_item (see output/text-item.h). */
724 table_output_text (int options UNUSED, const char *string)
726 text_item_submit (text_item_create (TEXT_ITEM_LOG, string));
729 /* Same as table_output_text(), but FORMAT is passed through printf-like
730 formatting before output. */
732 table_output_text_format (int options, const char *format, ...)
737 va_start (args, format);
738 text = xvasprintf (format, args);
741 table_output_text (options, text);
746 /* Initializes CELL with the contents of the table cell at column X and row Y
747 within TABLE. When CELL is no longer needed, the caller is responsible for
748 freeing it by calling table_cell_free(CELL).
750 The caller must ensure that CELL is destroyed before TABLE is unref'ed. */
752 table_get_cell (const struct table *t, int x, int y, struct table_cell *cell)
754 assert (x >= 0 && x < t->n[TABLE_HORZ]);
755 assert (y >= 0 && y < t->n[TABLE_VERT]);
757 int index = x + y * table_nc (t);
758 unsigned short opt = t->ct[index];
759 const void *cc = t->cc[index];
761 const struct table_area_style *style
762 = t->styles[(opt & TAB_STYLE_MASK) >> TAB_STYLE_SHIFT];
765 const struct table_cell *jc = cc;
771 *cell = (struct table_cell) {
772 .d = { [TABLE_HORZ] = { x, x + 1 },
773 [TABLE_VERT] = { y, y + 1 } },
775 .text = CONST_CAST (char *, cc ? cc : ""),
779 assert (cell->style);
782 /* Returns one of the TAL_* enumeration constants (declared in output/table.h)
783 representing a rule running alongside one of the cells in TABLE.
785 Suppose NC is the number of columns in TABLE and NR is the number of rows.
786 Then, if AXIS is TABLE_HORZ, then 0 <= X <= NC and 0 <= Y < NR. If (X,Y) =
787 (0,0), the return value is the rule that runs vertically on the left side of
788 cell (0,0); if (X,Y) = (1,0), it is the vertical rule between that cell and
789 cell (1,0); and so on, up to (NC,0), which runs vertically on the right of
792 The following diagram illustrates the meaning of (X,Y) for AXIS = TABLE_HORZ
793 within a 7x7 table. The '|' characters at the intersection of the X labels
794 and Y labels show the rule whose style would be returned by calling
795 table_get_rule with those X and Y values:
798 +--+--+--+--+--+--+--+
800 +--+--+--+--+--+--+--+
802 +--+--+--+--+--+--+--+
804 +--+--+--+--+--+--+--+
806 +--+--+--+--+--+--+--+
808 +--+--+--+--+--+--+--+
810 +--+--+--+--+--+--+--+
812 +--+--+--+--+--+--+--+
814 Similarly, if AXIS is TABLE_VERT, then 0 <= X < NC and 0 <= Y <= NR. If
815 (X,Y) = (0,0), the return value is the rule that runs horizontally above
816 the top of cell (0,0); if (X,Y) = (0,1), it is the horizontal rule
817 between that cell and cell (0,1); and so on, up to (0,NR), which runs
818 horizontally below cell (0,NR-1). */
820 table_get_rule (const struct table *table, enum table_axis axis, int x, int y,
821 struct cell_color *color)
823 assert (x >= 0 && x < table->n[TABLE_HORZ] + (axis == TABLE_HORZ));
824 assert (y >= 0 && y < table->n[TABLE_VERT] + (axis == TABLE_VERT));
826 uint8_t raw = (axis == TABLE_VERT
827 ? table->rh[x + table_nc (table) * y]
828 : table->rv[x + (table_nc (table) + 1) * y]);
829 struct cell_color *p = table->rule_colors[(raw & TAB_RULE_STYLE_MASK)
830 >> TAB_RULE_STYLE_SHIFT];
831 *color = p ? *p : (struct cell_color) CELL_COLOR_BLACK;
832 return (raw & TAB_RULE_TYPE_MASK) >> TAB_RULE_TYPE_SHIFT;