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/message.h"
24 #include "libpspp/start-date.h"
25 #include "libpspp/str.h"
26 #include "libpspp/string-map.h"
27 #include "libpspp/version.h"
28 #include "data/file-handle-def.h"
29 #include "output/cairo-chart.h"
30 #include "output/chart-item-provider.h"
31 #include "output/charts/boxplot.h"
32 #include "output/charts/np-plot.h"
33 #include "output/charts/piechart.h"
34 #include "output/charts/barchart.h"
35 #include "output/charts/plot-hist.h"
36 #include "output/charts/roc-chart.h"
37 #include "output/charts/spreadlevel-plot.h"
38 #include "output/charts/scree.h"
39 #include "output/charts/scatterplot.h"
40 #include "output/driver-provider.h"
41 #include "output/message-item.h"
42 #include "output/options.h"
43 #include "output/render.h"
44 #include "output/tab.h"
45 #include "output/table-item.h"
46 #include "output/table.h"
47 #include "output/text-item.h"
49 #include <cairo/cairo-pdf.h>
50 #include <cairo/cairo-ps.h>
51 #include <cairo/cairo-svg.h>
52 #include <cairo/cairo.h>
54 #include <pango/pango-font.h>
55 #include <pango/pango-layout.h>
56 #include <pango/pango.h>
57 #include <pango/pangocairo.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 #define XR_POINT PANGO_SCALE
74 /* Conversions to and from points. */
78 return x / (double) XR_POINT;
99 /* A font for use with Cairo. */
102 PangoFontDescription *desc;
106 /* An output item whose rendering is in progress. */
109 /* Renders as much of itself as it can on the current page. Returns true
110 if rendering is complete, false if the output item needs another
112 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
114 /* Destroys the output item. */
115 void (*destroy) (struct xr_render_fsm *);
118 /* Cairo output driver. */
121 struct output_driver driver;
123 /* User parameters. */
124 struct xr_font fonts[XR_N_FONTS];
126 int width; /* Page width minus margins. */
127 int length; /* Page length minus margins and header. */
129 int left_margin; /* Left margin in inch/(72 * XR_POINT). */
130 int right_margin; /* Right margin in inch/(72 * XR_POINT). */
131 int top_margin; /* Top margin in inch/(72 * XR_POINT). */
132 int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */
134 int line_gutter; /* Space around lines. */
135 int line_space; /* Space between lines. */
136 int line_width; /* Width of lines. */
140 int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
142 struct xr_color bg; /* Background color */
143 struct xr_color fg; /* Foreground color */
145 /* Internal state. */
146 struct render_params *params;
147 int char_width, char_height;
152 int page_number; /* Current page number. */
154 struct xr_render_fsm *fsm;
158 static const struct output_driver_class cairo_driver_class;
160 static void xr_driver_destroy_fsm (struct xr_driver *);
161 static void xr_driver_run_fsm (struct xr_driver *);
163 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
164 enum render_line_style styles[TABLE_N_AXES][2]);
165 static void xr_measure_cell_width (void *, const struct table_cell *,
166 int footnote_idx, int *min, int *max);
167 static int xr_measure_cell_height (void *, const struct table_cell *,
168 int footnote_idx, int width);
169 static void xr_draw_cell (void *, const struct table_cell *, int footnote_idx,
170 int bb[TABLE_N_AXES][2],
171 int clip[TABLE_N_AXES][2]);
172 static int xr_adjust_break (void *, const struct table_cell *, int footnote_idx,
173 int width, int height);
175 static struct xr_render_fsm *xr_render_output_item (
176 struct xr_driver *, const struct output_item *);
178 /* Output driver basics. */
180 static struct xr_driver *
181 xr_driver_cast (struct output_driver *driver)
183 assert (driver->class == &cairo_driver_class);
184 return UP_CAST (driver, struct xr_driver, driver);
187 static struct driver_option *
188 opt (struct output_driver *d, struct string_map *options, const char *key,
189 const char *default_value)
191 return driver_option_get (d, options, key, default_value);
194 /* Parse color information specified by KEY into {RED,GREEN,BLUE}.
195 Currently, the input string must be of the form "#RRRRGGGGBBBB"
196 Future implementations might allow things like "yellow" and
197 "sky-blue-ultra-brown"
200 parse_color (struct output_driver *d, struct string_map *options,
201 const char *key, const char *default_value,
202 struct xr_color *color)
204 int red, green, blue;
205 char *string = parse_string (opt (d, options, key, default_value));
207 if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue))
209 /* If the parsed option string fails, then try the default value */
210 if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue))
212 /* ... and if that fails set everything to zero */
213 red = green = blue = 0;
219 /* Convert 16 bit ints to float */
220 color->red = red / (double) 0xFFFF;
221 color->green = green / (double) 0xFFFF;
222 color->blue = blue / (double) 0xFFFF;
225 static PangoFontDescription *
226 parse_font (struct output_driver *d, struct string_map *options,
227 const char *key, const char *default_value,
230 PangoFontDescription *desc;
233 /* Parse KEY as a font description. */
234 string = parse_string (opt (d, options, key, default_value));
235 desc = pango_font_description_from_string (string);
238 msg (MW, _("`%s': bad font specification"), string);
240 /* Fall back to DEFAULT_VALUE, which had better be a valid font
242 desc = pango_font_description_from_string (default_value);
243 assert (desc != NULL);
247 /* If the font description didn't include an explicit font size, then set it
248 to DEFAULT_SIZE, which is in inch/72000 units. */
249 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
250 pango_font_description_set_size (desc,
251 (default_size / 1000.0) * PANGO_SCALE);
258 apply_options (struct xr_driver *xr, struct string_map *o)
260 struct output_driver *d = &xr->driver;
262 /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */
263 int left_margin, right_margin;
264 int top_margin, bottom_margin;
265 int paper_width, paper_length;
267 int min_break[TABLE_N_AXES];
269 /* Scale factor from inch/72000 to inch/(72 * XR_POINT). */
270 const double scale = XR_POINT / 1000.;
274 for (i = 0; i < XR_N_FONTS; i++)
276 struct xr_font *font = &xr->fonts[i];
278 if (font->desc != NULL)
279 pango_font_description_free (font->desc);
282 font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
283 xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
285 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
287 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
288 "serif italic", font_size);
289 xr->fonts[XR_FONT_MARKER].desc = parse_font (d, o, "marker-font", "serif",
290 font_size * PANGO_SCALE_X_SMALL);
292 xr->line_gutter = XR_POINT / 2;
293 xr->line_space = XR_POINT;
294 xr->line_width = XR_POINT / 2;
297 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg);
298 parse_color (d, o, "foreground-color", "#000000000000", &xr->fg);
300 /* Get dimensions. */
301 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
302 left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
303 right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
304 top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
305 bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
307 min_break[H] = parse_dimension (opt (d, o, "min-hbreak", NULL)) * scale;
308 min_break[V] = parse_dimension (opt (d, o, "min-vbreak", NULL)) * scale;
310 /* Convert to inch/(XR_POINT * 72). */
311 xr->left_margin = left_margin * scale;
312 xr->right_margin = right_margin * scale;
313 xr->top_margin = top_margin * scale;
314 xr->bottom_margin = bottom_margin * scale;
315 xr->width = (paper_width - left_margin - right_margin) * scale;
316 xr->length = (paper_length - top_margin - bottom_margin) * scale;
317 xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2;
318 xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2;
321 static struct xr_driver *
322 xr_allocate (const char *name, int device_type, struct string_map *o)
324 struct xr_driver *xr = xzalloc (sizeof *xr);
325 struct output_driver *d = &xr->driver;
327 output_driver_init (d, &cairo_driver_class, name, device_type);
329 apply_options (xr, o);
335 pango_to_xr (int pango)
337 return (XR_POINT != PANGO_SCALE
338 ? ceil (pango * (1. * XR_POINT / PANGO_SCALE))
345 return (XR_POINT != PANGO_SCALE
346 ? ceil (xr * (1. / XR_POINT * PANGO_SCALE))
351 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
357 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
361 for (i = 0; i < XR_N_FONTS; i++)
363 struct xr_font *font = &xr->fonts[i];
364 int char_width, char_height;
366 font->layout = pango_cairo_create_layout (cairo);
367 pango_layout_set_font_description (font->layout, font->desc);
369 pango_layout_set_text (font->layout, "0", 1);
370 pango_layout_get_size (font->layout, &char_width, &char_height);
371 xr->char_width = MAX (xr->char_width, pango_to_xr (char_width));
372 xr->char_height = MAX (xr->char_height, pango_to_xr (char_height));
374 xr->cell_margin = xr->char_width;
376 if (xr->params == NULL)
378 int single_width, double_width;
380 xr->params = xmalloc (sizeof *xr->params);
381 xr->params->draw_line = xr_draw_line;
382 xr->params->measure_cell_width = xr_measure_cell_width;
383 xr->params->measure_cell_height = xr_measure_cell_height;
384 xr->params->adjust_break = xr_adjust_break;
385 xr->params->draw_cell = xr_draw_cell;
386 xr->params->aux = xr;
387 xr->params->size[H] = xr->width;
388 xr->params->size[V] = xr->length;
389 xr->params->font_size[H] = xr->char_width;
390 xr->params->font_size[V] = xr->char_height;
392 single_width = 2 * xr->line_gutter + xr->line_width;
393 double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
394 for (i = 0; i < TABLE_N_AXES; i++)
396 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
397 xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
398 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
401 for (i = 0; i < TABLE_N_AXES; i++)
402 xr->params->min_break[i] = xr->min_break[i];
403 xr->params->supports_margins = true;
406 cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue);
411 static struct output_driver *
412 xr_create (const char *file_name, enum settings_output_devices device_type,
413 struct string_map *o, enum xr_output_type file_type)
415 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
416 struct xr_driver *xr;
417 cairo_surface_t *surface;
418 cairo_status_t status;
419 double width_pt, length_pt;
421 xr = xr_allocate (file_name, device_type, o);
423 width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
424 length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
425 if (file_type == XR_PDF)
426 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
427 else if (file_type == XR_PS)
428 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
429 else if (file_type == XR_SVG)
430 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
434 status = cairo_surface_status (surface);
435 if (status != CAIRO_STATUS_SUCCESS)
437 msg (ME, _("error opening output file `%s': %s"),
438 file_name, cairo_status_to_string (status));
439 cairo_surface_destroy (surface);
443 xr->cairo = cairo_create (surface);
444 cairo_surface_destroy (surface);
446 if (!xr_set_cairo (xr, xr->cairo))
449 cairo_save (xr->cairo);
450 xr_driver_next_page (xr, xr->cairo);
452 if (xr->width / xr->char_width < MIN_WIDTH)
454 msg (ME, _("The defined page is not wide enough to hold at least %d "
455 "characters in the default font. In fact, there's only "
456 "room for %d characters."),
458 xr->width / xr->char_width);
462 if (xr->length / xr->char_height < MIN_LENGTH)
464 msg (ME, _("The defined page is not long enough to hold at least %d "
465 "lines in the default font. In fact, there's only "
466 "room for %d lines."),
468 xr->length / xr->char_height);
475 output_driver_destroy (&xr->driver);
479 static struct output_driver *
480 xr_pdf_create (struct file_handle *fh, enum settings_output_devices device_type,
481 struct string_map *o)
483 struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_PDF);
488 static struct output_driver *
489 xr_ps_create (struct file_handle *fh, enum settings_output_devices device_type,
490 struct string_map *o)
492 struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_PS);
497 static struct output_driver *
498 xr_svg_create (struct file_handle *fh, enum settings_output_devices device_type,
499 struct string_map *o)
501 struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_SVG);
507 xr_destroy (struct output_driver *driver)
509 struct xr_driver *xr = xr_driver_cast (driver);
512 xr_driver_destroy_fsm (xr);
514 if (xr->cairo != NULL)
516 cairo_status_t status;
518 cairo_surface_finish (cairo_get_target (xr->cairo));
519 status = cairo_status (xr->cairo);
520 if (status != CAIRO_STATUS_SUCCESS)
521 msg (ME, _("error drawing output for %s driver: %s"),
522 output_driver_get_name (driver),
523 cairo_status_to_string (status));
524 cairo_destroy (xr->cairo);
527 free (xr->command_name);
528 for (i = 0; i < XR_N_FONTS; i++)
530 struct xr_font *font = &xr->fonts[i];
532 if (font->desc != NULL)
533 pango_font_description_free (font->desc);
534 if (font->layout != NULL)
535 g_object_unref (font->layout);
543 xr_flush (struct output_driver *driver)
545 struct xr_driver *xr = xr_driver_cast (driver);
547 cairo_surface_flush (cairo_get_target (xr->cairo));
551 xr_submit (struct output_driver *driver, const struct output_item *output_item)
553 struct xr_driver *xr = xr_driver_cast (driver);
555 output_driver_track_current_command (output_item, &xr->command_name);
557 xr_driver_output_item (xr, output_item);
558 while (xr_driver_need_new_page (xr))
560 cairo_restore (xr->cairo);
561 cairo_show_page (xr->cairo);
562 cairo_save (xr->cairo);
563 xr_driver_next_page (xr, xr->cairo);
567 /* Functions for rendering a series of output items to a series of Cairo
568 contexts, with pagination.
570 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
571 its underlying implementation.
573 See the big comment in cairo.h for intended usage. */
575 /* Gives new page CAIRO to XR for output. */
577 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
580 cairo_set_source_rgb (cairo, xr->bg.red, xr->bg.green, xr->bg.blue);
581 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
583 cairo_restore (cairo);
585 cairo_translate (cairo,
586 xr_to_pt (xr->left_margin),
587 xr_to_pt (xr->top_margin));
592 xr_driver_run_fsm (xr);
595 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
596 rendering a previous output item, that is, only if xr_driver_need_new_page()
599 xr_driver_output_item (struct xr_driver *xr,
600 const struct output_item *output_item)
602 assert (xr->fsm == NULL);
603 xr->fsm = xr_render_output_item (xr, output_item);
604 xr_driver_run_fsm (xr);
607 /* Returns true if XR is in the middle of rendering an output item and needs a
608 new page to be appended using xr_driver_next_page() to make progress,
611 xr_driver_need_new_page (const struct xr_driver *xr)
613 return xr->fsm != NULL;
616 /* Returns true if the current page doesn't have any content yet. */
618 xr_driver_is_page_blank (const struct xr_driver *xr)
624 xr_driver_destroy_fsm (struct xr_driver *xr)
628 xr->fsm->destroy (xr->fsm);
634 xr_driver_run_fsm (struct xr_driver *xr)
636 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
637 xr_driver_destroy_fsm (xr);
641 xr_layout_cell (struct xr_driver *, const struct table_cell *, int footnote_idx,
642 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
643 int *width, int *height, int *brk);
646 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
648 cairo_new_path (xr->cairo);
649 cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y));
650 cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y));
651 cairo_stroke (xr->cairo);
655 dump_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1)
657 cairo_new_path (xr->cairo);
658 cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y));
659 cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y0 + xr->y));
660 cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y));
661 cairo_line_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y1 + xr->y));
662 cairo_close_path (xr->cairo);
663 cairo_stroke (xr->cairo);
666 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
667 shortening it to X0...X1 if SHORTEN is true.
668 Draws a horizontal line X1...X3 at Y if RIGHT says so,
669 shortening it to X2...X3 if SHORTEN is true. */
671 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
672 enum render_line_style left, enum render_line_style right,
675 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
676 dump_line (xr, x0, y, x3, y);
679 if (left != RENDER_LINE_NONE)
680 dump_line (xr, x0, y, shorten ? x1 : x2, y);
681 if (right != RENDER_LINE_NONE)
682 dump_line (xr, shorten ? x2 : x1, y, x3, y);
686 /* Draws a vertical line Y0...Y2 at X if TOP says so,
687 shortening it to Y0...Y1 if SHORTEN is true.
688 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
689 shortening it to Y2...Y3 if SHORTEN is true. */
691 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
692 enum render_line_style top, enum render_line_style bottom,
695 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
696 dump_line (xr, x, y0, x, y3);
699 if (top != RENDER_LINE_NONE)
700 dump_line (xr, x, y0, x, shorten ? y1 : y2);
701 if (bottom != RENDER_LINE_NONE)
702 dump_line (xr, x, shorten ? y2 : y1, x, y3);
707 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
708 enum render_line_style styles[TABLE_N_AXES][2])
710 const int x0 = bb[H][0];
711 const int y0 = bb[V][0];
712 const int x3 = bb[H][1];
713 const int y3 = bb[V][1];
714 const int top = styles[H][0];
715 const int bottom = styles[H][1];
716 const int start_of_line = render_direction_rtl() ? styles[V][1]: styles[V][0];
717 const int end_of_line = render_direction_rtl() ? styles[V][0]: styles[V][1];
719 /* The algorithm here is somewhat subtle, to allow it to handle
720 all the kinds of intersections that we need.
722 Three additional ordinates are assigned along the x axis. The
723 first is xc, midway between x0 and x3. The others are x1 and
724 x2; for a single vertical line these are equal to xc, and for
725 a double vertical line they are the ordinates of the left and
726 right half of the double line.
728 yc, y1, and y2 are assigned similarly along the y axis.
730 The following diagram shows the coordinate system and output
731 for double top and bottom lines, single left line, and no
735 y0 ________________________
741 y1 = y2 = yc |######### # |
746 y3 |________#_____#_______|
748 struct xr_driver *xr = xr_;
750 /* Offset from center of each line in a pair of double lines. */
751 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
753 /* Are the lines along each axis single or double?
754 (It doesn't make sense to have different kinds of line on the
755 same axis, so we don't try to gracefully handle that case.) */
756 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
757 bool double_horz = start_of_line == RENDER_LINE_DOUBLE || end_of_line == RENDER_LINE_DOUBLE;
759 /* When horizontal lines are doubled,
760 the left-side line along y1 normally runs from x0 to x2,
761 and the right-side line along y1 from x3 to x1.
762 If the top-side line is also doubled, we shorten the y1 lines,
763 so that the left-side line runs only to x1,
764 and the right-side line only to x2.
765 Otherwise, the horizontal line at y = y1 below would cut off
766 the intersection, which looks ugly:
768 y0 ________________________
773 y1 |######### ########|
776 y2 |######################|
779 y3 |______________________|
780 It is more of a judgment call when the horizontal line is
781 single. We actually choose to cut off the line anyhow, as
782 shown in the first diagram above.
784 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
785 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
786 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
787 int horz_line_ofs = double_vert ? double_line_ofs : 0;
788 int xc = (x0 + x3) / 2;
789 int x1 = xc - horz_line_ofs;
790 int x2 = xc + horz_line_ofs;
792 bool shorten_x1_lines = start_of_line == RENDER_LINE_DOUBLE;
793 bool shorten_x2_lines = end_of_line == RENDER_LINE_DOUBLE;
794 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
795 int vert_line_ofs = double_horz ? double_line_ofs : 0;
796 int yc = (y0 + y3) / 2;
797 int y1 = yc - vert_line_ofs;
798 int y2 = yc + vert_line_ofs;
801 horz_line (xr, x0, x1, x2, x3, yc, start_of_line, end_of_line, shorten_yc_line);
804 horz_line (xr, x0, x1, x2, x3, y1, start_of_line, end_of_line, shorten_y1_lines);
805 horz_line (xr, x0, x1, x2, x3, y2, start_of_line, end_of_line, shorten_y2_lines);
809 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
812 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
813 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
818 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
819 int footnote_idx, int *min_width, int *max_width)
821 struct xr_driver *xr = xr_;
822 int bb[TABLE_N_AXES][2];
823 int clip[TABLE_N_AXES][2];
830 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
831 xr_layout_cell (xr, cell, footnote_idx, bb, clip, max_width, &h, NULL);
834 xr_layout_cell (xr, cell, footnote_idx, bb, clip, min_width, &h, NULL);
837 *min_width += xr->cell_margin * 2;
839 *max_width += xr->cell_margin * 2;
843 xr_measure_cell_height (void *xr_, const struct table_cell *cell,
844 int footnote_idx, int width)
846 struct xr_driver *xr = xr_;
847 int bb[TABLE_N_AXES][2];
848 int clip[TABLE_N_AXES][2];
852 bb[H][1] = width - xr->cell_margin * 2;
855 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
856 xr_layout_cell (xr, cell, footnote_idx, bb, clip, &w, &h, NULL);
861 xr_draw_cell (void *xr_, const struct table_cell *cell, int footnote_idx,
862 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
864 struct xr_driver *xr = xr_;
867 bb[H][0] += xr->cell_margin;
868 bb[H][1] -= xr->cell_margin;
869 if (bb[H][0] >= bb[H][1])
871 xr_layout_cell (xr, cell, footnote_idx, bb, clip, &w, &h, &brk);
875 xr_adjust_break (void *xr_, const struct table_cell *cell, int footnote_idx,
876 int width, int height)
878 struct xr_driver *xr = xr_;
879 int bb[TABLE_N_AXES][2];
880 int clip[TABLE_N_AXES][2];
883 if (xr_measure_cell_height (xr_, cell, footnote_idx, width) < height)
887 bb[H][1] = width - 2 * xr->cell_margin;
892 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
893 xr_layout_cell (xr, cell, footnote_idx, bb, clip, &w, &h, &brk);
898 xr_clip (struct xr_driver *xr, int clip[TABLE_N_AXES][2])
900 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
902 double x0 = xr_to_pt (clip[H][0] + xr->x);
903 double y0 = xr_to_pt (clip[V][0] + xr->y);
904 double x1 = xr_to_pt (clip[H][1] + xr->x);
905 double y1 = xr_to_pt (clip[V][1] + xr->y);
907 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
908 cairo_clip (xr->cairo);
913 add_attr_with_start (PangoAttrList *list, PangoAttribute *attr, guint start_index)
915 attr->start_index = start_index;
916 pango_attr_list_insert (list, attr);
920 xr_layout_cell_text (struct xr_driver *xr,
921 const struct cell_contents *contents, int footnote_idx,
922 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
923 int *widthp, int *brk)
925 unsigned int options = contents->options;
926 struct xr_font *font;
927 bool merge_footnotes;
931 if (contents->n_footnotes == 0)
932 merge_footnotes = false;
933 else if (contents->n_footnotes == 1 && (options & TAB_ALIGNMENT) == TAB_RIGHT)
935 PangoAttrList *attrs;
938 font = &xr->fonts[XR_FONT_MARKER];
940 str_format_26adic (footnote_idx + 1, false, marker, sizeof marker);
941 pango_layout_set_text (font->layout, marker, strlen (marker));
943 attrs = pango_attr_list_new ();
944 pango_attr_list_insert (attrs, pango_attr_rise_new (7000));
945 pango_layout_set_attributes (font->layout, attrs);
946 pango_attr_list_unref (attrs);
948 pango_layout_get_size (font->layout, &w, &h);
949 merge_footnotes = w > xr->cell_margin;
950 if (!merge_footnotes && clip[H][0] != clip[H][1])
952 cairo_save (xr->cairo);
954 cairo_translate (xr->cairo,
955 xr_to_pt (bb[H][1] + xr->x),
956 xr_to_pt (bb[V][0] + xr->y));
957 pango_layout_set_alignment (font->layout, PANGO_ALIGN_LEFT);
958 pango_layout_set_width (font->layout, -1);
959 pango_cairo_show_layout (xr->cairo, font->layout);
960 cairo_restore (xr->cairo);
963 pango_layout_set_attributes (font->layout, NULL);
966 merge_footnotes = true;
968 font = (options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
969 : options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
970 : &xr->fonts[XR_FONT_PROPORTIONAL]);
972 length = strlen (contents->text);
975 PangoAttrList *attrs;
979 bb[H][1] += xr->cell_margin;
982 ds_extend (&s, length + contents->n_footnotes * 10);
983 ds_put_cstr (&s, contents->text);
984 for (i = 0; i < contents->n_footnotes; i++)
989 ds_put_byte (&s, ',');
990 str_format_26adic (footnote_idx + i + 1, false, marker, sizeof marker);
991 ds_put_cstr (&s, marker);
993 pango_layout_set_text (font->layout, ds_cstr (&s), ds_length (&s));
996 attrs = pango_attr_list_new ();
997 add_attr_with_start (attrs, pango_attr_rise_new (7000), length);
998 add_attr_with_start (
999 attrs, pango_attr_font_desc_new (xr->fonts[XR_FONT_MARKER].desc), length);
1000 pango_layout_set_attributes (font->layout, attrs);
1001 pango_attr_list_unref (attrs);
1004 pango_layout_set_text (font->layout, contents->text, -1);
1006 pango_layout_set_alignment (
1008 ((options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
1009 : (options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
1010 : PANGO_ALIGN_CENTER));
1011 pango_layout_set_width (
1013 bb[H][1] == INT_MAX ? -1 : xr_to_pango (bb[H][1] - bb[H][0]));
1014 pango_layout_set_wrap (font->layout, PANGO_WRAP_WORD);
1016 if (clip[H][0] != clip[H][1])
1018 cairo_save (xr->cairo);
1020 cairo_translate (xr->cairo,
1021 xr_to_pt (bb[H][0] + xr->x),
1022 xr_to_pt (bb[V][0] + xr->y));
1023 pango_cairo_show_layout (xr->cairo, font->layout);
1025 /* If enabled, this draws a blue rectangle around the extents of each
1026 line of text, which can be rather useful for debugging layout
1030 PangoLayoutIter *iter;
1031 iter = pango_layout_get_iter (font->layout);
1034 PangoRectangle extents;
1036 pango_layout_iter_get_line_extents (iter, &extents, NULL);
1037 cairo_save (xr->cairo);
1038 cairo_set_source_rgb (xr->cairo, 1, 0, 0);
1040 pango_to_xr (extents.x) - xr->x,
1041 pango_to_xr (extents.y) - xr->y,
1042 pango_to_xr (extents.x + extents.width) - xr->x,
1043 pango_to_xr (extents.y + extents.height) - xr->y);
1044 cairo_restore (xr->cairo);
1046 while (pango_layout_iter_next_line (iter));
1047 pango_layout_iter_free (iter);
1050 cairo_restore (xr->cairo);
1053 pango_layout_get_size (font->layout, &w, &h);
1054 w = pango_to_xr (w);
1055 h = pango_to_xr (h);
1058 if (bb[V][0] + h >= bb[V][1])
1060 PangoLayoutIter *iter;
1061 int best UNUSED = 0;
1063 /* Choose a breakpoint between lines instead of in the middle of one. */
1064 iter = pango_layout_get_iter (font->layout);
1067 PangoRectangle extents;
1071 pango_layout_iter_get_line_extents (iter, NULL, &extents);
1072 pango_layout_iter_get_line_yrange (iter, &y0, &y1);
1073 extents.x = pango_to_xr (extents.x);
1074 extents.y = pango_to_xr (y0);
1075 extents.width = pango_to_xr (extents.width);
1076 extents.height = pango_to_xr (y1 - y0);
1077 bottom = bb[V][0] + extents.y + extents.height;
1078 if (bottom < bb[V][1])
1080 if (brk && clip[H][0] != clip[H][1])
1088 while (pango_layout_iter_next_line (iter));
1089 pango_layout_iter_free (iter);
1091 /* If enabled, draws a green line across the chosen breakpoint, which can
1092 be useful for debugging issues with breaking. */
1095 if (best && !xr->nest)
1097 cairo_save (xr->cairo);
1098 cairo_set_source_rgb (xr->cairo, 0, 1, 0);
1099 dump_line (xr, -xr->left_margin, best, xr->width + xr->right_margin, best);
1100 cairo_restore (xr->cairo);
1105 pango_layout_set_attributes (font->layout, NULL);
1106 return bb[V][0] + h;
1110 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
1112 int bb_[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
1113 int *width, int *height, int *brk)
1115 int bb[TABLE_N_AXES][2];
1123 memcpy (bb, bb_, sizeof bb);
1125 /* If enabled, draws a blue rectangle around the cell extents, which can be
1126 useful for debugging layout. */
1129 if (clip[H][0] != clip[H][1])
1131 int offset = (xr->nest) * XR_POINT;
1133 cairo_save (xr->cairo);
1134 cairo_set_source_rgb (xr->cairo, 0, 0, 1);
1136 bb[H][0] + offset, bb[V][0] + offset,
1137 bb[H][1] - offset, bb[V][1] - offset);
1138 cairo_restore (xr->cairo);
1142 for (i = 0; i < cell->n_contents && bb[V][0] < bb[V][1]; i++)
1144 const struct cell_contents *contents = &cell->contents[i];
1150 bb[V][0] += xr->char_height / 2;
1151 if (bb[V][0] >= bb[V][1])
1157 bb[V][0] = xr_layout_cell_text (xr, contents, footnote_idx, bb, clip,
1159 footnote_idx += contents->n_footnotes;
1161 *height = bb[V][0] - bb_[V][0];
1164 struct output_driver_factory pdf_driver_factory =
1165 { "pdf", "pspp.pdf", xr_pdf_create };
1166 struct output_driver_factory ps_driver_factory =
1167 { "ps", "pspp.ps", xr_ps_create };
1168 struct output_driver_factory svg_driver_factory =
1169 { "svg", "pspp.svg", xr_svg_create };
1171 static const struct output_driver_class cairo_driver_class =
1179 /* GUI rendering helpers. */
1183 struct output_item *item;
1186 struct render_pager *p;
1187 struct xr_driver *xr;
1190 #define CHART_WIDTH 500
1191 #define CHART_HEIGHT 375
1196 xr_driver_create (cairo_t *cairo, struct string_map *options)
1198 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
1199 if (!xr_set_cairo (xr, cairo))
1201 output_driver_destroy (&xr->driver);
1207 /* Destroy XR, which should have been created with xr_driver_create(). Any
1208 cairo_t added to XR is not destroyed, because it is owned by the client. */
1210 xr_driver_destroy (struct xr_driver *xr)
1215 output_driver_destroy (&xr->driver);
1219 static struct xr_rendering *
1220 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
1222 struct table_item *table_item;
1223 struct xr_rendering *r;
1225 table_item = table_item_create (table_from_string (TAB_LEFT, text),
1227 r = xr_rendering_create (xr, &table_item->output_item, cr);
1228 table_item_unref (table_item);
1234 xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
1236 if (is_table_item (xr->item))
1237 apply_options (xr->xr, o);
1240 struct xr_rendering *
1241 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
1244 struct xr_rendering *r = NULL;
1246 if (is_text_item (item))
1247 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
1249 else if (is_message_item (item))
1251 const struct message_item *message_item = to_message_item (item);
1252 const struct msg *msg = message_item_get_msg (message_item);
1253 char *s = msg_to_string (msg, NULL);
1254 r = xr_rendering_create_text (xr, s, cr);
1257 else if (is_table_item (item))
1259 r = xzalloc (sizeof *r);
1260 r->item = output_item_ref (item);
1262 xr_set_cairo (xr, cr);
1263 r->p = render_pager_create (xr->params, to_table_item (item));
1265 else if (is_chart_item (item))
1267 r = xzalloc (sizeof *r);
1268 r->item = output_item_ref (item);
1275 xr_rendering_destroy (struct xr_rendering *r)
1279 output_item_unref (r->item);
1280 render_pager_destroy (r->p);
1286 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
1288 if (is_table_item (r->item))
1290 *w = render_pager_get_size (r->p, H) / XR_POINT;
1291 *h = render_pager_get_size (r->p, V) / XR_POINT;
1300 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1301 double x, double y, double width, double height);
1305 xr_rendering_draw_all (struct xr_rendering *r, cairo_t *cr)
1307 if (is_table_item (r->item))
1309 struct xr_driver *xr = r->xr;
1311 xr_set_cairo (xr, cr);
1313 render_pager_draw (r->p);
1317 xr_draw_chart (to_chart_item (r->item), cr,
1318 0, 0, CHART_WIDTH, CHART_HEIGHT);
1322 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1323 double x, double y, double width, double height)
1325 struct xrchart_geometry geom;
1328 cairo_translate (cr, x, y + height);
1329 cairo_scale (cr, 1.0, -1.0);
1330 xrchart_geometry_init (cr, &geom, width, height);
1331 if (is_boxplot (chart_item))
1332 xrchart_draw_boxplot (chart_item, cr, &geom);
1333 else if (is_histogram_chart (chart_item))
1334 xrchart_draw_histogram (chart_item, cr, &geom);
1335 else if (is_np_plot_chart (chart_item))
1336 xrchart_draw_np_plot (chart_item, cr, &geom);
1337 else if (is_piechart (chart_item))
1338 xrchart_draw_piechart (chart_item, cr, &geom);
1339 else if (is_barchart (chart_item))
1340 xrchart_draw_barchart (chart_item, cr, &geom);
1341 else if (is_roc_chart (chart_item))
1342 xrchart_draw_roc (chart_item, cr, &geom);
1343 else if (is_scree (chart_item))
1344 xrchart_draw_scree (chart_item, cr, &geom);
1345 else if (is_spreadlevel_plot_chart (chart_item))
1346 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1347 else if (is_scatterplot_chart (chart_item))
1348 xrchart_draw_scatterplot (chart_item, cr, &geom);
1351 xrchart_geometry_free (cr, &geom);
1357 xr_draw_png_chart (const struct chart_item *item,
1358 const char *file_name_template, int number,
1359 const struct xr_color *fg,
1360 const struct xr_color *bg
1363 const int width = 640;
1364 const int length = 480;
1366 cairo_surface_t *surface;
1367 cairo_status_t status;
1368 const char *number_pos;
1372 number_pos = strchr (file_name_template, '#');
1373 if (number_pos != NULL)
1374 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1375 file_name_template, number, number_pos + 1);
1377 file_name = xstrdup (file_name_template);
1379 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1380 cr = cairo_create (surface);
1382 cairo_set_source_rgb (cr, bg->red, bg->green, bg->blue);
1385 cairo_set_source_rgb (cr, fg->red, fg->green, fg->blue);
1387 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1389 status = cairo_surface_write_to_png (surface, file_name);
1390 if (status != CAIRO_STATUS_SUCCESS)
1391 msg (ME, _("error writing output file `%s': %s"),
1392 file_name, cairo_status_to_string (status));
1395 cairo_surface_destroy (surface);
1400 struct xr_table_state
1402 struct xr_render_fsm fsm;
1403 struct table_item *table_item;
1404 struct render_pager *p;
1408 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1410 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1412 while (render_pager_has_next (ts->p))
1416 used = render_pager_draw_next (ts->p, xr->length - xr->y);
1429 xr_table_destroy (struct xr_render_fsm *fsm)
1431 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1433 table_item_unref (ts->table_item);
1434 render_pager_destroy (ts->p);
1438 static struct xr_render_fsm *
1439 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1441 struct xr_table_state *ts;
1443 ts = xmalloc (sizeof *ts);
1444 ts->fsm.render = xr_table_render;
1445 ts->fsm.destroy = xr_table_destroy;
1446 ts->table_item = table_item_ref (table_item);
1449 xr->y += xr->char_height;
1451 ts->p = render_pager_create (xr->params, table_item);
1456 struct xr_chart_state
1458 struct xr_render_fsm fsm;
1459 struct chart_item *chart_item;
1463 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1465 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1467 const int chart_height = 0.8 * (xr->length < xr->width ? xr->length : xr->width);
1469 if (xr->y > xr->length - chart_height)
1472 if (xr->cairo != NULL)
1474 xr_draw_chart (cs->chart_item, xr->cairo,
1477 xr_to_pt (xr->width),
1478 xr_to_pt (chart_height));
1480 xr->y += chart_height;
1486 xr_chart_destroy (struct xr_render_fsm *fsm)
1488 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1490 chart_item_unref (cs->chart_item);
1494 static struct xr_render_fsm *
1495 xr_render_chart (const struct chart_item *chart_item)
1497 struct xr_chart_state *cs;
1499 cs = xmalloc (sizeof *cs);
1500 cs->fsm.render = xr_chart_render;
1501 cs->fsm.destroy = xr_chart_destroy;
1502 cs->chart_item = chart_item_ref (chart_item);
1508 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1514 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1516 /* Nothing to do. */
1519 static struct xr_render_fsm *
1520 xr_render_eject (void)
1522 static struct xr_render_fsm eject_renderer =
1528 return &eject_renderer;
1531 static struct xr_render_fsm *
1532 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1534 struct table_item *table_item;
1535 struct xr_render_fsm *fsm;
1537 table_item = table_item_create (table_from_string (TAB_LEFT, text),
1539 fsm = xr_render_table (xr, table_item);
1540 table_item_unref (table_item);
1545 static struct xr_render_fsm *
1546 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1548 enum text_item_type type = text_item_get_type (text_item);
1549 const char *text = text_item_get_text (text_item);
1553 case TEXT_ITEM_TITLE:
1555 xr->title = xstrdup (text);
1558 case TEXT_ITEM_SUBTITLE:
1559 free (xr->subtitle);
1560 xr->subtitle = xstrdup (text);
1563 case TEXT_ITEM_COMMAND_CLOSE:
1566 case TEXT_ITEM_BLANK_LINE:
1568 xr->y += xr->char_height;
1571 case TEXT_ITEM_EJECT_PAGE:
1573 return xr_render_eject ();
1577 return xr_create_text_renderer (xr, text);
1583 static struct xr_render_fsm *
1584 xr_render_message (struct xr_driver *xr,
1585 const struct message_item *message_item)
1587 const struct msg *msg = message_item_get_msg (message_item);
1588 struct xr_render_fsm *fsm;
1591 s = msg_to_string (msg, xr->command_name);
1592 fsm = xr_create_text_renderer (xr, s);
1598 static struct xr_render_fsm *
1599 xr_render_output_item (struct xr_driver *xr,
1600 const struct output_item *output_item)
1602 if (is_table_item (output_item))
1603 return xr_render_table (xr, to_table_item (output_item));
1604 else if (is_chart_item (output_item))
1605 return xr_render_chart (to_chart_item (output_item));
1606 else if (is_text_item (output_item))
1607 return xr_render_text (xr, to_text_item (output_item));
1608 else if (is_message_item (output_item))
1609 return xr_render_message (xr, to_message_item (output_item));