output: Add footnote support.
[pspp] / src / output / ascii.c
index 251e22d443d2d27f37f1f4fb741f7151b7765c8e..562cd72ea76b75df68b0d352bf39c6bf6f28e90e 100644 (file)
@@ -197,11 +197,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
@@ -406,40 +406,16 @@ ascii_flush (struct output_driver *driver)
     }
 }
 
-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_page *page;
-  struct render_break x_break;
-  int caption_height;
+  struct render_pager *p;
   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;
@@ -447,7 +423,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++)
@@ -462,55 +438,25 @@ ascii_output_table_item (struct ascii_driver *a,
   if (a->file == NULL && !ascii_open_page (a))
     return;
 
-  page = render_page_create (&params, table_item_get_table (table_item));
-  for (render_break_init (&x_break, page, H);
-       render_break_has_next (&x_break); )
+  p = render_pager_create (&params, table_item);
+  while (render_pager_has_next (p))
     {
-      struct render_page *x_slice;
-      struct render_break y_break;
+      int used;
 
-      x_slice = render_break_next (&x_break, a->width);
-      for (render_break_init (&y_break, x_slice, V);
-           render_break_has_next (&y_break); )
+      if (a->y > 0)
+        a->y++;
+      used = render_pager_draw_next (p, a->length - a->y);
+      if (used == 0)
         {
-          struct render_page *y_slice;
-          int space;
-
-          if (a->y > 0)
-            a->y++;
-
-          space = a->length - a->y - caption_height;
-          if (render_break_next_size (&y_break) > space)
-            {
-              assert (a->y > 0);
-              ascii_close_page (a);
-              if (!ascii_open_page (a))
-                return;
-              continue;
-            }
-
-          y_slice = render_break_next (&y_break, space);
-          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;
-              ascii_draw_cell (a, &cell, bb, bb);
-              a->y += caption_height;
-              caption_height = 0;
-            }
-          render_page_draw (y_slice);
-          a->y += render_page_get_size (y_slice, V);
-          render_page_unref (y_slice);
+          assert (a->y > 0);
+          ascii_close_page (a);
+          if (!ascii_open_page (a))
+            break;
         }
-      render_break_destroy (&y_break);
+      else
+        a->y += used;
     }
-  render_break_destroy (&x_break);
+  render_pager_destroy (p);
 }
 
 static void
@@ -623,6 +569,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);
@@ -663,7 +610,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];
@@ -675,21 +622,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];
@@ -701,18 +650,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 *
@@ -853,22 +802,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);
@@ -877,7 +851,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;
 
@@ -944,6 +918,8 @@ ascii_layout_cell_text (struct ascii_driver *a,
     }
 
   free (breaks);
+  if (text != contents->text)
+    free (CONST_CAST (char *, text));
 
   return y;
 }
@@ -951,12 +927,12 @@ 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_page *page;
+  struct render_pager *p;
   int r[TABLE_N_AXES][2];
   int width, height;
   int i;
@@ -978,9 +954,9 @@ ascii_layout_subtable (struct ascii_driver *a,
       params.line_widths[V][i] = width;
     }
 
-  page = render_page_create (&params, table);
-  width = render_page_get_size (page, TABLE_HORZ);
-  height = render_page_get_size (page, TABLE_VERT);
+  p = render_pager_create (&params, contents->table);
+  width = render_pager_get_size (p, TABLE_HORZ);
+  height = render_pager_get_size (p, TABLE_VERT);
 
   /* r = intersect(bb, clip) - bb. */
   for (i = 0; i < TABLE_N_AXES; i++)
@@ -1000,11 +976,11 @@ ascii_layout_subtable (struct ascii_driver *a,
       else if (alignment == TAB_CENTER)
         a->x += (params.size[H] - width) / 2;
       a->y += bb[TABLE_VERT][0];
-      render_page_draw (page);
+      render_pager_draw (p);
       a->y -= bb[TABLE_VERT][0];
       a->x = save_x;
     }
-  render_page_unref (page);
+  render_pager_destroy (p);
 
   if (width > *widthp)
     *widthp = width;
@@ -1013,6 +989,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)
 {
@@ -1036,9 +1013,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];
 }
@@ -1060,6 +1039,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;
@@ -1070,7 +1050,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;
 }