1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA
25 /* This is the time at which vfm was last invoked. */
26 extern time_t last_vfm_invocation;
29 typedef struct write_case_data *write_case_data;
30 typedef int write_case_func (write_case_data);
32 /* The current active file, from which cases are read. */
33 extern struct case_source *vfm_source;
38 const struct case_source_class *class; /* Class. */
39 size_t value_cnt; /* Number of `union value's in case. */
40 void *aux; /* Auxiliary data. */
43 /* A case source class. */
44 struct case_source_class
46 const char *name; /* Identifying name. */
48 /* Returns the exact number of cases that READ will pass to
49 WRITE_CASE, if known, or -1 otherwise. */
50 int (*count) (const struct case_source *);
52 /* Reads the cases one by one into C and for each one calls
53 WRITE_CASE passing the given AUX data. */
54 void (*read) (struct case_source *,
56 write_case_func *write_case, write_case_data aux);
58 /* Destroys the source. */
59 void (*destroy) (struct case_source *);
62 extern const struct case_source_class storage_source_class;
63 extern const struct case_source_class data_list_source_class;
64 extern const struct case_source_class file_type_source_class;
65 extern const struct case_source_class input_program_source_class;
66 extern const struct case_source_class get_source_class;
67 extern const struct case_source_class import_source_class;
68 extern const struct case_source_class sort_source_class;
71 struct case_source *create_case_source (const struct case_source_class *,
72 const struct dictionary *,
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 *);
78 struct casefile *storage_source_get_casefile (struct case_source *);
80 /* The replacement active file, to which cases are written. */
81 extern struct case_sink *vfm_sink;
86 const struct case_sink_class *class; /* Class. */
87 void *aux; /* Auxiliary data. */
89 /* Cases written to a case sink belong to a dictionary, but
90 their data is compacted to drop scratch variables. */
91 const struct dictionary *dict; /* Dictionary for cases. */
92 int *idx_to_fv; /* `dict' index -> case `data' index. */
93 size_t value_cnt; /* Number of `union value's in case. */
96 /* A case sink class. */
97 struct case_sink_class
99 const char *name; /* Identifying name. */
101 /* Opens the sink for writing. */
102 void (*open) (struct case_sink *);
104 /* Writes a case to the sink. */
105 void (*write) (struct case_sink *, const struct ccase *);
107 /* Closes and destroys the sink. */
108 void (*destroy) (struct case_sink *);
110 /* Closes and destroys the sink and returns a source that can
111 read back the cases that were written, perhaps transformed
113 struct case_source *(*make_source) (struct case_sink *);
116 extern const struct case_sink_class storage_sink_class;
117 extern const struct case_sink_class null_sink_class;
119 struct case_sink *create_case_sink (const struct case_sink_class *,
120 const struct dictionary *,
122 void case_sink_open (struct case_sink *);
123 void case_sink_write (struct case_sink *, const struct ccase *);
124 void case_sink_destroy (struct case_sink *);
125 void free_case_sink (struct case_sink *);
127 /* Number of cases to lag. */
130 void procedure (int (*proc_func) (struct ccase *, void *aux), void *aux);
131 void procedure_with_splits (void (*begin_func) (void *aux),
132 int (*proc_func) (struct ccase *, void *aux),
133 void (*end_func) (void *aux),
135 struct ccase *lagged_case (int n_before);
137 void multipass_procedure_with_splits (void (*) (const struct casefile *,