Clean up how transformations work.

[pspp] / src / data / transformations.h

diff --git a/src/data/transformations.h b/src/data/transformations.h
index ee82291c992a6f6e8ba8e57a8eda3b0beb729550..dd8c29d0c873c2b048d9953c47b3e2d3d86a9212 100644 (file)
--- a/src/data/transformations.h
+++ b/src/data/transformations.h
@@ -1,57 +1,73 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-9, 2000, 2006, 2009, 2011 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #ifndef TRANSFORMATIONS_H
 #define TRANSFORMATIONS_H 1
 
 #include <stdbool.h>
 #include <stddef.h>
-#include <data/case.h>
+#include "data/case.h"
+
+/* One transformation. */
 
-/* trns_proc_func return values. */
 enum trns_result
   {
-    TRNS_CONTINUE = -1,         /* Continue to next transformation. */
-    TRNS_DROP_CASE = -2,        /* Drop this case. */
-    TRNS_ERROR = -3,            /* A serious error, so stop the procedure. */
-    TRNS_END_CASE = -4,         /* Skip to next case.  INPUT PROGRAM only. */
-    TRNS_END_FILE = -5          /* End of input.  INPUT PROGRAM only. */
+    TRNS_CONTINUE,              /* Continue to next transformation. */
+    TRNS_BREAK,                 /* Break out of LOOP. */
+    TRNS_DROP_CASE,             /* Drop this case. */
+    TRNS_ERROR,                 /* A serious error, so stop the procedure. */
+    TRNS_END_CASE,              /* Skip to next case.  INPUT PROGRAM only. */
+    TRNS_END_FILE               /* End of input.  INPUT PROGRAM only. */
   };
 
 struct ccase;
-typedef void trns_finalize_func (void *);
-typedef int trns_proc_func (void *, struct ccase *, casenumber);
-typedef bool trns_free_func (void *);
+
+struct trns_class
+  {
+    const char *name;           /* For debugging. */
+    enum trns_result (*execute) (void *aux, struct ccase **, casenumber);
+    bool (*destroy) (void *aux);
+  };
+
+struct transformation
+  {
+    const struct trns_class *class;
+    void *aux;
+  };
 \f
-/* Transformation chains. */
+/* A chain of transformations. */
 
-struct trns_chain *trns_chain_create (void);
-void trns_chain_finalize (struct trns_chain *);
-bool trns_chain_destroy (struct trns_chain *);
+struct trns_chain
+  {
+    struct transformation *xforms;
+    size_t n;
+    size_t allocated;
+  };
 
-bool trns_chain_is_empty (const struct trns_chain *);
+#define TRNS_CHAIN_INIT { .n = 0 }
 
-void trns_chain_append (struct trns_chain *, trns_finalize_func *,
-                        trns_proc_func *, trns_free_func *, void *);
-size_t trns_chain_next (struct trns_chain *);
-enum trns_result trns_chain_execute (struct trns_chain *, enum trns_result,
-                                     struct ccase *, const size_t *case_nr);
+void trns_chain_init (struct trns_chain *);
+bool trns_chain_uninit (struct trns_chain *);
 
+bool trns_chain_clear (struct trns_chain *);
+
+void trns_chain_append (struct trns_chain *, const struct transformation *);
 void trns_chain_splice (struct trns_chain *, struct trns_chain *);
 
+enum trns_result trns_chain_execute (const struct trns_chain *,
+                                     casenumber case_num, struct ccase **);
+
 #endif /* transformations.h */