table: Delete some functions that were unused or barely used.
[pspp] / src / output / ascii.c
index 6f8644ba3f299b117bbf844783bc49d757d85f88..7fd2f5e876b38952af5d770578c1d51a166314da 100644 (file)
 #include <ctype.h>
 #include <errno.h>
 #include <limits.h>
+#include <signal.h>
 #include <stdint.h>
 #include <stdlib.h>
-#include <signal.h>
 #include <unilbrk.h>
 #include <unistd.h>
 #include <unistr.h>
 #include <uniwidth.h>
 
+#ifdef HAVE_TERMIOS_H
+# include <termios.h>
+#endif
+
+#ifdef GWINSZ_IN_SYS_IOCTL
+# include <sys/ioctl.h>
+#endif
+
 #include "data/file-name.h"
 #include "data/file-handle-def.h"
 #include "data/settings.h"
@@ -39,7 +47,9 @@
 #include "libpspp/u8-line.h"
 #include "libpspp/version.h"
 #include "output/ascii.h"
-#include "output/cairo.h"
+#ifdef HAVE_CAIRO
+#include "output/cairo-chart.h"
+#endif
 #include "output/chart-item-provider.h"
 #include "output/driver-provider.h"
 #include "output/message-item.h"
@@ -183,14 +193,19 @@ struct ascii_driver
 
 #ifdef HAVE_CAIRO
     /* Colours for charts */
-    struct xr_color fg;
-    struct xr_color bg;
+    struct cell_color fg;
+    struct cell_color bg;
 #endif
 
+    /* How the page width is determined: */
+    enum {
+      FIXED_WIDTH,              /* Specified by configuration. */
+      VIEW_WIDTH,               /* From SET WIDTH. */
+      TERMINAL_WIDTH            /* From the terminal's width. */
+    } width_mode;
     int width;                  /* Page width. */
-    bool auto_width;            /* Use viewwidth as page width? */
 
-    int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
+    int min_hbreak;             /* Min cell size to break across pages. */
 
     const ucs4_t *box;          /* Line & box drawing characters. */
 
@@ -201,6 +216,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. */
+    int object_cnt;             /* Number of objects so far. */
     struct render_params params;
   };
 
@@ -208,11 +224,11 @@ static const struct output_driver_class ascii_driver_class;
 
 static void ascii_submit (struct output_driver *, const struct output_item *);
 
+static int get_terminal_width (void);
+
 static bool update_page_size (struct ascii_driver *, bool issue_error);
 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],
                              struct cell_color colors[TABLE_N_AXES][2]);
@@ -221,7 +237,7 @@ static void ascii_measure_cell_width (void *, const struct table_cell *,
 static int ascii_measure_cell_height (void *, const struct table_cell *,
                                       int width);
 static void ascii_draw_cell (void *, const struct table_cell *, int color_idx,
-                             int bb[TABLE_N_AXES][2],
+                             int bb[TABLE_N_AXES][2], int valign_offset,
                              int spill[TABLE_N_AXES][2],
                              int clip[TABLE_N_AXES][2]);
 
@@ -257,7 +273,6 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
               struct string_map *o)
 {
   enum { BOX_ASCII, BOX_UNICODE } box;
-  int min_break[TABLE_N_AXES];
   struct output_driver *d;
   struct ascii_driver *a;
 
@@ -270,20 +285,21 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
   a->chart_file_name = parse_chart_file_name (opt (d, o, "charts", fh_get_file_name (fh)));
   a->handle = fh;
 
-  min_break[H] = parse_int (opt (d, o, "min-hbreak", "-1"), -1, INT_MAX);
 
-  a->width = parse_page_size (opt (d, o, "width", "79"));
-  a->auto_width = a->width < 0;
-  a->min_break[H] = min_break[H] >= 0 ? min_break[H] : a->width / 2;
+  bool terminal = !strcmp (fh_get_file_name (fh), "-") && isatty (1);
+  a->width = parse_page_size (opt (d, o, "width", "-1"));
+  a->width_mode = (a->width > 0 ? FIXED_WIDTH
+                   : terminal ? TERMINAL_WIDTH
+                   : VIEW_WIDTH);
+  a->min_hbreak = parse_int (opt (d, o, "min-hbreak", "-1"), -1, INT_MAX);
+
 #ifdef HAVE_CAIRO
-  parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &a->bg);
-  parse_color (d, o, "foreground-color", "#000000000000", &a->fg);
+  a->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
+  a->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
 #endif
 
