Adopt use of gnulib for portability.
[pspp-builds.git] / src / casefile.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 2004 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #ifndef HEADER_CASEFILE
21 #define HEADER_CASEFILE
22
23 #include <stddef.h>
24 #include <stdbool.h>
25
26 struct ccase;
27 struct casefile;
28 struct casereader;
29
30 struct casefile *casefile_create (size_t value_cnt);
31 void casefile_destroy (struct casefile *);
32
33 int casefile_in_core (const struct casefile *);
34 void casefile_to_disk (const struct casefile *);
35 void casefile_sleep (const struct casefile *);
36
37 size_t casefile_get_value_cnt (const struct casefile *);
38 unsigned long casefile_get_case_cnt (const struct casefile *);
39
40 void casefile_append (struct casefile *, const struct ccase *);
41 void casefile_append_xfer (struct casefile *, struct ccase *);
42
43 void casefile_mode_reader (struct casefile *);
44 struct casereader *casefile_get_reader (const struct casefile *);
45 struct casereader *casefile_get_destructive_reader (struct casefile *);
46
47 const struct casefile *casereader_get_casefile (const struct casereader *);
48 int casereader_read (struct casereader *, struct ccase *);
49 int casereader_read_xfer (struct casereader *, struct ccase *);
50 void casereader_read_xfer_assert (struct casereader *, struct ccase *);
51 void casereader_destroy (struct casereader *);
52
53 unsigned long casereader_cnum(const struct casereader *);
54
55 #endif /* casefile.h */