fbuf: New data structure for buffered file I/O.
[pspp] / src / output / ascii.c
index 3548844693d09380dbfbe73a5ac696b3595b88d9..5a4c8c7e5652bf68fa61f469a864aa06574d8e7b 100644 (file)
@@ -28,6 +28,7 @@
 #include <uniwidth.h>
 
 #include "data/file-name.h"
+#include "data/file-handle-def.h"
 #include "data/settings.h"
 #include "libpspp/assertion.h"
 #include "libpspp/cast.h"
@@ -126,7 +127,15 @@ static const ucs4_t unicode_box_chars[N_BOX] =
 static inline int
 make_box_index (int left, int right, int top, int bottom)
 {
-  return ((right * RENDER_N_LINES + bottom) * RENDER_N_LINES + left) * RENDER_N_LINES + top;
+  int start_side = left;
+  int end_side = right;
+  if (render_direction_rtl ())
+    {
+      start_side = right;
+      end_side = left;
+    }
+
+  return ((end_side * RENDER_N_LINES + bottom) * RENDER_N_LINES + start_side) * RENDER_N_LINES + top;
 }
 
 /* How to emphasize text. */
@@ -172,7 +181,7 @@ struct ascii_driver
     char *command_name;
     char *title;
     char *subtitle;
-    char *file_name;            /* Output file name. */
+    struct file_handle *handle;
     FILE *file;                 /* Output file. */
     bool error;                 /* Output error? */
     int page_number;           /* Current page number. */
@@ -197,11 +206,11 @@ static bool ascii_open_page (struct ascii_driver *);
 static void ascii_draw_line (void *, int bb[TABLE_N_AXES][2],
                              enum render_line_style styles[TABLE_N_AXES][2]);
 static void ascii_measure_cell_width (void *, const struct table_cell *,
-                                      int *min, int *max);
+                                      int footnote_idx, int *min, int *max);
 static int ascii_measure_cell_height (void *, const struct table_cell *,
-                                      int width);
+                                      int footnote_idx, int width);
 static void ascii_draw_cell (void *, const struct table_cell *,
-                             int bb[TABLE_N_AXES][2],
+                             int footnote_idx, int bb[TABLE_N_AXES][2],
                              int clip[TABLE_N_AXES][2]);
 
 static void
@@ -233,7 +242,7 @@ opt (struct output_driver *d, struct string_map *options, const char *key,
 }
 
 static struct output_driver *
