Add support for reading and writing SPV files.
[pspp] / src / output / ascii.c
index 507e758e3fd727316f4f147d9162fd4f15218c02..a78a904de1325f3b91c775fb0d96d236e4c5ed51 100644 (file)
@@ -44,8 +44,8 @@
 #include "output/driver-provider.h"
 #include "output/message-item.h"
 #include "output/options.h"
+#include "output/pivot-table.h"
 #include "output/render.h"
-#include "output/tab.h"
 #include "output/table-item.h"
 #include "output/text-item.h"
 
 #define H TABLE_HORZ
 #define V TABLE_VERT
 
-#define N_BOX (RENDER_N_LINES * RENDER_N_LINES \
-               * RENDER_N_LINES * RENDER_N_LINES)
+enum
+  {
+    ASCII_LINE_NONE,
+    ASCII_LINE_SINGLE,
+    ASCII_LINE_DOUBLE,
+    ASCII_N_LINES
+  };
+
+#define N_BOX (ASCII_N_LINES * ASCII_N_LINES \
+               * ASCII_N_LINES * ASCII_N_LINES)
 
 static const ucs4_t ascii_box_chars[N_BOX] =
   {
@@ -125,27 +133,44 @@ static const ucs4_t unicode_box_chars[N_BOX] =
     0x2566, 0x256c, 0x256c,
   };
 
-static inline int
-make_box_index (int left, int right, int top, int bottom)
+static int
+ascii_line_from_render_line (int render_line)
 {
-  int start_side = left;
-  int end_side = right;
-  if (render_direction_rtl ())
+  switch (render_line)
     {
-      start_side = right;
-      end_side = left;
+    case RENDER_LINE_NONE:
+      return ASCII_LINE_NONE;
+
+    case RENDER_LINE_SINGLE:
+    case RENDER_LINE_DASHED:
+    case RENDER_LINE_THICK:
+    case RENDER_LINE_THIN:
+      return ASCII_LINE_SINGLE;
+
+    case RENDER_LINE_DOUBLE:
+      return ASCII_LINE_DOUBLE;
+
+    default:
+      return ASCII_LINE_NONE;
     }
 
-  return ((end_side * RENDER_N_LINES + bottom) * RENDER_N_LINES + start_side) * RENDER_N_LINES + top;
 }
 
-/* How to emphasize text. */
-enum emphasis_style
-  {
-    EMPH_BOLD,                  /* Overstrike for bold. */
-    EMPH_UNDERLINE,             /* Overstrike for underlining. */
-    EMPH_NONE                   /* No emphasis. */
-  };
+static int
+make_box_index (int left_, int right_, int top_, int bottom_)
+{
+  bool rtl = render_direction_rtl ();
+  int left = ascii_line_from_render_line (rtl ? right_ : left_);
+  int right = ascii_line_from_render_line (rtl ? left_ : right_);
+  int top = ascii_line_from_render_line (top_);
+  int bottom = ascii_line_from_render_line (bottom_);
+
+  int idx = right;
+  idx = idx * ASCII_N_LINES + bottom;
+  idx = idx * ASCII_N_LINES + left;
+  idx = idx * ASCII_N_LINES + top;
+  return idx;
+}
 
 /* ASCII output driver. */
 struct ascii_driver
@@ -154,13 +179,13 @@ struct ascii_driver
 
     /* User parameters. */
     bool append;                /* Append if output file already exists? */
-    enum emphasis_style emphasis; /* How to emphasize text. */
+    bool emphasis;              /* Enable bold and underline in output? */
     char *chart_file_name;      /* Name of files used for charts. */
 
 #ifdef HAVE_CAIRO
     /* Colours for charts */
-    struct xr_color fg;
-    struct xr_color bg;
+    struct cell_color fg;
+    struct cell_color bg;
 #endif
 
     int width;                  /* Page width. */
@@ -177,6 +202,7 @@ struct ascii_driver
     struct u8_line *lines;      /* Page content. */
     int allocated_lines;        /* Number of lines allocated. */
     int chart_cnt;              /* Number of charts so far. */
+    struct render_params params;
   };
 
 static const struct output_driver_class ascii_driver_class;
@@ -189,13 +215,15 @@ static int parse_page_size (struct driver_option *);
 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]);
+                             enum render_line_style styles[TABLE_N_AXES][2],
+                             struct cell_color colors[TABLE_N_AXES][2]);
 static void ascii_measure_cell_width (void *, const struct table_cell *,
                                       int *min, int *max);
 static int ascii_measure_cell_height (void *, const struct table_cell *,
                                       int width);
