struct variable
{
/* Dictionary information. */
- char name[LONG_NAME_LEN + 1]; /* Variable name. Mixed case. */
+ char name[VAR_NAME_LEN + 1]; /* Variable name. Mixed case. */
int width; /* 0 for numeric, otherwise string width. */
struct missing_values miss; /* Missing values. */
struct fmt_spec print; /* Default format for PRINT. */
have its values stored here. */
struct cat_vals *obs_vals;
};
-
-/* Returns true if VAR_TYPE is a valid variable type. */
-bool
-var_type_is_valid (enum var_type var_type)
-{
- return var_type == VAR_NUMERIC || var_type == VAR_STRING;
-}
-
-/* Returns the variable type for the given width. */
-enum var_type
-var_type_from_width (int width)
-{
- return width != 0 ? VAR_STRING : VAR_NUMERIC;
-}
\f
/* Creates and returns a new variable with the given NAME and
WIDTH and other fields initialized to default values. The
var_create (const char *name, int width)
{
struct variable *v;
+ enum val_type type;
assert (width >= 0 && width <= MAX_STRING);
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;
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. */
{
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);
msg (SE, _("Variable name cannot be empty string."));
return false;
}
- else if (length > LONG_NAME_LEN)
+ else if (length > VAR_NAME_LEN)
{
if (issue_error)
msg (SE, _("Variable name %s exceeds %d-character limit."),
- name, (int) LONG_NAME_LEN);
+ name, (int) VAR_NAME_LEN);
return false;
}
return true;
}
+/* Returns VAR's dictionary class. */
+enum dict_class
+var_get_dict_class (const struct variable *var)
+{
+ return dict_class_from_id (var->name);
+}
+
/* A hsh_compare_func that orders variables A and B by their
names. */
int
}
\f
/* Returns the type of variable V. */
-enum var_type
+enum val_type
var_get_type (const struct variable *v)
{
- return var_type_from_width (v->width);
+ return val_type_from_width (v->width);
}
/* Returns the width of variable V. */
return v->width;
}
-/* Sets the width of V to WIDTH. */
+/* Changes the width of V to NEW_WIDTH.
+ This function should be used cautiously. */
void
var_set_width (struct variable *v, int new_width)
{
bool
var_is_numeric (const struct variable *v)
{
- return var_get_type (v) == VAR_NUMERIC;
+ return var_get_type (v) == VAL_NUMERIC;
}
/* Returns true if variable V is a string variable, false
bool
var_is_alpha (const struct variable *v)
{
- return var_get_type (v) == VAR_STRING;
+ return var_get_type (v) == VAL_STRING;
}
/* Returns true if variable V is a short string variable, false
if (vls != NULL)
{
assert (val_labs_can_set_width (vls, v->width));
- v->val_labs = val_labs_copy (vls);
+ v->val_labs = val_labs_clone (vls);
val_labs_set_width (v->val_labs, v->width);
dict_var_changed (v);
}
/* Attempts to add a value label with the given VALUE and LABEL
to V. Returns true if successful, false if VALUE has an
- existing label.
- V must not be a long string variable. */
+ existing label or if V is a long string variable. */
bool
var_add_value_label (struct variable *v,
const union value *value, const char *label)
/* Adds or replaces a value label with the given VALUE and LABEL
to V.
- V must not be a long string variable. */
+ Has no effect if V is a long string variable. */
void
var_replace_value_label (struct variable *v,
const union value *value, const char *label)
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. */
}
/* 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)
{
}
/* 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)
{
}
/* 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
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
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. */
/* Returns true if variable V's value should be left from case to
- case, instead of being reset to 0, system-missing, or blanks. */
+ case, instead of being reset to system-missing or blanks. */
bool
var_get_leave (const struct variable *v)
{
bool
var_must_leave (const struct variable *v)
{
- return dict_class_from_id (v->name) == DC_SCRATCH;
+ return var_get_dict_class (v) == DC_SCRATCH;
}
\f
/* Returns the number of short names stored in VAR.
return v->obs_vals;
}
-/* Sets V's observed categorical values to CAT_VALS. */
+/* Sets V's observed categorical values to CAT_VALS.
+ V becomes the owner of CAT_VALS. */
void
var_set_obs_vals (const struct variable *v_, struct cat_vals *cat_vals)
{
return v->obs_vals != NULL;
}
\f
-/* Returns the dictionary class corresponding to a variable named
- NAME. */
-enum dict_class
-dict_class_from_id (const char *name)
-{
- switch (name[0])
- {
- default:
- return DC_ORDINARY;
- case '$':
- return DC_SYSTEM;
- case '#':
- return DC_SCRATCH;
- }
-}
-
-/* Returns the name of dictionary class DICT_CLASS. */
-const char *
-dict_class_to_name (enum dict_class dict_class)
-{
- switch (dict_class)
- {
- case DC_ORDINARY:
- return _("ordinary");
- case DC_SYSTEM:
- return _("system");
- case DC_SCRATCH:
- return _("scratch");
- default:
- NOT_REACHED ();
- }
-}
-\f
/* Returns V's vardict structure. */
const struct vardict_info *
var_get_vardict (const struct variable *v)
projects / pspp-builds.git / blobdiff