fbuf: New data structure for buffered file I/O.
[pspp] / src / data / file-name.c
index 1b31048e211b75dd301fc87d5c928cfe0bc764f6..edbabd5ed8f871a67374490109a48176f608409d 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2006, 2007, 2009, 2010, 2011 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,6 +17,7 @@
 #include <config.h>
 
 #include "data/file-name.h"
+#include "data/file-handle-def.h"
 
 #include <ctype.h>
 #include <errno.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <sys/stat.h>
+
 #include <unistd.h>
 
 #include "data/settings.h"
 #include "libpspp/hash-functions.h"
 #include "libpspp/message.h"
+#include "libpspp/i18n.h"
 #include "libpspp/str.h"
 #include "libpspp/version.h"
 
 #include "gl/dirname.h"
+#include "gl/dosname.h"
 #include "gl/intprops.h"
 #include "gl/minmax.h"
 #include "gl/relocatable.h"
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
-#if defined _WIN32 || defined __WIN32__
-#define WIN32_LEAN_AND_MEAN  /* avoid including junk */
-#include <windows.h>
-#endif
 \f
 /* Functions for performing operations on file names. */
 
-/* Searches for a configuration file with name NAME in the directories given in
+
+/* Returns the extension part of FILE_NAME as a malloc()'d string.
+   If FILE_NAME does not have an extension, returns an empty
+   string. */
+char *
+fn_extension (const struct file_handle *fh)
+{
+  const char *file_name = fh_get_file_name (fh);
+
+  const char *extension = strrchr (file_name, '.');
+  if (extension == NULL)
+    extension = "";
+  return xstrdup (extension);
+}
+\f
+/* Find out information about files. */
+
+/* Returns true iff NAME specifies an absolute file name. */
+static bool
+fn_is_absolute (const char *name)
+{
+  return IS_ABSOLUTE_FILE_NAME (name);
+}
+
+
+/* Searches for a file with name NAME in the directories given in
    PATH, which is terminated by a null pointer.  Returns the full name of the
    first file found, which the caller is responsible for freeing with free(),
    or NULL if none is found. */
@@ -73,89 +98,30 @@ fn_search_path (const char *base_name, char **path)
       else
         file = xasprintf ("%s/%s", dir, base_name);
 
-      if (fn_exists (file))
-        return file;
+      struct stat temp;
+      if (( (stat (file, &temp) == 0 ) && ( ! S_ISDIR (temp.st_mode) )))
+       return file;
+
       free (file);
     }
 
   return NULL;
 }
 
-/* Returns the directory part of FILE_NAME, as a malloc()'d
-   string. */
-char *
-fn_dir_name (const char *file_name)
-{
-  return dir_name (file_name);
-}
 
-/* Returns the extension part of FILE_NAME as a malloc()'d string.
-   If FILE_NAME does not have an extension, returns an empty
-   string. */
-char *
-fn_extension (const char *file_name)
-{
-  const char *extension = strrchr (file_name, '.');
-  if (extension == NULL)
-    extension = "";
-  return xstrdup (extension);
-}
-\f
-/* Find out information about files. */
-
-/* Returns true iff NAME specifies an absolute file name. */
-bool
-fn_is_absolute (const char *name)
-{
-  return IS_ABSOLUTE_FILE_NAME (name);
-}
-
-/* Returns true if FILE_NAME is a virtual file that doesn't
-   really exist on disk, false if it's a real file name. */
+/* Returns true if file with name NAME exists, and that file is not a
+   directory */
 bool
-fn_is_special (const char *file_name)
-{
-  if (!strcmp (file_name, "-") || !strcmp (file_name, "stdin")
-      || !strcmp (file_name, "stdout") || !strcmp (file_name, "stderr")
-#ifdef HAVE_POPEN
-      || file_name[0] == '|'
-      || (*file_name && file_name[strlen (file_name) - 1] == '|')
-#endif
-      )
-    return true;
-
-  return false;
-}
-
-/* Returns true if file with name NAME exists. */
-bool
-fn_exists (const char *name)
+fn_exists (const struct file_handle *fh)
 {
+  const char *name = fh_get_file_name (fh);
   struct stat temp;
-  return stat (name, &temp) == 0;
-}
-\f
-/* Environment variables. */
+  if ( stat (name, &temp) != 0 )
+    return false;
 
