Change enum legacy_encoding to const char *.
[pspp-builds.git] / src / language / data-io / data-writer.c
index 57a5b9f71abc29422006c11c88b8c885cf66f76a..85b11d4c1e553054160f8b1a57a3d1cac2704a00 100644 (file)
@@ -1,42 +1,51 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 1997-2004 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 1997-2004, 2006 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/>. */
 
 #include <config.h>
+
 #include <language/data-io/data-writer.h>
+
 #include <assert.h>
 #include <errno.h>
+#include <stdint.h>
 #include <stdlib.h>
-#include <libpspp/alloc.h>
-#include <libpspp/message.h>
+#include <sys/stat.h>
+
+#include <data/file-name.h>
+#include <data/make-file.h>
 #include <language/data-io/file-handle.h>
-#include <data/filename.h>
+#include <libpspp/assertion.h>
+#include <libpspp/integer-format.h>
+#include <libpspp/message.h>
 #include <libpspp/str.h>
 
+#include "minmax.h"
+#include "xalloc.h"
+
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
+#define N_(msgid) (msgid)
 
 /* Data file writer. */
 struct dfm_writer
   {
     struct file_handle *fh;     /* File handle. */
-    struct file_ext file;      /* Associated file. */
-    char *bounce;               /* Bounce buffer for fixed-size fields. */
+    struct fh_lock *lock;       /* Exclusive access to file. */
+    FILE *file;                 /* Associated file. */
+    struct replace_file *rf;    /* Atomic file replacement support. */
   };
 
 /* Opens a file handle for writing as a data file. */
@@ -44,73 +53,120 @@ struct dfm_writer *
 dfm_open_writer (struct file_handle *fh)
 {
   struct dfm_writer *w;
-  void **aux;
-  
-  aux = fh_open (fh, FH_REF_FILE, "data file", "ws");
-  if (aux == NULL)
+  struct fh_lock *lock;
+
+  lock = fh_lock (fh, FH_REF_FILE, N_("data file"), FH_ACC_WRITE, false);
+  if (lock == NULL)
     return NULL;
-  if (*aux != NULL)
-    return *aux;
-
-  w = *aux = xmalloc (sizeof *w);
-  w->fh = fh;
-  w->file.file = NULL;
-  w->bounce = NULL;
-
-  w->file.filename = xstrdup (fh_get_filename (w->fh));
-  w->file.mode = "wb";
-  w->file.file = NULL;
-  w->file.sequence_no = NULL;
-  w->file.param = NULL;
-  w->file.postopen = NULL;
-  w->file.preclose = NULL;
-      
-  if (!fn_open_ext (&w->file))
+
+  w = fh_lock_get_aux (lock);
+  if (w != NULL)
+    return w;
+
+  w = xmalloc (sizeof *w);
+  w->fh = fh_ref (fh);
+  w->lock = lock;
+  w->rf = replace_file_start (fh_get_file_name (w->fh), "wb",
+                              (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP
+                               | S_IROTH | S_IWOTH), &w->file, NULL);
+  if (w->rf == NULL)
     {
       msg (ME, _("An error occurred while opening \"%s\" for writing "
                  "as a data file: %s."),
-           fh_get_filename (w->fh), strerror (errno));
-      goto error;
+           fh_get_file_name (w->fh), strerror (errno));
+      dfm_close_writer (w);
+      return NULL;
     }
+  fh_lock_set_aux (lock, w);
 
   return w;
-
- error:
-  dfm_close_writer (w);
-  return NULL;
 }
 
 /* Returns false if an I/O error occurred on WRITER, true otherwise. */
 bool
-dfm_write_error (const struct dfm_writer *writer) 
+dfm_write_error (const struct dfm_writer *writer)
 {
-  return ferror (writer->file.file);
+  return ferror (writer->file);
 }
 
