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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 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_VALUE_H
  18 #define DATA_VALUE_H 1
  19
  20 #include "libpspp/compiler.h"
  21 #include <assert.h>
  22 #include <stdbool.h>
  23 #include <stdlib.h>
  24 #include <stdint.h>
  25 #include <string.h>
  26 #include "xalloc.h"
  27 \f
  28 /* A numeric or string value.  The client is responsible for keeping track of
  29    the value's width. */
  30 union value
  31   {
  32     double f;
  33     uint8_t *s;
  34   };
  35
  36 static inline void value_init (union value *, int width);
  37 static inline void value_clone (union value *, const union value *, int width);
  38 static inline bool value_needs_init (int width);
  39 static inline bool value_try_init (union value *, int width);
  40 static inline void value_destroy (union value *, int width);
  41
  42 static inline void value_copy (union value *, const union value *, int width);
  43 void value_copy_rpad (union value *, int dst_width,
  44                       const union value *, int src_width,
  45                       char pad);
  46 void value_copy_str_rpad (union value *, int dst_width, const uint8_t *,
  47                           char pad);
  48 void value_copy_buf_rpad (union value *dst, int dst_width,
  49                           const uint8_t *src, size_t src_len, char pad);
  50 void value_set_missing (union value *, int width);
  51 int value_compare_3way (const union value *, const union value *, int width);
  52 bool value_equal (const union value *, const union value *, int width);
  53 unsigned int value_hash (const union value *, int width, unsigned int basis) WARN_UNUSED_RESULT;
  54
  55 bool value_is_resizable (const union value *, int old_width, int new_width);
  56 bool value_needs_resize (int old_width, int new_width);
  57 void value_resize (union value *, int old_width, int new_width);
  58
  59 bool value_is_spaces (const union value *, int width);
  60
  61 static inline void value_swap (union value *, union value *);
  62
  63 struct pool;
  64 void value_init_pool (struct pool *, union value *, int width);
  65 void value_clone_pool (struct pool *, union value *, const union value *,
  66                        int width);
  67 void value_resize_pool (struct pool *, union value *,
  68                         int old_width, int new_width);
  69 \f
  70 /* Initializes V as a value of the given WIDTH, where 0
  71    represents a numeric value and a positive integer represents a
  72    string value WIDTH bytes long.
  73
  74    A WIDTH of -1 is ignored.
  75
  76    The contents of value V are indeterminate after
  77    initialization. */
  78 static inline void
  79 value_init (union value *v, int width)
  80 {
  81   if (width > 0)
  82     v->s = xmalloc (width);
  83 }
  84
  85 /* Initializes V as a value of the given WIDTH, as with value_init(), and
  86    copies SRC's value into V as its initial value. */
  87 static inline void
  88 value_clone (union value *v, const union value *src, int width)
  89 {
  90   if (width <= 0)
  91     v->f = src->f;
  92   else
  93     v->s = xmemdup (src->s, width);
  94 }
  95
  96 /* Returns true if a value of the given WIDTH actually needs to
  97    have the value_init and value_destroy functions called, false
  98    if those functions are no-ops for values of the given WIDTH.
  99
 100    Using this function is only a valuable optimization if a large
 101    number of values of the given WIDTH are to be initialized*/
 102 static inline bool
 103 value_needs_init (int width)
 104 {
 105   return width > 0;
 106 }
 107
 108 /* Same as value_init, except that failure to allocate memory
 109    causes it to return false instead of terminating the
 110    program.  On success, returns true. */
 111 static inline bool
 112 value_try_init (union value *v, int width)
 113 {
 114   if (width > 0)
 115     {
 116       v->s = malloc (width);
 117       return v->s != NULL;
 118     }
 119   else
 120     return true;
 121 }
 122
 123 /* Frees any memory allocated by value_init for V, which must
 124    have the given WIDTH. */
 125 static inline void
 126 value_destroy (union value *v, int width)
 127 {
 128   if (width > 0)
 129     free (v->s);
 130 }
 131
 132 /* Copies SRC to DST, given that they both contain data of the
 133    given WIDTH. */
 134 static inline void
 135 value_copy (union value *dst, const union value *src, int width)
 136 {
 137   if (width <= 0)
 138     dst->f = src->f;
 139   else
 140     memcpy (dst->s, src->s, width);
 141 }
 142
 143 /* Exchanges the contents of A and B. */
 144 static inline void
 145 value_swap (union value *a, union value *b)
 146 {
 147   union value tmp = *a;
 148   *a = *b;
 149   *b = tmp;
 150 }
 151
 152 #endif /* data/value.h */