Add scratch file handles.

[pspp-builds.git] / src / file-handle-def.h

diff --git a/src/file-handle-def.h b/src/file-handle-def.h
index b4ca8e27d69bb32909b2521d2c069bc2c997212d..c5c61ea865a34cc67e8ea56aa473872d31f3fac0 100644 (file)
--- a/src/file-handle-def.h
+++ b/src/file-handle-def.h
@@ -1,5 +1,5 @@
 /* PSPP - computes sample statistics.
-   Copyright (C) 1997-9, 2000,2005 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2005, 2006 Free Software Foundation, Inc.
    Written by Ben Pfaff <blp@gnu.org>.
 
    This program is free software; you can redistribute it and/or
@@ -20,13 +20,24 @@
 #ifndef FILE_HANDLE_DEF_H
 #define FILE_HANDLE_DEF_H
 
-#include <config.h>
+#include <stdbool.h>
+#include <stddef.h>
+
+/* What a file handle refers to.
+   (Ordinarily only a single value is allowed, but fh_open()
+   and fh_parse() take a mask.) */
+enum fh_referent
+  {
+    FH_REF_FILE = 001,          /* Ordinary file (the most common case). */
+    FH_REF_INLINE = 002,        /* The inline file. */
+    FH_REF_SCRATCH = 004        /* Temporary dataset. */
+  };
 
 /* File modes. */
 enum fh_mode
   {
-    MODE_TEXT,                  /* New-line delimited lines. */
-    MODE_BINARY                 /* Fixed-length records. */
+    FH_MODE_TEXT,               /* New-line delimited lines. */
+    FH_MODE_BINARY              /* Fixed-length records. */
   };
 
 /* Properties of a file handle. */
@@ -41,27 +52,45 @@ void fh_init (void);
 void fh_done (void);
 
 /* Creating file handles. */
-struct file_handle *fh_create (const char *handle_name, 
-                               const char *filename,
-                               const struct fh_properties *);
-/* Destroy file handle */
-void fh_free(struct file_handle *);
-
+struct file_handle *fh_create_file (const char *handle_name,
+                                    const char *filename,
+                                    const struct fh_properties *);
+struct file_handle *fh_create_scratch (const char *handle_name);
 const struct fh_properties *fh_default_properties (void);
 
-/* Finding file handles, based on handle name or filename. */
+/* Delete file handle from global list. */
+void fh_free (struct file_handle *);
+
+/* Finding file handles. */
 struct file_handle *fh_from_name (const char *handle_name);
 struct file_handle *fh_from_filename (const char *filename);
+struct file_handle *fh_inline_file (void);
 
-/* Querying properties of file handles. */
+/* Generic properties of file handles. */
 const char *fh_get_name (const struct file_handle *);
+enum fh_referent fh_get_referent (const struct file_handle *);
+
+/* Properties of FH_REF_FILE file handles. */
 const char *fh_get_filename (const struct file_handle *);
 enum fh_mode fh_get_mode (const struct file_handle *) ;
+
+/* Properties of FH_REF_FILE and FH_REF_INLINE file handles. */
 size_t fh_get_record_width (const struct file_handle *);
 size_t fh_get_tab_width (const struct file_handle *);
 
+/* Properties of FH_REF_SCRATCH file handles. */
+struct scratch_handle *fh_get_scratch_handle (struct file_handle *);
+void fh_set_scratch_handle (struct file_handle *, struct scratch_handle *);
+
 /* Opening and closing file handles. */
-void **fh_open (struct file_handle *, const char *type, const char *mode);
+void **fh_open (struct file_handle *, enum fh_referent mask,
+                const char *type, const char *mode);
 int fh_close (struct file_handle *, const char *type, const char *mode);
+bool fh_is_open (const struct file_handle *);
+
+/* Default file handle for DATA LIST, REREAD, REPEATING DATA
+   commands. */
+struct file_handle *fh_get_default_handle (void);
+void fh_set_default_handle (struct file_handle *);
 
 #endif