1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2012 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>
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 /* Measurements as we present to the rest of PSPP. */
69 #define XR_POINT PANGO_SCALE
70 #define XR_INCH (XR_POINT * 72)
72 /* Conversions to and from points. */
76 return x / (double) XR_POINT;
96 /* A font for use with Cairo. */
99 PangoFontDescription *desc;
103 /* An output item whose rendering is in progress. */
106 /* Renders as much of itself as it can on the current page. Returns true
107 if rendering is complete, false if the output item needs another
109 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
111 /* Destroys the output item. */
112 void (*destroy) (struct xr_render_fsm *);
115 /* Cairo output driver. */
118 struct output_driver driver;
120 /* User parameters. */
121 struct xr_font fonts[XR_N_FONTS];
123 int width; /* Page width minus margins. */
124 int length; /* Page length minus margins and header. */
126 int left_margin; /* Left margin in XR units. */
127 int right_margin; /* Right margin in XR units. */
128 int top_margin; /* Top margin in XR units. */
129 int bottom_margin; /* Bottom margin in XR units. */
131 int line_gutter; /* Space around lines. */
132 int line_space; /* Space between lines. */
133 int line_width; /* Width of lines. */
135 double bg_red, bg_green, bg_blue; /* Background color */
136 double fg_red, fg_green, fg_blue; /* Foreground color */
138 /* Internal state. */
139 struct render_params *params;
140 int char_width, char_height;
145 int page_number; /* Current page number. */
147 struct xr_render_fsm *fsm;
150 static const struct output_driver_class cairo_driver_class;
152 static void xr_driver_destroy_fsm (struct xr_driver *);
153 static void xr_driver_run_fsm (struct xr_driver *);
155 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
156 enum render_line_style styles[TABLE_N_AXES][2]);
157 static void xr_measure_cell_width (void *, const struct table_cell *,
159 static int xr_measure_cell_height (void *, const struct table_cell *,
161 static void xr_draw_cell (void *, const struct table_cell *,
162 int bb[TABLE_N_AXES][2],
163 int clip[TABLE_N_AXES][2]);
165 static struct xr_render_fsm *xr_render_output_item (
166 struct xr_driver *, const struct output_item *);
168 /* Output driver basics. */
170 static struct xr_driver *
171 xr_driver_cast (struct output_driver *driver)
173 assert (driver->class == &cairo_driver_class);
174 return UP_CAST (driver, struct xr_driver, driver);
177 static struct driver_option *
178 opt (struct output_driver *d, struct string_map *options, const char *key,
179 const char *default_value)
181 return driver_option_get (d, options, key, default_value);
184 /* Parse color information specified by KEY into {RED,GREEN,BLUE}.
185 Currently, the input string must be of the form "#RRRRGGGGBBBB"
186 Future implementations might allow things like "yellow" and
187 "sky-blue-ultra-brown"
190 parse_color (struct output_driver *d, struct string_map *options,
191 const char *key, const char *default_value,
192 double *dred, double *dgreen, double *dblue)
194 int red, green, blue;
195 char *string = parse_string (opt (d, options, key, default_value));
197 if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue))
199 /* If the parsed option string fails, then try the default value */
200 if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue))
202 /* ... and if that fails set everything to zero */
203 red = green = blue = 0;
209 /* Convert 16 bit ints to float */
210 *dred = red / (double) 0xFFFF;
211 *dgreen = green / (double) 0xFFFF;
212 *dblue = blue / (double) 0xFFFF;
215 static PangoFontDescription *
216 parse_font (struct output_driver *d, struct string_map *options,
217 const char *key, const char *default_value,
220 PangoFontDescription *desc;
223 /* Parse KEY as a font description. */
224 string = parse_string (opt (d, options, key, default_value));
225 desc = pango_font_description_from_string (string);
228 error (0, 0, _("`%s': bad font specification"), string);
230 /* Fall back to DEFAULT_VALUE, which had better be a valid font
232 desc = pango_font_description_from_string (default_value);
233 assert (desc != NULL);
237 /* If the font description didn't include an explicit font size, then set it
238 to DEFAULT_POINTS. */
239 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
240 pango_font_description_set_size (desc,
241 default_points / 1000.0 * PANGO_SCALE);
248 apply_options (struct xr_driver *xr, struct string_map *o)
250 struct output_driver *d = &xr->driver;
252 int paper_width, paper_length;
254 int font_points = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
255 xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
257 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
258 "serif", font_points);
259 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
260 "serif italic", font_points);
262 xr->line_gutter = XR_POINT;
263 xr->line_space = XR_POINT;
264 xr->line_width = XR_POINT / 2;
267 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg_red, &xr->bg_green, &xr->bg_blue);
268 parse_color (d, o, "foreground-color", "#000000000000", &xr->fg_red, &xr->fg_green, &xr->fg_blue);
270 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
271 xr->left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
272 xr->right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
273 xr->top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
274 xr->bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
276 xr->width = paper_width - xr->left_margin - xr->right_margin;
277 xr->length = paper_length - xr->top_margin - xr->bottom_margin;
280 static struct xr_driver *
281 xr_allocate (const char *name, int device_type, struct string_map *o)
283 struct xr_driver *xr = xzalloc (sizeof *xr);
284 struct output_driver *d = &xr->driver;
286 output_driver_init (d, &cairo_driver_class, name, device_type);
288 apply_options (xr, o);
294 xr_is_72dpi (cairo_t *cr)
296 cairo_surface_type_t type;
297 cairo_surface_t *surface;
299 surface = cairo_get_target (cr);
300 type = cairo_surface_get_type (surface);
301 return type == CAIRO_SURFACE_TYPE_PDF || type == CAIRO_SURFACE_TYPE_PS;
305 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
307 PangoContext *context;
313 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
315 map = pango_cairo_font_map_get_default ();
316 context = pango_cairo_font_map_create_context (PANGO_CAIRO_FONT_MAP (map));
317 if (xr_is_72dpi (cairo))
319 /* Pango seems to always scale fonts according to the DPI specified
320 in the font map, even if the surface has a real DPI. The default
321 DPI is 96, so on a 72 DPI device fonts end up being 96/72 = 133%
322 of their desired size. We deal with this by fixing the resolution
323 here. Presumably there is a better solution, but what? */
324 pango_cairo_context_set_resolution (context, 72.0);
329 for (i = 0; i < XR_N_FONTS; i++)
331 struct xr_font *font = &xr->fonts[i];
332 int char_width, char_height;
334 font->layout = pango_layout_new (context);
335 pango_layout_set_font_description (font->layout, font->desc);
337 pango_layout_set_text (font->layout, "0", 1);
338 pango_layout_get_size (font->layout, &char_width, &char_height);
339 xr->char_width = MAX (xr->char_width, char_width);
340 xr->char_height = MAX (xr->char_height, char_height);
343 g_object_unref (G_OBJECT (context));
345 if (xr->params == NULL)
347 int single_width, double_width;
349 xr->params = xmalloc (sizeof *xr->params);
350 xr->params->draw_line = xr_draw_line;
351 xr->params->measure_cell_width = xr_measure_cell_width;
352 xr->params->measure_cell_height = xr_measure_cell_height;
353 xr->params->draw_cell = xr_draw_cell;
354 xr->params->aux = xr;
355 xr->params->size[H] = xr->width;
356 xr->params->size[V] = xr->length;
357 xr->params->font_size[H] = xr->char_width;
358 xr->params->font_size[V] = xr->char_height;
360 single_width = 2 * xr->line_gutter + xr->line_width;
361 double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
362 for (i = 0; i < TABLE_N_AXES; i++)
364 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
365 xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
366 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
370 cairo_set_source_rgb (xr->cairo, xr->fg_red, xr->fg_green, xr->fg_blue);
375 static struct output_driver *
376 xr_create (const char *file_name, enum settings_output_devices device_type,
377 struct string_map *o, enum xr_output_type file_type)
379 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
380 struct output_driver *d;
381 struct xr_driver *xr;
382 cairo_surface_t *surface;
383 cairo_status_t status;
384 double width_pt, length_pt;
386 xr = xr_allocate (file_name, device_type, o);
389 width_pt = (xr->width + xr->left_margin + xr->right_margin) / 1000.0;
390 length_pt = (xr->length + xr->top_margin + xr->bottom_margin) / 1000.0;
391 if (file_type == XR_PDF)
392 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
393 else if (file_type == XR_PS)
394 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
395 else if (file_type == XR_SVG)
396 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
400 status = cairo_surface_status (surface);
401 if (status != CAIRO_STATUS_SUCCESS)
403 error (0, 0, _("error opening output file `%s': %s"),
404 file_name, cairo_status_to_string (status));
405 cairo_surface_destroy (surface);
409 xr->cairo = cairo_create (surface);
410 cairo_surface_destroy (surface);
412 if (!xr_set_cairo (xr, xr->cairo))
415 cairo_save (xr->cairo);
416 xr_driver_next_page (xr, xr->cairo);
418 if (xr->width / xr->char_width < MIN_WIDTH)
420 error (0, 0, _("The defined page is not wide enough to hold at least %d "
421 "characters in the default font. In fact, there's only "
422 "room for %d characters."),
424 xr->width / xr->char_width);
428 if (xr->length / xr->char_height < MIN_LENGTH)
430 error (0, 0, _("The defined page is not long enough to hold at least %d "
431 "lines in the default font. In fact, there's only "
432 "room for %d lines."),
434 xr->length / xr->char_height);
441 output_driver_destroy (&xr->driver);
445 static struct output_driver *
446 xr_pdf_create (const char *file_name, enum settings_output_devices device_type,
447 struct string_map *o)
449 return xr_create (file_name, device_type, o, XR_PDF);
452 static struct output_driver *
453 xr_ps_create (const char *file_name, enum settings_output_devices device_type,
454 struct string_map *o)
456 return xr_create (file_name, device_type, o, XR_PS);
459 static struct output_driver *
460 xr_svg_create (const char *file_name, enum settings_output_devices device_type,
461 struct string_map *o)
463 return xr_create (file_name, device_type, o, XR_SVG);
467 xr_destroy (struct output_driver *driver)
469 struct xr_driver *xr = xr_driver_cast (driver);
472 xr_driver_destroy_fsm (xr);
474 if (xr->cairo != NULL)
476 cairo_status_t status;
478 cairo_surface_finish (cairo_get_target (xr->cairo));
479 status = cairo_status (xr->cairo);
480 if (status != CAIRO_STATUS_SUCCESS)
481 error (0, 0, _("error drawing output for %s driver: %s"),
482 output_driver_get_name (driver),
483 cairo_status_to_string (status));
484 cairo_destroy (xr->cairo);
487 free (xr->command_name);
488 for (i = 0; i < XR_N_FONTS; i++)
490 struct xr_font *font = &xr->fonts[i];
492 if (font->desc != NULL)
493 pango_font_description_free (font->desc);
494 if (font->layout != NULL)
495 g_object_unref (font->layout);
503 xr_flush (struct output_driver *driver)
505 struct xr_driver *xr = xr_driver_cast (driver);
507 cairo_surface_flush (cairo_get_target (xr->cairo));
511 xr_init_caption_cell (const char *caption, struct table_cell *cell)
513 cell->contents = caption;
514 cell->options = TAB_LEFT;
515 cell->destructor = NULL;
518 static struct render_page *
519 xr_render_table_item (struct xr_driver *xr, const struct table_item *item,
520 int *caption_widthp, int *caption_heightp)
522 const char *caption = table_item_get_caption (item);
526 /* XXX doesn't do well with very large captions */
527 int min_width, max_width;
528 struct table_cell cell;
530 xr_init_caption_cell (caption, &cell);
532 xr_measure_cell_width (xr, &cell, &min_width, &max_width);
533 *caption_widthp = MIN (max_width, xr->width);
534 *caption_heightp = xr_measure_cell_height (xr, &cell, *caption_widthp);
537 *caption_heightp = 0;
539 return render_page_create (xr->params, table_item_get_table (item));
543 xr_submit (struct output_driver *driver, const struct output_item *output_item)
545 struct xr_driver *xr = xr_driver_cast (driver);
547 xr_driver_output_item (xr, output_item);
548 while (xr_driver_need_new_page (xr))
550 cairo_restore (xr->cairo);
551 cairo_show_page (xr->cairo);
552 cairo_save (xr->cairo);
553 xr_driver_next_page (xr, xr->cairo);
557 /* Functions for rendering a series of output items to a series of Cairo
558 contexts, with pagination.
560 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
561 its underlying implementation.
563 See the big comment in cairo.h for intended usage. */
565 /* Gives new page CAIRO to XR for output. CAIRO may be null to skip actually
566 rendering the page (which might be useful to find out how many pages an
567 output document has without actually rendering it). */
569 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
574 cairo_set_source_rgb (cairo, xr->bg_red, xr->bg_green, xr->bg_blue);
575 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
577 cairo_restore (cairo);
579 cairo_translate (cairo,
580 xr_to_pt (xr->left_margin),
581 xr_to_pt (xr->top_margin));
587 xr_driver_run_fsm (xr);
590 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
591 rendering a previous output item, that is, only if xr_driver_need_new_page()
594 xr_driver_output_item (struct xr_driver *xr,
595 const struct output_item *output_item)
597 assert (xr->fsm == NULL);
598 xr->fsm = xr_render_output_item (xr, output_item);
599 xr_driver_run_fsm (xr);
602 /* Returns true if XR is in the middle of rendering an output item and needs a
603 new page to be appended using xr_driver_next_page() to make progress,
606 xr_driver_need_new_page (const struct xr_driver *xr)
608 return xr->fsm != NULL;
611 /* Returns true if the current page doesn't have any content yet. */
613 xr_driver_is_page_blank (const struct xr_driver *xr)
619 xr_driver_destroy_fsm (struct xr_driver *xr)
623 xr->fsm->destroy (xr->fsm);
629 xr_driver_run_fsm (struct xr_driver *xr)
631 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
632 xr_driver_destroy_fsm (xr);
636 xr_layout_cell (struct xr_driver *, const struct table_cell *,
637 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
638 PangoWrapMode, int *width, int *height);
641 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
643 cairo_new_path (xr->cairo);
644 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
645 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
646 cairo_stroke (xr->cairo);
649 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
650 shortening it to X0...X1 if SHORTEN is true.
651 Draws a horizontal line X1...X3 at Y if RIGHT says so,
652 shortening it to X2...X3 if SHORTEN is true. */
654 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
655 enum render_line_style left, enum render_line_style right,
658 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
659 dump_line (xr, x0, y, x3, y);
662 if (left != RENDER_LINE_NONE)
663 dump_line (xr, x0, y, shorten ? x1 : x2, y);
664 if (right != RENDER_LINE_NONE)
665 dump_line (xr, shorten ? x2 : x1, y, x3, y);
669 /* Draws a vertical line Y0...Y2 at X if TOP says so,
670 shortening it to Y0...Y1 if SHORTEN is true.
671 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
672 shortening it to Y2...Y3 if SHORTEN is true. */
674 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
675 enum render_line_style top, enum render_line_style bottom,
678 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
679 dump_line (xr, x, y0, x, y3);
682 if (top != RENDER_LINE_NONE)
683 dump_line (xr, x, y0, x, shorten ? y1 : y2);
684 if (bottom != RENDER_LINE_NONE)
685 dump_line (xr, x, shorten ? y2 : y1, x, y3);
690 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
691 enum render_line_style styles[TABLE_N_AXES][2])
693 const int x0 = bb[H][0];
694 const int y0 = bb[V][0];
695 const int x3 = bb[H][1];
696 const int y3 = bb[V][1];
697 const int top = styles[H][0];
698 const int left = styles[V][0];
699 const int bottom = styles[H][1];
700 const int right = styles[V][1];
702 /* The algorithm here is somewhat subtle, to allow it to handle
703 all the kinds of intersections that we need.
705 Three additional ordinates are assigned along the x axis. The
706 first is xc, midway between x0 and x3. The others are x1 and
707 x2; for a single vertical line these are equal to xc, and for
708 a double vertical line they are the ordinates of the left and
709 right half of the double line.
711 yc, y1, and y2 are assigned similarly along the y axis.
713 The following diagram shows the coordinate system and output
714 for double top and bottom lines, single left line, and no
718 y0 ________________________
724 y1 = y2 = yc |######### # |
729 y3 |________#_____#_______|
731 struct xr_driver *xr = xr_;
733 /* Offset from center of each line in a pair of double lines. */
734 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
736 /* Are the lines along each axis single or double?
737 (It doesn't make sense to have different kinds of line on the
738 same axis, so we don't try to gracefully handle that case.) */
739 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
740 bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE;
742 /* When horizontal lines are doubled,
743 the left-side line along y1 normally runs from x0 to x2,
744 and the right-side line along y1 from x3 to x1.
745 If the top-side line is also doubled, we shorten the y1 lines,
746 so that the left-side line runs only to x1,
747 and the right-side line only to x2.
748 Otherwise, the horizontal line at y = y1 below would cut off
749 the intersection, which looks ugly:
751 y0 ________________________
756 y1 |######### ########|
759 y2 |######################|
762 y3 |______________________|
763 It is more of a judgment call when the horizontal line is
764 single. We actually choose to cut off the line anyhow, as
765 shown in the first diagram above.
767 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
768 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
769 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
770 int horz_line_ofs = double_vert ? double_line_ofs : 0;
771 int xc = (x0 + x3) / 2;
772 int x1 = xc - horz_line_ofs;
773 int x2 = xc + horz_line_ofs;
775 bool shorten_x1_lines = left == RENDER_LINE_DOUBLE;
776 bool shorten_x2_lines = right == RENDER_LINE_DOUBLE;
777 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
778 int vert_line_ofs = double_horz ? double_line_ofs : 0;
779 int yc = (y0 + y3) / 2;
780 int y1 = yc - vert_line_ofs;
781 int y2 = yc + vert_line_ofs;
784 horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line);
787 horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines);
788 horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines);
792 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
795 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
796 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
801 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
802 int *min_width, int *max_width)
804 struct xr_driver *xr = xr_;
805 int bb[TABLE_N_AXES][2];
806 int clip[TABLE_N_AXES][2];
813 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
814 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, max_width, &h);
817 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, min_width, &h);
821 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
823 struct xr_driver *xr = xr_;
824 int bb[TABLE_N_AXES][2];
825 int clip[TABLE_N_AXES][2];
832 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
833 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
838 xr_draw_cell (void *xr_, const struct table_cell *cell,
839 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
841 struct xr_driver *xr = xr_;
844 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
848 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
849 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
850 PangoWrapMode wrap, int *width, int *height)
852 struct xr_font *font;
854 font = (cell->options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
855 : cell->options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
856 : &xr->fonts[XR_FONT_PROPORTIONAL]);
858 pango_layout_set_text (font->layout, cell->contents, -1);
860 pango_layout_set_alignment (
862 ((cell->options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
863 : (cell->options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
864 : PANGO_ALIGN_CENTER));
865 pango_layout_set_width (font->layout,
866 bb[H][1] == INT_MAX ? -1 : bb[H][1] - bb[H][0]);
867 pango_layout_set_wrap (font->layout, wrap);
869 if (clip[H][0] != clip[H][1])
871 cairo_save (xr->cairo);
873 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
875 double x0 = xr_to_pt (clip[H][0]);
876 double y0 = xr_to_pt (clip[V][0] + xr->y);
877 double x1 = xr_to_pt (clip[H][1]);
878 double y1 = xr_to_pt (clip[V][1] + xr->y);
880 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
881 cairo_clip (xr->cairo);
884 cairo_translate (xr->cairo,
886 xr_to_pt (bb[V][0] + xr->y));
887 pango_cairo_show_layout (xr->cairo, font->layout);
888 cairo_restore (xr->cairo);
891 if (width != NULL || height != NULL)
895 pango_layout_get_size (font->layout, &w, &h);
904 xr_draw_title (struct xr_driver *xr, const char *title,
905 int title_width, int title_height)
907 struct table_cell cell;
908 int bb[TABLE_N_AXES][2];
910 xr_init_caption_cell (title, &cell);
912 bb[H][1] = title_width;
914 bb[V][1] = title_height;
915 xr_draw_cell (xr, &cell, bb, bb);
918 struct output_driver_factory pdf_driver_factory = { "pdf", xr_pdf_create };
919 struct output_driver_factory ps_driver_factory = { "ps", xr_ps_create };
920 struct output_driver_factory svg_driver_factory = { "svg", xr_svg_create };
922 static const struct output_driver_class cairo_driver_class =
930 /* GUI rendering helpers. */
934 struct output_item *item;
937 struct render_page *page;
938 struct xr_driver *xr;
943 #define CHART_WIDTH 500
944 #define CHART_HEIGHT 375
949 xr_driver_create (cairo_t *cairo, struct string_map *options)
951 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
952 if (!xr_set_cairo (xr, cairo))
954 output_driver_destroy (&xr->driver);
960 /* Destroy XR, which should have been created with xr_driver_create(). Any
961 cairo_t added to XR is not destroyed, because it is owned by the client. */
963 xr_driver_destroy (struct xr_driver *xr)
968 output_driver_destroy (&xr->driver);
972 static struct xr_rendering *
973 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
975 struct table_item *table_item;
976 struct xr_rendering *r;
978 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
979 r = xr_rendering_create (xr, &table_item->output_item, cr);
980 table_item_unref (table_item);
986 xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
988 if (is_table_item (xr->item))
989 apply_options (xr->xr, o);
992 struct xr_rendering *
993 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
996 struct xr_rendering *r = NULL;
998 if (is_text_item (item))
999 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
1001 else if (is_message_item (item))
1003 const struct message_item *message_item = to_message_item (item);
1004 const struct msg *msg = message_item_get_msg (message_item);
1005 char *s = msg_to_string (msg, NULL);
1006 r = xr_rendering_create_text (xr, s, cr);
1009 else if (is_table_item (item))
1011 r = xzalloc (sizeof *r);
1012 r->item = output_item_ref (item);
1014 xr_set_cairo (xr, cr);
1015 r->page = xr_render_table_item (xr, to_table_item (item),
1016 &r->title_width, &r->title_height);
1018 else if (is_chart_item (item))
1020 r = xzalloc (sizeof *r);
1021 r->item = output_item_ref (item);
1028 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
1030 if (is_table_item (r->item))
1032 int w0 = render_page_get_size (r->page, H);
1033 int w1 = r->title_width;
1034 *w = MAX (w0, w1) / 1024;
1035 *h = (render_page_get_size (r->page, V) + r->title_height) / 1024;
1044 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1045 double x, double y, double width, double height);
1047 /* Draws onto CR at least the region of R that is enclosed in (X,Y)-(X+W,Y+H),
1048 and possibly some additional parts. */
1050 xr_rendering_draw (struct xr_rendering *r, cairo_t *cr,
1051 int x, int y, int w, int h)
1053 if (is_table_item (r->item))
1055 struct xr_driver *xr = r->xr;
1057 xr_set_cairo (xr, cr);
1059 if (r->title_height > 0)
1062 xr_draw_title (xr, table_item_get_caption (to_table_item (r->item)),
1063 r->title_width, r->title_height);
1066 xr->y = r->title_height;
1067 render_page_draw_region (r->page, x * 1024, (y * 1024) - r->title_height,
1068 w * 1024, h * 1024);
1071 xr_draw_chart (to_chart_item (r->item), cr,
1072 0, 0, CHART_WIDTH, CHART_HEIGHT);
1076 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1077 double x, double y, double width, double height)
1079 struct xrchart_geometry geom;
1082 cairo_translate (cr, x, y + height);
1083 cairo_scale (cr, 1.0, -1.0);
1084 xrchart_geometry_init (cr, &geom, width, height);
1085 if (is_boxplot (chart_item))
1086 xrchart_draw_boxplot (chart_item, cr, &geom);
1087 else if (is_histogram_chart (chart_item))
1088 xrchart_draw_histogram (chart_item, cr, &geom);
1089 else if (is_np_plot_chart (chart_item))
1090 xrchart_draw_np_plot (chart_item, cr, &geom);
1091 else if (is_piechart (chart_item))
1092 xrchart_draw_piechart (chart_item, cr, &geom);
1093 else if (is_roc_chart (chart_item))
1094 xrchart_draw_roc (chart_item, cr, &geom);
1095 else if (is_scree (chart_item))
1096 xrchart_draw_scree (chart_item, cr, &geom);
1097 else if (is_spreadlevel_plot_chart (chart_item))
1098 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1101 xrchart_geometry_free (cr, &geom);
1107 xr_draw_png_chart (const struct chart_item *item,
1108 const char *file_name_template, int number)
1110 const int width = 640;
1111 const int length = 480;
1113 cairo_surface_t *surface;
1114 cairo_status_t status;
1115 const char *number_pos;
1119 number_pos = strchr (file_name_template, '#');
1120 if (number_pos != NULL)
1121 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1122 file_name_template, number, number_pos + 1);
1124 file_name = xstrdup (file_name_template);
1126 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1127 cr = cairo_create (surface);
1129 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0);
1131 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1133 status = cairo_surface_write_to_png (surface, file_name);
1134 if (status != CAIRO_STATUS_SUCCESS)
1135 error (0, 0, _("error writing output file `%s': %s"),
1136 file_name, cairo_status_to_string (status));
1139 cairo_surface_destroy (surface);
1144 struct xr_table_state
1146 struct xr_render_fsm fsm;
1147 struct table_item *table_item;
1148 struct render_break x_break;
1149 struct render_break y_break;
1154 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1156 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1160 struct render_page *y_slice;
1163 while (!render_break_has_next (&ts->y_break))
1165 struct render_page *x_slice;
1167 render_break_destroy (&ts->y_break);
1168 if (!render_break_has_next (&ts->x_break))
1171 x_slice = render_break_next (&ts->x_break, xr->width);
1172 render_break_init (&ts->y_break, x_slice, V);
1175 space = xr->length - xr->y;
1176 if (render_break_next_size (&ts->y_break) > space)
1182 y_slice = render_break_next (&ts->y_break, space);
1183 if (ts->caption_height)
1186 xr_draw_title (xr, table_item_get_caption (ts->table_item),
1187 xr->width, ts->caption_height);
1189 xr->y += ts->caption_height;
1190 ts->caption_height = 0;
1194 render_page_draw (y_slice);
1195 xr->y += render_page_get_size (y_slice, V);
1196 render_page_unref (y_slice);
1201 xr_table_destroy (struct xr_render_fsm *fsm)
1203 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1205 table_item_unref (ts->table_item);
1206 render_break_destroy (&ts->x_break);
1207 render_break_destroy (&ts->y_break);
1211 static struct xr_render_fsm *
1212 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1214 struct xr_table_state *ts;
1215 struct render_page *page;
1218 ts = xmalloc (sizeof *ts);
1219 ts->fsm.render = xr_table_render;
1220 ts->fsm.destroy = xr_table_destroy;
1221 ts->table_item = table_item_ref (table_item);
1224 xr->y += xr->char_height;
1226 page = xr_render_table_item (xr, table_item,
1227 &caption_width, &ts->caption_height);
1228 xr->params->size[V] = xr->length - ts->caption_height;
1230 render_break_init (&ts->x_break, page, H);
1231 render_break_init_empty (&ts->y_break);
1236 struct xr_chart_state
1238 struct xr_render_fsm fsm;
1239 struct chart_item *chart_item;
1243 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1245 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1250 if (xr->cairo != NULL)
1251 xr_draw_chart (cs->chart_item, xr->cairo, 0.0, 0.0,
1252 xr_to_pt (xr->width), xr_to_pt (xr->length));
1259 xr_chart_destroy (struct xr_render_fsm *fsm)
1261 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1263 chart_item_unref (cs->chart_item);
1267 static struct xr_render_fsm *
1268 xr_render_chart (const struct chart_item *chart_item)
1270 struct xr_chart_state *cs;
1272 cs = xmalloc (sizeof *cs);
1273 cs->fsm.render = xr_chart_render;
1274 cs->fsm.destroy = xr_chart_destroy;
1275 cs->chart_item = chart_item_ref (chart_item);
1281 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1287 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1289 /* Nothing to do. */
1292 static struct xr_render_fsm *
1293 xr_render_eject (void)
1295 static struct xr_render_fsm eject_renderer =
1301 return &eject_renderer;
1304 static struct xr_render_fsm *
1305 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1307 struct table_item *table_item;
1308 struct xr_render_fsm *fsm;
1310 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
1311 fsm = xr_render_table (xr, table_item);
1312 table_item_unref (table_item);
1317 static struct xr_render_fsm *
1318 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1320 enum text_item_type type = text_item_get_type (text_item);
1321 const char *text = text_item_get_text (text_item);
1325 case TEXT_ITEM_TITLE:
1327 xr->title = xstrdup (text);
1330 case TEXT_ITEM_SUBTITLE:
1331 free (xr->subtitle);
1332 xr->subtitle = xstrdup (text);
1335 case TEXT_ITEM_COMMAND_CLOSE:
1338 case TEXT_ITEM_BLANK_LINE:
1340 xr->y += xr->char_height;
1343 case TEXT_ITEM_EJECT_PAGE:
1345 return xr_render_eject ();
1349 return xr_create_text_renderer (xr, text);
1355 static struct xr_render_fsm *
1356 xr_render_message (struct xr_driver *xr,
1357 const struct message_item *message_item)
1359 const struct msg *msg = message_item_get_msg (message_item);
1360 struct xr_render_fsm *fsm;
1363 s = msg_to_string (msg, xr->command_name);
1364 fsm = xr_create_text_renderer (xr, s);
1370 static struct xr_render_fsm *
1371 xr_render_output_item (struct xr_driver *xr,
1372 const struct output_item *output_item)
1374 if (is_table_item (output_item))
1375 return xr_render_table (xr, to_table_item (output_item));
1376 else if (is_chart_item (output_item))
1377 return xr_render_chart (to_chart_item (output_item));
1378 else if (is_text_item (output_item))
1379 return xr_render_text (xr, to_text_item (output_item));
1380 else if (is_message_item (output_item))
1381 return xr_render_message (xr, to_message_item (output_item));