00f14180433e6e19be5d8a8d9c03c0822509a6c6
[pspp-builds.git] / src / output / table.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or
5    modify it under the terms of the GNU General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful, but
10    WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    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, write to the Free Software
16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17    02110-1301, USA. */
18
19 #if !tab_h
20 #define tab_h 1
21
22 #include <limits.h>
23 #include <libpspp/str.h>
24
25 /* Cell options. */
26 enum
27   {
28     TAB_NONE = 0,
29
30     TAB_ALIGN_MASK = 03,        /* Alignment mask. */
31     TAB_RIGHT = 00,             /* Right justify. */
32     TAB_LEFT = 01,              /* Left justify. */
33     TAB_CENTER = 02,            /* Center. */
34
35     /* Cell types. */
36     TAB_JOIN = 004,             /* Joined cell. */
37     TAB_EMPTY = 010,            /* Empty cell. */
38
39     /* Flags. */
40     TAB_EMPH = 020,             /* Emphasize cell contents. */
41     TAB_FIX = 040,              /* Use fixed font. */
42   };
43
44 /* Line styles. */
45 enum
46   {
47     TAL_0 = 0,                  /* No line. */
48     TAL_1 = 1,                  /* Single line. */
49     TAL_2 = 2,                  /* Double line. */
50     TAL_GAP = 3,                /* Spacing but no line. */
51     TAL_COUNT,                  /* Number of line styles. */
52   };
53
54 /* Column styles.  Must correspond to SOM_COL_*. */
55 enum
56   {
57     TAB_COL_NONE,                       /* No columns. */
58     TAB_COL_DOWN                        /* Columns down first. */
59   };
60
61 /* Joined cell. */
62 struct tab_joined_cell
63   {
64     int x1, y1;
65     int x2, y2;
66     int hit;
67     struct substring contents;
68   };
69
70 struct outp_driver;
71 struct tab_table;
72 typedef void tab_dim_func (struct tab_table *, struct outp_driver *);
73
74 /* A table. */
75 struct tab_table
76   {
77     struct pool *container;
78     
79     /* Contents. */
80     int col_style;              /* Columns: One of TAB_COL_*. */
81     int col_group;              /* Number of rows per column group. */
82     char *title;                /* Table title. */
83     unsigned flags;             /* SOMF_*. */
84     int nc, nr;                 /* Number of columns, rows. */
85     int cf;                     /* Column factor for indexing purposes. */
86     int l, r, t, b;             /* Number of header rows on each side. */
87     struct substring *cc;       /* Cell contents; substring *[nr][nc]. */
88     unsigned char *ct;          /* Cell types; unsigned char[nr][nc]. */
89     unsigned char *rh;          /* Horiz rules; unsigned char[nr+1][nc]. */
90     unsigned char *rv;          /* Vert rules; unsigned char[nr][nc+1]. */
91     tab_dim_func *dim;          /* Calculates cell widths and heights. */
92
93     /* Calculated during output. */
94     int *w;                     /* Column widths; [nc]. */
95     int *h;                     /* Row heights; [nr]. */
96     int *hrh;                   /* Heights of horizontal rules; [nr+1]. */
97     int *wrv;                   /* Widths of vertical rules; [nc+1]. */
98     int wl, wr, ht, hb;         /* Width/height of header rows/columns. */
99
100     /* Editing info. */
101     int col_ofs, row_ofs;       /* X and Y offsets. */
102   };
103
104 /* Number of rows in TABLE. */
105 #define tab_nr(TABLE) ((TABLE)->nr)
106
107 /* Number of columns in TABLE. */
108 #define tab_nc(TABLE) ((TABLE)->nc)
109
110 /* Number of left header columns in TABLE. */
111 #define tab_l(TABLE) ((TABLE)->l)
112
113 /* Number of right header columns in TABLE. */
114 #define tab_r(TABLE) ((TABLE)->r)
115
116 /* Number of top header rows in TABLE. */
117 #define tab_t(TABLE) ((TABLE)->t)
118
119 /* Number of bottom header rows in TABLE. */
120 #define tab_b(TABLE) ((TABLE)->b)
121
122 /* Tables. */
123 struct tab_table *tab_create (int nc, int nr, int reallocable);
124 void tab_destroy (struct tab_table *);
125 void tab_resize (struct tab_table *, int nc, int nr);
126 void tab_realloc (struct tab_table *, int nc, int nr);
127 void tab_headers (struct tab_table *, int l, int r, int t, int b);
128 void tab_columns (struct tab_table *, int style, int group);
129 void tab_title (struct tab_table *, const char *, ...)
130      PRINTF_FORMAT (2, 3);
131 void tab_flags (struct tab_table *, unsigned);
132 void tab_submit (struct tab_table *);
133
134 /* Dimensioning. */
135 tab_dim_func tab_natural_dimensions;
136 int tab_natural_width (struct tab_table *t, struct outp_driver *d, int c);
137 int tab_natural_height (struct tab_table *t, struct outp_driver *d, int r);
138 void tab_dim (struct tab_table *, tab_dim_func *);
139
140 /* Rules. */
141 void tab_hline (struct tab_table *, int style, int x1, int x2, int y);
142 void tab_vline (struct tab_table *, int style, int x, int y1, int y2);
143 void tab_box (struct tab_table *, int f_h, int f_v, int i_h, int i_v,
144               int x1, int y1, int x2, int y2);
145
146 /* Text options, passed in the `opt' argument. */
147 enum
148   {
149     TAT_NONE = 0,               /* No options. */
150     TAT_PRINTF = 0x0100,        /* Format the text string with sprintf. */
151     TAT_TITLE = 0x0200 | TAB_EMPH, /* Title attributes. */
152     TAT_NOWRAP = 0x0800         /* No text wrap (tab_output_text() only). */
153   };
154
155 /* Cells. */
156 struct fmt_spec;
157 union value;
158 void tab_value (struct tab_table *, int c, int r, unsigned char opt,
159                 const union value *, const struct fmt_spec *);
160 void tab_float (struct tab_table *, int c, int r, unsigned char opt,
161                 double v, int w, int d);
162 void tab_text (struct tab_table *, int c, int r, unsigned opt,
163                const char *, ...)
164      PRINTF_FORMAT (5, 6);
165 void tab_joint_text (struct tab_table *, int x1, int y1, int x2, int y2,
166                      unsigned opt, const char *, ...)
167      PRINTF_FORMAT (7, 8);
168
169 /* Cell low-level access. */
170 #define tab_alloc(TABLE, AMT) pool_alloc ((TABLE)->container, (AMT))
171 void tab_raw (struct tab_table *, int c, int r, unsigned opt,
172               struct substring *);
173
174 /* Editing. */
175 void tab_offset (struct tab_table *, int col, int row);
176 void tab_next_row (struct tab_table *);
177
178 /* Current row/column offset. */
179 #define tab_row(TABLE) ((TABLE)->row_ofs)
180 #define tab_col(TABLE) ((TABLE)->col_ofs)
181
182 /* Simple output. */
183 void tab_output_text (int options, const char *string, ...)
184      PRINTF_FORMAT (2, 3);
185
186 /* Embedding the command name in the output. */
187 void tab_set_command_name (const char *);
188
189 #endif /* tab_h */
190