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/hash-functions.h"
24 #include "libpspp/message.h"
25 #include "libpspp/pool.h"
26 #include "libpspp/start-date.h"
27 #include "libpspp/str.h"
28 #include "libpspp/string-map.h"
29 #include "libpspp/version.h"
30 #include "data/file-handle-def.h"
31 #include "output/cairo-chart.h"
32 #include "output/chart-item-provider.h"
33 #include "output/charts/boxplot.h"
34 #include "output/charts/np-plot.h"
35 #include "output/charts/piechart.h"
36 #include "output/charts/barchart.h"
37 #include "output/charts/plot-hist.h"
38 #include "output/charts/roc-chart.h"
39 #include "output/charts/spreadlevel-plot.h"
40 #include "output/charts/scree.h"
41 #include "output/charts/scatterplot.h"
42 #include "output/driver-provider.h"
43 #include "output/group-item.h"
44 #include "output/message-item.h"
45 #include "output/options.h"
46 #include "output/page-eject-item.h"
47 #include "output/page-setup-item.h"
48 #include "output/render.h"
49 #include "output/table-item.h"
50 #include "output/table.h"
51 #include "output/text-item.h"
53 #include <cairo/cairo-pdf.h>
54 #include <cairo/cairo-ps.h>
55 #include <cairo/cairo-svg.h>
56 #include <cairo/cairo.h>
59 #include <pango/pango-font.h>
60 #include <pango/pango-layout.h>
61 #include <pango/pango.h>
62 #include <pango/pangocairo.h>
65 #include "gl/c-ctype.h"
66 #include "gl/c-strcase.h"
67 #include "gl/intprops.h"
68 #include "gl/minmax.h"
69 #include "gl/xalloc.h"
72 #define _(msgid) gettext (msgid)
74 /* This file uses TABLE_HORZ and TABLE_VERT enough to warrant abbreviating. */
78 /* The unit used for internal measurements is inch/(72 * XR_POINT).
79 (Thus, XR_POINT units represent one point.) */
80 #define XR_POINT PANGO_SCALE
82 /* Conversions to and from points. */
86 return x / (double) XR_POINT;
89 /* Conversion from 1/96" units ("pixels") to Cairo/Pango units. */
93 return x * (PANGO_SCALE * 72 / 96);
96 /* Dimensions for drawing lines in tables. */
97 #define XR_LINE_WIDTH (XR_POINT / 2) /* Width of an ordinary line. */
98 #define XR_LINE_SPACE XR_POINT /* Space between double lines. */
111 XR_FONT_PROPORTIONAL,
117 /* A font for use with Cairo. */
120 PangoFontDescription *desc;
124 /* An output item whose rendering is in progress. */
127 /* Renders as much of itself as it can on the current page. Returns true
128 if rendering is complete, false if the output item needs another
130 bool (*render) (struct xr_render_fsm *, struct xr_driver *);
132 /* Destroys the output item. */
133 void (*destroy) (struct xr_render_fsm *);
136 /* Cairo output driver. */
139 struct output_driver driver;
141 /* User parameters. */
142 struct xr_font fonts[XR_N_FONTS];
144 int width; /* Page width minus margins. */
145 int length; /* Page length minus margins and header. */
147 int left_margin; /* Left margin in inch/(72 * XR_POINT). */
148 int right_margin; /* Right margin in inch/(72 * XR_POINT). */
149 int top_margin; /* Top margin in inch/(72 * XR_POINT). */
150 int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */
152 int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */
153 int object_spacing; /* Space between output objects. */
155 struct cell_color bg; /* Background color */
156 struct cell_color fg; /* Foreground color */
157 bool transparent; /* true -> do not render background */
158 bool systemcolors; /* true -> do not change colors */
160 int initial_page_number;
162 struct page_heading headings[2]; /* Top and bottom headings. */
163 int headings_height[2];
165 /* Internal state. */
166 struct render_params *params;
168 int char_width, char_height;
170 cairo_surface_t *surface;
171 int page_number; /* Current page number. */
173 struct xr_render_fsm *fsm;
176 static const struct output_driver_class cairo_driver_class;
178 static void xr_driver_destroy_fsm (struct xr_driver *);
179 static void xr_driver_run_fsm (struct xr_driver *);
181 static void xr_draw_line (void *, int bb[TABLE_N_AXES][2],
182 enum render_line_style styles[TABLE_N_AXES][2],
183 struct cell_color colors[TABLE_N_AXES][2]);
184 static void xr_measure_cell_width (void *, const struct table_cell *,
186 static int xr_measure_cell_height (void *, const struct table_cell *,
188 static void xr_draw_cell (void *, const struct table_cell *, int color_idx,
189 int bb[TABLE_N_AXES][2], int valign_offset,
190 int spill[TABLE_N_AXES][2],
191 int clip[TABLE_N_AXES][2]);
192 static int xr_adjust_break (void *, const struct table_cell *,
193 int width, int height);
195 static struct xr_render_fsm *xr_render_output_item (
196 struct xr_driver *, const struct output_item *);
198 /* Output driver basics. */
200 static struct xr_driver *
201 xr_driver_cast (struct output_driver *driver)
203 assert (driver->class == &cairo_driver_class);
204 return UP_CAST (driver, struct xr_driver, driver);
207 static struct driver_option *
208 opt (struct output_driver *d, struct string_map *options, const char *key,
209 const char *default_value)
211 return driver_option_get (d, options, key, default_value);
214 static PangoFontDescription *
215 parse_font (const char *font, int default_size, bool bold, bool italic)
217 if (!c_strcasecmp (font, "Monospaced"))
220 PangoFontDescription *desc = pango_font_description_from_string (font);
224 /* If the font description didn't include an explicit font size, then set it
225 to DEFAULT_SIZE, which is in inch/72000 units. */
226 if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE))
227 pango_font_description_set_size (desc,
228 (default_size / 1000.0) * PANGO_SCALE);
230 pango_font_description_set_weight (desc, (bold
232 : PANGO_WEIGHT_NORMAL));
233 pango_font_description_set_style (desc, (italic
235 : PANGO_STYLE_NORMAL));
240 static PangoFontDescription *
241 parse_font_option (struct output_driver *d, struct string_map *options,
242 const char *key, const char *default_value,
243 int default_size, bool bold, bool italic)
245 char *string = parse_string (opt (d, options, key, default_value));
246 PangoFontDescription *desc = parse_font (string, default_size, bold, italic);
249 msg (MW, _("`%s': bad font specification"), string);
251 /* Fall back to DEFAULT_VALUE, which had better be a valid font
253 desc = parse_font (default_value, default_size, bold, italic);
254 assert (desc != NULL);
262 apply_options (struct xr_driver *xr, struct string_map *o)
264 struct output_driver *d = &xr->driver;
266 /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */
267 int left_margin, right_margin;
268 int top_margin, bottom_margin;
269 int paper_width, paper_length;
271 int min_break[TABLE_N_AXES];
273 /* Scale factor from inch/72000 to inch/(72 * XR_POINT). */
274 const double scale = XR_POINT / 1000.;
278 for (i = 0; i < XR_N_FONTS; i++)
280 struct xr_font *font = &xr->fonts[i];
282 if (font->desc != NULL)
283 pango_font_description_free (font->desc);
286 font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000);
287 xr->fonts[XR_FONT_FIXED].desc = parse_font_option
288 (d, o, "fixed-font", "monospace", font_size, false, false);
289 xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font_option (
290 d, o, "prop-font", "sans serif", font_size, false, false);
291 xr->fonts[XR_FONT_EMPHASIS].desc = parse_font_option (
292 d, o, "emph-font", "sans serif", font_size, false, true);
294 xr->fg = parse_color (opt (d, o, "foreground-color", "#000000000000"));
295 xr->bg = parse_color (opt (d, o, "background-color", "#FFFFFFFFFFFF"));
297 xr->transparent = parse_boolean (opt (d, o, "transparent", "false"));
298 xr->systemcolors = parse_boolean (opt (d, o, "systemcolors", "false"));
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 int object_spacing = (parse_dimension (opt (d, o, "object-spacing", NULL))
313 /* Convert to inch/(XR_POINT * 72). */
314 xr->left_margin = left_margin * scale;
315 xr->right_margin = right_margin * scale;
316 xr->top_margin = top_margin * scale;
317 xr->bottom_margin = bottom_margin * scale;
318 xr->width = (paper_width - left_margin - right_margin) * scale;
319 xr->length = (paper_length - top_margin - bottom_margin) * scale;
320 xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2;
321 xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2;
322 xr->object_spacing = object_spacing >= 0 ? object_spacing : XR_POINT * 12;
324 /* There are no headings so headings_height can stay 0. */
327 static struct xr_driver *
328 xr_allocate (const char *name, int device_type, struct string_map *o,
331 struct xr_driver *xr = xzalloc (sizeof *xr);
332 struct output_driver *d = &xr->driver;
334 output_driver_init (d, &cairo_driver_class, name, device_type);
336 /* This is a nasty kluge for an issue that does not make sense. On any
337 surface other than a screen (e.g. for output to PDF or PS or SVG), the
338 fonts are way too big by default. A "9-point" font seems to appear about
339 16 points tall. We use a scale factor for these surfaces to help, but the
340 underlying issue is a mystery. */
341 xr->font_scale = font_scale;
343 apply_options (xr, o);
349 pango_to_xr (int pango)
351 return (XR_POINT != PANGO_SCALE
352 ? ceil (pango * (1. * XR_POINT / PANGO_SCALE))
359 return (XR_POINT != PANGO_SCALE
360 ? ceil (xr * (1. / XR_POINT * PANGO_SCALE))
365 xr_measure_fonts (cairo_t *cairo, const struct xr_font fonts[XR_N_FONTS],
366 int *char_width, int *char_height)
370 for (int i = 0; i < XR_N_FONTS; i++)
372 PangoLayout *layout = pango_cairo_create_layout (cairo);
373 pango_layout_set_font_description (layout, fonts[i].desc);
375 pango_layout_set_text (layout, "0", 1);
378 pango_layout_get_size (layout, &cw, &ch);
379 *char_width = MAX (*char_width, pango_to_xr (cw));
380 *char_height = MAX (*char_height, pango_to_xr (ch));
382 g_object_unref (G_OBJECT (layout));
387 get_layout_height (PangoLayout *layout)
390 pango_layout_get_size (layout, &w, &h);
395 xr_render_page_heading (cairo_t *cairo, const PangoFontDescription *font,
396 const struct page_heading *ph, int page_number,
397 int width, bool draw, int base_y)
399 PangoLayout *layout = pango_cairo_create_layout (cairo);
400 pango_layout_set_font_description (layout, font);
403 for (size_t i = 0; i < ph->n; i++)
405 const struct page_paragraph *pp = &ph->paragraphs[i];
407 char *markup = output_driver_substitute_heading_vars (pp->markup,
409 pango_layout_set_markup (layout, markup, -1);
412 pango_layout_set_alignment (
414 (pp->halign == TABLE_HALIGN_LEFT ? PANGO_ALIGN_LEFT
415 : pp->halign == TABLE_HALIGN_CENTER ? PANGO_ALIGN_CENTER
416 : pp->halign == TABLE_HALIGN_MIXED ? PANGO_ALIGN_LEFT
417 : PANGO_ALIGN_RIGHT));
418 pango_layout_set_width (layout, xr_to_pango (width));
422 cairo_translate (cairo, 0, xr_to_pt (y + base_y));
423 pango_cairo_show_layout (cairo, layout);
424 cairo_restore (cairo);
427 y += pango_to_xr (get_layout_height (layout));
430 g_object_unref (G_OBJECT (layout));
436 xr_measure_headings (cairo_surface_t *surface,
437 const PangoFontDescription *font,
438 const struct page_heading headings[2],
439 int width, int object_spacing, int height[2])
441 cairo_t *cairo = cairo_create (surface);
443 for (int i = 0; i < 2; i++)
445 int h = xr_render_page_heading (cairo, font, &headings[i], -1,
448 /* If the top heading is nonempty, add some space below it. */
456 cairo_destroy (cairo);
461 xr_check_fonts (cairo_surface_t *surface,
462 const struct xr_font fonts[XR_N_FONTS],
463 int usable_width, int usable_length)
465 cairo_t *cairo = cairo_create (surface);
466 int char_width, char_height;
467 xr_measure_fonts (cairo, fonts, &char_width, &char_height);
468 cairo_destroy (cairo);
471 enum { MIN_WIDTH = 3, MIN_LENGTH = 3 };
472 if (usable_width / char_width < MIN_WIDTH)
474 msg (ME, _("The defined page is not wide enough to hold at least %d "
475 "characters in the default font. In fact, there's only "
476 "room for %d characters."),
477 MIN_WIDTH, usable_width / char_width);
480 if (usable_length / char_height < MIN_LENGTH)
482 msg (ME, _("The defined page is not long enough to hold at least %d "
483 "lines in the default font. In fact, there's only "
484 "room for %d lines."),
485 MIN_LENGTH, usable_length / char_height);
492 xr_set_cairo (struct xr_driver *xr, cairo_t *cairo)
496 cairo_set_line_width (xr->cairo, xr_to_pt (XR_LINE_WIDTH));
498 xr_measure_fonts (xr->cairo, xr->fonts, &xr->char_width, &xr->char_height);
500 for (int i = 0; i < XR_N_FONTS; i++)
502 struct xr_font *font = &xr->fonts[i];
503 font->layout = pango_cairo_create_layout (cairo);
504 pango_layout_set_font_description (font->layout, font->desc);
507 if (xr->params == NULL)
509 static const struct render_ops xr_render_ops = {
510 .draw_line = xr_draw_line,
511 .measure_cell_width = xr_measure_cell_width,
512 .measure_cell_height = xr_measure_cell_height,
513 .adjust_break = xr_adjust_break,
514 .draw_cell = xr_draw_cell,
517 xr->params = xmalloc (sizeof *xr->params);
518 xr->params->ops = &xr_render_ops;
519 xr->params->aux = xr;
520 xr->params->size[H] = xr->width;
521 xr->params->size[V] = xr->length;
522 xr->params->font_size[H] = xr->char_width;
523 xr->params->font_size[V] = xr->char_height;
525 enum { LW = XR_LINE_WIDTH, LS = XR_LINE_SPACE };
526 static const int xr_line_widths[RENDER_N_LINES] =
528 [RENDER_LINE_NONE] = 0,
529 [RENDER_LINE_SINGLE] = LW,
530 [RENDER_LINE_DASHED] = LW,
531 [RENDER_LINE_THICK] = LW * 2,
532 [RENDER_LINE_THIN] = LW / 2,
533 [RENDER_LINE_DOUBLE] = 2 * LW + LS,
535 xr->params->line_widths = xr_line_widths;
537 for (int i = 0; i < TABLE_N_AXES; i++)
538 xr->params->min_break[i] = xr->min_break[i];
539 xr->params->supports_margins = true;
540 xr->params->rtl = render_direction_rtl ();
543 if (!xr->systemcolors)
544 cairo_set_source_rgb (xr->cairo,
545 xr->fg.r / 255.0, xr->fg.g / 255.0, xr->fg.b / 255.0);
548 static struct output_driver *
549 xr_create (struct file_handle *fh, enum settings_output_devices device_type,
550 struct string_map *o, enum xr_output_type file_type)
552 const char *file_name = fh_get_file_name (fh);
553 struct xr_driver *xr = xr_allocate (file_name, device_type, o, 72.0 / 128.0);
554 double width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin);
555 double length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin);
556 if (file_type == XR_PDF)
557 xr->surface = cairo_pdf_surface_create (file_name, width_pt, length_pt);
558 else if (file_type == XR_PS)
559 xr->surface = cairo_ps_surface_create (file_name, width_pt, length_pt);
560 else if (file_type == XR_SVG)
561 xr->surface = cairo_svg_surface_create (file_name, width_pt, length_pt);
565 cairo_status_t status = cairo_surface_status (xr->surface);
566 if (status != CAIRO_STATUS_SUCCESS)
568 msg (ME, _("error opening output file `%s': %s"),
569 file_name, cairo_status_to_string (status));
573 if (!xr_check_fonts (xr->surface, xr->fonts, xr->width, xr->length))
581 output_driver_destroy (&xr->driver);
585 static struct output_driver *
586 xr_pdf_create (struct file_handle *fh, enum settings_output_devices device_type,
587 struct string_map *o)
589 return xr_create (fh, device_type, o, XR_PDF);
592 static struct output_driver *
593 xr_ps_create (struct file_handle *fh, enum settings_output_devices device_type,
594 struct string_map *o)
596 return xr_create (fh, device_type, o, XR_PS);
599 static struct output_driver *
600 xr_svg_create (struct file_handle *fh, enum settings_output_devices device_type,
601 struct string_map *o)
603 return xr_create (fh, device_type, o, XR_SVG);
607 xr_destroy (struct output_driver *driver)
609 struct xr_driver *xr = xr_driver_cast (driver);
612 xr_driver_destroy_fsm (xr);
614 if (xr->cairo != NULL)
616 cairo_surface_finish (xr->surface);
617 cairo_status_t status = cairo_status (xr->cairo);
618 if (status != CAIRO_STATUS_SUCCESS)
619 fprintf (stderr, _("error drawing output for %s driver: %s"),
620 output_driver_get_name (driver),
621 cairo_status_to_string (status));
622 cairo_surface_destroy (xr->surface);
624 cairo_destroy (xr->cairo);
627 for (i = 0; i < XR_N_FONTS; i++)
629 struct xr_font *font = &xr->fonts[i];
631 if (font->desc != NULL)
632 pango_font_description_free (font->desc);
633 if (font->layout != NULL)
634 g_object_unref (font->layout);
642 xr_flush (struct output_driver *driver)
644 struct xr_driver *xr = xr_driver_cast (driver);
646 cairo_surface_flush (cairo_get_target (xr->cairo));
650 xr_update_page_setup (struct output_driver *driver,
651 const struct page_setup *ps)
653 struct xr_driver *xr = xr_driver_cast (driver);
655 xr->initial_page_number = ps->initial_page_number;
656 xr->object_spacing = ps->object_spacing * 72 * XR_POINT;
661 int usable[TABLE_N_AXES];
662 for (int i = 0; i < 2; i++)
663 usable[i] = (ps->paper[i]
664 - (ps->margins[i][0] + ps->margins[i][1])) * 72 * XR_POINT;
666 int headings_height[2];
667 usable[V] -= xr_measure_headings (
668 xr->surface, xr->fonts[XR_FONT_PROPORTIONAL].desc, ps->headings,
669 usable[H], xr->object_spacing, headings_height);
671 enum table_axis h = ps->orientation == PAGE_LANDSCAPE;
672 enum table_axis v = !h;
673 if (!xr_check_fonts (xr->surface, xr->fonts, usable[h], usable[v]))
676 for (int i = 0; i < 2; i++)
678 page_heading_uninit (&xr->headings[i]);
679 page_heading_copy (&xr->headings[i], &ps->headings[i]);
680 xr->headings_height[i] = headings_height[i];
682 xr->width = usable[h];
683 xr->length = usable[v];
684 xr->left_margin = ps->margins[h][0] * 72 * XR_POINT;
685 xr->right_margin = ps->margins[h][1] * 72 * XR_POINT;
686 xr->top_margin = ps->margins[v][0] * 72 * XR_POINT;
687 xr->bottom_margin = ps->margins[v][1] * 72 * XR_POINT;
688 cairo_pdf_surface_set_size (xr->surface,
689 ps->paper[h] * 72.0, ps->paper[v] * 72.0);
693 xr_submit (struct output_driver *driver, const struct output_item *output_item)
695 struct xr_driver *xr = xr_driver_cast (driver);
697 if (is_page_setup_item (output_item))
699 xr_update_page_setup (driver,
700 to_page_setup_item (output_item)->page_setup);
706 xr->page_number = xr->initial_page_number - 1;
707 xr_set_cairo (xr, cairo_create (xr->surface));
708 cairo_save (xr->cairo);
709 xr_driver_next_page (xr, xr->cairo);
712 xr_driver_output_item (xr, output_item);
713 while (xr_driver_need_new_page (xr))
715 cairo_restore (xr->cairo);
716 cairo_show_page (xr->cairo);
717 cairo_save (xr->cairo);
718 xr_driver_next_page (xr, xr->cairo);
722 /* Functions for rendering a series of output items to a series of Cairo
723 contexts, with pagination.
725 Used by PSPPIRE for printing, and by the basic Cairo output driver above as
726 its underlying implementation.
728 See the big comment in cairo.h for intended usage. */
730 /* Gives new page CAIRO to XR for output. */
732 xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo)
734 if (!xr->transparent)
737 cairo_set_source_rgb (cairo,
738 xr->bg.r / 255.0, xr->bg.g / 255.0, xr->bg.b / 255.0);
739 cairo_rectangle (cairo, 0, 0, xr->width, xr->length);
741 cairo_restore (cairo);
743 cairo_translate (cairo,
744 xr_to_pt (xr->left_margin),
745 xr_to_pt (xr->top_margin + xr->headings_height[0]));
751 xr_render_page_heading (xr->cairo, xr->fonts[XR_FONT_PROPORTIONAL].desc,
752 &xr->headings[0], xr->page_number, xr->width, true,
753 -xr->headings_height[0]);
754 xr_render_page_heading (xr->cairo, xr->fonts[XR_FONT_PROPORTIONAL].desc,
755 &xr->headings[1], xr->page_number, xr->width, true,
758 xr_driver_run_fsm (xr);
761 /* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of
762 rendering a previous output item, that is, only if xr_driver_need_new_page()
765 xr_driver_output_item (struct xr_driver *xr,
766 const struct output_item *output_item)
768 assert (xr->fsm == NULL);
769 xr->fsm = xr_render_output_item (xr, output_item);
770 xr_driver_run_fsm (xr);
773 /* Returns true if XR is in the middle of rendering an output item and needs a
774 new page to be appended using xr_driver_next_page() to make progress,
777 xr_driver_need_new_page (const struct xr_driver *xr)
779 return xr->fsm != NULL;
782 /* Returns true if the current page doesn't have any content yet. */
784 xr_driver_is_page_blank (const struct xr_driver *xr)
790 xr_driver_destroy_fsm (struct xr_driver *xr)
794 xr->fsm->destroy (xr->fsm);
800 xr_driver_run_fsm (struct xr_driver *xr)
802 if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr))
803 xr_driver_destroy_fsm (xr);
807 xr_layout_cell (struct xr_driver *, const struct table_cell *,
808 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
809 int *width, int *height, int *brk);
812 set_source_rgba (cairo_t *cairo, const struct cell_color *color)
814 cairo_set_source_rgba (cairo,
815 color->r / 255., color->g / 255., color->b / 255.,
816 color->alpha / 255.);
820 dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1, int style,
821 const struct cell_color *color)
823 cairo_new_path (xr->cairo);
824 if (!xr->systemcolors)
825 set_source_rgba (xr->cairo, color);
826 cairo_set_line_width (
828 xr_to_pt (style == RENDER_LINE_THICK ? XR_LINE_WIDTH * 2
829 : style == RENDER_LINE_THIN ? XR_LINE_WIDTH / 2
831 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
832 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
833 cairo_stroke (xr->cairo);
837 dump_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1)
839 cairo_new_path (xr->cairo);
840 cairo_set_line_width (xr->cairo, xr_to_pt (XR_LINE_WIDTH));
841 cairo_close_path (xr->cairo);
842 cairo_stroke (xr->cairo);
843 cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y));
844 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y0 + xr->y));
845 cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y));
846 cairo_line_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y1 + xr->y));
850 fill_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1)
852 cairo_new_path (xr->cairo);
853 cairo_set_line_width (xr->cairo, xr_to_pt (XR_LINE_WIDTH));
854 cairo_rectangle (xr->cairo,
855 xr_to_pt (x0), xr_to_pt (y0 + xr->y),
856 xr_to_pt (x1 - x0), xr_to_pt (y1 - y0));
857 cairo_fill (xr->cairo);
860 /* Draws a horizontal line X0...X2 at Y if LEFT says so,
861 shortening it to X0...X1 if SHORTEN is true.
862 Draws a horizontal line X1...X3 at Y if RIGHT says so,
863 shortening it to X2...X3 if SHORTEN is true. */
865 horz_line (struct xr_driver *xr, int x0, int x1, int x2, int x3, int y,
866 enum render_line_style left, enum render_line_style right,
867 const struct cell_color *left_color,
868 const struct cell_color *right_color,
871 if (left != RENDER_LINE_NONE && right != RENDER_LINE_NONE && !shorten
872 && cell_color_equal (left_color, right_color))
873 dump_line (xr, x0, y, x3, y, left, left_color);
876 if (left != RENDER_LINE_NONE)
877 dump_line (xr, x0, y, shorten ? x1 : x2, y, left, left_color);
878 if (right != RENDER_LINE_NONE)
879 dump_line (xr, shorten ? x2 : x1, y, x3, y, right, right_color);
883 /* Draws a vertical line Y0...Y2 at X if TOP says so,
884 shortening it to Y0...Y1 if SHORTEN is true.
885 Draws a vertical line Y1...Y3 at X if BOTTOM says so,
886 shortening it to Y2...Y3 if SHORTEN is true. */
888 vert_line (struct xr_driver *xr, int y0, int y1, int y2, int y3, int x,
889 enum render_line_style top, enum render_line_style bottom,
890 const struct cell_color *top_color,
891 const struct cell_color *bottom_color,
894 if (top != RENDER_LINE_NONE && bottom != RENDER_LINE_NONE && !shorten
895 && cell_color_equal (top_color, bottom_color))
896 dump_line (xr, x, y0, x, y3, top, top_color);
899 if (top != RENDER_LINE_NONE)
900 dump_line (xr, x, y0, x, shorten ? y1 : y2, top, top_color);
901 if (bottom != RENDER_LINE_NONE)
902 dump_line (xr, x, shorten ? y2 : y1, x, y3, bottom, bottom_color);
907 xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2],
908 enum render_line_style styles[TABLE_N_AXES][2],
909 struct cell_color colors[TABLE_N_AXES][2])
911 const int x0 = bb[H][0];
912 const int y0 = bb[V][0];
913 const int x3 = bb[H][1];
914 const int y3 = bb[V][1];
915 const int top = styles[H][0];
916 const int bottom = styles[H][1];
918 int start_side = render_direction_rtl();
919 int end_side = !start_side;
920 const int start_of_line = styles[V][start_side];
921 const int end_of_line = styles[V][end_side];
922 const struct cell_color *top_color = &colors[H][0];
923 const struct cell_color *bottom_color = &colors[H][1];
924 const struct cell_color *start_color = &colors[V][start_side];
925 const struct cell_color *end_color = &colors[V][end_side];
927 /* The algorithm here is somewhat subtle, to allow it to handle
928 all the kinds of intersections that we need.
930 Three additional ordinates are assigned along the x axis. The
931 first is xc, midway between x0 and x3. The others are x1 and
932 x2; for a single vertical line these are equal to xc, and for
933 a double vertical line they are the ordinates of the left and
934 right half of the double line.
936 yc, y1, and y2 are assigned similarly along the y axis.
938 The following diagram shows the coordinate system and output
939 for double top and bottom lines, single left line, and no
943 y0 ________________________
949 y1 = y2 = yc |######### # |
954 y3 |________#_____#_______|
956 struct xr_driver *xr = xr_;
958 /* Offset from center of each line in a pair of double lines. */
959 int double_line_ofs = (XR_LINE_SPACE + XR_LINE_WIDTH) / 2;
961 /* Are the lines along each axis single or double?
962 (It doesn't make sense to have different kinds of line on the
963 same axis, so we don't try to gracefully handle that case.) */
964 bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE;
965 bool double_horz = start_of_line == RENDER_LINE_DOUBLE || end_of_line == RENDER_LINE_DOUBLE;
967 /* When horizontal lines are doubled,
968 the left-side line along y1 normally runs from x0 to x2,
969 and the right-side line along y1 from x3 to x1.
970 If the top-side line is also doubled, we shorten the y1 lines,
971 so that the left-side line runs only to x1,
972 and the right-side line only to x2.
973 Otherwise, the horizontal line at y = y1 below would cut off
974 the intersection, which looks ugly:
976 y0 ________________________
981 y1 |######### ########|
984 y2 |######################|
987 y3 |______________________|
988 It is more of a judgment call when the horizontal line is
989 single. We actually choose to cut off the line anyhow, as
990 shown in the first diagram above.
992 bool shorten_y1_lines = top == RENDER_LINE_DOUBLE;
993 bool shorten_y2_lines = bottom == RENDER_LINE_DOUBLE;
994 bool shorten_yc_line = shorten_y1_lines && shorten_y2_lines;
995 int horz_line_ofs = double_vert ? double_line_ofs : 0;
996 int xc = (x0 + x3) / 2;
997 int x1 = xc - horz_line_ofs;
998 int x2 = xc + horz_line_ofs;
1000 bool shorten_x1_lines = start_of_line == RENDER_LINE_DOUBLE;
1001 bool shorten_x2_lines = end_of_line == RENDER_LINE_DOUBLE;
1002 bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines;
1003 int vert_line_ofs = double_horz ? double_line_ofs : 0;
1004 int yc = (y0 + y3) / 2;
1005 int y1 = yc - vert_line_ofs;
1006 int y2 = yc + vert_line_ofs;
1009 horz_line (xr, x0, x1, x2, x3, yc, start_of_line, end_of_line,
1010 start_color, end_color, shorten_yc_line);
1013 horz_line (xr, x0, x1, x2, x3, y1, start_of_line, end_of_line,
1014 start_color, end_color, shorten_y1_lines);
1015 horz_line (xr, x0, x1, x2, x3, y2, start_of_line, end_of_line,
1016 start_color, end_color, shorten_y2_lines);
1020 vert_line (xr, y0, y1, y2, y3, xc, top, bottom, top_color, bottom_color,
1024 vert_line (xr, y0, y1, y2, y3, x1, top, bottom, top_color, bottom_color,
1026 vert_line (xr, y0, y1, y2, y3, x2, top, bottom, top_color, bottom_color,
1032 xr_measure_cell_width (void *xr_, const struct table_cell *cell,
1033 int *min_width, int *max_width)
1035 struct xr_driver *xr = xr_;
1036 int bb[TABLE_N_AXES][2];
1037 int clip[TABLE_N_AXES][2];
1044 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
1045 xr_layout_cell (xr, cell, bb, clip, max_width, &h, NULL);
1048 xr_layout_cell (xr, cell, bb, clip, min_width, &h, NULL);
1051 *min_width += px_to_xr (cell->style->cell_style.margin[H][0]
1052 + cell->style->cell_style.margin[H][1]);
1054 *max_width += px_to_xr (cell->style->cell_style.margin[H][0]
1055 + cell->style->cell_style.margin[H][1]);
1059 xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width)
1061 struct xr_driver *xr = xr_;
1062 int bb[TABLE_N_AXES][2];
1063 int clip[TABLE_N_AXES][2];
1067 bb[H][1] = width - px_to_xr (cell->style->cell_style.margin[H][0]
1068 + cell->style->cell_style.margin[H][1]);
1071 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
1072 xr_layout_cell (xr, cell, bb, clip, &w, &h, NULL);
1073 h += px_to_xr (cell->style->cell_style.margin[V][0]
1074 + cell->style->cell_style.margin[V][1]);
1078 static void xr_clip (struct xr_driver *, int clip[TABLE_N_AXES][2]);
1081 xr_draw_cell (void *xr_, const struct table_cell *cell, int color_idx,
1082 int bb[TABLE_N_AXES][2], int valign_offset,
1083 int spill[TABLE_N_AXES][2],
1084 int clip[TABLE_N_AXES][2])
1086 struct xr_driver *xr = xr_;
1089 if (!xr->transparent)
1091 cairo_save (xr->cairo);
1092 int bg_clip[TABLE_N_AXES][2];
1093 for (int axis = 0; axis < TABLE_N_AXES; axis++)
1095 bg_clip[axis][0] = clip[axis][0];
1096 if (bb[axis][0] == clip[axis][0])
1097 bg_clip[axis][0] -= spill[axis][0];
1099 bg_clip[axis][1] = clip[axis][1];
1100 if (bb[axis][1] == clip[axis][1])
1101 bg_clip[axis][1] += spill[axis][1];
1103 xr_clip (xr, bg_clip);
1104 set_source_rgba (xr->cairo, &cell->style->font_style.bg[color_idx]);
1106 bb[H][0] - spill[H][0],
1107 bb[V][0] - spill[V][0],
1108 bb[H][1] + spill[H][1],
1109 bb[V][1] + spill[V][1]);
1110 cairo_restore (xr->cairo);
1112 cairo_save (xr->cairo);
1113 if (!xr->systemcolors)
1114 set_source_rgba (xr->cairo, &cell->style->font_style.fg[color_idx]);
1116 bb[V][0] += valign_offset;
1118 for (int axis = 0; axis < TABLE_N_AXES; axis++)
1120 bb[axis][0] += px_to_xr (cell->style->cell_style.margin[axis][0]);
1121 bb[axis][1] -= px_to_xr (cell->style->cell_style.margin[axis][1]);
1123 if (bb[H][0] < bb[H][1] && bb[V][0] < bb[V][1])
1124 xr_layout_cell (xr, cell, bb, clip, &w, &h, &brk);
1125 cairo_restore (xr->cairo);
1129 xr_adjust_break (void *xr_, const struct table_cell *cell,
1130 int width, int height)
1132 struct xr_driver *xr = xr_;
1133 int bb[TABLE_N_AXES][2];
1134 int clip[TABLE_N_AXES][2];
1137 if (xr_measure_cell_height (xr_, cell, width) < height)
1141 bb[H][1] = width - px_to_xr (cell->style->cell_style.margin[H][0]
1142 + cell->style->cell_style.margin[H][1]);
1146 bb[V][1] = height - px_to_xr (cell->style->cell_style.margin[V][0]
1147 + cell->style->cell_style.margin[V][1]);
1148 clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0;
1149 xr_layout_cell (xr, cell, bb, clip, &w, &h, &brk);
1154 xr_clip (struct xr_driver *xr, int clip[TABLE_N_AXES][2])
1156 if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX)
1158 double x0 = xr_to_pt (clip[H][0]);
1159 double y0 = xr_to_pt (clip[V][0] + xr->y);
1160 double x1 = xr_to_pt (clip[H][1]);
1161 double y1 = xr_to_pt (clip[V][1] + xr->y);
1163 cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0);
1164 cairo_clip (xr->cairo);
1169 add_attr (PangoAttrList *list, PangoAttribute *attr,
1170 guint start_index, guint end_index)
1172 attr->start_index = start_index;
1173 attr->end_index = end_index;
1174 pango_attr_list_insert (list, attr);
1178 markup_escape (struct string *out, unsigned int options,
1179 const char *in, size_t len)
1181 if (!(options & TAB_MARKUP))
1183 ds_put_substring (out, ss_buffer (in, len == -1 ? strlen (in) : len));
1195 ds_put_cstr (out, "&");
1198 ds_put_cstr (out, "<");
1201 ds_put_cstr (out, ">");
1204 ds_put_byte (out, c);
1211 get_layout_dimension (PangoLayout *layout, enum table_axis axis)
1213 int size[TABLE_N_AXES];
1214 pango_layout_get_size (layout, &size[H], &size[V]);
1219 xr_layout_cell_text (struct xr_driver *xr, const struct table_cell *cell,
1220 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
1221 int *widthp, int *brk)
1223 const struct font_style *font_style = &cell->style->font_style;
1224 const struct cell_style *cell_style = &cell->style->cell_style;
1225 unsigned int options = cell->options;
1227 enum table_axis X = options & TAB_ROTATE ? V : H;
1228 enum table_axis Y = !X;
1229 int R = options & TAB_ROTATE ? 0 : 1;
1231 struct xr_font *font = (options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED]
1232 : &xr->fonts[XR_FONT_PROPORTIONAL]);
1233 struct xr_font local_font;
1234 if (font_style->typeface)
1236 PangoFontDescription *desc = parse_font (
1237 font_style->typeface,
1238 font_style->size ? font_style->size * 1000 * xr->font_scale : 10000,
1239 font_style->bold, font_style->italic);
1242 PangoLayout *layout = pango_cairo_create_layout (xr->cairo);
1243 pango_layout_set_font_description (layout, desc);
1245 local_font.desc = desc;
1246 local_font.layout = layout;
1251 const char *text = cell->text;
1252 enum table_halign halign = table_halign_interpret (
1253 cell_style->halign, cell->options & TAB_NUMERIC);
1254 if (cell_style->halign == TABLE_HALIGN_DECIMAL && !(options & TAB_ROTATE))
1256 int margin_adjustment = -px_to_xr (cell_style->decimal_offset);
1258 const char *decimal = strrchr (text, cell_style->decimal_char);
1261 pango_layout_set_text (font->layout, decimal, strlen (decimal));
1262 pango_layout_set_width (font->layout, -1);
1263 margin_adjustment += get_layout_dimension (font->layout, H);
1266 if (margin_adjustment < 0)
1267 bb[H][1] += margin_adjustment;
1270 struct string tmp = DS_EMPTY_INITIALIZER;
1271 PangoAttrList *attrs = NULL;
1273 /* Deal with an oddity of the Unicode line-breaking algorithm (or perhaps in
1274 Pango's implementation of it): it will break after a period or a comma
1275 that precedes a digit, e.g. in ".000" it will break after the period.
1276 This code looks for such a situation and inserts a U+2060 WORD JOINER
1277 to prevent the break.
1279 This isn't necessary when the decimal point is between two digits
1280 (e.g. "0.000" won't be broken) or when the display width is not limited so
1281 that word wrapping won't happen.
1283 It isn't necessary to look for more than one period or comma, as would
1284 happen with grouping like 1,234,567.89 or 1.234.567,89 because if groups
1285 are present then there will always be a digit on both sides of every
1286 period and comma. */
1287 if (options & TAB_MARKUP)
1289 PangoAttrList *new_attrs;
1291 if (pango_parse_markup (text, -1, 0, &new_attrs, &new_text, NULL, NULL))
1294 tmp.ss = ss_cstr (new_text);
1295 tmp.capacity = tmp.ss.length;
1299 /* XXX should we report the error? */
1300 ds_put_cstr (&tmp, text);
1303 else if (options & TAB_ROTATE || bb[H][1] != INT_MAX)
1305 const char *decimal = text + strcspn (text, ".,");
1307 && c_isdigit (decimal[1])
1308 && (decimal == text || !c_isdigit (decimal[-1])))
1310 ds_extend (&tmp, strlen (text) + 16);
1311 markup_escape (&tmp, options, text, decimal - text + 1);
1312 ds_put_unichar (&tmp, 0x2060 /* U+2060 WORD JOINER */);
1313 markup_escape (&tmp, options, decimal + 1, -1);
1317 if (font_style->underline)
1320 attrs = pango_attr_list_new ();
1321 pango_attr_list_insert (attrs, pango_attr_underline_new (
1322 PANGO_UNDERLINE_SINGLE));
1325 if (cell->n_footnotes || cell->n_subscripts || cell->superscript)
1327 /* If we haven't already put TEXT into tmp, do it now. */
1328 if (ds_is_empty (&tmp))
1330 ds_extend (&tmp, strlen (text) + 16);
1331 markup_escape (&tmp, options, text, -1);
1334 size_t subscript_ofs = ds_length (&tmp);
1335 for (size_t i = 0; i < cell->n_subscripts; i++)
1338 ds_put_byte (&tmp, ',');
1339 ds_put_cstr (&tmp, cell->subscripts[i]);
1342 size_t superscript_ofs = ds_length (&tmp);
1343 if (cell->superscript)
1344 ds_put_cstr (&tmp, cell->superscript);
1346 size_t footnote_ofs = ds_length (&tmp);
1347 for (size_t i = 0; i < cell->n_footnotes; i++)
1350 ds_put_byte (&tmp, ',');
1351 ds_put_cstr (&tmp, cell->footnotes[i]->marker);
1354 /* Allow footnote markers to occupy the right margin. That way, numbers
1355 in the column are still aligned. */
1356 if (cell->n_footnotes && halign == TABLE_HALIGN_RIGHT)
1358 /* Measure the width of the footnote marker, so we know how much we
1359 need to make room for. */
1360 pango_layout_set_text (font->layout, ds_cstr (&tmp) + footnote_ofs,
1361 ds_length (&tmp) - footnote_ofs);
1363 PangoAttrList *fn_attrs = pango_attr_list_new ();
1364 pango_attr_list_insert (
1365 fn_attrs, pango_attr_scale_new (PANGO_SCALE_SMALL));
1366 pango_attr_list_insert (fn_attrs, pango_attr_rise_new (3000));
1367 pango_layout_set_attributes (font->layout, fn_attrs);
1368 pango_attr_list_unref (fn_attrs);
1369 int footnote_width = get_layout_dimension (font->layout, X);
1371 /* Bound the adjustment by the width of the right margin. */
1372 int right_margin = px_to_xr (cell_style->margin[X][R]);
1373 int footnote_adjustment = MIN (footnote_width, right_margin);
1375 /* Adjust the bounding box. */
1376 if (options & TAB_ROTATE)
1377 footnote_adjustment = -footnote_adjustment;
1378 bb[X][R] += footnote_adjustment;
1381 pango_layout_set_attributes (font->layout, NULL);
1384 /* Set attributes. */
1386 attrs = pango_attr_list_new ();
1387 add_attr (attrs, pango_attr_font_desc_new (font->desc), subscript_ofs,
1388 PANGO_ATTR_INDEX_TO_TEXT_END);
1389 add_attr (attrs, pango_attr_scale_new (PANGO_SCALE_SMALL),
1390 subscript_ofs, PANGO_ATTR_INDEX_TO_TEXT_END);
1391 if (cell->n_subscripts)
1392 add_attr (attrs, pango_attr_rise_new (-3000), subscript_ofs,
1393 superscript_ofs - subscript_ofs);
1394 if (cell->superscript || cell->n_footnotes)
1395 add_attr (attrs, pango_attr_rise_new (3000), superscript_ofs,
1396 PANGO_ATTR_INDEX_TO_TEXT_END);
1399 /* Set the attributes, if any. */
1402 pango_layout_set_attributes (font->layout, attrs);
1403 pango_attr_list_unref (attrs);
1407 if (ds_is_empty (&tmp))
1408 pango_layout_set_text (font->layout, text, -1);
1410 pango_layout_set_text (font->layout, ds_cstr (&tmp), ds_length (&tmp));
1413 pango_layout_set_alignment (font->layout,
1414 (halign == TABLE_HALIGN_RIGHT ? PANGO_ALIGN_RIGHT
1415 : halign == TABLE_HALIGN_LEFT ? PANGO_ALIGN_LEFT
1416 : PANGO_ALIGN_CENTER));
1417 pango_layout_set_width (
1419 bb[X][1] == INT_MAX ? -1 : xr_to_pango (bb[X][1] - bb[X][0]));
1420 pango_layout_set_wrap (font->layout, PANGO_WRAP_WORD);
1422 if (clip[H][0] != clip[H][1])
1424 cairo_save (xr->cairo);
1425 if (!(options & TAB_ROTATE))
1427 if (options & TAB_ROTATE)
1429 cairo_translate (xr->cairo,
1430 xr_to_pt (bb[H][0]),
1431 xr_to_pt (bb[V][1] + xr->y));
1432 cairo_rotate (xr->cairo, -M_PI_2);
1435 cairo_translate (xr->cairo,
1436 xr_to_pt (bb[H][0]),
1437 xr_to_pt (bb[V][0] + xr->y));
1438 pango_cairo_show_layout (xr->cairo, font->layout);
1440 /* If enabled, this draws a blue rectangle around the extents of each
1441 line of text, which can be rather useful for debugging layout
1445 PangoLayoutIter *iter;
1446 iter = pango_layout_get_iter (font->layout);
1449 PangoRectangle extents;
1451 pango_layout_iter_get_line_extents (iter, &extents, NULL);
1452 cairo_save (xr->cairo);
1453 cairo_set_source_rgb (xr->cairo, 1, 0, 0);
1455 pango_to_xr (extents.x),
1456 pango_to_xr (extents.y) - xr->y,
1457 pango_to_xr (extents.x + extents.width),
1458 pango_to_xr (extents.y + extents.height) - xr->y);
1459 cairo_restore (xr->cairo);
1461 while (pango_layout_iter_next_line (iter));
1462 pango_layout_iter_free (iter);
1465 cairo_restore (xr->cairo);
1468 int size[TABLE_N_AXES];
1469 pango_layout_get_size (font->layout, &size[H], &size[V]);
1470 int w = pango_to_xr (size[X]);
1471 int h = pango_to_xr (size[Y]);
1474 if (bb[V][0] + h >= bb[V][1] && !(options & TAB_ROTATE))
1476 PangoLayoutIter *iter;
1479 /* Choose a breakpoint between lines instead of in the middle of one. */
1480 iter = pango_layout_get_iter (font->layout);
1483 PangoRectangle extents;
1487 pango_layout_iter_get_line_extents (iter, NULL, &extents);
1488 pango_layout_iter_get_line_yrange (iter, &y0, &y1);
1489 extents.x = pango_to_xr (extents.x);
1490 extents.y = pango_to_xr (y0);
1491 extents.width = pango_to_xr (extents.width);
1492 extents.height = pango_to_xr (y1 - y0);
1493 bottom = bb[V][0] + extents.y + extents.height;
1494 if (bottom < bb[V][1])
1496 if (brk && clip[H][0] != clip[H][1])
1504 while (pango_layout_iter_next_line (iter));
1505 pango_layout_iter_free (iter);
1507 /* If enabled, draws a green line across the chosen breakpoint, which can
1508 be useful for debugging issues with breaking. */
1512 dump_line (xr, -xr->left_margin, best,
1513 xr->width + xr->right_margin, best,
1515 &(struct cell_color) CELL_COLOR (0, 255, 0));
1519 pango_layout_set_attributes (font->layout, NULL);
1521 if (font == &local_font)
1523 g_object_unref (G_OBJECT (font->layout));
1524 pango_font_description_free (font->desc);
1531 xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell,
1532 int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2],
1533 int *width, int *height, int *brk)
1538 /* If enabled, draws a blue rectangle around the cell extents, which can be
1539 useful for debugging layout. */
1542 if (clip[H][0] != clip[H][1])
1544 cairo_save (xr->cairo);
1545 cairo_set_source_rgb (xr->cairo, 0, 0, 1);
1546 dump_rectangle (xr, bb[H][0], bb[V][0], bb[H][1], bb[V][1]);
1547 cairo_restore (xr->cairo);
1553 *height = xr_layout_cell_text (xr, cell, bb, clip, width, brk);
1556 struct output_driver_factory pdf_driver_factory =
1557 { "pdf", "pspp.pdf", xr_pdf_create };
1558 struct output_driver_factory ps_driver_factory =
1559 { "ps", "pspp.ps", xr_ps_create };
1560 struct output_driver_factory svg_driver_factory =
1561 { "svg", "pspp.svg", xr_svg_create };
1563 static const struct output_driver_class cairo_driver_class =
1571 /* GUI rendering helpers. */
1575 struct output_item *item;
1578 struct render_pager *p;
1579 struct xr_driver *xr;
1582 #define CHART_WIDTH 500
1583 #define CHART_HEIGHT 375
1588 xr_driver_create (cairo_t *cairo, struct string_map *options)
1590 struct xr_driver *xr = xr_allocate ("cairo", 0, options, 1.0);
1591 xr_set_cairo (xr, cairo);
1595 /* Destroy XR, which should have been created with xr_driver_create(). Any
1596 cairo_t added to XR is not destroyed, because it is owned by the client. */
1598 xr_driver_destroy (struct xr_driver *xr)
1603 output_driver_destroy (&xr->driver);
1607 static struct xr_rendering *
1608 xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr)
1610 struct table_item *table_item;
1611 struct xr_rendering *r;
1613 table_item = table_item_create (table_from_string (text), NULL, NULL);
1614 r = xr_rendering_create (xr, &table_item->output_item, cr);
1615 table_item_unref (table_item);
1620 struct xr_rendering *
1621 xr_rendering_create (struct xr_driver *xr, const struct output_item *item,
1624 struct xr_rendering *r = NULL;
1626 if (is_text_item (item))
1627 r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)),
1629 else if (is_message_item (item))
1631 const struct message_item *message_item = to_message_item (item);
1632 char *s = msg_to_string (message_item_get_msg (message_item));
1633 r = xr_rendering_create_text (xr, s, cr);
1636 else if (is_table_item (item))
1638 r = xzalloc (sizeof *r);
1639 r->item = output_item_ref (item);
1641 xr_set_cairo (xr, cr);
1642 r->p = render_pager_create (xr->params, to_table_item (item));
1644 else if (is_chart_item (item))
1646 r = xzalloc (sizeof *r);
1647 r->item = output_item_ref (item);
1649 else if (is_group_open_item (item))
1650 r = xr_rendering_create_text (xr, to_group_open_item (item)->command_name,
1657 xr_rendering_destroy (struct xr_rendering *r)
1661 output_item_unref (r->item);
1662 render_pager_destroy (r->p);
1668 xr_rendering_measure (const struct xr_rendering *r, int *wp, int *hp)
1672 if (is_table_item (r->item))
1674 w = render_pager_get_size (r->p, H) / XR_POINT;
1675 h = render_pager_get_size (r->p, V) / XR_POINT;
1689 static void xr_draw_chart (const struct chart_item *, cairo_t *,
1690 double x, double y, double width, double height);
1694 xr_rendering_draw (struct xr_rendering *r, cairo_t *cr,
1695 int x0, int y0, int x1, int y1)
1697 if (is_table_item (r->item))
1699 struct xr_driver *xr = r->xr;
1701 xr_set_cairo (xr, cr);
1703 render_pager_draw_region (r->p, x0 * XR_POINT, y0 * XR_POINT,
1704 (x1 - x0) * XR_POINT, (y1 - y0) * XR_POINT);
1707 xr_draw_chart (to_chart_item (r->item), cr,
1708 0, 0, CHART_WIDTH, CHART_HEIGHT);
1712 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
1713 double x, double y, double width, double height)
1715 struct xrchart_geometry geom;
1718 cairo_translate (cr, x, y + height);
1719 cairo_scale (cr, 1.0, -1.0);
1720 xrchart_geometry_init (cr, &geom, width, height);
1721 if (is_boxplot (chart_item))
1722 xrchart_draw_boxplot (chart_item, cr, &geom);
1723 else if (is_histogram_chart (chart_item))
1724 xrchart_draw_histogram (chart_item, cr, &geom);
1725 else if (is_np_plot_chart (chart_item))
1726 xrchart_draw_np_plot (chart_item, cr, &geom);
1727 else if (is_piechart (chart_item))
1728 xrchart_draw_piechart (chart_item, cr, &geom);
1729 else if (is_barchart (chart_item))
1730 xrchart_draw_barchart (chart_item, cr, &geom);
1731 else if (is_roc_chart (chart_item))
1732 xrchart_draw_roc (chart_item, cr, &geom);
1733 else if (is_scree (chart_item))
1734 xrchart_draw_scree (chart_item, cr, &geom);
1735 else if (is_spreadlevel_plot_chart (chart_item))
1736 xrchart_draw_spreadlevel (chart_item, cr, &geom);
1737 else if (is_scatterplot_chart (chart_item))
1738 xrchart_draw_scatterplot (chart_item, cr, &geom);
1741 xrchart_geometry_free (cr, &geom);
1747 xr_draw_png_chart (const struct chart_item *item,
1748 const char *file_name_template, int number,
1749 const struct cell_color *fg,
1750 const struct cell_color *bg)
1752 const int width = 640;
1753 const int length = 480;
1755 cairo_surface_t *surface;
1756 cairo_status_t status;
1757 const char *number_pos;
1761 number_pos = strchr (file_name_template, '#');
1762 if (number_pos != NULL)
1763 file_name = xasprintf ("%.*s%d%s.png", (int) (number_pos - file_name_template),
1764 file_name_template, number, number_pos + 1);
1766 file_name = xasprintf ("%s.png", file_name_template);
1768 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
1769 cr = cairo_create (surface);
1771 cairo_set_source_rgb (cr, bg->r / 255.0, bg->g / 255.0, bg->b / 255.0);
1774 cairo_set_source_rgb (cr, fg->r / 255.0, fg->g / 255.0, fg->b / 255.0);
1776 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1778 status = cairo_surface_write_to_png (surface, file_name);
1779 if (status != CAIRO_STATUS_SUCCESS)
1780 msg (ME, _("error writing output file `%s': %s"),
1781 file_name, cairo_status_to_string (status));
1784 cairo_surface_destroy (surface);
1791 xr_draw_eps_chart (const struct chart_item *item,
1792 const char *file_name_template, int number,
1793 const struct cell_color *fg,
1794 const struct cell_color *bg)
1796 const int width = 640;
1797 const int length = 480;
1799 cairo_surface_t *surface;
1800 const char *number_pos;
1804 number_pos = strchr (file_name_template, '#');
1805 if (number_pos != NULL)
1806 file_name = xasprintf ("%.*s%d%s.eps", (int) (number_pos - file_name_template),
1807 file_name_template, number, number_pos + 1);
1809 file_name = xasprintf ("%s.eps", file_name_template);
1811 surface = cairo_ps_surface_create (file_name, width, length);
1812 cairo_ps_surface_set_eps (surface, true);
1813 cr = cairo_create (surface);
1815 cairo_set_source_rgb (cr, bg->r / 255.0, bg->g / 255.0, bg->b / 255.0);
1818 cairo_set_source_rgb (cr, fg->r / 255.0, fg->g / 255.0, fg->b / 255.0);
1820 xr_draw_chart (item, cr, 0.0, 0.0, width, length);
1823 cairo_surface_destroy (surface);
1830 struct xr_table_state
1832 struct xr_render_fsm fsm;
1833 struct render_pager *p;
1837 xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1839 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1841 while (render_pager_has_next (ts->p))
1845 used = render_pager_draw_next (ts->p, xr->length - xr->y);
1858 xr_table_destroy (struct xr_render_fsm *fsm)
1860 struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm);
1862 render_pager_destroy (ts->p);
1866 static struct xr_render_fsm *
1867 xr_render_table (struct xr_driver *xr, struct table_item *table_item)
1869 struct xr_table_state *ts;
1871 ts = xmalloc (sizeof *ts);
1872 ts->fsm.render = xr_table_render;
1873 ts->fsm.destroy = xr_table_destroy;
1876 xr->y += xr->char_height;
1878 ts->p = render_pager_create (xr->params, table_item);
1879 table_item_unref (table_item);
1884 struct xr_chart_state
1886 struct xr_render_fsm fsm;
1887 struct chart_item *chart_item;
1891 xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr)
1893 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1895 const int chart_height = 0.8 * (xr->length < xr->width ? xr->length : xr->width);
1897 if (xr->y > xr->length - chart_height)
1900 if (xr->cairo != NULL)
1902 xr_draw_chart (cs->chart_item, xr->cairo,
1905 xr_to_pt (xr->width),
1906 xr_to_pt (chart_height));
1908 xr->y += chart_height;
1914 xr_chart_destroy (struct xr_render_fsm *fsm)
1916 struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm);
1918 chart_item_unref (cs->chart_item);
1922 static struct xr_render_fsm *
1923 xr_render_chart (const struct chart_item *chart_item)
1925 struct xr_chart_state *cs;
1927 cs = xmalloc (sizeof *cs);
1928 cs->fsm.render = xr_chart_render;
1929 cs->fsm.destroy = xr_chart_destroy;
1930 cs->chart_item = chart_item_ref (chart_item);
1936 xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr)
1942 xr_eject_destroy (struct xr_render_fsm *fsm UNUSED)
1944 /* Nothing to do. */
1947 static struct xr_render_fsm *
1948 xr_render_eject (void)
1950 static struct xr_render_fsm eject_renderer =
1956 return &eject_renderer;
1959 static struct xr_render_fsm *
1960 xr_render_text (struct xr_driver *xr, const struct text_item *text_item)
1962 enum text_item_type type = text_item_get_type (text_item);
1966 case TEXT_ITEM_PAGE_TITLE:
1970 return xr_render_table (
1971 xr, text_item_to_table_item (text_item_ref (text_item)));
1977 static struct xr_render_fsm *
1978 xr_render_message (struct xr_driver *xr,
1979 const struct message_item *message_item)
1981 char *s = msg_to_string (message_item_get_msg (message_item));
1982 struct text_item *item = text_item_create (TEXT_ITEM_LOG, s);
1984 return xr_render_table (xr, text_item_to_table_item (item));
1987 static struct xr_render_fsm *
1988 xr_render_output_item (struct xr_driver *xr,
1989 const struct output_item *output_item)
1991 if (is_table_item (output_item))
1992 return xr_render_table (xr, table_item_ref (to_table_item (output_item)));
1993 else if (is_chart_item (output_item))
1994 return xr_render_chart (to_chart_item (output_item));
1995 else if (is_text_item (output_item))
1996 return xr_render_text (xr, to_text_item (output_item));
1997 else if (is_page_eject_item (output_item))
1998 return xr->y > 0 ? xr_render_eject () : NULL;
1999 else if (is_message_item (output_item))
2000 return xr_render_message (xr, to_message_item (output_item));
2006 xr_draw_svg_file (struct xr_rendering *r,
2007 const char *filename)
2011 xr_rendering_measure (r, &width, &height);
2012 cairo_surface_t *surface = cairo_svg_surface_create (filename, width, height);
2015 g_error ("Could not create cairo svg surface with file %s", filename);
2018 cairo_t *cr = cairo_create (surface);
2019 xr_rendering_draw (r, cr, 0, 0, width, height);
2021 cairo_surface_destroy (surface);