New function: var_create_internal.
[pspp-builds.git] / src / data / variable.c
index 4623b77b13a9f65ddcab64565898dcfc390c4cc5..e39692a062bfe4952ef13f1cf9cbadfba5305c2b 100644 (file)
@@ -86,6 +86,7 @@ struct variable *
 var_create (const char *name, int width)
 {
   struct variable *v;
+  enum val_type type;
 
   assert (width >= 0 && width <= MAX_STRING);
 
@@ -95,20 +96,11 @@ var_create (const char *name, int width)
   v->width = width;
   mv_init (&v->miss, width);
   v->leave = var_must_leave (v);
-  if (var_is_numeric (v))
-    {
-      v->print = fmt_for_output (FMT_F, 8, 2);
-      v->alignment = ALIGN_RIGHT;
-      v->measure = MEASURE_SCALE;
-    }
-  else
-    {
-      v->print = fmt_for_output (FMT_A, var_get_width (v), 0);
-      v->alignment = ALIGN_LEFT;
-      v->measure = MEASURE_NOMINAL;
-    }
+  type = val_type_from_width (width);
+  v->alignment = var_default_alignment (type);
+  v->measure = var_default_measure (type);
   v->display_width = var_default_display_width (width);
-  v->write = v->print;
+  v->print = v->write = var_default_formats (width);
   v->val_labs = NULL;
   v->label = NULL;
   v->short_names = NULL;
@@ -150,6 +142,23 @@ var_clone (const struct variable *old_var)
   return new_var;
 }
 
+/* Create a variable to be used for internal calculations only */
+struct variable *
+var_create_internal (int case_idx)
+{
+  struct variable *v = var_create ("$internal", 0);
+
+  struct vardict_info vdi;
+
+  vdi.dict = NULL;
+  vdi.dict_index = 0;
+  vdi.case_index = case_idx;
+
+  var_set_vardict (v, &vdi);
+
+  return v;
+}
+
 /* Destroys variable V.
    V must not belong to a dictionary.  If it does, use
    dict_delete_var instead. */
@@ -158,7 +167,11 @@ var_destroy (struct variable *v)
 {
   if (v != NULL)
     {
-      assert (!var_has_vardict (v));
+      if (var_has_vardict (v))
+       {
+         const struct vardict_info *vdi = var_get_vardict (v);
+         assert (vdi->dict == NULL);
+       }
       cat_stored_values_destroy (v->obs_vals);
       var_clear_short_names (v);
       var_clear_aux (v);
@@ -567,23 +580,26 @@ var_lookup_value_label (const struct variable *v, const union value *value)
   return val_labs_find (v->val_labs, *value);
 }
 
-/* Get a string representing VALUE for variable V.
-   That is, if VALUE has a label, return that label,
-   otherwise format VALUE and return the formatted string. */
-const char *
-var_get_value_name (const struct variable *v, const union value *value)
+/* 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)
 {
   const char *name = var_lookup_value_label (v, value);
   if (name == NULL)
     {
-      static char buf[MAX_STRING + 1];
-      data_out (value, &v->print, buf);
-      buf[v->print.w] = '\0';
-      name = buf;
+      char *s = ds_put_uninit (str, v->print.w);
+      data_out (value, &v->print, s);
     }
-  return name;
+  else
+    ds_put_cstr (str, name);
 }
 \f
+\f
 /* Print and write formats. */
 
 /* Returns V's print format specification. */
@@ -594,8 +610,9 @@ var_get_print_format (const struct variable *v)
 }
 
 /* Sets V's print format specification to PRINT, which must be a
-   valid format specification for outputting a variable of V's
-   width. */
+   valid format specification for a variable of V's width
+   (ordinarily an output format, but input formats are not
+   rejected). */
 void
 var_set_print_format (struct variable *v, const struct fmt_spec *print)
 {
@@ -612,8 +629,9 @@ var_get_write_format (const struct variable *v)
 }
 
 /* Sets V's write format specification to WRITE, which must be a
-   valid format specification for outputting a variable of V's
-   width. */
+   valid format specification for a variable of V's width
+   (ordinarily an output format, but input formats are not
+   rejected). */
 void
 var_set_write_format (struct variable *v, const struct fmt_spec *write)
 {
@@ -623,14 +641,27 @@ var_set_write_format (struct variable *v, const struct fmt_spec *write)
 }
 
 /* Sets V's print and write format specifications to FORMAT,
-   which must be a valid format specification for outputting a
-   variable of V's width. */
+   which must be a valid format specification for a variable of
+   V's width (ordinarily an output format, but input formats are
+   not rejected). */
 void
 var_set_both_formats (struct variable *v, const struct fmt_spec *format)
 {
   var_set_print_format (v, format);
   var_set_write_format (v, format);
 }
+
+/* Returns the default print and write format for a variable of
+   the given TYPE, as set by var_create.  The return value can be
+   used to reset a variable's print and write formats to the
+   default. */
+struct fmt_spec
+var_default_formats (int width)
+{
+  return (width == 0
+          ? fmt_for_output (FMT_F, 8, 2)
+          : fmt_for_output (FMT_A, width, 0));
+}
 \f
 /* Return a string representing this variable, in the form most
    appropriate from a human factors perspective, that is, its
@@ -708,6 +739,16 @@ var_set_measure (struct variable *v, enum measure measure)
   v->measure = measure;
   dict_var_changed (v);
 }
+
+/* Returns the default measurement level for a variable of the
+   given TYPE, as set by var_create.  The return value can be
+   used to reset a variable's measurement level to the
+   default. */
+enum measure
+var_default_measure (enum val_type type)
+{
+  return type == VAL_NUMERIC ? MEASURE_SCALE : MEASURE_NOMINAL;
+}
 \f
 /* Returns V's display width, which applies only to GUIs. */
 int
@@ -756,6 +797,15 @@ var_set_alignment (struct variable *v, enum alignment alignment)
   v->alignment = alignment;
   dict_var_changed (v);
 }
+
+/* Returns the default display alignment for a variable of the
+   given TYPE, as set by var_create.  The return value can be
+   used to reset a variable's display alignment to the default. */
+enum alignment
+var_default_alignment (enum val_type type)
+{
+  return type == VAL_NUMERIC ? ALIGN_RIGHT : ALIGN_LEFT;
+}
 \f
 /* Whether variables' values should be preserved from case to
    case. */