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