ab162a6268979bf551f85992575697ce10857964
[pspp] / src / output / driver.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2014 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 #ifndef OUTPUT_DRIVER_H
18 #define OUTPUT_DRIVER_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include "libpspp/compiler.h"
23
24 struct output_item;
25 struct page_setup;
26 struct string_set;
27 struct string_map;
28
29 void output_get_supported_formats (struct string_set *);
30
31 void output_engine_push (void);
32 void output_engine_pop (void);
33
34 void output_submit (struct output_item *);
35 void output_flush (void);
36
37 void output_log (const char *, ...) PRINTF_FORMAT (1, 2);
38
39 void output_set_title (const char *);
40 void output_set_subtitle (const char *);
41 void output_set_filename (const char *);
42
43 const char *output_get_command_name (void);
44 char *output_get_uppercase_command_name (void);
45
46 size_t output_open_group (struct output_item *);
47 void output_close_groups (size_t nesting_level);
48
49 void output_driver_parse_option (const char *option,
50                                  struct string_map *options);
51 struct output_driver *output_driver_create (struct string_map *options);
52 bool output_driver_is_registered (const struct output_driver *);
53
54 void output_driver_register (struct output_driver *);
55 void output_driver_unregister (struct output_driver *);
56
57 void output_set_page_setup (const struct page_setup *);
58
59 #endif /* output/driver.h */