-/* Writes record REC having length LEN to the file corresponding to
-   HANDLE.  REC is not null-terminated.  Returns nonzero on success,
-   zero on failure. */
-int
+/* Writes record REC (which need not be null-terminated) having
+   length LEN to the file corresponding to HANDLE.  Adds any
+   needed formatting, such as a trailing new-line.  Returns true
+   on success, false on failure. */
+bool
 dfm_put_record (struct dfm_writer *w, const char *rec, size_t len)
 {
   assert (w != NULL);
 
   if (dfm_write_error (w))
-    return 0;
-  
-  if (fh_get_mode (w->fh) == FH_MODE_BINARY
-      && len < fh_get_record_width (w->fh))
+    return false;
+
+  switch (fh_get_mode (w->fh))
     {
-      size_t rec_width = fh_get_record_width (w->fh);
-      if (w->bounce == NULL)
-        w->bounce = xmalloc (rec_width);
-      memcpy (w->bounce, rec, len);
-      memset (&w->bounce[len], 0, rec_width - len);
-      rec = w->bounce;
-      len = rec_width;
+    case FH_MODE_TEXT:
+      fwrite (rec, len, 1, w->file);
+      putc ('\n', w->file);
+      break;
+
+    case FH_MODE_FIXED:
+      {
+        size_t record_width = fh_get_record_width (w->fh);
+        size_t write_bytes = MIN (len, record_width);
+        size_t pad_bytes = record_width - write_bytes;
+        fwrite (rec, write_bytes, 1, w->file);
+        while (pad_bytes > 0)
+          {
+            static const char spaces[32] = "                                ";
+            size_t chunk = MIN (pad_bytes, sizeof spaces);
+            fwrite (spaces, chunk, 1, w->file);
+            pad_bytes -= chunk;
+          }
+      }
+      break;
+
+    case FH_MODE_VARIABLE:
+      {
+        uint32_t size = len;
+        integer_convert (INTEGER_NATIVE, &size, INTEGER_LSB_FIRST, &size,
+                         sizeof size);
+        fwrite (&size, sizeof size, 1, w->file);
+        fwrite (rec, len, 1, w->file);
+        fwrite (&size, sizeof size, 1, w->file);
+      }
+      break;
+
+    case FH_MODE_360_VARIABLE:
+    case FH_MODE_360_SPANNED:
+      {
+        size_t ofs = 0;
+        if (fh_get_mode (w->fh) == FH_MODE_360_VARIABLE)
+          len = MIN (65527, len);
+        while (ofs < len)
+          {
+            size_t chunk = MIN (65527, len - ofs);
+            uint32_t bdw = (chunk + 8) << 16;
+            int scc = (ofs == 0 && chunk == len ? 0
+                       : ofs == 0 ? 1
+                       : ofs + chunk == len ? 2
+                       : 3);
+            uint32_t rdw = ((chunk + 4) << 16) | (scc << 8);
+
+            integer_convert (INTEGER_NATIVE, &bdw, INTEGER_MSB_FIRST, &bdw,
+                             sizeof bdw);
+            integer_convert (INTEGER_NATIVE, &rdw, INTEGER_MSB_FIRST, &rdw,
+                             sizeof rdw);
+            fwrite (&bdw, 1, sizeof bdw, w->file);
+            fwrite (&rdw, 1, sizeof rdw, w->file);
+            fwrite (rec + ofs, 1, chunk, w->file);
+            ofs += chunk;
+          }
+      }
+      break;
+
+    default:
+      NOT_REACHED ();
     }
 
-  fwrite (rec, len, 1, w->file.file);
   return !dfm_write_error (w);
 }
 
@@ -122,25 +178,30 @@ dfm_close_writer (struct dfm_writer *w)
 
   if (w == NULL)
     return true;
-  if (fh_close (w->fh, "data file", "ws"))
+  if (fh_unlock (w->lock))
     return true;
 
   ok = true;
-  if (w->file.file != NULL)
+  if (w->file != NULL)
     {
-      ok = !dfm_write_error (w);
-      if (!fn_close_ext (&w->file))
-        ok = false;
+      const char *file_name = fh_get_file_name (w->fh);
+      ok = !dfm_write_error (w) && !fn_close (file_name, w->file);
 
       if (!ok)
-        msg (ME, _("I/O error occurred writing data file \"%s\"."),
-             fh_get_filename (w->fh));
+        msg (ME, _("I/O error occurred writing data file \"%s\"."), file_name);
 
-      free (w->file.filename);
-      w->file.filename = NULL;
+      if (ok ? !replace_file_commit (w->rf) : !replace_file_abort (w->rf))
+        ok = false;
     }
-  free (w->bounce);
+  fh_unref (w->fh);
   free (w);
 
   return ok;
 }
+
+/* Returns the legacy character encoding of data written to WRITER. */
+const char *
+dfm_writer_get_legacy_encoding (const struct dfm_writer *writer)
+{
+  return fh_get_legacy_encoding (writer->fh);
+}