Update GPG key for signing flatpaks.
[pspp] / data / dictionary.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2004, 2007 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 #ifndef DATA_DICTIONARY_H
18 #define DATA_DICTIONARY_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <data/case.h>
23 #include <data/dict-class.h>
24
25 struct string;
26 struct ccase;
27
28 /* Creating dictionaries. */
29 struct dictionary *dict_create (void);
30 struct dictionary *dict_clone (const struct dictionary *);
31
32
33 /* Clearing and destroying dictionaries. */
34 void dict_clear (struct dictionary *);
35 void dict_clear_aux (struct dictionary *);
36 void dict_destroy (struct dictionary *);
37
38 /* Common ways to access variables. */
39 struct variable *dict_lookup_var (const struct dictionary *, const char *);
40 struct variable *dict_lookup_var_assert (const struct dictionary *,
41                                          const char *);
42 struct variable *dict_get_var (const struct dictionary *, size_t position);
43 size_t dict_get_var_cnt (const struct dictionary *);
44
45 /* Other access to variables. */
46 bool dict_contains_var (const struct dictionary *, const struct variable *);
47 void dict_get_vars (const struct dictionary *,
48                     const struct variable ***vars, size_t *cnt,
49                     enum dict_class exclude);
50 void dict_get_vars_mutable (const struct dictionary *,
51                             struct variable ***vars, size_t *cnt,
52                             enum dict_class exclude);
53
54 /* Creating variables. */
55 struct variable *dict_create_var (struct dictionary *, const char *,
56                                   int width);
57 struct variable *dict_create_var_assert (struct dictionary *, const char *,
58                                          int width);
59 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
60                                  const char *);
61 struct variable *dict_clone_var_assert (struct dictionary *,
62                                         const struct variable *, const char *);
63
64 /* Deleting variables. */
65 void dict_delete_var (struct dictionary *, struct variable *);
66 void dict_delete_vars (struct dictionary *,
67                        struct variable *const *, size_t count);
68 void dict_delete_consecutive_vars (struct dictionary *,
69                                    size_t idx, size_t count);
70 void dict_delete_scratch_vars (struct dictionary *);
71
72 /* Changing the order of variables. */
73 void dict_reorder_var (struct dictionary *, struct variable *,
74                        size_t new_index);
75 void dict_reorder_vars (struct dictionary *,
76                         struct variable *const *, size_t count);
77
78 /* Variable names. */
79 void dict_rename_var (struct dictionary *, struct variable *, const char *);
80 bool dict_rename_vars (struct dictionary *,
81                        struct variable **, char **new_names,
82                        size_t count, char **err_name);
83 bool dict_make_unique_var_name (const struct dictionary *, const char *hint,
84                                 unsigned long int *num_start,
85                                 char name[]);
86
87 /* Weight variable. */
88 double dict_get_case_weight (const struct dictionary *,
89                              const struct ccase *, bool *);
90 struct variable *dict_get_weight (const struct dictionary *);
91 void dict_set_weight (struct dictionary *, struct variable *);
92
93 /* Filter variable. */
94 struct variable *dict_get_filter (const struct dictionary *);
95 void dict_set_filter (struct dictionary *, struct variable *);
96
97 /* Case limit (N OF CASES). */
98 casenumber dict_get_case_limit (const struct dictionary *);
99 void dict_set_case_limit (struct dictionary *, casenumber);
100
101 /* Size of cases for this dictionary. */
102 int dict_get_next_value_idx (const struct dictionary *);
103 size_t dict_get_case_size (const struct dictionary *);
104
105 /* Making this dictionary's cases smaller (if some variables were
106    deleted). */
107 size_t dict_count_values (const struct dictionary *,
108                           unsigned int exclude_classes);
109 void dict_compact_values (struct dictionary *);
110
111 /* SPLIT FILE variables. */
112 const struct variable *const *dict_get_split_vars (const struct dictionary *);
113 size_t dict_get_split_cnt (const struct dictionary *);
114 void dict_set_split_vars (struct dictionary *,
115                           struct variable *const *, size_t cnt);
116 void dict_unset_split_var (struct dictionary *, struct variable *);
117
118 /* File label. */
119 const char *dict_get_label (const struct dictionary *);
120 void dict_set_label (struct dictionary *, const char *);
121
122 /* Documents. */
123 #define DOC_LINE_LENGTH 80 /* Fixed length of document lines. */
124
125 const char *dict_get_documents (const struct dictionary *);
126 void dict_set_documents (struct dictionary *, const char *);
127 void dict_clear_documents (struct dictionary *);
128
129 void dict_add_document_line (struct dictionary *, const char *);
130 size_t dict_get_document_line_cnt (const struct dictionary *);
131 void dict_get_document_line (const struct dictionary *,
132                              size_t, struct string *);
133
134 /* Vectors. */
135 bool dict_create_vector (struct dictionary *, const char *name,
136                          struct variable **, size_t cnt);
137 void dict_create_vector_assert (struct dictionary *, const char *name,
138                                 struct variable **, size_t cnt);
139 const struct vector *dict_get_vector (const struct dictionary *, size_t idx);
140 size_t dict_get_vector_cnt (const struct dictionary *);
141 const struct vector *dict_lookup_vector (const struct dictionary *,
142                                          const char *name);
143 void dict_clear_vectors (struct dictionary *);
144
145 /* Functions to be called upon dictionary changes. */
146 struct dict_callbacks
147  {
148   void (*var_added) (struct dictionary *, int, void *);
149   void (*var_deleted) (struct dictionary *, int, int, int, void *);
150   void (*var_changed) (struct dictionary *, int, void *);
151   void (*var_resized) (struct dictionary *, int, int, void *);
152   void (*weight_changed) (struct dictionary *, int, void *);
153   void (*filter_changed) (struct dictionary *, int, void *);
154   void (*split_changed) (struct dictionary *, void *);
155  };
156
157 void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *,
158                          void *);
159 void dict_copy_callbacks (struct dictionary *, const struct dictionary *);
160
161 /* Debug use only. */
162 void dict_dump (const struct dictionary *);
163
164 #endif /* data/dictionary.h */