* fports.h, fports.c (scm_i_fdes_to_port): New, like
[bpt/guile.git] / libguile / vports.c
index 877da5c..e99d796 100644 (file)
@@ -1,50 +1,29 @@
-/*     Copyright (C) 1995,1996,1998,1999, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2002, 2003 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, 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.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
+ * This library 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
+ * Lesser General Public License for more details.
  *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
+#if HAVE_CONFIG_H
+#  include <config.h>
+#endif
 
 #include <stdio.h>
+#include <errno.h>
+
 #include "libguile/_scm.h"
 #include "libguile/eval.h"
 #include "libguile/chars.h"
  */
 
 
+static scm_t_bits scm_tc16_sfport;
+
+
 static void
 sf_flush (SCM port)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
   SCM stream = SCM_PACK (pt->stream);
 
   if (pt->write_pos > pt->write_buf)
     {
       /* write the byte. */
-      scm_apply (SCM_VELTS (stream)[0], SCM_MAKE_CHAR (*pt->write_buf),
-                scm_listofnull);
+      scm_call_1 (SCM_VELTS (stream)[0], SCM_MAKE_CHAR (*pt->write_buf));
       pt->write_pos = pt->write_buf;
   
       /* flush the output.  */
       {
        SCM f = SCM_VELTS (stream)[2];
 
-       if (!SCM_FALSEP (f))
-         scm_apply (f, SCM_EOL, SCM_EOL);
+       if (scm_is_true (f))
+         scm_call_0 (f);
       }
     }
 }
