1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006 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 <language/command.h>
27 #include <language/data-io/data-writer.h>
28 #include <language/data-io/file-handle.h>
29 #include <language/data-io/placement-parser.h>
30 #include <language/lexer/format-parser.h>
31 #include <language/lexer/lexer.h>
32 #include <language/lexer/variable-parser.h>
33 #include <libpspp/assertion.h>
34 #include <libpspp/compiler.h>
35 #include <libpspp/ll.h>
36 #include <libpspp/message.h>
37 #include <libpspp/misc.h>
38 #include <libpspp/pool.h>
39 #include <output/manager.h>
40 #include <output/table.h>
45 #define _(msgid) gettext (msgid)
47 /* Describes what to do when an output field is encountered. */
50 PRT_LITERAL, /* Literal string. */
51 PRT_VAR /* Variable. */
54 /* Describes how to output one field. */
58 struct ll ll; /* In struct print_trns `specs' list. */
59 enum field_type type; /* What type of field this is. */
60 int record; /* 1-based record number. */
61 int first_column; /* 0-based first column. */
64 const struct variable *var; /* Associated variable. */
65 struct fmt_spec format; /* Output spec. */
66 bool add_space; /* Add trailing space? */
67 bool sysmis_as_spaces; /* Output SYSMIS as spaces? */
69 /* PRT_LITERAL only. */
70 struct string string; /* String to output. */
73 static inline struct prt_out_spec *
74 ll_to_prt_out_spec (struct ll *ll)
76 return ll_data (ll, struct prt_out_spec, ll);
79 /* PRINT, PRINT EJECT, WRITE private data structure. */
82 struct pool *pool; /* Stores related data. */
83 bool eject; /* Eject page before printing? */
84 bool include_prefix; /* Prefix lines with space? */
85 struct dfm_writer *writer; /* Output file, NULL=listing file. */
86 struct ll_list specs; /* List of struct prt_out_specs. */
87 size_t record_cnt; /* Number of records to write. */
88 struct string line; /* Output buffer. */
97 static int internal_cmd_print (struct lexer *, struct dataset *ds,
98 enum which_formats, bool eject);
99 static trns_proc_func print_trns_proc;
100 static trns_free_func print_trns_free;
101 static bool parse_specs (struct lexer *, struct pool *tmp_pool, struct print_trns *,
102 struct dictionary *dict, enum which_formats);
103 static void dump_table (struct print_trns *, const struct file_handle *);
107 /* Parses PRINT command. */
109 cmd_print (struct lexer *lexer, struct dataset *ds)
111 return internal_cmd_print (lexer, ds, PRINT, false);
114 /* Parses PRINT EJECT command. */
116 cmd_print_eject (struct lexer *lexer, struct dataset *ds)
118 return internal_cmd_print (lexer, ds, PRINT, true);
121 /* Parses WRITE command. */
123 cmd_write (struct lexer *lexer, struct dataset *ds)
125 return internal_cmd_print (lexer, ds, WRITE, false);
128 /* Parses the output commands. */
130 internal_cmd_print (struct lexer *lexer, struct dataset *ds,
131 enum which_formats which_formats, bool eject)
133 bool print_table = 0;
134 struct print_trns *trns;
135 struct file_handle *fh = NULL;
136 struct pool *tmp_pool;
138 /* Fill in prt to facilitate error-handling. */
139 trns = pool_create_container (struct print_trns, pool);
142 trns->record_cnt = 0;
143 ll_init (&trns->specs);
144 ds_init_empty (&trns->line);
145 ds_register_pool (&trns->line, trns->pool);
147 tmp_pool = pool_create_subpool (trns->pool);
149 /* Parse the command options. */
150 while (lex_token (lexer) != '/' && lex_token (lexer) != '.')
152 if (lex_match_id (lexer, "OUTFILE"))
154 lex_match (lexer, '=');
156 fh = fh_parse (lexer, FH_REF_FILE);
160 else if (lex_match_id (lexer, "RECORDS"))
162 lex_match (lexer, '=');
163 lex_match (lexer, '(');
164 if (!lex_force_int (lexer))
166 trns->record_cnt = lex_integer (lexer);
168 lex_match (lexer, ')');
170 else if (lex_match_id (lexer, "TABLE"))
172 else if (lex_match_id (lexer, "NOTABLE"))
176 lex_error (lexer, _("expecting a valid subcommand"));
181 /* When PRINT or PRINT EJECT writes to an external file, we
182 prefix each line with a space for compatibility. */
183 trns->include_prefix = which_formats == PRINT && fh != NULL;
185 /* Parse variables and strings. */
186 if (!parse_specs (lexer, tmp_pool, trns, dataset_dict (ds), which_formats))
189 if (lex_end_of_command (lexer) != CMD_SUCCESS)
194 trns->writer = dfm_open_writer (fh);
195 if (trns->writer == NULL)
199 /* Output the variable table if requested. */
201 dump_table (trns, fh);
203 /* Put the transformation in the queue. */
204 add_transformation (ds, print_trns_proc, print_trns_free, trns);
206 pool_destroy (tmp_pool);
211 print_trns_free (trns);
215 static bool parse_string_argument (struct lexer *, struct print_trns *,
216 int record, int *column);
217 static bool parse_variable_argument (struct lexer *, const struct dictionary *,
219 struct pool *tmp_pool,
220 int *record, int *column,
223 /* Parses all the variable and string specifications on a single
224 PRINT, PRINT EJECT, or WRITE command into the prt structure.
227 parse_specs (struct lexer *lexer, struct pool *tmp_pool, struct print_trns *trns,
228 struct dictionary *dict,
229 enum which_formats which_formats)
234 if (lex_token (lexer) == '.')
236 trns->record_cnt = 1;
240 while (lex_token (lexer) != '.')
244 if (!parse_record_placement (lexer, &record, &column))
247 if (lex_token (lexer) == T_STRING)
248 ok = parse_string_argument (lexer, trns, record, &column);
250 ok = parse_variable_argument (lexer, dict, trns, tmp_pool, &record, &column,
255 lex_match (lexer, ',');
258 if (trns->record_cnt != 0 && trns->record_cnt != record)
259 msg (SW, _("Output calls for %d records but %u specified on RECORDS "
261 record, (unsigned int) trns->record_cnt);
262 trns->record_cnt = record;
267 /* Parses a string argument to the PRINT commands. Returns success. */
269 parse_string_argument (struct lexer *lexer, struct print_trns *trns, int record, int *column)
271 struct prt_out_spec *spec = pool_alloc (trns->pool, sizeof *spec);
272 spec->type = PRT_LITERAL;
273 spec->record = record;
274 spec->first_column = *column;
275 ds_init_string (&spec->string, lex_tokstr (lexer));
276 ds_register_pool (&spec->string, trns->pool);
279 /* Parse the included column range. */
280 if (lex_is_number (lexer))
282 int first_column, last_column;
283 bool range_specified;
285 if (!parse_column_range (lexer, &first_column, &last_column, &range_specified))
288 spec->first_column = first_column;
290 ds_set_length (&spec->string, last_column - first_column + 1, ' ');
292 *column = spec->first_column + ds_length (&spec->string);
294 ll_push_tail (&trns->specs, &spec->ll);
298 /* Parses a variable argument to the PRINT commands by passing it off
299 to fixed_parse_compatible() or fixed_parse_fortran() as appropriate.
302 parse_variable_argument (struct lexer *lexer, const struct dictionary *dict,
303 struct print_trns *trns, struct pool *tmp_pool,
304 int *record, int *column,
305 enum which_formats which_formats)
307 const struct variable **vars;
308 size_t var_cnt, var_idx;
309 struct fmt_spec *formats, *f;
313 if (!parse_variables_const_pool (lexer, tmp_pool, dict,
314 &vars, &var_cnt, PV_DUPLICATE))
317 if (lex_is_number (lexer) || lex_token (lexer) == '(')
319 if (!parse_var_placements (lexer, tmp_pool, var_cnt, false,
320 &formats, &format_cnt))
328 lex_match (lexer, '*');
330 formats = pool_nmalloc (tmp_pool, var_cnt, sizeof *formats);
331 format_cnt = var_cnt;
332 for (i = 0; i < var_cnt; i++)
334 const struct variable *v = vars[i];
335 formats[i] = (which_formats == PRINT
336 ? *var_get_print_format (v)
337 : *var_get_write_format (v));
339 add_space = which_formats == PRINT;
343 for (f = formats; f < &formats[format_cnt]; f++)
344 if (!execute_placement_format (f, record, column))
346 const struct variable *var;
347 struct prt_out_spec *spec;
349 var = vars[var_idx++];
350 if (!fmt_check_width_compat (f, var_get_width (var)))
353 spec = pool_alloc (trns->pool, sizeof *spec);
354 spec->type = PRT_VAR;
355 spec->record = *record;
356 spec->first_column = *column;
359 spec->add_space = add_space;
361 /* This is a completely bizarre twist for compatibility:
362 WRITE outputs the system-missing value as a field
363 filled with spaces, instead of using the normal format
364 that usually contains a period. */
365 spec->sysmis_as_spaces = (which_formats == WRITE
366 && var_is_numeric (var)
367 && (fmt_get_category (spec->format.type)
370 ll_push_tail (&trns->specs, &spec->ll);
372 *column += f->w + add_space;
374 assert (var_idx == var_cnt);
379 /* Prints the table produced by the TABLE subcommand to the listing
382 dump_table (struct print_trns *trns, const struct file_handle *fh)
384 struct prt_out_spec *spec;
389 spec_cnt = ll_count (&trns->specs);
390 t = tab_create (4, spec_cnt + 1, 0);
391 tab_columns (t, TAB_COL_DOWN, 1);
392 tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 3, spec_cnt);
393 tab_hline (t, TAL_2, 0, 3, 1);
394 tab_headers (t, 0, 0, 1, 0);
395 tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
396 tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Record"));
397 tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Columns"));
398 tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Format"));
399 tab_dim (t, tab_natural_dimensions);
401 ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
403 char fmt_string[FMT_STRING_LEN_MAX + 1];
408 tab_text (t, 0, row, TAB_LEFT | TAB_FIX | TAT_PRINTF, "\"%.*s\"",
409 (int) ds_length (&spec->string), ds_data (&spec->string));
410 width = ds_length (&spec->string);
413 tab_text (t, 0, row, TAB_LEFT, var_get_name (spec->var));
414 tab_text (t, 3, row, TAB_LEFT | TAB_FIX,
415 fmt_to_string (&spec->format, fmt_string));
416 width = spec->format.w;
421 tab_text (t, 1, row, TAT_PRINTF, "%d", spec->record);
422 tab_text (t, 2, row, TAT_PRINTF, "%3d-%3d",
423 spec->first_column, spec->first_column + width - 1);
428 tab_title (t, ngettext ("Writing %d record to %s.",
429 "Writing %d records to %s.", trns->record_cnt),
430 trns->record_cnt, fh_get_name (fh));
432 tab_title (t, ngettext ("Writing %d record.",
433 "Writing %d records.", trns->record_cnt),
438 /* Transformation. */
440 static void flush_records (struct print_trns *, int target_record,
441 bool *eject, int *record);
443 /* Performs the transformation inside print_trns T on case C. */
445 print_trns_proc (void *trns_, struct ccase *c, casenumber case_num UNUSED)
447 struct print_trns *trns = trns_;
448 bool eject = trns->eject;
450 struct prt_out_spec *spec;
452 ds_clear (&trns->line);
453 ds_put_char (&trns->line, ' ');
454 ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
456 flush_records (trns, spec->record, &eject, &record);
458 ds_set_length (&trns->line, spec->first_column, ' ');
459 if (spec->type == PRT_VAR)
461 const union value *input = case_data (c, spec->var);
462 char *output = ds_put_uninit (&trns->line, spec->format.w);
463 if (!spec->sysmis_as_spaces || input->f != SYSMIS)
464 data_out (input, &spec->format, output);
466 memset (output, ' ', spec->format.w);
468 ds_put_char (&trns->line, ' ');
471 ds_put_substring (&trns->line, ds_ss (&spec->string));
473 flush_records (trns, trns->record_cnt + 1, &eject, &record);
475 if (trns->writer != NULL && dfm_write_error (trns->writer))
477 return TRNS_CONTINUE;
480 /* Advance from *RECORD to TARGET_RECORD, outputting records
481 along the way. If *EJECT is true, then the first record
482 output is preceded by ejecting the page (and *EJECT is set
485 flush_records (struct print_trns *trns, int target_record,
486 bool *eject, int *record)
488 for (; target_record > *record; (*record)++)
490 char *line = ds_cstr (&trns->line);
491 size_t length = ds_length (&trns->line);
497 if (trns->writer == NULL)
504 if (trns->writer == NULL)
505 tab_output_text (TAB_FIX | TAT_NOWRAP, &line[1]);
508 if (!trns->include_prefix)
513 dfm_put_record (trns->writer, line, length);
516 ds_truncate (&trns->line, 1);
522 print_trns_free (void *trns_)
524 struct print_trns *trns = trns_;
527 if (trns->writer != NULL)
528 ok = dfm_close_writer (trns->writer);
529 pool_destroy (trns->pool);