pintos-os.org Git - pspp/blob - src/data/variable.h

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