1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 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 "output/cairo-chart.h"
29 #include "output/chart-item-provider.h"
30 #include "output/charts/boxplot.h"
31 #include "output/charts/np-plot.h"
32 #include "output/charts/piechart.h"
33 #include "output/charts/plot-hist.h"
34 #include "output/charts/roc-chart.h"
35 #include "output/charts/spreadlevel-plot.h"
36 #include "output/charts/scree.h"
37 #include "output/driver-provider.h"
38 #include "output/message-item.h"
39 #include "output/options.h"
40 #include "output/render.h"
41 #include "output/tab.h"
42 #include "output/table-item.h"
43 #include "output/table.h"
44 #include "output/text-item.h"
46 #include <cairo/cairo-pdf.h>
47 #include <cairo/cairo-ps.h>
48 #include <cairo/cairo-svg.h>
49 #include <cairo/cairo.h>
51 #include <pango/pango-font.h>
52 #include <pango/pango-layout.h>
53 #include <pango/pango.h>
54 #include <pango/pangocairo.h>
57 #include "gl/intprops.h"
58 #include "gl/minmax.h"
59 #include "gl/xalloc.h"
62 #define _(msgid) gettext (msgid)
64 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
68 /* The unit used for internal measurements is inch/(72 * XR_POINT). */
69 #define XR_POINT PANGO_SCALE
71 /* Conversions to and from points. */
75 return x / (double) XR_POINT;
95 /* A font for use with Cairo. */
98 PangoFontDescription *desc;
102 /* An output item whose rendering is in progress. */
105 /* Renders as much of itself as it can on the current page. Returns true
106 if rendering is complete, false if the output item needs another
108 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
110 /* Destroys the output item. */
111 void (*destroy) (struct xr_render_fsm *);
114 /* Cairo output driver. */
117 struct output_driver driver;
119 /* User parameters. */
120 struct xr_font fonts[XR_N_FONTS];
122 int width; /* Page width minus margins. */
123 int length; /* Page length minus margins and header. */
125 int left_margin; /* Left margin in inch/(72 * XR_POINT). */
126 int right_margin; /* Right margin in inch/(72 * XR_POINT). */
127 int top_margin; /* Top margin in inch/(72 * XR_POINT). */
128 int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */
130 int line_gutter; /* Space around lines. */
131 int line_space; /* Space between lines. */
132 int line_width; /* Width of lines. */
134 struct xr_color bg; /* Background color */
135 struct xr_color fg; /* Foreground color */
137 /* Internal state. */
138 struct render_params *params;
139 int char_width, char_height;
144 int page_number; /* Current page number. */
146 struct xr_render_fsm *fsm;
149 static const struct output_driver_class cairo_driver_class;
151 static void xr_driver_destroy_fsm (struct xr_driver *);
152 static void xr_driver_run_fsm (struct xr_driver *);
154 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
155 enum render_line_style styles[TABLE_N_AXES][2]);
156 static void xr_measure_cell_width (void *, const struct table_cell *,
158 static int xr_measure_cell_height (void *, const struct table_cell *,
160 static void xr_draw_cell (void *, const struct table_cell *,
161 int bb[TABLE_N_AXES][2],
162 int clip[TABLE_N_AXES][2]);
164 static struct xr_render_fsm *xr_render_output_item (
165 struct xr_driver *, const struct output_item *);
167 /* Output driver basics. */
169 static struct xr_driver *
170 xr_driver_cast (struct output_driver *driver)
172 assert (driver->class == &cairo_driver_class);
173 return UP_CAST (driver, struct xr_driver, driver);
176 static struct driver_option *
177 opt (struct output_driver *d, struct string_map *options, const char *key,
178 const char *default_value)
180 return driver_option_get (d, options, key, default_value);
183 /* Parse color information specified by KEY into {RED,GREEN,BLUE}.
184 Currently, the input string must be of the form "#RRRRGGGGBBBB"
185 Future implementations might allow things like "yellow" and
186 "sky-blue-ultra-brown"
189 parse_color (struct output_driver *d, struct string_map *options,
190 const char *key, const char *default_value,
191 struct xr_color *color)
193 int red, green, blue;
194 char *string = parse_string (opt (d, options, key, default_value));
196 if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue))
198 /* If the parsed option string fails, then try the default value */
199 if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue))
201 /* ... and if that fails set everything to zero */
202 red = green = blue = 0;
208 /* Convert 16 bit ints to float */
209 color->red = red / (double) 0xFFFF;
210 color->green = green / (double) 0xFFFF;
211 color->blue = blue / (double) 0xFFFF;
214 static PangoFontDescription *
215 parse_font (struct output_driver *d, struct string_map *options,
216 const char *key, const char *default_value,
219 PangoFontDescription *desc;
222 /* Parse KEY as a font description. */
223 string = parse_string (opt (d, options, key, default_value));
224 desc = pango_font_description_from_string (string);
227 msg (MW, _("`%s': bad font specification"), string);
229 /* Fall back to DEFAULT_VALUE, which had better be a valid font
231 desc = pango_font_description_from_string (default_value);
232 assert (desc != NULL);
236 /* If the font description didn't include an explicit font size, then set it
237 to DEFAULT_SIZE, which is in inch/72000 units. */
238 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
239 pango_font_description_set_size (desc,
240 (default_size / 1000.0) * PANGO_SCALE);
247 apply_options (struct xr_driver *xr, struct string_map *o)
249 struct output_driver *d = &xr->driver;
251 /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */
252 int left_margin, right_margin;
253 int top_margin, bottom_margin;
254 int paper_width, paper_length;
257 /* Scale factor from inch/72000 to inch/(72 * XR_POINT). */
258 const double scale = XR_POINT / 1000.;
262 for (i = 0; i < XR_N_FONTS; i++)
264 struct xr_font *font = &xr->fonts[i];
266 if (font->desc != NULL)
267 pango_font_description_free (font->desc);
270 font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
271 xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
273 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
275 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
276 "serif italic", font_size);
278 xr->line_gutter = parse_dimension (opt (d, o, "gutter", "3pt")) * scale;
279 xr->line_space = XR_POINT;
280 xr->line_width = XR_POINT / 2;
283 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg);
284 parse_color (d, o, "foreground-color", "#000000000000", &xr->fg);
286 /* Get dimensions. */
287 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
288 left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
289 right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
290 top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
291 bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
293 /* Convert to inch/(XR_POINT * 72). */
294 xr->left_margin = left_margin * scale;
295 xr->right_margin = right_margin * scale;
296 xr->top_margin = top_margin * scale;
297 xr->bottom_margin = bottom_margin * scale;
298 xr->width = (paper_width - left_margin - right_margin) * scale;
299 xr->length = (paper_length - top_margin - bottom_margin) * scale;
302 static struct xr_driver *
303 xr_allocate (const char *name, int device_type, struct string_map *o)
305 struct xr_driver *xr = xzalloc (sizeof *xr);
306 struct output_driver *d = &xr->driver;
308 output_driver_init (d, &cairo_driver_class, name, device_type);
310 apply_options (xr, o);
316 pango_to_xr (int pango)
318 return (XR_POINT != PANGO_SCALE
319 ? ceil (pango * (1. * XR_POINT / PANGO_SCALE))
326 return (XR_POINT != PANGO_SCALE
327 ? ceil (xr * (1. / XR_POINT * PANGO_SCALE))
332 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
338 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
342 for (i = 0; i < XR_N_FONTS; i++)
344 struct xr_font *font = &xr->fonts[i];
345 int char_width, char_height;
347 font->layout = pango_cairo_create_layout (cairo);
348 pango_layout_set_font_description (font->layout, font->desc);
350 pango_layout_set_text (font->layout, "0", 1);
351 pango_layout_get_size (font->layout, &char_width, &char_height);
352 xr->char_width = MAX (xr->char_width, pango_to_xr (char_width));
353 xr->char_height = MAX (xr->char_height, pango_to_xr (char_height));
356 if (xr->params == NULL)
358 int single_width, double_width;
360 xr->params = xmalloc (sizeof *xr->params);
361 xr->params->draw_line = xr_draw_line;
362 xr->params->measure_cell_width = xr_measure_cell_width;
363 xr->params->measure_cell_height = xr_measure_cell_height;
364 xr->params->draw_cell = xr_draw_cell;
365 xr->params->aux = xr;
366 xr->params->size[H] = xr->width;
367 xr->params->size[V] = xr->length;
368 xr->params->font_size[H] = xr->char_width;
369 xr->params->font_size[V] = xr->char_height;
371 single_width = 2 * xr->line_gutter + xr->line_width;
372 double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
373 for (i = 0; i < TABLE_N_AXES; i++)
375 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
376 xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
377 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
381 cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue);
386 static struct output_driver *
387 xr_create (const char *file_name, enum settings_output_devices device_type,
388 struct string_map *o, enum xr_output_type file_type)
390 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
391 struct xr_driver *xr;
392 cairo_surface_t *surface;
393 cairo_status_t status;
394 double width_pt, length_pt;
396 xr = xr_allocate (file_name, device_type, o);
398 width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
399 length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
400 if (file_type == XR_PDF)
401 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
402 else if (file_type == XR_PS)
403 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
404 else if (file_type == XR_SVG)
405 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
409 status = cairo_surface_status (surface);
410 if (status != CAIRO_STATUS_SUCCESS)
412 msg (ME, _("error opening output file `%s': %s"),
413 file_name, cairo_status_to_string (status));
414 cairo_surface_destroy (surface);
418 xr->cairo = cairo_create (surface);
419 cairo_surface_destroy (surface);
421 if (!xr_set_cairo (xr, xr->cairo))
424 cairo_save (xr->cairo);
425 xr_driver_next_page (xr, xr->cairo);
427 if (xr->width / xr->char_width < MIN_WIDTH)
429 msg (ME, _("The defined page is not wide enough to hold at least %d "
430 "characters in the default font. In fact, there's only "
431 "room for %d characters."),
433 xr->width / xr->char_width);
437 if (xr->length / xr->char_height < MIN_LENGTH)
439 msg (ME, _("The defined page is not long enough to hold at least %d "
440 "lines in the default font. In fact, there's only "
441 "room for %d lines."),
443 xr->length / xr->char_height);
450 output_driver_destroy (&xr->driver);
454 static struct output_driver *
455 xr_pdf_create (const char *file_name, enum settings_output_devices device_type,
456 struct string_map *o)
458 return xr_create (file_name, device_type, o, XR_PDF);
461 static struct output_driver *
462 xr_ps_create (const char *file_name, enum settings_output_devices device_type,
463 struct string_map *o)
465 return xr_create (file_name, device_type, o, XR_PS);
468 static struct output_driver *
469 xr_svg_create (const char *file_name, enum settings_output_devices device_type,
470 struct string_map *o)
472 return xr_create (file_name, device_type, o, XR_SVG);
476 xr_destroy (struct output_driver *driver)
478 struct xr_driver *xr = xr_driver_cast (driver);
481 xr_driver_destroy_fsm (xr);
483 if (xr->cairo != NULL)
485 cairo_status_t status;
487 cairo_surface_finish (cairo_get_target (xr->cairo));
488 status = cairo_status (xr->cairo);
489 if (status != CAIRO_STATUS_SUCCESS)
490 msg (ME, _("error drawing output for %s driver: %s"),
491 output_driver_get_name (driver),
492 cairo_status_to_string (status));
493 cairo_destroy (xr->cairo);
496 free (xr->command_name);
497 for (i = 0; i < XR_N_FONTS; i++)
499 struct xr_font *font = &xr->fonts[i];
501 if (font->desc != NULL)
502 pango_font_description_free (font->desc);
503 if (font->layout != NULL)
504 g_object_unref (font->layout);
512 xr_flush (struct output_driver *driver)
514 struct xr_driver *xr = xr_driver_cast (driver);
516 cairo_surface_flush (cairo_get_target (xr->cairo));
520 xr_init_caption_cell (const char *caption, struct table_cell *cell)
522 cell->contents = caption;
523 cell->options = TAB_LEFT;
524 cell->destructor = NULL;
527 static struct render_page *
528 xr_render_table_item (struct xr_driver *xr, const struct table_item *item,
529 int *caption_widthp, int *caption_heightp)
531 const char *caption = table_item_get_caption (item);
535 /* XXX doesn't do well with very large captions */
536 int min_width, max_width;
537 struct table_cell cell;
539 xr_init_caption_cell (caption, &cell);
541 xr_measure_cell_width (xr, &cell, &min_width, &max_width);
542 *caption_widthp = MIN (max_width, xr->width);
543 *caption_heightp = xr_measure_cell_height (xr, &cell, *caption_widthp);
546 *caption_heightp = 0;
548 return render_page_create (xr->params, table_item_get_table (item));
552 xr_submit (struct output_driver *driver, const struct output_item *output_item)
554 struct xr_driver *xr = xr_driver_cast (driver);
556 output_driver_track_current_command (output_item, &xr->command_name);
558 xr_driver_output_item (xr, output_item);
559 while (xr_driver_need_new_page (xr))
561 cairo_restore (xr->cairo);
562 cairo_show_page (xr->cairo);
563 cairo_save (xr->cairo);
564 xr_driver_next_page (xr, xr->cairo);
568 /* Functions for rendering a series of output items to a series of Cairo
569 contexts, with pagination.
571 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
572 its underlying implementation.
574 See the big comment in cairo.h for intended usage. */
576 /* Gives new page CAIRO to XR for output. CAIRO may be null to skip actually
577 rendering the page (which might be useful to find out how many pages an
578 output document has without actually rendering it). */
580 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
585 cairo_set_source_rgb (cairo, xr->bg.red, xr->bg.green, xr->bg.blue);
586 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
588 cairo_restore (cairo);
590 cairo_translate (cairo,
591 xr_to_pt (xr->left_margin),
592 xr_to_pt (xr->top_margin));
598 xr_driver_run_fsm (xr);
601 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
602 rendering a previous output item, that is, only if xr_driver_need_new_page()
605 xr_driver_output_item (struct xr_driver *xr,
606 const struct output_item *output_item)
608 assert (xr->fsm == NULL);
609 xr->fsm = xr_render_output_item (xr, output_item);
610 xr_driver_run_fsm (xr);
613 /* Returns true if XR is in the middle of rendering an output item and needs a
614 new page to be appended using xr_driver_next_page() to make progress,
617 xr_driver_need_new_page (const struct xr_driver *xr)
619 return xr->fsm != NULL;
622 /* Returns true if the current page doesn't have any content yet. */
624 xr_driver_is_page_blank (const struct xr_driver *xr)
630 xr_driver_destroy_fsm (struct xr_driver *xr)
634 xr->fsm->destroy (xr->fsm);
640 xr_driver_run_fsm (struct xr_driver *xr)
642 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
643 xr_driver_destroy_fsm (xr);
647 xr_layout_cell (struct xr_driver *, const struct table_cell *,
648 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
649 int *width, int *height);
652 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
654 cairo_new_path (xr->cairo);
655 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
656 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
657 cairo_stroke (xr->cairo);
660 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
661 shortening it to X0...X1 if SHORTEN is true.
662 Draws a horizontal line X1...X3 at Y if RIGHT says so,
663 shortening it to X2...X3 if SHORTEN is true. */
665 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
666 enum render_line_style left, enum render_line_style right,
669 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
670 dump_line (xr, x0, y, x3, y);
673 if (left != RENDER_LINE_NONE)
674 dump_line (xr, x0, y, shorten ? x1 : x2, y);
675 if (right != RENDER_LINE_NONE)
676 dump_line (xr, shorten ? x2 : x1, y, x3, y);
680 /* Draws a vertical line Y0...Y2 at X if TOP says so,
681 shortening it to Y0...Y1 if SHORTEN is true.
682 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
683 shortening it to Y2...Y3 if SHORTEN is true. */
685 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
686 enum render_line_style top, enum render_line_style bottom,
689 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
690 dump_line (xr, x, y0, x, y3);
693 if (top != RENDER_LINE_NONE)
694 dump_line (xr, x, y0, x, shorten ? y1 : y2);
695 if (bottom != RENDER_LINE_NONE)
696 dump_line (xr, x, shorten ? y2 : y1, x, y3);
701 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
702 enum render_line_style styles[TABLE_N_AXES][2])
704 const int x0 = bb[H][0];
705 const int y0 = bb[V][0];
706 const int x3 = bb[H][1];
707 const int y3 = bb[V][1];
708 const int top = styles[H][0];
709 const int left = styles[V][0];
710 const int bottom = styles[H][1];
711 const int right = styles[V][1];
713 /* The algorithm here is somewhat subtle, to allow it to handle
714 all the kinds of intersections that we need.
716 Three additional ordinates are assigned along the x axis. The
717 first is xc, midway between x0 and x3. The others are x1 and
718 x2; for a single vertical line these are equal to xc, and for
719 a double vertical line they are the ordinates of the left and
720 right half of the double line.
722 yc, y1, and y2 are assigned similarly along the y axis.
724 The following diagram shows the coordinate system and output
725 for double top and bottom lines, single left line, and no
729 y0 ________________________
735 y1 = y2 = yc |######### # |
740 y3 |________#_____#_______|
742 struct xr_driver *xr = xr_;
744 /* Offset from center of each line in a pair of double lines. */
745 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
747 /* Are the lines along each axis single or double?
748 (It doesn't make sense to have different kinds of line on the
749 same axis, so we don't try to gracefully handle that case.) */
750 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
751 bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE;
753 /* When horizontal lines are doubled,
754 the left-side line along y1 normally runs from x0 to x2,
755 and the right-side line along y1 from x3 to x1.
756 If the top-side line is also doubled, we shorten the y1 lines,
757 so that the left-side line runs only to x1,
758 and the right-side line only to x2.
759 Otherwise, the horizontal line at y = y1 below would cut off
760 the intersection, which looks ugly:
762 y0 ________________________
767 y1 |######### ########|
770 y2 |######################|
773 y3 |______________________|
774 It is more of a judgment call when the horizontal line is
775 single. We actually choose to cut off the line anyhow, as
776 shown in the first diagram above.
778 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
779 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
780 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
781 int horz_line_ofs = double_vert ? double_line_ofs : 0;
782 int xc = (x0 + x3) / 2;
783 int x1 = xc - horz_line_ofs;
784 int x2 = xc + horz_line_ofs;
786 bool shorten_x1_lines = left == RENDER_LINE_DOUBLE;
787 bool shorten_x2_lines = right == RENDER_LINE_DOUBLE;
788 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
789 int vert_line_ofs = double_horz ? double_line_ofs : 0;
790 int yc = (y0 + y3) / 2;
791 int y1 = yc - vert_line_ofs;
792 int y2 = yc + vert_line_ofs;
795 horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line);
798 horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines);
799 horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines);
803 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
806 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
807 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
812 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
813 int *min_width, int *max_width)
815 struct xr_driver *xr = xr_;
816 int bb[TABLE_N_AXES][2];
817 int clip[TABLE_N_AXES][2];
824 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
825 xr_layout_cell (xr, cell, bb, clip, max_width, &h);
828 xr_layout_cell (xr, cell, bb, clip, min_width, &h);
832 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
834 struct xr_driver *xr = xr_;
835 int bb[TABLE_N_AXES][2];
836 int clip[TABLE_N_AXES][2];
843 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
844 xr_layout_cell (xr, cell, bb, clip, &w, &h);
849 xr_draw_cell (void *xr_, const struct table_cell *cell,
850 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
852 struct xr_driver *xr = xr_;
855 xr_layout_cell (xr, cell, bb, clip, &w, &h);
859 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
860 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
861 int *width, int *height)
863 struct xr_font *font;
866 font = (cell->options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
867 : cell->options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
868 : &xr->fonts[XR_FONT_PROPORTIONAL]);
870 pango_layout_set_text (font->layout, cell->contents, -1);
872 pango_layout_set_alignment (
874 ((cell->options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
875 : (cell->options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
876 : PANGO_ALIGN_CENTER));
877 pango_layout_set_width (
879 bb[H][1] == INT_MAX ? -1 : xr_to_pango (bb[H][1] - bb[H][0]));
880 pango_layout_set_wrap (font->layout, PANGO_WRAP_WORD);
882 if (clip[H][0] != clip[H][1])
884 cairo_save (xr->cairo);
886 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
888 double x0 = xr_to_pt (clip[H][0]);
889 double y0 = xr_to_pt (clip[V][0] + xr->y);
890 double x1 = xr_to_pt (clip[H][1]);
891 double y1 = xr_to_pt (clip[V][1] + xr->y);
893 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
894 cairo_clip (xr->cairo);
897 cairo_translate (xr->cairo,
899 xr_to_pt (bb[V][0] + xr->y));
900 pango_cairo_show_layout (xr->cairo, font->layout);
901 cairo_restore (xr->cairo);
904 pango_layout_get_size (font->layout, &w, &h);
905 *width = pango_to_xr (w);
906 *height = pango_to_xr (h);
910 xr_draw_title (struct xr_driver *xr, const char *title,
911 int title_width, int title_height)
913 struct table_cell cell;
914 int bb[TABLE_N_AXES][2];
916 xr_init_caption_cell (title, &cell);
918 bb[H][1] = title_width;
920 bb[V][1] = title_height;
921 xr_draw_cell (xr, &cell, bb, bb);
924 struct output_driver_factory pdf_driver_factory =
925 { "pdf", "pspp.pdf", xr_pdf_create };
926 struct output_driver_factory ps_driver_factory =
927 { "ps", "pspp.ps", xr_ps_create };
928 struct output_driver_factory svg_driver_factory =
929 { "svg", "pspp.svg", xr_svg_create };
931 static const struct output_driver_class cairo_driver_class =
939 /* GUI rendering helpers. */
943 struct output_item *item;
946 struct render_page *page;
947 struct xr_driver *xr;
952 #define CHART_WIDTH 500
953 #define CHART_HEIGHT 375
958 xr_driver_create (cairo_t *cairo, struct string_map *options)
960 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
961 if (!xr_set_cairo (xr, cairo))
963 output_driver_destroy (&xr->driver);
969 /* Destroy XR, which should have been created with xr_driver_create(). Any
970 cairo_t added to XR is not destroyed, because it is owned by the client. */
972 xr_driver_destroy (struct xr_driver *xr)
977 output_driver_destroy (&xr->driver);
981 static struct xr_rendering *
982 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
984 struct table_item *table_item;
985 struct xr_rendering *r;
987 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
988 r = xr_rendering_create (xr, &table_item->output_item, cr);
989 table_item_unref (table_item);
995 xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
997 if (is_table_item (xr->item))
998 apply_options (xr->xr, o);
1001 struct xr_rendering *
1002 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
1005 struct xr_rendering *r = NULL;
1007 if (is_text_item (item))
1008 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
1010 else if (is_message_item (item))
1012 const struct message_item *message_item = to_message_item (item);
1013 const struct msg *msg = message_item_get_msg (message_item);
1014 char *s = msg_to_string (msg, NULL);
1015 r = xr_rendering_create_text (xr, s, cr);
1018 else if (is_table_item (item))
1020 r = xzalloc (sizeof *r);
1021 r->item = output_item_ref (item);
1023 xr_set_cairo (xr, cr);
1024 r->page = xr_render_table_item (xr, to_table_item (item),
1025 &r->title_width, &r->title_height);
1027 else if (is_chart_item (item))
1029 r = xzalloc (sizeof *r);
1030 r->item = output_item_ref (item);
1037 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
1039 if (is_table_item (r->item))
1041 int w0 = render_page_get_size (r->page, H);
1042 int w1 = r->title_width;
1043 *w = MAX (w0, w1) / XR_POINT;
1044 *h = (render_page_get_size (r->page, V) + r->title_height) / XR_POINT;
1053 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1054 double x, double y, double width, double height);
1056 /* Draws onto CR at least the region of R that is enclosed in (X,Y)-(X+W,Y+H),
1057 and possibly some additional parts. */
1059 xr_rendering_draw (struct xr_rendering *r, cairo_t *cr,
1060 int x, int y, int w, int h)
1062 if (is_table_item (r->item))
1064 struct xr_driver *xr = r->xr;
1066 xr_set_cairo (xr, cr);
1068 if (r->title_height > 0)
1071 xr_draw_title (xr, table_item_get_caption (to_table_item (r->item)),
1072 r->title_width, r->title_height);
1075 xr->y = r->title_height;
1076 render_page_draw_region (r->page,
1077 x * XR_POINT, (y * XR_POINT) - r->title_height,
1078 w * XR_POINT, h * XR_POINT);
1081 xr_draw_chart (to_chart_item (r->item), cr,
1082 0, 0, CHART_WIDTH, CHART_HEIGHT);
1086 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1087 double x, double y, double width, double height)
1089 struct xrchart_geometry geom;
1092 cairo_translate (cr, x, y + height);
1093 cairo_scale (cr, 1.0, -1.0);
1094 xrchart_geometry_init (cr, &geom, width, height);
1095 if (is_boxplot (chart_item))
1096 xrchart_draw_boxplot (chart_item, cr, &geom);
1097 else if (is_histogram_chart (chart_item))
1098 xrchart_draw_histogram (chart_item, cr, &geom);
1099 else if (is_np_plot_chart (chart_item))
1100 xrchart_draw_np_plot (chart_item, cr, &geom);
1101 else if (is_piechart (chart_item))
1102 xrchart_draw_piechart (chart_item, cr, &geom);
1103 else if (is_roc_chart (chart_item))
1104 xrchart_draw_roc (chart_item, cr, &geom);
1105 else if (is_scree (chart_item))
1106 xrchart_draw_scree (chart_item, cr, &geom);
1107 else if (is_spreadlevel_plot_chart (chart_item))
1108 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1111 xrchart_geometry_free (cr, &geom);
1117 xr_draw_png_chart (const struct chart_item *item,
1118 const char *file_name_template, int number,
1119 const struct xr_color *fg,
1120 const struct xr_color *bg
1123 const int width = 640;
1124 const int length = 480;
1126 cairo_surface_t *surface;
1127 cairo_status_t status;
1128 const char *number_pos;
1132 number_pos = strchr (file_name_template, '#');
1133 if (number_pos != NULL)
1134 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1135 file_name_template, number, number_pos + 1);
1137 file_name = xstrdup (file_name_template);
1139 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1140 cr = cairo_create (surface);
1142 cairo_set_source_rgb (cr, bg->red, bg->green, bg->blue);
1145 cairo_set_source_rgb (cr, fg->red, fg->green, fg->blue);
1147 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1149 status = cairo_surface_write_to_png (surface, file_name);
1150 if (status != CAIRO_STATUS_SUCCESS)
1151 msg (ME, _("error writing output file `%s': %s"),
1152 file_name, cairo_status_to_string (status));
1155 cairo_surface_destroy (surface);
1160 struct xr_table_state
1162 struct xr_render_fsm fsm;
1163 struct table_item *table_item;
1164 struct render_break x_break;
1165 struct render_break y_break;
1170 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1172 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1176 struct render_page *y_slice;
1179 while (!render_break_has_next (&ts->y_break))
1181 struct render_page *x_slice;
1183 render_break_destroy (&ts->y_break);
1184 if (!render_break_has_next (&ts->x_break))
1187 x_slice = render_break_next (&ts->x_break, xr->width);
1188 render_break_init (&ts->y_break, x_slice, V);
1191 space = xr->length - xr->y;
1192 if (render_break_next_size (&ts->y_break) > space)
1198 y_slice = render_break_next (&ts->y_break, space);
1199 if (ts->caption_height)
1202 xr_draw_title (xr, table_item_get_caption (ts->table_item),
1203 xr->width, ts->caption_height);
1205 xr->y += ts->caption_height;
1206 ts->caption_height = 0;
1210 render_page_draw (y_slice);
1211 xr->y += render_page_get_size (y_slice, V);
1212 render_page_unref (y_slice);
1217 xr_table_destroy (struct xr_render_fsm *fsm)
1219 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1221 table_item_unref (ts->table_item);
1222 render_break_destroy (&ts->x_break);
1223 render_break_destroy (&ts->y_break);
1227 static struct xr_render_fsm *
1228 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1230 struct xr_table_state *ts;
1231 struct render_page *page;
1234 ts = xmalloc (sizeof *ts);
1235 ts->fsm.render = xr_table_render;
1236 ts->fsm.destroy = xr_table_destroy;
1237 ts->table_item = table_item_ref (table_item);
1240 xr->y += xr->char_height;
1242 page = xr_render_table_item (xr, table_item,
1243 &caption_width, &ts->caption_height);
1244 xr->params->size[V] = xr->length - ts->caption_height;
1246 render_break_init (&ts->x_break, page, H);
1247 render_break_init_empty (&ts->y_break);
1252 struct xr_chart_state
1254 struct xr_render_fsm fsm;
1255 struct chart_item *chart_item;
1259 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1261 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1266 if (xr->cairo != NULL)
1267 xr_draw_chart (cs->chart_item, xr->cairo, 0.0, 0.0,
1268 xr_to_pt (xr->width), xr_to_pt (xr->length));
1275 xr_chart_destroy (struct xr_render_fsm *fsm)
1277 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1279 chart_item_unref (cs->chart_item);
1283 static struct xr_render_fsm *
1284 xr_render_chart (const struct chart_item *chart_item)
1286 struct xr_chart_state *cs;
1288 cs = xmalloc (sizeof *cs);
1289 cs->fsm.render = xr_chart_render;
1290 cs->fsm.destroy = xr_chart_destroy;
1291 cs->chart_item = chart_item_ref (chart_item);
1297 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1303 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1305 /* Nothing to do. */
1308 static struct xr_render_fsm *
1309 xr_render_eject (void)
1311 static struct xr_render_fsm eject_renderer =
1317 return &eject_renderer;
1320 static struct xr_render_fsm *
1321 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1323 struct table_item *table_item;
1324 struct xr_render_fsm *fsm;
1326 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
1327 fsm = xr_render_table (xr, table_item);
1328 table_item_unref (table_item);
1333 static struct xr_render_fsm *
1334 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1336 enum text_item_type type = text_item_get_type (text_item);
1337 const char *text = text_item_get_text (text_item);
1341 case TEXT_ITEM_TITLE:
1343 xr->title = xstrdup (text);
1346 case TEXT_ITEM_SUBTITLE:
1347 free (xr->subtitle);
1348 xr->subtitle = xstrdup (text);
1351 case TEXT_ITEM_COMMAND_CLOSE:
1354 case TEXT_ITEM_BLANK_LINE:
1356 xr->y += xr->char_height;
1359 case TEXT_ITEM_EJECT_PAGE:
1361 return xr_render_eject ();
1365 return xr_create_text_renderer (xr, text);
1371 static struct xr_render_fsm *
1372 xr_render_message (struct xr_driver *xr,
1373 const struct message_item *message_item)
1375 const struct msg *msg = message_item_get_msg (message_item);
1376 struct xr_render_fsm *fsm;
1379 s = msg_to_string (msg, xr->command_name);
1380 fsm = xr_create_text_renderer (xr, s);
1386 static struct xr_render_fsm *
1387 xr_render_output_item (struct xr_driver *xr,
1388 const struct output_item *output_item)
1390 if (is_table_item (output_item))
1391 return xr_render_table (xr, to_table_item (output_item));
1392 else if (is_chart_item (output_item))
1393 return xr_render_chart (to_chart_item (output_item));
1394 else if (is_text_item (output_item))
1395 return xr_render_text (xr, to_text_item (output_item));
1396 else if (is_message_item (output_item))
1397 return xr_render_message (xr, to_message_item (output_item));