src/data/variable.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 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_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 /* Bitfields to identify traits of a variable */
  27
  28 #define VAR_TRAIT_NAME             0x0001
  29 #define VAR_TRAIT_WIDTH            0x0002
  30 #define VAR_TRAIT_ROLE             0x0004
  31 #define VAR_TRAIT_LABEL            0x0008
  32 #define VAR_TRAIT_VALUE_LABELS     0x0010
  33 #define VAR_TRAIT_MISSING_VALUES   0x0020
  34 #define VAR_TRAIT_ALIGNMENT        0x0040
  35 #define VAR_TRAIT_MEASURE          0x0080
  36 #define VAR_TRAIT_DISPLAY_WIDTH    0x0100
  37 #define VAR_TRAIT_LEAVE            0x0200
  38 #define VAR_TRAIT_POSITION         0x0400
  39 #define VAR_TRAIT_ATTRIBUTES       0x0800
  40 #define VAR_TRAIT_PRINT_FORMAT     0x1000
  41 #define VAR_TRAIT_WRITE_FORMAT     0x2000
  42
  43
  44 union value;
  45
  46 /* Variables.
  47    These functions should rarely be called directly: use
  48    dict_create_var, dict_clone_var, or dict_delete_var
  49    instead. */
  50 struct variable *var_create (const char *name, int width);
  51 struct variable *var_clone (const struct variable *);
  52 void var_destroy (struct variable *);
  53
  54 /* Variable names. */
  55 const char *var_get_name (const struct variable *);
  56 void var_set_name (struct variable *, const char *);
  57 enum dict_class var_get_dict_class (const struct variable *);
  58
  59 int compare_vars_by_name (const void *, const void *, const void *);
  60 unsigned hash_var_by_name (const void *, const void *);
  61
  62 int compare_var_ptrs_by_name (const void *, const void *, const void *);
  63 unsigned hash_var_ptr_by_name (const void *, const void *);
  64
  65 int compare_var_ptrs_by_dict_index (const void *, const void *, const void *);
  66
  67 struct fmt_spec;
  68
  69 /* Types and widths of values associated with a variable. */
  70 enum val_type var_get_type (const struct variable *);
  71 int var_get_width (const struct variable *);
  72 void var_set_width (struct variable *, int width);
  73 void var_set_width_and_formats (struct variable *v, int new_width,
  74                                 const struct fmt_spec *print, const struct fmt_spec *write);
  75
  76 bool var_is_numeric (const struct variable *);
  77 bool var_is_alpha (const struct variable *);
  78
  79 /* Variables' missing values. */
  80 const struct missing_values *var_get_missing_values (const struct variable *);
  81 void var_set_missing_values (struct variable *, const struct missing_values *);
  82 void var_clear_missing_values (struct variable *);
  83 bool var_has_missing_values (const struct variable *);
  84
  85 bool var_is_value_missing (const struct variable *, const union value *,
  86                            enum mv_class);
  87 bool var_is_num_missing (const struct variable *, double, enum mv_class);
  88 bool var_is_str_missing (const struct variable *, const uint8_t[], enum mv_class);
  89
  90 /* Value labels. */
  91 const char *var_lookup_value_label (const struct variable *,
  92                                     const union value *);
  93 struct string;
  94 void var_append_value_name (const struct variable *, const union value *,
  95                             struct string *);
  96
  97 const char *
  98 var_get_value_name (const struct variable *v, const union value *value);
  99
 100
 101 bool var_has_value_labels (const struct variable *);
 102 const struct val_labs *var_get_value_labels (const struct variable *);
 103 void var_set_value_labels (struct variable *, const struct val_labs *);
 104
 105 bool var_add_value_label (struct variable *,
 106                           const union value *, const char *);
 107 void var_replace_value_label (struct variable *,
 108                               const union value *, const char *);
 109 void var_clear_value_labels (struct variable *);
 110
 111 /* Print and write formats. */
 112 const struct fmt_spec *var_get_print_format (const struct variable *);
 113 void var_set_print_format (struct variable *, const struct fmt_spec *);
 114 const struct fmt_spec *var_get_write_format (const struct variable *);
 115 void var_set_write_format (struct variable *, const struct fmt_spec *);
 116 void var_set_both_formats (struct variable *, const struct fmt_spec *);
 117
 118 struct fmt_spec var_default_formats (int width);
 119
 120 /* Variable labels. */
 121 const char *var_to_string (const struct variable *);
 122 const char *var_get_label (const struct variable *);
 123 bool var_set_label (struct variable *, const char *label, bool issue_warning);
 124 void var_clear_label (struct variable *);
 125 bool var_has_label (const struct variable *);
 126
 127 /* How data is measured. */
 128 enum measure
 129   {
 130     MEASURE_NOMINAL = 0,
 131     MEASURE_ORDINAL = 1,
 132     MEASURE_SCALE = 2,
 133     n_MEASURES
 134   };
 135
 136 bool measure_is_valid (enum measure);
 137 const char *measure_to_string (enum measure);
 138 const char *measure_to_syntax (enum measure);
 139
 140 enum measure var_get_measure (const struct variable *);
 141 void var_set_measure (struct variable *, enum measure);
 142
 143 enum measure var_default_measure (enum val_type);
 144
 145 /* Intended usage of a variable, for populating dialogs. */
 146 enum var_role
 147   {
 148     ROLE_INPUT,
 149     ROLE_TARGET,
 150     ROLE_BOTH,
 151     ROLE_NONE,
 152     ROLE_PARTITION,
 153     ROLE_SPLIT
 154   };
 155
 156 bool var_role_is_valid (enum var_role);
 157 const char *var_role_to_string (enum var_role);
 158 const char *var_role_to_syntax (enum var_role);
 159
 160 enum var_role var_get_role (const struct variable *);
 161 void var_set_role (struct variable *, enum var_role);
 162
 163 /* GUI display width. */
 164 int var_get_display_width (const struct variable *);
 165 void var_set_display_width (struct variable *, int display_width);
 166
 167 int var_default_display_width (int width);
 168
 169 /* Alignment of data for display. */
 170 enum alignment
 171   {
 172     ALIGN_LEFT = 0,
 173     ALIGN_RIGHT = 1,
 174     ALIGN_CENTRE = 2
 175   };
 176
 177 bool alignment_is_valid (enum alignment);
 178 const char *alignment_to_string (enum alignment);
 179 const char *alignment_to_syntax (enum alignment);
 180
 181 enum alignment var_get_alignment (const struct variable *);
 182 void var_set_alignment (struct variable *, enum alignment);
 183
 184 enum alignment var_default_alignment (enum val_type);
 185
 186 /* Whether variables' values should be preserved from case to
 187    case. */
 188 bool var_get_leave (const struct variable *);
 189 void var_set_leave (struct variable *, bool leave);
 190 bool var_must_leave (const struct variable *);
 191
 192 /* Short names. */
 193 size_t var_get_short_name_cnt (const struct variable *);
 194 const char *var_get_short_name (const struct variable *, size_t idx);
 195 void var_set_short_name (struct variable *, size_t, const char *);
 196 void var_clear_short_names (struct variable *);
 197
 198 /* Relationship with dictionary. */
 199 size_t var_get_dict_index (const struct variable *);
 200 size_t var_get_case_index (const struct variable *);
 201
 202 /* Custom attributes. */
 203 struct attrset *var_get_attributes (const struct variable *);
 204 void var_set_attributes (struct variable *, const struct attrset *);
 205 bool var_has_attributes (const struct variable *);
 206
 207 /* Encoding. */
 208 const char *var_get_encoding (const struct variable *);
 209
 210 /* Function types. */
 211 typedef bool var_predicate_func (const struct variable *);
 212
 213 #endif /* data/variable.h */