1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011, 2013 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "data/transformations.h"
29 struct transformation;
31 struct dataset *dataset_create (struct session *, const char *);
32 struct dataset *dataset_clone (struct dataset *, const char *);
33 void dataset_destroy (struct dataset *);
35 void dataset_clear (struct dataset *);
37 const char *dataset_name (const struct dataset *);
38 void dataset_set_name (struct dataset *, const char *);
40 struct session *dataset_session (const struct dataset *);
41 void dataset_set_session (struct dataset *, struct session *);
43 struct dictionary *dataset_dict (const struct dataset *);
44 void dataset_set_dict (struct dataset *, struct dictionary *);
46 const struct casereader *dataset_source (const struct dataset *);
47 bool dataset_has_source (const struct dataset *ds);
48 bool dataset_set_source (struct dataset *, struct casereader *);
49 struct casereader *dataset_steal_source (struct dataset *);
51 bool dataset_delete_vars (struct dataset *, struct variable **, size_t n);
53 unsigned int dataset_seqno (const struct dataset *);
55 struct dataset_callbacks
57 /* Called whenever a procedure completes execution or whenever the
58 dictionary within the dataset is modified (though not when it is
59 replaced by a new dictionary). */
60 void (*changed) (void *aux);
62 /* Called whenever a transformation is added or removed. NON_EMPTY is true
63 if after the change there is at least one transformation, false if there
64 are no transformations. */
65 void (*transformations_changed) (bool non_empty, void *aux);
68 void dataset_set_callbacks (struct dataset *, const struct dataset_callbacks *,
71 /* Dataset GUI window display status. */
74 DATASET_ASIS, /* Current state unchanged. */
75 DATASET_FRONT, /* Display and raise to top. */
76 DATASET_MINIMIZED, /* Display as icon. */
77 DATASET_HIDDEN /* Do not display. */
79 enum dataset_display dataset_get_display (const struct dataset *);
80 void dataset_set_display (struct dataset *, enum dataset_display);
82 /* Transformations. */
84 void add_transformation (struct dataset *ds, const struct trns_class *, void *);
86 bool proc_cancel_all_transformations (struct dataset *ds);
87 void proc_push_transformations (struct dataset *);
88 void proc_pop_transformations (struct dataset *, struct trns_chain *);
90 void proc_start_temporary_transformations (struct dataset *ds);
91 bool proc_in_temporary_transformations (const struct dataset *ds);
92 bool proc_make_temporary_transformations_permanent (struct dataset *ds);
93 bool proc_cancel_temporary_transformations (struct dataset *ds);
94 struct variable *add_permanent_ordering_transformation (struct dataset *);
98 void proc_discard_output (struct dataset *ds);
100 bool proc_execute (struct dataset *ds);
101 time_t time_of_last_procedure (struct dataset *ds);
103 struct casereader *proc_open_filtering (struct dataset *, bool filter);
104 struct casereader *proc_open (struct dataset *);
105 bool proc_is_open (const struct dataset *);
106 bool proc_commit (struct dataset *);
108 bool dataset_end_of_command (struct dataset *);
110 struct measure_guesser *measure_guesser_create (struct dataset *);
111 void measure_guesser_run (struct measure_guesser *, const struct casereader *);
112 void measure_guesser_destroy (struct measure_guesser *);
114 const struct ccase *lagged_case (const struct dataset *ds, int n_before);
115 void dataset_need_lag (struct dataset *ds, int n_before);
117 /* Private interface for use by session code. */
119 void dataset_set_session__(struct dataset *, struct session *);
121 #endif /* dataset.h */