First step in making struct variable opaque: the boring mechanical
[pspp-builds.git] / src / language / stats / rank.q
index 59846c85bf20f27903bb280a87a0ae769db55163..12024239f09ca5666739986d98acf1892a96b0ad 100644 (file)
@@ -117,7 +117,7 @@ static const struct fmt_spec dest_format[n_RANK_FUNCS] = {
   {FMT_F, 8, 4}  /* savage */
 };
 
-static const char *function_name[n_RANK_FUNCS] = {
+static const char * const function_name[n_RANK_FUNCS] = {
   "RANK",
   "NORMAL",
   "PERCENT",
@@ -128,7 +128,7 @@ static const char *function_name[n_RANK_FUNCS] = {
   "SAVAGE"
 };
 
-static rank_function_t rank_func[n_RANK_FUNCS] = {
+static const rank_function_t rank_func[n_RANK_FUNCS] = {
   rank_rank,
   rank_normal,
   rank_percent,
@@ -148,7 +148,7 @@ struct rank_spec
 
 
 /* Function to use for testing for missing values */
-static is_missing_func *value_is_missing;
+static mv_is_missing_func *value_is_missing;
 
 static struct rank_spec *rank_specs;
 static size_t n_rank_specs;
@@ -168,6 +168,7 @@ static struct cmd_rank cmd;
 
 static struct casefile *rank_sorted_casefile (struct casefile *cf, 
                                              const struct sort_criteria *, 
+                                             const struct dictionary *,
                                              const struct rank_spec *rs, 
                                              int n_rank_specs,
                                              int idx,
@@ -215,44 +216,45 @@ create_var_label (struct variable *dest_var,
       for (g = 0 ; g < n_group_vars ; ++g ) 
        {
          if ( g > 0 ) ds_put_cstr (&group_var_str, " ");
-         ds_put_cstr (&group_var_str, group_vars[g]->name);
+         ds_put_cstr (&group_var_str, var_get_name (group_vars[g]));
        }
 
       ds_put_format (&label, _("%s of %s by %s"), function_name[f], 
-                    src_var->name, ds_cstr (&group_var_str));
+                    var_get_name (src_var), ds_cstr (&group_var_str));
       ds_destroy (&group_var_str);
     }
   else
-    ds_put_format (&label,_("%s of %s"), function_name[f], src_var->name);  
+    ds_put_format (&label, _("%s of %s"),
+                   function_name[f], var_get_name (src_var));  
 
-  dest_var->label = strdup (ds_cstr (&label) );
+  var_set_label (dest_var, ds_cstr (&label));
 
   ds_destroy (&label);
 }
 
 
 static bool 
-rank_cmd (const struct sort_criteria *sc, 
-      const struct rank_spec *rank_specs, int n_rank_specs)
+rank_cmd (struct dataset *ds, const struct sort_criteria *sc, 
+         const struct rank_spec *rank_specs, int n_rank_specs)
 {
   struct sort_criteria criteria;
   bool result = true;
   int i;
-  const int n_splits = dict_get_split_cnt (default_dict);
+  const int n_splits = dict_get_split_cnt (dataset_dict (ds));
 
   criteria.crit_cnt = n_splits + n_group_vars + 1;
   criteria.crits = xnmalloc (criteria.crit_cnt, sizeof *criteria.crits);
   for (i = 0; i < n_splits ; i++) 
     {
-      struct variable *v = dict_get_split_vars (default_dict)[i];
+      struct variable *v = dict_get_split_vars (dataset_dict (ds))[i];
       criteria.crits[i].fv = v->fv;
-      criteria.crits[i].width = v->width;
+      criteria.crits[i].width = var_get_width (v);
       criteria.crits[i].dir = SRT_ASCEND;
     }
   for (i = 0; i < n_group_vars; i++) 
     {
       criteria.crits[i + n_splits].fv = group_vars[i]->fv;
-      criteria.crits[i + n_splits].width = group_vars[i]->width;
+      criteria.crits[i + n_splits].width = var_get_width (group_vars[i]);
       criteria.crits[i + n_splits].dir = SRT_ASCEND;
     }
   for (i = 0 ; i < sc->crit_cnt ; ++i )
@@ -263,10 +265,10 @@ rank_cmd (const struct sort_criteria *sc,
       struct casefile *sorted_cf ;
 
       /* Obtain active file in CF. */
-      if (!procedure (NULL, NULL))
+      if (!procedure (ds, NULL, NULL))
        goto error;
 
-      cf = proc_capture_output ();
+      cf = proc_capture_output (ds);
 
       /* Sort CF into SORTED_CF. */
       reader = casefile_get_destructive_reader (cf) ;
@@ -276,15 +278,16 @@ rank_cmd (const struct sort_criteria *sc,
       casefile_destroy (cf);
 
       out = rank_sorted_casefile (sorted_cf, &criteria,
+                                 dataset_dict (ds),
                                   rank_specs, n_rank_specs, 
-                                 i, &src_vars[i]->miss)  ;
+                                 i, var_get_missing_values (src_vars[i]));
       if ( NULL == out ) 
        {
          result = false ;
          continue ;
        }
       
-      proc_set_source (storage_source_create (out));
+      proc_set_source (ds, storage_source_create (out));
     }
 
   free (criteria.crits);
@@ -487,6 +490,7 @@ rank_savage (double c, double cc, double cc_1,
 static void
 rank_cases (struct casereader *cr,
            unsigned long end,
+           const struct dictionary *dict,
            const struct sort_criterion *criterion,
            const struct missing_values *mv,
            double w,
@@ -516,7 +520,7 @@ rank_cases (struct casereader *cr,
         break;
       
       this_value = case_data (&this_case, fv);
-      c = dict_get_case_weight (default_dict, &this_case, &warn);
+      c = dict_get_case_weight (dict, &this_case, &warn);
               
       lookahead = casereader_clone (cr);
       n = 0;
@@ -535,7 +539,7 @@ rank_cases (struct casereader *cr,
               break; 
             }
 
-          c += dict_get_case_weight (default_dict, &lookahead_case, &warn);
+          c += dict_get_case_weight (dict, &lookahead_case, &warn);
           case_destroy (&lookahead_case);
           n++;
         }
@@ -589,13 +593,14 @@ same_group (const struct ccase *a, const struct ccase *b,
 static struct casefile *
 rank_sorted_casefile (struct casefile *cf, 
                      const struct sort_criteria *crit, 
+                     const struct dictionary *dict,
                      const struct rank_spec *rs, 
                      int n_rank_specs, 
                      int dest_idx, 
                      const struct missing_values *mv)
 {
   struct casefile *dest = fastfile_create (casefile_get_value_cnt (cf));
-  struct casereader *lookahead = casefile_get_reader (cf);
+  struct casereader *lookahead = casefile_get_reader (cf, NULL);
   struct casereader *pos = casereader_clone (lookahead);
   struct ccase group_case;
   bool warn = true;
@@ -610,28 +615,32 @@ rank_sorted_casefile (struct casefile *cf,
       this_value = case_data( &group_case, ultimate_crit->fv);
 
       if ( !value_is_missing(mv, this_value) )
-       w = dict_get_case_weight (default_dict, &group_case, &warn);
+       w = dict_get_case_weight (dict, &group_case, &warn);
 
       while (casereader_read (lookahead, &this_case)) 
         {
          const union value *this_value = 
            case_data(&this_case, ultimate_crit->fv);
-          double c = dict_get_case_weight (default_dict, &this_case, &warn);
+          double c = dict_get_case_weight (dict, &this_case, &warn);
           if (!same_group (&group_case, &this_case, crit)) 
             {
               rank_cases (pos, casereader_cnum (lookahead) - 1,
+                         dict,
                          ultimate_crit, 
                          mv, w, 
                          rs, n_rank_specs, 
                          dest_idx, dest);
 
               w = 0.0;
+              case_destroy (&group_case);
               case_move (&group_case, &this_case);
             }
          if ( !value_is_missing (mv, this_value) )
            w += c;
+          case_destroy (&this_case);
         }
-      rank_cases (pos, ULONG_MAX, ultimate_crit, mv, w,
+      case_destroy (&group_case);
+      rank_cases (pos, ULONG_MAX, dict, ultimate_crit, mv, w,
                  rs, n_rank_specs, dest_idx, dest);
     }
 
@@ -648,7 +657,7 @@ rank_sorted_casefile (struct casefile *cf,
 
 /* Transformation function to enumerate all the cases */
 static int 
-create_resort_key (void *key_var_, struct ccase *cc, casenum_t case_num)
+create_resort_key (void *key_var_, struct ccase *cc, casenumber case_num)
 {
   struct variable *key_var = key_var_;
 
@@ -664,7 +673,7 @@ create_resort_key (void *key_var_, struct ccase *cc, casenum_t case_num)
    If VNAME is NULL, then a name will be automatically chosen.
  */
 static struct variable *
-create_rank_variable (enum RANK_FUNC f, 
+create_rank_variable (struct dictionary *dict, enum RANK_FUNC f, 
                      const struct variable *src_var, 
                      const char *vname)
 {
@@ -673,14 +682,14 @@ create_rank_variable (enum RANK_FUNC f,
   char name[SHORT_NAME_LEN + 1];
 
   if ( vname ) 
-    var = dict_create_var(default_dict, vname, 0);
+    var = dict_create_var(dict, vname, 0);
 
   if ( NULL == var )
     {
-      snprintf(name, SHORT_NAME_LEN + 1, "%c%s", 
-              function_name[f][0], src_var->name);
+      snprintf (name, SHORT_NAME_LEN + 1, "%c%s", 
+                function_name[f][0], var_get_name (src_var));
   
-      var = dict_create_var(default_dict, name, 0);
+      var = dict_create_var(dict, name, 0);
     }
 
   i = 1;
@@ -691,7 +700,7 @@ create_rank_variable (enum RANK_FUNC f,
       snprintf(name, SHORT_NAME_LEN + 1, "%s%03d", func_abb, 
               i);
 
-      var = dict_create_var(default_dict, name, 0);
+      var = dict_create_var(dict, name, 0);
       if (i++ >= 999) 
        break;
     }
@@ -705,7 +714,7 @@ create_rank_variable (enum RANK_FUNC f,
       snprintf(name, SHORT_NAME_LEN + 1, 
               "RNK%s%02d", func_abb, i);
 
-      var = dict_create_var(default_dict, name, 0);
+      var = dict_create_var(dict, name, 0);
       if ( i++ >= 99 ) 
        break;
     }
@@ -716,12 +725,11 @@ create_rank_variable (enum RANK_FUNC f,
       return NULL;
     }
 
-  var->write = var->print = dest_format[f];
+  var_set_both_formats (var, &dest_format[f]); 
 
   return var;
 }
 
-int cmd_rank(void);
 
 static void
 rank_cleanup(void)
@@ -750,14 +758,14 @@ rank_cleanup(void)
 }
 
 int
-cmd_rank(void)
+cmd_rank (struct lexer *lexer, struct dataset *ds)
 {
   bool result;
   struct variable *order;
   size_t i;
   n_rank_specs = 0;
 
-  if ( !parse_rank(&cmd, NULL) )
+  if ( !parse_rank (lexer, ds, &cmd, NULL) )
     {
       rank_cleanup ();
     return CMD_FAILURE;
@@ -799,7 +807,7 @@ cmd_rank(void)
          if ( rank_specs[i].destvars[v] == NULL ) 
            {
              rank_specs[i].destvars[v] = 
-               create_rank_variable (rank_specs[i].rfunc, src_vars[v], NULL);
+               create_rank_variable (dataset_dict(ds), rank_specs[i].rfunc, src_vars[v], NULL);
            }
       
          create_var_label ( rank_specs[i].destvars[v],
@@ -827,7 +835,7 @@ cmd_rank(void)
                  ds_init_empty (&varlist);
                  for ( g = 0 ; g < n_group_vars ; ++g ) 
                    {
-                     ds_put_cstr (&varlist, group_vars[g]->name);
+                     ds_put_cstr (&varlist, var_get_name (group_vars[g]));
 
                      if ( g < n_group_vars - 1)
                        ds_put_cstr (&varlist, " ");
@@ -837,10 +845,10 @@ cmd_rank(void)
                       rank_specs[i].rfunc == PROPORTION ) 
                    tab_output_text (TAT_PRINTF,
                                     _("%s into %s(%s of %s using %s BY %s)"), 
-                                    src_vars[v]->name,
-                                    rank_specs[i].destvars[v]->name,
+                                    var_get_name (src_vars[v]),
+                                    var_get_name (rank_specs[i].destvars[v]),
                                     function_name[rank_specs[i].rfunc],
-                                    src_vars[v]->name,
+                                    var_get_name (src_vars[v]),
                                     fraction_name(),
                                     ds_cstr (&varlist)
                                     );
@@ -848,10 +856,10 @@ cmd_rank(void)
                  else
                    tab_output_text (TAT_PRINTF,
                                     _("%s into %s(%s of %s BY %s)"), 
-                                    src_vars[v]->name,
-                                    rank_specs[i].destvars[v]->name,
+                                    var_get_name (src_vars[v]),
+                                    var_get_name (rank_specs[i].destvars[v]),
                                     function_name[rank_specs[i].rfunc],
-                                    src_vars[v]->name,
+                                    var_get_name (src_vars[v]),
                                     ds_cstr (&varlist)
                                     );
                  ds_destroy (&varlist);
@@ -862,20 +870,20 @@ cmd_rank(void)
                       rank_specs[i].rfunc == PROPORTION ) 
                    tab_output_text (TAT_PRINTF,
                                     _("%s into %s(%s of %s using %s)"), 
-                                    src_vars[v]->name,
-                                    rank_specs[i].destvars[v]->name,
+                                    var_get_name (src_vars[v]),
+                                    var_get_name (rank_specs[i].destvars[v]),
                                     function_name[rank_specs[i].rfunc],
-                                    src_vars[v]->name,
+                                    var_get_name (src_vars[v]),
                                     fraction_name()
                                     );
                    
                  else
                    tab_output_text (TAT_PRINTF,
                                     _("%s into %s(%s of %s)"), 
-                                    src_vars[v]->name,
-                                    rank_specs[i].destvars[v]->name,
+                                    var_get_name (src_vars[v]),
+                                    var_get_name (rank_specs[i].destvars[v]),
                                     function_name[rank_specs[i].rfunc],
-                                    src_vars[v]->name
+                                    var_get_name (src_vars[v])
                                     );
                }
            }
@@ -888,12 +896,12 @@ cmd_rank(void)
 
   /* Add a variable which we can sort by to get back the original
      order */
-  order = dict_create_var_assert (default_dict, "$ORDER_", 0);
+  order = dict_create_var_assert (dataset_dict (ds), "$ORDER_", 0);
 
-  add_transformation (create_resort_key, 0, order);
+  add_transformation (ds, create_resort_key, 0, order);
 
   /* Do the ranking */
-  result = rank_cmd (sc, rank_specs, n_rank_specs);
+  result = rank_cmd (ds, sc, rank_specs, n_rank_specs);
 
   /* Put the active file back in its original order */
   {
@@ -906,11 +914,11 @@ cmd_rank(void)
     criteria.crits = &restore_criterion;
     criteria.crit_cnt = 1;
     
-    sort_active_file_in_place (&criteria);
+    sort_active_file_in_place (ds, &criteria);
 }
 
   /* ... and we don't need our sort key anymore. So delete it */
-  dict_delete_var (default_dict, order);
+  dict_delete_var (dataset_dict (ds), order);
 
   rank_cleanup();
 
@@ -921,27 +929,28 @@ cmd_rank(void)
 /* Parser for the variables sub command  
    Returns 1 on success */
 static int
-rank_custom_variables(struct cmd_rank *cmd UNUSED, void *aux UNUSED)
+rank_custom_variables (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd UNUSED, void *aux UNUSED)
 {
   static const int terminators[2] = {T_BY, 0};
 
-  lex_match('=');
+  lex_match (lexer, '=');
 
-  if ((token != T_ID || dict_lookup_var (default_dict, tokid) == NULL)
-      && token != T_ALL)
+  if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL)
+      && lex_token (lexer) != T_ALL)
       return 2;
 
-  sc = sort_parse_criteria (default_dict
+  sc = sort_parse_criteria (lexer, dataset_dict (ds)
                            &src_vars, &n_src_vars, 0, terminators);
 
-  if ( lex_match(T_BY)  )
+  if ( lex_match (lexer, T_BY)  )
     {
-      if ((token != T_ID || dict_lookup_var (default_dict, tokid) == NULL))
+      if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL))
        {
          return 2;
        }
 
-      if (!parse_variables (default_dict, &group_vars, &n_group_vars,
+      if (!parse_variables (lexer, dataset_dict (ds), 
+                           &group_vars, &n_group_vars,
                            PV_NO_DUPLICATE | PV_NUMERIC | PV_NO_SCRATCH) )
        {
          free (group_vars);
@@ -955,7 +964,7 @@ rank_custom_variables(struct cmd_rank *cmd UNUSED, void *aux UNUSED)
 
 /* Parse the [/rank INTO var1 var2 ... varN ] clause */
 static int
-parse_rank_function(struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
+parse_rank_function (struct lexer *lexer, struct dictionary *dict, struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
 {
   int var_count = 0;
   
@@ -967,16 +976,16 @@ parse_rank_function(struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
   rank_specs[n_rank_specs - 1].destvars = 
            xcalloc (sc->crit_cnt, sizeof (struct variable *));
          
-  if (lex_match_id("INTO"))
+  if (lex_match_id (lexer, "INTO"))
     {
       struct variable *destvar;
 
-      while( token == T_ID ) 
+      while( lex_token (lexer) == T_ID ) 
        {
 
-         if ( dict_lookup_var (default_dict, tokid) != NULL )
+         if ( dict_lookup_var (dict, lex_tokid (lexer)) != NULL )
            {
-             msg(SE, _("Variable %s already exists."), tokid);
+             msg(SE, _("Variable %s already exists."), lex_tokid (lexer));
              return 0;
            }
          if ( var_count >= sc->crit_cnt ) 
@@ -985,10 +994,10 @@ parse_rank_function(struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
              return 0;
            }
 
-         destvar = create_rank_variable (f, src_vars[var_count], tokid);
+         destvar = create_rank_variable (dict, f, src_vars[var_count], lex_tokid (lexer));
          rank_specs[n_rank_specs - 1].destvars[var_count] = destvar ;
 
-         lex_get();
+         lex_get (lexer);
          ++var_count;
        }
     }
@@ -998,58 +1007,74 @@ parse_rank_function(struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
 
 
 static int
-rank_custom_rank(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_rank (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function(cmd, RANK);
+  struct dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, RANK);
 }
 
 static int
-rank_custom_normal(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_normal (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function(cmd, NORMAL);
+  struct  dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, NORMAL);
 }
 
 static int
-rank_custom_percent(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_percent (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function (cmd, PERCENT);
+  struct dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, PERCENT);
 }
 
 static int
-rank_custom_rfraction(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_rfraction (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function(cmd, RFRACTION);
+  struct dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, RFRACTION);
 }
 
 static int
-rank_custom_proportion(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_proportion (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function(cmd, PROPORTION);
+  struct dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, PROPORTION);
 }
 
 static int
-rank_custom_n(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_n (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function(cmd, N);
+  struct dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, N);
 }
 
 static int
-rank_custom_savage(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_savage (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  return parse_rank_function(cmd, SAVAGE);
+  struct dictionary *dict = dataset_dict (ds);
+
+  return parse_rank_function (lexer, dict, cmd, SAVAGE);
 }
 
 
 static int
-rank_custom_ntiles(struct cmd_rank *cmd, void *aux UNUSED )
+rank_custom_ntiles (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 {
-  if ( lex_force_match('(') ) 
+  struct dictionary *dict = dataset_dict (ds);
+
+  if ( lex_force_match (lexer, '(') ) 
     {
-      if ( lex_force_int() ) 
+      if ( lex_force_int (lexer) ) 
        {
-         k_ntiles = lex_integer ();
-         lex_get();
-         lex_force_match(')');
+         k_ntiles = lex_integer (lexer);
+         lex_get (lexer);
+         lex_force_match (lexer, ')');
        }
       else
        return 0;
@@ -1057,5 +1082,5 @@ rank_custom_ntiles(struct cmd_rank *cmd, void *aux UNUSED )
   else
     return 0;
 
-  return parse_rank_function(cmd, NTILES);
+  return parse_rank_function (lexer, dict, cmd, NTILES);
 }