New implementation of long variable names. Each variable has a
[pspp-builds.git] / src / flip.c
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
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.
9
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.
14
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
18    02110-1301, USA. */
19
20 #include "config.h"
21 #include "error.h"
22 #include <ctype.h>
23 #include <errno.h>
24 #include <float.h>
25 #include <limits.h>
26 #include <stdlib.h>
27 #include "algorithm.h"
28 #include "alloc.h"
29 #include "case.h"
30 #include "command.h"
31 #include "dictionary.h"
32 #include "error.h"
33 #include "lexer.h"
34 #include "misc.h"
35 #include "settings.h"
36 #include "str.h"
37 #include "val.h"
38 #include "var.h"
39 #include "vfm.h"
40
41
42 /* List of variable names. */
43 struct varname
44   {
45     struct varname *next;
46     char name[SHORT_NAME_LEN + 1];
47   };
48
49 /* Represents a FLIP input program. */
50 struct flip_pgm 
51   {
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. */
57
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. */
61
62     FILE *file;                 /* Temporary file containing data. */
63   };
64
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 *);
70
71 static const struct case_source_class flip_source_class;
72 static const struct case_sink_class flip_sink_class;
73
74 /* Parses and executes FLIP. */
75 int
76 cmd_flip (void)
77 {
78   struct flip_pgm *flip;
79
80   if (temporary != 0)
81     {
82       msg (SM, _("FLIP ignores TEMPORARY.  "
83                  "Temporary transformations will be made permanent."));
84       cancel_temporary (); 
85     }
86
87   flip = xmalloc (sizeof *flip);
88   flip->var = NULL;
89   flip->idx_to_fv = dict_get_compacted_idx_to_fv (default_dict);
90   flip->var_cnt = 0;
91   flip->case_cnt = 0;
92   flip->new_names = NULL;
93   flip->new_names_head = NULL;
94   flip->new_names_tail = NULL;
95   flip->file = NULL;
96
97   lex_match ('/');
98   if (lex_match_id ("VARIABLES"))
99     {
100       lex_match ('=');
101       if (!parse_variables (default_dict, &flip->var, &flip->var_cnt, PV_NO_DUPLICATE))
102         return CMD_FAILURE;
103       lex_match ('/');
104     }
105   else
106     dict_get_vars (default_dict, &flip->var, &flip->var_cnt, 1u << DC_SYSTEM);
107
108   lex_match ('/');
109   if (lex_match_id ("NEWNAMES"))
110     {
111       lex_match ('=');
112       flip->new_names = parse_variable ();
113       if (!flip->new_names)
114         goto error;
115     }
116   else
117     flip->new_names = dict_lookup_var (default_dict, "CASE_LBL");
118
119   if (flip->new_names)
120     {
121       int i;
122       
123       for (i = 0; i < flip->var_cnt; i++)
124         if (flip->var[i] == flip->new_names)
125           {
126             remove_element (flip->var, flip->var_cnt, sizeof *flip->var, i);
127             flip->var_cnt--;
128             break;
129           }
130     }
131
132   /* Read the active file into a flip_sink. */
133   flip->case_cnt = 0;
134   temp_trns = temporary = 0;
135   vfm_sink = flip_sink_create (flip);
136   flip->new_names_tail = NULL;
137   procedure (NULL, NULL);
138
139   /* Flip the data we read. */
140   flip_file (flip);
141
142   /* Flip the dictionary. */
143   dict_clear (default_dict);
144   if (!build_dictionary (flip))
145     {
146       discard_variables ();
147       goto error;
148     }
149   flip->case_size = dict_get_case_size (default_dict);
150
151   /* Set up flipped data for reading. */
152   vfm_source = flip_source_create (flip);
153
154   return lex_end_of_command ();
155
156  error:
157   destroy_flip_pgm (flip);
158   return CMD_FAILURE;
159 }
160
161 /* Destroys FLIP. */
162 static void
163 destroy_flip_pgm (struct flip_pgm *flip) 
164 {
165   struct varname *iter, *next;
166   
167   free (flip->var);
168   free (flip->idx_to_fv);
169   for (iter = flip->new_names_head; iter != NULL; iter = next) 
170     {
171       next = iter->next;
172       free (iter);
173     }
174   if (flip->file != NULL)
175     fclose (flip->file);
176   free (flip);
177 }
178
179 /* Make a new variable with base name NAME, which is bowdlerized and
180    mangled until acceptable, and returns success. */
181 static int
182 make_new_var (char name[])
183 {
184   char *cp;
185
186   /* Trim trailing spaces. */
187   cp = strchr (name, '\0');
188   while (cp > name && isspace ((unsigned char) cp[-1]))
189     *--cp = '\0';
190
191   /* Fix invalid characters. */
192   for (cp = name; *cp && cp < name + SHORT_NAME_LEN; cp++)
193     if (cp == name) 
194       {
195         if (!CHAR_IS_ID1 (*cp) || *cp == '$')
196           *cp = 'V';
197       }
198     else
199       {
200         if (!CHAR_IS_IDN (*cp))
201           *cp = '_'; 
202       }
203   *cp = '\0';
204   st_uppercase (name);
205   
206   if (dict_create_var (default_dict, name, 0))
207     return 1;
208
209   /* Add numeric extensions until acceptable. */
210   {
211     const int len = (int) strlen (name);
212     char n[SHORT_NAME_LEN + 1];
213     int i;
214
215     for (i = 1; i < 10000000; i++)
216       {
217         int ofs = min (7 - intlog10 (i), len);
218         memcpy (n, name, ofs);
219         sprintf (&n[ofs], "%d", i);
220
221         if (dict_create_var (default_dict, n, 0))
222           return 1;
223       }
224   }
225
226   msg (SE, _("Could not create acceptable variant for variable %s."), name);
227   return 0;
228 }
229
230 /* Make a new dictionary for all the new variable names. */
231 static int
232 build_dictionary (struct flip_pgm *flip)
233 {
234   dict_create_var_assert (default_dict, "CASE_LBL", 8);
235
236   if (flip->new_names_head == NULL)
237     {
238       int i;
239       
240       if (flip->case_cnt > 99999)
241         {
242           msg (SE, _("Cannot create more than 99999 variable names."));
243           return 0;
244         }
245       
246       for (i = 0; i < flip->case_cnt; i++)
247         {
248           struct variable *v;
249           char s[SHORT_NAME_LEN + 1];
250
251           sprintf (s, "VAR%03d", i);
252           v = dict_create_var_assert (default_dict, s, 0);
253         }
254     }
255   else
256     {
257       struct varname *v;
258
259       for (v = flip->new_names_head; v; v = v->next)
260         if (!make_new_var (v->name))
261           return 0;
262     }
263   
264   return 1;
265 }
266      
267 /* Cases during transposition. */
268 struct flip_sink_info 
269   {
270     struct flip_pgm *flip;              /* FLIP program. */
271     union value *output_buf;            /* Case output buffer. */
272   };
273
274 /* Creates a flip sink based on FLIP. */
275 static struct case_sink *
276 flip_sink_create (struct flip_pgm *flip) 
277 {
278   struct flip_sink_info *info = xmalloc (sizeof *info);
279   int i;
280
281   info->flip = flip;
282   info->output_buf = xmalloc (sizeof *info->output_buf * flip->var_cnt);
283
284   flip->file = tmpfile ();
285   if (!flip->file)
286     msg (FE, _("Could not create temporary file for FLIP."));
287
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));
294
295   flip->case_cnt = 1;
296
297   return create_case_sink (&flip_sink_class, default_dict, info);
298 }
299
300 /* Writes case C to the FLIP sink. */
301 static void
302 flip_sink_write (struct case_sink *sink, const struct ccase *c)
303 {
304   struct flip_sink_info *info = sink->aux;
305   struct flip_pgm *flip = info->flip;
306   int i;
307   
308   flip->case_cnt++;
309
310   if (flip->new_names != NULL)
311     {
312       struct varname *v = xmalloc (sizeof (struct varname));
313       v->next = NULL;
314       if (flip->new_names->type == NUMERIC) 
315         {
316           double f = case_num (c, flip->idx_to_fv[flip->new_names->index]);
317
318           if (f == SYSMIS)
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");
324           else 
325             {
326               char name[INT_DIGITS + 2];
327               sprintf (name, "V%d", (int) f);
328               st_trim_copy (v->name, name, sizeof v->name);
329             }
330         }
331       else
332         {
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]),
335                   width);
336           v->name[width] = 0;
337         }
338       
339       if (flip->new_names_head == NULL)
340         flip->new_names_head = v;
341       else
342         flip->new_names_tail->next = v;
343       flip->new_names_tail = v;
344     }
345
346   /* Write to external file. */
347   for (i = 0; i < flip->var_cnt; i++)
348     {
349       double out;
350       
351       if (flip->var[i]->type == NUMERIC)
352         out = case_num (c, flip->idx_to_fv[flip->var[i]->index]);
353       else
354         out = SYSMIS;
355       info->output_buf[i].f = out;
356     }
357           
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));
361 }
362
363 /* Transposes the external file into a new file. */
364 static void
365 flip_file (struct flip_pgm *flip)
366 {
367   size_t case_bytes;
368   size_t case_capacity;
369   size_t case_idx;
370   union value *input_buf, *output_buf;
371   FILE *input_file, *output_file;
372
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)
379     case_capacity = 2;
380   for (;;)
381     {
382       size_t bytes = case_bytes * case_capacity;
383       if (case_capacity > 2)
384         input_buf = malloc (bytes);
385       else
386         input_buf = xmalloc (bytes);
387       if (input_buf != NULL)
388         break;
389
390       case_capacity /= 2;
391       if (case_capacity < 2)
392         case_capacity = 2;
393     }
394
395   /* Use half the allocated memory for input_buf, half for
396      output_buf. */
397   case_capacity /= 2;
398   output_buf = input_buf + flip->var_cnt * case_capacity;
399
400   input_file = flip->file;
401   if (fseek (input_file, 0, SEEK_SET) != 0)
402     msg (FE, _("Error rewinding FLIP file: %s."), strerror (errno));
403
404   output_file = tmpfile ();
405   if (output_file == NULL)
406     msg (FE, _("Error creating FLIP source file."));
407   
408   for (case_idx = 0; case_idx < flip->case_cnt; )
409     {
410       unsigned long read_cases = min (flip->case_cnt - case_idx,
411                                       case_capacity);
412       int i;
413
414       if (read_cases != fread (input_buf, case_bytes, read_cases, input_file))
415         msg (FE, _("Error reading FLIP file: %s."), strerror (errno));
416
417       for (i = 0; i < flip->var_cnt; i++)
418         {
419           unsigned long j;
420           
421           for (j = 0; j < read_cases; j++)
422             output_buf[j] = input_buf[i + j * flip->var_cnt];
423
424 #ifndef HAVE_FSEEKO
425 #define fseeko fseek
426 #endif
427
428 #ifndef HAVE_OFF_T
429 #define off_t long int
430 #endif
431
432           if (fseeko (output_file,
433                       sizeof *input_buf * (case_idx
434                                            + (off_t) i * flip->case_cnt),
435                       SEEK_SET) != 0)
436             msg (FE, _("Error seeking FLIP source file: %s."),
437                        strerror (errno));
438
439           if (fwrite (output_buf, sizeof *output_buf, read_cases, output_file)
440               != read_cases)
441             msg (FE, _("Error writing FLIP source file: %s."),
442                  strerror (errno));
443         }
444
445       case_idx += read_cases;
446     }
447
448   fclose (input_file);
449   free (input_buf);
450   
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;
454 }
455
456 /* Destroy sink's internal data. */
457 static void
458 flip_sink_destroy (struct case_sink *sink)
459 {
460   struct flip_sink_info *info = sink->aux;
461
462   free (info->output_buf);
463   free (info);
464 }
465
466 /* FLIP sink class. */
467 static const struct case_sink_class flip_sink_class = 
468   {
469     "FLIP",
470     NULL,
471     flip_sink_write,
472     flip_sink_destroy,
473     NULL,
474   };
475
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)
480 {
481   return create_case_source (&flip_source_class, pgm);
482 }
483
484 /* Reads the FLIP stream.  Copies each case into C and calls
485    WRITE_CASE passing WC_DATA. */
486 static void
487 flip_source_read (struct case_source *source,
488                   struct ccase *c,
489                   write_case_func *write_case, write_case_data wc_data)
490 {
491   struct flip_pgm *flip = source->aux;
492   union value *input_buf;
493   int i;
494
495   input_buf = xmalloc (sizeof *input_buf * flip->case_cnt);
496   for (i = 0; i < flip->var_cnt; i++)
497     {
498       size_t j;
499       
500       if (fread (input_buf, sizeof *input_buf, flip->case_cnt,
501                  flip->file) != flip->case_cnt) 
502         {
503           if (ferror (flip->file))
504             msg (SE, _("Error reading FLIP temporary file: %s."),
505                  strerror (errno));
506           else if (feof (flip->file))
507             msg (SE, _("Unexpected end of file reading FLIP temporary file."));
508           else
509             assert (0);
510           break;
511         }
512
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))
516         break;
517     }
518   free (input_buf);
519 }
520
521 /* Destroy internal data in SOURCE. */
522 static void
523 flip_source_destroy (struct case_source *source)
524 {
525   struct flip_pgm *flip = source->aux;
526
527   destroy_flip_pgm (flip);
528 }
529
530 static const struct case_source_class flip_source_class = 
531   {
532     "FLIP",
533     NULL,
534     flip_source_read,
535     flip_source_destroy
536   };