/* 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
- {
- unsigned int options; /* TAB_*. */
+struct pool;
+struct string;
- /* Exactly one of these must be nonnull. */
- char *text; /* A paragraph of text. */
- struct table_item *table; /* A table nested within the cell. */
+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. */
or both. */
int d[TABLE_N_AXES][2];
- /* 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.
+ unsigned int options; /* TAB_*. */
+ char *text; /* A paragraph of text. */
- '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;
+ /* Optional footnote(s). */
+ const struct footnote **footnotes;
+ size_t n_footnotes;
- /* Called to free the cell's data, if nonnull. */
- void (*destructor) (void *destructor_aux);
- void *destructor_aux;
+ const struct area_style *style;
};
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
struct table_class
{
- /* Frees TABLE.
-
- The table class may assume that any cells that were retrieved by calling
- the 'get_cell' function have been freed (by calling their destructors)
- before this function is called. */
+ /* Frees TABLE. */
void (*destroy) (struct table *table);
/* Initializes CELL with the contents of the table cell at column X and row
- Y within TABLE. All members of CELL must be initialized, except that if
- 'destructor' is set to a null pointer, then 'destructor_aux' need not be
- initialized. The 'contents' member of CELL must be set to a nonnull
- value.
+ Y within TABLE. All members of CELL must be initialized. The
+ 'contents' member of CELL must be set to a nonnull value.
The table class must allow any number of cells in the table to be
retrieved simultaneously; that is, TABLE must not assume that a given
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);
-
- /* This function is optional and most table classes will not implement it.
-
- If provided, this function must take ownership of A and B and return a
- table that consists of tables A and B "pasted together", that is, a
- table whose size is the sum of the sizes of A and B along the axis
- specified by ORIENTATION. A and B will ordinarily have the same size
- along the axis opposite ORIENTATION; no particular handling of tables
- that have different sizes along that axis is required.
-
- The handling of rules at the seam between A and B is not specified, but
- table_rule_combine() is one reasonable way to do it.
-
- Called only if neither A and B is shared (as returned by
- table_is_shared()).
-
- Called if A or B or both is of the class defined by this table class.
- That is, the implementation must be prepared to deal with the case where
- A or B is not the ordinarily expected table class.
-
- This function may return a null pointer if it cannot implement the paste
- operation, in which case the caller will use a fallback
- implementation.
-
- This function is used to implement table_paste(). */
- struct table *(*paste) (struct table *a, struct table *b,
- enum table_axis orientation);
-
- /* This function is optional and most table classes will not implement it.
-
- If provided, this function must take ownership of TABLE and return a new
- table whose contents are the TABLE's rows RECT[TABLE_VERT][0] through
- 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()).
-
- This function may return a null pointer if it cannot implement the
- select operation, in which case the caller will use a fallback
- implementation.
-
- This function is used to implement table_select(). */
- struct table *(*select) (struct table *table, int rect[TABLE_N_AXES][2]);
+ enum table_axis axis, int x, int y,
+ struct cell_color *color);
};
void table_init (struct table *, const struct table_class *);
/* 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 */
projects / pspp / blobdiff