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 <termios.h>
  32 #endif
  33
  34 #ifdef GWINSZ_IN_SYS_IOCTL
  35 # include <sys/ioctl.h>
  36 #endif
  37
  38 #include "data/file-name.h"
  39 #include "data/file-handle-def.h"
  40 #include "data/settings.h"
  41 #include "libpspp/assertion.h"
  42 #include "libpspp/cast.h"
  43 #include "libpspp/compiler.h"
  44 #include "libpspp/message.h"
  45 #include "libpspp/start-date.h"
  46 #include "libpspp/string-map.h"
  47 #include "libpspp/u8-line.h"
  48 #include "libpspp/version.h"
  49 #include "output/ascii.h"
  50 #ifdef HAVE_CAIRO
  51 #include "output/cairo-chart.h"
  52 #endif
  53 #include "output/chart-item-provider.h"
  54 #include "output/driver-provider.h"
  55 #include "output/message-item.h"
  56 #include "output/options.h"
  57 #include "output/render.h"
  58 #include "output/table-item.h"
  59 #include "output/text-item.h"
  60
  61 #include "gl/minmax.h"
  62 #include "gl/xalloc.h"
  63 #include "gl/xsize.h"
  64
  65 #include "gettext.h"
  66 #define _(msgid) gettext (msgid)
  67
  68 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
  69 #define H TABLE_HORZ
  70 #define V TABLE_VERT
  71
  72 enum
  73   {
  74     ASCII_LINE_NONE,
  75     ASCII_LINE_DASHED,
  76     ASCII_LINE_SINGLE,
  77     ASCII_LINE_DOUBLE,
  78     ASCII_N_LINES
  79   };
  80
  81 struct box_chars
  82   {
  83     ucs4_t c[ASCII_N_LINES][ASCII_N_LINES][ASCII_N_LINES][ASCII_N_LINES];
  84   };
  85
  86 static const struct box_chars *
  87 get_ascii_box (void)
  88 {
  89   enum {
  90     _ = ASCII_LINE_NONE,
  91     d = ASCII_LINE_DASHED,
  92     S = ASCII_LINE_SINGLE,
  93     D = ASCII_LINE_DOUBLE,
  94   };
  95
  96   static const struct box_chars ascii_box =
  97     {
  98       /* r  b  l   t:  _    d    S    D */
  99       .c[_][_][_] = { ' ', '|', '|', '#', },
 100       .c[_][_][d] = { '-', '+', '+', '#', },
 101       .c[_][_][S] = { '-', '+', '+', '#', },
 102       .c[_][_][D] = { '=', '#', '#', '#', },
 103       .c[_][d][_] = { '|', '|', '|', '#', },
 104       .c[_][d][d] = { '+', '+', '+', '#', },
 105       .c[_][d][S] = { '+', '+', '+', '#', },
 106       .c[_][d][D] = { '#', '#', '#', '#', },
 107       .c[_][S][_] = { '|', '|', '|', '#', },
 108       .c[_][S][d] = { '+', '+', '+', '#', },
 109       .c[_][S][S] = { '+', '+', '+', '#', },
 110       .c[_][S][D] = { '#', '#', '#', '#', },
 111       .c[_][D][_] = { '#', '#', '#', '#', },
 112       .c[_][D][d] = { '#', '#', '#', '#', },
 113       .c[_][D][S] = { '#', '#', '#', '#', },
 114       .c[_][D][D] = { '#', '#', '#', '#', },
 115       .c[d][_][_] = { '-', '+', '+', '#', },
 116       .c[d][_][d] = { '-', '+', '+', '#', },
 117       .c[d][_][S] = { '-', '+', '+', '#', },
 118       .c[d][_][D] = { '#', '#', '#', '#', },
 119       .c[d][d][_] = { '+', '+', '+', '#', },
 120       .c[d][d][d] = { '+', '+', '+', '#', },
 121       .c[d][d][S] = { '+', '+', '+', '#', },
 122       .c[d][d][D] = { '#', '#', '#', '#', },
 123       .c[d][S][_] = { '+', '+', '+', '#', },
 124       .c[d][S][d] = { '+', '+', '+', '#', },
 125       .c[d][S][S] = { '+', '+', '+', '#', },
 126       .c[d][S][D] = { '#', '#', '#', '#', },
 127       .c[d][D][_] = { '#', '#', '#', '#', },
 128       .c[d][D][d] = { '#', '#', '#', '#', },
 129       .c[d][D][S] = { '#', '#', '#', '#', },
 130       .c[d][D][D] = { '#', '#', '#', '#', },
 131       .c[S][_][_] = { '-', '+', '+', '#', },
 132       .c[S][_][d] = { '-', '+', '+', '#', },
 133       .c[S][_][S] = { '-', '+', '+', '#', },
 134       .c[S][_][D] = { '#', '#', '#', '#', },
 135       .c[S][d][_] = { '+', '+', '+', '#', },
 136       .c[S][d][d] = { '+', '+', '+', '#', },
 137       .c[S][d][S] = { '+', '+', '+', '#', },
 138       .c[S][d][D] = { '#', '#', '#', '#', },
 139       .c[S][S][_] = { '+', '+', '+', '#', },
 140       .c[S][S][d] = { '+', '+', '+', '#', },
 141       .c[S][S][S] = { '+', '+', '+', '#', },
 142       .c[S][S][D] = { '#', '#', '#', '#', },
 143       .c[S][D][_] = { '#', '#', '#', '#', },
 144       .c[S][D][d] = { '#', '#', '#', '#', },
 145       .c[S][D][S] = { '#', '#', '#', '#', },
 146       .c[S][D][D] = { '#', '#', '#', '#', },
 147       .c[D][_][_] = { '=', '#', '#', '#', },
 148       .c[D][_][d] = { '#', '#', '#', '#', },
 149       .c[D][_][S] = { '#', '#', '#', '#', },
 150       .c[D][_][D] = { '=', '#', '#', '#', },
 151       .c[D][d][_] = { '#', '#', '#', '#', },
 152       .c[D][d][d] = { '#', '#', '#', '#', },
 153       .c[D][d][S] = { '#', '#', '#', '#', },
 154       .c[D][d][D] = { '#', '#', '#', '#', },
 155       .c[D][S][_] = { '#', '#', '#', '#', },
 156       .c[D][S][d] = { '#', '#', '#', '#', },
 157       .c[D][S][S] = { '#', '#', '#', '#', },
 158       .c[D][S][D] = { '#', '#', '#', '#', },
 159       .c[D][D][_] = { '#', '#', '#', '#', },
 160       .c[D][D][d] = { '#', '#', '#', '#', },
 161       .c[D][D][S] = { '#', '#', '#', '#', },
 162       .c[D][D][D] = { '#', '#', '#', '#', },
 163     };
 164   return &ascii_box;
 165 }
 166
 167 static const struct box_chars *
 168 get_unicode_box (void)
 169 {
 170   enum {
 171     _ = ASCII_LINE_NONE,
 172     d = ASCII_LINE_DASHED,
 173     S = ASCII_LINE_SINGLE,
 174     D = ASCII_LINE_DOUBLE,
 175   };
 176
 177   static const struct box_chars unicode_box =
 178     {
 179       /* r  b  l   t:   _       d       S       D */
 180       .c[_][_][_] = { 0x0020, 0x2575, 0x2575, 0x2551, }, /*  ╵╵║ */
 181       .c[_][_][d] = { 0x2574, 0x256f, 0x256f, 0x255c, }, /* ╴╯╯╜ */
 182       .c[_][_][S] = { 0x2574, 0x256f, 0x256f, 0x255c, }, /* ╴╯╯╜ */
 183       .c[_][_][D] = { 0x2550, 0x255b, 0x255b, 0x255d, }, /* ═╛╛╝ */
 184       .c[_][S][_] = { 0x2577, 0x2502, 0x2502, 0x2551, }, /* ╷││║ */
 185       .c[_][S][d] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
 186       .c[_][S][S] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
 187       .c[_][S][D] = { 0x2555, 0x2561, 0x2561, 0x2563, }, /* ╕╡╡╣ */
 188       .c[_][d][_] = { 0x2577, 0x250a, 0x2502, 0x2551, }, /* ╷┊│║ */
 189       .c[_][d][d] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
 190       .c[_][d][S] = { 0x256e, 0x2524, 0x2524, 0x2562, }, /* ╮┤┤╢ */
 191       .c[_][d][D] = { 0x2555, 0x2561, 0x2561, 0x2563, }, /* ╕╡╡╣ */
 192       .c[_][D][_] = { 0x2551, 0x2551, 0x2551, 0x2551, }, /* ║║║║ */
 193       .c[_][D][d] = { 0x2556, 0x2562, 0x2562, 0x2562, }, /* ╖╢╢╢ */
 194       .c[_][D][S] = { 0x2556, 0x2562, 0x2562, 0x2562, }, /* ╖╢╢╢ */
 195       .c[_][D][D] = { 0x2557, 0x2563, 0x2563, 0x2563, }, /* ╗╣╣╣ */
 196       .c[d][_][_] = { 0x2576, 0x2570, 0x2570, 0x2559, }, /* ╶╰╰╙ */
 197       .c[d][_][d] = { 0x254c, 0x2534, 0x2534, 0x2568, }, /* ╌┴┴╨ */
 198       .c[d][_][S] = { 0x2500, 0x2534, 0x2534, 0x2568, }, /* ─┴┴╨ */
 199       .c[d][_][D] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
 200       .c[d][d][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
 201       .c[d][d][d] = { 0x252c, 0x002b, 0x253c, 0x256a, }, /* ┬+┼╪ */
 202       .c[d][d][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 203       .c[d][d][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 204       .c[d][S][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
 205       .c[d][S][d] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 206       .c[d][S][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 207       .c[d][S][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 208       .c[d][D][_] = { 0x2553, 0x255f, 0x255f, 0x255f, }, /* ╓╟╟╟ */
 209       .c[d][D][d] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
 210       .c[d][D][S] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
 211       .c[d][D][D] = { 0x2566, 0x256c, 0x256c, 0x256c, }, /* ╦╬╬╬ */
 212       .c[S][_][_] = { 0x2576, 0x2570, 0x2570, 0x2559, }, /* ╶╰╰╙ */
 213       .c[S][_][d] = { 0x2500, 0x2534, 0x2534, 0x2568, }, /* ─┴┴╨ */
 214       .c[S][_][S] = { 0x2500, 0x2534, 0x2534, 0x2568, }, /* ─┴┴╨ */
 215       .c[S][_][D] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
 216       .c[S][d][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
 217       .c[S][d][d] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 218       .c[S][d][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 219       .c[S][d][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 220       .c[S][S][_] = { 0x256d, 0x251c, 0x251c, 0x255f, }, /* ╭├├╟ */
 221       .c[S][S][d] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 222       .c[S][S][S] = { 0x252c, 0x253c, 0x253c, 0x256a, }, /* ┬┼┼╪ */
 223       .c[S][S][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 224       .c[S][D][_] = { 0x2553, 0x255f, 0x255f, 0x255f, }, /* ╓╟╟╟ */
 225       .c[S][D][d] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
 226       .c[S][D][S] = { 0x2565, 0x256b, 0x256b, 0x256b, }, /* ╥╫╫╫ */
 227       .c[S][D][D] = { 0x2566, 0x256c, 0x256c, 0x256c, }, /* ╦╬╬╬ */
 228       .c[D][_][_] = { 0x2550, 0x2558, 0x2558, 0x255a, }, /* ═╘╘╚ */
 229       .c[D][_][d] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
 230       .c[D][_][S] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
 231       .c[D][_][D] = { 0x2550, 0x2567, 0x2567, 0x2569, }, /* ═╧╧╩ */
 232       .c[D][d][_] = { 0x2552, 0x255e, 0x255e, 0x2560, }, /* ╒╞╞╠ */
 233       .c[D][d][d] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 234       .c[D][d][S] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 235       .c[D][d][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 236       .c[D][S][_] = { 0x2552, 0x255e, 0x255e, 0x2560, }, /* ╒╞╞╠ */
 237       .c[D][S][d] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 238       .c[D][S][S] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 239       .c[D][S][D] = { 0x2564, 0x256a, 0x256a, 0x256c, }, /* ╤╪╪╬ */
 240       .c[D][D][_] = { 0x2554, 0x2560, 0x2560, 0x2560, }, /* ╔╠╠╠ */
 241       .c[D][D][d] = { 0x2560, 0x256c, 0x256c, 0x256c, }, /* ╠╬╬╬ */
 242       .c[D][D][S] = { 0x2560, 0x256c, 0x256c, 0x256c, }, /* ╠╬╬╬ */
 243       .c[D][D][D] = { 0x2566, 0x256c, 0x256c, 0x256c, }, /* ╦╬╬╬ */
 244     };
 245   return &unicode_box;
 246 }
 247
 248 static int
 249 ascii_line_from_render_line (int render_line)
 250 {
 251   switch (render_line)
 252     {
 253     case RENDER_LINE_NONE:
 254       return ASCII_LINE_NONE;
 255
 256     case RENDER_LINE_DASHED:
 257       return ASCII_LINE_DASHED;
 258
 259     case RENDER_LINE_SINGLE:
 260     case RENDER_LINE_THICK:
 261     case RENDER_LINE_THIN:
 262       return ASCII_LINE_SINGLE;
 263
 264     case RENDER_LINE_DOUBLE:
 265       return ASCII_LINE_DOUBLE;
 266
 267     default:
 268       return ASCII_LINE_NONE;
 269     }
 270
 271 }
 272
 273 static ucs4_t
 274 box_get (const struct box_chars *box,
 275          int left_, int right_, int top_, int bottom_)
 276 {
 277   bool rtl = render_direction_rtl ();
 278   int left = ascii_line_from_render_line (rtl ? right_ : left_);
 279   int right = ascii_line_from_render_line (rtl ? left_ : right_);
 280   int top = ascii_line_from_render_line (top_);
 281   int bottom = ascii_line_from_render_line (bottom_);
 282
 283   return box->c[right][bottom][left][top];
 284 }
 285
 286 /* ASCII output driver. */
 287 struct ascii_driver
 288   {
 289     struct output_driver driver;
 290
 291     /* User parameters. */
 292     bool append;                /* Append if output file already exists? */
 293     bool emphasis;              /* Enable bold and underline in output? */
 294     char *chart_file_name;      /* Name of files used for charts. */
 295
 296 #ifdef HAVE_CAIRO
 297     /* Colours for charts */
 298     struct cell_color fg;
 299     struct cell_color bg;
 300 #endif
 301
 302     /* How the page width is determined: */
 303     enum {
 304       FIXED_WIDTH,              /* Specified by configuration. */
 305       VIEW_WIDTH,               /* From SET WIDTH. */
 306       TERMINAL_WIDTH            /* From the terminal's width. */
 307     } width_mode;
 308     int width;                  /* Page width. */
 309
 310     int min_hbreak;             /* Min cell size to break across pages. */
 311
 312     const struct box_chars *box; /* Line & box drawing characters. */
 313
 314     /* Internal state. */
 315     struct file_handle *handle;
 316     FILE *file;                 /* Output file. */
 317     bool error;                 /* Output error? */
 318     struct u8_line *lines;      /* Page content. */
 319     int allocated_lines;        /* Number of lines allocated. */
 320     int chart_cnt;              /* Number of charts so far. */
 321     int object_cnt;             /* Number of objects so far. */
 322     struct render_params params;
 323   };
 324
 325 static const struct output_driver_class ascii_driver_class;
 326
 327 static void ascii_submit (struct output_driver *, const struct output_item *);
 328
 329 static int get_terminal_width (void);
 330
 331 static bool update_page_size (struct ascii_driver *, bool issue_error);
 332 static int parse_page_size (struct driver_option *);
 333
 334 static void ascii_draw_line (void *, int bb[TABLE_N_AXES][2],
 335                              enum render_line_style styles[TABLE_N_AXES][2],
 336                              struct cell_color colors[TABLE_N_AXES][2]);
 337 static void ascii_measure_cell_width (void *, const struct table_cell *,
 338                                       int *min, int *max);
 339 static int ascii_measure_cell_height (void *, const struct table_cell *,
 340                                       int width);
 341 static void ascii_draw_cell (void *, const struct table_cell *, int color_idx,
 342                              int bb[TABLE_N_AXES][2], int valign_offset,
 343                              int spill[TABLE_N_AXES][2],
 344                              int clip[TABLE_N_AXES][2]);
 345
 346 static struct ascii_driver *
 347 ascii_driver_cast (struct output_driver *driver)
 348 {
 349   assert (driver->class == &ascii_driver_class);
 350   return UP_CAST (driver, struct ascii_driver, driver);
 351 }
 352
 353 static struct driver_option *
 354 opt (struct output_driver *d, struct string_map *options, const char *key,
 355      const char *default_value)
 356 {
 357   return driver_option_get (d, options, key, default_value);
 358 }
 359
 360 /* Return true iff the terminal appears to be an xterm with
 361    UTF-8 capabilities */
 362 static bool
 363 term_is_utf8_xterm (void)
 364 {
 365   const char *term = getenv ("TERM");
 366   const char *xterm_locale = getenv ("XTERM_LOCAL");
 367   return (term && xterm_locale
 368           && !strcmp (term, "xterm")
 369           && (strcasestr (xterm_locale, "utf8")
 370               || strcasestr (xterm_locale, "utf-8")));
 371 }
 372
 373 static struct output_driver *
 374 ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
 375               struct string_map *o)
 376 {
 377   enum { BOX_ASCII, BOX_UNICODE } box;
 378   struct output_driver *d;
 379   struct ascii_driver *a;
 380
 381   a = xzalloc (sizeof *a);
 382   d = &a->driver;
 383   output_driver_init (&a->driver, &ascii_driver_class, fh_get_file_name (fh), device_type);
 384   a->append = parse_boolean (opt (d, o, "append", "false"));
 385   a->emphasis = parse_boolean (opt (d, o, "emphasis", "false"));
 386
 387   a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", fh_get_file_name (fh)));
 388   a->handle = fh;
 389
 390
 391   bool terminal = !strcmp (fh_get_file_name (fh), "-") && isatty (1);
 392   a->width = parse_page_size (opt (d, o, "width", "-1"));
 393   a->width_mode = (a->width > 0 ? FIXED_WIDTH
 394                    : terminal ? TERMINAL_WIDTH
 395                    : VIEW_WIDTH);
 396   a->min_hbreak = parse_int (opt (d, o, "min-hbreak", "-1"), -1, INT_MAX);
 397
 398 #ifdef HAVE_CAIRO
 399   a->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
 400   a->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
 401 #endif
 402
 403   const char *default_box = (terminal && (!strcmp (locale_charset (), "UTF-8")
 404                                           || term_is_utf8_xterm ())
 405                              ? "unicode" : "ascii");
 406   box = parse_enum (opt (d, o, "box", default_box),
 407                     "ascii", BOX_ASCII,
 408                     "unicode", BOX_UNICODE,
 409                     NULL_SENTINEL);
 410   a->box = box == BOX_ASCII ? get_ascii_box () : get_unicode_box ();
 411
 412   a->file = NULL;
 413   a->error = false;
 414   a->lines = NULL;
 415   a->allocated_lines = 0;
 416   a->chart_cnt = 0;
 417   a->object_cnt = 0;
 418
 419   static const struct render_ops ascii_render_ops = {
 420     .draw_line = ascii_draw_line,
 421     .measure_cell_width = ascii_measure_cell_width,
 422     .measure_cell_height = ascii_measure_cell_height,
 423     .adjust_break = NULL,
 424     .draw_cell = ascii_draw_cell,
 425   };
 426   a->params.ops = &ascii_render_ops;
 427   a->params.aux = a;
 428   a->params.size[H] = a->width;
 429   a->params.size[V] = INT_MAX;
 430   a->params.font_size[H] = 1;
 431   a->params.font_size[V] = 1;
 432
 433   static const int ascii_line_widths[RENDER_N_LINES] = {
 434     [RENDER_LINE_NONE] = 0,
 435     [RENDER_LINE_SINGLE] = 1,
 436     [RENDER_LINE_DASHED] = 1,
 437     [RENDER_LINE_THICK] = 1,
 438     [RENDER_LINE_THIN] = 1,
 439     [RENDER_LINE_DOUBLE] = 1,
 440   };
 441   a->params.line_widths = ascii_line_widths;
 442   a->params.supports_margins = false;
 443   a->params.rtl = render_direction_rtl ();
 444
 445   if (!update_page_size (a, true))
 446     goto error;
 447
 448   a->file = fn_open (a->handle, a->append ? "a" : "w");
 449   if (!a->file)
 450     {
 451       msg_error (errno, _("ascii: opening output file `%s'"),
 452                  fh_get_file_name (a->handle));
 453       goto error;
 454     }
 455
 456   return d;
 457
 458 error:
 459   output_driver_destroy (d);
 460   return NULL;
 461 }
 462
 463 static int
 464 parse_page_size (struct driver_option *option)
 465 {
 466   int dim = atol (option->default_value);
 467
 468   if (option->value != NULL)
 469     {
 470       if (!strcmp (option->value, "auto"))
 471         dim = -1;
 472       else
 473         {
 474           int value;
 475           char *tail;
 476
 477           errno = 0;
 478           value = strtol (option->value, &tail, 0);
 479           if (value >= 1 && errno != ERANGE && *tail == '\0')
 480             dim = value;
 481           else
 482             msg (MW, _("%s: %s must be positive integer or `auto'"),
 483                    option->driver_name, option->name);
 484         }
 485     }
 486
 487   driver_option_destroy (option);
 488
 489   return dim;
 490 }
 491
 492 /* Re-calculates the page width based on settings, margins, and, if "auto" is
 493    set, the size of the user's terminal window or GUI output window. */
 494 static bool
 495 update_page_size (struct ascii_driver *a, bool issue_error)
 496 {
 497   enum { MIN_WIDTH = 6 };
 498
 499   int want_width = (a->width_mode == VIEW_WIDTH ? settings_get_viewwidth ()
 500                     : a->width_mode == TERMINAL_WIDTH ? get_terminal_width ()
 501                     : a->width);
 502   bool ok = want_width >= MIN_WIDTH;
 503   if (!ok && issue_error)
 504     msg (ME, _("ascii: page must be at least %d characters wide, but "
 505                "as configured is only %d characters"),
 506          MIN_WIDTH, want_width);
 507
 508   a->width = ok ? want_width : MIN_WIDTH;
 509   a->params.size[H] = a->width;
 510   a->params.min_break[H] = a->min_hbreak >= 0 ? a->min_hbreak : a->width / 2;
 511
 512   return ok;
 513 }
 514
 515 static void
 516 ascii_destroy (struct output_driver *driver)
 517 {
 518   struct ascii_driver *a = ascii_driver_cast (driver);
 519   int i;
 520
 521   if (a->file != NULL)
 522     fn_close (a->handle, a->file);
 523   fh_unref (a->handle);
 524   free (a->chart_file_name);
 525   for (i = 0; i < a->allocated_lines; i++)
 526     u8_line_destroy (&a->lines[i]);
 527   free (a->lines);
 528   free (a);
 529 }
 530
 531 static void
 532 ascii_flush (struct output_driver *driver)
 533 {
 534   struct ascii_driver *a = ascii_driver_cast (driver);
 535   if (a->file)
 536     fflush (a->file);
 537 }
 538
 539 static void
 540 ascii_output_lines (struct ascii_driver *a, size_t n_lines)
 541 {
 542   for (size_t y = 0; y < n_lines; y++)
 543     {
 544       if (y < a->allocated_lines)
 545         {
 546           struct u8_line *line = &a->lines[y];
 547
 548           while (ds_chomp_byte (&line->s, ' '))
 549             continue;
 550           fwrite (ds_data (&line->s), 1, ds_length (&line->s), a->file);
 551           u8_line_clear (&a->lines[y]);
 552         }
 553       putc ('\n', a->file);
 554     }
 555 }
 556
 557 static void
 558 ascii_output_table_item (struct ascii_driver *a,
 559                          const struct table_item *table_item)
 560 {
 561   struct render_pager *p;
 562
 563   update_page_size (a, false);
 564
 565   if (a->object_cnt++)
 566     putc ('\n', a->file);
 567
 568   p = render_pager_create (&a->params, table_item);
 569   for (int i = 0; render_pager_has_next (p); i++)
 570     {
 571       if (i)
 572         putc ('\n', a->file);
 573       ascii_output_lines (a, render_pager_draw_next (p, INT_MAX));
 574     }
 575   render_pager_destroy (p);
 576 }
 577
 578 static void
 579 ascii_output_table_item_unref (struct ascii_driver *a,
 580                                struct table_item *table_item)
 581 {
 582   ascii_output_table_item (a, table_item);
 583   table_item_unref (table_item);
 584 }
 585
 586 static void
 587 ascii_submit (struct output_driver *driver,
 588               const struct output_item *output_item)
 589 {
 590   struct ascii_driver *a = ascii_driver_cast (driver);
 591
 592   if (a->error)
 593     return;
 594
 595   if (is_table_item (output_item))
 596     ascii_output_table_item (a, to_table_item (output_item));
 597 #ifdef HAVE_CAIRO
 598   else if (is_chart_item (output_item) && a->chart_file_name != NULL)
 599     {
 600       struct chart_item *chart_item = to_chart_item (output_item);
 601       char *file_name;
 602
 603       file_name = xr_draw_png_chart (chart_item, a->chart_file_name,
 604                                      ++a->chart_cnt,
 605                                      &a->fg,
 606                                      &a->bg);
 607       if (file_name != NULL)
 608         {
 609           struct text_item *text_item;
 610
 611           text_item = text_item_create_format (
 612             TEXT_ITEM_LOG, _("See %s for a chart."), file_name);
 613
 614           ascii_submit (driver, &text_item->output_item);
 615           text_item_unref (text_item);
 616           free (file_name);
 617         }
 618     }
 619 #endif  /* HAVE_CAIRO */
 620   else if (is_text_item (output_item))
 621     {
 622       const struct text_item *text_item = to_text_item (output_item);
 623       enum text_item_type type = text_item_get_type (text_item);
 624
 625       if (type != TEXT_ITEM_PAGE_TITLE)
 626         ascii_output_table_item_unref (
 627           a, text_item_to_table_item (text_item_ref (text_item)));
 628     }
 629   else if (is_message_item (output_item))
 630     ascii_output_table_item_unref (
 631       a, text_item_to_table_item (
 632         message_item_to_text_item (
 633           to_message_item (
 634             output_item_ref (output_item)))));
 635 }
 636
 637 const struct output_driver_factory txt_driver_factory =
 638   { "txt", "-", ascii_create };
 639 const struct output_driver_factory list_driver_factory =
 640   { "list", "-", ascii_create };
 641
 642 static const struct output_driver_class ascii_driver_class =
 643   {
 644     "text",
 645     ascii_destroy,
 646     ascii_submit,
 647     ascii_flush,
 648   };
 649 \f
 650 static char *ascii_reserve (struct ascii_driver *, int y, int x0, int x1,
 651                             int n);
 652 static void ascii_layout_cell (struct ascii_driver *,
 653                                const struct table_cell *,
 654                                int bb[TABLE_N_AXES][2],
 655                                int clip[TABLE_N_AXES][2],
 656                                int *width, int *height);
 657
 658 static void
 659 ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
 660                  enum render_line_style styles[TABLE_N_AXES][2],
 661                  struct cell_color colors[TABLE_N_AXES][2] UNUSED)
 662 {
 663   struct ascii_driver *a = a_;
 664   char mbchar[6];
 665   int x0, y0, x1, y1;
 666   ucs4_t uc;
 667   int mblen;
 668   int x, y;
 669
 670   /* Clip to the page. */
 671   x0 = MAX (bb[H][0], 0);
 672   y0 = MAX (bb[V][0], 0);
 673   x1 = MIN (bb[H][1], a->width);
 674   y1 = bb[V][1];
 675   if (x1 <= 0 || y1 <= 0 || x0 >= a->width)
 676     return;
 677
 678   /* Draw. */
 679   uc = box_get (a->box, styles[V][0], styles[V][1], styles[H][0], styles[H][1]);
 680   mblen = u8_uctomb (CHAR_CAST (uint8_t *, mbchar), uc, 6);
 681   for (y = y0; y < y1; y++)
 682     {
 683       char *p = ascii_reserve (a, y, x0, x1, mblen * (x1 - x0));
 684       for (x = x0; x < x1; x++)
 685         {
 686           memcpy (p, mbchar, mblen);
 687           p += mblen;
 688         }
 689     }
 690 }
 691
 692 static void
 693 ascii_measure_cell_width (void *a_, const struct table_cell *cell,
 694                           int *min_width, int *max_width)
 695 {
 696   struct ascii_driver *a = a_;
 697   int bb[TABLE_N_AXES][2];
 698   int clip[TABLE_N_AXES][2];
 699   int h;
 700
 701   bb[H][0] = 0;
 702   bb[H][1] = INT_MAX;
 703   bb[V][0] = 0;
 704   bb[V][1] = INT_MAX;
 705   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
 706   ascii_layout_cell (a, cell, bb, clip, max_width, &h);
 707
 708   if (cell->n_footnotes || strchr (cell->text, ' ')
 709       || cell->n_subscripts || cell->superscript)
 710     {
 711       bb[H][1] = 1;
 712       ascii_layout_cell (a, cell, bb, clip, min_width, &h);
 713     }
 714   else
 715     *min_width = *max_width;
 716 }
 717
 718 static int
 719 ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
 720 {
 721   struct ascii_driver *a = a_;
 722   int bb[TABLE_N_AXES][2];
 723   int clip[TABLE_N_AXES][2];
 724   int w, h;
 725
 726   bb[H][0] = 0;
 727   bb[H][1] = width;
 728   bb[V][0] = 0;
 729   bb[V][1] = INT_MAX;
 730   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
 731   ascii_layout_cell (a, cell, bb, clip, &w, &h);
 732   return h;
 733 }
 734
 735 static void
 736 ascii_draw_cell (void *a_, const struct table_cell *cell, int color_idx UNUSED,
 737                  int bb[TABLE_N_AXES][2], int valign_offset,
 738                  int spill[TABLE_N_AXES][2] UNUSED,
 739                  int clip[TABLE_N_AXES][2])
 740 {
 741   struct ascii_driver *a = a_;
 742   int w, h;
 743
 744   bb[V][0] += valign_offset;
 745   ascii_layout_cell (a, cell, bb, clip, &w, &h);
 746 }
 747
 748 static char *
 749 ascii_reserve (struct ascii_driver *a, int y, int x0, int x1, int n)
 750 {
 751   if (y >= a->allocated_lines)
 752     {
 753       size_t new_alloc = MAX (25, a->allocated_lines);
 754       while (new_alloc <= y)
 755         new_alloc = xtimes (new_alloc, 2);
 756       a->lines = xnrealloc (a->lines, new_alloc, sizeof *a->lines);
 757       for (size_t i = a->allocated_lines; i < new_alloc; i++)
 758         u8_line_init (&a->lines[i]);
 759       a->allocated_lines = new_alloc;
 760     }
 761   return u8_line_reserve (&a->lines[y], x0, x1, n);
 762 }
 763
 764 static void
 765 text_draw (struct ascii_driver *a, enum table_halign halign, int options,
 766            bool bold, bool underline,
 767            int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
 768            int y, const uint8_t *string, int n, size_t width)
 769 {
 770   int x0 = MAX (0, clip[H][0]);
 771   int y0 = MAX (0, clip[V][0]);
 772   int x1 = MIN (a->width, clip[H][1]);
 773   int y1 = clip[V][1];
 774   int x;
 775
 776   if (y < y0 || y >= y1)
 777     return;
 778
 779   switch (table_halign_interpret (halign, options & TAB_NUMERIC))
 780     {
 781     case TABLE_HALIGN_LEFT:
 782       x = bb[H][0];
 783       break;
 784     case TABLE_HALIGN_CENTER:
 785       x = (bb[H][0] + bb[H][1] - width + 1) / 2;
 786       break;
 787     case TABLE_HALIGN_RIGHT:
 788     case TABLE_HALIGN_DECIMAL:
 789       x = bb[H][1] - width;
 790       break;
 791     default:
 792       NOT_REACHED ();
 793     }
 794   if (x >= x1)
 795     return;
 796
 797   while (x < x0)
 798     {
 799       ucs4_t uc;
 800       int mblen;
 801       int w;
 802
 803       if (n == 0)
 804         return;
 805       mblen = u8_mbtouc (&uc, string, n);
 806
 807       string += mblen;
 808       n -= mblen;
 809
 810       w = uc_width (uc, "UTF-8");
 811       if (w > 0)
 812         {
 813           x += w;
 814           width -= w;
 815         }
 816     }
 817   if (n == 0)
 818     return;
 819
 820   if (x + width > x1)
 821     {
 822       int ofs;
 823
 824       ofs = width = 0;
 825       for (ofs = 0; ofs < n;)
 826         {
 827           ucs4_t uc;
 828           int mblen;
 829           int w;
 830
 831           mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
 832
 833           w = uc_width (uc, "UTF-8");
 834           if (w > 0)
 835             {
 836               if (width + w > x1 - x)
 837                 break;
 838               width += w;
 839             }
 840           ofs += mblen;
 841         }
 842       n = ofs;
 843       if (n == 0)
 844         return;
 845     }
 846
 847   if (!a->emphasis || (!bold && !underline))
 848     memcpy (ascii_reserve (a, y, x, x + width, n), string, n);
 849   else
 850     {
 851       size_t n_out;
 852       size_t ofs;
 853       char *out;
 854       int mblen;
 855
 856       /* First figure out how many bytes need to be inserted. */
 857       n_out = n;
 858       for (ofs = 0; ofs < n; ofs += mblen)
 859         {
 860           ucs4_t uc;
 861           int w;
 862
 863           mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
 864           w = uc_width (uc, "UTF-8");
 865
 866           if (w > 0)
 867             {
 868               if (bold)
 869                 n_out += 1 + mblen;
 870               if (underline)
 871                 n_out += 2;
 872             }
 873         }
 874
 875       /* Then insert them. */
 876       out = ascii_reserve (a, y, x, x + width, n_out);
 877       for (ofs = 0; ofs < n; ofs += mblen)
 878         {
 879           ucs4_t uc;
 880           int w;
 881
 882           mblen = u8_mbtouc (&uc, string + ofs, n - ofs);
 883           w = uc_width (uc, "UTF-8");
 884
 885           if (w > 0)
 886             {
 887               if (bold)
 888                 {
 889                   out = mempcpy (out, string + ofs, mblen);
 890                   *out++ = '\b';
 891                 }
 892               if (underline)
 893                 {
 894                   *out++ = '_';
 895                   *out++ = '\b';
 896                 }
 897             }
 898           out = mempcpy (out, string + ofs, mblen);
 899         }
 900     }
 901 }
 902
 903 static char *
 904 add_markers (const char *text, const struct table_cell *cell)
 905 {
 906   struct string s = DS_EMPTY_INITIALIZER;
 907   ds_put_cstr (&s, text);
 908   for (size_t i = 0; i < cell->n_subscripts; i++)
 909     ds_put_format (&s, "%c%s", i ? ',' : '_', cell->subscripts[i]);
 910   if (cell->superscript)
 911     ds_put_format (&s, "^%s", cell->superscript);
 912   for (size_t i = 0; i < cell->n_footnotes; i++)
 913     ds_put_format (&s, "[%s]", cell->footnotes[i]->marker);
 914   return ds_steal_cstr (&s);
 915 }
 916
 917 static void
 918 ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
 919                    int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
 920                    int *widthp, int *heightp)
 921 {
 922   *widthp = 0;
 923   *heightp = 0;
 924
 925   /* Get the basic textual contents. */
 926   const char *plain_text = (cell->options & TAB_MARKUP
 927                             ? output_get_text_from_markup (cell->text)
 928                             : cell->text);
 929
 930   /* Append footnotes, subscripts, superscript if any. */
 931   const char *text;
 932   if (cell->n_footnotes || cell->n_subscripts || cell->superscript)
 933     {
 934       text = add_markers (plain_text, cell);
 935       if (plain_text != cell->text)
 936         free (CONST_CAST (char *, plain_text));
 937     }
 938   else
 939     text = plain_text;
 940
 941   /* Calculate length; if it's zero, then there's nothing to do. */
 942   size_t length = strlen (text);
 943   if (!length)
 944     {
 945       if (text != cell->text)
 946         free (CONST_CAST (char *, text));
 947       return;
 948     }
 949
 950   char *breaks = xmalloc (length + 1);
 951   u8_possible_linebreaks (CHAR_CAST (const uint8_t *, text), length,
 952                           "UTF-8", breaks);
 953   breaks[length] = (breaks[length - 1] == UC_BREAK_MANDATORY
 954                     ? UC_BREAK_PROHIBITED : UC_BREAK_POSSIBLE);
 955
 956   size_t pos = 0;
 957   int bb_width = bb[H][1] - bb[H][0];
 958   for (int y = bb[V][0]; y < bb[V][1] && pos < length; y++)
 959     {
 960       const uint8_t *line = CHAR_CAST (const uint8_t *, text + pos);
 961       const char *b = breaks + pos;
 962       size_t n = length - pos;
 963
 964       size_t last_break_ofs = 0;
 965       int last_break_width = 0;
 966       int width = 0;
 967       size_t graph_ofs;
 968       size_t ofs;
 969
 970       for (ofs = 0; ofs < n;)
 971         {
 972           ucs4_t uc;
 973           int mblen;
 974           int w;
 975
 976           mblen = u8_mbtouc (&uc, line + ofs, n - ofs);
 977           if (b[ofs] == UC_BREAK_MANDATORY)
 978             break;
 979           else if (b[ofs] == UC_BREAK_POSSIBLE)
 980             {
 981               last_break_ofs = ofs;
 982               last_break_width = width;
 983             }
 984
 985           w = uc_width (uc, "UTF-8");
 986           if (w > 0)
 987             {
 988               if (width + w > bb_width)
 989                 {
 990                   if (isspace (line[ofs]))
 991                     break;
 992                   else if (last_break_ofs != 0)
 993                     {
 994                       ofs = last_break_ofs;
 995                       width = last_break_width;
 996                       break;
 997                     }
 998                 }
 999               width += w;
1000             }
1001           ofs += mblen;
1002         }
1003
1004       /* Trim any trailing spaces off the end of the text to be drawn. */
1005       for (graph_ofs = ofs; graph_ofs > 0; graph_ofs--)
1006         if (!isspace (line[graph_ofs - 1]))
1007           break;
1008       width -= ofs - graph_ofs;
1009
1010       /* Draw text. */
1011       text_draw (a, cell->style->cell_style.halign, cell->options,
1012                  cell->style->font_style.bold,
1013                  cell->style->font_style.underline,
1014                  bb, clip, y, line, graph_ofs, width);
1015
1016       /* If a new-line ended the line, just skip the new-line.  Otherwise, skip
1017          past any spaces past the end of the line (but not past a new-line). */
1018       if (b[ofs] == UC_BREAK_MANDATORY)
1019         ofs++;
1020       else
1021         while (ofs < n && isspace (line[ofs]) && b[ofs] != UC_BREAK_MANDATORY)
1022           ofs++;
1023
1024       if (width > *widthp)
1025         *widthp = width;
1026       ++*heightp;
1027       pos += ofs;
1028     }
1029
1030   free (breaks);
1031   if (text != cell->text)
1032     free (CONST_CAST (char *, text));
1033 }
1034
1035 void
1036 ascii_test_write (struct output_driver *driver,
1037                   const char *s, int x, int y, bool bold, bool underline)
1038 {
1039   struct ascii_driver *a = ascii_driver_cast (driver);
1040   int bb[TABLE_N_AXES][2];
1041   int width, height;
1042
1043   if (!a->file)
1044     return;
1045
1046   struct table_area_style style = {
1047     .cell_style.halign = TABLE_HALIGN_LEFT,
1048     .font_style.bold = bold,
1049     .font_style.underline = underline,
1050   };
1051   struct table_cell cell = {
1052     .text = CONST_CAST (char *, s),
1053     .style = &style,
1054   };
1055
1056   bb[TABLE_HORZ][0] = x;
1057   bb[TABLE_HORZ][1] = a->width;
1058   bb[TABLE_VERT][0] = y;
1059   bb[TABLE_VERT][1] = INT_MAX;
1060
1061   ascii_layout_cell (a, &cell, bb, bb, &width, &height);
1062 }
1063
1064 void
1065 ascii_test_set_length (struct output_driver *driver, int y, int length)
1066 {
1067   struct ascii_driver *a = ascii_driver_cast (driver);
1068
1069   if (!a->file)
1070     return;
1071
1072   if (y < 0)
1073     return;
1074   u8_line_set_length (&a->lines[y], length);
1075 }
1076
1077 void
1078 ascii_test_flush (struct output_driver *driver)
1079 {
1080   struct ascii_driver *a = ascii_driver_cast (driver);
1081
1082   for (size_t i = a->allocated_lines; i-- > 0;)
1083     if (a->lines[i].width)
1084       {
1085         ascii_output_lines (a, i + 1);
1086         break;
1087       }
1088 }
1089 \f
1090 static sig_atomic_t terminal_changed = true;
1091 static int terminal_width;
1092
1093 #if HAVE_DECL_SIGWINCH
1094 static void
1095 winch_handler (int signum UNUSED)
1096 {
1097   terminal_changed = true;
1098 }
1099 #endif
1100
1101 int
1102 get_terminal_width (void)
1103 {
1104 #if HAVE_DECL_SIGWINCH
1105   static bool setup_signal;
1106   if (!setup_signal)
1107     {
1108       setup_signal = true;
1109
1110       struct sigaction action = { .sa_handler = winch_handler };
1111       sigemptyset (&action.sa_mask);
1112       sigaction (SIGWINCH, &action, NULL);
1113     }
1114 #endif
1115
1116   if (terminal_changed)
1117     {
1118       terminal_changed = false;
1119
1120 #ifdef HAVE_TERMIOS_H
1121       struct winsize ws;
1122       if (!ioctl (0, TIOCGWINSZ, &ws))
1123         terminal_width = ws.ws_col;
1124       else
1125 #endif
1126         {
1127           if (getenv ("COLUMNS"))
1128             terminal_width = atoi (getenv ("COLUMNS"));
1129         }
1130
1131       if (terminal_width <= 0 || terminal_width > 1024)
1132         terminal_width = 79;
1133     }
1134
1135   return terminal_width;
1136 }