* Deprecated scm_makfromstr and added scm_mem2string as a replacement.
[bpt/guile.git] / libguile / vports.c
index b3e3c6a..33ae235 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1998 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,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
  * 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.  */
+
+/* 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 "_scm.h"
-#include "eval.h"
-#include "chars.h"
-#include "fports.h"
+#include <errno.h>
+
+#include "libguile/_scm.h"
+#include "libguile/eval.h"
+#include "libguile/chars.h"
+#include "libguile/fports.h"
+#include "libguile/root.h"
+#include "libguile/strings.h"
+#include "libguile/vectors.h"
 
-#include "vports.h"
+#include "libguile/validate.h"
+#include "libguile/vports.h"
 
 #ifdef HAVE_STRING_H
 #include <string.h>
  */
 
 
+static scm_t_bits scm_tc16_sfport;
 
-static int prinsfpt SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
-
-static int 
-prinsfpt (exp, port, pstate)
-     SCM exp;
-     SCM port;
-     scm_print_state *pstate;
-{
-  scm_prinport (exp, port, "soft");
-  return !0;
-}
 
-/* called with a single char at most.  */
 static void
-sfflush (SCM port)
+sf_flush (SCM port)
 {
-  struct scm_port_table *pt = SCM_PTAB_ENTRY (port);
-  SCM stream = pt->stream;
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
+  SCM stream = SCM_PACK (pt->stream);
 
   if (pt->write_pos > pt->write_buf)
     {
-      /* write the char. */
-      scm_apply (SCM_VELTS (stream)[0], SCM_MAKICHR (*pt->write_buf),
+      /* write the byte. */
+      scm_apply (SCM_VELTS (stream)[0], SCM_MAKE_CHAR (*pt->write_buf),
                 scm_listofnull);
       pt->write_pos = pt->write_buf;
   
@@ -90,99 +89,149 @@ sfflush (SCM port)
       {
        SCM f = SCM_VELTS (stream)[2];
 
-       if (f != SCM_BOOL_F)
+       if (!SCM_FALSEP (f))
          scm_apply (f, SCM_EOL, SCM_EOL);
       }
     }
 }
 
-/* string output proc (element 1) is no longer called.  */
+static void
+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_mem2string ((char *) data, size), SCM_EOL),
+            SCM_EOL);
+}
 
 /* calling the flush proc (element 2) is in case old code needs it,
    but perhaps softports could the use port buffer in the same way as
    fports.  */
 
-/* returns a single character.  */
+/* places a single char in the input buffer.  */
 static int 
-sf_fill_buffer (SCM port)
+sf_fill_input (SCM port)
 {
-  SCM p = SCM_STREAM (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))
     return EOF;
-  SCM_ASSERT (SCM_ICHRP (ans), ans, SCM_ARG1, "sf_fill_buffer");
-  return SCM_ICHR (ans);
+  SCM_ASSERT (SCM_CHARP (ans), ans, SCM_ARG1, "sf_fill_input");
+  {
+    scm_t_port *pt = SCM_PTAB_ENTRY (port);    
+
+    *pt->read_buf = SCM_CHAR (ans);
+    pt->read_pos = pt->read_buf;
+    pt->read_end = pt->read_buf + 1;
+    return *pt->read_buf;
+  }
 }
 
 
 static int 
-sfclose (SCM port)
+sf_close (SCM port)
 {
-  SCM p = SCM_STREAM (port);
+  SCM p = SCM_PACK (SCM_STREAM (port));
   SCM f = SCM_VELTS (p)[4];
-  if (SCM_BOOL_F == f)
+  if (SCM_FALSEP (f))
     return 0;
   f = scm_apply (f, SCM_EOL, SCM_EOL);
   errno = 0;
-  return SCM_BOOL_F == f ? EOF : 0;
+  return SCM_FALSEP (f) ? EOF : 0;
 }
 
 
 
-SCM_PROC(s_make_soft_port, "make-soft-port", 2, 0, 0, scm_make_soft_port);
-
-SCM 
-scm_make_soft_port (pv, modes)
-     SCM pv;
-     SCM modes;
+SCM_DEFINE (scm_make_soft_port, "make-soft-port", 2, 0, 0,
+           (SCM pv, SCM modes),
+           "Return a port capable of receiving or delivering characters as\n"
+           "specified by the @var{modes} string (@pxref{File Ports,\n"
+           "open-file}).  @var{pv} must be a vector of length 5.  Its\n"
+           "components are as follows:\n"
+           "\n"
+           "@enumerate 0\n"
+           "@item\n"
+           "procedure accepting one character for output\n"
+           "@item\n"
+           "procedure accepting a string for output\n"
+           "@item\n"
+           "thunk for flushing output\n"
+           "@item\n"
+           "thunk for getting one character\n"
+           "@item\n"
+           "thunk for closing port (not by garbage collection)\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\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"
+           "            (lambda (c) (write c stdout))\n"
+           "            (lambda (s) (display s stdout))\n"
+           "            (lambda () (display \".\" stdout))\n"
+           "            (lambda () (char-upcase (read-char)))\n"
+           "            (lambda () (display \"@@\" stdout)))\n"
+           "           \"rw\"))\n"
+           "\n"
+           "(write p p) @result{} #<input-output: soft 8081e20>\n"
+           "@end lisp")
+#define FUNC_NAME s_scm_make_soft_port
 {
-  struct scm_port_table * pt;
+  scm_t_port *pt;
   SCM z;
-  SCM_ASSERT (SCM_NIMP (pv) && SCM_VECTORP (pv) && 5 == SCM_LENGTH (pv), pv, SCM_ARG1, s_make_soft_port);
-  SCM_ASSERT (SCM_NIMP (modes) && SCM_ROSTRINGP (modes), modes, SCM_ARG2, s_make_soft_port);
-  SCM_COERCE_SUBSTR (modes);
+  SCM_VALIDATE_VECTOR_LEN (1,pv,5);
+  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_SETCAR (z, scm_tc16_sfport | scm_mode_bits (SCM_ROCHARS (modes)));
+  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_SETSTREAM (z, pv);
-  pt->read_buf = pt->read_pos = pt->read_end = &pt->shortbuf;
-  pt->write_buf = pt->write_pos = &pt->shortbuf;
-  pt->read_buf_size = pt->write_buf_size = 1;
-  pt->write_end = pt->write_buf + pt->write_buf_size;
+  SCM_SETSTREAM (z, SCM_UNPACK (pv));
   SCM_ALLOW_INTS;
   return z;
 }
+#undef FUNC_NAME
 
 
-static int 
-noop0 (SCM port)
-{
-  return 0;
-}
-
-
-scm_ptobfuns scm_sfptob =
+static scm_t_bits
+scm_make_sfptob ()
 {
-  scm_markstream,
-  noop0,
-  prinsfpt,
-  0,
-  sfflush,
-  sfclose,
-  sf_fill_buffer,
-  0,
-  0,
-};
+  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);
 
+  return tc;
+}
 
 void
 scm_init_vports ()
 {
-#include "vports.x"
+  scm_tc16_sfport = scm_make_sfptob ();
+
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/vports.x"
+#endif
 }
 
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/