-  const char *default_box = (!strcmp (fh_get_file_name (fh), "-")
-                             && isatty (STDOUT_FILENO)
-                             && (!strcmp (locale_charset (), "UTF-8")
-                                 || term_is_utf8_xterm ())
+  const char *default_box = (terminal && (!strcmp (locale_charset (), "UTF-8")
+                                          || term_is_utf8_xterm ())
                              ? "unicode" : "ascii");
   box = parse_enum (opt (d, o, "box", default_box),
                     "ascii", BOX_ASCII,
@@ -295,32 +311,46 @@ ascii_create (struct  file_handle *fh, enum settings_output_devices device_type,
   a->error = false;
   a->lines = NULL;
   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->chart_cnt = 0;
+  a->object_cnt = 0;
+
+  static const struct render_ops ascii_render_ops = {
+    .draw_line = ascii_draw_line,
+    .measure_cell_width = ascii_measure_cell_width,
+    .measure_cell_height = ascii_measure_cell_height,
+    .adjust_break = NULL,
+    .draw_cell = ascii_draw_cell,
+  };
+  a->params.ops = &ascii_render_ops;
   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];
+
+  static const int ascii_line_widths[RENDER_N_LINES] = {
+    [RENDER_LINE_NONE] = 0,
+    [RENDER_LINE_SINGLE] = 1,
+    [RENDER_LINE_DASHED] = 1,
+    [RENDER_LINE_THICK] = 1,
+    [RENDER_LINE_THIN] = 1,
+    [RENDER_LINE_DOUBLE] = 1,
+  };
+  a->params.line_widths = ascii_line_widths;
   a->params.supports_margins = false;
   a->params.rtl = render_direction_rtl ();
 
   if (!update_page_size (a, true))
     goto error;
 
+  a->file = fn_open (a->handle, a->append ? "a" : "w");
+  if (!a->file)
+    {
+      msg_error (errno, _("ascii: opening output file `%s'"),
+                 fh_get_file_name (a->handle));
+      goto error;
+    }
+
   return d;
 
 error:
@@ -344,7 +374,7 @@ parse_page_size (struct driver_option *option)
 
           errno = 0;
           value = strtol (option->value, &tail, 0);
-          if (dim >= 1 && errno != ERANGE && *tail == '\0')
+          if (value >= 1 && errno != ERANGE && *tail == '\0')
             dim = value;
           else
             msg (MW, _("%s: %s must be positive integer or `auto'"),
@@ -362,28 +392,22 @@ parse_page_size (struct driver_option *option)
 static bool
 update_page_size (struct ascii_driver *a, bool issue_error)
 {
-  enum { MIN_WIDTH = 6, MIN_LENGTH = 6 };
-
-  if (a->auto_width)
-    {
-      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)
-    {
-      if (issue_error)
-        msg (ME,
-               _("ascii: page must be at least %d characters wide, but "
-                 "as configured is only %d characters"),
-               MIN_WIDTH,
-               a->width);
-      if (a->width < MIN_WIDTH)
-        a->params.size[H] = a->width = MIN_WIDTH;
-      return false;
-    }
+  enum { MIN_WIDTH = 6 };
+
+  int want_width = (a->width_mode == VIEW_WIDTH ? settings_get_viewwidth ()
+                    : a->width_mode == TERMINAL_WIDTH ? get_terminal_width ()
+                    : a->width);
+  bool ok = want_width >= MIN_WIDTH;
+  if (!ok && issue_error)
+    msg (ME, _("ascii: page must be at least %d characters wide, but "
+               "as configured is only %d characters"),
+         MIN_WIDTH, want_width);
+
+  a->width = ok ? want_width : MIN_WIDTH;
+  a->params.size[H] = a->width;
+  a->params.min_break[H] = a->min_hbreak >= 0 ? a->min_hbreak : a->width / 2;
 
-  return true;
+  return ok;
 }
 
 static void
@@ -415,14 +439,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]);
     }
 }
 
