output: Implement styling for footnotes.

[pspp] / src / output / table-provider.h

diff --git a/src/output/table-provider.h b/src/output/table-provider.h
index 5dbf99b15ad3e6303357a061fd7adc390932eee3..2a3a17c9daeec45e4c8461ce6bcd2255b2cc8b68 100644 (file)
--- a/src/output/table-provider.h
+++ b/src/output/table-provider.h
@@ -17,8 +17,19 @@
 #ifndef OUTPUT_TABLE_PROVIDER
 #define OUTPUT_TABLE_PROVIDER 1
 
+#include <stdint.h>
 #include "output/table.h"
 
+struct string;
+
+struct footnote
+  {
+    size_t idx;
+    char *content;
+    char *marker;
+    struct cell_style *style;
+  };
+
 /* An item of contents within a table cell. */
 struct cell_contents
   {
@@ -26,10 +37,53 @@ struct cell_contents
     char *text;                 /* A paragraph of text. */
 
     /* Optional footnote(s). */
-    char **footnotes;
+    const struct footnote **footnotes;
     size_t n_footnotes;
   };
 
+void cell_contents_format_footnote_markers (const struct cell_contents *,
+                                            struct string *);
+
+struct cell_color
+  {
+    uint8_t r, g, b;
+  };
+
+#define CELL_COLOR(r, g, b) (struct cell_color) { r, g, b }
+#define CELL_COLOR_BLACK CELL_COLOR (0, 0, 0)
+#define CELL_COLOR_WHITE CELL_COLOR (255, 255, 255)
+
+static inline bool
+cell_color_equal (const struct cell_color *a, const struct cell_color *b)
+{
+  return a->r == b->r && a->g == b->g && a->b == b->b;
+}
+
+struct cell_style
+  {
+    struct cell_color fg, bg;
+    int margin[TABLE_N_AXES][2];
+    char *font;
+    int font_size;
+    bool bold, italic, underline;
+  };
+
+#define CELL_STYLE_INITIALIZER                                  \
+    {                                                           \
+      .fg = CELL_COLOR_BLACK,                                   \
+      .bg = CELL_COLOR_WHITE,                                   \
+      .margin = { [TABLE_HORZ][0] = 8, [TABLE_HORZ][1] = 11,    \
+                  [TABLE_VERT][0] = 1, [TABLE_VERT][1] = 1 },   \
+      .font = NULL,                                             \
+      .font_size = 0,                                           \
+      .bold = false,                                            \
+      .italic = false,                                          \
+      .underline = false,                                       \
+    }
+
+struct cell_style *cell_style_clone (const struct cell_style *);
+void cell_style_free (struct cell_style *);
+
 /* A cell in a table. */
 struct table_cell
   {
@@ -63,6 +117,8 @@ struct table_cell
     size_t n_contents;
     struct cell_contents inline_contents;
 
+    const struct cell_style *style;
+
     /* Called to free the cell's data, if nonnull. */
     void (*destructor) (void *destructor_aux);
     void *destructor_aux;
@@ -137,7 +193,8 @@ struct table_class
        See table_get_rule() in table.c for a detailed explanation of the
        meaning of AXIS and X and Y, including a diagram. */
     int (*get_rule) (const struct table *table,
-                     enum table_axis axis, int x, int y);
+                     enum table_axis axis, int x, int y,
+                     struct cell_color *color);
 
     /* This function is optional and most table classes will not implement it.
 
@@ -193,6 +250,9 @@ void table_set_nr (struct table *, int nr);
 /* For use primarily by output drivers. */
 
 void table_get_cell (const struct table *, int x, int y, struct table_cell *);
-int table_get_rule (const struct table *, enum table_axis, int x, int y);
+int table_get_rule (const struct table *, enum table_axis, int x, int y,
+                    struct cell_color *);
+size_t table_collect_footnotes (const struct table_item *,
+                                const struct footnote ***);
 
 #endif /* output/table-provider.h */