1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011, 2012, 2013, 2014,
3 2015, 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/dictionary.h"
27 #include "data/attributes.h"
28 #include "data/case.h"
29 #include "data/identifier.h"
30 #include "data/mrset.h"
31 #include "data/settings.h"
32 #include "data/value-labels.h"
33 #include "data/vardict.h"
34 #include "data/variable.h"
35 #include "data/vector.h"
36 #include "libpspp/array.h"
37 #include "libpspp/assertion.h"
38 #include "libpspp/compiler.h"
39 #include "libpspp/hash-functions.h"
40 #include "libpspp/hmap.h"
41 #include "libpspp/i18n.h"
42 #include "libpspp/message.h"
43 #include "libpspp/misc.h"
44 #include "libpspp/pool.h"
45 #include "libpspp/str.h"
46 #include "libpspp/string-array.h"
47 #include "libpspp/ll.h"
49 #include "gl/intprops.h"
50 #include "gl/minmax.h"
51 #include "gl/xalloc.h"
52 #include "gl/xmemdup0.h"
55 #define _(msgid) gettext (msgid)
61 struct vardict_info *var; /* Variables. */
62 size_t var_cnt, var_cap; /* Number of variables, capacity. */
63 struct caseproto *proto; /* Prototype for dictionary cases
65 struct hmap name_map; /* Variable index by name. */
66 int next_value_idx; /* Index of next `union value' to allocate. */
67 const struct variable **split; /* SPLIT FILE vars. */
68 size_t split_cnt; /* SPLIT FILE count. */
69 struct variable *weight; /* WEIGHT variable. */
70 struct variable *filter; /* FILTER variable. */
71 casenumber case_limit; /* Current case limit (N command). */
72 char *label; /* File label. */
73 struct string_array documents; /* Documents. */
74 struct vector **vector; /* Vectors of variables. */
75 size_t vector_cnt; /* Number of vectors. */
76 struct attrset attributes; /* Custom attributes. */
77 struct mrset **mrsets; /* Multiple response sets. */
78 size_t n_mrsets; /* Number of multiple response sets. */
80 /* Whether variable names must be valid identifiers. Normally, this is
81 true, but sometimes a dictionary is prepared for external use
82 (e.g. output to a CSV file) where names don't have to be valid. */
83 bool names_must_be_ids;
85 char *encoding; /* Character encoding of string data */
87 const struct dict_callbacks *callbacks; /* Callbacks on dictionary
89 void *cb_data ; /* Data passed to callbacks */
91 void (*changed) (struct dictionary *, void *); /* Generic change callback */
95 static void dict_unset_split_var (struct dictionary *, struct variable *, bool);
96 static void dict_unset_mrset_var (struct dictionary *, struct variable *);
98 /* Compares two double pointers to variables, which should point
99 to elements of a struct dictionary's `var' member array. */
101 compare_var_ptrs (const void *a_, const void *b_, const void *aux UNUSED)
103 struct variable *const *a = a_;
104 struct variable *const *b = b_;
106 return *a < *b ? -1 : *a > *b;
110 unindex_var (struct dictionary *d, struct vardict_info *vardict)
112 hmap_delete (&d->name_map, &vardict->name_node);
115 /* This function assumes that vardict->name_node.hash is valid, that is, that
116 its name has not changed since it was hashed (rename_var() updates this
117 hash along with the name itself). */
119 reindex_var (struct dictionary *d, struct vardict_info *vardict, bool skip_callbacks)
121 struct variable *old = (d->callbacks && d->callbacks->var_changed
122 ? var_clone (vardict->var)
125 struct variable *var = vardict->var;
126 var_set_vardict (var, vardict);
127 hmap_insert_fast (&d->name_map, &vardict->name_node,
128 vardict->name_node.hash);
130 if (! skip_callbacks)
132 if (d->changed) d->changed (d, d->changed_data);
135 d->callbacks->var_changed (d, var_get_dict_index (var), VAR_TRAIT_POSITION, old, d->cb_data);
141 /* Sets the case_index in V's vardict to CASE_INDEX. */
143 set_var_case_index (struct variable *v, int case_index)
145 var_get_vardict (v)->case_index = case_index;
148 /* Removes the dictionary variables with indexes from FROM to TO (exclusive)
151 unindex_vars (struct dictionary *d, size_t from, size_t to)
155 for (i = from; i < to; i++)
156 unindex_var (d, &d->var[i]);
159 /* Re-sets the dict_index in the dictionary variables with
160 indexes from FROM to TO (exclusive). */
162 reindex_vars (struct dictionary *d, size_t from, size_t to, bool skip_callbacks)
166 for (i = from; i < to; i++)
167 reindex_var (d, &d->var[i], skip_callbacks);
172 /* Returns the encoding for data in dictionary D. The return value is a
173 nonnull string that contains an IANA character set name. */
175 dict_get_encoding (const struct dictionary *d)
180 /* Returns true if UTF-8 string ID is an acceptable identifier in DICT's
181 encoding, false otherwise. If ISSUE_ERROR is true, issues an explanatory
182 error message on failure. */
184 dict_id_is_valid (const struct dictionary *dict, const char *id,
187 return (!dict->names_must_be_ids
188 || id_is_valid (id, dict->encoding, issue_error));
192 dict_set_change_callback (struct dictionary *d,
193 void (*changed) (struct dictionary *, void*),
196 d->changed = changed;
197 d->changed_data = data;
200 /* Discards dictionary D's caseproto. (It will be regenerated
201 lazily, on demand.) */
203 invalidate_proto (struct dictionary *d)
205 caseproto_unref (d->proto);
209 /* Print a representation of dictionary D to stdout, for
210 debugging purposes. */
212 dict_dump (const struct dictionary *d)
215 for (i = 0 ; i < d->var_cnt ; ++i)
217 const struct variable *v = d->var[i].var;
218 printf ("Name: %s;\tdict_idx: %zu; case_idx: %zu\n",
220 var_get_dict_index (v),
221 var_get_case_index (v));
226 /* Associate CALLBACKS with DICT. Callbacks will be invoked whenever
227 the dictionary or any of the variables it contains are modified.
228 Each callback will get passed CALLBACK_DATA.
229 Any callback may be NULL, in which case it'll be ignored.
232 dict_set_callbacks (struct dictionary *dict,
233 const struct dict_callbacks *callbacks,
236 dict->callbacks = callbacks;
237 dict->cb_data = callback_data;
240 /* Shallow copy the callbacks from SRC to DEST */
242 dict_copy_callbacks (struct dictionary *dest,
243 const struct dictionary *src)
245 dest->callbacks = src->callbacks;
246 dest->cb_data = src->cb_data;
249 /* Creates and returns a new dictionary with the specified ENCODING. */
251 dict_create (const char *encoding)
253 struct dictionary *d = xzalloc (sizeof *d);
255 d->encoding = xstrdup (encoding);
256 d->names_must_be_ids = true;
257 hmap_init (&d->name_map);
258 attrset_init (&d->attributes);
264 /* Creates and returns a (deep) copy of an existing
267 The new dictionary's case indexes are copied from the old
268 dictionary. If the new dictionary won't be used to access
269 cases produced with the old dictionary, then the new
270 dictionary's case indexes should be compacted with
271 dict_compact_values to save space.
273 Callbacks are not cloned. */
275 dict_clone (const struct dictionary *s)
277 struct dictionary *d;
280 d = dict_create (s->encoding);
281 dict_set_names_must_be_ids (d, dict_get_names_must_be_ids (s));
283 for (i = 0; i < s->var_cnt; i++)
285 struct variable *sv = s->var[i].var;
286 struct variable *dv = dict_clone_var_assert (d, sv);
289 for (i = 0; i < var_get_short_name_cnt (sv); i++)
290 var_set_short_name (dv, i, var_get_short_name (sv, i));
292 var_get_vardict (dv)->case_index = var_get_vardict (sv)->case_index;
295 d->next_value_idx = s->next_value_idx;
297 d->split_cnt = s->split_cnt;
298 if (d->split_cnt > 0)
300 d->split = xnmalloc (d->split_cnt, sizeof *d->split);
301 for (i = 0; i < d->split_cnt; i++)
302 d->split[i] = dict_lookup_var_assert (d, var_get_name (s->split[i]));
305 if (s->weight != NULL)
306 dict_set_weight (d, dict_lookup_var_assert (d, var_get_name (s->weight)));
308 if (s->filter != NULL)
309 dict_set_filter (d, dict_lookup_var_assert (d, var_get_name (s->filter)));
311 d->case_limit = s->case_limit;
312 dict_set_label (d, dict_get_label (s));
313 dict_set_documents (d, dict_get_documents (s));
315 d->vector_cnt = s->vector_cnt;
316 d->vector = xnmalloc (d->vector_cnt, sizeof *d->vector);
317 for (i = 0; i < s->vector_cnt; i++)
318 d->vector[i] = vector_clone (s->vector[i], s, d);
320 dict_set_attributes (d, dict_get_attributes (s));
322 for (i = 0; i < s->n_mrsets; i++)
324 const struct mrset *old = s->mrsets[i];
328 /* Clone old mrset, then replace vars from D by vars from S. */
329 new = mrset_clone (old);
330 for (j = 0; j < new->n_vars; j++)
331 new->vars[j] = dict_lookup_var_assert (d, var_get_name (new->vars[j]));
333 dict_add_mrset (d, new);
341 /* Returns the SPLIT FILE vars (see cmd_split_file()). Call
342 dict_get_split_cnt() to determine how many SPLIT FILE vars
343 there are. Returns a null pointer if and only if there are no
345 const struct variable *const *
346 dict_get_split_vars (const struct dictionary *d)
351 /* Returns the number of SPLIT FILE vars. */
353 dict_get_split_cnt (const struct dictionary *d)
358 /* Removes variable V, which must be in D, from D's set of split
361 dict_unset_split_var (struct dictionary *d, struct variable *v, bool skip_callbacks)
365 assert (dict_contains_var (d, v));
367 orig_count = d->split_cnt;
368 d->split_cnt = remove_equal (d->split, d->split_cnt, sizeof *d->split,
369 &v, compare_var_ptrs, NULL);
370 if (orig_count != d->split_cnt && !skip_callbacks)
372 if (d->changed) d->changed (d, d->changed_data);
373 /* We changed the set of split variables so invoke the
375 if (d->callbacks && d->callbacks->split_changed)
376 d->callbacks->split_changed (d, d->cb_data);
381 /* Sets CNT split vars SPLIT in dictionary D. */
383 dict_set_split_vars__ (struct dictionary *d,
384 struct variable *const *split, size_t cnt, bool skip_callbacks)
386 assert (cnt == 0 || split != NULL);
391 d->split = xnrealloc (d->split, cnt, sizeof *d->split) ;
392 memcpy (d->split, split, cnt * sizeof *d->split);
402 if (d->changed) d->changed (d, d->changed_data);
403 if (d->callbacks && d->callbacks->split_changed)
404 d->callbacks->split_changed (d, d->cb_data);
408 /* Sets CNT split vars SPLIT in dictionary D. */
410 dict_set_split_vars (struct dictionary *d,
411 struct variable *const *split, size_t cnt)
413 dict_set_split_vars__ (d, split, cnt, false);
418 /* Deletes variable V from dictionary D and frees V.
420 This is a very bad idea if there might be any pointers to V
421 from outside D. In general, no variable in the active dataset's
422 dictionary should be deleted when any transformations are
423 active on the dictionary's dataset, because those
424 transformations might reference the deleted variable. The
425 safest time to delete a variable is just after a procedure has
426 been executed, as done by DELETE VARIABLES.
428 Pointers to V within D are not a problem, because
429 dict_delete_var() knows to remove V from split variables,
430 weights, filters, etc. */
432 dict_delete_var__ (struct dictionary *d, struct variable *v, bool skip_callbacks)
434 int dict_index = var_get_dict_index (v);
435 const int case_index = var_get_case_index (v);
437 assert (dict_contains_var (d, v));
439 dict_unset_split_var (d, v, skip_callbacks);
440 dict_unset_mrset_var (d, v);
443 dict_set_weight (d, NULL);
446 dict_set_filter (d, NULL);
448 dict_clear_vectors (d);
450 /* Remove V from var array. */
451 unindex_vars (d, dict_index, d->var_cnt);
452 remove_element (d->var, d->var_cnt, sizeof *d->var, dict_index);
455 /* Update dict_index for each affected variable. */
456 reindex_vars (d, dict_index, d->var_cnt, skip_callbacks);
459 var_clear_vardict (v);
461 if (! skip_callbacks)
463 if (d->changed) d->changed (d, d->changed_data);
464 if (d->callbacks && d->callbacks->var_deleted)
465 d->callbacks->var_deleted (d, v, dict_index, case_index, d->cb_data);
468 invalidate_proto (d);
472 /* Deletes variable V from dictionary D and frees V.
474 This is a very bad idea if there might be any pointers to V
475 from outside D. In general, no variable in the active dataset's
476 dictionary should be deleted when any transformations are
477 active on the dictionary's dataset, because those
478 transformations might reference the deleted variable. The
479 safest time to delete a variable is just after a procedure has
480 been executed, as done by DELETE VARIABLES.
482 Pointers to V within D are not a problem, because
483 dict_delete_var() knows to remove V from split variables,
484 weights, filters, etc. */
486 dict_delete_var (struct dictionary *d, struct variable *v)
488 dict_delete_var__ (d, v, false);
492 /* Deletes the COUNT variables listed in VARS from D. This is
493 unsafe; see the comment on dict_delete_var() for details. */
495 dict_delete_vars (struct dictionary *d,
496 struct variable *const *vars, size_t count)
498 /* FIXME: this can be done in O(count) time, but this algorithm
500 assert (count == 0 || vars != NULL);
503 dict_delete_var (d, *vars++);
506 /* Deletes the COUNT variables in D starting at index IDX. This
507 is unsafe; see the comment on dict_delete_var() for
508 details. Deleting consecutive vars will result in less callbacks
509 compared to iterating over dict_delete_var.
510 A simple while loop over dict_delete_var will
511 produce (d->var_cnt - IDX) * COUNT variable changed callbacks
512 plus COUNT variable delete callbacks.
513 This here produces d->var_cnt - IDX variable changed callbacks
514 plus COUNT variable delete callbacks. */
516 dict_delete_consecutive_vars (struct dictionary *d, size_t idx, size_t count)
518 assert (idx + count <= d->var_cnt);
520 /* We need to store the variable and the corresponding case_index
521 for the delete callbacks later. We store them in a linked list.*/
524 struct variable *var;
527 struct ll_list list = LL_INITIALIZER (list);
529 for (size_t i = idx; i < idx + count; i++)
531 struct delvar *dv = xmalloc (sizeof (struct delvar));
533 struct variable *v = d->var[i].var;
535 dict_unset_split_var (d, v, false);
536 dict_unset_mrset_var (d, v);
539 dict_set_weight (d, NULL);
542 dict_set_filter (d, NULL);
545 dv->case_index = var_get_case_index (v);
546 ll_push_tail (&list, (struct ll *)dv);
549 dict_clear_vectors (d);
551 /* Remove variables from var array. */
552 unindex_vars (d, idx, d->var_cnt);
553 remove_range (d->var, d->var_cnt, sizeof *d->var, idx, count);
556 /* Reindexing will result variable-changed callback */
557 reindex_vars (d, idx, d->var_cnt, false);
559 invalidate_proto (d);
560 if (d->changed) d->changed (d, d->changed_data);
562 /* Now issue the variable delete callbacks and delete
563 the variables. The vardict is not valid at this point
564 anymore. That is the reason why we stored the
565 caseindex before reindexing. */
566 for (size_t vi = idx; vi < idx + count; vi++)
568 struct delvar *dv = (struct delvar *) ll_pop_head (&list);
569 var_clear_vardict (dv->var);
570 if (d->callbacks && d->callbacks->var_deleted)
571 d->callbacks->var_deleted (d, dv->var, vi, dv->case_index, d->cb_data);
577 /* Deletes scratch variables from dictionary D. */
579 dict_delete_scratch_vars (struct dictionary *d)
583 /* FIXME: this can be done in O(count) time, but this algorithm
585 for (i = 0; i < d->var_cnt;)
586 if (var_get_dict_class (d->var[i].var) == DC_SCRATCH)
587 dict_delete_var (d, d->var[i].var);
594 /* Clears the contents from a dictionary without destroying the
595 dictionary itself. */
597 dict_clear__ (struct dictionary *d, bool skip_callbacks)
599 /* FIXME? Should we really clear case_limit, label, documents?
600 Others are necessarily cleared by deleting all the variables.*/
601 while (d->var_cnt > 0)
603 dict_delete_var__ (d, d->var[d->var_cnt - 1].var, skip_callbacks);
608 d->var_cnt = d->var_cap = 0;
609 invalidate_proto (d);
610 hmap_clear (&d->name_map);
611 d->next_value_idx = 0;
612 dict_set_split_vars__ (d, NULL, 0, skip_callbacks);
621 dict_set_weight (d, NULL);
622 dict_set_filter (d, NULL);
627 string_array_clear (&d->documents);
628 dict_clear_vectors (d);
629 attrset_clear (&d->attributes);
632 /* Clears the contents from a dictionary without destroying the
633 dictionary itself. */
635 dict_clear (struct dictionary *d)
637 dict_clear__ (d, false);
640 /* Clears a dictionary and destroys it. */
642 _dict_destroy (struct dictionary *d)
644 /* In general, we don't want callbacks occurring, if the dictionary
645 is being destroyed */
646 d->callbacks = NULL ;
648 dict_clear__ (d, true);
649 string_array_destroy (&d->documents);
650 hmap_destroy (&d->name_map);
651 attrset_destroy (&d->attributes);
652 dict_clear_mrsets (d);
658 dict_ref (struct dictionary *d)
665 dict_unref (struct dictionary *d)
670 assert (d->ref_cnt >= 0);
675 /* Returns the number of variables in D. */
677 dict_get_var_cnt (const struct dictionary *d)
682 /* Returns the variable in D with dictionary index IDX, which
683 must be between 0 and the count returned by
684 dict_get_var_cnt(), exclusive. */
686 dict_get_var (const struct dictionary *d, size_t idx)
688 assert (idx < d->var_cnt);
690 return d->var[idx].var;
693 /* Sets *VARS to an array of pointers to variables in D and *CNT
694 to the number of variables in *D. All variables are returned
695 except for those, if any, in the classes indicated by EXCLUDE.
696 (There is no point in putting DC_SYSTEM in EXCLUDE as
697 dictionaries never include system variables.) */
699 dict_get_vars (const struct dictionary *d, const struct variable ***vars,
700 size_t *cnt, enum dict_class exclude)
702 dict_get_vars_mutable (d, (struct variable ***) vars, cnt, exclude);
705 /* Sets *VARS to an array of pointers to variables in D and *CNT
706 to the number of variables in *D. All variables are returned
707 except for those, if any, in the classes indicated by EXCLUDE.
708 (There is no point in putting DC_SYSTEM in EXCLUDE as
709 dictionaries never include system variables.) */
711 dict_get_vars_mutable (const struct dictionary *d, struct variable ***vars,
712 size_t *cnt, enum dict_class exclude)
717 assert (exclude == (exclude & DC_ALL));
720 for (i = 0; i < d->var_cnt; i++)
722 enum dict_class class = var_get_dict_class (d->var[i].var);
723 if (!(class & exclude))
727 *vars = xnmalloc (count, sizeof **vars);
729 for (i = 0; i < d->var_cnt; i++)
731 enum dict_class class = var_get_dict_class (d->var[i].var);
732 if (!(class & exclude))
733 (*vars)[(*cnt)++] = d->var[i].var;
735 assert (*cnt == count);
738 static struct variable *
739 add_var_with_case_index (struct dictionary *d, struct variable *v,
742 struct vardict_info *vardict;
744 assert (case_index >= d->next_value_idx);
746 /* Update dictionary. */
747 if (d->var_cnt >= d->var_cap)
751 d->var = x2nrealloc (d->var, &d->var_cap, sizeof *d->var);
752 hmap_clear (&d->name_map);
753 for (i = 0; i < d->var_cnt; i++)
755 var_set_vardict (d->var[i].var, &d->var[i]);
756 hmap_insert_fast (&d->name_map, &d->var[i].name_node,
757 d->var[i].name_node.hash);
761 vardict = &d->var[d->var_cnt++];
764 hmap_insert (&d->name_map, &vardict->name_node,
765 utf8_hash_case_string (var_get_name (v), 0));
766 vardict->case_index = case_index;
767 var_set_vardict (v, vardict);
769 if (d->changed) d->changed (d, d->changed_data);
770 if (d->callbacks && d->callbacks->var_added)
771 d->callbacks->var_added (d, var_get_dict_index (v), d->cb_data);
773 invalidate_proto (d);
774 d->next_value_idx = case_index + 1;
779 static struct variable *
780 add_var (struct dictionary *d, struct variable *v)
782 return add_var_with_case_index (d, v, d->next_value_idx);
785 /* Creates and returns a new variable in D with the given NAME
786 and WIDTH. Returns a null pointer if the given NAME would
787 duplicate that of an existing variable in the dictionary. */
789 dict_create_var (struct dictionary *d, const char *name, int width)
791 return (dict_lookup_var (d, name) == NULL
792 ? dict_create_var_assert (d, name, width)
796 /* Creates and returns a new variable in D with the given NAME
797 and WIDTH. Assert-fails if the given NAME would duplicate
798 that of an existing variable in the dictionary. */
800 dict_create_var_assert (struct dictionary *d, const char *name, int width)
802 assert (dict_lookup_var (d, name) == NULL);
803 return add_var (d, var_create (name, width));
806 /* Creates and returns a new variable in D, as a copy of existing variable
807 OLD_VAR, which need not be in D or in any dictionary. Returns a null
808 pointer if OLD_VAR's name would duplicate that of an existing variable in
811 dict_clone_var (struct dictionary *d, const struct variable *old_var)
813 return dict_clone_var_as (d, old_var, var_get_name (old_var));
816 /* Creates and returns a new variable in D, as a copy of existing variable
817 OLD_VAR, which need not be in D or in any dictionary. Assert-fails if
818 OLD_VAR's name would duplicate that of an existing variable in the
821 dict_clone_var_assert (struct dictionary *d, const struct variable *old_var)
823 return dict_clone_var_as_assert (d, old_var, var_get_name (old_var));
826 /* Creates and returns a new variable in D with name NAME, as a copy of
827 existing variable OLD_VAR, which need not be in D or in any dictionary.
828 Returns a null pointer if the given NAME would duplicate that of an existing
829 variable in the dictionary. */
831 dict_clone_var_as (struct dictionary *d, const struct variable *old_var,
834 return (dict_lookup_var (d, name) == NULL
835 ? dict_clone_var_as_assert (d, old_var, name)
839 /* Creates and returns a new variable in D with name NAME, as a copy of
840 existing variable OLD_VAR, which need not be in D or in any dictionary.
841 Assert-fails if the given NAME would duplicate that of an existing variable
842 in the dictionary. */
844 dict_clone_var_as_assert (struct dictionary *d, const struct variable *old_var,
847 struct variable *new_var = var_clone (old_var);
848 assert (dict_lookup_var (d, name) == NULL);
849 var_set_name (new_var, name);
850 return add_var (d, new_var);
854 dict_clone_var_in_place_assert (struct dictionary *d,
855 const struct variable *old_var)
857 assert (dict_lookup_var (d, var_get_name (old_var)) == NULL);
858 return add_var_with_case_index (d, var_clone (old_var),
859 var_get_case_index (old_var));
862 /* Returns the variable named NAME in D, or a null pointer if no
863 variable has that name. */
865 dict_lookup_var (const struct dictionary *d, const char *name)
867 struct vardict_info *vardict;
869 HMAP_FOR_EACH_WITH_HASH (vardict, struct vardict_info, name_node,
870 utf8_hash_case_string (name, 0), &d->name_map)
872 struct variable *var = vardict->var;
873 if (!utf8_strcasecmp (var_get_name (var), name))
880 /* Returns the variable named NAME in D. Assert-fails if no
881 variable has that name. */
883 dict_lookup_var_assert (const struct dictionary *d, const char *name)
885 struct variable *v = dict_lookup_var (d, name);
890 /* Returns true if variable V is in dictionary D,
893 dict_contains_var (const struct dictionary *d, const struct variable *v)
895 return (var_has_vardict (v)
896 && vardict_get_dictionary (var_get_vardict (v)) == d);
899 /* Moves V to 0-based position IDX in D. Other variables in D,
900 if any, retain their relative positions. Runs in time linear
901 in the distance moved. */
903 dict_reorder_var (struct dictionary *d, struct variable *v, size_t new_index)
905 size_t old_index = var_get_dict_index (v);
907 assert (new_index < d->var_cnt);
909 unindex_vars (d, MIN (old_index, new_index), MAX (old_index, new_index) + 1);
910 move_element (d->var, d->var_cnt, sizeof *d->var, old_index, new_index);
911 reindex_vars (d, MIN (old_index, new_index), MAX (old_index, new_index) + 1, false);
914 /* Reorders the variables in D, placing the COUNT variables
915 listed in ORDER in that order at the beginning of D. The
916 other variables in D, if any, retain their relative
919 dict_reorder_vars (struct dictionary *d,
920 struct variable *const *order, size_t count)
922 struct vardict_info *new_var;
925 assert (count == 0 || order != NULL);
926 assert (count <= d->var_cnt);
928 new_var = xnmalloc (d->var_cap, sizeof *new_var);
930 /* Add variables in ORDER to new_var. */
931 for (i = 0; i < count; i++)
933 struct vardict_info *old_var;
935 assert (dict_contains_var (d, order[i]));
937 old_var = var_get_vardict (order[i]);
938 new_var[i] = *old_var;
939 old_var->dict = NULL;
942 /* Add remaining variables to new_var. */
943 for (i = 0; i < d->var_cnt; i++)
944 if (d->var[i].dict != NULL)
945 new_var[count++] = d->var[i];
946 assert (count == d->var_cnt);
948 /* Replace old vardicts by new ones. */
952 hmap_clear (&d->name_map);
953 reindex_vars (d, 0, d->var_cnt, false);
956 /* Changes the name of variable V that is currently in a dictionary to
959 rename_var (struct variable *v, const char *new_name)
961 struct vardict_info *vardict = var_get_vardict (v);
962 var_clear_vardict (v);
963 var_set_name (v, new_name);
964 vardict->name_node.hash = utf8_hash_case_string (new_name, 0);
965 var_set_vardict (v, vardict);
968 /* Tries to changes the name of V in D to name NEW_NAME. Returns true if
969 successful, false if a variable (other than V) with the given name already
972 dict_try_rename_var (struct dictionary *d, struct variable *v,
973 const char *new_name)
975 struct variable *conflict = dict_lookup_var (d, new_name);
976 if (conflict && v != conflict)
979 struct variable *old = var_clone (v);
980 unindex_var (d, var_get_vardict (v));
981 rename_var (v, new_name);
982 reindex_var (d, var_get_vardict (v), false);
984 if (settings_get_algorithm () == ENHANCED)
985 var_clear_short_names (v);
987 if (d->changed) d->changed (d, d->changed_data);
988 if (d->callbacks && d->callbacks->var_changed)
989 d->callbacks->var_changed (d, var_get_dict_index (v), VAR_TRAIT_NAME, old, d->cb_data);
996 /* Changes the name of V in D to name NEW_NAME. Assert-fails if
997 a variable named NEW_NAME is already in D, except that
998 NEW_NAME may be the same as V's existing name. */
1000 dict_rename_var (struct dictionary *d, struct variable *v,
1001 const char *new_name)
1003 bool ok UNUSED = dict_try_rename_var (d, v, new_name);
1007 /* Renames COUNT variables specified in VARS to the names given
1008 in NEW_NAMES within dictionary D. If the renaming would
1009 result in a duplicate variable name, returns false and stores a
1010 name that would be duplicated into *ERR_NAME (if ERR_NAME is
1011 non-null). Otherwise, the renaming is successful, and true
1014 dict_rename_vars (struct dictionary *d,
1015 struct variable **vars, char **new_names, size_t count,
1022 assert (count == 0 || vars != NULL);
1023 assert (count == 0 || new_names != NULL);
1025 /* Save the names of the variables to be renamed. */
1026 pool = pool_create ();
1027 old_names = pool_nalloc (pool, count, sizeof *old_names);
1028 for (i = 0; i < count; i++)
1029 old_names[i] = pool_strdup (pool, var_get_name (vars[i]));
1031 /* Remove the variables to be renamed from the name hash,
1033 for (i = 0; i < count; i++)
1035 unindex_var (d, var_get_vardict (vars[i]));
1036 rename_var (vars[i], new_names[i]);
1039 /* Add the renamed variables back into the name hash,
1040 checking for conflicts. */
1041 for (i = 0; i < count; i++)
1043 if (dict_lookup_var (d, var_get_name (vars[i])) != NULL)
1045 /* There is a name conflict.
1046 Back out all the name changes that have already
1047 taken place, and indicate failure. */
1048 size_t fail_idx = i;
1049 if (err_name != NULL)
1050 *err_name = new_names[i];
1052 for (i = 0; i < fail_idx; i++)
1053 unindex_var (d, var_get_vardict (vars[i]));
1055 for (i = 0; i < count; i++)
1057 rename_var (vars[i], old_names[i]);
1058 reindex_var (d, var_get_vardict (vars[i]), false);
1061 pool_destroy (pool);
1064 reindex_var (d, var_get_vardict (vars[i]), false);
1067 /* Clear short names. */
1068 if (settings_get_algorithm () == ENHANCED)
1069 for (i = 0; i < count; i++)
1070 var_clear_short_names (vars[i]);
1072 pool_destroy (pool);
1076 /* Returns true if a variable named NAME may be inserted in DICT;
1077 that is, if there is not already a variable with that name in
1078 DICT and if NAME is not a reserved word. (The caller's checks
1079 have already verified that NAME is otherwise acceptable as a
1082 var_name_is_insertable (const struct dictionary *dict, const char *name)
1084 return (dict_lookup_var (dict, name) == NULL
1085 && lex_id_to_token (ss_cstr (name)) == T_ID);
1089 make_hinted_name (const struct dictionary *dict, const char *hint)
1091 size_t hint_len = strlen (hint);
1092 bool dropped = false;
1097 if (hint_len > ID_MAX_LEN)
1098 hint_len = ID_MAX_LEN;
1100 /* The allocation size here is OK: characters that are copied directly fit
1101 OK, and characters that are not copied directly are replaced by a single
1102 '_' byte. If u8_mbtouc() replaces bad input by 0xfffd, then that will get
1103 replaced by '_' too. */
1104 root = rp = xmalloc (hint_len + 1);
1105 for (ofs = 0; ofs < hint_len; ofs += mblen)
1109 mblen = u8_mbtouc (&uc, CHAR_CAST (const uint8_t *, hint + ofs),
1112 ? lex_uc_is_id1 (uc) && uc != '$'
1113 : lex_uc_is_idn (uc))
1120 rp += u8_uctomb (CHAR_CAST (uint8_t *, rp), uc, 6);
1122 else if (rp != root)
1127 if (root[0] != '\0')
1129 unsigned long int i;
1131 if (var_name_is_insertable (dict, root))
1134 for (i = 0; i < ULONG_MAX; i++)
1136 char suffix[INT_BUFSIZE_BOUND (i) + 1];
1140 if (!str_format_26adic (i + 1, true, &suffix[1], sizeof suffix - 1))
1143 name = utf8_encoding_concat (root, suffix, dict->encoding, 64);
1144 if (var_name_is_insertable (dict, name))
1159 make_numeric_name (const struct dictionary *dict, unsigned long int *num_start)
1161 unsigned long int number;
1163 for (number = num_start != NULL ? MAX (*num_start, 1) : 1;
1167 char name[3 + INT_STRLEN_BOUND (number) + 1];
1169 sprintf (name, "VAR%03lu", number);
1170 if (dict_lookup_var (dict, name) == NULL)
1172 if (num_start != NULL)
1173 *num_start = number + 1;
1174 return xstrdup (name);
1182 /* Devises and returns a variable name unique within DICT. The variable name
1183 is owned by the caller, which must free it with free() when it is no longer
1186 HINT, if it is non-null, is used as a suggestion that will be
1187 modified for suitability as a variable name and for
1190 If HINT is null or entirely unsuitable, a name in the form
1191 "VAR%03d" will be generated, where the smallest unused integer
1192 value is used. If NUM_START is non-null, then its value is
1193 used as the minimum numeric value to check, and it is updated
1194 to the next value to be checked.
1197 dict_make_unique_var_name (const struct dictionary *dict, const char *hint,
1198 unsigned long int *num_start)
1202 char *hinted_name = make_hinted_name (dict, hint);
1203 if (hinted_name != NULL)
1207 return make_numeric_name (dict, num_start);
1210 /* Returns whether variable names must be valid identifiers. Normally, this is
1211 true, but sometimes a dictionary is prepared for external use (e.g. output
1212 to a CSV file) where names don't have to be valid. */
1214 dict_get_names_must_be_ids (const struct dictionary *d)
1216 return d->names_must_be_ids;
1219 /* Sets whether variable names must be valid identifiers. Normally, this is
1220 true, but sometimes a dictionary is prepared for external use (e.g. output
1221 to a CSV file) where names don't have to be valid.
1223 Changing this setting from false to true doesn't make the dictionary check
1224 all the existing variable names, so it can cause an invariant violation. */
1226 dict_set_names_must_be_ids (struct dictionary *d, bool names_must_be_ids)
1228 d->names_must_be_ids = names_must_be_ids;
1231 /* Returns the weighting variable in dictionary D, or a null
1232 pointer if the dictionary is unweighted. */
1234 dict_get_weight (const struct dictionary *d)
1236 assert (d->weight == NULL || dict_contains_var (d, d->weight));
1241 /* Returns the value of D's weighting variable in case C, except
1242 that a negative weight is returned as 0. Returns 1 if the
1243 dictionary is unweighted. Will warn about missing, negative,
1244 or zero values if *WARN_ON_INVALID is true. The function will
1245 set *WARN_ON_INVALID to false if an invalid weight is
1248 dict_get_case_weight (const struct dictionary *d, const struct ccase *c,
1249 bool *warn_on_invalid)
1253 if (d->weight == NULL)
1257 double w = case_num (c, d->weight);
1259 return var_force_valid_weight (d->weight, w, warn_on_invalid);
1263 /* Returns the format to use for weights. */
1264 const struct fmt_spec *
1265 dict_get_weight_format (const struct dictionary *d)
1267 return d->weight ? var_get_print_format (d->weight) : &F_8_0;
1270 /* Sets the weighting variable of D to V, or turning off
1271 weighting if V is a null pointer. */
1273 dict_set_weight (struct dictionary *d, struct variable *v)
1275 assert (v == NULL || dict_contains_var (d, v));
1276 assert (v == NULL || var_is_numeric (v));
1280 if (d->changed) d->changed (d, d->changed_data);
1281 if (d->callbacks && d->callbacks->weight_changed)
1282 d->callbacks->weight_changed (d,
1283 v ? var_get_dict_index (v) : -1,
1287 /* Returns the filter variable in dictionary D (see cmd_filter())
1288 or a null pointer if the dictionary is unfiltered. */
1290 dict_get_filter (const struct dictionary *d)
1292 assert (d->filter == NULL || dict_contains_var (d, d->filter));
1297 /* Sets V as the filter variable for dictionary D. Passing a
1298 null pointer for V turn off filtering. */
1300 dict_set_filter (struct dictionary *d, struct variable *v)
1302 assert (v == NULL || dict_contains_var (d, v));
1303 assert (v == NULL || var_is_numeric (v));
1307 if (d->changed) d->changed (d, d->changed_data);
1308 if (d->callbacks && d->callbacks->filter_changed)
1309 d->callbacks->filter_changed (d,
1310 v ? var_get_dict_index (v) : -1,
1314 /* Returns the case limit for dictionary D, or zero if the number
1315 of cases is unlimited. */
1317 dict_get_case_limit (const struct dictionary *d)
1319 return d->case_limit;
1322 /* Sets CASE_LIMIT as the case limit for dictionary D. Use
1323 0 for CASE_LIMIT to indicate no limit. */
1325 dict_set_case_limit (struct dictionary *d, casenumber case_limit)
1327 d->case_limit = case_limit;
1330 /* Returns the prototype used for cases created by dictionary D. */
1331 const struct caseproto *
1332 dict_get_proto (const struct dictionary *d_)
1334 struct dictionary *d = CONST_CAST (struct dictionary *, d_);
1335 if (d->proto == NULL)
1339 d->proto = caseproto_create ();
1340 d->proto = caseproto_reserve (d->proto, d->var_cnt);
1341 for (i = 0; i < d->var_cnt; i++)
1342 d->proto = caseproto_set_width (d->proto,
1343 var_get_case_index (d->var[i].var),
1344 var_get_width (d->var[i].var));
1349 /* Returns the case index of the next value to be added to D.
1350 This value is the number of `union value's that need to be
1351 allocated to store a case for dictionary D. */
1353 dict_get_next_value_idx (const struct dictionary *d)
1355 return d->next_value_idx;
1358 /* Returns the number of bytes needed to store a case for
1361 dict_get_case_size (const struct dictionary *d)
1363 return sizeof (union value) * dict_get_next_value_idx (d);
1366 /* Reassigns values in dictionary D so that fragmentation is
1369 dict_compact_values (struct dictionary *d)
1373 d->next_value_idx = 0;
1374 for (i = 0; i < d->var_cnt; i++)
1376 struct variable *v = d->var[i].var;
1377 set_var_case_index (v, d->next_value_idx++);
1379 invalidate_proto (d);
1382 /* Returns the number of values occupied by the variables in
1383 dictionary D. All variables are considered if EXCLUDE_CLASSES
1384 is 0, or it may contain one or more of (1u << DC_ORDINARY),
1385 (1u << DC_SYSTEM), or (1u << DC_SCRATCH) to exclude the
1386 corresponding type of variable.
1388 The return value may be less than the number of values in one
1389 of dictionary D's cases (as returned by
1390 dict_get_next_value_idx) even if E is 0, because there may be
1391 gaps in D's cases due to deleted variables. */
1393 dict_count_values (const struct dictionary *d, unsigned int exclude_classes)
1398 assert ((exclude_classes & ~((1u << DC_ORDINARY)
1400 | (1u << DC_SCRATCH))) == 0);
1403 for (i = 0; i < d->var_cnt; i++)
1405 enum dict_class class = var_get_dict_class (d->var[i].var);
1406 if (!(exclude_classes & (1u << class)))
1412 /* Returns the case prototype that would result after deleting
1413 all variables from D that are not in one of the
1414 EXCLUDE_CLASSES and compacting the dictionary with
1417 The caller must unref the returned caseproto when it is no
1420 dict_get_compacted_proto (const struct dictionary *d,
1421 unsigned int exclude_classes)
1423 struct caseproto *proto;
1426 assert ((exclude_classes & ~((1u << DC_ORDINARY)
1428 | (1u << DC_SCRATCH))) == 0);
1430 proto = caseproto_create ();
1431 for (i = 0; i < d->var_cnt; i++)
1433 struct variable *v = d->var[i].var;
1434 if (!(exclude_classes & (1u << var_get_dict_class (v))))
1435 proto = caseproto_add_width (proto, var_get_width (v));
1439 /* Returns the file label for D, or a null pointer if D is
1440 unlabeled (see cmd_file_label()). */
1442 dict_get_label (const struct dictionary *d)
1447 /* Sets D's file label to LABEL, truncating it to at most 60 bytes in D's
1450 Removes D's label if LABEL is null or the empty string. */
1452 dict_set_label (struct dictionary *d, const char *label)
1455 if (label == NULL || label[0] == '\0')
1458 d->label = utf8_encoding_trunc (label, d->encoding, 60);
1461 /* Returns the documents for D, as an UTF-8 encoded string_array. The
1462 return value is always nonnull; if there are no documents then the
1463 string_arary is empty.*/
1464 const struct string_array *
1465 dict_get_documents (const struct dictionary *d)
1467 return &d->documents;
1470 /* Replaces the documents for D by NEW_DOCS, a UTF-8 encoded string_array. */
1472 dict_set_documents (struct dictionary *d, const struct string_array *new_docs)
1476 dict_clear_documents (d);
1478 for (i = 0; i < new_docs->n; i++)
1479 dict_add_document_line (d, new_docs->strings[i], false);
1482 /* Replaces the documents for D by UTF-8 encoded string NEW_DOCS, dividing it
1483 into individual lines at new-line characters. Each line is truncated to at
1484 most DOC_LINE_LENGTH bytes in D's encoding. */
1486 dict_set_documents_string (struct dictionary *d, const char *new_docs)
1490 dict_clear_documents (d);
1491 for (s = new_docs; *s != '\0';)
1493 size_t len = strcspn (s, "\n");
1494 char *line = xmemdup0 (s, len);
1495 dict_add_document_line (d, line, false);
1504 /* Drops the documents from dictionary D. */
1506 dict_clear_documents (struct dictionary *d)
1508 string_array_clear (&d->documents);
1511 /* Appends the UTF-8 encoded LINE to the documents in D. LINE will be
1512 truncated so that it is no more than 80 bytes in the dictionary's
1513 encoding. If this causes some text to be lost, and ISSUE_WARNING is true,
1514 then a warning will be issued. */
1516 dict_add_document_line (struct dictionary *d, const char *line,
1522 trunc_len = utf8_encoding_trunc_len (line, d->encoding, DOC_LINE_LENGTH);
1523 truncated = line[trunc_len] != '\0';
1524 if (truncated && issue_warning)
1526 /* Note to translators: "bytes" is correct, not characters */
1527 msg (SW, _("Truncating document line to %d bytes."), DOC_LINE_LENGTH);
1530 string_array_append_nocopy (&d->documents, xmemdup0 (line, trunc_len));
1535 /* Returns the number of document lines in dictionary D. */
1537 dict_get_document_line_cnt (const struct dictionary *d)
1539 return d->documents.n;
1542 /* Returns document line number IDX in dictionary D. The caller must not
1543 modify or free the returned string. */
1545 dict_get_document_line (const struct dictionary *d, size_t idx)
1547 assert (idx < d->documents.n);
1548 return d->documents.strings[idx];
1551 /* Creates in D a vector named NAME that contains the CNT
1552 variables in VAR. Returns true if successful, or false if a
1553 vector named NAME already exists in D. */
1555 dict_create_vector (struct dictionary *d,
1557 struct variable **var, size_t cnt)
1562 for (i = 0; i < cnt; i++)
1563 assert (dict_contains_var (d, var[i]));
1565 if (dict_lookup_vector (d, name) == NULL)
1567 d->vector = xnrealloc (d->vector, d->vector_cnt + 1, sizeof *d->vector);
1568 d->vector[d->vector_cnt++] = vector_create (name, var, cnt);
1575 /* Creates in D a vector named NAME that contains the CNT
1576 variables in VAR. A vector named NAME must not already exist
1579 dict_create_vector_assert (struct dictionary *d,
1581 struct variable **var, size_t cnt)
1583 assert (dict_lookup_vector (d, name) == NULL);
1584 dict_create_vector (d, name, var, cnt);
1587 /* Returns the vector in D with index IDX, which must be less
1588 than dict_get_vector_cnt (D). */
1589 const struct vector *
1590 dict_get_vector (const struct dictionary *d, size_t idx)
1592 assert (idx < d->vector_cnt);
1594 return d->vector[idx];
1597 /* Returns the number of vectors in D. */
1599 dict_get_vector_cnt (const struct dictionary *d)
1601 return d->vector_cnt;
1604 /* Looks up and returns the vector within D with the given
1606 const struct vector *
1607 dict_lookup_vector (const struct dictionary *d, const char *name)
1610 for (i = 0; i < d->vector_cnt; i++)
1611 if (!utf8_strcasecmp (vector_get_name (d->vector[i]), name))
1612 return d->vector[i];
1616 /* Deletes all vectors from D. */
1618 dict_clear_vectors (struct dictionary *d)
1622 for (i = 0; i < d->vector_cnt; i++)
1623 vector_destroy (d->vector[i]);
1630 /* Multiple response sets. */
1632 /* Returns the multiple response set in DICT with index IDX, which must be
1633 between 0 and the count returned by dict_get_n_mrsets(), exclusive. */
1634 const struct mrset *
1635 dict_get_mrset (const struct dictionary *dict, size_t idx)
1637 assert (idx < dict->n_mrsets);
1638 return dict->mrsets[idx];
1641 /* Returns the number of multiple response sets in DICT. */
1643 dict_get_n_mrsets (const struct dictionary *dict)
1645 return dict->n_mrsets;
1648 /* Looks for a multiple response set named NAME in DICT. If it finds one,
1649 returns its index; otherwise, returns SIZE_MAX. */
1651 dict_lookup_mrset_idx (const struct dictionary *dict, const char *name)
1655 for (i = 0; i < dict->n_mrsets; i++)
1656 if (!utf8_strcasecmp (name, dict->mrsets[i]->name))
1662 /* Looks for a multiple response set named NAME in DICT. If it finds one,
1663 returns it; otherwise, returns NULL. */
1664 const struct mrset *
1665 dict_lookup_mrset (const struct dictionary *dict, const char *name)
1667 size_t idx = dict_lookup_mrset_idx (dict, name);
1668 return idx != SIZE_MAX ? dict->mrsets[idx] : NULL;
1671 /* Adds MRSET to DICT, replacing any existing set with the same name. Returns
1672 true if a set was replaced, false if none existed with the specified name.
1674 Ownership of MRSET is transferred to DICT. */
1676 dict_add_mrset (struct dictionary *dict, struct mrset *mrset)
1680 assert (mrset_ok (mrset, dict));
1682 idx = dict_lookup_mrset_idx (dict, mrset->name);
1683 if (idx == SIZE_MAX)
1685 dict->mrsets = xrealloc (dict->mrsets,
1686 (dict->n_mrsets + 1) * sizeof *dict->mrsets);
1687 dict->mrsets[dict->n_mrsets++] = mrset;
1692 mrset_destroy (dict->mrsets[idx]);
1693 dict->mrsets[idx] = mrset;
1698 /* Looks for a multiple response set in DICT named NAME. If found, removes it
1699 from DICT and returns true. If none is found, returns false without
1702 Deleting one multiple response set causes the indexes of other sets within
1705 dict_delete_mrset (struct dictionary *dict, const char *name)
1707 size_t idx = dict_lookup_mrset_idx (dict, name);
1708 if (idx != SIZE_MAX)
1710 mrset_destroy (dict->mrsets[idx]);
1711 dict->mrsets[idx] = dict->mrsets[--dict->n_mrsets];
1718 /* Deletes all multiple response sets from DICT. */
1720 dict_clear_mrsets (struct dictionary *dict)
1724 for (i = 0; i < dict->n_mrsets; i++)
1725 mrset_destroy (dict->mrsets[i]);
1726 free (dict->mrsets);
1727 dict->mrsets = NULL;
1731 /* Removes VAR, which must be in DICT, from DICT's multiple response sets. */
1733 dict_unset_mrset_var (struct dictionary *dict, struct variable *var)
1737 assert (dict_contains_var (dict, var));
1739 for (i = 0; i < dict->n_mrsets;)
1741 struct mrset *mrset = dict->mrsets[i];
1744 for (j = 0; j < mrset->n_vars;)
1745 if (mrset->vars[j] == var)
1746 remove_element (mrset->vars, mrset->n_vars--,
1747 sizeof *mrset->vars, j);
1751 if (mrset->n_vars < 2)
1753 mrset_destroy (mrset);
1754 dict->mrsets[i] = dict->mrsets[--dict->n_mrsets];
1761 /* Returns D's attribute set. The caller may examine or modify
1762 the attribute set, but must not destroy it. Destroying D or
1763 calling dict_set_attributes for D will also destroy D's
1766 dict_get_attributes (const struct dictionary *d)
1768 return CONST_CAST (struct attrset *, &d->attributes);
1771 /* Replaces D's attributes set by a copy of ATTRS. */
1773 dict_set_attributes (struct dictionary *d, const struct attrset *attrs)
1775 attrset_destroy (&d->attributes);
1776 attrset_clone (&d->attributes, attrs);
1779 /* Returns true if D has at least one attribute in its attribute
1780 set, false if D's attribute set is empty. */
1782 dict_has_attributes (const struct dictionary *d)
1784 return attrset_count (&d->attributes) > 0;
1787 /* Called from variable.c to notify the dictionary that some property (indicated
1788 by WHAT) of the variable has changed. OLDVAR is a copy of V as it existed
1789 prior to the change. OLDVAR is destroyed by this function.
1792 dict_var_changed (const struct variable *v, unsigned int what, struct variable *oldvar)
1794 if (var_has_vardict (v))
1796 const struct vardict_info *vardict = var_get_vardict (v);
1797 struct dictionary *d = vardict->dict;
1802 if (what & (VAR_TRAIT_WIDTH | VAR_TRAIT_POSITION))
1803 invalidate_proto (d);
1805 if (d->changed) d->changed (d, d->changed_data);
1806 if (d->callbacks && d->callbacks->var_changed)
1807 d->callbacks->var_changed (d, var_get_dict_index (v), what, oldvar, d->cb_data);
1814 /* Dictionary used to contain "internal variables". */
1815 static struct dictionary *internal_dict;
1817 /* Create a variable of the specified WIDTH to be used for internal
1818 calculations only. The variable is assigned case index CASE_IDX. */
1820 dict_create_internal_var (int case_idx, int width)
1822 if (internal_dict == NULL)
1823 internal_dict = dict_create ("UTF-8");
1827 static int counter = INT_MAX / 2;
1828 struct variable *var;
1831 if (++counter == INT_MAX)
1832 counter = INT_MAX / 2;
1834 sprintf (name, "$internal%d", counter);
1835 var = dict_create_var (internal_dict, name, width);
1838 set_var_case_index (var, case_idx);
1844 /* Destroys VAR, which must have been created with
1845 dict_create_internal_var(). */
1847 dict_destroy_internal_var (struct variable *var)
1851 dict_delete_var (internal_dict, var);
1853 /* Destroy internal_dict if it has no variables left, just so that
1854 valgrind --leak-check --show-reachable won't show internal_dict. */
1855 if (dict_get_var_cnt (internal_dict) == 0)
1857 dict_unref (internal_dict);
1858 internal_dict = NULL;
1864 vardict_get_dict_index (const struct vardict_info *vardict)
1866 return vardict - vardict->dict->var;