1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009 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/>. */
21 #include <data/case.h>
22 #include <data/data-out.h>
23 #include <data/procedure.h>
24 #include <data/transformations.h>
25 #include <data/variable.h>
26 #include <data/format.h>
27 #include <language/command.h>
28 #include <language/data-io/data-writer.h>
29 #include <language/data-io/file-handle.h>
30 #include <language/data-io/placement-parser.h>
31 #include <language/lexer/format-parser.h>
32 #include <language/lexer/lexer.h>
33 #include <language/lexer/variable-parser.h>
34 #include <libpspp/assertion.h>
35 #include <libpspp/i18n.h>
36 #include <libpspp/compiler.h>
37 #include <libpspp/ll.h>
38 #include <libpspp/message.h>
39 #include <libpspp/misc.h>
40 #include <libpspp/pool.h>
41 #include <output/text-item.h>
42 #include <output/tab.h>
47 #define _(msgid) gettext (msgid)
49 /* Describes what to do when an output field is encountered. */
52 PRT_LITERAL, /* Literal string. */
53 PRT_VAR /* Variable. */
56 /* Describes how to output one field. */
60 struct ll ll; /* In struct print_trns `specs' list. */
61 enum field_type type; /* What type of field this is. */
62 int record; /* 1-based record number. */
63 int first_column; /* 0-based first column. */
66 const struct variable *var; /* Associated variable. */
67 struct fmt_spec format; /* Output spec. */
68 bool add_space; /* Add trailing space? */
69 bool sysmis_as_spaces; /* Output SYSMIS as spaces? */
71 /* PRT_LITERAL only. */
72 struct string string; /* String to output. */
75 static inline struct prt_out_spec *
76 ll_to_prt_out_spec (struct ll *ll)
78 return ll_data (ll, struct prt_out_spec, ll);
81 /* PRINT, PRINT EJECT, WRITE private data structure. */
84 struct pool *pool; /* Stores related data. */
85 bool eject; /* Eject page before printing? */
86 bool include_prefix; /* Prefix lines with space? */
87 const char *encoding; /* Encoding to use for output. */
88 struct dfm_writer *writer; /* Output file, NULL=listing file. */
89 struct ll_list specs; /* List of struct prt_out_specs. */
90 size_t record_cnt; /* Number of records to write. */
91 struct string line; /* Output buffer. */
100 static int internal_cmd_print (struct lexer *, struct dataset *ds,
101 enum which_formats, bool eject);
102 static trns_proc_func print_trns_proc;
103 static trns_free_func print_trns_free;
104 static bool parse_specs (struct lexer *, struct pool *tmp_pool, struct print_trns *,
105 struct dictionary *dict, enum which_formats);
106 static void dump_table (struct print_trns *, const struct file_handle *);
110 /* Parses PRINT command. */
112 cmd_print (struct lexer *lexer, struct dataset *ds)
114 return internal_cmd_print (lexer, ds, PRINT, false);
117 /* Parses PRINT EJECT command. */
119 cmd_print_eject (struct lexer *lexer, struct dataset *ds)
121 return internal_cmd_print (lexer, ds, PRINT, true);
124 /* Parses WRITE command. */
126 cmd_write (struct lexer *lexer, struct dataset *ds)
128 return internal_cmd_print (lexer, ds, WRITE, false);
131 /* Parses the output commands. */
133 internal_cmd_print (struct lexer *lexer, struct dataset *ds,
134 enum which_formats which_formats, bool eject)
136 bool print_table = 0;
137 struct print_trns *trns;
138 struct file_handle *fh = NULL;
139 struct pool *tmp_pool;
141 /* Fill in prt to facilitate error-handling. */
142 trns = pool_create_container (struct print_trns, pool);
145 trns->record_cnt = 0;
146 ll_init (&trns->specs);
147 ds_init_empty (&trns->line);
148 ds_register_pool (&trns->line, trns->pool);
150 tmp_pool = pool_create_subpool (trns->pool);
152 /* Parse the command options. */
153 while (lex_token (lexer) != '/' && lex_token (lexer) != '.')
155 if (lex_match_id (lexer, "OUTFILE"))
157 lex_match (lexer, '=');
159 fh = fh_parse (lexer, FH_REF_FILE);
163 else if (lex_match_id (lexer, "RECORDS"))
165 lex_match (lexer, '=');
166 lex_match (lexer, '(');
167 if (!lex_force_int (lexer))
169 trns->record_cnt = lex_integer (lexer);
171 lex_match (lexer, ')');
173 else if (lex_match_id (lexer, "TABLE"))
175 else if (lex_match_id (lexer, "NOTABLE"))
179 lex_error (lexer, _("expecting a valid subcommand"));
184 /* When PRINT or PRINT EJECT writes to an external file, we
185 prefix each line with a space for compatibility. */
186 trns->include_prefix = which_formats == PRINT && fh != NULL;
188 /* Parse variables and strings. */
189 if (!parse_specs (lexer, tmp_pool, trns, dataset_dict (ds), which_formats))
192 if (lex_end_of_command (lexer) != CMD_SUCCESS)
197 trns->writer = dfm_open_writer (fh);
198 if (trns->writer == NULL)
200 trns->encoding = dfm_writer_get_legacy_encoding (trns->writer);
203 trns->encoding = LEGACY_NATIVE;
205 /* Output the variable table if requested. */
207 dump_table (trns, fh);
209 /* Put the transformation in the queue. */
210 add_transformation (ds, print_trns_proc, print_trns_free, trns);
212 pool_destroy (tmp_pool);
218 print_trns_free (trns);
223 static bool parse_string_argument (struct lexer *, struct print_trns *,
224 int record, int *column);
225 static bool parse_variable_argument (struct lexer *, const struct dictionary *,
227 struct pool *tmp_pool,
228 int *record, int *column,
231 /* Parses all the variable and string specifications on a single
232 PRINT, PRINT EJECT, or WRITE command into the prt structure.
235 parse_specs (struct lexer *lexer, struct pool *tmp_pool, struct print_trns *trns,
236 struct dictionary *dict,
237 enum which_formats which_formats)
242 if (lex_token (lexer) == '.')
244 trns->record_cnt = 1;
248 while (lex_token (lexer) != '.')
252 if (!parse_record_placement (lexer, &record, &column))
255 if (lex_token (lexer) == T_STRING)
256 ok = parse_string_argument (lexer, trns, record, &column);
258 ok = parse_variable_argument (lexer, dict, trns, tmp_pool, &record, &column,
263 lex_match (lexer, ',');
266 if (trns->record_cnt != 0 && trns->record_cnt != record)
267 msg (SW, _("Output calls for %d records but %zu specified on RECORDS "
269 record, trns->record_cnt);
270 trns->record_cnt = record;
275 /* Parses a string argument to the PRINT commands. Returns success. */
277 parse_string_argument (struct lexer *lexer, struct print_trns *trns, int record, int *column)
279 struct prt_out_spec *spec = pool_alloc (trns->pool, sizeof *spec);
280 spec->type = PRT_LITERAL;
281 spec->record = record;
282 spec->first_column = *column;
283 ds_init_string (&spec->string, lex_tokstr (lexer));
284 ds_register_pool (&spec->string, trns->pool);
287 /* Parse the included column range. */
288 if (lex_is_number (lexer))
290 int first_column, last_column;
291 bool range_specified;
293 if (!parse_column_range (lexer, 1,
294 &first_column, &last_column, &range_specified))
297 spec->first_column = first_column;
299 ds_set_length (&spec->string, last_column - first_column + 1, ' ');
301 *column = spec->first_column + ds_length (&spec->string);
303 ll_push_tail (&trns->specs, &spec->ll);
307 /* Parses a variable argument to the PRINT commands by passing it off
308 to fixed_parse_compatible() or fixed_parse_fortran() as appropriate.
311 parse_variable_argument (struct lexer *lexer, const struct dictionary *dict,
312 struct print_trns *trns, struct pool *tmp_pool,
313 int *record, int *column,
314 enum which_formats which_formats)
316 const struct variable **vars;
317 size_t var_cnt, var_idx;
318 struct fmt_spec *formats, *f;
322 if (!parse_variables_const_pool (lexer, tmp_pool, dict,
323 &vars, &var_cnt, PV_DUPLICATE))
326 if (lex_is_number (lexer) || lex_token (lexer) == '(')
328 if (!parse_var_placements (lexer, tmp_pool, var_cnt, false,
329 &formats, &format_cnt))
337 lex_match (lexer, '*');
339 formats = pool_nmalloc (tmp_pool, var_cnt, sizeof *formats);
340 format_cnt = var_cnt;
341 for (i = 0; i < var_cnt; i++)
343 const struct variable *v = vars[i];
344 formats[i] = (which_formats == PRINT
345 ? *var_get_print_format (v)
346 : *var_get_write_format (v));
348 add_space = which_formats == PRINT;
352 for (f = formats; f < &formats[format_cnt]; f++)
353 if (!execute_placement_format (f, record, column))
355 const struct variable *var;
356 struct prt_out_spec *spec;
358 var = vars[var_idx++];
359 if (!fmt_check_width_compat (f, var_get_width (var)))
362 spec = pool_alloc (trns->pool, sizeof *spec);
363 spec->type = PRT_VAR;
364 spec->record = *record;
365 spec->first_column = *column;
368 spec->add_space = add_space;
370 /* This is a completely bizarre twist for compatibility:
371 WRITE outputs the system-missing value as a field
372 filled with spaces, instead of using the normal format
373 that usually contains a period. */
374 spec->sysmis_as_spaces = (which_formats == WRITE
375 && var_is_numeric (var)
376 && (fmt_get_category (spec->format.type)
379 ll_push_tail (&trns->specs, &spec->ll);
381 *column += f->w + add_space;
383 assert (var_idx == var_cnt);
388 /* Prints the table produced by the TABLE subcommand to the listing
391 dump_table (struct print_trns *trns, const struct file_handle *fh)
393 struct prt_out_spec *spec;
398 spec_cnt = ll_count (&trns->specs);
399 t = tab_create (4, spec_cnt + 1);
400 tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 3, spec_cnt);
401 tab_hline (t, TAL_2, 0, 3, 1);
402 tab_headers (t, 0, 0, 1, 0);
403 tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
404 tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Record"));
405 tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Columns"));
406 tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Format"));
408 ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
410 char fmt_string[FMT_STRING_LEN_MAX + 1];
415 tab_text_format (t, 0, row, TAB_LEFT | TAB_FIX, "\"%.*s\"",
416 (int) ds_length (&spec->string),
417 ds_data (&spec->string));
418 width = ds_length (&spec->string);
421 tab_text (t, 0, row, TAB_LEFT, var_get_name (spec->var));
422 tab_text (t, 3, row, TAB_LEFT | TAB_FIX,
423 fmt_to_string (&spec->format, fmt_string));
424 width = spec->format.w;
429 tab_text_format (t, 1, row, 0, "%d", spec->record);
430 tab_text_format (t, 2, row, 0, "%3d-%3d",
431 spec->first_column, spec->first_column + width - 1);
436 tab_title (t, ngettext ("Writing %zu record to %s.",
437 "Writing %zu records to %s.", trns->record_cnt),
438 trns->record_cnt, fh_get_name (fh));
440 tab_title (t, ngettext ("Writing %zu record.",
441 "Writing %zu records.", trns->record_cnt),
446 /* Transformation. */
448 static void flush_records (struct print_trns *, int target_record,
449 bool *eject, int *record);
451 /* Performs the transformation inside print_trns T on case C. */
453 print_trns_proc (void *trns_, struct ccase **c, casenumber case_num UNUSED)
455 struct print_trns *trns = trns_;
456 bool eject = trns->eject;
457 char encoded_space = legacy_from_native (trns->encoding, ' ');
459 struct prt_out_spec *spec;
461 ds_clear (&trns->line);
462 ds_put_char (&trns->line, ' ');
463 ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
465 flush_records (trns, spec->record, &eject, &record);
467 ds_set_length (&trns->line, spec->first_column, encoded_space);
468 if (spec->type == PRT_VAR)
470 const union value *input = case_data (*c, spec->var);
471 char *output = ds_put_uninit (&trns->line, spec->format.w);
472 if (!spec->sysmis_as_spaces || input->f != SYSMIS)
473 data_out_legacy (input, trns->encoding, &spec->format, output);
475 memset (output, encoded_space, spec->format.w);
477 ds_put_char (&trns->line, encoded_space);
481 ds_put_substring (&trns->line, ds_ss (&spec->string));
482 if (0 != strcmp (trns->encoding, LEGACY_NATIVE))
484 size_t length = ds_length (&spec->string);
485 char *data = ss_data (ds_tail (&trns->line, length));
486 char *s = recode_string (trns->encoding, LEGACY_NATIVE, data, length);
487 memcpy (data, s, length);
492 flush_records (trns, trns->record_cnt + 1, &eject, &record);
494 if (trns->writer != NULL && dfm_write_error (trns->writer))
496 return TRNS_CONTINUE;
499 /* Advance from *RECORD to TARGET_RECORD, outputting records
500 along the way. If *EJECT is true, then the first record
501 output is preceded by ejecting the page (and *EJECT is set
504 flush_records (struct print_trns *trns, int target_record,
505 bool *eject, int *record)
507 for (; target_record > *record; (*record)++)
509 char *line = ds_cstr (&trns->line);
510 size_t length = ds_length (&trns->line);
516 if (trns->writer == NULL)
517 text_item_submit (text_item_create (TEXT_ITEM_EJECT_PAGE, ""));
521 line[0] = legacy_from_native (trns->encoding, leader);
523 if (trns->writer == NULL)
524 tab_output_text (TAB_FIX, &line[1]);
527 if (!trns->include_prefix)
532 dfm_put_record (trns->writer, line, length);
535 ds_truncate (&trns->line, 1);
541 print_trns_free (void *trns_)
543 struct print_trns *trns = trns_;
546 if (trns->writer != NULL)
547 ok = dfm_close_writer (trns->writer);
548 pool_destroy (trns->pool);