html: Pop up tooltip with table notes in output.
[pspp] / src / output / text-item.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
3
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.
8
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.
13
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/>. */
16
17 #include <config.h>
18
19 #include "output/text-item.h"
20
21 #include <stdarg.h>
22 #include <stdlib.h>
23
24 #include "libpspp/cast.h"
25 #include "libpspp/pool.h"
26 #include "output/driver.h"
27 #include "output/output-item-provider.h"
28 #include "output/table.h"
29 #include "output/table-item.h"
30 #include "output/table-provider.h"
31
32 #include "gl/xalloc.h"
33 #include "gl/xvasprintf.h"
34
35 #include "gettext.h"
36 #define _(msgid) gettext (msgid)
37
38 const char *
39 text_item_type_to_string (enum text_item_type type)
40 {
41   switch (type)
42     {
43     case TEXT_ITEM_PAGE_TITLE:
44       return _("Page Title");
45
46     case TEXT_ITEM_TITLE:
47       return _("Title");
48
49     case TEXT_ITEM_SYNTAX:
50     case TEXT_ITEM_LOG:
51       return _("Log");
52
53     default:
54       return _("Text");
55     }
56 }
57
58 /* Creates and returns a new text item containing TEXT and the specified TYPE.
59    The new text item takes ownership of TEXT. */
60 struct text_item *
61 text_item_create_nocopy (enum text_item_type type, char *text)
62 {
63   struct text_item *item = xzalloc (sizeof *item);
64   output_item_init (&item->output_item, &text_item_class);
65   item->text = text;
66   item->type = type;
67   return item;
68 }
69
70 /* Creates and returns a new text item containing a copy of TEXT and the
71    specified TYPE.  The caller retains ownership of TEXT. */
72 struct text_item *
73 text_item_create (enum text_item_type type, const char *text)
74 {
75   return text_item_create_nocopy (type, xstrdup (text));
76 }
77
78 /* Creates and returns a new text item containing a copy of FORMAT, which is
79    formatted as if by printf(), and the specified TYPE.  The caller retains
80    ownership of FORMAT. */
81 struct text_item *
82 text_item_create_format (enum text_item_type type, const char *format, ...)
83 {
84   struct text_item *item;
85   va_list args;
86
87   va_start (args, format);
88   item = text_item_create_nocopy (type, xvasprintf (format, args));
89   va_end (args);
90
91   return item;
92 }
93
94 /* Returns ITEM's type. */
95 enum text_item_type
96 text_item_get_type (const struct text_item *item)
97 {
98   return item->type;
99 }
100
101 /* Returns ITEM's text, which the caller may not modify or free. */
102 const char *
103 text_item_get_text (const struct text_item *item)
104 {
105   return item->text;
106 }
107
108 /* Submits ITEM to the configured output drivers, and transfers ownership to
109    the output subsystem. */
110 void
111 text_item_submit (struct text_item *item)
112 {
113   output_submit (&item->output_item);
114 }
115
116 struct table_item *
117 text_item_to_table_item (struct text_item *text_item)
118 {
119   struct table *tab = table_create (1, 1, 0, 0, 0, 0);
120
121   struct table_area_style *style = pool_alloc (tab->container, sizeof *style);
122   *style = (struct table_area_style) { TABLE_AREA_STYLE_INITIALIZER__,
123                                        .cell_style.halign = TABLE_HALIGN_LEFT };
124   struct font_style *font_style = &style->font_style;
125   if (text_item->typeface)
126     font_style->typeface = pool_strdup (tab->container, text_item->typeface);
127   font_style->size = text_item->size;
128   font_style->bold = text_item->bold;
129   font_style->italic = text_item->italic;
130   font_style->underline = text_item->underline;
131   font_style->markup = text_item->markup;
132   tab->styles[0] = style;
133
134   int opts = 0;
135   if (text_item->markup)
136     opts |= TAB_MARKUP;
137   if (text_item->type == TEXT_ITEM_SYNTAX || text_item->type == TEXT_ITEM_LOG)
138     opts |= TAB_FIX;
139   table_text (tab, 0, 0, opts, text_item_get_text (text_item));
140   struct table_item *table_item = table_item_create (tab, NULL, NULL, NULL);
141   text_item_unref (text_item);
142   return table_item;
143 }
144 \f
145 static void
146 text_item_destroy (struct output_item *output_item)
147 {
148   struct text_item *item = to_text_item (output_item);
149   free (item->text);
150   free (item->typeface);
151   free (item);
152 }
153
154 const struct output_item_class text_item_class =
155   {
156     "text",
157     text_item_destroy,
158   };