Fixed bug reporting the significance of paired value t-test.
[pspp-builds.git] / src / ui / gui / psppire-case-file.c
index 0c8e52a93968430186eed573c37ffff0f46a8b0a..2edfec89ae0a036c3791309ba432e16567839706 100644 (file)
@@ -1,37 +1,37 @@
-/* 
-    PSPPIRE --- A Graphical User Interface for PSPP
-    Copyright (C) 2006  Free Software Foundation
-    Written by John Darrington
+/* PSPPIRE - a graphical user interface for PSPP.
+   Copyright (C) 2006  Free Software Foundation
 
-    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
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
+   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
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    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., 51 Franklin Street, Fifth Floor, Boston, MA
-    02110-1301, USA. */
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
+#include <config.h>
 #include <string.h>
 #include <stdlib.h>
 
-#include "psppire-object.h"
 #include "psppire-case-file.h"
 
 #include <gtksheet/gtkextra-marshal.h>
 
+#include <data/format.h>
 #include <data/case.h>
-#include <data/casefile.h>
 #include <data/data-in.h>
-
+#include <data/datasheet.h>
+#include <data/casereader.h>
 #include <math/sort.h>
+#include <libpspp/misc.h>
+
+#include "xalloc.h"
+#include "xmalloca.h"
 
 /* --- prototypes --- */
 static void psppire_case_file_class_init       (PsppireCaseFileClass   *class);
@@ -42,12 +42,12 @@ static void psppire_case_file_finalize      (GObject                *object);
 /* --- variables --- */
 static GObjectClass     *parent_class = NULL;
 
-enum  {CASE_CHANGED, 
+enum  {CASE_CHANGED,
        CASE_INSERTED,
        CASES_DELETED,
        n_SIGNALS};
 
-static guint signal[n_SIGNALS];
+static guint signal[n_SIGNALS];
 
 
 /* --- functions --- */
@@ -74,55 +74,130 @@ psppire_case_file_get_type (void)
        (GInstanceInitFunc) psppire_case_file_init,
       };
 
-      object_type = g_type_register_static (G_TYPE_PSPPIRE_OBJECT, "PsppireCaseFile",
+      object_type = g_type_register_static (G_TYPE_OBJECT, "PsppireCaseFile",
                                            &object_info, 0);
     }
 
   return object_type;
 }
 
+/* Properties */
+enum
+{
+  PROP_0,
+  PROP_DATASHEET,
+  PROP_READER
+};
+
+
+
+
+static void
+psppire_case_file_set_property (GObject         *object,
+                               guint            prop_id,
+                               const GValue    *value,
+                               GParamSpec      *pspec)
+
+{
+  PsppireCaseFile *cf = PSPPIRE_CASE_FILE (object);
+
+  switch (prop_id)
+    {
+    case PROP_READER:
+      cf->datasheet = datasheet_create (g_value_get_pointer (value));
+      cf->accessible = TRUE;
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    };
+}
+
+static void
+psppire_case_file_get_property (GObject         *object,
+                               guint            prop_id,
+                               GValue          *value,
+                               GParamSpec      *pspec)
+{
+  PsppireCaseFile *cf = PSPPIRE_CASE_FILE (object);
+
+  switch (prop_id)
+    {
+    case PROP_DATASHEET:
+      g_value_set_pointer (value, cf->datasheet);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    };
+}
+
 
 static void
 psppire_case_file_class_init (PsppireCaseFileClass *class)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (class);
+  GParamSpec *datasheet_spec ;
+  GParamSpec *reader_spec ;
 
   parent_class = g_type_class_peek_parent (class);
 
   object_class->finalize = psppire_case_file_finalize;
 
