X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Foutput%2Fcairo.c;h=8cb504d2dd0e877309fb916a241e69439de031bc;hb=19616643b06c6f27463ecbd725ae25be0bf1cfd1;hp=3584f30f575c4ef680d1d232ed3350f3e9e51ad3;hpb=d6ea5a0c84b5b758dbdab6d803f281f688db41e7;p=pspp diff --git a/src/output/cairo.c b/src/output/cairo.c index 3584f30f57..8cb504d2dd 100644 --- a/src/output/cairo.c +++ b/src/output/cairo.c @@ -1,5 +1,5 @@ /* PSPP - a program for statistical analysis. - Copyright (C) 2009, 2010 Free Software Foundation, Inc. + Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Free Software Foundation, Inc. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -16,44 +16,50 @@ #include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include "output/cairo.h" + +#include "libpspp/assertion.h" +#include "libpspp/cast.h" +#include "libpspp/message.h" +#include "libpspp/start-date.h" +#include "libpspp/str.h" +#include "libpspp/string-map.h" +#include "libpspp/version.h" +#include "data/file-handle-def.h" +#include "output/cairo-chart.h" +#include "output/chart-item-provider.h" +#include "output/charts/boxplot.h" +#include "output/charts/np-plot.h" +#include "output/charts/piechart.h" +#include "output/charts/barchart.h" +#include "output/charts/plot-hist.h" +#include "output/charts/roc-chart.h" +#include "output/charts/spreadlevel-plot.h" +#include "output/charts/scree.h" +#include "output/charts/scatterplot.h" +#include "output/driver-provider.h" +#include "output/message-item.h" +#include "output/options.h" +#include "output/render.h" +#include "output/tab.h" +#include "output/table-item.h" +#include "output/table.h" +#include "output/text-item.h" #include #include #include #include +#include #include #include #include #include #include -#include "error.h" -#include "intprops.h" -#include "minmax.h" -#include "xalloc.h" +#include "gl/intprops.h" +#include "gl/minmax.h" +#include "gl/xalloc.h" #include "gettext.h" #define _(msgid) gettext (msgid) @@ -62,9 +68,8 @@ #define H TABLE_HORZ #define V TABLE_VERT -/* Measurements as we present to the rest of PSPP. */ +/* The unit used for internal measurements is inch/(72 * XR_POINT). */ #define XR_POINT PANGO_SCALE -#define XR_INCH (XR_POINT * 72) /* Conversions to and from points. */ static double @@ -87,16 +92,27 @@ enum xr_font_type XR_FONT_PROPORTIONAL, XR_FONT_EMPHASIS, XR_FONT_FIXED, + XR_FONT_MARKER, XR_N_FONTS }; /* A font for use with Cairo. */ struct xr_font { - char *string; PangoFontDescription *desc; PangoLayout *layout; - PangoFontMetrics *metrics; + }; + +/* An output item whose rendering is in progress. */ +struct xr_render_fsm + { + /* Renders as much of itself as it can on the current page. Returns true + if rendering is complete, false if the output item needs another + page. */ + bool (*render) (struct xr_render_fsm *, struct xr_driver *); + + /* Destroys the output item. */ + void (*destroy) (struct xr_render_fsm *); }; /* Cairo output driver. */ @@ -105,56 +121,66 @@ struct xr_driver struct output_driver driver; /* User parameters. */ - bool headers; /* Draw headers at top of page? */ - struct xr_font fonts[XR_N_FONTS]; - int font_height; /* In XR units. */ int width; /* Page width minus margins. */ int length; /* Page length minus margins and header. */ - int left_margin; /* Left margin in XR units. */ - int right_margin; /* Right margin in XR units. */ - int top_margin; /* Top margin in XR units. */ - int bottom_margin; /* Bottom margin in XR units. */ + int left_margin; /* Left margin in inch/(72 * XR_POINT). */ + int right_margin; /* Right margin in inch/(72 * XR_POINT). */ + int top_margin; /* Top margin in inch/(72 * XR_POINT). */ + int bottom_margin; /* Bottom margin in inch/(72 * XR_POINT). */ int line_gutter; /* Space around lines. */ int line_space; /* Space between lines. */ int line_width; /* Width of lines. */ - enum xr_output_type file_type; /* Type of output file. */ + int cell_margin; + + int min_break[TABLE_N_AXES]; /* Min cell size to break across pages. */ + + struct xr_color bg; /* Background color */ + struct xr_color fg; /* Foreground color */ /* Internal state. */ struct render_params *params; + int char_width, char_height; + char *command_name; char *title; char *subtitle; cairo_t *cairo; int page_number; /* Current page number. */ - int y; + int x, y; + struct xr_render_fsm *fsm; + int nest; }; -static void xr_show_page (struct xr_driver *); -static void draw_headers (struct xr_driver *); +static const struct output_driver_class cairo_driver_class; -static bool load_font (struct xr_driver *, struct xr_font *); -static void free_font (struct xr_font *); +static void xr_driver_destroy_fsm (struct xr_driver *); +static void xr_driver_run_fsm (struct xr_driver *); static void xr_draw_line (void *, int bb[TABLE_N_AXES][2], enum render_line_style styles[TABLE_N_AXES][2]); static void xr_measure_cell_width (void *, const struct table_cell *, - int *min, int *max); + int footnote_idx, int *min, int *max); static int xr_measure_cell_height (void *, const struct table_cell *, - int width); -static void xr_draw_cell (void *, const struct table_cell *, + int footnote_idx, int width); +static void xr_draw_cell (void *, const struct table_cell *, int footnote_idx, int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2]); +static int xr_adjust_break (void *, const struct table_cell *, int footnote_idx, + int width, int height); + +static struct xr_render_fsm *xr_render_output_item ( + struct xr_driver *, const struct output_item *); -/* Driver initialization. */ +/* Output driver basics. */ static struct xr_driver * xr_driver_cast (struct output_driver *driver) { - assert (driver->class == &cairo_class); + assert (driver->class == &cairo_driver_class); return UP_CAST (driver, struct xr_driver, driver); } @@ -165,31 +191,162 @@ opt (struct output_driver *d, struct string_map *options, const char *key, return driver_option_get (d, options, key, default_value); } -static struct xr_driver * -xr_allocate (const char *name, int device_type, struct string_map *o) +/* Parse color information specified by KEY into {RED,GREEN,BLUE}. + Currently, the input string must be of the form "#RRRRGGGGBBBB" + Future implementations might allow things like "yellow" and + "sky-blue-ultra-brown" +*/ +void +parse_color (struct output_driver *d, struct string_map *options, + const char *key, const char *default_value, + struct xr_color *color) { - struct output_driver *d; - struct xr_driver *xr; + int red, green, blue; + char *string = parse_string (opt (d, options, key, default_value)); + + if (3 != sscanf (string, "#%04x%04x%04x", &red, &green, &blue)) + { + /* If the parsed option string fails, then try the default value */ + if ( 3 != sscanf (default_value, "#%04x%04x%04x", &red, &green, &blue)) + { + /* ... and if that fails set everything to zero */ + red = green = blue = 0; + } + } + + free (string); + + /* Convert 16 bit ints to float */ + color->red = red / (double) 0xFFFF; + color->green = green / (double) 0xFFFF; + color->blue = blue / (double) 0xFFFF; +} + +static PangoFontDescription * +parse_font (struct output_driver *d, struct string_map *options, + const char *key, const char *default_value, + int default_size) +{ + PangoFontDescription *desc; + char *string; + + /* Parse KEY as a font description. */ + string = parse_string (opt (d, options, key, default_value)); + desc = pango_font_description_from_string (string); + if (desc == NULL) + { + msg (MW, _("`%s': bad font specification"), string); + + /* Fall back to DEFAULT_VALUE, which had better be a valid font + description. */ + desc = pango_font_description_from_string (default_value); + assert (desc != NULL); + } + free (string); - xr = xzalloc (sizeof *xr); - d = &xr->driver; - output_driver_init (d, &cairo_class, name, device_type); - xr->headers = true; - xr->font_height = XR_POINT * 10; - xr->fonts[XR_FONT_FIXED].string - = parse_string (opt (d, o, "fixed-font", "monospace")); - xr->fonts[XR_FONT_PROPORTIONAL].string - = parse_string (opt (d, o, "prop-font", "serif")); - xr->fonts[XR_FONT_EMPHASIS].string - = parse_string (opt (d, o, "emph-font", "serif italic")); - xr->line_gutter = XR_POINT; + /* If the font description didn't include an explicit font size, then set it + to DEFAULT_SIZE, which is in inch/72000 units. */ + if (!(pango_font_description_get_set_fields (desc) & PANGO_FONT_MASK_SIZE)) + pango_font_description_set_size (desc, + (default_size / 1000.0) * PANGO_SCALE); + + return desc; +} + + +static void +apply_options (struct xr_driver *xr, struct string_map *o) +{ + struct output_driver *d = &xr->driver; + + /* In inch/72000 units used by parse_paper_size() and parse_dimension(). */ + int left_margin, right_margin; + int top_margin, bottom_margin; + int paper_width, paper_length; + int font_size; + int min_break[TABLE_N_AXES]; + + /* Scale factor from inch/72000 to inch/(72 * XR_POINT). */ + const double scale = XR_POINT / 1000.; + + int i; + + for (i = 0; i < XR_N_FONTS; i++) + { + struct xr_font *font = &xr->fonts[i]; + + if (font->desc != NULL) + pango_font_description_free (font->desc); + } + + font_size = parse_int (opt (d, o, "font-size", "10000"), 1000, 1000000); + xr->fonts[XR_FONT_FIXED].desc = parse_font (d, o, "fixed-font", "monospace", + font_size); + xr->fonts[XR_FONT_PROPORTIONAL].desc = parse_font (d, o, "prop-font", + "serif", font_size); + xr->fonts[XR_FONT_EMPHASIS].desc = parse_font (d, o, "emph-font", + "serif italic", font_size); + xr->fonts[XR_FONT_MARKER].desc = parse_font (d, o, "marker-font", "serif", + font_size * PANGO_SCALE_X_SMALL); + + xr->line_gutter = XR_POINT / 2; xr->line_space = XR_POINT; xr->line_width = XR_POINT / 2; - xr->page_number = 1; + xr->page_number = 0; + + parse_color (d, o, "background-color", "#FFFFFFFFFFFF", &xr->bg); + parse_color (d, o, "foreground-color", "#000000000000", &xr->fg); + + /* Get dimensions. */ + parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length); + left_margin = parse_dimension (opt (d, o, "left-margin", ".5in")); + right_margin = parse_dimension (opt (d, o, "right-margin", ".5in")); + top_margin = parse_dimension (opt (d, o, "top-margin", ".5in")); + bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in")); + + min_break[H] = parse_dimension (opt (d, o, "min-hbreak", NULL)) * scale; + min_break[V] = parse_dimension (opt (d, o, "min-vbreak", NULL)) * scale; + + /* Convert to inch/(XR_POINT * 72). */ + xr->left_margin = left_margin * scale; + xr->right_margin = right_margin * scale; + xr->top_margin = top_margin * scale; + xr->bottom_margin = bottom_margin * scale; + xr->width = (paper_width - left_margin - right_margin) * scale; + xr->length = (paper_length - top_margin - bottom_margin) * scale; + xr->min_break[H] = min_break[H] >= 0 ? min_break[H] : xr->width / 2; + xr->min_break[V] = min_break[V] >= 0 ? min_break[V] : xr->length / 2; +} + +static struct xr_driver * +xr_allocate (const char *name, int device_type, struct string_map *o) +{ + struct xr_driver *xr = xzalloc (sizeof *xr); + struct output_driver *d = &xr->driver; + + output_driver_init (d, &cairo_driver_class, name, device_type); + + apply_options (xr, o); return xr; } +static int +pango_to_xr (int pango) +{ + return (XR_POINT != PANGO_SCALE + ? ceil (pango * (1. * XR_POINT / PANGO_SCALE)) + : pango); +} + +static int +xr_to_pango (int xr) +{ + return (XR_POINT != PANGO_SCALE + ? ceil (xr * (1. / XR_POINT * PANGO_SCALE)) + : xr); +} + static bool xr_set_cairo (struct xr_driver *xr, cairo_t *cairo) { @@ -199,9 +356,22 @@ xr_set_cairo (struct xr_driver *xr, cairo_t *cairo) cairo_set_line_width (xr->cairo, xr_to_pt (xr->line_width)); + xr->char_width = 0; + xr->char_height = 0; for (i = 0; i < XR_N_FONTS; i++) - if (!load_font (xr, &xr->fonts[i])) - return false; + { + struct xr_font *font = &xr->fonts[i]; + int char_width, char_height; + + font->layout = pango_cairo_create_layout (cairo); + pango_layout_set_font_description (font->layout, font->desc); + + pango_layout_set_text (font->layout, "0", 1); + pango_layout_get_size (font->layout, &char_width, &char_height); + xr->char_width = MAX (xr->char_width, pango_to_xr (char_width)); + xr->char_height = MAX (xr->char_height, pango_to_xr (char_height)); + } + xr->cell_margin = xr->char_width; if (xr->params == NULL) { @@ -211,12 +381,13 @@ xr_set_cairo (struct xr_driver *xr, cairo_t *cairo) xr->params->draw_line = xr_draw_line; xr->params->measure_cell_width = xr_measure_cell_width; xr->params->measure_cell_height = xr_measure_cell_height; + xr->params->adjust_break = xr_adjust_break; xr->params->draw_cell = xr_draw_cell; xr->params->aux = xr; xr->params->size[H] = xr->width; xr->params->size[V] = xr->length; - xr->params->font_size[H] = xr->font_height / 2; /* XXX */ - xr->params->font_size[V] = xr->font_height; + xr->params->font_size[H] = xr->char_width; + xr->params->font_size[V] = xr->char_height; single_width = 2 * xr->line_gutter + xr->line_width; double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width; @@ -226,57 +397,35 @@ xr_set_cairo (struct xr_driver *xr, cairo_t *cairo) xr->params->line_widths[i][RENDER_LINE_SINGLE] = single_width; xr->params->line_widths[i][RENDER_LINE_DOUBLE] = double_width; } + + for (i = 0; i < TABLE_N_AXES; i++) + xr->params->min_break[i] = xr->min_break[i]; } + cairo_set_source_rgb (xr->cairo, xr->fg.red, xr->fg.green, xr->fg.blue); + return true; } static struct output_driver * -xr_create (const char *name, enum output_device_type device_type, - struct string_map *o) +xr_create (const char *file_name, enum settings_output_devices device_type, + struct string_map *o, enum xr_output_type file_type) { enum { MIN_WIDTH = 3, MIN_LENGTH = 3 }; - struct output_driver *d; struct xr_driver *xr; cairo_surface_t *surface; cairo_status_t status; double width_pt, length_pt; - int paper_width, paper_length; - char *file_name; - xr = xr_allocate (name, device_type, o); - d = &xr->driver; + xr = xr_allocate (file_name, device_type, o); - xr->headers = parse_boolean (opt (d, o, "headers", "true")); - - xr->file_type = parse_enum (opt (d, o, "output-type", "pdf"), - "pdf", XR_PDF, - "ps", XR_PS, - "svg", XR_SVG, - (char *) NULL); - file_name = parse_string (opt (d, o, "output-file", - (xr->file_type == XR_PDF ? "pspp.pdf" - : xr->file_type == XR_PS ? "pspp.ps" - : "pspp.svg"))); - - parse_paper_size (opt (d, o, "paper-size", ""), &paper_width, &paper_length); - xr->left_margin = parse_dimension (opt (d, o, "left-margin", ".5in")); - xr->right_margin = parse_dimension (opt (d, o, "right-margin", ".5in")); - xr->top_margin = parse_dimension (opt (d, o, "top-margin", ".5in")); - xr->bottom_margin = parse_dimension (opt (d, o, "bottom-margin", ".5in")); - - if (xr->headers) - xr->top_margin += 3 * xr->font_height; - xr->width = paper_width - xr->left_margin - xr->right_margin; - xr->length = paper_length - xr->top_margin - xr->bottom_margin; - - width_pt = paper_width / 1000.0; - length_pt = paper_length / 1000.0; - if (xr->file_type == XR_PDF) + width_pt = xr_to_pt (xr->width + xr->left_margin + xr->right_margin); + length_pt = xr_to_pt (xr->length + xr->top_margin + xr->bottom_margin); + if (file_type == XR_PDF) surface = cairo_pdf_surface_create (file_name, width_pt, length_pt); - else if (xr->file_type == XR_PS) + else if (file_type == XR_PS) surface = cairo_ps_surface_create (file_name, width_pt, length_pt); - else if (xr->file_type == XR_SVG) + else if (file_type == XR_SVG) surface = cairo_svg_surface_create (file_name, width_pt, length_pt); else NOT_REACHED (); @@ -284,7 +433,7 @@ xr_create (const char *name, enum output_device_type device_type, status = cairo_surface_status (surface); if (status != CAIRO_STATUS_SUCCESS) { - error (0, 0, _("opening output file \"%s\": %s"), + msg (ME, _("error opening output file `%s': %s"), file_name, cairo_status_to_string (status)); cairo_surface_destroy (surface); goto error; @@ -293,35 +442,32 @@ xr_create (const char *name, enum output_device_type device_type, xr->cairo = cairo_create (surface); cairo_surface_destroy (surface); - cairo_translate (xr->cairo, - xr_to_pt (xr->left_margin), - xr_to_pt (xr->top_margin)); - if (!xr_set_cairo (xr, xr->cairo)) goto error; - if (xr->width / (xr->font_height / 2) < MIN_WIDTH) + cairo_save (xr->cairo); + xr_driver_next_page (xr, xr->cairo); + + if (xr->width / xr->char_width < MIN_WIDTH) { - error (0, 0, _("The defined page is not wide enough to hold at least %d " + msg (ME, _("The defined page is not wide enough to hold at least %d " "characters in the default font. In fact, there's only " "room for %d characters."), MIN_WIDTH, - xr->width / (xr->font_height / 2)); + xr->width / xr->char_width); goto error; } - if (xr->length / xr->font_height < MIN_LENGTH) + if (xr->length / xr->char_height < MIN_LENGTH) { - error (0, 0, _("The defined page is not long " - "enough to hold margins and headers, plus least %d " - "lines of the default fonts. In fact, there's only " + msg (ME, _("The defined page is not long enough to hold at least %d " + "lines in the default font. In fact, there's only " "room for %d lines."), MIN_LENGTH, - xr->length / xr->font_height); + xr->length / xr->char_height); goto error; } - free (file_name); return &xr->driver; error: @@ -329,30 +475,65 @@ xr_create (const char *name, enum output_device_type device_type, return NULL; } +static struct output_driver * +xr_pdf_create (struct file_handle *fh, enum settings_output_devices device_type, + struct string_map *o) +{ + struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_PDF); + fh_unref (fh); + return od ; +} + +static struct output_driver * +xr_ps_create (struct file_handle *fh, enum settings_output_devices device_type, + struct string_map *o) +{ + struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_PS); + fh_unref (fh); + return od ; +} + +static struct output_driver * +xr_svg_create (struct file_handle *fh, enum settings_output_devices device_type, + struct string_map *o) +{ + struct output_driver *od = xr_create (fh_get_file_name (fh), device_type, o, XR_SVG); + fh_unref (fh); + return od ; +} + static void xr_destroy (struct output_driver *driver) { struct xr_driver *xr = xr_driver_cast (driver); size_t i; + xr_driver_destroy_fsm (xr); + if (xr->cairo != NULL) { cairo_status_t status; - if (xr->y > 0) - xr_show_page (xr); - cairo_surface_finish (cairo_get_target (xr->cairo)); status = cairo_status (xr->cairo); if (status != CAIRO_STATUS_SUCCESS) - error (0, 0, _("error drawing output for %s driver: %s"), + msg (ME, _("error drawing output for %s driver: %s"), output_driver_get_name (driver), cairo_status_to_string (status)); cairo_destroy (xr->cairo); } + free (xr->command_name); for (i = 0; i < XR_N_FONTS; i++) - free_font (&xr->fonts[i]); + { + struct xr_font *font = &xr->fonts[i]; + + if (font->desc != NULL) + pango_font_description_free (font->desc); + if (font->layout != NULL) + g_object_unref (font->layout); + } + free (xr->params); free (xr); } @@ -366,173 +547,118 @@ xr_flush (struct output_driver *driver) } static void -xr_init_caption_cell (const char *caption, struct table_cell *cell) +xr_submit (struct output_driver *driver, const struct output_item *output_item) { - cell->contents = caption; - cell->options = TAB_LEFT; - cell->destructor = NULL; -} + struct xr_driver *xr = xr_driver_cast (driver); -static struct render_page * -xr_render_table_item (struct xr_driver *xr, const struct table_item *item, - int *caption_heightp) -{ - const char *caption = table_item_get_caption (item); + output_driver_track_current_command (output_item, &xr->command_name); - if (caption != NULL) + xr_driver_output_item (xr, output_item); + while (xr_driver_need_new_page (xr)) { - /* XXX doesn't do well with very large captions */ - struct table_cell cell; - xr_init_caption_cell (caption, &cell); - *caption_heightp = xr_measure_cell_height (xr, &cell, xr->width); + cairo_restore (xr->cairo); + cairo_show_page (xr->cairo); + cairo_save (xr->cairo); + xr_driver_next_page (xr, xr->cairo); } - else - *caption_heightp = 0; - - return render_page_create (xr->params, table_item_get_table (item)); } + +/* Functions for rendering a series of output items to a series of Cairo + contexts, with pagination. -static void -xr_submit (struct output_driver *driver, const struct output_item *output_item) + Used by PSPPIRE for printing, and by the basic Cairo output driver above as + its underlying implementation. + + See the big comment in cairo.h for intended usage. */ + +/* Gives new page CAIRO to XR for output. */ +void +xr_driver_next_page (struct xr_driver *xr, cairo_t *cairo) { - struct xr_driver *xr = xr_driver_cast (driver); - if (is_table_item (output_item)) - { - struct table_item *table_item = to_table_item (output_item); - struct render_break x_break; - struct render_page *page; - int caption_height; + cairo_save (cairo); + cairo_set_source_rgb (cairo, xr->bg.red, xr->bg.green, xr->bg.blue); + cairo_rectangle (cairo, 0, 0, xr->width, xr->length); + cairo_fill (cairo); + cairo_restore (cairo); - if (xr->y > 0) - xr->y += xr->font_height; + cairo_translate (cairo, + xr_to_pt (xr->left_margin), + xr_to_pt (xr->top_margin)); - page = xr_render_table_item (xr, table_item, &caption_height); - xr->params->size[V] = xr->length - caption_height; - for (render_break_init (&x_break, page, H); - render_break_has_next (&x_break); ) - { - struct render_page *x_slice; - struct render_break y_break; + xr->page_number++; + xr->cairo = cairo; + xr->x = xr->y = 0; + xr_driver_run_fsm (xr); +} - x_slice = render_break_next (&x_break, xr->width); - for (render_break_init (&y_break, x_slice, V); - render_break_has_next (&y_break); ) - { - int space = xr->length - xr->y; - struct render_page *y_slice; - - /* XXX doesn't allow for caption or space between segments */ - if (render_break_next_size (&y_break) > space) - { - assert (xr->y > 0); - xr_show_page (xr); - continue; - } - - y_slice = render_break_next (&y_break, space); - if (caption_height) - { - struct table_cell cell; - int bb[TABLE_N_AXES][2]; - - xr_init_caption_cell (table_item_get_caption (table_item), - &cell); - bb[H][0] = 0; - bb[H][1] = xr->width; - bb[V][0] = 0; - bb[V][1] = caption_height; - xr_draw_cell (xr, &cell, bb, bb); - xr->y += caption_height; - caption_height = 0; - } - - render_page_draw (y_slice); - xr->y += render_page_get_size (y_slice, V); - render_page_unref (y_slice); - } - render_break_destroy (&y_break); - } - render_break_destroy (&x_break); - } - else if (is_chart_item (output_item)) - { - if (xr->y > 0) - xr_show_page (xr); - xr_draw_chart (to_chart_item (output_item), xr->cairo, 0.0, 0.0, - xr_to_pt (xr->width), xr_to_pt (xr->length)); - xr_show_page (xr); - } - else if (is_text_item (output_item)) - { - const struct text_item *text_item = to_text_item (output_item); - enum text_item_type type = text_item_get_type (text_item); - const char *text = text_item_get_text (text_item); +/* Start rendering OUTPUT_ITEM to XR. Only valid if XR is not in the middle of + rendering a previous output item, that is, only if xr_driver_need_new_page() + returns false. */ +void +xr_driver_output_item (struct xr_driver *xr, + const struct output_item *output_item) +{ + assert (xr->fsm == NULL); + xr->fsm = xr_render_output_item (xr, output_item); + xr_driver_run_fsm (xr); +} - switch (type) - { - case TEXT_ITEM_TITLE: - free (xr->title); - xr->title = xstrdup (text); - break; - - case TEXT_ITEM_SUBTITLE: - free (xr->subtitle); - xr->subtitle = xstrdup (text); - break; - - case TEXT_ITEM_COMMAND_CLOSE: - break; - - case TEXT_ITEM_BLANK_LINE: - if (xr->y > 0) - xr->y += xr->font_height; - break; - - case TEXT_ITEM_EJECT_PAGE: - if (xr->y > 0) - xr_show_page (xr); - break; - - default: - { - struct table_item *item; - - item = table_item_create (table_from_string (TAB_LEFT, text), - NULL); - xr_submit (&xr->driver, &item->output_item); - table_item_unref (item); - } - break; - } +/* Returns true if XR is in the middle of rendering an output item and needs a + new page to be appended using xr_driver_next_page() to make progress, + otherwise false. */ +bool +xr_driver_need_new_page (const struct xr_driver *xr) +{ + return xr->fsm != NULL; +} - } +/* Returns true if the current page doesn't have any content yet. */ +bool +xr_driver_is_page_blank (const struct xr_driver *xr) +{ + return xr->y == 0; } static void -xr_show_page (struct xr_driver *xr) +xr_driver_destroy_fsm (struct xr_driver *xr) { - if (xr->headers) + if (xr->fsm != NULL) { - xr->y = 0; - draw_headers (xr); + xr->fsm->destroy (xr->fsm); + xr->fsm = NULL; } - cairo_show_page (xr->cairo); +} - xr->page_number++; - xr->y = 0; +static void +xr_driver_run_fsm (struct xr_driver *xr) +{ + if (xr->fsm != NULL && !xr->fsm->render (xr->fsm, xr)) + xr_driver_destroy_fsm (xr); } static void -xr_layout_cell (struct xr_driver *, const struct table_cell *, +xr_layout_cell (struct xr_driver *, const struct table_cell *, int footnote_idx, int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2], - PangoWrapMode, int *width, int *height); + int *width, int *height, int *brk); static void dump_line (struct xr_driver *xr, int x0, int y0, int x1, int y1) { cairo_new_path (xr->cairo); - cairo_move_to (xr->cairo, xr_to_pt (x0), xr_to_pt (y0 + xr->y)); - cairo_line_to (xr->cairo, xr_to_pt (x1), xr_to_pt (y1 + xr->y)); + cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y)); + cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y)); + cairo_stroke (xr->cairo); +} + +static void UNUSED +dump_rectangle (struct xr_driver *xr, int x0, int y0, int x1, int y1) +{ + cairo_new_path (xr->cairo); + cairo_move_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y0 + xr->y)); + cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y0 + xr->y)); + cairo_line_to (xr->cairo, xr_to_pt (x1 + xr->x), xr_to_pt (y1 + xr->y)); + cairo_line_to (xr->cairo, xr_to_pt (x0 + xr->x), xr_to_pt (y1 + xr->y)); + cairo_close_path (xr->cairo); cairo_stroke (xr->cairo); } @@ -585,9 +711,9 @@ xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2], const int x3 = bb[H][1]; const int y3 = bb[V][1]; const int top = styles[H][0]; - const int left = styles[V][0]; const int bottom = styles[H][1]; - const int right = styles[V][1]; + const int start_of_line = render_direction_rtl() ? styles[V][1]: styles[V][0]; + const int end_of_line = render_direction_rtl() ? styles[V][0]: styles[V][1]; /* The algorithm here is somewhat subtle, to allow it to handle all the kinds of intersections that we need. @@ -627,7 +753,7 @@ xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2], (It doesn't make sense to have different kinds of line on the same axis, so we don't try to gracefully handle that case.) */ bool double_vert = top == RENDER_LINE_DOUBLE || bottom == RENDER_LINE_DOUBLE; - bool double_horz = left == RENDER_LINE_DOUBLE || right == RENDER_LINE_DOUBLE; + bool double_horz = start_of_line == RENDER_LINE_DOUBLE || end_of_line == RENDER_LINE_DOUBLE; /* When horizontal lines are doubled, the left-side line along y1 normally runs from x0 to x2, @@ -662,8 +788,8 @@ xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2], int x1 = xc - horz_line_ofs; int x2 = xc + horz_line_ofs; - bool shorten_x1_lines = left == RENDER_LINE_DOUBLE; - bool shorten_x2_lines = right == RENDER_LINE_DOUBLE; + bool shorten_x1_lines = start_of_line == RENDER_LINE_DOUBLE; + bool shorten_x2_lines = end_of_line == RENDER_LINE_DOUBLE; bool shorten_xc_line = shorten_x1_lines && shorten_x2_lines; int vert_line_ofs = double_horz ? double_line_ofs : 0; int yc = (y0 + y3) / 2; @@ -671,11 +797,11 @@ xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2], int y2 = yc + vert_line_ofs; if (!double_horz) - horz_line (xr, x0, x1, x2, x3, yc, left, right, shorten_yc_line); + horz_line (xr, x0, x1, x2, x3, yc, start_of_line, end_of_line, shorten_yc_line); else { - horz_line (xr, x0, x1, x2, x3, y1, left, right, shorten_y1_lines); - horz_line (xr, x0, x1, x2, x3, y2, left, right, shorten_y2_lines); + horz_line (xr, x0, x1, x2, x3, y1, start_of_line, end_of_line, shorten_y1_lines); + horz_line (xr, x0, x1, x2, x3, y2, start_of_line, end_of_line, shorten_y2_lines); } if (!double_vert) @@ -689,7 +815,7 @@ xr_draw_line (void *xr_, int bb[TABLE_N_AXES][2], static void xr_measure_cell_width (void *xr_, const struct table_cell *cell, - int *min_width, int *max_width) + int footnote_idx, int *min_width, int *max_width) { struct xr_driver *xr = xr_; int bb[TABLE_N_AXES][2]; @@ -701,14 +827,20 @@ xr_measure_cell_width (void *xr_, const struct table_cell *cell, bb[V][0] = 0; bb[V][1] = INT_MAX; clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0; - xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, max_width, &h); + xr_layout_cell (xr, cell, footnote_idx, bb, clip, max_width, &h, NULL); bb[H][1] = 1; - xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, min_width, &h); + xr_layout_cell (xr, cell, footnote_idx, bb, clip, min_width, &h, NULL); + + if (*min_width > 0) + *min_width += xr->cell_margin * 2; + if (*max_width > 0) + *max_width += xr->cell_margin * 2; } static int -xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width) +xr_measure_cell_height (void *xr_, const struct table_cell *cell, + int footnote_idx, int width) { struct xr_driver *xr = xr_; int bb[TABLE_N_AXES][2]; @@ -716,194 +848,407 @@ xr_measure_cell_height (void *xr_, const struct table_cell *cell, int width) int w, h; bb[H][0] = 0; - bb[H][1] = width; + bb[H][1] = width - xr->cell_margin * 2; bb[V][0] = 0; bb[V][1] = INT_MAX; clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0; - xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h); + xr_layout_cell (xr, cell, footnote_idx, bb, clip, &w, &h, NULL); return h; } static void -xr_draw_cell (void *xr_, const struct table_cell *cell, +xr_draw_cell (void *xr_, const struct table_cell *cell, int footnote_idx, int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2]) { struct xr_driver *xr = xr_; - int w, h; + int w, h, brk; - xr_layout_cell (xr, cell, bb, clip, PANGO_WRAP_WORD, &w, &h); + bb[H][0] += xr->cell_margin; + bb[H][1] -= xr->cell_margin; + if (bb[H][0] >= bb[H][1]) + return; + xr_layout_cell (xr, cell, footnote_idx, bb, clip, &w, &h, &brk); } - -/* Writes STRING at location (X,Y) trimmed to the given MAX_WIDTH - and with the given cell OPTIONS for XR. */ + static int -draw_text (struct xr_driver *xr, const char *string, int x, int y, - int max_width, unsigned int options) +xr_adjust_break (void *xr_, const struct table_cell *cell, int footnote_idx, + int width, int height) { - struct table_cell cell; + struct xr_driver *xr = xr_; int bb[TABLE_N_AXES][2]; - int w, h; + int clip[TABLE_N_AXES][2]; + int w, h, brk; - cell.contents = string; - cell.options = options; - bb[H][0] = x; - bb[V][0] = y; - bb[H][1] = x + max_width; - bb[V][1] = xr->font_height; - xr_layout_cell (xr, &cell, bb, bb, PANGO_WRAP_WORD_CHAR, &w, &h); - return w; -} + if (xr_measure_cell_height (xr_, cell, footnote_idx, width) < height) + return -1; -/* Writes LEFT left-justified and RIGHT right-justified within - (X0...X1) at Y. LEFT or RIGHT or both may be null. */ + bb[H][0] = 0; + bb[H][1] = width - 2 * xr->cell_margin; + if (bb[H][1] <= 0) + return 0; + bb[V][0] = 0; + bb[V][1] = height; + clip[H][0] = clip[H][1] = clip[V][0] = clip[V][1] = 0; + xr_layout_cell (xr, cell, footnote_idx, bb, clip, &w, &h, &brk); + return brk; +} + static void -draw_header_line (struct xr_driver *xr, const char *left, const char *right, - int x0, int x1, int y) +xr_clip (struct xr_driver *xr, int clip[TABLE_N_AXES][2]) { - int right_width = 0; - if (right != NULL) - right_width = (draw_text (xr, right, x0, y, x1 - x0, TAB_RIGHT) - + xr->font_height / 2); - if (left != NULL) - draw_text (xr, left, x0, y, x1 - x0 - right_width, TAB_LEFT); + if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX) + { + double x0 = xr_to_pt (clip[H][0] + xr->x); + double y0 = xr_to_pt (clip[V][0] + xr->y); + double x1 = xr_to_pt (clip[H][1] + xr->x); + double y1 = xr_to_pt (clip[V][1] + xr->y); + + cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0); + cairo_clip (xr->cairo); + } } -/* Draw top of page headers for XR. */ static void -draw_headers (struct xr_driver *xr) +add_attr_with_start (PangoAttrList *list, PangoAttribute *attr, guint start_index) { - char *r1, *r2; - int x0, x1; - int y; - - y = -3 * xr->font_height; - x0 = xr->font_height / 2; - x1 = xr->width - xr->font_height / 2; - - /* Draw box. */ - cairo_rectangle (xr->cairo, 0, xr_to_pt (y), xr_to_pt (xr->width), - xr_to_pt (2 * (xr->font_height - + xr->line_width + xr->line_gutter))); - cairo_save (xr->cairo); - cairo_set_source_rgb (xr->cairo, 0.9, 0.9, 0.9); - cairo_fill_preserve (xr->cairo); - cairo_restore (xr->cairo); - cairo_stroke (xr->cairo); + attr->start_index = start_index; + pango_attr_list_insert (list, attr); +} - y += xr->line_width + xr->line_gutter; +static int +xr_layout_cell_text (struct xr_driver *xr, + const struct cell_contents *contents, int footnote_idx, + int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2], + int y, int *widthp, int *brk) +{ + unsigned int options = contents->options; + struct xr_font *font; + bool merge_footnotes; + size_t length; + int w, h; - r1 = xasprintf (_("%s - Page %d"), get_start_date (), xr->page_number); - r2 = xasprintf ("%s - %s", version, host_system); + if (contents->n_footnotes == 0) + merge_footnotes = false; + else if (contents->n_footnotes == 1 && (options & TAB_ALIGNMENT) == TAB_RIGHT) + { + PangoAttrList *attrs; + char marker[16]; - draw_header_line (xr, xr->title, r1, x0, x1, y); - y += xr->font_height; + font = &xr->fonts[XR_FONT_MARKER]; - draw_header_line (xr, xr->subtitle, r2, x0, x1, y); + str_format_26adic (footnote_idx + 1, false, marker, sizeof marker); + pango_layout_set_text (font->layout, marker, strlen (marker)); - free (r1); - free (r2); -} - -static void -xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell, - int bb[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2], - PangoWrapMode wrap, int *width, int *height) -{ - struct xr_font *font; + attrs = pango_attr_list_new (); + pango_attr_list_insert (attrs, pango_attr_rise_new (7000)); + pango_layout_set_attributes (font->layout, attrs); + pango_attr_list_unref (attrs); + + pango_layout_get_size (font->layout, &w, &h); + merge_footnotes = w > xr->cell_margin; + if (!merge_footnotes && clip[H][0] != clip[H][1]) + { + cairo_save (xr->cairo); + xr_clip (xr, clip); + cairo_translate (xr->cairo, + xr_to_pt (bb[H][1] + xr->x), + xr_to_pt (y + xr->y)); + pango_layout_set_alignment (font->layout, PANGO_ALIGN_LEFT); + pango_layout_set_width (font->layout, -1); + pango_cairo_show_layout (xr->cairo, font->layout); + cairo_restore (xr->cairo); + } - font = (cell->options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED] - : cell->options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS] + pango_layout_set_attributes (font->layout, NULL); + } + else + merge_footnotes = true; + + font = (options & TAB_FIX ? &xr->fonts[XR_FONT_FIXED] + : options & TAB_EMPH ? &xr->fonts[XR_FONT_EMPHASIS] : &xr->fonts[XR_FONT_PROPORTIONAL]); - pango_layout_set_text (font->layout, cell->contents, -1); + length = strlen (contents->text); + if (merge_footnotes) + { + PangoAttrList *attrs; + struct string s; + size_t i; + + bb[H][1] += xr->cell_margin; + + ds_init_empty (&s); + ds_extend (&s, length + contents->n_footnotes * 10); + ds_put_cstr (&s, contents->text); + for (i = 0; i < contents->n_footnotes; i++) + { + char marker[16]; + + if (i > 0) + ds_put_byte (&s, ','); + str_format_26adic (footnote_idx + i + 1, false, marker, sizeof marker); + ds_put_cstr (&s, marker); + } + pango_layout_set_text (font->layout, ds_cstr (&s), ds_length (&s)); + ds_destroy (&s); + + attrs = pango_attr_list_new (); + add_attr_with_start (attrs, pango_attr_rise_new (7000), length); + add_attr_with_start ( + attrs, pango_attr_font_desc_new (xr->fonts[XR_FONT_MARKER].desc), length); + pango_layout_set_attributes (font->layout, attrs); + pango_attr_list_unref (attrs); + } + else + pango_layout_set_text (font->layout, contents->text, -1); pango_layout_set_alignment ( font->layout, - ((cell->options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT - : (cell->options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT + ((options & TAB_ALIGNMENT) == TAB_RIGHT ? PANGO_ALIGN_RIGHT + : (options & TAB_ALIGNMENT) == TAB_LEFT ? PANGO_ALIGN_LEFT : PANGO_ALIGN_CENTER)); - pango_layout_set_width (font->layout, - bb[H][1] == INT_MAX ? -1 : bb[H][1] - bb[H][0]); - pango_layout_set_wrap (font->layout, wrap); + pango_layout_set_width ( + font->layout, + bb[H][1] == INT_MAX ? -1 : xr_to_pango (bb[H][1] - bb[H][0])); + pango_layout_set_wrap (font->layout, PANGO_WRAP_WORD); if (clip[H][0] != clip[H][1]) { cairo_save (xr->cairo); + xr_clip (xr, clip); + cairo_translate (xr->cairo, + xr_to_pt (bb[H][0] + xr->x), + xr_to_pt (y + xr->y)); + pango_cairo_show_layout (xr->cairo, font->layout); - if (clip[H][1] != INT_MAX || clip[V][1] != INT_MAX) + /* If enabled, this draws a blue rectangle around the extents of each + line of text, which can be rather useful for debugging layout + issues. */ + if (0) { - double x0 = xr_to_pt (clip[H][0]); - double y0 = xr_to_pt (clip[V][0] + xr->y); - double x1 = xr_to_pt (clip[H][1]); - double y1 = xr_to_pt (clip[V][1] + xr->y); - - cairo_rectangle (xr->cairo, x0, y0, x1 - x0, y1 - y0); - cairo_clip (xr->cairo); + PangoLayoutIter *iter; + iter = pango_layout_get_iter (font->layout); + do + { + PangoRectangle extents; + + pango_layout_iter_get_line_extents (iter, &extents, NULL); + cairo_save (xr->cairo); + cairo_set_source_rgb (xr->cairo, 1, 0, 0); + dump_rectangle (xr, + pango_to_xr (extents.x) - xr->x, + pango_to_xr (extents.y) - xr->y, + pango_to_xr (extents.x + extents.width) - xr->x, + pango_to_xr (extents.y + extents.height) - xr->y); + cairo_restore (xr->cairo); + } + while (pango_layout_iter_next_line (iter)); + pango_layout_iter_free (iter); } - cairo_translate (xr->cairo, - xr_to_pt (bb[H][0]), - xr_to_pt (bb[V][0] + xr->y)); - pango_cairo_show_layout (xr->cairo, font->layout); cairo_restore (xr->cairo); } - if (width != NULL || height != NULL) + pango_layout_get_size (font->layout, &w, &h); + w = pango_to_xr (w); + h = pango_to_xr (h); + if (w > *widthp) + *widthp = w; + if (y + h >= bb[V][1]) { - int w, h; + PangoLayoutIter *iter; + int best UNUSED = 0; - pango_layout_get_size (font->layout, &w, &h); - if (width != NULL) - *width = w; - if (height != NULL) - *height = h; + /* Choose a breakpoint between lines instead of in the middle of one. */ + iter = pango_layout_get_iter (font->layout); + do + { + PangoRectangle extents; + int y0, y1; + int bottom; + + pango_layout_iter_get_line_extents (iter, NULL, &extents); + pango_layout_iter_get_line_yrange (iter, &y0, &y1); + extents.x = pango_to_xr (extents.x); + extents.y = pango_to_xr (y0); + extents.width = pango_to_xr (extents.width); + extents.height = pango_to_xr (y1 - y0); + bottom = y + extents.y + extents.height; + if (bottom < bb[V][1]) + { + if (brk && clip[H][0] != clip[H][1]) + best = bottom; + if (brk) + *brk = bottom; + } + else + break; + } + while (pango_layout_iter_next_line (iter)); + pango_layout_iter_free (iter); + + /* If enabled, draws a green line across the chosen breakpoint, which can + be useful for debugging issues with breaking. */ + if (0) + { + if (best && !xr->nest) + { + cairo_save (xr->cairo); + cairo_set_source_rgb (xr->cairo, 0, 1, 0); + dump_line (xr, -xr->left_margin, best, xr->width + xr->right_margin, best); + cairo_restore (xr->cairo); + } + } } + + pango_layout_set_attributes (font->layout, NULL); + return y + h; } - -/* Attempts to load FONT, initializing its other members based on - its 'string' member and the information in DRIVER. Returns true - if successful, otherwise false. */ -static bool -load_font (struct xr_driver *xr, struct xr_font *font) + +static int +xr_layout_cell_subtable (struct xr_driver *xr, + const struct cell_contents *contents, + int footnote_idx UNUSED, + int bb[TABLE_N_AXES][2], + int clip[TABLE_N_AXES][2], int *widthp, int *brk) { - PangoContext *context; - PangoLanguage *language; + int single_width, double_width; + struct render_params params; + struct render_pager *p; + int r[TABLE_N_AXES][2]; + int width, height; + int i; - font->desc = pango_font_description_from_string (font->string); - if (font->desc == NULL) + params.draw_line = xr_draw_line; + params.measure_cell_width = xr_measure_cell_width; + params.measure_cell_height = xr_measure_cell_height; + params.adjust_break = NULL; + params.draw_cell = xr_draw_cell; + params.aux = xr; + params.size[H] = bb[H][1] - bb[H][0]; + params.size[V] = bb[V][1] - bb[V][0]; + params.font_size[H] = xr->char_width; + params.font_size[V] = xr->char_height; + + single_width = 2 * xr->line_gutter + xr->line_width; + double_width = 2 * xr->line_gutter + xr->line_space + 2 * xr->line_width; + for (i = 0; i < TABLE_N_AXES; i++) { - error (0, 0, _("\"%s\": bad font specification"), font->string); - return false; + params.line_widths[i][RENDER_LINE_NONE] = 0; + params.line_widths[i][RENDER_LINE_SINGLE] = single_width; + params.line_widths[i][RENDER_LINE_DOUBLE] = double_width; } - pango_font_description_set_absolute_size (font->desc, xr->font_height); - font->layout = pango_cairo_create_layout (xr->cairo); - pango_layout_set_font_description (font->layout, font->desc); + xr->nest++; + p = render_pager_create (¶ms, contents->table); + width = render_pager_get_size (p, H); + height = render_pager_get_size (p, V); + if (bb[V][0] + height >= bb[V][1]) + *brk = bb[V][0] + render_pager_get_best_breakpoint (p, bb[V][1] - bb[V][0]); + + /* r = intersect(bb, clip) - bb. */ + for (i = 0; i < TABLE_N_AXES; i++) + { + r[i][0] = MAX (bb[i][0], clip[i][0]) - bb[i][0]; + r[i][1] = MIN (bb[i][1], clip[i][1]) - bb[i][0]; + } - language = pango_language_get_default (); - context = pango_layout_get_context (font->layout); - font->metrics = pango_context_get_metrics (context, font->desc, language); + if (r[H][0] < r[H][1] && r[V][0] < r[V][1]) + { + unsigned int alignment = contents->options & TAB_ALIGNMENT; + int save_x = xr->x; - return true; + cairo_save (xr->cairo); + xr_clip (xr, clip); + xr->x += bb[H][0]; + if (alignment == TAB_RIGHT) + xr->x += params.size[H] - width; + else if (alignment == TAB_CENTER) + xr->x += (params.size[H] - width) / 2; + xr->y += bb[V][0]; + render_pager_draw_region (p, r[H][0], r[V][0], + r[H][1] - r[H][0], r[V][1] - r[V][0]); + xr->y -= bb[V][0]; + xr->x = save_x; + cairo_restore (xr->cairo); + } + render_pager_destroy (p); + xr->nest--; + + if (width > *widthp) + *widthp = width; + return bb[V][0] + height; } -/* Frees FONT. */ static void -free_font (struct xr_font *font) +xr_layout_cell (struct xr_driver *xr, const struct table_cell *cell, + int footnote_idx, + int bb_[TABLE_N_AXES][2], int clip[TABLE_N_AXES][2], + int *width, int *height, int *brk) { - free (font->string); - if (font->desc != NULL) - pango_font_description_free (font->desc); - pango_font_metrics_unref (font->metrics); - if (font->layout != NULL) - g_object_unref (font->layout); -} + int bb[TABLE_N_AXES][2]; + size_t i; + + *width = 0; + *height = 0; + if (brk) + *brk = 0; + + memcpy (bb, bb_, sizeof bb); + + /* If enabled, draws a blue rectangle around the cell extents, which can be + useful for debugging layout. */ + if (0) + { + if (clip[H][0] != clip[H][1]) + { + int offset = (xr->nest) * XR_POINT; + + cairo_save (xr->cairo); + cairo_set_source_rgb (xr->cairo, 0, 0, 1); + dump_rectangle (xr, + bb[H][0] + offset, bb[V][0] + offset, + bb[H][1] - offset, bb[V][1] - offset); + cairo_restore (xr->cairo); + } + } + + for (i = 0; i < cell->n_contents && bb[V][0] < bb[V][1]; i++) + { + const struct cell_contents *contents = &cell->contents[i]; + + if (brk) + *brk = bb[V][0]; + if (i > 0) + { + bb[V][0] += xr->char_height / 2; + if (bb[V][0] >= bb[V][1]) + break; + if (brk) + *brk = bb[V][0]; + } -/* Cairo driver class. */ -const struct output_driver_class cairo_class = + if (contents->text) + bb[V][0] = xr_layout_cell_text (xr, contents, footnote_idx, bb, clip, + bb[V][0], width, brk); + else + bb[V][0] = xr_layout_cell_subtable (xr, contents, footnote_idx, + bb, clip, width, brk); + footnote_idx += contents->n_footnotes; + } + *height = bb[V][0] - bb_[V][0]; +} + +struct output_driver_factory pdf_driver_factory = + { "pdf", "pspp.pdf", xr_pdf_create }; +struct output_driver_factory ps_driver_factory = + { "ps", "pspp.ps", xr_ps_create }; +struct output_driver_factory svg_driver_factory = + { "svg", "pspp.svg", xr_svg_create }; + +static const struct output_driver_class cairo_driver_class = { "cairo", - xr_create, xr_destroy, xr_submit, xr_flush, @@ -913,30 +1258,22 @@ const struct output_driver_class cairo_class = struct xr_rendering { + struct output_item *item; + /* Table items. */ - struct render_page *page; + struct render_pager *p; struct xr_driver *xr; - int title_height; - - /* Chart items. */ - struct chart_item *chart; }; #define CHART_WIDTH 500 #define CHART_HEIGHT 375 -struct xr_driver * -xr_create_driver (cairo_t *cairo) -{ - struct xr_driver *xr; - struct string_map map; - string_map_init (&map); - xr = xr_allocate ("cairo", 0, &map); - string_map_destroy (&map); - xr->width = INT_MAX / 8; - xr->length = INT_MAX / 8; +struct xr_driver * +xr_driver_create (cairo_t *cairo, struct string_map *options) +{ + struct xr_driver *xr = xr_allocate ("cairo", 0, options); if (!xr_set_cairo (xr, cairo)) { output_driver_destroy (&xr->driver); @@ -945,6 +1282,39 @@ xr_create_driver (cairo_t *cairo) return xr; } +/* Destroy XR, which should have been created with xr_driver_create(). Any + cairo_t added to XR is not destroyed, because it is owned by the client. */ +void +xr_driver_destroy (struct xr_driver *xr) +{ + if (xr != NULL) + { + xr->cairo = NULL; + output_driver_destroy (&xr->driver); + } +} + +static struct xr_rendering * +xr_rendering_create_text (struct xr_driver *xr, const char *text, cairo_t *cr) +{ + struct table_item *table_item; + struct xr_rendering *r; + + table_item = table_item_create (table_from_string (TAB_LEFT, text), + NULL, NULL); + r = xr_rendering_create (xr, &table_item->output_item, cr); + table_item_unref (table_item); + + return r; +} + +void +xr_rendering_apply_options (struct xr_rendering *xr, struct string_map *o) +{ + if (is_table_item (xr->item)) + apply_options (xr->xr, o); +} + struct xr_rendering * xr_rendering_create (struct xr_driver *xr, const struct output_item *item, cairo_t *cr) @@ -952,40 +1322,51 @@ xr_rendering_create (struct xr_driver *xr, const struct output_item *item, struct xr_rendering *r = NULL; if (is_text_item (item)) + r = xr_rendering_create_text (xr, text_item_get_text (to_text_item (item)), + cr); + else if (is_message_item (item)) { - const struct text_item *text_item = to_text_item (item); - const char *text = text_item_get_text (text_item); - struct table_item *table_item; - - table_item = table_item_create (table_from_string (TAB_LEFT, text), - NULL); - r = xr_rendering_create (xr, &table_item->output_item, cr); - table_item_unref (table_item); + const struct message_item *message_item = to_message_item (item); + const struct msg *msg = message_item_get_msg (message_item); + char *s = msg_to_string (msg, NULL); + r = xr_rendering_create_text (xr, s, cr); + free (s); } else if (is_table_item (item)) { r = xzalloc (sizeof *r); + r->item = output_item_ref (item); r->xr = xr; xr_set_cairo (xr, cr); - r->page = xr_render_table_item (xr, to_table_item (item), - &r->title_height); + r->p = render_pager_create (xr->params, to_table_item (item)); } else if (is_chart_item (item)) { r = xzalloc (sizeof *r); - r->chart = to_chart_item (output_item_ref (item)); + r->item = output_item_ref (item); } return r; } +void +xr_rendering_destroy (struct xr_rendering *r) +{ + if (r) + { + output_item_unref (r->item); + render_pager_destroy (r->p); + free (r); + } +} + void xr_rendering_measure (struct xr_rendering *r, int *w, int *h) { - if (r->chart == NULL) + if (is_table_item (r->item)) { - *w = render_page_get_size (r->page, H) / 1024; - *h = (render_page_get_size (r->page, V) + r->title_height) / 1024; + *w = render_pager_get_size (r->p, H) / XR_POINT; + *h = render_pager_get_size (r->p, V) / XR_POINT; } else { @@ -994,22 +1375,28 @@ xr_rendering_measure (struct xr_rendering *r, int *w, int *h) } } +static void xr_draw_chart (const struct chart_item *, cairo_t *, + double x, double y, double width, double height); + +/* Draws onto CR */ void -xr_rendering_draw (struct xr_rendering *r, cairo_t *cr) +xr_rendering_draw_all (struct xr_rendering *r, cairo_t *cr) { - if (r->chart == NULL) + if (is_table_item (r->item)) { struct xr_driver *xr = r->xr; xr_set_cairo (xr, cr); - xr->y = 0; - render_page_draw (r->page); + + render_pager_draw (r->p); + } else - xr_draw_chart (r->chart, cr, 0, 0, CHART_WIDTH, CHART_HEIGHT); + xr_draw_chart (to_chart_item (r->item), cr, + 0, 0, CHART_WIDTH, CHART_HEIGHT); } -void +static void xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr, double x, double y, double width, double height) { @@ -1027,10 +1414,16 @@ xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr, xrchart_draw_np_plot (chart_item, cr, &geom); else if (is_piechart (chart_item)) xrchart_draw_piechart (chart_item, cr, &geom); + else if (is_barchart (chart_item)) + xrchart_draw_barchart (chart_item, cr, &geom); else if (is_roc_chart (chart_item)) xrchart_draw_roc (chart_item, cr, &geom); else if (is_scree (chart_item)) xrchart_draw_scree (chart_item, cr, &geom); + else if (is_spreadlevel_plot_chart (chart_item)) + xrchart_draw_spreadlevel (chart_item, cr, &geom); + else if (is_scatterplot_chart (chart_item)) + xrchart_draw_scatterplot (chart_item, cr, &geom); else NOT_REACHED (); xrchart_geometry_free (cr, &geom); @@ -1040,7 +1433,10 @@ xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr, char * xr_draw_png_chart (const struct chart_item *item, - const char *file_name_template, int number) + const char *file_name_template, int number, + const struct xr_color *fg, + const struct xr_color *bg + ) { const int width = 640; const int length = 480; @@ -1061,19 +1457,16 @@ xr_draw_png_chart (const struct chart_item *item, surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length); cr = cairo_create (surface); - cairo_save (cr); - cairo_set_source_rgb (cr, 1.0, 1.0, 1.0); - cairo_rectangle (cr, 0, 0, width, length); - cairo_fill (cr); - cairo_restore (cr); + cairo_set_source_rgb (cr, bg->red, bg->green, bg->blue); + cairo_paint (cr); - cairo_set_source_rgb (cr, 0.0, 0.0, 0.0); + cairo_set_source_rgb (cr, fg->red, fg->green, fg->blue); xr_draw_chart (item, cr, 0.0, 0.0, width, length); status = cairo_surface_write_to_png (surface, file_name); if (status != CAIRO_STATUS_SUCCESS) - error (0, 0, _("writing output file \"%s\": %s"), + msg (ME, _("error writing output file `%s': %s"), file_name, cairo_status_to_string (status)); cairo_destroy (cr); @@ -1081,3 +1474,217 @@ xr_draw_png_chart (const struct chart_item *item, return file_name; } + +struct xr_table_state + { + struct xr_render_fsm fsm; + struct table_item *table_item; + struct render_pager *p; + }; + +static bool +xr_table_render (struct xr_render_fsm *fsm, struct xr_driver *xr) +{ + struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm); + + while (render_pager_has_next (ts->p)) + { + int used; + + used = render_pager_draw_next (ts->p, xr->length - xr->y); + if (!used) + { + assert (xr->y > 0); + return true; + } + else + xr->y += used; + } + return false; +} + +static void +xr_table_destroy (struct xr_render_fsm *fsm) +{ + struct xr_table_state *ts = UP_CAST (fsm, struct xr_table_state, fsm); + + table_item_unref (ts->table_item); + render_pager_destroy (ts->p); + free (ts); +} + +static struct xr_render_fsm * +xr_render_table (struct xr_driver *xr, const struct table_item *table_item) +{ + struct xr_table_state *ts; + + ts = xmalloc (sizeof *ts); + ts->fsm.render = xr_table_render; + ts->fsm.destroy = xr_table_destroy; + ts->table_item = table_item_ref (table_item); + + if (xr->y > 0) + xr->y += xr->char_height; + + ts->p = render_pager_create (xr->params, table_item); + + return &ts->fsm; +} + +struct xr_chart_state + { + struct xr_render_fsm fsm; + struct chart_item *chart_item; + }; + +static bool +xr_chart_render (struct xr_render_fsm *fsm, struct xr_driver *xr) +{ + struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm); + + const int chart_height = xr->length; + + if (xr->y > xr->length - chart_height) + return true; + + if (xr->cairo != NULL) + { + xr_draw_chart (cs->chart_item, xr->cairo, + 0.0, + xr_to_pt (xr->y), + xr_to_pt (xr->width), + xr_to_pt (chart_height)); + } + xr->y += chart_height; + + return false; +} + +static void +xr_chart_destroy (struct xr_render_fsm *fsm) +{ + struct xr_chart_state *cs = UP_CAST (fsm, struct xr_chart_state, fsm); + + chart_item_unref (cs->chart_item); + free (cs); +} + +static struct xr_render_fsm * +xr_render_chart (const struct chart_item *chart_item) +{ + struct xr_chart_state *cs; + + cs = xmalloc (sizeof *cs); + cs->fsm.render = xr_chart_render; + cs->fsm.destroy = xr_chart_destroy; + cs->chart_item = chart_item_ref (chart_item); + + return &cs->fsm; +} + +static bool +xr_eject_render (struct xr_render_fsm *fsm UNUSED, struct xr_driver *xr) +{ + return xr->y > 0; +} + +static void +xr_eject_destroy (struct xr_render_fsm *fsm UNUSED) +{ + /* Nothing to do. */ +} + +static struct xr_render_fsm * +xr_render_eject (void) +{ + static struct xr_render_fsm eject_renderer = + { + xr_eject_render, + xr_eject_destroy + }; + + return &eject_renderer; +} + +static struct xr_render_fsm * +xr_create_text_renderer (struct xr_driver *xr, const char *text) +{ + struct table_item *table_item; + struct xr_render_fsm *fsm; + + table_item = table_item_create (table_from_string (TAB_LEFT, text), + NULL, NULL); + fsm = xr_render_table (xr, table_item); + table_item_unref (table_item); + + return fsm; +} + +static struct xr_render_fsm * +xr_render_text (struct xr_driver *xr, const struct text_item *text_item) +{ + enum text_item_type type = text_item_get_type (text_item); + const char *text = text_item_get_text (text_item); + + switch (type) + { + case TEXT_ITEM_TITLE: + free (xr->title); + xr->title = xstrdup (text); + break; + + case TEXT_ITEM_SUBTITLE: + free (xr->subtitle); + xr->subtitle = xstrdup (text); + break; + + case TEXT_ITEM_COMMAND_CLOSE: + break; + + case TEXT_ITEM_BLANK_LINE: + if (xr->y > 0) + xr->y += xr->char_height; + break; + + case TEXT_ITEM_EJECT_PAGE: + if (xr->y > 0) + return xr_render_eject (); + break; + + default: + return xr_create_text_renderer (xr, text); + } + + return NULL; +} + +static struct xr_render_fsm * +xr_render_message (struct xr_driver *xr, + const struct message_item *message_item) +{ + const struct msg *msg = message_item_get_msg (message_item); + struct xr_render_fsm *fsm; + char *s; + + s = msg_to_string (msg, xr->command_name); + fsm = xr_create_text_renderer (xr, s); + free (s); + + return fsm; +} + +static struct xr_render_fsm * +xr_render_output_item (struct xr_driver *xr, + const struct output_item *output_item) +{ + if (is_table_item (output_item)) + return xr_render_table (xr, to_table_item (output_item)); + else if (is_chart_item (output_item)) + return xr_render_chart (to_chart_item (output_item)); + else if (is_text_item (output_item)) + return xr_render_text (xr, to_text_item (output_item)); + else if (is_message_item (output_item)) + return xr_render_message (xr, to_message_item (output_item)); + else + return NULL; +}