1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011, 2012, 2013,
3 2014, 2016, 2020 Free Software Foundation, Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "data/variable.h"
24 #include "data/attributes.h"
25 #include "data/data-out.h"
26 #include "data/dictionary.h"
27 #include "data/format.h"
28 #include "data/identifier.h"
29 #include "data/missing-values.h"
30 #include "data/settings.h"
31 #include "data/value-labels.h"
32 #include "data/vardict.h"
33 #include "libpspp/assertion.h"
34 #include "libpspp/compiler.h"
35 #include "libpspp/hash-functions.h"
36 #include "libpspp/i18n.h"
37 #include "libpspp/message.h"
38 #include "libpspp/misc.h"
39 #include "libpspp/str.h"
41 #include "gl/minmax.h"
42 #include "gl/xalloc.h"
45 #define _(msgid) gettext (msgid)
46 #define N_(msgid) (msgid)
48 /* This should follow the definition in Gtk */
56 const GEnumValue align[] =
58 {ALIGN_LEFT, "left", N_("Left")},
59 {ALIGN_RIGHT, "right", N_("Right")},
60 {ALIGN_CENTRE, "center", N_("Center")},
64 const GEnumValue measure[] =
66 {MEASURE_NOMINAL, "nominal", N_("Nominal")},
67 {MEASURE_ORDINAL, "ordinal", N_("Ordinal")},
68 {MEASURE_SCALE, "scale", N_("Scale")},
72 const GEnumValue role[] =
74 {ROLE_INPUT, "input", N_("Input")},
75 {ROLE_TARGET, "output", N_("Output")},
76 {ROLE_BOTH, "both", N_("Both")},
77 {ROLE_NONE, "none", N_("None")},
78 {ROLE_PARTITION, "partition", N_("Partition")},
79 {ROLE_SPLIT, "split", N_("Split")},
87 /* Dictionary information. */
88 char *name; /* Variable name. Mixed case. */
89 int width; /* 0 for numeric, otherwise string width. */
90 struct missing_values miss; /* Missing values. */
91 struct fmt_spec print; /* Default format for PRINT. */
92 struct fmt_spec write; /* Default format for WRITE. */
93 struct val_labs *val_labs; /* Value labels. */
94 char *label; /* Variable label. */
95 struct string name_and_label; /* The name and label in the same string */
97 /* GUI information. */
98 enum measure measure; /* Nominal, ordinal, or continuous. */
99 enum var_role role; /* Intended use. */
100 int display_width; /* Width of data editor column. */
101 enum alignment alignment; /* Alignment of data in GUI. */
103 /* Case information. */
104 bool leave; /* Leave value from case to case? */
106 /* Data for use by containing dictionary. */
107 struct vardict_info *vardict;
109 /* Used only for system and portable file input and output.
110 See short-names.h. */
112 size_t short_name_cnt;
114 /* Custom attributes. */
115 struct attrset attributes;
119 static void var_set_print_format_quiet (struct variable *v, const struct fmt_spec *print);
120 static void var_set_write_format_quiet (struct variable *v, const struct fmt_spec *write);
121 static void var_set_label_quiet (struct variable *v, const char *label);
122 static void var_set_name_quiet (struct variable *v, const char *name);
124 /* Creates and returns a new variable with the given NAME and
125 WIDTH and other fields initialized to default values. The
126 variable is not added to a dictionary; for that, use
127 dict_create_var instead. */
129 var_create (const char *name, int width)
134 assert (width >= 0 && width <= MAX_STRING);
136 v = xzalloc (sizeof *v);
137 var_set_name_quiet (v, name);
139 mv_init (&v->miss, width);
140 v->leave = var_must_leave (v);
141 type = val_type_from_width (width);
142 v->alignment = var_default_alignment (type);
143 v->measure = var_default_measure (type);
144 v->role = ROLE_INPUT;
145 v->display_width = var_default_display_width (width);
146 v->print = v->write = var_default_formats (width);
147 attrset_init (&v->attributes);
148 ds_init_empty (&v->name_and_label);
155 /* Destroys variable V.
156 V must not belong to a dictionary. If it does, use
157 dict_delete_var instead. */
159 var_destroy__ (struct variable *v)
161 assert (!var_has_vardict (v));
162 mv_destroy (&v->miss);
163 var_clear_short_names (v);
164 val_labs_destroy (v->val_labs);
165 var_set_label_quiet (v, NULL);
166 attrset_destroy (var_get_attributes (v));
168 ds_destroy (&v->name_and_label);
173 var_ref (struct variable *v)
180 var_unref (struct variable *v)
182 if (--v->ref_cnt == 0)
188 /* Variable names. */
190 /* Return variable V's name, as a UTF-8 encoded string. */
192 var_get_name (const struct variable *v)
199 /* Sets V's name to NAME, a UTF-8 encoded string.
200 Do not use this function for a variable in a dictionary. Use
201 dict_rename_var instead. */
203 var_set_name_quiet (struct variable *v, const char *name)
205 assert (!var_has_vardict (v));
208 v->name = xstrdup (name);
209 ds_destroy (&v->name_and_label);
210 ds_init_empty (&v->name_and_label);
213 /* Sets V's name to NAME, a UTF-8 encoded string.
214 Do not use this function for a variable in a dictionary. Use
215 dict_rename_var instead. */
217 var_set_name (struct variable *v, const char *name)
219 struct variable *ov = var_clone (v);
220 var_set_name_quiet (v, name);
221 dict_var_changed (v, VAR_TRAIT_NAME, ov);
224 /* Returns VAR's dictionary class. */
226 var_get_dict_class (const struct variable *var)
228 return dict_class_from_id (var->name);
231 /* A hsh_compare_func that orders variables A and B by their
234 compare_vars_by_name (const void *a_, const void *b_, const void *aux UNUSED)
236 const struct variable *a = a_;
237 const struct variable *b = b_;
239 return utf8_strcasecmp (a->name, b->name);
242 /* A hsh_hash_func that hashes variable V based on its name. */
244 hash_var_by_name (const void *v_, const void *aux UNUSED)
246 const struct variable *v = v_;
248 return utf8_hash_case_string (v->name, 0);
251 /* A hsh_compare_func that orders pointers to variables A and B
254 compare_var_ptrs_by_name (const void *a_, const void *b_,
255 const void *aux UNUSED)
257 struct variable *const *a = a_;
258 struct variable *const *b = b_;
260 return utf8_strcasecmp (var_get_name (*a), var_get_name (*b));
263 /* A hsh_compare_func that orders pointers to variables A and B
264 by their dictionary indexes. */
266 compare_var_ptrs_by_dict_index (const void *a_, const void *b_,
267 const void *aux UNUSED)
269 struct variable *const *a = a_;
270 struct variable *const *b = b_;
271 size_t a_index = var_get_dict_index (*a);
272 size_t b_index = var_get_dict_index (*b);
274 return a_index < b_index ? -1 : a_index > b_index;
277 /* A hsh_hash_func that hashes pointer to variable V based on its
280 hash_var_ptr_by_name (const void *v_, const void *aux UNUSED)
282 struct variable *const *v = v_;
284 return utf8_hash_case_string (var_get_name (*v), 0);
287 /* Returns the type of variable V. */
289 var_get_type (const struct variable *v)
291 return val_type_from_width (v->width);
294 /* Returns the width of variable V. */
296 var_get_width (const struct variable *v)
302 var_set_width_and_formats (struct variable *v, int new_width,
303 const struct fmt_spec *print, const struct fmt_spec *write)
306 unsigned int traits = 0;
310 if (mv_is_resizable (&v->miss, new_width))
311 mv_resize (&v->miss, new_width);
314 mv_destroy (&v->miss);
315 mv_init (&v->miss, new_width);
317 if (new_width != var_get_width (v))
318 traits |= VAR_TRAIT_MISSING_VALUES;
320 if (v->val_labs != NULL)
322 if (val_labs_can_set_width (v->val_labs, new_width))
323 val_labs_set_width (v->val_labs, new_width);
326 val_labs_destroy (v->val_labs);
329 traits |= VAR_TRAIT_VALUE_LABELS;
332 if (fmt_resize (&v->print, new_width))
333 traits |= VAR_TRAIT_PRINT_FORMAT;
335 if (fmt_resize (&v->write, new_width))
336 traits |= VAR_TRAIT_WRITE_FORMAT;
338 if (v->width != new_width)
340 v->width = new_width;
341 traits |= VAR_TRAIT_WIDTH;
346 var_set_print_format_quiet (v, print);
347 traits |= VAR_TRAIT_PRINT_FORMAT;
352 var_set_write_format_quiet (v, write);
353 traits |= VAR_TRAIT_WRITE_FORMAT;
357 dict_var_changed (v, traits, ov);
360 /* Changes the width of V to NEW_WIDTH.
361 This function should be used cautiously. */
363 var_set_width (struct variable *v, int new_width)
365 const int old_width = v->width;
367 if (old_width == new_width)
370 var_set_width_and_formats (v, new_width, NULL, NULL);
376 /* Returns true if variable V is numeric, false otherwise. */
378 var_is_numeric (const struct variable *v)
380 return var_get_type (v) == VAL_NUMERIC;
383 /* Returns true if variable V is a string variable, false
386 var_is_alpha (const struct variable *v)
388 return var_get_type (v) == VAL_STRING;
391 /* Returns variable V's missing values. */
392 const struct missing_values *
393 var_get_missing_values (const struct variable *v)
398 /* Sets variable V's missing values to MISS, which must be of V's
399 width or at least resizable to V's width.
400 If MISS is null, then V's missing values, if any, are
403 var_set_missing_values_quiet (struct variable *v, const struct missing_values *miss)
407 assert (mv_is_resizable (miss, v->width));
408 mv_destroy (&v->miss);
409 mv_copy (&v->miss, miss);
410 mv_resize (&v->miss, v->width);
416 /* Sets variable V's missing values to MISS, which must be of V's
417 width or at least resizable to V's width.
418 If MISS is null, then V's missing values, if any, are
421 var_set_missing_values (struct variable *v, const struct missing_values *miss)
423 struct variable *ov = var_clone (v);
424 var_set_missing_values_quiet (v, miss);
425 dict_var_changed (v, VAR_TRAIT_MISSING_VALUES, ov);
428 /* Sets variable V to have no user-missing values. */
430 var_clear_missing_values (struct variable *v)
432 var_set_missing_values (v, NULL);
435 /* Returns true if V has any user-missing values,
438 var_has_missing_values (const struct variable *v)
440 return !mv_is_empty (&v->miss);
443 /* Returns true if VALUE is in the given CLASS of missing values
444 in V, false otherwise. */
446 var_is_value_missing (const struct variable *v, const union value *value,
449 return mv_is_value_missing (&v->miss, value, class);
452 /* Returns true if D is in the given CLASS of missing values in
454 V must be a numeric variable. */
456 var_is_num_missing (const struct variable *v, double d, enum mv_class class)
458 return mv_is_num_missing (&v->miss, d, class);
461 /* Returns true if S[] is a missing value for V, false otherwise.
462 S[] must contain exactly as many characters as V's width.
463 V must be a string variable. */
465 var_is_str_missing (const struct variable *v, const uint8_t s[],
468 return mv_is_str_missing (&v->miss, s, class);
471 /* Returns variable V's value labels,
472 possibly a null pointer if it has none. */
473 const struct val_labs *
474 var_get_value_labels (const struct variable *v)
479 /* Returns true if variable V has at least one value label. */
481 var_has_value_labels (const struct variable *v)
483 return val_labs_count (v->val_labs) > 0;
486 /* Sets variable V's value labels to a copy of VLS,
487 which must have a width equal to V's width or one that can be
488 changed to V's width.
489 If VLS is null, then V's value labels, if any, are removed. */
491 var_set_value_labels_quiet (struct variable *v, const struct val_labs *vls)
493 val_labs_destroy (v->val_labs);
498 assert (val_labs_can_set_width (vls, v->width));
499 v->val_labs = val_labs_clone (vls);
500 val_labs_set_width (v->val_labs, v->width);
505 /* Sets variable V's value labels to a copy of VLS,
506 which must have a width equal to V's width or one that can be
507 changed to V's width.
508 If VLS is null, then V's value labels, if any, are removed. */
510 var_set_value_labels (struct variable *v, const struct val_labs *vls)
512 struct variable *ov = var_clone (v);
513 var_set_value_labels_quiet (v, vls);
514 dict_var_changed (v, VAR_TRAIT_LABEL, ov);
518 /* Makes sure that V has a set of value labels,
519 by assigning one to it if necessary. */
521 alloc_value_labels (struct variable *v)
523 if (v->val_labs == NULL)
524 v->val_labs = val_labs_create (v->width);
527 /* Attempts to add a value label with the given VALUE and UTF-8 encoded LABEL
528 to V. Returns true if successful, false otherwise (probably due to an
531 In LABEL, the two-byte sequence "\\n" is interpreted as a new-line. */
533 var_add_value_label (struct variable *v,
534 const union value *value, const char *label)
536 alloc_value_labels (v);
537 return val_labs_add (v->val_labs, value, label);
540 /* Adds or replaces a value label with the given VALUE and UTF-8 encoded LABEL
543 In LABEL, the two-byte sequence "\\n" is interpreted as a new-line. */
545 var_replace_value_label (struct variable *v,
546 const union value *value, const char *label)
548 alloc_value_labels (v);
549 val_labs_replace (v->val_labs, value, label);
552 /* Removes V's value labels, if any. */
554 var_clear_value_labels (struct variable *v)
556 var_set_value_labels (v, NULL);
559 /* Returns the label associated with VALUE for variable V, as a UTF-8 string in
560 a format suitable for output, or a null pointer if none. */
562 var_lookup_value_label (const struct variable *v, const union value *value)
564 return val_labs_find (v->val_labs, value);
568 Append to STR the string representation of VALUE for variable V.
569 STR must be a pointer to an initialised struct string.
572 append_value (const struct variable *v, const union value *value,
575 char *s = data_out (value, var_get_encoding (v), &v->print);
576 struct substring ss = ss_cstr (s);
577 ss_rtrim (&ss, ss_cstr (" "));
578 ds_put_substring (str, ss);
583 var_append_value_name__ (const struct variable *v, const union value *value,
584 enum settings_value_show show, struct string *str)
586 const char *label = var_lookup_value_label (v, value);
590 case SETTINGS_VALUE_SHOW_VALUE:
591 append_value (v, value, str);
595 case SETTINGS_VALUE_SHOW_LABEL:
597 ds_put_cstr (str, label);
599 append_value (v, value, str);
602 case SETTINGS_VALUE_SHOW_BOTH:
603 append_value (v, value, str);
605 ds_put_format (str, " %s", label);
610 /* Append STR with a string representing VALUE for variable V.
611 That is, if VALUE has a label, append that label,
612 otherwise format VALUE and append the formatted string.
613 STR must be a pointer to an initialised struct string.
616 var_append_value_name (const struct variable *v, const union value *value,
619 var_append_value_name__ (v, value, settings_get_show_values (), str);
622 /* Print and write formats. */
624 /* Returns V's print format specification. */
625 const struct fmt_spec *
626 var_get_print_format (const struct variable *v)
631 /* Sets V's print format specification to PRINT, which must be a
632 valid format specification for a variable of V's width
633 (ordinarily an output format, but input formats are not
636 var_set_print_format_quiet (struct variable *v, const struct fmt_spec *print)
638 if (!fmt_equal (&v->print, print))
640 assert (fmt_check_width_compat (print, v->width));
645 /* Sets V's print format specification to PRINT, which must be a
646 valid format specification for a variable of V's width
647 (ordinarily an output format, but input formats are not
650 var_set_print_format (struct variable *v, const struct fmt_spec *print)
652 struct variable *ov = var_clone (v);
653 var_set_print_format_quiet (v, print);
654 dict_var_changed (v, VAR_TRAIT_PRINT_FORMAT, ov);
657 /* Returns V's write format specification. */
658 const struct fmt_spec *
659 var_get_write_format (const struct variable *v)
664 /* Sets V's write format specification to WRITE, which must be a
665 valid format specification for a variable of V's width
666 (ordinarily an output format, but input formats are not
669 var_set_write_format_quiet (struct variable *v, const struct fmt_spec *write)
671 if (!fmt_equal (&v->write, write))
673 assert (fmt_check_width_compat (write, v->width));
678 /* Sets V's write format specification to WRITE, which must be a
679 valid format specification for a variable of V's width
680 (ordinarily an output format, but input formats are not
683 var_set_write_format (struct variable *v, const struct fmt_spec *write)
685 struct variable *ov = var_clone (v);
686 var_set_write_format_quiet (v, write);
687 dict_var_changed (v, VAR_TRAIT_WRITE_FORMAT, ov);
691 /* Sets V's print and write format specifications to FORMAT,
692 which must be a valid format specification for a variable of
693 V's width (ordinarily an output format, but input formats are
696 var_set_both_formats (struct variable *v, const struct fmt_spec *format)
698 struct variable *ov = var_clone (v);
699 var_set_print_format_quiet (v, format);
700 var_set_write_format_quiet (v, format);
701 dict_var_changed (v, VAR_TRAIT_PRINT_FORMAT | VAR_TRAIT_WRITE_FORMAT, ov);
704 /* Returns the default print and write format for a variable of
705 the given TYPE, as set by var_create. The return value can be
706 used to reset a variable's print and write formats to the
709 var_default_formats (int width)
712 ? fmt_for_output (FMT_F, 8, 2)
713 : fmt_for_output (FMT_A, width, 0));
719 /* Update the combined name and label string if necessary */
721 update_vl_string (const struct variable *v)
723 /* Cast away const! */
724 struct string *str = (struct string *) &v->name_and_label;
726 if (ds_is_empty (str))
729 ds_put_format (str, _("%s (%s)"), v->label, v->name);
731 ds_put_cstr (str, v->name);
736 /* Return a string representing this variable, in the form most
737 appropriate from a human factors perspective, that is, its
738 variable label if it has one, otherwise its name. */
740 var_to_string (const struct variable *v)
742 switch (settings_get_show_variables ())
744 case SETTINGS_VALUE_SHOW_VALUE:
747 case SETTINGS_VALUE_SHOW_LABEL:
749 return v->label != NULL ? v->label : v->name;
751 case SETTINGS_VALUE_SHOW_BOTH:
752 update_vl_string (v);
753 return ds_cstr (&v->name_and_label);
757 /* Returns V's variable label, or a null pointer if it has none. */
759 var_get_label (const struct variable *v)
764 /* Sets V's variable label to UTF-8 encoded string LABEL, stripping off leading
765 and trailing white space. If LABEL is a null pointer or if LABEL is an
766 empty string (after stripping white space), then V's variable label (if any)
769 var_set_label_quiet (struct variable *v, const char *label)
774 if (label != NULL && label[strspn (label, CC_SPACES)])
775 v->label = xstrdup (label);
777 ds_destroy (&v->name_and_label);
778 ds_init_empty (&v->name_and_label);
783 /* Sets V's variable label to UTF-8 encoded string LABEL, stripping off leading
784 and trailing white space. If LABEL is a null pointer or if LABEL is an
785 empty string (after stripping white space), then V's variable label (if any)
788 var_set_label (struct variable *v, const char *label)
790 struct variable *ov = var_clone (v);
791 var_set_label_quiet (v, label);
792 dict_var_changed (v, VAR_TRAIT_LABEL, ov);
796 /* Removes any variable label from V. */
798 var_clear_label (struct variable *v)
800 var_set_label (v, NULL);
803 /* Returns true if V has a variable V,
806 var_has_label (const struct variable *v)
808 return v->label != NULL;
811 /* Returns true if M is a valid variable measurement level,
814 measure_is_valid (enum measure m)
816 return m == MEASURE_NOMINAL || m == MEASURE_ORDINAL || m == MEASURE_SCALE;
819 /* Returns a string version of measurement level M, for display to a user.
820 The caller may translate the string by passing it to gettext(). */
822 measure_to_string (enum measure m)
824 assert (m == measure[m].value);
825 return measure[m].label;
828 /* Returns a string version of measurement level M, for use in PSPP command
831 measure_to_syntax (enum measure m)
835 case MEASURE_NOMINAL:
838 case MEASURE_ORDINAL:
849 /* Returns V's measurement level. */
851 var_get_measure (const struct variable *v)
856 /* Sets V's measurement level to MEASURE. */
858 var_set_measure_quiet (struct variable *v, enum measure measure)
860 assert (measure_is_valid (measure));
861 v->measure = measure;
865 /* Sets V's measurement level to MEASURE. */
867 var_set_measure (struct variable *v, enum measure measure)
869 struct variable *ov = var_clone (v);
870 var_set_measure_quiet (v, measure);
871 dict_var_changed (v, VAR_TRAIT_MEASURE, ov);
875 /* Returns the default measurement level for a variable of the
876 given TYPE, as set by var_create. The return value can be
877 used to reset a variable's measurement level to the
880 var_default_measure (enum val_type type)
882 return type == VAL_NUMERIC ? MEASURE_SCALE : MEASURE_NOMINAL;
885 /* Returns true if M is a valid variable role,
888 var_role_is_valid (enum var_role role)
905 /* Returns a string version of ROLE, for display to a user.
906 The caller may translate the string by passing it to gettext(). */
908 var_role_to_string (enum var_role r)
910 assert (r == role[r].value);
911 return role[r].label;
914 /* Returns a string version of ROLE, for use in PSPP comamnd syntax. */
916 var_role_to_syntax (enum var_role role)
943 /* Returns V's role. */
945 var_get_role (const struct variable *v)
950 /* Sets V's role to ROLE. */
952 var_set_role_quiet (struct variable *v, enum var_role role)
954 assert (var_role_is_valid (role));
959 /* Sets V's role to ROLE. */
961 var_set_role (struct variable *v, enum var_role role)
963 struct variable *ov = var_clone (v);
964 var_set_role_quiet (v, role);
965 dict_var_changed (v, VAR_TRAIT_ROLE, ov);
968 /* Returns V's display width, which applies only to GUIs. */
970 var_get_display_width (const struct variable *v)
972 return v->display_width;
975 /* Sets V's display width to DISPLAY_WIDTH. */
977 var_set_display_width_quiet (struct variable *v, int new_width)
979 if (v->display_width != new_width)
981 v->display_width = new_width;
986 var_set_display_width (struct variable *v, int new_width)
988 if (v->display_width != new_width)
990 struct variable *ov = var_clone (v);
991 var_set_display_width_quiet (v, new_width);
992 dict_var_changed (v, VAR_TRAIT_DISPLAY_WIDTH, ov);
996 /* Returns the default display width for a variable of the given
997 WIDTH, as set by var_create. The return value can be used to
998 reset a variable's display width to the default. */
1000 var_default_display_width (int width)
1002 return width == 0 ? 8 : MIN (width, 32);
1005 /* Returns true if A is a valid alignment,
1008 alignment_is_valid (enum alignment a)
1010 return a == ALIGN_LEFT || a == ALIGN_RIGHT || a == ALIGN_CENTRE;
1013 /* Returns a string version of alignment A, for display to a user.
1014 The caller may translate the string by passing it to gettext(). */
1016 alignment_to_string (enum alignment a)
1018 assert (a == align[a].value);
1019 return align[a].label;
1022 /* Returns a string version of alignment A, for use in PSPP command syntax. */
1024 alignment_to_syntax (enum alignment a)
1042 /* Returns V's display alignment, which applies only to GUIs. */
1044 var_get_alignment (const struct variable *v)
1046 return v->alignment;
1049 /* Sets V's display alignment to ALIGNMENT. */
1051 var_set_alignment_quiet (struct variable *v, enum alignment alignment)
1053 assert (alignment_is_valid (alignment));
1054 v->alignment = alignment;
1057 /* Sets V's display alignment to ALIGNMENT. */
1059 var_set_alignment (struct variable *v, enum alignment alignment)
1061 struct variable *ov = var_clone (v);
1062 var_set_alignment_quiet (v, alignment);
1063 dict_var_changed (v, VAR_TRAIT_ALIGNMENT, ov);
1067 /* Returns the default display alignment for a variable of the
1068 given TYPE, as set by var_create. The return value can be
1069 used to reset a variable's display alignment to the default. */
1071 var_default_alignment (enum val_type type)
1073 return type == VAL_NUMERIC ? ALIGN_RIGHT : ALIGN_LEFT;
1076 /* Whether variables' values should be preserved from case to
1079 /* Returns true if variable V's value should be left from case to
1080 case, instead of being reset to system-missing or blanks. */
1082 var_get_leave (const struct variable *v)
1087 /* Sets V's leave setting to LEAVE. */
1089 var_set_leave_quiet (struct variable *v, bool leave)
1091 assert (leave || !var_must_leave (v));
1096 /* Sets V's leave setting to LEAVE. */
1098 var_set_leave (struct variable *v, bool leave)
1100 struct variable *ov = var_clone (v);
1101 var_set_leave_quiet (v, leave);
1102 dict_var_changed (v, VAR_TRAIT_LEAVE, ov);
1106 /* Returns true if V must be left from case to case,
1107 false if it can be set either way. */
1109 var_must_leave (const struct variable *v)
1111 return var_get_dict_class (v) == DC_SCRATCH;
1114 /* Returns the number of short names stored in VAR.
1116 Short names are used only for system and portable file input
1117 and output. They are upper-case only, not necessarily unique,
1118 and limited to SHORT_NAME_LEN characters (plus a null
1119 terminator). Ordinarily a variable has at most one short
1120 name, but very long string variables (longer than 255 bytes)
1121 may have more. A variable might not have any short name at
1122 all if it hasn't been saved to or read from a system or
1125 var_get_short_name_cnt (const struct variable *var)
1127 return var->short_name_cnt;
1130 /* Returns VAR's short name with the given IDX, if it has one
1131 with that index, or a null pointer otherwise. Short names may
1132 be sparse: even if IDX is less than the number of short names
1133 in VAR, this function may return a null pointer. */
1135 var_get_short_name (const struct variable *var, size_t idx)
1137 return idx < var->short_name_cnt ? var->short_names[idx] : NULL;
1140 /* Sets VAR's short name with the given IDX to the UTF-8 string SHORT_NAME.
1141 The caller must already have checked that, in the dictionary encoding,
1142 SHORT_NAME is no more than SHORT_NAME_LEN bytes long. The new short name
1143 will be converted to uppercase.
1145 Specifying a null pointer for SHORT_NAME clears the specified short name. */
1147 var_set_short_name (struct variable *var, size_t idx, const char *short_name)
1149 struct variable *ov = var_clone (var);
1151 /* Clear old short name numbered IDX, if any. */
1152 if (idx < var->short_name_cnt)
1154 free (var->short_names[idx]);
1155 var->short_names[idx] = NULL;
1158 /* Install new short name for IDX. */
1159 if (short_name != NULL)
1161 if (idx >= var->short_name_cnt)
1163 size_t old_cnt = var->short_name_cnt;
1165 var->short_name_cnt = MAX (idx * 2, 1);
1166 var->short_names = xnrealloc (var->short_names, var->short_name_cnt,
1167 sizeof *var->short_names);
1168 for (i = old_cnt; i < var->short_name_cnt; i++)
1169 var->short_names[i] = NULL;
1171 var->short_names[idx] = utf8_to_upper (short_name);
1174 dict_var_changed (var, VAR_TRAIT_NAME, ov);
1177 /* Clears V's short names. */
1179 var_clear_short_names (struct variable *v)
1183 for (i = 0; i < v->short_name_cnt; i++)
1184 free (v->short_names[i]);
1185 free (v->short_names);
1186 v->short_names = NULL;
1187 v->short_name_cnt = 0;
1190 /* Relationship with dictionary. */
1192 /* Returns V's index within its dictionary, the value
1193 for which "dict_get_var (dict, index)" will return V.
1194 V must be in a dictionary. */
1196 var_get_dict_index (const struct variable *v)
1198 assert (var_has_vardict (v));
1199 return vardict_get_dict_index (v->vardict);
1202 /* Returns V's index within the case represented by its
1203 dictionary, that is, the value for which "case_data_idx (case,
1204 index)" will return the data for V in that case.
1205 V must be in a dictionary. */
1207 var_get_case_index (const struct variable *v)
1209 assert (var_has_vardict (v));
1210 return vardict_get_case_index (v->vardict);
1213 /* Returns variable V's attribute set. The caller may examine or
1214 modify the attribute set, but must not destroy it. Destroying
1215 V, or calling var_set_attributes() on V, will also destroy its
1218 var_get_attributes (const struct variable *v)
1220 return CONST_CAST (struct attrset *, &v->attributes);
1223 /* Replaces variable V's attributes set by a copy of ATTRS. */
1225 var_set_attributes_quiet (struct variable *v, const struct attrset *attrs)
1227 attrset_destroy (&v->attributes);
1228 attrset_clone (&v->attributes, attrs);
1231 /* Replaces variable V's attributes set by a copy of ATTRS. */
1233 var_set_attributes (struct variable *v, const struct attrset *attrs)
1235 struct variable *ov = var_clone (v);
1236 var_set_attributes_quiet (v, attrs);
1237 dict_var_changed (v, VAR_TRAIT_ATTRIBUTES, ov);
1241 /* Returns true if V has any custom attributes, false if it has none. */
1243 var_has_attributes (const struct variable *v)
1245 return attrset_count (&v->attributes) > 0;
1249 /* Creates and returns a clone of OLD_VAR. Most properties of
1250 the new variable are copied from OLD_VAR, except:
1252 - The variable's short name is not copied, because there is
1253 no reason to give a new variable with potentially a new
1254 name the same short name.
1256 - The new variable is not added to OLD_VAR's dictionary by
1257 default. Use dict_clone_var, instead, to do that.
1260 var_clone (const struct variable *old_var)
1262 struct variable *new_var = var_create (var_get_name (old_var),
1263 var_get_width (old_var));
1265 var_set_missing_values_quiet (new_var, var_get_missing_values (old_var));
1266 var_set_print_format_quiet (new_var, var_get_print_format (old_var));
1267 var_set_write_format_quiet (new_var, var_get_write_format (old_var));
1268 var_set_value_labels_quiet (new_var, var_get_value_labels (old_var));
1269 var_set_label_quiet (new_var, var_get_label (old_var));
1270 var_set_measure_quiet (new_var, var_get_measure (old_var));
1271 var_set_role_quiet (new_var, var_get_role (old_var));
1272 var_set_display_width_quiet (new_var, var_get_display_width (old_var));
1273 var_set_alignment_quiet (new_var, var_get_alignment (old_var));
1274 var_set_leave_quiet (new_var, var_get_leave (old_var));
1275 var_set_attributes_quiet (new_var, var_get_attributes (old_var));
1282 /* Returns the encoding of values of variable VAR. (This is actually a
1283 property of the dictionary.) Returns null if no specific encoding has been
1286 var_get_encoding (const struct variable *var)
1288 return (var_has_vardict (var)
1289 ? dict_get_encoding (vardict_get_dictionary (var->vardict))
1293 /* Returns V's vardict structure. */
1294 struct vardict_info *
1295 var_get_vardict (const struct variable *v)
1297 return CONST_CAST (struct vardict_info *, v->vardict);
1300 /* Sets V's vardict data to VARDICT. */
1302 var_set_vardict (struct variable *v, struct vardict_info *vardict)
1304 v->vardict = vardict;
1307 /* Returns true if V has vardict data. */
1309 var_has_vardict (const struct variable *v)
1311 return v->vardict != NULL;
1314 /* Clears V's vardict data. */
1316 var_clear_vardict (struct variable *v)
1323 Returns zero, if W is a missing value for WV or if it is less than zero.
1324 Typically used to force a numerical value into a valid weight.
1326 As a side effect, this function will emit a warning if the value
1327 WARN_ON_INVALID points to a bool which is TRUE. That bool will be then
1331 var_force_valid_weight (const struct variable *wv, double w, bool *warn_on_invalid)
1333 if (w < 0.0 || (wv && var_is_num_missing (wv, w, MV_ANY)))
1336 if (w == 0.0 && warn_on_invalid != NULL && *warn_on_invalid)
1338 *warn_on_invalid = false;
1339 msg (SW, _("At least one case in the data file had a weight value "
1340 "that was user-missing, system-missing, zero, or "
1341 "negative. These case(s) were ignored."));