-  signal[CASE_CHANGED] =
-    g_signal_new ("case_changed",
-                 G_TYPE_FROM_CLASS(class),
+  datasheet_spec =
+    g_param_spec_pointer ("datasheet",
+                         "Datasheet",
+                         "A pointer to the datasheet belonging to this object",
+                         G_PARAM_READABLE );
+  reader_spec =
+    g_param_spec_pointer ("casereader",
+                         "CaseReader",
+                         "A pointer to the case reader from which this object is constructed",
+                         G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE );
+
+  object_class->set_property = psppire_case_file_set_property;
+  object_class->get_property = psppire_case_file_get_property;
+
+  g_object_class_install_property (object_class,
+                                   PROP_DATASHEET,
+                                   datasheet_spec);
+
+  g_object_class_install_property (object_class,
+                                   PROP_READER,
+                                   reader_spec);
+
+  signals [CASE_CHANGED] =
+    g_signal_new ("case-changed",
+                 G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
                  g_cclosure_marshal_VOID__INT,
-                 G_TYPE_NONE, 
+                 G_TYPE_NONE,
                  1,
                  G_TYPE_INT);
 
 
-  signal[CASE_INSERTED] =
-    g_signal_new ("case_inserted",
-                 G_TYPE_FROM_CLASS(class),
+  signal[CASE_INSERTED] =
+    g_signal_new ("case-inserted",
+                 G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
                  g_cclosure_marshal_VOID__INT,
-                 G_TYPE_NONE, 
+                 G_TYPE_NONE,
                  1,
                  G_TYPE_INT);
 
 
-  signal[CASES_DELETED] =
-    g_signal_new ("cases_deleted",
-                 G_TYPE_FROM_CLASS(class),
+  signal[CASES_DELETED] =
+    g_signal_new ("cases-deleted",
+                 G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
                  gtkextra_VOID__INT_INT,
-                 G_TYPE_NONE, 
+                 G_TYPE_NONE,
                  2,
                  G_TYPE_INT, G_TYPE_INT);
 }
@@ -131,9 +206,9 @@ static void
 psppire_case_file_finalize (GObject *object)
 {
   PsppireCaseFile *cf = PSPPIRE_CASE_FILE (object);
-  
-  if ( cf->casefile) 
-    casefile_destroy(cf->casefile);
+
+  if ( cf->accessible)
+    datasheet_destroy (cf->datasheet);
 
   G_OBJECT_CLASS (parent_class)->finalize (object);
 }
@@ -141,124 +216,233 @@ psppire_case_file_finalize (GObject *object)
 static void
 psppire_case_file_init (PsppireCaseFile *cf)
 {
-  cf->casefile = 0;
+  cf->datasheet = NULL;
+  cf->accessible = FALSE;
 }
 
+
 /**
  * psppire_case_file_new:
  * @returns: a new #PsppireCaseFile object
- * 
- * Creates a new #PsppireCaseFile. 
+ *
+ * Creates a new #PsppireCaseFile.
  */
 PsppireCaseFile*
-psppire_case_file_new (gint var_cnt)
+psppire_case_file_new (struct casereader *reader)
 {
-  PsppireCaseFile *cf = g_object_new (G_TYPE_PSPPIRE_CASE_FILE, NULL);
+  return g_object_new (G_TYPE_PSPPIRE_CASE_FILE,
+                      "casereader", reader,
+                      NULL);
+}
 
-  cf->casefile = casefile_create(var_cnt);
 
-  return cf;
-}
+gboolean
+psppire_case_file_delete_cases (PsppireCaseFile *cf, casenumber n_cases, casenumber first)
+{
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->datasheet, FALSE);
+  g_return_val_if_fail (cf->accessible, FALSE);
+
+  g_return_val_if_fail (first + n_cases <=
+                       psppire_case_file_get_case_count (cf), FALSE);
+
+  datasheet_delete_rows (cf->datasheet, first, n_cases);
 
+  g_signal_emit (cf, signals [CASES_DELETED], 0, first, n_cases);
 
+  return TRUE;
+}
 
-/* Append a case to the case file */
+/* Insert case CC into the case file before POSN */
 gboolean
-psppire_case_file_append_case(PsppireCaseFile *cf, 
-                             struct ccase *c)
+psppire_case_file_insert_case (PsppireCaseFile *cf,
+                              struct ccase *cc,
+                              casenumber posn)
 {
+  struct ccase tmp;
   bool result ;
-  gint posn ;
 
-  g_return_val_if_fail(cf, FALSE);
-  g_return_val_if_fail(cf->casefile, FALSE);
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->datasheet, FALSE);
+  g_return_val_if_fail (cf->accessible, FALSE);
 
