1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2012, 2013 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>
50 #include <pango/pango-font.h>
51 #include <pango/pango-layout.h>
52 #include <pango/pango.h>
53 #include <pango/pangocairo.h>
56 #include "gl/intprops.h"
57 #include "gl/minmax.h"
58 #include "gl/xalloc.h"
61 #define _(msgid) gettext (msgid)
63 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
67 /* Measurements as we present to the rest of PSPP. */
70 /* Conversions to and from points. */
74 return x / (double) XR_POINT;
94 /* A font for use with Cairo. */
97 PangoFontDescription *desc;
101 /* An output item whose rendering is in progress. */
104 /* Renders as much of itself as it can on the current page. Returns true
105 if rendering is complete, false if the output item needs another
107 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
109 /* Destroys the output item. */
110 void (*destroy) (struct xr_render_fsm *);
113 /* Cairo output driver. */
116 struct output_driver driver;
118 /* User parameters. */
119 struct xr_font fonts[XR_N_FONTS];
121 int width; /* Page width minus margins. */
122 int length; /* Page length minus margins and header. */
124 int left_margin; /* Left margin in XR units. */
125 int right_margin; /* Right margin in XR units. */
126 int top_margin; /* Top margin in XR units. */
127 int bottom_margin; /* Bottom margin in XR units. */
129 int line_gutter; /* Space around lines. */
130 int line_space; /* Space between lines. */
131 int line_width; /* Width of lines. */
133 struct xr_color bg; /* Background color */
134 struct xr_color fg; /* Foreground color */
136 /* Internal state. */
137 struct render_params *params;
138 int char_width, char_height;
143 int page_number; /* Current page number. */
145 struct xr_render_fsm *fsm;
148 static const struct output_driver_class cairo_driver_class;
150 static void xr_driver_destroy_fsm (struct xr_driver *);
151 static void xr_driver_run_fsm (struct xr_driver *);
153 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
154 enum render_line_style styles[TABLE_N_AXES][2]);
155 static void xr_measure_cell_width (void *, const struct table_cell *,
157 static int xr_measure_cell_height (void *, const struct table_cell *,
159 static void xr_draw_cell (void *, const struct table_cell *,
160 int bb[TABLE_N_AXES][2],
161 int clip[TABLE_N_AXES][2]);
163 static struct xr_render_fsm *xr_render_output_item (
164 struct xr_driver *, const struct output_item *);
166 /* Output driver basics. */
168 static struct xr_driver *
169 xr_driver_cast (struct output_driver *driver)
171 assert (driver->class == &cairo_driver_class);
172 return UP_CAST (driver, struct xr_driver, driver);
175 static struct driver_option *
176 opt (struct output_driver *d, struct string_map *options, const char *key,
177 const char *default_value)
179 return driver_option_get (d, options, key, default_value);
182 /* Parse color information specified by KEY into {RED,GREEN,BLUE}.
183 Currently, the input string must be of the form "#RRRRGGGGBBBB"
184 Future implementations might allow things like "yellow" and
185 "sky-blue-ultra-brown"
188 parse_color (struct output_driver *d, struct string_map *options,
189 const char *key, const char *default_value,
190 struct xr_color *color)
192 int red, green, blue;
193 char *string = parse_string (opt (d, options, key, default_value));
195 if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue))
197 /* If the parsed option string fails, then try the default value */
198 if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue))
200 /* ... and if that fails set everything to zero */
201 red = green = blue = 0;
207 /* Convert 16 bit ints to float */
208 color->red = red / (double) 0xFFFF;
209 color->green = green / (double) 0xFFFF;
210 color->blue = blue / (double) 0xFFFF;
213 static PangoFontDescription *
214 parse_font (struct output_driver *d, struct string_map *options,
215 const char *key, const char *default_value,
218 PangoFontDescription *desc;
221 /* Parse KEY as a font description. */
222 string = parse_string (opt (d, options, key, default_value));
223 desc = pango_font_description_from_string (string);
226 msg (MW, _("`%s': bad font specification"), string);
228 /* Fall back to DEFAULT_VALUE, which had better be a valid font
230 desc = pango_font_description_from_string (default_value);
231 assert (desc != NULL);
235 /* If the font description didn't include an explicit font size, then set it
236 to DEFAULT_POINTS. */
237 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
238 pango_font_description_set_size (desc,
239 default_points / 1000.0 * PANGO_SCALE);
246 apply_options (struct xr_driver *xr, struct string_map *o)
248 struct output_driver *d = &xr->driver;
250 int paper_width, paper_length, i;
252 int font_points = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
254 for (i = 0; i < XR_N_FONTS; i++)
256 struct xr_font *font = &xr->fonts[i];
258 if (font->desc != NULL)
259 pango_font_description_free (font->desc);
262 xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
264 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
265 "serif", font_points);
266 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
267 "serif italic", font_points);
269 xr->line_gutter = parse_dimension (opt (d, o, "gutter", "3pt"));
270 xr->line_space = XR_POINT;
271 xr->line_width = XR_POINT / 2;
274 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg);
275 parse_color (d, o, "foreground-color", "#000000000000", &xr->fg);
277 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
278 xr->left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
279 xr->right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
280 xr->top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
281 xr->bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
283 xr->width = paper_width - xr->left_margin - xr->right_margin;
284 xr->length = paper_length - xr->top_margin - xr->bottom_margin;
287 static struct xr_driver *
288 xr_allocate (const char *name, int device_type, struct string_map *o)
290 struct xr_driver *xr = xzalloc (sizeof *xr);
291 struct output_driver *d = &xr->driver;
293 output_driver_init (d, &cairo_driver_class, name, device_type);
295 apply_options (xr, o);
301 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
307 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
311 for (i = 0; i < XR_N_FONTS; i++)
313 struct xr_font *font = &xr->fonts[i];
314 int char_width, char_height;
316 font->layout = pango_cairo_create_layout (cairo);
317 pango_layout_set_font_description (font->layout, font->desc);
319 pango_layout_set_text (font->layout, "0", 1);
320 pango_layout_get_size (font->layout, &char_width, &char_height);
321 xr->char_width = MAX (xr->char_width, char_width);
322 xr->char_height = MAX (xr->char_height, char_height);
325 if (xr->params == NULL)
327 int single_width, double_width;
329 xr->params = xmalloc (sizeof *xr->params);
330 xr->params->draw_line = xr_draw_line;
331 xr->params->measure_cell_width = xr_measure_cell_width;
332 xr->params->measure_cell_height = xr_measure_cell_height;
333 xr->params->draw_cell = xr_draw_cell;
334 xr->params->aux = xr;
335 xr->params->size[H] = xr->width;
336 xr->params->size[V] = xr->length;
337 xr->params->font_size[H] = xr->char_width;
338 xr->params->font_size[V] = xr->char_height;
340 single_width = 2 * xr->line_gutter + xr->line_width;
341 double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
342 for (i = 0; i < TABLE_N_AXES; i++)
344 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
345 xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
346 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
350 cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue);
355 static struct output_driver *
356 xr_create (const char *file_name, enum settings_output_devices device_type,
357 struct string_map *o, enum xr_output_type file_type)
359 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
360 struct xr_driver *xr;
361 cairo_surface_t *surface;
362 cairo_status_t status;
363 double width_pt, length_pt;
365 xr = xr_allocate (file_name, device_type, o);
367 width_pt = (xr->width + xr->left_margin + xr->right_margin) / 1000.0;
368 length_pt = (xr->length + xr->top_margin + xr->bottom_margin) / 1000.0;
369 if (file_type == XR_PDF)
370 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
371 else if (file_type == XR_PS)
372 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
373 else if (file_type == XR_SVG)
374 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
378 status = cairo_surface_status (surface);
379 if (status != CAIRO_STATUS_SUCCESS)
381 msg (ME, _("error opening output file `%s': %s"),
382 file_name, cairo_status_to_string (status));
383 cairo_surface_destroy (surface);
387 xr->cairo = cairo_create (surface);
388 cairo_surface_destroy (surface);
390 if (!xr_set_cairo (xr, xr->cairo))
393 cairo_save (xr->cairo);
394 xr_driver_next_page (xr, xr->cairo);
396 if (xr->width / xr->char_width < MIN_WIDTH)
398 msg (ME, _("The defined page is not wide enough to hold at least %d "
399 "characters in the default font. In fact, there's only "
400 "room for %d characters."),
402 xr->width / xr->char_width);
406 if (xr->length / xr->char_height < MIN_LENGTH)
408 msg (ME, _("The defined page is not long enough to hold at least %d "
409 "lines in the default font. In fact, there's only "
410 "room for %d lines."),
412 xr->length / xr->char_height);
419 output_driver_destroy (&xr->driver);
423 static struct output_driver *
424 xr_pdf_create (const char *file_name, enum settings_output_devices device_type,
425 struct string_map *o)
427 return xr_create (file_name, device_type, o, XR_PDF);
430 static struct output_driver *
431 xr_ps_create (const char *file_name, enum settings_output_devices device_type,
432 struct string_map *o)
434 return xr_create (file_name, device_type, o, XR_PS);
437 static struct output_driver *
438 xr_svg_create (const char *file_name, enum settings_output_devices device_type,
439 struct string_map *o)
441 return xr_create (file_name, device_type, o, XR_SVG);
445 xr_destroy (struct output_driver *driver)
447 struct xr_driver *xr = xr_driver_cast (driver);
450 xr_driver_destroy_fsm (xr);
452 if (xr->cairo != NULL)
454 cairo_status_t status;
456 cairo_surface_finish (cairo_get_target (xr->cairo));
457 status = cairo_status (xr->cairo);
458 if (status != CAIRO_STATUS_SUCCESS)
459 msg (ME, _("error drawing output for %s driver: %s"),
460 output_driver_get_name (driver),
461 cairo_status_to_string (status));
462 cairo_destroy (xr->cairo);
465 free (xr->command_name);
466 for (i = 0; i < XR_N_FONTS; i++)
468 struct xr_font *font = &xr->fonts[i];
470 if (font->desc != NULL)
471 pango_font_description_free (font->desc);
472 if (font->layout != NULL)
473 g_object_unref (font->layout);
481 xr_flush (struct output_driver *driver)
483 struct xr_driver *xr = xr_driver_cast (driver);
485 cairo_surface_flush (cairo_get_target (xr->cairo));
489 xr_init_caption_cell (const char *caption, struct table_cell *cell)
491 cell->contents = caption;
492 cell->options = TAB_LEFT;
493 cell->destructor = NULL;
496 static struct render_page *
497 xr_render_table_item (struct xr_driver *xr, const struct table_item *item,
498 int *caption_widthp, int *caption_heightp)
500 const char *caption = table_item_get_caption (item);
504 /* XXX doesn't do well with very large captions */
505 int min_width, max_width;
506 struct table_cell cell;
508 xr_init_caption_cell (caption, &cell);
510 xr_measure_cell_width (xr, &cell, &min_width, &max_width);
511 *caption_widthp = MIN (max_width, xr->width);
512 *caption_heightp = xr_measure_cell_height (xr, &cell, *caption_widthp);
515 *caption_heightp = 0;
517 return render_page_create (xr->params, table_item_get_table (item));
521 xr_submit (struct output_driver *driver, const struct output_item *output_item)
523 struct xr_driver *xr = xr_driver_cast (driver);
525 output_driver_track_current_command (output_item, &xr->command_name);
527 xr_driver_output_item (xr, output_item);
528 while (xr_driver_need_new_page (xr))
530 cairo_restore (xr->cairo);
531 cairo_show_page (xr->cairo);
532 cairo_save (xr->cairo);
533 xr_driver_next_page (xr, xr->cairo);
537 /* Functions for rendering a series of output items to a series of Cairo
538 contexts, with pagination.
540 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
541 its underlying implementation.
543 See the big comment in cairo.h for intended usage. */
545 /* Gives new page CAIRO to XR for output. CAIRO may be null to skip actually
546 rendering the page (which might be useful to find out how many pages an
547 output document has without actually rendering it). */
549 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
554 cairo_set_source_rgb (cairo, xr->bg.red, xr->bg.green, xr->bg.blue);
555 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
557 cairo_restore (cairo);
559 cairo_translate (cairo,
560 xr_to_pt (xr->left_margin),
561 xr_to_pt (xr->top_margin));
567 xr_driver_run_fsm (xr);
570 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
571 rendering a previous output item, that is, only if xr_driver_need_new_page()
574 xr_driver_output_item (struct xr_driver *xr,
575 const struct output_item *output_item)
577 assert (xr->fsm == NULL);
578 xr->fsm = xr_render_output_item (xr, output_item);
579 xr_driver_run_fsm (xr);
582 /* Returns true if XR is in the middle of rendering an output item and needs a
583 new page to be appended using xr_driver_next_page() to make progress,
586 xr_driver_need_new_page (const struct xr_driver *xr)
588 return xr->fsm != NULL;
591 /* Returns true if the current page doesn't have any content yet. */
593 xr_driver_is_page_blank (const struct xr_driver *xr)
599 xr_driver_destroy_fsm (struct xr_driver *xr)
603 xr->fsm->destroy (xr->fsm);
609 xr_driver_run_fsm (struct xr_driver *xr)
611 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
612 xr_driver_destroy_fsm (xr);
616 xr_layout_cell (struct xr_driver *, const struct table_cell *,
617 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
618 PangoWrapMode, int *width, int *height);
621 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
623 cairo_new_path (xr->cairo);
624 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
625 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
626 cairo_stroke (xr->cairo);
629 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
630 shortening it to X0...X1 if SHORTEN is true.
631 Draws a horizontal line X1...X3 at Y if RIGHT says so,
632 shortening it to X2...X3 if SHORTEN is true. */
634 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
635 enum render_line_style left, enum render_line_style right,
638 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
639 dump_line (xr, x0, y, x3, y);
642 if (left != RENDER_LINE_NONE)
643 dump_line (xr, x0, y, shorten ? x1 : x2, y);
644 if (right != RENDER_LINE_NONE)
645 dump_line (xr, shorten ? x2 : x1, y, x3, y);
649 /* Draws a vertical line Y0...Y2 at X if TOP says so,
650 shortening it to Y0...Y1 if SHORTEN is true.
651 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
652 shortening it to Y2...Y3 if SHORTEN is true. */
654 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
655 enum render_line_style top, enum render_line_style bottom,
658 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
659 dump_line (xr, x, y0, x, y3);
662 if (top != RENDER_LINE_NONE)
663 dump_line (xr, x, y0, x, shorten ? y1 : y2);
664 if (bottom != RENDER_LINE_NONE)
665 dump_line (xr, x, shorten ? y2 : y1, x, y3);
670 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
671 enum render_line_style styles[TABLE_N_AXES][2])
673 const int x0 = bb[H][0];
674 const int y0 = bb[V][0];
675 const int x3 = bb[H][1];
676 const int y3 = bb[V][1];
677 const int top = styles[H][0];
678 const int left = styles[V][0];
679 const int bottom = styles[H][1];
680 const int right = styles[V][1];
682 /* The algorithm here is somewhat subtle, to allow it to handle
683 all the kinds of intersections that we need.
685 Three additional ordinates are assigned along the x axis. The
686 first is xc, midway between x0 and x3. The others are x1 and
687 x2; for a single vertical line these are equal to xc, and for
688 a double vertical line they are the ordinates of the left and
689 right half of the double line.
691 yc, y1, and y2 are assigned similarly along the y axis.
693 The following diagram shows the coordinate system and output
694 for double top and bottom lines, single left line, and no
698 y0 ________________________
704 y1 = y2 = yc |######### # |
709 y3 |________#_____#_______|
711 struct xr_driver *xr = xr_;
713 /* Offset from center of each line in a pair of double lines. */
714 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
716 /* Are the lines along each axis single or double?
717 (It doesn't make sense to have different kinds of line on the
718 same axis, so we don't try to gracefully handle that case.) */
719 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
720 bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE;
722 /* When horizontal lines are doubled,
723 the left-side line along y1 normally runs from x0 to x2,
724 and the right-side line along y1 from x3 to x1.
725 If the top-side line is also doubled, we shorten the y1 lines,
726 so that the left-side line runs only to x1,
727 and the right-side line only to x2.
728 Otherwise, the horizontal line at y = y1 below would cut off
729 the intersection, which looks ugly:
731 y0 ________________________
736 y1 |######### ########|
739 y2 |######################|
742 y3 |______________________|
743 It is more of a judgment call when the horizontal line is
744 single. We actually choose to cut off the line anyhow, as
745 shown in the first diagram above.
747 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
748 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
749 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
750 int horz_line_ofs = double_vert ? double_line_ofs : 0;
751 int xc = (x0 + x3) / 2;
752 int x1 = xc - horz_line_ofs;
753 int x2 = xc + horz_line_ofs;
755 bool shorten_x1_lines = left == RENDER_LINE_DOUBLE;
756 bool shorten_x2_lines = right == RENDER_LINE_DOUBLE;
757 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
758 int vert_line_ofs = double_horz ? double_line_ofs : 0;
759 int yc = (y0 + y3) / 2;
760 int y1 = yc - vert_line_ofs;
761 int y2 = yc + vert_line_ofs;
764 horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line);
767 horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines);
768 horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines);
772 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
775 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
776 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
781 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
782 int *min_width, int *max_width)
784 struct xr_driver *xr = xr_;
785 int bb[TABLE_N_AXES][2];
786 int clip[TABLE_N_AXES][2];
793 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
794 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, max_width, &h);
797 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, min_width, &h);
801 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
803 struct xr_driver *xr = xr_;
804 int bb[TABLE_N_AXES][2];
805 int clip[TABLE_N_AXES][2];
812 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
813 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
818 xr_draw_cell (void *xr_, const struct table_cell *cell,
819 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
821 struct xr_driver *xr = xr_;
824 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
828 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
829 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
830 PangoWrapMode wrap, int *width, int *height)
832 struct xr_font *font;
834 font = (cell->options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
835 : cell->options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
836 : &xr->fonts[XR_FONT_PROPORTIONAL]);
838 pango_layout_set_text (font->layout, cell->contents, -1);
840 pango_layout_set_alignment (
842 ((cell->options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
843 : (cell->options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
844 : PANGO_ALIGN_CENTER));
845 pango_layout_set_width (font->layout,
846 bb[H][1] == INT_MAX ? -1 : bb[H][1] - bb[H][0]);
847 pango_layout_set_wrap (font->layout, wrap);
849 if (clip[H][0] != clip[H][1])
851 cairo_save (xr->cairo);
853 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
855 double x0 = xr_to_pt (clip[H][0]);
856 double y0 = xr_to_pt (clip[V][0] + xr->y);
857 double x1 = xr_to_pt (clip[H][1]);
858 double y1 = xr_to_pt (clip[V][1] + xr->y);
860 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
861 cairo_clip (xr->cairo);
864 cairo_translate (xr->cairo,
866 xr_to_pt (bb[V][0] + xr->y));
867 pango_cairo_show_layout (xr->cairo, font->layout);
868 cairo_restore (xr->cairo);
871 if (width != NULL || height != NULL)
875 pango_layout_get_size (font->layout, &w, &h);
884 xr_draw_title (struct xr_driver *xr, const char *title,
885 int title_width, int title_height)
887 struct table_cell cell;
888 int bb[TABLE_N_AXES][2];
890 xr_init_caption_cell (title, &cell);
892 bb[H][1] = title_width;
894 bb[V][1] = title_height;
895 xr_draw_cell (xr, &cell, bb, bb);
898 struct output_driver_factory pdf_driver_factory =
899 { "pdf", "pspp.pdf", xr_pdf_create };
900 struct output_driver_factory ps_driver_factory =
901 { "ps", "pspp.ps", xr_ps_create };
902 struct output_driver_factory svg_driver_factory =
903 { "svg", "pspp.svg", xr_svg_create };
905 static const struct output_driver_class cairo_driver_class =
913 /* GUI rendering helpers. */
917 struct output_item *item;
920 struct render_page *page;
921 struct xr_driver *xr;
926 #define CHART_WIDTH 500
927 #define CHART_HEIGHT 375
932 xr_driver_create (cairo_t *cairo, struct string_map *options)
934 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
935 if (!xr_set_cairo (xr, cairo))
937 output_driver_destroy (&xr->driver);
943 /* Destroy XR, which should have been created with xr_driver_create(). Any
944 cairo_t added to XR is not destroyed, because it is owned by the client. */
946 xr_driver_destroy (struct xr_driver *xr)
951 output_driver_destroy (&xr->driver);
955 static struct xr_rendering *
956 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
958 struct table_item *table_item;
959 struct xr_rendering *r;
961 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
962 r = xr_rendering_create (xr, &table_item->output_item, cr);
963 table_item_unref (table_item);
969 xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
971 if (is_table_item (xr->item))
972 apply_options (xr->xr, o);
975 struct xr_rendering *
976 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
979 struct xr_rendering *r = NULL;
981 if (is_text_item (item))
982 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
984 else if (is_message_item (item))
986 const struct message_item *message_item = to_message_item (item);
987 const struct msg *msg = message_item_get_msg (message_item);
988 char *s = msg_to_string (msg, NULL);
989 r = xr_rendering_create_text (xr, s, cr);
992 else if (is_table_item (item))
994 r = xzalloc (sizeof *r);
995 r->item = output_item_ref (item);
997 xr_set_cairo (xr, cr);
998 r->page = xr_render_table_item (xr, to_table_item (item),
999 &r->title_width, &r->title_height);
1001 else if (is_chart_item (item))
1003 r = xzalloc (sizeof *r);
1004 r->item = output_item_ref (item);
1011 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
1013 if (is_table_item (r->item))
1015 int w0 = render_page_get_size (r->page, H);
1016 int w1 = r->title_width;
1017 *w = MAX (w0, w1) / XR_POINT;
1018 *h = (render_page_get_size (r->page, V) + r->title_height) / XR_POINT;
1027 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1028 double x, double y, double width, double height);
1030 /* Draws onto CR at least the region of R that is enclosed in (X,Y)-(X+W,Y+H),
1031 and possibly some additional parts. */
1033 xr_rendering_draw (struct xr_rendering *r, cairo_t *cr,
1034 int x, int y, int w, int h)
1036 if (is_table_item (r->item))
1038 struct xr_driver *xr = r->xr;
1040 xr_set_cairo (xr, cr);
1042 if (r->title_height > 0)
1045 xr_draw_title (xr, table_item_get_caption (to_table_item (r->item)),
1046 r->title_width, r->title_height);
1049 xr->y = r->title_height;
1050 render_page_draw_region (r->page,
1051 x * XR_POINT, (y * XR_POINT) - r->title_height,
1052 w * XR_POINT, h * XR_POINT);
1055 xr_draw_chart (to_chart_item (r->item), cr,
1056 0, 0, CHART_WIDTH, CHART_HEIGHT);
1060 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1061 double x, double y, double width, double height)
1063 struct xrchart_geometry geom;
1066 cairo_translate (cr, x, y + height);
1067 cairo_scale (cr, 1.0, -1.0);
1068 xrchart_geometry_init (cr, &geom, width, height);
1069 if (is_boxplot (chart_item))
1070 xrchart_draw_boxplot (chart_item, cr, &geom);
1071 else if (is_histogram_chart (chart_item))
1072 xrchart_draw_histogram (chart_item, cr, &geom);
1073 else if (is_np_plot_chart (chart_item))
1074 xrchart_draw_np_plot (chart_item, cr, &geom);
1075 else if (is_piechart (chart_item))
1076 xrchart_draw_piechart (chart_item, cr, &geom);
1077 else if (is_roc_chart (chart_item))
1078 xrchart_draw_roc (chart_item, cr, &geom);
1079 else if (is_scree (chart_item))
1080 xrchart_draw_scree (chart_item, cr, &geom);
1081 else if (is_spreadlevel_plot_chart (chart_item))
1082 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1085 xrchart_geometry_free (cr, &geom);
1091 xr_draw_png_chart (const struct chart_item *item,
1092 const char *file_name_template, int number,
1093 const struct xr_color *fg,
1094 const struct xr_color *bg
1097 const int width = 640;
1098 const int length = 480;
1100 cairo_surface_t *surface;
1101 cairo_status_t status;
1102 const char *number_pos;
1106 number_pos = strchr (file_name_template, '#');
1107 if (number_pos != NULL)
1108 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1109 file_name_template, number, number_pos + 1);
1111 file_name = xstrdup (file_name_template);
1113 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1114 cr = cairo_create (surface);
1116 cairo_set_source_rgb (cr, bg->red, bg->green, bg->blue);
1119 cairo_set_source_rgb (cr, fg->red, fg->green, fg->blue);
1121 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1123 status = cairo_surface_write_to_png (surface, file_name);
1124 if (status != CAIRO_STATUS_SUCCESS)
1125 msg (ME, _("error writing output file `%s': %s"),
1126 file_name, cairo_status_to_string (status));
1129 cairo_surface_destroy (surface);
1134 struct xr_table_state
1136 struct xr_render_fsm fsm;
1137 struct table_item *table_item;
1138 struct render_break x_break;
1139 struct render_break y_break;
1144 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1146 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1150 struct render_page *y_slice;
1153 while (!render_break_has_next (&ts->y_break))
1155 struct render_page *x_slice;
1157 render_break_destroy (&ts->y_break);
1158 if (!render_break_has_next (&ts->x_break))
1161 x_slice = render_break_next (&ts->x_break, xr->width);
1162 render_break_init (&ts->y_break, x_slice, V);
1165 space = xr->length - xr->y;
1166 if (render_break_next_size (&ts->y_break) > space)
1172 y_slice = render_break_next (&ts->y_break, space);
1173 if (ts->caption_height)
1176 xr_draw_title (xr, table_item_get_caption (ts->table_item),
1177 xr->width, ts->caption_height);
1179 xr->y += ts->caption_height;
1180 ts->caption_height = 0;
1184 render_page_draw (y_slice);
1185 xr->y += render_page_get_size (y_slice, V);
1186 render_page_unref (y_slice);
1191 xr_table_destroy (struct xr_render_fsm *fsm)
1193 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1195 table_item_unref (ts->table_item);
1196 render_break_destroy (&ts->x_break);
1197 render_break_destroy (&ts->y_break);
1201 static struct xr_render_fsm *
1202 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1204 struct xr_table_state *ts;
1205 struct render_page *page;
1208 ts = xmalloc (sizeof *ts);
1209 ts->fsm.render = xr_table_render;
1210 ts->fsm.destroy = xr_table_destroy;
1211 ts->table_item = table_item_ref (table_item);
1214 xr->y += xr->char_height;
1216 page = xr_render_table_item (xr, table_item,
1217 &caption_width, &ts->caption_height);
1218 xr->params->size[V] = xr->length - ts->caption_height;
1220 render_break_init (&ts->x_break, page, H);
1221 render_break_init_empty (&ts->y_break);
1226 struct xr_chart_state
1228 struct xr_render_fsm fsm;
1229 struct chart_item *chart_item;
1233 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1235 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1240 if (xr->cairo != NULL)
1241 xr_draw_chart (cs->chart_item, xr->cairo, 0.0, 0.0,
1242 xr_to_pt (xr->width), xr_to_pt (xr->length));
1249 xr_chart_destroy (struct xr_render_fsm *fsm)
1251 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1253 chart_item_unref (cs->chart_item);
1257 static struct xr_render_fsm *
1258 xr_render_chart (const struct chart_item *chart_item)
1260 struct xr_chart_state *cs;
1262 cs = xmalloc (sizeof *cs);
1263 cs->fsm.render = xr_chart_render;
1264 cs->fsm.destroy = xr_chart_destroy;
1265 cs->chart_item = chart_item_ref (chart_item);
1271 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1277 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1279 /* Nothing to do. */
1282 static struct xr_render_fsm *
1283 xr_render_eject (void)
1285 static struct xr_render_fsm eject_renderer =
1291 return &eject_renderer;
1294 static struct xr_render_fsm *
1295 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1297 struct table_item *table_item;
1298 struct xr_render_fsm *fsm;
1300 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
1301 fsm = xr_render_table (xr, table_item);
1302 table_item_unref (table_item);
1307 static struct xr_render_fsm *
1308 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1310 enum text_item_type type = text_item_get_type (text_item);
1311 const char *text = text_item_get_text (text_item);
1315 case TEXT_ITEM_TITLE:
1317 xr->title = xstrdup (text);
1320 case TEXT_ITEM_SUBTITLE:
1321 free (xr->subtitle);
1322 xr->subtitle = xstrdup (text);
1325 case TEXT_ITEM_COMMAND_CLOSE:
1328 case TEXT_ITEM_BLANK_LINE:
1330 xr->y += xr->char_height;
1333 case TEXT_ITEM_EJECT_PAGE:
1335 return xr_render_eject ();
1339 return xr_create_text_renderer (xr, text);
1345 static struct xr_render_fsm *
1346 xr_render_message (struct xr_driver *xr,
1347 const struct message_item *message_item)
1349 const struct msg *msg = message_item_get_msg (message_item);
1350 struct xr_render_fsm *fsm;
1353 s = msg_to_string (msg, xr->command_name);
1354 fsm = xr_create_text_renderer (xr, s);
1360 static struct xr_render_fsm *
1361 xr_render_output_item (struct xr_driver *xr,
1362 const struct output_item *output_item)
1364 if (is_table_item (output_item))
1365 return xr_render_table (xr, to_table_item (output_item));
1366 else if (is_chart_item (output_item))
1367 return xr_render_chart (to_chart_item (output_item));
1368 else if (is_text_item (output_item))
1369 return xr_render_text (xr, to_text_item (output_item));
1370 else if (is_message_item (output_item))
1371 return xr_render_message (xr, to_message_item (output_item));