Break ctables_cell_insert__() from ctables_cell_add__()
[pspp] / src / output / cairo-pager.c
index 36823bd9452344168722b6b7b5c4a0d81823aa1f..1dbffd8270aa37d3bee3deffadae794fedb14ffb 100644 (file)
 #include "output/cairo-pager.h"
 
 #include <math.h>
+#include <cairo/cairo-pdf.h>
 #include <pango/pango-layout.h>
 #include <pango/pangocairo.h>
 
 #include "output/driver-provider.h"
+#include "output/output-item.h"
 
 #include "gl/xalloc.h"
 
@@ -87,8 +89,7 @@ xr_page_style_equals (const struct xr_page_style *a,
     if (!page_heading_equals (&a->headings[i], &b->headings[i]))
       return false;
 
-  return (a->initial_page_number == b->initial_page_number
-          && a->object_spacing == b->object_spacing);
+  return a->initial_page_number == b->initial_page_number;
 }
 \f
 struct xr_pager
@@ -100,7 +101,19 @@ struct xr_pager
 
     /* Current output item. */
     struct xr_fsm *fsm;
-    struct output_item *item;
+    struct output_iterator iter;
+    struct output_item *root_item;
+    int slice_idx;
+    const char *label;
+
+    /* Grouping, for constructing the outline for PDFs. */
+    struct outline_node
+      {
+        const struct output_item *item;
+        int group_id;
+      }
+    *nodes;
+    size_t n_nodes, allocated_nodes;
 
     /* Current output page. */
     cairo_t *cr;
