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] = { 0x254c, 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][_][_] = { 0x254c, 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 TABLE_STROKE_NONE:
249 return ASCII_LINE_NONE;
251 case TABLE_STROKE_DASHED:
252 return ASCII_LINE_DASHED;
254 case TABLE_STROKE_SOLID:
255 case TABLE_STROKE_THICK:
256 case TABLE_STROKE_THIN:
257 return ASCII_LINE_SINGLE;
259 case TABLE_STROKE_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 const struct table_border_style[TABLE_N_AXES][2]);
330 static void ascii_measure_cell_width (void *, const struct table_cell *,
332 static int ascii_measure_cell_height (void *, const struct table_cell *,
334 static void ascii_draw_cell (void *, const struct table_cell *, int color_idx,
335 int bb[TABLE_N_AXES][2], int valign_offset,
336 int spill[TABLE_N_AXES][2],
337 int clip[TABLE_N_AXES][2]);
339 static struct ascii_driver *
340 ascii_driver_cast (struct output_driver *driver)
342 assert (driver->class == &ascii_driver_class);
343 return UP_CAST (driver, struct ascii_driver, driver);
346 static struct driver_option *
347 opt (struct output_driver *d, struct string_map *options, const char *key,
348 const char *default_value)
350 return driver_option_get (d, options, key, default_value);
353 /* Return true iff the terminal appears to be an xterm with
354 UTF-8 capabilities */
356 term_is_utf8_xterm (void)
358 const char *term = getenv ("TERM");
359 const char *xterm_locale = getenv ("XTERM_LOCAL");
360 return (term && xterm_locale
361 && !strcmp (term, "xterm")
362 && (strcasestr (xterm_locale, "utf8")
363 || strcasestr (xterm_locale, "utf-8")));
366 static struct output_driver *
367 ascii_create (struct file_handle *fh, enum settings_output_devices device_type,
368 struct string_map *o)
370 enum { BOX_ASCII, BOX_UNICODE } box;
371 struct output_driver *d;
372 struct ascii_driver *a = XZALLOC (struct ascii_driver);
374 output_driver_init (&a->driver, &ascii_driver_class, fh_get_file_name (fh), device_type);
375 a->append = parse_boolean (opt (d, o, "append", "false"));
376 a->emphasis = parse_boolean (opt (d, o, "emphasis", "false"));
378 a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", fh_get_file_name (fh)));
382 bool terminal = !strcmp (fh_get_file_name (fh), "-") && isatty (1);
383 a->width = parse_page_size (opt (d, o, "width", "-1"));
384 a->width_mode = (a->width > 0 ? FIXED_WIDTH
385 : terminal ? TERMINAL_WIDTH
387 a->min_hbreak = parse_int (opt (d, o, "min-hbreak", "-1"), -1, INT_MAX);
389 a->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
390 a->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
392 const char *default_box = (terminal && (!strcmp (locale_charset (), "UTF-8")
393 || term_is_utf8_xterm ())
394 ? "unicode" : "ascii");
395 box = parse_enum (opt (d, o, "box", default_box),
397 "unicode", BOX_UNICODE,
399 a->box = box == BOX_ASCII ? get_ascii_box () : get_unicode_box ();
404 a->allocated_lines = 0;
408 static const struct render_ops ascii_render_ops = {
409 .draw_line = ascii_draw_line,
410 .measure_cell_width = ascii_measure_cell_width,
411 .measure_cell_height = ascii_measure_cell_height,
412 .adjust_break = NULL,
413 .draw_cell = ascii_draw_cell,
415 a->params.ops = &ascii_render_ops;
417 a->params.size[H] = a->width;
418 a->params.size[V] = INT_MAX;
419 a->params.font_size[H] = 1;
420 a->params.font_size[V] = 1;
422 static const int ascii_line_widths[TABLE_N_STROKES] = {
423 [TABLE_STROKE_NONE] = 0,
424 [TABLE_STROKE_SOLID] = 1,
425 [TABLE_STROKE_DASHED] = 1,
426 [TABLE_STROKE_THICK] = 1,
427 [TABLE_STROKE_THIN] = 1,
428 [TABLE_STROKE_DOUBLE] = 1,
430 a->params.line_widths = ascii_line_widths;
431 a->params.supports_margins = false;
432 a->params.rtl = render_direction_rtl ();
433 a->params.printing = true;
435 if (!update_page_size (a, true))
438 a->file = fn_open (a->handle, a->append ? "a" : "w");
441 msg_error (errno, _("ascii: opening output file `%s'"),
442 fh_get_file_name (a->handle));
449 output_driver_destroy (d);
454 parse_page_size (struct driver_option *option)
456 int dim = atol (option->default_value);
458 if (option->value != NULL)
460 if (!strcmp (option->value, "auto"))
468 value = strtol (option->value, &tail, 0);
469 if (value >= 1 && errno != ERANGE && *tail == '\0')
472 msg (MW, _("%s: %s must be positive integer or `auto'"),
473 option->driver_name, option->name);
477 driver_option_destroy (option);
482 /* Re-calculates the page width based on settings, margins, and, if "auto" is
483 set, the size of the user's terminal window or GUI output window. */
485 update_page_size (struct ascii_driver *a, bool issue_error)
487 enum { MIN_WIDTH = 6 };
489 int want_width = (a->width_mode == VIEW_WIDTH ? settings_get_viewwidth ()
490 : a->width_mode == TERMINAL_WIDTH ? get_terminal_width ()
492 bool ok = want_width >= MIN_WIDTH;
493 if (!ok && issue_error)
494 msg (ME, _("ascii: page must be at least %d characters wide, but "
495 "as configured is only %d characters"),
496 MIN_WIDTH, want_width);
498 a->width = ok ? want_width : MIN_WIDTH;
499 a->params.size[H] = a->width;
500 a->params.min_break[H] = a->min_hbreak >= 0 ? a->min_hbreak : a->width / 2;
506 ascii_destroy (struct output_driver *driver)
508 struct ascii_driver *a = ascii_driver_cast (driver);
512 fn_close (a->handle, a->file);
513 fh_unref (a->handle);
514 free (a->chart_file_name);
515 for (i = 0; i < a->allocated_lines; i++)
516 u8_line_destroy (&a->lines[i]);
522 ascii_flush (struct output_driver *driver)
524 struct ascii_driver *a = ascii_driver_cast (driver);
530 ascii_output_lines (struct ascii_driver *a, size_t n_lines)
532 for (size_t y = 0; y < n_lines; y++)
534 if (y < a->allocated_lines)
536 struct u8_line *line = &a->lines[y];
538 while (ds_chomp_byte (&line->s, ' '))
540 fwrite (ds_data (&line->s), 1, ds_length (&line->s), a->file);
541 u8_line_clear (&a->lines[y]);
543 putc ('\n', a->file);
548 ascii_output_table_item (struct ascii_driver *a,
549 const struct output_item *item)
551 update_page_size (a, false);
554 size_t *layer_indexes;
555 PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true)
557 struct render_pager *p = render_pager_create (&a->params, item->table,
559 for (int i = 0; render_pager_has_next (p); i++)
562 putc ('\n', a->file);
564 ascii_output_lines (a, render_pager_draw_next (p, INT_MAX));
566 render_pager_destroy (p);
573 ascii_output_table_item_unref (struct ascii_driver *a,
574 struct output_item *table_item)
576 ascii_output_table_item (a, table_item);
577 output_item_unref (table_item);
581 ascii_submit (struct output_driver *driver, const struct output_item *item)
583 struct ascii_driver *a = ascii_driver_cast (driver);
589 case OUTPUT_ITEM_TABLE:
590 ascii_output_table_item (a, item);
593 case OUTPUT_ITEM_IMAGE:
594 if (a->chart_file_name != NULL)
596 char *file_name = xr_write_png_image (
597 item->image, a->chart_file_name, ++a->n_charts);
598 if (file_name != NULL)
600 struct output_item *text_item = text_item_create_nocopy (
602 xasprintf (_("See %s for an image."), file_name),
605 ascii_submit (driver, text_item);
606 output_item_unref (text_item);
612 case OUTPUT_ITEM_CHART:
613 if (a->chart_file_name != NULL)
615 char *file_name = xr_draw_png_chart (
616 item->chart, a->chart_file_name, ++a->n_charts, &a->fg, &a->bg);
617 if (file_name != NULL)
619 struct output_item *text_item = text_item_create_nocopy (
621 xasprintf (_("See %s for a chart."), file_name),
624 ascii_submit (driver, text_item);
625 output_item_unref (text_item);
631 case OUTPUT_ITEM_TEXT:
632 if (item->text.subtype != TEXT_ITEM_PAGE_TITLE)
633 ascii_output_table_item_unref (
634 a, text_item_to_table_item (output_item_ref (item)));
637 case OUTPUT_ITEM_MESSAGE:
638 ascii_output_table_item_unref (
639 a, text_item_to_table_item (
640 message_item_to_text_item (
641 output_item_ref (item))));
644 case OUTPUT_ITEM_GROUP:
647 case OUTPUT_ITEM_PAGE_BREAK:
652 const struct output_driver_factory txt_driver_factory =
653 { "txt", "-", ascii_create };
654 const struct output_driver_factory list_driver_factory =
655 { "list", "-", ascii_create };
657 static const struct output_driver_class ascii_driver_class =
660 .destroy = ascii_destroy,
661 .submit = ascii_submit,
662 .flush = ascii_flush,
665 static char *ascii_reserve (struct ascii_driver *, int y, int x0, int x1,
667 static void ascii_layout_cell (struct ascii_driver *,
668 const struct table_cell *,
669 int bb[TABLE_N_AXES][2],
670 int clip[TABLE_N_AXES][2],
671 int *width, int *height);
674 ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
675 const struct table_border_style styles[TABLE_N_AXES][2])
677 struct ascii_driver *a = a_;
684 /* Clip to the page. */
685 x0 = MAX (bb[H][0], 0);
686 y0 = MAX (bb[V][0], 0);
687 x1 = MIN (bb[H][1], a->width);
689 if (x1 <= 0 || y1 <= 0 || x0 >= a->width)
693 enum table_stroke v0 = styles[V][0].stroke;
694 enum table_stroke v1 = styles[V][1].stroke;
695 enum table_stroke h0 = styles[H][0].stroke;
696 enum table_stroke h1 = styles[H][1].stroke;
697 uc = box_get (a->box, v0, v1, h0, h1);
698 mblen = u8_uctomb (CHAR_CAST (uint8_t *, mbchar), uc, 6);
699 for (y = y0; y < y1; y++)
701 char *p = ascii_reserve (a, y, x0, x1, mblen * (x1 - x0));
702 for (x = x0; x < x1; x++)
704 memcpy (p, mbchar, mblen);
711 ascii_measure_cell_width (void *a_, const struct table_cell *cell,
712 int *min_width, int *max_width)
714 struct ascii_driver *a = a_;
715 int bb[TABLE_N_AXES][2];
716 int clip[TABLE_N_AXES][2];
723 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
724 ascii_layout_cell (a, cell, bb, clip, max_width, &h);
727 ascii_layout_cell (a, cell, bb, clip, min_width, &h);
731 ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
733 struct ascii_driver *a = a_;
734 int bb[TABLE_N_AXES][2];
735 int clip[TABLE_N_AXES][2];
742 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
743 ascii_layout_cell (a, cell, bb, clip, &w, &h);
748 ascii_draw_cell (void *a_, const struct table_cell *cell, int color_idx UNUSED,
749 int bb[TABLE_N_AXES][2], int valign_offset,
750 int spill[TABLE_N_AXES][2] UNUSED,
751 int clip[TABLE_N_AXES][2])
753 struct ascii_driver *a = a_;
756 bb[V][0] += valign_offset;
757 ascii_layout_cell (a, cell, bb, clip, &w, &h);
761 ascii_reserve (struct ascii_driver *a, int y, int x0, int x1, int n)
763 if (y >= a->allocated_lines)
765 size_t new_alloc = MAX (25, a->allocated_lines);
766 while (new_alloc <= y)
767 new_alloc = xtimes (new_alloc, 2);
768 a->lines = xnrealloc (a->lines, new_alloc, sizeof *a->lines);
769 for (size_t i = a->allocated_lines; i < new_alloc; i++)
770 u8_line_init (&a->lines[i]);
771 a->allocated_lines = new_alloc;
773 return u8_line_reserve (&a->lines[y], x0, x1, n);
777 text_draw (struct ascii_driver *a, enum table_halign halign, bool numeric,
778 bool bold, bool underline,
779 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
780 int y, const uint8_t *string, int n, size_t width)
782 int x0 = MAX (0, clip[H][0]);
783 int y0 = MAX (0, clip[V][0]);
784 int x1 = MIN (a->width, clip[H][1]);
788 if (y < y0 || y >= y1)
791 switch (table_halign_interpret (halign, numeric))
793 case TABLE_HALIGN_LEFT:
796 case TABLE_HALIGN_CENTER:
797 x = (bb[H][0] + bb[H][1] - width + 1) / 2;
799 case TABLE_HALIGN_RIGHT:
800 case TABLE_HALIGN_DECIMAL:
801 x = bb[H][1] - width;
817 mblen = u8_mbtouc (&uc, string, n);
822 w = uc_width (uc, "UTF-8");
837 for (ofs = 0; ofs < n;)
843 mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
845 w = uc_width (uc, "UTF-8");
848 if (width + w > x1 - x)
859 if (!a->emphasis || (!bold && !underline))
860 memcpy (ascii_reserve (a, y, x, x + width, n), string, n);
868 /* First figure out how many bytes need to be inserted. */
870 for (ofs = 0; ofs < n; ofs += mblen)
875 mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
876 w = uc_width (uc, "UTF-8");
887 /* Then insert them. */
888 out = ascii_reserve (a, y, x, x + width, n_out);
889 for (ofs = 0; ofs < n; ofs += mblen)
894 mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
895 w = uc_width (uc, "UTF-8");
901 out = mempcpy (out, string + ofs, mblen);
910 out = mempcpy (out, string + ofs, mblen);
916 ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
917 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
918 int *widthp, int *heightp)
923 struct string body = DS_EMPTY_INITIALIZER;
924 bool numeric = pivot_value_format (cell->value, a->pt, &body);
926 /* Calculate length; if it's zero, then there's nothing to do. */
927 if (ds_is_empty (&body))
933 size_t length = ds_length (&body);
934 const uint8_t *text = CHAR_CAST (uint8_t *, ds_cstr (&body));
936 char *breaks = xmalloc (length + 1);
937 u8_possible_linebreaks (text, length, "UTF-8", breaks);
938 breaks[length] = (breaks[length - 1] == UC_BREAK_MANDATORY
939 ? UC_BREAK_PROHIBITED : UC_BREAK_POSSIBLE);
942 int bb_width = bb[H][1] - bb[H][0];
943 for (int y = bb[V][0]; y < bb[V][1] && pos < length; y++)
945 const uint8_t *line = text + pos;
946 const char *b = breaks + pos;
947 size_t n = length - pos;
949 size_t last_break_ofs = 0;
950 int last_break_width = 0;
955 for (ofs = 0; ofs < n;)
961 mblen = u8_mbtouc (&uc, line + ofs, n - ofs);
962 if (b[ofs] == UC_BREAK_MANDATORY)
964 else if (b[ofs] == UC_BREAK_POSSIBLE)
966 last_break_ofs = ofs;
967 last_break_width = width;
970 w = uc_width (uc, "UTF-8");
973 if (width + w > bb_width)
975 if (isspace (line[ofs]))
977 else if (last_break_ofs != 0)
979 ofs = last_break_ofs;
980 width = last_break_width;
989 /* Trim any trailing spaces off the end of the text to be drawn. */
990 for (graph_ofs = ofs; graph_ofs > 0; graph_ofs--)
991 if (!isspace (line[graph_ofs - 1]))
993 width -= ofs - graph_ofs;
996 text_draw (a, cell->cell_style->halign, numeric,
997 cell->font_style->bold,
998 cell->font_style->underline,
999 bb, clip, y, line, graph_ofs, width);
1001 /* If a new-line ended the line, just skip the new-line. Otherwise, skip
1002 past any spaces past the end of the line (but not past a new-line). */
1003 if (b[ofs] == UC_BREAK_MANDATORY)
1006 while (ofs < n && isspace (line[ofs]) && b[ofs] != UC_BREAK_MANDATORY)
1009 if (width > *widthp)
1020 ascii_test_write (struct output_driver *driver,
1021 const char *s, int x, int y, bool bold, bool underline)
1023 struct ascii_driver *a = ascii_driver_cast (driver);
1024 int bb[TABLE_N_AXES][2];
1030 struct cell_style cell_style = { .halign = TABLE_HALIGN_LEFT };
1031 struct font_style font_style = {
1033 .underline = underline,
1035 const struct pivot_value value = {
1037 .type = PIVOT_VALUE_TEXT,
1038 .local = CONST_CAST (char *, s),
1039 .c = CONST_CAST (char *, s),
1040 .id = CONST_CAST (char *, s),
1041 .user_provided = true,
1044 struct table_cell cell = {
1046 .font_style = &font_style,
1047 .cell_style = &cell_style,
1050 bb[TABLE_HORZ][0] = x;
1051 bb[TABLE_HORZ][1] = a->width;
1052 bb[TABLE_VERT][0] = y;
1053 bb[TABLE_VERT][1] = INT_MAX;
1055 struct pivot_table pt = {
1056 .show_values = SETTINGS_VALUE_SHOW_DEFAULT,
1057 .show_variables = SETTINGS_VALUE_SHOW_DEFAULT,
1060 ascii_layout_cell (a, &cell, bb, bb, &width, &height);
1065 ascii_test_set_length (struct output_driver *driver, int y, int length)
1067 struct ascii_driver *a = ascii_driver_cast (driver);
1074 u8_line_set_length (&a->lines[y], length);
1078 ascii_test_flush (struct output_driver *driver)
1080 struct ascii_driver *a = ascii_driver_cast (driver);
1082 for (size_t i = a->allocated_lines; i-- > 0;)
1083 if (a->lines[i].width)
1085 ascii_output_lines (a, i + 1);
1090 static sig_atomic_t terminal_changed = true;
1091 static int terminal_width;
1093 #if HAVE_DECL_SIGWINCH
1095 winch_handler (int signum UNUSED)
1097 terminal_changed = true;
1102 get_terminal_width (void)
1104 #if HAVE_DECL_SIGWINCH
1105 static bool setup_signal;
1108 setup_signal = true;
1110 struct sigaction action = { .sa_handler = winch_handler };
1111 sigemptyset (&action.sa_mask);
1112 sigaction (SIGWINCH, &action, NULL);
1116 if (terminal_changed)
1118 terminal_changed = false;
1120 #ifdef HAVE_TERMIOS_H
1122 if (!ioctl (0, TIOCGWINSZ, &ws))
1123 terminal_width = ws.ws_col;
1127 if (getenv ("COLUMNS"))
1128 terminal_width = atoi (getenv ("COLUMNS"));
1131 if (terminal_width <= 0 || terminal_width > 1024)
1132 terminal_width = 79;
1135 return terminal_width;