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., 59 Temple Place - Suite 330, Boston, MA
37 /* List of variable names. */
44 /* Represents a FLIP input program. */
47 struct variable **var; /* Variables to transpose. */
48 int var_cnt; /* Number of elements in `var'. */
49 int case_cnt; /* Pre-flip case count. */
50 size_t case_size; /* Post-flip bytes per case. */
52 struct variable *new_names; /* Variable containing new variable names. */
53 struct varname *new_names_head; /* First new variable. */
54 struct varname *new_names_tail; /* Last new variable. */
56 FILE *file; /* Temporary file containing data. */
59 static void destroy_flip_pgm (struct flip_pgm *);
60 static struct case_sink *flip_sink_create (struct flip_pgm *);
61 static struct case_source *flip_source_create (struct flip_pgm *);
62 static void flip_file (struct flip_pgm *);
63 static int build_dictionary (struct flip_pgm *);
65 static const struct case_source_class flip_source_class;
66 static const struct case_sink_class flip_sink_class;
68 /* Parses and executes FLIP. */
72 struct flip_pgm *flip;
76 msg (SM, _("FLIP ignores TEMPORARY. "
77 "Temporary transformations will be made permanent."));
81 flip = xmalloc (sizeof *flip);
85 flip->new_names = NULL;
86 flip->new_names_head = NULL;
87 flip->new_names_tail = NULL;
90 lex_match_id ("FLIP");
92 if (lex_match_id ("VARIABLES"))
95 if (!parse_variables (default_dict, &flip->var, &flip->var_cnt, PV_NO_DUPLICATE))
100 dict_get_vars (default_dict, &flip->var, &flip->var_cnt, 1u << DC_SYSTEM);
103 if (lex_match_id ("NEWNAMES"))
106 flip->new_names = parse_variable ();
107 if (!flip->new_names)
111 flip->new_names = dict_lookup_var (default_dict, "CASE_LBL");
117 for (i = 0; i < flip->var_cnt; i++)
118 if (flip->var[i] == flip->new_names)
120 memmove (&flip->var[i], &flip->var[i + 1], sizeof *flip->var * (flip->var_cnt - i - 1));
126 /* Read the active file into a flip_sink. */
128 temp_trns = temporary = 0;
129 vfm_sink = flip_sink_create (flip);
130 flip->new_names_tail = NULL;
131 procedure (NULL, NULL);
133 /* Flip the data we read. */
136 /* Flip the dictionary. */
137 dict_clear (default_dict);
138 if (!build_dictionary (flip))
140 discard_variables ();
143 flip->case_size = dict_get_case_size (default_dict);
145 /* Set up flipped data for reading. */
146 vfm_source = flip_source_create (flip);
148 return lex_end_of_command ();
151 destroy_flip_pgm (flip);
157 destroy_flip_pgm (struct flip_pgm *flip)
159 struct varname *iter, *next;
162 for (iter = flip->new_names_head; iter != NULL; iter = next)
167 if (flip->file != NULL)
172 /* Make a new variable with base name NAME, which is bowdlerized and
173 mangled until acceptable, and returns success. */
175 make_new_var (char name[])
177 /* Fix invalid characters. */
181 for (cp = name; *cp && !isspace (*cp); cp++)
183 *cp = toupper ((unsigned char) *cp);
184 if (!isalpha (*cp) && *cp != '@' && *cp != '#'
185 && (cp == name || (*cp != '.' && *cp != '$' && *cp != '_'
189 *cp = 'V'; /* _ not valid in first position. */
197 if (dict_create_var (default_dict, name, 0))
200 /* Add numeric extensions until acceptable. */
202 int len = (int) strlen (name);
206 for (i = 1; i < 10000000; i++)
208 int ofs = min (7 - intlog10 (i), len);
209 memcpy (n, name, ofs);
210 sprintf (&n[ofs], "%d", i);
212 if (dict_create_var (default_dict, n, 0))
217 msg (SE, _("Could not create acceptable variant for variable %s."), name);
221 /* Make a new dictionary for all the new variable names. */
223 build_dictionary (struct flip_pgm *flip)
225 dict_create_var_assert (default_dict, "CASE_LBL", 8);
227 if (flip->new_names_head == NULL)
231 if (flip->case_cnt > 99999)
233 msg (SE, _("Cannot create more than 99999 variable names."));
237 for (i = 0; i < flip->case_cnt; i++)
242 sprintf (s, "VAR%03d", i);
243 v = dict_create_var_assert (default_dict, s, 0);
250 for (v = flip->new_names_head; v; v = v->next)
251 if (!make_new_var (v->name))
258 /* Cases during transposition. */
259 struct flip_sink_info
261 struct flip_pgm *flip; /* FLIP program. */
262 union value *output_buf; /* Case output buffer. */
265 /* Creates a flip sink based on FLIP. */
266 static struct case_sink *
267 flip_sink_create (struct flip_pgm *flip)
269 struct flip_sink_info *info = xmalloc (sizeof *info);
273 info->output_buf = xmalloc (sizeof *info->output_buf * flip->var_cnt);
275 flip->file = tmpfile ();
277 msg (FE, _("Could not create temporary file for FLIP."));
279 /* Write variable names as first case. */
280 for (i = 0; i < flip->var_cnt; i++)
281 st_bare_pad_copy (info->output_buf[i].s, flip->var[i]->name, 8);
282 if (fwrite (info->output_buf, sizeof *info->output_buf,
283 flip->var_cnt, flip->file) != (size_t) flip->var_cnt)
284 msg (FE, _("Error writing FLIP file: %s."), strerror (errno));
288 return create_case_sink (&flip_sink_class, default_dict, info);
291 /* Writes case C to the FLIP sink. */
293 flip_sink_write (struct case_sink *sink, const struct ccase *c)
295 struct flip_sink_info *info = sink->aux;
296 struct flip_pgm *flip = info->flip;
301 if (flip->new_names != NULL)
303 struct varname *v = xmalloc (sizeof (struct varname));
305 if (flip->new_names->type == NUMERIC)
307 double f = c->data[sink->idx_to_fv[flip->new_names->index]].f;
310 strcpy (v->name, "VSYSMIS");
311 else if (f < INT_MIN)
312 strcpy (v->name, "VNEGINF");
313 else if (f > INT_MAX)
314 strcpy (v->name, "VPOSINF");
317 char name[INT_DIGITS + 2];
318 sprintf (name, "V%d", (int) f);
319 strncpy (v->name, name, 8);
325 int width = min (flip->new_names->width, 8);
326 memcpy (v->name, c->data[sink->idx_to_fv[flip->new_names->index]].s,
331 if (flip->new_names_head == NULL)
332 flip->new_names_head = v;
334 flip->new_names_tail->next = v;
335 flip->new_names_tail = v;
338 /* Write to external file. */
339 for (i = 0; i < flip->var_cnt; i++)
340 if (flip->var[i]->type == NUMERIC)
341 info->output_buf[i].f = c->data[sink->idx_to_fv[flip->var[i]->index]].f;
343 info->output_buf[i].f = SYSMIS;
345 if (fwrite (info->output_buf, sizeof *info->output_buf,
346 flip->var_cnt, flip->file) != (size_t) flip->var_cnt)
347 msg (FE, _("Error writing FLIP file: %s."), strerror (errno));
350 /* Transposes the external file into a new file. */
352 flip_file (struct flip_pgm *flip)
355 size_t case_capacity;
357 union value *input_buf, *output_buf;
358 FILE *input_file, *output_file;
360 /* Allocate memory for many cases. */
361 case_bytes = flip->var_cnt * sizeof *input_buf;
362 case_capacity = set_max_workspace / case_bytes;
363 if (case_capacity > flip->case_cnt * 2)
364 case_capacity = flip->case_cnt * 2;
365 if (case_capacity < 2)
369 size_t bytes = case_bytes * case_capacity;
370 if (case_capacity > 2)
371 input_buf = malloc (bytes);
373 input_buf = xmalloc (bytes);
374 if (input_buf != NULL)
378 if (case_capacity < 2)
382 /* Use half the allocated memory for input_buf, half for
385 output_buf = input_buf + flip->var_cnt * case_capacity;
387 input_file = flip->file;
388 if (fseek (input_file, 0, SEEK_SET) != 0)
389 msg (FE, _("Error rewinding FLIP file: %s."), strerror (errno));
391 output_file = tmpfile ();
392 if (output_file == NULL)
393 msg (FE, _("Error creating FLIP source file."));
395 for (case_idx = 0; case_idx < flip->case_cnt; )
397 unsigned long read_cases = min (flip->case_cnt - case_idx,
401 if (read_cases != fread (input_buf, case_bytes, read_cases, input_file))
402 msg (FE, _("Error reading FLIP file: %s."), strerror (errno));
404 for (i = 0; i < flip->var_cnt; i++)
408 for (j = 0; j < read_cases; j++)
409 output_buf[j] = input_buf[i + j * flip->var_cnt];
411 if (fseek (output_file,
412 sizeof *input_buf * (case_idx + i * flip->case_cnt),
414 msg (FE, _("Error seeking FLIP source file: %s."),
417 if (fwrite (output_buf, sizeof *output_buf, read_cases, output_file)
419 msg (FE, _("Error writing FLIP source file: %s."),
423 case_idx += read_cases;
429 if (fseek (output_file, 0, SEEK_SET) != 0)
430 msg (FE, _("Error rewind FLIP source file: %s."), strerror (errno));
431 flip->file = output_file;
434 /* Destroy sink's internal data. */
436 flip_sink_destroy (struct case_sink *sink)
438 struct flip_sink_info *info = sink->aux;
440 free (info->output_buf);
444 /* FLIP sink class. */
445 static const struct case_sink_class flip_sink_class =
454 /* Creates and returns a FLIP source based on PGM,
455 which should have already been used as a sink. */
456 static struct case_source *
457 flip_source_create (struct flip_pgm *pgm)
459 return create_case_source (&flip_source_class, default_dict, pgm);
462 /* Reads the FLIP stream. Copies each case into C and calls
463 WRITE_CASE passing WC_DATA. */
465 flip_source_read (struct case_source *source,
467 write_case_func *write_case, write_case_data wc_data)
469 struct flip_pgm *flip = source->aux;
472 for (i = 0; i < flip->var_cnt; i++)
474 if (fread (c->data, sizeof *c->data, flip->case_cnt,
475 flip->file) != flip->case_cnt)
477 if (ferror (flip->file))
478 msg (SE, _("Error reading FLIP temporary file: %s."),
480 else if (feof (flip->file))
481 msg (SE, _("Unexpected end of file reading FLIP temporary file."));
487 if (!write_case (wc_data))
492 /* Destroy internal data in SOURCE. */
494 flip_source_destroy (struct case_source *source)
496 struct flip_pgm *flip = source->aux;
498 destroy_flip_pgm (flip);
501 static const struct case_source_class flip_source_class =