output-item: Make label a part of every output_item.
[pspp] / src / output / table-item.c
index 1308cb86503cddd887354bbdac1d13c9c6798555..1b17c320a6e8e5a119c5ac1ff70a79089dcd83c6 100644 (file)
 #include "libpspp/cast.h"
 #include "output/driver.h"
 #include "output/output-item-provider.h"
+#include "output/pivot-table.h"
 #include "output/table-item.h"
 
 #include "gl/xalloc.h"
 
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
+
 struct table_item_text *
 table_item_text_create (const char *content)
 {
@@ -35,8 +39,7 @@ table_item_text_create (const char *content)
     return NULL;
 
   struct table_item_text *text = xmalloc (sizeof *text);
-  *text = (struct table_item_text) { .content = xstrdup (content),
-                                     .halign = TAB_LEFT };
+  *text = (struct table_item_text) { .content = xstrdup (content) };
   return text;
 }
 
@@ -52,8 +55,7 @@ table_item_text_clone (const struct table_item_text *old)
     .footnotes = xmemdup (old->footnotes,
                           old->n_footnotes * sizeof *old->footnotes),
     .n_footnotes = old->n_footnotes,
-    .style = cell_style_clone (NULL, old->style),
-    .halign = old->halign,
+    .style = table_area_style_clone (NULL, old->style),
   };
   return new;
 }
@@ -65,23 +67,76 @@ table_item_text_destroy (struct table_item_text *text)
     {
       free (text->content);
       free (text->footnotes);
-      cell_style_free (text->style);
+      table_area_style_free (text->style);
       free (text);
     }
 }
 
+void
+table_item_layer_copy (struct table_item_layer *dst,
+                       const struct table_item_layer *src)
+{
+  dst->content = xstrdup (src->content);
+  dst->footnotes = xmemdup (src->footnotes,
+                            src->n_footnotes * sizeof *src->footnotes);
+  dst->n_footnotes = src->n_footnotes;
+}
+void
+table_item_layer_uninit (struct table_item_layer *layer)
+{
+  if (layer)
+    {
+      free (layer->content);
+      free (layer->footnotes);
+    }
+}
+
+struct table_item_layers *
+table_item_layers_clone (const struct table_item_layers *old)
+{
+  if (!old)
+    return NULL;
+
+  struct table_item_layers *new = xmalloc (sizeof *new);
+  *new = (struct table_item_layers) {
+    .layers = xnmalloc (old->n_layers, sizeof *new->layers),
+    .n_layers = old->n_layers,
+    .style = table_area_style_clone (NULL, old->style),
+  };
+  for (size_t i = 0; i < new->n_layers; i++)
+    table_item_layer_copy (&new->layers[i], &old->layers[i]);
+  return new;
+}
+
+void
+table_item_layers_destroy (struct table_item_layers *layers)
+{
+  if (layers)
+    {
+      for (size_t i = 0; i < layers->n_layers; i++)
+        table_item_layer_uninit (&layers->layers[i]);
+      free (layers->layers);
+      table_area_style_free (layers->style);
+      free (layers);
+    }
+}
+
 /* Initializes ITEM as a table item for rendering TABLE.  The new table item
-   initially has the specified TITLE and CAPTION, which may each be NULL.  The
-   caller retains ownership of TITLE and CAPTION. */
+   initially has the specified TITLE, CAPTION, and NOTES, which may each be
+   NULL.  The caller retains ownership of TITLE, CAPTION, and NOTES. */
 struct table_item *
-table_item_create (struct table *table, const char *title, const char *caption)
+table_item_create (struct table *table, const char *title, const char *caption,
+                   const char *notes)
 {
   struct table_item *item = xmalloc (sizeof *item);
-  output_item_init (&item->output_item, &table_item_class);
-  item->table = table;
-  item->title = table_item_text_create (title);
-  item->layers = NULL;
-  item->caption = table_item_text_create (caption);
+  *item = (struct table_item) {
+    .output_item = OUTPUT_ITEM_INITIALIZER (&table_item_class),
+    .table = table,
+    .title = table_item_text_create (title),
+    .caption = table_item_text_create (caption),
+    .notes = notes ? xstrdup (notes) : NULL,
+  };
   return item;
 }
 
@@ -116,7 +171,7 @@ table_item_set_title (struct table_item *item,
 
 /* Returns ITEM's layers, which will be a null pointer if no layers have been
    set. */
-const struct table_item_text *
+const struct table_item_layers *
 table_item_get_layers (const struct table_item *item)
 {
   return item->layers;
@@ -129,11 +184,11 @@ table_item_get_layers (const struct table_item *item)
    This function may only be used on a table_item that is unshared. */
 void
 table_item_set_layers (struct table_item *item,
-                      const struct table_item_text *layers)
+                       const struct table_item_layers *layers)
 {
   assert (!table_item_is_shared (item));
-  table_item_text_destroy (item->layers);
-  item->layers = table_item_text_clone (layers);
+  table_item_layers_destroy (item->layers);
+  item->layers = table_item_layers_clone (layers);
 }
 
 /* Returns ITEM's caption, which is a null pointer if no caption has been
@@ -158,6 +213,26 @@ table_item_set_caption (struct table_item *item,
   item->caption = table_item_text_clone (caption);
 }
 
+/* Returns ITEM's notes, which is a null pointer if ITEM has no notes. */
+const char *
+table_item_get_notes (const struct table_item *item)
+{
+  return item->notes;
+}
+
+/* Sets ITEM's notes to NOTES, replacing any previous notes.  Specify NULL for
+   NOTES to clear any notes from ITEM.  The caller retains ownership of
+   NOTES.
+
+   This function may only be used on a table_item that is unshared.*/
+void
+table_item_set_notes (struct table_item *item, const char *notes)
+{
+  assert (!table_item_is_shared (item));
+  free (item->notes);
+  item->notes = notes ? xstrdup (notes) : NULL;
+}
+
 /* Submits TABLE_ITEM to the configured output drivers, and transfers ownership
    to the output subsystem. */
 void
@@ -166,18 +241,30 @@ table_item_submit (struct table_item *table_item)
   output_submit (&table_item->output_item);
 }
 \f
+static const char *
+table_item_get_label (const struct output_item *output_item)
+{
+  const struct table_item *item = to_table_item (output_item);
+  return (item->title && item->title->content
+          ? item->title->content
+          : _("Table"));
+}
+
 static void
 table_item_destroy (struct output_item *output_item)
 {
   struct table_item *item = to_table_item (output_item);
   table_item_text_destroy (item->title);
-  table_item_text_destroy (item->layers);
   table_item_text_destroy (item->caption);
+  table_item_layers_destroy (item->layers);
+  free (item->notes);
+  pivot_table_unref (item->pt);
   table_unref (item->table);
   free (item);
 }
 
 const struct output_item_class table_item_class =
   {
+    table_item_get_label,
     table_item_destroy,
   };