variable: New function var_append_value_name__().
[pspp] / src / data / variable.c
index 5f4098fc71d38abb8f0f148e6d9cdff8e3a95c6e..3ad9eccdb07c05548d4bc87664ff35d1e191b1e9 100644 (file)
@@ -49,33 +49,33 @@ typedef struct
 {
   int value;
   const char *name;
-  const char *nick;
+  const char *label;
 } GEnumValue;
 
 const GEnumValue align[] =
   {
-    {ALIGN_LEFT,   N_("Left"), N_("Left")},
-    {ALIGN_RIGHT,  N_("Right"), N_("Right")},
-    {ALIGN_CENTRE, N_("Center"), N_("Center")},
+    {ALIGN_LEFT,   "left", N_("Left")},
+    {ALIGN_RIGHT,  "right", N_("Right")},
+    {ALIGN_CENTRE, "center", N_("Center")},
     {0,0,0}
   };
 
 const GEnumValue measure[] =
   {
-    {MEASURE_NOMINAL, N_("Nominal"), N_("Nominal")},
-    {MEASURE_ORDINAL, N_("Ordinal"), N_("Ordinal")},
-    {MEASURE_SCALE,   N_("Scale"), N_("Scale")},
+    {MEASURE_NOMINAL, "nominal", N_("Nominal")},
+    {MEASURE_ORDINAL, "ordinal", N_("Ordinal")},
+    {MEASURE_SCALE,   "scale", N_("Scale")},
     {0,0,0}
   };
 
 const GEnumValue role[] =
   {
-    {ROLE_INPUT,  N_("Input"),    N_("Input")},
-    {ROLE_TARGET, N_("Output"),   N_("Output")},
-    {ROLE_BOTH,   N_("Both"),     N_("Both")},
-    {ROLE_NONE,   N_("None"),     N_("None")},
-    {ROLE_PARTITION, N_("Partition"), N_("Partition")},
-    {ROLE_SPLIT,  N_("Split"),    N_("Split")},
+    {ROLE_INPUT,  "input",    N_("Input")},
+    {ROLE_TARGET, "output",   N_("Output")},
+    {ROLE_BOTH,   "both",     N_("Both")},
+    {ROLE_NONE,   "none",     N_("None")},
+    {ROLE_PARTITION, "partition", N_("Partition")},
+    {ROLE_SPLIT,  "split",    N_("Split")},
     {0,0,0}
   };
 
@@ -186,7 +186,6 @@ static void
 var_set_name_quiet (struct variable *v, const char *name)
 {
   assert (!var_has_vardict (v));
-  assert (id_is_plausible (name, false));
 
   free (v->name);
   v->name = xstrdup (name);
@@ -497,7 +496,7 @@ var_set_value_labels (struct variable *v, const struct val_labs *vls)
 {
   struct variable *ov = var_clone (v);
   var_set_value_labels_quiet (v, vls);
-  dict_var_changed (v, VAR_TRAIT_LABEL, ov);  
+  dict_var_changed (v, VAR_TRAIT_LABEL, ov);
 }
 
 
@@ -559,46 +558,50 @@ append_value (const struct variable *v, const union value *value,
              struct string *str)
 {
   char *s = data_out (value, var_get_encoding (v), &v->print);
-  ds_put_cstr (str, s);
+  struct substring ss = ss_cstr (s);
+  ss_rtrim (&ss, ss_cstr (" "));
+  ds_put_substring (str, ss);
   free (s);
 }
 
-/* Append STR with a string representing VALUE for variable V.
-   That is, if VALUE has a label, append that label,
-   otherwise format VALUE and append the formatted string.
-   STR must be a pointer to an initialised struct string.
-*/
 void
-var_append_value_name (const struct variable *v, const union value *value,
-                      struct string *str)
+var_append_value_name__ (const struct variable *v, const union value *value,
+                         enum settings_value_show show, struct string *str)
 {
-  enum settings_value_style style = settings_get_value_style ();
-  const char *name = var_lookup_value_label (v, value);
+  const char *label = var_lookup_value_label (v, value);
 
-  switch (style)
+  switch (show)
     {
-    case SETTINGS_VAL_STYLE_VALUES:
+    case SETTINGS_VALUE_SHOW_VALUE:
       append_value (v, value, str);
       break;
-      
-    case SETTINGS_VAL_STYLE_LABELS:
-      if (name == NULL)
-       append_value (v, value, str);
+
+    default:
+    case SETTINGS_VALUE_SHOW_LABEL:
+      if (label)
+       ds_put_cstr (str, label);
       else
-       ds_put_cstr (str, name);
+       append_value (v, value, str);
       break;
 
-    case SETTINGS_VAL_STYLE_BOTH:
-    default:
+    case SETTINGS_VALUE_SHOW_BOTH:
       append_value (v, value, str);
-      if (name != NULL)
-       {
-         ds_put_cstr (str, " (");
-         ds_put_cstr (str, name);
-         ds_put_cstr (str, ")");
-       }
+      if (label != NULL)
+        ds_put_format (str, " %s", label);
       break;
-    };
+    }
+}
+
+/* Append STR with a string representing VALUE for variable V.
+   That is, if VALUE has a label, append that label,
+   otherwise format VALUE and append the formatted string.
+   STR must be a pointer to an initialised struct string.
+*/
+void
+var_append_value_name (const struct variable *v, const union value *value,
+                      struct string *str)
+{
+  var_append_value_name__ (v, value, settings_get_show_values (), str);
 }
 \f
 /* Print and write formats. */
