output: Add support for colors in cells.
[pspp] / src / output / table-provider.h
index b64410c22703b33f7f4b98bc49a624f016d0dfbc..9a790612287033a2db29fcfe269d62a6b54ae36c 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011, 2013, 2014 Free Software Foundation, Inc.
+   Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011, 2013, 2014, 2018 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 #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;
+  };
+
 /* An item of contents within a table cell. */
 struct cell_contents
   {
     unsigned int options;       /* TAB_*. */
-
-    /* Exactly one of these must be nonnull. */
     char *text;                 /* A paragraph of text. */
-    struct table_item *table;   /* A table nested within the cell. */
 
     /* 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;
+  };
+
 /* A cell in a table. */
 struct table_cell
   {
@@ -66,6 +96,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;
@@ -197,5 +229,7 @@ void table_set_nr (struct table *, int nr);
 
 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);
+size_t table_collect_footnotes (const struct table_item *,
+                                const struct footnote ***);
 
 #endif /* output/table-provider.h */