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