@@ -721,24 +724,19 @@ update_vl_string (const struct variable *v)
 const char *
 var_to_string (const struct variable *v)
 {
-  enum settings_var_style style = settings_get_var_style ();
-
-  switch (style)
-  {
-    case SETTINGS_VAR_STYLE_NAMES:
+  switch (settings_get_show_variables ())
+    {
+    case SETTINGS_VALUE_SHOW_VALUE:
       return v->name;
-      break;
-    case SETTINGS_VAR_STYLE_LABELS:
+
+    case SETTINGS_VALUE_SHOW_LABEL:
+    default:
       return v->label != NULL ? v->label : v->name;
-      break;
-    case SETTINGS_VAR_STYLE_BOTH:
+
+    case SETTINGS_VALUE_SHOW_BOTH:
       update_vl_string (v);
       return ds_cstr (&v->name_and_label);
-      break;
-    default:
-      NOT_REACHED ();
-      break;
-  };
+    }
 }
 
 /* Returns V's variable label, or a null pointer if it has none. */
@@ -803,12 +801,13 @@ measure_is_valid (enum measure m)
   return m == MEASURE_NOMINAL || m == MEASURE_ORDINAL || m == MEASURE_SCALE;
 }
 
-/* Returns a string version of measurement level M, for display to a user. */
+/* Returns a string version of measurement level M, for display to a user.
+   The caller may translate the string by passing it to gettext(). */
 const char *
 measure_to_string (enum measure m)
 {
   assert (m == measure[m].value);
-  return gettext (measure[m].nick);
+  return measure[m].label;
 }
 
 /* Returns a string version of measurement level M, for use in PSPP command
@@ -888,12 +887,13 @@ var_role_is_valid (enum var_role role)
     }
 }
 
-/* Returns a string version of ROLE, for display to a user. */
+/* Returns a string version of ROLE, for display to a user.
+   The caller may translate the string by passing it to gettext(). */
 const char *
 var_role_to_string (enum var_role r)
 {
   assert (r == role[r].value);
-  return gettext (role[r].nick);
+  return role[r].label;
 }
 
 /* Returns a string version of ROLE, for use in PSPP comamnd syntax. */
@@ -995,12 +995,13 @@ alignment_is_valid (enum alignment a)
   return a == ALIGN_LEFT || a == ALIGN_RIGHT || a == ALIGN_CENTRE;
 }
 
-/* Returns a string version of alignment A, for display to a user. */
+/* Returns a string version of alignment A, for display to a user.
+   The caller may translate the string by passing it to gettext(). */
 const char *
 alignment_to_string (enum alignment a)
 {
   assert (a == align[a].value);
-  return gettext (align[a].nick);
+  return align[a].label;
 }
 
 /* Returns a string version of alignment A, for use in PSPP command syntax. */
@@ -1106,7 +1107,7 @@ var_must_leave (const struct variable *v)
    all if it hasn't been saved to or read from a system or
    portable file. */
 size_t
-var_get_short_name_cnt (const struct variable *var) 
+var_get_short_name_cnt (const struct variable *var)
 {
   return var->short_name_cnt;
 }
@@ -1132,17 +1133,15 @@ var_set_short_name (struct variable *var, size_t idx, const char *short_name)
 {
   struct variable *ov = var_clone (var);
 
-  assert (short_name == NULL || id_is_plausible (short_name, false));
-
   /* Clear old short name numbered IDX, if any. */
-  if (idx < var->short_name_cnt) 
+  if (idx < var->short_name_cnt)
     {
       free (var->short_names[idx]);
-      var->short_names[idx] = NULL; 
+      var->short_names[idx] = NULL;
     }
 
   /* Install new short name for IDX. */
-  if (short_name != NULL) 
+  if (short_name != NULL)
     {
       if (idx >= var->short_name_cnt)
         {
@@ -1201,14 +1200,14 @@ var_get_case_index (const struct variable *v)
    V, or calling var_set_attributes() on V, will also destroy its
    attribute set. */
 struct attrset *
-var_get_attributes (const struct variable *v) 
+var_get_attributes (const struct variable *v)
 {
   return CONST_CAST (struct attrset *, &v->attributes);
 }
 
 /* Replaces variable V's attributes set by a copy of ATTRS. */
 static void
-var_set_attributes_quiet (struct variable *v, const struct attrset *attrs) 
+var_set_attributes_quiet (struct variable *v, const struct attrset *attrs)
 {
   attrset_destroy (&v->attributes);
   attrset_clone (&v->attributes, attrs);
@@ -1216,7 +1215,7 @@ var_set_attributes_quiet (struct variable *v, const struct attrset *attrs)
 
 /* Replaces variable V's attributes set by a copy of ATTRS. */
 void
-var_set_attributes (struct variable *v, const struct attrset *attrs) 
+var_set_attributes (struct variable *v, const struct attrset *attrs)
 {
   struct variable *ov = var_clone (v);
   var_set_attributes_quiet (v, attrs);
@@ -1303,3 +1302,29 @@ var_clear_vardict (struct variable *v)
 {
   v->vardict = NULL;
 }
+
+\f
+/*
+  Returns zero, if W is a missing value for WV or if it is less than zero.
+  Typically used to force a numerical value into a valid weight.
+
+  As a side effect, this function will emit a warning if the value
+  WARN_ON_INVALID points to a bool which is TRUE.  That bool will be then
+  set to FALSE.
+ */
+double
+var_force_valid_weight (const struct variable *wv, double w, bool *warn_on_invalid)
+{
+  if (w < 0.0 || (wv && var_is_num_missing (wv, w, MV_ANY)))
+    w = 0.0;
+
+  if (w == 0.0 && warn_on_invalid != NULL && *warn_on_invalid)
+    {
+      *warn_on_invalid = false;
+      msg (SW, _("At least one case in the data file had a weight value "
+                "that was user-missing, system-missing, zero, or "
+                "negative.  These case(s) were ignored."));
+    }
+
+  return w;
+}