1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2004, 2009, 2010, 2011, 2014, 2015,
3 2020 Free Software Foundation, Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "output/cairo-chart.h"
21 #include "math/chart-geometry.h"
23 #include <cairo/cairo-ps.h>
24 #include <cairo/cairo.h>
25 #include <pango/pango.h>
26 #include <pango/pangocairo.h>
34 #include "libpspp/assertion.h"
35 #include "libpspp/message.h"
36 #include "math/chart-geometry.h"
37 #include "output/chart-item.h"
38 #include "output/charts/barchart.h"
39 #include "output/charts/boxplot.h"
40 #include "output/charts/np-plot.h"
41 #include "output/charts/piechart.h"
42 #include "output/charts/plot-hist.h"
43 #include "output/charts/roc-chart.h"
44 #include "output/charts/scatterplot.h"
45 #include "output/charts/scree.h"
46 #include "output/charts/spreadlevel-plot.h"
47 #include "output/table.h"
49 #include "gl/xalloc.h"
50 #include "gl/xvasprintf.h"
53 #define _(msgid) gettext (msgid)
56 xrchart_geometry_init (cairo_t *cr, struct xrchart_geometry *geom,
57 double width, double length)
59 /* Set default chart geometry. */
60 geom->axis[SCALE_ORDINATE].data_max = 0.900 * length;
61 geom->axis[SCALE_ORDINATE].data_min = 0.200 * length;
63 geom->axis[SCALE_ABSCISSA].data_min = 0.150 * width;
64 geom->axis[SCALE_ABSCISSA].data_max = 0.800 * width;
65 geom->abscissa_bottom = 0.070 * length;
66 geom->ordinate_left = 0.050 * width;
67 geom->title_bottom = 0.920 * length;
68 geom->legend_left = 0.810 * width;
69 geom->legend_right = width;
70 geom->font_size = 15.0;
71 geom->in_path = false;
75 geom->fill_colour = data_colour[0];
77 cairo_set_line_width (cr, 1.0);
79 cairo_rectangle (cr, geom->axis[SCALE_ABSCISSA].data_min, geom->axis[SCALE_ORDINATE].data_min,
80 geom->axis[SCALE_ABSCISSA].data_max - geom->axis[SCALE_ABSCISSA].data_min,
81 geom->axis[SCALE_ORDINATE].data_max - geom->axis[SCALE_ORDINATE].data_min);
86 xrchart_geometry_free (cairo_t *cr UNUSED, struct xrchart_geometry *geom)
90 for (i = 0 ; i < geom->n_datasets; ++i)
91 free (geom->dataset[i]);
95 #if ! PANGO_VERSION_CHECK (1, 22, 0)
96 int pango_layout_get_baseline (PangoLayout *layout);
98 /* Shamelessly copied from the pango source */
100 pango_layout_get_baseline (PangoLayout *layout)
104 /* XXX this is so inefficient */
105 PangoLayoutIter *iter = pango_layout_get_iter (layout);
106 baseline = pango_layout_iter_get_baseline (iter);
107 pango_layout_iter_free (iter);
114 These colours come from:
115 http://tango.freedesktop.org/static/cvs/tango-art-tools/palettes/Tango-Palette.gpl */
116 const struct xrchart_colour data_colour[XRCHART_N_COLOURS] =
118 {252, 233, 79}, /* Butter 1 */
119 {138, 226, 52}, /* Chameleon 1 */
120 {252, 175, 62}, /* Orange 1 */
121 {114, 159, 207}, /* Sky Blue 1 */
122 {173, 127, 168}, /* Plum 1 */
123 {233, 185, 110}, /* Chocolate 1 */
124 {239, 41, 41}, /* Scarlet Red 1 */
125 {238, 238, 236}, /* Aluminium 1 */
127 {237, 212, 0}, /* Butter 2 */
128 {115, 210, 22}, /* Chameleon 2 */
129 {245, 121, 0}, /* Orange 2 */
130 {52, 101, 164}, /* Sky Blue 2 */
131 {117, 80, 123}, /* Plum 2 */
132 {193, 125, 17}, /* Chocolate 2 */
133 {204, 0, 0}, /* Scarlet Red 2 */
135 {136, 138, 133}, /* Aluminium 4 */
137 {196, 160, 0}, /* Butter 3 */
138 {78, 154, 6}, /* Chameleon 3 */
139 {206, 92, 0}, /* Orange 3 */
140 {32, 74, 135}, /* Sky Blue 3 */
141 {92, 53, 102}, /* Plum 3 */
142 {143, 89, 2}, /* Chocolate 3 */
143 {164, 0, 0}, /* Scarlet Red 3 */
144 {85, 87, 83}, /* Aluminium 5 */
146 {211, 215, 207}, /* Aluminium 2 */
147 {186, 189, 182}, /* Aluminium 3 */
148 {46, 52, 54}, /* Aluminium 6 */
152 xrchart_draw_marker (cairo_t *cr, double x, double y,
153 enum xrmarker_type marker, double size)
156 cairo_translate (cr, x, y);
157 cairo_scale (cr, size / 2.0, size / 2.0);
158 cairo_set_line_width (cr, cairo_get_line_width (cr) / (size / 2.0));
161 case XRMARKER_CIRCLE:
162 cairo_arc (cr, 0, 0, 1.0, 0, 2 * M_PI);
166 case XRMARKER_ASTERISK:
167 cairo_move_to (cr, 0, -1.0); /* | */
168 cairo_line_to (cr, 0, 1.0);
169 cairo_move_to (cr, -M_SQRT1_2, -M_SQRT1_2); /* / */
170 cairo_line_to (cr, M_SQRT1_2, M_SQRT1_2);
171 cairo_move_to (cr, -M_SQRT1_2, M_SQRT1_2); /* \ */
172 cairo_line_to (cr, M_SQRT1_2, -M_SQRT1_2);
176 case XRMARKER_SQUARE:
177 cairo_rectangle (cr, -1.0, -1.0, 2.0, 2.0);
185 xrchart_label_rotate (cairo_t *cr, int horz_justify, int vert_justify,
186 double font_size, const char *string, double angle)
188 PangoFontDescription *desc;
192 desc = pango_font_description_from_string ("Sans");
198 pango_font_description_set_absolute_size (desc, font_size * PANGO_SCALE);
201 cairo_rotate (cr, angle);
202 cairo_get_current_point (cr, &x, &y);
203 cairo_translate (cr, x, y);
204 cairo_move_to (cr, 0, 0);
205 cairo_scale (cr, 1.0, -1.0);
207 layout = pango_cairo_create_layout (cr);
208 pango_layout_set_font_description (layout, desc);
209 pango_layout_set_markup (layout, string, -1);
210 if (horz_justify != 'l')
215 pango_layout_get_size (layout, &width_pango, NULL);
216 width = (double) width_pango / PANGO_SCALE;
217 if (horz_justify == 'r')
218 cairo_rel_move_to (cr, -width, 0);
220 cairo_rel_move_to (cr, -width / 2.0, 0);
222 if (vert_justify == 'x')
224 int baseline_pango = pango_layout_get_baseline (layout);
225 double baseline = (double) baseline_pango / PANGO_SCALE;
226 cairo_rel_move_to (cr, 0, -baseline);
228 else if (vert_justify != 't')
233 pango_layout_get_size (layout, NULL, &height_pango);
234 height = (double) height_pango / PANGO_SCALE;
235 if (vert_justify == 'b')
236 cairo_rel_move_to (cr, 0, -height);
237 else if (vert_justify == 'c')
238 cairo_rel_move_to (cr, 0, -height / 2.0);
240 pango_cairo_show_layout (cr, layout);
241 g_object_unref (layout);
247 pango_font_description_free (desc);
251 xrchart_label (cairo_t *cr, int horz_justify, int vert_justify,
252 double font_size, const char *string)
254 xrchart_label_rotate (cr, horz_justify, vert_justify, font_size, string, 0);
258 /* Draw a tick mark at position
259 If label is non null, then print it at the tick mark
262 draw_tick_internal (cairo_t *cr, const struct xrchart_geometry *geom,
263 enum tick_orientation orientation,
269 draw_tick (cairo_t *cr, const struct xrchart_geometry *geom,
270 enum tick_orientation orientation,
273 const char *label, ...)
277 va_start (ap, label);
278 s = xvasprintf (label, ap);
280 if (fabs (position) < DBL_EPSILON)
283 draw_tick_internal (cr, geom, orientation, rotated, position, s);
290 draw_tick_internal (cairo_t *cr, const struct xrchart_geometry *geom,
291 enum tick_orientation orientation,
296 const int tickSize = 10;
299 cairo_move_to (cr, geom->axis[SCALE_ABSCISSA].data_min, geom->axis[SCALE_ORDINATE].data_min);
301 if (orientation == SCALE_ABSCISSA)
303 cairo_rel_move_to (cr, position, 0);
304 cairo_rel_line_to (cr, 0, -tickSize);
306 else if (orientation == SCALE_ORDINATE)
308 cairo_rel_move_to (cr, 0, position);
309 cairo_rel_line_to (cr, -tickSize, 0);
313 cairo_get_current_point (cr, &x, &y);
319 cairo_move_to (cr, x, y);
321 if (orientation == SCALE_ABSCISSA)
324 xrchart_label_rotate (cr, 'l', 'c', geom->font_size, s, -G_PI_4);
326 xrchart_label (cr, 'c', 't', geom->font_size, s);
328 else if (orientation == SCALE_ORDINATE)
330 xrchart_label (cr, 'r', 'c', geom->font_size, s);
336 /* Write the title on a chart*/
338 xrchart_write_title (cairo_t *cr, const struct xrchart_geometry *geom,
339 const char *title, ...)
345 cairo_move_to (cr, geom->axis[SCALE_ABSCISSA].data_min, geom->title_bottom);
348 s = xvasprintf (title, ap);
349 xrchart_label (cr, 'l', 'x', geom->font_size * 1.5, s);
357 xrchart_text_extents (cairo_t *cr, const struct xrchart_geometry *geom,
359 double *width, double *height)
361 PangoFontDescription *desc;
366 desc = pango_font_description_from_string ("Sans");
369 pango_font_description_set_absolute_size (desc, geom->font_size * PANGO_SCALE);
370 layout = pango_cairo_create_layout (cr);
371 pango_layout_set_font_description (layout, desc);
372 pango_layout_set_markup (layout, utf8, -1);
373 pango_layout_get_size (layout, &width_pango, &height_pango);
374 *width = (double) width_pango / PANGO_SCALE;
375 *height = (double) height_pango / PANGO_SCALE;
376 g_object_unref (layout);
377 pango_font_description_free (desc);
381 xrchart_write_scale (cairo_t *cr, struct xrchart_geometry *geom,
382 double smin, double smax, enum tick_orientation orient)
391 char *tick_format_string;
392 bool tickoversize = false;
397 chart_get_scale (smax, smin, &lower, &interval, &ticks);
399 tick_format_string = chart_get_ticks_format (lower, interval, ticks, &tickscale);
401 upper = lower + interval * (ticks+1);
403 geom->axis[orient].max = upper;
404 geom->axis[orient].min = lower;
406 struct xrchart_axis *axis = &geom->axis[orient];
407 geom->axis[orient].scale = (fabs ((double) axis->data_max - axis->data_min)
408 / fabs (axis->max - axis->min));
410 if (orient == SCALE_ABSCISSA)
413 double lower_txt_width, upper_txt_width, unused, width;
414 test_text = xasprintf(tick_format_string, upper*tickscale);
415 xrchart_text_extents (cr, geom, test_text, &upper_txt_width, &unused);
417 test_text = xasprintf(tick_format_string, lower*tickscale);
418 xrchart_text_extents (cr, geom, test_text, &lower_txt_width, &unused);
420 width = MAX(lower_txt_width, upper_txt_width);
421 tickoversize = width > 0.9 *
422 ((double)(geom->axis[SCALE_ABSCISSA].data_max - geom->axis[SCALE_ABSCISSA].data_min))/(ticks+1);
427 for (s = 0 ; s <= ticks; ++s)
429 draw_tick (cr, geom, orient, tickoversize,
430 s * interval * geom->axis[orient].scale,
431 tick_format_string, pos*tickscale);
434 free(tick_format_string);
439 /* Set the scale for the ordinate */
441 xrchart_write_yscale (cairo_t *cr, struct xrchart_geometry *geom,
442 double smin, double smax)
444 return xrchart_write_scale (cr, geom, smin, smax, SCALE_ORDINATE);
447 /* Set the scale for the abscissa */
449 xrchart_write_xscale (cairo_t *cr, struct xrchart_geometry *geom,
450 double smin, double smax)
452 return xrchart_write_scale (cr, geom, smin, smax, SCALE_ABSCISSA);
456 /* Write the abscissa label */
458 xrchart_write_xlabel (cairo_t *cr, const struct xrchart_geometry *geom,
461 cairo_move_to (cr, geom->axis[SCALE_ABSCISSA].data_min, geom->abscissa_bottom);
462 xrchart_label (cr, 'l', 't', geom->font_size, label);
465 /* Write the ordinate label */
467 xrchart_write_ylabel (cairo_t *cr, const struct xrchart_geometry *geom,
471 cairo_translate (cr, geom->ordinate_left, geom->axis[SCALE_ORDINATE].data_min);
472 cairo_rotate (cr, M_PI / 2.0);
474 xrchart_label (cr, 'l', 'x', geom->font_size, label);
480 xrchart_write_legend (cairo_t *cr, const struct xrchart_geometry *geom)
483 const int vstep = geom->font_size * 2;
486 const int swatch = 20;
487 const int legend_top = geom->axis[SCALE_ORDINATE].data_max;
488 const int legend_bottom = legend_top -
489 (vstep * geom->n_datasets + 2 * ypad);
493 cairo_rectangle (cr, geom->legend_left, legend_top,
494 geom->legend_right - xpad - geom->legend_left,
495 legend_bottom - legend_top);
498 for (i = 0 ; i < geom->n_datasets ; ++i)
500 const int ypos = legend_top - vstep * (i + 1);
501 const int xpos = geom->legend_left + xpad;
502 const struct xrchart_colour *colour;
504 cairo_move_to (cr, xpos, ypos);
507 colour = &data_colour [ i % XRCHART_N_COLOURS];
508 cairo_set_source_rgb (cr,
510 colour->green / 255.0,
511 colour->blue / 255.0);
512 cairo_rectangle (cr, xpos, ypos, swatch, swatch);
513 cairo_fill_preserve (cr);
517 cairo_move_to (cr, xpos + swatch * 1.5, ypos);
518 xrchart_label (cr, 'l', 'x', geom->font_size, geom->dataset[i]);
524 /* Start a new vector called NAME */
526 xrchart_vector_start (cairo_t *cr, struct xrchart_geometry *geom, const char *name)
528 const struct xrchart_colour *colour;
532 colour = &data_colour[geom->n_datasets % XRCHART_N_COLOURS];
533 cairo_set_source_rgb (cr,
535 colour->green / 255.0,
536 colour->blue / 255.0);
539 geom->dataset = xrealloc (geom->dataset,
540 geom->n_datasets * sizeof (*geom->dataset));
542 geom->dataset[geom->n_datasets - 1] = strdup (name);
545 /* Plot a data point */
547 xrchart_datum (cairo_t *cr, const struct xrchart_geometry *geom,
548 int dataset UNUSED, double x, double y)
550 double x_pos = (x - geom->axis[SCALE_ABSCISSA].min) * geom->axis[SCALE_ABSCISSA].scale + geom->axis[SCALE_ABSCISSA].data_min;
551 double y_pos = (y - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale + geom->axis[SCALE_ORDINATE].data_min;
553 xrchart_draw_marker (cr, x_pos, y_pos, XRMARKER_CIRCLE, 10);
557 xrchart_vector_end (cairo_t *cr, struct xrchart_geometry *geom)
561 geom->in_path = false;
564 /* Plot a data point */
566 xrchart_vector (cairo_t *cr, struct xrchart_geometry *geom, double x, double y)
569 (x - geom->axis[SCALE_ABSCISSA].min) * geom->axis[SCALE_ABSCISSA].scale + geom->axis[SCALE_ABSCISSA].data_min ;
572 (y - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale + geom->axis[SCALE_ORDINATE].data_min ;
575 cairo_line_to (cr, x_pos, y_pos);
578 cairo_move_to (cr, x_pos, y_pos);
579 geom->in_path = true;
585 /* Draw a line with slope SLOPE and intercept INTERCEPT.
586 between the points limit1 and limit2.
587 If lim_dim is XRCHART_DIM_Y then the limit{1,2} are on the
588 y axis otherwise the x axis
591 xrchart_line(cairo_t *cr, const struct xrchart_geometry *geom,
592 double slope, double intercept,
593 double limit1, double limit2, enum xrchart_dim lim_dim)
598 if (lim_dim == XRCHART_DIM_Y)
600 x1 = (limit1 - intercept) / slope;
601 x2 = (limit2 - intercept) / slope;
609 y1 = slope * x1 + intercept;
610 y2 = slope * x2 + intercept;
613 y1 = (y1 - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale + geom->axis[SCALE_ORDINATE].data_min;
614 y2 = (y2 - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale + geom->axis[SCALE_ORDINATE].data_min;
615 x1 = (x1 - geom->axis[SCALE_ABSCISSA].min) * geom->axis[SCALE_ABSCISSA].scale + geom->axis[SCALE_ABSCISSA].data_min;
616 x2 = (x2 - geom->axis[SCALE_ABSCISSA].min) * geom->axis[SCALE_ABSCISSA].scale + geom->axis[SCALE_ABSCISSA].data_min;
618 cairo_move_to (cr, x1, y1);
619 cairo_line_to (cr, x2, y2);
624 xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
625 double width, double height)
627 struct xrchart_geometry geom;
630 cairo_translate (cr, 0, height);
631 cairo_scale (cr, 1.0, -1.0);
632 xrchart_geometry_init (cr, &geom, width, height);
633 if (is_boxplot (chart_item))
634 xrchart_draw_boxplot (chart_item, cr, &geom);
635 else if (is_histogram_chart (chart_item))
636 xrchart_draw_histogram (chart_item, cr, &geom);
637 else if (is_np_plot_chart (chart_item))
638 xrchart_draw_np_plot (chart_item, cr, &geom);
639 else if (is_piechart (chart_item))
640 xrchart_draw_piechart (chart_item, cr, &geom);
641 else if (is_barchart (chart_item))
642 xrchart_draw_barchart (chart_item, cr, &geom);
643 else if (is_roc_chart (chart_item))
644 xrchart_draw_roc (chart_item, cr, &geom);
645 else if (is_scree (chart_item))
646 xrchart_draw_scree (chart_item, cr, &geom);
647 else if (is_spreadlevel_plot_chart (chart_item))
648 xrchart_draw_spreadlevel (chart_item, cr, &geom);
649 else if (is_scatterplot_chart (chart_item))
650 xrchart_draw_scatterplot (chart_item, cr, &geom);
653 xrchart_geometry_free (cr, &geom);
659 xr_draw_png_chart (const struct chart_item *item,
660 const char *file_name_template, int number,
661 const struct cell_color *fg,
662 const struct cell_color *bg)
664 const int width = 640;
665 const int length = 480;
667 cairo_surface_t *surface;
668 cairo_status_t status;
669 const char *number_pos;
673 number_pos = strchr (file_name_template, '#');
674 if (number_pos != NULL)
675 file_name = xasprintf ("%.*s%d%s.png", (int) (number_pos - file_name_template),
676 file_name_template, number, number_pos + 1);
678 file_name = xasprintf ("%s.png", file_name_template);
680 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, length);
681 cr = cairo_create (surface);
683 cairo_set_source_rgb (cr, bg->r / 255.0, bg->g / 255.0, bg->b / 255.0);
686 cairo_set_source_rgb (cr, fg->r / 255.0, fg->g / 255.0, fg->b / 255.0);
688 xr_draw_chart (item, cr, width, length);
690 status = cairo_surface_write_to_png (surface, file_name);
691 if (status != CAIRO_STATUS_SUCCESS)
692 msg (ME, _("error writing output file `%s': %s"),
693 file_name, cairo_status_to_string (status));
696 cairo_surface_destroy (surface);
703 xr_draw_eps_chart (const struct chart_item *item,
704 const char *file_name_template, int number,
705 const struct cell_color *fg,
706 const struct cell_color *bg)
708 const int width = 640;
709 const int length = 480;
711 cairo_surface_t *surface;
712 const char *number_pos;
716 number_pos = strchr (file_name_template, '#');
717 if (number_pos != NULL)
718 file_name = xasprintf ("%.*s%d%s.eps", (int) (number_pos - file_name_template),
719 file_name_template, number, number_pos + 1);
721 file_name = xasprintf ("%s.eps", file_name_template);
723 surface = cairo_ps_surface_create (file_name, width, length);
724 cairo_ps_surface_set_eps (surface, true);
725 cr = cairo_create (surface);
727 cairo_set_source_rgb (cr, bg->r / 255.0, bg->g / 255.0, bg->b / 255.0);
730 cairo_set_source_rgb (cr, fg->r / 255.0, fg->g / 255.0, fg->b / 255.0);
732 xr_draw_chart (item, cr, width, length);
735 cairo_surface_destroy (surface);