gui: Fix behavior of print preview in psppire-output-window.
[pspp] / src / data / variable.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006, 2009, 2010, 2011 Free Software Foundation, Inc.
3
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.
8
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.
13
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/>. */
16
17 #include <config.h>
18
19 #include "data/variable.h"
20
21 #include <stdlib.h>
22
23 #include "data/attributes.h"
24 #include "data/data-out.h"
25 #include "data/dictionary.h"
26 #include "data/format.h"
27 #include "data/identifier.h"
28 #include "data/missing-values.h"
29 #include "data/settings.h"
30 #include "data/value-labels.h"
31 #include "data/vardict.h"
32 #include "libpspp/assertion.h"
33 #include "libpspp/compiler.h"
34 #include "libpspp/hash-functions.h"
35 #include "libpspp/i18n.h"
36 #include "libpspp/message.h"
37 #include "libpspp/misc.h"
38 #include "libpspp/str.h"
39
40 #include "gl/minmax.h"
41 #include "gl/xalloc.h"
42
43 #include "gettext.h"
44 #define _(msgid) gettext (msgid)
45
46 /* A variable. */
47 struct variable
48   {
49     /* Dictionary information. */
50     char *name;                 /* Variable name.  Mixed case. */
51     int width;                  /* 0 for numeric, otherwise string width. */
52     struct missing_values miss; /* Missing values. */
53     struct fmt_spec print;      /* Default format for PRINT. */
54     struct fmt_spec write;      /* Default format for WRITE. */
55     struct val_labs *val_labs;  /* Value labels. */
56     char *label;                /* Variable label. */
57
58     /* GUI information. */
59     enum measure measure;       /* Nominal, ordinal, or continuous. */
60     int display_width;          /* Width of data editor column. */
61     enum alignment alignment;   /* Alignment of data in GUI. */
62
63     /* Case information. */
64     bool leave;                 /* Leave value from case to case? */
65
66     /* Data for use by containing dictionary. */
67     struct vardict_info *vardict;
68
69     /* Used only for system and portable file input and output.
70        See short-names.h. */
71     char **short_names;
72     size_t short_name_cnt;
73
74     /* Each command may use these fields as needed. */
75     void *aux;
76     void (*aux_dtor) (struct variable *);
77
78     /* Custom attributes. */
79     struct attrset attributes;
80   };
81 \f
82 /* Creates and returns a new variable with the given NAME and
83    WIDTH and other fields initialized to default values.  The
84    variable is not added to a dictionary; for that, use
85    dict_create_var instead. */
86 struct variable *
87 var_create (const char *name, int width)
88 {
89   struct variable *v;
90   enum val_type type;
91
92   assert (width >= 0 && width <= MAX_STRING);
93
94   v = xmalloc (sizeof *v);
95   v->vardict = NULL;
96   v->name = NULL;
97   var_set_name (v, name);
98   v->width = width;
99   mv_init (&v->miss, width);
100   v->leave = var_must_leave (v);
101   type = val_type_from_width (width);
102   v->alignment = var_default_alignment (type);
103   v->measure = var_default_measure (type);
104   v->display_width = var_default_display_width (width);
105   v->print = v->write = var_default_formats (width);
106   v->val_labs = NULL;
107   v->label = NULL;
108   v->short_names = NULL;
109   v->short_name_cnt = 0;
110   v->aux = NULL;
111   v->aux_dtor = NULL;
112   attrset_init (&v->attributes);
113
114   return v;
115 }
116
117 /* Creates and returns a clone of OLD_VAR.  Most properties of
118    the new variable are copied from OLD_VAR, except:
119
120     - The variable's short name is not copied, because there is
121       no reason to give a new variable with potentially a new
122       name the same short name.
123
124     - The new variable is not added to OLD_VAR's dictionary by
125       default.  Use dict_clone_var, instead, to do that.
126 */
127 struct variable *
128 var_clone (const struct variable *old_var)
129 {
130   struct variable *new_var = var_create (var_get_name (old_var),
131                                          var_get_width (old_var));
132
133   var_set_missing_values (new_var, var_get_missing_values (old_var));
134   var_set_print_format (new_var, var_get_print_format (old_var));
135   var_set_write_format (new_var, var_get_write_format (old_var));
136   var_set_value_labels (new_var, var_get_value_labels (old_var));
137   var_set_label (new_var, var_get_label (old_var), false);
138   var_set_measure (new_var, var_get_measure (old_var));
139   var_set_display_width (new_var, var_get_display_width (old_var));
140   var_set_alignment (new_var, var_get_alignment (old_var));
141   var_set_leave (new_var, var_get_leave (old_var));
142   var_set_attributes (new_var, var_get_attributes (old_var));
143
144   return new_var;
145 }
146
147 /* Destroys variable V.
148    V must not belong to a dictionary.  If it does, use
149    dict_delete_var instead. */
150 void
151 var_destroy (struct variable *v)
152 {
153   if (v != NULL)
154     {
155       assert (!var_has_vardict (v));
156       mv_destroy (&v->miss);
157       var_clear_short_names (v);
158       var_clear_aux (v);
159       val_labs_destroy (v->val_labs);
160       var_clear_label (v);
161       free (v->name);
162       free (v);
163     }
164 }
165 \f
166 /* Variable names. */
167
168 /* Return variable V's name, as a UTF-8 encoded string. */
169 const char *
170 var_get_name (const struct variable *v)
171 {
172   return v->name;
173 }
174
175 /* Sets V's name to NAME, a UTF-8 encoded string.
176    Do not use this function for a variable in a dictionary.  Use
177    dict_rename_var instead. */
178 void
179 var_set_name (struct variable *v, const char *name)
180 {
181   assert (!var_has_vardict (v));
182   assert (id_is_plausible (name, false));
183
184   free (v->name);
185   v->name = xstrdup (name);
186   dict_var_changed (v);
187 }
188
189 /* Returns VAR's dictionary class. */
190 enum dict_class
191 var_get_dict_class (const struct variable *var)
192 {
193   return dict_class_from_id (var->name);
194 }
195
196 /* A hsh_compare_func that orders variables A and B by their
197    names. */
198 int
199 compare_vars_by_name (const void *a_, const void *b_, const void *aux UNUSED)
200 {
201   const struct variable *a = a_;
202   const struct variable *b = b_;
203
204   return strcasecmp (a->name, b->name);
205 }
206
207 /* A hsh_hash_func that hashes variable V based on its name. */
208 unsigned
209 hash_var_by_name (const void *v_, const void *aux UNUSED)
210 {
211   const struct variable *v = v_;
212
213   return hash_case_string (v->name, 0);
214 }
215
216 /* A hsh_compare_func that orders pointers to variables A and B
217    by their names. */
218 int
219 compare_var_ptrs_by_name (const void *a_, const void *b_,
220                           const void *aux UNUSED)
221 {
222   struct variable *const *a = a_;
223   struct variable *const *b = b_;
224
225   return strcasecmp (var_get_name (*a), var_get_name (*b));
226 }
227
228 /* A hsh_compare_func that orders pointers to variables A and B
229    by their dictionary indexes. */
230 int
231 compare_var_ptrs_by_dict_index (const void *a_, const void *b_,
232                                 const void *aux UNUSED)
233 {
234   struct variable *const *a = a_;
235   struct variable *const *b = b_;
236   size_t a_index = var_get_dict_index (*a);
237   size_t b_index = var_get_dict_index (*b);
238
239   return a_index < b_index ? -1 : a_index > b_index;
240 }
241
242 /* A hsh_hash_func that hashes pointer to variable V based on its
243    name. */
244 unsigned
245 hash_var_ptr_by_name (const void *v_, const void *aux UNUSED)
246 {
247   struct variable *const *v = v_;
248
249   return hash_case_string (var_get_name (*v), 0);
250 }
251 \f
252 /* Returns the type of variable V. */
253 enum val_type
254 var_get_type (const struct variable *v)
255 {
256   return val_type_from_width (v->width);
257 }
258
259 /* Returns the width of variable V. */
260 int
261 var_get_width (const struct variable *v)
262 {
263   return v->width;
264 }
265
266 /* Changes the width of V to NEW_WIDTH.
267    This function should be used cautiously. */
268 void
269 var_set_width (struct variable *v, int new_width)
270 {
271   const int old_width = v->width;
272
273   if (old_width == new_width)
274     return;
275
276   if (mv_is_resizable (&v->miss, new_width))
277     mv_resize (&v->miss, new_width);
278   else
279     {
280       mv_destroy (&v->miss);
281       mv_init (&v->miss, new_width);
282     }
283
284   if (v->val_labs != NULL)
285     {
286       if (val_labs_can_set_width (v->val_labs, new_width))
287         val_labs_set_width (v->val_labs, new_width);
288       else
289         {
290           val_labs_destroy (v->val_labs);
291           v->val_labs = NULL;
292         }
293     }
294
295   fmt_resize (&v->print, new_width);
296   fmt_resize (&v->write, new_width);
297
298   v->width = new_width;
299   dict_var_resized (v, old_width);
300   dict_var_changed (v);
301 }
302
303 /* Returns true if variable V is numeric, false otherwise. */
304 bool
305 var_is_numeric (const struct variable *v)
306 {
307   return var_get_type (v) == VAL_NUMERIC;
308 }
309
310 /* Returns true if variable V is a string variable, false
311    otherwise. */
312 bool
313 var_is_alpha (const struct variable *v)
314 {
315   return var_get_type (v) == VAL_STRING;
316 }
317 \f
318 /* Returns variable V's missing values. */
319 const struct missing_values *
320 var_get_missing_values (const struct variable *v)
321 {
322   return &v->miss;
323 }
324
325 /* Sets variable V's missing values to MISS, which must be of V's
326    width or at least resizable to V's width.
327    If MISS is null, then V's missing values, if any, are
328    cleared. */
329 void
330 var_set_missing_values (struct variable *v, const struct missing_values *miss)
331 {
332   if (miss != NULL)
333     {
334       assert (mv_is_resizable (miss, v->width));
335       mv_destroy (&v->miss);
336       mv_copy (&v->miss, miss);
337       mv_resize (&v->miss, v->width);
338     }
339   else
340     mv_clear (&v->miss);
341
342   dict_var_changed (v);
343 }
344
345 /* Sets variable V to have no user-missing values. */
346 void
347 var_clear_missing_values (struct variable *v)
348 {
349   var_set_missing_values (v, NULL);
350 }
351
352 /* Returns true if V has any user-missing values,
353    false otherwise. */
354 bool
355 var_has_missing_values (const struct variable *v)
356 {
357   return !mv_is_empty (&v->miss);
358 }
359
360 /* Returns true if VALUE is in the given CLASS of missing values
361    in V, false otherwise. */
362 bool
363 var_is_value_missing (const struct variable *v, const union value *value,
364                       enum mv_class class)
365 {
366   return mv_is_value_missing (&v->miss, value, class);
367 }
368
369 /* Returns true if D is in the given CLASS of missing values in
370    V, false otherwise.
371    V must be a numeric variable. */
372 bool
373 var_is_num_missing (const struct variable *v, double d, enum mv_class class)
374 {
375   return mv_is_num_missing (&v->miss, d, class);
376 }
377
378 /* Returns true if S[] is a missing value for V, false otherwise.
379    S[] must contain exactly as many characters as V's width.
380    V must be a string variable. */
381 bool
382 var_is_str_missing (const struct variable *v, const uint8_t s[],
383                     enum mv_class class)
384 {
385   return mv_is_str_missing (&v->miss, s, class);
386 }
387 \f
388 /* Returns variable V's value labels,
389    possibly a null pointer if it has none. */
390 const struct val_labs *
391 var_get_value_labels (const struct variable *v)
392 {
393   return v->val_labs;
394 }
395
396 /* Returns true if variable V has at least one value label. */
397 bool
398 var_has_value_labels (const struct variable *v)
399 {
400   return val_labs_count (v->val_labs) > 0;
401 }
402
403 /* Sets variable V's value labels to a copy of VLS,
404    which must have a width equal to V's width or one that can be
405    changed to V's width.
406    If VLS is null, then V's value labels, if any, are removed. */
407 void
408 var_set_value_labels (struct variable *v, const struct val_labs *vls)
409 {
410   val_labs_destroy (v->val_labs);
411   v->val_labs = NULL;
412
413   if (vls != NULL)
414     {
415       assert (val_labs_can_set_width (vls, v->width));
416       v->val_labs = val_labs_clone (vls);
417       val_labs_set_width (v->val_labs, v->width);
418       dict_var_changed (v);
419     }
420 }
421
422 /* Makes sure that V has a set of value labels,
423    by assigning one to it if necessary. */
424 static void
425 alloc_value_labels (struct variable *v)
426 {
427   if (v->val_labs == NULL)
428     v->val_labs = val_labs_create (v->width);
429 }
430
431 /* Attempts to add a value label with the given VALUE and UTF-8 encoded LABEL
432    to V.  Returns true if successful, false otherwise (probably due to an
433    existing label).
434
435    In LABEL, the two-byte sequence "\\n" is interpreted as a new-line. */
436 bool
437 var_add_value_label (struct variable *v,
438                      const union value *value, const char *label)
439 {
440   alloc_value_labels (v);
441   return val_labs_add (v->val_labs, value, label);
442 }
443
444 /* Adds or replaces a value label with the given VALUE and UTF-8 encoded LABEL
445    to V.
446
447    In LABEL, the two-byte sequence "\\n" is interpreted as a new-line. */
448 void
449 var_replace_value_label (struct variable *v,
450                          const union value *value, const char *label)
451 {
452   alloc_value_labels (v);
453   val_labs_replace (v->val_labs, value, label);
454 }
455
456 /* Removes V's value labels, if any. */
457 void
458 var_clear_value_labels (struct variable *v)
459 {
460   var_set_value_labels (v, NULL);
461 }
462
463 /* Returns the label associated with VALUE for variable V, as a UTF-8 string in
464    a format suitable for output, or a null pointer if none. */
465 const char *
466 var_lookup_value_label (const struct variable *v, const union value *value)
467 {
468   return val_labs_find (v->val_labs, value);
469 }
470
471 /*
472    Append to STR the string representation of VALUE for variable V.
473    STR must be a pointer to an initialised struct string.
474 */
475 static void
476 append_value (const struct variable *v, const union value *value,
477               struct string *str)
478 {
479   char *s = data_out (value, var_get_encoding (v), &v->print);
480   ds_put_cstr (str, s);
481   free (s);
482 }
483
484 /* Append STR with a string representing VALUE for variable V.
485    That is, if VALUE has a label, append that label,
486    otherwise format VALUE and append the formatted string.
487    STR must be a pointer to an initialised struct string.
488 */
489 void
490 var_append_value_name (const struct variable *v, const union value *value,
491                        struct string *str)
492 {
493   enum settings_value_style style = settings_get_value_style ();
494   const char *name = var_lookup_value_label (v, value);
495
496   switch (style)
497     {
498     case SETTINGS_VAL_STYLE_VALUES:
499       append_value (v, value, str);
500       break;
501       
502     case SETTINGS_VAL_STYLE_LABELS:
503       if (name == NULL)
504         append_value (v, value, str);
505       else
506         ds_put_cstr (str, name);
507       break;
508
509     case SETTINGS_VAL_STYLE_BOTH:
510     default:
511       append_value (v, value, str);
512       if (name != NULL)
513         {
514           ds_put_cstr (str, " (");
515           ds_put_cstr (str, name);
516           ds_put_cstr (str, ")");
517         }
518       break;
519     };
520 }
521 \f
522 /* Print and write formats. */
523
524 /* Returns V's print format specification. */
525 const struct fmt_spec *
526 var_get_print_format (const struct variable *v)
527 {
528   return &v->print;
529 }
530
531 /* Sets V's print format specification to PRINT, which must be a
532    valid format specification for a variable of V's width
533    (ordinarily an output format, but input formats are not
534    rejected). */
535 void
536 var_set_print_format (struct variable *v, const struct fmt_spec *print)
537 {
538   assert (fmt_check_width_compat (print, v->width));
539   v->print = *print;
540   dict_var_changed (v);
541 }
542
543 /* Returns V's write format specification. */
544 const struct fmt_spec *
545 var_get_write_format (const struct variable *v)
546 {
547   return &v->write;
548 }
549
550 /* Sets V's write format specification to WRITE, which must be a
551    valid format specification for a variable of V's width
552    (ordinarily an output format, but input formats are not
553    rejected). */
554 void
555 var_set_write_format (struct variable *v, const struct fmt_spec *write)
556 {
557   assert (fmt_check_width_compat (write, v->width));
558   v->write = *write;
559   dict_var_changed (v);
560 }
561
562 /* Sets V's print and write format specifications to FORMAT,
563    which must be a valid format specification for a variable of
564    V's width (ordinarily an output format, but input formats are
565    not rejected). */
566 void
567 var_set_both_formats (struct variable *v, const struct fmt_spec *format)
568 {
569   var_set_print_format (v, format);
570   var_set_write_format (v, format);
571 }
572
573 /* Returns the default print and write format for a variable of
574    the given TYPE, as set by var_create.  The return value can be
575    used to reset a variable's print and write formats to the
576    default. */
577 struct fmt_spec
578 var_default_formats (int width)
579 {
580   return (width == 0
581           ? fmt_for_output (FMT_F, 8, 2)
582           : fmt_for_output (FMT_A, width, 0));
583 }
584 \f
585 /* Return a string representing this variable, in the form most
586    appropriate from a human factors perspective, that is, its
587    variable label if it has one, otherwise its name. */
588 const char *
589 var_to_string (const struct variable *v)
590 {
591   return v->label != NULL ? v->label : v->name;
592 }
593
594 /* Returns V's variable label, or a null pointer if it has none. */
595 const char *
596 var_get_label (const struct variable *v)
597 {
598   return v->label;
599 }
600
601 /* Sets V's variable label to UTF-8 encoded string LABEL, stripping off leading
602    and trailing white space.  If LABEL is a null pointer or if LABEL is an
603    empty string (after stripping white space), then V's variable label (if any)
604    is removed.
605
606    Variable labels are limited to 255 bytes in V's encoding (as returned by
607    var_get_encoding()).  If LABEL fits within this limit, this function returns
608    true.  Otherwise, the variable label is set to a truncated value, this
609    function returns false and, if ISSUE_WARNING is true, issues a warning.  */
610 bool
611 var_set_label (struct variable *v, const char *label, bool issue_warning)
612 {
613   bool truncated = false;
614
615   free (v->label);
616   v->label = NULL;
617
618   if (label != NULL && label[strspn (label, CC_SPACES)])
619     {
620       const char *dict_encoding = var_get_encoding (v);
621       struct substring s = ss_cstr (label);
622       size_t trunc_len;
623
624       if (dict_encoding != NULL)
625         {
626           enum { MAX_LABEL_LEN = 255 };
627
628           trunc_len = utf8_encoding_trunc_len (label, dict_encoding,
629                                                MAX_LABEL_LEN);
630           if (ss_length (s) > trunc_len)
631             {
632               if (issue_warning)
633                 msg (SW, _("Truncating variable label for variable `%s' to %d "
634                            "bytes."), var_get_name (v), MAX_LABEL_LEN);
635               ss_truncate (&s, trunc_len);
636               truncated = true;
637             }
638         }
639
640         v->label = ss_xstrdup (s);
641     }
642
643   dict_var_changed (v);
644
645   return truncated;
646 }
647
648 /* Removes any variable label from V. */
649 void
650 var_clear_label (struct variable *v)
651 {
652   var_set_label (v, NULL, false);
653 }
654
655 /* Returns true if V has a variable V,
656    false otherwise. */
657 bool
658 var_has_label (const struct variable *v)
659 {
660   return v->label != NULL;
661 }
662 \f
663 /* Returns true if M is a valid variable measurement level,
664    false otherwise. */
665 bool
666 measure_is_valid (enum measure m)
667 {
668   return m == MEASURE_NOMINAL || m == MEASURE_ORDINAL || m == MEASURE_SCALE;
669 }
670
671 /* Returns a string version of measurement level M, for display to a user. */
672 const char *
673 measure_to_string (enum measure m)
674 {
675   switch (m)
676     {
677     case MEASURE_NOMINAL:
678       return _("Nominal");
679
680     case MEASURE_ORDINAL:
681       return _("Ordinal");
682
683     case MEASURE_SCALE:
684       return _("Scale");
685
686     default:
687       return "Invalid";
688     }
689 }
690
691 /* Returns V's measurement level. */
692 enum measure
693 var_get_measure (const struct variable *v)
694 {
695   return v->measure;
696 }
697
698 /* Sets V's measurement level to MEASURE. */
699 void
700 var_set_measure (struct variable *v, enum measure measure)
701 {
702   assert (measure_is_valid (measure));
703   v->measure = measure;
704   dict_var_changed (v);
705 }
706
707 /* Returns the default measurement level for a variable of the
708    given TYPE, as set by var_create.  The return value can be
709    used to reset a variable's measurement level to the
710    default. */
711 enum measure
712 var_default_measure (enum val_type type)
713 {
714   return type == VAL_NUMERIC ? MEASURE_SCALE : MEASURE_NOMINAL;
715 }
716 \f
717 /* Returns V's display width, which applies only to GUIs. */
718 int
719 var_get_display_width (const struct variable *v)
720 {
721   return v->display_width;
722 }
723
724 /* Sets V's display width to DISPLAY_WIDTH. */
725 void
726 var_set_display_width (struct variable *v, int new_width)
727 {
728   if (v->display_width != new_width)
729     {
730       v->display_width = new_width;
731       dict_var_display_width_changed (v);
732       dict_var_changed (v);
733     }
734 }
735
736 /* Returns the default display width for a variable of the given
737    WIDTH, as set by var_create.  The return value can be used to
738    reset a variable's display width to the default. */
739 int
740 var_default_display_width (int width)
741 {
742   return width == 0 ? 8 : MIN (width, 32);
743 }
744 \f
745 /* Returns true if A is a valid alignment,
746    false otherwise. */
747 bool
748 alignment_is_valid (enum alignment a)
749 {
750   return a == ALIGN_LEFT || a == ALIGN_RIGHT || a == ALIGN_CENTRE;
751 }
752
753 /* Returns a string version of alignment A, for display to a user. */
754 const char *
755 alignment_to_string (enum alignment a)
756 {
757   switch (a)
758     {
759     case ALIGN_LEFT:
760       return _("Left");
761
762     case ALIGN_RIGHT:
763       return _("Right");
764
765     case ALIGN_CENTRE:
766       return _("Center");
767
768     default:
769       return "Invalid";
770     }
771 }
772
773 /* Returns V's display alignment, which applies only to GUIs. */
774 enum alignment
775 var_get_alignment (const struct variable *v)
776 {
777   return v->alignment;
778 }
779
780 /* Sets V's display alignment to ALIGNMENT. */
781 void
782 var_set_alignment (struct variable *v, enum alignment alignment)
783 {
784   assert (alignment_is_valid (alignment));
785   v->alignment = alignment;
786   dict_var_changed (v);
787 }
788
789 /* Returns the default display alignment for a variable of the
790    given TYPE, as set by var_create.  The return value can be
791    used to reset a variable's display alignment to the default. */
792 enum alignment
793 var_default_alignment (enum val_type type)
794 {
795   return type == VAL_NUMERIC ? ALIGN_RIGHT : ALIGN_LEFT;
796 }
797 \f
798 /* Whether variables' values should be preserved from case to
799    case. */
800
801 /* Returns true if variable V's value should be left from case to
802    case, instead of being reset to system-missing or blanks. */
803 bool
804 var_get_leave (const struct variable *v)
805 {
806   return v->leave;
807 }
808
809 /* Sets V's leave setting to LEAVE. */
810 void
811 var_set_leave (struct variable *v, bool leave)
812 {
813   assert (leave || !var_must_leave (v));
814   v->leave = leave;
815   dict_var_changed (v);
816 }
817
818 /* Returns true if V must be left from case to case,
819    false if it can be set either way. */
820 bool
821 var_must_leave (const struct variable *v)
822 {
823   return var_get_dict_class (v) == DC_SCRATCH;
824 }
825 \f
826 /* Returns the number of short names stored in VAR.
827
828    Short names are used only for system and portable file input
829    and output.  They are upper-case only, not necessarily unique,
830    and limited to SHORT_NAME_LEN characters (plus a null
831    terminator).  Ordinarily a variable has at most one short
832    name, but very long string variables (longer than 255 bytes)
833    may have more.  A variable might not have any short name at
834    all if it hasn't been saved to or read from a system or
835    portable file. */
836 size_t
837 var_get_short_name_cnt (const struct variable *var) 
838 {
839   return var->short_name_cnt;
840 }
841
842 /* Returns VAR's short name with the given IDX, if it has one
843    with that index, or a null pointer otherwise.  Short names may
844    be sparse: even if IDX is less than the number of short names
845    in VAR, this function may return a null pointer. */
846 const char *
847 var_get_short_name (const struct variable *var, size_t idx)
848 {
849   return idx < var->short_name_cnt ? var->short_names[idx] : NULL;
850 }
851
852 /* Sets VAR's short name with the given IDX to the UTF-8 string SHORT_NAME.
853    The caller must already have checked that, in the dictionary encoding,
854    SHORT_NAME is no more than SHORT_NAME_LEN bytes long.  The new short name
855    will be converted to uppercase.
856
857    Specifying a null pointer for SHORT_NAME clears the specified short name. */
858 void
859 var_set_short_name (struct variable *var, size_t idx, const char *short_name)
860 {
861   assert (short_name == NULL || id_is_plausible (short_name, false));
862
863   /* Clear old short name numbered IDX, if any. */
864   if (idx < var->short_name_cnt) 
865     {
866       free (var->short_names[idx]);
867       var->short_names[idx] = NULL; 
868     }
869
870   /* Install new short name for IDX. */
871   if (short_name != NULL) 
872     {
873       if (idx >= var->short_name_cnt)
874         {
875           size_t old_cnt = var->short_name_cnt;
876           size_t i;
877           var->short_name_cnt = MAX (idx * 2, 1);
878           var->short_names = xnrealloc (var->short_names, var->short_name_cnt,
879                                         sizeof *var->short_names);
880           for (i = old_cnt; i < var->short_name_cnt; i++)
881             var->short_names[i] = NULL;
882         }
883       var->short_names[idx] = xstrdup (short_name);
884       str_uppercase (var->short_names[idx]);
885     }
886
887   dict_var_changed (var);
888 }
889
890 /* Clears V's short names. */
891 void
892 var_clear_short_names (struct variable *v)
893 {
894   size_t i;
895
896   for (i = 0; i < v->short_name_cnt; i++)
897     free (v->short_names[i]);
898   free (v->short_names);
899   v->short_names = NULL;
900   v->short_name_cnt = 0;
901 }
902 \f
903 /* Relationship with dictionary. */
904
905 /* Returns V's index within its dictionary, the value
906    for which "dict_get_var (dict, index)" will return V.
907    V must be in a dictionary. */
908 size_t
909 var_get_dict_index (const struct variable *v)
910 {
911   assert (var_has_vardict (v));
912   return vardict_get_dict_index (v->vardict);
913 }
914
915 /* Returns V's index within the case represented by its
916    dictionary, that is, the value for which "case_data_idx (case,
917    index)" will return the data for V in that case.
918    V must be in a dictionary. */
919 size_t
920 var_get_case_index (const struct variable *v)
921 {
922   assert (var_has_vardict (v));
923   return vardict_get_case_index (v->vardict);
924 }
925 \f
926 /* Returns V's auxiliary data, or a null pointer if none has been
927    attached. */
928 void *
929 var_get_aux (const struct variable *v)
930 {
931   return v->aux;
932 }
933
934 /* Assign auxiliary data AUX to variable V, which must not
935    already have auxiliary data.  Before V's auxiliary data is
936    cleared, AUX_DTOR(V) will be called.  (var_dtor_free, below,
937    may be appropriate for use as AUX_DTOR.) */
938 void *
939 var_attach_aux (const struct variable *v_,
940                 void *aux, void (*aux_dtor) (struct variable *))
941 {
942   struct variable *v = CONST_CAST (struct variable *, v_);
943   assert (v->aux == NULL);
944   assert (aux != NULL);
945   v->aux = aux;
946   v->aux_dtor = aux_dtor;
947   return aux;
948 }
949
950 /* Remove auxiliary data, if any, from V, and return it, without
951    calling any associated destructor. */
952 void *
953 var_detach_aux (struct variable *v)
954 {
955   void *aux = v->aux;
956   assert (aux != NULL);
957   v->aux = NULL;
958   return aux;
959 }
960
961 /* Clears auxiliary data, if any, from V, and calls any
962    associated destructor. */
963 void
964 var_clear_aux (struct variable *v)
965 {
966   if (v->aux != NULL)
967     {
968       if (v->aux_dtor != NULL)
969         v->aux_dtor (v);
970       v->aux = NULL;
971     }
972 }
973
974 /* This function is appropriate for use an auxiliary data
975    destructor (passed as AUX_DTOR to var_attach_aux()) for the
976    case where the auxiliary data should be passed to free(). */
977 void
978 var_dtor_free (struct variable *v)
979 {
980   free (v->aux);
981 }
982 \f
983 /* Returns variable V's attribute set.  The caller may examine or
984    modify the attribute set, but must not destroy it.  Destroying
985    V, or calling var_set_attributes() on V, will also destroy its
986    attribute set. */
987 struct attrset *
988 var_get_attributes (const struct variable *v) 
989 {
990   return CONST_CAST (struct attrset *, &v->attributes);
991 }
992
993 /* Replaces variable V's attributes set by a copy of ATTRS. */
994 void
995 var_set_attributes (struct variable *v, const struct attrset *attrs) 
996 {
997   attrset_destroy (&v->attributes);
998   attrset_clone (&v->attributes, attrs);
999 }
1000
1001 /* Returns true if V has any custom attributes, false if it has none. */
1002 bool
1003 var_has_attributes (const struct variable *v)
1004 {
1005   return attrset_count (&v->attributes) > 0;
1006 }
1007 \f
1008 /* Returns the encoding of values of variable VAR.  (This is actually a
1009    property of the dictionary.)  Returns null if no specific encoding has been
1010    set.  */
1011 const char *
1012 var_get_encoding (const struct variable *var)
1013 {
1014   return (var_has_vardict (var)
1015           ? dict_get_encoding (vardict_get_dictionary (var->vardict))
1016           : NULL);
1017 }
1018 \f
1019 /* Returns V's vardict structure. */
1020 struct vardict_info *
1021 var_get_vardict (const struct variable *v)
1022 {
1023   return CONST_CAST (struct vardict_info *, v->vardict);
1024 }
1025
1026 /* Sets V's vardict data to VARDICT. */
1027 void
1028 var_set_vardict (struct variable *v, struct vardict_info *vardict)
1029 {
1030   v->vardict = vardict;
1031 }
1032
1033 /* Returns true if V has vardict data. */
1034 bool
1035 var_has_vardict (const struct variable *v)
1036 {
1037   return v->vardict != NULL;
1038 }
1039
1040 /* Clears V's vardict data. */
1041 void
1042 var_clear_vardict (struct variable *v)
1043 {
1044   v->vardict = NULL;
1045 }