src/data/variable.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009 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_VARIABLE_H
  18 #define DATA_VARIABLE_H 1
  19
  20 #include <stddef.h>
  21 #include <stdbool.h>
  22 #include <data/dict-class.h>
  23 #include <data/missing-values.h>
  24 #include <data/val-type.h>
  25
  26 union value;
  27
  28 /* Variables.
  29    These functions should rarely be called directly: use
  30    dict_create_var, dict_clone_var, or dict_delete_var
  31    instead. */
  32 struct variable *var_create (const char *name, int width);
  33 struct variable *var_clone (const struct variable *);
  34 void var_destroy (struct variable *);
  35 struct variable *var_create_internal (int case_idx, int width);
  36
  37
  38 /* Variable names. */
  39 #define VAR_NAME_LEN 64 /* Maximum length of variable name, in bytes. */
  40
  41 const char *var_get_name (const struct variable *);
  42 void var_set_name (struct variable *, const char *);
  43 bool var_is_valid_name (const char *, bool issue_error);
  44 bool var_is_plausible_name (const char *name, bool issue_error);
  45 enum dict_class var_get_dict_class (const struct variable *);
  46
  47 int compare_vars_by_name (const void *, const void *, const void *);
  48 unsigned hash_var_by_name (const void *, const void *);
  49
  50 int compare_var_ptrs_by_name (const void *, const void *, const void *);
  51 unsigned hash_var_ptr_by_name (const void *, const void *);
  52
  53 int compare_var_ptrs_by_dict_index (const void *, const void *, const void *);
  54
  55 /* Types and widths of values associated with a variable. */
  56 enum val_type var_get_type (const struct variable *);
  57 int var_get_width (const struct variable *);
  58 void var_set_width (struct variable *, int width);
  59
  60 bool var_is_numeric (const struct variable *);
  61 bool var_is_alpha (const struct variable *);
  62
  63 /* Variables' missing values. */
  64 const struct missing_values *var_get_missing_values (const struct variable *);
  65 void var_set_missing_values (struct variable *, const struct missing_values *);
  66 void var_clear_missing_values (struct variable *);
  67 bool var_has_missing_values (const struct variable *);
  68
  69 bool var_is_value_missing (const struct variable *, const union value *,
  70                            enum mv_class);
  71 bool var_is_num_missing (const struct variable *, double, enum mv_class);
  72 bool var_is_str_missing (const struct variable *, const char[], enum mv_class);
  73
  74 /* Value labels. */
  75 const char *var_lookup_value_label (const struct variable *,
  76                                     const union value *);
  77 struct string;
  78 void var_append_value_name (const struct variable *, const union value *,
  79                             struct string *);
  80
  81 const char *
  82 var_get_value_name (const struct variable *v, const union value *value);
  83
  84
  85 bool var_has_value_labels (const struct variable *);
  86 const struct val_labs *var_get_value_labels (const struct variable *);
  87 void var_set_value_labels (struct variable *, const struct val_labs *);
  88
  89 bool var_add_value_label (struct variable *,
  90                           const union value *, const char *);
  91 void var_replace_value_label (struct variable *,
  92                               const union value *, const char *);
  93 void var_clear_value_labels (struct variable *);
  94
  95 /* Print and write formats. */
  96 const struct fmt_spec *var_get_print_format (const struct variable *);
  97 void var_set_print_format (struct variable *, const struct fmt_spec *);
  98 const struct fmt_spec *var_get_write_format (const struct variable *);
  99 void var_set_write_format (struct variable *, const struct fmt_spec *);
 100 void var_set_both_formats (struct variable *, const struct fmt_spec *);
 101
 102 struct fmt_spec var_default_formats (int width);
 103
 104 /* Variable labels. */
 105 const char *var_to_string (const struct variable *);
 106 const char *var_get_label (const struct variable *);
 107 void var_set_label (struct variable *, const char *);
 108 void var_clear_label (struct variable *);
 109 bool var_has_label (const struct variable *);
 110
 111 /* How data is measured. */
 112 enum measure
 113   {
 114     MEASURE_NOMINAL = 0,
 115     MEASURE_ORDINAL = 1,
 116     MEASURE_SCALE = 2,
 117     n_MEASURES
 118   };
 119
 120 bool measure_is_valid (enum measure);
 121 enum measure var_get_measure (const struct variable *);
 122 void var_set_measure (struct variable *, enum measure);
 123
 124 enum measure var_default_measure (enum val_type);
 125
 126 /* GUI display width. */
 127 int var_get_display_width (const struct variable *);
 128 void var_set_display_width (struct variable *, int display_width);
 129
 130 int var_default_display_width (int width);
 131
 132 /* Alignment of data for display. */
 133 enum alignment
 134   {
 135     ALIGN_LEFT = 0,
 136     ALIGN_RIGHT = 1,
 137     ALIGN_CENTRE = 2,
 138     n_ALIGN
 139   };
 140
 141 bool alignment_is_valid (enum alignment);
 142 enum alignment var_get_alignment (const struct variable *);
 143 void var_set_alignment (struct variable *, enum alignment);
 144
 145 enum alignment var_default_alignment (enum val_type);
 146
 147 /* Whether variables' values should be preserved from case to
 148    case. */
 149 bool var_get_leave (const struct variable *);
 150 void var_set_leave (struct variable *, bool leave);
 151 bool var_must_leave (const struct variable *);
 152
 153 /* Short names. */
 154 size_t var_get_short_name_cnt (const struct variable *);
 155 const char *var_get_short_name (const struct variable *, size_t idx);
 156 void var_set_short_name (struct variable *, size_t, const char *);
 157 void var_clear_short_names (struct variable *);
 158
 159 /* Relationship with dictionary. */
 160 size_t var_get_dict_index (const struct variable *);
 161 size_t var_get_case_index (const struct variable *);
 162
 163 /* Variable auxiliary data. */
 164 void *var_get_aux (const struct variable *);
 165 void *var_attach_aux (const struct variable *,
 166                       void *aux, void (*aux_dtor) (struct variable *));
 167 void var_clear_aux (struct variable *);
 168 void *var_detach_aux (struct variable *);
 169 void var_dtor_free (struct variable *);
 170
 171 /* Observed categorical values. */
 172 struct cat_vals *var_get_obs_vals (const struct variable *);
 173 void var_set_obs_vals (const struct variable *, struct cat_vals *);
 174 bool var_has_obs_vals (const struct variable *);
 175
 176 /* Custom attributes. */
 177 struct attrset *var_get_attributes (const struct variable *);
 178 void var_set_attributes (struct variable *, const struct attrset *);
 179 bool var_has_attributes (const struct variable *);
 180
 181 /* Function types. */
 182 typedef bool var_predicate_func (const struct variable *);
 183
 184 #endif /* data/variable.h */