Clean up and improve case code.
[pspp] / src / data / casefile.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 2004, 2006 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or
5    modify it under the terms of the GNU General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful, but
10    WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software
16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17    02110-1301, USA. */
18
19 #ifndef CASEFILE_H
20 #define CASEFILE_H
21
22 #include <config.h>
23 #include <stddef.h>
24 #include <stdbool.h>
25
26
27 struct ccase;
28 struct casereader;
29 struct casefile;
30 struct casefilter;
31
32 /* Casereader functions */
33
34 struct casefile *casereader_get_casefile (const struct casereader *r);
35
36 unsigned long casereader_cnum (const struct casereader *r);
37
38 bool casereader_read (struct casereader *r, struct ccase *c);
39
40 bool casereader_read_xfer (struct casereader *r, struct ccase *c);
41
42 void casereader_destroy (struct casereader *r);
43
44 struct casereader *casereader_clone(const struct casereader *r);
45
46
47 /* Casefile functions */
48
49 void casefile_destroy (struct casefile *cf);
50
51 bool casefile_error (const struct casefile *cf);
52
53 unsigned long casefile_get_case_cnt (const struct casefile *cf);
54
55 size_t casefile_get_value_cnt (const struct casefile *cf);
56
57 struct casereader *casefile_get_reader (const struct casefile *cf, struct casefilter *filter);
58
59 struct casereader *casefile_get_destructive_reader (struct casefile *cf);
60
61 bool casefile_append (struct casefile *cf, const struct ccase *c);
62
63 bool casefile_append_xfer (struct casefile *cf, struct ccase *c);
64
65 bool casefile_sleep (const struct casefile *cf);
66
67 bool casefile_in_core (const struct casefile *cf);
68
69 bool casefile_to_disk (const struct casefile *cf);
70
71 #endif