output: Add support for fonts.

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

diff --git a/src/output/table-provider.h b/src/output/table-provider.h
index 6d1a415618e18529d8ab029a79893fb5a6b321a0..ae7f77d420b40cf7fa364cf2c87431f0c119c7cd 100644 (file)
--- a/src/output/table-provider.h
+++ b/src/output/table-provider.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997, 1998, 1999, 2000, 2009 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
@@ -17,7 +17,71 @@
 #ifndef OUTPUT_TABLE_PROVIDER
 #define OUTPUT_TABLE_PROVIDER 1
 
-#include <output/table.h>
+#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_*. */
+    char *text;                 /* A paragraph of text. */
+
+    /* Optional footnote(s). */
+    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
@@ -39,8 +103,20 @@ struct table_cell
        or both. */
     int d[TABLE_N_AXES][2];
 
-    const char *contents;       /* Text string contents. */
-    unsigned int options;       /* TAB_* values. */
+    /* The cell's contents.
+
+       Most table cells contain only one item (a paragraph of text), but cells
+       are allowed to be empty (n_contents == 0) or contain a nested table, or
+       multiple items.
+
+       'inline_contents' provides a place to store a single item to handle the
+       common case.
+    */
+    const struct cell_contents *contents;
+    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);
@@ -152,7 +228,7 @@ struct table_class
        RECT[TABLE_VERT][1], exclusive, and the TABLE's columns
        RECT[TABLE_HORZ][0] through RECT[TABLE_HORZ][1].
 
-       Called only if TABLE is not shared (as returned by table_is_shared()).p
+       Called only if TABLE is not shared (as returned by table_is_shared()).
 
        This function may return a null pointer if it cannot implement the
        select operation, in which case the caller will use a fallback
@@ -173,5 +249,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 */