output: Add support for alternating row colors.
[pspp] / src / output / ascii.c
index c6a8ee51de427636fe9d67d449a665d9f85eb326..d4032483da7132c609370d4952d7901745525f9f 100644 (file)
 #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,7 +179,7 @@ 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
@@ -171,7 +196,6 @@ struct ascii_driver
     const ucs4_t *box;          /* Line & box drawing characters. */
 
     /* Internal state. */
-    char *command_name;
     struct file_handle *handle;
     FILE *file;                 /* Output file. */
     bool error;                 /* Output error? */
@@ -190,13 +214,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 footnote_idx, int *min, int *max);
+                                      int *min, int *max);
 static int ascii_measure_cell_height (void *, const struct table_cell *,
-                                      int footnote_idx, int width);
-static void ascii_draw_cell (void *, const struct table_cell *,
-                             int footnote_idx, int bb[TABLE_N_AXES][2],
+                                      int width);
+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 *
@@ -226,11 +252,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;
@@ -250,7 +272,6 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
                     NULL_SENTINEL);
   a->box = box == BOX_ASCII ? ascii_box_chars : unicode_box_chars;
 
-  a->command_name = NULL;
   a->file = NULL;
   a->error = false;
   a->lines = NULL;
@@ -334,7 +355,6 @@ ascii_destroy (struct output_driver *driver)
   if (a->file != NULL)
     fn_close (a->handle, a->file);
   fh_unref (a->handle);
-  free (a->command_name);
   free (a->chart_file_name);
   for (i = 0; i < a->allocated_lines; i++)
     u8_line_destroy (&a->lines[i]);
@@ -428,8 +448,6 @@ ascii_submit (struct output_driver *driver,
 {
   struct ascii_driver *a = ascii_driver_cast (driver);
 
-  output_driver_track_current_command (output_item, &a->command_name);
-
   if (a->error)
     return;
 
@@ -487,7 +505,7 @@ ascii_submit (struct output_driver *driver,
     {
       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, a->command_name);
+      char *s = msg_to_string (msg, message_item->command_name);
       ascii_output_text (a, s);
       free (s);
     }
@@ -510,14 +528,14 @@ 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);
 
 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];
@@ -551,7 +569,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 footnote_idx, int *min_width, int *max_width)
+                          int *min_width, int *max_width)
 {
   struct ascii_driver *a = a_;
   int bb[TABLE_N_AXES][2];
@@ -563,22 +581,21 @@ 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, footnote_idx, bb, clip, max_width, &h);
+  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, ' '))
     {
       bb[H][1] = 1;
-      ascii_layout_cell (a, cell, footnote_idx, bb, clip, min_width, &h);
+      ascii_layout_cell (a, cell, bb, clip, min_width, &h);
     }
   else
     *min_width = *max_width;
 }
 
 static int
-ascii_measure_cell_height (void *a_, const struct table_cell *cell,
-                           int footnote_idx, int width)
+ascii_measure_cell_height (void *a_, const struct table_cell *cell, int width)
 {
   struct ascii_driver *a = a_;
   int bb[TABLE_N_AXES][2];
@@ -590,18 +607,20 @@ ascii_measure_cell_height (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, footnote_idx, bb, clip, &w, &h);
+  ascii_layout_cell (a, cell, bb, clip, &w, &h);
   return h;
 }
 
 static void
-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])
+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;
 
-  ascii_layout_cell (a, cell, footnote_idx, bb, clip, &w, &h);
+  ascii_layout_cell (a, cell, bb, clip, &w, &h);
 }
 
 static char *
@@ -622,6 +641,7 @@ 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,
+           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)
 {
@@ -634,7 +654,7 @@ text_draw (struct ascii_driver *a, unsigned int options,
   if (y < y0 || y >= y1)
     return;
 
-  switch (options & TAB_ALIGNMENT)
+  switch (options & TAB_HALIGN)
     {
     case TAB_LEFT:
       x = bb[H][0];
@@ -701,7 +721,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
     {
@@ -721,7 +741,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. */
@@ -736,11 +761,16 @@ 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);
         }
@@ -749,7 +779,8 @@ text_draw (struct ascii_driver *a, unsigned int options,
 
 static int
 ascii_layout_cell_text (struct ascii_driver *a,
-                        const struct cell_contents *contents, int *footnote_idx,
+                        const struct cell_contents *contents,
+                        bool bold, bool underline,
                         int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
                         int *widthp)
 {
@@ -771,12 +802,7 @@ ascii_layout_cell_text (struct ascii_driver *a,
       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);
-        }
+        ds_put_format (&s, "[%s]", contents->footnotes[i]->marker);
 
       length = ds_length (&s);
       text = ds_steal_cstr (&s);
@@ -849,7 +875,8 @@ 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, contents->options, bold, 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). */
@@ -873,7 +900,6 @@ ascii_layout_cell_text (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)
 {
@@ -896,7 +922,8 @@ ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
             break;
         }
 
-      bb[V][0] = ascii_layout_cell_text (a, contents, &footnote_idx,
+      bb[V][0] = ascii_layout_cell_text (a, contents, cell->style->bold,
+                                         cell->style->underline,
                                          bb, clip, widthp);
     }
   *heightp = bb[V][0] - bb_[V][0];
@@ -904,31 +931,35 @@ ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
 
 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);
-  struct cell_contents contents;
-  struct table_cell cell;
   int bb[TABLE_N_AXES][2];
   int width, height;
 
   if (a->file == NULL && !ascii_open_page (a))
     return;
 
-  contents.options = options | TAB_LEFT;
-  contents.text = CONST_CAST (char *, s);
-  contents.n_footnotes = 0;
-
-  memset (&cell, 0, sizeof cell);
-  cell.contents = &contents;
-  cell.n_contents = 1;
+  struct cell_contents contents = {
+    .options = TAB_LEFT,
+    .text = CONST_CAST (char *, s),
+  };
+  struct cell_style cell_style = {
+    .bold = bold,
+    .underline = underline,
+  };
+  struct table_cell cell = {
+    .contents = &contents,
+    .n_contents = 1,
+    .style = &cell_style,
+  };
 
   bb[TABLE_HORZ][0] = x;
   bb[TABLE_HORZ][1] = a->width;
   bb[TABLE_VERT][0] = y;
   bb[TABLE_VERT][1] = INT_MAX;
 
-  ascii_layout_cell (a, &cell, 0, bb, bb, &width, &height);
+  ascii_layout_cell (a, &cell, bb, bb, &width, &height);
 }
 
 void