treewide: Replace <name>_cnt by n_<name>s and <name>_cap by allocated_<name>.

[pspp] / src / data / case.h

diff --git a/src/data/case.h b/src/data/case.h
index 6f53772688c3c1f29ba15cc0475735d0803762e4..256d66019dd81f7ca25275291fcadc05b42b8964 100644 (file)
--- a/src/data/case.h
+++ b/src/data/case.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2004, 2007, 2009 Free Software Foundation, Inc.
+   Copyright (C) 2004, 2007, 2009, 2010, 2011 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
@@ -21,8 +21,10 @@
 #include <stddef.h>
 #include <stdbool.h>
 #include <stdlib.h>
-#include <libpspp/compiler.h>
-#include "value.h"
+
+#include "libpspp/compiler.h"
+#include "libpspp/str.h"
+#include "data/caseproto.h"
 
 struct variable;
 
@@ -51,29 +53,36 @@ typedef long int casenumber;
    shared case. */
 struct ccase
   {
-    size_t n_values;            /* Number of values. */
+    struct caseproto *proto;    /* Case prototype. */
     size_t ref_cnt;             /* Reference count. */
     union value values[1];      /* Values. */
   };
 
-struct ccase *case_create (size_t n_values) MALLOC_LIKE;
-struct ccase *case_try_create (size_t n_values) MALLOC_LIKE;
+struct ccase *case_create (const struct caseproto *) MALLOC_LIKE;
+struct ccase *case_try_create (const struct caseproto *) MALLOC_LIKE;
+struct ccase *case_clone (const struct ccase *) MALLOC_LIKE;
 
 static inline struct ccase *case_unshare (struct ccase *) WARN_UNUSED_RESULT;
-static inline struct ccase *case_ref (const struct ccase *);
+struct ccase *case_ref (const struct ccase *) WARN_UNUSED_RESULT;
 static inline void case_unref (struct ccase *);
 static inline bool case_is_shared (const struct ccase *);
 
-static inline size_t case_get_value_cnt (const struct ccase *);
+static inline size_t case_get_n_values (const struct ccase *);
+static inline const struct caseproto *case_get_proto (const struct ccase *);
+
+size_t case_get_cost (const struct caseproto *);
 
-struct ccase *case_resize (struct ccase *, size_t new_cnt) WARN_UNUSED_RESULT;
-struct ccase *case_unshare_and_resize (struct ccase *, size_t new_cnt)
+struct ccase *case_resize (struct ccase *, const struct caseproto *)
   WARN_UNUSED_RESULT;
+struct ccase *case_unshare_and_resize (struct ccase *,
+                                       const struct caseproto *)
+  WARN_UNUSED_RESULT;
+
+void case_set_missing (struct ccase *);
 
 void case_copy (struct ccase *dst, size_t dst_idx,
                 const struct ccase *src, size_t src_idx,
                 size_t cnt);
-
 void case_copy_out (const struct ccase *,
                     size_t start_idx, union value *, size_t n_values);
 void case_copy_in (struct ccase *,
@@ -86,9 +95,15 @@ union value *case_data_rw_idx (struct ccase *, size_t idx);
 
 double case_num (const struct ccase *, const struct variable *);
 double case_num_idx (const struct ccase *, size_t idx);
+double *case_num_rw (struct ccase *, const struct variable *);
+double *case_num_rw_idx (struct ccase *, size_t idx);
 
-const char *case_str (const struct ccase *, const struct variable *);
-const char *case_str_idx (const struct ccase *, size_t idx);
+const uint8_t *case_str (const struct ccase *, const struct variable *);
+const uint8_t *case_str_idx (const struct ccase *, size_t idx);
+struct substring case_ss (const struct ccase *, const struct variable *);
+struct substring case_ss_idx (const struct ccase *, size_t width, size_t idx);
+uint8_t *case_str_rw (struct ccase *, const struct variable *);
+uint8_t *case_str_rw_idx (struct ccase *, size_t idx);
 
 int case_compare (const struct ccase *, const struct ccase *,
                   const struct variable *const *, size_t n_vars);
@@ -101,6 +116,7 @@ const union value *case_data_all (const struct ccase *);
 union value *case_data_all_rw (struct ccase *);
 \f
 struct ccase *case_unshare__ (struct ccase *);
+void case_unref__ (struct ccase *);
 
 /* If C is a shared case, that is, if it has a reference count
    greater than 1, makes a new unshared copy and returns it,
@@ -110,7 +126,7 @@ struct ccase *case_unshare__ (struct ccase *);
    This function should be used before attempting to modify any
    of the data in a case that might be shared, e.g.:
         c = case_unshare (c);              // Make sure that C is not shared.
-        case_data_rw (c, myvar)->f = 1;    // Modify data in C.
+        *case_num_rw (c, myvar) = 1;       // Modify data in C.
 */
 static inline struct ccase *
 case_unshare (struct ccase *c)
@@ -120,16 +136,6 @@ case_unshare (struct ccase *c)
   return c;
 }
 
-/* Increments case C's reference count and returns C.  Afterward,
-   case C is shared among its reference count holders. */
-static inline struct ccase *
-case_ref (const struct ccase *c_)
-{
-  struct ccase *c = (struct ccase *) c_;
-  c->ref_cnt++;
-  return c;
-}
-
 /* Decrements case C's reference count.  Frees C if its
    reference count drops to 0.
 
@@ -137,8 +143,8 @@ case_ref (const struct ccase *c_)
 static inline void
 case_unref (struct ccase *c)
 {
-  if (c != NULL && !--c->ref_cnt)
-    free (c);
+  if (c != NULL && --c->ref_cnt == 0)
+    case_unref__ (c);
 }
 
 /* Returns true if case C is shared.  A case that is shared
@@ -152,9 +158,17 @@ case_is_shared (const struct ccase *c)
 
 /* Returns the number of union values in C. */
 static inline size_t
-case_get_value_cnt (const struct ccase *c)
+case_get_n_values (const struct ccase *c)
+{
+  return caseproto_get_n_widths (c->proto);
+}
+
+/* Returns the prototype that describes the format of case C.
+   The caller must not unref the returned prototype. */
+static inline const struct caseproto *
+case_get_proto (const struct ccase *c)
 {
-  return c->n_values;
+  return c->proto;
 }
 
 #endif /* data/case.h */