1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #include "output/cairo.h"
21 #include "libpspp/assertion.h"
22 #include "libpspp/cast.h"
23 #include "libpspp/hash-functions.h"
24 #include "libpspp/message.h"
25 #include "libpspp/pool.h"
26 #include "libpspp/start-date.h"
27 #include "libpspp/str.h"
28 #include "libpspp/string-map.h"
29 #include "libpspp/version.h"
30 #include "data/file-handle-def.h"
31 #include "output/cairo-chart.h"
32 #include "output/cairo-fsm.h"
33 #include "output/chart-item-provider.h"
34 #include "output/driver-provider.h"
35 #include "output/group-item.h"
36 #include "output/message-item.h"
37 #include "output/options.h"
38 #include "output/page-eject-item.h"
39 #include "output/page-setup-item.h"
40 #include "output/render.h"
41 #include "output/table-item.h"
42 #include "output/table.h"
43 #include "output/text-item.h"
45 #include <cairo/cairo-pdf.h>
46 #include <cairo/cairo-ps.h>
47 #include <cairo/cairo-svg.h>
49 #include <cairo/cairo.h>
52 #include <pango/pango-font.h>
53 #include <pango/pango-layout.h>
54 #include <pango/pango.h>
55 #include <pango/pangocairo.h>
58 #include "gl/c-ctype.h"
59 #include "gl/c-strcase.h"
60 #include "gl/intprops.h"
61 #include "gl/minmax.h"
62 #include "gl/xalloc.h"
65 #define _(msgid) gettext (msgid)
67 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
71 /* The unit used for internal measurements is inch/(72 * XR_POINT).
72 (Thus, XR_POINT units represent one point.) */
73 #define XR_POINT PANGO_SCALE
75 /* Conversions to and from points. */
79 return x / (double) XR_POINT;
82 /* Dimensions for drawing lines in tables. */
83 #define XR_LINE_WIDTH (XR_POINT / 2) /* Width of an ordinary line. */
84 #define XR_LINE_SPACE XR_POINT /* Space between double lines. */
94 /* Cairo output driver. */
97 struct output_driver driver;
99 /* User parameters. */
100 PangoFontDescription *fonts[XR_N_FONTS];
102 int width; /* Page width minus margins. */
103 int length; /* Page length minus margins and header. */
105 int left_margin; /* Left margin in inch/(72 * XR_POINT). */
106 int right_margin; /* Right margin in inch/(72 * XR_POINT). */
107 int top_margin; /* Top margin in inch/(72 * XR_POINT). */
108 int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */
110 int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
111 int object_spacing; /* Space between output objects. */
113 struct cell_color bg; /* Background color */
114 struct cell_color fg; /* Foreground color */
115 bool transparent; /* true -> do not render background */
116 bool systemcolors; /* true -> do not change colors */
118 int initial_page_number;
120 struct page_heading headings[2]; /* Top and bottom headings. */
121 int headings_height[2];
123 /* Internal state. */
124 struct xr_fsm_style *style;
126 int char_width, char_height;
128 cairo_surface_t *surface;
129 int page_number; /* Current page number. */
134 static const struct output_driver_class cairo_driver_class;
136 static void xr_driver_destroy_fsm (struct xr_driver *);
137 static void xr_driver_run_fsm (struct xr_driver *);
139 /* Output driver basics. */
141 static struct xr_driver *
142 xr_driver_cast (struct output_driver *driver)
144 assert (driver->class == &cairo_driver_class);
145 return UP_CAST (driver, struct xr_driver, driver);
148 static struct driver_option *
149 opt (struct output_driver *d, struct string_map *options, const char *key,
150 const char *default_value)
152 return driver_option_get (d, options, key, default_value);
155 static PangoFontDescription *
156 parse_font (const char *font, int default_size, bool bold, bool italic)
158 if (!c_strcasecmp (font, "Monospaced"))
161 PangoFontDescription *desc = pango_font_description_from_string (font);
165 /* If the font description didn't include an explicit font size, then set it
166 to DEFAULT_SIZE, which is in inch/72000 units. */
167 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
168 pango_font_description_set_size (desc,
169 (default_size / 1000.0) * PANGO_SCALE);
171 pango_font_description_set_weight (desc, (bold
173 : PANGO_WEIGHT_NORMAL));
174 pango_font_description_set_style (desc, (italic
176 : PANGO_STYLE_NORMAL));
181 static PangoFontDescription *
182 parse_font_option (struct output_driver *d, struct string_map *options,
183 const char *key, const char *default_value,
184 int default_size, bool bold, bool italic)
186 char *string = parse_string (opt (d, options, key, default_value));
187 PangoFontDescription *desc = parse_font (string, default_size, bold, italic);
190 msg (MW, _("`%s': bad font specification"), string);
192 /* Fall back to DEFAULT_VALUE, which had better be a valid font
194 desc = parse_font (default_value, default_size, bold, italic);
195 assert (desc != NULL);
203 apply_options (struct xr_driver *xr, struct string_map *o)
205 struct output_driver *d = &xr->driver;
207 /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */
208 int left_margin, right_margin;
209 int top_margin, bottom_margin;
210 int paper_width, paper_length;
212 int min_break[TABLE_N_AXES];
214 /* Scale factor from inch/72000 to inch/(72 * XR_POINT). */
215 const double scale = XR_POINT / 1000.;
219 for (i = 0; i < XR_N_FONTS; i++)
220 if (xr->fonts[i] != NULL)
221 pango_font_description_free (xr->fonts[i]);
223 font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
224 xr->fonts[XR_FONT_FIXED] = parse_font_option
225 (d, o, "fixed-font", "monospace", font_size, false, false);
226 xr->fonts[XR_FONT_PROPORTIONAL] = parse_font_option (
227 d, o, "prop-font", "sans serif", font_size, false, false);
229 xr->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
230 xr->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
232 xr->transparent = parse_boolean (opt (d, o, "transparent", "false"));
233 xr->systemcolors = parse_boolean (opt (d, o, "systemcolors", "false"));
235 /* Get dimensions. */
236 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
237 left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
238 right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
239 top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
240 bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
242 min_break[H] = parse_dimension (opt (d, o, "min-hbreak", NULL)) * scale;
243 min_break[V] = parse_dimension (opt (d, o, "min-vbreak", NULL)) * scale;
245 int object_spacing = (parse_dimension (opt (d, o, "object-spacing", NULL))
248 /* Convert to inch/(XR_POINT * 72). */
249 xr->left_margin = left_margin * scale;
250 xr->right_margin = right_margin * scale;
251 xr->top_margin = top_margin * scale;
252 xr->bottom_margin = bottom_margin * scale;
253 xr->width = (paper_width - left_margin - right_margin) * scale;
254 xr->length = (paper_length - top_margin - bottom_margin) * scale;
255 xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2;
256 xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2;
257 xr->object_spacing = object_spacing >= 0 ? object_spacing : XR_POINT * 12;
259 /* There are no headings so headings_height can stay 0. */
262 static struct xr_driver *
263 xr_allocate (const char *name, int device_type, struct string_map *o,
266 struct xr_driver *xr = xzalloc (sizeof *xr);
267 struct output_driver *d = &xr->driver;
269 output_driver_init (d, &cairo_driver_class, name, device_type);
271 /* This is a nasty kluge for an issue that does not make sense. On any
272 surface other than a screen (e.g. for output to PDF or PS or SVG), the
273 fonts are way too big by default. A "9-point" font seems to appear about
274 16 points tall. We use a scale factor for these surfaces to help, but the
275 underlying issue is a mystery. */
276 xr->font_scale = font_scale;
278 apply_options (xr, o);
284 pango_to_xr (int pango)
286 return (XR_POINT != PANGO_SCALE
287 ? ceil (pango * (1. * XR_POINT / PANGO_SCALE))
294 return (XR_POINT != PANGO_SCALE
295 ? ceil (xr * (1. / XR_POINT * PANGO_SCALE))
300 xr_measure_fonts (cairo_t *cairo, PangoFontDescription *fonts[XR_N_FONTS],
301 int *char_width, int *char_height)
305 for (int i = 0; i < XR_N_FONTS; i++)
307 PangoLayout *layout = pango_cairo_create_layout (cairo);
308 pango_layout_set_font_description (layout, fonts[i]);
310 pango_layout_set_text (layout, "0", 1);
313 pango_layout_get_size (layout, &cw, &ch);
314 *char_width = MAX (*char_width, pango_to_xr (cw));
315 *char_height = MAX (*char_height, pango_to_xr (ch));
317 g_object_unref (G_OBJECT (layout));
322 get_layout_height (PangoLayout *layout)
325 pango_layout_get_size (layout, &w, &h);
330 xr_render_page_heading (cairo_t *cairo, const PangoFontDescription *font,
331 const struct page_heading *ph, int page_number,
332 int width, bool draw, int base_y)
334 PangoLayout *layout = pango_cairo_create_layout (cairo);
335 pango_layout_set_font_description (layout, font);
338 for (size_t i = 0; i < ph->n; i++)
340 const struct page_paragraph *pp = &ph->paragraphs[i];
342 char *markup = output_driver_substitute_heading_vars (pp->markup,
344 pango_layout_set_markup (layout, markup, -1);
347 pango_layout_set_alignment (
349 (pp->halign == TABLE_HALIGN_LEFT ? PANGO_ALIGN_LEFT
350 : pp->halign == TABLE_HALIGN_CENTER ? PANGO_ALIGN_CENTER
351 : pp->halign == TABLE_HALIGN_MIXED ? PANGO_ALIGN_LEFT
352 : PANGO_ALIGN_RIGHT));
353 pango_layout_set_width (layout, xr_to_pango (width));
357 cairo_translate (cairo, 0, xr_to_pt (y + base_y));
358 pango_cairo_show_layout (cairo, layout);
359 cairo_restore (cairo);
362 y += pango_to_xr (get_layout_height (layout));
365 g_object_unref (G_OBJECT (layout));
371 xr_measure_headings (cairo_surface_t *surface,
372 const PangoFontDescription *font,
373 const struct page_heading headings[2],
374 int width, int object_spacing, int height[2])
376 cairo_t *cairo = cairo_create (surface);
378 for (int i = 0; i < 2; i++)
380 int h = xr_render_page_heading (cairo, font, &headings[i], -1,
383 /* If the top heading is nonempty, add some space below it. */
391 cairo_destroy (cairo);
396 xr_check_fonts (cairo_surface_t *surface,
397 PangoFontDescription *fonts[XR_N_FONTS],
398 int usable_width, int usable_length)
400 cairo_t *cairo = cairo_create (surface);
401 int char_width, char_height;
402 xr_measure_fonts (cairo, fonts, &char_width, &char_height);
403 cairo_destroy (cairo);
406 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
407 if (usable_width / char_width < MIN_WIDTH)
409 msg (ME, _("The defined page is not wide enough to hold at least %d "
410 "characters in the default font. In fact, there's only "
411 "room for %d characters."),
412 MIN_WIDTH, usable_width / char_width);
415 if (usable_length / char_height < MIN_LENGTH)
417 msg (ME, _("The defined page is not long enough to hold at least %d "
418 "lines in the default font. In fact, there's only "
419 "room for %d lines."),
420 MIN_LENGTH, usable_length / char_height);
427 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
431 cairo_set_line_width (xr->cairo, xr_to_pt (XR_LINE_WIDTH));
433 xr_measure_fonts (xr->cairo, xr->fonts, &xr->char_width, &xr->char_height);
435 if (xr->style == NULL)
437 xr->style = xmalloc (sizeof *xr->style);
438 *xr->style = (struct xr_fsm_style) {
440 .size = { [H] = xr->width, [V] = xr->length },
441 .min_break = { [H] = xr->min_break[H], [V] = xr->min_break[V] },
442 .use_system_colors = xr->systemcolors,
443 .transparent = xr->transparent,
444 .font_scale = xr->font_scale,
447 for (size_t i = 0; i < XR_N_FONTS; i++)
448 xr->style->fonts[i] = pango_font_description_copy (xr->fonts[i]);
451 if (!xr->systemcolors)
452 cairo_set_source_rgb (xr->cairo,
453 xr->fg.r / 255.0, xr->fg.g / 255.0, xr->fg.b / 255.0);
456 static struct output_driver *
457 xr_create (struct file_handle *fh, enum settings_output_devices device_type,
458 struct string_map *o, enum xr_output_type file_type)
460 const char *file_name = fh_get_file_name (fh);
461 struct xr_driver *xr = xr_allocate (file_name, device_type, o, 72.0 / 128.0);
462 double width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
463 double length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
464 if (file_type == XR_PDF)
465 xr->surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
466 else if (file_type == XR_PS)
467 xr->surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
468 else if (file_type == XR_SVG)
469 xr->surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
473 cairo_status_t status = cairo_surface_status (xr->surface);
474 if (status != CAIRO_STATUS_SUCCESS)
476 msg (ME, _("error opening output file `%s': %s"),
477 file_name, cairo_status_to_string (status));
481 if (!xr_check_fonts (xr->surface, xr->fonts, xr->width, xr->length))
489 output_driver_destroy (&xr->driver);
493 static struct output_driver *
494 xr_pdf_create (struct file_handle *fh, enum settings_output_devices device_type,
495 struct string_map *o)
497 return xr_create (fh, device_type, o, XR_PDF);
500 static struct output_driver *
501 xr_ps_create (struct file_handle *fh, enum settings_output_devices device_type,
502 struct string_map *o)
504 return xr_create (fh, device_type, o, XR_PS);
507 static struct output_driver *
508 xr_svg_create (struct file_handle *fh, enum settings_output_devices device_type,
509 struct string_map *o)
511 return xr_create (fh, device_type, o, XR_SVG);
515 xr_destroy (struct output_driver *driver)
517 struct xr_driver *xr = xr_driver_cast (driver);
520 xr_driver_destroy_fsm (xr);
522 if (xr->cairo != NULL)
524 cairo_surface_finish (xr->surface);
525 cairo_status_t status = cairo_status (xr->cairo);
526 if (status != CAIRO_STATUS_SUCCESS)
527 fprintf (stderr, _("error drawing output for %s driver: %s"),
528 output_driver_get_name (driver),
529 cairo_status_to_string (status));
530 cairo_surface_destroy (xr->surface);
532 cairo_destroy (xr->cairo);
535 for (i = 0; i < XR_N_FONTS; i++)
536 if (xr->fonts[i] != NULL)
537 pango_font_description_free (xr->fonts[i]);
539 xr_fsm_style_unref (xr->style);
544 xr_flush (struct output_driver *driver)
546 struct xr_driver *xr = xr_driver_cast (driver);
548 cairo_surface_flush (cairo_get_target (xr->cairo));
552 xr_update_page_setup (struct output_driver *driver,
553 const struct page_setup *ps)
555 struct xr_driver *xr = xr_driver_cast (driver);
557 xr->initial_page_number = ps->initial_page_number;
558 xr->object_spacing = ps->object_spacing * 72 * XR_POINT;
563 int usable[TABLE_N_AXES];
564 for (int i = 0; i < 2; i++)
565 usable[i] = (ps->paper[i]
566 - (ps->margins[i][0] + ps->margins[i][1])) * 72 * XR_POINT;
568 int headings_height[2];
569 usable[V] -= xr_measure_headings (
570 xr->surface, xr->fonts[XR_FONT_PROPORTIONAL], ps->headings,
571 usable[H], xr->object_spacing, headings_height);
573 enum table_axis h = ps->orientation == PAGE_LANDSCAPE;
574 enum table_axis v = !h;
575 if (!xr_check_fonts (xr->surface, xr->fonts, usable[h], usable[v]))
578 for (int i = 0; i < 2; i++)
580 page_heading_uninit (&xr->headings[i]);
581 page_heading_copy (&xr->headings[i], &ps->headings[i]);
582 xr->headings_height[i] = headings_height[i];
584 xr->width = usable[h];
585 xr->length = usable[v];
586 xr->left_margin = ps->margins[h][0] * 72 * XR_POINT;
587 xr->right_margin = ps->margins[h][1] * 72 * XR_POINT;
588 xr->top_margin = ps->margins[v][0] * 72 * XR_POINT;
589 xr->bottom_margin = ps->margins[v][1] * 72 * XR_POINT;
590 cairo_pdf_surface_set_size (xr->surface,
591 ps->paper[h] * 72.0, ps->paper[v] * 72.0);
595 xr_submit (struct output_driver *driver, const struct output_item *output_item)
597 struct xr_driver *xr = xr_driver_cast (driver);
599 if (is_page_setup_item (output_item))
601 xr_update_page_setup (driver,
602 to_page_setup_item (output_item)->page_setup);
608 xr->page_number = xr->initial_page_number - 1;
609 xr_set_cairo (xr, cairo_create (xr->surface));
610 cairo_save (xr->cairo);
611 xr_driver_next_page (xr, xr->cairo);
614 xr_driver_output_item (xr, output_item);
615 while (xr_driver_need_new_page (xr))
617 cairo_restore (xr->cairo);
618 cairo_show_page (xr->cairo);
619 cairo_save (xr->cairo);
620 xr_driver_next_page (xr, xr->cairo);
624 /* Functions for rendering a series of output items to a series of Cairo
625 contexts, with pagination.
627 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
628 its underlying implementation.
630 See the big comment in cairo.h for intended usage. */
632 /* Gives new page CAIRO to XR for output. */
634 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
636 if (!xr->transparent)
639 cairo_set_source_rgb (cairo,
640 xr->bg.r / 255.0, xr->bg.g / 255.0, xr->bg.b / 255.0);
641 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
643 cairo_restore (cairo);
645 cairo_translate (cairo,
646 xr_to_pt (xr->left_margin),
647 xr_to_pt (xr->top_margin + xr->headings_height[0]));
653 xr_render_page_heading (xr->cairo, xr->fonts[XR_FONT_PROPORTIONAL],
654 &xr->headings[0], xr->page_number, xr->width, true,
655 -xr->headings_height[0]);
656 xr_render_page_heading (xr->cairo, xr->fonts[XR_FONT_PROPORTIONAL],
657 &xr->headings[1], xr->page_number, xr->width, true,
660 xr_driver_run_fsm (xr);
663 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
664 rendering a previous output item, that is, only if xr_driver_need_new_page()
667 xr_driver_output_item (struct xr_driver *xr,
668 const struct output_item *output_item)
670 assert (xr->fsm == NULL);
671 xr->fsm = xr_fsm_create (output_item, xr->style, xr->cairo);
672 xr_driver_run_fsm (xr);
675 /* Returns true if XR is in the middle of rendering an output item and needs a
676 new page to be appended using xr_driver_next_page() to make progress,
679 xr_driver_need_new_page (const struct xr_driver *xr)
681 return xr->fsm != NULL;
684 /* Returns true if the current page doesn't have any content yet. */
686 xr_driver_is_page_blank (const struct xr_driver *xr)
692 xr_driver_destroy_fsm (struct xr_driver *xr)
694 xr_fsm_destroy (xr->fsm);
699 xr_driver_run_fsm (struct xr_driver *xr)
703 cairo_save (xr->cairo);
704 cairo_translate (xr->cairo, 0, xr_to_pt (xr->y));
705 int used = xr_fsm_draw_slice (xr->fsm, xr->cairo, xr->length - xr->y);
707 cairo_restore (xr->cairo);
709 if (xr_fsm_is_empty (xr->fsm))
710 xr_driver_destroy_fsm (xr);
714 struct output_driver_factory pdf_driver_factory =
715 { "pdf", "pspp.pdf", xr_pdf_create };
716 struct output_driver_factory ps_driver_factory =
717 { "ps", "pspp.ps", xr_ps_create };
718 struct output_driver_factory svg_driver_factory =
719 { "svg", "pspp.svg", xr_svg_create };
721 static const struct output_driver_class cairo_driver_class =
730 xr_driver_create (cairo_t *cairo, struct string_map *options)
732 struct xr_driver *xr = xr_allocate ("cairo", 0, options, 1.0);
733 xr_set_cairo (xr, cairo);
737 /* Destroy XR, which should have been created with xr_driver_create(). Any
738 cairo_t added to XR is not destroyed, because it is owned by the client. */
740 xr_driver_destroy (struct xr_driver *xr)
745 output_driver_destroy (&xr->driver);