2001-11-04 Stefan Jahn <stefan@lkcc.org>
[bpt/guile.git] / libguile / fports.c
index f8a7170..426db6f 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1997,1998,1999, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 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
@@ -39,8 +39,6 @@
  * whether to permit this exception to apply to your modifications.
  * If you do not wish that, delete this exception notice.  */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
 
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #else
-scm_sizet fwrite ();
+size_t fwrite ();
 #endif
-#ifdef HAVE_ST_BLKSIZE
+#ifdef HAVE_IO_H
+#include <io.h>
+#endif
+#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
 #include <sys/stat.h>
 #endif
 
 #include <errno.h>
 
 #include "libguile/iselect.h"
+/* Some defines for Windows. */
+#ifdef __MINGW32__
+# include <sys/stat.h>
+# include <winsock2.h>
+# define ftruncate(fd, size) chsize (fd, size)
+#endif /* __MINGW32__ */
+
+
+scm_t_bits scm_tc16_fport;
+
 
 /* default buffer size, used if the O/S won't supply a value.  */
-static const int default_buffer_size = 1024;
+static const size_t default_buffer_size = 1024;
 
 /* create FPORT buffer with specified sizes (or -1 to use default size or
    0 for no buffer.  */
 static void
-scm_fport_buffer_add (SCM port, int read_size, int write_size)
+scm_fport_buffer_add (SCM port, long read_size, int write_size)
+#define FUNC_NAME "scm_fport_buffer_add"
 {
-  struct scm_fport *fp = SCM_FSTREAM (port);
-  scm_port *pt = SCM_PTAB_ENTRY (port);
-  char *s_scm_fport_buffer_add = "scm_fport_buffer_add";
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
 
   if (read_size == -1 || write_size == -1)
     {
-      int default_size;
-#ifdef HAVE_ST_BLKSIZE
+      size_t default_size;
+#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
       struct stat st;
+      scm_t_fport *fp = SCM_FSTREAM (port);
       
       default_size = (fstat (fp->fdes, &st) == -1) ? default_buffer_size
        : st.st_blksize;
@@ -100,9 +111,7 @@ scm_fport_buffer_add (SCM port, int read_size, int write_size)
 
   if (SCM_INPUT_PORT_P (port) && read_size > 0)
     {
-      pt->read_buf = malloc (read_size);
-      if (pt->read_buf == NULL)
-       scm_memory_error (s_scm_fport_buffer_add);
+      pt->read_buf = scm_must_malloc (read_size, FUNC_NAME);
       pt->read_pos = pt->read_end = pt->read_buf;
       pt->read_buf_size = read_size;
     }
@@ -114,9 +123,7 @@ scm_fport_buffer_add (SCM port, int read_size, int write_size)
 
   if (SCM_OUTPUT_PORT_P (port) && write_size > 0)
     {
-      pt->write_buf = malloc (write_size);
-      if (pt->write_buf == NULL)
-       scm_memory_error (s_scm_fport_buffer_add);
+      pt->write_buf = scm_must_malloc (write_size, FUNC_NAME);
       pt->write_pos = pt->write_buf;
       pt->write_buf_size = write_size;
     }
@@ -132,6 +139,7 @@ scm_fport_buffer_add (SCM port, int read_size, int write_size)
   else
     SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) | SCM_BUF0);
 }
+#undef FUNC_NAME
 
 SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0, 
             (SCM port, SCM mode, SCM size),