@@ -434,10 +460,8 @@ ascii_output_table_item (struct ascii_driver *a,
 
   update_page_size (a, false);
 
-  if (a->file)
+  if (a->object_cnt++)
     putc ('\n', a->file);
-  else if (!ascii_open_page (a))
-    return;
 
   p = render_pager_create (&a->params, table_item);
   for (int i = 0; render_pager_has_next (p); i++)
@@ -457,13 +481,6 @@ ascii_output_table_item_unref (struct ascii_driver *a,
   table_item_unref (table_item);
 }
 
-static void
-ascii_output_text (struct ascii_driver *a, const char *text)
-{
-  ascii_output_table_item_unref (
-    a, table_item_create (table_from_string (text), NULL, NULL));
-}
-
 static void
 ascii_submit (struct output_driver *driver,
               const struct output_item *output_item)
@@ -482,7 +499,7 @@ ascii_submit (struct output_driver *driver,
       char *file_name;
 
       file_name = xr_draw_png_chart (chart_item, a->chart_file_name,
-                                     a->chart_cnt++,
+                                     ++a->chart_cnt,
                                     &a->fg,
                                     &a->bg);
       if (file_name != NULL)
@@ -490,7 +507,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);
@@ -503,28 +520,16 @@ 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);
 
-      switch (type)
-        {
-        case TEXT_ITEM_PAGE_TITLE:
-        case TEXT_ITEM_BLANK_LINE:
-          break;
-
-        case TEXT_ITEM_EJECT_PAGE:
-          break;
-
-        default:
-          ascii_output_table_item_unref (
-            a, text_item_to_table_item (text_item_ref (text_item)));
-          break;
-        }
+      if (type != TEXT_ITEM_PAGE_TITLE)
+        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);
-      char *s = msg_to_string (message_item_get_msg (message_item));
-      ascii_output_text (a, s);
-      free (s);
-    }
+    ascii_output_table_item_unref (
+      a, text_item_to_table_item (
+        message_item_to_text_item (
+          to_message_item (
+            output_item_ref (output_item)))));
 }
 
 const struct output_driver_factory txt_driver_factory =
@@ -599,7 +604,8 @@ 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_footnotes || strchr (cell->text, ' '))
+  if (cell->n_footnotes || strchr (cell->text, ' ')
+      || cell->n_subscripts || cell->superscript)
     {
       bb[H][1] = 1;
       ascii_layout_cell (a, cell, bb, clip, min_width, &h);
@@ -627,13 +633,14 @@ 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 color_idx UNUSED,
-                 int bb[TABLE_N_AXES][2],
+                 int bb[TABLE_N_AXES][2], int valign_offset,
                  int spill[TABLE_N_AXES][2] UNUSED,
                  int clip[TABLE_N_AXES][2])
 {
   struct ascii_driver *a = a_;
   int w, h;
 
+  bb[V][0] += valign_offset;
   ascii_layout_cell (a, cell, bb, clip, &w, &h);
 }
 
