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 table (see table.h) and some formatting properties. Currently
24 the formatting properties are an optional title (a brief description
25 typically displayed above the table) and an optional caption (a more verbose
26 description typically displayed below the table). */
28 #include "libpspp/compiler.h"
29 #include "output/output-item.h"
30 #include "output/table.h"
32 /* Title or caption in a table item. */
33 struct table_item_text
36 const struct footnote **footnotes;
38 struct table_area_style *style;
41 struct table_item_text *table_item_text_create (const char *);
42 struct table_item_text *table_item_text_clone (const struct table_item_text *);
43 void table_item_text_destroy (struct table_item_text *);
45 struct table_item_layer
48 const struct footnote **footnotes;
52 void table_item_layer_copy (struct table_item_layer *,
53 const struct table_item_layer *);
54 void table_item_layer_uninit (struct table_item_layer *);
56 struct table_item_layers
58 struct table_item_layer *layers;
60 struct table_area_style *style;
63 struct table_item_layers *table_item_layers_clone (
64 const struct table_item_layers *);
65 void table_item_layers_destroy (struct table_item_layers *);
69 The members of struct table_item should not be accessed directly. Use one
70 of the accessor functions defined below. */
73 struct output_item output_item; /* Superclass. */
74 struct table *table; /* The table to be rendered. */
75 struct table_item_text *title; /* Null if there is no title. */
76 struct table_item_text *caption; /* Null if there is no caption. */
77 struct table_item_layers *layers; /* Null if there is no layer info. */
78 struct pivot_table *pt;
81 struct table_item *table_item_create (struct table *, const char *title,
84 const struct table *table_item_get_table (const struct table_item *);
86 const struct table_item_text *table_item_get_title (const struct table_item *);
87 void table_item_set_title (struct table_item *,
88 const struct table_item_text *);
90 const struct table_item_layers *table_item_get_layers (
91 const struct table_item *);
92 void table_item_set_layers (struct table_item *,
93 const struct table_item_layers *);
95 const struct table_item_text *table_item_get_caption (
96 const struct table_item *);
97 void table_item_set_caption (struct table_item *,
98 const struct table_item_text *);
100 /* This boilerplate for table_item, a subclass of output_item, was
101 autogenerated by mk-class-boilerplate. */
104 #include "libpspp/cast.h"
106 extern const struct output_item_class table_item_class;
108 /* Returns true if SUPER is a table_item, otherwise false. */
110 is_table_item (const struct output_item *super)
112 return super->class == &table_item_class;
115 /* Returns SUPER converted to table_item. SUPER must be a table_item, as
116 reported by is_table_item. */
117 static inline struct table_item *
118 to_table_item (const struct output_item *super)
120 assert (is_table_item (super));
121 return UP_CAST (super, struct table_item, output_item);
124 /* Returns INSTANCE converted to output_item. */
125 static inline struct output_item *
126 table_item_super (const struct table_item *instance)
128 return CONST_CAST (struct output_item *, &instance->output_item);
131 /* Increments INSTANCE's reference count and returns INSTANCE. */
132 static inline struct table_item *
133 table_item_ref (const struct table_item *instance)
135 return to_table_item (output_item_ref (&instance->output_item));
138 /* Decrements INSTANCE's reference count, then destroys INSTANCE if
139 the reference count is now zero. */
141 table_item_unref (struct table_item *instance)
143 output_item_unref (&instance->output_item);
146 /* Returns true if INSTANCE's reference count is greater than 1,
149 table_item_is_shared (const struct table_item *instance)
151 return output_item_is_shared (&instance->output_item);
154 void table_item_submit (struct table_item *);
156 #endif /* output/table-item.h */