pintos-os.org Git - pspp/blob - src/output/table-provider.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2009, 2011, 2013, 2014 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #ifndef OUTPUT_TABLE_PROVIDER
  18 #define OUTPUT_TABLE_PROVIDER 1
  19
  20 #include "output/table.h"
  21
  22 /* An item of contents within a table cell. */
  23 struct cell_contents
  24   {
  25     unsigned int options;       /* TAB_*. */
  26
  27     /* Exactly one of these must be nonnull. */
  28     char *text;                 /* A paragraph of text. */
  29     struct table_item *table;   /* A table nested within the cell. */
  30
  31     /* Optional footnote(s). */
  32     char **footnotes;
  33     size_t n_footnotes;
  34   };
  35
  36 /* A cell in a table. */
  37 struct table_cell
  38   {
  39     /* Occupied table region.
  40
  41        d[TABLE_HORZ][0] is the leftmost column.
  42        d[TABLE_HORZ][1] is the rightmost column, plus 1.
  43        d[TABLE_VERT][0] is the top row.
  44        d[TABLE_VERT][1] is the bottom row, plus 1.
  45
  46        For an ordinary cell:
  47            d[TABLE_HORZ][1] == d[TABLE_HORZ][0] + 1
  48        and d[TABLE_VERT][1] == d[TABLE_VERT][0] + 1
  49
  50        For a joined cell:
  51           d[TABLE_HORZ][1] > d[TABLE_HORZ][0] + 1
  52        or d[TABLE_VERT][1] > d[TABLE_VERT][0] + 1
  53        or both. */
  54     int d[TABLE_N_AXES][2];
  55
  56     /* The cell's contents.
  57
  58        Most table cells contain only one item (a paragraph of text), but cells
  59        are allowed to be empty (n_contents == 0) or contain a nested table, or
  60        multiple items.
  61
  62        'inline_contents' provides a place to store a single item to handle the
  63        common case.
  64     */
  65     const struct cell_contents *contents;
  66     size_t n_contents;
  67     struct cell_contents inline_contents;
  68
  69     /* Called to free the cell's data, if nonnull. */
  70     void (*destructor) (void *destructor_aux);
  71     void *destructor_aux;
  72   };
  73
  74 void table_cell_free (struct table_cell *);
  75
  76 /* Returns the number of columns that CELL spans.  This is 1 for an ordinary
  77    cell and greater than one for a cell that joins multiple columns. */
  78 static inline int
  79 table_cell_colspan (const struct table_cell *cell)
  80 {
  81   return cell->d[TABLE_HORZ][1] - cell->d[TABLE_HORZ][0];
  82 }
  83
  84 /* Returns the number of rows that CELL spans.  This is 1 for an ordinary cell
  85    and greater than one for a cell that joins multiple rows. */
  86 static inline int
  87 table_cell_rowspan (const struct table_cell *cell)
  88 {
  89   return cell->d[TABLE_VERT][1] - cell->d[TABLE_VERT][0];
  90 }
  91
  92 /* Returns true if CELL is a joined cell, that is, if it spans multiple rows
  93    or columns.  Otherwise, returns false. */
  94 static inline bool
  95 table_cell_is_joined (const struct table_cell *cell)
  96 {
  97   return table_cell_colspan (cell) > 1 || table_cell_rowspan (cell) > 1;
  98 }
  99 \f
 100 /* Declarations to allow defining table classes. */
 101
 102 struct table_class
 103   {
 104     /* Frees TABLE.
 105
 106        The table class may assume that any cells that were retrieved by calling
 107        the 'get_cell' function have been freed (by calling their destructors)
 108        before this function is called. */
 109     void (*destroy) (struct table *table);
 110
 111     /* Initializes CELL with the contents of the table cell at column X and row
 112        Y within TABLE.  All members of CELL must be initialized, except that if
 113        'destructor' is set to a null pointer, then 'destructor_aux' need not be
 114        initialized.  The 'contents' member of CELL must be set to a nonnull
 115        value.
 116
 117        The table class must allow any number of cells in the table to be
 118        retrieved simultaneously; that is, TABLE must not assume that a given
 119        cell will be freed before another one is retrieved using 'get_cell'.
 120
 121        The table class must allow joined cells to be retrieved, with identical
 122        contents, using any (X,Y) location inside the cell.
 123
 124        The table class must not allow cells to overlap.
 125
 126        The table class should not allow a joined cell to cross the border
 127        between header rows/columns and the interior of the table.  That is, a
 128        joined cell should be entirely within headers rows and columns or
 129        entirely outside them.
 130
 131        The table class may assume that CELL will be freed before TABLE is
 132        destroyed. */
 133     void (*get_cell) (const struct table *table, int x, int y,
 134                       struct table_cell *cell);
 135
 136     /* Returns one of the TAL_* enumeration constants (declared in
 137        output/table.h) representing a rule running alongside one of the cells
 138        in TABLE.
 139
 140        See table_get_rule() in table.c for a detailed explanation of the
 141        meaning of AXIS and X and Y, including a diagram. */
 142     int (*get_rule) (const struct table *table,
 143                      enum table_axis axis, int x, int y);
 144
 145     /* This function is optional and most table classes will not implement it.
 146
 147        If provided, this function must take ownership of A and B and return a
 148        table that consists of tables A and B "pasted together", that is, a
 149        table whose size is the sum of the sizes of A and B along the axis
 150        specified by ORIENTATION.  A and B will ordinarily have the same size
 151        along the axis opposite ORIENTATION; no particular handling of tables
 152        that have different sizes along that axis is required.
 153
 154        The handling of rules at the seam between A and B is not specified, but
 155        table_rule_combine() is one reasonable way to do it.
 156
 157        Called only if neither A and B is shared (as returned by
 158        table_is_shared()).
 159
 160        Called if A or B or both is of the class defined by this table class.
 161        That is, the implementation must be prepared to deal with the case where
 162        A or B is not the ordinarily expected table class.
 163
 164        This function may return a null pointer if it cannot implement the paste
 165        operation, in which case the caller will use a fallback
 166        implementation.
 167
 168        This function is used to implement table_paste(). */
 169     struct table *(*paste) (struct table *a, struct table *b,
 170                             enum table_axis orientation);
 171
 172     /* This function is optional and most table classes will not implement it.
 173
 174        If provided, this function must take ownership of TABLE and return a new
 175        table whose contents are the TABLE's rows RECT[TABLE_VERT][0] through
 176        RECT[TABLE_VERT][1], exclusive, and the TABLE's columns
 177        RECT[TABLE_HORZ][0] through RECT[TABLE_HORZ][1].
 178
 179        Called only if TABLE is not shared (as returned by table_is_shared()).
 180
 181        This function may return a null pointer if it cannot implement the
 182        select operation, in which case the caller will use a fallback
 183        implementation.
 184
 185        This function is used to implement table_select(). */
 186     struct table *(*select) (struct table *table, int rect[TABLE_N_AXES][2]);
 187   };
 188
 189 void table_init (struct table *, const struct table_class *);
 190
 191 /* Table class implementations can call these functions or just set the
 192    table's n[] and h[][] members directly. */
 193 void table_set_nc (struct table *, int nc);
 194 void table_set_nr (struct table *, int nr);
 195 \f
 196 /* For use primarily by output drivers. */
 197
 198 void table_get_cell (const struct table *, int x, int y, struct table_cell *);
 199 int table_get_rule (const struct table *, enum table_axis, int x, int y);
 200
 201 #endif /* output/table-provider.h */