src/data/value.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010 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_VALUE_H
  18 #define DATA_VALUE_H 1
  19
  20 #include <assert.h>
  21 #include <stdbool.h>
  22 #include <stdlib.h>
  23 #include <stdint.h>
  24 #include <string.h>
  25 #include "xalloc.h"
  26 \f
  27 /* Maximum length of a "short" string, that is represented in
  28    "union value" without a separate pointer.
  29
  30    This is an implementation detail of the "union value" code.
  31    There is little reason for client code to use it. */
  32 #define MAX_SHORT_STRING 8
  33
  34 /* A numeric or string value.
  35
  36    The client is responsible for keeping track of the value's
  37    width.
  38
  39    This structure is semi-opaque:
  40
  41        - If the value is a number, clients may access the 'f'
  42          member directly.
  43
  44        - Clients should not access other members directly.
  45 */
  46 union value
  47   {
  48     double f;
  49     uint8_t short_string[MAX_SHORT_STRING];
  50     uint8_t *long_string;
  51   };
  52
  53 static inline void value_init (union value *, int width);
  54 static inline void value_clone (union value *, const union value *, int width);
  55 static inline bool value_needs_init (int width);
  56 static inline bool value_try_init (union value *, int width);
  57 static inline void value_destroy (union value *, int width);
  58
  59 static inline double value_num (const union value *);
  60 static inline const uint8_t *value_str (const union value *, int width);
  61 static inline uint8_t *value_str_rw (union value *, int width);
  62
  63 static inline void value_copy (union value *, const union value *, int width);
  64 void value_copy_rpad (union value *, int dst_width,
  65                       const union value *, int src_width,
  66                       char pad);
  67 void value_copy_str_rpad (union value *, int dst_width, const uint8_t *,
  68                           char pad);
  69 void value_copy_buf_rpad (union value *dst, int dst_width,
  70                           const uint8_t *src, size_t src_len, char pad);
  71 void value_set_missing (union value *, int width);
  72 int value_compare_3way (const union value *, const union value *, int width);
  73 bool value_equal (const union value *, const union value *, int width);
  74 unsigned int value_hash (const union value *, int width, unsigned int basis);
  75
  76 bool value_is_resizable (const union value *, int old_width, int new_width);
  77 bool value_needs_resize (int old_width, int new_width);
  78 void value_resize (union value *, int old_width, int new_width);
  79
  80 static inline void value_swap (union value *, union value *);
  81
  82 struct pool;
  83 void value_init_pool (struct pool *, union value *, int width);
  84 void value_resize_pool (struct pool *, union value *,
  85                         int old_width, int new_width);
  86 \f
  87 /* Initializes V as a value of the given WIDTH, where 0
  88    represents a numeric value and a positive integer represents a
  89    string value WIDTH bytes long.
  90
  91    A WIDTH of -1 is ignored.
  92
  93    The contents of value V are indeterminate after
  94    initialization. */
  95 static inline void
  96 value_init (union value *v, int width)
  97 {
  98   if (width > MAX_SHORT_STRING)
  99     v->long_string = xmalloc (width);
 100 }
 101
 102 /* Initializes V as a value of the given WIDTH, as with value_init(), and
 103    copies SRC's value into V as its initial value. */
 104 static inline void
 105 value_clone (union value *v, const union value *src, int width)
 106 {
 107   if (width <= MAX_SHORT_STRING)
 108     *v = *src;
 109   else
 110     v->long_string = xmemdup (src->long_string, width);
 111 }
 112
 113 /* Returns true if a value of the given WIDTH actually needs to
 114    have the value_init and value_destroy functions called, false
 115    if those functions are no-ops for values of the given WIDTH.
 116
 117    Using this function is only a valuable optimization if a large
 118    number of values of the given WIDTH are to be initialized*/
 119 static inline bool
 120 value_needs_init (int width)
 121 {
 122   return width > MAX_SHORT_STRING;
 123 }
 124
 125 /* Same as value_init, except that failure to allocate memory
 126    causes it to return false instead of terminating the
 127    program.  On success, returns true. */
 128 static inline bool
 129 value_try_init (union value *v, int width)
 130 {
 131   if (width > MAX_SHORT_STRING)
 132     {
 133       v->long_string = malloc (width);
 134       return v->long_string != NULL;
 135     }
 136   else
 137     return true;
 138 }
 139
 140 /* Frees any memory allocated by value_init for V, which must
 141    have the given WIDTH. */
 142 static inline void
 143 value_destroy (union value *v, int width)
 144 {
 145   if (width > MAX_SHORT_STRING)
 146     free (v->long_string);
 147 }
 148
 149 /* Returns the numeric value in V, which must have width 0. */
 150 static inline double
 151 value_num (const union value *v)
 152 {
 153   return v->f;
 154 }
 155
 156 /* Returns the string value in V, which must have width WIDTH.
 157
 158    The returned value is not null-terminated.
 159
 160    It is important that WIDTH be the actual value that was passed
 161    to value_init.  Passing, e.g., a smaller value because only
 162    that number of bytes will be accessed will not always work. */
 163 static inline const uint8_t *
 164 value_str (const union value *v, int width)
 165 {
 166   assert (width > 0);
 167   return (width > MAX_SHORT_STRING ? v->long_string : v->short_string);
 168 }
 169
 170 /* Returns the string value in V, which must have width WIDTH.
 171
 172    The returned value is not null-terminated.
 173
 174    It is important that WIDTH be the actual value that was passed
 175    to value_init.  Passing, e.g., a smaller value because only
 176    that number of bytes will be accessed will not always work. */
 177 static inline uint8_t *
 178 value_str_rw (union value *v, int width)
 179 {
 180   assert (width > 0);
 181   return (width > MAX_SHORT_STRING ? v->long_string : v->short_string);
 182 }
 183
 184 /* Copies SRC to DST, given that they both contain data of the
 185    given WIDTH. */
 186 static inline void
 187 value_copy (union value *dst, const union value *src, int width)
 188 {
 189   if (width <= MAX_SHORT_STRING)
 190     *dst = *src;
 191   else if (dst != src)
 192     memcpy (dst->long_string, src->long_string, width);
 193 }
 194
 195 /* Exchanges the contents of A and B. */
 196 static inline void
 197 value_swap (union value *a, union value *b)
 198 {
 199   union value tmp = *a;
 200   *a = *b;
 201   *b = tmp;
 202 }
 203
 204 #endif /* data/value.h */