html: Pop up tooltip with table notes in output.
[pspp] / src / output / pivot-output.c
index d6925ceb83030a4f30f6ff3f8206f2d1cbc13daa..ea0cdd4a6e6eea178b8b5f358b64df620b58cbda 100644 (file)
@@ -23,8 +23,8 @@
 #include "data/settings.h"
 #include "libpspp/assertion.h"
 #include "libpspp/pool.h"
-#include "output/tab.h"
 #include "output/table.h"
+#include "output/page-eject-item.h"
 #include "output/table-item.h"
 #include "output/text-item.h"
 #include "output/table-provider.h"
@@ -54,19 +54,19 @@ find_category (const struct pivot_dimension *d, int dim_index,
   return NULL;
 }
 
-static struct area_style *
-area_style_override (struct pool *pool,
-                     const struct area_style *in,
-                     const struct cell_style *cell_,
-                     const struct font_style *font_)
+static struct table_area_style *
+table_area_style_override (struct pool *pool,
+                           const struct table_area_style *in,
+                           const struct cell_style *cell_,
+                           const struct font_style *font_)
 {
   const struct cell_style *cell = cell_ ? cell_ : &in->cell_style;
   const struct font_style *font = font_ ? font_ : &in->font_style;
 
-  struct area_style *out = (pool
+  struct table_area_style *out = (pool
                             ? pool_alloc (pool, sizeof *out)
                             : xmalloc (sizeof *out));
-  *out = (struct area_style) {
+  *out = (struct table_area_style) {
     .cell_style.halign = cell->halign,
     .cell_style.valign = cell->valign,
     .cell_style.decimal_offset = cell->decimal_offset,
@@ -91,8 +91,8 @@ area_style_override (struct pool *pool,
 }
 
 static void
-fill_cell (struct tab_table *t, int x1, int y1, int x2, int y2,
-           const struct area_style *style, int style_idx,
+fill_cell (struct table *t, int x1, int y1, int x2, int y2,
+           const struct table_area_style *style, int style_idx,
            const struct pivot_value *value, struct footnote **footnotes,
            enum settings_value_show show_values,
            enum settings_value_show show_variables,
@@ -112,25 +112,33 @@ fill_cell (struct tab_table *t, int x1, int y1, int x2, int y2,
       if (rotate_label)
         opts |= TAB_ROTATE;
     }
-  tab_joint_text (t, x1, y1, x2, y2, opts, ds_cstr (&s));
+  table_joint_text (t, x1, y1, x2, y2, opts, ds_cstr (&s));
   ds_destroy (&s);
 
   if (value)
     {
       if (value->cell_style || value->font_style)
-        tab_add_style (t, x1, y1,
-                       area_style_override (t->container, style,
-                                            value->cell_style,
-                                            value->font_style));
+        table_add_style (t, x1, y1,
+                         table_area_style_override (t->container, style,
+                                                    value->cell_style,
+                                                    value->font_style));
 
       for (size_t i = 0; i < value->n_footnotes; i++)
-        tab_add_footnote (t, x1, y1, footnotes[value->footnotes[i]->idx]);
+        {
+          struct footnote *f = footnotes[value->footnotes[i]->idx];
+          if (f)
+            table_add_footnote (t, x1, y1, f);
+        }
+
+      if (value->n_subscripts)
+        table_add_subscripts (t, x1, y1,
+                              value->subscripts, value->n_subscripts);
     }
 }
 
 static struct table_item_text *
 pivot_value_to_table_item_text (const struct pivot_value *value,
-                                const struct area_style *area,
+                                const struct table_area_style *area,
                                 struct footnote **footnotes,
                                 enum settings_value_show show_values,
                                 enum settings_value_show show_variables)
@@ -145,13 +153,16 @@ pivot_value_to_table_item_text (const struct pivot_value *value,
   *text = (struct table_item_text) {
     .content = ds_steal_cstr (&s),
     .footnotes = xnmalloc (value->n_footnotes, sizeof *text->footnotes),
-    .n_footnotes = value->n_footnotes,
-    .style = area_style_override (
+    .style = table_area_style_override (
       NULL, area, value->cell_style, value->font_style),
   };
 
   for (size_t i = 0; i < value->n_footnotes; i++)
-    text->footnotes[i] = footnotes[value->footnotes[i]->idx];
+    {
+      struct footnote *f = footnotes[value->footnotes[i]->idx];
+      if (f)
+        text->footnotes[text->n_footnotes++] = f;
+    }
 
   return text;
 }
@@ -164,19 +175,19 @@ get_table_rule (const struct table_border_style *styles,
 }
 
 static void
-draw_line (struct tab_table *t, const struct table_border_style *styles,
+draw_line (struct table *t, const struct table_border_style *styles,
            enum pivot_border style_idx,
            enum table_axis axis, int a, int b0, int b1)
 {
   int rule = get_table_rule (styles, style_idx);
   if (axis == H)
-    tab_hline (t, rule, b0, b1, a);
+    table_hline (t, rule, b0, b1, a);
   else
-    tab_vline (t, rule, a, b0, b1);
+    table_vline (t, rule, a, b0, b1);
 }
 
 static void
-compose_headings (struct tab_table *t,
+compose_headings (struct table *t,
                   const struct pivot_axis *a_axis, enum table_axis a,
                   const struct pivot_axis *b_axis,
                   const struct table_border_style *borders,
@@ -185,8 +196,9 @@ compose_headings (struct tab_table *t,
                   enum pivot_border cat_col_horz,
                   enum pivot_border cat_col_vert,
                   const size_t *column_enumeration, size_t n_columns,
-                  const struct area_style *label_style, int label_style_idx,
-                  const struct area_style *corner_style,
+                  const struct table_area_style *label_style,
+                  int label_style_idx,
+                  const struct table_area_style *corner_style,
                   struct footnote **footnotes,
                   enum settings_value_show show_values,
                   enum settings_value_show show_variables,
@@ -209,7 +221,7 @@ compose_headings (struct tab_table *t,
 
       for (int row_ofs = 0; row_ofs < d->label_depth; row_ofs++)
         {
-          for (size_t x1 = 0; x1 < n_columns; )
+          for (size_t x1 = 0; x1 < n_columns;)
             {
               const struct pivot_category *c = find_category (
                 d, dim_index, column_enumeration + x1 * stride, row_ofs);
@@ -252,7 +264,7 @@ compose_headings (struct tab_table *t,
                            ? dim_col_vert
                            : cat_col_vert);
                       draw_line (t, borders, style, b, x2 + a_ofs, y1,
-                                 t->table.n[b] - 1);
+                                 t->n[b] - 1);
                     }
                   if (pivot_category_is_leaf (c) && x1 > 0)
                     {
@@ -261,7 +273,7 @@ compose_headings (struct tab_table *t,
                            ? dim_col_vert
                            : cat_col_vert);
                       draw_line (t, borders, style, b, x1 + a_ofs, y1,
-                                 t->table.n[b] - 1);
+                                 t->n[b] - 1);
                     }
                 }
               if (c->parent && c->parent->show_label)
@@ -286,58 +298,40 @@ compose_headings (struct tab_table *t,
 
       if (dim_index > 1)
         draw_line (t, borders, dim_col_horz, a, bottom_row + 1, a_ofs,
-                   t->table.n[a] - 1);
+                   t->n[a] - 1);
 
       bottom_row -= d->label_depth;
     }
 }
 
 static void
-pivot_table_submit_layer (const struct pivot_table *st,
+pivot_table_submit_layer (const struct pivot_table *pt,
                           const size_t *layer_indexes)
 {
   const size_t *pindexes[PIVOT_N_AXES]
     = { [PIVOT_AXIS_LAYER] = layer_indexes };
 
-  struct string layer_label = DS_EMPTY_INITIALIZER;
-  const struct pivot_axis *layer_axis = &st->axes[PIVOT_AXIS_LAYER];
-  for (size_t i = 0; i < layer_axis->n_dimensions; i++)
-    {
-      const struct pivot_dimension *d = layer_axis->dimensions[i];
-      if (d->n_leaves)
-        {
-          if (!ds_is_empty (&layer_label))
-            ds_put_byte (&layer_label, '\n');
-          pivot_value_format (d->root->name, st->show_values,
-                              st->show_variables, &layer_label);
-          ds_put_cstr (&layer_label, ": ");
-          pivot_value_format (d->data_leaves[layer_indexes[i]]->name,
-                              st->show_values, st->show_variables,
-                              &layer_label);
-        }
-    }
-
   size_t body[TABLE_N_AXES];
   size_t *column_enumeration = pivot_table_enumerate_axis (
-    st, PIVOT_AXIS_COLUMN, layer_indexes, st->omit_empty, &body[H]);
+    pt, PIVOT_AXIS_COLUMN, layer_indexes, pt->look->omit_empty, &body[H]);
   size_t *row_enumeration = pivot_table_enumerate_axis (
-    st, PIVOT_AXIS_ROW, layer_indexes, st->omit_empty, &body[V]);
+    pt, PIVOT_AXIS_ROW, layer_indexes, pt->look->omit_empty, &body[V]);
 
   int stub[TABLE_N_AXES] = {
-    [H] = st->axes[PIVOT_AXIS_ROW].label_depth,
-    [V] = st->axes[PIVOT_AXIS_COLUMN].label_depth,
+    [H] = pt->axes[PIVOT_AXIS_ROW].label_depth,
+    [V] = pt->axes[PIVOT_AXIS_COLUMN].label_depth,
   };
-  struct tab_table *table = tab_create (body[H] + stub[H],
-                                        body[V] + stub[V]);
-  tab_headers (table, stub[H], 0, stub[V], 0);
+  struct table *table = table_create (body[H] + stub[H],
+                                      body[V] + stub[V],
+                                      stub[H], 0, stub[V], 0);
 
   for (size_t i = 0; i < PIVOT_N_AREAS; i++)
-    table->styles[i] = area_style_override (table->container, &st->areas[i],
-                                            NULL, NULL);
+    table->styles[i] = table_area_style_override (
+      table->container, &pt->look->areas[i], NULL, NULL);
 
   for (size_t i = 0; i < PIVOT_N_BORDERS; i++)
     {
-      const struct table_border_style *in = &st->borders[i];
+      const struct table_border_style *in = &pt->look->borders[i];
       table->rule_colors[i] = pool_alloc (table->container,
                                           sizeof *table->rule_colors[i]);
       struct cell_color *out = table->rule_colors[i];
@@ -347,64 +341,74 @@ pivot_table_submit_layer (const struct pivot_table *st,
       out->b = in->color.b;
     }
 
-  struct footnote **footnotes = xcalloc (st->n_footnotes, sizeof *footnotes);
-  for (size_t i = 0; i < st->n_footnotes; i++)
-    footnotes[i] = tab_create_footnote (
-      table, i,
-      pivot_value_to_string (st->footnotes[i]->content,
-                             st->show_values, st->show_variables),
-      pivot_value_to_string (st->footnotes[i]->marker,
-                             st->show_values, st->show_variables),
-      area_style_override (table->container, &st->areas[PIVOT_AREA_FOOTER],
-                           st->footnotes[i]->content->cell_style,
-                           st->footnotes[i]->content->font_style));
+  struct footnote **footnotes = XCALLOC (pt->n_footnotes,  struct footnote *);
+  for (size_t i = 0; i < pt->n_footnotes; i++)
+    {
+      const struct pivot_footnote *pf = pt->footnotes[i];
+
+      if (!pf->show)
+        continue;
+
+      char *content = pivot_value_to_string (pf->content, pt->show_values,
+                                             pt->show_variables);
+      char *marker = pivot_value_to_string (pf->marker, pt->show_values,
+                                            pt->show_variables);
+      footnotes[i] = table_create_footnote (
+        table, i, content, marker,
+        table_area_style_override (table->container,
+                                   &pt->look->areas[PIVOT_AREA_FOOTER],
+                                   pf->content->cell_style,
+                                   pf->content->font_style));
+      free (marker);
+      free (content);
+    }
 
   compose_headings (table,
-                    &st->axes[PIVOT_AXIS_COLUMN], H, &st->axes[PIVOT_AXIS_ROW],
-                    st->borders,
+                    &pt->axes[PIVOT_AXIS_COLUMN], H, &pt->axes[PIVOT_AXIS_ROW],
+                    pt->look->borders,
                     PIVOT_BORDER_DIM_COL_HORZ,
                     PIVOT_BORDER_DIM_COL_VERT,
                     PIVOT_BORDER_CAT_COL_HORZ,
                     PIVOT_BORDER_CAT_COL_VERT,
                     column_enumeration, body[H],
-                    &st->areas[PIVOT_AREA_COLUMN_LABELS],
+                    &pt->look->areas[PIVOT_AREA_COLUMN_LABELS],
                     PIVOT_AREA_COLUMN_LABELS,
-                    &st->areas[PIVOT_AREA_CORNER], footnotes,
-                    st->show_values, st->show_variables,
-                    st->rotate_inner_column_labels, false);
+                    &pt->look->areas[PIVOT_AREA_CORNER], footnotes,
+                    pt->show_values, pt->show_variables,
+                    pt->rotate_inner_column_labels, false);
 
   compose_headings (table,
-                    &st->axes[PIVOT_AXIS_ROW], V, &st->axes[PIVOT_AXIS_COLUMN],
-                    st->borders,
+                    &pt->axes[PIVOT_AXIS_ROW], V, &pt->axes[PIVOT_AXIS_COLUMN],
+                    pt->look->borders,
                     PIVOT_BORDER_DIM_ROW_VERT,
                     PIVOT_BORDER_DIM_ROW_HORZ,
                     PIVOT_BORDER_CAT_ROW_VERT,
                     PIVOT_BORDER_CAT_ROW_HORZ,
                     row_enumeration, body[V],
-                    &st->areas[PIVOT_AREA_ROW_LABELS],
+                    &pt->look->areas[PIVOT_AREA_ROW_LABELS],
                     PIVOT_AREA_ROW_LABELS,
-                    &st->areas[PIVOT_AREA_CORNER], footnotes,
-                    st->show_values, st->show_variables,
-                    false, st->rotate_outer_row_labels);
+                    &pt->look->areas[PIVOT_AREA_CORNER], footnotes,
+                    pt->show_values, pt->show_variables,
+                    false, pt->rotate_outer_row_labels);
 
-  size_t *dindexes = xcalloc (st->n_dimensions, sizeof *dindexes);
+  size_t *dindexes = XCALLOC (pt->n_dimensions, size_t);
   size_t y = 0;
   PIVOT_ENUMERATION_FOR_EACH (pindexes[PIVOT_AXIS_ROW], row_enumeration,
-                              &st->axes[PIVOT_AXIS_ROW])
+                              &pt->axes[PIVOT_AXIS_ROW])
     {
       size_t x = 0;
       PIVOT_ENUMERATION_FOR_EACH (pindexes[PIVOT_AXIS_COLUMN],
                                   column_enumeration,
-                                  &st->axes[PIVOT_AXIS_COLUMN])
+                                  &pt->axes[PIVOT_AXIS_COLUMN])
         {
-          pivot_table_convert_indexes_ptod (st, pindexes, dindexes);
-          const struct pivot_value *value = pivot_table_get (st, dindexes);
+          pivot_table_convert_indexes_ptod (pt, pindexes, dindexes);
+          const struct pivot_value *value = pivot_table_get (pt, dindexes);
           fill_cell (table,
                      x + stub[H], y + stub[V],
                      x + stub[H], y + stub[V],
-                     &st->areas[PIVOT_AREA_DATA], PIVOT_AREA_DATA,
+                     &pt->look->areas[PIVOT_AREA_DATA], PIVOT_AREA_DATA,
                      value, footnotes,
-                     st->show_values, st->show_variables, false);
+                     pt->show_values, pt->show_variables, false);
 
           x++;
         }
@@ -413,97 +417,130 @@ pivot_table_submit_layer (const struct pivot_table *st,
     }
   free (dindexes);
 
-  if (st->corner_text && stub[H] && stub[V])
+  if (pt->corner_text && stub[H] && stub[V])
     fill_cell (table, 0, 0, stub[H] - 1, stub[V] - 1,
-               &st->areas[PIVOT_AREA_CORNER], PIVOT_AREA_CORNER,
-               st->corner_text, footnotes,
-               st->show_values, st->show_variables, false);
+               &pt->look->areas[PIVOT_AREA_CORNER], PIVOT_AREA_CORNER,
+               pt->corner_text, footnotes,
+               pt->show_values, pt->show_variables, false);
 
-  if (tab_nc (table) && tab_nr (table))
+  if (table_nc (table) && table_nr (table))
     {
-      tab_hline (
-        table, get_table_rule (st->borders, PIVOT_BORDER_INNER_TOP),
-        0, tab_nc (table) - 1, 0);
-      tab_hline (
-        table, get_table_rule (st->borders, PIVOT_BORDER_INNER_BOTTOM),
-        0, tab_nc (table) - 1, tab_nr (table));
-      tab_vline (
-        table, get_table_rule (st->borders, PIVOT_BORDER_INNER_LEFT),
-        0, 0, tab_nr (table) - 1);
-      tab_vline (
-        table, get_table_rule (st->borders, PIVOT_BORDER_INNER_RIGHT),
-        tab_nc (table), 0, tab_nr (table) - 1);
+      table_hline (
+        table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_TOP),
+        0, table_nc (table) - 1, 0);
+      table_hline (
+        table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_BOTTOM),
+        0, table_nc (table) - 1, table_nr (table));
+      table_vline (
+        table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_LEFT),
+        0, 0, table_nr (table) - 1);
+      table_vline (
+        table, get_table_rule (pt->look->borders, PIVOT_BORDER_INNER_RIGHT),
+        table_nc (table), 0, table_nr (table) - 1);
 
       if (stub[V])
-        tab_hline (
-          table, get_table_rule (st->borders, PIVOT_BORDER_DATA_TOP),
-          0, tab_nc (table) - 1, stub[V]);
+        table_hline (
+          table, get_table_rule (pt->look->borders, PIVOT_BORDER_DATA_TOP),
+          0, table_nc (table) - 1, stub[V]);
       if (stub[H])
-        tab_vline (
-          table, get_table_rule (st->borders, PIVOT_BORDER_DATA_LEFT),
-          stub[H], 0, tab_nr (table) - 1);
+        table_vline (
+          table, get_table_rule (pt->look->borders, PIVOT_BORDER_DATA_LEFT),
+          stub[H], 0, table_nr (table) - 1);
 
     }
   free (column_enumeration);
   free (row_enumeration);
 
