-/* PSPP - computes sample statistics.
- Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+ Copyright (C) 1997, 1998, 1999, 2000, 2009, 2013, 2014 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 the Free Software Foundation; either version 2 of the
- License, or (at your option) any later version.
+ 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
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- 02110-1301, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
-#if !tab_h
-#define tab_h 1
+#ifndef OUTPUT_TABLE_H
+#define OUTPUT_TABLE_H 1
-#include <limits.h>
-#include <libpspp/str.h>
+/* Tables.
-/* Cell options. */
-enum
+. A table is a rectangular grid of cells. Cells can be joined to form larger
+ cells. Rows and columns can be separated by rules of various types. Rows
+ at the top and bottom of a table and columns at the left and right edges of
+ a table can be designated as headers, which means that if the table must be
+ broken across more than one page, those rows or columns are repeated on each
+ page.
+
+ Every table is an instance of a particular table class that is responsible
+ for keeping track of cell data. By far the most common table class is
+ struct tab_table (see output/tab.h). This header also declares some other
+ kinds of table classes, near the end of the file.
+
+ A table is not itself an output_item, and thus a table cannot by itself be
+ used for output, but they can be embedded inside struct table_item (see
+ table-item.h) for that purpose. */
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stddef.h>
+
+struct casereader;
+struct fmt_spec;
+struct pool;
+struct table_item;
+struct variable;
+
+/* A table axis.
+
+ Many table-related declarations use 2-element arrays in place of "x" and "y"
+ variables. This reduces code duplication significantly, because much table
+ code treats rows and columns the same way.
+
+ A lot of code that uses these enumerations assumes that the two values are 0
+ and 1, so don't change them to other values. */
+enum table_axis
{
- TAB_NONE = 0,
+ TABLE_HORZ,
+ TABLE_VERT
+#define TABLE_N_AXES 2
+ };
- TAB_ALIGN_MASK = 03, /* Alignment mask. */
- TAB_RIGHT = 00, /* Right justify. */
- TAB_LEFT = 01, /* Left justify. */
- TAB_CENTER = 02, /* Center. */
+struct cell_color
+ {
+ uint8_t alpha, r, g, b;
+ };
- /* Cell types. */
- TAB_JOIN = 004, /* Joined cell. */
- TAB_EMPTY = 010, /* Empty cell. */
+#define CELL_COLOR(r, g, b) { 255, r, g, b }
+#define CELL_COLOR_BLACK CELL_COLOR (0, 0, 0)
+#define CELL_COLOR_WHITE CELL_COLOR (255, 255, 255)
- /* Flags. */
- TAB_EMPH = 020, /* Emphasize cell contents. */
- TAB_FIX = 040, /* Use fixed font. */
+static inline bool
+cell_color_equal (const struct cell_color *a, const struct cell_color *b)
+{
+ return a->alpha == b->alpha && a->r == b->r && a->g == b->g && a->b == b->b;
+}
+
+void cell_color_dump (const struct cell_color *);
+
+enum table_stroke
+ {
+ TABLE_STROKE_NONE,
+ TABLE_STROKE_SOLID,
+ TABLE_STROKE_DASHED,
+ TABLE_STROKE_THICK,
+ TABLE_STROKE_THIN,
+ TABLE_STROKE_DOUBLE,
+ TABLE_N_STROKES,
};
-/* Line styles. */
-enum
+const char *table_stroke_to_string (enum table_stroke);
+
+struct table_border_style
{
- TAL_0 = 0, /* No line. */
- TAL_1 = 1, /* Single line. */
- TAL_2 = 2, /* Double line. */
- TAL_GAP = 3, /* Spacing but no line. */
- TAL_COUNT, /* Number of line styles. */
+ enum table_stroke stroke;
+ struct cell_color color;
};
-/* Column styles. Must correspond to SOM_COL_*. */
-enum
+#define TABLE_BORDER_STYLE_INITIALIZER { TABLE_STROKE_SOLID, CELL_COLOR_BLACK }
+
+enum table_halign
{
- TAB_COL_NONE, /* No columns. */
- TAB_COL_DOWN /* Columns down first. */
+ TABLE_HALIGN_RIGHT,
+ TABLE_HALIGN_LEFT,
+ TABLE_HALIGN_CENTER,
+ TABLE_HALIGN_MIXED,
+ TABLE_HALIGN_DECIMAL
};
-/* Joined cell. */
-struct tab_joined_cell
+const char *table_halign_to_string (enum table_halign);
+
+enum table_valign
{
- int x1, y1;
- int x2, y2;
- int hit;
- struct substring contents;
+ TABLE_VALIGN_TOP,
+ TABLE_VALIGN_CENTER,
+ TABLE_VALIGN_BOTTOM,
};
-struct outp_driver;
-struct tab_table;
-typedef void tab_dim_func (struct tab_table *, struct outp_driver *);
+const char *table_valign_to_string (enum table_valign);
-/* A table. */
-struct tab_table
+struct cell_style
+ {
+ enum table_halign halign;
+ enum table_valign valign;
+ double decimal_offset; /* In 1/96" units. */
+ char decimal_char; /* Either '.' or ','. */
+ int margin[TABLE_N_AXES][2]; /* In 1/96" units. */
+ };
+
+#define CELL_STYLE_INITIALIZER { CELL_STYLE_INITIALIZER__ }
+#define CELL_STYLE_INITIALIZER__ \
+ .margin = { [TABLE_HORZ][0] = 8, [TABLE_HORZ][1] = 11, \
+ [TABLE_VERT][0] = 1, [TABLE_VERT][1] = 1 }
+
+void cell_style_dump (const struct cell_style *);
+
+struct font_style
+ {
+ bool bold, italic, underline, markup;
+ struct cell_color fg[2], bg[2];
+ char *typeface;
+ int size;
+ };
+
+#define FONT_STYLE_INITIALIZER { FONT_STYLE_INITIALIZER__ }
+#define FONT_STYLE_INITIALIZER__ \
+ .fg = { [0] = CELL_COLOR_BLACK, [1] = CELL_COLOR_BLACK}, \
+ .bg = { [0] = CELL_COLOR_WHITE, [1] = CELL_COLOR_WHITE},
+
+void font_style_copy (struct font_style *, const struct font_style *);
+void font_style_uninit (struct font_style *);
+void font_style_dump (const struct font_style *);
+
+struct area_style
{
- struct pool *container;
-
- /* Contents. */
- int col_style; /* Columns: One of TAB_COL_*. */
- int col_group; /* Number of rows per column group. */
- char *title; /* Table title. */
- unsigned flags; /* SOMF_*. */
- int nc, nr; /* Number of columns, rows. */
- int cf; /* Column factor for indexing purposes. */
- int l, r, t, b; /* Number of header rows on each side. */
- struct substring *cc; /* Cell contents; substring *[nr][nc]. */
- unsigned char *ct; /* Cell types; unsigned char[nr][nc]. */
- unsigned char *rh; /* Horiz rules; unsigned char[nr+1][nc]. */
- unsigned char *rv; /* Vert rules; unsigned char[nr][nc+1]. */
- tab_dim_func *dim; /* Calculates cell widths and heights. */
-
- /* Calculated during output. */
- int *w; /* Column widths; [nc]. */
- int *h; /* Row heights; [nr]. */
- int *hrh; /* Heights of horizontal rules; [nr+1]. */
- int *wrv; /* Widths of vertical rules; [nc+1]. */
- int wl, wr, ht, hb; /* Width/height of header rows/columns. */
-
- /* Editing info. */
- int col_ofs, row_ofs; /* X and Y offsets. */
+ struct cell_style cell_style;
+ struct font_style font_style;
};
-/* Number of rows in TABLE. */
-#define tab_nr(TABLE) ((TABLE)->nr)
-
-/* Number of columns in TABLE. */
-#define tab_nc(TABLE) ((TABLE)->nc)
-
-/* Number of left header columns in TABLE. */
-#define tab_l(TABLE) ((TABLE)->l)
-
-/* Number of right header columns in TABLE. */
-#define tab_r(TABLE) ((TABLE)->r)
-
-/* Number of top header rows in TABLE. */
-#define tab_t(TABLE) ((TABLE)->t)
-
-/* Number of bottom header rows in TABLE. */
-#define tab_b(TABLE) ((TABLE)->b)
-
-/* Tables. */
-struct tab_table *tab_create (int nc, int nr, int reallocable);
-void tab_destroy (struct tab_table *);
-void tab_resize (struct tab_table *, int nc, int nr);
-void tab_realloc (struct tab_table *, int nc, int nr);
-void tab_headers (struct tab_table *, int l, int r, int t, int b);
-void tab_columns (struct tab_table *, int style, int group);
-void tab_title (struct tab_table *, const char *, ...)
- PRINTF_FORMAT (2, 3);
-void tab_flags (struct tab_table *, unsigned);
-void tab_submit (struct tab_table *);
-
-/* Dimensioning. */
-tab_dim_func tab_natural_dimensions;
-int tab_natural_width (struct tab_table *t, struct outp_driver *d, int c);
-int tab_natural_height (struct tab_table *t, struct outp_driver *d, int r);
-void tab_dim (struct tab_table *, tab_dim_func *);
-
-/* Rules. */
-void tab_hline (struct tab_table *, int style, int x1, int x2, int y);
-void tab_vline (struct tab_table *, int style, int x, int y1, int y2);
-void tab_box (struct tab_table *, int f_h, int f_v, int i_h, int i_v,
- int x1, int y1, int x2, int y2);
-
-/* Text options, passed in the `opt' argument. */
+#define AREA_STYLE_INITIALIZER { AREA_STYLE_INITIALIZER__ }
+#define AREA_STYLE_INITIALIZER__ \
+ .cell_style = CELL_STYLE_INITIALIZER, \
+ .font_style = FONT_STYLE_INITIALIZER
+
+struct area_style *area_style_clone (struct pool *, const struct area_style *);
+void area_style_copy (struct area_style *, const struct area_style *);
+void area_style_uninit (struct area_style *);
+void area_style_free (struct area_style *);
+
+/* Properties of a table cell. */
enum
{
- TAT_NONE = 0, /* No options. */
- TAT_PRINTF = 0x0100, /* Format the text string with sprintf. */
- TAT_TITLE = 0x0200 | TAB_EMPH, /* Title attributes. */
- TAT_NOWRAP = 0x0800 /* No text wrap (tab_output_text() only). */
+ TAB_NONE = 0,
+ TAB_FIX = 1 << 1, /* Use fixed font. */
+ TAB_MARKUP = 1 << 2, /* Text contains Pango markup. */
+ TAB_NUMERIC = 1 << 3, /* Cell contents are numeric. */
+ TAB_ROTATE = 1 << 4, /* Rotate cell contents 90 degrees. */
+
+ /* Bits with values (1 << TAB_FIRST_AVAILABLE) and higher are
+ not used, so they are available for subclasses to use as
+ they wish. */
+ TAB_FIRST_AVAILABLE = 5
};
-/* Cells. */
-struct fmt_spec;
-union value;
-void tab_value (struct tab_table *, int c, int r, unsigned char opt,
- const union value *, const struct fmt_spec *);
-void tab_float (struct tab_table *, int c, int r, unsigned char opt,
- double v, int w, int d);
-void tab_text (struct tab_table *, int c, int r, unsigned opt,
- const char *, ...)
- PRINTF_FORMAT (5, 6);
-void tab_joint_text (struct tab_table *, int x1, int y1, int x2, int y2,
- unsigned opt, const char *, ...)
- PRINTF_FORMAT (7, 8);
-
-/* Cell low-level access. */
-#define tab_alloc(TABLE, AMT) pool_alloc ((TABLE)->container, (AMT))
-void tab_raw (struct tab_table *, int c, int r, unsigned opt,
- struct substring *);
-
-/* Editing. */
-void tab_offset (struct tab_table *, int col, int row);
-void tab_next_row (struct tab_table *);
-
-/* Current row/column offset. */
-#define tab_row(TABLE) ((TABLE)->row_ofs)
-#define tab_col(TABLE) ((TABLE)->col_ofs)
-
-/* Simple output. */
-void tab_output_text (int options, const char *string, ...)
- PRINTF_FORMAT (2, 3);
-
-/* Embedding the command name in the output. */
-void tab_set_command_name (const char *);
-
-#endif /* tab_h */
+/* Styles for the rules around table cells. */
+enum
+ {
+ TAL_NONE = TABLE_STROKE_NONE,
+#define TAL_0 TAL_NONE
+ TAL_SOLID = TABLE_STROKE_SOLID,
+#define TAL_1 TAL_SOLID
+ TAL_DASHED = TABLE_STROKE_DASHED,
+ TAL_THICK = TABLE_STROKE_THICK,
+ TAL_THIN = TABLE_STROKE_THIN,
+ TAL_DOUBLE = TABLE_STROKE_DOUBLE,
+#define TAL_2 TAL_DOUBLE
+ };
+
+/* Given line styles A and B (each one of the TAL_* enumeration constants
+ above), returns a line style that "combines" them, that is, that gives a
+ reasonable line style choice for a rule for different reasons should have
+ both styles A and B. */
+static inline int table_rule_combine (int a, int b)
+{
+ return a > b ? a : b;
+}
+
+/* A table. */
+struct table
+ {
+ const struct table_class *klass;
+
+ /* Table size.
+
+ n[TABLE_HORZ]: Number of columns.
+ n[TABLE_VERT]: Number of rows. */
+ int n[TABLE_N_AXES];
+
+ /* Table headers.
+
+ Rows at the top and bottom of a table and columns at the left and right
+ edges of a table can be designated as headers. If the table must be
+ broken across more than one page for output, headers rows and columns
+ are repeated on each page.
+
+ h[TABLE_HORZ][0]: Left header columns.
+ h[TABLE_HORZ][1]: Right header columns.
+ h[TABLE_VERT][0]: Top header rows.
+ h[TABLE_VERT][1]: Bottom header rows. */
+ int h[TABLE_N_AXES][2];
+
+ /* Reference count. A table may be shared between multiple owners,
+ indicated by a reference count greater than 1. When this is the case,
+ the table must not be modified. */
+ int ref_cnt;
+ };
+/* Reference counting. */
+struct table *table_ref (const struct table *);
+void table_unref (struct table *);
+bool table_is_shared (const struct table *);
+
+/* Returns the number of columns or rows, respectively, in T. */
+static inline int table_nc (const struct table *t)
+ { return t->n[TABLE_HORZ]; }
+static inline int table_nr (const struct table *t)
+ { return t->n[TABLE_VERT]; }
+
+/* Returns the number of left, right, top, or bottom headers, respectively, in
+ T. */
+static inline int table_hl (const struct table *t)
+ { return t->h[TABLE_HORZ][0]; }
+static inline int table_hr (const struct table *t)
+ { return t->h[TABLE_HORZ][1]; }
+static inline int table_ht (const struct table *t)
+ { return t->h[TABLE_VERT][0]; }
+static inline int table_hb (const struct table *t)
+ { return t->h[TABLE_VERT][1]; }
+
+/* Set headers. */
+void table_set_hl (struct table *, int hl);
+void table_set_hr (struct table *, int hr);
+void table_set_ht (struct table *, int ht);
+void table_set_hb (struct table *, int hb);
+
+#endif /* output/table.h */
projects / pspp / blobdiff