pintos-os.org Git - pspp/blob - src/output/pivot-output.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2018 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>. */
  16
  17 #include <config.h>
  18
  19 #include <stdlib.h>
  20
  21 #include "output/pivot-table.h"
  22
  23 #include "data/settings.h"
  24 #include "libpspp/assertion.h"
  25 #include "libpspp/pool.h"
  26 #include "output/table.h"
  27 #include "output/table-item.h"
  28 #include "output/text-item.h"
  29 #include "output/table-provider.h"
  30
  31 #include "gl/minmax.h"
  32 #include "gl/xalloc.h"
  33
  34 #define H TABLE_HORZ
  35 #define V TABLE_VERT
  36
  37 static const struct pivot_category *
  38 find_category (const struct pivot_dimension *d, int dim_index,
  39                const size_t *indexes, int row_ofs)
  40 {
  41   size_t index = indexes[dim_index];
  42   assert (index < d->n_leaves);
  43   for (const struct pivot_category *c = d->presentation_leaves[index];
  44        c; c = c->parent)
  45     {
  46       if (!row_ofs)
  47         return c;
  48
  49       row_ofs -= 1 + c->extra_depth;
  50       if (row_ofs < 0)
  51         return NULL;
  52     }
  53   return NULL;
  54 }
  55
  56 static struct area_style *
  57 area_style_override (struct pool *pool,
  58                      const struct area_style *in,
  59                      const struct cell_style *cell_,
  60                      const struct font_style *font_)
  61 {
  62   const struct cell_style *cell = cell_ ? cell_ : &in->cell_style;
  63   const struct font_style *font = font_ ? font_ : &in->font_style;
  64
  65   struct area_style *out = (pool
  66                             ? pool_alloc (pool, sizeof *out)
  67                             : xmalloc (sizeof *out));
  68   *out = (struct area_style) {
  69     .cell_style.halign = cell->halign,
  70     .cell_style.valign = cell->valign,
  71     .cell_style.decimal_offset = cell->decimal_offset,
  72     .cell_style.margin[H][0] = cell->margin[H][0],
  73     .cell_style.margin[H][1] = cell->margin[H][1],
  74     .cell_style.margin[V][0] = cell->margin[V][0],
  75     .cell_style.margin[V][1] = cell->margin[V][1],
  76     .font_style.fg[0] = font->fg[0],
  77     .font_style.fg[1] = font->fg[1],
  78     .font_style.bg[0] = font->bg[0],
  79     .font_style.bg[1] = font->bg[1],
  80     .font_style.typeface = (font->typeface
  81                             ? pool_strdup (pool, font->typeface)
  82                             : NULL),
  83     .font_style.size = font->size,
  84     .font_style.bold = font->bold,
  85     .font_style.italic = font->italic,
  86     .font_style.underline = font->underline,
  87     .font_style.markup = font->markup,
  88   };
  89   return out;
  90 }
  91
  92 static void
  93 fill_cell (struct table *t, int x1, int y1, int x2, int y2,
  94            const struct area_style *style, int style_idx,
  95            const struct pivot_value *value, struct footnote **footnotes,
  96            enum settings_value_show show_values,
  97            enum settings_value_show show_variables,
  98            bool rotate_label)
  99 {
 100
 101   struct string s = DS_EMPTY_INITIALIZER;
 102   int opts = style_idx << TAB_STYLE_SHIFT;
 103   if (value)
 104     {
 105       bool numeric = pivot_value_format_body (value, show_values,
 106                                               show_variables, &s);
 107       if (numeric)
 108         opts |= TAB_NUMERIC;
 109       if (value->font_style && value->font_style->markup)
 110         opts |= TAB_MARKUP;
 111       if (rotate_label)
 112         opts |= TAB_ROTATE;
 113     }
 114   table_joint_text (t, x1, y1, x2, y2, opts, ds_cstr (&s));
 115   ds_destroy (&s);
 116
 117   if (value)
 118     {
 119       if (value->cell_style || value->font_style)
 120         table_add_style (t, x1, y1,
 121                          area_style_override (t->container, style,
 122                                               value->cell_style,
 123                                               value->font_style));
 124
 125       for (size_t i = 0; i < value->n_footnotes; i++)
 126         {
 127           struct footnote *f = footnotes[value->footnotes[i]->idx];
 128           if (f)
 129             table_add_footnote (t, x1, y1, f);
 130         }
 131
 132       if (value->n_subscripts)
 133         table_add_subscripts (t, x1, y1,
 134                               value->subscripts, value->n_subscripts);
 135     }
 136 }
 137
 138 static struct table_item_text *
 139 pivot_value_to_table_item_text (const struct pivot_value *value,
 140                                 const struct area_style *area,
 141                                 struct footnote **footnotes,
 142                                 enum settings_value_show show_values,
 143                                 enum settings_value_show show_variables)
 144 {
 145   if (!value)
 146     return NULL;
 147
 148   struct string s = DS_EMPTY_INITIALIZER;
 149   pivot_value_format_body (value, show_values, show_variables, &s);
 150
 151   struct table_item_text *text = xmalloc (sizeof *text);
 152   *text = (struct table_item_text) {
 153     .content = ds_steal_cstr (&s),
 154     .footnotes = xnmalloc (value->n_footnotes, sizeof *text->footnotes),
 155     .style = area_style_override (
 156       NULL, area, value->cell_style, value->font_style),
 157   };
 158
 159   for (size_t i = 0; i < value->n_footnotes; i++)
 160     {
 161       struct footnote *f = footnotes[value->footnotes[i]->idx];
 162       if (f)
 163         text->footnotes[text->n_footnotes++] = f;
 164     }
 165
 166   return text;
 167 }
 168
 169 static int
 170 get_table_rule (const struct table_border_style *styles,
 171                 enum pivot_border style_idx)
 172 {
 173   return styles[style_idx].stroke | (style_idx << TAB_RULE_STYLE_SHIFT);
 174 }
 175
 176 static void
 177 draw_line (struct table *t, const struct table_border_style *styles,
 178            enum pivot_border style_idx,
 179            enum table_axis axis, int a, int b0, int b1)
 180 {
 181   int rule = get_table_rule (styles, style_idx);
 182   if (axis == H)
 183     table_hline (t, rule, b0, b1, a);
 184   else
 185     table_vline (t, rule, a, b0, b1);
 186 }
 187
 188 static void
 189 compose_headings (struct table *t,
 190                   const struct pivot_axis *a_axis, enum table_axis a,
 191                   const struct pivot_axis *b_axis,
 192                   const struct table_border_style *borders,
 193                   enum pivot_border dim_col_horz,
 194                   enum pivot_border dim_col_vert,
 195                   enum pivot_border cat_col_horz,
 196                   enum pivot_border cat_col_vert,
 197                   const size_t *column_enumeration, size_t n_columns,
 198                   const struct area_style *label_style, int label_style_idx,
 199                   const struct area_style *corner_style,
 200                   struct footnote **footnotes,
 201                   enum settings_value_show show_values,
 202                   enum settings_value_show show_variables,
 203                   bool rotate_inner_labels, bool rotate_outer_labels)
 204 {
 205   enum table_axis b = !a;
 206   int b_size = a_axis->label_depth;
 207   int a_ofs = b_axis->label_depth;
 208
 209   if (!a_axis->n_dimensions || !n_columns || !b_size)
 210     return;
 211
 212   int bottom_row = b_size - 1;
 213   const int stride = MAX (1, a_axis->n_dimensions);
 214   for (int dim_index = 0; dim_index < a_axis->n_dimensions; dim_index++)
 215     {
 216       const struct pivot_dimension *d = a_axis->dimensions[dim_index];
 217       if (d->hide_all_labels)
 218         continue;
 219
 220       for (int row_ofs = 0; row_ofs < d->label_depth; row_ofs++)
 221         {
 222           for (size_t x1 = 0; x1 < n_columns; )
 223             {
 224               const struct pivot_category *c = find_category (
 225                 d, dim_index, column_enumeration + x1 * stride, row_ofs);
 226               if (!c)
 227                 {
 228                   x1++;
 229                   continue;
 230                 }
 231
 232               size_t x2;
 233               for (x2 = x1 + 1; x2 < n_columns; x2++)
 234                 {
 235                   const struct pivot_category *c2 = find_category (
 236                     d, dim_index, column_enumeration + x2 * stride, row_ofs);
 237                   if (c != c2)
 238                     break;
 239                 }
 240
 241               int y1 = bottom_row - row_ofs - c->extra_depth;
 242               int y2 = bottom_row - row_ofs + 1;
 243               bool is_outer_row = y1 == 0;
 244               bool is_inner_row = y2 == b_size;
 245               if (pivot_category_is_leaf (c) || c->show_label)
 246                 {
 247                   int bb[TABLE_N_AXES][2];
 248                   bb[a][0] = x1 + a_ofs;
 249                   bb[a][1] = x2 + a_ofs - 1;
 250                   bb[b][0] = y1;
 251                   bb[b][1] = y2 - 1;
 252                   bool rotate = ((rotate_inner_labels && is_inner_row)
 253                                  || (rotate_outer_labels && is_outer_row));
 254                   fill_cell (t, bb[H][0], bb[V][0], bb[H][1], bb[V][1],
 255                              label_style, label_style_idx, c->name, footnotes,
 256                              show_values, show_variables, rotate);
 257
 258                   if (pivot_category_is_leaf (c) && x2 + 1 <= n_columns)
 259                     {
 260                       enum pivot_border style
 261                         = (y1 == 0 && a_axis->label_depth > d->label_depth
 262                            ? dim_col_vert
 263                            : cat_col_vert);
 264                       draw_line (t, borders, style, b, x2 + a_ofs, y1,
 265                                  t->n[b] - 1);
 266                     }
 267                   if (pivot_category_is_leaf (c) && x1 > 0)
 268                     {
 269                       enum pivot_border style
 270                         = (y1 == 0 && a_axis->label_depth > d->label_depth
 271                            ? dim_col_vert
 272                            : cat_col_vert);
 273                       draw_line (t, borders, style, b, x1 + a_ofs, y1,
 274                                  t->n[b] - 1);
 275                     }
 276                 }
 277               if (c->parent && c->parent->show_label)
 278                 draw_line (t, borders, cat_col_horz, a, y1,
 279                            x1 + a_ofs, x2 + a_ofs - 1);
 280
 281               x1 = x2;
 282             }
 283         }
 284
 285       if (d->root->show_label_in_corner && a_ofs > 0)
 286         {
 287           int bb[TABLE_N_AXES][2];
 288           bb[a][0] = a_ofs - 1;
 289           bb[a][1] = a_ofs - 1;
 290           bb[b][0] = bottom_row - d->label_depth + 1;
 291           bb[b][1] = bottom_row;
 292           fill_cell (t, bb[H][0], bb[V][0], bb[H][1], bb[V][1],
 293                      corner_style, PIVOT_AREA_CORNER, d->root->name, footnotes,
 294                      show_values, show_variables, false);
 295         }
 296
 297       if (dim_index > 1)
 298         draw_line (t, borders, dim_col_horz, a, bottom_row + 1, a_ofs,
 299                    t->n[a] - 1);
 300
 301       bottom_row -= d->label_depth;
 302     }
 303 }
 304
 305 static void
 306 pivot_table_submit_layer (const struct pivot_table *pt,
 307                           const size_t *layer_indexes)
 308 {
 309   const size_t *pindexes[PIVOT_N_AXES]
 310     = { [PIVOT_AXIS_LAYER] = layer_indexes };
 311
 312   size_t body[TABLE_N_AXES];
 313   size_t *column_enumeration = pivot_table_enumerate_axis (
 314     pt, PIVOT_AXIS_COLUMN, layer_indexes, pt->omit_empty, &body[H]);
 315   size_t *row_enumeration = pivot_table_enumerate_axis (
 316     pt, PIVOT_AXIS_ROW, layer_indexes, pt->omit_empty, &body[V]);
 317
 318   int stub[TABLE_N_AXES] = {
 319     [H] = pt->axes[PIVOT_AXIS_ROW].label_depth,
 320     [V] = pt->axes[PIVOT_AXIS_COLUMN].label_depth,
 321   };
 322   struct table *table = table_create (body[H] + stub[H],
 323                                       body[V] + stub[V],
 324                                       stub[H], 0, stub[V], 0);
 325
 326   for (size_t i = 0; i < PIVOT_N_AREAS; i++)
 327     table->styles[i] = area_style_override (table->container, &pt->areas[i],
 328                                             NULL, NULL);
 329
 330   for (size_t i = 0; i < PIVOT_N_BORDERS; i++)
 331     {
 332       const struct table_border_style *in = &pt->borders[i];
 333       table->rule_colors[i] = pool_alloc (table->container,
 334                                           sizeof *table->rule_colors[i]);
 335       struct cell_color *out = table->rule_colors[i];
 336       out->alpha = in->color.alpha;
 337       out->r = in->color.r;
 338       out->g = in->color.g;
 339       out->b = in->color.b;
 340     }
 341
 342   struct footnote **footnotes = xcalloc (pt->n_footnotes, sizeof *footnotes);
 343   for (size_t i = 0; i < pt->n_footnotes; i++)
 344     {
 345       const struct pivot_footnote *pf = pt->footnotes[i];
 346
 347       if (!pf->show)
 348         continue;
 349
 350       char *content = pivot_value_to_string (pf->content, pt->show_values,
 351                                              pt->show_variables);
 352       char *marker = pivot_value_to_string (pf->marker, pt->show_values,
 353                                             pt->show_variables);
 354       footnotes[i] = table_create_footnote (
 355         table, i, content, marker,
 356         area_style_override (table->container, &pt->areas[PIVOT_AREA_FOOTER],
 357                              pf->content->cell_style,
 358                              pf->content->font_style));
 359       free (marker);
 360       free (content);
 361     }
 362
 363   compose_headings (table,
 364                     &pt->axes[PIVOT_AXIS_COLUMN], H, &pt->axes[PIVOT_AXIS_ROW],
 365                     pt->borders,
 366                     PIVOT_BORDER_DIM_COL_HORZ,
 367                     PIVOT_BORDER_DIM_COL_VERT,
 368                     PIVOT_BORDER_CAT_COL_HORZ,
 369                     PIVOT_BORDER_CAT_COL_VERT,
 370                     column_enumeration, body[H],
 371                     &pt->areas[PIVOT_AREA_COLUMN_LABELS],
 372                     PIVOT_AREA_COLUMN_LABELS,
 373                     &pt->areas[PIVOT_AREA_CORNER], footnotes,
 374                     pt->show_values, pt->show_variables,
 375                     pt->rotate_inner_column_labels, false);
 376
 377   compose_headings (table,
 378                     &pt->axes[PIVOT_AXIS_ROW], V, &pt->axes[PIVOT_AXIS_COLUMN],
 379                     pt->borders,
 380                     PIVOT_BORDER_DIM_ROW_VERT,
 381                     PIVOT_BORDER_DIM_ROW_HORZ,
 382                     PIVOT_BORDER_CAT_ROW_VERT,
 383                     PIVOT_BORDER_CAT_ROW_HORZ,
 384                     row_enumeration, body[V],
 385                     &pt->areas[PIVOT_AREA_ROW_LABELS],
 386                     PIVOT_AREA_ROW_LABELS,
 387                     &pt->areas[PIVOT_AREA_CORNER], footnotes,
 388                     pt->show_values, pt->show_variables,
 389                     false, pt->rotate_outer_row_labels);
 390
 391   size_t *dindexes = xcalloc (pt->n_dimensions, sizeof *dindexes);
 392   size_t y = 0;
 393   PIVOT_ENUMERATION_FOR_EACH (pindexes[PIVOT_AXIS_ROW], row_enumeration,
 394                               &pt->axes[PIVOT_AXIS_ROW])
 395     {
 396       size_t x = 0;
 397       PIVOT_ENUMERATION_FOR_EACH (pindexes[PIVOT_AXIS_COLUMN],
 398                                   column_enumeration,
 399                                   &pt->axes[PIVOT_AXIS_COLUMN])
 400         {
 401           pivot_table_convert_indexes_ptod (pt, pindexes, dindexes);
 402           const struct pivot_value *value = pivot_table_get (pt, dindexes);
 403           fill_cell (table,
 404                      x + stub[H], y + stub[V],
 405                      x + stub[H], y + stub[V],
 406                      &pt->areas[PIVOT_AREA_DATA], PIVOT_AREA_DATA,
 407                      value, footnotes,
 408                      pt->show_values, pt->show_variables, false);
 409
 410           x++;
 411         }
 412
 413       y++;
 414     }
 415   free (dindexes);
 416
 417   if (pt->corner_text && stub[H] && stub[V])
 418     fill_cell (table, 0, 0, stub[H] - 1, stub[V] - 1,
 419                &pt->areas[PIVOT_AREA_CORNER], PIVOT_AREA_CORNER,
 420                pt->corner_text, footnotes,
 421                pt->show_values, pt->show_variables, false);
 422
 423   if (table_nc (table) && table_nr (table))
 424     {
 425       table_hline (
 426         table, get_table_rule (pt->borders, PIVOT_BORDER_INNER_TOP),
 427         0, table_nc (table) - 1, 0);
 428       table_hline (
 429         table, get_table_rule (pt->borders, PIVOT_BORDER_INNER_BOTTOM),
 430         0, table_nc (table) - 1, table_nr (table));
 431       table_vline (
 432         table, get_table_rule (pt->borders, PIVOT_BORDER_INNER_LEFT),
 433         0, 0, table_nr (table) - 1);
 434       table_vline (
 435         table, get_table_rule (pt->borders, PIVOT_BORDER_INNER_RIGHT),
 436         table_nc (table), 0, table_nr (table) - 1);
 437
 438       if (stub[V])
 439         table_hline (
 440           table, get_table_rule (pt->borders, PIVOT_BORDER_DATA_TOP),
 441           0, table_nc (table) - 1, stub[V]);
 442       if (stub[H])
 443         table_vline (
 444           table, get_table_rule (pt->borders, PIVOT_BORDER_DATA_LEFT),
 445           stub[H], 0, table_nr (table) - 1);
 446
 447     }
 448   free (column_enumeration);
 449   free (row_enumeration);
 450
 451   struct table_item *ti = table_item_create (table, NULL, NULL);
 452
 453   if (pt->title)
 454     {
 455       struct table_item_text *title = pivot_value_to_table_item_text (
 456         pt->title, &pt->areas[PIVOT_AREA_TITLE], footnotes,
 457         pt->show_values, pt->show_variables);
 458       table_item_set_title (ti, title);
 459       table_item_text_destroy (title);
 460     }
 461
 462   const struct pivot_axis *layer_axis = &pt->axes[PIVOT_AXIS_LAYER];
 463   struct table_item_layers *layers = NULL;
 464   for (size_t i = 0; i < layer_axis->n_dimensions; i++)
 465     {
 466       const struct pivot_dimension *d = layer_axis->dimensions[i];
 467       if (d->n_leaves)
 468         {
 469           if (!layers)
 470             {
 471               layers = xzalloc (sizeof *layers);
 472               layers->style = area_style_override (
 473                 NULL, &pt->areas[PIVOT_AREA_LAYERS], NULL, NULL);
 474               layers->layers = xnmalloc (layer_axis->n_dimensions,
 475                                          sizeof *layers->layers);
 476             }
 477
 478           const struct pivot_value *name
 479             = d->data_leaves[layer_indexes[i]]->name;
 480           struct table_item_layer *layer = &layers->layers[layers->n_layers++];
 481           struct string s = DS_EMPTY_INITIALIZER;
 482           pivot_value_format_body (name, pt->show_values, pt->show_variables,
 483                                    &s);
 484           layer->content = ds_steal_cstr (&s);
 485           layer->n_footnotes = 0;
 486           layer->footnotes = xnmalloc (name->n_footnotes,
 487                                        sizeof *layer->footnotes);
 488           for (size_t i = 0; i < name->n_footnotes; i++)
 489             {
 490               struct footnote *f = footnotes[name->footnotes[i]->idx];
 491               if (f)
 492                 layer->footnotes[layer->n_footnotes++] = f;
 493             }
 494         }
 495     }
 496   if (layers)
 497     {
 498       table_item_set_layers (ti, layers);
 499       table_item_layers_destroy (layers);
 500     }
 501
 502   if (pt->caption && pt->show_caption)
 503     {
 504       struct table_item_text *caption = pivot_value_to_table_item_text (
 505         pt->caption, &pt->areas[PIVOT_AREA_CAPTION], footnotes,
 506         pt->show_values, pt->show_variables);
 507       table_item_set_caption (ti, caption);
 508       table_item_text_destroy (caption);
 509     }
 510
 511   free (footnotes);
 512   table_item_submit (ti);
 513 }
 514
 515 void
 516 pivot_table_submit (struct pivot_table *pt)
 517 {
 518   pivot_table_assign_label_depth (CONST_CAST (struct pivot_table *, pt));
 519
 520   int old_decimal = settings_get_decimal_char (FMT_COMMA);
 521   if (pt->decimal == '.' || pt->decimal == ',')
 522     settings_set_decimal_char (pt->decimal);
 523
 524   if (pt->print_all_layers)
 525     {
 526       size_t *layer_indexes;
 527
 528       PIVOT_AXIS_FOR_EACH (layer_indexes, &pt->axes[PIVOT_AXIS_LAYER])
 529         {
 530           if (pt->paginate_layers)
 531             text_item_submit (text_item_create (TEXT_ITEM_EJECT_PAGE, ""));
 532           pivot_table_submit_layer (pt, layer_indexes);
 533         }
 534     }
 535   else
 536     pivot_table_submit_layer (pt, pt->current_layer);
 537
 538   settings_set_decimal_char (old_decimal);
 539
 540   pivot_table_unref (pt);
 541 }