1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2008, 2010 Free Software Foundation
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 "terminal-opts.h"
26 #include "data/settings.h"
27 #include "data/file-name.h"
28 #include "language/syntax-file.h"
29 #include "libpspp/argv-parser.h"
30 #include "libpspp/assertion.h"
31 #include "libpspp/cast.h"
32 #include "libpspp/compiler.h"
33 #include "libpspp/getl.h"
34 #include "libpspp/llx.h"
35 #include "libpspp/str.h"
36 #include "libpspp/string-array.h"
37 #include "libpspp/string-map.h"
38 #include "libpspp/string-set.h"
39 #include "libpspp/version.h"
40 #include "output/driver.h"
41 #include "output/driver-provider.h"
42 #include "output/msglog.h"
43 #include "ui/terminal/msg-ui.h"
44 #include "ui/terminal/read-line.h"
47 #include "gl/progname.h"
48 #include "gl/version-etc.h"
49 #include "gl/xmemdup0.h"
52 #define _(msgid) gettext (msgid)
53 #define N_(msgid) msgid
57 struct source_stream *source_stream;
58 enum syntax_mode syntax_mode;
59 struct string_map options; /* Output driver options. */
60 bool has_output_driver;
61 bool has_terminal_driver;
80 static struct argv_option terminal_argv_options[N_TERMINAL_OPTIONS] =
82 {"testing-mode", 0, no_argument, OPT_TESTING_MODE},
83 {"error-file", 'e', required_argument, OPT_ERROR_FILE},
84 {"output", 'o', required_argument, OPT_OUTPUT},
85 {NULL, 'O', required_argument, OPT_OUTPUT_OPTION},
86 {"no-output", 0, no_argument, OPT_NO_OUTPUT},
87 {"interactive", 'i', no_argument, OPT_INTERACTIVE},
88 {"no-statrc", 'r', no_argument, OPT_NO_STATRC},
89 {"help", 'h', no_argument, OPT_HELP},
90 {"version", 'V', no_argument, OPT_VERSION},
94 register_output_driver (struct terminal_opts *to)
96 if (!string_map_is_empty (&to->options))
98 struct output_driver *driver;
100 driver = output_driver_create (&to->options);
103 output_driver_register (driver);
105 to->has_output_driver = true;
106 if (driver->device_type == SETTINGS_DEVICE_TERMINAL)
107 to->has_terminal_driver = true;
109 string_map_clear (&to->options);
114 parse_output_option (struct terminal_opts *to, const char *option)
119 equals = strchr (option, '=');
122 error (0, 0, _("%s: output option missing `='"), option);
126 key = xmemdup0 (option, equals - option);
127 if (string_map_contains (&to->options, key))
129 error (0, 0, _("%s: output option specified more than once"), key);
134 value = xmemdup0 (equals + 1, strlen (equals + 1));
135 string_map_insert_nocopy (&to->options, key, value);
139 get_supported_formats (void)
141 const struct string_set_node *node;
142 struct string_array format_array;
143 struct string_set format_set;
148 /* Get supported formats as unordered set. */
149 string_set_init (&format_set);
150 output_get_supported_formats (&format_set);
152 /* Converted supported formats to sorted array. */
153 string_array_init (&format_array);
154 STRING_SET_FOR_EACH (format, node, &format_set)
155 string_array_append (&format_array, format);
156 string_array_sort (&format_array);
157 string_set_destroy (&format_set);
159 /* Converted supported formats to string. */
160 format_string = string_array_join (&format_array, " ");
161 string_array_destroy (&format_array);
162 return format_string;
166 get_default_include_path (void)
168 struct source_stream *ss;
173 ss = create_source_stream ();
174 path = getl_include_path (ss);
175 ds_init_empty (&dst);
176 for (i = 0; path[i] != NULL; i++)
177 ds_put_format (&dst, " %s", path[i]);
178 destroy_source_stream (ss);
180 return ds_steal_cstr (&dst);
186 char *supported_formats = get_supported_formats ();
187 char *default_include_path = get_default_include_path ();
190 PSPP, a program for statistical analysis of sample data.\n\
191 Usage: %s [OPTION]... FILE...\n\
193 Arguments to long options also apply to equivalent short options.\n\
196 -o, --output=FILE output to FILE, default format from FILE's name\n\
197 -O format=FORMAT override format for previous -o\n\
198 -O OPTION=VALUE set output option to customize previous -o\n\
199 -O device={terminal|listing} override device type for previous -o\n\
200 -e, --error-file=FILE append errors, warnings, and notes to FILE\n\
201 --no-output disable default output driver\n\
202 Supported output formats: %s\n\
205 -I, --include=DIR append DIR to search path\n\
206 -I-, --no-include clear search path\n\
207 -r, --no-statrc disable running rc file at startup\n\
208 -a, --algorithm={compatible|enhanced}\n\
209 set to `compatible' if you want output\n\
210 calculated from broken algorithms\n\
211 -x, --syntax={compatible|enhanced}\n\
212 set to `compatible' to disable PSPP extensions\n\
213 -i, --interactive interpret syntax in interactive mode\n\
214 -s, --safer don't allow some unsafe operations\n\
215 Default search path:%s\n\
217 Informative output:\n\
218 -h, --help display this help and exit\n\
219 -V, --version output version information and exit\n\
221 Non-option arguments are interpreted as syntax files to execute.\n"),
222 program_name, supported_formats, default_include_path);
224 free (supported_formats);
225 free (default_include_path);
227 emit_bug_reporting_address ();
232 terminal_option_callback (int id, void *to_)
234 struct terminal_opts *to = to_;
238 case OPT_TESTING_MODE:
239 settings_set_testing_mode (true);
243 if (!strcmp (optarg, "none") || msglog_create (optarg))
244 to->has_error_file = true;
248 register_output_driver (to);
249 string_map_insert (&to->options, "output-file", optarg);
252 case OPT_OUTPUT_OPTION:
253 parse_output_option (to, optarg);
257 /* Pretend that we already have an output driver, which disables adding
258 one in terminal_opts_done() when we don't already have one. */
259 to->has_output_driver = true;
262 case OPT_INTERACTIVE:
263 to->syntax_mode = GETL_INTERACTIVE;
267 to->process_statrc = false;
275 version_etc (stdout, "pspp", PACKAGE_NAME, PACKAGE_VERSION,
276 "Ben Pfaff", "John Darrington", "Jason Stover",
285 struct terminal_opts *
286 terminal_opts_init (struct argv_parser *ap, struct source_stream *ss)
288 struct terminal_opts *to;
290 to = xzalloc (sizeof *to);
291 to->source_stream = ss;
292 to->syntax_mode = GETL_BATCH;
293 string_map_init (&to->options);
294 to->has_output_driver = false;
295 to->has_error_file = false;
296 to->process_statrc = true;
298 argv_parser_add_options (ap, terminal_argv_options, N_TERMINAL_OPTIONS,
299 terminal_option_callback, to);
304 add_syntax_file (struct terminal_opts *to, const char *file_name)
306 if (!strcmp (file_name, "-") && isatty (STDIN_FILENO))
307 getl_append_source (to->source_stream, create_readln_source (),
308 GETL_INTERACTIVE, ERRMODE_CONTINUE);
310 getl_append_source (to->source_stream,
311 create_syntax_file_source (file_name),
312 to->syntax_mode, ERRMODE_CONTINUE);
316 terminal_opts_done (struct terminal_opts *to, int argc, char *argv[])
318 if (to->process_statrc)
320 char *rc = fn_search_path ("rc", getl_include_path (to->source_stream));
323 getl_append_source (to->source_stream,
324 create_syntax_file_source (rc), GETL_BATCH,
334 for (i = optind; i < argc; i++)
335 add_syntax_file (to, argv[i]);
338 add_syntax_file (to, "-");
340 register_output_driver (to);
341 if (!to->has_output_driver)
343 string_map_insert (&to->options, "output-file", "-");
344 string_map_insert (&to->options, "format", "txt");
345 register_output_driver (to);
348 if (!to->has_terminal_driver && !to->has_error_file)
351 string_map_destroy (&to->options);