@@ -714,7 +721,7 @@ text_draw (struct ascii_driver *a, enum table_halign halign, int options,
       int ofs;
 
       ofs = width = 0;
-      for (ofs = 0; ofs < n; )
+      for (ofs = 0; ofs < n;)
         {
           ucs4_t uc;
           int mblen;
@@ -793,10 +800,14 @@ text_draw (struct ascii_driver *a, enum table_halign halign, int options,
 }
 
 static char *
-add_footnote_markers (const char *text, const struct table_cell *cell)
+add_markers (const char *text, const struct table_cell *cell)
 {
   struct string s = DS_EMPTY_INITIALIZER;
   ds_put_cstr (&s, text);
+  for (size_t i = 0; i < cell->n_subscripts; i++)
+    ds_put_format (&s, "%c%s", i ? ',' : '_', cell->subscripts[i]);
+  if (cell->superscript)
+    ds_put_format (&s, "^%s", cell->superscript);
   for (size_t i = 0; i < cell->n_footnotes; i++)
     ds_put_format (&s, "[%s]", cell->footnotes[i]->marker);
   return ds_steal_cstr (&s);
@@ -815,11 +826,11 @@ ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
                             ? output_get_text_from_markup (cell->text)
                             : cell->text);
 
-  /* Append footnote markers if any. */
+  /* Append footnotes, subscripts, superscript if any. */
   const char *text;
-  if (cell->n_footnotes)
+  if (cell->n_footnotes || cell->n_subscripts || cell->superscript)
     {
-      text = add_footnote_markers (plain_text, cell);
+      text = add_markers (plain_text, cell);
       if (plain_text != cell->text)
         free (CONST_CAST (char *, plain_text));
     }
@@ -855,7 +866,7 @@ ascii_layout_cell (struct ascii_driver *a, const struct table_cell *cell,
       size_t graph_ofs;
       size_t ofs;
 
-      for (ofs = 0; ofs < n; )
+      for (ofs = 0; ofs < n;)
         {
           ucs4_t uc;
           int mblen;
@@ -928,10 +939,10 @@ ascii_test_write (struct output_driver *driver,
   int bb[TABLE_N_AXES][2];
   int width, height;
 
-  if (a->file == NULL && !ascii_open_page (a))
+  if (!a->file)
     return;
 
-  struct area_style style = {
+  struct table_area_style style = {
     .cell_style.halign = TABLE_HALIGN_LEFT,
     .font_style.bold = bold,
     .font_style.underline = underline,
@@ -954,7 +965,7 @@ ascii_test_set_length (struct output_driver *driver, int y, int length)
 {
   struct ascii_driver *a = ascii_driver_cast (driver);
 
-  if (a->file == NULL && !ascii_open_page (a))
+  if (!a->file)
     return;
 
   if (y < 0)
@@ -967,7 +978,7 @@ ascii_test_flush (struct output_driver *driver)
 {
   struct ascii_driver *a = ascii_driver_cast (driver);
 
-  for (size_t i = a->allocated_lines; i-- > 0; )
+  for (size_t i = a->allocated_lines; i-- > 0;)
     if (a->lines[i].width)
       {
         ascii_output_lines (a, i + 1);
@@ -975,50 +986,50 @@ ascii_test_flush (struct output_driver *driver)
       }
 }
 \f
-/* ascii_close_page () and support routines. */
+static sig_atomic_t terminal_changed = true;
+static int terminal_width;
 
 #if HAVE_DECL_SIGWINCH
-static struct ascii_driver *the_driver;
-
 static void
 winch_handler (int signum UNUSED)
 {
-  update_page_size (the_driver, false);
+  terminal_changed = true;
 }
 #endif
 
-static bool
-ascii_open_page (struct ascii_driver *a)
+int
+get_terminal_width (void)
 {
-  if (a->error)
-    return false;
-
-  if (a->file == NULL)
-    {
-      a->file = fn_open (a->handle, a->append ? "a" : "w");
-      if (a->file != NULL)
-        {
-         if ( isatty (fileno (a->file)))
-           {
 #if HAVE_DECL_SIGWINCH
-             struct sigaction action;
-             sigemptyset (&action.sa_mask);
-             action.sa_flags = 0;
-             action.sa_handler = winch_handler;
-             the_driver = a;
-             sigaction (SIGWINCH, &action, NULL);
+  static bool setup_signal;
+  if (!setup_signal)
+    {
+      setup_signal = true;
+
+      struct sigaction action = { .sa_handler = winch_handler };
+      sigemptyset (&action.sa_mask);
+      sigaction (SIGWINCH, &action, NULL);
+    }
 #endif
-             a->auto_width = true;
-           }
-        }
+
+  if (terminal_changed)
+    {
+      terminal_changed = false;
+
+#ifdef HAVE_TERMIOS_H
+      struct winsize ws;
+      if (!ioctl (0, TIOCGWINSZ, &ws))
+        terminal_width = ws.ws_col;
       else
+#endif
         {
-          msg_error (errno, _("ascii: opening output file `%s'"),
-                    fh_get_file_name (a->handle));
-          a->error = true;
-          return false;
+          if (getenv ("COLUMNS"))
+            terminal_width = atoi (getenv ("COLUMNS"));
         }
+
+      if (terminal_width <= 0 || terminal_width > 1024)
+        terminal_width = 79;
     }
 
-  return true;
+  return terminal_width;
 }