-  struct table_item *ti = table_item_create (&table->table, NULL, NULL);
+  struct table_item *ti = table_item_create (table, NULL, NULL, pt->notes);
 
-  if (st->title)
+  if (pt->title)
     {
       struct table_item_text *title = pivot_value_to_table_item_text (
-        st->title, &st->areas[PIVOT_AREA_TITLE], footnotes,
-        st->show_values, st->show_variables);
+        pt->title, &pt->look->areas[PIVOT_AREA_TITLE], footnotes,
+        pt->show_values, pt->show_variables);
       table_item_set_title (ti, title);
       table_item_text_destroy (title);
     }
 
-  if (!ds_is_empty (&layer_label))
+  const struct pivot_axis *layer_axis = &pt->axes[PIVOT_AXIS_LAYER];
+  struct table_item_layers *layers = NULL;
+  for (size_t i = 0; i < layer_axis->n_dimensions; i++)
     {
-      struct table_item_text *layers = table_item_text_create (
-        ds_cstr (&layer_label));
-      layers->style = area_style_override (NULL, &st->areas[PIVOT_AREA_LAYERS],
-                                           NULL, NULL);
-      table_item_set_layers (ti, layers);
-      table_item_text_destroy (layers);
+      const struct pivot_dimension *d = layer_axis->dimensions[i];
+      if (d->n_leaves)
+        {
+          if (!layers)
+            {
+              layers = xzalloc (sizeof *layers);
+              layers->style = table_area_style_override (
+                NULL, &pt->look->areas[PIVOT_AREA_LAYERS], NULL, NULL);
+              layers->layers = xnmalloc (layer_axis->n_dimensions,
+                                         sizeof *layers->layers);
+            }
 
-      ds_destroy (&layer_label);
+          const struct pivot_value *name
+            = d->data_leaves[layer_indexes[i]]->name;
+          struct table_item_layer *layer = &layers->layers[layers->n_layers++];
+          struct string s = DS_EMPTY_INITIALIZER;
+          pivot_value_format_body (name, pt->show_values, pt->show_variables,
+                                   &s);
+          layer->content = ds_steal_cstr (&s);
+          layer->n_footnotes = 0;
+          layer->footnotes = xnmalloc (name->n_footnotes,
+                                       sizeof *layer->footnotes);
+          for (size_t i = 0; i < name->n_footnotes; i++)
+            {
+              struct footnote *f = footnotes[name->footnotes[i]->idx];
+              if (f)
+                layer->footnotes[layer->n_footnotes++] = f;
+            }
+        }
+    }
+  if (layers)
+    {
+      table_item_set_layers (ti, layers);
+      table_item_layers_destroy (layers);
     }
 