-/* Simulates $VER and $ARCH environment variables. */
-const char *
-fn_getenv (const char *s)
-{
-  if (!strcmp (s, "VER"))
-    return fn_getenv_default ("STAT_VER", bare_version);
-  else if (!strcmp (s, "ARCH"))
-    return fn_getenv_default ("STAT_ARCH", host_system);
-  else
-    return getenv (s);
+  return ! S_ISDIR (temp.st_mode);
 }
 
-/* Returns getenv(KEY) if that's non-NULL; else returns DEF. */
-const char *
-fn_getenv_default (const char *key, const char *def)
-{
-  const char *value = getenv (key);
-  return value ? value : def;
-}
 \f
 /* Basic file handling. */
 
@@ -165,7 +131,7 @@ fn_getenv_default (const char *key, const char *def)
 static FILE *
 safety_violation (const char *fn)
 {
-  msg (SE, _("Not opening pipe file `%s' because SAFER option set."), fn);
+  msg (SE, _("Not opening pipe file `%s' because %s option set."), fn, "SAFER");
   errno = EPERM;
   return NULL;
 }
@@ -176,8 +142,10 @@ safety_violation (const char *fn)
    NULL on failure.  If NULL is returned then errno is set to a
    sensible value.  */
 FILE *
-fn_open (const char *fn, const char *mode)
+fn_fopen (const struct file_handle *fh, const char *mode)
 {
+  const char *fn = fh_get_file_name (fh);
+
   assert (mode[0] == 'r' || mode[0] == 'w' || mode[0] == 'a');
 
   if (mode[0] == 'r')
@@ -221,22 +189,67 @@ fn_open (const char *fn, const char *mode)
     }
   else
 #endif
+
+#if WIN32
     {
-      FILE *f = fopen (fn, mode);
+      wchar_t *ss = convert_to_filename_encoding (fn, strlen (fn), fh_get_file_name_encoding (fh));
+      wchar_t *m =  (wchar_t *) recode_string ("UTF-16LE", "ASCII", mode, strlen (mode));
+      FILE *fp = _wfopen (ss, m);
+      free (m);
+      free (ss);
+      return fp;
+    }
+#else
+    return fopen (fn, mode);
+#endif
+}
 
-      if (f && mode[0] != 'r')
-       setvbuf (f, NULL, _IOLBF, 0);
+/* File open routine that understands `-' as stdin/stdout.  Returns file
+   descriptor on success, otherwise a negative errno value.  */
+int
+fn_open (const struct file_handle *fh, int flags, mode_t mode)
+{
+  const char *fn = fh_get_file_name (fh);
 
-      return f;
+  int orig_fd = -1;
+  if ((flags & O_ACCMODE) == O_RDONLY)
+    {
+      if (!strcmp (fn, "stdin") || !strcmp (fn, "-"))
+        orig_fd = STDIN_FILENO;
+    }
+  else
+    {
+      if (!strcmp (fn, "stdout") || !strcmp (fn, "-"))
+        orig_fd = STDOUT_FILENO;
+      else if (!strcmp (fn, "stderr"))
+        orig_fd = STDERR_FILENO;
+    }
+  if (orig_fd >= 0)
+    {
+      int fd = dup (orig_fd);
+      return fd >= 0 ? fd : -errno;
     }
+
+#if WIN32
+  wchar_t *ss = convert_to_filename_encoding (fn, strlen (fn), fh_get_file_name_encoding (fh));
+  wchar_t *m =  (wchar_t *) recode_string ("UTF-16LE", "ASCII", mode, strlen (mode));
+  int fd = _wopen (fn, flags, mode);
+  free (m);
+  free (ss);
+#else
+  int fd = open (fn, flags, mode);
+#endif
+
+  return fd >= 0 ? fd : -errno;
 }
 
-/* Counterpart to fn_open that closes file F with name FN; returns 0
+/* Counterpart to fn_fopen that closes file F with name FN; returns 0
    on success, EOF on failure.  If EOF is returned, errno is set to a
    sensible value. */
 int
-fn_close (const char *fn, FILE *f)
+fn_close (const struct file_handle *fh, FILE *f)
 {
+  const char *fn = fh_get_file_name (fh);
   if (fileno (f) == STDIN_FILENO
       || fileno (f) == STDOUT_FILENO
       || fileno (f) == STDERR_FILENO)
@@ -252,133 +265,6 @@ fn_close (const char *fn, FILE *f)
     return fclose (f);
 }
 
