+++ /dev/null
-/* PSPP - a program for statistical analysis.
- Copyright (C) 1997-9, 2000, 2010, 2011, 2012 Free Software Foundation, Inc.
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>. */
-
-#include <config.h>
-
-#include <stdlib.h>
-
-#include "data/dataset.h"
-#include "data/dictionary.h"
-#include "data/variable.h"
-#include "language/command.h"
-#include "language/lexer/lexer.h"
-#include "language/lexer/variable-parser.h"
-#include "libpspp/array.h"
-#include "libpspp/assertion.h"
-#include "libpspp/compiler.h"
-#include "libpspp/i18n.h"
-#include "libpspp/message.h"
-#include "libpspp/misc.h"
-#include "libpspp/str.h"
-
-#include "gl/xalloc.h"
-
-#include "gettext.h"
-#define _(msgid) gettext (msgid)
-
-/* These control the ordering produced by
- compare_variables_given_ordering(). */
-struct ordering
- {
- bool forward; /* true=FORWARD, false=BACKWARD. */
- bool positional; /* true=POSITIONAL, false=ALPHA. */
- };
-
-/* Increasing order of variable index. */
-static struct ordering forward_positional_ordering = {1, 1};
-
-static int compare_variables_given_ordering (const void *, const void *,
- const void *ordering);
-
-/* Explains how to modify the variables in a dictionary. */
-struct var_modification
- {
- /* New variable ordering. */
- struct variable **reorder_vars;
- size_t n_reorder;
-
- /* DROP/KEEP information. */
- struct variable **drop_vars;
- size_t n_drop;
-
- /* New variable names. */
- struct variable **rename_vars;
- char **new_names;
- size_t n_rename;
- };
-
-static bool rearrange_dict (struct dictionary *d,
- const struct var_modification *vm);
-
-/* Performs MODIFY VARS command. */
-int
-cmd_modify_vars (struct lexer *lexer, struct dataset *ds)
-{
- if (proc_make_temporary_transformations_permanent (ds))
- lex_ofs_error (lexer, 0, lex_ofs (lexer) - 1,
- _("%s may not be used after %s. "
- "Temporary transformations will be made permanent."),
- "MODIFY VARS", "TEMPORARY");
-
- /* Bits indicated whether we've already encountered a subcommand of this
- type. */
- unsigned int already_encountered = 0;
-
- /* Return code. */
- int ret_code = CMD_CASCADING_FAILURE;
-
- /* What we are going to do to the active dataset. */
- struct var_modification vm =
- {
- .reorder_vars = NULL,
- .n_reorder = 0,
- .rename_vars = NULL,
- .new_names = NULL,
- .n_rename = 0,
- .drop_vars = NULL,
- .n_drop = 0,
- };
-
- /* Parse each subcommand. */
- lex_match (lexer, T_SLASH);
- for (;;)
- {
- if (lex_match_id (lexer, "REORDER"))
- {
- if (already_encountered & 1)
- {
- lex_sbc_only_once (lexer, "REORDER");
- goto done;
- }
- already_encountered |= 1;
-
- struct variable **v = NULL;
- size_t nv = 0;
-
- lex_match (lexer, T_EQUALS);
- do
- {
- struct ordering ordering;
- size_t prev_nv = nv;
-
- ordering.forward = ordering.positional = true;
- for (;;)
- {
- if (lex_match_id (lexer, "FORWARD"))
- ordering.forward = true;
- else if (lex_match_id (lexer, "BACKWARD"))
- ordering.forward = false;
- else if (lex_match_id (lexer, "POSITIONAL"))
- ordering.positional = true;
- else if (lex_match_id (lexer, "ALPHA"))
- ordering.positional = false;
- else
- break;
- }
-
- if (lex_match (lexer, T_ALL)
- || lex_token (lexer) == T_SLASH
- || lex_token (lexer) == T_ENDCMD)
- {
- if (prev_nv != 0)
- {
- msg (SE, _("Cannot specify ALL after specifying a set "
- "of variables."));
- goto done;
- }
- dict_get_vars_mutable (dataset_dict (ds), &v, &nv,
- DC_SYSTEM);
- }
- else
- {
- if (!lex_match (lexer, T_LPAREN))
- {
- lex_error_expecting (lexer, "`('");
- free (v);
- goto done;
- }
- if (!parse_variables (lexer, dataset_dict (ds), &v, &nv,
- PV_APPEND | PV_NO_DUPLICATE))
- {
- free (v);
- goto done;
- }
- if (!lex_match (lexer, T_RPAREN))
- {
- lex_error_expecting (lexer, "`)'");
- free (v);
- goto done;
- }
- }
-
- if (!ordering.positional)
- sort (&v[prev_nv], nv - prev_nv, sizeof *v,
- compare_variables_given_ordering, &ordering);
- else if (!ordering.forward)
- reverse_array(&v[prev_nv], nv - prev_nv, sizeof *v);
- }
- while (lex_token (lexer) != T_SLASH
- && lex_token (lexer) != T_ENDCMD);
-
- vm.reorder_vars = v;
- vm.n_reorder = nv;
- }
- else if (lex_match_id (lexer, "RENAME"))
- {
- if (already_encountered & 2)
- {
- lex_sbc_only_once (lexer, "RENAME");
- goto done;
- }
- already_encountered |= 2;
-
- lex_match (lexer, T_EQUALS);
- do
- {
- size_t prev_nv_1 = vm.n_rename;
- size_t prev_nv_2 = vm.n_rename;
-
- if (!lex_match (lexer, T_LPAREN))
- {
- lex_error_expecting (lexer, "`('");
- goto done;
- }
- if (!parse_variables (lexer, dataset_dict (ds),
- &vm.rename_vars, &vm.n_rename,
- PV_APPEND | PV_NO_DUPLICATE))
- goto done;
- if (!lex_match (lexer, T_EQUALS))
- {
- lex_error_expecting (lexer, "`='");
- goto done;
- }
-
- if (!parse_DATA_LIST_vars (lexer, dataset_dict (ds),
- &vm.new_names, &prev_nv_1, PV_APPEND))
- goto done;
- if (prev_nv_1 != vm.n_rename)
- {
- msg (SE, _("Differing number of variables in old name list "
- "(%zu) and in new name list (%zu)."),
- vm.n_rename - prev_nv_2, prev_nv_1 - prev_nv_2);
- for (size_t i = 0; i < prev_nv_1; i++)
- free (vm.new_names[i]);
- free (vm.new_names);
- vm.new_names = NULL;
- goto done;
- }
- if (!lex_match (lexer, T_RPAREN))
- {
- lex_error_expecting (lexer, "`)'");
- goto done;
- }
- }
- while (lex_token (lexer) != T_ENDCMD
- && lex_token (lexer) != T_SLASH);
- }
- else if (lex_match_id (lexer, "KEEP"))
- {
- if (already_encountered & 4)
- {
- lex_next_error (lexer, -1, -1,
- _("%s subcommand may be given at most once. "
- "It may not be given in conjunction with the "
- "%s subcommand."),
- "KEEP", "DROP");
- goto done;
- }
- already_encountered |= 4;
-
- struct variable **keep_vars, **drop_vars;
- size_t n_keep, n_drop;
- lex_match (lexer, T_EQUALS);
- if (!parse_variables (lexer, dataset_dict (ds),
- &keep_vars, &n_keep, PV_NONE))
- goto done;
-
- /* Transform the list of variables to keep into a list of
- variables to drop. First sort the keep list, then figure
- out which variables are missing. */
- sort (keep_vars, n_keep, sizeof *keep_vars,
- compare_variables_given_ordering,
- &forward_positional_ordering);
-
- struct variable **all_vars;
- size_t n_all;
- dict_get_vars_mutable (dataset_dict (ds), &all_vars, &n_all, 0);
- assert (n_all >= n_keep);
-
- n_drop = n_all - n_keep;
- drop_vars = xnmalloc (n_drop, sizeof *keep_vars);
- if (set_difference (all_vars, n_all,
- keep_vars, n_keep,
- sizeof *all_vars,
- drop_vars,
- compare_variables_given_ordering,
- &forward_positional_ordering)
- != n_drop)
- NOT_REACHED ();
-
- free (keep_vars);
- free (all_vars);
-
- vm.drop_vars = drop_vars;
- vm.n_drop = n_drop;
- }
- else if (lex_match_id (lexer, "DROP"))
- {
- struct variable **drop_vars;
- size_t n_drop;
-
- if (already_encountered & 4)
- {
- lex_next_error (lexer, -1, -1,
- _("%s subcommand may be given at most once. "
- "It may not be given in conjunction with the "
- "%s subcommand."),
- "DROP", "KEEP"
- );
- goto done;
- }
- already_encountered |= 4;
-
- int start_ofs = lex_ofs (lexer) - 1;
- lex_match (lexer, T_EQUALS);
- if (!parse_variables (lexer, dataset_dict (ds),
- &drop_vars, &n_drop, PV_NONE))
- goto done;
- int end_ofs = lex_ofs (lexer) - 1;
- vm.drop_vars = drop_vars;
- vm.n_drop = n_drop;
-
- if (n_drop == dict_get_n_vars (dataset_dict (ds)))
- {
- lex_ofs_error (lexer, start_ofs, end_ofs,
- _("%s may not be used to delete all variables "
- "from the active dataset dictionary. "
- "Use %s instead."), "MODIFY VARS", "NEW FILE");
- goto done;
- }
- }
- else if (lex_match_id (lexer, "MAP"))
- {
- struct dictionary *temp = dict_clone (dataset_dict (ds));
- int success = rearrange_dict (temp, &vm);
- if (success)
- {
- /* FIXME: display new dictionary. */
- }
- dict_unref (temp);
- }
- else
- {
- lex_error_expecting (lexer, "REORDER", "RENAME", "KEEP",
- "DROP", "MAP");
- goto done;
- }
-
- if (lex_token (lexer) == T_ENDCMD)
- break;
- if (lex_token (lexer) != T_SLASH)
- {
- lex_error_expecting (lexer, "`/'", "`.'");
- goto done;
- }
- lex_get (lexer);
- }
-
- if (already_encountered & (1 | 4))
- {
- /* Read the data. */
- if (!proc_execute (ds))
- goto done;
- }
-
- if (!rearrange_dict (dataset_dict (ds), &vm))
- goto done;
-
- ret_code = CMD_SUCCESS;
-
-done:
- free (vm.reorder_vars);
- free (vm.rename_vars);
- if (vm.new_names)
- for (size_t i = 0; i < vm.n_rename; i++)
- free (vm.new_names[i]);
- free (vm.new_names);
- free (vm.drop_vars);
- return ret_code;
-}
-
-/* Compares A and B according to the settings in ORDERING, returning a
- strcmp()-type result. */
-static int
-compare_variables_given_ordering (const void *a_, const void *b_,
- const void *ordering_)
-{
- struct variable *const *pa = a_;
- struct variable *const *pb = b_;
- const struct variable *a = *pa;
- const struct variable *b = *pb;
- const struct ordering *ordering = ordering_;
-
- int result;
- if (ordering->positional)
- {
- size_t a_index = var_get_dict_index (a);
- size_t b_index = var_get_dict_index (b);
- result = a_index < b_index ? -1 : a_index > b_index;
- }
- else
- result = utf8_strcasecmp (var_get_name (a), var_get_name (b));
- if (!ordering->forward)
- result = -result;
- return result;
-}
-
-/* Pairs a variable with a new name. */
-struct var_renaming
- {
- struct variable *var;
- const char *new_name;
- };
-
-/* A algo_compare_func that compares new_name members in struct var_renaming
- structures A and B. */
-static int
-compare_var_renaming_by_new_name (const void *a_, const void *b_,
- const void *aux UNUSED)
-{
- const struct var_renaming *a = a_;
- const struct var_renaming *b = b_;
-
- return utf8_strcasecmp (a->new_name, b->new_name);
-}
-
-/* Returns true if performing VM on dictionary D would not cause problems such
- as duplicate variable names. Returns false otherwise, and issues an error
- message. */
-static bool
-validate_var_modification (const struct dictionary *d,
- const struct var_modification *vm)
-{
- /* Variable reordering can't be a problem, so we don't simulate
- it. Variable renaming can cause duplicate names, but
- dropping variables can eliminate them, so we simulate both
- of those. */
-
- /* All variables, in index order. */
- struct variable **all_vars;
- size_t n_all;
- dict_get_vars_mutable (d, &all_vars, &n_all, 0);
-
- /* Drop variables, in index order. */
- size_t n_drop = vm->n_drop;
- struct variable **drop_vars = xnmalloc (n_drop, sizeof *drop_vars);
- memcpy (drop_vars, vm->drop_vars, n_drop * sizeof *drop_vars);
- sort (drop_vars, n_drop, sizeof *drop_vars,
- compare_variables_given_ordering, &forward_positional_ordering);
-
- /* Keep variables, in index order. */
- assert (n_all >= n_drop);
- size_t n_keep = n_all - n_drop;
- struct variable **keep_vars = xnmalloc (n_keep, sizeof *keep_vars);
- if (set_difference (all_vars, n_all,
- drop_vars, n_drop,
- sizeof *all_vars,
- keep_vars,
- compare_variables_given_ordering,
- &forward_positional_ordering) != n_keep)
- NOT_REACHED ();
-
- /* Copy variables into var_renaming array. */
- struct var_renaming *var_renaming = xnmalloc (n_keep, sizeof *var_renaming);
- for (size_t i = 0; i < n_keep; i++)
- {
- var_renaming[i].var = keep_vars[i];
- var_renaming[i].new_name = var_get_name (keep_vars[i]);
- }
-
- /* Rename variables in var_renaming array. */
- for (size_t i = 0; i < vm->n_rename; i++)
- {
- struct variable *const *kv;
- struct var_renaming *vr;
-
- /* Get the var_renaming element. */
- kv = binary_search (keep_vars, n_keep, sizeof *keep_vars,
- &vm->rename_vars[i],
- compare_variables_given_ordering,
- &forward_positional_ordering);
- if (kv == NULL)
- continue;
- vr = var_renaming + (kv - keep_vars);
-
- vr->new_name = vm->new_names[i];
- }
-
- /* Sort var_renaming array by new names and check for duplicates. */
- sort (var_renaming, n_keep, sizeof *var_renaming,
- compare_var_renaming_by_new_name, NULL);
- bool ok = !adjacent_find_equal (var_renaming, n_keep, sizeof *var_renaming,
- compare_var_renaming_by_new_name, NULL);
-
- /* Clean up. */
- free (all_vars);
- free (keep_vars);
- free (drop_vars);
- free (var_renaming);
-
- return ok;
-}
-
-/* Reorders, removes, and renames variables in dictionary D according to VM.
- Returns true if successful, false if there would have been duplicate
- variable names if the modifications had been carried out. In the latter
- case, the dictionary is not modified. */
-static bool
-rearrange_dict (struct dictionary *d, const struct var_modification *vm)
-{
- /* Check whether the modifications will cause duplicate names. */
- if (!validate_var_modification (d, vm))
- return false;
-
- /* Record the old names of variables to rename. After variables are deleted,
- we can't depend on the variables to still exist, but we can still look
- them up by name. */
- char **rename_old_names = xnmalloc (vm->n_rename, sizeof *rename_old_names);
- for (size_t i = 0; i < vm->n_rename; i++)
- rename_old_names[i] = xstrdup (var_get_name (vm->rename_vars[i]));
-
- /* Reorder and delete variables. */
- dict_reorder_vars (d, vm->reorder_vars, vm->n_reorder);
- dict_delete_vars (d, vm->drop_vars, vm->n_drop);
-
- /* Compose lists of variables to rename and their new names. */
- struct variable **rename_vars = xnmalloc (vm->n_rename, sizeof *rename_vars);
- char **rename_new_names = xnmalloc (vm->n_rename, sizeof *rename_new_names);
- size_t n_rename = 0;
- for (size_t i = 0; i < vm->n_rename; i++)
- {
- struct variable *var = dict_lookup_var (d, rename_old_names[i]);
- if (var == NULL)
- continue;
-
- rename_vars[n_rename] = var;
- rename_new_names[n_rename] = vm->new_names[i];
- n_rename++;
- }
-
- /* Do renaming. */
- if (dict_rename_vars (d, rename_vars, rename_new_names, n_rename,
- NULL) == 0)
- NOT_REACHED ();
-
- /* Clean up. */
- for (size_t i = 0; i < vm->n_rename; i++)
- free (rename_old_names[i]);
- free (rename_old_names);
- free (rename_vars);
- free (rename_new_names);
-
- return true;
-}
projects / pspp / commitdiff