2002-07-20 Han-Wen <hanwen@cs.uu.nl>
[bpt/guile.git] / libguile / ioext.c
index bf757c1..931a157 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
  * 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
 
-
 #include <stdio.h>
+#include <errno.h>
+
 #include "libguile/_scm.h"
-#include "libguile/ports.h"
-#include "libguile/read.h"
+#include "libguile/ioext.h"
 #include "libguile/fports.h"
-#include "libguile/unif.h"
-#include "libguile/chars.h"
 #include "libguile/feature.h"
-#include "libguile/root.h"
+#include "libguile/ports.h"
 #include "libguile/strings.h"
-
 #include "libguile/validate.h"
-#include "libguile/ioext.h"
 
 #include <fcntl.h>
 
-#ifdef HAVE_STRING_H
-#include <string.h>
+#ifdef HAVE_IO_H
+#include <io.h>
 #endif
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 \f
 
-SCM_DEFINE (scm_read_string_x_partial, "read-string!/partial", 1, 3, 0,
-           (SCM str, SCM port_or_fdes, SCM start, SCM end),
-           "Read characters from an fport or file descriptor into a\n"
-           "string @var{str}.  This procedure is scsh-compatible\n"
-           "and can efficiently read large strings.  It will:\n\n"
-           "@itemize\n"
-           "@item\n"
-           "attempt to fill the entire string, unless the @var{start}\n"
-           "and/or @var{end} arguments are supplied.  i.e., @var{start}\n"
-           "defaults to 0 and @var{end} defaults to\n"
-           "@code{(string-length str)}\n"
-           "@item\n"
-           "use the current input port if @var{port_or_fdes} is not\n"
-           "supplied.\n" 
-           "@item\n"
-           "read any characters that are currently available,\n"
-           "without waiting for the rest (short reads are possible).\n\n"
-           "@item\n"
-           "wait for as long as it needs to for the first character to\n"
-           "become available, unless the port is in non-blocking mode\n"
-           "@item\n"
-           "return @code{#f} if end-of-file is encountered before reading\n"
-            "any characters, otherwise return the number of characters\n"
-           "read.\n"
-           "@item\n"
-           "return 0 if the port is in non-blocking mode and no characters\n"
-           "are immediately available.\n"
-           "@item\n"
-           "return 0 if the request is for 0 bytes, with no\n"
-           "end-of-file check\n"
-           "@end itemize")
-#define FUNC_NAME s_scm_read_string_x_partial
-{
-  char *dest;
-  long read_len;
-  long chars_read = 0;
-  int fdes;
-
-  {
-    long offset;
-    long last;
-
-    SCM_VALIDATE_SUBSTRING_SPEC_COPY (1, str, dest, 3, start, offset,
-                                     4, end, last);
-    dest += offset;
-    read_len = last - offset;
-  }
-
-  if (SCM_INUMP (port_or_fdes))
-    fdes = SCM_INUM (port_or_fdes);
-  else
-    {
-      SCM port = SCM_UNBNDP (port_or_fdes) ? scm_cur_inp : port_or_fdes;
-
-      SCM_VALIDATE_OPFPORT (2, port);
-      SCM_VALIDATE_INPUT_PORT (2, port);
-
-      /* if there's anything in the port buffers, use it, but then
-        don't touch the file descriptor.  otherwise the
-        "return immediately if something is available" rule may
-        be violated.  */
-      chars_read = scm_take_from_input_buffers (port, dest, read_len);
-      fdes = SCM_FPORT_FDES (port);
-    }
-
-  if (chars_read == 0 && read_len > 0) /* don't confuse read_len == 0 with
-                                         EOF.  */
-    {
-      SCM_SYSCALL (chars_read = read (fdes, dest, read_len));
-      if (chars_read == -1)
-       {
-#if defined (EWOULDBLOCK) || defined (EAGAIN)
-         if (
-#if defined (EWOULDBLOCK)
-             errno == EWOULDBLOCK
-#else
-             errno == EAGAIN
-#endif
-             )
-           chars_read = 0;
-         else
-#endif
-           SCM_SYSERROR;
-        }
-      else if (chars_read == 0)
-       return SCM_BOOL_F;
-    }
-  return scm_long2num (chars_read);
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_read_delimited_x, "%read-delimited!", 3, 3, 0,
-            (SCM delims, SCM str, SCM gobble, SCM port, SCM start, SCM end),
-           "Read characters from @var{port} into @var{str} until one of the\n"
-           "characters in the @var{delims} string is encountered.  If @var{gobble}\n"
-           "is true, discard the delimiter character; otherwise, leave it\n"
-           "in the input stream for the next read.\n"
-           "If @var{port} is not specified, use the value of\n"
-           "@code{(current-input-port)}.  If @var{start} or @var{end} are specified,\n"
-           "store data only into the substring of @var{str} bounded by @var{start}\n"
-           "and @var{end} (which default to the beginning and end of the string,\n"
-           "respectively).\n\n"
-           "Return a pair consisting of the delimiter that terminated the string and\n"
-           "the number of characters read.  If reading stopped at the end of file,\n"
-           "the delimiter returned is the @var{eof-object}; if the string was filled\n"
-           "without encountering a delimiter, this value is @var{#f}.")
-#define FUNC_NAME s_scm_read_delimited_x
-{
-  long j;
-  char *buf;
-  long cstart;
-  long cend;
-  int c;
-  char *cdelims;
-  int num_delims;
-
-  SCM_VALIDATE_STRING_COPY (1, delims, cdelims);
-  num_delims = SCM_STRING_LENGTH (delims);
-  SCM_VALIDATE_SUBSTRING_SPEC_COPY (2, str, buf, 5, start, cstart,
-                                   6, end, cend);
-  if (SCM_UNBNDP (port))
-    port = scm_cur_inp;
-  else
-    SCM_VALIDATE_OPINPORT (4,port);
-
-  for (j = cstart; j < cend; j++)
-    {  
-      int k;
-
-      c = scm_getc (port);
-      for (k = 0; k < num_delims; k++)
-       {
-         if (cdelims[k] == c)
-           {
-             if (SCM_FALSEP (gobble))
-               scm_ungetc (c, port);
-
-             return scm_cons (SCM_MAKE_CHAR (c),
-                              scm_long2num (j - cstart));
-           }
-       }
-      if (c == EOF)
-       return scm_cons (SCM_EOF_VAL, 
-                        scm_long2num (j - cstart));
-
-      buf[j] = c;
-    }
-  return scm_cons (SCM_BOOL_F, scm_long2num (j - cstart));
-}
-#undef FUNC_NAME
-
-static unsigned char *
-scm_do_read_line (SCM port, int *len_p)
-{
-  scm_port *pt = SCM_PTAB_ENTRY (port);
-  unsigned char *end;
-
-  /* I thought reading lines was simple.  Mercy me.  */
-
-  /* The common case: the buffer contains a complete line. 
-     This needs to be fast.  */
-  if ((end = memchr (pt->read_pos, '\n', (pt->read_end - pt->read_pos)))
-          != 0)
-    {
-      int buf_len = (end + 1) - pt->read_pos;
-      /* Allocate a buffer of the perfect size.  */
-      unsigned char *buf = scm_must_malloc (buf_len + 1, "%read-line");
-
-      memcpy (buf, pt->read_pos, buf_len);
-      pt->read_pos += buf_len;
-
-      buf[buf_len] = '\0';
-
-      *len_p = buf_len;
-      return buf;
-    }
-
-  /* The buffer contains no newlines.  */
-  {
-    /* When live, len is always the number of characters in the
-       current buffer that are part of the current line.  */
-    int len = (pt->read_end - pt->read_pos);
-    int buf_size = (len < 50) ? 60 : len * 2;
-    /* Invariant: buf always has buf_size + 1 characters allocated;
-       the `+ 1' is for the final '\0'.  */
-    unsigned char *buf = scm_must_malloc (buf_size + 1, "%read-line");
-    int buf_len = 0;
-
-    for (;;)
-      {
-       if (buf_len + len > buf_size)
-         {
-           int new_size = (buf_len + len) * 2;
-           buf = scm_must_realloc (buf, buf_size + 1, new_size + 1,
-                                   "%read-line");
-           buf_size = new_size;
-         }
-
-       /* Copy what we've got out of the port, into our buffer.  */
-       memcpy (buf + buf_len, pt->read_pos, len);
-       buf_len += len;
-       pt->read_pos += len;
-
-       /* If we had seen a newline, we're done now.  */
-       if (end)
-         break;
-
-       /* Get more characters.  */
-       if (scm_fill_input (port) == EOF)
-         {
-           /* If we're missing a final newline in the file, return
-              what we did get, sans newline.  */
-           if (buf_len > 0)
-             break;
-
-           free (buf);
-           return 0;
-         }
-
-       /* Search the buffer for newlines.  */
-       if ((end = memchr (pt->read_pos, '\n',
-                          (len = (pt->read_end - pt->read_pos))))
-           != 0)
-         len = (end - pt->read_pos) + 1;
-      }
-
-    /* I wonder how expensive this realloc is.  */
-    buf = scm_must_realloc (buf, buf_size + 1, buf_len + 1, "%read-line");
-    buf[buf_len] = '\0';
-    *len_p = buf_len;
-    return buf;
-  }
-}  
-
-
-/*
- * %read-line 
- * truncates any terminating newline from its input, and returns
- * a cons of the string read and its terminating character.  Doing
- * so makes it easy to implement the hairy `read-line' options
- * efficiently in Scheme.
- */
-
-SCM_DEFINE (scm_read_line, "%read-line", 0, 1, 0, 
-            (SCM port),
-           "Read a newline-terminated line from @var{port}, allocating storage as\n"
-           "necessary.  The newline terminator (if any) is removed from the string,\n"
-           "and a pair consisting of the line and its delimiter is returned.  The\n"
-           "delimiter may be either a newline or the @var{eof-object}; if\n"
-           "@code{%read-line} is called at the end of file, it returns the pair\n"
-           "@code{(#<eof> . #<eof>)}.")
-#define FUNC_NAME s_scm_read_line
-{
-  scm_port *pt;
-  char *s;
-  int slen;
-  SCM line, term;
-
-  if (SCM_UNBNDP (port))
-    port = scm_cur_inp;
-  SCM_VALIDATE_OPINPORT (1,port);
-
-  pt = SCM_PTAB_ENTRY (port);
-  if (pt->rw_active == SCM_PORT_WRITE)
-    scm_ptobs[SCM_PTOBNUM (port)].flush (port);
-
-  s = (char *) scm_do_read_line (port, &slen);
-
-  if (s == NULL)
-    term = line = SCM_EOF_VAL;
-  else
-    {
-      if (s[slen-1] == '\n')
-       {
-         term = SCM_MAKE_CHAR ('\n');
-         s[slen-1] = '\0';
-         line = scm_take_str (s, slen-1);
-         scm_done_malloc (-1);
-         SCM_INCLINE (port);
-       }
-      else
-       {
-         /* Fix: we should check for eof on the port before assuming this. */
-         term = SCM_EOF_VAL;
-         line = scm_take_str (s, slen);
-         SCM_COL (port) += slen;
-       }         
-    }
-
-  if (pt->rw_random)
-    pt->rw_active = SCM_PORT_READ;
-
-  return scm_cons (line, term);
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_write_line, "write-line", 1, 1, 0,
-            (SCM obj, SCM port),
-           "Display @var{obj} and a newline character to @var{port}.  If @var{port}\n"
-           "is not specified, @code{(current-output-port)} is used.  This function\n"
-           "is equivalent to:\n\n"
-           "@smalllisp\n"
-           "(display obj [port])\n"
-           "(newline [port])\n"
-           "@end smalllisp")
-#define FUNC_NAME s_scm_write_line
-{
-  scm_display (obj, port);
-  return scm_newline (port);
-}
-#undef FUNC_NAME
-
 SCM_DEFINE (scm_ftell, "ftell", 1, 0, 0, 
-            (SCM object),
-           "Returns an integer representing the current position of @var{fd/port},\n"
-           "measured from the beginning.  Equivalent to:\n"
-           "@smalllisp\n"
+            (SCM fd_port),
+           "Return an integer representing the current position of\n"
+           "@var{fd/port}, measured from the beginning.  Equivalent to:\n"
+           "\n"
+           "@lisp\n"
            "(seek port 0 SEEK_CUR)\n"
-           "@end smalllisp")
+           "@end lisp")
 #define FUNC_NAME s_scm_ftell
 {
-  return scm_seek (object, SCM_INUM0, SCM_MAKINUM (SEEK_CUR));
-}
-#undef FUNC_NAME
-
-
-#if (SCM_DEBUG_DEPRECATED == 0)
-
-SCM_DEFINE (scm_fseek, "fseek", 3, 0, 0,
-            (SCM object, SCM offset, SCM whence),
-           "Obsolete.  Almost the same as seek, above, but the return value is\n"
-           "unspecified.")
-#define FUNC_NAME s_scm_fseek
-{
-  scm_seek (object, offset, whence);
-  return SCM_UNSPECIFIED;
+  return scm_seek (fd_port, SCM_INUM0, SCM_MAKINUM (SEEK_CUR));
 }
 #undef FUNC_NAME
 
