1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010 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/scree.h"
36 #include "output/driver-provider.h"
37 #include "output/message-item.h"
38 #include "output/options.h"
39 #include "output/render.h"
40 #include "output/tab.h"
41 #include "output/table-item.h"
42 #include "output/table.h"
43 #include "output/text-item.h"
45 #include <cairo/cairo-pdf.h>
46 #include <cairo/cairo-ps.h>
47 #include <cairo/cairo-svg.h>
48 #include <cairo/cairo.h>
49 #include <pango/pango-font.h>
50 #include <pango/pango-layout.h>
51 #include <pango/pango.h>
52 #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. */
68 #define XR_POINT PANGO_SCALE
69 #define XR_INCH (XR_POINT * 72)
71 /* Conversions to and from points. */
75 return x / (double) XR_POINT;
95 /* A font for use with Cairo. */
99 PangoFontDescription *desc;
101 PangoFontMetrics *metrics;
104 /* An output item whose rendering is in progress. */
107 /* Renders as much of itself as it can on the current page. Returns true
108 if rendering is complete, false if the output item needs another
110 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
112 /* Destroys the output item. */
113 void (*destroy) (struct xr_render_fsm *);
116 /* Cairo output driver. */
119 struct output_driver driver;
121 /* User parameters. */
122 bool headers; /* Draw headers at top of page? */
124 struct xr_font fonts[XR_N_FONTS];
125 int font_height; /* In XR units. */
127 int width; /* Page width minus margins. */
128 int length; /* Page length minus margins and header. */
130 int left_margin; /* Left margin in XR units. */
131 int right_margin; /* Right margin in XR units. */
132 int top_margin; /* Top margin in XR units. */
133 int bottom_margin; /* Bottom margin in XR units. */
135 int line_gutter; /* Space around lines. */
136 int line_space; /* Space between lines. */
137 int line_width; /* Width of lines. */
139 /* Internal state. */
140 struct render_params *params;
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 draw_headers (struct xr_driver *);
153 static void xr_driver_destroy_fsm (struct xr_driver *);
154 static void xr_driver_run_fsm (struct xr_driver *);
156 static bool load_font (struct xr_driver *, struct xr_font *);
157 static void free_font (struct xr_font *);
159 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
160 enum render_line_style styles[TABLE_N_AXES][2]);
161 static void xr_measure_cell_width (void *, const struct table_cell *,
163 static int xr_measure_cell_height (void *, const struct table_cell *,
165 static void xr_draw_cell (void *, const struct table_cell *,
166 int bb[TABLE_N_AXES][2],
167 int clip[TABLE_N_AXES][2]);
169 static struct xr_render_fsm *xr_render_output_item (
170 struct xr_driver *, const struct output_item *);
172 /* Output driver basics. */
174 static struct xr_driver *
175 xr_driver_cast (struct output_driver *driver)
177 assert (driver->class == &cairo_driver_class);
178 return UP_CAST (driver, struct xr_driver, driver);
181 static struct driver_option *
182 opt (struct output_driver *d, struct string_map *options, const char *key,
183 const char *default_value)
185 return driver_option_get (d, options, key, default_value);
188 static struct xr_driver *
189 xr_allocate (const char *name, int device_type, struct string_map *o)
191 struct output_driver *d;
192 struct xr_driver *xr;
194 xr = xzalloc (sizeof *xr);
196 output_driver_init (d, &cairo_driver_class, name, device_type);
198 xr->font_height = XR_POINT * 10;
199 xr->fonts[XR_FONT_FIXED].string
200 = parse_string (opt (d, o, "fixed-font", "monospace"));
201 xr->fonts[XR_FONT_PROPORTIONAL].string
202 = parse_string (opt (d, o, "prop-font", "serif"));
203 xr->fonts[XR_FONT_EMPHASIS].string
204 = parse_string (opt (d, o, "emph-font", "serif italic"));
205 xr->line_gutter = XR_POINT;
206 xr->line_space = XR_POINT;
207 xr->line_width = XR_POINT / 2;
214 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
220 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
222 for (i = 0; i < XR_N_FONTS; i++)
223 if (!load_font (xr, &xr->fonts[i]))
226 if (xr->params == NULL)
228 int single_width, double_width;
230 xr->params = xmalloc (sizeof *xr->params);
231 xr->params->draw_line = xr_draw_line;
232 xr->params->measure_cell_width = xr_measure_cell_width;
233 xr->params->measure_cell_height = xr_measure_cell_height;
234 xr->params->draw_cell = xr_draw_cell;
235 xr->params->aux = xr;
236 xr->params->size[H] = xr->width;
237 xr->params->size[V] = xr->length;
238 xr->params->font_size[H] = xr->font_height / 2; /* XXX */
239 xr->params->font_size[V] = xr->font_height;
241 single_width = 2 * xr->line_gutter + xr->line_width;
242 double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
243 for (i = 0; i < TABLE_N_AXES; i++)
245 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
246 xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
247 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
254 static struct output_driver *
255 xr_create (const char *file_name, enum settings_output_devices device_type,
256 struct string_map *o, enum xr_output_type file_type)
258 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
259 struct output_driver *d;
260 struct xr_driver *xr;
261 cairo_surface_t *surface;
262 cairo_status_t status;
263 double width_pt, length_pt;
264 int paper_width, paper_length;
266 xr = xr_allocate (file_name, device_type, o);
269 xr->headers = parse_boolean (opt (d, o, "headers", "true"));
271 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
272 xr->left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
273 xr->right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
274 xr->top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
275 xr->bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
278 xr->top_margin += 3 * xr->font_height;
279 xr->width = paper_width - xr->left_margin - xr->right_margin;
280 xr->length = paper_length - xr->top_margin - xr->bottom_margin;
282 width_pt = paper_width / 1000.0;
283 length_pt = paper_length / 1000.0;
284 if (file_type == XR_PDF)
285 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
286 else if (file_type == XR_PS)
287 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
288 else if (file_type == XR_SVG)
289 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
293 status = cairo_surface_status (surface);
294 if (status != CAIRO_STATUS_SUCCESS)
296 error (0, 0, _("error opening output file \"%s\": %s"),
297 file_name, cairo_status_to_string (status));
298 cairo_surface_destroy (surface);
302 xr->cairo = cairo_create (surface);
303 cairo_surface_destroy (surface);
305 cairo_translate (xr->cairo,
306 xr_to_pt (xr->left_margin),
307 xr_to_pt (xr->top_margin));
309 if (!xr_set_cairo (xr, xr->cairo))
312 if (xr->width / (xr->font_height / 2) < MIN_WIDTH)
314 error (0, 0, _("The defined page is not wide enough to hold at least %d "
315 "characters in the default font. In fact, there's only "
316 "room for %d characters."),
318 xr->width / (xr->font_height / 2));
322 if (xr->length / xr->font_height < MIN_LENGTH)
324 error (0, 0, _("The defined page is not long "
325 "enough to hold margins and headers, plus least %d "
326 "lines of the default fonts. In fact, there's only "
327 "room for %d lines."),
329 xr->length / xr->font_height);
338 output_driver_destroy (&xr->driver);
342 static struct output_driver *
343 xr_pdf_create (const char *file_name, enum settings_output_devices device_type,
344 struct string_map *o)
346 return xr_create (file_name, device_type, o, XR_PDF);
349 static struct output_driver *
350 xr_ps_create (const char *file_name, enum settings_output_devices device_type,
351 struct string_map *o)
353 return xr_create (file_name, device_type, o, XR_PS);
356 static struct output_driver *
357 xr_svg_create (const char *file_name, enum settings_output_devices device_type,
358 struct string_map *o)
360 return xr_create (file_name, device_type, o, XR_SVG);
364 xr_destroy (struct output_driver *driver)
366 struct xr_driver *xr = xr_driver_cast (driver);
369 xr_driver_destroy_fsm (xr);
371 if (xr->cairo != NULL)
373 cairo_status_t status;
375 cairo_surface_finish (cairo_get_target (xr->cairo));
376 status = cairo_status (xr->cairo);
377 if (status != CAIRO_STATUS_SUCCESS)
378 error (0, 0, _("error drawing output for %s driver: %s"),
379 output_driver_get_name (driver),
380 cairo_status_to_string (status));
381 cairo_destroy (xr->cairo);
384 free (xr->command_name);
385 for (i = 0; i < XR_N_FONTS; i++)
386 free_font (&xr->fonts[i]);
392 xr_flush (struct output_driver *driver)
394 struct xr_driver *xr = xr_driver_cast (driver);
396 cairo_surface_flush (cairo_get_target (xr->cairo));
400 xr_init_caption_cell (const char *caption, struct table_cell *cell)
402 cell->contents = caption;
403 cell->options = TAB_LEFT;
404 cell->destructor = NULL;
407 static struct render_page *
408 xr_render_table_item (struct xr_driver *xr, const struct table_item *item,
409 int *caption_heightp)
411 const char *caption = table_item_get_caption (item);
415 /* XXX doesn't do well with very large captions */
416 struct table_cell cell;
417 xr_init_caption_cell (caption, &cell);
418 *caption_heightp = xr_measure_cell_height (xr, &cell, xr->width);
421 *caption_heightp = 0;
423 return render_page_create (xr->params, table_item_get_table (item));
427 xr_submit (struct output_driver *driver, const struct output_item *output_item)
429 struct xr_driver *xr = xr_driver_cast (driver);
431 xr_driver_output_item (xr, output_item);
432 while (xr_driver_need_new_page (xr))
434 cairo_show_page (xr->cairo);
435 xr_driver_next_page (xr, xr->cairo);
439 /* Functions for rendering a series of output items to a series of Cairo
440 contexts, with pagination, possibly including headers.
442 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
443 its underlying implementation.
445 See the big comment in cairo.h for intended usage. */
447 /* Gives new page CAIRO to XR for output. CAIRO may be null to skip actually
448 rendering the page (which might be useful to find out how many pages an
449 output document has without actually rendering it). */
451 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
457 xr_driver_run_fsm (xr);
460 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
461 rendering a previous output item, that is, only if xr_driver_need_new_page()
464 xr_driver_output_item (struct xr_driver *xr,
465 const struct output_item *output_item)
467 assert (xr->fsm == NULL);
468 xr->fsm = xr_render_output_item (xr, output_item);
469 xr_driver_run_fsm (xr);
472 /* Returns true if XR is in the middle of rendering an output item and needs a
473 new page to be appended using xr_driver_next_page() to make progress,
476 xr_driver_need_new_page (const struct xr_driver *xr)
478 return xr->fsm != NULL;
481 /* Returns true if the current page doesn't have any content yet (besides
482 headers, if enabled). */
484 xr_driver_is_page_blank (const struct xr_driver *xr)
490 xr_driver_destroy_fsm (struct xr_driver *xr)
494 xr->fsm->destroy (xr->fsm);
500 xr_driver_run_fsm (struct xr_driver *xr)
502 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
503 xr_driver_destroy_fsm (xr);
507 xr_layout_cell (struct xr_driver *, const struct table_cell *,
508 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
509 PangoWrapMode, int *width, int *height);
512 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
514 cairo_new_path (xr->cairo);
515 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
516 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
517 cairo_stroke (xr->cairo);
520 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
521 shortening it to X0...X1 if SHORTEN is true.
522 Draws a horizontal line X1...X3 at Y if RIGHT says so,
523 shortening it to X2...X3 if SHORTEN is true. */
525 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
526 enum render_line_style left, enum render_line_style right,
529 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
530 dump_line (xr, x0, y, x3, y);
533 if (left != RENDER_LINE_NONE)
534 dump_line (xr, x0, y, shorten ? x1 : x2, y);
535 if (right != RENDER_LINE_NONE)
536 dump_line (xr, shorten ? x2 : x1, y, x3, y);
540 /* Draws a vertical line Y0...Y2 at X if TOP says so,
541 shortening it to Y0...Y1 if SHORTEN is true.
542 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
543 shortening it to Y2...Y3 if SHORTEN is true. */
545 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
546 enum render_line_style top, enum render_line_style bottom,
549 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
550 dump_line (xr, x, y0, x, y3);
553 if (top != RENDER_LINE_NONE)
554 dump_line (xr, x, y0, x, shorten ? y1 : y2);
555 if (bottom != RENDER_LINE_NONE)
556 dump_line (xr, x, shorten ? y2 : y1, x, y3);
561 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
562 enum render_line_style styles[TABLE_N_AXES][2])
564 const int x0 = bb[H][0];
565 const int y0 = bb[V][0];
566 const int x3 = bb[H][1];
567 const int y3 = bb[V][1];
568 const int top = styles[H][0];
569 const int left = styles[V][0];
570 const int bottom = styles[H][1];
571 const int right = styles[V][1];
573 /* The algorithm here is somewhat subtle, to allow it to handle
574 all the kinds of intersections that we need.
576 Three additional ordinates are assigned along the x axis. The
577 first is xc, midway between x0 and x3. The others are x1 and
578 x2; for a single vertical line these are equal to xc, and for
579 a double vertical line they are the ordinates of the left and
580 right half of the double line.
582 yc, y1, and y2 are assigned similarly along the y axis.
584 The following diagram shows the coordinate system and output
585 for double top and bottom lines, single left line, and no
589 y0 ________________________
595 y1 = y2 = yc |######### # |
600 y3 |________#_____#_______|
602 struct xr_driver *xr = xr_;
604 /* Offset from center of each line in a pair of double lines. */
605 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
607 /* Are the lines along each axis single or double?
608 (It doesn't make sense to have different kinds of line on the
609 same axis, so we don't try to gracefully handle that case.) */
610 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
611 bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE;
613 /* When horizontal lines are doubled,
614 the left-side line along y1 normally runs from x0 to x2,
615 and the right-side line along y1 from x3 to x1.
616 If the top-side line is also doubled, we shorten the y1 lines,
617 so that the left-side line runs only to x1,
618 and the right-side line only to x2.
619 Otherwise, the horizontal line at y = y1 below would cut off
620 the intersection, which looks ugly:
622 y0 ________________________
627 y1 |######### ########|
630 y2 |######################|
633 y3 |______________________|
634 It is more of a judgment call when the horizontal line is
635 single. We actually choose to cut off the line anyhow, as
636 shown in the first diagram above.
638 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
639 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
640 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
641 int horz_line_ofs = double_vert ? double_line_ofs : 0;
642 int xc = (x0 + x3) / 2;
643 int x1 = xc - horz_line_ofs;
644 int x2 = xc + horz_line_ofs;
646 bool shorten_x1_lines = left == RENDER_LINE_DOUBLE;
647 bool shorten_x2_lines = right == RENDER_LINE_DOUBLE;
648 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
649 int vert_line_ofs = double_horz ? double_line_ofs : 0;
650 int yc = (y0 + y3) / 2;
651 int y1 = yc - vert_line_ofs;
652 int y2 = yc + vert_line_ofs;
655 horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line);
658 horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines);
659 horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines);
663 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
666 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
667 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
672 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
673 int *min_width, int *max_width)
675 struct xr_driver *xr = xr_;
676 int bb[TABLE_N_AXES][2];
677 int clip[TABLE_N_AXES][2];
684 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
685 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, max_width, &h);
688 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, min_width, &h);
692 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
694 struct xr_driver *xr = xr_;
695 int bb[TABLE_N_AXES][2];
696 int clip[TABLE_N_AXES][2];
703 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
704 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
709 xr_draw_cell (void *xr_, const struct table_cell *cell,
710 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
712 struct xr_driver *xr = xr_;
715 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
718 /* Writes STRING at location (X,Y) trimmed to the given MAX_WIDTH
719 and with the given cell OPTIONS for XR. */
721 draw_text (struct xr_driver *xr, const char *string, int x, int y,
722 int max_width, unsigned int options)
724 struct table_cell cell;
725 int bb[TABLE_N_AXES][2];
728 cell.contents = string;
729 cell.options = options;
731 bb[V][0] = y - xr->y;
732 bb[H][1] = x + max_width;
733 bb[V][1] = xr->font_height - xr->y;
734 xr_layout_cell (xr, &cell, bb, bb, PANGO_WRAP_WORD_CHAR, &w, &h);
738 /* Writes LEFT left-justified and RIGHT right-justified within
739 (X0...X1) at Y. LEFT or RIGHT or both may be null. */
741 draw_header_line (struct xr_driver *xr, const char *left, const char *right,
742 int x0, int x1, int y)
746 right_width = (draw_text (xr, right, x0, y, x1 - x0, TAB_RIGHT)
747 + xr->font_height / 2);
749 draw_text (xr, left, x0, y, x1 - x0 - right_width, TAB_LEFT);
752 /* Draw top of page headers for XR. */
754 draw_headers (struct xr_driver *xr)
760 if (!xr->headers || xr->cairo == NULL)
763 y = -3 * xr->font_height;
764 x0 = xr->font_height / 2;
765 x1 = xr->width - xr->font_height / 2;
768 cairo_rectangle (xr->cairo, 0, xr_to_pt (y), xr_to_pt (xr->width),
769 xr_to_pt (2 * (xr->font_height
770 + xr->line_width + xr->line_gutter)));
771 cairo_save (xr->cairo);
772 cairo_set_source_rgb (xr->cairo, 0.9, 0.9, 0.9);
773 cairo_fill_preserve (xr->cairo);
774 cairo_restore (xr->cairo);
775 cairo_stroke (xr->cairo);
777 y += xr->line_width + xr->line_gutter;
779 r1 = xasprintf (_("%s - Page %d"), get_start_date (), xr->page_number);
780 r2 = xasprintf ("%s - %s", version, host_system);
782 draw_header_line (xr, xr->title, r1, x0, x1, y);
783 y += xr->font_height;
785 draw_header_line (xr, xr->subtitle, r2, x0, x1, y);
792 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
793 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
794 PangoWrapMode wrap, int *width, int *height)
796 struct xr_font *font;
798 font = (cell->options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
799 : cell->options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
800 : &xr->fonts[XR_FONT_PROPORTIONAL]);
802 pango_layout_set_text (font->layout, cell->contents, -1);
804 pango_layout_set_alignment (
806 ((cell->options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
807 : (cell->options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
808 : PANGO_ALIGN_CENTER));
809 pango_layout_set_width (font->layout,
810 bb[H][1] == INT_MAX ? -1 : bb[H][1] - bb[H][0]);
811 pango_layout_set_wrap (font->layout, wrap);
813 if (clip[H][0] != clip[H][1])
815 cairo_save (xr->cairo);
817 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
819 double x0 = xr_to_pt (clip[H][0]);
820 double y0 = xr_to_pt (clip[V][0] + xr->y);
821 double x1 = xr_to_pt (clip[H][1]);
822 double y1 = xr_to_pt (clip[V][1] + xr->y);
824 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
825 cairo_clip (xr->cairo);
828 cairo_translate (xr->cairo,
830 xr_to_pt (bb[V][0] + xr->y));
831 pango_cairo_show_layout (xr->cairo, font->layout);
832 cairo_restore (xr->cairo);
835 if (width != NULL || height != NULL)
839 pango_layout_get_size (font->layout, &w, &h);
847 /* Attempts to load FONT, initializing its other members based on
848 its 'string' member and the information in DRIVER. Returns true
849 if successful, otherwise false. */
851 load_font (struct xr_driver *xr, struct xr_font *font)
853 PangoContext *context;
854 PangoLanguage *language;
856 font->desc = pango_font_description_from_string (font->string);
857 if (font->desc == NULL)
859 error (0, 0, _("\"%s\": bad font specification"), font->string);
862 pango_font_description_set_absolute_size (font->desc, xr->font_height);
864 font->layout = pango_cairo_create_layout (xr->cairo);
865 pango_layout_set_font_description (font->layout, font->desc);
867 language = pango_language_get_default ();
868 context = pango_layout_get_context (font->layout);
869 font->metrics = pango_context_get_metrics (context, font->desc, language);
876 free_font (struct xr_font *font)
879 if (font->desc != NULL)
880 pango_font_description_free (font->desc);
881 pango_font_metrics_unref (font->metrics);
882 if (font->layout != NULL)
883 g_object_unref (font->layout);
886 struct output_driver_factory pdf_driver_factory = { "pdf", xr_pdf_create };
887 struct output_driver_factory ps_driver_factory = { "ps", xr_ps_create };
888 struct output_driver_factory svg_driver_factory = { "svg", xr_svg_create };
890 static const struct output_driver_class cairo_driver_class =
898 /* GUI rendering helpers. */
903 struct render_page *page;
904 struct xr_driver *xr;
908 struct chart_item *chart;
911 #define CHART_WIDTH 500
912 #define CHART_HEIGHT 375
915 xr_driver_create (cairo_t *cairo, struct string_map *options)
917 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
918 xr->width = INT_MAX / 8;
919 xr->length = INT_MAX / 8;
920 if (!xr_set_cairo (xr, cairo))
922 output_driver_destroy (&xr->driver);
928 static struct xr_rendering *
929 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
931 struct table_item *table_item;
932 struct xr_rendering *r;
934 table_item = table_item_create (table_from_string (0, text), NULL);
935 r = xr_rendering_create (xr, &table_item->output_item, cr);
936 table_item_unref (table_item);
941 struct xr_rendering *
942 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
945 struct xr_rendering *r = NULL;
947 if (is_text_item (item))
948 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
950 else if (is_message_item (item))
952 const struct message_item *message_item = to_message_item (item);
953 const struct msg *msg = message_item_get_msg (message_item);
954 char *s = msg_to_string (msg, NULL);
955 r = xr_rendering_create_text (xr, s, cr);
958 else if (is_table_item (item))
960 r = xzalloc (sizeof *r);
962 xr_set_cairo (xr, cr);
963 r->page = xr_render_table_item (xr, to_table_item (item),
966 else if (is_chart_item (item))
968 r = xzalloc (sizeof *r);
969 r->chart = to_chart_item (output_item_ref (item));
976 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
978 if (r->chart == NULL)
980 *w = render_page_get_size (r->page, H) / 1024;
981 *h = (render_page_get_size (r->page, V) + r->title_height) / 1024;
991 xr_rendering_draw (struct xr_rendering *r, cairo_t *cr)
993 if (r->chart == NULL)
995 struct xr_driver *xr = r->xr;
997 xr_set_cairo (xr, cr);
999 render_page_draw (r->page);
1002 xr_draw_chart (r->chart, cr, 0, 0, CHART_WIDTH, CHART_HEIGHT);
1006 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1007 double x, double y, double width, double height)
1009 struct xrchart_geometry geom;
1012 cairo_translate (cr, x, y + height);
1013 cairo_scale (cr, 1.0, -1.0);
1014 xrchart_geometry_init (cr, &geom, width, height);
1015 if (is_boxplot (chart_item))
1016 xrchart_draw_boxplot (chart_item, cr, &geom);
1017 else if (is_histogram_chart (chart_item))
1018 xrchart_draw_histogram (chart_item, cr, &geom);
1019 else if (is_np_plot_chart (chart_item))
1020 xrchart_draw_np_plot (chart_item, cr, &geom);
1021 else if (is_piechart (chart_item))
1022 xrchart_draw_piechart (chart_item, cr, &geom);
1023 else if (is_roc_chart (chart_item))
1024 xrchart_draw_roc (chart_item, cr, &geom);
1025 else if (is_scree (chart_item))
1026 xrchart_draw_scree (chart_item, cr, &geom);
1029 xrchart_geometry_free (cr, &geom);
1035 xr_draw_png_chart (const struct chart_item *item,
1036 const char *file_name_template, int number)
1038 const int width = 640;
1039 const int length = 480;
1041 cairo_surface_t *surface;
1042 cairo_status_t status;
1043 const char *number_pos;
1047 number_pos = strchr (file_name_template, '#');
1048 if (number_pos != NULL)
1049 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1050 file_name_template, number, number_pos + 1);
1052 file_name = xstrdup (file_name_template);
1054 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1055 cr = cairo_create (surface);
1058 cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
1059 cairo_rectangle (cr, 0, 0, width, length);
1063 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0);
1065 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1067 status = cairo_surface_write_to_png (surface, file_name);
1068 if (status != CAIRO_STATUS_SUCCESS)
1069 error (0, 0, _("error writing output file \"%s\": %s"),
1070 file_name, cairo_status_to_string (status));
1073 cairo_surface_destroy (surface);
1078 struct xr_table_state
1080 struct xr_render_fsm fsm;
1081 struct table_item *table_item;
1082 struct render_break x_break;
1083 struct render_break y_break;
1088 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1090 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1094 struct render_page *y_slice;
1097 while (!render_break_has_next (&ts->y_break))
1099 struct render_page *x_slice;
1101 render_break_destroy (&ts->y_break);
1102 if (!render_break_has_next (&ts->x_break))
1105 x_slice = render_break_next (&ts->x_break, xr->width);
1106 render_break_init (&ts->y_break, x_slice, V);
1109 space = xr->length - xr->y;
1110 if (render_break_next_size (&ts->y_break) > space)
1116 y_slice = render_break_next (&ts->y_break, space);
1117 if (ts->caption_height)
1121 struct table_cell cell;
1122 int bb[TABLE_N_AXES][2];
1124 xr_init_caption_cell (table_item_get_caption (ts->table_item),
1127 bb[H][1] = xr->width;
1129 bb[V][1] = ts->caption_height;
1130 xr_draw_cell (xr, &cell, bb, bb);
1132 xr->y += ts->caption_height;
1133 ts->caption_height = 0;
1137 render_page_draw (y_slice);
1138 xr->y += render_page_get_size (y_slice, V);
1139 render_page_unref (y_slice);
1144 xr_table_destroy (struct xr_render_fsm *fsm)
1146 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1148 table_item_unref (ts->table_item);
1149 render_break_destroy (&ts->x_break);
1150 render_break_destroy (&ts->y_break);
1154 static struct xr_render_fsm *
1155 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1157 struct xr_table_state *ts;
1158 struct render_page *page;
1160 ts = xmalloc (sizeof *ts);
1161 ts->fsm.render = xr_table_render;
1162 ts->fsm.destroy = xr_table_destroy;
1163 ts->table_item = table_item_ref (table_item);
1166 xr->y += xr->font_height;
1168 page = xr_render_table_item (xr, table_item, &ts->caption_height);
1169 xr->params->size[V] = xr->length - ts->caption_height;
1171 render_break_init (&ts->x_break, page, H);
1172 render_break_init_empty (&ts->y_break);
1177 struct xr_chart_state
1179 struct xr_render_fsm fsm;
1180 struct chart_item *chart_item;
1184 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1186 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1191 if (xr->cairo != NULL)
1192 xr_draw_chart (cs->chart_item, xr->cairo, 0.0, 0.0,
1193 xr_to_pt (xr->width), xr_to_pt (xr->length));
1200 xr_chart_destroy (struct xr_render_fsm *fsm)
1202 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1204 chart_item_unref (cs->chart_item);
1208 static struct xr_render_fsm *
1209 xr_render_chart (const struct chart_item *chart_item)
1211 struct xr_chart_state *cs;
1213 cs = xmalloc (sizeof *cs);
1214 cs->fsm.render = xr_chart_render;
1215 cs->fsm.destroy = xr_chart_destroy;
1216 cs->chart_item = chart_item_ref (chart_item);
1222 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1228 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1230 /* Nothing to do. */
1233 static struct xr_render_fsm *
1234 xr_render_eject (void)
1236 static struct xr_render_fsm eject_renderer =
1242 return &eject_renderer;
1245 static struct xr_render_fsm *
1246 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1248 struct table_item *table_item;
1249 struct xr_render_fsm *fsm;
1251 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
1252 fsm = xr_render_table (xr, table_item);
1253 table_item_unref (table_item);
1258 static struct xr_render_fsm *
1259 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1261 enum text_item_type type = text_item_get_type (text_item);
1262 const char *text = text_item_get_text (text_item);
1266 case TEXT_ITEM_TITLE:
1268 xr->title = xstrdup (text);
1272 case TEXT_ITEM_SUBTITLE:
1273 free (xr->subtitle);
1274 xr->subtitle = xstrdup (text);
1278 case TEXT_ITEM_COMMAND_CLOSE:
1281 case TEXT_ITEM_BLANK_LINE:
1283 xr->y += xr->font_height;
1286 case TEXT_ITEM_EJECT_PAGE:
1288 return xr_render_eject ();
1292 return xr_create_text_renderer (xr, text);
1298 static struct xr_render_fsm *
1299 xr_render_message (struct xr_driver *xr,
1300 const struct message_item *message_item)
1302 const struct msg *msg = message_item_get_msg (message_item);
1303 struct xr_render_fsm *fsm;
1306 s = msg_to_string (msg, xr->command_name);
1307 fsm = xr_create_text_renderer (xr, s);
1313 static struct xr_render_fsm *
1314 xr_render_output_item (struct xr_driver *xr,
1315 const struct output_item *output_item)
1317 if (is_table_item (output_item))
1318 return xr_render_table (xr, to_table_item (output_item));
1319 else if (is_chart_item (output_item))
1320 return xr_render_chart (to_chart_item (output_item));
1321 else if (is_text_item (output_item))
1322 return xr_render_text (xr, to_text_item (output_item));
1323 else if (is_message_item (output_item))
1324 return xr_render_message (xr, to_message_item (output_item));