@@ -147,8 +155,9 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
            "@end table")
 #define FUNC_NAME s_scm_setvbuf
 {
-  int cmode, csize;
-  scm_port *pt;
+  int cmode;
+  long csize;
+  scm_t_port *pt;
 
   port = SCM_COERCE_OUTPORT (port);
 
@@ -185,9 +194,9 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
 
   /* silently discards buffered chars.  */
   if (pt->read_buf != &pt->shortbuf)
-    free (pt->read_buf);
+    scm_must_free (pt->read_buf);
   if (pt->write_buf != &pt->shortbuf)
-    free (pt->write_buf);
+    scm_must_free (pt->write_buf);
 
   scm_fport_buffer_add (port, csize, csize);
   return SCM_UNSPECIFIED;
@@ -201,7 +210,7 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
 void
 scm_evict_ports (int fd)
 {
-  int i;
+  long i;
 
   for (i = 0; i < scm_port_table_size; i++)
     {
@@ -209,7 +218,7 @@ scm_evict_ports (int fd)
 
       if (SCM_FPORTP (port))
        {
-         struct scm_fport *fp = SCM_FSTREAM (port);
+         scm_t_fport *fp = SCM_FSTREAM (port);
 
          if (fp->fdes == fd)
            {
@@ -222,6 +231,17 @@ scm_evict_ports (int fd)
     }
 }
 
+
+SCM_DEFINE (scm_file_port_p, "file-port?", 1, 0, 0,
+           (SCM obj),
+           "Determine whether @var{obj} is a port that is related to a file.")
+#define FUNC_NAME s_scm_file_port_p
+{
+  return SCM_BOOL (SCM_FPORTP (obj));
+}
+#undef FUNC_NAME
+
+
 /* scm_open_file
  * Return a new port open on a given file.
  *
@@ -231,12 +251,12 @@ scm_evict_ports (int fd)
  * Return the new port.
  */
 SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
-           (SCM filename, SCM modes),
-           "Open the file whose name is @var{string}, and return a port\n"
+           (SCM filename, SCM mode),
+           "Open the file whose name is @var{filename}, and return a port\n"
            "representing that file.  The attributes of the port are\n"
-           "determined by the @var{mode} string.  The way in \n"
-           "which this is interpreted is similar to C stdio:\n\n"
-           "The first character must be one of the following:\n\n"
+           "determined by the @var{mode} string.  The way in which this is\n"
+           "interpreted is similar to C stdio.  The first character must be\n"
+           "one of the following:\n"
            "@table @samp\n"
            "@item r\n"
            "Open an existing file for input.\n"
@@ -244,48 +264,47 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
            "Open a file for output, creating it if it doesn't already exist\n"
            "or removing its contents if it does.\n"
            "@item a\n"
-           "Open a file for output, creating it if it doesn't already exist.\n"
-           "All writes to the port will go to the end of the file.\n"
+           "Open a file for output, creating it if it doesn't already\n"
+           "exist.  All writes to the port will go to the end of the file.\n"
            "The \"append mode\" can be turned off while the port is in use\n"
            "@pxref{Ports and File Descriptors, fcntl}\n"
-           "@end table\n\n"
-           "The following additional characters can be appended:\n\n"
+           "@end table\n"
+           "The following additional characters can be appended:\n"
            "@table @samp\n"
            "@item +\n"
            "Open the port for both input and output.  E.g., @code{r+}: open\n"
            "an existing file for both input and output.\n"
            "@item 0\n"
-           "Create an \"unbuffered\" port.  In this case input and output operations\n"
-           "are passed directly to the underlying port implementation without\n"
-           "additional buffering.  This is likely to slow down I/O operations.\n"
-           "The buffering mode can be changed while a port is in use\n"
-           "@pxref{Ports and File Descriptors, setvbuf}\n"
+           "Create an \"unbuffered\" port.  In this case input and output\n"
+           "operations are passed directly to the underlying port\n"
+           "implementation without additional buffering.  This is likely to\n"
+           "slow down I/O operations.  The buffering mode can be changed\n"
+           "while a port is in use @pxref{Ports and File Descriptors,\n"
+           "setvbuf}\n"
            "@item l\n"
            "Add line-buffering to the port.  The port output buffer will be\n"
            "automatically flushed whenever a newline character is written.\n"
-           "@end table\n\n"
-           "In theory we could create read/write ports which were buffered in one\n"
-           "direction only.  However this isn't included in the current interfaces.\n\n"
-           "If a file cannot be opened with the access requested,\n"
-           "@code{open-file} throws an exception.")
+           "@end table\n"
+           "In theory we could create read/write ports which were buffered\n"
+           "in one direction only.  However this isn't included in the\n"
+           "current interfaces.  If a file cannot be opened with the access\n"
+           "requested, @code{open-file} throws an exception.")
 #define FUNC_NAME s_scm_open_file
 {
   SCM port;
   int fdes;
   int flags = 0;
   char *file;
-  char *mode;
+  char *md;
   char *ptr;
 
   SCM_VALIDATE_STRING (1, filename);
-  SCM_VALIDATE_STRING (2, modes);
-  SCM_STRING_COERCE_0TERMINATION_X (filename);
-  SCM_STRING_COERCE_0TERMINATION_X (modes);
+  SCM_VALIDATE_STRING (2, mode);
 
   file = SCM_STRING_CHARS (filename);
-  mode = SCM_STRING_CHARS (modes);
+  md = SCM_STRING_CHARS (mode);
 
-  switch (*mode)
+  switch (*md)
     {
     case 'r':
       flags |= O_RDONLY;
@@ -297,9 +316,9 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
       flags |= O_WRONLY | O_CREAT | O_APPEND;
       break;
     default:
-      scm_out_of_range (FUNC_NAME, modes);
+      scm_out_of_range (FUNC_NAME, mode);
     }
-  ptr = mode + 1;
+  ptr = md + 1;
   while (*ptr != '\0')
     {
       switch (*ptr)
@@ -316,7 +335,7 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
        case 'l':  /* line buffered: handled during output.  */
          break;
        default:
-         scm_out_of_range (FUNC_NAME, modes);
+         scm_out_of_range (FUNC_NAME, mode);
        }
       ptr++;
     }
@@ -329,12 +348,54 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
                        scm_cons (scm_makfrom0str (strerror (en)),
                                  scm_cons (filename, SCM_EOL)), en);
     }
