Implemented a rotations subdialog for the FACTOR command
[pspp] / src / output / driver.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010 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/driver.h"
20 #include "output/driver-provider.h"
21
22 #include <ctype.h>
23 #include <errno.h>
24 #include <limits.h>
25 #include <stdlib.h>
26 #include <string.h>
27
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"
40
41 #include "gl/error.h"
42 #include "gl/xalloc.h"
43 #include "gl/xmemdup0.h"
44
45 #include "gettext.h"
46 #define _(msgid) gettext (msgid)
47
48 static const struct output_driver_factory *factories[];
49
50 /* Drivers currently registered with output_driver_register(). */
51 static struct llx_list drivers = LLX_INITIALIZER (drivers);
52
53 static struct output_item *deferred_syntax;
54 static bool in_command;
55
56 void
57 output_close (void)
58 {
59   while (!llx_is_empty (&drivers))
60     {
61       struct output_driver *d = llx_pop_head (&drivers, &llx_malloc_mgr);
62       output_driver_destroy (d);
63     }
64 }
65
66 void
67 output_get_supported_formats (struct string_set *formats)
68 {
69   const struct output_driver_factory **fp;
70
71   for (fp = factories; *fp != NULL; fp++)
72     string_set_insert (formats, (*fp)->extension);
73 }
74
75 static void
76 output_submit__ (struct output_item *item)
77 {
78   struct llx *llx, *next;
79
80   for (llx = llx_head (&drivers); llx != llx_null (&drivers); llx = next)
81     {
82       struct output_driver *d = llx_data (llx);
83       enum settings_output_type type;
84
85       next = llx_next (llx);
86
87       if (is_message_item (item))
88         {
89           const struct msg *m = message_item_get_msg (to_message_item (item));
90           if (m->severity == MSG_S_NOTE)
91             type = SETTINGS_OUTPUT_NOTE;
92           else
93             type = SETTINGS_OUTPUT_ERROR;
94         }
95       else if (is_text_item (item)
96                && text_item_get_type (to_text_item (item)) == TEXT_ITEM_SYNTAX)
97         type = SETTINGS_OUTPUT_SYNTAX;
98       else
99         type = SETTINGS_OUTPUT_RESULT;
100
101       if (settings_get_output_routing (type) & d->device_type)
102         d->class->submit (d, item);
103     }
104
105   output_item_unref (item);
106 }
107
108 static void
109 flush_deferred_syntax (void)
110 {
111   if (deferred_syntax != NULL)
112     {
113       output_submit__ (deferred_syntax);
114       deferred_syntax = NULL;
115     }
116 }
117
118 /* Submits ITEM to the configured output drivers, and transfers ownership to
119    the output subsystem. */
120 void
121 output_submit (struct output_item *item)
122 {
123   if (is_text_item (item))
124     {
125       struct text_item *text = to_text_item (item);
126       switch (text_item_get_type (text))
127         {
128         case TEXT_ITEM_SYNTAX:
129           if (!in_command)
130             {
131               flush_deferred_syntax ();
132               deferred_syntax = item;
133               return;
134             }
135           break;
136
137         case TEXT_ITEM_COMMAND_OPEN:
138           output_submit__ (item);
139           flush_deferred_syntax ();
140           in_command = true;
141           return;
142
143         case TEXT_ITEM_COMMAND_CLOSE:
144           in_command = false;
145           break;
146
147         default:
148           break;
149         }
150     }
151
152   output_submit__ (item);
153 }
154
155 /* Flushes output to screen devices, so that the user can see
156    output that doesn't fill up an entire page. */
157 void
158 output_flush (void)
159 {
160   struct llx *llx;
161
162   for (llx = llx_head (&drivers); llx != llx_null (&drivers);
163        llx = llx_next (llx))
164     {
165       struct output_driver *d = llx_data (llx);
166       if (d->device_type & SETTINGS_DEVICE_TERMINAL && d->class->flush != NULL)
167         d->class->flush (d);
168     }
169 }
170 \f
171 void
172 output_driver_init (struct output_driver *driver,
173                     const struct output_driver_class *class,
174                     const char *name, enum settings_output_devices type)
175 {
176   driver->class = class;
177   driver->name = xstrdup (name);
178   driver->device_type = type;
179 }
180
181 void
182 output_driver_destroy (struct output_driver *driver)
183 {
184   if (driver != NULL)
185     {
186       char *name = driver->name;
187       if (output_driver_is_registered (driver))
188         output_driver_unregister (driver);
189       if (driver->class->destroy)
190         driver->class->destroy (driver);
191       free (name);
192     }
193 }
194
195 const char *
196 output_driver_get_name (const struct output_driver *driver)
197 {
198   return driver->name;
199 }
200 \f
201 void
202 output_driver_register (struct output_driver *driver)
203 {
204   assert (!output_driver_is_registered (driver));
205   llx_push_tail (&drivers, driver, &llx_malloc_mgr);
206 }
207
208 void
209 output_driver_unregister (struct output_driver *driver)
210 {
211   llx_remove (llx_find (llx_head (&drivers), llx_null (&drivers), driver),
212               &llx_malloc_mgr);
213 }
214
215 bool
216 output_driver_is_registered (const struct output_driver *driver)
217 {
218   return llx_find (llx_head (&drivers), llx_null (&drivers), driver) != NULL;
219 }
220 \f
221 /* Useful functions for output driver implementation. */
222
223 void
224 output_driver_track_current_command (const struct output_item *output_item,
225                                      char **command_namep)
226 {
227   if (is_text_item (output_item))
228     {
229       const struct text_item *item = to_text_item (output_item);
230       const char *text = text_item_get_text (item);
231       enum text_item_type type = text_item_get_type (item);
232
233       if (type == TEXT_ITEM_COMMAND_OPEN)
234         {
235           free (*command_namep);
236           *command_namep = xstrdup (text);
237         }
238       else if (type == TEXT_ITEM_COMMAND_CLOSE)
239         {
240           free (*command_namep);
241           *command_namep = NULL;
242         }
243     }
244 }
245 \f
246 extern const struct output_driver_factory txt_driver_factory;
247 extern const struct output_driver_factory list_driver_factory;
248 extern const struct output_driver_factory html_driver_factory;
249 extern const struct output_driver_factory csv_driver_factory;
250 #ifdef ODT_SUPPORT
251 extern const struct output_driver_factory odt_driver_factory;
252 #endif
253 #ifdef HAVE_CAIRO
254 extern const struct output_driver_factory pdf_driver_factory;
255 extern const struct output_driver_factory ps_driver_factory;
256 extern const struct output_driver_factory svg_driver_factory;
257 #endif
258
259 static const struct output_driver_factory *factories[] =
260   {
261     &txt_driver_factory,
262     &list_driver_factory,
263     &html_driver_factory,
264     &csv_driver_factory,
265 #ifdef ODT_SUPPORT
266     &odt_driver_factory,
267 #endif
268 #ifdef HAVE_CAIRO
269     &pdf_driver_factory,
270     &ps_driver_factory,
271     &svg_driver_factory,
272 #endif
273     NULL
274   };
275
276 static const struct output_driver_factory *
277 find_factory (const char *format)
278 {
279   const struct output_driver_factory **fp;
280
281   for (fp = factories; *fp != NULL; fp++)
282     {
283       const struct output_driver_factory *f = *fp;
284
285       if (!strcmp (f->extension, format))
286         return f;
287     }
288   return &txt_driver_factory;
289 }
290
291 static enum settings_output_devices
292 default_device_type (const char *file_name)
293 {
294   return (!strcmp (file_name, "-")
295           ? SETTINGS_DEVICE_TERMINAL
296           : SETTINGS_DEVICE_LISTING);
297 }
298
299 struct output_driver *
300 output_driver_create (struct string_map *options)
301 {
302   enum settings_output_devices device_type;
303   const struct output_driver_factory *f;
304   struct output_driver *driver;
305   char *device_string;
306   char *file_name;
307   char *format;
308
309   file_name = string_map_find_and_delete (options, "output-file");
310   if (file_name == NULL)
311     file_name = xstrdup ("-");
312
313   format = string_map_find_and_delete (options, "format");
314   if (format == NULL)
315     {
316       const char *extension = strrchr (file_name, '.');
317       format = xstrdup (extension != NULL ? extension + 1 : "");
318     }
319
320   /* XXX should use parse_enum(). */
321   device_string = string_map_find_and_delete (options, "device");
322   if (device_string == NULL || device_string[0] == '\0')
323     device_type = default_device_type (file_name);
324   else if (!strcmp (device_string, "terminal"))
325     device_type = SETTINGS_DEVICE_TERMINAL;
326   else if (!strcmp (device_string, "listing"))
327     device_type = SETTINGS_DEVICE_LISTING;
328   else
329     {
330       error (0, 0, _("%s is not a valid device type (the choices are "
331                      "\"terminal\" and \"listing\")"), device_string);
332       device_type = default_device_type (file_name);
333     }
334
335   f = find_factory (format);
336   driver = f->create (file_name, device_type, options);
337   if (driver != NULL)
338     {
339       const struct string_map_node *node;
340       const char *key;
341
342       STRING_MAP_FOR_EACH_KEY (key, node, options)
343         error (0, 0, _("%s: unknown option \"%s\""), file_name, key);
344     }
345   string_map_clear (options);
346
347   free (file_name);
348   free (format);
349   free (device_string);
350
351   return driver;
352 }