@@ -95,9 +76,7 @@ sf_write (SCM port, const void *data, size_t size)
 {
   SCM p = SCM_PACK (SCM_STREAM (port));
 
-  scm_apply (SCM_VELTS (p)[1], 
-            scm_cons (scm_makfromstr ((char *) data, size, 0), SCM_EOL),
-            SCM_EOL);
+  scm_call_1 (SCM_VELTS (p)[1], scm_mem2string ((char *) data, size));
 }
 
 /* calling the flush proc (element 2) is in case old code needs it,
@@ -111,12 +90,12 @@ sf_fill_input (SCM port)
   SCM p = SCM_PACK (SCM_STREAM (port));
   SCM ans;
 
-  ans = scm_apply (SCM_VELTS (p)[3], SCM_EOL, SCM_EOL); /* get char.  */
-  if (SCM_FALSEP (ans) || SCM_EOF_OBJECT_P (ans))
+  ans = scm_call_0 (SCM_VELTS (p)[3]); /* get char.  */
+  if (scm_is_false (ans) || SCM_EOF_OBJECT_P (ans))
     return EOF;
   SCM_ASSERT (SCM_CHARP (ans), ans, SCM_ARG1, "sf_fill_input");
   {
-    scm_port *pt = SCM_PTAB_ENTRY (port);    
+    scm_t_port *pt = SCM_PTAB_ENTRY (port);    
 
     *pt->read_buf = SCM_CHAR (ans);
     pt->read_pos = pt->read_buf;
@@ -131,21 +110,38 @@ sf_close (SCM port)
 {
   SCM p = SCM_PACK (SCM_STREAM (port));
   SCM f = SCM_VELTS (p)[4];
-  if (SCM_FALSEP (f))
+  if (scm_is_false (f))
     return 0;
-  f = scm_apply (f, SCM_EOL, SCM_EOL);
+  f = scm_call_0 (f);
   errno = 0;
-  return SCM_FALSEP (f) ? EOF : 0;
+  return scm_is_false (f) ? EOF : 0;
+}
+
+
+static int 
+sf_input_waiting (SCM port)
+{
+  SCM p = SCM_PACK (SCM_STREAM (port));
+  if (SCM_VECTOR_LENGTH (p) >= 6)
+    {
+      SCM f = SCM_VELTS (p)[5];
+      if (scm_is_true (f))
+       return scm_to_int (scm_call_0 (f));
+    }
+  /* Default is such that char-ready? for soft ports returns #t, as it
+     did before this extension was implemented. */
+  return 1;
 }
 
 
 
 SCM_DEFINE (scm_make_soft_port, "make-soft-port", 2, 0, 0,
            (SCM pv, SCM modes),
-           "Returns a port capable of receiving or delivering characters as\n"
+           "Return a port capable of receiving or delivering characters as\n"
            "specified by the @var{modes} string (@pxref{File Ports,\n"
-           "open-file}).  @var{vector} must be a vector of length 6.  Its components\n"
-           "are as follows:\n\n"
+           "open-file}).  @var{pv} must be a vector of length 5 or 6.  Its\n"
+           "components are as follows:\n"
+           "\n"
            "@enumerate 0\n"
            "@item\n"
            "procedure accepting one character for output\n"
@@ -157,15 +153,22 @@ SCM_DEFINE (scm_make_soft_port, "make-soft-port", 2, 0, 0,
            "thunk for getting one character\n"
            "@item\n"
            "thunk for closing port (not by garbage collection)\n"
-           "@end enumerate\n\n"
+           "@item\n"
+           "(if present and not @code{#f}) thunk for computing the number of\n"
+           "characters that can be read from the port without blocking.\n"
+           "@end enumerate\n"
+           "\n"
            "For an output-only port only elements 0, 1, 2, and 4 need be\n"
-           "procedures.  For an input-only port only elements 3 and 4 need be\n"
-           "procedures.  Thunks 2 and 4 can instead be @code{#f} if there is no useful\n"
-           "operation for them to perform.\n\n"
-           "If thunk 3 returns @code{#f} or an @code{eof-object} (@pxref{Input,\n"
-           "eof-object?, ,r4rs, The Revised^4 Report on Scheme}) it indicates that\n"
-           "the port has reached end-of-file.  For example:\n\n"
-           "@example\n"
+           "procedures.  For an input-only port only elements 3 and 4 need\n"
+           "be procedures.  Thunks 2 and 4 can instead be @code{#f} if\n"
+           "there is no useful operation for them to perform.\n"
+           "\n"
+           "If thunk 3 returns @code{#f} or an @code{eof-object}\n"
+           "(@pxref{Input, eof-object?, ,r5rs, The Revised^5 Report on\n"
+           "Scheme}) it indicates that the port has reached end-of-file.\n"
+           "For example:\n"
+           "\n"
+           "@lisp\n"
            "(define stdout (current-output-port))\n"
            "(define p (make-soft-port\n"
            "           (vector\n"
@@ -174,43 +177,52 @@ SCM_DEFINE (scm_make_soft_port, "make-soft-port", 2, 0, 0,
            "            (lambda () (display \".\" stdout))\n"
            "            (lambda () (char-upcase (read-char)))\n"
            "            (lambda () (display \"@@\" stdout)))\n"
-           "           \"rw\"))\n\n"
+           "           \"rw\"))\n"
+           "\n"
            "(write p p) @result{} #<input-output: soft 8081e20>\n"
-           "@end example")
+           "@end lisp")
 #define FUNC_NAME s_scm_make_soft_port
 {
-  scm_port *pt;
+  int vlen;
+  scm_t_port *pt;
   SCM z;
-  SCM_VALIDATE_VECTOR_LEN (1,pv,5);
+
+  SCM_VALIDATE_VECTOR (1, pv);
+  vlen = SCM_VECTOR_LENGTH (pv);
+  SCM_ASSERT ((vlen == 5) || (vlen == 6), pv, 1, FUNC_NAME);
   SCM_VALIDATE_STRING (2, modes);
-  SCM_STRING_COERCE_0TERMINATION_X (modes);
-  SCM_NEWCELL (z);
-  SCM_DEFER_INTS;
-  pt = scm_add_to_port_table (z);
+  
+  scm_mutex_lock (&scm_i_port_table_mutex);
+  z = scm_new_port_table_entry (scm_tc16_sfport);
+  pt = SCM_PTAB_ENTRY (z);
   scm_port_non_buffer (pt);
-  SCM_SET_CELL_TYPE (z, scm_tc16_sfport | scm_mode_bits (SCM_STRING_CHARS (modes)));
-  SCM_SETPTAB_ENTRY (z, pt);
+  SCM_SET_CELL_TYPE (z, scm_tc16_sfport | scm_i_mode_bits (modes));
+
   SCM_SETSTREAM (z, SCM_UNPACK (pv));
-  SCM_ALLOW_INTS;
+  scm_mutex_unlock (&scm_i_port_table_mutex);
   return z;
 }
 #undef FUNC_NAME
 
 
-void scm_make_sfptob (void); /* Called from ports.c */
-
-void
+static scm_t_bits
 scm_make_sfptob ()
 {
-  long tc = scm_make_port_type ("soft", sf_fill_input, sf_write);
+  scm_t_bits tc = scm_make_port_type ("soft", sf_fill_input, sf_write);
+
   scm_set_port_mark (tc, scm_markstream);
   scm_set_port_flush (tc, sf_flush);
   scm_set_port_close (tc, sf_close);
+  scm_set_port_input_waiting (tc, sf_input_waiting);
+
+  return tc;
 }
 
 void
 scm_init_vports ()
 {
+  scm_tc16_sfport = scm_make_sfptob ();
+
 #include "libguile/vports.x"
 }