src/data/procedure.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000, 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 PROCEDURE_H
  20 #define PROCEDURE_H 1
  21
  22 #include <time.h>
  23 #include <stdbool.h>
  24
  25 #include <data/transformations.h>
  26 #include <data/casefile-factory.h>
  27 #include <libpspp/compiler.h>
  28
  29 struct ccase;
  30 struct casefile;
  31 struct case_sink;
  32 struct case_source;
  33
  34 struct dataset;
  35
  36 \f
  37 /* Transformations. */
  38
  39 void add_transformation (struct dataset *ds,
  40                          trns_proc_func *, trns_free_func *, void *);
  41 void add_transformation_with_finalizer (struct dataset *ds,
  42                                         trns_finalize_func *,
  43                                         trns_proc_func *,
  44                                         trns_free_func *, void *);
  45 size_t next_transformation (const struct dataset *ds);
  46
  47 void discard_variables (struct dataset *ds);
  48
  49
  50
  51 bool proc_cancel_all_transformations (struct dataset *ds);
  52 struct trns_chain *proc_capture_transformations (struct dataset *ds);
  53
  54 void proc_start_temporary_transformations (struct dataset *ds);
  55 bool proc_in_temporary_transformations (const struct dataset *ds);
  56 bool proc_make_temporary_transformations_permanent (struct dataset *ds);
  57 bool proc_cancel_temporary_transformations (struct dataset *ds);
  58 \f
  59 /* Procedures. */
  60
  61 struct dictionary ;
  62 typedef void  replace_source_callback (struct case_source *);
  63 typedef void  replace_dictionary_callback (struct dictionary *);
  64
  65
  66 struct dataset * create_dataset (struct casefile_factory *fact,
  67                                  replace_source_callback *,
  68                                  replace_dictionary_callback *
  69                                  );
  70
  71 void destroy_dataset (struct dataset *);
  72
  73 struct casefile_factory *dataset_get_casefile_factory (const struct dataset *);
  74
  75 void proc_set_source (struct dataset *ds, struct case_source *);
  76 bool proc_has_source (const struct dataset *ds);
  77
  78 void proc_set_sink (struct dataset *ds, struct case_sink *);
  79 struct casefile *proc_capture_output (struct dataset *ds);
  80
  81 typedef bool casefile_func (const struct casefile *, void *);
  82 typedef bool case_func (const struct ccase *, void *, const struct dataset *);
  83 typedef void begin_func (const struct ccase *, void *, const struct dataset*);
  84
  85 typedef bool end_func (void *, const struct dataset *);
  86
  87 typedef bool split_func (const struct ccase *, const struct casefile *,
  88                               void *, const struct dataset *);
  89
  90
  91
  92 bool procedure (struct dataset *ds, case_func *, void *aux)  WARN_UNUSED_RESULT;
  93
  94 bool procedure_with_splits (struct dataset *ds,
  95                             begin_func *,
  96                             case_func *,
  97                             end_func *,
  98                             void *aux)
  99      WARN_UNUSED_RESULT;
 100 bool multipass_procedure (struct dataset *ds, casefile_func *, void  *aux)
 101      WARN_UNUSED_RESULT;
 102 bool multipass_procedure_with_splits (struct dataset *ds,
 103                                            split_func *,
 104                                            void *aux)
 105      WARN_UNUSED_RESULT;
 106
 107 time_t time_of_last_procedure (struct dataset *ds);
 108
 109 void proc_open (struct dataset *);
 110 bool proc_read (struct dataset *, struct ccase **);
 111 bool proc_close (struct dataset *);
 112 \f
 113
 114 struct ccase *lagged_case (const struct dataset *ds, int n_before);
 115
 116 inline struct dictionary *dataset_dict (const struct dataset *ds);
 117 inline void dataset_set_dict ( struct dataset *ds, struct dictionary *dict);
 118
 119 inline int dataset_n_lag (const struct dataset *ds);
 120 inline void dataset_set_n_lag (struct dataset *ds, int n_lag);
 121
 122
 123 #endif /* procedure.h */