-static void ascii_draw_cell (void *, const struct table_cell *,
+static void ascii_draw_cell (void *, const struct table_cell *, int color_idx,
                              int bb[TABLE_N_AXES][2],
+                             int spill[TABLE_N_AXES][2],
                              int clip[TABLE_N_AXES][2]);
 
 static struct ascii_driver *
@@ -212,6 +240,19 @@ opt (struct output_driver *d, struct string_map *options, const char *key,
   return driver_option_get (d, options, key, default_value);
 }
 
+/* Return true iff the terminal appears to be an xterm with
+   UTF-8 capabilities */
+static bool
+term_is_utf8_xterm (void)
+{
+  const char *term = getenv ("TERM");
+  const char *xterm_locale = getenv ("XTERM_LOCAL");
+  return (term && xterm_locale
+          && !strcmp (term, "xterm")
+          && (strcasestr (xterm_locale, "utf8")
+              || strcasestr (xterm_locale, "utf-8")));
+}
+
 static struct output_driver *
 ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
               struct string_map *o)
@@ -225,11 +266,7 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
   d = &a->driver;
   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->emphasis = parse_enum (opt (d, o, "emphasis", "none"),
-                            "bold", EMPH_BOLD,
-                            "underline", EMPH_UNDERLINE,
-                            "none", EMPH_NONE,
-                            NULL_SENTINEL);
+  a->emphasis = parse_boolean (opt (d, o, "emphasis", "false"));
 
   a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", fh_get_file_name (fh)));
   a->handle = fh;
@@ -243,7 +280,13 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
   parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &a->bg);
   parse_color (d, o, "foreground-color", "#000000000000", &a->fg);
 #endif
-  box = parse_enum (opt (d, o, "box", "ascii"),
+
+  const char *default_box = (!strcmp (fh_get_file_name (fh), "-")
+                             && isatty (STDOUT_FILENO)
+                             && (!strcmp (locale_charset (), "UTF-8")
+                                 || term_is_utf8_xterm ())
+                             ? "unicode" : "ascii");
+  box = parse_enum (opt (d, o, "box", default_box),
                     "ascii", BOX_ASCII,
                     "unicode", BOX_UNICODE,
                     NULL_SENTINEL);
@@ -255,6 +298,27 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
   a->allocated_lines = 0;
   a->chart_cnt = 1;
 
+  a->params.draw_line = ascii_draw_line;
+  a->params.measure_cell_width = ascii_measure_cell_width;
+  a->params.measure_cell_height = ascii_measure_cell_height;
+  a->params.adjust_break = NULL;
+  a->params.draw_cell = ascii_draw_cell;
+  a->params.aux = a;
+  a->params.size[H] = a->width;
+  a->params.size[V] = INT_MAX;
+  a->params.font_size[H] = 1;
+  a->params.font_size[V] = 1;
+  for (int i = 0; i < RENDER_N_LINES; i++)
+    {
+      int width = i == RENDER_LINE_NONE ? 0 : 1;
+      a->params.line_widths[H][i] = width;
+      a->params.line_widths[V][i] = width;
+    }
+  for (int i = 0; i < TABLE_N_AXES; i++)
+    a->params.min_break[i] = a->min_break[i];
+  a->params.supports_margins = false;
+  a->params.rtl = render_direction_rtl ();
+
   if (!update_page_size (a, true))
     goto error;
 
@@ -303,8 +367,8 @@ update_page_size (struct ascii_driver *a, bool issue_error)
 
   if (a->auto_width)
     {
-      a->width = settings_get_viewwidth ();
-      a->min_break[H] = a->width / 2;
+      a->params.size[H] = a->width = settings_get_viewwidth ();
+      a->params.min_break[H] = a->min_break[H] = a->width / 2;
     }
 
   if (a->width < MIN_WIDTH)
@@ -316,7 +380,7 @@ update_page_size (struct ascii_driver *a, bool issue_error)
                MIN_WIDTH,
                a->width);
       if (a->width < MIN_WIDTH)
-        a->width = MIN_WIDTH;
+        a->params.size[H] = a->width = MIN_WIDTH;
       return false;
     }
 
@@ -352,14 +416,16 @@ ascii_output_lines (struct ascii_driver *a, size_t n_lines)
 {
   for (size_t y = 0; y < n_lines; y++)
     {
-      struct u8_line *line = &a->lines[y];
+      if (y < a->allocated_lines)
+        {
+          struct u8_line *line = &a->lines[y];
 
-      while (ds_chomp_byte (&line->s, ' '))
-        continue;
-      fwrite (ds_data (&line->s), 1, ds_length (&line->s), a->file);
+          while (ds_chomp_byte (&line->s, ' '))
+            continue;
+          fwrite (ds_data (&line->s), 1, ds_length (&line->s), a->file);
+          u8_line_clear (&a->lines[y]);
+        }
       putc ('\n', a->file);
-
-      u8_line_clear (&a->lines[y]);
     }
 }
 
