/* PSPP - a program for statistical analysis.
- Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
+ Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include <config.h>
-#include "output/cairo.h"
-
#include "libpspp/assertion.h"
#include "libpspp/cast.h"
#include "libpspp/message.h"
-#include "libpspp/start-date.h"
#include "libpspp/str.h"
#include "libpspp/string-map.h"
-#include "libpspp/version.h"
-#include "output/cairo-chart.h"
-#include "output/chart-item-provider.h"
-#include "output/charts/boxplot.h"
-#include "output/charts/np-plot.h"
-#include "output/charts/piechart.h"
-#include "output/charts/plot-hist.h"
-#include "output/charts/roc-chart.h"
-#include "output/charts/spreadlevel-plot.h"
-#include "output/charts/scree.h"
+#include "data/file-handle-def.h"
+#include "output/cairo-fsm.h"
+#include "output/cairo-pager.h"
#include "output/driver-provider.h"
-#include "output/message-item.h"
#include "output/options.h"
-#include "output/render.h"
-#include "output/tab.h"
-#include "output/table-item.h"
+#include "output/output-item.h"
#include "output/table.h"
-#include "output/text-item.h"
#include <cairo/cairo-pdf.h>
#include <cairo/cairo-ps.h>
#include <cairo/cairo-svg.h>
+
#include <cairo/cairo.h>
+#include <inttypes.h>
#include <math.h>
#include <pango/pango-font.h>
-#include <pango/pango-layout.h>
-#include <pango/pango.h>
-#include <pango/pangocairo.h>
#include <stdlib.h>
-#include "gl/intprops.h"
-#include "gl/minmax.h"
+#include "gl/c-strcase.h"
#include "gl/xalloc.h"
#include "gettext.h"
#define H TABLE_HORZ
#define V TABLE_VERT
-/* The unit used for internal measurements is inch/(72 * XR_POINT). */
+/* The unit used for internal measurements is inch/(72 * XR_POINT).
+ (Thus, XR_POINT units represent one point.) */
#define XR_POINT PANGO_SCALE
/* Conversions to and from points. */
{
XR_PDF,
XR_PS,
- XR_SVG
+ XR_SVG,
+ XR_PNG
};
-/* Cairo fonts. */
-enum xr_font_type
+/* Cairo output driver. */
+struct xr_driver
{
- XR_FONT_PROPORTIONAL,
- XR_FONT_EMPHASIS,
- XR_FONT_FIXED,
- XR_N_FONTS
- };
+ struct output_driver driver;
-/* A font for use with Cairo. */
-struct xr_font
- {
- PangoFontDescription *desc;
- PangoLayout *layout;
- };
+ enum xr_output_type output_type;
+ struct xr_fsm_style *fsm_style;
+ struct xr_page_style *page_style;
+ struct xr_pager *pager;
+ bool trim;
-/* An output item whose rendering is in progress. */
-struct xr_render_fsm
- {
- /* Renders as much of itself as it can on the current page. Returns true
- if rendering is complete, false if the output item needs another
- page. */
- bool (*render) (struct xr_render_fsm *, struct xr_driver *);
+ /* This is the surface where we're currently drawing. It is always
+ nonnull.
- /* Destroys the output item. */
- void (*destroy) (struct xr_render_fsm *);
- };
+ If 'trim' is true, this is a special Cairo "recording surface" that we
+ are using to save output temporarily just to find out the bounding box,
+ then later replay it into the destination surface.
-/* Cairo output driver. */
-struct xr_driver
- {
- struct output_driver driver;
+ If 'trim' is false:
+
+ - For output to a PDF or PostScript file, it is the same pointer as
+ 'dest_surface'.
+
+ - For output to a PNG file, it is an image surface.
+
+ - For output to an SVG file, it is a recording surface.
+ */
+ cairo_surface_t *drawing_surface;
+
+ /* - For output to a PDF or PostScript file, this is the surface for the
+ PDF or PostScript file where the output is ultimately going.
- /* User parameters. */
- struct xr_font fonts[XR_N_FONTS];
-
- int width; /* Page width minus margins. */
- int length; /* Page length minus margins and header. */
-
- int left_margin; /* Left margin in inch/(72 * XR_POINT). */
- int right_margin; /* Right margin in inch/(72 * XR_POINT). */
- int top_margin; /* Top margin in inch/(72 * XR_POINT). */
- int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */
-
- int line_gutter; /* Space around lines. */
- int line_space; /* Space between lines. */
- int line_width; /* Width of lines. */
-
- int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
-
- struct xr_color bg; /* Background color */
- struct xr_color fg; /* Foreground color */
-
- /* Internal state. */
- struct render_params *params;
- int char_width, char_height;
- char *command_name;
- char *title;
- char *subtitle;
- cairo_t *cairo;
- int page_number; /* Current page number. */
- int x, y;
- struct xr_render_fsm *fsm;
- int nest;
+ - For output to a PNG file, this is NULL, because Cairo has very
+ limited support for PNG. Cairo can't open a PNG file for writing as
+ a surface, it can only save an existing surface to a PNG file.
+
+ - For output to a SVG file, this is NULL, because Cairo does not
+ permit resizing the SVG page size after creating the file, whereas
+ this driver needs to do that sometimes. Also, SVG is not multi-page
+ (according to https://wiki.inkscape.org/wiki/index.php/Multipage).
+ */
+ cairo_surface_t *dest_surface;
+
+ /* Used only in file names, for PNG and SVG output where we can only write
+ one page per file. */
+ int page_number;
};
static const struct output_driver_class cairo_driver_class;
-static void xr_driver_destroy_fsm (struct xr_driver *);
-static void xr_driver_run_fsm (struct xr_driver *);
-
-static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
- enum render_line_style styles[TABLE_N_AXES][2]);
-static void xr_measure_cell_width (void *, const struct table_cell *,
- int *min, int *max);
-static int xr_measure_cell_height (void *, const struct table_cell *,
- int width);
-static void xr_draw_cell (void *, const struct table_cell *,
- int bb[TABLE_N_AXES][2],
- int clip[TABLE_N_AXES][2]);
-static int xr_adjust_break (void *, const struct table_cell *,
- int width, int height);
-
-static struct xr_render_fsm *xr_render_output_item (
- struct xr_driver *, const struct output_item *);
\f
/* Output driver basics. */
return driver_option_get (d, options, key, default_value);
}
-/* Parse color information specified by KEY into {RED,GREEN,BLUE}.
- Currently, the input string must be of the form "#RRRRGGGGBBBB"
- Future implementations might allow things like "yellow" and
- "sky-blue-ultra-brown"
-*/
-void
-parse_color (struct output_driver *d, struct string_map *options,
- const char *key, const char *default_value,
- struct xr_color *color)
+static PangoFontDescription *
+parse_font (const char *font, int default_size, bool bold, bool italic)
{
- int red, green, blue;
- char *string = parse_string (opt (d, options, key, default_value));
+ if (!c_strcasecmp (font, "Monospaced"))
+ font = "Monospace";
- if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue))
- {
- /* If the parsed option string fails, then try the default value */
- if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue))
- {
- /* ... and if that fails set everything to zero */
- red = green = blue = 0;
- }
- }
+ PangoFontDescription *desc = pango_font_description_from_string (font);
+ if (desc == NULL)
+ return NULL;
- free (string);
+ /* If the font description didn't include an explicit font size, then set it
+ to DEFAULT_SIZE, which is in inch/72000 units. */
+ if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
+ pango_font_description_set_size (desc,
+ (default_size / 1000.0) * PANGO_SCALE);
+
+ pango_font_description_set_weight (desc, (bold
+ ? PANGO_WEIGHT_BOLD
+ : PANGO_WEIGHT_NORMAL));
+ pango_font_description_set_style (desc, (italic
+ ? PANGO_STYLE_ITALIC
+ : PANGO_STYLE_NORMAL));
- /* Convert 16 bit ints to float */
- color->red = red / (double) 0xFFFF;
- color->green = green / (double) 0xFFFF;
- color->blue = blue / (double) 0xFFFF;
+ return desc;
}
static PangoFontDescription *
-parse_font (struct output_driver *d, struct string_map *options,
- const char *key, const char *default_value,
- int default_size)
+parse_font_option (struct output_driver *d, struct string_map *options,
+ const char *key, const char *default_value,
+ int default_size, bool bold, bool italic)
{
- PangoFontDescription *desc;
- char *string;
-
- /* Parse KEY as a font description. */
- string = parse_string (opt (d, options, key, default_value));
- desc = pango_font_description_from_string (string);
- if (desc == NULL)
+ char *string = parse_string (opt (d, options, key, default_value));
+ PangoFontDescription *desc = parse_font (string, default_size, bold, italic);
+ if (!desc)
{
msg (MW, _("`%s': bad font specification"), string);
/* Fall back to DEFAULT_VALUE, which had better be a valid font
description. */
- desc = pango_font_description_from_string (default_value);
+ desc = parse_font (default_value, default_size, bold, italic);
assert (desc != NULL);
}
free (string);
- /* If the font description didn't include an explicit font size, then set it
- to DEFAULT_SIZE, which is in inch/72000 units. */
- if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
- pango_font_description_set_size (desc,
- (default_size / 1000.0) * PANGO_SCALE);
-
return desc;
}
-
-static void
-apply_options (struct xr_driver *xr, struct string_map *o)
+static struct xr_driver *
+xr_allocate (const char *name, int device_type,
+ enum xr_output_type output_type, struct string_map *o)
{
+ struct xr_driver *xr = XZALLOC (struct xr_driver);
struct output_driver *d = &xr->driver;
- /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */
- int left_margin, right_margin;
- int top_margin, bottom_margin;
- int paper_width, paper_length;
- int font_size;
- int min_break[TABLE_N_AXES];
+ output_driver_init (d, &cairo_driver_class, name, device_type);
+ xr->output_type = output_type;
/* Scale factor from inch/72000 to inch/(72 * XR_POINT). */
const double scale = XR_POINT / 1000.;
- int i;
+ int paper[TABLE_N_AXES];
+ parse_paper_size (opt (d, o, "paper-size", ""), &paper[H], &paper[V]);
+ for (int a = 0; a < TABLE_N_AXES; a++)
+ paper[a] *= scale;
- for (i = 0; i < XR_N_FONTS; i++)
- {
- struct xr_font *font = &xr->fonts[i];
-
- if (font->desc != NULL)
- pango_font_description_free (font->desc);
- }
+ int margins[TABLE_N_AXES][2];
+ margins[H][0] = parse_dimension (opt (d, o, "left-margin", ".5in")) * scale;
+ margins[H][1] = parse_dimension (opt (d, o, "right-margin", ".5in")) * scale;
+ margins[V][0] = parse_dimension (opt (d, o, "top-margin", ".5in")) * scale;
+ margins[V][1] = parse_dimension (opt (d, o, "bottom-margin", ".5in")) * scale;
- font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
- xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
- font_size);
- xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
- "serif", font_size);
- xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
- "serif italic", font_size);
-
- xr->line_gutter = parse_dimension (opt (d, o, "gutter", "3pt")) * scale;
- xr->line_space = XR_POINT;
- xr->line_width = XR_POINT / 2;
- xr->page_number = 0;
-
- parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg);
- parse_color (d, o, "foreground-color", "#000000000000", &xr->fg);
-
- /* Get dimensions. */
- parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
- left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
- right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
- top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
- bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
+ int size[TABLE_N_AXES];
+ for (int a = 0; a < TABLE_N_AXES; a++)
+ size[a] = paper[a] - margins[a][0] - margins[a][1];
+ int min_break[TABLE_N_AXES];
min_break[H] = parse_dimension (opt (d, o, "min-hbreak", NULL)) * scale;
min_break[V] = parse_dimension (opt (d, o, "min-vbreak", NULL)) * scale;
+ for (int a = 0; a < TABLE_N_AXES; a++)
+ if (min_break[a] <= 0)
+ min_break[a] = size[a] / 2;
- /* Convert to inch/(XR_POINT * 72). */
- xr->left_margin = left_margin * scale;
- xr->right_margin = right_margin * scale;
- xr->top_margin = top_margin * scale;
- xr->bottom_margin = bottom_margin * scale;
- xr->width = (paper_width - left_margin - right_margin) * scale;
- xr->length = (paper_length - top_margin - bottom_margin) * scale;
- xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2;
- xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2;
-}
-
-static struct xr_driver *
-xr_allocate (const char *name, int device_type, struct string_map *o)
-{
- struct xr_driver *xr = xzalloc (sizeof *xr);
- struct output_driver *d = &xr->driver;
-
- output_driver_init (d, &cairo_driver_class, name, device_type);
-
- apply_options (xr, o);
+ int font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
+ PangoFontDescription *font = parse_font_option (
+ d, o, "prop-font", "Sans Serif", font_size, false, false);
- return xr;
-}
-
-static int
-pango_to_xr (int pango)
-{
- return (XR_POINT != PANGO_SCALE
- ? ceil (pango * (1. * XR_POINT / PANGO_SCALE))
- : pango);
-}
-
-static int
-xr_to_pango (int xr)
-{
- return (XR_POINT != PANGO_SCALE
- ? ceil (xr * (1. / XR_POINT * PANGO_SCALE))
- : xr);
-}
+ struct cell_color fg = parse_color (opt (d, o, "foreground-color", "black"));
-static bool
-xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
-{
- int i;
+ bool systemcolors = parse_boolean (opt (d, o, "systemcolors", "false"));
- xr->cairo = cairo;
+ int object_spacing
+ = parse_dimension (opt (d, o, "object-spacing", NULL)) * scale;
+ if (object_spacing <= 0)
+ object_spacing = XR_POINT * 12;
- cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
+ const char *default_resolution = (output_type == XR_PNG ? "96" : "72");
+ int font_resolution = parse_int (opt (d, o, "font-resolution",
+ default_resolution), 10, 1000);
- xr->char_width = 0;
- xr->char_height = 0;
- for (i = 0; i < XR_N_FONTS; i++)
- {
- struct xr_font *font = &xr->fonts[i];
- int char_width, char_height;
+ xr->trim = parse_boolean (opt (d, o, "trim", "false"));
- font->layout = pango_cairo_create_layout (cairo);
- pango_layout_set_font_description (font->layout, font->desc);
+ /* Cairo 1.16.0 has a bug that causes crashes if outlines are enabled at the
+ same time as trimming:
+ https://lists.cairographics.org/archives/cairo/2020-December/029151.html
+ For now, just disable the outline if trimming is enabled. */
+ bool include_outline
+ = (output_type == XR_PDF
+ && parse_boolean (opt (d, o, "outline", xr->trim ? "false" : "true")));
- pango_layout_set_text (font->layout, "0", 1);
- pango_layout_get_size (font->layout, &char_width, &char_height);
- xr->char_width = MAX (xr->char_width, pango_to_xr (char_width));
- xr->char_height = MAX (xr->char_height, pango_to_xr (char_height));
- }
+ xr->page_style = xmalloc (sizeof *xr->page_style);
+ *xr->page_style = (struct xr_page_style) {
+ .ref_cnt = 1,
- if (xr->params == NULL)
- {
- int single_width, double_width;
-
- xr->params = xmalloc (sizeof *xr->params);
- xr->params->draw_line = xr_draw_line;
- xr->params->measure_cell_width = xr_measure_cell_width;
- xr->params->measure_cell_height = xr_measure_cell_height;
- xr->params->adjust_break = xr_adjust_break;
- xr->params->draw_cell = xr_draw_cell;
- xr->params->aux = xr;
- xr->params->size[H] = xr->width;
- xr->params->size[V] = xr->length;
- xr->params->font_size[H] = xr->char_width;
- xr->params->font_size[V] = xr->char_height;
-
- single_width = 2 * xr->line_gutter + xr->line_width;
- double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
- for (i = 0; i < TABLE_N_AXES; i++)
- {
- xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
- xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
- xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
- }
+ .margins = {
+ [H] = { margins[H][0], margins[H][1], },
+ [V] = { margins[V][0], margins[V][1], },
+ },
- for (i = 0; i < TABLE_N_AXES; i++)
- xr->params->min_break[i] = xr->min_break[i];
- }
+ .initial_page_number = 1,
+ .include_outline = include_outline,
+ };
- cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue);
+ xr->fsm_style = xmalloc (sizeof *xr->fsm_style);
+ *xr->fsm_style = (struct xr_fsm_style) {
+ .ref_cnt = 1,
+ .size = { [H] = size[H], [V] = size[V] },
+ .min_break = { [H] = min_break[H], [V] = min_break[V] },
+ .font = font,
+ .fg = fg,
+ .use_system_colors = systemcolors,
+ .object_spacing = object_spacing,
+ .font_resolution = font_resolution,
+ };
- return true;
+ return xr;
}
static struct output_driver *
-xr_create (const char *file_name, enum settings_output_devices device_type,
- struct string_map *o, enum xr_output_type file_type)
-{
- enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
- struct xr_driver *xr;
- cairo_surface_t *surface;
- cairo_status_t status;
- double width_pt, length_pt;
-
- xr = xr_allocate (file_name, device_type, o);
-
- width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
- length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
- if (file_type == XR_PDF)
- surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
- else if (file_type == XR_PS)
- surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
- else if (file_type == XR_SVG)
- surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
- else
- NOT_REACHED ();
-
- status = cairo_surface_status (surface);
- if (status != CAIRO_STATUS_SUCCESS)
- {
- msg (ME, _("error opening output file `%s': %s"),
- file_name, cairo_status_to_string (status));
- cairo_surface_destroy (surface);
- goto error;
- }
-
- xr->cairo = cairo_create (surface);
- cairo_surface_destroy (surface);
-
- if (!xr_set_cairo (xr, xr->cairo))
- goto error;
-
- cairo_save (xr->cairo);
- xr_driver_next_page (xr, xr->cairo);
-
- if (xr->width / xr->char_width < MIN_WIDTH)
- {
- msg (ME, _("The defined page is not wide enough to hold at least %d "
- "characters in the default font. In fact, there's only "
- "room for %d characters."),
- MIN_WIDTH,
- xr->width / xr->char_width);
- goto error;
+xr_create (struct file_handle *fh, enum settings_output_devices device_type,
+ struct string_map *o, enum xr_output_type output_type)
+{
+ const char *file_name = fh_get_file_name (fh);
+ struct xr_driver *xr = xr_allocate (file_name, device_type, output_type, o);
+
+ double paper[TABLE_N_AXES];
+ for (int a = 0; a < TABLE_N_AXES; a++)
+ paper[a] = xr_to_pt (xr_page_style_paper_size (xr->page_style,
+ xr->fsm_style, a));
+
+ xr->dest_surface
+ = (output_type == XR_PDF
+ ? cairo_pdf_surface_create (file_name, paper[H], paper[V])
+ : output_type == XR_PS
+ ? cairo_ps_surface_create (file_name, paper[H], paper[V])
+ : NULL);
+ if (xr->dest_surface)
+ {
+ cairo_status_t status = cairo_surface_status (xr->dest_surface);
+ if (status != CAIRO_STATUS_SUCCESS)
+ {
+ msg (ME, _("error opening output file `%s': %s"),
+ file_name, cairo_status_to_string (status));
+ goto error;
+ }
}
- if (xr->length / xr->char_height < MIN_LENGTH)
- {
- msg (ME, _("The defined page is not long enough to hold at least %d "
- "lines in the default font. In fact, there's only "
- "room for %d lines."),
- MIN_LENGTH,
- xr->length / xr->char_height);
- goto error;
- }
+ xr->drawing_surface
+ = (xr->trim || output_type == XR_SVG
+ ? cairo_recording_surface_create (CAIRO_CONTENT_COLOR_ALPHA,
+ &(cairo_rectangle_t) {
+ .width = paper[H],
+ .height = paper[V] })
+ : output_type == XR_PNG
+ ? cairo_image_surface_create (CAIRO_FORMAT_ARGB32, paper[H], paper[V])
+ : xr->dest_surface);
+ fh_unref (fh);
return &xr->driver;
error:
+ fh_unref (fh);
output_driver_destroy (&xr->driver);
return NULL;
}
static struct output_driver *
-xr_pdf_create (const char *file_name, enum settings_output_devices device_type,
+xr_pdf_create (struct file_handle *fh, enum settings_output_devices device_type,
struct string_map *o)
{
- return xr_create (file_name, device_type, o, XR_PDF);
+ return xr_create (fh, device_type, o, XR_PDF);
}
static struct output_driver *
-xr_ps_create (const char *file_name, enum settings_output_devices device_type,
+xr_ps_create (struct file_handle *fh, enum settings_output_devices device_type,
struct string_map *o)
{
- return xr_create (file_name, device_type, o, XR_PS);
+ return xr_create (fh, device_type, o, XR_PS);
}
static struct output_driver *
-xr_svg_create (const char *file_name, enum settings_output_devices device_type,
+xr_svg_create (struct file_handle *fh, enum settings_output_devices device_type,
struct string_map *o)
{
- return xr_create (file_name, device_type, o, XR_SVG);
-}
-
-static void
-xr_destroy (struct output_driver *driver)
-{
- struct xr_driver *xr = xr_driver_cast (driver);
- size_t i;
-
- xr_driver_destroy_fsm (xr);
-
- if (xr->cairo != NULL)
- {
- cairo_status_t status;
-
- cairo_surface_finish (cairo_get_target (xr->cairo));
- status = cairo_status (xr->cairo);
- if (status != CAIRO_STATUS_SUCCESS)
- msg (ME, _("error drawing output for %s driver: %s"),
- output_driver_get_name (driver),
- cairo_status_to_string (status));
- cairo_destroy (xr->cairo);
- }
-
- free (xr->command_name);
- for (i = 0; i < XR_N_FONTS; i++)
- {
- struct xr_font *font = &xr->fonts[i];
-
- if (font->desc != NULL)
- pango_font_description_free (font->desc);
- if (font->layout != NULL)
- g_object_unref (font->layout);
- }
-
- free (xr->params);
- free (xr);
+ return xr_create (fh, device_type, o, XR_SVG);
}
-static void
-xr_flush (struct output_driver *driver)
+static struct output_driver *
+xr_png_create (struct file_handle *fh, enum settings_output_devices device_type,
+ struct string_map *o)
{
- struct xr_driver *xr = xr_driver_cast (driver);
-
- cairo_surface_flush (cairo_get_target (xr->cairo));
+ return xr_create (fh, device_type, o, XR_PNG);
}
static void
-xr_submit (struct output_driver *driver, const struct output_item *output_item)
-{
- struct xr_driver *xr = xr_driver_cast (driver);
-
- output_driver_track_current_command (output_item, &xr->command_name);
-
- xr_driver_output_item (xr, output_item);
- while (xr_driver_need_new_page (xr))
- {
- cairo_restore (xr->cairo);
- cairo_show_page (xr->cairo);
- cairo_save (xr->cairo);
- xr_driver_next_page (xr, xr->cairo);
- }
-}
-\f
-/* Functions for rendering a series of output items to a series of Cairo
- contexts, with pagination.
-
- Used by PSPPIRE for printing, and by the basic Cairo output driver above as
- its underlying implementation.
-
- See the big comment in cairo.h for intended usage. */
-
-/* Gives new page CAIRO to XR for output. CAIRO may be null to skip actually
- rendering the page (which might be useful to find out how many pages an
- output document has without actually rendering it). */
-void
-xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
+xr_set_surface_size (cairo_surface_t *surface, enum xr_output_type output_type,
+ double width, double height)
{
- if (cairo != NULL)
+ switch (output_type)
{
- cairo_save (cairo);
- cairo_set_source_rgb (cairo, xr->bg.red, xr->bg.green, xr->bg.blue);
- cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
- cairo_fill (cairo);
- cairo_restore (cairo);
-
- cairo_translate (cairo,
- xr_to_pt (xr->left_margin),
- xr_to_pt (xr->top_margin));
- }
-
- xr->page_number++;
- xr->cairo = cairo;
- xr->x = xr->y = 0;
- xr_driver_run_fsm (xr);
-}
-
-/* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
- rendering a previous output item, that is, only if xr_driver_need_new_page()
- returns false. */
-void
-xr_driver_output_item (struct xr_driver *xr,
- const struct output_item *output_item)
-{
- assert (xr->fsm == NULL);
- xr->fsm = xr_render_output_item (xr, output_item);
- xr_driver_run_fsm (xr);
-}
-
-/* Returns true if XR is in the middle of rendering an output item and needs a
- new page to be appended using xr_driver_next_page() to make progress,
- otherwise false. */
-bool
-xr_driver_need_new_page (const struct xr_driver *xr)
-{
- return xr->fsm != NULL;
-}
+ case XR_PDF:
+ cairo_pdf_surface_set_size (surface, width, height);
+ break;
-/* Returns true if the current page doesn't have any content yet. */
-bool
-xr_driver_is_page_blank (const struct xr_driver *xr)
-{
- return xr->y == 0;
-}
+ case XR_PS:
+ cairo_ps_surface_set_size (surface, width, height);
+ break;
-static void
-xr_driver_destroy_fsm (struct xr_driver *xr)
-{
- if (xr->fsm != NULL)
- {
- xr->fsm->destroy (xr->fsm);
- xr->fsm = NULL;
+ case XR_SVG:
+ case XR_PNG:
+ NOT_REACHED ();
}
}
static void
-xr_driver_run_fsm (struct xr_driver *xr)
+xr_copy_surface (cairo_surface_t *dst, cairo_surface_t *src,
+ double x, double y)
{
- if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
- xr_driver_destroy_fsm (xr);
+ cairo_t *cr = cairo_create (dst);
+ cairo_set_source_surface (cr, src, x, y);
+ cairo_paint (cr);
+ cairo_destroy (cr);
}
-\f
-static void
-xr_layout_cell (struct xr_driver *, const struct table_cell *,
- int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
- int *width, int *height, int *brk);
static void
-dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
-{
- cairo_new_path (xr->cairo);
- cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y));
- cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y));
- cairo_stroke (xr->cairo);
-}
-
-static void UNUSED
-dump_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1)
-{
- cairo_new_path (xr->cairo);
- cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y));
- cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y0 + xr->y));
- cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y));
- cairo_line_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y1 + xr->y));
- cairo_close_path (xr->cairo);
- cairo_stroke (xr->cairo);
+clear_rectangle (cairo_surface_t *surface,
+ double x0, double y0, double x1, double y1)
+{
+ cairo_t *cr = cairo_create (surface);
+ cairo_set_source_rgb (cr, 1, 1, 1);
+ cairo_new_path (cr);
+ cairo_rectangle (cr, x0, y0, x1 - x0, y1 - y0);
+ cairo_fill (cr);
+ cairo_destroy (cr);
}
-/* Draws a horizontal line X0...X2 at Y if LEFT says so,
- shortening it to X0...X1 if SHORTEN is true.
- Draws a horizontal line X1...X3 at Y if RIGHT says so,
- shortening it to X2...X3 if SHORTEN is true. */
static void
-horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
- enum render_line_style left, enum render_line_style right,
- bool shorten)
+xr_report_error (cairo_status_t status, const char *file_name)
{
- if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
- dump_line (xr, x0, y, x3, y);
- else
- {
- if (left != RENDER_LINE_NONE)
- dump_line (xr, x0, y, shorten ? x1 : x2, y);
- if (right != RENDER_LINE_NONE)
- dump_line (xr, shorten ? x2 : x1, y, x3, y);
- }
+ if (status != CAIRO_STATUS_SUCCESS)
+ fprintf (stderr, "%s: %s\n", file_name, cairo_status_to_string (status));
}
-/* Draws a vertical line Y0...Y2 at X if TOP says so,
- shortening it to Y0...Y1 if SHORTEN is true.
- Draws a vertical line Y1...Y3 at X if BOTTOM says so,
- shortening it to Y2...Y3 if SHORTEN is true. */
static void
-vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
- enum render_line_style top, enum render_line_style bottom,
- bool shorten)
+xr_finish_page (struct xr_driver *xr)
{
- if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
- dump_line (xr, x, y0, x, y3);
- else
- {
- if (top != RENDER_LINE_NONE)
- dump_line (xr, x, y0, x, shorten ? y1 : y2);
- if (bottom != RENDER_LINE_NONE)
- dump_line (xr, x, shorten ? y2 : y1, x, y3);
- }
-}
+ xr_pager_finish_page (xr->pager);
-static void
-xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
- enum render_line_style styles[TABLE_N_AXES][2])
-{
- const int x0 = bb[H][0];
- const int y0 = bb[V][0];
- const int x3 = bb[H][1];
- const int y3 = bb[V][1];
- const int top = styles[H][0];
- const int left = styles[V][0];
- const int bottom = styles[H][1];
- const int right = styles[V][1];
-
- /* The algorithm here is somewhat subtle, to allow it to handle
- all the kinds of intersections that we need.
-
- Three additional ordinates are assigned along the x axis. The
- first is xc, midway between x0 and x3. The others are x1 and
- x2; for a single vertical line these are equal to xc, and for
- a double vertical line they are the ordinates of the left and
- right half of the double line.
-
- yc, y1, and y2 are assigned similarly along the y axis.
-
- The following diagram shows the coordinate system and output
- for double top and bottom lines, single left line, and no
- right line:
-
- x0 x1 xc x2 x3
- y0 ________________________
- | # # |
- | # # |
- | # # |
- | # # |
- | # # |
- y1 = y2 = yc |######### # |
- | # # |
- | # # |
- | # # |
- | # # |
- y3 |________#_____#_______|
- */
- struct xr_driver *xr = xr_;
-
- /* Offset from center of each line in a pair of double lines. */
- int double_line_ofs = (xr->line_space + xr->line_width) / 2;
-
- /* Are the lines along each axis single or double?
- (It doesn't make sense to have different kinds of line on the
- same axis, so we don't try to gracefully handle that case.) */
- bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
- bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE;
-
- /* When horizontal lines are doubled,
- the left-side line along y1 normally runs from x0 to x2,
- and the right-side line along y1 from x3 to x1.
- If the top-side line is also doubled, we shorten the y1 lines,
- so that the left-side line runs only to x1,
- and the right-side line only to x2.
- Otherwise, the horizontal line at y = y1 below would cut off
- the intersection, which looks ugly:
- x0 x1 x2 x3
- y0 ________________________
- | # # |
- | # # |
- | # # |
- | # # |
- y1 |######### ########|
- | |
- | |
- y2 |######################|
- | |
- | |
- y3 |______________________|
- It is more of a judgment call when the horizontal line is
- single. We actually choose to cut off the line anyhow, as
- shown in the first diagram above.
- */
- bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
- bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
- bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
- int horz_line_ofs = double_vert ? double_line_ofs : 0;
- int xc = (x0 + x3) / 2;
- int x1 = xc - horz_line_ofs;
- int x2 = xc + horz_line_ofs;
-
- bool shorten_x1_lines = left == RENDER_LINE_DOUBLE;
- bool shorten_x2_lines = right == RENDER_LINE_DOUBLE;
- bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
- int vert_line_ofs = double_horz ? double_line_ofs : 0;
- int yc = (y0 + y3) / 2;
- int y1 = yc - vert_line_ofs;
- int y2 = yc + vert_line_ofs;
-
- if (!double_horz)
- horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line);
- else
- {
- horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines);
- horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines);
- }
+ /* For 'trim' true:
- if (!double_vert)
- vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
- else
- {
- vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
- vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
- }
-}
+ - If the destination is PDF or PostScript, set the dest surface size, copy
+ ink extent, show_page.
-static void
-xr_measure_cell_width (void *xr_, const struct table_cell *cell,
- int *min_width, int *max_width)
-{
- struct xr_driver *xr = xr_;
- int bb[TABLE_N_AXES][2];
- int clip[TABLE_N_AXES][2];
- int h;
-
- bb[H][0] = 0;
- bb[H][1] = INT_MAX;
- bb[V][0] = 0;
- bb[V][1] = INT_MAX;
- clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
- xr_layout_cell (xr, cell, bb, clip, max_width, &h, NULL);
-
- bb[H][1] = 1;
- xr_layout_cell (xr, cell, bb, clip, min_width, &h, NULL);
-}
+ - If the destination is PNG, create image surface, copy ink extent,
+ cairo_surface_write_to_png(), destroy image surface.
-static int
-xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
-{
- struct xr_driver *xr = xr_;
- int bb[TABLE_N_AXES][2];
- int clip[TABLE_N_AXES][2];
- int w, h;
-
- bb[H][0] = 0;
- bb[H][1] = width;
- bb[V][0] = 0;
- bb[V][1] = INT_MAX;
- clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
- xr_layout_cell (xr, cell, bb, clip, &w, &h, NULL);
- return h;
-}
+ - If the destination is SVG, create svg surface, copy ink extent, close.
-static void
-xr_draw_cell (void *xr_, const struct table_cell *cell,
- int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
-{
- struct xr_driver *xr = xr_;
- int w, h, brk;
+ then destroy drawing_surface and make a new one.
- xr_layout_cell (xr, cell, bb, clip, &w, &h, &brk);
-}
+ For 'trim' false:
-static int
-xr_adjust_break (void *xr_, const struct table_cell *cell,
- int width, int height)
-{
- struct xr_driver *xr = xr_;
- int bb[TABLE_N_AXES][2];
- int clip[TABLE_N_AXES][2];
- int w, h, brk;
-
- if (xr_measure_cell_height (xr_, cell, width) < height)
- return -1;
-
- bb[H][0] = 0;
- bb[H][1] = width;
- bb[V][0] = 0;
- bb[V][1] = height;
- clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
- xr_layout_cell (xr, cell, bb, clip, &w, &h, &brk);
- return brk;
-}
-\f
-static void
-xr_clip (struct xr_driver *xr, int clip[TABLE_N_AXES][2])
-{
- if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
- {
- double x0 = xr_to_pt (clip[H][0] + xr->x);
- double y0 = xr_to_pt (clip[V][0] + xr->y);
- double x1 = xr_to_pt (clip[H][1] + xr->x);
- double y1 = xr_to_pt (clip[V][1] + xr->y);
+ - If the destination is PDF or PostScript, show_page.
- cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
- cairo_clip (xr->cairo);
- }
-}
+ - If the destination is PNG, cairo_surface_write_to_png(), destroy image
+ surface, create new image surface.
-static int
-xr_layout_cell_text (struct xr_driver *xr,
- const struct cell_contents *contents,
- int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
- int y, int *widthp, int *brk)
-{
- unsigned int options = contents->options;
- struct xr_font *font;
- int w, h;
-
- font = (options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
- : options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
- : &xr->fonts[XR_FONT_PROPORTIONAL]);
-
- pango_layout_set_text (font->layout, contents->text, -1);
-
- pango_layout_set_alignment (
- font->layout,
- ((options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
- : (options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
- : PANGO_ALIGN_CENTER));
- pango_layout_set_width (
- font->layout,
- bb[H][1] == INT_MAX ? -1 : xr_to_pango (bb[H][1] - bb[H][0]));
- pango_layout_set_wrap (font->layout, PANGO_WRAP_WORD);
-
- if (clip[H][0] != clip[H][1])
- {
- cairo_save (xr->cairo);
- xr_clip (xr, clip);
- cairo_translate (xr->cairo,
- xr_to_pt (bb[H][0] + xr->x),
- xr_to_pt (y + xr->y));
- pango_cairo_show_layout (xr->cairo, font->layout);
-
- /* If enabled, this draws a blue rectangle around the extents of each
- line of text, which can be rather useful for debugging layout
- issues. */
- if (0)
- {
- PangoLayoutIter *iter;
- iter = pango_layout_get_iter (font->layout);
- do
- {
- PangoRectangle extents;
-
- pango_layout_iter_get_line_extents (iter, &extents, NULL);
- cairo_save (xr->cairo);
- cairo_set_source_rgb (xr->cairo, 1, 0, 0);
- dump_rectangle (xr,
- pango_to_xr (extents.x) - xr->x,
- pango_to_xr (extents.y) - xr->y,
- pango_to_xr (extents.x + extents.width) - xr->x,
- pango_to_xr (extents.y + extents.height) - xr->y);
- cairo_restore (xr->cairo);
- }
- while (pango_layout_iter_next_line (iter));
- pango_layout_iter_free (iter);
- }
+ - If the destination is SVG, create svg surface, copy whole thing, close.
- cairo_restore (xr->cairo);
- }
+ */
+ double paper[TABLE_N_AXES];
+ for (int a = 0; a < TABLE_N_AXES; a++)
+ paper[a] = xr_to_pt (xr_page_style_paper_size (
+ xr->page_style, xr->fsm_style, a));
- pango_layout_get_size (font->layout, &w, &h);
- w = pango_to_xr (w);
- h = pango_to_xr (h);
- if (w > *widthp)
- *widthp = w;
- if (y + h >= bb[V][1])
- {
- PangoLayoutIter *iter;
- int best UNUSED = 0;
-
- /* Choose a breakpoint between lines instead of in the middle of one. */
- iter = pango_layout_get_iter (font->layout);
- do
+ xr->page_number++;
+ char *file_name = (xr->page_number > 1
+ ? xasprintf ("%s-%d", xr->driver.name, xr->page_number)
+ : xr->driver.name);
+
+ if (xr->trim)
+ {
+ /* Get the bounding box for the drawing surface. */
+ double ofs[TABLE_N_AXES], size[TABLE_N_AXES];
+ cairo_recording_surface_ink_extents (xr->drawing_surface,
+ &ofs[H], &ofs[V],
+ &size[H], &size[V]);
+ const int (*margins)[2] = xr->page_style->margins;
+ for (int a = 0; a < TABLE_N_AXES; a++)
{
- PangoRectangle extents;
- int y0, y1;
- int bottom;
-
- pango_layout_iter_get_line_extents (iter, NULL, &extents);
- pango_layout_iter_get_line_yrange (iter, &y0, &y1);
- extents.x = pango_to_xr (extents.x);
- extents.y = pango_to_xr (y0);
- extents.width = pango_to_xr (extents.width);
- extents.height = pango_to_xr (y1 - y0);
- bottom = y + extents.y + extents.height;
- if (bottom < bb[V][1])
- {
- if (brk && clip[H][0] != clip[H][1])
- best = bottom;
- *brk = bottom;
- }
- else
- break;
+ double scale = XR_POINT;
+ size[a] += (margins[a][0] + margins[a][1]) / scale;
+ ofs[a] = -ofs[a] + margins[a][0] / scale;
}
- while (pango_layout_iter_next_line (iter));
- /* If enabled, draws a green line across the chosen breakpoint, which can
- be useful for debugging issues with breaking. */
- if (0)
+ switch (xr->output_type)
{
- if (best && !xr->nest)
- {
- cairo_save (xr->cairo);
- cairo_set_source_rgb (xr->cairo, 0, 1, 0);
- dump_line (xr, -xr->left_margin, best, xr->width + xr->right_margin, best);
- cairo_restore (xr->cairo);
- }
+ case XR_PDF:
+ case XR_PS:
+ xr_set_surface_size (xr->dest_surface, xr->output_type,
+ size[H], size[V]);
+ xr_copy_surface (xr->dest_surface, xr->drawing_surface,
+ ofs[H], ofs[V]);
+ cairo_surface_show_page (xr->dest_surface);
+ break;
+
+ case XR_SVG:
+ {
+ cairo_surface_t *svg = cairo_svg_surface_create (
+ file_name, size[H], size[V]);
+ xr_copy_surface (svg, xr->drawing_surface, ofs[H], ofs[V]);
+ xr_report_error (cairo_surface_status (svg), file_name);
+ cairo_surface_destroy (svg);
+ }
+ break;
+
+ case XR_PNG:
+ {
+ cairo_surface_t *png = cairo_image_surface_create (
+ CAIRO_FORMAT_ARGB32, size[H], size[V]);
+ clear_rectangle (png, 0, 0, size[H], size[V]);
+ xr_copy_surface (png, xr->drawing_surface, ofs[H], ofs[V]);
+ xr_report_error (cairo_surface_write_to_png (png, file_name),
+ file_name);
+ cairo_surface_destroy (png);
+ }
+ break;
}
- }
- return y + h;
-}
-
-static int
-xr_layout_cell_subtable (struct xr_driver *xr,
- const struct cell_contents *contents,
- int bb[TABLE_N_AXES][2],
- int clip[TABLE_N_AXES][2], int *widthp, int *brk)
-{
- int single_width, double_width;
- struct render_params params;
- struct render_pager *p;
- int r[TABLE_N_AXES][2];
- int width, height;
- int i;
-
- params.draw_line = xr_draw_line;
- params.measure_cell_width = xr_measure_cell_width;
- params.measure_cell_height = xr_measure_cell_height;
- params.adjust_break = NULL;
- params.draw_cell = xr_draw_cell;
- params.aux = xr;
- params.size[H] = bb[H][1] - bb[H][0];
- params.size[V] = bb[V][1] - bb[V][0];
- params.font_size[H] = xr->char_width;
- params.font_size[V] = xr->char_height;
-
- single_width = 2 * xr->line_gutter + xr->line_width;
- double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
- for (i = 0; i < TABLE_N_AXES; i++)
- {
- params.line_widths[i][RENDER_LINE_NONE] = 0;
- params.line_widths[i][RENDER_LINE_SINGLE] = single_width;
- params.line_widths[i][RENDER_LINE_DOUBLE] = double_width;
- }
-
- xr->nest++;
- p = render_pager_create (¶ms, contents->table);
- width = render_pager_get_size (p, H);
- height = render_pager_get_size (p, V);
- if (bb[V][0] + height >= bb[V][1])
- *brk = bb[V][0] + render_pager_get_best_breakpoint (p, bb[V][1] - bb[V][0]);
-
- /* r = intersect(bb, clip) - bb. */
- for (i = 0; i < TABLE_N_AXES; i++)
- {
- r[i][0] = MAX (bb[i][0], clip[i][0]) - bb[i][0];
- r[i][1] = MIN (bb[i][1], clip[i][1]) - bb[i][0];
- }
-
- if (r[H][0] < r[H][1] && r[V][0] < r[V][1])
- {
- unsigned int alignment = contents->options & TAB_ALIGNMENT;
- int save_x = xr->x;
-
- cairo_save (xr->cairo);
- xr_clip (xr, clip);
- xr->x += bb[H][0];
- if (alignment == TAB_RIGHT)
- xr->x += params.size[H] - width;
- else if (alignment == TAB_CENTER)
- xr->x += (params.size[H] - width) / 2;
- xr->y += bb[V][0];
- render_pager_draw_region (p, r[H][0], r[V][0],
- r[H][1] - r[H][0], r[V][1] - r[V][0]);
- xr->y -= bb[V][0];
- xr->x = save_x;
- cairo_restore (xr->cairo);
- }
- render_pager_destroy (p);
- xr->nest--;
-
- if (width > *widthp)
- *widthp = width;
- return bb[V][0] + height;
-}
-static void
-xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
- int bb_[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
- int *width, int *height, int *brk)
-{
- int bb[TABLE_N_AXES][2];
- size_t i;
-
- *width = 0;
- *height = 0;
- if (brk)
- *brk = 0;
-
- memcpy (bb, bb_, sizeof bb);
-
- /* If enabled, draws a blue rectangle around the cell extents, which can be
- useful for debugging layout. */
- if (0)
- {
- if (clip[H][0] != clip[H][1])
- {
- int offset = (xr->nest) * XR_POINT;
-
- cairo_save (xr->cairo);
- cairo_set_source_rgb (xr->cairo, 0, 0, 1);
- dump_rectangle (xr,
- bb[H][0] + offset, bb[V][0] + offset,
- bb[H][1] - offset, bb[V][1] - offset);
- cairo_restore (xr->cairo);
- }
+ /* Destroy the recording surface and create a fresh one of the same
+ size. */
+ cairo_surface_destroy (xr->drawing_surface);
+ xr->drawing_surface = cairo_recording_surface_create (
+ CAIRO_CONTENT_COLOR_ALPHA,
+ &(cairo_rectangle_t) { .width = paper[H], .height = paper[V] });
}
-
- for (i = 0; i < cell->n_contents && bb[V][0] < bb[V][1]; i++)
+ else
{
- const struct cell_contents *contents = &cell->contents[i];
-
- if (brk)
- *brk = bb[V][0];
- if (i > 0)
+ switch (xr->output_type)
{
- bb[V][0] += xr->char_height / 2;
- if (bb[V][0] >= bb[V][1])
- break;
- if (brk)
- *brk = bb[V][0];
+ case XR_PDF:
+ case XR_PS:
+ cairo_surface_show_page (xr->dest_surface);
+ break;
+
+ case XR_SVG:
+ {
+ cairo_surface_t *svg = cairo_svg_surface_create (
+ file_name, paper[H], paper[V]);
+ xr_copy_surface (svg, xr->drawing_surface, 0.0, 0.0);
+ xr_report_error (cairo_surface_status (svg), file_name);
+ cairo_surface_destroy (svg);
+ }
+ break;
+
+ case XR_PNG:
+ xr_report_error (cairo_surface_write_to_png (xr->drawing_surface,
+ file_name), file_name);
+ cairo_surface_destroy (xr->drawing_surface);
+ xr->drawing_surface = cairo_image_surface_create (
+ CAIRO_FORMAT_ARGB32, paper[H], paper[V]);
+ break;
}
-
- if (contents->text)
- bb[V][0] = xr_layout_cell_text (xr, contents, bb, clip,
- bb[V][0], width, brk);
- else
- bb[V][0] = xr_layout_cell_subtable (xr, contents, bb, clip, width, brk);
- }
- *height = bb[V][0] - bb_[V][0];
-}
-\f
-struct output_driver_factory pdf_driver_factory =
- { "pdf", "pspp.pdf", xr_pdf_create };
-struct output_driver_factory ps_driver_factory =
- { "ps", "pspp.ps", xr_ps_create };
-struct output_driver_factory svg_driver_factory =
- { "svg", "pspp.svg", xr_svg_create };
-
-static const struct output_driver_class cairo_driver_class =
-{
- "cairo",
- xr_destroy,
- xr_submit,
- xr_flush,
-};
-\f
-/* GUI rendering helpers. */
-
-struct xr_rendering
- {
- struct output_item *item;
-
- /* Table items. */
- struct render_pager *p;
- struct xr_driver *xr;
- };
-
-#define CHART_WIDTH 500
-#define CHART_HEIGHT 375
-
-
-
-struct xr_driver *
-xr_driver_create (cairo_t *cairo, struct string_map *options)
-{
- struct xr_driver *xr = xr_allocate ("cairo", 0, options);
- if (!xr_set_cairo (xr, cairo))
- {
- output_driver_destroy (&xr->driver);
- return NULL;
- }
- return xr;
-}
-
-/* Destroy XR, which should have been created with xr_driver_create(). Any
- cairo_t added to XR is not destroyed, because it is owned by the client. */
-void
-xr_driver_destroy (struct xr_driver *xr)
-{
- if (xr != NULL)
- {
- xr->cairo = NULL;
- output_driver_destroy (&xr->driver);
}
-}
-
-static struct xr_rendering *
-xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
-{
- struct table_item *table_item;
- struct xr_rendering *r;
-
- table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
- r = xr_rendering_create (xr, &table_item->output_item, cr);
- table_item_unref (table_item);
-
- return r;
-}
-void
-xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
-{
- if (is_table_item (xr->item))
- apply_options (xr->xr, o);
+ if (file_name != xr->driver.name)
+ free (file_name);
}
-struct xr_rendering *
-xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
- cairo_t *cr)
+static void
+xr_destroy (struct output_driver *driver)
{
- struct xr_rendering *r = NULL;
-
- if (is_text_item (item))
- r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
- cr);
- else if (is_message_item (item))
- {
- const struct message_item *message_item = to_message_item (item);
- const struct msg *msg = message_item_get_msg (message_item);
- char *s = msg_to_string (msg, NULL);
- r = xr_rendering_create_text (xr, s, cr);
- free (s);
- }
- else if (is_table_item (item))
- {
- r = xzalloc (sizeof *r);
- r->item = output_item_ref (item);
- r->xr = xr;
- xr_set_cairo (xr, cr);
- r->p = render_pager_create (xr->params, to_table_item (item));
- }
- else if (is_chart_item (item))
- {
- r = xzalloc (sizeof *r);
- r->item = output_item_ref (item);
- }
+ struct xr_driver *xr = xr_driver_cast (driver);
- return r;
-}
+ if (xr->pager)
+ xr_finish_page (xr);
-void
-xr_rendering_destroy (struct xr_rendering *r)
-{
- if (r)
- {
- output_item_unref (r->item);
- render_pager_destroy (r->p);
- free (r);
- }
-}
+ xr_pager_destroy (xr->pager);
-void
-xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
-{
- if (is_table_item (r->item))
- {
- *w = render_pager_get_size (r->p, H) / XR_POINT;
- *h = render_pager_get_size (r->p, V) / XR_POINT;
- }
- else
+ if (xr->drawing_surface && xr->drawing_surface != xr->dest_surface)
+ cairo_surface_destroy (xr->drawing_surface);
+ if (xr->dest_surface)
{
- *w = CHART_WIDTH;
- *h = CHART_HEIGHT;
+ cairo_surface_finish (xr->dest_surface);
+ cairo_status_t status = cairo_surface_status (xr->dest_surface);
+ if (status != CAIRO_STATUS_SUCCESS)
+ fprintf (stderr, _("error drawing output for %s driver: %s\n"),
+ output_driver_get_name (driver),
+ cairo_status_to_string (status));
+ cairo_surface_destroy (xr->dest_surface);
}
-}
-
-static void xr_draw_chart (const struct chart_item *, cairo_t *,
- double x, double y, double width, double height);
-
-/* Draws onto CR at least the region of R that is enclosed in (X,Y)-(X+W,Y+H),
- and possibly some additional parts. */
-void
-xr_rendering_draw (struct xr_rendering *r, cairo_t *cr,
- int x, int y, int w, int h)
-{
- if (is_table_item (r->item))
- {
- struct xr_driver *xr = r->xr;
-
- xr_set_cairo (xr, cr);
- xr->y = 0;
- render_pager_draw_region (r->p,
- x * XR_POINT, y * XR_POINT,
- w * XR_POINT, h * XR_POINT);
- }
- else
- xr_draw_chart (to_chart_item (r->item), cr,
- 0, 0, CHART_WIDTH, CHART_HEIGHT);
+ xr_page_style_unref (xr->page_style);
+ xr_fsm_style_unref (xr->fsm_style);
+ free (xr);
}
static void
-xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
- double x, double y, double width, double height)
+xr_update_page_setup (struct output_driver *driver,
+ const struct page_setup *setup)
{
- struct xrchart_geometry geom;
-
- cairo_save (cr);
- cairo_translate (cr, x, y + height);
- cairo_scale (cr, 1.0, -1.0);
- xrchart_geometry_init (cr, &geom, width, height);
- if (is_boxplot (chart_item))
- xrchart_draw_boxplot (chart_item, cr, &geom);
- else if (is_histogram_chart (chart_item))
- xrchart_draw_histogram (chart_item, cr, &geom);
- else if (is_np_plot_chart (chart_item))
- xrchart_draw_np_plot (chart_item, cr, &geom);
- else if (is_piechart (chart_item))
- xrchart_draw_piechart (chart_item, cr, &geom);
- else if (is_roc_chart (chart_item))
- xrchart_draw_roc (chart_item, cr, &geom);
- else if (is_scree (chart_item))
- xrchart_draw_scree (chart_item, cr, &geom);
- else if (is_spreadlevel_plot_chart (chart_item))
- xrchart_draw_spreadlevel (chart_item, cr, &geom);
- else
- NOT_REACHED ();
- xrchart_geometry_free (cr, &geom);
-
- cairo_restore (cr);
-}
-
-char *
-xr_draw_png_chart (const struct chart_item *item,
- const char *file_name_template, int number,
- const struct xr_color *fg,
- const struct xr_color *bg
- )
-{
- const int width = 640;
- const int length = 480;
-
- cairo_surface_t *surface;
- cairo_status_t status;
- const char *number_pos;
- char *file_name;
- cairo_t *cr;
-
- number_pos = strchr (file_name_template, '#');
- if (number_pos != NULL)
- file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
- file_name_template, number, number_pos + 1);
- else
- file_name = xstrdup (file_name_template);
-
- surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
- cr = cairo_create (surface);
-
- cairo_set_source_rgb (cr, bg->red, bg->green, bg->blue);
- cairo_paint (cr);
+ struct xr_driver *xr = xr_driver_cast (driver);
- cairo_set_source_rgb (cr, fg->red, fg->green, fg->blue);
+ const double scale = 72 * XR_POINT;
- xr_draw_chart (item, cr, 0.0, 0.0, width, length);
+ int swap = setup->orientation == PAGE_LANDSCAPE;
+ enum table_axis h = H ^ swap;
+ enum table_axis v = V ^ swap;
- status = cairo_surface_write_to_png (surface, file_name);
- if (status != CAIRO_STATUS_SUCCESS)
- msg (ME, _("error writing output file `%s': %s"),
- file_name, cairo_status_to_string (status));
+ struct xr_page_style *old_ps = xr->page_style;
+ xr->page_style = xmalloc (sizeof *xr->page_style);
+ *xr->page_style = (struct xr_page_style) {
+ .ref_cnt = 1,
- cairo_destroy (cr);
- cairo_surface_destroy (surface);
+ .margins = {
+ [H] = { setup->margins[h][0] * scale, setup->margins[h][1] * scale },
+ [V] = { setup->margins[v][0] * scale, setup->margins[v][1] * scale },
+ },
- return file_name;
-}
-\f
-struct xr_table_state
- {
- struct xr_render_fsm fsm;
- struct table_item *table_item;
- struct render_pager *p;
+ .initial_page_number = setup->initial_page_number,
+ .include_outline = old_ps->include_outline,
};
-
-static bool
-xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
-{
- struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
-
- while (render_pager_has_next (ts->p))
- {
- int used;
-
- used = render_pager_draw_next (ts->p, xr->length - xr->y);
- if (!used)
- {
- assert (xr->y > 0);
- return true;
- }
- else
- xr->y += used;
- }
- return false;
-}
-
-static void
-xr_table_destroy (struct xr_render_fsm *fsm)
-{
- struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
-
- table_item_unref (ts->table_item);
- render_pager_destroy (ts->p);
- free (ts);
-}
-
-static struct xr_render_fsm *
-xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
-{
- struct xr_table_state *ts;
-
- ts = xmalloc (sizeof *ts);
- ts->fsm.render = xr_table_render;
- ts->fsm.destroy = xr_table_destroy;
- ts->table_item = table_item_ref (table_item);
-
- if (xr->y > 0)
- xr->y += xr->char_height;
-
- ts->p = render_pager_create (xr->params, table_item);
-
- return &ts->fsm;
-}
-\f
-struct xr_chart_state
- {
- struct xr_render_fsm fsm;
- struct chart_item *chart_item;
+ for (size_t i = 0; i < 2; i++)
+ page_heading_copy (&xr->page_style->headings[i], &setup->headings[i]);
+ xr_page_style_unref (old_ps);
+
+ struct xr_fsm_style *old_fs = xr->fsm_style;
+ xr->fsm_style = xmalloc (sizeof *xr->fsm_style);
+ *xr->fsm_style = (struct xr_fsm_style) {
+ .ref_cnt = 1,
+ .size = { [H] = setup->paper[H] * scale, [V] = setup->paper[V] * scale },
+ .min_break = {
+ [H] = setup->paper[H] * scale / 2,
+ [V] = setup->paper[V] * scale / 2,
+ },
+ .font = pango_font_description_copy (old_fs->font),
+ .fg = old_fs->fg,
+ .use_system_colors = old_fs->use_system_colors,
+ .object_spacing = setup->object_spacing * 72 * XR_POINT,
+ .font_resolution = old_fs->font_resolution,
};
+ xr_fsm_style_unref (old_fs);
-static bool
-xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
-{
- struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
-
- if (xr->y > 0)
- return true;
-
- if (xr->cairo != NULL)
- xr_draw_chart (cs->chart_item, xr->cairo, 0.0, 0.0,
- xr_to_pt (xr->width), xr_to_pt (xr->length));
- xr->y = xr->length;
-
- return false;
+ xr_set_surface_size (xr->dest_surface, xr->output_type,
+ setup->paper[H] * 72.0, setup->paper[V] * 72.0);
}
static void
-xr_chart_destroy (struct xr_render_fsm *fsm)
+xr_submit (struct output_driver *driver, const struct output_item *item)
{
- struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
-
- chart_item_unref (cs->chart_item);
- free (cs);
-}
-
-static struct xr_render_fsm *
-xr_render_chart (const struct chart_item *chart_item)
-{
- struct xr_chart_state *cs;
-
- cs = xmalloc (sizeof *cs);
- cs->fsm.render = xr_chart_render;
- cs->fsm.destroy = xr_chart_destroy;
- cs->chart_item = chart_item_ref (chart_item);
-
- return &cs->fsm;
-}
-\f
-static bool
-xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
-{
- return xr->y > 0;
-}
-
-static void
-xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
-{
- /* Nothing to do. */
-}
+ struct xr_driver *xr = xr_driver_cast (driver);
-static struct xr_render_fsm *
-xr_render_eject (void)
-{
- static struct xr_render_fsm eject_renderer =
+ if (!xr->pager)
{
- xr_eject_render,
- xr_eject_destroy
- };
-
- return &eject_renderer;
-}
-\f
-static struct xr_render_fsm *
-xr_create_text_renderer (struct xr_driver *xr, const char *text)
-{
- struct table_item *table_item;
- struct xr_render_fsm *fsm;
-
- table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
- fsm = xr_render_table (xr, table_item);
- table_item_unref (table_item);
-
- return fsm;
-}
-
-static struct xr_render_fsm *
-xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
-{
- enum text_item_type type = text_item_get_type (text_item);
- const char *text = text_item_get_text (text_item);
+ xr->pager = xr_pager_create (xr->page_style, xr->fsm_style);
+ xr_pager_add_page (xr->pager, cairo_create (xr->drawing_surface));
+ }
- switch (type)
+ xr_pager_add_item (xr->pager, item);
+ while (xr_pager_needs_new_page (xr->pager))
{
- case TEXT_ITEM_TITLE:
- free (xr->title);
- xr->title = xstrdup (text);
- break;
-
- case TEXT_ITEM_SUBTITLE:
- free (xr->subtitle);
- xr->subtitle = xstrdup (text);
- break;
-
- case TEXT_ITEM_COMMAND_CLOSE:
- break;
-
- case TEXT_ITEM_BLANK_LINE:
- if (xr->y > 0)
- xr->y += xr->char_height;
- break;
-
- case TEXT_ITEM_EJECT_PAGE:
- if (xr->y > 0)
- return xr_render_eject ();
- break;
-
- default:
- return xr_create_text_renderer (xr, text);
+ xr_finish_page (xr);
+ xr_pager_add_page (xr->pager, cairo_create (xr->drawing_surface));
}
-
- return NULL;
}
-static struct xr_render_fsm *
-xr_render_message (struct xr_driver *xr,
- const struct message_item *message_item)
+static void
+xr_setup (struct output_driver *driver, const struct page_setup *ps)
{
- const struct msg *msg = message_item_get_msg (message_item);
- struct xr_render_fsm *fsm;
- char *s;
-
- s = msg_to_string (msg, xr->command_name);
- fsm = xr_create_text_renderer (xr, s);
- free (s);
+ struct xr_driver *xr = xr_driver_cast (driver);
- return fsm;
+ if (!xr->pager)
+ xr_update_page_setup (driver, ps);
}
+\f
+struct output_driver_factory pdf_driver_factory =
+ { "pdf", "pspp.pdf", xr_pdf_create };
+struct output_driver_factory ps_driver_factory =
+ { "ps", "pspp.ps", xr_ps_create };
+struct output_driver_factory svg_driver_factory =
+ { "svg", "pspp.svg", xr_svg_create };
+struct output_driver_factory png_driver_factory =
+ { "png", "pspp.png", xr_png_create };
-static struct xr_render_fsm *
-xr_render_output_item (struct xr_driver *xr,
- const struct output_item *output_item)
+static const struct output_driver_class cairo_driver_class =
{
- if (is_table_item (output_item))
- return xr_render_table (xr, to_table_item (output_item));
- else if (is_chart_item (output_item))
- return xr_render_chart (to_chart_item (output_item));
- else if (is_text_item (output_item))
- return xr_render_text (xr, to_text_item (output_item));
- else if (is_message_item (output_item))
- return xr_render_message (xr, to_message_item (output_item));
- else
- return NULL;
-}
+ .name = "cairo",
+ .destroy = xr_destroy,
+ .submit = xr_submit,
+ .setup = xr_setup,
+ .handles_groups = true,
+};