1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007, 2009, 2010 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/driver.h"
20 #include "output/driver-provider.h"
28 #include "data/file-name.h"
29 #include "data/settings.h"
30 #include "libpspp/array.h"
31 #include "libpspp/assertion.h"
32 #include "libpspp/message.h"
33 #include "libpspp/llx.h"
34 #include "libpspp/string-map.h"
35 #include "libpspp/string-set.h"
36 #include "libpspp/str.h"
37 #include "output/message-item.h"
38 #include "output/output-item.h"
39 #include "output/text-item.h"
42 #include "gl/xalloc.h"
43 #include "gl/xmemdup0.h"
46 #define _(msgid) gettext (msgid)
48 static const struct output_driver_factory *factories[];
50 /* Drivers currently registered with output_driver_register(). */
51 static struct llx_list drivers = LLX_INITIALIZER (drivers);
56 while (!llx_is_empty (&drivers))
58 struct output_driver *d = llx_pop_head (&drivers, &llx_malloc_mgr);
59 output_driver_destroy (d);
64 output_get_supported_formats (struct string_set *formats)
66 const struct output_driver_factory **fp;
68 for (fp = factories; *fp != NULL; fp++)
69 string_set_insert (formats, (*fp)->extension);
72 /* Submits ITEM to the configured output drivers, and transfers ownership to
73 the output subsystem. */
75 output_submit (struct output_item *item)
77 struct llx *llx, *next;
79 for (llx = llx_head (&drivers); llx != llx_null (&drivers); llx = next)
81 struct output_driver *d = llx_data (llx);
82 enum settings_output_type type;
84 next = llx_next (llx);
86 if (is_message_item (item))
88 const struct msg *m = message_item_get_msg (to_message_item (item));
89 if (m->severity == MSG_S_NOTE)
90 type = SETTINGS_OUTPUT_NOTE;
92 type = SETTINGS_OUTPUT_ERROR;
94 else if (is_text_item (item)
95 && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
96 type = SETTINGS_OUTPUT_SYNTAX;
98 type = SETTINGS_OUTPUT_RESULT;
100 if (settings_get_output_routing (type) & d->device_type)
101 d->class->submit (d, item);
104 output_item_unref (item);
107 /* Flushes output to screen devices, so that the user can see
108 output that doesn't fill up an entire page. */
114 for (llx = llx_head (&drivers); llx != llx_null (&drivers);
115 llx = llx_next (llx))
117 struct output_driver *d = llx_data (llx);
118 if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
124 output_driver_init (struct output_driver *driver,
125 const struct output_driver_class *class,
126 const char *name, enum settings_output_devices type)
128 driver->class = class;
129 driver->name = xstrdup (name);
130 driver->device_type = type;
134 output_driver_destroy (struct output_driver *driver)
138 char *name = driver->name;
139 if (output_driver_is_registered (driver))
140 output_driver_unregister (driver);
141 if (driver->class->destroy)
142 driver->class->destroy (driver);
148 output_driver_get_name (const struct output_driver *driver)
154 output_driver_register (struct output_driver *driver)
156 assert (!output_driver_is_registered (driver));
157 llx_push_tail (&drivers, driver, &llx_malloc_mgr);
161 output_driver_unregister (struct output_driver *driver)
163 llx_remove (llx_find (llx_head (&drivers), llx_null (&drivers), driver),
168 output_driver_is_registered (const struct output_driver *driver)
170 return llx_find (llx_head (&drivers), llx_null (&drivers), driver) != NULL;
173 /* Useful functions for output driver implementation. */
176 output_driver_track_current_command (const struct output_item *output_item,
177 char **command_namep)
179 if (is_text_item (output_item))
181 const struct text_item *item = to_text_item (output_item);
182 const char *text = text_item_get_text (item);
183 enum text_item_type type = text_item_get_type (item);
185 if (type == TEXT_ITEM_COMMAND_OPEN)
187 free (*command_namep);
188 *command_namep = xstrdup (text);
190 else if (type == TEXT_ITEM_COMMAND_CLOSE)
192 free (*command_namep);
193 *command_namep = NULL;
198 extern const struct output_driver_factory txt_driver_factory;
199 extern const struct output_driver_factory list_driver_factory;
200 extern const struct output_driver_factory html_driver_factory;
201 extern const struct output_driver_factory csv_driver_factory;
203 extern const struct output_driver_factory odt_driver_factory;
206 extern const struct output_driver_factory pdf_driver_factory;
207 extern const struct output_driver_factory ps_driver_factory;
208 extern const struct output_driver_factory svg_driver_factory;
211 static const struct output_driver_factory *factories[] =
214 &list_driver_factory,
215 &html_driver_factory,
228 static const struct output_driver_factory *
229 find_factory (const char *format)
231 const struct output_driver_factory **fp;
233 for (fp = factories; *fp != NULL; fp++)
235 const struct output_driver_factory *f = *fp;
237 if (!strcmp (f->extension, format))
240 return &txt_driver_factory;
243 static enum settings_output_devices
244 default_device_type (const char *file_name)
246 return (!strcmp (file_name, "-")
247 ? SETTINGS_DEVICE_TERMINAL
248 : SETTINGS_DEVICE_LISTING);
251 struct output_driver *
252 output_driver_create (struct string_map *options)
254 enum settings_output_devices device_type;
255 const struct output_driver_factory *f;
256 struct output_driver *driver;
261 file_name = string_map_find_and_delete (options, "output-file");
262 if (file_name == NULL)
263 file_name = xstrdup ("-");
265 format = string_map_find_and_delete (options, "format");
268 const char *extension = strrchr (file_name, '.');
269 format = xstrdup (extension != NULL ? extension + 1 : "");
272 /* XXX should use parse_enum(). */
273 device_string = string_map_find_and_delete (options, "device");
274 if (device_string == NULL || device_string[0] == '\0')
275 device_type = default_device_type (file_name);
276 else if (!strcmp (device_string, "terminal"))
277 device_type = SETTINGS_DEVICE_TERMINAL;
278 else if (!strcmp (device_string, "listing"))
279 device_type = SETTINGS_DEVICE_LISTING;
282 /* TRANSLATORS: Don't translate the words `terminal' or `listing'. */
283 error (0, 0, _("%s is not a valid device type (the choices are "
284 "`terminal' and `listing')"), device_string);
285 device_type = default_device_type (file_name);
288 f = find_factory (format);
289 driver = f->create (file_name, device_type, options);
292 const struct string_map_node *node;
295 STRING_MAP_FOR_EACH_KEY (key, node, options)
296 error (0, 0, _("%s: unknown option `%s'"), file_name, key);
298 string_map_clear (options);
302 free (device_string);