1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
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.
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.
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/>. */
31 # include <sys/ioctl.h>
35 #include "data/file-name.h"
36 #include "data/file-handle-def.h"
37 #include "data/settings.h"
38 #include "libpspp/assertion.h"
39 #include "libpspp/cast.h"
40 #include "libpspp/compiler.h"
41 #include "libpspp/message.h"
42 #include "libpspp/start-date.h"
43 #include "libpspp/string-map.h"
44 #include "libpspp/u8-line.h"
45 #include "libpspp/version.h"
46 #include "output/ascii.h"
47 #include "output/cairo-chart.h"
48 #include "output/chart-provider.h"
49 #include "output/driver-provider.h"
50 #include "output/options.h"
51 #include "output/pivot-output.h"
52 #include "output/pivot-table.h"
53 #include "output/render.h"
54 #include "output/output-item.h"
56 #include "gl/minmax.h"
57 #include "gl/xalloc.h"
61 #define _(msgid) gettext (msgid)
63 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
78 ucs4_t c[ASCII_N_LINES][ASCII_N_LINES][ASCII_N_LINES][ASCII_N_LINES];
81 static const struct box_chars *
86 d = ASCII_LINE_DASHED,
87 S = ASCII_LINE_SINGLE,
88 D = ASCII_LINE_DOUBLE,
91 static const struct box_chars ascii_box =
93 /* r b l t: _ d S D */
94 .c[_][_][_] = { ' ', '|', '|', '#', },
95 .c[_][_][d] = { '-', '+', '+', '#', },
96 .c[_][_][S] = { '-', '+', '+', '#', },
97 .c[_][_][D] = { '=', '#', '#', '#', },
98 .c[_][d][_] = { '|', '|', '|', '#', },
99 .c[_][d][d] = { '+', '+', '+', '#', },
100 .c[_][d][S] = { '+', '+', '+', '#', },
101 .c[_][d][D] = { '#', '#', '#', '#', },
102 .c[_][S][_] = { '|', '|', '|', '#', },
103 .c[_][S][d] = { '+', '+', '+', '#', },
104 .c[_][S][S] = { '+', '+', '+', '#', },
105 .c[_][S][D] = { '#', '#', '#', '#', },
106 .c[_][D][_] = { '#', '#', '#', '#', },
107 .c[_][D][d] = { '#', '#', '#', '#', },
108 .c[_][D][S] = { '#', '#', '#', '#', },
109 .c[_][D][D] = { '#', '#', '#', '#', },
110 .c[d][_][_] = { '-', '+', '+', '#', },
111 .c[d][_][d] = { '-', '+', '+', '#', },
112 .c[d][_][S] = { '-', '+', '+', '#', },
113 .c[d][_][D] = { '#', '#', '#', '#', },
114 .c[d][d][_] = { '+', '+', '+', '#', },
115 .c[d][d][d] = { '+', '+', '+', '#', },
116 .c[d][d][S] = { '+', '+', '+', '#', },
117 .c[d][d][D] = { '#', '#', '#', '#', },
118 .c[d][S][_] = { '+', '+', '+', '#', },
119 .c[d][S][d] = { '+', '+', '+', '#', },
120 .c[d][S][S] = { '+', '+', '+', '#', },
121 .c[d][S][D] = { '#', '#', '#', '#', },
122 .c[d][D][_] = { '#', '#', '#', '#', },
123 .c[d][D][d] = { '#', '#', '#', '#', },
124 .c[d][D][S] = { '#', '#', '#', '#', },
125 .c[d][D][D] = { '#', '#', '#', '#', },
126 .c[S][_][_] = { '-', '+', '+', '#', },
127 .c[S][_][d] = { '-', '+', '+', '#', },
128 .c[S][_][S] = { '-', '+', '+', '#', },
129 .c[S][_][D] = { '#', '#', '#', '#', },
130 .c[S][d][_] = { '+', '+', '+', '#', },
131 .c[S][d][d] = { '+', '+', '+', '#', },
132 .c[S][d][S] = { '+', '+', '+', '#', },
133 .c[S][d][D] = { '#', '#', '#', '#', },
134 .c[S][S][_] = { '+', '+', '+', '#', },
135 .c[S][S][d] = { '+', '+', '+', '#', },
136 .c[S][S][S] = { '+', '+', '+', '#', },
137 .c[S][S][D] = { '#', '#', '#', '#', },
138 .c[S][D][_] = { '#', '#', '#', '#', },
139 .c[S][D][d] = { '#', '#', '#', '#', },
140 .c[S][D][S] = { '#', '#', '#', '#', },
141 .c[S][D][D] = { '#', '#', '#', '#', },
142 .c[D][_][_] = { '=', '#', '#', '#', },
143 .c[D][_][d] = { '#', '#', '#', '#', },
144 .c[D][_][S] = { '#', '#', '#', '#', },
145 .c[D][_][D] = { '=', '#', '#', '#', },
146 .c[D][d][_] = { '#', '#', '#', '#', },
147 .c[D][d][d] = { '#', '#', '#', '#', },
148 .c[D][d][S] = { '#', '#', '#', '#', },
149 .c[D][d][D] = { '#', '#', '#', '#', },
150 .c[D][S][_] = { '#', '#', '#', '#', },
151 .c[D][S][d] = { '#', '#', '#', '#', },
152 .c[D][S][S] = { '#', '#', '#', '#', },
153 .c[D][S][D] = { '#', '#', '#', '#', },
154 .c[D][D][_] = { '#', '#', '#', '#', },
155 .c[D][D][d] = { '#', '#', '#', '#', },
156 .c[D][D][S] = { '#', '#', '#', '#', },
157 .c[D][D][D] = { '#', '#', '#', '#', },
162 static const struct box_chars *
163 get_unicode_box (void)
167 d = ASCII_LINE_DASHED,
168 S = ASCII_LINE_SINGLE,
169 D = ASCII_LINE_DOUBLE,
172 static const struct box_chars unicode_box =
174 /* r b l t: _ d S D */
175 .c[_][_][_] = { 0x0020, 0x2575, 0x2575, 0x2551, }, /* ╵╵║ */
176 .c[_][_][d] = { 0x2574, 0x256f, 0x256f, 0x255c, }, /* ╴╯╯╜ */
177 .c[_][_][S] = { 0x2574, 0x256f, 0x256f, 0x255c, }, /* ╴╯╯╜ */
178 .c[_][_][D] = { 0x2550, 0x255b, 0x255b, 0x255d, }, /* ═╛╛╝ */
179 .c[_][S][_] = { 0x2577, 0x2502, 0x2502, 0x2551, }, /* ╷││║ */
180 .c[_][S][d] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
181 .c[_][S][S] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
182 .c[_][S][D] = { 0x2555, 0x2561, 0x2561, 0x2563, }, /* ╕╡╡╣ */
183 .c[_][d][_] = { 0x2577, 0x250a, 0x2502, 0x2551, }, /* ╷┊│║ */
184 .c[_][d][d] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
185 .c[_][d][S] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
186 .c[_][d][D] = { 0x2555, 0x2561, 0x2561, 0x2563, }, /* ╕╡╡╣ */
187 .c[_][D][_] = { 0x2551, 0x2551, 0x2551, 0x2551, }, /* ║║║║ */
188 .c[_][D][d] = { 0x2556, 0x2562, 0x2562, 0x2562, }, /* ╖╢╢╢ */
189 .c[_][D][S] = { 0x2556, 0x2562, 0x2562, 0x2562, }, /* ╖╢╢╢ */
190 .c[_][D][D] = { 0x2557, 0x2563, 0x2563, 0x2563, }, /* ╗╣╣╣ */
191 .c[d][_][_] = { 0x2576, 0x2570, 0x2570, 0x2559, }, /* ╶╰╰╙ */
192 .c[d][_][d] = { 0x254c, 0x2534, 0x2534, 0x2568, }, /* ╌┴┴╨ */
193 .c[d][_][S] = { 0x2500, 0x2534, 0x2534, 0x2568, }, /* ─┴┴╨ */
194 .c[d][_][D] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
195 .c[d][d][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
196 .c[d][d][d] = { 0x252c, 0x002b, 0x253c, 0x256a, }, /* ┬+┼╪ */
197 .c[d][d][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
198 .c[d][d][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
199 .c[d][S][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
200 .c[d][S][d] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
201 .c[d][S][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
202 .c[d][S][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
203 .c[d][D][_] = { 0x2553, 0x255f, 0x255f, 0x255f, }, /* ╓╟╟╟ */
204 .c[d][D][d] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
205 .c[d][D][S] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
206 .c[d][D][D] = { 0x2566, 0x256c, 0x256c, 0x256c, }, /* ╦╬╬╬ */
207 .c[S][_][_] = { 0x2576, 0x2570, 0x2570, 0x2559, }, /* ╶╰╰╙ */
208 .c[S][_][d] = { 0x2500, 0x2534, 0x2534, 0x2568, }, /* ─┴┴╨ */
209 .c[S][_][S] = { 0x2500, 0x2534, 0x2534, 0x2568, }, /* ─┴┴╨ */
210 .c[S][_][D] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
211 .c[S][d][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
212 .c[S][d][d] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
213 .c[S][d][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
214 .c[S][d][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
215 .c[S][S][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
216 .c[S][S][d] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
217 .c[S][S][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
218 .c[S][S][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
219 .c[S][D][_] = { 0x2553, 0x255f, 0x255f, 0x255f, }, /* ╓╟╟╟ */
220 .c[S][D][d] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
221 .c[S][D][S] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
222 .c[S][D][D] = { 0x2566, 0x256c, 0x256c, 0x256c, }, /* ╦╬╬╬ */
223 .c[D][_][_] = { 0x2550, 0x2558, 0x2558, 0x255a, }, /* ═╘╘╚ */
224 .c[D][_][d] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
225 .c[D][_][S] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
226 .c[D][_][D] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
227 .c[D][d][_] = { 0x2552, 0x255e, 0x255e, 0x2560, }, /* ╒╞╞╠ */
228 .c[D][d][d] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
229 .c[D][d][S] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
230 .c[D][d][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
231 .c[D][S][_] = { 0x2552, 0x255e, 0x255e, 0x2560, }, /* ╒╞╞╠ */
232 .c[D][S][d] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
233 .c[D][S][S] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
234 .c[D][S][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
235 .c[D][D][_] = { 0x2554, 0x2560, 0x2560, 0x2560, }, /* ╔╠╠╠ */
236 .c[D][D][d] = { 0x2560, 0x256c, 0x256c, 0x256c, }, /* ╠╬╬╬ */
237 .c[D][D][S] = { 0x2560, 0x256c, 0x256c, 0x256c, }, /* ╠╬╬╬ */
238 .c[D][D][D] = { 0x2566, 0x256c, 0x256c, 0x256c, }, /* ╦╬╬╬ */
244 ascii_line_from_render_line (int render_line)
248 case RENDER_LINE_NONE:
249 return ASCII_LINE_NONE;
251 case RENDER_LINE_DASHED:
252 return ASCII_LINE_DASHED;
254 case RENDER_LINE_SINGLE:
255 case RENDER_LINE_THICK:
256 case RENDER_LINE_THIN:
257 return ASCII_LINE_SINGLE;
259 case RENDER_LINE_DOUBLE:
260 return ASCII_LINE_DOUBLE;
263 return ASCII_LINE_NONE;
269 box_get (const struct box_chars *box,
270 int left_, int right_, int top_, int bottom_)
272 bool rtl = render_direction_rtl ();
273 int left = ascii_line_from_render_line (rtl ? right_ : left_);
274 int right = ascii_line_from_render_line (rtl ? left_ : right_);
275 int top = ascii_line_from_render_line (top_);
276 int bottom = ascii_line_from_render_line (bottom_);
278 return box->c[right][bottom][left][top];
281 /* ASCII output driver. */
284 struct output_driver driver;
286 /* User parameters. */
287 bool append; /* Append if output file already exists? */
288 bool emphasis; /* Enable bold and underline in output? */
289 char *chart_file_name; /* Name of files used for charts. */
291 /* Colours for charts */
292 struct cell_color fg;
293 struct cell_color bg;
295 /* How the page width is determined: */
297 FIXED_WIDTH, /* Specified by configuration. */
298 VIEW_WIDTH, /* From SET WIDTH. */
299 TERMINAL_WIDTH /* From the terminal's width. */
301 int width; /* Page width. */
303 int min_hbreak; /* Min cell size to break across pages. */
305 const struct box_chars *box; /* Line & box drawing characters. */
307 /* Internal state. */
308 struct file_handle *handle;
309 FILE *file; /* Output file. */
310 bool error; /* Output error? */
311 struct u8_line *lines; /* Page content. */
312 int allocated_lines; /* Number of lines allocated. */
313 int n_charts; /* Number of charts so far. */
314 int n_objects; /* Number of objects so far. */
315 const struct pivot_table *pt;
316 struct render_params params;
319 static const struct output_driver_class ascii_driver_class;
321 static void ascii_submit (struct output_driver *, const struct output_item *);
323 static int get_terminal_width (void);
325 static bool update_page_size (struct ascii_driver *, bool issue_error);
326 static int parse_page_size (struct driver_option *);
328 static void ascii_draw_line (void *, int bb[TABLE_N_AXES][2],
329 enum render_line_style styles[TABLE_N_AXES][2],
330 struct cell_color colors[TABLE_N_AXES][2]);
331 static void ascii_measure_cell_width (void *, const struct table_cell *,
333 static int ascii_measure_cell_height (void *, const struct table_cell *,
335 static void ascii_draw_cell (void *, const struct table_cell *, int color_idx,
336 int bb[TABLE_N_AXES][2], int valign_offset,
337 int spill[TABLE_N_AXES][2],
338 int clip[TABLE_N_AXES][2]);
340 static struct ascii_driver *
341 ascii_driver_cast (struct output_driver *driver)
343 assert (driver->class == &ascii_driver_class);
344 return UP_CAST (driver, struct ascii_driver, driver);
347 static struct driver_option *
348 opt (struct output_driver *d, struct string_map *options, const char *key,
349 const char *default_value)
351 return driver_option_get (d, options, key, default_value);
354 /* Return true iff the terminal appears to be an xterm with
355 UTF-8 capabilities */
357 term_is_utf8_xterm (void)
359 const char *term = getenv ("TERM");
360 const char *xterm_locale = getenv ("XTERM_LOCAL");
361 return (term && xterm_locale
362 && !strcmp (term, "xterm")
363 && (strcasestr (xterm_locale, "utf8")
364 || strcasestr (xterm_locale, "utf-8")));
367 static struct output_driver *
368 ascii_create (struct file_handle *fh, enum settings_output_devices device_type,
369 struct string_map *o)
371 enum { BOX_ASCII, BOX_UNICODE } box;
372 struct output_driver *d;
373 struct ascii_driver *a = XZALLOC (struct ascii_driver);
375 output_driver_init (&a->driver, &ascii_driver_class, fh_get_file_name (fh), device_type);
376 a->append = parse_boolean (opt (d, o, "append", "false"));
377 a->emphasis = parse_boolean (opt (d, o, "emphasis", "false"));
379 a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", fh_get_file_name (fh)));
383 bool terminal = !strcmp (fh_get_file_name (fh), "-") && isatty (1);
384 a->width = parse_page_size (opt (d, o, "width", "-1"));
385 a->width_mode = (a->width > 0 ? FIXED_WIDTH
386 : terminal ? TERMINAL_WIDTH
388 a->min_hbreak = parse_int (opt (d, o, "min-hbreak", "-1"), -1, INT_MAX);
390 a->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
391 a->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
393 const char *default_box = (terminal && (!strcmp (locale_charset (), "UTF-8")
394 || term_is_utf8_xterm ())
395 ? "unicode" : "ascii");
396 box = parse_enum (opt (d, o, "box", default_box),
398 "unicode", BOX_UNICODE,
400 a->box = box == BOX_ASCII ? get_ascii_box () : get_unicode_box ();
405 a->allocated_lines = 0;
409 static const struct render_ops ascii_render_ops = {
410 .draw_line = ascii_draw_line,
411 .measure_cell_width = ascii_measure_cell_width,
412 .measure_cell_height = ascii_measure_cell_height,
413 .adjust_break = NULL,
414 .draw_cell = ascii_draw_cell,
416 a->params.ops = &ascii_render_ops;
418 a->params.size[H] = a->width;
419 a->params.size[V] = INT_MAX;
420 a->params.font_size[H] = 1;
421 a->params.font_size[V] = 1;
423 static const int ascii_line_widths[RENDER_N_LINES] = {
424 [RENDER_LINE_NONE] = 0,
425 [RENDER_LINE_SINGLE] = 1,
426 [RENDER_LINE_DASHED] = 1,
427 [RENDER_LINE_THICK] = 1,
428 [RENDER_LINE_THIN] = 1,
429 [RENDER_LINE_DOUBLE] = 1,
431 a->params.line_widths = ascii_line_widths;
432 a->params.supports_margins = false;
433 a->params.rtl = render_direction_rtl ();
434 a->params.printing = true;
436 if (!update_page_size (a, true))
439 a->file = fn_open (a->handle, a->append ? "a" : "w");
442 msg_error (errno, _("ascii: opening output file `%s'"),
443 fh_get_file_name (a->handle));
450 output_driver_destroy (d);
455 parse_page_size (struct driver_option *option)
457 int dim = atol (option->default_value);
459 if (option->value != NULL)
461 if (!strcmp (option->value, "auto"))
469 value = strtol (option->value, &tail, 0);
470 if (value >= 1 && errno != ERANGE && *tail == '\0')
473 msg (MW, _("%s: %s must be positive integer or `auto'"),
474 option->driver_name, option->name);
478 driver_option_destroy (option);
483 /* Re-calculates the page width based on settings, margins, and, if "auto" is
484 set, the size of the user's terminal window or GUI output window. */
486 update_page_size (struct ascii_driver *a, bool issue_error)
488 enum { MIN_WIDTH = 6 };
490 int want_width = (a->width_mode == VIEW_WIDTH ? settings_get_viewwidth ()
491 : a->width_mode == TERMINAL_WIDTH ? get_terminal_width ()
493 bool ok = want_width >= MIN_WIDTH;
494 if (!ok && issue_error)
495 msg (ME, _("ascii: page must be at least %d characters wide, but "
496 "as configured is only %d characters"),
497 MIN_WIDTH, want_width);
499 a->width = ok ? want_width : MIN_WIDTH;
500 a->params.size[H] = a->width;
501 a->params.min_break[H] = a->min_hbreak >= 0 ? a->min_hbreak : a->width / 2;
507 ascii_destroy (struct output_driver *driver)
509 struct ascii_driver *a = ascii_driver_cast (driver);
513 fn_close (a->handle, a->file);
514 fh_unref (a->handle);
515 free (a->chart_file_name);
516 for (i = 0; i < a->allocated_lines; i++)
517 u8_line_destroy (&a->lines[i]);
523 ascii_flush (struct output_driver *driver)
525 struct ascii_driver *a = ascii_driver_cast (driver);
531 ascii_output_lines (struct ascii_driver *a, size_t n_lines)
533 for (size_t y = 0; y < n_lines; y++)
535 if (y < a->allocated_lines)
537 struct u8_line *line = &a->lines[y];
539 while (ds_chomp_byte (&line->s, ' '))
541 fwrite (ds_data (&line->s), 1, ds_length (&line->s), a->file);
542 u8_line_clear (&a->lines[y]);
544 putc ('\n', a->file);
549 ascii_output_table_item (struct ascii_driver *a,
550 const struct output_item *item)
552 update_page_size (a, false);
555 size_t *layer_indexes;
556 PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true)
558 struct render_pager *p = render_pager_create (&a->params, item->table,
560 for (int i = 0; render_pager_has_next (p); i++)
563 putc ('\n', a->file);
565 ascii_output_lines (a, render_pager_draw_next (p, INT_MAX));
567 render_pager_destroy (p);
574 ascii_output_table_item_unref (struct ascii_driver *a,
575 struct output_item *table_item)
577 ascii_output_table_item (a, table_item);
578 output_item_unref (table_item);
582 ascii_submit (struct output_driver *driver, const struct output_item *item)
584 struct ascii_driver *a = ascii_driver_cast (driver);
590 case OUTPUT_ITEM_TABLE:
591 ascii_output_table_item (a, item);
594 case OUTPUT_ITEM_IMAGE:
595 if (a->chart_file_name != NULL)
597 char *file_name = xr_write_png_image (
598 item->image, a->chart_file_name, ++a->n_charts);
599 if (file_name != NULL)
601 struct output_item *text_item = text_item_create_nocopy (
603 xasprintf (_("See %s for an image."), file_name),
606 ascii_submit (driver, text_item);
607 output_item_unref (text_item);
613 case OUTPUT_ITEM_CHART:
614 if (a->chart_file_name != NULL)
616 char *file_name = xr_draw_png_chart (
617 item->chart, a->chart_file_name, ++a->n_charts, &a->fg, &a->bg);
618 if (file_name != NULL)
620 struct output_item *text_item = text_item_create_nocopy (
622 xasprintf (_("See %s for a chart."), file_name),
625 ascii_submit (driver, text_item);
626 output_item_unref (text_item);
632 case OUTPUT_ITEM_TEXT:
633 if (item->text.subtype != TEXT_ITEM_PAGE_TITLE)
634 ascii_output_table_item_unref (
635 a, text_item_to_table_item (output_item_ref (item)));
638 case OUTPUT_ITEM_MESSAGE:
639 ascii_output_table_item_unref (
640 a, text_item_to_table_item (
641 message_item_to_text_item (
642 output_item_ref (item))));
645 case OUTPUT_ITEM_GROUP:
648 case OUTPUT_ITEM_PAGE_BREAK:
653 const struct output_driver_factory txt_driver_factory =
654 { "txt", "-", ascii_create };
655 const struct output_driver_factory list_driver_factory =
656 { "list", "-", ascii_create };
658 static const struct output_driver_class ascii_driver_class =
661 .destroy = ascii_destroy,
662 .submit = ascii_submit,
663 .flush = ascii_flush,
666 static char *ascii_reserve (struct ascii_driver *, int y, int x0, int x1,
668 static void ascii_layout_cell (struct ascii_driver *,
669 const struct table_cell *,
670 int bb[TABLE_N_AXES][2],
671 int clip[TABLE_N_AXES][2],
672 int *width, int *height);
675 ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
676 enum render_line_style styles[TABLE_N_AXES][2],
677 struct cell_color colors[TABLE_N_AXES][2] UNUSED)
679 struct ascii_driver *a = a_;
686 /* Clip to the page. */
687 x0 = MAX (bb[H][0], 0);
688 y0 = MAX (bb[V][0], 0);
689 x1 = MIN (bb[H][1], a->width);
691 if (x1 <= 0 || y1 <= 0 || x0 >= a->width)
695 uc = box_get (a->box, styles[V][0], styles[V][1], styles[H][0], styles[H][1]);
696 mblen = u8_uctomb (CHAR_CAST (uint8_t *, mbchar), uc, 6);
697 for (y = y0; y < y1; y++)
699 char *p = ascii_reserve (a, y, x0, x1, mblen * (x1 - x0));
700 for (x = x0; x < x1; x++)
702 memcpy (p, mbchar, mblen);
709 ascii_measure_cell_width (void *a_, const struct table_cell *cell,
710 int *min_width, int *max_width)
712 struct ascii_driver *a = a_;
713 int bb[TABLE_N_AXES][2];
714 int clip[TABLE_N_AXES][2];
721 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
722 ascii_layout_cell (a, cell, bb, clip, max_width, &h);
725 ascii_layout_cell (a, cell, bb, clip, min_width, &h);
729 ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
731 struct ascii_driver *a = a_;
732 int bb[TABLE_N_AXES][2];
733 int clip[TABLE_N_AXES][2];
740 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
741 ascii_layout_cell (a, cell, bb, clip, &w, &h);
746 ascii_draw_cell (void *a_, const struct table_cell *cell, int color_idx UNUSED,
747 int bb[TABLE_N_AXES][2], int valign_offset,
748 int spill[TABLE_N_AXES][2] UNUSED,
749 int clip[TABLE_N_AXES][2])
751 struct ascii_driver *a = a_;
754 bb[V][0] += valign_offset;
755 ascii_layout_cell (a, cell, bb, clip, &w, &h);
759 ascii_reserve (struct ascii_driver *a, int y, int x0, int x1, int n)
761 if (y >= a->allocated_lines)
763 size_t new_alloc = MAX (25, a->allocated_lines);
764 while (new_alloc <= y)
765 new_alloc = xtimes (new_alloc, 2);
766 a->lines = xnrealloc (a->lines, new_alloc, sizeof *a->lines);
767 for (size_t i = a->allocated_lines; i < new_alloc; i++)
768 u8_line_init (&a->lines[i]);
769 a->allocated_lines = new_alloc;
771 return u8_line_reserve (&a->lines[y], x0, x1, n);
775 text_draw (struct ascii_driver *a, enum table_halign halign, bool numeric,
776 bool bold, bool underline,
777 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
778 int y, const uint8_t *string, int n, size_t width)
780 int x0 = MAX (0, clip[H][0]);
781 int y0 = MAX (0, clip[V][0]);
782 int x1 = MIN (a->width, clip[H][1]);
786 if (y < y0 || y >= y1)
789 switch (table_halign_interpret (halign, numeric))
791 case TABLE_HALIGN_LEFT:
794 case TABLE_HALIGN_CENTER:
795 x = (bb[H][0] + bb[H][1] - width + 1) / 2;
797 case TABLE_HALIGN_RIGHT:
798 case TABLE_HALIGN_DECIMAL:
799 x = bb[H][1] - width;
815 mblen = u8_mbtouc (&uc, string, n);
820 w = uc_width (uc, "UTF-8");
835 for (ofs = 0; ofs < n;)
841 mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
843 w = uc_width (uc, "UTF-8");
846 if (width + w > x1 - x)
857 if (!a->emphasis || (!bold && !underline))
858 memcpy (ascii_reserve (a, y, x, x + width, n), string, n);
866 /* First figure out how many bytes need to be inserted. */
868 for (ofs = 0; ofs < n; ofs += mblen)
873 mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
874 w = uc_width (uc, "UTF-8");
885 /* Then insert them. */
886 out = ascii_reserve (a, y, x, x + width, n_out);
887 for (ofs = 0; ofs < n; ofs += mblen)
892 mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
893 w = uc_width (uc, "UTF-8");
899 out = mempcpy (out, string + ofs, mblen);
908 out = mempcpy (out, string + ofs, mblen);
914 ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
915 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
916 int *widthp, int *heightp)
921 struct string body = DS_EMPTY_INITIALIZER;
922 bool numeric = pivot_value_format (cell->value, a->pt, &body);
924 /* Calculate length; if it's zero, then there's nothing to do. */
925 if (ds_is_empty (&body))
931 size_t length = ds_length (&body);
932 const uint8_t *text = CHAR_CAST (uint8_t *, ds_cstr (&body));
934 char *breaks = xmalloc (length + 1);
935 u8_possible_linebreaks (text, length, "UTF-8", breaks);
936 breaks[length] = (breaks[length - 1] == UC_BREAK_MANDATORY
937 ? UC_BREAK_PROHIBITED : UC_BREAK_POSSIBLE);
940 int bb_width = bb[H][1] - bb[H][0];
941 for (int y = bb[V][0]; y < bb[V][1] && pos < length; y++)
943 const uint8_t *line = text + pos;
944 const char *b = breaks + pos;
945 size_t n = length - pos;
947 size_t last_break_ofs = 0;
948 int last_break_width = 0;
953 for (ofs = 0; ofs < n;)
959 mblen = u8_mbtouc (&uc, line + ofs, n - ofs);
960 if (b[ofs] == UC_BREAK_MANDATORY)
962 else if (b[ofs] == UC_BREAK_POSSIBLE)
964 last_break_ofs = ofs;
965 last_break_width = width;
968 w = uc_width (uc, "UTF-8");
971 if (width + w > bb_width)
973 if (isspace (line[ofs]))
975 else if (last_break_ofs != 0)
977 ofs = last_break_ofs;
978 width = last_break_width;
987 /* Trim any trailing spaces off the end of the text to be drawn. */
988 for (graph_ofs = ofs; graph_ofs > 0; graph_ofs--)
989 if (!isspace (line[graph_ofs - 1]))
991 width -= ofs - graph_ofs;
994 text_draw (a, cell->cell_style->halign, numeric,
995 cell->font_style->bold,
996 cell->font_style->underline,
997 bb, clip, y, line, graph_ofs, width);
999 /* If a new-line ended the line, just skip the new-line. Otherwise, skip
1000 past any spaces past the end of the line (but not past a new-line). */
1001 if (b[ofs] == UC_BREAK_MANDATORY)
1004 while (ofs < n && isspace (line[ofs]) && b[ofs] != UC_BREAK_MANDATORY)
1007 if (width > *widthp)
1018 ascii_test_write (struct output_driver *driver,
1019 const char *s, int x, int y, bool bold, bool underline)
1021 struct ascii_driver *a = ascii_driver_cast (driver);
1022 int bb[TABLE_N_AXES][2];
1028 struct cell_style cell_style = { .halign = TABLE_HALIGN_LEFT };
1029 struct font_style font_style = {
1031 .underline = underline,
1033 const struct pivot_value value = {
1035 .type = PIVOT_VALUE_TEXT,
1036 .local = CONST_CAST (char *, s),
1037 .c = CONST_CAST (char *, s),
1038 .id = CONST_CAST (char *, s),
1039 .user_provided = true,
1042 struct table_cell cell = {
1044 .font_style = &font_style,
1045 .cell_style = &cell_style,
1048 bb[TABLE_HORZ][0] = x;
1049 bb[TABLE_HORZ][1] = a->width;
1050 bb[TABLE_VERT][0] = y;
1051 bb[TABLE_VERT][1] = INT_MAX;
1053 struct pivot_table pt = {
1054 .show_values = SETTINGS_VALUE_SHOW_DEFAULT,
1055 .show_variables = SETTINGS_VALUE_SHOW_DEFAULT,
1058 ascii_layout_cell (a, &cell, bb, bb, &width, &height);
1063 ascii_test_set_length (struct output_driver *driver, int y, int length)
1065 struct ascii_driver *a = ascii_driver_cast (driver);
1072 u8_line_set_length (&a->lines[y], length);
1076 ascii_test_flush (struct output_driver *driver)
1078 struct ascii_driver *a = ascii_driver_cast (driver);
1080 for (size_t i = a->allocated_lines; i-- > 0;)
1081 if (a->lines[i].width)
1083 ascii_output_lines (a, i + 1);
1088 static sig_atomic_t terminal_changed = true;
1089 static int terminal_width;
1091 #if HAVE_DECL_SIGWINCH
1093 winch_handler (int signum UNUSED)
1095 terminal_changed = true;
1100 get_terminal_width (void)
1102 #if HAVE_DECL_SIGWINCH
1103 static bool setup_signal;
1106 setup_signal = true;
1108 struct sigaction action = { .sa_handler = winch_handler };
1109 sigemptyset (&action.sa_mask);
1110 sigaction (SIGWINCH, &action, NULL);
1114 if (terminal_changed)
1116 terminal_changed = false;
1118 #ifdef HAVE_TERMIOS_H
1120 if (!ioctl (0, TIOCGWINSZ, &ws))
1121 terminal_width = ws.ws_col;
1125 if (getenv ("COLUMNS"))
1126 terminal_width = atoi (getenv ("COLUMNS"));
1129 if (terminal_width <= 0 || terminal_width > 1024)
1130 terminal_width = 79;
1133 return terminal_width;