output: Expand footnote support.
[pspp] / src / output / table-item.h
index 855324416fa066cd73d6c03896567071e4279d7a..4e070ddabf778ef001eadb22b412971842efd044 100644 (file)
 #include "libpspp/compiler.h"
 #include "output/output-item.h"
 
+/* Title or caption in a table item. */
+struct table_item_text
+  {
+    char *content;
+    const struct footnote **footnotes;
+    size_t n_footnotes;
+  };
+
+struct table_item_text *table_item_text_create (const char *);
+struct table_item_text *table_item_text_clone (const struct table_item_text *);
+void table_item_text_destroy (struct table_item_text *);
+
 /* A table item.
 
    The members of struct table_item should not be accessed directly.  Use one
    of the accessor functions defined below. */
 struct table_item
   {
-    struct output_item output_item; /* Superclass. */
-    struct table *table;        /* The table to be rendered. */
-    char *title;                /* May be null if there is no title. */
-    char *caption;              /* May be null if there is no caption. */
+    struct output_item output_item;  /* Superclass. */
+    struct table *table;             /* The table to be rendered. */
+    struct table_item_text *title;   /* Null if there is no title. */
+    struct table_item_text *caption; /* Null if there is no caption. */
   };
 
 struct table_item *table_item_create (struct table *, const char *title,
@@ -45,11 +57,14 @@ struct table_item *table_item_create (struct table *, const char *title,
 
 const struct table *table_item_get_table (const struct table_item *);
 
-const char *table_item_get_title (const struct table_item *);
-void table_item_set_title (struct table_item *, const char *);
+const struct table_item_text *table_item_get_title (const struct table_item *);
+void table_item_set_title (struct table_item *,
+                           const struct table_item_text *);
 
-const char *table_item_get_caption (const struct table_item *);
-void table_item_set_caption (struct table_item *, const char *);
+const struct table_item_text *table_item_get_caption (
+  const struct table_item *);
+void table_item_set_caption (struct table_item *,
+                             const struct table_item_text *);
 \f
 /* This boilerplate for table_item, a subclass of output_item, was
    autogenerated by mk-class-boilerplate. */