1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007 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/>. */
19 #include "dictionary.h"
27 #include "value-labels.h"
31 #include <libpspp/alloc.h>
32 #include <libpspp/array.h>
33 #include <libpspp/compiler.h>
34 #include <libpspp/hash.h>
35 #include <libpspp/message.h>
36 #include <libpspp/misc.h>
37 #include <libpspp/pool.h>
38 #include <libpspp/str.h>
43 #define _(msgid) gettext (msgid)
48 struct variable **var; /* Variables. */
49 size_t var_cnt, var_cap; /* Number of variables, capacity. */
50 struct hsh_table *name_tab; /* Variable index by name. */
51 int next_value_idx; /* Index of next `union value' to allocate. */
52 const struct variable **split; /* SPLIT FILE vars. */
53 size_t split_cnt; /* SPLIT FILE count. */
54 struct variable *weight; /* WEIGHT variable. */
55 struct variable *filter; /* FILTER variable. */
56 size_t case_limit; /* Current case limit (N command). */
57 char *label; /* File label. */
58 struct string documents; /* Documents, as a string. */
59 struct vector **vector; /* Vectors of variables. */
60 size_t vector_cnt; /* Number of vectors. */
61 const struct dict_callbacks *callbacks; /* Callbacks on dictionary
63 void *cb_data ; /* Data passed to callbacks */
66 /* Print a representation of dictionary D to stdout, for
67 debugging purposes. */
69 dict_dump (const struct dictionary *d)
72 for (i = 0 ; i < d->var_cnt ; ++i )
74 const struct variable *v =
76 printf ("Name: %s;\tdict_idx: %d; case_idx: %d\n",
78 var_get_dict_index (v),
79 var_get_case_index (v));
84 /* Associate CALLBACKS with DICT. Callbacks will be invoked whenever
85 the dictionary or any of the variables it contains are modified.
86 Each callback will get passed CALLBACK_DATA.
87 Any callback may be NULL, in which case it'll be ignored.
90 dict_set_callbacks (struct dictionary *dict,
91 const struct dict_callbacks *callbacks,
94 dict->callbacks = callbacks;
95 dict->cb_data = callback_data;
98 /* Shallow copy the callbacks from SRC to DEST */
100 dict_copy_callbacks (struct dictionary *dest,
101 const struct dictionary *src)
103 dest->callbacks = src->callbacks;
104 dest->cb_data = src->cb_data;
107 /* Creates and returns a new dictionary. */
111 struct dictionary *d = xzalloc (sizeof *d);
113 d->name_tab = hsh_create (8, compare_vars_by_name, hash_var_by_name,
118 /* Creates and returns a (deep) copy of an existing
121 dict_clone (const struct dictionary *s)
123 struct dictionary *d;
130 for (i = 0; i < s->var_cnt; i++)
132 struct variable *sv = s->var[i];
133 struct variable *dv = dict_clone_var_assert (d, sv, var_get_name (sv));
136 for (i = 0; i < var_get_short_name_cnt (sv); i++)
137 var_set_short_name (dv, i, var_get_short_name (sv, i));
140 d->next_value_idx = s->next_value_idx;
142 d->split_cnt = s->split_cnt;
143 if (d->split_cnt > 0)
145 d->split = xnmalloc (d->split_cnt, sizeof *d->split);
146 for (i = 0; i < d->split_cnt; i++)
147 d->split[i] = dict_lookup_var_assert (d, var_get_name (s->split[i]));
150 if (s->weight != NULL)
151 dict_set_weight (d, dict_lookup_var_assert (d, var_get_name (s->weight)));
153 if (s->filter != NULL)
154 dict_set_filter (d, dict_lookup_var_assert (d, var_get_name (s->filter)));
156 d->case_limit = s->case_limit;
157 dict_set_label (d, dict_get_label (s));
158 dict_set_documents (d, dict_get_documents (s));
160 d->vector_cnt = s->vector_cnt;
161 d->vector = xnmalloc (d->vector_cnt, sizeof *d->vector);
162 for (i = 0; i < s->vector_cnt; i++)
163 d->vector[i] = vector_clone (s->vector[i], s, d);
168 /* Clears the contents from a dictionary without destroying the
169 dictionary itself. */
171 dict_clear (struct dictionary *d)
173 /* FIXME? Should we really clear case_limit, label, documents?
174 Others are necessarily cleared by deleting all the variables.*/
177 while (d->var_cnt > 0 )
179 struct variable *v = d->var[d->var_cnt - 1];
180 int dict_index = var_get_dict_index (v);
181 int case_index = var_get_case_index (v);
182 int val_cnt = var_get_value_cnt (v);
184 var_clear_vardict (v);
189 if (d->callbacks && d->callbacks->var_deleted )
190 d->callbacks->var_deleted (d,
191 dict_index, case_index, val_cnt,
197 d->var_cnt = d->var_cap = 0;
198 hsh_clear (d->name_tab);
199 d->next_value_idx = 0;
200 dict_set_split_vars (d, NULL, 0);
201 dict_set_weight (d, NULL);
202 dict_set_filter (d, NULL);
206 ds_destroy (&d->documents);
207 dict_clear_vectors (d);
210 /* Destroys the aux data for every variable in D, by calling
211 var_clear_aux() for each variable. */
213 dict_clear_aux (struct dictionary *d)
219 for (i = 0; i < d->var_cnt; i++)
220 var_clear_aux (d->var[i]);
223 /* Clears a dictionary and destroys it. */
225 dict_destroy (struct dictionary *d)
229 /* In general, we don't want callbacks occuring, if the dictionary
230 is being destroyed */
231 d->callbacks = NULL ;
234 hsh_destroy (d->name_tab);
239 /* Returns the number of variables in D. */
241 dict_get_var_cnt (const struct dictionary *d)
248 /* Returns the variable in D with dictionary index IDX, which
249 must be between 0 and the count returned by
250 dict_get_var_cnt(), exclusive. */
252 dict_get_var (const struct dictionary *d, size_t idx)
255 assert (idx < d->var_cnt);
261 dict_get_vars (const struct dictionary *d, const struct variable ***vars,
262 size_t *cnt, unsigned exclude_classes)
264 dict_get_vars_mutable (d, (struct variable ***) vars, cnt, exclude_classes);
267 /* Sets *VARS to an array of pointers to variables in D and *CNT
268 to the number of variables in *D. All variables are returned
269 if EXCLUDE_CLASSES is 0, or it may contain one or more of (1u
270 << DC_ORDINARY), (1u << DC_SYSTEM), or (1u << DC_SCRATCH) to
271 exclude the corresponding type of variable. */
273 dict_get_vars_mutable (const struct dictionary *d, struct variable ***vars,
274 size_t *cnt, unsigned exclude_classes)
280 assert (vars != NULL);
281 assert (cnt != NULL);
282 assert ((exclude_classes & ~((1u << DC_ORDINARY)
284 | (1u << DC_SCRATCH))) == 0);
287 for (i = 0; i < d->var_cnt; i++)
289 enum dict_class class = dict_class_from_id (var_get_name (d->var[i]));
290 if (!(exclude_classes & (1u << class)))
294 *vars = xnmalloc (count, sizeof **vars);
296 for (i = 0; i < d->var_cnt; i++)
298 enum dict_class class = dict_class_from_id (var_get_name (d->var[i]));
299 if (!(exclude_classes & (1u << class)))
300 (*vars)[(*cnt)++] = d->var[i];
302 assert (*cnt == count);
305 static struct variable *
306 add_var (struct dictionary *d, struct variable *v)
308 /* Add dictionary info to variable. */
309 struct vardict_info vdi;
310 vdi.case_index = d->next_value_idx;
311 vdi.dict_index = d->var_cnt;
313 var_set_vardict (v, &vdi);
315 /* Update dictionary. */
316 if (d->var_cnt >= d->var_cap)
318 d->var_cap = 8 + 2 * d->var_cap;
319 d->var = xnrealloc (d->var, d->var_cap, sizeof *d->var);
321 d->var[d->var_cnt++] = v;
322 hsh_force_insert (d->name_tab, v);
324 if ( d->callbacks && d->callbacks->var_added )
325 d->callbacks->var_added (d, var_get_dict_index (v), d->cb_data);
327 d->next_value_idx += var_get_value_cnt (v);
332 /* Creates and returns a new variable in D with the given NAME
333 and WIDTH. Returns a null pointer if the given NAME would
334 duplicate that of an existing variable in the dictionary. */
336 dict_create_var (struct dictionary *d, const char *name, int width)
338 return (dict_lookup_var (d, name) == NULL
339 ? dict_create_var_assert (d, name, width)
343 /* Creates and returns a new variable in D with the given NAME
344 and WIDTH. Assert-fails if the given NAME would duplicate
345 that of an existing variable in the dictionary. */
347 dict_create_var_assert (struct dictionary *d, const char *name, int width)
349 assert (dict_lookup_var (d, name) == NULL);
350 return add_var (d, var_create (name, width));
353 /* Creates and returns a new variable in D with name NAME, as a
354 copy of existing variable OLD_VAR, which need not be in D or
355 in any dictionary. Returns a null pointer if the given NAME
356 would duplicate that of an existing variable in the
359 dict_clone_var (struct dictionary *d, const struct variable *old_var,
362 return (dict_lookup_var (d, name) == NULL
363 ? dict_clone_var_assert (d, old_var, name)
367 /* Creates and returns a new variable in D with name NAME, as a
368 copy of existing variable OLD_VAR, which need not be in D or
369 in any dictionary. Assert-fails if the given NAME would
370 duplicate that of an existing variable in the dictionary. */
372 dict_clone_var_assert (struct dictionary *d, const struct variable *old_var,
375 struct variable *new_var = var_clone (old_var);
376 assert (dict_lookup_var (d, name) == NULL);
377 var_set_name (new_var, name);
378 return add_var (d, new_var);
381 /* Returns the variable named NAME in D, or a null pointer if no
382 variable has that name. */
384 dict_lookup_var (const struct dictionary *d, const char *name)
386 struct variable *target ;
387 struct variable *result ;
389 if ( ! var_is_valid_name (name, false))
392 target = var_create (name, 0);
393 result = hsh_find (d->name_tab, target);
394 var_destroy (target);
399 /* Returns the variable named NAME in D. Assert-fails if no
400 variable has that name. */
402 dict_lookup_var_assert (const struct dictionary *d, const char *name)
404 struct variable *v = dict_lookup_var (d, name);
409 /* Returns true if variable V is in dictionary D,
412 dict_contains_var (const struct dictionary *d, const struct variable *v)
414 if (var_has_vardict (v))
416 const struct vardict_info *vdi = var_get_vardict (v);
417 return (vdi->dict_index >= 0
418 && vdi->dict_index < d->var_cnt
419 && d->var[vdi->dict_index] == v);
425 /* Compares two double pointers to variables, which should point
426 to elements of a struct dictionary's `var' member array. */
428 compare_var_ptrs (const void *a_, const void *b_, const void *aux UNUSED)
430 struct variable *const *a = a_;
431 struct variable *const *b = b_;
433 return *a < *b ? -1 : *a > *b;
436 /* Sets the dict_index in V's vardict to DICT_INDEX. */
438 set_var_dict_index (struct variable *v, int dict_index)
440 struct vardict_info vdi = *var_get_vardict (v);
441 struct dictionary *d = vdi.dict;
442 vdi.dict_index = dict_index;
443 var_set_vardict (v, &vdi);
445 if ( d->callbacks && d->callbacks->var_changed )
446 d->callbacks->var_changed (d, dict_index, d->cb_data);
449 /* Sets the case_index in V's vardict to CASE_INDEX. */
451 set_var_case_index (struct variable *v, int case_index)
453 struct vardict_info vdi = *var_get_vardict (v);
454 vdi.case_index = case_index;
455 var_set_vardict (v, &vdi);
458 /* Re-sets the dict_index in the dictionary variables with
459 indexes from FROM to TO (exclusive). */
461 reindex_vars (struct dictionary *d, size_t from, size_t to)
465 for (i = from; i < to; i++)
466 set_var_dict_index (d->var[i], i);
469 /* Deletes variable V from dictionary D and frees V.
471 This is a very bad idea if there might be any pointers to V
472 from outside D. In general, no variable in the active file's
473 dictionary should be deleted when any transformations are
474 active on the dictionary's dataset, because those
475 transformations might reference the deleted variable. The
476 safest time to delete a variable is just after a procedure has
477 been executed, as done by MODIFY VARS.
479 Pointers to V within D are not a problem, because
480 dict_delete_var() knows to remove V from split variables,
481 weights, filters, etc. */
483 dict_delete_var (struct dictionary *d, struct variable *v)
485 int dict_index = var_get_dict_index (v);
486 const int case_index = var_get_case_index (v);
487 const int val_cnt = var_get_value_cnt (v);
489 assert (dict_contains_var (d, v));
491 /* Delete aux data. */
494 dict_unset_split_var (d, v);
497 dict_set_weight (d, NULL);
500 dict_set_filter (d, NULL);
502 dict_clear_vectors (d);
504 /* Remove V from var array. */
505 remove_element (d->var, d->var_cnt, sizeof *d->var, dict_index);
508 /* Update dict_index for each affected variable. */
509 reindex_vars (d, dict_index, d->var_cnt);
511 /* Update name hash. */
512 hsh_force_delete (d->name_tab, v);
516 var_clear_vardict (v);
519 if (d->callbacks && d->callbacks->var_deleted )
520 d->callbacks->var_deleted (d, dict_index, case_index, val_cnt, d->cb_data);
523 /* Deletes the COUNT variables listed in VARS from D. This is
524 unsafe; see the comment on dict_delete_var() for details. */
526 dict_delete_vars (struct dictionary *d,
527 struct variable *const *vars, size_t count)
529 /* FIXME: this can be done in O(count) time, but this algorithm
532 assert (count == 0 || vars != NULL);
535 dict_delete_var (d, *vars++);
538 /* Deletes the COUNT variables in D starting at index IDX. This
539 is unsafe; see the comment on dict_delete_var() for
542 dict_delete_consecutive_vars (struct dictionary *d, size_t idx, size_t count)
544 /* FIXME: this can be done in O(count) time, but this algorithm
546 assert (idx + count <= d->var_cnt);
549 dict_delete_var (d, d->var[idx]);
552 /* Deletes scratch variables from dictionary D. */
554 dict_delete_scratch_vars (struct dictionary *d)
558 /* FIXME: this can be done in O(count) time, but this algorithm
562 for (i = 0; i < d->var_cnt; )
563 if (dict_class_from_id (var_get_name (d->var[i])) == DC_SCRATCH)
564 dict_delete_var (d, d->var[i]);
569 /* Moves V to 0-based position IDX in D. Other variables in D,
570 if any, retain their relative positions. Runs in time linear
571 in the distance moved. */
573 dict_reorder_var (struct dictionary *d, struct variable *v, size_t new_index)
575 size_t old_index = var_get_dict_index (v);
577 assert (new_index < d->var_cnt);
578 move_element (d->var, d->var_cnt, sizeof *d->var, old_index, new_index);
579 reindex_vars (d, MIN (old_index, new_index), MAX (old_index, new_index) + 1);
582 /* Reorders the variables in D, placing the COUNT variables
583 listed in ORDER in that order at the beginning of D. The
584 other variables in D, if any, retain their relative
587 dict_reorder_vars (struct dictionary *d,
588 struct variable *const *order, size_t count)
590 struct variable **new_var;
594 assert (count == 0 || order != NULL);
595 assert (count <= d->var_cnt);
597 new_var = xnmalloc (d->var_cnt, sizeof *new_var);
598 memcpy (new_var, order, count * sizeof *new_var);
599 for (i = 0; i < count; i++)
601 size_t index = var_get_dict_index (order[i]);
602 assert (d->var[index] == order[i]);
603 d->var[index] = NULL;
604 set_var_dict_index (order[i], i);
606 for (i = 0; i < d->var_cnt; i++)
607 if (d->var[i] != NULL)
609 assert (count < d->var_cnt);
610 new_var[count] = d->var[i];
611 set_var_dict_index (new_var[count], count);
618 /* Changes the name of variable V in dictionary D to NEW_NAME. */
620 rename_var (struct dictionary *d, struct variable *v, const char *new_name)
622 struct vardict_info vdi;
624 assert (dict_contains_var (d, v));
626 vdi = *var_get_vardict (v);
627 var_clear_vardict (v);
628 var_set_name (v, new_name);
629 var_set_vardict (v, &vdi);
632 /* Changes the name of V in D to name NEW_NAME. Assert-fails if
633 a variable named NEW_NAME is already in D, except that
634 NEW_NAME may be the same as V's existing name. */
636 dict_rename_var (struct dictionary *d, struct variable *v,
637 const char *new_name)
639 assert (!strcasecmp (var_get_name (v), new_name)
640 || dict_lookup_var (d, new_name) == NULL);
642 hsh_force_delete (d->name_tab, v);
643 rename_var (d, v, new_name);
644 hsh_force_insert (d->name_tab, v);
646 if (get_algorithm () == ENHANCED)
647 var_clear_short_names (v);
649 if ( d->callbacks && d->callbacks->var_changed )
650 d->callbacks->var_changed (d, var_get_dict_index (v), d->cb_data);
653 /* Renames COUNT variables specified in VARS to the names given
654 in NEW_NAMES within dictionary D. If the renaming would
655 result in a duplicate variable name, returns false and stores a
656 name that would be duplicated into *ERR_NAME (if ERR_NAME is
657 non-null). Otherwise, the renaming is successful, and true
660 dict_rename_vars (struct dictionary *d,
661 struct variable **vars, char **new_names, size_t count,
668 assert (count == 0 || vars != NULL);
669 assert (count == 0 || new_names != NULL);
671 /* Save the names of the variables to be renamed. */
672 pool = pool_create ();
673 old_names = pool_nalloc (pool, count, sizeof *old_names);
674 for (i = 0; i < count; i++)
675 old_names[i] = pool_strdup (pool, var_get_name (vars[i]));
677 /* Remove the variables to be renamed from the name hash,
679 for (i = 0; i < count; i++)
681 hsh_force_delete (d->name_tab, vars[i]);
682 rename_var (d, vars[i], new_names[i]);
685 /* Add the renamed variables back into the name hash,
686 checking for conflicts. */
687 for (i = 0; i < count; i++)
688 if (hsh_insert (d->name_tab, vars[i]) != NULL)
690 /* There is a name conflict.
691 Back out all the name changes that have already
692 taken place, and indicate failure. */
694 if (err_name != NULL)
695 *err_name = new_names[i];
697 for (i = 0; i < fail_idx; i++)
698 hsh_force_delete (d->name_tab, vars[i]);
700 for (i = 0; i < count; i++)
702 rename_var (d, vars[i], old_names[i]);
703 hsh_force_insert (d->name_tab, vars[i]);
710 /* Clear short names. */
711 if (get_algorithm () == ENHANCED)
712 for (i = 0; i < count; i++)
713 var_clear_short_names (vars[i]);
719 /* Returns the weighting variable in dictionary D, or a null
720 pointer if the dictionary is unweighted. */
722 dict_get_weight (const struct dictionary *d)
725 assert (d->weight == NULL || dict_contains_var (d, d->weight));
730 /* Returns the value of D's weighting variable in case C, except that a
731 negative weight is returned as 0. Returns 1 if the dictionary is
732 unweighted. Will warn about missing, negative, or zero values if
733 warn_on_invalid is true. The function will set warn_on_invalid to false
734 if an invalid weight is found. */
736 dict_get_case_weight (const struct dictionary *d, const struct ccase *c,
737 bool *warn_on_invalid)
742 if (d->weight == NULL)
746 double w = case_num (c, d->weight);
747 if (w < 0.0 || var_is_num_missing (d->weight, w, MV_ANY))
749 if ( w == 0.0 && warn_on_invalid != NULL && *warn_on_invalid ) {
750 *warn_on_invalid = false;
751 msg (SW, _("At least one case in the data file had a weight value "
752 "that was user-missing, system-missing, zero, or "
753 "negative. These case(s) were ignored."));
759 /* Sets the weighting variable of D to V, or turning off
760 weighting if V is a null pointer. */
762 dict_set_weight (struct dictionary *d, struct variable *v)
765 assert (v == NULL || dict_contains_var (d, v));
766 assert (v == NULL || var_is_numeric (v));
770 if ( d->callbacks && d->callbacks->weight_changed )
771 d->callbacks->weight_changed (d,
772 v ? var_get_dict_index (v) : -1,
776 /* Returns the filter variable in dictionary D (see cmd_filter())
777 or a null pointer if the dictionary is unfiltered. */
779 dict_get_filter (const struct dictionary *d)
782 assert (d->filter == NULL || dict_contains_var (d, d->filter));
787 /* Sets V as the filter variable for dictionary D. Passing a
788 null pointer for V turn off filtering. */
790 dict_set_filter (struct dictionary *d, struct variable *v)
793 assert (v == NULL || dict_contains_var (d, v));
797 if ( d->callbacks && d->callbacks->filter_changed )
798 d->callbacks->filter_changed (d,
799 v ? var_get_dict_index (v) : -1,
803 /* Returns the case limit for dictionary D, or zero if the number
804 of cases is unlimited. */
806 dict_get_case_limit (const struct dictionary *d)
810 return d->case_limit;
813 /* Sets CASE_LIMIT as the case limit for dictionary D. Use
814 0 for CASE_LIMIT to indicate no limit. */
816 dict_set_case_limit (struct dictionary *d, size_t case_limit)
820 d->case_limit = case_limit;
823 /* Returns the case index of the next value to be added to D.
824 This value is the number of `union value's that need to be
825 allocated to store a case for dictionary D. */
827 dict_get_next_value_idx (const struct dictionary *d)
831 return d->next_value_idx;
834 /* Returns the number of bytes needed to store a case for
837 dict_get_case_size (const struct dictionary *d)
841 return sizeof (union value) * dict_get_next_value_idx (d);
844 /* Reassigns values in dictionary D so that fragmentation is
847 dict_compact_values (struct dictionary *d)
851 d->next_value_idx = 0;
852 for (i = 0; i < d->var_cnt; i++)
854 struct variable *v = d->var[i];
855 set_var_case_index (v, d->next_value_idx);
856 d->next_value_idx += var_get_value_cnt (v);
861 Reassigns case indices for D, increasing each index above START by
865 dict_pad_values (struct dictionary *d, int start, int padding)
872 for (i = 0; i < d->var_cnt; ++i)
874 struct variable *v = d->var[i];
876 int index = var_get_case_index (v);
879 set_var_case_index (v, index + padding);
882 d->next_value_idx += padding;
886 /* Returns the number of values occupied by the variables in
887 dictionary D. All variables are considered if EXCLUDE_CLASSES
888 is 0, or it may contain one or more of (1u << DC_ORDINARY),
889 (1u << DC_SYSTEM), or (1u << DC_SCRATCH) to exclude the
890 corresponding type of variable.
892 The return value may be less than the number of values in one
893 of dictionary D's cases (as returned by
894 dict_get_next_value_idx) even if E is 0, because there may be
895 gaps in D's cases due to deleted variables. */
897 dict_count_values (const struct dictionary *d, unsigned int exclude_classes)
902 assert ((exclude_classes & ~((1u << DC_ORDINARY)
904 | (1u << DC_SCRATCH))) == 0);
907 for (i = 0; i < d->var_cnt; i++)
909 enum dict_class class = dict_class_from_id (var_get_name (d->var[i]));
910 if (!(exclude_classes & (1u << class)))
911 cnt += var_get_value_cnt (d->var[i]);
916 /* Returns the SPLIT FILE vars (see cmd_split_file()). Call
917 dict_get_split_cnt() to determine how many SPLIT FILE vars
918 there are. Returns a null pointer if and only if there are no
920 const struct variable *const *
921 dict_get_split_vars (const struct dictionary *d)
928 /* Returns the number of SPLIT FILE vars. */
930 dict_get_split_cnt (const struct dictionary *d)
937 /* Removes variable V from the set of split variables in dictionary D */
939 dict_unset_split_var (struct dictionary *d,
942 const int count = d->split_cnt;
943 d->split_cnt = remove_equal (d->split, d->split_cnt, sizeof *d->split,
944 &v, compare_var_ptrs, NULL);
946 if ( count == d->split_cnt)
949 if ( d->callbacks && d->callbacks->split_changed )
950 d->callbacks->split_changed (d, d->cb_data);
953 /* Sets CNT split vars SPLIT in dictionary D. */
955 dict_set_split_vars (struct dictionary *d,
956 struct variable *const *split, size_t cnt)
959 assert (cnt == 0 || split != NULL);
962 d->split = cnt > 0 ? xnrealloc (d->split, cnt, sizeof *d->split) : NULL;
963 memcpy (d->split, split, cnt * sizeof *d->split);
965 if ( d->callbacks && d->callbacks->split_changed )
966 d->callbacks->split_changed (d, d->cb_data);
969 /* Returns the file label for D, or a null pointer if D is
970 unlabeled (see cmd_file_label()). */
972 dict_get_label (const struct dictionary *d)
979 /* Sets D's file label to LABEL, truncating it to a maximum of 60
982 dict_set_label (struct dictionary *d, const char *label)
989 else if (strlen (label) < 60)
990 d->label = xstrdup (label);
993 d->label = xmalloc (61);
994 memcpy (d->label, label, 60);
999 /* Returns the documents for D, or a null pointer if D has no
1000 documents. If the return value is nonnull, then the string
1001 will be an exact multiple of DOC_LINE_LENGTH bytes in length,
1002 with each segment corresponding to one line. */
1004 dict_get_documents (const struct dictionary *d)
1006 return ds_is_empty (&d->documents) ? NULL : ds_cstr (&d->documents);
1009 /* Sets the documents for D to DOCUMENTS, or removes D's
1010 documents if DOCUMENT is a null pointer. If DOCUMENTS is
1011 nonnull, then it should be an exact multiple of
1012 DOC_LINE_LENGTH bytes in length, with each segment
1013 corresponding to one line. */
1015 dict_set_documents (struct dictionary *d, const char *documents)
1019 ds_assign_cstr (&d->documents, documents != NULL ? documents : "");
1021 /* In case the caller didn't get it quite right, pad out the
1022 final line with spaces. */
1023 remainder = ds_length (&d->documents) % DOC_LINE_LENGTH;
1025 ds_put_char_multiple (&d->documents, ' ', DOC_LINE_LENGTH - remainder);
1028 /* Drops the documents from dictionary D. */
1030 dict_clear_documents (struct dictionary *d)
1032 ds_clear (&d->documents);
1035 /* Appends LINE to the documents in D. LINE will be truncated or
1036 padded on the right with spaces to make it exactly
1037 DOC_LINE_LENGTH bytes long. */
1039 dict_add_document_line (struct dictionary *d, const char *line)
1041 if (strlen (line) > DOC_LINE_LENGTH)
1043 /* Note to translators: "bytes" is correct, not characters */
1044 msg (SW, _("Truncating document line to %d bytes."), DOC_LINE_LENGTH);
1046 buf_copy_str_rpad (ds_put_uninit (&d->documents, DOC_LINE_LENGTH),
1047 DOC_LINE_LENGTH, line);
1050 /* Returns the number of document lines in dictionary D. */
1052 dict_get_document_line_cnt (const struct dictionary *d)
1054 return ds_length (&d->documents) / DOC_LINE_LENGTH;
1057 /* Copies document line number IDX from dictionary D into
1058 LINE, trimming off any trailing white space. */
1060 dict_get_document_line (const struct dictionary *d,
1061 size_t idx, struct string *line)
1063 assert (idx < dict_get_document_line_cnt (d));
1064 ds_assign_substring (line, ds_substr (&d->documents, idx * DOC_LINE_LENGTH,
1066 ds_rtrim (line, ss_cstr (CC_SPACES));
1069 /* Creates in D a vector named NAME that contains the CNT
1070 variables in VAR. Returns true if successful, or false if a
1071 vector named NAME already exists in D. */
1073 dict_create_vector (struct dictionary *d,
1075 struct variable **var, size_t cnt)
1079 assert (var != NULL);
1081 for (i = 0; i < cnt; i++)
1082 assert (dict_contains_var (d, var[i]));
1084 if (dict_lookup_vector (d, name) == NULL)
1086 d->vector = xnrealloc (d->vector, d->vector_cnt + 1, sizeof *d->vector);
1087 d->vector[d->vector_cnt++] = vector_create (name, var, cnt);
1094 /* Creates in D a vector named NAME that contains the CNT
1095 variables in VAR. A vector named NAME must not already exist
1098 dict_create_vector_assert (struct dictionary *d,
1100 struct variable **var, size_t cnt)
1102 assert (dict_lookup_vector (d, name) == NULL);
1103 dict_create_vector (d, name, var, cnt);
1106 /* Returns the vector in D with index IDX, which must be less
1107 than dict_get_vector_cnt (D). */
1108 const struct vector *
1109 dict_get_vector (const struct dictionary *d, size_t idx)
1112 assert (idx < d->vector_cnt);
1114 return d->vector[idx];
1117 /* Returns the number of vectors in D. */
1119 dict_get_vector_cnt (const struct dictionary *d)
1123 return d->vector_cnt;
1126 /* Looks up and returns the vector within D with the given
1128 const struct vector *
1129 dict_lookup_vector (const struct dictionary *d, const char *name)
1132 for (i = 0; i < d->vector_cnt; i++)
1133 if (!strcasecmp (vector_get_name (d->vector[i]), name))
1134 return d->vector[i];
1138 /* Deletes all vectors from D. */
1140 dict_clear_vectors (struct dictionary *d)
1144 for (i = 0; i < d->vector_cnt; i++)
1145 vector_destroy (d->vector[i]);
1152 /* Called from variable.c to notify the dictionary that some property of
1153 the variable has changed */
1155 dict_var_changed (const struct variable *v)
1157 if ( var_has_vardict (v))
1159 const struct vardict_info *vdi = var_get_vardict (v);
1160 struct dictionary *d;
1164 if ( d->callbacks && d->callbacks->var_changed )
1165 d->callbacks->var_changed (d, var_get_dict_index (v), d->cb_data);
1170 /* Called from variable.c to notify the dictionary that the variable's width
1173 dict_var_resized (const struct variable *v, int delta)
1175 if ( var_has_vardict (v))
1177 const struct vardict_info *vdi = var_get_vardict (v);
1178 struct dictionary *d;
1182 dict_pad_values (d, var_get_case_index(v) + 1, delta);
1184 if ( d->callbacks && d->callbacks->var_resized )
1185 d->callbacks->var_resized (d, var_get_dict_index (v), delta, d->cb_data);