-  posn = casefile_get_case_cnt(cf->casefile);
+  case_clone (&tmp, cc);
+  result = datasheet_insert_rows (cf->datasheet, posn, &tmp, 1);
+
+  if ( result )
+    g_signal_emit (cf, signals [CASE_INSERTED], 0, posn);
+  else
+    g_warning ("Cannot insert case at position %ld\n", posn);
 
-  result = casefile_append(cf->casefile, c);
-  
-  g_signal_emit(cf, signal[CASE_INSERTED], 0, posn);
-               
   return result;
 }
 
 
-inline gint
-psppire_case_file_get_case_count(const PsppireCaseFile *cf)
+casenumber
+psppire_case_file_get_case_count (const PsppireCaseFile *cf)
 {
-  g_return_val_if_fail(cf, FALSE);
-  
-  if ( ! cf->casefile) 
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->accessible, FALSE);
+
+  if ( ! cf->datasheet)
     return 0;
 
-  return casefile_get_case_cnt(cf->casefile);
+  return datasheet_get_row_cnt (cf->datasheet);
 }
 
-/* Return the IDXth value from case CASENUM.
-   The return value must not be freed or written to
- */
-const union value *
-psppire_case_file_get_value(const PsppireCaseFile *cf, gint casenum, gint idx)
+/* Copies the IDXth value from case CASENUM into VALUE.
+   If VALUE is null, then memory is allocated is allocated with
+   malloc.  Returns the value if successful, NULL on failure. */
+union value *
+psppire_case_file_get_value (const PsppireCaseFile *cf,
+                             casenumber casenum, size_t idx,
+                             union value *value, int width)
 {
-  const union value *v; 
-  struct ccase c;
-  struct casereader *reader =  casefile_get_random_reader (cf->casefile);
-
-  casereader_seek(reader, casenum);
+  bool allocated;
 
-  casereader_read(reader, &c);
+  g_return_val_if_fail (cf, false);
+  g_return_val_if_fail (cf->datasheet, false);
 
-  v = case_data(&c, idx);
-  casereader_destroy(reader);
-  case_destroy(&c);
+  g_return_val_if_fail (idx < datasheet_get_column_cnt (cf->datasheet), false);
 
-  return v;
+  if (value == NULL)
+    {
+      value = xnmalloc (value_cnt_from_width (width), sizeof *value);
+      allocated = true;
+    }
+  else
+    allocated = false;
+  if (!datasheet_get_value (cf->datasheet, casenum, idx, value, width))
+    {
+      if (allocated)
+        free (value);
+      value = NULL;
+    }
+  return value;
 }
 
 void
-psppire_case_file_clear(PsppireCaseFile *cf)
+psppire_case_file_clear (PsppireCaseFile *cf)
 {
-  casefile_destroy(cf->casefile);
-  cf->casefile = 0;
-  g_signal_emit(cf, signal[CASES_DELETED], 0, 0, -1);
+  datasheet_destroy (cf->datasheet);
+  cf->datasheet = NULL;
+  g_signal_emit (cf, signals [CASES_DELETED], 0, 0, -1);
 }
 
-/* Set the IDXth value of case C using FF and DATA */
+/* Set the IDXth value of case C to V.
+   Returns true if successful, false on I/O error. */
 gboolean
-psppire_case_file_set_value(PsppireCaseFile *cf, gint casenum, gint idx,
-                           struct data_in *d_in)
+psppire_case_file_set_value (PsppireCaseFile *cf, casenumber casenum, gint idx,
+                           union value *v, gint width)
 {
-  struct ccase cc ;
+  bool ok;
+
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->datasheet, FALSE);
+
+  g_return_val_if_fail (idx < datasheet_get_column_cnt (cf->datasheet), FALSE);
+
+  ok = datasheet_put_value (cf->datasheet, casenum, idx, v, width);
+  if (ok)
+    g_signal_emit (cf, signals [CASE_CHANGED], 0, casenum);
+  return ok;
+}
 
