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/table-item.h"
29 #include "gl/xalloc.h"
31 struct table_item_text *
32 table_item_text_create (const char *content)
37 struct table_item_text *text = xmalloc (sizeof *text);
38 *text = (struct table_item_text) { .content = xstrdup (content) };
42 struct table_item_text *
43 table_item_text_clone (const struct table_item_text *old)
48 struct table_item_text *new = xmalloc (sizeof *new);
49 *new = (struct table_item_text) {
50 .content = xstrdup (old->content),
51 .footnotes = xmemdup (old->footnotes,
52 old->n_footnotes * sizeof *old->footnotes),
53 .n_footnotes = old->n_footnotes,
54 .style = cell_style_clone (old->style),
60 table_item_text_destroy (struct table_item_text *text)
65 free (text->footnotes);
66 cell_style_free (text->style);
71 /* Initializes ITEM as a table item for rendering TABLE. The new table item
72 initially has the specified TITLE and CAPTION, which may each be NULL. The
73 caller retains ownership of TITLE and CAPTION. */
75 table_item_create (struct table *table, const char *title, const char *caption)
77 struct table_item *item = xmalloc (sizeof *item);
78 output_item_init (&item->output_item, &table_item_class);
80 item->title = table_item_text_create (title);
81 item->caption = table_item_text_create (caption);
85 /* Returns the table contained by TABLE_ITEM. The caller must not modify or
86 unref the returned table. */
88 table_item_get_table (const struct table_item *table_item)
90 return table_item->table;
93 /* Returns ITEM's title, which is a null pointer if no title has been
95 const struct table_item_text *
96 table_item_get_title (const struct table_item *item)
101 /* Sets ITEM's title to TITLE, replacing any previous title. Specify NULL for
102 TITLE to clear any title from ITEM. The caller retains ownership of TITLE.
104 This function may only be used on a table_item that is unshared. */
106 table_item_set_title (struct table_item *item,
107 const struct table_item_text *title)
109 assert (!table_item_is_shared (item));
110 table_item_text_destroy (item->title);
111 item->title = table_item_text_clone (title);
114 /* Returns ITEM's caption, which is a null pointer if no caption has been
116 const struct table_item_text *
117 table_item_get_caption (const struct table_item *item)
119 return item->caption;
122 /* Sets ITEM's caption to CAPTION, replacing any previous caption. Specify
123 NULL for CAPTION to clear any caption from ITEM. The caller retains
124 ownership of CAPTION.
126 This function may only be used on a table_item that is unshared. */
128 table_item_set_caption (struct table_item *item,
129 const struct table_item_text *caption)
131 assert (!table_item_is_shared (item));
132 table_item_text_destroy (item->caption);
133 item->caption = table_item_text_clone (caption);
136 /* Submits TABLE_ITEM to the configured output drivers, and transfers ownership
137 to the output subsystem. */
139 table_item_submit (struct table_item *table_item)
141 output_submit (&table_item->output_item);
145 table_item_destroy (struct output_item *output_item)
147 struct table_item *item = to_table_item (output_item);
149 free (item->caption);
150 table_unref (item->table);
154 const struct output_item_class table_item_class =