-  port = scm_fdes_to_port (fdes, mode, filename);
+  port = scm_fdes_to_port (fdes, md, filename);
   return port;
 }
 #undef FUNC_NAME
 
 \f
+#ifdef __MINGW32__
+/*
+ * Try getting the appropiate file flags for a given file descriptor
+ * under Windows. This incorporates some fancy operations because Windows
+ * differentiates between file, pipe and socket descriptors.
+ */
+#ifndef O_ACCMODE
+# define O_ACCMODE 0x0003
+#endif
+
+static int getflags (int fdes)
+{
+  int flags = 0;
+  struct stat buf;
+  int error, optlen = sizeof (int);
+
+  /* Is this a socket ? */
+  if (getsockopt (fdes, SOL_SOCKET, SO_ERROR, (void *) &error, &optlen) >= 0)
+    flags = O_RDWR;
+  /* Maybe a regular file ? */
+  else if (fstat (fdes, &buf) < 0)
+    flags = -1;
+  else
+    {
+      /* Or an anonymous pipe handle ? */
+      if (buf.st_mode & _S_IFIFO)
+       flags = PeekNamedPipe ((HANDLE) _get_osfhandle (fdes), NULL, 0, 
+                              NULL, NULL, NULL) ? O_RDONLY : O_WRONLY;
+      /* stdin ? */
+      else if (fdes == fileno (stdin) && isatty (fdes))
+       flags = O_RDONLY;
+      /* stdout / stderr ? */
+      else if ((fdes == fileno (stdout) || fdes == fileno (stderr)) && 
+              isatty (fdes))
+       flags = O_WRONLY;
+      else
+       flags = buf.st_mode;
+    }
+  return flags;
+}
+#endif /* __MINGW32__ */
+
 /* Building Guile ports from a file descriptor.  */
 
 /* Build a Scheme port from an open file descriptor `fdes'.
@@ -348,11 +409,15 @@ scm_fdes_to_port (int fdes, char *mode, SCM name)
 {
   long mode_bits = scm_mode_bits (mode);
   SCM port;
-  scm_port *pt;
+  scm_t_port *pt;
   int flags;
 
   /* test that fdes is valid.  */
+#ifdef __MINGW32__
+  flags = getflags (fdes);
+#else
   flags = fcntl (fdes, F_GETFL, 0);
+#endif
   if (flags == -1)
     SCM_SYSERROR;
   flags &= O_ACCMODE;
