Continue reforming procedure execution. In this phase, move
[pspp-builds.git] / src / data / procedure.h
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000, 2006 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 PROCEDURE_H
21 #define PROCEDURE_H 1
22
23 #include <time.h>
24 #include <stdbool.h>
25 #include <data/transformations.h>
26
27 struct ccase;
28 struct casefile;
29 struct case_sink;
30 struct case_source;
31
32 /* Dictionary produced by permanent and temporary transformations
33    on data from the source. */
34 extern struct dictionary *default_dict;
35 \f
36 /* Transformations. */
37
38 void add_transformation (trns_proc_func *, trns_free_func *, void *);
39 void add_transformation_with_finalizer (trns_finalize_func *,
40                                         trns_proc_func *,
41                                         trns_free_func *, void *);
42 size_t next_transformation (void);
43
44 void discard_variables (void);
45
46 bool proc_cancel_all_transformations (void);
47 struct trns_chain *proc_capture_transformations (void);
48
49 void proc_start_temporary_transformations (void);
50 bool proc_in_temporary_transformations (void);
51 bool proc_make_temporary_transformations_permanent (void);
52 bool proc_cancel_temporary_transformations (void);
53 \f
54 /* Procedures. */
55
56 void proc_init (void);
57 void proc_done (void);
58
59 void proc_set_source (struct case_source *);
60 bool proc_has_source (void);
61
62 void proc_set_sink (struct case_sink *);
63 struct casefile *proc_capture_output (void);
64
65 bool procedure (bool (*proc_func) (struct ccase *, void *aux), void *aux);
66 bool procedure_with_splits (void (*begin_func) (void *aux),
67                             bool (*proc_func) (struct ccase *, void *aux),
68                             void (*end_func) (void *aux),
69                             void *aux);
70 bool multipass_procedure (bool (*proc_func) (const struct casefile *,
71                                              void *aux),
72                           void *aux);
73 bool multipass_procedure_with_splits (bool (*) (const struct casefile *,
74                                                 void *),
75                                       void *aux);
76 time_t time_of_last_procedure (void);
77 \f
78 /* Number of cases to lag. */
79 extern int n_lag;
80
81 struct ccase *lagged_case (int n_before);
82
83 #endif /* procedure.h */