src/data/short-names.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007, 2009, 2010, 2011 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 "data/short-names.h"
  20
  21 #include "data/dictionary.h"
  22 #include "data/sys-file-private.h"
  23 #include "data/variable.h"
  24 #include "libpspp/assertion.h"
  25 #include "libpspp/compiler.h"
  26 #include "libpspp/message.h"
  27 #include "libpspp/str.h"
  28 #include "libpspp/stringi-set.h"
  29
  30 #include "gettext.h"
  31 #define _(msgid) gettext (msgid)
  32
  33 /* Sets V's short name to BASE, followed by a suffix of the form
  34    _A, _B, _C, ..., _AA, _AB, etc. according to the value of
  35    SUFFIX_NUMBER.  Truncates BASE as necessary to fit. */
  36 static void
  37 set_var_short_name_suffix (struct variable *v, size_t i,
  38                            const char *base, int suffix_number)
  39 {
  40   char suffix[SHORT_NAME_LEN + 1];
  41   char short_name[SHORT_NAME_LEN + 1];
  42   int len, ofs;
  43
  44   assert (suffix_number >= 0);
  45
  46   /* Compose suffix. */
  47   suffix[0] = '_';
  48   if (!str_format_26adic (suffix_number, &suffix[1], sizeof suffix - 1))
  49     msg (SE, _("Variable suffix too large."));
  50   len = strlen (suffix);
  51
  52   /* Append suffix to V's short name. */
  53   str_copy_trunc (short_name, sizeof short_name, base);
  54   if (strlen (short_name) + len > SHORT_NAME_LEN)
  55     ofs = SHORT_NAME_LEN - len;
  56   else
  57     ofs = strlen (short_name);
  58   strcpy (short_name + ofs, suffix);
  59
  60   /* Set name. */
  61   var_set_short_name (v, i, short_name);
  62 }
  63
  64 static void
  65 claim_short_name (struct variable *v, size_t i,
  66                   struct stringi_set *short_names)
  67 {
  68   const char *short_name = var_get_short_name (v, i);
  69   if (short_name != NULL && !stringi_set_insert (short_names, short_name))
  70     var_set_short_name (v, i, NULL);
  71 }
  72
  73 /* Form initial short_name from the variable name, then try _A,
  74    _B, ... _AA, _AB, etc., if needed. */
  75 static void
  76 assign_short_name (struct variable *v, size_t i,
  77                    struct stringi_set *short_names)
  78 {
  79   int trial;
  80
  81   if (var_get_short_name (v, i) != NULL)
  82     return;
  83
  84   for (trial = 0; ; trial++)
  85     {
  86       if (trial == 0)
  87         var_set_short_name (v, i, var_get_name (v));
  88       else
  89         set_var_short_name_suffix (v, i, var_get_name (v), trial);
  90
  91       if (stringi_set_insert (short_names, var_get_short_name (v, i)))
  92         break;
  93     }
  94 }
  95
  96 /* Assigns a valid, unique short_name[] to each variable in D.
  97    Each variable whose actual name is short has highest priority
  98    for that short name.  Otherwise, variables with an existing
  99    short_name[] have the next highest priority for a given short
 100    name; if it is already taken, then the variable is treated as
 101    if short_name[] had been empty.  Otherwise, long names are
 102    truncated to form short names.  If that causes conflicts,
 103    variables are renamed as PREFIX_A, PREFIX_B, and so on. */
 104 void
 105 short_names_assign (struct dictionary *d)
 106 {
 107   size_t var_cnt = dict_get_var_cnt (d);
 108   struct stringi_set short_names;
 109   size_t i, j;
 110
 111   stringi_set_init (&short_names);
 112
 113   /* Clear short names that conflict with a variable name. */
 114   for (i = 0; i < var_cnt; i++)
 115     {
 116       struct variable *v = dict_get_var (d, i);
 117       int segment_cnt = sfm_width_to_segments (var_get_width (v));
 118       for (j = 0; j < segment_cnt; j++)
 119         {
 120           const char *name = var_get_short_name (v, j);
 121           if (name != NULL)
 122             {
 123               struct variable *ov = dict_lookup_var (d, name);
 124               if (ov != NULL && (ov != v || j > 0))
 125                 var_set_short_name (v, j, NULL);
 126             }
 127         }
 128     }
 129
 130   /* Give variables whose names are short the corresponding short
 131      name. */
 132   for (i = 0; i < var_cnt; i++)
 133     {
 134       struct variable *v = dict_get_var (d, i);
 135       const char *name = var_get_name (v);
 136       if (strlen (name) <= SHORT_NAME_LEN)
 137         var_set_short_name (v, 0, name);
 138     }
 139
 140   /* Each variable with an assigned short name for its first
 141      segment now gets it unless there is a conflict.  In case of
 142      conflict, the claimant earlier in dictionary order wins.
 143      Then similarly for additional segments of very long
 144      strings. */
 145   for (i = 0; i < var_cnt; i++)
 146     {
 147       struct variable *v = dict_get_var (d, i);
 148       claim_short_name (v, 0, &short_names);
 149     }
 150   for (i = 0; i < var_cnt; i++)
 151     {
 152       struct variable *v = dict_get_var (d, i);
 153       int segment_cnt = sfm_width_to_segments (var_get_width (v));
 154       for (j = 1; j < segment_cnt; j++)
 155         claim_short_name (v, j, &short_names);
 156     }
 157
 158   /* Assign short names to first segment of remaining variables,
 159      then similarly for additional segments. */
 160   for (i = 0; i < var_cnt; i++)
 161     {
 162       struct variable *v = dict_get_var (d, i);
 163       assign_short_name (v, 0, &short_names);
 164     }
 165   for (i = 0; i < var_cnt; i++)
 166     {
 167       struct variable *v = dict_get_var (d, i);
 168       int segment_cnt = sfm_width_to_segments (var_get_width (v));
 169       for (j = 1; j < segment_cnt; j++)
 170         assign_short_name (v, j, &short_names);
 171     }
 172
 173   stringi_set_destroy (&short_names);
 174 }