@@ -370,10 +435,10 @@ scm_fdes_to_port (int fdes, char *mode, SCM name)
   SCM_SET_CELL_TYPE (port, (scm_tc16_fport | mode_bits));
 
   {
-    struct scm_fport *fp
-      = (struct scm_fport *) malloc (sizeof (struct scm_fport));
-    if (fp == NULL)
-      SCM_MEMORY_ERROR;
+    scm_t_fport *fp
+      = (scm_t_fport *) scm_must_malloc (sizeof (scm_t_fport),
+                                             FUNC_NAME);
+
     fp->fdes = fdes;
     pt->rw_random = SCM_FDES_RANDOM_P (fdes);
     SCM_SETSTREAM (port, fp);
@@ -427,7 +492,7 @@ fport_input_waiting (SCM port)
 
 \f
 static int 
-fport_print (SCM exp, SCM port, scm_print_state *pstate)
+fport_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
 {
   scm_puts ("#<", port);
   scm_print_port_mode (exp, port);    
@@ -442,16 +507,18 @@ fport_print (SCM exp, SCM port, scm_print_state *pstate)
       scm_putc (' ', port);
       fdes = (SCM_FSTREAM (exp))->fdes;
       
+#ifdef HAVE_TTYNAME
       if (isatty (fdes))
        scm_puts (ttyname (fdes), port);
       else
+#endif /* HAVE_TTYNAME */
        scm_intprint (fdes, 10, port);
     }
   else
     {
       scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
       scm_putc (' ', port);
-      scm_intprint (SCM_UNPACK (SCM_CDR (exp)), 16, port);
+      scm_intprint ((scm_t_bits) SCM_PTAB_ENTRY (exp), 16, port);
     }
   scm_putc ('>', port);
   return 1;
@@ -486,15 +553,14 @@ fport_wait_for_input (SCM port)
 
 static void fport_flush (SCM port);
 
-/* fill a port's read-buffer with a single read.
-   returns the first char and moves the read_pos pointer past it.
-   or returns EOF if end of file.  */
+/* fill a port's read-buffer with a single read.  returns the first
+   char or EOF if end of file.  */
 static int
 fport_fill_input (SCM port)
 {
-  int count;
-  scm_port *pt = SCM_PTAB_ENTRY (port);
-  struct scm_fport *fp = SCM_FSTREAM (port);
+  long count;
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_fport *fp = SCM_FSTREAM (port);
 
 #ifdef GUILE_ISELECT
   fport_wait_for_input (port);
@@ -515,8 +581,8 @@ fport_fill_input (SCM port)
 static off_t
 fport_seek (SCM port, off_t offset, int whence)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
-  struct scm_fport *fp = SCM_FSTREAM (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_fport *fp = SCM_FSTREAM (port);
   off_t rv;
   off_t result;
 
@@ -567,47 +633,89 @@ fport_seek (SCM port, off_t offset, int whence)
 static void
 fport_truncate (SCM port, off_t length)
 {
-  struct scm_fport *fp = SCM_FSTREAM (port);
+  scm_t_fport *fp = SCM_FSTREAM (port);
 
   if (ftruncate (fp->fdes, length) == -1)
     scm_syserror ("ftruncate");
 }
 
-static void
-fport_write (SCM port, const void *data, size_t size)
+/* helper for fport_write: try to write data, using multiple system
+   calls if required.  */
+#define FUNC_NAME "write_all"
+static void write_all (SCM port, const void *data, size_t remaining)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  int fdes = SCM_FSTREAM (port)->fdes;
 
-  if (pt->write_buf == &pt->shortbuf)
+  while (remaining > 0)
     {
-      /* "unbuffered" port.  */
-      int fdes = SCM_FSTREAM (port)->fdes;
+      size_t done;
+
+      SCM_SYSCALL (done = write (fdes, data, remaining));
 
-      if (write (fdes, data, size) == -1)
-       scm_syserror ("fport_write");
+      if (done == -1)
+       SCM_SYSERROR;
+      remaining -= done;
+      data = ((const char *) data) + done;
     }
-  else 
+}
+#undef FUNC_NAME
+
+static void
+fport_write (SCM port, const void *data, size_t size)
+{
+  /* this procedure tries to minimize the number of writes/flushes.  */
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
+
+  if (pt->write_buf == &pt->shortbuf
+      || (pt->write_pos == pt->write_buf && size >= pt->write_buf_size))
     {
-      const char *input = (char *) data;
-      size_t remaining = size;
+      /* "unbuffered" port, or
+        port with empty buffer and data won't fit in buffer. */
+      write_all (port, data, size);
+      return;
+    }
 
-      while (remaining > 0)
-       {
-         int space = pt->write_end - pt->write_pos;
-         int write_len = (remaining > space) ? space : remaining;
-
-         memcpy (pt->write_pos, input, write_len);
-         pt->write_pos += write_len;
-         remaining -= write_len;
-         input += write_len;
-         if (write_len == space)
+  {
+    off_t space = pt->write_end - pt->write_pos;
+
+    if (size <= space)
+      {
+       /* data fits in buffer.  */
+       memcpy (pt->write_pos, data, size);
+       pt->write_pos += size;
+       if (pt->write_pos == pt->write_end)
+         {
            fport_flush (port);
+           /* we can skip the line-buffering check if nothing's buffered. */
+           return;
+         }
+      }
+    else
+      {
+       memcpy (pt->write_pos, data, space);
+       pt->write_pos = pt->write_end;
+       fport_flush (port);
+       {
+         const void *ptr = ((const char *) data) + space;
+         size_t remaining = size - space;
+
+         if (size >= pt->write_buf_size)
+           {
+             write_all (port, ptr, remaining);
+             return;
+           }
+         else
+           {
+             memcpy (pt->write_pos, ptr, remaining);
+             pt->write_pos += remaining;
+           }
        }
+      }
 
-      /* handle line buffering.  */
-      if ((SCM_CELL_WORD_0 (port) & SCM_BUFLINE) && memchr (data, '\n', size))
-       fport_flush (port);
-    }
+    /* handle line buffering.  */     
+    if ((SCM_CELL_WORD_0 (port) & SCM_BUFLINE) && memchr (data, '\n', size))
+      fport_flush (port);
+  }
 }
 
 /* becomes 1 when process is exiting: normal exception handling won't
@@ -617,22 +725,22 @@ extern int terminating;
 static void
 fport_flush (SCM port)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
-  struct scm_fport *fp = SCM_FSTREAM (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_fport *fp = SCM_FSTREAM (port);
   unsigned char *ptr = pt->write_buf;
-  int init_size = pt->write_pos - pt->write_buf;
-  int remaining = init_size;
+  long init_size = pt->write_pos - pt->write_buf;
+  long remaining = init_size;
 
   while (remaining > 0)
     {
-      int count;
+      long count;
 
       SCM_SYSCALL (count = write (fp->fdes, ptr, remaining));
       if (count < 0)
        {
          /* error.  assume nothing was written this call, but
             fix up the buffer for any previous successful writes.  */
-         int done = init_size - remaining;
+         long done = init_size - remaining;
              
          if (done > 0)
            {
@@ -675,8 +783,8 @@ fport_flush (SCM port)
 static void
 fport_end_input (SCM port, int offset)
 {
-  struct scm_fport *fp = SCM_FSTREAM (port);
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_fport *fp = SCM_FSTREAM (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
   
   offset += pt->read_end - pt->read_pos;
 
@@ -694,8 +802,8 @@ fport_end_input (SCM port, int offset)
 static int
 fport_close (SCM port)
 {
-  struct scm_fport *fp = SCM_FSTREAM (port);
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_fport *fp = SCM_FSTREAM (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
   int rv;
 
   fport_flush (port);
@@ -712,26 +820,25 @@ fport_close (SCM port)
   if (pt->read_buf == pt->putback_buf)
     pt->read_buf = pt->saved_read_buf;
   if (pt->read_buf != &pt->shortbuf)
-    free (pt->read_buf);
+    scm_must_free (pt->read_buf);
   if (pt->write_buf != &pt->shortbuf)
-    free (pt->write_buf);
-  free ((char *) fp);
+    scm_must_free (pt->write_buf);
+  scm_must_free ((char *) fp);
   return rv;
 }
 
-static scm_sizet
+static size_t
 fport_free (SCM port)
 {
   fport_close (port);
   return 0;
 }
 
-void scm_make_fptob (void); /* Called from ports.c */
-
-void
+static scm_t_bits
 scm_make_fptob ()
 {
-  long tc = scm_make_port_type ("file", fport_fill_input, fport_write);
+  scm_t_bits tc = scm_make_port_type ("file", fport_fill_input, fport_write);
+
   scm_set_port_free            (tc, fport_free);
   scm_set_port_print           (tc, fport_print);
   scm_set_port_flush           (tc, fport_flush);
@@ -740,17 +847,22 @@ scm_make_fptob ()
   scm_set_port_seek            (tc, fport_seek);
   scm_set_port_truncate        (tc, fport_truncate);
   scm_set_port_input_waiting   (tc, fport_input_waiting);
+
+  return tc;
 }
 
 void
 scm_init_fports ()
 {
+  scm_tc16_fport = scm_make_fptob ();
+
+  scm_c_define ("_IOFBF", SCM_MAKINUM (_IOFBF));
+  scm_c_define ("_IOLBF", SCM_MAKINUM (_IOLBF));
+  scm_c_define ("_IONBF", SCM_MAKINUM (_IONBF));
+
 #ifndef SCM_MAGIC_SNARFER
 #include "libguile/fports.x"
 #endif
-  scm_sysintern ("_IOFBF", SCM_MAKINUM (_IOFBF));
-  scm_sysintern ("_IOLBF", SCM_MAKINUM (_IOLBF));
-  scm_sysintern ("_IONBF", SCM_MAKINUM (_IONBF));
 }
 
 /*