Make cases simpler, faster, and easier to understand.
[pspp-builds.git] / src / data / casewriter.c
index 1a8ae730175eb68587fd1b11ef6cd4cc175e06e3..56e6c291cbb4fb7722a310eeb504b20bb58a37d5 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 2007 Free Software Foundation, Inc.
+   Copyright (C) 2007, 2009 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
@@ -35,6 +35,7 @@
 struct casewriter
   {
     struct taint *taint;
+    size_t value_cnt;
     casenumber case_cnt;
     const struct casewriter_class *class;
     void *aux;
@@ -47,6 +48,7 @@ static struct casewriter *create_casewriter_window (size_t value_cnt,
 void
 casewriter_write (struct casewriter *writer, struct ccase *c)
 {
+  assert (case_get_value_cnt (c) >= writer->value_cnt);
   writer->class->write (writer, writer->aux, c);
 }
 
@@ -67,6 +69,14 @@ casewriter_destroy (struct casewriter *writer)
   return ok;
 }
 
+/* Returns the number of `union value's in each case written to
+   WRITER. */
+size_t
+casewriter_get_value_cnt (const struct casewriter *writer)
+{
+  return writer->value_cnt;
+}
+
 /* Destroys WRITER and in its place returns a casereader that can
    be used to read back the data written to WRITER.  WRITER must
    not be used again after calling this function, even as an
@@ -81,8 +91,7 @@ casewriter_destroy (struct casewriter *writer)
 struct casereader *
 casewriter_make_reader (struct casewriter *writer)
 {
-  struct casereader *reader;
-  reader = writer->class->convert_to_reader (writer, writer->aux);
+  struct casereader *reader = writer->class->convert_to_reader (writer, writer->aux);
   taint_propagate (writer->taint, casereader_get_taint (reader));
   taint_destroy (writer->taint);
   free (writer);
@@ -133,12 +142,15 @@ casewriter_get_taint (const struct casewriter *writer)
 }
 
 /* Creates and returns a new casewriter with the given CLASS and
-   auxiliary data AUX. */
+   auxiliary data AUX.  The casewriter accepts cases with
+   VALUE_CNT `union value's. */
 struct casewriter *
-casewriter_create (const struct casewriter_class *class, void *aux)
+casewriter_create (size_t value_cnt,
+                   const struct casewriter_class *class, void *aux)
 {
   struct casewriter *writer = xmalloc (sizeof *writer);
   writer->taint = taint_create ();
+  writer->value_cnt = value_cnt;
   writer->case_cnt = 0;
   writer->class = class;
   writer->aux = aux;
@@ -157,7 +169,7 @@ casewriter_create (const struct casewriter_class *class, void *aux)
 struct casewriter *
 autopaging_writer_create (size_t value_cnt)
 {
-  return create_casewriter_window (value_cnt, get_workspace_cases (value_cnt));
+  return create_casewriter_window (value_cnt, settings_get_workspace_cases (value_cnt));
 }
 
 /* Returns a casewriter for cases with VALUE_CNT struct values
@@ -196,7 +208,8 @@ static struct casewriter *
 create_casewriter_window (size_t value_cnt, casenumber max_in_core_cases)
 {
   struct casewindow *window = casewindow_create (value_cnt, max_in_core_cases);
-  struct casewriter *writer = casewriter_create (&casewriter_window_class,
+  struct casewriter *writer = casewriter_create (value_cnt,
+                                                 &casewriter_window_class,
                                                  window);
   taint_propagate (casewindow_get_taint (window),
                    casewriter_get_taint (writer));
@@ -227,27 +240,29 @@ casewriter_window_convert_to_reader (struct casewriter *writer UNUSED,
                                      void *window_)
 {
   struct casewindow *window = window_;
-  struct casereader *reader;
-  reader = casereader_create_random (casewindow_get_value_cnt (window),
-                                     casewindow_get_case_cnt (window),
-                                     &casereader_window_class, window);
+  struct casereader *reader =
+    casereader_create_random (casewindow_get_value_cnt (window),
+                             casewindow_get_case_cnt (window),
+                             &casereader_window_class, window);
+
   taint_propagate (casewindow_get_taint (window),
                    casereader_get_taint (reader));
   return reader;
 }
 
-/* Reads the case at the given 0-based OFFSET from the front of
-   WINDOW into C.  Returns true if successful, false if
-   OFFSET is beyond the end of file or upon I/O error. */
-static bool
+/* Reads and returns the case at the given 0-based OFFSET from
+   the front of WINDOW into C.  Returns a null pointer if OFFSET
+   is beyond the end of file or upon I/O error.  The caller must
+   call case_unref() on the returned case when it is no longer
+   needed.*/
+static struct ccase *
 casereader_window_read (struct casereader *reader UNUSED, void *window_,
-                        casenumber offset, struct ccase *c)
+                        casenumber offset)
 {
   struct casewindow *window = window_;
   if (offset >= casewindow_get_case_cnt (window))
-    return false;
-  else
-    return casewindow_get_case (window, offset, c);
+    return NULL;
+  return casewindow_get_case (window, offset);
 }
 
 /* Destroys casewindow reader WINDOW. */