refactor
[pspp] / src / output / chart.c
index 958695ae30a28cbc180816a2ec49689c9884dad0..6f1ce034a3a47875ccb51228513ce22de72e2199 100644 (file)
-/* PSPP - computes sample statistics.
-   Copyright (C) 2004 Free Software Foundation, Inc.
-   Written by John Darrington <john@darrington.wattle.id.au>
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2004, 2009, 2011 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 the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   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
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #include <config.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <plot.h>
-#include <stdarg.h>
-#include <string.h>
-#include <float.h>
+
 #include <assert.h>
-#include <math.h>
+#include <stdlib.h>
+
+#include "libpspp/cast.h"
+#include "libpspp/compiler.h"
+#include "libpspp/str.h"
+#include "output/chart-provider.h"
+#include "output/output-item.h"
 
-#include "chart.h"
-#include "str.h"
-#include "alloc.h"
-#include "manager.h"
-#include "output.h"
+#include "gl/xalloc.h"
 
-extern struct som_table_class tab_table_class;
+#include "gettext.h"
+#define _(msgid) gettext (msgid)
 
 struct chart *
-chart_create(void)
+chart_ref (const struct chart *chart_)
 {
-  struct chart *chart;
-  struct outp_driver *d;
-
-  d = outp_drivers (NULL);
-  if (d == NULL)
-    return NULL;
-  
-  chart = xmalloc (sizeof *chart);
-  d->class->initialise_chart(d, chart);
-  if (!chart->lp) 
-    {
-      free (chart);
-      return NULL; 
-    }
-
-  if (pl_openpl_r (chart->lp) < 0)      /* open Plotter */
-    return NULL;
-  
-  pl_fspace_r (chart->lp, 0.0, 0.0, 1000.0, 1000.0); /* set coordinate system */
-  pl_flinewidth_r (chart->lp, 0.25);    /* set line thickness */
-  pl_pencolorname_r (chart->lp, "black"); 
-
-  pl_erase_r (chart->lp);               /* erase graphics display */
-  pl_filltype_r(chart->lp,0);
-
-  pl_savestate_r(chart->lp);
-
-  /* Set default chartetry */
-  chart->data_top =   900;
-  chart->data_right = 800;
-  chart->data_bottom = 120;
-  chart->data_left = 150;
-  chart->abscissa_top = 70;
-  chart->ordinate_right = 120;
-  chart->title_bottom = 920;
-  chart->legend_left = 810;
-  chart->legend_right = 1000;
-  chart->font_size = 0;
-  strcpy(chart->fill_colour,"red");
-
-  /* Get default font size */
-  if ( !chart->font_size) 
-    chart->font_size = pl_fontsize_r(chart->lp, -1);
-
-  /* Draw the data area */
-  pl_box_r(chart->lp, 
-          chart->data_left, chart->data_bottom, 
-          chart->data_right, chart->data_top);
-
+  struct chart *chart = CONST_CAST (struct chart *, chart_);
+  assert (chart->ref_cnt > 0);
+  chart->ref_cnt++;
   return chart;
 }
 
 void
-chart_submit(struct chart *chart)
+chart_unref (struct chart *chart)
 {
-  struct som_entity s;
-  struct outp_driver *d;
+  if (chart)
+    {
+      assert (chart->ref_cnt > 0);
+      if (!--chart->ref_cnt)
+        {
+          char *title = chart->title;
+          chart->class->destroy (chart);
+          free (title);
+        }
+    }
+}
 
-  if ( ! chart ) 
-     return ;
+bool
+chart_is_shared (const struct chart *chart)
+{
+  assert (chart->ref_cnt > 0);
+  return chart->ref_cnt > 1;
+}
 
-  pl_restorestate_r(chart->lp);
+/* Initializes CHART as a chart of the specified CLASS.  The new chart
+   initially has the specified TITLE, which may be NULL if no title is yet
+   available.  The caller retains ownership of TITLE.
 
-  s.class = &tab_table_class;
-  s.ext = chart;
-  s.type = SOM_CHART;
-  som_submit (&s);
-  
-  if (pl_closepl_r (chart->lp) < 0)     /* close Plotter */
-    {
-      fprintf (stderr, "Couldn't close Plotter\n");
-    }
+   A chart is abstract, that is, a plain chart is not useful on its own.  Thus,
+   this function is normally called from the initialization function of some
+   subclass of chart. */
+void
+chart_init (struct chart *chart, const struct chart_class *class,
+            const char *title)
+{
+  *chart = (struct chart) {
+    .ref_cnt = 1,
+    .class = class,
+    .title = xstrdup_if_nonnull (title),
+  };
+}
 
-  pl_deletepl_r(chart->lp);
+/* Returns CHART's title, which is a null pointer if no title has been set. */
+const char *
+chart_get_title (const struct chart *chart)
+{
+  return chart->title;
+}
 
-  pl_deleteplparams(chart->pl_params);
+/* Sets CHART's title to TITLE, replacing any previous title.  Specify NULL for
+   TITLE to clear any title from CHART.  The caller retains ownership of
+   TITLE.
 
-  d = outp_drivers (NULL);
-  d->class->finalise_chart(d, chart);
-  free(chart);
+   This function may only be used on a chart that is unshared. */
+void
+chart_set_title (struct chart *chart, const char *title)
+{
+  assert (!chart_is_shared (chart));
+  free (chart->title);
+  chart->title = xstrdup_if_nonnull (title);
 }
 
+/* Submits CHART to the configured output drivers, and transfers ownership to
+   the output subsystem. */
+void
+chart_submit (struct chart *chart)
+{
+  if (chart)
+    output_item_submit (chart_item_create (chart));
+}