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
27 #include "algorithm.h"
31 #include "dictionary.h"
42 /* List of variable names. */
46 char name[SHORT_NAME_LEN + 1];
49 /* Represents a FLIP input program. */
52 struct variable **var; /* Variables to transpose. */
53 int *idx_to_fv; /* var[]->index to compacted sink case fv. */
54 int var_cnt; /* Number of elements in `var'. */
55 int case_cnt; /* Pre-flip case count. */
56 size_t case_size; /* Post-flip bytes per case. */
58 struct variable *new_names; /* Variable containing new variable names. */
59 struct varname *new_names_head; /* First new variable. */
60 struct varname *new_names_tail; /* Last new variable. */
62 FILE *file; /* Temporary file containing data. */
65 static void destroy_flip_pgm (struct flip_pgm *);
66 static struct case_sink *flip_sink_create (struct flip_pgm *);
67 static struct case_source *flip_source_create (struct flip_pgm *);
68 static void flip_file (struct flip_pgm *);
69 static int build_dictionary (struct flip_pgm *);
71 static const struct case_source_class flip_source_class;
72 static const struct case_sink_class flip_sink_class;
74 /* Parses and executes FLIP. */
78 struct flip_pgm *flip;
82 msg (SM, _("FLIP ignores TEMPORARY. "
83 "Temporary transformations will be made permanent."));
87 flip = xmalloc (sizeof *flip);
89 flip->idx_to_fv = dict_get_compacted_idx_to_fv (default_dict);
92 flip->new_names = NULL;
93 flip->new_names_head = NULL;
94 flip->new_names_tail = NULL;
98 if (lex_match_id ("VARIABLES"))
101 if (!parse_variables (default_dict, &flip->var, &flip->var_cnt, PV_NO_DUPLICATE))
106 dict_get_vars (default_dict, &flip->var, &flip->var_cnt, 1u << DC_SYSTEM);
109 if (lex_match_id ("NEWNAMES"))
112 flip->new_names = parse_variable ();
113 if (!flip->new_names)
117 flip->new_names = dict_lookup_var (default_dict, "CASE_LBL");
123 for (i = 0; i < flip->var_cnt; i++)
124 if (flip->var[i] == flip->new_names)
126 remove_element (flip->var, flip->var_cnt, sizeof *flip->var, i);
132 /* Read the active file into a flip_sink. */
134 temp_trns = temporary = 0;
135 vfm_sink = flip_sink_create (flip);
136 flip->new_names_tail = NULL;
137 procedure (NULL, NULL);
139 /* Flip the data we read. */
142 /* Flip the dictionary. */
143 dict_clear (default_dict);
144 if (!build_dictionary (flip))
146 discard_variables ();
149 flip->case_size = dict_get_case_size (default_dict);
151 /* Set up flipped data for reading. */
152 vfm_source = flip_source_create (flip);
154 return lex_end_of_command ();
157 destroy_flip_pgm (flip);
163 destroy_flip_pgm (struct flip_pgm *flip)
165 struct varname *iter, *next;
168 free (flip->idx_to_fv);
169 for (iter = flip->new_names_head; iter != NULL; iter = next)
174 if (flip->file != NULL)
179 /* Make a new variable with base name NAME, which is bowdlerized and
180 mangled until acceptable, and returns success. */
182 make_new_var (char name[])
186 /* Trim trailing spaces. */
187 cp = strchr (name, '\0');
188 while (cp > name && isspace ((unsigned char) cp[-1]))
191 /* Fix invalid characters. */
192 for (cp = name; *cp && cp < name + SHORT_NAME_LEN; cp++)
195 if (!CHAR_IS_ID1 (*cp) || *cp == '$')
200 if (!CHAR_IS_IDN (*cp))
206 if (dict_create_var (default_dict, name, 0))
209 /* Add numeric extensions until acceptable. */
211 const int len = (int) strlen (name);
212 char n[SHORT_NAME_LEN + 1];
215 for (i = 1; i < 10000000; i++)
217 int ofs = min (7 - intlog10 (i), len);
218 memcpy (n, name, ofs);
219 sprintf (&n[ofs], "%d", i);
221 if (dict_create_var (default_dict, n, 0))
226 msg (SE, _("Could not create acceptable variant for variable %s."), name);
230 /* Make a new dictionary for all the new variable names. */
232 build_dictionary (struct flip_pgm *flip)
234 dict_create_var_assert (default_dict, "CASE_LBL", 8);
236 if (flip->new_names_head == NULL)
240 if (flip->case_cnt > 99999)
242 msg (SE, _("Cannot create more than 99999 variable names."));
246 for (i = 0; i < flip->case_cnt; i++)
249 char s[SHORT_NAME_LEN + 1];
251 sprintf (s, "VAR%03d", i);
252 v = dict_create_var_assert (default_dict, s, 0);
259 for (v = flip->new_names_head; v; v = v->next)
260 if (!make_new_var (v->name))
267 /* Cases during transposition. */
268 struct flip_sink_info
270 struct flip_pgm *flip; /* FLIP program. */
271 union value *output_buf; /* Case output buffer. */
274 /* Creates a flip sink based on FLIP. */
275 static struct case_sink *
276 flip_sink_create (struct flip_pgm *flip)
278 struct flip_sink_info *info = xmalloc (sizeof *info);
282 info->output_buf = xmalloc (sizeof *info->output_buf * flip->var_cnt);
284 flip->file = tmpfile ();
286 msg (FE, _("Could not create temporary file for FLIP."));
288 /* Write variable names as first case. */
289 for (i = 0; i < flip->var_cnt; i++)
290 st_bare_pad_copy (info->output_buf[i].s, flip->var[i]->name, MAX_SHORT_STRING);
291 if (fwrite (info->output_buf, sizeof *info->output_buf,
292 flip->var_cnt, flip->file) != (size_t) flip->var_cnt)
293 msg (FE, _("Error writing FLIP file: %s."), strerror (errno));
297 return create_case_sink (&flip_sink_class, default_dict, info);
300 /* Writes case C to the FLIP sink. */
302 flip_sink_write (struct case_sink *sink, const struct ccase *c)
304 struct flip_sink_info *info = sink->aux;
305 struct flip_pgm *flip = info->flip;
310 if (flip->new_names != NULL)
312 struct varname *v = xmalloc (sizeof (struct varname));
314 if (flip->new_names->type == NUMERIC)
316 double f = case_num (c, flip->idx_to_fv[flip->new_names->index]);
319 strcpy (v->name, "VSYSMIS");
320 else if (f < INT_MIN)
321 strcpy (v->name, "VNEGINF");
322 else if (f > INT_MAX)
323 strcpy (v->name, "VPOSINF");
326 char name[INT_DIGITS + 2];
327 sprintf (name, "V%d", (int) f);
328 st_trim_copy (v->name, name, sizeof v->name);
333 int width = min (flip->new_names->width, MAX_SHORT_STRING);
334 memcpy (v->name, case_str (c, flip->idx_to_fv[flip->new_names->index]),
339 if (flip->new_names_head == NULL)
340 flip->new_names_head = v;
342 flip->new_names_tail->next = v;
343 flip->new_names_tail = v;
346 /* Write to external file. */
347 for (i = 0; i < flip->var_cnt; i++)
351 if (flip->var[i]->type == NUMERIC)
352 out = case_num (c, flip->idx_to_fv[flip->var[i]->index]);
355 info->output_buf[i].f = out;
358 if (fwrite (info->output_buf, sizeof *info->output_buf,
359 flip->var_cnt, flip->file) != (size_t) flip->var_cnt)
360 msg (FE, _("Error writing FLIP file: %s."), strerror (errno));
363 /* Transposes the external file into a new file. */
365 flip_file (struct flip_pgm *flip)
368 size_t case_capacity;
370 union value *input_buf, *output_buf;
371 FILE *input_file, *output_file;
373 /* Allocate memory for many cases. */
374 case_bytes = flip->var_cnt * sizeof *input_buf;
375 case_capacity = get_max_workspace() / case_bytes;
376 if (case_capacity > flip->case_cnt * 2)
377 case_capacity = flip->case_cnt * 2;
378 if (case_capacity < 2)
382 size_t bytes = case_bytes * case_capacity;
383 if (case_capacity > 2)
384 input_buf = malloc (bytes);
386 input_buf = xmalloc (bytes);
387 if (input_buf != NULL)
391 if (case_capacity < 2)
395 /* Use half the allocated memory for input_buf, half for
398 output_buf = input_buf + flip->var_cnt * case_capacity;
400 input_file = flip->file;
401 if (fseek (input_file, 0, SEEK_SET) != 0)
402 msg (FE, _("Error rewinding FLIP file: %s."), strerror (errno));
404 output_file = tmpfile ();
405 if (output_file == NULL)
406 msg (FE, _("Error creating FLIP source file."));
408 for (case_idx = 0; case_idx < flip->case_cnt; )
410 unsigned long read_cases = min (flip->case_cnt - case_idx,
414 if (read_cases != fread (input_buf, case_bytes, read_cases, input_file))
415 msg (FE, _("Error reading FLIP file: %s."), strerror (errno));
417 for (i = 0; i < flip->var_cnt; i++)
421 for (j = 0; j < read_cases; j++)
422 output_buf[j] = input_buf[i + j * flip->var_cnt];
429 #define off_t long int
432 if (fseeko (output_file,
433 sizeof *input_buf * (case_idx
434 + (off_t) i * flip->case_cnt),
436 msg (FE, _("Error seeking FLIP source file: %s."),
439 if (fwrite (output_buf, sizeof *output_buf, read_cases, output_file)
441 msg (FE, _("Error writing FLIP source file: %s."),
445 case_idx += read_cases;
451 if (fseek (output_file, 0, SEEK_SET) != 0)
452 msg (FE, _("Error rewind FLIP source file: %s."), strerror (errno));
453 flip->file = output_file;
456 /* Destroy sink's internal data. */
458 flip_sink_destroy (struct case_sink *sink)
460 struct flip_sink_info *info = sink->aux;
462 free (info->output_buf);
466 /* FLIP sink class. */
467 static const struct case_sink_class flip_sink_class =
476 /* Creates and returns a FLIP source based on PGM,
477 which should have already been used as a sink. */
478 static struct case_source *
479 flip_source_create (struct flip_pgm *pgm)
481 return create_case_source (&flip_source_class, pgm);
484 /* Reads the FLIP stream. Copies each case into C and calls
485 WRITE_CASE passing WC_DATA. */
487 flip_source_read (struct case_source *source,
489 write_case_func *write_case, write_case_data wc_data)
491 struct flip_pgm *flip = source->aux;
492 union value *input_buf;
495 input_buf = xmalloc (sizeof *input_buf * flip->case_cnt);
496 for (i = 0; i < flip->var_cnt; i++)
500 if (fread (input_buf, sizeof *input_buf, flip->case_cnt,
501 flip->file) != flip->case_cnt)
503 if (ferror (flip->file))
504 msg (SE, _("Error reading FLIP temporary file: %s."),
506 else if (feof (flip->file))
507 msg (SE, _("Unexpected end of file reading FLIP temporary file."));
513 for (j = 0; j < flip->case_cnt; j++)
514 case_data_rw (c, j)->f = input_buf[j].f;
515 if (!write_case (wc_data))
521 /* Destroy internal data in SOURCE. */
523 flip_source_destroy (struct case_source *source)
525 struct flip_pgm *flip = source->aux;
527 destroy_flip_pgm (flip);
530 static const struct case_source_class flip_source_class =