Update all #include directives to the currently preferred style.
[pspp-builds.git] / src / output / charts / piechart.h
index c09b4876e7fb910b61160eadcd60e89d05c81b45..b59a7296d14e792031a595a1c024808c25a13451 100644 (file)
@@ -1,34 +1,99 @@
-/* PSPP - draws pie charts of sample statistics
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2004, 2009, 2011 Free Software Foundation, Inc.
 
-Copyright (C) 2004 Free Software Foundation, Inc.
-Written by John Darrington <john@darrington.wattle.id.au>
+   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 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 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. */
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #ifndef PIECHART_H
 #define PIECHART_H
 
-struct slice {
-  const char *label;
-  double magnetude;
-};
+#include "libpspp/str.h"
+#include "output/chart-item.h"
+
+struct piechart
+  {
+    struct chart_item chart_item;
+    struct slice *slices;
+    int n_slices;
+  };
+
+struct slice
+  {
+    struct string label;
+    double magnitude;
+  };
+
+struct chart_item *piechart_create (const char *title,
+                                    const struct slice *, int n_slices);
+\f
+/* This boilerplate for piechart, a subclass of chart_item, was
+   autogenerated by mk-class-boilerplate. */
+
+#include <assert.h>
+#include "libpspp/cast.h"
+
+extern const struct chart_item_class piechart_class;
+
+/* Returns true if SUPER is a piechart, otherwise false. */
+static inline bool
+is_piechart (const struct chart_item *super)
+{
+  return super->class == &piechart_class;
+}
+
+/* Returns SUPER converted to piechart.  SUPER must be a piechart, as
+   reported by is_piechart. */
+static inline struct piechart *
+to_piechart (const struct chart_item *super)
+{
+  assert (is_piechart (super));
+  return UP_CAST (super, struct piechart, chart_item);
+}
+
+/* Returns INSTANCE converted to chart_item. */
+static inline struct chart_item *
+piechart_super (const struct piechart *instance)
+{
+  return CONST_CAST (struct chart_item *, &instance->chart_item);
+}
+
+/* Increments INSTANCE's reference count and returns INSTANCE. */
+static inline struct piechart *
+piechart_ref (const struct piechart *instance)
+{
+  return to_piechart (chart_item_ref (&instance->chart_item));
+}
 
-/* Draw a piechart */
-void piechart_plot(const char *title, 
-                  const struct slice *slices, int n_slices);
+/* Decrements INSTANCE's reference count, then destroys INSTANCE if
+   the reference count is now zero. */
+static inline void
+piechart_unref (struct piechart *instance)
+{
+  chart_item_unref (&instance->chart_item);
+}
 
-#endif
+/* Returns true if INSTANCE's reference count is greater than 1,
+   false otherwise. */
+static inline bool
+piechart_is_shared (const struct piechart *instance)
+{
+  return chart_item_is_shared (&instance->chart_item);
+}
 
+static inline void
+piechart_submit (struct piechart *instance)
+{
+  chart_item_submit (&instance->chart_item);
+}
+\f
+#endif /* output/charts/piechart.h */