Change "union value" to dynamically allocate long strings.
[pspp-builds.git] / src / data / datasheet.h
index dd47dcd41ac19bbc6cb53f9c874c3ed7e697c958..0508896ae9e30876be39c4e749aabe50d4e572ee 100644 (file)
@@ -1,20 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2007 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   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 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.
+   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. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #ifndef DATA_DATASHEET_H
 #define DATA_DATASHEET_H 1
 #include <data/case.h>
 #include <data/value.h>
 
+struct caseproto;
 struct casereader;
 
-/* A datasheet is a 2-d array of data that may be stored in
-   memory or on disk.  It efficiently supports data storage and
-   retrieval, as well as adding, removing, and rearranging both
-   rows and columns.  */
+/* A datasheet is a 2-d array of "union value"s that may be
+   stored in memory or on disk.  It efficiently supports data
+   storage and retrieval, as well as adding, removing, and
+   rearranging both rows and columns.  */
 
 struct datasheet *datasheet_create (struct casereader *);
 void datasheet_destroy (struct datasheet *);
 struct datasheet *datasheet_rename (struct datasheet *);
 
+const struct caseproto *datasheet_get_proto (const struct datasheet *);
+int datasheet_get_column_width (const struct datasheet *, size_t column);
+
 bool datasheet_error (const struct datasheet *);
 void datasheet_force_error (struct datasheet *);
 const struct taint *datasheet_get_taint (const struct datasheet *);
@@ -40,19 +42,22 @@ const struct taint *datasheet_get_taint (const struct datasheet *);
 struct casereader *datasheet_make_reader (struct datasheet *);
 
 /* Columns. */
-size_t datasheet_get_column_cnt (const struct datasheet *);
-bool datasheet_insert_columns (struct datasheet *,
-                               const union value[], size_t cnt,
-                               size_t before);
+size_t datasheet_get_n_columns (const struct datasheet *);
+bool datasheet_insert_column (struct datasheet *,
+                              const union value *, int width, size_t before);
 void datasheet_delete_columns (struct datasheet *, size_t start, size_t cnt);
 void datasheet_move_columns (struct datasheet *,
                              size_t old_start, size_t new_start,
                              size_t cnt);
+bool datasheet_resize_column (struct datasheet *, size_t column, int new_width,
+                              void (*resize_cb) (const union value *,
+                                                 union value *, void *aux),
+                              void *aux);
 
 /* Rows. */
-casenumber datasheet_get_row_cnt (const struct datasheet *);
+casenumber datasheet_get_n_rows (const struct datasheet *);
 bool datasheet_insert_rows (struct datasheet *,
-                            casenumber before, struct ccase[],
+                            casenumber before, struct ccase *[],
                             casenumber cnt);
 void datasheet_delete_rows (struct datasheet *,
                             casenumber first, casenumber cnt);
@@ -61,28 +66,15 @@ void datasheet_move_rows (struct datasheet *,
                           size_t cnt);
 
 /* Data. */
-bool datasheet_get_row (const struct datasheet *, casenumber, struct ccase *);
+struct ccase *datasheet_get_row (const struct datasheet *, casenumber);
 bool datasheet_put_row (struct datasheet *, casenumber, struct ccase *);
 bool datasheet_get_value (const struct datasheet *, casenumber, size_t column,
-                          union value *, int width);
+                          union value *);
 bool datasheet_put_value (struct datasheet *, casenumber, size_t column,
-                          const union value *, int width);
-
-/* Testing. */
-struct mc_options;
-
-struct datasheet_test_params
-  {
-    /* Parameters. */
-    int max_rows;
-    int max_cols;
-    int backing_rows;
-    int backing_cols;
+                          const union value *);
 
-    /* State. */
-    int next_value;
-  };
 
-struct mc_results *datasheet_test (struct mc_options *options, void *params);
+unsigned int hash_datasheet (const struct datasheet *ds);
+struct datasheet *clone_datasheet (const struct datasheet *ds);
 
 #endif /* data/datasheet.h */