Add support for PNG images in .spv files.
[pspp] / src / output / cairo-chart.c
index 78f5fabab7249ae2fdfff448be9891f120cb40f1..11175292ec2daefde28b81411e4ffd4ce32149a2 100644 (file)
@@ -1,5 +1,6 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2004, 2009, 2010, 2011 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2009, 2010, 2011, 2014, 2015,
+   2020 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
 #include <config.h>
 
 #include "output/cairo-chart.h"
+#include "math/chart-geometry.h"
 
-#include <assert.h>
+#include <cairo/cairo-ps.h>
 #include <cairo/cairo.h>
 #include <pango/pango.h>
 #include <pango/pangocairo.h>
-#include <errno.h>
 #include <float.h>
 #include <math.h>
 #include <stdarg.h>
 #include <string.h>
 
 #include "libpspp/assertion.h"
+#include "libpspp/message.h"
 #include "math/chart-geometry.h"
-#include "output/cairo.h"
 #include "output/chart-item.h"
+#include "output/charts/barchart.h"
+#include "output/charts/boxplot.h"
+#include "output/charts/np-plot.h"
+#include "output/charts/piechart.h"
+#include "output/charts/plot-hist.h"
+#include "output/charts/roc-chart.h"
+#include "output/charts/scatterplot.h"
+#include "output/charts/scree.h"
+#include "output/charts/spreadlevel-plot.h"
+#include "output/table.h"
 
-#include "gl/error.h"
 #include "gl/xalloc.h"
 #include "gl/xvasprintf.h"
 
