1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "data/file-handle-def.h"
29 #include "output/cairo-chart.h"
30 #include "output/chart-item-provider.h"
31 #include "output/charts/boxplot.h"
32 #include "output/charts/np-plot.h"
33 #include "output/charts/piechart.h"
34 #include "output/charts/barchart.h"
35 #include "output/charts/plot-hist.h"
36 #include "output/charts/roc-chart.h"
37 #include "output/charts/spreadlevel-plot.h"
38 #include "output/charts/scree.h"
39 #include "output/charts/scatterplot.h"
40 #include "output/driver-provider.h"
41 #include "output/message-item.h"
42 #include "output/options.h"
43 #include "output/render.h"
44 #include "output/tab.h"
45 #include "output/table-item.h"
46 #include "output/table.h"
47 #include "output/text-item.h"
49 #include <cairo/cairo-pdf.h>
50 #include <cairo/cairo-ps.h>
51 #include <cairo/cairo-svg.h>
52 #include <cairo/cairo.h>
54 #include <pango/pango-font.h>
55 #include <pango/pango-layout.h>
56 #include <pango/pango.h>
57 #include <pango/pangocairo.h>
60 #include "gl/intprops.h"
61 #include "gl/minmax.h"
62 #include "gl/xalloc.h"
65 #define _(msgid) gettext (msgid)
67 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
71 /* The unit used for internal measurements is inch/(72 * XR_POINT). */
72 #define XR_POINT PANGO_SCALE
74 /* Conversions to and from points. */
78 return x / (double) XR_POINT;
99 /* A font for use with Cairo. */
102 PangoFontDescription *desc;
106 /* An output item whose rendering is in progress. */
109 /* Renders as much of itself as it can on the current page. Returns true
110 if rendering is complete, false if the output item needs another
112 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
114 /* Destroys the output item. */
115 void (*destroy) (struct xr_render_fsm *);
118 /* Cairo output driver. */
121 struct output_driver driver;
123 /* User parameters. */
124 struct xr_font fonts[XR_N_FONTS];
126 int width; /* Page width minus margins. */
127 int length; /* Page length minus margins and header. */
129 int left_margin; /* Left margin in inch/(72 * XR_POINT). */
130 int right_margin; /* Right margin in inch/(72 * XR_POINT). */
131 int top_margin; /* Top margin in inch/(72 * XR_POINT). */
132 int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */
134 int line_gutter; /* Space around lines. */
135 int line_space; /* Space between lines. */
136 int line_width; /* Width of lines. */
140 int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
142 struct xr_color bg; /* Background color */
143 struct xr_color fg; /* Foreground color */
145 /* Internal state. */
146 struct render_params *params;
147 int char_width, char_height;
152 int page_number; /* Current page number. */
154 struct xr_render_fsm *fsm;
158 static const struct output_driver_class cairo_driver_class;
160 static void xr_driver_destroy_fsm (struct xr_driver *);
161 static void xr_driver_run_fsm (struct xr_driver *);
163 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
164 enum render_line_style styles[TABLE_N_AXES][2]);
165 static void xr_measure_cell_width (void *, const struct table_cell *,
167 static int xr_measure_cell_height (void *, const struct table_cell *,
169 static void xr_draw_cell (void *, const struct table_cell *,
170 int bb[TABLE_N_AXES][2],
171 int clip[TABLE_N_AXES][2]);
172 static int xr_adjust_break (void *, const struct table_cell *,
173 int width, int height);
175 static struct xr_render_fsm *xr_render_output_item (
176 struct xr_driver *, const struct output_item *);
178 /* Output driver basics. */
180 static struct xr_driver *
181 xr_driver_cast (struct output_driver *driver)
183 assert (driver->class == &cairo_driver_class);
184 return UP_CAST (driver, struct xr_driver, driver);
187 static struct driver_option *
188 opt (struct output_driver *d, struct string_map *options, const char *key,
189 const char *default_value)
191 return driver_option_get (d, options, key, default_value);
194 /* Parse color information specified by KEY into {RED,GREEN,BLUE}.
195 Currently, the input string must be of the form "#RRRRGGGGBBBB"
196 Future implementations might allow things like "yellow" and
197 "sky-blue-ultra-brown"
200 parse_color (struct output_driver *d, struct string_map *options,
201 const char *key, const char *default_value,
202 struct xr_color *color)
204 int red, green, blue;
205 char *string = parse_string (opt (d, options, key, default_value));
207 if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue))
209 /* If the parsed option string fails, then try the default value */
210 if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue))
212 /* ... and if that fails set everything to zero */
213 red = green = blue = 0;
219 /* Convert 16 bit ints to float */
220 color->red = red / (double) 0xFFFF;
221 color->green = green / (double) 0xFFFF;
222 color->blue = blue / (double) 0xFFFF;
225 static PangoFontDescription *
226 parse_font (struct output_driver *d, struct string_map *options,
227 const char *key, const char *default_value,
230 PangoFontDescription *desc;
233 /* Parse KEY as a font description. */
234 string = parse_string (opt (d, options, key, default_value));
235 desc = pango_font_description_from_string (string);
238 msg (MW, _("`%s': bad font specification"), string);
240 /* Fall back to DEFAULT_VALUE, which had better be a valid font
242 desc = pango_font_description_from_string (default_value);
243 assert (desc != NULL);
247 /* If the font description didn't include an explicit font size, then set it
248 to DEFAULT_SIZE, which is in inch/72000 units. */
249 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
250 pango_font_description_set_size (desc,
251 (default_size / 1000.0) * PANGO_SCALE);
258 apply_options (struct xr_driver *xr, struct string_map *o)
260 struct output_driver *d = &xr->driver;
262 /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */
263 int left_margin, right_margin;
264 int top_margin, bottom_margin;
265 int paper_width, paper_length;
267 int min_break[TABLE_N_AXES];
269 /* Scale factor from inch/72000 to inch/(72 * XR_POINT). */
270 const double scale = XR_POINT / 1000.;
274 for (i = 0; i < XR_N_FONTS; i++)
276 struct xr_font *font = &xr->fonts[i];
278 if (font->desc != NULL)
279 pango_font_description_free (font->desc);
282 font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
283 xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace",
285 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font",
286 "sans serif", font_size);
287 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font",
288 "sans serif italic", font_size);
289 xr->fonts[XR_FONT_MARKER].desc = parse_font (d, o, "marker-font", "sans serif",
290 font_size * PANGO_SCALE_X_SMALL);
292 xr->line_gutter = XR_POINT / 2;
293 xr->line_space = XR_POINT;
294 xr->line_width = XR_POINT / 2;
297 parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg);
298 parse_color (d, o, "foreground-color", "#000000000000", &xr->fg);
300 /* Get dimensions. */
301 parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length);
302 left_margin = parse_dimension (opt (d, o, "left-margin", ".5in"));
303 right_margin = parse_dimension (opt (d, o, "right-margin", ".5in"));
304 top_margin = parse_dimension (opt (d, o, "top-margin", ".5in"));
305 bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in"));
307 min_break[H] = parse_dimension (opt (d, o, "min-hbreak", NULL)) * scale;
308 min_break[V] = parse_dimension (opt (d, o, "min-vbreak", NULL)) * scale;
310 /* Convert to inch/(XR_POINT * 72). */
311 xr->left_margin = left_margin * scale;
312 xr->right_margin = right_margin * scale;
313 xr->top_margin = top_margin * scale;
314 xr->bottom_margin = bottom_margin * scale;
315 xr->width = (paper_width - left_margin - right_margin) * scale;
316 xr->length = (paper_length - top_margin - bottom_margin) * scale;
317 xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2;
318 xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2;
321 static struct xr_driver *
322 xr_allocate (const char *name, int device_type, struct string_map *o)
324 struct xr_driver *xr = xzalloc (sizeof *xr);
325 struct output_driver *d = &xr->driver;
327 output_driver_init (d, &cairo_driver_class, name, device_type);
329 apply_options (xr, o);
335 pango_to_xr (int pango)
337 return (XR_POINT != PANGO_SCALE
338 ? ceil (pango * (1. * XR_POINT / PANGO_SCALE))
345 return (XR_POINT != PANGO_SCALE
346 ? ceil (xr * (1. / XR_POINT * PANGO_SCALE))
351 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
357 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
361 for (i = 0; i < XR_N_FONTS; i++)
363 struct xr_font *font = &xr->fonts[i];
364 int char_width, char_height;
366 font->layout = pango_cairo_create_layout (cairo);
367 pango_layout_set_font_description (font->layout, font->desc);
369 pango_layout_set_text (font->layout, "0", 1);
370 pango_layout_get_size (font->layout, &char_width, &char_height);
371 xr->char_width = MAX (xr->char_width, pango_to_xr (char_width));
372 xr->char_height = MAX (xr->char_height, pango_to_xr (char_height));
374 xr->cell_margin = xr->char_width / 2;
376 if (xr->params == NULL)
378 xr->params = xmalloc (sizeof *xr->params);
379 xr->params->draw_line = xr_draw_line;
380 xr->params->measure_cell_width = xr_measure_cell_width;
381 xr->params->measure_cell_height = xr_measure_cell_height;
382 xr->params->adjust_break = xr_adjust_break;
383 xr->params->draw_cell = xr_draw_cell;
384 xr->params->aux = xr;
385 xr->params->size[H] = xr->width;
386 xr->params->size[V] = xr->length;
387 xr->params->font_size[H] = xr->char_width;
388 xr->params->font_size[V] = xr->char_height;
390 int lg = xr->line_gutter;
391 int lw = xr->line_width;
392 int ls = xr->line_space;
393 for (i = 0; i < TABLE_N_AXES; i++)
395 xr->params->line_widths[i][RENDER_LINE_NONE] = 0;
396 xr->params->line_widths[i][RENDER_LINE_SINGLE] = 2 * lg + lw;
397 xr->params->line_widths[i][RENDER_LINE_DASHED] = 2 * lg + lw;
398 xr->params->line_widths[i][RENDER_LINE_THICK] = 2 * lg + lw * 3;
399 xr->params->line_widths[i][RENDER_LINE_THIN] = 2 * lg + lw / 2;
400 xr->params->line_widths[i][RENDER_LINE_DOUBLE] = 2 * (lg + lw) + ls;
403 for (i = 0; i < TABLE_N_AXES; i++)
404 xr->params->min_break[i] = xr->min_break[i];
405 xr->params->supports_margins = true;
408 cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue);
413 static struct output_driver *
414 xr_create (const char *file_name, enum settings_output_devices device_type,
415 struct string_map *o, enum xr_output_type file_type)
417 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
418 struct xr_driver *xr;
419 cairo_surface_t *surface;
420 cairo_status_t status;
421 double width_pt, length_pt;
423 xr = xr_allocate (file_name, device_type, o);
425 width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
426 length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
427 if (file_type == XR_PDF)
428 surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
429 else if (file_type == XR_PS)
430 surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
431 else if (file_type == XR_SVG)
432 surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
436 status = cairo_surface_status (surface);
437 if (status != CAIRO_STATUS_SUCCESS)
439 msg (ME, _("error opening output file `%s': %s"),
440 file_name, cairo_status_to_string (status));
441 cairo_surface_destroy (surface);
445 xr->cairo = cairo_create (surface);
446 cairo_surface_destroy (surface);
448 if (!xr_set_cairo (xr, xr->cairo))
451 cairo_save (xr->cairo);
452 xr_driver_next_page (xr, xr->cairo);
454 if (xr->width / xr->char_width < MIN_WIDTH)
456 msg (ME, _("The defined page is not wide enough to hold at least %d "
457 "characters in the default font. In fact, there's only "
458 "room for %d characters."),
460 xr->width / xr->char_width);
464 if (xr->length / xr->char_height < MIN_LENGTH)
466 msg (ME, _("The defined page is not long enough to hold at least %d "
467 "lines in the default font. In fact, there's only "
468 "room for %d lines."),
470 xr->length / xr->char_height);
477 output_driver_destroy (&xr->driver);
481 static struct output_driver *
482 xr_pdf_create (struct file_handle *fh, enum settings_output_devices device_type,
483 struct string_map *o)
485 struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_PDF);
490 static struct output_driver *
491 xr_ps_create (struct file_handle *fh, enum settings_output_devices device_type,
492 struct string_map *o)
494 struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_PS);
499 static struct output_driver *
500 xr_svg_create (struct file_handle *fh, enum settings_output_devices device_type,
501 struct string_map *o)
503 struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_SVG);
509 xr_destroy (struct output_driver *driver)
511 struct xr_driver *xr = xr_driver_cast (driver);
514 xr_driver_destroy_fsm (xr);
516 if (xr->cairo != NULL)
518 cairo_status_t status;
520 cairo_surface_finish (cairo_get_target (xr->cairo));
521 status = cairo_status (xr->cairo);
522 if (status != CAIRO_STATUS_SUCCESS)
523 msg (ME, _("error drawing output for %s driver: %s"),
524 output_driver_get_name (driver),
525 cairo_status_to_string (status));
526 cairo_destroy (xr->cairo);
529 for (i = 0; i < XR_N_FONTS; i++)
531 struct xr_font *font = &xr->fonts[i];
533 if (font->desc != NULL)
534 pango_font_description_free (font->desc);
535 if (font->layout != NULL)
536 g_object_unref (font->layout);
544 xr_flush (struct output_driver *driver)
546 struct xr_driver *xr = xr_driver_cast (driver);
548 cairo_surface_flush (cairo_get_target (xr->cairo));
552 xr_submit (struct output_driver *driver, const struct output_item *output_item)
554 struct xr_driver *xr = xr_driver_cast (driver);
556 xr_driver_output_item (xr, output_item);
557 while (xr_driver_need_new_page (xr))
559 cairo_restore (xr->cairo);
560 cairo_show_page (xr->cairo);
561 cairo_save (xr->cairo);
562 xr_driver_next_page (xr, xr->cairo);
566 /* Functions for rendering a series of output items to a series of Cairo
567 contexts, with pagination.
569 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
570 its underlying implementation.
572 See the big comment in cairo.h for intended usage. */
574 /* Gives new page CAIRO to XR for output. */
576 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
579 cairo_set_source_rgb (cairo, xr->bg.red, xr->bg.green, xr->bg.blue);
580 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
582 cairo_restore (cairo);
584 cairo_translate (cairo,
585 xr_to_pt (xr->left_margin),
586 xr_to_pt (xr->top_margin));
591 xr_driver_run_fsm (xr);
594 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
595 rendering a previous output item, that is, only if xr_driver_need_new_page()
598 xr_driver_output_item (struct xr_driver *xr,
599 const struct output_item *output_item)
601 assert (xr->fsm == NULL);
602 xr->fsm = xr_render_output_item (xr, output_item);
603 xr_driver_run_fsm (xr);
606 /* Returns true if XR is in the middle of rendering an output item and needs a
607 new page to be appended using xr_driver_next_page() to make progress,
610 xr_driver_need_new_page (const struct xr_driver *xr)
612 return xr->fsm != NULL;
615 /* Returns true if the current page doesn't have any content yet. */
617 xr_driver_is_page_blank (const struct xr_driver *xr)
623 xr_driver_destroy_fsm (struct xr_driver *xr)
627 xr->fsm->destroy (xr->fsm);
633 xr_driver_run_fsm (struct xr_driver *xr)
635 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
636 xr_driver_destroy_fsm (xr);
640 xr_layout_cell (struct xr_driver *, const struct table_cell *,
641 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
642 int *width, int *height, int *brk);
645 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1, int style)
647 cairo_new_path (xr->cairo);
648 cairo_set_line_width (
650 xr_to_pt (style == RENDER_LINE_THICK ? xr->line_width * 3
651 : style == RENDER_LINE_THIN ? xr->line_width / 2
653 cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y));
654 cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y));
655 cairo_stroke (xr->cairo);
659 dump_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1)
661 cairo_new_path (xr->cairo);
662 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
663 cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y));
664 cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y0 + xr->y));
665 cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y));
666 cairo_line_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y1 + xr->y));
667 cairo_close_path (xr->cairo);
668 cairo_stroke (xr->cairo);
672 fill_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1)
674 cairo_new_path (xr->cairo);
675 cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width));
676 cairo_rectangle (xr->cairo,
677 xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y),
678 xr_to_pt (x1 - x0), xr_to_pt (y1 - y0));
679 cairo_fill (xr->cairo);
682 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
683 shortening it to X0...X1 if SHORTEN is true.
684 Draws a horizontal line X1...X3 at Y if RIGHT says so,
685 shortening it to X2...X3 if SHORTEN is true. */
687 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
688 enum render_line_style left, enum render_line_style right,
691 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten)
692 dump_line (xr, x0, y, x3, y, left);
695 if (left != RENDER_LINE_NONE)
696 dump_line (xr, x0, y, shorten ? x1 : x2, y, left);
697 if (right != RENDER_LINE_NONE)
698 dump_line (xr, shorten ? x2 : x1, y, x3, y, right);
702 /* Draws a vertical line Y0...Y2 at X if TOP says so,
703 shortening it to Y0...Y1 if SHORTEN is true.
704 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
705 shortening it to Y2...Y3 if SHORTEN is true. */
707 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
708 enum render_line_style top, enum render_line_style bottom,
711 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten)
712 dump_line (xr, x, y0, x, y3, top);
715 if (top != RENDER_LINE_NONE)
716 dump_line (xr, x, y0, x, shorten ? y1 : y2, top);
717 if (bottom != RENDER_LINE_NONE)
718 dump_line (xr, x, shorten ? y2 : y1, x, y3, bottom);
723 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
724 enum render_line_style styles[TABLE_N_AXES][2])
726 const int x0 = bb[H][0];
727 const int y0 = bb[V][0];
728 const int x3 = bb[H][1];
729 const int y3 = bb[V][1];
730 const int top = styles[H][0];
731 const int bottom = styles[H][1];
732 const int start_of_line = render_direction_rtl() ? styles[V][1]: styles[V][0];
733 const int end_of_line = render_direction_rtl() ? styles[V][0]: styles[V][1];
735 /* The algorithm here is somewhat subtle, to allow it to handle
736 all the kinds of intersections that we need.
738 Three additional ordinates are assigned along the x axis. The
739 first is xc, midway between x0 and x3. The others are x1 and
740 x2; for a single vertical line these are equal to xc, and for
741 a double vertical line they are the ordinates of the left and
742 right half of the double line.
744 yc, y1, and y2 are assigned similarly along the y axis.
746 The following diagram shows the coordinate system and output
747 for double top and bottom lines, single left line, and no
751 y0 ________________________
757 y1 = y2 = yc |######### # |
762 y3 |________#_____#_______|
764 struct xr_driver *xr = xr_;
766 /* Offset from center of each line in a pair of double lines. */
767 int double_line_ofs = (xr->line_space + xr->line_width) / 2;
769 /* Are the lines along each axis single or double?
770 (It doesn't make sense to have different kinds of line on the
771 same axis, so we don't try to gracefully handle that case.) */
772 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
773 bool double_horz = start_of_line == RENDER_LINE_DOUBLE || end_of_line == RENDER_LINE_DOUBLE;
775 /* When horizontal lines are doubled,
776 the left-side line along y1 normally runs from x0 to x2,
777 and the right-side line along y1 from x3 to x1.
778 If the top-side line is also doubled, we shorten the y1 lines,
779 so that the left-side line runs only to x1,
780 and the right-side line only to x2.
781 Otherwise, the horizontal line at y = y1 below would cut off
782 the intersection, which looks ugly:
784 y0 ________________________
789 y1 |######### ########|
792 y2 |######################|
795 y3 |______________________|
796 It is more of a judgment call when the horizontal line is
797 single. We actually choose to cut off the line anyhow, as
798 shown in the first diagram above.
800 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
801 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
802 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
803 int horz_line_ofs = double_vert ? double_line_ofs : 0;
804 int xc = (x0 + x3) / 2;
805 int x1 = xc - horz_line_ofs;
806 int x2 = xc + horz_line_ofs;
808 bool shorten_x1_lines = start_of_line == RENDER_LINE_DOUBLE;
809 bool shorten_x2_lines = end_of_line == RENDER_LINE_DOUBLE;
810 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
811 int vert_line_ofs = double_horz ? double_line_ofs : 0;
812 int yc = (y0 + y3) / 2;
813 int y1 = yc - vert_line_ofs;
814 int y2 = yc + vert_line_ofs;
817 horz_line (xr, x0, x1, x2, x3, yc, start_of_line, end_of_line, shorten_yc_line);
820 horz_line (xr, x0, x1, x2, x3, y1, start_of_line, end_of_line, shorten_y1_lines);
821 horz_line (xr, x0, x1, x2, x3, y2, start_of_line, end_of_line, shorten_y2_lines);
825 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, shorten_xc_line);
828 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, shorten_x1_lines);
829 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, shorten_x2_lines);
834 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
835 int *min_width, int *max_width)
837 struct xr_driver *xr = xr_;
838 int bb[TABLE_N_AXES][2];
839 int clip[TABLE_N_AXES][2];
846 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
847 xr_layout_cell (xr, cell, bb, clip, max_width, &h, NULL);
850 xr_layout_cell (xr, cell, bb, clip, min_width, &h, NULL);
853 *min_width += xr->cell_margin * 2;
855 *max_width += xr->cell_margin * 2;
859 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
861 struct xr_driver *xr = xr_;
862 int bb[TABLE_N_AXES][2];
863 int clip[TABLE_N_AXES][2];
867 bb[H][1] = width - xr->cell_margin * 2;
870 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
871 xr_layout_cell (xr, cell, bb, clip, &w, &h, NULL);
875 static void xr_clip (struct xr_driver *, int clip[TABLE_N_AXES][2]);
878 xr_draw_cell (void *xr_, const struct table_cell *cell,
879 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2])
881 struct xr_driver *xr = xr_;
884 cairo_save (xr->cairo);
886 cairo_set_source_rgb (xr->cairo,
887 cell->style->bg.r / 255.,
888 cell->style->bg.g / 255.,
889 cell->style->bg.b / 255.);
890 fill_rectangle (xr, bb[H][0], bb[V][0], bb[H][1], bb[V][1]);
891 cairo_restore (xr->cairo);
893 cairo_save (xr->cairo);
894 cairo_set_source_rgb (xr->cairo,
895 cell->style->fg.r / 255.,
896 cell->style->fg.g / 255.,
897 cell->style->fg.b / 255.);
899 bb[H][0] += xr->cell_margin;
900 bb[H][1] -= xr->cell_margin;
901 if (bb[H][0] < bb[H][1])
902 xr_layout_cell (xr, cell, bb, clip, &w, &h, &brk);
903 cairo_restore (xr->cairo);
907 xr_adjust_break (void *xr_, const struct table_cell *cell,
908 int width, int height)
910 struct xr_driver *xr = xr_;
911 int bb[TABLE_N_AXES][2];
912 int clip[TABLE_N_AXES][2];
915 if (xr_measure_cell_height (xr_, cell, width) < height)
919 bb[H][1] = width - 2 * xr->cell_margin;
924 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
925 xr_layout_cell (xr, cell, bb, clip, &w, &h, &brk);
930 xr_clip (struct xr_driver *xr, int clip[TABLE_N_AXES][2])
932 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
934 double x0 = xr_to_pt (clip[H][0] + xr->x);
935 double y0 = xr_to_pt (clip[V][0] + xr->y);
936 double x1 = xr_to_pt (clip[H][1] + xr->x);
937 double y1 = xr_to_pt (clip[V][1] + xr->y);
939 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
940 cairo_clip (xr->cairo);
945 add_attr_with_start (PangoAttrList *list, PangoAttribute *attr, guint start_index)
947 attr->start_index = start_index;
948 pango_attr_list_insert (list, attr);
952 xr_layout_cell_text (struct xr_driver *xr,
953 const struct cell_contents *contents,
954 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
955 int *widthp, int *brk)
957 unsigned int options = contents->options;
958 struct xr_font *font;
959 bool merge_footnotes;
963 if (contents->n_footnotes == 0)
964 merge_footnotes = false;
965 else if (contents->n_footnotes == 1 && (options & TAB_HALIGN) == TAB_RIGHT)
967 PangoAttrList *attrs;
969 font = &xr->fonts[XR_FONT_MARKER];
971 const char *marker = contents->footnotes[0]->marker;
972 pango_layout_set_text (font->layout, marker, strlen (marker));
974 attrs = pango_attr_list_new ();
975 pango_attr_list_insert (attrs, pango_attr_rise_new (7000));
976 pango_layout_set_attributes (font->layout, attrs);
977 pango_attr_list_unref (attrs);
979 pango_layout_get_size (font->layout, &w, &h);
980 merge_footnotes = w > xr->cell_margin;
981 if (!merge_footnotes && clip[H][0] != clip[H][1])
983 cairo_save (xr->cairo);
985 cairo_translate (xr->cairo,
986 xr_to_pt (bb[H][1] + xr->x),
987 xr_to_pt (bb[V][0] + xr->y));
988 pango_layout_set_alignment (font->layout, PANGO_ALIGN_LEFT);
989 pango_layout_set_width (font->layout, -1);
990 pango_cairo_show_layout (xr->cairo, font->layout);
991 cairo_restore (xr->cairo);
994 pango_layout_set_attributes (font->layout, NULL);
997 merge_footnotes = true;
999 font = (options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
1000 : options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS]
1001 : &xr->fonts[XR_FONT_PROPORTIONAL]);
1003 length = strlen (contents->text);
1004 if (merge_footnotes)
1006 PangoAttrList *attrs;
1009 bb[H][1] += xr->cell_margin;
1012 ds_extend (&s, length + contents->n_footnotes * 10);
1013 ds_put_cstr (&s, contents->text);
1014 cell_contents_format_footnote_markers (contents, &s);
1015 pango_layout_set_text (font->layout, ds_cstr (&s), ds_length (&s));
1018 attrs = pango_attr_list_new ();
1019 add_attr_with_start (attrs, pango_attr_rise_new (7000), length);
1020 add_attr_with_start (
1021 attrs, pango_attr_font_desc_new (xr->fonts[XR_FONT_MARKER].desc), length);
1022 pango_layout_set_attributes (font->layout, attrs);
1023 pango_attr_list_unref (attrs);
1026 pango_layout_set_text (font->layout, contents->text, -1);
1028 pango_layout_set_alignment (
1030 ((options & TAB_HALIGN) == TAB_RIGHT ? PANGO_ALIGN_RIGHT
1031 : (options & TAB_HALIGN) == TAB_LEFT ? PANGO_ALIGN_LEFT
1032 : PANGO_ALIGN_CENTER));
1033 pango_layout_set_width (
1035 bb[H][1] == INT_MAX ? -1 : xr_to_pango (bb[H][1] - bb[H][0]));
1036 pango_layout_set_wrap (font->layout, PANGO_WRAP_WORD);
1038 if (clip[H][0] != clip[H][1])
1040 cairo_save (xr->cairo);
1042 cairo_translate (xr->cairo,
1043 xr_to_pt (bb[H][0] + xr->x),
1044 xr_to_pt (bb[V][0] + xr->y));
1045 pango_cairo_show_layout (xr->cairo, font->layout);
1047 /* If enabled, this draws a blue rectangle around the extents of each
1048 line of text, which can be rather useful for debugging layout
1052 PangoLayoutIter *iter;
1053 iter = pango_layout_get_iter (font->layout);
1056 PangoRectangle extents;
1058 pango_layout_iter_get_line_extents (iter, &extents, NULL);
1059 cairo_save (xr->cairo);
1060 cairo_set_source_rgb (xr->cairo, 1, 0, 0);
1062 pango_to_xr (extents.x) - xr->x,
1063 pango_to_xr (extents.y) - xr->y,
1064 pango_to_xr (extents.x + extents.width) - xr->x,
1065 pango_to_xr (extents.y + extents.height) - xr->y);
1066 cairo_restore (xr->cairo);
1068 while (pango_layout_iter_next_line (iter));
1069 pango_layout_iter_free (iter);
1072 cairo_restore (xr->cairo);
1075 pango_layout_get_size (font->layout, &w, &h);
1076 w = pango_to_xr (w);
1077 h = pango_to_xr (h);
1080 if (bb[V][0] + h >= bb[V][1])
1082 PangoLayoutIter *iter;
1083 int best UNUSED = 0;
1085 /* Choose a breakpoint between lines instead of in the middle of one. */
1086 iter = pango_layout_get_iter (font->layout);
1089 PangoRectangle extents;
1093 pango_layout_iter_get_line_extents (iter, NULL, &extents);
1094 pango_layout_iter_get_line_yrange (iter, &y0, &y1);
1095 extents.x = pango_to_xr (extents.x);
1096 extents.y = pango_to_xr (y0);
1097 extents.width = pango_to_xr (extents.width);
1098 extents.height = pango_to_xr (y1 - y0);
1099 bottom = bb[V][0] + extents.y + extents.height;
1100 if (bottom < bb[V][1])
1102 if (brk && clip[H][0] != clip[H][1])
1110 while (pango_layout_iter_next_line (iter));
1111 pango_layout_iter_free (iter);
1113 /* If enabled, draws a green line across the chosen breakpoint, which can
1114 be useful for debugging issues with breaking. */
1117 if (best && !xr->nest)
1119 cairo_save (xr->cairo);
1120 cairo_set_source_rgb (xr->cairo, 0, 1, 0);
1121 dump_line (xr, -xr->left_margin, best,
1122 xr->width + xr->right_margin, best,
1123 RENDER_LINE_SINGLE);
1124 cairo_restore (xr->cairo);
1129 pango_layout_set_attributes (font->layout, NULL);
1130 return bb[V][0] + h;
1134 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
1135 int bb_[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
1136 int *width, int *height, int *brk)
1138 int bb[TABLE_N_AXES][2];
1146 memcpy (bb, bb_, sizeof bb);
1148 /* If enabled, draws a blue rectangle around the cell extents, which can be
1149 useful for debugging layout. */
1152 if (clip[H][0] != clip[H][1])
1154 int offset = (xr->nest) * XR_POINT;
1156 cairo_save (xr->cairo);
1157 cairo_set_source_rgb (xr->cairo, 0, 0, 1);
1159 bb[H][0] + offset, bb[V][0] + offset,
1160 bb[H][1] - offset, bb[V][1] - offset);
1161 cairo_restore (xr->cairo);
1165 for (i = 0; i < cell->n_contents && bb[V][0] < bb[V][1]; i++)
1167 const struct cell_contents *contents = &cell->contents[i];
1173 bb[V][0] += xr->char_height / 2;
1174 if (bb[V][0] >= bb[V][1])
1180 bb[V][0] = xr_layout_cell_text (xr, contents, bb, clip, width, brk);
1182 *height = bb[V][0] - bb_[V][0];
1185 struct output_driver_factory pdf_driver_factory =
1186 { "pdf", "pspp.pdf", xr_pdf_create };
1187 struct output_driver_factory ps_driver_factory =
1188 { "ps", "pspp.ps", xr_ps_create };
1189 struct output_driver_factory svg_driver_factory =
1190 { "svg", "pspp.svg", xr_svg_create };
1192 static const struct output_driver_class cairo_driver_class =
1200 /* GUI rendering helpers. */
1204 struct output_item *item;
1207 struct render_pager *p;
1208 struct xr_driver *xr;
1211 #define CHART_WIDTH 500
1212 #define CHART_HEIGHT 375
1217 xr_driver_create (cairo_t *cairo, struct string_map *options)
1219 struct xr_driver *xr = xr_allocate ("cairo", 0, options);
1220 if (!xr_set_cairo (xr, cairo))
1222 output_driver_destroy (&xr->driver);
1228 /* Destroy XR, which should have been created with xr_driver_create(). Any
1229 cairo_t added to XR is not destroyed, because it is owned by the client. */
1231 xr_driver_destroy (struct xr_driver *xr)
1236 output_driver_destroy (&xr->driver);
1240 static struct xr_rendering *
1241 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
1243 struct table_item *table_item;
1244 struct xr_rendering *r;
1246 table_item = table_item_create (table_from_string (TAB_LEFT, text),
1248 r = xr_rendering_create (xr, &table_item->output_item, cr);
1249 table_item_unref (table_item);
1255 xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o)
1257 if (is_table_item (xr->item))
1258 apply_options (xr->xr, o);
1261 struct xr_rendering *
1262 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
1265 struct xr_rendering *r = NULL;
1267 if (is_text_item (item))
1268 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
1270 else if (is_message_item (item))
1272 const struct message_item *message_item = to_message_item (item);
1273 const struct msg *msg = message_item_get_msg (message_item);
1274 char *s = msg_to_string (msg, NULL);
1275 r = xr_rendering_create_text (xr, s, cr);
1278 else if (is_table_item (item))
1280 r = xzalloc (sizeof *r);
1281 r->item = output_item_ref (item);
1283 xr_set_cairo (xr, cr);
1284 r->p = render_pager_create (xr->params, to_table_item (item));
1286 else if (is_chart_item (item))
1288 r = xzalloc (sizeof *r);
1289 r->item = output_item_ref (item);
1296 xr_rendering_destroy (struct xr_rendering *r)
1300 output_item_unref (r->item);
1301 render_pager_destroy (r->p);
1307 xr_rendering_measure (struct xr_rendering *r, int *w, int *h)
1309 if (is_table_item (r->item))
1311 *w = render_pager_get_size (r->p, H) / XR_POINT;
1312 *h = render_pager_get_size (r->p, V) / XR_POINT;
1321 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1322 double x, double y, double width, double height);
1326 xr_rendering_draw_all (struct xr_rendering *r, cairo_t *cr)
1328 if (is_table_item (r->item))
1330 struct xr_driver *xr = r->xr;
1332 xr_set_cairo (xr, cr);
1334 render_pager_draw (r->p);
1338 xr_draw_chart (to_chart_item (r->item), cr,
1339 0, 0, CHART_WIDTH, CHART_HEIGHT);
1343 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1344 double x, double y, double width, double height)
1346 struct xrchart_geometry geom;
1349 cairo_translate (cr, x, y + height);
1350 cairo_scale (cr, 1.0, -1.0);
1351 xrchart_geometry_init (cr, &geom, width, height);
1352 if (is_boxplot (chart_item))
1353 xrchart_draw_boxplot (chart_item, cr, &geom);
1354 else if (is_histogram_chart (chart_item))
1355 xrchart_draw_histogram (chart_item, cr, &geom);
1356 else if (is_np_plot_chart (chart_item))
1357 xrchart_draw_np_plot (chart_item, cr, &geom);
1358 else if (is_piechart (chart_item))
1359 xrchart_draw_piechart (chart_item, cr, &geom);
1360 else if (is_barchart (chart_item))
1361 xrchart_draw_barchart (chart_item, cr, &geom);
1362 else if (is_roc_chart (chart_item))
1363 xrchart_draw_roc (chart_item, cr, &geom);
1364 else if (is_scree (chart_item))
1365 xrchart_draw_scree (chart_item, cr, &geom);
1366 else if (is_spreadlevel_plot_chart (chart_item))
1367 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1368 else if (is_scatterplot_chart (chart_item))
1369 xrchart_draw_scatterplot (chart_item, cr, &geom);
1372 xrchart_geometry_free (cr, &geom);
1378 xr_draw_png_chart (const struct chart_item *item,
1379 const char *file_name_template, int number,
1380 const struct xr_color *fg,
1381 const struct xr_color *bg
1384 const int width = 640;
1385 const int length = 480;
1387 cairo_surface_t *surface;
1388 cairo_status_t status;
1389 const char *number_pos;
1393 number_pos = strchr (file_name_template, '#');
1394 if (number_pos != NULL)
1395 file_name = xasprintf ("%.*s%d%s", (int) (number_pos - file_name_template),
1396 file_name_template, number, number_pos + 1);
1398 file_name = xstrdup (file_name_template);
1400 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1401 cr = cairo_create (surface);
1403 cairo_set_source_rgb (cr, bg->red, bg->green, bg->blue);
1406 cairo_set_source_rgb (cr, fg->red, fg->green, fg->blue);
1408 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1410 status = cairo_surface_write_to_png (surface, file_name);
1411 if (status != CAIRO_STATUS_SUCCESS)
1412 msg (ME, _("error writing output file `%s': %s"),
1413 file_name, cairo_status_to_string (status));
1416 cairo_surface_destroy (surface);
1421 struct xr_table_state
1423 struct xr_render_fsm fsm;
1424 struct table_item *table_item;
1425 struct render_pager *p;
1429 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1431 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1433 while (render_pager_has_next (ts->p))
1437 used = render_pager_draw_next (ts->p, xr->length - xr->y);
1450 xr_table_destroy (struct xr_render_fsm *fsm)
1452 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1454 table_item_unref (ts->table_item);
1455 render_pager_destroy (ts->p);
1459 static struct xr_render_fsm *
1460 xr_render_table (struct xr_driver *xr, const struct table_item *table_item)
1462 struct xr_table_state *ts;
1464 ts = xmalloc (sizeof *ts);
1465 ts->fsm.render = xr_table_render;
1466 ts->fsm.destroy = xr_table_destroy;
1467 ts->table_item = table_item_ref (table_item);
1470 xr->y += xr->char_height;
1472 ts->p = render_pager_create (xr->params, table_item);
1477 struct xr_chart_state
1479 struct xr_render_fsm fsm;
1480 struct chart_item *chart_item;
1484 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1486 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1488 const int chart_height = 0.8 * (xr->length < xr->width ? xr->length : xr->width);
1490 if (xr->y > xr->length - chart_height)
1493 if (xr->cairo != NULL)
1495 xr_draw_chart (cs->chart_item, xr->cairo,
1498 xr_to_pt (xr->width),
1499 xr_to_pt (chart_height));
1501 xr->y += chart_height;
1507 xr_chart_destroy (struct xr_render_fsm *fsm)
1509 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1511 chart_item_unref (cs->chart_item);
1515 static struct xr_render_fsm *
1516 xr_render_chart (const struct chart_item *chart_item)
1518 struct xr_chart_state *cs;
1520 cs = xmalloc (sizeof *cs);
1521 cs->fsm.render = xr_chart_render;
1522 cs->fsm.destroy = xr_chart_destroy;
1523 cs->chart_item = chart_item_ref (chart_item);
1529 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1535 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1537 /* Nothing to do. */
1540 static struct xr_render_fsm *
1541 xr_render_eject (void)
1543 static struct xr_render_fsm eject_renderer =
1549 return &eject_renderer;
1552 static struct xr_render_fsm *
1553 xr_create_text_renderer (struct xr_driver *xr, const char *text)
1555 struct table_item *table_item;
1556 struct xr_render_fsm *fsm;
1558 table_item = table_item_create (table_from_string (TAB_LEFT, text),
1560 fsm = xr_render_table (xr, table_item);
1561 table_item_unref (table_item);
1566 static struct xr_render_fsm *
1567 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1569 enum text_item_type type = text_item_get_type (text_item);
1570 const char *text = text_item_get_text (text_item);
1574 case TEXT_ITEM_TITLE:
1576 xr->title = xstrdup (text);
1579 case TEXT_ITEM_SUBTITLE:
1580 free (xr->subtitle);
1581 xr->subtitle = xstrdup (text);
1584 case TEXT_ITEM_COMMAND_CLOSE:
1587 case TEXT_ITEM_BLANK_LINE:
1589 xr->y += xr->char_height;
1592 case TEXT_ITEM_EJECT_PAGE:
1594 return xr_render_eject ();
1598 return xr_create_text_renderer (xr, text);
1604 static struct xr_render_fsm *
1605 xr_render_message (struct xr_driver *xr,
1606 const struct message_item *message_item)
1608 const struct msg *msg = message_item_get_msg (message_item);
1609 struct xr_render_fsm *fsm;
1612 s = msg_to_string (msg, message_item->command_name);
1613 fsm = xr_create_text_renderer (xr, s);
1619 static struct xr_render_fsm *
1620 xr_render_output_item (struct xr_driver *xr,
1621 const struct output_item *output_item)
1623 if (is_table_item (output_item))
1624 return xr_render_table (xr, to_table_item (output_item));
1625 else if (is_chart_item (output_item))
1626 return xr_render_chart (to_chart_item (output_item));
1627 else if (is_text_item (output_item))
1628 return xr_render_text (xr, to_text_item (output_item));
1629 else if (is_message_item (output_item))
1630 return xr_render_message (xr, to_message_item (output_item));