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/>. */
19 #include "output/table-provider.h"
23 #include "libpspp/assertion.h"
24 #include "libpspp/cast.h"
25 #include "output/driver.h"
26 #include "output/output-item-provider.h"
27 #include "output/pivot-table.h"
28 #include "output/table-item.h"
30 #include "gl/xalloc.h"
32 struct table_item_text *
33 table_item_text_create (const char *content)
38 struct table_item_text *text = xmalloc (sizeof *text);
39 *text = (struct table_item_text) { .content = xstrdup (content) };
43 struct table_item_text *
44 table_item_text_clone (const struct table_item_text *old)
49 struct table_item_text *new = xmalloc (sizeof *new);
50 *new = (struct table_item_text) {
51 .content = xstrdup (old->content),
52 .footnotes = xmemdup (old->footnotes,
53 old->n_footnotes * sizeof *old->footnotes),
54 .n_footnotes = old->n_footnotes,
55 .style = table_area_style_clone (NULL, old->style),
61 table_item_text_destroy (struct table_item_text *text)
66 free (text->footnotes);
67 table_area_style_free (text->style);
73 table_item_layer_copy (struct table_item_layer *dst,
74 const struct table_item_layer *src)
76 dst->content = xstrdup (src->content);
77 dst->footnotes = xmemdup (src->footnotes,
78 src->n_footnotes * sizeof *src->footnotes);
79 dst->n_footnotes = src->n_footnotes;
83 table_item_layer_uninit (struct table_item_layer *layer)
87 free (layer->content);
88 free (layer->footnotes);
92 struct table_item_layers *
93 table_item_layers_clone (const struct table_item_layers *old)
98 struct table_item_layers *new = xmalloc (sizeof *new);
99 *new = (struct table_item_layers) {
100 .layers = xnmalloc (old->n_layers, sizeof *new->layers),
101 .n_layers = old->n_layers,
102 .style = table_area_style_clone (NULL, old->style),
104 for (size_t i = 0; i < new->n_layers; i++)
105 table_item_layer_copy (&new->layers[i], &old->layers[i]);
110 table_item_layers_destroy (struct table_item_layers *layers)
114 for (size_t i = 0; i < layers->n_layers; i++)
115 table_item_layer_uninit (&layers->layers[i]);
116 free (layers->layers);
117 table_area_style_free (layers->style);
122 /* Initializes ITEM as a table item for rendering TABLE. The new table item
123 initially has the specified TITLE, CAPTION, and NOTES, which may each be
124 NULL. The caller retains ownership of TITLE, CAPTION, and NOTES. */
126 table_item_create (struct table *table, const char *title, const char *caption,
129 struct table_item *item = xmalloc (sizeof *item);
130 output_item_init (&item->output_item, &table_item_class);
132 item->title = table_item_text_create (title);
134 item->caption = table_item_text_create (caption);
135 item->notes = notes ? xstrdup (notes) : NULL;
140 /* Returns the table contained by TABLE_ITEM. The caller must not modify or
141 unref the returned table. */
143 table_item_get_table (const struct table_item *table_item)
145 return table_item->table;
148 /* Returns ITEM's title, which is a null pointer if no title has been
150 const struct table_item_text *
151 table_item_get_title (const struct table_item *item)
156 /* Sets ITEM's title to TITLE, replacing any previous title. Specify NULL for
157 TITLE to clear any title from ITEM. The caller retains ownership of TITLE.
159 This function may only be used on a table_item that is unshared. */
161 table_item_set_title (struct table_item *item,
162 const struct table_item_text *title)
164 assert (!table_item_is_shared (item));
165 table_item_text_destroy (item->title);
166 item->title = table_item_text_clone (title);
169 /* Returns ITEM's layers, which will be a null pointer if no layers have been
171 const struct table_item_layers *
172 table_item_get_layers (const struct table_item *item)
177 /* Sets ITEM's layers to LAYERS, replacing any previous layers. Specify NULL
178 for LAYERS to clear any layers from ITEM. The caller retains ownership of
181 This function may only be used on a table_item that is unshared. */
183 table_item_set_layers (struct table_item *item,
184 const struct table_item_layers *layers)
186 assert (!table_item_is_shared (item));
187 table_item_layers_destroy (item->layers);
188 item->layers = table_item_layers_clone (layers);
191 /* Returns ITEM's caption, which is a null pointer if no caption has been
193 const struct table_item_text *
194 table_item_get_caption (const struct table_item *item)
196 return item->caption;
199 /* Sets ITEM's caption to CAPTION, replacing any previous caption. Specify
200 NULL for CAPTION to clear any caption from ITEM. The caller retains
201 ownership of CAPTION.
203 This function may only be used on a table_item that is unshared. */
205 table_item_set_caption (struct table_item *item,
206 const struct table_item_text *caption)
208 assert (!table_item_is_shared (item));
209 table_item_text_destroy (item->caption);
210 item->caption = table_item_text_clone (caption);
213 /* Returns ITEM's notes, which is a null pointer if ITEM has no notes. */
215 table_item_get_notes (const struct table_item *item)
220 /* Sets ITEM's notes to NOTES, replacing any previous notes. Specify NULL for
221 NOTES to clear any notes from ITEM. The caller retains ownership of
224 This function may only be used on a table_item that is unshared.*/
226 table_item_set_notes (struct table_item *item, const char *notes)
228 assert (!table_item_is_shared (item));
230 item->notes = notes ? xstrdup (notes) : NULL;
233 /* Submits TABLE_ITEM to the configured output drivers, and transfers ownership
234 to the output subsystem. */
236 table_item_submit (struct table_item *table_item)
238 output_submit (&table_item->output_item);
242 table_item_destroy (struct output_item *output_item)
244 struct table_item *item = to_table_item (output_item);
245 table_item_text_destroy (item->title);
246 table_item_text_destroy (item->caption);
247 table_item_layers_destroy (item->layers);
249 pivot_table_unref (item->pt);
250 table_unref (item->table);
254 const struct output_item_class table_item_class =