@@ -48,7 +58,7 @@ xrchart_geometry_init (cairo_t *cr, struct xrchart_geometry *geom,
 {
   /* Set default chart geometry. */
   geom->axis[SCALE_ORDINATE].data_max = 0.900 * length;
-  geom->axis[SCALE_ORDINATE].data_min = 0.120 * length;
+  geom->axis[SCALE_ORDINATE].data_min = 0.200 * length;
 
   geom->axis[SCALE_ABSCISSA].data_min = 0.150 * width;
   geom->axis[SCALE_ABSCISSA].data_max = 0.800 * width;
@@ -62,9 +72,7 @@ xrchart_geometry_init (cairo_t *cr, struct xrchart_geometry *geom,
   geom->dataset = NULL;
   geom->n_datasets = 0;
 
-  geom->fill_colour.red = 255;
-  geom->fill_colour.green = 0;
-  geom->fill_colour.blue = 0;
+  geom->fill_colour = data_colour[0];
 
   cairo_set_line_width (cr, 1.0);
 
@@ -102,19 +110,42 @@ pango_layout_get_baseline (PangoLayout    *layout)
 }
 #endif
 
-
-
+/*
+    These colours come from:
+    http://tango.freedesktop.org/static/cvs/tango-art-tools/palettes/Tango-Palette.gpl */
 const struct xrchart_colour data_colour[XRCHART_N_COLOURS] =
   {
-    { 165, 42, 42 },            /* brown */
-    { 255, 0, 0 },              /* red */
-    { 255, 165, 0 },            /* orange */
-    { 255, 255, 0 },            /* yellow */
-    { 0, 255, 0 },              /* green */
-    { 0, 0, 255 },              /* blue */
-    { 238, 130, 238 },          /* violet */
-    { 190, 190, 190 },          /* grey */
-    { 255, 192, 203 },          /* pink */
+    {252, 233,  79},   /* Butter 1 */
+    {138, 226,  52},   /* Chameleon 1 */
+    {252, 175,  62},   /* Orange 1 */
+    {114, 159, 207},   /* Sky Blue 1 */
+    {173, 127, 168},   /* Plum 1 */
+    {233, 185, 110},   /* Chocolate 1 */
+    {239,  41,  41},   /* Scarlet Red 1 */
+    {238, 238, 236},   /* Aluminium 1 */
+
+    {237, 212,   0},   /* Butter 2 */
+    {115, 210,  22},   /* Chameleon 2 */
+    {245, 121,   0},   /* Orange 2 */
+    {52,  101, 164},   /* Sky Blue 2 */
+    {117,  80, 123},   /* Plum 2 */
+    {193, 125,  17},   /* Chocolate 2 */
+    {204,   0,   0},   /* Scarlet Red 2 */
+
+    {136, 138, 133},   /* Aluminium 4 */
+
+    {196, 160,   0},   /* Butter 3 */
+    {78,  154,   6},   /* Chameleon 3 */
+    {206,  92,   0},   /* Orange 3 */
+    {32,   74, 135},   /* Sky Blue 3 */
+    {92,   53, 102},   /* Plum 3 */
+    {143,  89,   2},   /* Chocolate 3 */
+    {164,   0,   0},   /* Scarlet Red 3 */
+    {85,   87,  83},   /* Aluminium 5 */
+
+    {211, 215, 207},   /* Aluminium 2 */
+    {186, 189, 182},   /* Aluminium 3 */
+    {46,   52,  54},   /* Aluminium 6 */
   };
 
 void
@@ -158,7 +189,7 @@ xrchart_label_rotate (cairo_t *cr, int horz_justify, int vert_justify,
   PangoLayout *layout;
   double x, y;
 
-  desc = pango_font_description_from_string ("sans serif");
+  desc = pango_font_description_from_string ("Sans");
   if (desc == NULL)
     {
       cairo_new_path (cr);
@@ -175,7 +206,7 @@ xrchart_label_rotate (cairo_t *cr, int horz_justify, int vert_justify,
 
   layout = pango_cairo_create_layout (cr);
   pango_layout_set_font_description (layout, desc);
-  pango_layout_set_text (layout, string, -1);
+  pango_layout_set_markup (layout, string, -1);
   if (horz_justify != 'l')
     {
       int width_pango;
@@ -289,15 +320,13 @@ draw_tick_internal (cairo_t *cr, const struct xrchart_geometry *geom,
 
       if (orientation == SCALE_ABSCISSA)
        {
-         if ( rotated) 
+         if (rotated)
            xrchart_label_rotate (cr, 'l', 'c', geom->font_size, s, -G_PI_4);
          else
            xrchart_label (cr, 'c', 't', geom->font_size, s);
        }
       else if (orientation == SCALE_ORDINATE)
         {
-          if (fabs (position) < DBL_EPSILON)
-           cairo_rel_move_to (cr, 0, 10);
           xrchart_label (cr, 'r', 'c', geom->font_size, s);
         }
     }
@@ -324,48 +353,103 @@ xrchart_write_title (cairo_t *cr, const struct xrchart_geometry *geom,
   cairo_restore (cr);
 }
 
+static void
+xrchart_text_extents (cairo_t *cr, const struct xrchart_geometry *geom,
+                     const char *utf8,
+                     double *width, double *height)
+{
+  PangoFontDescription *desc;
+  PangoLayout *layout;
+  int width_pango;
+  int height_pango;
 
+  desc = pango_font_description_from_string ("Sans");
+  if (desc == NULL)
+      return;
+  pango_font_description_set_absolute_size (desc, geom->font_size * PANGO_SCALE);
+  layout = pango_cairo_create_layout (cr);
+  pango_layout_set_font_description (layout, desc);
+  pango_layout_set_markup (layout, utf8, -1);
+  pango_layout_get_size (layout, &width_pango, &height_pango);
+  *width = (double) width_pango / PANGO_SCALE;
+  *height = (double) height_pango / PANGO_SCALE;
+  g_object_unref (layout);
+  pango_font_description_free (desc);
+}
 
-static void
+static bool
 xrchart_write_scale (cairo_t *cr, struct xrchart_geometry *geom,
-                    double smin, double smax, int ticks, enum tick_orientation orient)
+                    double smin, double smax, enum tick_orientation orient)
 {
   int s;
+  int ticks;
+
+  double interval;
+  double lower;
+  double upper;
+  double tickscale;
+  char *tick_format_string;
+  bool tickoversize = false;
 
-  const double tick_interval =
-    chart_rounded_tick ((smax - smin) / (double) ticks);
+  if (smax == smin)
+    return false;
 
-  int upper = ceil (smax / tick_interval);
-  int lower = floor (smin / tick_interval);
+  chart_get_scale (smax, smin, &lower, &interval, &ticks);
 
-  geom->axis[orient].max = tick_interval * upper;
-  geom->axis[orient].min = tick_interval * lower;
+  tick_format_string = chart_get_ticks_format (lower, interval, ticks, &tickscale);
 
-  geom->axis[orient].scale = (fabs (geom->axis[orient].data_max - geom->axis[orient].data_min)
-     / fabs (geom->axis[orient].max - geom->axis[orient].min));
+  upper = lower + interval * (ticks+1);
 
-  for (s = 0 ; s < upper - lower; ++s)
+  geom->axis[orient].max = upper;
+  geom->axis[orient].min = lower;
+
+  struct xrchart_axis *axis = &geom->axis[orient];
+  geom->axis[orient].scale = (fabs ((double) axis->data_max - axis->data_min)
+                             / fabs (axis->max - axis->min));
+
+  if (orient == SCALE_ABSCISSA)
+    {
+      char *test_text;
+      double lower_txt_width, upper_txt_width, unused, width;
+      test_text = xasprintf(tick_format_string, upper*tickscale);
+      xrchart_text_extents (cr, geom, test_text, &upper_txt_width, &unused);
+      free(test_text);
+      test_text = xasprintf(tick_format_string, lower*tickscale);
+      xrchart_text_extents (cr, geom, test_text, &lower_txt_width, &unused);
+      free(test_text);
+      width = MAX(lower_txt_width, upper_txt_width);
+      tickoversize = width > 0.9 *
+       ((double)(geom->axis[SCALE_ABSCISSA].data_max - geom->axis[SCALE_ABSCISSA].data_min))/(ticks+1);
+    }
+
+  double pos = lower;
+
+  for (s = 0 ; s <= ticks; ++s)
     {
-      double pos = (s + lower) * tick_interval;
-      draw_tick (cr, geom, orient, false,
-                s * tick_interval * geom->axis[orient].scale, "%g", pos);
+      draw_tick (cr, geom, orient, tickoversize,
+                s * interval * geom->axis[orient].scale,
+                tick_format_string, pos*tickscale);
+      pos += interval;
     }
+  free(tick_format_string);
+
+  return true;
 }
 
 /* Set the scale for the ordinate */
-void
+bool
 xrchart_write_yscale (cairo_t *cr, struct xrchart_geometry *geom,
-                    double smin, double smax, int ticks)
+                    double smin, double smax)
 {
-  xrchart_write_scale (cr, geom, smin, smax, ticks, SCALE_ORDINATE);
+  return xrchart_write_scale (cr, geom, smin, smax, SCALE_ORDINATE);
 }
 
 /* Set the scale for the abscissa */
-void
+bool
 xrchart_write_xscale (cairo_t *cr, struct xrchart_geometry *geom,
-                    double smin, double smax, int ticks)
+                     double smin, double smax)
 {
-  xrchart_write_scale (cr, geom, smin, smax, ticks, SCALE_ABSCISSA);
+  return xrchart_write_scale (cr, geom, smin, smax, SCALE_ABSCISSA);
 }
 
 
@@ -402,7 +486,7 @@ xrchart_write_legend (cairo_t *cr, const struct xrchart_geometry *geom)
   const int swatch = 20;
   const int legend_top = geom->axis[SCALE_ORDINATE].data_max;
   const int legend_bottom = legend_top -
-    (vstep * geom->n_datasets + 2 * ypad );
+    (vstep * geom->n_datasets + 2 * ypad);
 
   cairo_save (cr);
 
@@ -411,7 +495,7 @@ xrchart_write_legend (cairo_t *cr, const struct xrchart_geometry *geom)
                    legend_bottom - legend_top);
   cairo_stroke (cr);
 
-  for (i = 0 ; i < geom->n_datasets ; ++i )
+  for (i = 0 ; i < geom->n_datasets ; ++i)
     {
       const int ypos = legend_top - vstep * (i + 1);
       const int xpos = geom->legend_left + xpad;
@@ -466,7 +550,7 @@ xrchart_datum (cairo_t *cr, const struct xrchart_geometry *geom,
   double x_pos = (x - geom->axis[SCALE_ABSCISSA].min) * geom->axis[SCALE_ABSCISSA].scale + geom->axis[SCALE_ABSCISSA].data_min;
   double y_pos = (y - geom->axis[SCALE_ORDINATE].min) * geom->axis[SCALE_ORDINATE].scale + geom->axis[SCALE_ORDINATE].data_min;
 
-  xrchart_draw_marker (cr, x_pos, y_pos, XRMARKER_SQUARE, 15);
+  xrchart_draw_marker (cr, x_pos, y_pos, XRMARKER_CIRCLE, 10);
 }
 
 void
@@ -511,10 +595,10 @@ xrchart_line(cairo_t *cr, const struct xrchart_geometry *geom,
   double x1, y1;
   double x2, y2;
 
-  if ( lim_dim == XRCHART_DIM_Y )
+  if (lim_dim == XRCHART_DIM_Y)
     {
-      x1 = ( limit1 - intercept ) / slope;
-      x2 = ( limit2 - intercept ) / slope;
+      x1 = (limit1 - intercept) / slope;
+      x2 = (limit2 - intercept) / slope;
       y1 = limit1;
       y2 = limit2;
     }
@@ -535,3 +619,133 @@ xrchart_line(cairo_t *cr, const struct xrchart_geometry *geom,
   cairo_line_to (cr, x2, y2);
   cairo_stroke (cr);
 }
+\f
+void
+xr_draw_chart (const struct chart_item *chart_item, cairo_t *cr,
+               double width, double height)
+{
+  struct xrchart_geometry geom;
+
+  cairo_save (cr);
+  cairo_translate (cr, 0, height);
+  cairo_scale (cr, 1.0, -1.0);
+  xrchart_geometry_init (cr, &geom, width, height);
+  if (is_boxplot (chart_item))
+    xrchart_draw_boxplot (chart_item, cr, &geom);
+  else if (is_histogram_chart (chart_item))
+    xrchart_draw_histogram (chart_item, cr, &geom);
+  else if (is_np_plot_chart (chart_item))
+    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);
+
+  cairo_restore (cr);
+}
+
+cairo_surface_t *
+xr_draw_image_chart (const struct chart_item *item,
+                     const struct cell_color *fg,
+                     const struct cell_color *bg)
+{
+  const int width = 640;
+  const int length = 480;
+
+  cairo_surface_t *surface = cairo_image_surface_create (
+    CAIRO_FORMAT_RGB24, width, length);
+  cairo_t *cr = cairo_create (surface);
+
+  cairo_set_source_rgb (cr, bg->r / 255.0, bg->g / 255.0, bg->b / 255.0);
+  cairo_paint (cr);
+
+  cairo_set_source_rgb (cr, fg->r / 255.0, fg->g / 255.0, fg->b / 255.0);
+  xr_draw_chart (item, cr, width, length);
+
+  cairo_destroy (cr);
+
+  return surface;
+}
+
+char *
+xr_write_png_image (cairo_surface_t *surface,
+                    const char *file_name_template, int number)
+{
+  const char *number_pos = strchr (file_name_template, '#');
+  char *file_name;
+  if (number_pos != NULL)
+    file_name = xasprintf ("%.*s%d%s.png",
+                           (int) (number_pos - file_name_template),
+                           file_name_template, number, number_pos + 1);
+  else
+    file_name = xasprintf ("%s.png", file_name_template);
+
+  cairo_status_t status = cairo_surface_write_to_png (surface, file_name);
+  if (status != CAIRO_STATUS_SUCCESS)
+    msg (ME, _("error writing output file `%s': %s"),
+           file_name, cairo_status_to_string (status));
+
+  return file_name;
+}
+
+char *
+xr_draw_png_chart (const struct chart_item *item,
+                   const char *file_name_template, int number,
+                  const struct cell_color *fg,
+                  const struct cell_color *bg)
+{
+  cairo_surface_t *surface = xr_draw_image_chart (item, fg, bg);
+  char *file_name = xr_write_png_image (surface, file_name_template, number);
+  cairo_surface_destroy (surface);
+  return file_name;
+}
+
+char *
+xr_draw_eps_chart (const struct chart_item *item,
+                   const char *file_name_template, int number,
+                  const struct cell_color *fg,
+                  const struct cell_color *bg)
+{
+  const int width = 640;
+  const int length = 480;
+
+  cairo_surface_t *surface;
+  const char *number_pos;
+  char *file_name;
+  cairo_t *cr;
+
+  number_pos = strchr (file_name_template, '#');
+  if (number_pos != NULL)
+    file_name = xasprintf ("%.*s%d%s.eps", (int) (number_pos - file_name_template),
+                           file_name_template, number, number_pos + 1);
+  else
+    file_name = xasprintf ("%s.eps", file_name_template);
+
+  surface = cairo_ps_surface_create (file_name, width, length);
+  cairo_ps_surface_set_eps (surface, true);
+  cr = cairo_create (surface);
+
+  cairo_set_source_rgb (cr, bg->r / 255.0, bg->g / 255.0, bg->b / 255.0);
+  cairo_paint (cr);
+
+  cairo_set_source_rgb (cr, fg->r / 255.0, fg->g / 255.0, fg->b / 255.0);
+
+  xr_draw_chart (item, cr, width, length);
+
+  cairo_destroy (cr);
+  cairo_surface_destroy (surface);
+
+  return file_name;
+}
+