-ascii_create (const char *file_name, enum settings_output_devices device_type,
+ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
               struct string_map *o)
 {
   enum { BOX_ASCII, BOX_UNICODE } box;
@@ -244,7 +253,7 @@ ascii_create (const char *file_name, enum settings_output_devices device_type,
 
   a = xzalloc (sizeof *a);
   d = &a->driver;
-  output_driver_init (&a->driver, &ascii_driver_class, file_name, device_type);
+  output_driver_init (&a->driver, &ascii_driver_class, fh_get_file_name (fh), device_type);
   a->append = parse_boolean (opt (d, o, "append", "false"));
   a->headers = parse_boolean (opt (d, o, "headers", "false"));
   a->paginate = parse_boolean (opt (d, o, "paginate", "false"));
@@ -255,7 +264,8 @@ ascii_create (const char *file_name, enum settings_output_devices device_type,
                             "none", EMPH_NONE,
                             NULL_SENTINEL);
 
-  a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", file_name));
+  a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", fh_get_file_name (fh)));
+  a->handle = fh;
 
   a->top_margin = parse_int (opt (d, o, "top-margin", "0"), 0, INT_MAX);
   a->bottom_margin = parse_int (opt (d, o, "bottom-margin", "0"), 0, INT_MAX);
@@ -283,7 +293,6 @@ ascii_create (const char *file_name, enum settings_output_devices device_type,
   a->command_name = NULL;
   a->title = xstrdup ("");
   a->subtitle = xstrdup ("");
-  a->file_name = xstrdup (file_name);
   a->file = NULL;
   a->error = false;
   a->page_number = 0;
@@ -380,11 +389,11 @@ ascii_destroy (struct output_driver *driver)
     ascii_close_page (a);
 
   if (a->file != NULL)
-    fn_close (a->file_name, a->file);
+    fn_close (a->handle, a->file);
+  fh_unref (a->handle);
   free (a->command_name);
   free (a->title);
   free (a->subtitle);
-  free (a->file_name);
   free (a->chart_file_name);
   for (i = 0; i < a->allocated_lines; i++)
     u8_line_destroy (&a->lines[i]);
@@ -400,45 +409,22 @@ ascii_flush (struct output_driver *driver)
     {
       ascii_close_page (a);
 
-      if (fn_close (a->file_name, a->file) != 0)
-        msg_error (errno, _("ascii: closing output file `%s'"), a->file_name);
+      if (fn_close (a->handle, a->file) != 0)
+        msg_error (errno, _("ascii: closing output file `%s'"), fh_get_file_name (a->handle));
       a->file = NULL;
     }
 }
 
-static void
-ascii_init_caption_cell (const char *caption, struct table_cell *cell)
-{
-  cell->inline_contents.options = TAB_LEFT;
-  cell->inline_contents.text = CONST_CAST (char *, caption);
-  cell->inline_contents.table = NULL;
-  cell->contents = &cell->inline_contents;
-  cell->n_contents = 1;
-  cell->destructor = NULL;
-}
-
 static void
 ascii_output_table_item (struct ascii_driver *a,
                          const struct table_item *table_item)
 {
-  const char *caption = table_item_get_caption (table_item);
   struct render_params params;
   struct render_pager *p;
-  int caption_height;
   int i;
 
   update_page_size (a, false);
 
-  if (caption != NULL)
-    {
-      /* XXX doesn't do well with very large captions */
-      struct table_cell cell;
-      ascii_init_caption_cell (caption, &cell);
-      caption_height = ascii_measure_cell_height (a, &cell, a->width);
-    }
-  else
-    caption_height = 0;
-
   params.draw_line = ascii_draw_line;
   params.measure_cell_width = ascii_measure_cell_width;
   params.measure_cell_height = ascii_measure_cell_height;
@@ -446,7 +432,7 @@ ascii_output_table_item (struct ascii_driver *a,
   params.draw_cell = ascii_draw_cell;
   params.aux = a;
   params.size[H] = a->width;
-  params.size[V] = a->length - caption_height;
+  params.size[V] = a->length;
   params.font_size[H] = 1;
   params.font_size[V] = 1;
   for (i = 0; i < RENDER_N_LINES; i++)
@@ -461,42 +447,23 @@ ascii_output_table_item (struct ascii_driver *a,
   if (a->file == NULL && !ascii_open_page (a))
     return;
 
-  p = render_pager_create (render_page_create (&params, table_item_get_table (
-                                                 table_item)));
+  p = render_pager_create (&params, table_item);
   while (render_pager_has_next (p))
     {
       int used;
 
       if (a->y > 0)
         a->y++;
-      a->y += caption_height;
       used = render_pager_draw_next (p, a->length - a->y);
       if (used == 0)
         {
-          assert (a->y > 0);
+          assert (a->y >= 0);
           ascii_close_page (a);
           if (!ascii_open_page (a))
             break;
         }
       else
-        {
-          if (caption_height)
-            {
-              struct table_cell cell;
-              int bb[TABLE_N_AXES][2];
-
-              ascii_init_caption_cell (caption, &cell);
-              bb[H][0] = 0;
-              bb[H][1] = a->width;
-              bb[V][0] = 0;
-              bb[V][1] = caption_height;
-              a->y -= caption_height;
-              ascii_draw_cell (a, &cell, bb, bb);
-              a->y += caption_height;
-              caption_height = 0;
-            }
-          a->y += used;
-        }
+        a->y += used;
     }
   render_pager_destroy (p);
 }
@@ -506,7 +473,8 @@ ascii_output_text (struct ascii_driver *a, const char *text)
 {
   struct table_item *table_item;
 
-  table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
+  table_item = table_item_create (table_from_string (TAB_LEFT, text),
+                                  NULL, NULL);
   ascii_output_table_item (a, table_item);
   table_item_unref (table_item);
 }
@@ -532,7 +500,7 @@ ascii_submit (struct output_driver *driver,
 
       file_name = xr_draw_png_chart (chart_item, a->chart_file_name,
                                      a->chart_cnt++,
-                                    &a->fg, 
+                                    &a->fg,
                                     &a->bg);
       if (file_name != NULL)
         {
@@ -611,6 +579,7 @@ static char *ascii_reserve (struct ascii_driver *, int y, int x0, int x1,
                             int n);
 static void ascii_layout_cell (struct ascii_driver *,
                                const struct table_cell *,
+                               int footnote_idx,
                                int bb[TABLE_N_AXES][2],
                                int clip[TABLE_N_AXES][2],
                                int *width, int *height);
@@ -651,7 +620,7 @@ ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
 
 static void
 ascii_measure_cell_width (void *a_, const struct table_cell *cell,
-                          int *min_width, int *max_width)
+                          int footnote_idx, int *min_width, int *max_width)
 {
   struct ascii_driver *a = a_;
   int bb[TABLE_N_AXES][2];
@@ -663,21 +632,23 @@ ascii_measure_cell_width (void *a_, const struct table_cell *cell,
   bb[V][0] = 0;
   bb[V][1] = INT_MAX;
   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
-  ascii_layout_cell (a, cell, bb, clip, max_width, &h);
+  ascii_layout_cell (a, cell, footnote_idx, bb, clip, max_width, &h);
 
   if (cell->n_contents != 1
       || cell->contents[0].table
+      || cell->contents[0].n_footnotes
       || strchr (cell->contents[0].text, ' '))
     {
       bb[H][1] = 1;
-      ascii_layout_cell (a, cell, bb, clip, min_width, &h);
+      ascii_layout_cell (a, cell, footnote_idx, bb, clip, min_width, &h);
     }
   else
     *min_width = *max_width;
 }
 
 static int
-ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
+ascii_measure_cell_height (void *a_, const struct table_cell *cell,
+                           int footnote_idx, int width)
 {
   struct ascii_driver *a = a_;
   int bb[TABLE_N_AXES][2];
@@ -689,18 +660,18 @@ ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
   bb[V][0] = 0;
   bb[V][1] = INT_MAX;
   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
-  ascii_layout_cell (a, cell, bb, clip, &w, &h);
+  ascii_layout_cell (a, cell, footnote_idx, bb, clip, &w, &h);
   return h;
 }
 
 static void
-ascii_draw_cell (void *a_, const struct table_cell *cell,
+ascii_draw_cell (void *a_, const struct table_cell *cell, int footnote_idx,
                  int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
 {
   struct ascii_driver *a = a_;
   int w, h;
 
-  ascii_layout_cell (a, cell, bb, clip, &w, &h);
+  ascii_layout_cell (a, cell, footnote_idx, bb, clip, &w, &h);
 }
 
 static char *
@@ -841,22 +812,47 @@ text_draw (struct ascii_driver *a, unsigned int options,
 
 static int
 ascii_layout_cell_text (struct ascii_driver *a,
-                        const struct cell_contents *contents,
+                        const struct cell_contents *contents, int *footnote_idx,
                         int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
                         int *widthp)
 {
-  size_t length = strlen (contents->text);
+  size_t length;
+  const char *text;
   char *breaks;
   int bb_width;
   size_t pos;
   int y;
 
   y = bb[V][0];
-  if (length == 0)
-    return y;
+  length = strlen (contents->text);
+  if (contents->n_footnotes)
+    {
+      struct string s;
+      int i;
+
+      ds_init_empty (&s);
+      ds_extend (&s, length + contents->n_footnotes * 4);
+      ds_put_cstr (&s, contents->text);
+      for (i = 0; i < contents->n_footnotes; i++)
+        {
+          char marker[10];
+
+          str_format_26adic (++*footnote_idx, false, marker, sizeof marker);
+          ds_put_format (&s, "[%s]", marker);
+        }
+
+      length = ds_length (&s);
+      text = ds_steal_cstr (&s);
+    }
+  else
+    {
+      if (length == 0)
+        return y;
+      text = contents->text;
+    }
 
   breaks = xmalloc (length + 1);
-  u8_possible_linebreaks (CHAR_CAST (const uint8_t *, contents->text), length,
+  u8_possible_linebreaks (CHAR_CAST (const uint8_t *, text), length,
                           "UTF-8", breaks);
   breaks[length] = (breaks[length - 1] == UC_BREAK_MANDATORY
                     ? UC_BREAK_PROHIBITED : UC_BREAK_POSSIBLE);
@@ -865,7 +861,7 @@ ascii_layout_cell_text (struct ascii_driver *a,
   bb_width = bb[H][1] - bb[H][0];
   for (y = bb[V][0]; y < bb[V][1] && pos < length; y++)
     {
-      const uint8_t *line = CHAR_CAST (const uint8_t *, contents->text + pos);
+      const uint8_t *line = CHAR_CAST (const uint8_t *, text + pos);
       const char *b = breaks + pos;
       size_t n = length - pos;
 
@@ -932,6 +928,8 @@ ascii_layout_cell_text (struct ascii_driver *a,
     }
 
   free (breaks);
+  if (text != contents->text)
+    free (CONST_CAST (char *, text));
 
   return y;
 }
@@ -939,10 +937,10 @@ ascii_layout_cell_text (struct ascii_driver *a,
 static int
 ascii_layout_subtable (struct ascii_driver *a,
                        const struct cell_contents *contents,
+                       int *footnote_idx UNUSED /* XXX */,
                        int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2] UNUSED,
                        int *widthp)
 {
-  const struct table *table = contents->table;
   struct render_params params;
   struct render_pager *p;
   int r[TABLE_N_AXES][2];
@@ -966,7 +964,7 @@ ascii_layout_subtable (struct ascii_driver *a,
       params.line_widths[V][i] = width;
     }
 
-  p = render_pager_create (render_page_create (&params, table));
+  p = render_pager_create (&params, contents->table);
   width = render_pager_get_size (p, TABLE_HORZ);
   height = render_pager_get_size (p, TABLE_VERT);
 
@@ -1001,6 +999,7 @@ ascii_layout_subtable (struct ascii_driver *a,
 
 static void
 ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
+                   int footnote_idx,
                    int bb_[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
                    int *widthp, int *heightp)
 {
@@ -1024,9 +1023,11 @@ ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
         }
 
       if (contents->text)
-        bb[V][0] = ascii_layout_cell_text (a, contents, bb, clip, widthp);
+        bb[V][0] = ascii_layout_cell_text (a, contents, &footnote_idx,
+                                           bb, clip, widthp);
       else
-        bb[V][0] = ascii_layout_subtable (a, contents, bb, clip, widthp);
+        bb[V][0] = ascii_layout_subtable (a, contents, &footnote_idx,
+                                          bb, clip, widthp);
     }
   *heightp = bb[V][0] - bb_[V][0];
 }
@@ -1048,6 +1049,7 @@ ascii_test_write (struct output_driver *driver,
   contents.options = options | TAB_LEFT;
   contents.text = CONST_CAST (char *, s);
   contents.table = NULL;
+  contents.n_footnotes = 0;
 
   memset (&cell, 0, sizeof cell);
   cell.contents = &contents;
@@ -1058,7 +1060,7 @@ ascii_test_write (struct output_driver *driver,
   bb[TABLE_VERT][0] = y;
   bb[TABLE_VERT][1] = a->length;
 
-  ascii_layout_cell (a, &cell, bb, bb, &width, &height);
+  ascii_layout_cell (a, &cell, 0, bb, bb, &width, &height);
 
   a->y = 1;
 }
@@ -1098,7 +1100,7 @@ ascii_open_page (struct ascii_driver *a)
 
   if (a->file == NULL)
     {
-      a->file = fn_open (a->file_name, a->append ? "a" : "w");
+      a->file = fn_fopen (a->handle, a->append ? "a" : "w");
       if (a->file != NULL)
         {
          if ( isatty (fileno (a->file)))
@@ -1118,7 +1120,7 @@ ascii_open_page (struct ascii_driver *a)
       else
         {
           msg_error (errno, _("ascii: opening output file `%s'"),
-                 a->file_name);
+                    fh_get_file_name (a->handle));
           a->error = true;
           return false;
         }