Revise.
[pspp] / src / vfm.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 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 #if !vfm_h
21 #define vfm_h 1
22
23 #include <time.h>
24
25 /* This is the time at which vfm was last invoked. */
26 extern time_t last_vfm_invocation;
27
28 struct ccase;
29 typedef struct write_case_data *write_case_data;
30 typedef int write_case_func (write_case_data);
31 \f
32 /* The current active file, from which cases are read. */
33 extern struct case_source *vfm_source;
34
35 /* A case source. */
36 struct case_source 
37   {
38     const struct case_source_class *class;      /* Class. */
39     void *aux;          /* Auxiliary data. */
40   };
41
42 /* A case source class. */
43 struct case_source_class
44   {
45     const char *name;                   /* Identifying name. */
46     
47     /* Returns the exact number of cases that READ will pass to
48        WRITE_CASE, if known, or -1 otherwise. */
49     int (*count) (const struct case_source *);
50
51     /* Reads the cases one by one into C and for each one calls
52        WRITE_CASE passing the given AUX data. */
53     void (*read) (struct case_source *,
54                   struct ccase *c,
55                   write_case_func *write_case, write_case_data aux);
56
57     /* Destroys the source. */
58     void (*destroy) (struct case_source *);
59   };
60
61 extern const struct case_source_class storage_source_class;
62 extern const struct case_source_class data_list_source_class;
63 extern const struct case_source_class file_type_source_class;
64 extern const struct case_source_class input_program_source_class;
65 extern const struct case_source_class get_source_class;
66 extern const struct case_source_class import_source_class;
67 extern const struct case_source_class sort_source_class;
68
69 struct dictionary;
70 struct case_source *create_case_source (const struct case_source_class *,
71                                         void *);
72 void free_case_source (struct case_source *);
73
74 int case_source_is_complex (const struct case_source *);
75 int case_source_is_class (const struct case_source *,
76                           const struct case_source_class *);
77
78 struct casefile *storage_source_get_casefile (struct case_source *);
79 struct case_source *storage_source_create (struct casefile *);
80 \f
81 /* The replacement active file, to which cases are written. */
82 extern struct case_sink *vfm_sink;
83
84 /* A case sink. */
85 struct case_sink 
86   {
87     const struct case_sink_class *class;        /* Class. */
88     void *aux;          /* Auxiliary data. */
89     size_t value_cnt;   /* Number of `union value's in case. */
90   };
91
92 /* A case sink class. */
93 struct case_sink_class
94   {
95     const char *name;                   /* Identifying name. */
96     
97     /* Opens the sink for writing. */
98     void (*open) (struct case_sink *);
99                   
100     /* Writes a case to the sink. */
101     void (*write) (struct case_sink *, const struct ccase *);
102     
103     /* Closes and destroys the sink. */
104     void (*destroy) (struct case_sink *);
105
106     /* Closes the sink and returns a source that can read back
107        the cases that were written, perhaps transformed in some
108        way.  The sink must still be separately destroyed by
109        calling destroy(). */
110     struct case_source *(*make_source) (struct case_sink *);
111   };
112
113 extern const struct case_sink_class storage_sink_class;
114 extern const struct case_sink_class null_sink_class;
115
116 struct case_sink *create_case_sink (const struct case_sink_class *,
117                                     const struct dictionary *,
118                                     void *);
119 void case_sink_open (struct case_sink *);
120 void case_sink_write (struct case_sink *, const struct ccase *);
121 void case_sink_destroy (struct case_sink *);
122 void free_case_sink (struct case_sink *);
123 \f
124 /* Number of cases to lag. */
125 extern int n_lag;
126
127 void procedure (int (*proc_func) (struct ccase *, void *aux), void *aux);
128 void procedure_with_splits (void (*begin_func) (void *aux),
129                             int (*proc_func) (struct ccase *, void *aux),
130                             void (*end_func) (void *aux),
131                             void *aux);
132 struct ccase *lagged_case (int n_before);
133 \f
134 void multipass_procedure_with_splits (void (*) (const struct casefile *,
135                                                 void *),
136                                       void *aux);
137
138 #endif /* !vfm_h */