-  struct casereader *reader =  casefile_get_random_reader (cf->casefile);
 
-  casereader_seek(reader, casenum);
-  casereader_read(reader, &cc);
 
-  /* Cast away const in flagrant abuse of the casefile */
-  d_in->v = (union value *) case_data(&cc, idx);
+/* Set the IDXth value of case C using D_IN */
+gboolean
+psppire_case_file_data_in (PsppireCaseFile *cf, casenumber casenum, gint idx,
+                          struct substring input, const struct fmt_spec *fmt)
+{
+  union value *value = NULL;
+  int width;
+  bool ok;
 
-  if ( ! data_in(d_in) ) 
-    g_warning("Cant set value\n");
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->datasheet, FALSE);
 
-  case_destroy(&cc);
-  casereader_destroy(reader);
+  g_return_val_if_fail (idx < datasheet_get_column_cnt (cf->datasheet), FALSE);
 
-  g_signal_emit(cf, signal[CASE_CHANGED], 0, casenum);
+  width = fmt_var_width (fmt);
+  value = xmalloca (value_cnt_from_width (width) * sizeof *value);
+  ok = (datasheet_get_value (cf->datasheet, casenum, idx, value, width)
+        && data_in (input, LEGACY_NATIVE, fmt->type, 0, 0, 0, value, width)
+        && datasheet_put_value (cf->datasheet, casenum, idx, value, width));
+
+  if (ok)
+    g_signal_emit (cf, signals [CASE_CHANGED], 0, casenum);
+
+  freea (value);
 
   return TRUE;
 }
 
 
 void
-psppire_case_file_sort(PsppireCaseFile *cf, const struct sort_criteria *sc)
+psppire_case_file_sort (PsppireCaseFile *cf, struct case_ordering *ordering)
 {
+  struct casereader *sorted_data;
   gint c;
-  struct casereader *reader = casefile_get_reader(cf->casefile);
-  cf->casefile = sort_execute(reader, sc);
+
+  sorted_data = sort_execute (datasheet_make_reader (cf->datasheet), ordering);
+  cf->datasheet = datasheet_create (sorted_data);
 
   /* FIXME: Need to have a signal to change a range of cases, instead of
      calling a signal many times */
-  for ( c = 0 ; c < casefile_get_case_cnt(cf->casefile) ; ++c ) 
-    g_signal_emit(cf, signal[CASE_CHANGED], 0, c);
+  for ( c = 0 ; c < datasheet_get_row_cnt (cf->datasheet) ; ++c )
+    g_signal_emit (cf, signals [CASE_CHANGED], 0, c);
 }
+
+
+/* Resize the cases in the casefile, by inserting N_VALUES into every
+   one of them at the position immediately preceeding WHERE.
+*/
+gboolean
+psppire_case_file_insert_values (PsppireCaseFile *cf,
+                                gint n_values, gint where)
+{
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->accessible, FALSE);
+
+  if ( n_values == 0 )
+    return FALSE;
+
+  g_assert (n_values > 0);
+
+  if ( ! cf->datasheet )
+    cf->datasheet = datasheet_create (NULL);
+
+  {
+    union value *values = xcalloc (n_values, sizeof *values);
+    datasheet_insert_columns (cf->datasheet, values, n_values, where);
+    free (values);
+  }
+
+  return TRUE;
+}
+
+
+/* Fills C with the CASENUMth case.
+   Returns true on success, false otherwise.
+ */
+gboolean
+psppire_case_file_get_case (const PsppireCaseFile *cf, casenumber casenum,
+                          struct ccase *c)
+{
+  g_return_val_if_fail (cf, FALSE);
+  g_return_val_if_fail (cf->datasheet, FALSE);
+
+  return datasheet_get_row (cf->datasheet, casenum, c);
+}
+
+
+
+struct casereader *
+psppire_case_file_make_reader (PsppireCaseFile *cf)
+{
+  struct casereader *r = datasheet_make_reader (cf->datasheet);
+  cf->accessible = FALSE;
+  return r;
+}
+