1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2018 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/>. */
21 #include "output/pivot-table.h"
23 #include "data/settings.h"
24 #include "libpspp/assertion.h"
25 #include "libpspp/pool.h"
26 #include "output/table.h"
27 #include "output/page-eject-item.h"
28 #include "output/table-item.h"
29 #include "output/text-item.h"
30 #include "output/table-provider.h"
32 #include "gl/minmax.h"
33 #include "gl/xalloc.h"
38 static const struct pivot_category *
39 find_category (const struct pivot_dimension *d, int dim_index,
40 const size_t *indexes, int row_ofs)
42 size_t index = indexes[dim_index];
43 assert (index < d->n_leaves);
44 for (const struct pivot_category *c = d->presentation_leaves[index];
50 row_ofs -= 1 + c->extra_depth;
57 static struct table_area_style *
58 table_area_style_override (struct pool *pool,
59 const struct table_area_style *in,
60 const struct cell_style *cell_,
61 const struct font_style *font_,
64 const struct cell_style *cell = cell_ ? cell_ : &in->cell_style;
65 const struct font_style *font = font_ ? font_ : &in->font_style;
67 struct table_area_style *out = (pool
68 ? pool_alloc (pool, sizeof *out)
69 : xmalloc (sizeof *out));
70 *out = (struct table_area_style) {
71 .cell_style.halign = rotate_label ? TABLE_HALIGN_CENTER : cell->halign,
72 .cell_style.valign = rotate_label ? TABLE_VALIGN_CENTER : cell->valign,
73 .cell_style.decimal_offset = cell->decimal_offset,
74 .cell_style.margin[H][0] = cell->margin[H][0],
75 .cell_style.margin[H][1] = cell->margin[H][1],
76 .cell_style.margin[V][0] = cell->margin[V][0],
77 .cell_style.margin[V][1] = cell->margin[V][1],
78 .font_style.fg[0] = font->fg[0],
79 .font_style.fg[1] = font->fg[1],
80 .font_style.bg[0] = font->bg[0],
81 .font_style.bg[1] = font->bg[1],
82 .font_style.typeface = (font->typeface
83 ? pool_strdup (pool, font->typeface)
85 .font_style.size = font->size,
86 .font_style.bold = font->bold,
87 .font_style.italic = font->italic,
88 .font_style.underline = font->underline,
89 .font_style.markup = font->markup,
95 fill_cell (struct table *t, int x1, int y1, int x2, int y2,
96 const struct table_area_style *style, int style_idx,
97 const struct pivot_value *value, struct footnote **footnotes,
98 enum settings_value_show show_values,
99 enum settings_value_show show_variables,
103 struct string s = DS_EMPTY_INITIALIZER;
104 int opts = style_idx << TAB_STYLE_SHIFT;
107 bool numeric = pivot_value_format_body (value, show_values,
111 if (value->font_style && value->font_style->markup)
116 table_joint_text (t, x1, y1, x2, y2, opts, ds_cstr (&s));
121 if (value->cell_style || value->font_style || rotate_label)
122 table_add_style (t, x1, y1,
123 table_area_style_override (t->container, style,
128 for (size_t i = 0; i < value->n_footnotes; i++)
130 struct footnote *f = footnotes[value->footnotes[i]->idx];
132 table_add_footnote (t, x1, y1, f);
135 if (value->n_subscripts)
136 table_add_subscripts (t, x1, y1,
137 value->subscripts, value->n_subscripts);
141 static struct table_item_text *
142 pivot_value_to_table_item_text (const struct pivot_value *value,
143 const struct table_area_style *area,
144 struct footnote **footnotes,
145 enum settings_value_show show_values,
146 enum settings_value_show show_variables)
151 struct string s = DS_EMPTY_INITIALIZER;
152 pivot_value_format_body (value, show_values, show_variables, &s);
154 struct table_item_text *text = xmalloc (sizeof *text);
155 *text = (struct table_item_text) {
156 .content = ds_steal_cstr (&s),
157 .footnotes = xnmalloc (value->n_footnotes, sizeof *text->footnotes),
158 .style = table_area_style_override (
159 NULL, area, value->cell_style, value->font_style, false),
162 for (size_t i = 0; i < value->n_footnotes; i++)
164 struct footnote *f = footnotes[value->footnotes[i]->idx];
166 text->footnotes[text->n_footnotes++] = f;
173 get_table_rule (const struct table_border_style *styles,
174 enum pivot_border style_idx)
176 return styles[style_idx].stroke | (style_idx << TAB_RULE_STYLE_SHIFT);
180 draw_line (struct table *t, const struct table_border_style *styles,
181 enum pivot_border style_idx,
182 enum table_axis axis, int a, int b0, int b1)
184 int rule = get_table_rule (styles, style_idx);
186 table_hline (t, rule, b0, b1, a);
188 table_vline (t, rule, a, b0, b1);
192 compose_headings (struct table *t,
193 const struct pivot_axis *a_axis, enum table_axis a,
194 const struct pivot_axis *b_axis,
195 const struct table_border_style *borders,
196 enum pivot_border dim_col_horz,
197 enum pivot_border dim_col_vert,
198 enum pivot_border cat_col_horz,
199 enum pivot_border cat_col_vert,
200 const size_t *column_enumeration, size_t n_columns,
201 const struct table_area_style *label_style,
203 const struct table_area_style *corner_style,
204 struct footnote **footnotes,
205 enum settings_value_show show_values,
206 enum settings_value_show show_variables,
207 bool rotate_inner_labels, bool rotate_outer_labels)
209 enum table_axis b = !a;
210 int b_size = a_axis->label_depth;
211 int a_ofs = b_axis->label_depth;
213 if (!a_axis->n_dimensions || !n_columns || !b_size)
216 int bottom_row = b_size - 1;
217 const int stride = MAX (1, a_axis->n_dimensions);
218 for (int dim_index = 0; dim_index < a_axis->n_dimensions; dim_index++)
220 const struct pivot_dimension *d = a_axis->dimensions[dim_index];
221 if (d->hide_all_labels)
224 for (int row_ofs = 0; row_ofs < d->label_depth; row_ofs++)
226 for (size_t x1 = 0; x1 < n_columns;)
228 const struct pivot_category *c = find_category (
229 d, dim_index, column_enumeration + x1 * stride, row_ofs);
237 for (x2 = x1 + 1; x2 < n_columns; x2++)
239 const struct pivot_category *c2 = find_category (
240 d, dim_index, column_enumeration + x2 * stride, row_ofs);
245 int y1 = bottom_row - row_ofs - c->extra_depth;
246 int y2 = bottom_row - row_ofs + 1;
247 bool is_outer_row = y1 == 0;
248 bool is_inner_row = y2 == b_size;
249 if (pivot_category_is_leaf (c) || c->show_label)
251 int bb[TABLE_N_AXES][2];
252 bb[a][0] = x1 + a_ofs;
253 bb[a][1] = x2 + a_ofs - 1;
256 bool rotate = ((rotate_inner_labels && is_inner_row)
257 || (rotate_outer_labels && is_outer_row));
258 fill_cell (t, bb[H][0], bb[V][0], bb[H][1], bb[V][1],
259 label_style, label_style_idx, c->name, footnotes,
260 show_values, show_variables, rotate);
262 if (pivot_category_is_leaf (c) && x2 + 1 <= n_columns)
264 enum pivot_border style
265 = (y1 == 0 && a_axis->label_depth > d->label_depth
268 draw_line (t, borders, style, b, x2 + a_ofs, y1,
271 if (pivot_category_is_leaf (c) && x1 > 0)
273 enum pivot_border style
274 = (y1 == 0 && a_axis->label_depth > d->label_depth
277 draw_line (t, borders, style, b, x1 + a_ofs, y1,
281 if (c->parent && c->parent->show_label)
282 draw_line (t, borders, cat_col_horz, a, y1,
283 x1 + a_ofs, x2 + a_ofs - 1);
289 if (d->root->show_label_in_corner && a_ofs > 0)
291 int bb[TABLE_N_AXES][2];
292 bb[a][0] = a_ofs - 1;
293 bb[a][1] = a_ofs - 1;
294 bb[b][0] = bottom_row - d->label_depth + 1;
295 bb[b][1] = bottom_row;
296 fill_cell (t, bb[H][0], bb[V][0], bb[H][1], bb[V][1],
297 corner_style, PIVOT_AREA_CORNER, d->root->name, footnotes,
298 show_values, show_variables, false);
302 draw_line (t, borders, dim_col_horz, a, bottom_row + 1, a_ofs,
305 bottom_row -= d->label_depth;
310 pivot_table_submit_layer (const struct pivot_table *pt,
311 const size_t *layer_indexes)
313 const size_t *pindexes[PIVOT_N_AXES]
314 = { [PIVOT_AXIS_LAYER] = layer_indexes };
316 size_t body[TABLE_N_AXES];
317 size_t *column_enumeration = pivot_table_enumerate_axis (
318 pt, PIVOT_AXIS_COLUMN, layer_indexes, pt->look->omit_empty, &body[H]);
319 size_t *row_enumeration = pivot_table_enumerate_axis (
320 pt, PIVOT_AXIS_ROW, layer_indexes, pt->look->omit_empty, &body[V]);
322 int stub[TABLE_N_AXES] = {
323 [H] = pt->axes[PIVOT_AXIS_ROW].label_depth,
324 [V] = pt->axes[PIVOT_AXIS_COLUMN].label_depth,
326 struct table *table = table_create (body[H] + stub[H],
328 stub[H], 0, stub[V], 0);
330 for (size_t i = 0; i < PIVOT_N_AREAS; i++)
331 table->styles[i] = table_area_style_override (
332 table->container, &pt->look->areas[i], NULL, NULL, false);
334 for (size_t i = 0; i < PIVOT_N_BORDERS; i++)
336 const struct table_border_style *in = &pt->look->borders[i];
337 table->rule_colors[i] = pool_alloc (table->container,
338 sizeof *table->rule_colors[i]);
339 struct cell_color *out = table->rule_colors[i];
340 out->alpha = in->color.alpha;
341 out->r = in->color.r;
342 out->g = in->color.g;
343 out->b = in->color.b;
346 struct footnote **footnotes = XCALLOC (pt->n_footnotes, struct footnote *);
347 for (size_t i = 0; i < pt->n_footnotes; i++)
349 const struct pivot_footnote *pf = pt->footnotes[i];
354 char *content = pivot_value_to_string (pf->content, pt->show_values,
356 char *marker = pivot_value_to_string (pf->marker, pt->show_values,
358 footnotes[i] = table_create_footnote (
359 table, i, content, marker,
360 table_area_style_override (table->container,
361 &pt->look->areas[PIVOT_AREA_FOOTER],
362 pf->content->cell_style,
363 pf->content->font_style,
369 compose_headings (table,
370 &pt->axes[PIVOT_AXIS_COLUMN], H, &pt->axes[PIVOT_AXIS_ROW],
372 PIVOT_BORDER_DIM_COL_HORZ,
373 PIVOT_BORDER_DIM_COL_VERT,
374 PIVOT_BORDER_CAT_COL_HORZ,
375 PIVOT_BORDER_CAT_COL_VERT,
376 column_enumeration, body[H],
377 &pt->look->areas[PIVOT_AREA_COLUMN_LABELS],
378 PIVOT_AREA_COLUMN_LABELS,
379 &pt->look->areas[PIVOT_AREA_CORNER], footnotes,
380 pt->show_values, pt->show_variables,
381 pt->rotate_outer_row_labels, false);
383 compose_headings (table,
384 &pt->axes[PIVOT_AXIS_ROW], V, &pt->axes[PIVOT_AXIS_COLUMN],
386 PIVOT_BORDER_DIM_ROW_VERT,
387 PIVOT_BORDER_DIM_ROW_HORZ,
388 PIVOT_BORDER_CAT_ROW_VERT,
389 PIVOT_BORDER_CAT_ROW_HORZ,
390 row_enumeration, body[V],
391 &pt->look->areas[PIVOT_AREA_ROW_LABELS],
392 PIVOT_AREA_ROW_LABELS,
393 &pt->look->areas[PIVOT_AREA_CORNER], footnotes,
394 pt->show_values, pt->show_variables,
395 false, pt->rotate_inner_column_labels);
397 size_t *dindexes = XCALLOC (pt->n_dimensions, size_t);
399 PIVOT_ENUMERATION_FOR_EACH (pindexes[PIVOT_AXIS_ROW], row_enumeration,
400 &pt->axes[PIVOT_AXIS_ROW])
403 PIVOT_ENUMERATION_FOR_EACH (pindexes[PIVOT_AXIS_COLUMN],
405 &pt->axes[PIVOT_AXIS_COLUMN])
407 pivot_table_convert_indexes_ptod (pt, pindexes, dindexes);
408 const struct pivot_value *value = pivot_table_get (pt, dindexes);
410 x + stub[H], y + stub[V],
411 x + stub[H], y + stub[V],
412 &pt->look->areas[PIVOT_AREA_DATA], PIVOT_AREA_DATA,
414 pt->show_values, pt->show_variables, false);
423 if ((pt->corner_text || !pt->look->row_labels_in_corner)
424 && stub[H] && stub[V])
425 fill_cell (table, 0, 0, stub[H] - 1, stub[V] - 1,
426 &pt->look->areas[PIVOT_AREA_CORNER], PIVOT_AREA_CORNER,
427 pt->corner_text, footnotes,
428 pt->show_values, pt->show_variables, false);
430 if (table->n[H] && table->n[V])
433 table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_TOP),
434 0, table->n[H] - 1, 0);
436 table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_BOTTOM),
437 0, table->n[H] - 1, table->n[V]);
439 table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_LEFT),
440 0, 0, table->n[V] - 1);
442 table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_RIGHT),
443 table->n[H], 0, table->n[V] - 1);
447 table, get_table_rule (pt->look->borders, PIVOT_BORDER_DATA_TOP),
448 0, table->n[H] - 1, stub[V]);
451 table, get_table_rule (pt->look->borders, PIVOT_BORDER_DATA_LEFT),
452 stub[H], 0, table->n[V] - 1);
455 free (column_enumeration);
456 free (row_enumeration);
458 struct table_item *ti = table_item_create (table, NULL, NULL, pt->notes);
462 struct table_item_text *title = pivot_value_to_table_item_text (
463 pt->title, &pt->look->areas[PIVOT_AREA_TITLE], footnotes,
464 pt->show_values, pt->show_variables);
465 table_item_set_title (ti, title);
466 table_item_text_destroy (title);
469 const struct pivot_axis *layer_axis = &pt->axes[PIVOT_AXIS_LAYER];
470 struct table_item_layers *layers = NULL;
471 for (size_t i = 0; i < layer_axis->n_dimensions; i++)
473 const struct pivot_dimension *d = layer_axis->dimensions[i];
478 layers = xzalloc (sizeof *layers);
479 layers->style = table_area_style_override (
480 NULL, &pt->look->areas[PIVOT_AREA_LAYERS], NULL, NULL, false);
481 layers->layers = xnmalloc (layer_axis->n_dimensions,
482 sizeof *layers->layers);
485 const struct pivot_value *name
486 = d->data_leaves[layer_indexes[i]]->name;
487 struct table_item_layer *layer = &layers->layers[layers->n_layers++];
488 struct string s = DS_EMPTY_INITIALIZER;
489 pivot_value_format_body (name, pt->show_values, pt->show_variables,
491 layer->content = ds_steal_cstr (&s);
492 layer->n_footnotes = 0;
493 layer->footnotes = xnmalloc (name->n_footnotes,
494 sizeof *layer->footnotes);
495 for (size_t i = 0; i < name->n_footnotes; i++)
497 struct footnote *f = footnotes[name->footnotes[i]->idx];
499 layer->footnotes[layer->n_footnotes++] = f;
505 table_item_set_layers (ti, layers);
506 table_item_layers_destroy (layers);
509 if (pt->caption && pt->show_caption)
511 struct table_item_text *caption = pivot_value_to_table_item_text (
512 pt->caption, &pt->look->areas[PIVOT_AREA_CAPTION], footnotes,
513 pt->show_values, pt->show_variables);
514 table_item_set_caption (ti, caption);
515 table_item_text_destroy (caption);
519 ti->pt = pivot_table_ref (pt);
521 table_item_submit (ti);
525 pivot_table_submit (struct pivot_table *pt)
527 pivot_table_assign_label_depth (CONST_CAST (struct pivot_table *, pt));
529 int old_decimal = settings_get_decimal_char (FMT_COMMA);
530 if (pt->decimal == '.' || pt->decimal == ',')
531 settings_set_decimal_char (pt->decimal);
533 if (pt->look->print_all_layers)
535 size_t *layer_indexes;
537 PIVOT_AXIS_FOR_EACH (layer_indexes, &pt->axes[PIVOT_AXIS_LAYER])
539 if (pt->look->paginate_layers)
540 page_eject_item_submit (page_eject_item_create ());
541 pivot_table_submit_layer (pt, layer_indexes);
545 pivot_table_submit_layer (pt, pt->current_layer);
547 settings_set_decimal_char (old_decimal);
549 pivot_table_unref (pt);