output: Support decimal and mixed alignment,
[pspp] / src / output / table-provider.h
index 36a666534fe42486fa1350f1d0775f0ca1bf308e..ef1f6ea5b916da933f179bf8e3178f856a9129e8 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011 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 pool;
+struct string;
+
+enum table_halign table_halign_interpret (enum table_halign, bool numeric);
+
+struct footnote
+  {
+    size_t idx;
+    char *content;
+    char *marker;
+    struct area_style *style;
+  };
+
 /* A cell in a table. */
 struct table_cell
   {
@@ -39,8 +53,14 @@ struct table_cell
        or both. */
     int d[TABLE_N_AXES][2];
 
-    const char *contents;       /* Text string contents. */
-    unsigned int options;       /* TAB_* values. */
+    unsigned int options;       /* TAB_*. */
+    char *text;                 /* A paragraph of text. */
+
+    /* Optional footnote(s). */
+    const struct footnote **footnotes;
+    size_t n_footnotes;
+
+    const struct area_style *style;
 
     /* Called to free the cell's data, if nonnull. */
     void (*destructor) (void *destructor_aux);
@@ -49,6 +69,9 @@ struct table_cell
 
 void table_cell_free (struct table_cell *);
 
+void table_cell_format_footnote_markers (const struct table_cell *,
+                                         struct string *);
+
 /* Returns the number of columns that CELL spans.  This is 1 for an ordinary
    cell and greater than one for a cell that joins multiple columns. */
 static inline int
@@ -116,7 +139,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.
 
@@ -152,7 +176,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
@@ -172,6 +196,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 */