1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2012, 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/>. */
17 #ifndef OUTPUT_DRIVER_PROVIDER_H
18 #define OUTPUT_DRIVER_PROVIDER_H 1
22 #include "data/settings.h"
23 #include "libpspp/compiler.h"
24 #include "output/driver.h"
27 struct output_iterator;
31 /* A configured output driver. */
34 const struct output_driver_class *class; /* Driver class. */
35 char *name; /* Name of this driver. */
36 enum settings_output_devices device_type; /* One of SETTINGS_DEVICE_*. */
39 void output_driver_init (struct output_driver *,
40 const struct output_driver_class *,
41 const char *, enum settings_output_devices);
43 void output_driver_destroy (struct output_driver *);
45 const char *output_driver_get_name (const struct output_driver *);
47 char *output_driver_substitute_heading_vars (const char *, int page_number);
49 /* One kind of output driver.
51 Output driver implementations must not call msg() to report errors. This
52 can lead to reentrance in the output driver, because msg() may report error
53 messages using the output drivers. Instead, this code should report errors
54 with error(), which will never call into the output drivers. */
55 struct output_driver_class
57 /* Name of this driver class. */
60 /* Closes and frees DRIVER. */
61 void (*destroy) (struct output_driver *driver);
63 /* Passes ITEM to DRIVER to be written as output. The caller retains
64 ownership of ITEM (but DRIVER may keep a copy of it by incrementing the
65 reference count by calling output_item_ref). */
66 void (*submit) (struct output_driver *driver,
67 const struct output_item *item);
69 /* Ensures that any output items passed to the 'submit' function for DRIVER
70 have actually been displayed.
72 This is called from the text-based UI before showing the command prompt,
73 to ensure that the user has actually been shown any preceding output If
74 it doesn't make sense for DRIVER to be used this way, then this function
75 need not do anything. */
76 void (*flush) (struct output_driver *driver);
78 /* Ordinarily, the core driver code will skip passing hidden output items
79 to 'submit'. If this member is true, the core driver hands them to the
80 driver to let it handle them itself. */
83 /* Ordinarily, the core driver code will flatten groups of output items
84 before passing them to 'submit'. If this member is true, the core
85 driver code leaves them in place for the driver to handle. */
89 /* An abstract way for the output subsystem to create an output driver. */
90 struct output_driver_factory
92 /* The file extension, without the leading dot, e.g. "pdf". */
93 const char *extension;
95 /* The default file name, including extension.
97 If this is "-", that implies that by default output will be directed to
99 const char *default_file_name;
101 /* Creates a new output driver of this class. NAME and TYPE should be
102 passed directly to output_driver_init. Returns the new output driver if
103 successful, otherwise a null pointer.
105 It is up to the driver class to decide how to interpret OPTIONS. The
106 create function should delete pairs that it understands from OPTIONS,
107 because the caller may issue errors about unknown options for any pairs
108 that remain. The functions in output/options.h can be useful.
110 The returned driver should not have been registered (with
111 output_driver_register). The caller will register the driver (if this
113 struct output_driver *(*create) (struct file_handle *,
114 enum settings_output_devices type,
115 struct string_map *options);
118 #endif /* output/driver-provider.h */