Fix memory leak in barcharts
[pspp] / src / output / charts / barchart.h
index 4a6e3b725c62334a6a06d314d91271ff94a63fcf..d47ce165bb24d641f67ced9f2dcf9ea0e260f903 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) 2015 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/>. */
 
 #ifndef BARCHART_H
 #define BARCHART_H
 
-#include <output/chart.h>
+#include "libpspp/str.h"
+#include "libpspp/hmap.h"
+#include "data/value.h"
+#include "output/chart-item.h"
 
-enum  bar_opts {
-  BAR_GROUPED =  0,
-  BAR_STACKED,
-  BAR_RANGE
+
+struct category
+{
+  struct hmap_node node;
+  int idx;                     /* Unique zero based index */
+  struct string label;         /* The label to be displayed for this category */
+  union value val;             /* The value of this category */
+  int width;                   /* The width of VAL */
 };
 
-void draw_barchart(struct chart *ch, const char *title, 
-             const char *xlabel, const char *ylabel, enum bar_opts opt);
 
-#endif
+struct barchart
+  {
+    struct chart_item chart_item;
+
+    /* The categories */
+    struct freq **cats;
+
+    /* The total number of categories (regardless of level) */
+    int n_nzcats;
+
+    /* The number of primary categories */
+    int n_pcats;
+
+    /* The largest count of all the categories */
+    double largest;
+
+    /* The label for the ordinate (vertical axis) */
+    char *ylabel;
+
+    /* The variables holding the categorical values */
+    const struct variable **var;
+    int n_vars;
+
+    int widths[2];
+
+    /* A hash table of struct category indexed by VAL */
+    struct hmap primaries;
+
+    /* A hash table of struct category indexed by VAL */
+    struct hmap secondaries;
+
+
+    /* A array of pointers to the members of the above hmap, 
+       sorted by VAL */
+    struct category **ss;
+  };
+
+
+struct variable;
+struct freq;
+
+struct chart_item *barchart_create (const struct variable **, int n_vars,
+                                   const char *ylabel,
+                                    struct freq *const *, int n_cats);
+\f
+/* This boilerplate for barchart, a subclass of chart_item, was
+   autogenerated by mk-class-boilerplate. */
+
+#include <assert.h>
+#include "libpspp/cast.h"
+
+extern const struct chart_item_class barchart_class;
+
+/* Returns true if SUPER is a barchart, otherwise false. */
+static inline bool
+is_barchart (const struct chart_item *super)
+{
+  return super->class == &barchart_class;
+}
+
+/* Returns SUPER converted to barchart.  SUPER must be a barchart, as
+   reported by is_barchart. */
+static inline struct barchart *
+to_barchart (const struct chart_item *super)
+{
+  assert (is_barchart (super));
+  return UP_CAST (super, struct barchart, chart_item);
+}
+
+/* Returns INSTANCE converted to chart_item. */
+static inline struct chart_item *
+barchart_super (const struct barchart *instance)
+{
+  return CONST_CAST (struct chart_item *, &instance->chart_item);
+}
+
+/* Increments INSTANCE's reference count and returns INSTANCE. */
+static inline struct barchart *
+barchart_ref (const struct barchart *instance)
+{
+  return to_barchart (chart_item_ref (&instance->chart_item));
+}
+
+/* Decrements INSTANCE's reference count, then destroys INSTANCE if
+   the reference count is now zero. */
+static inline void
+barchart_unref (struct barchart *instance)
+{
+  chart_item_unref (&instance->chart_item);
+}
+
+/* Returns true if INSTANCE's reference count is greater than 1,
+   false otherwise. */
+static inline bool
+barchart_is_shared (const struct barchart *instance)
+{
+  return chart_item_is_shared (&instance->chart_item);
+}
+
+static inline void
+barchart_submit (struct barchart *instance)
+{
+  chart_item_submit (&instance->chart_item);
+}
+\f
+#endif /* output/charts/barchart.h */