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