#if !vfm_h
#define vfm_h 1
-#include "cases.h"
#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
+/* The current active file, from which cases are read. */
+extern struct case_source *vfm_source;
-/* `value' indexes to initialize to particular values for certain cases. */
-extern struct long_vec reinit_sysmis; /* SYSMIS for every case. */
-extern struct long_vec reinit_blanks; /* Blanks for every case. */
-extern struct long_vec init_zero; /* Zero for first case only. */
-extern struct long_vec init_blanks; /* Blanks for first case only. */
+/* A case source. */
+struct case_source
+ {
+ const struct case_source_class *class; /* Class. */
+ size_t value_cnt; /* Number of `union value's in case. */
+ void *aux; /* Auxiliary data. */
+ };
-/* A case stream: either a source or a sink, depending on context. */
-struct case_stream
+/* A case source class. */
+struct case_source_class
{
- /* Initializes sink. */
- void (*init) (void);
+ const char *name; /* Identifying name. */
- /* Reads all the cases and passes them to WRITE_CASE. */
- void (*read) (void);
+ /* Returns the exact number of cases that READ will pass to
+ WRITE_CASE, if known, or -1 otherwise. */
+ int (*count) (const struct case_source *);
+
+ /* 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 *);
+ };
- /* Writes a single case, temp_case. */
- void (*write) (void);
+extern const struct case_source_class storage_source_class;
+extern const struct case_source_class data_list_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 *,
+ const struct dictionary *,
+ 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 casefile *storage_source_get_casefile (struct case_source *);
+struct case_source *storage_source_create (struct casefile *,
+ const struct dictionary *);
+\f
+/* The replacement active file, to which cases are written. */
+extern struct case_sink *vfm_sink;
+
+/* A case sink. */
+struct case_sink
+ {
+ const struct case_sink_class *class; /* Class. */
+ void *aux; /* Auxiliary data. */
+
+ /* Cases written to a case sink belong to a dictionary, but
+ their data is compacted to drop scratch variables. */
+ const struct dictionary *dict; /* Dictionary for cases. */
+ int *idx_to_fv; /* `dict' index -> case `data' index. */
+ size_t value_cnt; /* Number of `union value's in case. */
+ };
- /* Switches mode from sink to source. */
- void (*mode) (void);
+/* A case sink class. */
+struct case_sink_class
+ {
+ const char *name; /* Identifying name. */
- /* Discards source's internal data. */
- void (*destroy_source) (void);
-
- /* Discards sink's internal data. */
- void (*destroy_sink) (void);
-
- /* Identifying name for the stream. */
- const char *name;
+ /* Opens the sink for writing. */
+ void (*open) (struct case_sink *);
+
+ /* Writes a case to the sink. */
+ void (*write) (struct case_sink *, const struct ccase *);
+
+ /* Closes and destroys the sink. */
+ void (*destroy) (struct case_sink *);
+
+ /* 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 *);
};
-/* This is used to read from the active file. */
-extern struct case_stream *vfm_source;
-
-/* This is used to write to the replacement active file. */
-extern struct case_stream *vfm_sink;
-
-/* General data streams. */
-extern struct case_stream vfm_memory_stream;
-extern struct case_stream vfm_disk_stream;
-extern struct case_stream sort_stream;
-extern struct case_stream flip_stream;
-
-/* Streams that are only sources. */
-extern struct case_stream data_list_source;
-extern struct case_stream input_program_source;
-extern struct case_stream file_type_source;
-extern struct case_stream get_source;
-extern struct case_stream import_source;
-extern struct case_stream matrix_data_source;
-
+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 *,
+ 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;
-extern int (*write_case) (void);
-
-void procedure (void (*beginfunc) (void),
- int (*procfunc) (struct ccase *curcase),
- void (*endfunc) (void));
+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 page_to_disk (void);
-
-void process_active_file (void (*beginfunc) (void),
- int (*casefunc) (struct ccase *curcase),
- void (*endfunc) (void));
-void process_active_file_output_case (void);
+\f
+void multipass_procedure_with_splits (void (*) (const struct casefile *,
+ void *),
+ void *aux);
#endif /* !vfm_h */
projects / pspp-builds.git / blobdiff