1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
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.
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.
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/>. */
22 #include <data/attributes.h>
23 #include <data/category.h>
24 #include <data/data-out.h>
25 #include <data/format.h>
26 #include <data/dictionary.h>
27 #include <data/identifier.h>
28 #include <data/missing-values.h>
29 #include <data/value-labels.h>
30 #include <data/vardict.h>
32 #include <libpspp/misc.h>
33 #include <libpspp/assertion.h>
34 #include <libpspp/compiler.h>
35 #include <libpspp/hash.h>
36 #include <libpspp/message.h>
37 #include <libpspp/str.h>
42 #define _(msgid) gettext (msgid)
47 /* Dictionary information. */
48 char name[VAR_NAME_LEN + 1]; /* Variable name. Mixed case. */
49 int width; /* 0 for numeric, otherwise string width. */
50 struct missing_values miss; /* Missing values. */
51 struct fmt_spec print; /* Default format for PRINT. */
52 struct fmt_spec write; /* Default format for WRITE. */
53 struct val_labs *val_labs; /* Value labels. */
54 char *label; /* Variable label. */
56 /* GUI information. */
57 enum measure measure; /* Nominal, ordinal, or continuous. */
58 int display_width; /* Width of data editor column. */
59 enum alignment alignment; /* Alignment of data in GUI. */
61 /* Case information. */
62 bool leave; /* Leave value from case to case? */
64 /* Data for use by containing dictionary. */
65 struct vardict_info vardict;
67 /* Used only for system and portable file input and output.
70 size_t short_name_cnt;
72 /* Each command may use these fields as needed. */
74 void (*aux_dtor) (struct variable *);
76 /* Values of a categorical variable. Procedures need
77 vectors with binary entries, so any variable of type ALPHA will
78 have its values stored here. */
79 struct cat_vals *obs_vals;
81 /* Custom attributes. */
82 struct attrset attributes;
85 /* Creates and returns a new variable with the given NAME and
86 WIDTH and other fields initialized to default values. The
87 variable is not added to a dictionary; for that, use
88 dict_create_var instead. */
90 var_create (const char *name, int width)
95 assert (width >= 0 && width <= MAX_STRING);
97 v = xmalloc (sizeof *v);
98 v->vardict.dict_index = v->vardict.case_index = -1;
99 var_set_name (v, name);
101 mv_init (&v->miss, width);
102 v->leave = var_must_leave (v);
103 type = val_type_from_width (width);
104 v->alignment = var_default_alignment (type);
105 v->measure = var_default_measure (type);
106 v->display_width = var_default_display_width (width);
107 v->print = v->write = var_default_formats (width);
110 v->short_names = NULL;
111 v->short_name_cnt = 0;
115 attrset_init (&v->attributes);
120 /* Creates and returns a clone of OLD_VAR. Most properties of
121 the new variable are copied from OLD_VAR, except:
123 - The variable's short name is not copied, because there is
124 no reason to give a new variable with potentially a new
125 name the same short name.
127 - The new variable is not added to OLD_VAR's dictionary by
128 default. Use dict_clone_var, instead, to do that.
130 - Auxiliary data and obs_vals are not copied. */
132 var_clone (const struct variable *old_var)
134 struct variable *new_var = var_create (var_get_name (old_var),
135 var_get_width (old_var));
137 var_set_missing_values (new_var, var_get_missing_values (old_var));
138 var_set_print_format (new_var, var_get_print_format (old_var));
139 var_set_write_format (new_var, var_get_write_format (old_var));
140 var_set_value_labels (new_var, var_get_value_labels (old_var));
141 var_set_label (new_var, var_get_label (old_var));
142 var_set_measure (new_var, var_get_measure (old_var));
143 var_set_display_width (new_var, var_get_display_width (old_var));
144 var_set_alignment (new_var, var_get_alignment (old_var));
145 var_set_leave (new_var, var_get_leave (old_var));
146 var_set_attributes (new_var, var_get_attributes (old_var));
151 /* Create a variable to be used for internal calculations only */
153 var_create_internal (int case_idx)
155 struct variable *v = var_create ("$internal", 0);
157 struct vardict_info vdi;
161 vdi.case_index = case_idx;
163 var_set_vardict (v, &vdi);
168 /* Destroys variable V.
169 V must not belong to a dictionary. If it does, use
170 dict_delete_var instead. */
172 var_destroy (struct variable *v)
176 if (var_has_vardict (v))
178 const struct vardict_info *vdi = var_get_vardict (v);
179 assert (vdi->dict == NULL);
181 cat_stored_values_destroy (v->obs_vals);
182 var_clear_short_names (v);
184 val_labs_destroy (v->val_labs);
190 /* Variable names. */
192 /* Return variable V's name. */
194 var_get_name (const struct variable *v)
199 /* Sets V's name to NAME.
200 Do not use this function for a variable in a dictionary. Use
201 dict_rename_var instead. */
203 var_set_name (struct variable *v, const char *name)
205 assert (v->vardict.dict_index == -1);
206 assert (var_is_plausible_name (name, false));
208 str_copy_trunc (v->name, sizeof v->name, name);
209 dict_var_changed (v);
212 /* Returns true if NAME is an acceptable name for a variable,
213 false otherwise. If ISSUE_ERROR is true, issues an
214 explanatory error message on failure. */
216 var_is_valid_name (const char *name, bool issue_error)
221 assert (name != NULL);
223 /* Note that strlen returns number of BYTES, not the number of
225 length = strlen (name);
227 plausible = var_is_plausible_name(name, issue_error);
233 if (!lex_is_id1 (name[0]))
236 msg (SE, _("Character `%c' (in %s) may not appear "
237 "as the first character in a variable name."),
243 for (i = 0; i < length; i++)
245 if (!lex_is_idn (name[i]))
248 msg (SE, _("Character `%c' (in %s) may not appear in "
258 /* Returns true if NAME is an plausible name for a variable,
259 false otherwise. If ISSUE_ERROR is true, issues an
260 explanatory error message on failure.
261 This function makes no use of LC_CTYPE.
264 var_is_plausible_name (const char *name, bool issue_error)
268 assert (name != NULL);
270 /* Note that strlen returns number of BYTES, not the number of
272 length = strlen (name);
276 msg (SE, _("Variable name cannot be empty string."));
279 else if (length > VAR_NAME_LEN)
282 msg (SE, _("Variable name %s exceeds %d-character limit."),
283 name, (int) VAR_NAME_LEN);
287 if (lex_id_to_token (ss_cstr (name)) != T_ID)
290 msg (SE, _("`%s' may not be used as a variable name because it "
291 "is a reserved word."), name);
298 /* Returns VAR's dictionary class. */
300 var_get_dict_class (const struct variable *var)
302 return dict_class_from_id (var->name);
305 /* A hsh_compare_func that orders variables A and B by their
308 compare_vars_by_name (const void *a_, const void *b_, const void *aux UNUSED)
310 const struct variable *a = a_;
311 const struct variable *b = b_;
313 return strcasecmp (a->name, b->name);
316 /* A hsh_hash_func that hashes variable V based on its name. */
318 hash_var_by_name (const void *v_, const void *aux UNUSED)
320 const struct variable *v = v_;
322 return hsh_hash_case_string (v->name);
325 /* A hsh_compare_func that orders pointers to variables A and B
328 compare_var_ptrs_by_name (const void *a_, const void *b_,
329 const void *aux UNUSED)
331 struct variable *const *a = a_;
332 struct variable *const *b = b_;
334 return strcasecmp (var_get_name (*a), var_get_name (*b));
337 /* A hsh_compare_func that orders pointers to variables A and B
338 by their dictionary indexes. */
340 compare_var_ptrs_by_dict_index (const void *a_, const void *b_,
341 const void *aux UNUSED)
343 struct variable *const *a = a_;
344 struct variable *const *b = b_;
345 size_t a_index = var_get_dict_index (*a);
346 size_t b_index = var_get_dict_index (*b);
348 return a_index < b_index ? -1 : a_index > b_index;
351 /* A hsh_hash_func that hashes pointer to variable V based on its
354 hash_var_ptr_by_name (const void *v_, const void *aux UNUSED)
356 struct variable *const *v = v_;
358 return hsh_hash_case_string (var_get_name (*v));
361 /* Returns the type of variable V. */
363 var_get_type (const struct variable *v)
365 return val_type_from_width (v->width);
368 /* Returns the width of variable V. */
370 var_get_width (const struct variable *v)
375 /* Changes the width of V to NEW_WIDTH.
376 This function should be used cautiously. */
378 var_set_width (struct variable *v, int new_width)
380 const int old_width = v->width;
382 if (mv_is_resizable (&v->miss, new_width))
383 mv_resize (&v->miss, new_width);
385 mv_init (&v->miss, new_width);
387 if (v->val_labs != NULL)
389 if (val_labs_can_set_width (v->val_labs, new_width))
390 val_labs_set_width (v->val_labs, new_width);
393 val_labs_destroy (v->val_labs);
398 fmt_resize (&v->print, new_width);
399 fmt_resize (&v->write, new_width);
401 v->width = new_width;
404 const int old_val_count = value_cnt_from_width (old_width);
405 const int new_val_count = value_cnt_from_width (new_width);
407 if ( old_val_count != new_val_count)
408 dict_var_resized (v, new_val_count - old_val_count);
411 dict_var_changed (v);
414 /* Returns true if variable V is numeric, false otherwise. */
416 var_is_numeric (const struct variable *v)
418 return var_get_type (v) == VAL_NUMERIC;
421 /* Returns true if variable V is a string variable, false
424 var_is_alpha (const struct variable *v)
426 return var_get_type (v) == VAL_STRING;
429 /* Returns true if variable V is a short string variable, false
432 var_is_short_string (const struct variable *v)
434 return v->width > 0 && v->width <= MAX_SHORT_STRING;
437 /* Returns true if variable V is a long string variable, false
440 var_is_long_string (const struct variable *v)
442 return v->width > MAX_SHORT_STRING;
445 /* Returns the number of "union value"s need to store a value of
448 var_get_value_cnt (const struct variable *v)
450 return value_cnt_from_width (v->width);
453 /* Returns variable V's missing values. */
454 const struct missing_values *
455 var_get_missing_values (const struct variable *v)
460 /* Sets variable V's missing values to MISS, which must be of V's
461 width or at least resizable to V's width.
462 If MISS is null, then V's missing values, if any, are
465 var_set_missing_values (struct variable *v, const struct missing_values *miss)
469 assert (mv_is_resizable (miss, v->width));
470 mv_copy (&v->miss, miss);
471 mv_resize (&v->miss, v->width);
474 mv_init (&v->miss, v->width);
476 dict_var_changed (v);
479 /* Sets variable V to have no user-missing values. */
481 var_clear_missing_values (struct variable *v)
483 var_set_missing_values (v, NULL);
486 /* Returns true if V has any user-missing values,
489 var_has_missing_values (const struct variable *v)
491 return !mv_is_empty (&v->miss);
494 /* Returns true if VALUE is in the given CLASS of missing values
495 in V, false otherwise. */
497 var_is_value_missing (const struct variable *v, const union value *value,
500 return mv_is_value_missing (&v->miss, value, class);
503 /* Returns true if D is in the given CLASS of missing values in
505 V must be a numeric variable. */
507 var_is_num_missing (const struct variable *v, double d, enum mv_class class)
509 return mv_is_num_missing (&v->miss, d, class);
512 /* Returns true if S[] is a missing value for V, false otherwise.
513 S[] must contain exactly as many characters as V's width.
514 V must be a string variable. */
516 var_is_str_missing (const struct variable *v, const char s[],
519 return mv_is_str_missing (&v->miss, s, class);
522 /* Returns variable V's value labels,
523 possibly a null pointer if it has none. */
524 const struct val_labs *
525 var_get_value_labels (const struct variable *v)
530 /* Returns true if variable V has at least one value label. */
532 var_has_value_labels (const struct variable *v)
534 return val_labs_count (v->val_labs) > 0;
537 /* Sets variable V's value labels to a copy of VLS,
538 which must have a width equal to V's width or one that can be
539 changed to V's width.
540 If VLS is null, then V's value labels, if any, are removed. */
542 var_set_value_labels (struct variable *v, const struct val_labs *vls)
544 val_labs_destroy (v->val_labs);
549 assert (val_labs_can_set_width (vls, v->width));
550 v->val_labs = val_labs_clone (vls);
551 val_labs_set_width (v->val_labs, v->width);
552 dict_var_changed (v);
556 /* Makes sure that V has a set of value labels,
557 by assigning one to it if necessary. */
559 alloc_value_labels (struct variable *v)
561 assert (!var_is_long_string (v));
562 if (v->val_labs == NULL)
563 v->val_labs = val_labs_create (v->width);
566 /* Attempts to add a value label with the given VALUE and LABEL
567 to V. Returns true if successful, false if VALUE has an
568 existing label or if V is a long string variable. */
570 var_add_value_label (struct variable *v,
571 const union value *value, const char *label)
573 alloc_value_labels (v);
574 return val_labs_add (v->val_labs, *value, label);
577 /* Adds or replaces a value label with the given VALUE and LABEL
579 Has no effect if V is a long string variable. */
581 var_replace_value_label (struct variable *v,
582 const union value *value, const char *label)
584 alloc_value_labels (v);
585 val_labs_replace (v->val_labs, *value, label);
588 /* Removes V's value labels, if any. */
590 var_clear_value_labels (struct variable *v)
592 var_set_value_labels (v, NULL);
595 /* Returns the label associated with VALUE for variable V,
596 or a null pointer if none. */
598 var_lookup_value_label (const struct variable *v, const union value *value)
600 return val_labs_find (v->val_labs, *value);
603 /* Append STR with a string representing VALUE for variable V.
604 That is, if VALUE has a label, append that label,
605 otherwise format VALUE and append the formatted string.
606 STR must be a pointer to an initialised struct string.
609 var_append_value_name (const struct variable *v, const union value *value,
612 const char *name = var_lookup_value_label (v, value);
615 char *s = ds_put_uninit (str, v->print.w);
616 data_out (value, &v->print, s);
619 ds_put_cstr (str, name);
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 (struct variable *v, const struct fmt_spec *print)
638 assert (fmt_check_width_compat (print, v->width));
640 dict_var_changed (v);
643 /* Returns V's write format specification. */
644 const struct fmt_spec *
645 var_get_write_format (const struct variable *v)
650 /* Sets V's write format specification to WRITE, which must be a
651 valid format specification for a variable of V's width
652 (ordinarily an output format, but input formats are not
655 var_set_write_format (struct variable *v, const struct fmt_spec *write)
657 assert (fmt_check_width_compat (write, v->width));
659 dict_var_changed (v);
662 /* Sets V's print and write format specifications to FORMAT,
663 which must be a valid format specification for a variable of
664 V's width (ordinarily an output format, but input formats are
667 var_set_both_formats (struct variable *v, const struct fmt_spec *format)
669 var_set_print_format (v, format);
670 var_set_write_format (v, format);
673 /* Returns the default print and write format for a variable of
674 the given TYPE, as set by var_create. The return value can be
675 used to reset a variable's print and write formats to the
678 var_default_formats (int width)
681 ? fmt_for_output (FMT_F, 8, 2)
682 : fmt_for_output (FMT_A, width, 0));
685 /* Return a string representing this variable, in the form most
686 appropriate from a human factors perspective, that is, its
687 variable label if it has one, otherwise its name. */
689 var_to_string (const struct variable *v)
691 return v->label != NULL ? v->label : v->name;
694 /* Returns V's variable label, or a null pointer if it has none. */
696 var_get_label (const struct variable *v)
701 /* Sets V's variable label to LABEL, stripping off leading and
702 trailing white space and truncating to 255 characters.
703 If LABEL is a null pointer or if LABEL is an empty string
704 (after stripping white space), then V's variable label (if
707 var_set_label (struct variable *v, const char *label)
714 struct substring s = ss_cstr (label);
715 ss_trim (&s, ss_cstr (CC_SPACES));
716 ss_truncate (&s, 255);
717 if (!ss_is_empty (s))
718 v->label = ss_xstrdup (s);
719 dict_var_changed (v);
723 /* Removes any variable label from V. */
725 var_clear_label (struct variable *v)
727 var_set_label (v, NULL);
730 /* Returns true if V has a variable V,
733 var_has_label (const struct variable *v)
735 return v->label != NULL;
738 /* Returns true if M is a valid variable measurement level,
741 measure_is_valid (enum measure m)
743 return m == MEASURE_NOMINAL || m == MEASURE_ORDINAL || m == MEASURE_SCALE;
746 /* Returns V's measurement level. */
748 var_get_measure (const struct variable *v)
753 /* Sets V's measurement level to MEASURE. */
755 var_set_measure (struct variable *v, enum measure measure)
757 assert (measure_is_valid (measure));
758 v->measure = measure;
759 dict_var_changed (v);
762 /* Returns the default measurement level for a variable of the
763 given TYPE, as set by var_create. The return value can be
764 used to reset a variable's measurement level to the
767 var_default_measure (enum val_type type)
769 return type == VAL_NUMERIC ? MEASURE_SCALE : MEASURE_NOMINAL;
772 /* Returns V's display width, which applies only to GUIs. */
774 var_get_display_width (const struct variable *v)
776 return v->display_width;
779 /* Sets V's display width to DISPLAY_WIDTH. */
781 var_set_display_width (struct variable *v, int display_width)
783 v->display_width = display_width;
784 dict_var_changed (v);
787 /* Returns the default display width for a variable of the given
788 WIDTH, as set by var_create. The return value can be used to
789 reset a variable's display width to the default. */
791 var_default_display_width (int width)
793 return width == 0 ? 8 : MIN (width, 32);
796 /* Returns true if A is a valid alignment,
799 alignment_is_valid (enum alignment a)
801 return a == ALIGN_LEFT || a == ALIGN_RIGHT || a == ALIGN_CENTRE;
804 /* Returns V's display alignment, which applies only to GUIs. */
806 var_get_alignment (const struct variable *v)
811 /* Sets V's display alignment to ALIGNMENT. */
813 var_set_alignment (struct variable *v, enum alignment alignment)
815 assert (alignment_is_valid (alignment));
816 v->alignment = alignment;
817 dict_var_changed (v);
820 /* Returns the default display alignment for a variable of the
821 given TYPE, as set by var_create. The return value can be
822 used to reset a variable's display alignment to the default. */
824 var_default_alignment (enum val_type type)
826 return type == VAL_NUMERIC ? ALIGN_RIGHT : ALIGN_LEFT;
829 /* Whether variables' values should be preserved from case to
832 /* Returns true if variable V's value should be left from case to
833 case, instead of being reset to system-missing or blanks. */
835 var_get_leave (const struct variable *v)
840 /* Sets V's leave setting to LEAVE. */
842 var_set_leave (struct variable *v, bool leave)
844 assert (leave || !var_must_leave (v));
846 dict_var_changed (v);
849 /* Returns true if V must be left from case to case,
850 false if it can be set either way. */
852 var_must_leave (const struct variable *v)
854 return var_get_dict_class (v) == DC_SCRATCH;
857 /* Returns the number of short names stored in VAR.
859 Short names are used only for system and portable file input
860 and output. They are upper-case only, not necessarily unique,
861 and limited to SHORT_NAME_LEN characters (plus a null
862 terminator). Ordinarily a variable has at most one short
863 name, but very long string variables (longer than 255 bytes)
864 may have more. A variable might not have any short name at
865 all if it hasn't been saved to or read from a system or
868 var_get_short_name_cnt (const struct variable *var)
870 return var->short_name_cnt;
873 /* Returns VAR's short name with the given IDX, if it has one
874 with that index, or a null pointer otherwise. Short names may
875 be sparse: even if IDX is less than the number of short names
876 in VAR, this function may return a null pointer. */
878 var_get_short_name (const struct variable *var, size_t idx)
880 return idx < var->short_name_cnt ? var->short_names[idx] : NULL;
883 /* Sets VAR's short name with the given IDX to SHORT_NAME,
884 truncating it to SHORT_NAME_LEN characters and converting it
885 to uppercase in the process. Specifying a null pointer for
886 SHORT_NAME clears the specified short name. */
888 var_set_short_name (struct variable *var, size_t idx, const char *short_name)
890 assert (var != NULL);
891 assert (short_name == NULL || var_is_plausible_name (short_name, false));
893 /* Clear old short name numbered IDX, if any. */
894 if (idx < var->short_name_cnt)
896 free (var->short_names[idx]);
897 var->short_names[idx] = NULL;
900 /* Install new short name for IDX. */
901 if (short_name != NULL)
903 if (idx >= var->short_name_cnt)
905 size_t old_cnt = var->short_name_cnt;
907 var->short_name_cnt = MAX (idx * 2, 1);
908 var->short_names = xnrealloc (var->short_names, var->short_name_cnt,
909 sizeof *var->short_names);
910 for (i = old_cnt; i < var->short_name_cnt; i++)
911 var->short_names[i] = NULL;
913 var->short_names[idx] = xstrndup (short_name, MAX_SHORT_STRING);
914 str_uppercase (var->short_names[idx]);
917 dict_var_changed (var);
920 /* Clears V's short names. */
922 var_clear_short_names (struct variable *v)
926 for (i = 0; i < v->short_name_cnt; i++)
927 free (v->short_names[i]);
928 free (v->short_names);
929 v->short_names = NULL;
930 v->short_name_cnt = 0;
933 /* Relationship with dictionary. */
935 /* Returns V's index within its dictionary, the value
936 for which "dict_get_var (dict, index)" will return V.
937 V must be in a dictionary. */
939 var_get_dict_index (const struct variable *v)
941 assert (v->vardict.dict_index != -1);
942 return v->vardict.dict_index;
945 /* Returns V's index within the case represented by its
946 dictionary, that is, the value for which "case_data_idx (case,
947 index)" will return the data for V in that case.
948 V must be in a dictionary. */
950 var_get_case_index (const struct variable *v)
952 assert (v->vardict.case_index != -1);
953 return v->vardict.case_index;
956 /* Returns V's auxiliary data, or a null pointer if none has been
959 var_get_aux (const struct variable *v)
964 /* Assign auxiliary data AUX to variable V, which must not
965 already have auxiliary data. Before V's auxiliary data is
966 cleared, AUX_DTOR(V) will be called. (var_dtor_free, below,
967 may be appropriate for use as AUX_DTOR.) */
969 var_attach_aux (const struct variable *v_,
970 void *aux, void (*aux_dtor) (struct variable *))
972 struct variable *v = (struct variable *) v_ ; /* cast away const */
973 assert (v->aux == NULL);
974 assert (aux != NULL);
976 v->aux_dtor = aux_dtor;
980 /* Remove auxiliary data, if any, from V, and return it, without
981 calling any associated destructor. */
983 var_detach_aux (struct variable *v)
986 assert (aux != NULL);
991 /* Clears auxiliary data, if any, from V, and calls any
992 associated destructor. */
994 var_clear_aux (struct variable *v)
999 if (v->aux_dtor != NULL)
1005 /* This function is appropriate for use an auxiliary data
1006 destructor (passed as AUX_DTOR to var_attach_aux()) for the
1007 case where the auxiliary data should be passed to free(). */
1009 var_dtor_free (struct variable *v)
1014 /* Observed categorical values. */
1016 /* Returns V's observed categorical values,
1017 which V must have. */
1019 var_get_obs_vals (const struct variable *v)
1021 assert (v->obs_vals != NULL);
1025 /* Sets V's observed categorical values to CAT_VALS.
1026 V becomes the owner of CAT_VALS. */
1028 var_set_obs_vals (const struct variable *v_, struct cat_vals *cat_vals)
1030 struct variable *v = (struct variable *) v_ ; /* cast away const */
1031 cat_stored_values_destroy (v->obs_vals);
1032 v->obs_vals = cat_vals;
1035 /* Returns true if V has observed categorical values,
1038 var_has_obs_vals (const struct variable *v)
1040 return v->obs_vals != NULL;
1043 /* Returns variable V's attribute set. The caller may examine or
1044 modify the attribute set, but must not destroy it. Destroying
1045 V, or calling var_set_attributes() on V, will also destroy its
1048 var_get_attributes (const struct variable *v)
1050 return (struct attrset *) &v->attributes;
1053 /* Replaces variable V's attributes set by a copy of ATTRS. */
1055 var_set_attributes (struct variable *v, const struct attrset *attrs)
1057 attrset_destroy (&v->attributes);
1058 attrset_clone (&v->attributes, attrs);
1061 /* Returns true if V has any custom attributes, false if it has none. */
1063 var_has_attributes (const struct variable *v)
1065 return attrset_count (&v->attributes) > 0;
1068 /* Returns V's vardict structure. */
1069 const struct vardict_info *
1070 var_get_vardict (const struct variable *v)
1072 assert (var_has_vardict (v));
1076 /* Sets V's vardict data to VARDICT. */
1078 var_set_vardict (struct variable *v, const struct vardict_info *vardict)
1080 assert (vardict->dict_index >= 0);
1081 assert (vardict->case_index >= 0);
1082 v->vardict = *vardict;
1085 /* Returns true if V has vardict data. */
1087 var_has_vardict (const struct variable *v)
1089 return v->vardict.dict_index != -1;
1092 /* Clears V's vardict data. */
1094 var_clear_vardict (struct variable *v)
1096 v->vardict.dict_index = v->vardict.case_index = -1;