ascii: Fix handling of file open error.
[pspp-builds.git] / src / output / ascii.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2007, 2009 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 <stdint.h>
23 #include <stdlib.h>
24
25 #include <data/file-name.h>
26 #include <data/settings.h>
27 #include <libpspp/assertion.h>
28 #include <libpspp/compiler.h>
29 #include <libpspp/start-date.h>
30 #include <libpspp/string-map.h>
31 #include <libpspp/version.h>
32 #include <output/cairo.h>
33 #include <output/chart-item-provider.h>
34 #include "output/options.h"
35 #include <output/tab.h>
36 #include <output/text-item.h>
37 #include <output/driver-provider.h>
38 #include <output/render.h>
39 #include <output/table-item.h>
40
41 #include "error.h"
42 #include "minmax.h"
43 #include "xalloc.h"
44
45 #include "gettext.h"
46 #define _(msgid) gettext (msgid)
47
48 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
49 #define H TABLE_HORZ
50 #define V TABLE_VERT
51
52 /* Line styles bit shifts. */
53 enum
54   {
55     LNS_TOP = 0,
56     LNS_LEFT = 2,
57     LNS_BOTTOM = 4,
58     LNS_RIGHT = 6,
59
60     LNS_COUNT = 256
61   };
62
63 static inline int
64 make_box_index (int left, int right, int top, int bottom)
65 {
66   return ((left << LNS_LEFT) | (right << LNS_RIGHT)
67           | (top << LNS_TOP) | (bottom << LNS_BOTTOM));
68 }
69
70 /* Character attributes. */
71 #define ATTR_EMPHASIS   0x100   /* Bold-face. */
72 #define ATTR_BOX        0x200   /* Line drawing character. */
73
74 /* A line of text. */
75 struct ascii_line
76   {
77     unsigned short *chars;      /* Characters and attributes. */
78     int n_chars;                /* Length. */
79     int allocated_chars;        /* Allocated "chars" elements. */
80   };
81
82 /* How to emphasize text. */
83 enum emphasis_style
84   {
85     EMPH_BOLD,                  /* Overstrike for bold. */
86     EMPH_UNDERLINE,             /* Overstrike for underlining. */
87     EMPH_NONE                   /* No emphasis. */
88   };
89
90 /* ASCII output driver. */
91 struct ascii_driver
92   {
93     struct output_driver driver;
94
95     /* User parameters. */
96     bool append;                /* Append if output-file already exists? */
97     bool headers;               /* Print headers at top of page? */
98     bool paginate;              /* Insert formfeeds? */
99     bool squeeze_blank_lines;   /* Squeeze multiple blank lines into one? */
100     enum emphasis_style emphasis; /* How to emphasize text. */
101     int tab_width;              /* Width of a tab; 0 not to use tabs. */
102     char *chart_file_name;      /* Name of files used for charts. */
103
104     int width;                  /* Page width. */
105     int length;                 /* Page length minus margins and header. */
106     bool auto_width;            /* Use viewwidth as page width? */
107     bool auto_length;           /* Use viewlength as page width? */
108
109     int top_margin;             /* Top margin in lines. */
110     int bottom_margin;          /* Bottom margin in lines. */
111
112     char *box[LNS_COUNT];       /* Line & box drawing characters. */
113     char *init;                 /* Device initialization string. */
114
115     /* Internal state. */
116     char *title;
117     char *subtitle;
118     char *file_name;            /* Output file name. */
119     FILE *file;                 /* Output file. */
120     bool error;                 /* Output error? */
121     int page_number;            /* Current page number. */
122     struct ascii_line *lines;   /* Page content. */
123     int allocated_lines;        /* Number of lines allocated. */
124     int chart_cnt;              /* Number of charts so far. */
125     int y;
126   };
127
128 static int vertical_margins (const struct ascii_driver *);
129
130 static const char *get_default_box (int right, int bottom, int left, int top);
131 static bool update_page_size (struct ascii_driver *, bool issue_error);
132 static int parse_page_size (struct driver_option *);
133
134 static void ascii_close_page (struct ascii_driver *);
135 static bool ascii_open_page (struct ascii_driver *);
136
137 static void ascii_draw_line (void *, int bb[TABLE_N_AXES][2],
138                              enum render_line_style styles[TABLE_N_AXES][2]);
139 static void ascii_measure_cell_width (void *, const struct table_cell *,
140                                       int *min, int *max);
141 static int ascii_measure_cell_height (void *, const struct table_cell *,
142                                       int width);
143 static void ascii_draw_cell (void *, const struct table_cell *,
144                              int bb[TABLE_N_AXES][2],
145                              int clip[TABLE_N_AXES][2]);
146
147 static struct ascii_driver *
148 ascii_driver_cast (struct output_driver *driver)
149 {
150   assert (driver->class == &ascii_class);
151   return UP_CAST (driver, struct ascii_driver, driver);
152 }
153
154 static struct driver_option *
155 opt (struct output_driver *d, struct string_map *options, const char *key,
156      const char *default_value)
157 {
158   return driver_option_get (d, options, key, default_value);
159 }
160
161 static struct output_driver *
162 ascii_create (const char *name, enum output_device_type device_type,
163               struct string_map *o)
164 {
165   struct output_driver *d;
166   struct ascii_driver *a;
167   int paper_length;
168   int right, bottom, left, top;
169
170   a = xzalloc (sizeof *a);
171   d = &a->driver;
172   output_driver_init (&a->driver, &ascii_class, name, device_type);
173   a->append = parse_boolean (opt (d, o, "append", "false"));
174   a->headers = parse_boolean (opt (d, o, "headers", "true"));
175   a->paginate = parse_boolean (opt (d, o, "paginate", "true"));
176   a->squeeze_blank_lines = parse_boolean (opt (d, o, "squeeze", "false"));
177   a->emphasis = parse_enum (opt (d, o, "emphasis", "bold"),
178                             "bold", EMPH_BOLD,
179                             "underline", EMPH_UNDERLINE,
180                             "none", EMPH_NONE,
181                             (char *) NULL);
182   a->tab_width = parse_int (opt (d, o, "tab-width", "0"), 8, INT_MAX);
183
184   if (parse_enum (opt (d, o, "chart-type", "png"),
185                   "png", true,
186                   "none", false,
187                   (char *) NULL))
188     a->chart_file_name = parse_chart_file_name (opt (d, o, "chart-files",
189                                                      "pspp-#.png"));
190   else
191     a->chart_file_name = NULL;
192
193   a->top_margin = parse_int (opt (d, o, "top-margin", "2"), 0, INT_MAX);
194   a->bottom_margin = parse_int (opt (d, o, "bottom-margin", "2"), 0, INT_MAX);
195
196   a->width = parse_page_size (opt (d, o, "width", "79"));
197   paper_length = parse_page_size (opt (d, o, "length", "66"));
198   a->auto_width = a->width < 0;
199   a->auto_length = paper_length < 0;
200   a->length = paper_length - vertical_margins (a);
201
202   for (right = 0; right < 4; right++)
203     for (bottom = 0; bottom < 4; bottom++)
204       for (left = 0; left < 4; left++)
205         for (top = 0; top < 4; top++)
206           {
207             int indx = make_box_index (left, right, top, bottom);
208             const char *default_value;
209             char name[16];
210
211             sprintf (name, "box[%d%d%d%d]", right, bottom, left, top);
212             default_value = get_default_box (right, bottom, left, top);
213             a->box[indx] = parse_string (opt (d, o, name, default_value));
214           }
215   a->init = parse_string (opt (d, o, "init", ""));
216
217   a->title = xstrdup ("");
218   a->subtitle = xstrdup ("");
219   a->file_name = parse_string (opt (d, o, "output-file", "pspp.list"));
220   a->file = NULL;
221   a->error = false;
222   a->page_number = 0;
223   a->lines = NULL;
224   a->allocated_lines = 0;
225   a->chart_cnt = 1;
226
227   if (!update_page_size (a, true))
228     goto error;
229
230   return d;
231
232 error:
233   output_driver_destroy (d);
234   return NULL;
235 }
236
237 static const char *
238 get_default_box (int right, int bottom, int left, int top)
239 {
240   switch ((top << 12) | (left << 8) | (bottom << 4) | (right << 0))
241     {
242     case 0x0000:
243       return " ";
244
245     case 0x0100: case 0x0101: case 0x0001:
246       return "-";
247
248     case 0x1000: case 0x1010: case 0x0010:
249       return "|";
250
251     case 0x0300: case 0x0303: case 0x0003:
252     case 0x0200: case 0x0202: case 0x0002:
253       return "=";
254
255     default:
256       return left > 1 || top > 1 || right > 1 || bottom > 1 ? "#" : "+";
257     }
258 }
259
260 static int
261 parse_page_size (struct driver_option *option)
262 {
263   int dim = atol (option->default_value);
264
265   if (option->value != NULL)
266     {
267       if (!strcmp (option->value, "auto"))
268         dim = -1;
269       else
270         {
271           int value;
272           char *tail;
273
274           errno = 0;
275           value = strtol (option->value, &tail, 0);
276           if (dim >= 1 && errno != ERANGE && *tail == '\0')
277             dim = value;
278           else
279             error (0, 0, _("%s: %s must be positive integer or `auto'"),
280                    option->driver_name, option->name);
281         }
282     }
283
284   driver_option_destroy (option);
285
286   return dim;
287 }
288
289 static int
290 vertical_margins (const struct ascii_driver *a)
291 {
292   return a->top_margin + a->bottom_margin + (a->headers ? 3 : 0);
293 }
294
295 /* Re-calculates the page width and length based on settings,
296    margins, and, if "auto" is set, the size of the user's
297    terminal window or GUI output window. */
298 static bool
299 update_page_size (struct ascii_driver *a, bool issue_error)
300 {
301   enum { MIN_WIDTH = 6, MIN_LENGTH = 6 };
302
303   if (a->auto_width)
304     a->width = settings_get_viewwidth ();
305   if (a->auto_length)
306     a->length = settings_get_viewlength () - vertical_margins (a);
307
308   if (a->width < MIN_WIDTH || a->length < MIN_LENGTH)
309     {
310       if (issue_error)
311         error (0, 0,
312                _("ascii: page excluding margins and headers "
313                  "must be at least %d characters wide by %d lines long, but "
314                  "as configured is only %d characters by %d lines"),
315                MIN_WIDTH, MIN_LENGTH,
316                a->width, a->length);
317       if (a->width < MIN_WIDTH)
318         a->width = MIN_WIDTH;
319       if (a->length < MIN_LENGTH)
320         a->length = MIN_LENGTH;
321       return false;
322     }
323
324   return true;
325 }
326
327 static void
328 ascii_destroy (struct output_driver *driver)
329 {
330   struct ascii_driver *a = ascii_driver_cast (driver);
331   int i;
332
333   if (a->y > 0)
334     ascii_close_page (a);
335
336   if (a->file != NULL)
337     fn_close (a->file_name, a->file);
338   free (a->title);
339   free (a->subtitle);
340   free (a->file_name);
341   free (a->chart_file_name);
342   for (i = 0; i < LNS_COUNT; i++)
343     free (a->box[i]);
344   free (a->init);
345   for (i = 0; i < a->allocated_lines; i++)
346     free (a->lines[i].chars);
347   free (a->lines);
348   free (a);
349 }
350
351 static void
352 ascii_flush (struct output_driver *driver)
353 {
354   struct ascii_driver *a = ascii_driver_cast (driver);
355   if (a->y > 0)
356     {
357       ascii_close_page (a);
358
359       if (fn_close (a->file_name, a->file) != 0)
360         error (0, errno, _("ascii: closing output file \"%s\""),
361                a->file_name);
362       a->file = NULL;
363     }
364 }
365
366 static void
367 ascii_init_caption_cell (const char *caption, struct table_cell *cell)
368 {
369   cell->contents = caption;
370   cell->options = TAB_LEFT;
371   cell->destructor = NULL;
372 }
373
374 static void
375 ascii_submit (struct output_driver *driver,
376               const struct output_item *output_item)
377 {
378   struct ascii_driver *a = ascii_driver_cast (driver);
379   if (a->error)
380     return;
381   if (is_table_item (output_item))
382     {
383       struct table_item *table_item = to_table_item (output_item);
384       const char *caption = table_item_get_caption (table_item);
385       struct render_params params;
386       struct render_page *page;
387       struct render_break x_break;
388       int caption_height;
389       int i;
390
391       update_page_size (a, false);
392
393       if (caption != NULL)
394         {
395           /* XXX doesn't do well with very large captions */
396           struct table_cell cell;
397           ascii_init_caption_cell (caption, &cell);
398           caption_height = ascii_measure_cell_height (a, &cell, a->width);
399         }
400       else
401         caption_height = 0;
402
403       params.draw_line = ascii_draw_line;
404       params.measure_cell_width = ascii_measure_cell_width;
405       params.measure_cell_height = ascii_measure_cell_height;
406       params.draw_cell = ascii_draw_cell,
407       params.aux = a;
408       params.size[H] = a->width;
409       params.size[V] = a->length - caption_height;
410       params.font_size[H] = 1;
411       params.font_size[V] = 1;
412       for (i = 0; i < RENDER_N_LINES; i++)
413         {
414           int width = i == RENDER_LINE_NONE ? 0 : 1;
415           params.line_widths[H][i] = width;
416           params.line_widths[V][i] = width;
417         }
418
419       if (a->file == NULL && !ascii_open_page (a))
420         return;
421
422       page = render_page_create (&params, table_item_get_table (table_item));
423       for (render_break_init (&x_break, page, H);
424            render_break_has_next (&x_break); )
425         {
426           struct render_page *x_slice;
427           struct render_break y_break;
428
429           x_slice = render_break_next (&x_break, a->width);
430           for (render_break_init (&y_break, x_slice, V);
431                render_break_has_next (&y_break); )
432             {
433               struct render_page *y_slice;
434               int space;
435
436               if (a->y > 0)
437                 a->y++;
438
439               space = a->length - a->y - caption_height;
440               if (render_break_next_size (&y_break) > space)
441                 {
442                   assert (a->y > 0);
443                   ascii_close_page (a);
444                   if (!ascii_open_page (a))
445                     return;
446                   continue;
447                 }
448
449               y_slice = render_break_next (&y_break, space);
450               if (caption_height)
451                 {
452                   struct table_cell cell;
453                   int bb[TABLE_N_AXES][2];
454
455                   ascii_init_caption_cell (caption, &cell);
456                   bb[H][0] = 0;
457                   bb[H][1] = a->width;
458                   bb[V][0] = 0;
459                   bb[V][1] = caption_height;
460                   ascii_draw_cell (a, &cell, bb, bb);
461                   a->y += caption_height;
462                   caption_height = 0;
463                 }
464               render_page_draw (y_slice);
465               a->y += render_page_get_size (y_slice, V);
466               render_page_unref (y_slice);
467             }
468           render_break_destroy (&y_break);
469         }
470       render_break_destroy (&x_break);
471     }
472   else if (is_chart_item (output_item) && a->chart_file_name != NULL)
473     {
474       struct chart_item *chart_item = to_chart_item (output_item);
475       char *file_name;
476
477       file_name = xr_draw_png_chart (chart_item, a->chart_file_name,
478                                      a->chart_cnt++);
479       if (file_name != NULL)
480         {
481           struct text_item *text_item;
482
483           text_item = text_item_create_format (
484             TEXT_ITEM_PARAGRAPH, _("See %s for a chart."), file_name);
485
486           ascii_submit (driver, &text_item->output_item);
487           text_item_unref (text_item);
488           free (file_name);
489         }
490     }
491   else if (is_text_item (output_item))
492     {
493       const struct text_item *text_item = to_text_item (output_item);
494       enum text_item_type type = text_item_get_type (text_item);
495       const char *text = text_item_get_text (text_item);
496
497       switch (type)
498         {
499         case TEXT_ITEM_TITLE:
500           free (a->title);
501           a->title = xstrdup (text);
502           break;
503
504         case TEXT_ITEM_SUBTITLE:
505           free (a->subtitle);
506           a->subtitle = xstrdup (text);
507           break;
508
509         case TEXT_ITEM_COMMAND_CLOSE:
510           break;
511
512         case TEXT_ITEM_BLANK_LINE:
513           if (a->y > 0)
514             a->y++;
515           break;
516
517         case TEXT_ITEM_EJECT_PAGE:
518           if (a->y > 0)
519             ascii_close_page (a);
520           break;
521
522         default:
523           {
524             struct table_item *item;
525
526             item = table_item_create (table_from_string (0, text), NULL);
527             ascii_submit (&a->driver, &item->output_item);
528             table_item_unref (item);
529           }
530           break;
531         }
532     }
533 }
534
535 const struct output_driver_class ascii_class =
536   {
537     "ascii",
538     ascii_create,
539     ascii_destroy,
540     ascii_submit,
541     ascii_flush,
542   };
543 \f
544 enum wrap_mode
545   {
546     WRAP_WORD,
547     WRAP_CHAR,
548     WRAP_WORD_CHAR
549   };
550
551 static void ascii_expand_line (struct ascii_driver *, int y, int length);
552 static void ascii_layout_cell (struct ascii_driver *,
553                                const struct table_cell *,
554                                int bb[TABLE_N_AXES][2],
555                                int clip[TABLE_N_AXES][2], enum wrap_mode wrap,
556                                int *width, int *height);
557
558 static void
559 ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
560                  enum render_line_style styles[TABLE_N_AXES][2])
561 {
562   struct ascii_driver *a = a_;
563   unsigned short int value;
564   int x1, y1;
565   int x, y;
566
567   /* Clip to the page. */
568   if (bb[H][0] >= a->width || bb[V][0] + a->y >= a->length)
569     return;
570   x1 = MIN (bb[H][1], a->width);
571   y1 = MIN (bb[V][1] + a->y, a->length);
572
573   /* Draw. */
574   value = ATTR_BOX | make_box_index (styles[V][0], styles[V][1],
575                                      styles[H][0], styles[H][1]);
576   for (y = bb[V][0] + a->y; y < y1; y++)
577     {
578       ascii_expand_line (a, y, x1);
579       for (x = bb[H][0]; x < x1; x++)
580         a->lines[y].chars[x] = value;
581     }
582 }
583
584 static void
585 ascii_measure_cell_width (void *a_, const struct table_cell *cell,
586                           int *min_width, int *max_width)
587 {
588   struct ascii_driver *a = a_;
589   int bb[TABLE_N_AXES][2];
590   int clip[TABLE_N_AXES][2];
591   int h;
592
593   bb[H][0] = 0;
594   bb[H][1] = INT_MAX;
595   bb[V][0] = 0;
596   bb[V][1] = INT_MAX;
597   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
598   ascii_layout_cell (a, cell, bb, clip, WRAP_WORD, max_width, &h);
599
600   if (strchr (cell->contents, ' '))
601     {
602       bb[H][1] = 1;
603       ascii_layout_cell (a, cell, bb, clip, WRAP_WORD, min_width, &h);
604     }
605   else
606     *min_width = *max_width;
607 }
608
609 static int
610 ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
611 {
612   struct ascii_driver *a = a_;
613   int bb[TABLE_N_AXES][2];
614   int clip[TABLE_N_AXES][2];
615   int w, h;
616
617   bb[H][0] = 0;
618   bb[H][1] = width;
619   bb[V][0] = 0;
620   bb[V][1] = INT_MAX;
621   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
622   ascii_layout_cell (a, cell, bb, clip, WRAP_WORD, &w, &h);
623   return h;
624 }
625
626 static void
627 ascii_draw_cell (void *a_, const struct table_cell *cell,
628                  int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
629 {
630   struct ascii_driver *a = a_;
631   int w, h;
632
633   ascii_layout_cell (a, cell, bb, clip, WRAP_WORD, &w, &h);
634 }
635
636 /* Ensures that at least the first LENGTH characters of line Y in
637    ascii driver A have been cleared out. */
638 static void
639 ascii_expand_line (struct ascii_driver *a, int y, int length)
640 {
641   struct ascii_line *line = &a->lines[y];
642   if (line->n_chars < length)
643     {
644       int x;
645       if (line->allocated_chars < length)
646         {
647           line->allocated_chars = MAX (length, MIN (length * 2, a->width));
648           line->chars = xnrealloc (line->chars, line->allocated_chars,
649                                    sizeof *line->chars);
650         }
651       for (x = line->n_chars; x < length; x++)
652         line->chars[x] = ' ';
653       line->n_chars = length;
654     }
655 }
656
657 static void
658 text_draw (struct ascii_driver *a, const struct table_cell *cell,
659            int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
660            int y, const char *string, int n)
661 {
662   int x0 = MAX (0, clip[H][0]);
663   int y0 = MAX (0, clip[V][0] + a->y);
664   int x1 = clip[H][1];
665   int y1 = MIN (a->length, clip[V][1] + a->y);
666   int x;
667
668   y += a->y;
669   if (y < y0 || y >= y1)
670     return;
671
672   switch (cell->options & TAB_ALIGNMENT)
673     {
674     case TAB_LEFT:
675       x = bb[H][0];
676       break;
677     case TAB_CENTER:
678       x = (bb[H][0] + bb[H][1] - n + 1) / 2;
679       break;
680     case TAB_RIGHT:
681       x = bb[H][1] - n;
682       break;
683     default:
684       NOT_REACHED ();
685     }
686
687   if (x0 > x)
688     {
689       n -= x0 - x;
690       if (n <= 0)
691         return;
692       string += x0 - x;
693       x = x0;
694     }
695   if (x + n >= x1)
696     n = x1 - x;
697
698   if (n > 0)
699     {
700       int attr = cell->options & TAB_EMPH ? ATTR_EMPHASIS : 0;
701       size_t i;
702
703       ascii_expand_line (a, y, x + n);
704       for (i = 0; i < n; i++)
705         a->lines[y].chars[x + i] = string[i] | attr;
706     }
707 }
708
709 static void
710 ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
711                    int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
712                    enum wrap_mode wrap, int *width, int *height)
713 {
714   size_t length = strlen (cell->contents);
715   int y, pos;
716
717   *width = 0;
718   pos = 0;
719   for (y = bb[V][0]; y < bb[V][1] && pos < length; y++)
720     {
721       const char *line = &cell->contents[pos];
722       const char *new_line;
723       size_t line_len;
724
725       /* Find line length without considering word wrap. */
726       line_len = MIN (bb[H][1] - bb[H][0], length - pos);
727       new_line = memchr (line, '\n', line_len);
728       if (new_line != NULL)
729         line_len = new_line - line;
730
731       /* Word wrap. */
732       if (pos + line_len < length && wrap != WRAP_CHAR)
733         {
734           size_t space_len = line_len;
735           while (space_len > 0 && !isspace ((unsigned char) line[space_len]))
736             space_len--;
737           if (space_len > 0)
738             line_len = space_len;
739           else if (wrap == WRAP_WORD)
740             {
741               while (pos + line_len < length
742                      && !isspace ((unsigned char) line[line_len]))
743                 line_len++;
744             }
745         }
746       if (line_len > *width)
747         *width = line_len;
748
749       /* Draw text. */
750       text_draw (a, cell, bb, clip, y, line, line_len);
751
752       /* Next line. */
753       pos += line_len;
754       if (pos < length && isspace ((unsigned char) cell->contents[pos]))
755         pos++;
756     }
757   *height = y - bb[V][0];
758 }
759 \f
760 /* ascii_close_page () and support routines. */
761
762 static bool
763 ascii_open_page (struct ascii_driver *a)
764 {
765   int i;
766
767   if (a->error)
768     return false;
769
770   if (a->file == NULL)
771     {
772       a->file = fn_open (a->file_name, a->append ? "a" : "w");
773       if (a->file != NULL)
774         {
775           if (a->init != NULL)
776             fputs (a->init, a->file);
777         }
778       else
779         {
780           error (0, errno, _("ascii: opening output file \"%s\""),
781                  a->file_name);
782           a->error = true;
783           return false;
784         }
785     }
786
787   a->page_number++;
788
789   if (a->length > a->allocated_lines)
790     {
791       a->lines = xnrealloc (a->lines, a->length, sizeof *a->lines);
792       for (i = a->allocated_lines; i < a->length; i++)
793         {
794           struct ascii_line *line = &a->lines[i];
795           line->chars = NULL;
796           line->allocated_chars = 0;
797         }
798       a->allocated_lines = a->length;
799     }
800
801   for (i = 0; i < a->length; i++)
802     a->lines[i].n_chars = 0;
803
804   return true;
805 }
806
807 /* Writes LINE to A's output file.  */
808 static void
809 output_line (struct ascii_driver *a, const struct ascii_line *line)
810 {
811   size_t length;
812   size_t i;
813
814   length = line->n_chars;
815   while (length > 0 && line->chars[length - 1] == ' ')
816     length--;
817
818   for (i = 0; i < length; i++)
819     {
820       int attribute = line->chars[i] & (ATTR_BOX | ATTR_EMPHASIS);
821       int ch = line->chars[i] & ~(ATTR_BOX | ATTR_EMPHASIS);
822
823       switch (attribute)
824         {
825         case ATTR_BOX:
826           fputs (a->box[ch], a->file);
827           break;
828
829         case ATTR_EMPHASIS:
830           if (a->emphasis == EMPH_BOLD)
831             fprintf (a->file, "%c\b%c", ch, ch);
832           else if (a->emphasis == EMPH_UNDERLINE)
833             fprintf (a->file, "_\b%c", ch);
834           else
835             putc (ch, a->file);
836           break;
837
838         default:
839           putc (ch, a->file);
840           break;
841         }
842     }
843
844   putc ('\n', a->file);
845 }
846
847 static void
848 output_title_line (FILE *out, int width, const char *left, const char *right)
849 {
850   struct string s = DS_EMPTY_INITIALIZER;
851   ds_put_char_multiple (&s, ' ', width);
852   if (left != NULL)
853     {
854       size_t length = MIN (strlen (left), width);
855       memcpy (ds_end (&s) - width, left, length);
856     }
857   if (right != NULL)
858     {
859       size_t length = MIN (strlen (right), width);
860       memcpy (ds_end (&s) - length, right, length);
861     }
862   ds_put_char (&s, '\n');
863   fputs (ds_cstr (&s), out);
864   ds_destroy (&s);
865 }
866
867 static void
868 ascii_close_page (struct ascii_driver *a)
869 {
870   bool any_blank;
871   int i, y;
872
873   a->y = 0;
874   if (a->file == NULL)
875     return;
876
877   if (!a->top_margin && !a->bottom_margin && a->squeeze_blank_lines
878       && !a->paginate && a->page_number > 1)
879     putc ('\n', a->file);
880
881   for (i = 0; i < a->top_margin; i++)
882     putc ('\n', a->file);
883   if (a->headers)
884     {
885       char *r1, *r2;
886
887       r1 = xasprintf (_("%s - Page %d"), get_start_date (), a->page_number);
888       r2 = xasprintf ("%s - %s" , version, host_system);
889
890       output_title_line (a->file, a->width, a->title, r1);
891       output_title_line (a->file, a->width, a->subtitle, r2);
892       putc ('\n', a->file);
893
894       free (r1);
895       free (r2);
896     }
897
898   any_blank = false;
899   for (y = 0; y < a->allocated_lines; y++)
900     {
901       struct ascii_line *line = &a->lines[y];
902
903       if (a->squeeze_blank_lines && y > 0 && line->n_chars == 0)
904         any_blank = true;
905       else
906         {
907           if (any_blank)
908             {
909               putc ('\n', a->file);
910               any_blank = false;
911             }
912
913           output_line (a, line);
914         }
915     }
916   if (!a->squeeze_blank_lines)
917     for (y = a->allocated_lines; y < a->length; y++)
918       putc ('\n', a->file);
919
920   for (i = 0; i < a->bottom_margin; i++)
921     putc ('\n', a->file);
922   if (a->paginate)
923     putc ('\f', a->file);
924 }