-#endif  /* SCM_DEBUG_DEPRECATED == 0 */
-
-
 SCM_DEFINE (scm_redirect_port, "redirect-port", 2, 0, 0,
             (SCM old, SCM new),
            "This procedure takes two ports and duplicates the underlying file\n"
@@ -426,21 +92,21 @@ SCM_DEFINE (scm_redirect_port, "redirect-port", 2, 0, 0,
 #define FUNC_NAME s_scm_redirect_port
 {
   int ans, oldfd, newfd;
-  struct scm_fport *fp;
+  scm_t_fport *fp;
 
   old = SCM_COERCE_OUTPORT (old);
   new = SCM_COERCE_OUTPORT (new);
   
-  SCM_VALIDATE_OPFPORT (1,old);
-  SCM_VALIDATE_OPFPORT (2,new);
+  SCM_VALIDATE_OPFPORT (1, old);
+  SCM_VALIDATE_OPFPORT (2, new);
   oldfd = SCM_FPORT_FDES (old);
   fp = SCM_FSTREAM (new);
   newfd = fp->fdes;
   if (oldfd != newfd)
     {
-      scm_port *pt = SCM_PTAB_ENTRY (new);
-      scm_port *old_pt = SCM_PTAB_ENTRY (old);
-      scm_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (new)];
+      scm_t_port *pt = SCM_PTAB_ENTRY (new);
+      scm_t_port *old_pt = SCM_PTAB_ENTRY (old);
+      scm_t_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (new)];
 
       /* must flush to old fdes.  */
       if (pt->rw_active == SCM_PORT_WRITE)
@@ -459,7 +125,9 @@ SCM_DEFINE (scm_redirect_port, "redirect-port", 2, 0, 0,
 
 SCM_DEFINE (scm_dup_to_fdes, "dup->fdes", 1, 1, 0, 
             (SCM fd_or_port, SCM fd),
-           "Returns an integer file descriptor.")
+           "Return a new integer file descriptor referring to the open file\n"
+           "designated by @var{fd_or_port}, which must be either an open\n"
+           "file port or a file descriptor.")
 #define FUNC_NAME s_scm_dup_to_fdes
 {
   int oldfd, newfd, rv;
@@ -470,7 +138,7 @@ SCM_DEFINE (scm_dup_to_fdes, "dup->fdes", 1, 1, 0,
     oldfd = SCM_INUM (fd_or_port);
   else
     {
-      SCM_VALIDATE_OPFPORT (1,fd_or_port);
+      SCM_VALIDATE_OPFPORT (1, fd_or_port);
       oldfd = SCM_FPORT_FDES (fd_or_port);
     }
 
@@ -524,12 +192,12 @@ SCM_DEFINE (scm_dup2, "dup2", 2, 0, 0,
 
 SCM_DEFINE (scm_fileno, "fileno", 1, 0, 0, 
             (SCM port),
-           "Returns the integer file descriptor underlying @var{port}.\n"
-           "Does not change its revealed count.")
+           "Return the integer file descriptor underlying @var{port}.  Does\n"
+           "not change its revealed count.")
 #define FUNC_NAME s_scm_fileno
 {
   port = SCM_COERCE_OUTPORT (port);
-  SCM_VALIDATE_OPFPORT (1,port);
+  SCM_VALIDATE_OPFPORT (1, port);
   return SCM_MAKINUM (SCM_FPORT_FDES (port));
 }
 #undef FUNC_NAME
@@ -537,11 +205,15 @@ SCM_DEFINE (scm_fileno, "fileno", 1, 0, 0,
 /* GJB:FIXME:: why does this not throw
    an error if the arg is not a port?
    This proc as is would be better names isattyport?
-   if it is not going to assume that the arg is a port */
+   if it is not going to assume that the arg is a port
+
+   [cmm] I don't see any problem with the above.  why should a type
+   predicate assume _anything_ about its argument?
+*/
 SCM_DEFINE (scm_isatty_p, "isatty?", 1, 0, 0, 
             (SCM port),
-           "Returns @code{#t} if @var{port} is using a serial\n"
-           "non-file device, otherwise @code{#f}.")
+           "Return @code{#t} if @var{port} is using a serial non--file\n"
+           "device, otherwise @code{#f}.")
 #define FUNC_NAME s_scm_isatty_p
 {
   int rv;
@@ -560,15 +232,14 @@ SCM_DEFINE (scm_isatty_p, "isatty?", 1, 0, 0,
 
 SCM_DEFINE (scm_fdopen, "fdopen", 2, 0, 0,
             (SCM fdes, SCM modes),
-           "Returns a new port based on the file descriptor @var{fdes}.\n"
-           "Modes are given by the string @var{modes}.  The revealed count of the port\n"
-           "is initialized to zero.  The modes string is the same as that accepted\n"
-           "by @ref{File Ports, open-file}.")
+           "Return a new port based on the file descriptor @var{fdes}.\n"
+           "Modes are given by the string @var{modes}.  The revealed count\n"
+           "of the port is initialized to zero.  The modes string is the\n"
+           "same as that accepted by @ref{File Ports, open-file}.")
 #define FUNC_NAME s_scm_fdopen
 {
-  SCM_VALIDATE_INUM (1,fdes);
+  SCM_VALIDATE_INUM (1, fdes);
   SCM_VALIDATE_STRING (2, modes);
-  SCM_STRING_COERCE_0TERMINATION_X (modes);
 
   return scm_fdes_to_port (SCM_INUM (fdes), SCM_STRING_CHARS (modes), SCM_BOOL_F);
 }
@@ -591,15 +262,15 @@ SCM_DEFINE (scm_primitive_move_to_fdes, "primitive-move->fdes", 2, 0, 0,
            "required value or @code{#t} if it was moved.")
 #define FUNC_NAME s_scm_primitive_move_to_fdes
 {
-  struct scm_fport *stream;
+  scm_t_fport *stream;
   int old_fd;
   int new_fd;
   int rv;
 
   port = SCM_COERCE_OUTPORT (port);
 
-  SCM_VALIDATE_OPFPORT (1,port);
-  SCM_VALIDATE_INUM (2,fd);
+  SCM_VALIDATE_OPFPORT (1, port);
+  SCM_VALIDATE_INUM (2, fd);
   stream = SCM_FSTREAM (port);
   old_fd = stream->fdes;
   new_fd = SCM_INUM (fd);
@@ -620,20 +291,21 @@ SCM_DEFINE (scm_primitive_move_to_fdes, "primitive-move->fdes", 2, 0, 0,
 /* Return a list of ports using a given file descriptor.  */
 SCM_DEFINE (scm_fdes_to_ports, "fdes->ports", 1, 0, 0, 
            (SCM fd),
-           "Returns a list of existing ports which have @var{fdes} as an\n"
-           "underlying file descriptor, without changing their revealed counts.")
+           "Return a list of existing ports which have @var{fdes} as an\n"
+           "underlying file descriptor, without changing their revealed\n"
+           "counts.")
 #define FUNC_NAME s_scm_fdes_to_ports
 {
   SCM result = SCM_EOL;
   int int_fd;
-  int i;
+  long i;
   
-  SCM_VALIDATE_INUM_COPY (1,fd,int_fd);
+  SCM_VALIDATE_INUM_COPY (1, fd, int_fd);
 
   for (i = 0; i < scm_port_table_size; i++)
     {
       if (SCM_OPFPORTP (scm_port_table[i]->port)
-         && ((struct scm_fport *) scm_port_table[i]->stream)->fdes == int_fd)
+         && ((scm_t_fport *) scm_port_table[i]->stream)->fdes == int_fd)
        result = scm_cons (scm_port_table[i]->port, result);
     }
   return result;
@@ -646,9 +318,7 @@ scm_init_ioext ()
 {
   scm_add_feature ("i/o-extensions");
 
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/ioext.x"
-#endif
 }