value: New function value_clone().
[pspp] / src / data / value.h
index 90f8575356a24a873a0dbf4f9df41d60d8fca1ce..61df087754b1e78327f2fbb02453ddf8ab8f9e9f 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2007, 2009 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2007, 2009, 2010 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 #include <assert.h>
 #include <stdbool.h>
 #include <stdlib.h>
+#include <stdint.h>
 #include <string.h>
 #include "xalloc.h"
 \f
+/* Maximum length of a "short" string, that is represented in
+   "union value" without a separate pointer.
+
+   This is an implementation detail of the "union value" code.
+   There is little reason for client code to use it. */
 #define MAX_SHORT_STRING 8
 
 /* A numeric or string value.
 union value
   {
     double f;
-    char short_string[MAX_SHORT_STRING];
-    char *long_string;
+    uint8_t short_string[MAX_SHORT_STRING];
+    uint8_t *long_string;
   };
 
 static inline void value_init (union value *, int width);
+static inline void value_clone (union value *, const union value *, int width);
 static inline bool value_needs_init (int width);
 static inline bool value_try_init (union value *, int width);
 static inline void value_destroy (union value *, int width);
 
 static inline double value_num (const union value *);
-static inline const char *value_str (const union value *, int width);
-static inline char *value_str_rw (union value *, int width);
-
-int compare_values (const void *, const void *, const void *var);
-unsigned hash_value (const void *, const void *var);
+static inline const uint8_t *value_str (const union value *, int width);
+static inline uint8_t *value_str_rw (union value *, int width);
 
 static inline void value_copy (union value *, const union value *, int width);
 void value_copy_rpad (union value *, int dst_width,
                       const union value *, int src_width,
                       char pad);
-void value_copy_str_rpad (union value *, int dst_width, const char *,
+void value_copy_str_rpad (union value *, int dst_width, const uint8_t *,
                           char pad);
 void value_copy_buf_rpad (union value *dst, int dst_width,
-                          const char *src, size_t src_len, char pad);
+                          const uint8_t *src, size_t src_len, char pad);
 void value_set_missing (union value *, int width);
 int value_compare_3way (const union value *, const union value *, int width);
 bool value_equal (const union value *, const union value *, int width);
-size_t value_hash (const union value *, int width, unsigned int basis);
+unsigned int value_hash (const union value *, int width, unsigned int basis);
 
 bool value_is_resizable (const union value *, int old_width, int new_width);
 bool value_needs_resize (int old_width, int new_width);
 void value_resize (union value *, int old_width, int new_width);
 
+static inline void value_swap (union value *, union value *);
+
 struct pool;
 void value_init_pool (struct pool *, union value *, int width);
 void value_resize_pool (struct pool *, union value *,
@@ -93,6 +99,17 @@ value_init (union value *v, int width)
     v->long_string = xmalloc (width);
 }
 
+/* Initializes V as a value of the given WIDTH, as with value_init(), and
+   copies SRC's value into V as its initial value. */
+static inline void
+value_clone (union value *v, const union value *src, int width)
+{
+  if (width <= MAX_SHORT_STRING)
+    *v = *src;
+  else
+    v->long_string = xmemdup (src->long_string, width);
+}
+
 /* Returns true if a value of the given WIDTH actually needs to
    have the value_init and value_destroy functions called, false
    if those functions are no-ops for values of the given WIDTH.
@@ -143,7 +160,7 @@ value_num (const union value *v)
    It is important that WIDTH be the actual value that was passed
    to value_init.  Passing, e.g., a smaller value because only
    that number of bytes will be accessed will not always work. */
-static inline const char *
+static inline const uint8_t *
 value_str (const union value *v, int width)
 {
   assert (width > 0);
@@ -157,7 +174,7 @@ value_str (const union value *v, int width)
    It is important that WIDTH be the actual value that was passed
    to value_init.  Passing, e.g., a smaller value because only
    that number of bytes will be accessed will not always work. */
-static inline char *
+static inline uint8_t *
 value_str_rw (union value *v, int width)
 {
   assert (width > 0);
@@ -175,4 +192,13 @@ value_copy (union value *dst, const union value *src, int width)
     memcpy (dst->long_string, src->long_string, width);
 }
 
+/* Exchanges the contents of A and B. */
+static inline void
+value_swap (union value *a, union value *b)
+{
+  union value tmp = *a;
+  *a = *b;
+  *b = tmp;
+}
+
 #endif /* data/value.h */