@@ -194,11 +207,11 @@ xr_measure_headings (const struct xr_page_style *ps,
   for (int i = 0; i < 2; i++)
     {
       int *h = &heading_heights[i];
-      *h = xr_render_page_heading (cairo, fs->fonts[XR_FONT_PROPORTIONAL],
+      *h = xr_render_page_heading (cairo, fs->font,
                                    &ps->headings[i], -1, fs->size[H], 0,
                                    fs->font_resolution);
       if (*h)
-        *h += ps->object_spacing;
+        *h += fs->object_spacing;
     }
   cairo_destroy (cairo);
   cairo_surface_destroy (surface);
@@ -234,11 +247,14 @@ xr_pager_destroy (struct xr_pager *p)
 {
   if (p)
     {
+      free (p->nodes);
+
       xr_page_style_unref (p->page_style);
       xr_fsm_style_unref (p->fsm_style);
 
       xr_fsm_destroy (p->fsm);
-      output_item_unref (p->item);
+      output_iterator_destroy (&p->iter);
+      output_item_unref (p->root_item);
 
       if (p->cr)
         {
@@ -252,14 +268,15 @@ xr_pager_destroy (struct xr_pager *p)
 bool
 xr_pager_has_item (const struct xr_pager *p)
 {
-  return p->item != NULL;
+  return p->root_item != NULL;
 }
 
 void
 xr_pager_add_item (struct xr_pager *p, const struct output_item *item)
 {
-  assert (!p->item);
-  p->item = output_item_ref (item);
+  assert (!p->root_item);
+  p->root_item = output_item_ref (item);
+  output_iterator_init (&p->iter, item);
   xr_pager_run (p);
 }
 
@@ -279,91 +296,168 @@ xr_pager_add_page (struct xr_pager *p, cairo_t *cr)
 
   const struct xr_fsm_style *fs = p->fsm_style;
   const struct xr_page_style *ps = p->page_style;
-  const struct cell_color *bg = &ps->bg;
-  if (bg->alpha)
-    {
-      cairo_save (cr);
-      cairo_set_source_rgba (cr, bg->r / 255.0, bg->g / 255.0,
-                          bg->b / 255.0, bg->alpha / 255.0);
-      cairo_rectangle (cr, 0, 0, fs->size[H], fs->size[V]);
-      cairo_fill (cr);
-      cairo_restore (cr);
-    }
   cairo_translate (cr,
                    xr_to_pt (ps->margins[H][0]),
                    xr_to_pt (ps->margins[V][0]));
 
-  const PangoFontDescription *font = fs->fonts[XR_FONT_PROPORTIONAL];
   int page_number = p->page_index++ + ps->initial_page_number;
   if (p->heading_heights[0])
-    xr_render_page_heading (cr, font, &ps->headings[0], page_number,
+    xr_render_page_heading (cr, fs->font, &ps->headings[0], page_number,
                             fs->size[H], -p->heading_heights[0],
                             fs->font_resolution);
 
   if (p->heading_heights[1])
-    xr_render_page_heading (cr, font, &ps->headings[1], page_number,
-                            fs->size[H], fs->size[V] + ps->object_spacing,
+    xr_render_page_heading (cr, fs->font, &ps->headings[1], page_number,
+                            fs->size[H], fs->size[V] + fs->object_spacing,
                             fs->font_resolution);
 
+  cairo_surface_t *surface = cairo_get_target (cr);
+  if (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_PDF)
+    {
+      char *page_label = xasprintf ("%d", page_number);
+      cairo_pdf_surface_set_page_label (surface, page_label);
+      free (page_label);
+    }
+
   xr_pager_run (p);
 }
 
+void
+xr_pager_finish_page (struct xr_pager *p)
+{
+  if (p->cr)
+    {
+      cairo_restore (p->cr);
+      cairo_destroy (p->cr);
+      p->cr = NULL;
+    }
+}
+
 bool
 xr_pager_needs_new_page (struct xr_pager *p)
 {
-  if (p->item && (!p->cr || p->y >= p->fsm_style->size[V]))
+  if (p->root_item && (!p->cr || p->y >= p->fsm_style->size[V]))
     {
-      if (p->cr)
-        {
-          cairo_restore (p->cr);
-          cairo_destroy (p->cr);
-          p->cr = NULL;
-        }
+      xr_pager_finish_page (p);
       return true;
     }
   else
     return false;
 }
 
+static int
+add_outline (cairo_t *cr, int parent_id,
+             const char *utf8, const char *link_attribs,
+             cairo_pdf_outline_flags_t flags)
+{
+  cairo_surface_t *surface = cairo_get_target (cr);
+  return (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_PDF
+          ? cairo_pdf_surface_add_outline (surface, parent_id,
+                                           utf8, link_attribs, flags)
+          : 0);
+}
+
 static void
 xr_pager_run (struct xr_pager *p)
 {
-  if (p->item && p->cr && p->y < p->fsm_style->size[V])
+  if (!p->root_item || !p->cr || p->y >= p->fsm_style->size[V])
+    return;
+
+  for (;;)
     {
-      if (!p->fsm)
+      /* Make sure we've got an object to render. */
+      while (!p->fsm)
         {
-          p->fsm = xr_fsm_create (p->item, p->fsm_style, p->cr);
-          if (!p->fsm)
+          /* If there are no remaining objects to render, then we're done. */
+          if (!p->iter.cur)
             {
-              output_item_unref (p->item);
-              p->item = NULL;
-
+              output_item_unref (p->root_item);
+              p->root_item = NULL;
               return;
             }
-        }
 
-      for (;;)
-        {
-          int spacing = p->page_style->object_spacing;
-          int chunk = xr_fsm_draw_slice (p->fsm, p->cr,
-                                         p->fsm_style->size[V] - p->y);
-          p->y += chunk + spacing;
-          cairo_translate (p->cr, 0, xr_to_pt (chunk + spacing));
+          /* Prepare to render the current object. */
+          p->fsm = xr_fsm_create_for_printing (p->iter.cur, p->fsm_style,
+                                               p->cr);
+          p->label = output_item_get_label (p->iter.cur);
+          p->slice_idx = 0;
+          while (p->n_nodes > p->iter.n)
+            p->n_nodes--;
+          while (p->n_nodes)
+            {
+              size_t i = p->n_nodes - 1;
+              if (p->nodes[i].item == p->iter.nodes[i].group)
+                break;
 
-          if (xr_fsm_is_empty (p->fsm))
+              p->nodes--;
+            }
+          while (p->n_nodes < p->iter.n)
             {
-              xr_fsm_destroy (p->fsm);
-              p->fsm = NULL;
-              output_item_unref (p->item);
-              p->item = NULL;
-              return;
+              if (p->n_nodes >= p->allocated_nodes)
+                p->nodes = x2nrealloc (p->nodes, &p->allocated_nodes,
+                                       sizeof *p->nodes);
+              size_t i = p->n_nodes++;
+              p->nodes[i] = (struct outline_node) {
+                .item = p->iter.nodes[i].group,
+              };
             }
-          else if (!chunk)
+          output_iterator_next (&p->iter);
+        }
+
+      char *dest_name = NULL;
+      if (p->page_style->include_outline)
+        {
+          static int counter = 0;
+          dest_name = xasprintf ("dest%d", counter++);
+          char *attrs = xasprintf ("name='%s'", dest_name);
+          cairo_tag_begin (p->cr, CAIRO_TAG_DEST, attrs);
+          free (attrs);
+        }
+
+      int spacing = p->fsm_style->object_spacing;
+      int chunk = xr_fsm_draw_slice (p->fsm, p->cr,
+                                     p->fsm_style->size[V] - p->y);
+      p->y += chunk + spacing;
+      cairo_translate (p->cr, 0, xr_to_pt (chunk + spacing));
+
+      if (p->page_style->include_outline)
+        {
+          cairo_tag_end (p->cr, CAIRO_TAG_DEST);
+
+          if (chunk && p->slice_idx++ == 0)
             {
-              assert (p->y > 0);
-              p->y = INT_MAX;
-              return;
+              char *attrs = xasprintf ("dest='%s'", dest_name);
+
+              int parent_group_id = CAIRO_PDF_OUTLINE_ROOT;
+              for (size_t i = 0; i < p->n_nodes; i++)
+                {
+                  struct outline_node *node = &p->nodes[i];
+                  if (!node->group_id)
+                    {
+                      const char *label = output_item_get_label (node->item);
+                      node->group_id = add_outline (
+                        p->cr, parent_group_id, label, attrs,
+                        CAIRO_PDF_OUTLINE_FLAG_OPEN);
+                    }
+                  parent_group_id = node->group_id;
+                }
+
+              add_outline (p->cr, parent_group_id, p->label, attrs, 0);
+              free (attrs);
             }
+          free (dest_name);
+        }
+
+      if (xr_fsm_is_empty (p->fsm))
+        {
+          xr_fsm_destroy (p->fsm);
+          p->fsm = NULL;
+        }
+      else if (!chunk)
+        {
+          assert (p->y > 0);
+          p->y = INT_MAX;
+          return;
         }
     }
 }