src/data/dictionary.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2004, 2007, 2009, 2010, 2011, 2012, 2013 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 (const char *encoding);
  30 struct dictionary *dict_clone (const struct dictionary *) WARN_UNUSED_RESULT;
  31 struct dictionary *dict_ref (struct dictionary *s) WARN_UNUSED_RESULT;
  32
  33
  34 /* Clearing and destroying dictionaries. */
  35 void dict_clear (struct dictionary *);
  36 void dict_unref (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_n_vars (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 *n_vars,
  49                     enum dict_class exclude);
  50 void dict_get_vars_mutable (const struct dictionary *,
  51                             struct variable ***vars, size_t *n_vars,
  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 struct variable *dict_clone_var_assert (struct dictionary *,
  61                                         const struct variable *);
  62 struct variable *dict_clone_var_as (struct dictionary *,
  63                                     const struct variable *, const char *);
  64 struct variable *dict_clone_var_as_assert (struct dictionary *,
  65                                            const struct variable *,
  66                                            const char *);
  67 struct variable *dict_create_var_with_unique_name (struct dictionary *,
  68                                                    const char *hint,
  69                                                    int width);
  70
  71 /* Deleting variables. */
  72 void dict_delete_var (struct dictionary *, struct variable *);
  73 void dict_delete_vars (struct dictionary *,
  74                        struct variable *const *, size_t count);
  75 void dict_delete_consecutive_vars (struct dictionary *,
  76                                    size_t idx, size_t count);
  77 void dict_delete_scratch_vars (struct dictionary *);
  78
  79 /* Changing the order of variables. */
  80 void dict_reorder_var (struct dictionary *, struct variable *,
  81                        size_t new_index);
  82 void dict_reorder_vars (struct dictionary *,
  83                         struct variable *const *, size_t count);
  84
  85 /* Variable names. */
  86 bool dict_try_rename_var (struct dictionary *,
  87                           struct variable *, const char *);
  88 void dict_rename_var (struct dictionary *, struct variable *, const char *);
  89 bool dict_rename_vars (struct dictionary *,
  90                        struct variable **, char **new_names,
  91                        size_t count, char **err_name);
  92 char *dict_make_unique_var_name (const struct dictionary *, const char *hint);
  93
  94 bool dict_get_names_must_be_ids (const struct dictionary *);
  95 void dict_set_names_must_be_ids (struct dictionary *, bool);
  96
  97 /* Weight variable. */
  98 double dict_get_case_weight (const struct dictionary *,
  99                              const struct ccase *, bool *);
 100 double dict_get_rounded_case_weight (const struct dictionary *,
 101                                      const struct ccase *, bool *);
 102 struct variable *dict_get_weight (const struct dictionary *);
 103 void dict_set_weight (struct dictionary *, struct variable *);
 104 struct fmt_spec dict_get_weight_format (const struct dictionary *);
 105
 106 /* Filter variable. */
 107 struct variable *dict_get_filter (const struct dictionary *);
 108 void dict_set_filter (struct dictionary *, struct variable *);
 109
 110 /* Case limit (N OF CASES). */
 111 casenumber dict_get_case_limit (const struct dictionary *);
 112 void dict_set_case_limit (struct dictionary *, casenumber);
 113
 114 /* Size of cases for this dictionary. */
 115 const struct caseproto *dict_get_proto (const struct dictionary *);
 116
 117 /* SPLIT FILE variables.
 118
 119    SPLIT_NONE is used if and only if there are no split file variables. */
 120 enum split_type
 121   {
 122     SPLIT_NONE,                 /* No split file variables. */
 123     SPLIT_SEPARATE,             /* Produce separate output for each split. */
 124     SPLIT_LAYERED,              /* Output splits in same table.  */
 125   };
 126 #define MAX_SPLITS 8
 127 const struct variable *const *dict_get_split_vars (const struct dictionary *);
 128 size_t dict_get_n_splits (const struct dictionary *);
 129 enum split_type dict_get_split_type (const struct dictionary *);
 130 void dict_set_split_vars (struct dictionary *,
 131                           struct variable *const *, size_t n,
 132                           enum split_type);
 133 void dict_clear_split_vars (struct dictionary *);
 134
 135 /* File label. */
 136 const char *dict_get_label (const struct dictionary *);
 137 void dict_set_label (struct dictionary *, const char *);
 138
 139 /* Documents. */
 140 #define DOC_LINE_LENGTH 80 /* Fixed length of document lines. */
 141
 142 const struct string_array *dict_get_documents (const struct dictionary *);
 143 void dict_set_documents (struct dictionary *, const struct string_array *);
 144 void dict_set_documents_string (struct dictionary *, const char *);
 145 void dict_clear_documents (struct dictionary *);
 146
 147 bool dict_add_document_line (struct dictionary *, const char *,
 148                              bool issue_warning);
 149 size_t dict_get_document_n_lines (const struct dictionary *);
 150 const char *dict_get_document_line (const struct dictionary *, size_t);
 151
 152 /* Vectors. */
 153 bool dict_create_vector (struct dictionary *, const char *name,
 154                          struct variable **, size_t n);
 155 void dict_create_vector_assert (struct dictionary *, const char *name,
 156                                 struct variable **, size_t n);
 157 const struct vector *dict_get_vector (const struct dictionary *, size_t idx);
 158 size_t dict_get_n_vectors (const struct dictionary *);
 159 const struct vector *dict_lookup_vector (const struct dictionary *,
 160                                          const char *name);
 161 void dict_clear_vectors (struct dictionary *);
 162
 163 /* Multiple response sets. */
 164 const struct mrset *dict_get_mrset (const struct dictionary *, size_t idx);
 165 size_t dict_get_n_mrsets (const struct dictionary *);
 166 const struct mrset *dict_lookup_mrset (const struct dictionary *,
 167                                        const char *name);
 168
 169 bool dict_add_mrset (struct dictionary *, struct mrset *);
 170 bool dict_delete_mrset (struct dictionary *, const char *name);
 171 void dict_clear_mrsets (struct dictionary *);
 172
 173 /* Variable sets. */
 174 const struct varset *dict_get_varset (const struct dictionary *, size_t idx);
 175 size_t dict_get_n_varsets (const struct dictionary *);
 176 const struct varset *dict_lookup_varset (const struct dictionary *,
 177                                          const char *name);
 178
 179 bool dict_add_varset (struct dictionary *, struct varset *);
 180 bool dict_delete_varset (struct dictionary *, const char *name);
 181 void dict_clear_varsets (struct dictionary *);
 182
 183 /* Attributes. */
 184 struct attrset *dict_get_attributes (const struct dictionary *);
 185 void dict_set_attributes (struct dictionary *, const struct attrset *);
 186 bool dict_has_attributes (const struct dictionary *);
 187
 188 /* Data encoding. */
 189 const char *dict_get_encoding (const struct dictionary *d);
 190
 191 char *dict_id_is_valid__ (const struct dictionary *, const char *id,
 192                           enum dict_class)
 193   WARN_UNUSED_RESULT;
 194 bool dict_id_is_valid (const struct dictionary *, const char *id,
 195                        enum dict_class);
 196
 197 /* Functions to be called upon dictionary changes. */
 198 struct dict_callbacks
 199  {
 200   void (*var_added) (struct dictionary *, int, void *);
 201   void (*vars_deleted) (struct dictionary *, int dict_index, unsigned int n, void *);
 202   void (*var_moved) (struct dictionary *, int new_dict_index, int old_dict_index, void *);
 203   void (*var_changed) (struct dictionary *, int, unsigned int, const struct variable *, void *);
 204   void (*weight_changed) (struct dictionary *, int, void *);
 205   void (*filter_changed) (struct dictionary *, int, void *);
 206   void (*split_changed) (struct dictionary *, void *);
 207  };
 208
 209 void dict_set_callbacks (struct dictionary *, const struct dict_callbacks *,
 210                          void *);
 211 void dict_copy_callbacks (struct dictionary *, const struct dictionary *);
 212
 213 void dict_set_change_callback (struct dictionary *d,
 214                                void (*changed) (struct dictionary *, void*),
 215                                void *data);
 216
 217
 218 /* Debug use only. */
 219 void dict_dump (const struct dictionary *);
 220
 221 #endif /* data/dictionary.h */