pintos-os.org Git - pspp/blob - src/output/ascii.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2012, 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 #include <config.h>
  18
  19 #include <ctype.h>
  20 #include <errno.h>
  21 #include <limits.h>
  22 #include <signal.h>
  23 #include <stdint.h>
  24 #include <stdlib.h>
  25 #include <unilbrk.h>
  26 #include <unistd.h>
  27 #include <unistr.h>
  28 #include <uniwidth.h>
  29
  30 #ifdef HAVE_TERMIOS_H
  31 # include <sys/ioctl.h>
  32 # include <termios.h>
  33 #endif
  34
  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"
  55
  56 #include "gl/minmax.h"
  57 #include "gl/xalloc.h"
  58 #include "gl/xsize.h"
  59
  60 #include "gettext.h"
  61 #define _(msgid) gettext (msgid)
  62
  63 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
  64 #define H TABLE_HORZ
  65 #define V TABLE_VERT
  66
  67 enum
  68   {
  69     ASCII_LINE_NONE,
  70     ASCII_LINE_DASHED,
  71     ASCII_LINE_SINGLE,
  72     ASCII_LINE_DOUBLE,
  73     ASCII_N_LINES
  74   };
  75
  76 struct box_chars
  77   {
  78     ucs4_t c[ASCII_N_LINES][ASCII_N_LINES][ASCII_N_LINES][ASCII_N_LINES];
  79   };
  80
  81 static const struct box_chars *
  82 get_ascii_box (void)
  83 {
  84   enum {
  85     _ = ASCII_LINE_NONE,
  86     d = ASCII_LINE_DASHED,
  87     S = ASCII_LINE_SINGLE,
  88     D = ASCII_LINE_DOUBLE,
  89   };
  90
  91   static const struct box_chars ascii_box =
  92     {
  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] = { '#', '#', '#', '#', },
 158     };
 159   return &ascii_box;
 160 }
 161
 162 static const struct box_chars *
 163 get_unicode_box (void)
 164 {
 165   enum {
 166     _ = ASCII_LINE_NONE,
 167     d = ASCII_LINE_DASHED,
 168     S = ASCII_LINE_SINGLE,
 169     D = ASCII_LINE_DOUBLE,
 170   };
 171
 172   static const struct box_chars unicode_box =
 173     {
 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, }, /* ╦╬╬╬ */
 239     };
 240   return &unicode_box;
 241 }
 242
 243 static int
 244 ascii_line_from_render_line (int render_line)
 245 {
 246   switch (render_line)
 247     {
 248     case TABLE_STROKE_NONE:
 249       return ASCII_LINE_NONE;
 250
 251     case TABLE_STROKE_DASHED:
 252       return ASCII_LINE_DASHED;
 253
 254     case TABLE_STROKE_SOLID:
 255     case TABLE_STROKE_THICK:
 256     case TABLE_STROKE_THIN:
 257       return ASCII_LINE_SINGLE;
 258
 259     case TABLE_STROKE_DOUBLE:
 260       return ASCII_LINE_DOUBLE;
 261
 262     default:
 263       return ASCII_LINE_NONE;
 264     }
 265
 266 }
 267
 268 static ucs4_t
 269 box_get (const struct box_chars *box,
 270          int left_, int right_, int top_, int bottom_)
 271 {
 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_);
 277
 278   return box->c[right][bottom][left][top];
 279 }
 280
 281 /* How the page width is determined. */
 282 enum ascii_width_mode
 283   {
 284     FIXED_WIDTH,              /* Specified by configuration. */
 285     VIEW_WIDTH,               /* From SET WIDTH. */
 286     TERMINAL_WIDTH            /* From the terminal's width. */
 287   };
 288
 289 /* ASCII output driver. */
 290 struct ascii_driver
 291   {
 292     struct output_driver driver;
 293
 294     /* User parameters. */
 295     bool emphasis;              /* Enable bold and underline in output? */
 296     char *chart_file_name;      /* Name of files used for charts. */
 297
 298     /* Colours for charts */
 299     struct cell_color fg;
 300     struct cell_color bg;
 301
 302     /* How the page width is determined: */
 303     enum ascii_width_mode width_mode;
 304     int width;                  /* Page width. */
 305
 306     int min_hbreak;             /* Min cell size to break across pages. */
 307
 308     const struct box_chars *box; /* Line & box drawing characters. */
 309
 310     /* Internal state. */
 311     struct file_handle *handle;
 312     FILE *file;                 /* Output file. */
 313     bool error;                 /* Output error? */
 314     struct u8_line *lines;      /* Page content. */
 315     int allocated_lines;        /* Number of lines allocated. */
 316     int n_charts;               /* Number of charts so far. */
 317     int n_objects;              /* Number of objects so far. */
 318     const struct pivot_table *pt;
 319     struct render_params params;
 320   };
 321
 322 static const struct output_driver_class ascii_driver_class;
 323
 324 static void ascii_submit (struct output_driver *, const struct output_item *);
 325
 326 static int get_terminal_width (void);
 327
 328 static bool update_page_size (struct ascii_driver *, bool issue_error);
 329 static int parse_page_size (struct driver_option *);
 330
 331 static void ascii_draw_line (void *, int bb[TABLE_N_AXES][2],
 332                              const struct table_border_style[TABLE_N_AXES][2]);
 333 static void ascii_measure_cell_width (void *, const struct table_cell *,
 334                                       int *min, int *max);
 335 static int ascii_measure_cell_height (void *, const struct table_cell *,
 336                                       int width);
 337 static void ascii_draw_cell (void *, const struct table_cell *, int color_idx,
 338                              int bb[TABLE_N_AXES][2], int valign_offset,
 339                              int spill[TABLE_N_AXES][2],
 340                              int clip[TABLE_N_AXES][2]);
 341
 342 static struct ascii_driver *
 343 ascii_driver_cast (struct output_driver *driver)
 344 {
 345   assert (driver->class == &ascii_driver_class);
 346   return UP_CAST (driver, struct ascii_driver, driver);
 347 }
 348
 349 static struct driver_option *
 350 opt (struct string_map *options, const char *key, const char *default_value)
 351 {
 352   return driver_option_get ("ascii", options, key, default_value);
 353 }
 354
 355 /* Return true iff the terminal appears to be an xterm with
 356    UTF-8 capabilities */
 357 static bool
 358 term_is_utf8_xterm (void)
 359 {
 360   const char *term = getenv ("TERM");
 361   const char *xterm_locale = getenv ("XTERM_LOCAL");
 362   return (term && xterm_locale
 363           && !strcmp (term, "xterm")
 364           && (strcasestr (xterm_locale, "utf8")
 365               || strcasestr (xterm_locale, "utf-8")));
 366 }
 367
 368 static struct output_driver *
 369 ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
 370               struct string_map *o)
 371 {
 372   bool append = parse_boolean (opt (o, "append", "false"));
 373   FILE *file = fn_open (fh, append ? "a" : "w");
 374   if (!file)
 375     {
 376       msg_error (errno, _("ascii: opening output file `%s'"),
 377                  fh_get_file_name (fh));
 378       return NULL;
 379     }
 380
 381   int width = parse_page_size (opt (o, "width", "-1"));
 382   bool terminal = !strcmp (fh_get_file_name (fh), "-") && isatty (1);
 383
 384   const char *default_box = (terminal && (!strcmp (locale_charset (), "UTF-8")
 385                                           || term_is_utf8_xterm ())
 386                              ? "unicode" : "ascii");
 387   enum { BOX_ASCII, BOX_UNICODE } box = parse_enum (opt (o, "box", default_box),
 388                                                     "ascii", BOX_ASCII,
 389                                                     "unicode", BOX_UNICODE,
 390                                                     NULL_SENTINEL);
 391
 392   static const struct render_ops ascii_render_ops = {
 393     .draw_line = ascii_draw_line,
 394     .measure_cell_width = ascii_measure_cell_width,
 395     .measure_cell_height = ascii_measure_cell_height,
 396     .adjust_break = NULL,
 397     .draw_cell = ascii_draw_cell,
 398   };
 399
 400   static const int ascii_line_widths[TABLE_N_STROKES] = {
 401     [TABLE_STROKE_NONE] = 0,
 402     [TABLE_STROKE_SOLID] = 1,
 403     [TABLE_STROKE_DASHED] = 1,
 404     [TABLE_STROKE_THICK] = 1,
 405     [TABLE_STROKE_THIN] = 1,
 406     [TABLE_STROKE_DOUBLE] = 1,
 407   };
 408
 409   struct ascii_driver *a = xmalloc (sizeof *a);
 410   *a = (struct ascii_driver) {
 411     .driver = {
 412       .class = &ascii_driver_class,
 413       .name = xstrdup (fh_get_file_name (fh)),
 414       .device_type = device_type
 415     },
 416
 417     .emphasis = parse_boolean (opt (o, "emphasis", "false")),
 418     .chart_file_name = parse_chart_file_name (opt (o, "charts",
 419                                                    fh_get_file_name (fh))),
 420
 421     .fg = parse_color (opt (o, "foreground-color", "#000000000000")),
 422     .bg = parse_color (opt (o, "background-color", "#FFFFFFFFFFFF")),
 423
 424     .width_mode = (width > 0 ? FIXED_WIDTH
 425                    : terminal ? TERMINAL_WIDTH
 426                    : VIEW_WIDTH),
 427     .width = width,
 428
 429     .min_hbreak = parse_int (opt (o, "min-hbreak", "-1"), -1, INT_MAX),
 430
 431     .box = box == BOX_ASCII ? get_ascii_box () : get_unicode_box (),
 432
 433     .handle = fh,
 434     .file = file,
 435
 436     .params = (struct render_params) {
 437       .ops = &ascii_render_ops,
 438       .aux = a,
 439       .size = { [H] = a->width, [V] = INT_MAX },
 440       .font_size = { [H] = 1, [V] = 1 },
 441       .line_widths = ascii_line_widths,
 442       .rtl = render_direction_rtl (),
 443       .printing = true,
 444     },
 445   };
 446
 447   if (!update_page_size (a, true))
 448     goto error;
 449
 450   return &a->driver;
 451
 452 error:
 453   output_driver_destroy (&a->driver);
 454   return NULL;
 455 }
 456
 457 static int
 458 parse_page_size (struct driver_option *option)
 459 {
 460   int dim = atol (option->default_value);
 461
 462   if (option->value != NULL)
 463     {
 464       if (!strcmp (option->value, "auto"))
 465         dim = -1;
 466       else
 467         {
 468           int value;
 469           char *tail;
 470
 471           errno = 0;
 472           value = strtol (option->value, &tail, 0);
 473           if (value >= 1 && errno != ERANGE && *tail == '\0')
 474             dim = value;
 475           else
 476             msg (MW, _("%s: %s must be positive integer or `auto'"),
 477                    option->driver_name, option->name);
 478         }
 479     }
 480
 481   driver_option_destroy (option);
 482
 483   return dim;
 484 }
 485
 486 /* Re-calculates the page width based on settings, margins, and, if "auto" is
 487    set, the size of the user's terminal window or GUI output window. */
 488 static bool
 489 update_page_size (struct ascii_driver *a, bool issue_error)
 490 {
 491   enum { MIN_WIDTH = 6 };
 492
 493   int want_width = (a->width_mode == VIEW_WIDTH ? settings_get_viewwidth ()
 494                     : a->width_mode == TERMINAL_WIDTH ? get_terminal_width ()
 495                     : a->width);
 496   bool ok = want_width >= MIN_WIDTH;
 497   if (!ok && issue_error)
 498     msg (ME, _("ascii: page must be at least %d characters wide, but "
 499                "as configured is only %d characters"),
 500          MIN_WIDTH, want_width);
 501
 502   a->width = ok ? want_width : MIN_WIDTH;
 503   a->params.size[H] = a->width;
 504   a->params.min_break[H] = a->min_hbreak >= 0 ? a->min_hbreak : a->width / 2;
 505
 506   return ok;
 507 }
 508
 509 static void
 510 ascii_destroy (struct output_driver *driver)
 511 {
 512   struct ascii_driver *a = ascii_driver_cast (driver);
 513   int i;
 514
 515   if (a->file != NULL)
 516     fn_close (a->handle, a->file);
 517   fh_unref (a->handle);
 518   free (a->chart_file_name);
 519   for (i = 0; i < a->allocated_lines; i++)
 520     u8_line_destroy (&a->lines[i]);
 521   free (a->lines);
 522   free (a);
 523 }
 524
 525 static void
 526 ascii_flush (struct output_driver *driver)
 527 {
 528   struct ascii_driver *a = ascii_driver_cast (driver);
 529   if (a->file)
 530     fflush (a->file);
 531 }
 532
 533 static void
 534 ascii_output_lines (struct ascii_driver *a, size_t n_lines)
 535 {
 536   for (size_t y = 0; y < n_lines; y++)
 537     {
 538       if (y < a->allocated_lines)
 539         {
 540           struct u8_line *line = &a->lines[y];
 541
 542           while (ds_chomp_byte (&line->s, ' '))
 543             continue;
 544           fwrite (ds_data (&line->s), 1, ds_length (&line->s), a->file);
 545           u8_line_clear (&a->lines[y]);
 546         }
 547       putc ('\n', a->file);
 548     }
 549 }
 550
 551 static void
 552 ascii_output_table_item (struct ascii_driver *a,
 553                          const struct output_item *item)
 554 {
 555   update_page_size (a, false);
 556   a->pt = item->table;
 557
 558   size_t *layer_indexes;
 559   PIVOT_OUTPUT_FOR_EACH_LAYER (layer_indexes, item->table, true)
 560     {
 561       struct render_pager *p = render_pager_create (&a->params, item->table,
 562                                                     layer_indexes);
 563       for (int i = 0; render_pager_has_next (p); i++)
 564         {
 565           if (a->n_objects++)
 566             putc ('\n', a->file);
 567
 568           ascii_output_lines (a, render_pager_draw_next (p, INT_MAX));
 569         }
 570       render_pager_destroy (p);
 571     }
 572
 573   a->pt = NULL;
 574 }
 575
 576 static void
 577 ascii_output_table_item_unref (struct ascii_driver *a,
 578                                struct output_item *table_item)
 579 {
 580   ascii_output_table_item (a, table_item);
 581   output_item_unref (table_item);
 582 }
 583
 584 static void
 585 ascii_submit (struct output_driver *driver, const struct output_item *item)
 586 {
 587   struct ascii_driver *a = ascii_driver_cast (driver);
 588   if (a->error)
 589     return;
 590
 591   switch (item->type)
 592     {
 593     case OUTPUT_ITEM_TABLE:
 594       ascii_output_table_item (a, item);
 595       break;
 596
 597     case OUTPUT_ITEM_IMAGE:
 598       if (a->chart_file_name != NULL)
 599         {
 600           char *file_name = xr_write_png_image (
 601             item->image, a->chart_file_name, ++a->n_charts);
 602           if (file_name != NULL)
 603             {
 604               struct output_item *text_item = text_item_create_nocopy (
 605                 TEXT_ITEM_LOG,
 606                 xasprintf (_("See %s for an image."), file_name),
 607                 NULL);
 608
 609               ascii_submit (driver, text_item);
 610               output_item_unref (text_item);
 611               free (file_name);
 612             }
 613         }
 614       break;
 615
 616     case OUTPUT_ITEM_CHART:
 617       if (a->chart_file_name != NULL)
 618         {
 619           char *file_name = xr_draw_png_chart (
 620             item->chart, a->chart_file_name, ++a->n_charts, &a->fg, &a->bg);
 621           if (file_name != NULL)
 622             {
 623               struct output_item *text_item = text_item_create_nocopy (
 624                 TEXT_ITEM_LOG,
 625                 xasprintf (_("See %s for a chart."), file_name),
 626                 NULL);
 627
 628               ascii_submit (driver, text_item);
 629               output_item_unref (text_item);
 630               free (file_name);
 631             }
 632         }
 633       break;
 634
 635     case OUTPUT_ITEM_TEXT:
 636       if (item->text.subtype != TEXT_ITEM_PAGE_TITLE)
 637         ascii_output_table_item_unref (
 638           a, text_item_to_table_item (output_item_ref (item)));
 639       break;
 640
 641     case OUTPUT_ITEM_MESSAGE:
 642       ascii_output_table_item_unref (
 643         a, text_item_to_table_item (
 644           message_item_to_text_item (
 645             output_item_ref (item))));
 646       break;
 647
 648     case OUTPUT_ITEM_GROUP:
 649       break;
 650
 651     case OUTPUT_ITEM_PAGE_BREAK:
 652       break;
 653     }
 654 }
 655
 656 const struct output_driver_factory txt_driver_factory =
 657   { "txt", "-", ascii_create };
 658 const struct output_driver_factory list_driver_factory =
 659   { "list", "-", ascii_create };
 660
 661 static const struct output_driver_class ascii_driver_class =
 662   {
 663     .name = "text",
 664     .destroy = ascii_destroy,
 665     .submit = ascii_submit,
 666     .flush = ascii_flush,
 667   };
 668 \f
 669 static char *ascii_reserve (struct ascii_driver *, int y, int x0, int x1,
 670                             int n);
 671 static void ascii_layout_cell (struct ascii_driver *,
 672                                const struct table_cell *,
 673                                int bb[TABLE_N_AXES][2],
 674                                int clip[TABLE_N_AXES][2],
 675                                int *width, int *height);
 676
 677 static void
 678 ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
 679                  const struct table_border_style styles[TABLE_N_AXES][2])
 680 {
 681   struct ascii_driver *a = a_;
 682   char mbchar[6];
 683   int x0, y0, x1, y1;
 684   ucs4_t uc;
 685   int mblen;
 686   int x, y;
 687
 688   /* Clip to the page. */
 689   x0 = MAX (bb[H][0], 0);
 690   y0 = MAX (bb[V][0], 0);
 691   x1 = MIN (bb[H][1], a->width);
 692   y1 = bb[V][1];
 693   if (x1 <= 0 || y1 <= 0 || x0 >= a->width)
 694     return;
 695
 696   /* Draw. */
 697   enum table_stroke v0 = styles[V][0].stroke;
 698   enum table_stroke v1 = styles[V][1].stroke;
 699   enum table_stroke h0 = styles[H][0].stroke;
 700   enum table_stroke h1 = styles[H][1].stroke;
 701   uc = box_get (a->box, v0, v1, h0, h1);
 702   mblen = u8_uctomb (CHAR_CAST (uint8_t *, mbchar), uc, 6);
 703   for (y = y0; y < y1; y++)
 704     {
 705       char *p = ascii_reserve (a, y, x0, x1, mblen * (x1 - x0));
 706       for (x = x0; x < x1; x++)
 707         {
 708           memcpy (p, mbchar, mblen);
 709           p += mblen;
 710         }
 711     }
 712 }
 713
 714 static void
 715 ascii_measure_cell_width (void *a_, const struct table_cell *cell,
 716                           int *min_width, int *max_width)
 717 {
 718   struct ascii_driver *a = a_;
 719   int bb[TABLE_N_AXES][2];
 720   int clip[TABLE_N_AXES][2];
 721   int h;
 722
 723   bb[H][0] = 0;
 724   bb[H][1] = INT_MAX;
 725   bb[V][0] = 0;
 726   bb[V][1] = INT_MAX;
 727   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
 728   ascii_layout_cell (a, cell, bb, clip, max_width, &h);
 729
 730   bb[H][1] = 1;
 731   ascii_layout_cell (a, cell, bb, clip, min_width, &h);
 732 }
 733
 734 static int
 735 ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
 736 {
 737   struct ascii_driver *a = a_;
 738   int bb[TABLE_N_AXES][2];
 739   int clip[TABLE_N_AXES][2];
 740   int w, h;
 741
 742   bb[H][0] = 0;
 743   bb[H][1] = width;
 744   bb[V][0] = 0;
 745   bb[V][1] = INT_MAX;
 746   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
 747   ascii_layout_cell (a, cell, bb, clip, &w, &h);
 748   return h;
 749 }
 750
 751 static void
 752 ascii_draw_cell (void *a_, const struct table_cell *cell, int color_idx UNUSED,
 753                  int bb[TABLE_N_AXES][2], int valign_offset,
 754                  int spill[TABLE_N_AXES][2] UNUSED,
 755                  int clip[TABLE_N_AXES][2])
 756 {
 757   struct ascii_driver *a = a_;
 758   int w, h;
 759
 760   bb[V][0] += valign_offset;
 761   ascii_layout_cell (a, cell, bb, clip, &w, &h);
 762 }
 763
 764 static char *
 765 ascii_reserve (struct ascii_driver *a, int y, int x0, int x1, int n)
 766 {
 767   if (y >= a->allocated_lines)
 768     {
 769       size_t new_alloc = MAX (25, a->allocated_lines);
 770       while (new_alloc <= y)
 771         new_alloc = xtimes (new_alloc, 2);
 772       a->lines = xnrealloc (a->lines, new_alloc, sizeof *a->lines);
 773       for (size_t i = a->allocated_lines; i < new_alloc; i++)
 774         u8_line_init (&a->lines[i]);
 775       a->allocated_lines = new_alloc;
 776     }
 777   return u8_line_reserve (&a->lines[y], x0, x1, n);
 778 }
 779
 780 static void
 781 text_draw (struct ascii_driver *a, enum table_halign halign, bool numeric,
 782            bool bold, bool underline,
 783            int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
 784            int y, const uint8_t *string, int n, size_t width)
 785 {
 786   int x0 = MAX (0, clip[H][0]);
 787   int y0 = MAX (0, clip[V][0]);
 788   int x1 = MIN (a->width, clip[H][1]);
 789   int y1 = clip[V][1];
 790   int x;
 791
 792   if (y < y0 || y >= y1)
 793     return;
 794
 795   switch (table_halign_interpret (halign, numeric))
 796     {
 797     case TABLE_HALIGN_LEFT:
 798       x = bb[H][0];
 799       break;
 800     case TABLE_HALIGN_CENTER:
 801       x = (bb[H][0] + bb[H][1] - width + 1) / 2;
 802       break;
 803     case TABLE_HALIGN_RIGHT:
 804     case TABLE_HALIGN_DECIMAL:
 805       x = bb[H][1] - width;
 806       break;
 807     default:
 808       NOT_REACHED ();
 809     }
 810   if (x >= x1)
 811     return;
 812
 813   while (x < x0)
 814     {
 815       ucs4_t uc;
 816       int mblen;
 817       int w;
 818
 819       if (n == 0)
 820         return;
 821       mblen = u8_mbtouc (&uc, string, n);
 822
 823       string += mblen;
 824       n -= mblen;
 825
 826       w = uc_width (uc, "UTF-8");
 827       if (w > 0)
 828         {
 829           x += w;
 830           width -= w;
 831         }
 832     }
 833   if (n == 0)
 834     return;
 835
 836   if (x + width > x1)
 837     {
 838       int ofs;
 839
 840       ofs = width = 0;
 841       for (ofs = 0; ofs < n;)
 842         {
 843           ucs4_t uc;
 844           int mblen;
 845           int w;
 846
 847           mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
 848
 849           w = uc_width (uc, "UTF-8");
 850           if (w > 0)
 851             {
 852               if (width + w > x1 - x)
 853                 break;
 854               width += w;
 855             }
 856           ofs += mblen;
 857         }
 858       n = ofs;
 859       if (n == 0)
 860         return;
 861     }
 862
 863   if (!a->emphasis || (!bold && !underline))
 864     memcpy (ascii_reserve (a, y, x, x + width, n), string, n);
 865   else
 866     {
 867       size_t n_out;
 868       size_t ofs;
 869       char *out;
 870       int mblen;
 871
 872       /* First figure out how many bytes need to be inserted. */
 873       n_out = n;
 874       for (ofs = 0; ofs < n; ofs += mblen)
 875         {
 876           ucs4_t uc;
 877           int w;
 878
 879           mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
 880           w = uc_width (uc, "UTF-8");
 881
 882           if (w > 0)
 883             {
 884               if (bold)
 885                 n_out += 1 + mblen;
 886               if (underline)
 887                 n_out += 2;
 888             }
 889         }
 890
 891       /* Then insert them. */
 892       out = ascii_reserve (a, y, x, x + width, n_out);
 893       for (ofs = 0; ofs < n; ofs += mblen)
 894         {
 895           ucs4_t uc;
 896           int w;
 897
 898           mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
 899           w = uc_width (uc, "UTF-8");
 900
 901           if (w > 0)
 902             {
 903               if (bold)
 904                 {
 905                   out = mempcpy (out, string + ofs, mblen);
 906                   *out++ = '\b';
 907                 }
 908               if (underline)
 909                 {
 910                   *out++ = '_';
 911                   *out++ = '\b';
 912                 }
 913             }
 914           out = mempcpy (out, string + ofs, mblen);
 915         }
 916     }
 917 }
 918
 919 static void
 920 ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
 921                    int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
 922                    int *widthp, int *heightp)
 923 {
 924   *widthp = 0;
 925   *heightp = 0;
 926
 927   struct string body = DS_EMPTY_INITIALIZER;
 928   bool numeric = pivot_value_format (cell->value, a->pt, &body);
 929
 930   /* Calculate length; if it's zero, then there's nothing to do. */
 931   if (ds_is_empty (&body))
 932     {
 933       ds_destroy (&body);
 934       return;
 935     }
 936
 937   size_t length = ds_length (&body);
 938   const uint8_t *text = CHAR_CAST (uint8_t *, ds_cstr (&body));
 939
 940   char *breaks = xmalloc (length + 1);
 941   u8_possible_linebreaks (text, length, "UTF-8", breaks);
 942   breaks[length] = (breaks[length - 1] == UC_BREAK_MANDATORY
 943                     ? UC_BREAK_PROHIBITED : UC_BREAK_POSSIBLE);
 944
 945   size_t pos = 0;
 946   int bb_width = bb[H][1] - bb[H][0];
 947   for (int y = bb[V][0]; y < bb[V][1] && pos < length; y++)
 948     {
 949       const uint8_t *line = text + pos;
 950       const char *b = breaks + pos;
 951       size_t n = length - pos;
 952
 953       size_t last_break_ofs = 0;
 954       int last_break_width = 0;
 955       int width = 0;
 956       size_t graph_ofs;
 957       size_t ofs;
 958
 959       for (ofs = 0; ofs < n;)
 960         {
 961           ucs4_t uc;
 962           int mblen;
 963           int w;
 964
 965           mblen = u8_mbtouc (&uc, line + ofs, n - ofs);
 966           if (b[ofs] == UC_BREAK_MANDATORY)
 967             break;
 968           else if (b[ofs] == UC_BREAK_POSSIBLE)
 969             {
 970               last_break_ofs = ofs;
 971               last_break_width = width;
 972             }
 973
 974           w = uc_width (uc, "UTF-8");
 975           if (w > 0)
 976             {
 977               if (width + w > bb_width)
 978                 {
 979                   if (isspace (line[ofs]))
 980                     break;
 981                   else if (last_break_ofs != 0)
 982                     {
 983                       ofs = last_break_ofs;
 984                       width = last_break_width;
 985                       break;
 986                     }
 987                 }
 988               width += w;
 989             }
 990           ofs += mblen;
 991         }
 992
 993       /* Trim any trailing spaces off the end of the text to be drawn. */
 994       for (graph_ofs = ofs; graph_ofs > 0; graph_ofs--)
 995         if (!isspace (line[graph_ofs - 1]))
 996           break;
 997       width -= ofs - graph_ofs;
 998
 999       /* Draw text. */
1000       text_draw (a, cell->cell_style->halign, numeric,
1001                  cell->font_style->bold,
1002                  cell->font_style->underline,
1003                  bb, clip, y, line, graph_ofs, width);
1004
1005       /* If a new-line ended the line, just skip the new-line.  Otherwise, skip
1006          past any spaces past the end of the line (but not past a new-line). */
1007       if (b[ofs] == UC_BREAK_MANDATORY)
1008         ofs++;
1009       else
1010         while (ofs < n && isspace (line[ofs]) && b[ofs] != UC_BREAK_MANDATORY)
1011           ofs++;
1012
1013       if (width > *widthp)
1014         *widthp = width;
1015       ++*heightp;
1016       pos += ofs;
1017     }
1018
1019   free (breaks);
1020   ds_destroy (&body);
1021 }
1022
1023 void
1024 ascii_test_write (struct output_driver *driver,
1025                   const char *s, int x, int y, bool bold, bool underline)
1026 {
1027   struct ascii_driver *a = ascii_driver_cast (driver);
1028   int bb[TABLE_N_AXES][2];
1029   int width, height;
1030
1031   if (!a->file)
1032     return;
1033
1034   struct cell_style cell_style = { .halign = TABLE_HALIGN_LEFT };
1035   struct font_style font_style = {
1036     .bold = bold,
1037     .underline = underline,
1038   };
1039   const struct pivot_value value = {
1040     .text = {
1041       .type = PIVOT_VALUE_TEXT,
1042       .local = CONST_CAST (char *, s),
1043       .c = CONST_CAST (char *, s),
1044       .id = CONST_CAST (char *, s),
1045       .user_provided = true,
1046     },
1047   };
1048   struct table_cell cell = {
1049     .value = &value,
1050     .font_style = &font_style,
1051     .cell_style = &cell_style,
1052   };
1053
1054   bb[TABLE_HORZ][0] = x;
1055   bb[TABLE_HORZ][1] = a->width;
1056   bb[TABLE_VERT][0] = y;
1057   bb[TABLE_VERT][1] = INT_MAX;
1058
1059   struct pivot_table pt = {
1060     .show_values = SETTINGS_VALUE_SHOW_DEFAULT,
1061     .show_variables = SETTINGS_VALUE_SHOW_DEFAULT,
1062   };
1063   a->pt = &pt;
1064   ascii_layout_cell (a, &cell, bb, bb, &width, &height);
1065   a->pt = NULL;
1066 }
1067
1068 void
1069 ascii_test_set_length (struct output_driver *driver, int y, int length)
1070 {
1071   struct ascii_driver *a = ascii_driver_cast (driver);
1072
1073   if (!a->file)
1074     return;
1075
1076   if (y < 0)
1077     return;
1078   u8_line_set_length (&a->lines[y], length);
1079 }
1080
1081 void
1082 ascii_test_flush (struct output_driver *driver)
1083 {
1084   struct ascii_driver *a = ascii_driver_cast (driver);
1085
1086   for (size_t i = a->allocated_lines; i-- > 0;)
1087     if (a->lines[i].width)
1088       {
1089         ascii_output_lines (a, i + 1);
1090         break;
1091       }
1092 }
1093 \f
1094 static sig_atomic_t terminal_changed = true;
1095 static int terminal_width;
1096
1097 #if HAVE_DECL_SIGWINCH
1098 static void
1099 winch_handler (int signum UNUSED)
1100 {
1101   terminal_changed = true;
1102 }
1103 #endif
1104
1105 int
1106 get_terminal_width (void)
1107 {
1108 #if HAVE_DECL_SIGWINCH
1109   static bool setup_signal;
1110   if (!setup_signal)
1111     {
1112       setup_signal = true;
1113
1114       struct sigaction action = { .sa_handler = winch_handler };
1115       sigemptyset (&action.sa_mask);
1116       sigaction (SIGWINCH, &action, NULL);
1117     }
1118 #endif
1119
1120   if (terminal_changed)
1121     {
1122       terminal_changed = false;
1123
1124 #ifdef HAVE_TERMIOS_H
1125       struct winsize ws;
1126       if (!ioctl (0, TIOCGWINSZ, &ws))
1127         terminal_width = ws.ws_col;
1128       else
1129 #endif
1130         {
1131           if (getenv ("COLUMNS"))
1132             terminal_width = atoi (getenv ("COLUMNS"));
1133         }
1134
1135       if (terminal_width <= 0 || terminal_width > 1024)
1136         terminal_width = 79;
1137     }
1138
1139   return terminal_width;
1140 }