src/output/cairo-chart.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2004, 2009, 2010, 2011 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>. */
  16
  17 #include <config.h>
  18
  19 #include "output/cairo-chart.h"
  20
  21 #include <assert.h>
  22 #include <cairo/cairo.h>
  23 #include <pango/pango.h>
  24 #include <pango/pangocairo.h>
  25 #include <errno.h>
  26 #include <float.h>
  27 #include <math.h>
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #include "libpspp/assertion.h"
  34 #include "math/chart-geometry.h"
  35 #include "output/cairo.h"
  36 #include "output/chart-item.h"
  37
  38 #include "gl/error.h"
  39 #include "gl/xalloc.h"
  40 #include "gl/xvasprintf.h"
  41
  42 #include "gettext.h"
  43 #define _(msgid) gettext (msgid)
  44
  45 void
  46 xrchart_geometry_init (cairo_t *cr, struct xrchart_geometry *geom,
  47                        double width, double length)
  48 {
  49   /* Set default chartetry. */
  50   geom->data_top = 0.900 * length;
  51   geom->data_right = 0.800 * width;
  52   geom->data_bottom = 0.120 * length;
  53   geom->data_left = 0.150 * width;
  54   geom->abscissa_top = 0.070 * length;
  55   geom->ordinate_right = 0.120 * width;
  56   geom->title_bottom = 0.920 * length;
  57   geom->legend_left = 0.810 * width;
  58   geom->legend_right = width;
  59   geom->font_size = 15.0;
  60   geom->in_path = false;
  61   geom->dataset = NULL;
  62   geom->n_datasets = 0;
  63
  64   geom->fill_colour.red = 255;
  65   geom->fill_colour.green = 0;
  66   geom->fill_colour.blue = 0;
  67
  68   cairo_set_line_width (cr, 1.0);
  69
  70   cairo_rectangle (cr, geom->data_left, geom->data_bottom,
  71                    geom->data_right - geom->data_left,
  72                    geom->data_top - geom->data_bottom);
  73   cairo_stroke (cr);
  74 }
  75
  76 void
  77 xrchart_geometry_free (cairo_t *cr UNUSED, struct xrchart_geometry *geom)
  78 {
  79   int i;
  80
  81   for (i = 0 ; i < geom->n_datasets; ++i)
  82     free (geom->dataset[i]);
  83   free (geom->dataset);
  84 }
  85
  86 #if ! PANGO_VERSION_CHECK (1, 22, 0)
  87 int pango_layout_get_baseline (PangoLayout    *layout);
  88
  89 /* Shamelessly copied from the pango source */
  90 int
  91 pango_layout_get_baseline (PangoLayout    *layout)
  92 {
  93   int baseline;
  94
  95   /* XXX this is so inefficient */
  96   PangoLayoutIter *iter = pango_layout_get_iter (layout);
  97   baseline = pango_layout_iter_get_baseline (iter);
  98   pango_layout_iter_free (iter);
  99
 100   return baseline;
 101 }
 102 #endif
 103
 104
 105
 106 const struct xrchart_colour data_colour[XRCHART_N_COLOURS] =
 107   {
 108     { 165, 42, 42 },            /* brown */
 109     { 255, 0, 0 },              /* red */
 110     { 255, 165, 0 },            /* orange */
 111     { 255, 255, 0 },            /* yellow */
 112     { 0, 255, 0 },              /* green */
 113     { 0, 0, 255 },              /* blue */
 114     { 238, 130, 238 },          /* violet */
 115     { 190, 190, 190 },          /* grey */
 116     { 255, 192, 203 },          /* pink */
 117   };
 118
 119 void
 120 xrchart_draw_marker (cairo_t *cr, double x, double y,
 121                      enum xrmarker_type marker, double size)
 122 {
 123   cairo_save (cr);
 124   cairo_translate (cr, x, y);
 125   cairo_scale (cr, size / 2.0, size / 2.0);
 126   cairo_set_line_width (cr, cairo_get_line_width (cr) / (size / 2.0));
 127   switch (marker)
 128     {
 129     case XRMARKER_CIRCLE:
 130       cairo_arc (cr, 0, 0, 1.0, 0, 2 * M_PI);
 131       cairo_stroke (cr);
 132       break;
 133
 134     case XRMARKER_ASTERISK:
 135       cairo_move_to (cr, 0, -1.0); /* | */
 136       cairo_line_to (cr, 0, 1.0);
 137       cairo_move_to (cr, -M_SQRT1_2, -M_SQRT1_2); /* / */
 138       cairo_line_to (cr, M_SQRT1_2, M_SQRT1_2);
 139       cairo_move_to (cr, -M_SQRT1_2, M_SQRT1_2); /* \ */
 140       cairo_line_to (cr, M_SQRT1_2, -M_SQRT1_2);
 141       cairo_stroke (cr);
 142       break;
 143
 144     case XRMARKER_SQUARE:
 145       cairo_rectangle (cr, -1.0, -1.0, 2.0, 2.0);
 146       cairo_stroke (cr);
 147       break;
 148     }
 149   cairo_restore (cr);
 150 }
 151
 152 void
 153 xrchart_label (cairo_t *cr, int horz_justify, int vert_justify,
 154                double font_size, const char *string)
 155 {
 156   PangoFontDescription *desc;
 157   PangoLayout *layout;
 158   double x, y;
 159
 160   desc = pango_font_description_from_string ("sans serif");
 161   if (desc == NULL)
 162     {
 163       cairo_new_path (cr);
 164       return;
 165     }
 166   pango_font_description_set_absolute_size (desc, font_size * PANGO_SCALE);
 167
 168   cairo_save (cr);
 169   cairo_get_current_point (cr, &x, &y);
 170   cairo_translate (cr, x, y);
 171   cairo_move_to (cr, 0, 0);
 172   cairo_scale (cr, 1.0, -1.0);
 173
 174   layout = pango_cairo_create_layout (cr);
 175   pango_layout_set_font_description (layout, desc);
 176   pango_layout_set_text (layout, string, -1);
 177   if (horz_justify != 'l')
 178     {
 179       int width_pango;
 180       double width;
 181
 182       pango_layout_get_size (layout, &width_pango, NULL);
 183       width = (double) width_pango / PANGO_SCALE;
 184       if (horz_justify == 'r')
 185         cairo_rel_move_to (cr, -width, 0);
 186       else
 187         cairo_rel_move_to (cr, -width / 2.0, 0);
 188     }
 189   if (vert_justify == 'x')
 190     {
 191       int baseline_pango = pango_layout_get_baseline (layout);
 192       double baseline = (double) baseline_pango / PANGO_SCALE;
 193       cairo_rel_move_to (cr, 0, -baseline);
 194     }
 195   else if (vert_justify != 't')
 196     {
 197       int height_pango;
 198       double height;
 199
 200       pango_layout_get_size (layout, NULL, &height_pango);
 201       height = (double) height_pango / PANGO_SCALE;
 202       if (vert_justify == 'b')
 203         cairo_rel_move_to (cr, 0, -height);
 204       else if (vert_justify == 'c')
 205         cairo_rel_move_to (cr, 0, -height / 2.0);
 206     }
 207   pango_cairo_show_layout (cr, layout);
 208   g_object_unref (layout);
 209
 210   cairo_restore (cr);
 211
 212   cairo_new_path (cr);
 213
 214   pango_font_description_free (desc);
 215 }
 216
 217 /* Draw a tick mark at position
 218    If label is non zero, then print it at the tick mark
 219 */
 220 void
 221 draw_tick (cairo_t *cr, const struct xrchart_geometry *geom,
 222            enum tick_orientation orientation,
 223            double position,
 224            const char *label, ...)
 225 {
 226   const int tickSize = 10;
 227   double x, y;
 228
 229   cairo_move_to (cr, geom->data_left, geom->data_bottom);
 230
 231   if (orientation == TICK_ABSCISSA)
 232     {
 233       cairo_rel_move_to (cr, position, 0);
 234       cairo_rel_line_to (cr, 0, -tickSize);
 235     }
 236   else if (orientation == TICK_ORDINATE)
 237     {
 238       cairo_rel_move_to (cr, 0, position);
 239       cairo_rel_line_to (cr, -tickSize, 0);
 240     }
 241   else
 242     NOT_REACHED ();
 243   cairo_get_current_point (cr, &x, &y);
 244
 245   cairo_stroke (cr);
 246
 247   if (label != NULL)
 248     {
 249       va_list ap;
 250       char *s;
 251
 252       cairo_move_to (cr, x, y);
 253
 254       va_start (ap, label);
 255       s = xvasprintf (label, ap);
 256       if (orientation == TICK_ABSCISSA)
 257         xrchart_label (cr, 'c', 't', geom->font_size, s);
 258       else if (orientation == TICK_ORDINATE)
 259         {
 260           if (fabs (position) < DBL_EPSILON)
 261             cairo_rel_move_to (cr, 0, 10);
 262           xrchart_label (cr, 'r', 'c', geom->font_size, s);
 263         }
 264       free (s);
 265       va_end (ap);
 266     }
 267 }
 268
 269
 270 /* Write the title on a chart*/
 271 void
 272 xrchart_write_title (cairo_t *cr, const struct xrchart_geometry *geom,
 273                    const char *title, ...)
 274 {
 275   va_list ap;
 276   char *s;
 277
 278   cairo_save (cr);
 279   cairo_move_to (cr, geom->data_left, geom->title_bottom);
 280
 281   va_start(ap, title);
 282   s = xvasprintf (title, ap);
 283   xrchart_label (cr, 'l', 'x', geom->font_size * 1.5, s);
 284   free (s);
 285   va_end (ap);
 286
 287   cairo_restore (cr);
 288 }
 289
 290
 291 /* Set the scale for the abscissa */
 292 void
 293 xrchart_write_xscale (cairo_t *cr, struct xrchart_geometry *geom,
 294                     double min, double max, int ticks)
 295 {
 296   double x;
 297
 298   const double tick_interval =
 299     chart_rounded_tick ((max - min) / (double) ticks);
 300
 301   geom->x_max = ceil (max / tick_interval) * tick_interval;
 302   geom->x_min = floor (min / tick_interval) * tick_interval;
 303   geom->abscissa_scale = fabs(geom->data_right - geom->data_left) /
 304     fabs(geom->x_max - geom->x_min);
 305
 306   for (x = geom->x_min; x <= geom->x_max; x += tick_interval)
 307     draw_tick (cr, geom, TICK_ABSCISSA,
 308                (x - geom->x_min) * geom->abscissa_scale, "%g", x);
 309 }
 310
 311
 312 /* Set the scale for the ordinate */
 313 void
 314 xrchart_write_yscale (cairo_t *cr, struct xrchart_geometry *geom,
 315                     double smin, double smax, int ticks)
 316 {
 317   double y;
 318
 319   const double tick_interval =
 320     chart_rounded_tick ((smax - smin) / (double) ticks);
 321
 322   geom->y_max = ceil (smax / tick_interval) * tick_interval;
 323   geom->y_min = floor (smin / tick_interval) * tick_interval;
 324
 325   geom->ordinate_scale =
 326     (fabs (geom->data_top - geom->data_bottom)
 327      / fabs (geom->y_max - geom->y_min));
 328
 329   for (y = geom->y_min; y <= geom->y_max; y += tick_interval)
 330     draw_tick (cr, geom, TICK_ORDINATE,
 331                (y - geom->y_min) * geom->ordinate_scale, "%g", y);
 332 }
 333
 334 /* Write the abscissa label */
 335 void
 336 xrchart_write_xlabel (cairo_t *cr, const struct xrchart_geometry *geom,
 337                     const char *label)
 338 {
 339   cairo_move_to (cr, geom->data_left, geom->abscissa_top);
 340   xrchart_label (cr, 'l', 't', geom->font_size, label);
 341 }
 342
 343 /* Write the ordinate label */
 344 void
 345 xrchart_write_ylabel (cairo_t *cr, const struct xrchart_geometry *geom,
 346                     const char *label)
 347 {
 348   cairo_save (cr);
 349   cairo_translate (cr, -geom->data_bottom, -geom->ordinate_right);
 350   cairo_move_to (cr, 0, 0);
 351   cairo_rotate (cr, M_PI / 2.0);
 352   xrchart_label (cr, 'l', 'x', geom->font_size, label);
 353   cairo_restore (cr);
 354 }
 355
 356
 357 void
 358 xrchart_write_legend (cairo_t *cr, const struct xrchart_geometry *geom)
 359 {
 360   int i;
 361   const int vstep = geom->font_size * 2;
 362   const int xpad = 10;
 363   const int ypad = 10;
 364   const int swatch = 20;
 365   const int legend_top = geom->data_top;
 366   const int legend_bottom = legend_top -
 367     (vstep * geom->n_datasets + 2 * ypad );
 368
 369   cairo_save (cr);
 370
 371   cairo_rectangle (cr, geom->legend_left, legend_top,
 372                    geom->legend_right - xpad - geom->legend_left,
 373                    legend_bottom - legend_top);
 374   cairo_stroke (cr);
 375
 376   for (i = 0 ; i < geom->n_datasets ; ++i )
 377     {
 378       const int ypos = legend_top - vstep * (i + 1);
 379       const int xpos = geom->legend_left + xpad;
 380       const struct xrchart_colour *colour;
 381
 382       cairo_move_to (cr, xpos, ypos);
 383
 384       cairo_save (cr);
 385       colour = &data_colour [ i % XRCHART_N_COLOURS];
 386       cairo_set_source_rgb (cr,
 387                             colour->red / 255.0,
 388                             colour->green / 255.0,
 389                             colour->blue / 255.0);
 390       cairo_rectangle (cr, xpos, ypos, swatch, swatch);
 391       cairo_fill_preserve (cr);
 392       cairo_stroke (cr);
 393       cairo_restore (cr);
 394
 395       cairo_move_to (cr, xpos + swatch * 1.5, ypos);
 396       xrchart_label (cr, 'l', 'x', geom->font_size, geom->dataset[i]);
 397     }
 398
 399   cairo_restore (cr);
 400 }
 401
 402 /* Start a new vector called NAME */
 403 void
 404 xrchart_vector_start (cairo_t *cr, struct xrchart_geometry *geom, const char *name)
 405 {
 406   const struct xrchart_colour *colour;
 407
 408   cairo_save (cr);
 409
 410   colour = &data_colour[geom->n_datasets % XRCHART_N_COLOURS];
 411   cairo_set_source_rgb (cr,
 412                         colour->red / 255.0,
 413                         colour->green / 255.0,
 414                         colour->blue / 255.0);
 415
 416   geom->n_datasets++;
 417   geom->dataset = xrealloc (geom->dataset,
 418                             geom->n_datasets * sizeof (*geom->dataset));
 419
 420   geom->dataset[geom->n_datasets - 1] = strdup (name);
 421 }
 422
 423 /* Plot a data point */
 424 void
 425 xrchart_datum (cairo_t *cr, const struct xrchart_geometry *geom,
 426              int dataset UNUSED, double x, double y)
 427 {
 428   double x_pos = (x - geom->x_min) * geom->abscissa_scale + geom->data_left;
 429   double y_pos = (y - geom->y_min) * geom->ordinate_scale + geom->data_bottom;
 430
 431   xrchart_draw_marker (cr, x_pos, y_pos, XRMARKER_SQUARE, 15);
 432 }
 433
 434 void
 435 xrchart_vector_end (cairo_t *cr, struct xrchart_geometry *geom)
 436 {
 437   cairo_stroke (cr);
 438   cairo_restore (cr);
 439   geom->in_path = false;
 440 }
 441
 442 /* Plot a data point */
 443 void
 444 xrchart_vector (cairo_t *cr, struct xrchart_geometry *geom, double x, double y)
 445 {
 446   const double x_pos =
 447     (x - geom->x_min) * geom->abscissa_scale + geom->data_left ;
 448
 449   const double y_pos =
 450     (y - geom->y_min) * geom->ordinate_scale + geom->data_bottom ;
 451
 452   if (geom->in_path)
 453     cairo_line_to (cr, x_pos, y_pos);
 454   else
 455     {
 456       cairo_move_to (cr, x_pos, y_pos);
 457       geom->in_path = true;
 458     }
 459 }
 460
 461
 462
 463 /* Draw a line with slope SLOPE and intercept INTERCEPT.
 464    between the points limit1 and limit2.
 465    If lim_dim is XRCHART_DIM_Y then the limit{1,2} are on the
 466    y axis otherwise the x axis
 467 */
 468 void
 469 xrchart_line(cairo_t *cr, const struct xrchart_geometry *geom,
 470            double slope, double intercept,
 471            double limit1, double limit2, enum xrchart_dim lim_dim)
 472 {
 473   double x1, y1;
 474   double x2, y2;
 475
 476   if ( lim_dim == XRCHART_DIM_Y )
 477     {
 478       x1 = ( limit1 - intercept ) / slope;
 479       x2 = ( limit2 - intercept ) / slope;
 480       y1 = limit1;
 481       y2 = limit2;
 482     }
 483   else
 484     {
 485       x1 = limit1;
 486       x2 = limit2;
 487       y1 = slope * x1 + intercept;
 488       y2 = slope * x2 + intercept;
 489     }
 490
 491   y1 = (y1 - geom->y_min) * geom->ordinate_scale + geom->data_bottom;
 492   y2 = (y2 - geom->y_min) * geom->ordinate_scale + geom->data_bottom;
 493   x1 = (x1 - geom->x_min) * geom->abscissa_scale + geom->data_left;
 494   x2 = (x2 - geom->x_min) * geom->abscissa_scale + geom->data_left;
 495
 496   cairo_move_to (cr, x1, y1);
 497   cairo_line_to (cr, x2, y2);
 498   cairo_stroke (cr);
 499 }