@@ -367,38 +433,16 @@ static void
 ascii_output_table_item (struct ascii_driver *a,
                          const struct table_item *table_item)
 {
-  struct render_params params;
   struct render_pager *p;
-  int i;
 
   update_page_size (a, false);
 
-  params.draw_line = ascii_draw_line;
-  params.measure_cell_width = ascii_measure_cell_width;
-  params.measure_cell_height = ascii_measure_cell_height;
-  params.adjust_break = NULL;
-  params.draw_cell = ascii_draw_cell;
-  params.aux = a;
-  params.size[H] = a->width;
-  params.size[V] = INT_MAX;
-  params.font_size[H] = 1;
-  params.font_size[V] = 1;
-  for (i = 0; i < RENDER_N_LINES; i++)
-    {
-      int width = i == RENDER_LINE_NONE ? 0 : 1;
-      params.line_widths[H][i] = width;
-      params.line_widths[V][i] = width;
-    }
-  for (i = 0; i < TABLE_N_AXES; i++)
-    params.min_break[i] = a->min_break[i];
-  params.supports_margins = false;
-
   if (a->file)
     putc ('\n', a->file);
   else if (!ascii_open_page (a))
     return;
 
-  p = render_pager_create (&params, table_item);
+  p = render_pager_create (&a->params, table_item);
   for (int i = 0; render_pager_has_next (p); i++)
     {
       if (i)
@@ -409,16 +453,21 @@ ascii_output_table_item (struct ascii_driver *a,
 }
 
 static void
-ascii_output_text (struct ascii_driver *a, const char *text)
+ascii_output_table_item_unref (struct ascii_driver *a,
+                               struct table_item *table_item)
 {
-  struct table_item *table_item;
-
-  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);
 }
 
+static void
+ascii_output_text (struct ascii_driver *a, const char *text)
+{
+  struct pivot_table *pt = pivot_table_create_for_text (
+    NULL, pivot_value_new_user_text (text, -1));
+  ascii_output_table_item_unref (a, table_item_create (pt));
+}
+
 static void
 ascii_submit (struct output_driver *driver,
               const struct output_item *output_item)
@@ -445,7 +494,7 @@ ascii_submit (struct output_driver *driver,
           struct text_item *text_item;
 
           text_item = text_item_create_format (
-            TEXT_ITEM_PARAGRAPH, _("See %s for a chart."), file_name);
+            TEXT_ITEM_LOG, _("See %s for a chart."), file_name);
 
           ascii_submit (driver, &text_item->output_item);
           text_item_unref (text_item);
@@ -457,32 +506,15 @@ ascii_submit (struct output_driver *driver,
     {
       const struct text_item *text_item = to_text_item (output_item);
       enum text_item_type type = text_item_get_type (text_item);
-      const char *text = text_item_get_text (text_item);
-
-      switch (type)
-        {
-        case TEXT_ITEM_TITLE:
-        case TEXT_ITEM_SUBTITLE:
-        case TEXT_ITEM_COMMAND_OPEN:
-        case TEXT_ITEM_COMMAND_CLOSE:
-          break;
 
-        case TEXT_ITEM_BLANK_LINE:
-          break;
-
-        case TEXT_ITEM_EJECT_PAGE:
-          break;
-
-        default:
-          ascii_output_text (a, text);
-          break;
-        }
+      if (type != TEXT_ITEM_PAGE_TITLE && type != TEXT_ITEM_EJECT_PAGE)
+        ascii_output_table_item_unref (
+          a, text_item_to_table_item (text_item_ref (text_item)));
     }
   else if (is_message_item (output_item))
     {
       const struct message_item *message_item = to_message_item (output_item);
-      const struct msg *msg = message_item_get_msg (message_item);
-      char *s = msg_to_string (msg, message_item->command_name);
+      char *s = msg_to_string (message_item_get_msg (message_item));
       ascii_output_text (a, s);
       free (s);
     }
@@ -511,7 +543,8 @@ static void ascii_layout_cell (struct ascii_driver *,
 
 static void
 ascii_draw_line (void *a_, int bb[TABLE_N_AXES][2],
-                 enum render_line_style styles[TABLE_N_AXES][2])
+                 enum render_line_style styles[TABLE_N_AXES][2],
+                 struct cell_color colors[TABLE_N_AXES][2] UNUSED)
 {
   struct ascii_driver *a = a_;
   char mbchar[6];
@@ -559,9 +592,7 @@ ascii_measure_cell_width (void *a_, const struct table_cell *cell,
   clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
   ascii_layout_cell (a, cell, bb, clip, max_width, &h);
 
-  if (cell->n_contents != 1
-      || cell->contents[0].n_footnotes
-      || strchr (cell->contents[0].text, ' '))
+  if (cell->n_footnotes || strchr (cell->text, ' '))
     {
       bb[H][1] = 1;
       ascii_layout_cell (a, cell, bb, clip, min_width, &h);
@@ -588,8 +619,10 @@ ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
 }
 
 static void
-ascii_draw_cell (void *a_, const struct table_cell *cell,
-                 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
+ascii_draw_cell (void *a_, const struct table_cell *cell, int color_idx UNUSED,
+                 int bb[TABLE_N_AXES][2],
+                 int spill[TABLE_N_AXES][2] UNUSED,
+                 int clip[TABLE_N_AXES][2])
 {
   struct ascii_driver *a = a_;
   int w, h;
@@ -614,7 +647,8 @@ ascii_reserve (struct ascii_driver *a, int y, int x0, int x1, int n)
 }
 
 static void
-text_draw (struct ascii_driver *a, unsigned int options,
+text_draw (struct ascii_driver *a, enum table_halign halign, int options,
+           bool bold, bool underline,
            int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
            int y, const uint8_t *string, int n, size_t width)
 {
@@ -627,15 +661,16 @@ text_draw (struct ascii_driver *a, unsigned int options,
   if (y < y0 || y >= y1)
     return;
 
-  switch (options & TAB_ALIGNMENT)
+  switch (table_halign_interpret (halign, options & TAB_NUMERIC))
     {
-    case TAB_LEFT:
+    case TABLE_HALIGN_LEFT:
       x = bb[H][0];
       break;
-    case TAB_CENTER:
+    case TABLE_HALIGN_CENTER:
       x = (bb[H][0] + bb[H][1] - width + 1) / 2;
       break;
-    case TAB_RIGHT:
+    case TABLE_HALIGN_RIGHT:
+    case TABLE_HALIGN_DECIMAL:
       x = bb[H][1] - width;
       break;
     default:
@@ -694,7 +729,7 @@ text_draw (struct ascii_driver *a, unsigned int options,
         return;
     }
 
-  if (!(options & TAB_EMPH) || a->emphasis == EMPH_NONE)
+  if (!a->emphasis || (!bold && !underline))
     memcpy (ascii_reserve (a, y, x, x + width, n), string, n);
   else
     {
@@ -714,7 +749,12 @@ text_draw (struct ascii_driver *a, unsigned int options,
           w = uc_width (uc, "UTF-8");
 
           if (w > 0)
-            n_out += a->emphasis == EMPH_UNDERLINE ? 2 : 1 + mblen;
+            {
+              if (bold)
+                n_out += 1 + mblen;
+              if (underline)
+                n_out += 2;
+            }
         }
 
       /* Then insert them. */
@@ -729,62 +769,74 @@ text_draw (struct ascii_driver *a, unsigned int options,
 
           if (w > 0)
             {
-              if (a->emphasis == EMPH_UNDERLINE)
-                *out++ = '_';
-              else
-                out = mempcpy (out, string + ofs, mblen);
-              *out++ = '\b';
+              if (bold)
+                {
+                  out = mempcpy (out, string + ofs, mblen);
+                  *out++ = '\b';
+                }
+              if (underline)
+                {
+                  *out++ = '_';
+                  *out++ = '\b';
+                }
             }
           out = mempcpy (out, string + ofs, mblen);
         }
     }
 }
 
-static int
-ascii_layout_cell_text (struct ascii_driver *a,
-                        const struct cell_contents *contents,
-                        int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
-                        int *widthp)
+static char *
+add_footnote_markers (const char *text, const struct table_cell *cell)
 {
-  size_t length;
-  const char *text;
-  char *breaks;
-  int bb_width;
-  size_t pos;
-  int y;
-
-  y = bb[V][0];
-  length = strlen (contents->text);
-  if (contents->n_footnotes)
-    {
-      struct string s;
-      int i;
+  struct string s = DS_EMPTY_INITIALIZER;
+  ds_put_cstr (&s, text);
+  for (size_t i = 0; i < cell->n_footnotes; i++)
+    ds_put_format (&s, "[%s]", cell->footnotes[i]->marker);
+  return ds_steal_cstr (&s);
+}
 
-      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++)
-        ds_put_format (&s, "[%s]", contents->footnotes[i]->marker);
+static void
+ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
+                   int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
+                   int *widthp, int *heightp)
+{
+  *widthp = 0;
+  *heightp = 0;
+
+  /* Get the basic textual contents. */
+  const char *plain_text = (cell->options & TAB_MARKUP
+                            ? output_get_text_from_markup (cell->text)
+                            : cell->text);
 
-      length = ds_length (&s);
-      text = ds_steal_cstr (&s);
+  /* Append footnote markers if any. */
+  const char *text;
+  if (cell->n_footnotes)
+    {
+      text = add_footnote_markers (plain_text, cell);
+      if (plain_text != cell->text)
+        free (CONST_CAST (char *, plain_text));
     }
   else
+    text = plain_text;
+
+  /* Calculate length; if it's zero, then there's nothing to do. */
+  size_t length = strlen (text);
+  if (!length)
     {
-      if (length == 0)
-        return y;
-      text = contents->text;
+      if (text != cell->text)
+        free (CONST_CAST (char *, text));
+      return;
     }
 
-  breaks = xmalloc (length + 1);
+  char *breaks = xmalloc (length + 1);
   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);
 
-  pos = 0;
-  bb_width = bb[H][1] - bb[H][0];
-  for (y = bb[V][0]; y < bb[V][1] && pos < length; y++)
+  size_t pos = 0;
+  int bb_width = bb[H][1] - bb[H][0];
+  for (int y = bb[V][0]; y < bb[V][1] && pos < length; y++)
     {
       const uint8_t *line = CHAR_CAST (const uint8_t *, text + pos);
       const char *b = breaks + pos;
@@ -837,7 +889,10 @@ ascii_layout_cell_text (struct ascii_driver *a,
       width -= ofs - graph_ofs;
 
       /* Draw text. */
-      text_draw (a, contents->options, bb, clip, y, line, graph_ofs, width);
+      text_draw (a, cell->style->cell_style.halign, cell->options,
+                 cell->style->font_style.bold,
+                 cell->style->font_style.underline,
+                 bb, clip, y, line, graph_ofs, width);
 
       /* If a new-line ended the line, just skip the new-line.  Otherwise, skip
          past any spaces past the end of the line (but not past a new-line). */
@@ -849,48 +904,18 @@ ascii_layout_cell_text (struct ascii_driver *a,
 
       if (width > *widthp)
         *widthp = width;
+      ++*heightp;
       pos += ofs;
     }
 
   free (breaks);
-  if (text != contents->text)
+  if (text != cell->text)
     free (CONST_CAST (char *, text));
-
-  return y;
-}
-
-static void
-ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
-                   int bb_[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
-                   int *widthp, int *heightp)
-{
-  int bb[TABLE_N_AXES][2];
-  size_t i;
-
-  *widthp = 0;
-  *heightp = 0;
-
-  memcpy (bb, bb_, sizeof bb);
-  for (i = 0; i < cell->n_contents && bb[V][0] < bb[V][1]; i++)
-    {
-      const struct cell_contents *contents = &cell->contents[i];
-
-      /* Put a blank line between contents. */
-      if (i > 0)
-        {
-          bb[V][0]++;
-          if (bb[V][0] >= bb[V][1])
-            break;
-        }
-
-      bb[V][0] = ascii_layout_cell_text (a, contents, bb, clip, widthp);
-    }
-  *heightp = bb[V][0] - bb_[V][0];
 }
 
 void
 ascii_test_write (struct output_driver *driver,
-                  const char *s, int x, int y, unsigned int options)
+                  const char *s, int x, int y, bool bold, bool underline)
 {
   struct ascii_driver *a = ascii_driver_cast (driver);
   int bb[TABLE_N_AXES][2];
@@ -899,14 +924,14 @@ ascii_test_write (struct output_driver *driver,
   if (a->file == NULL && !ascii_open_page (a))
     return;
 
-  struct cell_contents contents = {
-    .options = options | TAB_LEFT,
-    .text = CONST_CAST (char *, s),
+  struct area_style style = {
+    .cell_style.halign = TABLE_HALIGN_LEFT,
+    .font_style.bold = bold,
+    .font_style.underline = underline,
   };
-
   struct table_cell cell = {
-    .contents = &contents,
-    .n_contents = 1,
+    .text = CONST_CAST (char *, s),
+    .style = &style,
   };
 
   bb[TABLE_HORZ][0] = x;