1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 #include <data/case.h>
25 #include <data/procedure.h>
26 #include <data/transformations.h>
27 #include <data/variable.h>
28 #include <language/command.h>
29 #include <language/data-io/data-writer.h>
30 #include <language/data-io/file-handle.h>
31 #include <language/data-io/placement-parser.h>
32 #include <language/lexer/format-parser.h>
33 #include <language/lexer/lexer.h>
34 #include <language/lexer/variable-parser.h>
35 #include <libpspp/alloc.h>
36 #include <libpspp/assertion.h>
37 #include <libpspp/compiler.h>
38 #include <libpspp/ll.h>
39 #include <libpspp/message.h>
40 #include <libpspp/misc.h>
41 #include <libpspp/pool.h>
42 #include <output/manager.h>
43 #include <output/table.h>
46 #define _(msgid) gettext (msgid)
48 /* Describes what to do when an output field is encountered. */
51 PRT_LITERAL, /* Literal string. */
52 PRT_VAR /* Variable. */
55 /* Describes how to output one field. */
59 struct ll ll; /* In struct print_trns `specs' list. */
60 enum field_type type; /* What type of field this is. */
61 int record; /* 1-based record number. */
62 int first_column; /* 0-based first column. */
65 struct variable *var; /* Associated variable. */
66 struct fmt_spec format; /* Output spec. */
67 bool add_space; /* Add trailing space? */
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 omit_new_lines; /* Omit new-line characters? */
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 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 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 dataset *ds)
111 return internal_cmd_print (ds, PRINT, false);
114 /* Parses PRINT EJECT command. */
116 cmd_print_eject (struct dataset *ds)
118 return internal_cmd_print (ds, PRINT, true);
121 /* Parses WRITE command. */
123 cmd_write (struct dataset *ds)
125 return internal_cmd_print (ds, WRITE, false);
128 /* Parses the output commands. */
130 internal_cmd_print (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. */
152 if (lex_match_id ("OUTFILE"))
156 fh = fh_parse (FH_REF_FILE);
160 else if (lex_match_id ("RECORDS"))
164 if (!lex_force_int ())
166 trns->record_cnt = lex_integer ();
170 else if (lex_match_id ("TABLE"))
172 else if (lex_match_id ("NOTABLE"))
176 lex_error (_("expecting a valid subcommand"));
181 /* Parse variables and strings. */
182 if (!parse_specs (tmp_pool, trns, dataset_dict (ds), which_formats))
185 if (lex_end_of_command () != CMD_SUCCESS)
190 trns->writer = dfm_open_writer (fh);
191 if (trns->writer == NULL)
194 trns->omit_new_lines = (which_formats == WRITE
195 && fh_get_mode (fh) == FH_MODE_BINARY);
198 /* Output the variable table if requested. */
200 dump_table (trns, fh);
202 /* Put the transformation in the queue. */
203 add_transformation (ds, print_trns_proc, print_trns_free, trns);
205 pool_destroy (tmp_pool);
210 print_trns_free (trns);
214 static bool parse_string_argument (struct print_trns *,
215 int record, int *column);
216 static bool parse_variable_argument (const struct dictionary *,
218 struct pool *tmp_pool,
219 int *record, int *column,
222 /* Parses all the variable and string specifications on a single
223 PRINT, PRINT EJECT, or WRITE command into the prt structure.
226 parse_specs (struct pool *tmp_pool, struct print_trns *trns,
227 struct dictionary *dict,
228 enum which_formats which_formats)
237 if (!parse_record_placement (&record, &column))
240 if (token == T_STRING)
241 ok = parse_string_argument (trns, record, &column);
243 ok = parse_variable_argument (dict, trns, tmp_pool, &record, &column,
251 if (trns->record_cnt != 0 && trns->record_cnt != record)
252 msg (SW, _("Output calls for %d records but %d specified on RECORDS "
254 record, trns->record_cnt);
255 trns->record_cnt = record;
260 /* Parses a string argument to the PRINT commands. Returns success. */
262 parse_string_argument (struct print_trns *trns, int record, int *column)
264 struct prt_out_spec *spec = pool_alloc (trns->pool, sizeof *spec);
265 spec->type = PRT_LITERAL;
266 spec->record = record;
267 spec->first_column = *column;
268 ds_init_string (&spec->string, &tokstr);
269 ds_register_pool (&spec->string, trns->pool);
272 /* Parse the included column range. */
273 if (lex_is_number ())
275 int first_column, last_column;
276 bool range_specified;
278 if (!parse_column_range (&first_column, &last_column, &range_specified))
281 spec->first_column = first_column;
283 ds_set_length (&spec->string, last_column - first_column + 1, ' ');
285 *column = spec->first_column + ds_length (&spec->string);
287 ll_push_tail (&trns->specs, &spec->ll);
291 /* Parses a variable argument to the PRINT commands by passing it off
292 to fixed_parse_compatible() or fixed_parse_fortran() as appropriate.
295 parse_variable_argument (const struct dictionary *dict,
296 struct print_trns *trns, struct pool *tmp_pool,
297 int *record, int *column,
298 enum which_formats which_formats)
300 struct variable **vars;
301 size_t var_cnt, var_idx;
302 struct fmt_spec *formats, *f;
306 if (!parse_variables_pool (tmp_pool, dict, &vars, &var_cnt, PV_DUPLICATE))
309 if (lex_is_number () || token == '(')
311 if (!parse_var_placements (tmp_pool, var_cnt, &formats, &format_cnt))
321 formats = pool_nmalloc (tmp_pool, var_cnt, sizeof *formats);
322 format_cnt = var_cnt;
323 for (i = 0; i < var_cnt; i++)
325 struct variable *v = vars[i];
326 formats[i] = which_formats == PRINT ? v->print : v->write;
332 for (f = formats; f < &formats[format_cnt]; f++)
333 if (!execute_placement_format (f, record, column))
335 struct variable *var;
336 struct prt_out_spec *spec;
338 var = vars[var_idx++];
339 if (!check_specifier_width (f, var->width, true))
342 spec = pool_alloc (trns->pool, sizeof *spec);
343 spec->type = PRT_VAR;
344 spec->record = *record;
345 spec->first_column = *column;
348 spec->add_space = add_space;
349 ll_push_tail (&trns->specs, &spec->ll);
351 *column += f->w + add_space;
353 assert (var_idx == var_cnt);
358 /* Prints the table produced by the TABLE subcommand to the listing
361 dump_table (struct print_trns *trns, const struct file_handle *fh)
363 struct prt_out_spec *spec;
368 spec_cnt = ll_count (&trns->specs);
369 t = tab_create (4, spec_cnt + 1, 0);
370 tab_columns (t, TAB_COL_DOWN, 1);
371 tab_box (t, TAL_1, TAL_1, TAL_0, TAL_1, 0, 0, 3, spec_cnt);
372 tab_hline (t, TAL_2, 0, 3, 1);
373 tab_headers (t, 0, 0, 1, 0);
374 tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Variable"));
375 tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Record"));
376 tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Columns"));
377 tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Format"));
378 tab_dim (t, tab_natural_dimensions);
380 ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
386 tab_text (t, 0, row, TAB_LEFT | TAB_FIX | TAT_PRINTF, "\"%.*s\"",
387 (int) ds_length (&spec->string), ds_data (&spec->string));
388 width = ds_length (&spec->string);
391 tab_text (t, 0, row, TAB_LEFT, spec->var->name);
392 tab_text (t, 3, row, TAB_LEFT | TAB_FIX,
393 fmt_to_string (&spec->format));
394 width = spec->format.w;
399 tab_text (t, 1, row, TAT_PRINTF, "%d", spec->record);
400 tab_text (t, 2, row, TAT_PRINTF, "%3d-%3d",
401 spec->first_column, spec->first_column + width - 1);
406 tab_title (t, ngettext ("Writing %d record to %s.",
407 "Writing %d records to %s.", trns->record_cnt),
408 trns->record_cnt, fh_get_name (fh));
410 tab_title (t, ngettext ("Writing %d record.",
411 "Writing %d records.", trns->record_cnt),
416 /* Transformation. */
418 static void flush_records (struct print_trns *,
419 int target_record, int *record);
421 /* Performs the transformation inside print_trns T on case C. */
423 print_trns_proc (void *trns_, struct ccase *c, casenumber case_num UNUSED)
425 struct print_trns *trns = trns_;
426 struct prt_out_spec *spec;
433 ds_clear (&trns->line);
434 ll_for_each (spec, struct prt_out_spec, ll, &trns->specs)
436 flush_records (trns, spec->record, &record);
438 ds_set_length (&trns->line, spec->first_column - 1, ' ');
439 if (spec->type == PRT_VAR)
441 data_out (ds_put_uninit (&trns->line, spec->format.w),
442 &spec->format, case_data (c, spec->var->fv));
444 ds_put_char (&trns->line, ' ');
447 ds_put_substring (&trns->line, ds_ss (&spec->string));
449 flush_records (trns, trns->record_cnt + 1, &record);
451 if (trns->writer != NULL && dfm_write_error (trns->writer))
453 return TRNS_CONTINUE;
457 flush_records (struct print_trns *trns, int target_record, int *record)
459 while (target_record > *record)
461 if (trns->writer == NULL)
462 tab_output_text (TAB_FIX | TAT_NOWRAP, ds_cstr (&trns->line));
465 if (!trns->omit_new_lines)
466 ds_put_char (&trns->line, '\n');
468 dfm_put_record (trns->writer,
469 ds_data (&trns->line), ds_length (&trns->line));
471 ds_clear (&trns->line);
479 print_trns_free (void *trns_)
481 struct print_trns *trns = trns_;
484 if (trns->writer != NULL)
485 ok = dfm_close_writer (trns->writer);
486 pool_destroy (trns->pool);