1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2011, 2014 Free Software Foundation, Inc.
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.
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.
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/>. */
17 #ifndef OUTPUT_TABLE_ITEM_H
18 #define OUTPUT_TABLE_ITEM_H 1
22 A table item is a subclass of an output item (see output-item.h) that
23 contains a pivot table (see pivot-table.h). */
25 #include "libpspp/compiler.h"
26 #include "output/output-item.h"
31 struct output_item output_item; /* Superclass. */
32 struct pivot_table *table; /* The table to be rendered. */
35 struct table_item *table_item_create (struct pivot_table *);
37 /* This boilerplate for table_item, a subclass of output_item, was
38 autogenerated by mk-class-boilerplate. */
41 #include "libpspp/cast.h"
43 extern const struct output_item_class table_item_class;
45 /* Returns true if SUPER is a table_item, otherwise false. */
47 is_table_item (const struct output_item *super)
49 return super->class == &table_item_class;
52 /* Returns SUPER converted to table_item. SUPER must be a table_item, as
53 reported by is_table_item. */
54 static inline struct table_item *
55 to_table_item (const struct output_item *super)
57 assert (is_table_item (super));
58 return UP_CAST (super, struct table_item, output_item);
61 /* Returns INSTANCE converted to output_item. */
62 static inline struct output_item *
63 table_item_super (const struct table_item *instance)
65 return CONST_CAST (struct output_item *, &instance->output_item);
68 /* Increments INSTANCE's reference count and returns INSTANCE. */
69 static inline struct table_item *
70 table_item_ref (const struct table_item *instance)
72 return to_table_item (output_item_ref (&instance->output_item));
75 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
76 the reference count is now zero. */
78 table_item_unref (struct table_item *instance)
80 output_item_unref (&instance->output_item);
83 /* Returns true if INSTANCE's reference count is greater than 1,
86 table_item_is_shared (const struct table_item *instance)
88 return output_item_is_shared (&instance->output_item);
91 void table_item_submit (struct table_item *);
93 #endif /* output/table-item.h */