Add scratch file handles.
[pspp-builds.git] / src / vfm.h
index 186dd6f1d09ca17721f0524630346c28d92881d3..cfd639a925ead255085b610cc7f6bb49aca25637 100644 (file)
--- a/src/vfm.h
+++ b/src/vfm.h
 
    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., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA. */
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA. */
 
 #if !vfm_h
 #define vfm_h 1
 
 #include <time.h>
 
-/* This is the time at which vfm was last invoked. */
-extern time_t last_vfm_invocation;
-
-/* This is the case that is to be filled in by input programs. */
-extern struct ccase *temp_case;
-
+struct ccase;
 typedef struct write_case_data *write_case_data;
 typedef int write_case_func (write_case_data);
 \f
@@ -38,7 +33,7 @@ extern struct case_source *vfm_source;
 struct case_source 
   {
     const struct case_source_class *class;      /* Class. */
-    void *aux;                                  /* Auxiliary data. */
+    void *aux;          /* Auxiliary data. */
   };
 
 /* A case source class. */
@@ -50,31 +45,31 @@ struct case_source_class
        WRITE_CASE, if known, or -1 otherwise. */
     int (*count) (const struct case_source *);
 
-    /* Reads all the cases and calls WRITE_CASE passing the given
-       AUX data for each one. */
-    void (*read) (struct case_source *, write_case_func *, write_case_data);
+    /* Reads the cases one by one into C and for each one calls
+       WRITE_CASE passing the given AUX data. */
+    void (*read) (struct case_source *,
+                  struct ccase *c,
+                  write_case_func *write_case, write_case_data aux);
 
     /* Destroys the source. */
     void (*destroy) (struct case_source *);
   };
 
-extern const struct case_source_class memory_source_class;
-extern const struct case_source_class disk_source_class;
-extern const struct case_source_class data_list_source_class;
+extern const struct case_source_class storage_source_class;
 extern const struct case_source_class file_type_source_class;
 extern const struct case_source_class input_program_source_class;
-extern const struct case_source_class get_source_class;
-extern const struct case_source_class import_source_class;
-extern const struct case_source_class sort_source_class;
 
+struct dictionary;
 struct case_source *create_case_source (const struct case_source_class *,
                                         void *);
+void free_case_source (struct case_source *);
+
 int case_source_is_complex (const struct case_source *);
 int case_source_is_class (const struct case_source *,
                           const struct case_source_class *);
-struct case_list *memory_source_get_cases (const struct case_source *);
-void memory_source_set_cases (const struct case_source *,
-                                     struct case_list *);
+
+struct casefile *storage_source_get_casefile (struct case_source *);
+struct case_source *storage_source_create (struct casefile *);
 \f
 /* The replacement active file, to which cases are written. */
 extern struct case_sink *vfm_sink;
@@ -83,7 +78,8 @@ extern struct case_sink *vfm_sink;
 struct case_sink 
   {
     const struct case_sink_class *class;        /* Class. */
-    void *aux;                                  /* Auxiliary data. */
+    void *aux;          /* Auxiliary data. */
+    size_t value_cnt;   /* Number of `union value's in case. */
   };
 
 /* A case sink class. */
@@ -91,42 +87,47 @@ struct case_sink_class
   {
     const char *name;                   /* Identifying name. */
     
-    /* Creates the sink and opens it for writing. */
+    /* Opens the sink for writing. */
     void (*open) (struct case_sink *);
                   
     /* Writes a case to the sink. */
-    void (*write) (struct case_sink *, struct ccase *);
+    void (*write) (struct case_sink *, const struct ccase *);
     
     /* Closes and destroys the sink. */
     void (*destroy) (struct case_sink *);
 
-    /* Closes and destroys the sink and returns a source that can
-       read back the cases that were written, perhaps transformed
-       in some way. */
+    /* Closes the sink and returns a source that can read back
+       the cases that were written, perhaps transformed in some
+       way.  The sink must still be separately destroyed by
+       calling destroy(). */
     struct case_source *(*make_source) (struct case_sink *);
   };
 
-extern const struct case_sink_class memory_sink_class;
-extern const struct case_sink_class disk_sink_class;
-extern const struct case_sink_class sort_sink_class;
+extern const struct case_sink_class storage_sink_class;
+extern const struct case_sink_class null_sink_class;
 
-struct case_sink *create_case_sink (const struct case_sink_class *, void *);
+struct case_sink *create_case_sink (const struct case_sink_class *,
+                                    const struct dictionary *,
+                                    void *);
+void case_sink_open (struct case_sink *);
+void case_sink_write (struct case_sink *, const struct ccase *);
+void case_sink_destroy (struct case_sink *);
+void free_case_sink (struct case_sink *);
 \f
 /* Number of cases to lag. */
 extern int n_lag;
 
-void procedure (void (*beginfunc) (void *aux),
-               int (*procfunc) (struct ccase *curcase, void *aux),
-               void (*endfunc) (void *aux),
-                void *aux);
+void procedure (int (*proc_func) (struct ccase *, void *aux), void *aux);
+void procedure_with_splits (void (*begin_func) (void *aux),
+                            int (*proc_func) (struct ccase *, void *aux),
+                            void (*end_func) (void *aux),
+                            void *aux);
 struct ccase *lagged_case (int n_before);
-void compact_case (struct ccase *dest, const struct ccase *src);
-void write_active_file_to_disk (void);
-
-void process_active_file (void (*beginfunc) (void *),
-                         int (*casefunc) (struct ccase *curcase, void *),
-                         void (*endfunc) (void *),
-                          void *aux);
-void process_active_file_output_case (void);
+\f
+void multipass_procedure_with_splits (void (*) (const struct casefile *,
+                                                void *),
+                                      void *aux);
+\f
+time_t vfm_last_invocation (void);
 
 #endif /* !vfm_h */