Cope with new location of upstream files
[pspp] / src / language / stats / autorecode.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2009, 2010, 2012, 2013, 2014 Free Software Foundation, Inc.
3
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.
8
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.
13
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/>. */
16
17 #include <config.h>
18
19 #include <float.h>
20 #include <stdlib.h>
21
22 #include "data/case.h"
23 #include "data/casereader.h"
24 #include "data/dataset.h"
25 #include "data/dictionary.h"
26 #include "data/transformations.h"
27 #include "data/variable.h"
28 #include "language/command.h"
29 #include "language/lexer/lexer.h"
30 #include "language/lexer/variable-parser.h"
31 #include "libpspp/array.h"
32 #include "libpspp/compiler.h"
33 #include "libpspp/hash-functions.h"
34 #include "libpspp/hmap.h"
35 #include "libpspp/i18n.h"
36 #include "libpspp/message.h"
37 #include "libpspp/pool.h"
38 #include "libpspp/str.h"
39
40 #include "gl/xalloc.h"
41 #include "gl/c-xvasprintf.h"
42 #include "gl/mbiter.h"
43
44
45 #include "gettext.h"
46 #define _(msgid) gettext (msgid)
47
48 /* FIXME: Implement PRINT subcommand. */
49
50 /* Explains how to recode one value. */
51 struct arc_item
52   {
53     struct hmap_node hmap_node; /* Element in "struct arc_spec" hash table. */
54     union value from;           /* Original value. */
55     int width;                  /* Width of the original value */
56
57     double to;                  /* Recoded value. */
58   };
59
60 /* Explains how to recode an AUTORECODE variable. */
61 struct arc_spec
62   {
63     int width;                  /* Variable width. */
64     int src_idx;                /* Case index of source variable. */
65     struct variable *dst;       /* Target variable. */
66     struct rec_items *items;
67   };
68
69 /* Descending or ascending sort order. */
70 enum arc_direction
71   {
72     ASCENDING,
73     DESCENDING
74   };
75
76 struct rec_items
77 {
78   struct hmap ht;         /* Hash table of "struct arc_item"s. */
79   int refcnt;
80 };
81
82
83
84 /* AUTORECODE data. */
85 struct autorecode_pgm
86 {
87   struct arc_spec *specs;
88   size_t n_specs;
89
90   /* Hash table of "struct arc_item"s. */
91   struct rec_items *global_items;
92
93   bool blank_valid;
94 };
95
96 static trns_proc_func autorecode_trns_proc;
97 static trns_free_func autorecode_trns_free;
98
99 static int compare_arc_items (const void *, const void *, const void *aux);
100 static void arc_free (struct autorecode_pgm *);
101 static struct arc_item *find_arc_item (const struct arc_spec *, const union value *,
102                                        size_t hash);
103
104 static bool
105 value_is_blank (const union value *val, int width, const struct dictionary *dict)
106 {
107   mbi_iterator_t iter;
108   const char *str = CHAR_CAST_BUG (const char*, value_str (val, width));
109   char *text = recode_string (UTF8, dict_get_encoding (dict), str, width);
110
111   for (mbi_init (iter, text, width); mbi_avail (iter); mbi_advance (iter))
112     {
113       mbchar_t c = mbi_cur (iter);
114
115       if ( ! mb_isblank (c))
116         {
117           free (text);
118           return false;
119         }
120     }
121
122   free (text);
123   return true;
124 }
125
126 /* Performs the AUTORECODE procedure. */
127 int
128 cmd_autorecode (struct lexer *lexer, struct dataset *ds)
129 {
130   struct autorecode_pgm *arc = NULL;
131
132   struct dictionary *dict = dataset_dict (ds);
133   const struct variable **src_vars = NULL;
134   char **dst_names = NULL;
135   size_t n_srcs = 0;
136   size_t n_dsts = 0;
137
138   enum arc_direction direction = ASCENDING;
139
140   struct casereader *input;
141   struct ccase *c;
142
143   size_t i;
144   bool ok;
145
146   /* Create procedure. */
147   arc = xzalloc (sizeof *arc);
148   arc->blank_valid = true;
149
150   /* Parse variable lists. */
151   lex_match_id (lexer, "VARIABLES");
152   lex_match (lexer, T_EQUALS);
153   if (!parse_variables_const (lexer, dict, &src_vars, &n_srcs,
154                               PV_NO_DUPLICATE | PV_NO_SCRATCH))
155     goto error;
156   lex_match (lexer, T_SLASH);
157   if (!lex_force_match_id (lexer, "INTO"))
158     goto error;
159   lex_match (lexer, T_EQUALS);
160   if (!parse_DATA_LIST_vars (lexer, dict, &dst_names, &n_dsts,
161                              PV_NO_DUPLICATE))
162     goto error;
163   if (n_dsts != n_srcs)
164     {
165       msg (SE, _("Source variable count (%zu) does not match "
166                  "target variable count (%zu)."),
167            n_srcs, n_dsts);
168
169       goto error;
170     }
171   for (i = 0; i < n_dsts; i++)
172     {
173       const char *name = dst_names[i];
174
175       if (dict_lookup_var (dict, name) != NULL)
176         {
177           msg (SE, _("Target variable %s duplicates existing variable %s."),
178                name, name);
179           goto error;
180         }
181     }
182
183   /* Parse options. */
184   while (lex_match (lexer, T_SLASH))
185     {
186       if (lex_match_id (lexer, "DESCENDING"))
187         direction = DESCENDING;
188       else if (lex_match_id (lexer, "PRINT"))
189         {
190           /* Not yet implemented. */
191         }
192       else if (lex_match_id (lexer, "GROUP"))
193         {
194           arc->global_items = xmalloc (sizeof (*arc->global_items));
195           arc->global_items->refcnt = 1;
196           hmap_init (&arc->global_items->ht);
197         }
198       else if (lex_match_id (lexer, "BLANK"))
199         {
200           lex_match (lexer, T_EQUALS);
201           if (lex_match_id (lexer, "VALID"))
202             {
203               arc->blank_valid = true;
204             }
205           else if (lex_match_id (lexer, "MISSING"))
206             {
207               arc->blank_valid = false;
208             }
209           else
210             goto error;
211         }
212       else
213         goto error;
214     }
215
216   if (lex_token (lexer) != T_ENDCMD)
217     {
218       lex_error (lexer, _("expecting end of command"));
219       goto error;
220     }
221
222   arc->specs = xmalloc (n_dsts * sizeof *arc->specs);
223   arc->n_specs = n_dsts;
224
225
226   for (i = 0; i < n_dsts; i++)
227     {
228       struct arc_spec *spec = &arc->specs[i];
229
230       spec->width = var_get_width (src_vars[i]);
231       spec->src_idx = var_get_case_index (src_vars[i]);
232
233       if (arc->global_items)
234         {
235           arc->global_items->refcnt++;
236           spec->items = arc->global_items;
237         }
238       else
239         {
240           spec->items = xzalloc (sizeof (*spec->items));
241           spec->items->refcnt = 1;
242           hmap_init (&spec->items->ht);
243         }
244     }
245
246
247   /* Execute procedure. */
248   input = proc_open (ds);
249   for (; (c = casereader_read (input)) != NULL; case_unref (c))
250     for (i = 0; i < arc->n_specs; i++)
251       {
252         struct arc_spec *spec = &arc->specs[i];
253         int width = spec->width;
254         const union value *value = case_data_idx (c, spec->src_idx);
255         size_t hash = value_hash (value, width, 0);
256         struct arc_item *item;
257
258         item = find_arc_item (spec, value, hash);
259         if ( (item == NULL)
260              &&
261              ( arc->blank_valid
262                || val_type_from_width (spec->width) == VAL_NUMERIC
263                || ! value_is_blank (value, width, dict))
264              )
265           {
266             item = xmalloc (sizeof *item);
267             item->width = width;
268             value_clone (&item->from, value, width);
269             hmap_insert (&spec->items->ht, &item->hmap_node, hash);
270           }
271       }
272   ok = casereader_destroy (input);
273   ok = proc_commit (ds) && ok;
274
275   /* Re-fetch dictionary because it might have changed (if TEMPORARY was in
276      use). */
277   dict = dataset_dict (ds);
278
279   /* Create transformation. */
280   for (i = 0; i < arc->n_specs; i++)
281     {
282       struct arc_spec *spec = &arc->specs[i];
283       struct arc_item **items;
284       struct arc_item *item;
285       size_t n_items;
286       size_t j;
287
288       /* Create destination variable. */
289       spec->dst = dict_create_var_assert (dict, dst_names[i], 0);
290
291       /* Create array of pointers to items. */
292       n_items = hmap_count (&spec->items->ht);
293       items = xmalloc (n_items * sizeof *items);
294       j = 0;
295       HMAP_FOR_EACH (item, struct arc_item, hmap_node, &spec->items->ht)
296         items[j++] = item;
297
298       assert (j == n_items);
299
300       /* Sort array by value. */
301       sort (items, n_items, sizeof *items, compare_arc_items, NULL);
302
303       /* Assign recoded values in sorted order. */
304       for (j = 0; j < n_items; j++)
305         {
306           const union value *from = &items[j]->from;
307           char *recoded_value  = NULL;
308           const int src_width = items[j]->width;
309           union value to_val;
310           size_t len;
311
312           value_init (&to_val, 0);
313
314           items[j]->to = direction == ASCENDING ? j + 1 : n_items - j;
315
316           to_val.f = items[j]->to;
317
318           /* Add value labels to the destination variable which indicate
319              the source value from whence the new value comes. */
320           if (src_width > 0)
321             {
322               const char *str = CHAR_CAST_BUG (const char*, value_str (from, src_width));
323
324               recoded_value = recode_string (UTF8, dict_get_encoding (dict),
325                                              str, src_width);
326             }
327           else
328             recoded_value = c_xasprintf ("%.*g", DBL_DIG + 1, from->f);
329
330           /* Remove trailing whitespace */
331           len = strlen (recoded_value);
332           while (len > 0 && recoded_value[len - 1] == ' ')
333             recoded_value[--len] = '\0';
334
335           var_add_value_label (spec->dst, &to_val, recoded_value);
336           value_destroy (&to_val, 0);
337           free (recoded_value);
338         }
339
340       /* Free array. */
341       free (items);
342     }
343   add_transformation (ds, autorecode_trns_proc, autorecode_trns_free, arc);
344
345   for (i = 0; i < n_dsts; i++)
346     free (dst_names[i]);
347   free (dst_names);
348   free (src_vars);
349
350   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
351
352 error:
353   for (i = 0; i < n_dsts; i++)
354     free (dst_names[i]);
355   free (dst_names);
356   free (src_vars);
357   arc_free (arc);
358   return CMD_CASCADING_FAILURE;
359 }
360
361 static void
362 arc_free (struct autorecode_pgm *arc)
363 {
364   if (arc != NULL)
365     {
366       size_t i;
367
368       for (i = 0; i < arc->n_specs; i++)
369         {
370           struct arc_spec *spec = &arc->specs[i];
371           struct arc_item *item, *next;
372
373           HMAP_FOR_EACH_SAFE (item, next, struct arc_item, hmap_node,
374                               &spec->items->ht)
375             {
376               value_destroy (&item->from, item->width);
377               hmap_delete (&spec->items->ht, &item->hmap_node);
378               free (item);
379             }
380         }
381
382       for (i = 0; i < arc->n_specs; i++)
383         {
384           struct arc_spec *spec = &arc->specs[i];
385
386           if (--spec->items->refcnt == 0)
387             {
388               hmap_destroy (&spec->items->ht);
389               free (spec->items);
390             }
391         }
392
393       if (arc->global_items && --arc->global_items->refcnt == 0)
394         {
395           hmap_destroy (&arc->global_items->ht);
396           free (arc->global_items);
397         }
398
399       free (arc->specs);
400       free (arc);
401     }
402 }
403
404 static struct arc_item *
405 find_arc_item (const struct arc_spec *spec, const union value *value,
406                size_t hash)
407 {
408   struct arc_item *item;
409
410   HMAP_FOR_EACH_WITH_HASH (item, struct arc_item, hmap_node, hash, &spec->items->ht)
411     if (value_equal (value, &item->from, spec->width))
412       return item;
413   return NULL;
414 }
415
416 static int
417 compare_arc_items (const void *a_, const void *b_, const void *aux UNUSED)
418 {
419   const struct arc_item *const *a = a_;
420   const struct arc_item *const *b = b_;
421   int width_a = (*a)->width;
422   int width_b = (*b)->width;
423
424   if ( width_a == width_b)
425     return value_compare_3way (&(*a)->from, &(*b)->from, width_a);
426
427   if ( width_a == 0 && width_b != 0)
428     return -1;
429
430   if ( width_b == 0 && width_a != 0)
431     return +1;
432
433   return buf_compare_rpad (CHAR_CAST_BUG (const char *, value_str (&(*a)->from, width_a)), width_a,
434                            CHAR_CAST_BUG (const char *, value_str (&(*b)->from, width_b)), width_b);
435 }
436
437 static int
438 autorecode_trns_proc (void *arc_, struct ccase **c,
439                       casenumber case_idx UNUSED)
440 {
441   struct autorecode_pgm *arc = arc_;
442   size_t i;
443
444   *c = case_unshare (*c);
445   for (i = 0; i < arc->n_specs; i++)
446     {
447       const struct arc_spec *spec = &arc->specs[i];
448       const union value *value = case_data_idx (*c, spec->src_idx);
449       unsigned int hash = value_hash (value, spec->width, 0);
450       const struct arc_item *item = find_arc_item (spec, value, hash);
451
452       case_data_rw (*c, spec->dst)->f = item ? item->to : SYSMIS;
453     }
454
455   return TRNS_CONTINUE;
456 }
457
458 static bool
459 autorecode_trns_free (void *arc_)
460 {
461   struct autorecode_pgm *arc = arc_;
462
463   arc_free (arc);
464   return true;
465 }