pintos-os.org Git - pspp/blob - src/data/dataset.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011, 2013 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>. */
  16
  17 #ifndef PROCEDURE_H
  18 #define PROCEDURE_H 1
  19
  20 #include <time.h>
  21 #include <stdbool.h>
  22
  23 #include "data/transformations.h"
  24
  25 struct casereader;
  26 struct dataset;
  27 struct dictionary;
  28 struct session;
  29 struct transformation;
  30 \f
  31 struct dataset *dataset_create (struct session *, const char *);
  32 struct dataset *dataset_clone (struct dataset *, const char *);
  33 void dataset_destroy (struct dataset *);
  34
  35 void dataset_clear (struct dataset *);
  36
  37 const char *dataset_name (const struct dataset *);
  38 void dataset_set_name (struct dataset *, const char *);
  39
  40 struct session *dataset_session (const struct dataset *);
  41 void dataset_set_session (struct dataset *, struct session *);
  42
  43 struct dictionary *dataset_dict (const struct dataset *);
  44 void dataset_set_dict (struct dataset *, struct dictionary *);
  45
  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 *);
  50
  51 unsigned int dataset_seqno (const struct dataset *);
  52
  53 struct dataset_callbacks
  54   {
  55     /* Called whenever a procedure completes execution or whenever the
  56        dictionary within the dataset is modified (though not when it is
  57        replaced by a new dictionary). */
  58     void (*changed) (void *aux);
  59
  60     /* Called whenever a transformation is added or removed.  NON_EMPTY is true
  61        if after the change there is at least one transformation, false if there
  62        are no transformations. */
  63     void (*transformations_changed) (bool non_empty, void *aux);
  64   };
  65
  66 void dataset_set_callbacks (struct dataset *, const struct dataset_callbacks *,
  67                             void *aux);
  68
  69 /* Dataset GUI window display status. */
  70 enum dataset_display
  71   {
  72     DATASET_ASIS,               /* Current state unchanged. */
  73     DATASET_FRONT,              /* Display and raise to top. */
  74     DATASET_MINIMIZED,          /* Display as icon. */
  75     DATASET_HIDDEN              /* Do not display. */
  76   };
  77 enum dataset_display dataset_get_display (const struct dataset *);
  78 void dataset_set_display (struct dataset *, enum dataset_display);
  79 \f
  80 /* Transformations. */
  81
  82 void add_transformation (struct dataset *ds, const struct trns_class *, void *);
  83
  84 bool proc_cancel_all_transformations (struct dataset *ds);
  85 void proc_push_transformations (struct dataset *);
  86 void proc_pop_transformations (struct dataset *, struct trns_chain *);
  87
  88 void proc_start_temporary_transformations (struct dataset *ds);
  89 bool proc_in_temporary_transformations (const struct dataset *ds);
  90 bool proc_make_temporary_transformations_permanent (struct dataset *ds);
  91 bool proc_cancel_temporary_transformations (struct dataset *ds);
  92 struct variable *add_permanent_ordering_transformation (struct dataset *);
  93 \f
  94 /* Procedures. */
  95
  96 void proc_discard_output (struct dataset *ds);
  97
  98 bool proc_execute (struct dataset *ds);
  99 time_t time_of_last_procedure (struct dataset *ds);
 100
 101 struct casereader *proc_open_filtering (struct dataset *, bool filter);
 102 struct casereader *proc_open (struct dataset *);
 103 bool proc_is_open (const struct dataset *);
 104 bool proc_commit (struct dataset *);
 105
 106 bool dataset_end_of_command (struct dataset *);
 107 \f
 108 const struct ccase *lagged_case (const struct dataset *ds, int n_before);
 109 void dataset_need_lag (struct dataset *ds, int n_before);
 110 \f
 111 /* Private interface for use by session code. */
 112
 113 void dataset_set_session__(struct dataset *, struct session *);
 114
 115 #endif /* dataset.h */