file-handle-def: New function fh_equal().

[pspp] / src / data / file-handle-def.h

diff --git a/src/data/file-handle-def.h b/src/data/file-handle-def.h
index b4a6d6100e8ed291ed8705a659d381beb8ec26a6..df9a757835520df6cce509ee8019764c96c8faf1 100644 (file)
--- a/src/data/file-handle-def.h
+++ b/src/data/file-handle-def.h
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2005, 2006 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2005, 2006, 2010, 2011, 2013 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
@@ -17,9 +17,11 @@
 #ifndef FILE_HANDLE_DEF_H
 #define FILE_HANDLE_DEF_H
 
+#include "libpspp/compiler.h"
 #include <stdbool.h>
 #include <stddef.h>
-#include <libpspp/legacy-encoding.h>
+
+struct dataset;
 
 /* What a file handle refers to.
    (Ordinarily only a single value is allowed, but fh_open()
@@ -28,7 +30,7 @@ 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. */
+    FH_REF_DATASET = 004        /* Dataset. */
   };
 
 /* File modes. */
@@ -48,13 +50,25 @@ enum fh_access
     FH_ACC_WRITE                /* Write to it. */
   };
 
+/* How a line ends.
+
+   This affects only writing FH_MODE_TEXT files.  Writing in other modes does
+   not use line ends, and reading in FH_MODE_TEXT mode accepts all forms of
+   line ends. */
+enum fh_line_ends
+  {
+    FH_END_LF,                  /* Unix line ends (\n). */
+    FH_END_CRLF                 /* MS-DOS line ends (\r\n). */
+  };
+
 /* Properties of a file handle. */
 struct fh_properties
   {
     enum fh_mode mode;          /* File mode. */
+    enum fh_line_ends line_ends; /* Line ends for text files. */
     size_t record_width;        /* Length of fixed-format records. */
     size_t tab_width;           /* Tab width, 0=do not expand tabs. */
-    const char *encoding;       /* ASCII or EBCDIC? */
+    const char *encoding;       /* Charset for contents. */
   };
 
 void fh_init (void);
@@ -62,38 +76,40 @@ void fh_done (void);
 
 /* Creating file handles. */
 struct file_handle *fh_create_file (const char *handle_name,
-                                    const char *file_name,
+                                    const char *file_name, const char *file_name_encoding,
                                     const struct fh_properties *);
-struct file_handle *fh_create_scratch (const char *handle_name);
+struct file_handle *fh_create_dataset (struct dataset *);
 const struct fh_properties *fh_default_properties (void);
 
 /* Reference management. */
-struct file_handle *fh_ref (struct file_handle *);
+struct file_handle *fh_ref (struct file_handle *) WARN_UNUSED_RESULT;
 void fh_unref (struct file_handle *);
 void fh_unname (struct file_handle *);
 
 /* Finding file handles. */
 struct file_handle *fh_from_id (const char *handle_name);
-struct file_handle *fh_from_file_name (const char *file_name);
 struct file_handle *fh_inline_file (void);
 
 /* Generic properties of file handles. */
 const char *fh_get_id (const struct file_handle *);
 const char *fh_get_name (const struct file_handle *);
 enum fh_referent fh_get_referent (const struct file_handle *);
+const char *fh_get_encoding (const struct file_handle *);
+
+bool fh_equal (const struct file_handle *, const struct file_handle *);
 
 /* Properties of FH_REF_FILE file handles. */
 const char *fh_get_file_name (const struct file_handle *);
+const char *fh_get_file_name_encoding (const struct file_handle *handle);
 enum fh_mode fh_get_mode (const struct file_handle *) ;
+enum fh_line_ends fh_get_line_ends (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 *);
-const char *fh_get_legacy_encoding (const struct file_handle *);
 
-/* Properties of FH_REF_SCRATCH file handles. */
-struct scratch_handle *fh_get_scratch_handle (const struct file_handle *);
-void fh_set_scratch_handle (struct file_handle *, struct scratch_handle *);
+/* Properties of FH_REF_DATASET file handles. */
+struct dataset *fh_get_dataset (const struct file_handle *);
 
 /* Mutual exclusion for access . */
 struct fh_lock *fh_lock (struct file_handle *, enum fh_referent mask,