-/* Creates a new file named FN with the given PERMISSIONS bits,
-   and returns a stream for it or a null pointer on failure.
-   MODE should be "w" or "wb". */
-FILE *
-create_stream (const char *fn, const char *mode, mode_t permissions)
-{
-  int fd;
-  FILE *stream;
-
-  fd = open (fn, O_WRONLY | O_CREAT | O_TRUNC, permissions);
-  if (fd < 0)
-    return NULL;
-
-  stream = fdopen (fd, mode);
-  if (stream == NULL)
-    {
-      int save_errno = errno;
-      close (fd);
-      errno = save_errno;
-    }
-
-  return stream;
-}
-
-/* A file's identity:
-
-   - For a file that exists, this is its device and inode.
-
-   - For a file that does not exist, but which has a directory
-     name that exists, this is the device and inode of the
-     directory, plus the file's base name.
-
-   - For a file that does not exist and has a nonexistent
-     directory, this is the file name.
-
-   Windows doesn't have inode numbers, so we just use the name
-   there. */
-struct file_identity
-{
-  dev_t device;               /* Device number. */
-  ino_t inode;                /* Inode number. */
-  char *name;                 /* File name, where needed, otherwise NULL. */
-};
-
-/* Returns a pointer to a dynamically allocated structure whose
-   value can be used to tell whether two files are actually the
-   same file.  Returns a null pointer if no information about the
-   file is available, perhaps because it does not exist.  The
-   caller is responsible for freeing the structure with
-   fn_free_identity() when finished. */
-struct file_identity *
-fn_get_identity (const char *file_name)
-{
-  struct file_identity *identity = xmalloc (sizeof *identity);
-
-#if !(defined _WIN32 || defined __WIN32__)
-  struct stat s;
-  if (lstat (file_name, &s) == 0)
-    {
-      identity->device = s.st_dev;
-      identity->inode = s.st_ino;
-      identity->name = NULL;
-    }
-  else
-    {
-      char *dir = dir_name (file_name);
-      if (last_component (file_name) != NULL && stat (dir, &s) == 0)
-        {
-          identity->device = s.st_dev;
-          identity->inode = s.st_ino;
-          identity->name = base_name (file_name);
-        }
-      else
-        {
-          identity->device = 0;
-          identity->inode = 0;
-          identity->name = xstrdup (file_name);
-        }
-      free (dir);
-    }
-#else /* Windows */
-  char cname[PATH_MAX];
-  int ok = GetFullPathName (file_name, sizeof cname, cname, NULL);
-  identity->device = 0;
-  identity->inode = 0;
-  identity->name = xstrdup (ok ? cname : file_name);
-  str_lowercase (identity->name);
-#endif /* Windows */
-
-  return identity;
-}
-
-/* Frees IDENTITY obtained from fn_get_identity(). */
-void
-fn_free_identity (struct file_identity *identity)
-{
-  if (identity != NULL)
-    {
-      free (identity->name);
-      free (identity);
-    }
-}
-
-/* Compares A and B, returning a strcmp()-type result. */
-int
-fn_compare_file_identities (const struct file_identity *a,
-                            const struct file_identity *b)
-{
-  if (a->device != b->device)
-    return a->device < b->device ? -1 : 1;
-  else if (a->inode != b->inode)
-    return a->inode < b->inode ? -1 : 1;
-  else if (a->name != NULL)
-    return b->name != NULL ? strcmp (a->name, b->name) : 1;
-  else
-    return b->name != NULL ? -1 : 0;
-}
-
-/* Returns a hash value for IDENTITY. */
-unsigned int
-fn_hash_identity (const struct file_identity *identity)
-{
-  unsigned int hash = hash_int (identity->device, identity->inode);
-  if (identity->name != NULL)
-    hash = hash_string (identity->name, hash);
-  return hash;
-}
 
 #ifdef WIN32
 
@@ -393,7 +279,6 @@ default_output_path (void)
     {
       /* Windows NT defines HOMEDRIVE and HOMEPATH.  But give preference
         to HOME, because the user can change HOME.  */
-
       const char *home_dir = getenv ("HOME");
       int i;