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, i;
254 int font_points = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
256 for (i = 0; i < XR_N_FONTS; i++)
258 struct xr_font *font = &xr->fonts[i];
260 if (font->desc != NULL)
261 pango_font_description_free (font->desc);
264 xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
266 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
267 "serif", font_points);
268 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
269 "serif italic", font_points);
271 xr->line_gutter = XR_POINT;
272 xr->line_space = XR_POINT;
273 xr->line_width = XR_POINT / 2;
276 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg_red, &xr->bg_green, &xr->bg_blue);
277 parse_color (d, o, "foreground-color", "#000000000000", &xr->fg_red, &xr->fg_green, &xr->fg_blue);
279 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
280 xr->left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
281 xr->right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
282 xr->top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
283 xr->bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
285 xr->width = paper_width - xr->left_margin - xr->right_margin;
286 xr->length = paper_length - xr->top_margin - xr->bottom_margin;
289 static struct xr_driver *
290 xr_allocate (const char *name, int device_type, struct string_map *o)
292 struct xr_driver *xr = xzalloc (sizeof *xr);
293 struct output_driver *d = &xr->driver;
295 output_driver_init (d, &cairo_driver_class, name, device_type);
297 apply_options (xr, o);
303 xr_is_72dpi (cairo_t *cr)
305 cairo_surface_type_t type;
306 cairo_surface_t *surface;
308 surface = cairo_get_target (cr);
309 type = cairo_surface_get_type (surface);
310 return type == CAIRO_SURFACE_TYPE_PDF || type == CAIRO_SURFACE_TYPE_PS;
314 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
316 PangoContext *context;
322 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
324 map = pango_cairo_font_map_get_default ();
325 context = pango_font_map_create_context (map);
326 if (xr_is_72dpi (cairo))
328 /* Pango seems to always scale fonts according to the DPI specified
329 in the font map, even if the surface has a real DPI. The default
330 DPI is 96, so on a 72 DPI device fonts end up being 96/72 = 133%
331 of their desired size. We deal with this by fixing the resolution
332 here. Presumably there is a better solution, but what? */
333 pango_cairo_context_set_resolution (context, 72.0);
338 for (i = 0; i < XR_N_FONTS; i++)
340 struct xr_font *font = &xr->fonts[i];
341 int char_width, char_height;
343 font->layout = pango_layout_new (context);
344 pango_layout_set_font_description (font->layout, font->desc);
346 pango_layout_set_text (font->layout, "0", 1);
347 pango_layout_get_size (font->layout, &char_width, &char_height);
348 xr->char_width = MAX (xr->char_width, char_width);
349 xr->char_height = MAX (xr->char_height, char_height);
352 g_object_unref (G_OBJECT (context));
354 if (xr->params == NULL)
356 int single_width, double_width;
358 xr->params = xmalloc (sizeof *xr->params);
359 xr->params->draw_line = xr_draw_line;
360 xr->params->measure_cell_width = xr_measure_cell_width;
361 xr->params->measure_cell_height = xr_measure_cell_height;
362 xr->params->draw_cell = xr_draw_cell;
363 xr->params->aux = xr;
364 xr->params->size[H] = xr->width;
365 xr->params->size[V] = xr->length;
366 xr->params->font_size[H] = xr->char_width;
367 xr->params->font_size[V] = xr->char_height;
369 single_width = 2 * xr->line_gutter + xr->line_width;
370 double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width;
371 for (i = 0; i < TABLE_N_AXES; i++)
373 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
374 xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width;
375 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width;
379 cairo_set_source_rgb (xr->cairo, xr->fg_red, xr->fg_green, xr->fg_blue);
384 static struct output_driver *
385 xr_create (const char *file_name, enum settings_output_devices device_type,
386 struct string_map *o, enum xr_output_type file_type)
388 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
389 struct xr_driver *xr;
390 cairo_surface_t *surface;
391 cairo_status_t status;
392 double width_pt, length_pt;
394 xr = xr_allocate (file_name, device_type, o);
396 width_pt = (xr->width + xr->left_margin + xr->right_margin) / 1000.0;
397 length_pt = (xr->length + xr->top_margin + xr->bottom_margin) / 1000.0;
398 if (file_type == XR_PDF)
399 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
400 else if (file_type == XR_PS)
401 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
402 else if (file_type == XR_SVG)
403 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
407 status = cairo_surface_status (surface);
408 if (status != CAIRO_STATUS_SUCCESS)
410 error (0, 0, _("error opening output file `%s': %s"),
411 file_name, cairo_status_to_string (status));
412 cairo_surface_destroy (surface);
416 xr->cairo = cairo_create (surface);
417 cairo_surface_destroy (surface);
419 if (!xr_set_cairo (xr, xr->cairo))
422 cairo_save (xr->cairo);
423 xr_driver_next_page (xr, xr->cairo);
425 if (xr->width / xr->char_width < MIN_WIDTH)
427 error (0, 0, _("The defined page is not wide enough to hold at least %d "
428 "characters in the default font. In fact, there's only "
429 "room for %d characters."),
431 xr->width / xr->char_width);
435 if (xr->length / xr->char_height < MIN_LENGTH)
437 error (0, 0, _("The defined page is not long enough to hold at least %d "
438 "lines in the default font. In fact, there's only "
439 "room for %d lines."),
441 xr->length / xr->char_height);
448 output_driver_destroy (&xr->driver);
452 static struct output_driver *
453 xr_pdf_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_PDF);
459 static struct output_driver *
460 xr_ps_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_PS);
466 static struct output_driver *
467 xr_svg_create (const char *file_name, enum settings_output_devices device_type,
468 struct string_map *o)
470 return xr_create (file_name, device_type, o, XR_SVG);
474 xr_destroy (struct output_driver *driver)
476 struct xr_driver *xr = xr_driver_cast (driver);
479 xr_driver_destroy_fsm (xr);
481 if (xr->cairo != NULL)
483 cairo_status_t status;
485 cairo_surface_finish (cairo_get_target (xr->cairo));
486 status = cairo_status (xr->cairo);
487 if (status != CAIRO_STATUS_SUCCESS)
488 error (0, 0, _("error drawing output for %s driver: %s"),
489 output_driver_get_name (driver),
490 cairo_status_to_string (status));
491 cairo_destroy (xr->cairo);
494 free (xr->command_name);
495 for (i = 0; i < XR_N_FONTS; i++)
497 struct xr_font *font = &xr->fonts[i];
499 if (font->desc != NULL)
500 pango_font_description_free (font->desc);
501 if (font->layout != NULL)
502 g_object_unref (font->layout);
510 xr_flush (struct output_driver *driver)
512 struct xr_driver *xr = xr_driver_cast (driver);
514 cairo_surface_flush (cairo_get_target (xr->cairo));
518 xr_init_caption_cell (const char *caption, struct table_cell *cell)
520 cell->contents = caption;
521 cell->options = TAB_LEFT;
522 cell->destructor = NULL;
525 static struct render_page *
526 xr_render_table_item (struct xr_driver *xr, const struct table_item *item,
527 int *caption_widthp, int *caption_heightp)
529 const char *caption = table_item_get_caption (item);
533 /* XXX doesn't do well with very large captions */
534 int min_width, max_width;
535 struct table_cell cell;
537 xr_init_caption_cell (caption, &cell);
539 xr_measure_cell_width (xr, &cell, &min_width, &max_width);
540 *caption_widthp = MIN (max_width, xr->width);
541 *caption_heightp = xr_measure_cell_height (xr, &cell, *caption_widthp);
544 *caption_heightp = 0;
546 return render_page_create (xr->params, table_item_get_table (item));
550 xr_submit (struct output_driver *driver, const struct output_item *output_item)
552 struct xr_driver *xr = xr_driver_cast (driver);
554 xr_driver_output_item (xr, output_item);
555 while (xr_driver_need_new_page (xr))
557 cairo_restore (xr->cairo);
558 cairo_show_page (xr->cairo);
559 cairo_save (xr->cairo);
560 xr_driver_next_page (xr, xr->cairo);
564 /* Functions for rendering a series of output items to a series of Cairo
565 contexts, with pagination.
567 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
568 its underlying implementation.
570 See the big comment in cairo.h for intended usage. */
572 /* Gives new page CAIRO to XR for output. CAIRO may be null to skip actually
573 rendering the page (which might be useful to find out how many pages an
574 output document has without actually rendering it). */
576 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
581 cairo_set_source_rgb (cairo, xr->bg_red, xr->bg_green, xr->bg_blue);
582 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
584 cairo_restore (cairo);
586 cairo_translate (cairo,
587 xr_to_pt (xr->left_margin),
588 xr_to_pt (xr->top_margin));
594 xr_driver_run_fsm (xr);
597 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
598 rendering a previous output item, that is, only if xr_driver_need_new_page()
601 xr_driver_output_item (struct xr_driver *xr,
602 const struct output_item *output_item)
604 assert (xr->fsm == NULL);
605 xr->fsm = xr_render_output_item (xr, output_item);
606 xr_driver_run_fsm (xr);
609 /* Returns true if XR is in the middle of rendering an output item and needs a
610 new page to be appended using xr_driver_next_page() to make progress,
613 xr_driver_need_new_page (const struct xr_driver *xr)
615 return xr->fsm != NULL;
618 /* Returns true if the current page doesn't have any content yet. */
620 xr_driver_is_page_blank (const struct xr_driver *xr)
626 xr_driver_destroy_fsm (struct xr_driver *xr)
630 xr->fsm->destroy (xr->fsm);
636 xr_driver_run_fsm (struct xr_driver *xr)
638 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
639 xr_driver_destroy_fsm (xr);
643 xr_layout_cell (struct xr_driver *, const struct table_cell *,
644 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
645 PangoWrapMode, int *width, int *height);
648 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1)
650 cairo_new_path (xr->cairo);
651 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
652 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
653 cairo_stroke (xr->cairo);
656 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
657 shortening it to X0...X1 if SHORTEN is true.
658 Draws a horizontal line X1...X3 at Y if RIGHT says so,
659 shortening it to X2...X3 if SHORTEN is true. */
661 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
662 enum render_line_style left, enum render_line_style right,
665 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
666 dump_line (xr, x0, y, x3, y);
669 if (left != RENDER_LINE_NONE)
670 dump_line (xr, x0, y, shorten ? x1 : x2, y);
671 if (right != RENDER_LINE_NONE)
672 dump_line (xr, shorten ? x2 : x1, y, x3, y);
676 /* Draws a vertical line Y0...Y2 at X if TOP says so,
677 shortening it to Y0...Y1 if SHORTEN is true.
678 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
679 shortening it to Y2...Y3 if SHORTEN is true. */
681 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
682 enum render_line_style top, enum render_line_style bottom,
685 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
686 dump_line (xr, x, y0, x, y3);
689 if (top != RENDER_LINE_NONE)
690 dump_line (xr, x, y0, x, shorten ? y1 : y2);
691 if (bottom != RENDER_LINE_NONE)
692 dump_line (xr, x, shorten ? y2 : y1, x, y3);
697 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
698 enum render_line_style styles[TABLE_N_AXES][2])
700 const int x0 = bb[H][0];
701 const int y0 = bb[V][0];
702 const int x3 = bb[H][1];
703 const int y3 = bb[V][1];
704 const int top = styles[H][0];
705 const int left = styles[V][0];
706 const int bottom = styles[H][1];
707 const int right = styles[V][1];
709 /* The algorithm here is somewhat subtle, to allow it to handle
710 all the kinds of intersections that we need.
712 Three additional ordinates are assigned along the x axis. The
713 first is xc, midway between x0 and x3. The others are x1 and
714 x2; for a single vertical line these are equal to xc, and for
715 a double vertical line they are the ordinates of the left and
716 right half of the double line.
718 yc, y1, and y2 are assigned similarly along the y axis.
720 The following diagram shows the coordinate system and output
721 for double top and bottom lines, single left line, and no
725 y0 ________________________
731 y1 = y2 = yc |######### # |
736 y3 |________#_____#_______|
738 struct xr_driver *xr = xr_;
740 /* Offset from center of each line in a pair of double lines. */
741 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
743 /* Are the lines along each axis single or double?
744 (It doesn't make sense to have different kinds of line on the
745 same axis, so we don't try to gracefully handle that case.) */
746 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
747 bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE;
749 /* When horizontal lines are doubled,
750 the left-side line along y1 normally runs from x0 to x2,
751 and the right-side line along y1 from x3 to x1.
752 If the top-side line is also doubled, we shorten the y1 lines,
753 so that the left-side line runs only to x1,
754 and the right-side line only to x2.
755 Otherwise, the horizontal line at y = y1 below would cut off
756 the intersection, which looks ugly:
758 y0 ________________________
763 y1 |######### ########|
766 y2 |######################|
769 y3 |______________________|
770 It is more of a judgment call when the horizontal line is
771 single. We actually choose to cut off the line anyhow, as
772 shown in the first diagram above.
774 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
775 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
776 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
777 int horz_line_ofs = double_vert ? double_line_ofs : 0;
778 int xc = (x0 + x3) / 2;
779 int x1 = xc - horz_line_ofs;
780 int x2 = xc + horz_line_ofs;
782 bool shorten_x1_lines = left == RENDER_LINE_DOUBLE;
783 bool shorten_x2_lines = right == RENDER_LINE_DOUBLE;
784 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
785 int vert_line_ofs = double_horz ? double_line_ofs : 0;
786 int yc = (y0 + y3) / 2;
787 int y1 = yc - vert_line_ofs;
788 int y2 = yc + vert_line_ofs;
791 horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line);
794 horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines);
795 horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines);
799 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
802 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
803 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
808 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
809 int *min_width, int *max_width)
811 struct xr_driver *xr = xr_;
812 int bb[TABLE_N_AXES][2];
813 int clip[TABLE_N_AXES][2];
820 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
821 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, max_width, &h);
824 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, min_width, &h);
828 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
830 struct xr_driver *xr = xr_;
831 int bb[TABLE_N_AXES][2];
832 int clip[TABLE_N_AXES][2];
839 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
840 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
845 xr_draw_cell (void *xr_, const struct table_cell *cell,
846 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
848 struct xr_driver *xr = xr_;
851 xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h);
855 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
856 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
857 PangoWrapMode wrap, int *width, int *height)
859 struct xr_font *font;
861 font = (cell->options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
862 : cell->options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
863 : &xr->fonts[XR_FONT_PROPORTIONAL]);
865 pango_layout_set_text (font->layout, cell->contents, -1);
867 pango_layout_set_alignment (
869 ((cell->options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
870 : (cell->options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT
871 : PANGO_ALIGN_CENTER));
872 pango_layout_set_width (font->layout,
873 bb[H][1] == INT_MAX ? -1 : bb[H][1] - bb[H][0]);
874 pango_layout_set_wrap (font->layout, wrap);
876 if (clip[H][0] != clip[H][1])
878 cairo_save (xr->cairo);
880 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
882 double x0 = xr_to_pt (clip[H][0]);
883 double y0 = xr_to_pt (clip[V][0] + xr->y);
884 double x1 = xr_to_pt (clip[H][1]);
885 double y1 = xr_to_pt (clip[V][1] + xr->y);
887 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
888 cairo_clip (xr->cairo);
891 cairo_translate (xr->cairo,
893 xr_to_pt (bb[V][0] + xr->y));
894 pango_cairo_show_layout (xr->cairo, font->layout);
895 cairo_restore (xr->cairo);
898 if (width != NULL || height != NULL)
902 pango_layout_get_size (font->layout, &w, &h);
911 xr_draw_title (struct xr_driver *xr, const char *title,
912 int title_width, int title_height)
914 struct table_cell cell;
915 int bb[TABLE_N_AXES][2];
917 xr_init_caption_cell (title, &cell);
919 bb[H][1] = title_width;
921 bb[V][1] = title_height;
922 xr_draw_cell (xr, &cell, bb, bb);
925 struct output_driver_factory pdf_driver_factory = { "pdf", xr_pdf_create };
926 struct output_driver_factory ps_driver_factory = { "ps", xr_ps_create };
927 struct output_driver_factory svg_driver_factory = { "svg", xr_svg_create };
929 static const struct output_driver_class cairo_driver_class =
937 /* GUI rendering helpers. */
941 struct output_item *item;
944 struct render_page *page;
945 struct xr_driver *xr;
950 #define CHART_WIDTH 500
951 #define CHART_HEIGHT 375
956 xr_driver_create (cairo_t *cairo, struct string_map *options)
958 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
959 if (!xr_set_cairo (xr, cairo))
961 output_driver_destroy (&xr->driver);
967 /* Destroy XR, which should have been created with xr_driver_create(). Any
968 cairo_t added to XR is not destroyed, because it is owned by the client. */
970 xr_driver_destroy (struct xr_driver *xr)
975 output_driver_destroy (&xr->driver);
979 static struct xr_rendering *
980 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
982 struct table_item *table_item;
983 struct xr_rendering *r;
985 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
986 r = xr_rendering_create (xr, &table_item->output_item, cr);
987 table_item_unref (table_item);
993 xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
995 if (is_table_item (xr->item))
996 apply_options (xr->xr, o);
999 struct xr_rendering *
1000 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
1003 struct xr_rendering *r = NULL;
1005 if (is_text_item (item))
1006 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
1008 else if (is_message_item (item))
1010 const struct message_item *message_item = to_message_item (item);
1011 const struct msg *msg = message_item_get_msg (message_item);
1012 char *s = msg_to_string (msg, NULL);
1013 r = xr_rendering_create_text (xr, s, cr);
1016 else if (is_table_item (item))
1018 r = xzalloc (sizeof *r);
1019 r->item = output_item_ref (item);
1021 xr_set_cairo (xr, cr);
1022 r->page = xr_render_table_item (xr, to_table_item (item),
1023 &r->title_width, &r->title_height);
1025 else if (is_chart_item (item))
1027 r = xzalloc (sizeof *r);
1028 r->item = output_item_ref (item);
1035 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
1037 if (is_table_item (r->item))
1039 int w0 = render_page_get_size (r->page, H);
1040 int w1 = r->title_width;
1041 *w = MAX (w0, w1) / 1024;
1042 *h = (render_page_get_size (r->page, V) + r->title_height) / 1024;
1051 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1052 double x, double y, double width, double height);
1054 /* Draws onto CR at least the region of R that is enclosed in (X,Y)-(X+W,Y+H),
1055 and possibly some additional parts. */
1057 xr_rendering_draw (struct xr_rendering *r, cairo_t *cr,
1058 int x, int y, int w, int h)
1060 if (is_table_item (r->item))
1062 struct xr_driver *xr = r->xr;
1064 xr_set_cairo (xr, cr);
1066 if (r->title_height > 0)
1069 xr_draw_title (xr, table_item_get_caption (to_table_item (r->item)),
1070 r->title_width, r->title_height);
1073 xr->y = r->title_height;
1074 render_page_draw_region (r->page, x * 1024, (y * 1024) - r->title_height,
1075 w * 1024, h * 1024);
1078 xr_draw_chart (to_chart_item (r->item), cr,
1079 0, 0, CHART_WIDTH, CHART_HEIGHT);
1083 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1084 double x, double y, double width, double height)
1086 struct xrchart_geometry geom;
1089 cairo_translate (cr, x, y + height);
1090 cairo_scale (cr, 1.0, -1.0);
1091 xrchart_geometry_init (cr, &geom, width, height);
1092 if (is_boxplot (chart_item))
1093 xrchart_draw_boxplot (chart_item, cr, &geom);
1094 else if (is_histogram_chart (chart_item))
1095 xrchart_draw_histogram (chart_item, cr, &geom);
1096 else if (is_np_plot_chart (chart_item))
1097 xrchart_draw_np_plot (chart_item, cr, &geom);
1098 else if (is_piechart (chart_item))
1099 xrchart_draw_piechart (chart_item, cr, &geom);
1100 else if (is_roc_chart (chart_item))
1101 xrchart_draw_roc (chart_item, cr, &geom);
1102 else if (is_scree (chart_item))
1103 xrchart_draw_scree (chart_item, cr, &geom);
1104 else if (is_spreadlevel_plot_chart (chart_item))
1105 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1108 xrchart_geometry_free (cr, &geom);
1114 xr_draw_png_chart (const struct chart_item *item,
1115 const char *file_name_template, int number)
1117 const int width = 640;
1118 const int length = 480;
1120 cairo_surface_t *surface;
1121 cairo_status_t status;
1122 const char *number_pos;
1126 number_pos = strchr (file_name_template, '#');
1127 if (number_pos != NULL)
1128 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1129 file_name_template, number, number_pos + 1);
1131 file_name = xstrdup (file_name_template);
1133 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1134 cr = cairo_create (surface);
1136 cairo_set_source_rgb (cr, 0.0, 0.0, 0.0);
1138 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1140 status = cairo_surface_write_to_png (surface, file_name);
1141 if (status != CAIRO_STATUS_SUCCESS)
1142 error (0, 0, _("error writing output file `%s': %s"),
1143 file_name, cairo_status_to_string (status));
1146 cairo_surface_destroy (surface);
1151 struct xr_table_state
1153 struct xr_render_fsm fsm;
1154 struct table_item *table_item;
1155 struct render_break x_break;
1156 struct render_break y_break;
1161 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1163 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1167 struct render_page *y_slice;
1170 while (!render_break_has_next (&ts->y_break))
1172 struct render_page *x_slice;
1174 render_break_destroy (&ts->y_break);
1175 if (!render_break_has_next (&ts->x_break))
1178 x_slice = render_break_next (&ts->x_break, xr->width);
1179 render_break_init (&ts->y_break, x_slice, V);
1182 space = xr->length - xr->y;
1183 if (render_break_next_size (&ts->y_break) > space)
1189 y_slice = render_break_next (&ts->y_break, space);
1190 if (ts->caption_height)
1193 xr_draw_title (xr, table_item_get_caption (ts->table_item),
1194 xr->width, ts->caption_height);
1196 xr->y += ts->caption_height;
1197 ts->caption_height = 0;
1201 render_page_draw (y_slice);
1202 xr->y += render_page_get_size (y_slice, V);
1203 render_page_unref (y_slice);
1208 xr_table_destroy (struct xr_render_fsm *fsm)
1210 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1212 table_item_unref (ts->table_item);
1213 render_break_destroy (&ts->x_break);
1214 render_break_destroy (&ts->y_break);
1218 static struct xr_render_fsm *
1219 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1221 struct xr_table_state *ts;
1222 struct render_page *page;
1225 ts = xmalloc (sizeof *ts);
1226 ts->fsm.render = xr_table_render;
1227 ts->fsm.destroy = xr_table_destroy;
1228 ts->table_item = table_item_ref (table_item);
1231 xr->y += xr->char_height;
1233 page = xr_render_table_item (xr, table_item,
1234 &caption_width, &ts->caption_height);
1235 xr->params->size[V] = xr->length - ts->caption_height;
1237 render_break_init (&ts->x_break, page, H);
1238 render_break_init_empty (&ts->y_break);
1243 struct xr_chart_state
1245 struct xr_render_fsm fsm;
1246 struct chart_item *chart_item;
1250 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1252 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1257 if (xr->cairo != NULL)
1258 xr_draw_chart (cs->chart_item, xr->cairo, 0.0, 0.0,
1259 xr_to_pt (xr->width), xr_to_pt (xr->length));
1266 xr_chart_destroy (struct xr_render_fsm *fsm)
1268 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1270 chart_item_unref (cs->chart_item);
1274 static struct xr_render_fsm *
1275 xr_render_chart (const struct chart_item *chart_item)
1277 struct xr_chart_state *cs;
1279 cs = xmalloc (sizeof *cs);
1280 cs->fsm.render = xr_chart_render;
1281 cs->fsm.destroy = xr_chart_destroy;
1282 cs->chart_item = chart_item_ref (chart_item);
1288 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1294 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1296 /* Nothing to do. */
1299 static struct xr_render_fsm *
1300 xr_render_eject (void)
1302 static struct xr_render_fsm eject_renderer =
1308 return &eject_renderer;
1311 static struct xr_render_fsm *
1312 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1314 struct table_item *table_item;
1315 struct xr_render_fsm *fsm;
1317 table_item = table_item_create (table_from_string (TAB_LEFT, text), NULL);
1318 fsm = xr_render_table (xr, table_item);
1319 table_item_unref (table_item);
1324 static struct xr_render_fsm *
1325 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1327 enum text_item_type type = text_item_get_type (text_item);
1328 const char *text = text_item_get_text (text_item);
1332 case TEXT_ITEM_TITLE:
1334 xr->title = xstrdup (text);
1337 case TEXT_ITEM_SUBTITLE:
1338 free (xr->subtitle);
1339 xr->subtitle = xstrdup (text);
1342 case TEXT_ITEM_COMMAND_CLOSE:
1345 case TEXT_ITEM_BLANK_LINE:
1347 xr->y += xr->char_height;
1350 case TEXT_ITEM_EJECT_PAGE:
1352 return xr_render_eject ();
1356 return xr_create_text_renderer (xr, text);
1362 static struct xr_render_fsm *
1363 xr_render_message (struct xr_driver *xr,
1364 const struct message_item *message_item)
1366 const struct msg *msg = message_item_get_msg (message_item);
1367 struct xr_render_fsm *fsm;
1370 s = msg_to_string (msg, xr->command_name);
1371 fsm = xr_create_text_renderer (xr, s);
1377 static struct xr_render_fsm *
1378 xr_render_output_item (struct xr_driver *xr,
1379 const struct output_item *output_item)
1381 if (is_table_item (output_item))
1382 return xr_render_table (xr, to_table_item (output_item));
1383 else if (is_chart_item (output_item))
1384 return xr_render_chart (to_chart_item (output_item));
1385 else if (is_text_item (output_item))
1386 return xr_render_text (xr, to_text_item (output_item));
1387 else if (is_message_item (output_item))
1388 return xr_render_message (xr, to_message_item (output_item));