Implemented the find dialog.
[pspp] / src / 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 DICTIONARY_H
18 #define DICTIONARY_H
19
20 #include <stdbool.h>
21 #include <stddef.h>
22
23 /* Dictionary. */
24
25 struct variable;
26 struct dictionary;
27 struct string;
28
29 struct dict_callbacks
30  {
31   void (*var_added) (struct dictionary *, int, void *);
32   void (*var_deleted) (struct dictionary *, int, int, int, void *);
33   void (*var_changed) (struct dictionary *, int, void *);
34   void (*var_resized) (struct dictionary *, int, int, void *);
35   void (*weight_changed) (struct dictionary *, int, void *);
36   void (*filter_changed) (struct dictionary *, int, void *);
37   void (*split_changed) (struct dictionary *, void *);
38  };
39
40
41 struct dictionary *dict_create (void);
42 struct dictionary *dict_clone (const struct dictionary *);
43 void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *,
44                          void *);
45 void dict_copy_callbacks (struct dictionary *, const struct dictionary *);
46
47
48 void dict_clear (struct dictionary *);
49 void dict_clear_aux (struct dictionary *);
50 void dict_destroy (struct dictionary *);
51
52 size_t dict_get_var_cnt (const struct dictionary *);
53 struct variable *dict_get_var (const struct dictionary *, size_t idx);
54 inline void dict_get_vars (const struct dictionary *,
55                     const struct variable ***vars, size_t *cnt,
56                     unsigned exclude_classes);
57 void dict_get_vars_mutable (const struct dictionary *,
58                     struct variable ***vars, size_t *cnt,
59                     unsigned exclude_classes);
60
61 struct variable *dict_create_var (struct dictionary *, const char *,
62                                   int width);
63
64 struct variable *dict_create_var_assert (struct dictionary *, const char *,
65                                   int width);
66 struct variable *dict_clone_var (struct dictionary *, const struct variable *,
67                                  const char *);
68 struct variable *dict_clone_var_assert (struct dictionary *,
69                                         const struct variable *, const char *);
70
71 struct variable *dict_lookup_var (const struct dictionary *, const char *);
72 struct variable *dict_lookup_var_assert (const struct dictionary *,
73                                          const char *);
74 bool dict_contains_var (const struct dictionary *, const struct variable *);
75 void dict_delete_var (struct dictionary *, struct variable *);
76 void dict_delete_vars (struct dictionary *,
77                        struct variable *const *, size_t count);
78 void dict_delete_consecutive_vars (struct dictionary *d,
79                                    size_t idx, size_t count);
80 void dict_delete_scratch_vars (struct dictionary *);
81 void dict_reorder_var (struct dictionary *d, struct variable *v,
82                        size_t new_index);
83 void dict_reorder_vars (struct dictionary *,
84                         struct variable *const *, size_t count);
85 void dict_rename_var (struct dictionary *, struct variable *, const char *);
86 bool dict_rename_vars (struct dictionary *,
87                        struct variable **, char **new_names,
88                        size_t count, char **err_name);
89
90 struct ccase;
91 struct variable *dict_get_weight (const struct dictionary *);
92 double dict_get_case_weight (const struct dictionary *,
93                              const struct ccase *, bool *);
94 void dict_set_weight (struct dictionary *, struct variable *);
95
96 struct variable *dict_get_filter (const struct dictionary *);
97 void dict_set_filter (struct dictionary *, struct variable *);
98
99 size_t dict_get_case_limit (const struct dictionary *);
100 void dict_set_case_limit (struct dictionary *, size_t);
101
102 int dict_get_next_value_idx (const struct dictionary *);
103 size_t dict_get_case_size (const struct dictionary *);
104
105 size_t dict_count_values (const struct dictionary *,
106                           unsigned int exclude_classes);
107 void dict_compact_values (struct dictionary *);
108
109 const struct variable *const *dict_get_split_vars (const struct dictionary *);
110 size_t dict_get_split_cnt (const struct dictionary *);
111 void dict_set_split_vars (struct dictionary *,
112                           struct variable *const *, size_t cnt);
113 void dict_unset_split_var (struct dictionary *d,
114                            struct variable *v);
115
116 const char *dict_get_label (const struct dictionary *);
117 void dict_set_label (struct dictionary *, const char *);
118
119 /* Fixed length of lines in dictionary documents. */
120 #define DOC_LINE_LENGTH 80
121
122 const char *dict_get_documents (const struct dictionary *);
123 void dict_set_documents (struct dictionary *, const char *);
124 void dict_clear_documents (struct dictionary *);
125 void dict_add_document_line (struct dictionary *, const char *);
126 size_t dict_get_document_line_cnt (const struct dictionary *);
127 void dict_get_document_line (const struct dictionary *,
128                              size_t, struct string *);
129
130 bool dict_create_vector (struct dictionary *,
131                          const char *name,
132                          struct variable **, size_t cnt);
133 void dict_create_vector_assert (struct dictionary *,
134                                 const char *name,
135                                 struct variable **, size_t cnt);
136 const struct vector *dict_get_vector (const struct dictionary *,
137                                       size_t idx);
138 size_t dict_get_vector_cnt (const struct dictionary *);
139 const struct vector *dict_lookup_vector (const struct dictionary *,
140                                          const char *name);
141 void dict_clear_vectors (struct dictionary *);
142
143 void dict_dump (const struct dictionary *);
144
145 #endif /* dictionary.h */