/* 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"
-/* An item of contents within a table cell. */
-struct cell_contents
+struct pool;
+struct string;
+
+struct footnote
{
- unsigned int options; /* TAB_*. */
+ size_t idx;
+ char *content;
+ char *marker;
+ struct cell_style *style;
+ };
- /* Exactly one of these must be nonnull. */
- char *text; /* A paragraph of text. */
- struct table *table; /* A table nested within the cell. */
+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[2], bg[2];
+ int margin[TABLE_N_AXES][2];
+ char *typeface;
+ int size;
+ bool bold, italic, underline;
+ };
+
+#define CELL_STYLE_INITIALIZER \
+ { \
+ .fg = { [0] = CELL_COLOR_BLACK, [1] = CELL_COLOR_BLACK}, \
+ .bg = { [0] = CELL_COLOR_WHITE, [1] = CELL_COLOR_WHITE}, \
+ .margin = { [TABLE_HORZ][0] = 8, [TABLE_HORZ][1] = 11, \
+ [TABLE_VERT][0] = 1, [TABLE_VERT][1] = 1 }, \
+ .typeface = NULL, \
+ .size = 0, \
+ .bold = false, \
+ .italic = false, \
+ .underline = false, \
+ }
+
+struct cell_style *cell_style_clone (struct pool *, const struct cell_style *);
+void cell_style_free (struct cell_style *);
+
/* A cell in a table. */
struct table_cell
{
or both. */
int d[TABLE_N_AXES][2];
- /* The cell's contents.
+ unsigned int options; /* TAB_*. */
+ char *text; /* A paragraph of text. */
- 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.
+ /* Optional footnote(s). */
+ const struct footnote **footnotes;
+ size_t n_footnotes;
- '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);
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
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.
/* 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 */