-  if (st->caption)
+  if (pt->caption && pt->show_caption)
     {
       struct table_item_text *caption = pivot_value_to_table_item_text (
-        st->caption, &st->areas[PIVOT_AREA_CAPTION], footnotes,
-        st->show_values, st->show_variables);
+        pt->caption, &pt->look->areas[PIVOT_AREA_CAPTION], footnotes,
+        pt->show_values, pt->show_variables);
       table_item_set_caption (ti, caption);
       table_item_text_destroy (caption);
     }
 
+  free (footnotes);
+  ti->pt = pivot_table_ref (pt);
+
   table_item_submit (ti);
 }
 
 void
-pivot_table_submit (const struct pivot_table *st)
+pivot_table_submit (struct pivot_table *pt)
 {
-  pivot_table_assign_label_depth (CONST_CAST (struct pivot_table *, st));
+  pivot_table_assign_label_depth (CONST_CAST (struct pivot_table *, pt));
 
   int old_decimal = settings_get_decimal_char (FMT_COMMA);
-  if (st->decimal == '.' || st->decimal == ',')
-    settings_set_decimal_char (st->decimal);
+  if (pt->decimal == '.' || pt->decimal == ',')
+    settings_set_decimal_char (pt->decimal);
 
-  if (st->print_all_layers)
+  if (pt->look->print_all_layers)
     {
       size_t *layer_indexes;
 
-      PIVOT_AXIS_FOR_EACH (layer_indexes, &st->axes[PIVOT_AXIS_LAYER])
+      PIVOT_AXIS_FOR_EACH (layer_indexes, &pt->axes[PIVOT_AXIS_LAYER])
         {
-          if (st->paginate_layers)
-            text_item_submit (text_item_create (TEXT_ITEM_EJECT_PAGE, ""));
-          pivot_table_submit_layer (st, layer_indexes);
+          if (pt->look->paginate_layers)
+            page_eject_item_submit (page_eject_item_create ());
+          pivot_table_submit_layer (pt, layer_indexes);
         }
     }
   else
-    pivot_table_submit_layer (st, st->current_layer);
+    pivot_table_submit_layer (pt, pt->current_layer);
 
   settings_set_decimal_char (old_decimal);
+
+  pivot_table_unref (pt);
 }