Adopt use of gnulib for portability.
[pspp-builds.git] / src / case.h
index 9e8b6e4fadcdfd3437087529886f4c4b781dbcc2..cf99e0226e4bb1883050f7d3be2b7611763cd58b 100644 (file)
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA. */
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA. */
 
 #ifndef HEADER_CASE
 #define HEADER_CASE
 
 #include <stddef.h>
+#include <stdbool.h>
 #include "val.h"
 
 /* Opaque structure that represents a case.  Use accessor
    case_move() or case_clone() instead of copying.  */
 struct ccase 
   {
-    struct case_data *case_data;
+    struct case_data *case_data;        /* Actual data. */
 #if GLOBAL_DEBUGGING
-    struct ccase *this;
+    struct ccase *this;                 /* Detects unauthorized move/copy. */
 #endif
   };
 
 /* Invisible to user code. */
 struct case_data
   {
-    size_t value_cnt;
-    unsigned ref_cnt;
-    union value values[1];
+    size_t value_cnt;                   /* Number of values. */
+    unsigned ref_cnt;                   /* Reference count. */
+    union value values[1];              /* Values. */
   };
 
 #ifdef GLOBAL_DEBUGGING
@@ -56,6 +57,9 @@ CASE_INLINE void case_clone (struct ccase *, const struct ccase *);
 CASE_INLINE void case_move (struct ccase *, struct ccase *);
 CASE_INLINE void case_destroy (struct ccase *);
 
+void case_resize (struct ccase *, size_t old_cnt, size_t new_cnt);
+void case_swap (struct ccase *, struct ccase *);
+
 int case_try_create (struct ccase *, size_t value_cnt);
 int case_try_clone (struct ccase *, const struct ccase *);
 
@@ -63,9 +67,9 @@ CASE_INLINE void case_copy (struct ccase *dst, size_t dst_idx,
                             const struct ccase *src, size_t src_idx,
                             size_t cnt);
 
-CASE_INLINE size_t case_serial_size (size_t value_cnt);
-CASE_INLINE void case_serialize (const struct ccase *, void *, size_t);
-CASE_INLINE void case_unserialize (struct ccase *, const void *, size_t);
+CASE_INLINE void case_to_values (const struct ccase *, union value *, size_t);
+CASE_INLINE void case_from_values (struct ccase *,
+                                   const union value *, size_t);
 
 CASE_INLINE const union value *case_data (const struct ccase *, size_t idx);
 CASE_INLINE double case_num (const struct ccase *, size_t idx);
@@ -73,6 +77,16 @@ CASE_INLINE const char *case_str (const struct ccase *, size_t idx);
 
 CASE_INLINE union value *case_data_rw (struct ccase *, size_t idx);
 
+struct variable;
+int case_compare (const struct ccase *, const struct ccase *,
+                  struct variable *const *, size_t var_cnt);
+int case_compare_2dict (const struct ccase *, const struct ccase *,
+                        struct variable *const *, struct variable *const *,
+                        size_t var_cnt);
+
+const union value *case_data_all (const struct ccase *);
+union value *case_data_all_rw (struct ccase *);
+
 void case_unshare (struct ccase *);
 
 #ifndef GLOBAL_DEBUGGING
@@ -126,28 +140,22 @@ case_copy (struct ccase *dst, size_t dst_idx,
              sizeof *dst->case_data->values * value_cnt); 
 }
 
-static inline size_t
-case_serial_size (size_t value_cnt) 
-{
-  return value_cnt * sizeof (union value);
-}
-
 static inline void
-case_serialize (const struct ccase *c, void *output,
-                size_t output_size UNUSED
+case_to_values (const struct ccase *c, union value *output,
+                size_t output_size ) 
 {
   memcpy (output, c->case_data->values,
-          case_serial_size (c->case_data->value_cnt));
+          output_size * sizeof *output);
 }
 
 static inline void
-case_unserialize (struct ccase *c, const void *input,
+case_from_values (struct ccase *c, const union value *input,
                   size_t input_size UNUSED) 
 {
   if (c->case_data->ref_cnt > 1)
     case_unshare (c);
   memcpy (c->case_data->values, input,
-          case_serial_size (c->case_data->value_cnt));
+          c->case_data->value_cnt * sizeof *input);
 }
 
 static inline const union value *