* Change a couple of functions to accept either symbols or strings only.
[bpt/guile.git] / libguile / strports.c
index dfec4f2..8717e98 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1998,1999 Free Software Foundation, Inc.
+/*     Copyright (C) 1995,1996,1998,1999, 2000 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 "libguile/_scm.h"
+
 #include <stdio.h>
-#include "_scm.h"
-#include "unif.h"
-#include "eval.h"
-#include "read.h"
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
 
-#include "strports.h"
+#include "libguile/unif.h"
+#include "libguile/eval.h"
+#include "libguile/ports.h"
+#include "libguile/read.h"
+#include "libguile/root.h"
+#include "libguile/strings.h"
+#include "libguile/modules.h"
+
+#include "libguile/strports.h"
 
 #ifdef HAVE_STRING_H
 #include <string.h>
  *
  */
 
-
-static int 
-prinstpt (SCM exp, SCM port, scm_print_state *pstate)
-{
-  scm_prinport (exp, port, "string");
-  return !0;
-}
+/* NOTES:
+   write_buf/write_end point to the ends of the allocated string.
+   read_buf/read_end in principle point to the part of the string which
+   has been written to, but this is only updated after a flush.
+   read_pos and write_pos in principle should be equal, but this is only true
+   when rw_active is SCM_PORT_NEITHER.
+*/
 
 static int
 stfill_buffer (SCM port)
 {
-  SCM str = SCM_STREAM (port);
   scm_port *pt = SCM_PTAB_ENTRY (port);
   
-  pt->read_buf = SCM_ROCHARS (str);
-  pt->read_buf_size = SCM_ROLENGTH (str);
-  pt->read_end = pt->read_buf + pt->read_buf_size;
-
   if (pt->read_pos >= pt->read_end)
     return EOF;
   else
-    return scm_return_first (*(pt->read_pos++), port);
+    return scm_return_first_int (*pt->read_pos, port);
 }
 
+/* change the size of a port's string to new_size.  this doesn't
+   change read_buf_size.  */
 static void 
-st_grow_port (scm_port *pt, off_t add)
+st_resize_port (scm_port *pt, off_t new_size)
 {
-  off_t new_size = pt->write_buf_size + add;
+  SCM old_stream = SCM_PACK (pt->stream);
+  SCM new_stream = scm_makstr (new_size, 0);
+  unsigned long int old_size = SCM_STRING_LENGTH (old_stream);
+  unsigned long int min_size = min (old_size, new_size);
+  unsigned long int i;
+
+  off_t index = pt->write_pos - pt->write_buf;
+
+  pt->write_buf_size = new_size;
 
-  scm_vector_set_length_x (pt->stream,
-                          SCM_MAKINUM (new_size));
-  pt->read_buf_size = pt->write_buf_size = new_size;
-  /* reset buffer in case reallocation moved the string. */
+  for (i = 0; i != min_size; ++i)
+    SCM_STRING_CHARS (new_stream) [i] = SCM_STRING_CHARS (old_stream) [i];
+
+  /* reset buffer. */
   {
-    off_t index = pt->write_pos - pt->write_buf;
-    
-    pt->read_buf = pt->write_buf = SCM_CHARS (pt->stream);
-    pt->write_pos = pt->write_buf + index;
-    pt->read_end = pt->write_end = pt->write_buf + pt->write_buf_size;
+    pt->stream = new_stream;
+    pt->read_buf = pt->write_buf = SCM_STRING_UCHARS (new_stream);
+    pt->read_pos = pt->write_pos = pt->write_buf + index;
+    pt->write_end = pt->write_buf + pt->write_buf_size;
+    pt->read_end = pt->read_buf + pt->read_buf_size;
   }
 }
 
+/* amount by which write_buf is expanded.  */
+#define SCM_WRITE_BLOCK 80
+
+/* ensure that write_pos < write_end by enlarging the buffer when
+   necessary.  update read_buf to account for written chars.  */
 static void
 st_flush (SCM port)
 {
@@ -107,19 +130,47 @@ st_flush (SCM port)
 
   if (pt->write_pos == pt->write_end)
     {
-      st_grow_port (pt, 1);
+      st_resize_port (pt, pt->write_buf_size + SCM_WRITE_BLOCK);
     }
   pt->read_pos = pt->write_pos;
-  pt->rw_active = 0;
+  if (pt->read_pos > pt->read_end)
+    {
+      pt->read_end = (unsigned char *) pt->read_pos;
+      pt->read_buf_size = pt->read_end - pt->read_buf;
+    }
+  pt->rw_active = SCM_PORT_NEITHER;
 }
 
 static void
-st_read_flush (SCM port, int offset)
+st_write (SCM port, const void *data, size_t size)
 {
   scm_port *pt = SCM_PTAB_ENTRY (port);
+  const char *input = (char *) data;
 
-  pt->write_pos = (unsigned char *) pt->read_pos;
-  pt->rw_active = 0;
+  while (size > 0)
+    {
+      int space = pt->write_end - pt->write_pos;
+      int write_len = (size > space) ? space : size;
+      
+      strncpy ((char *) pt->write_pos, input, write_len);
+      pt->write_pos += write_len;
+      size -= write_len;
+      input += write_len;
+      if (write_len == space)
+       st_flush (port);
+    }
+}
+
+static void
+st_end_input (SCM port, int offset)
+{
+  scm_port *pt = SCM_PTAB_ENTRY (port);
+  
+  if (pt->read_pos - pt->read_buf < offset)
+    scm_misc_error ("st_end_input", "negative position", SCM_EOL);
+
+  pt->write_pos = (unsigned char *) (pt->read_pos = pt->read_pos - offset);
+  pt->rw_active = SCM_PORT_NEITHER;
 }
 
 static off_t
@@ -128,56 +179,99 @@ st_seek (SCM port, off_t offset, int whence)
   scm_port *pt = SCM_PTAB_ENTRY (port);
   off_t target;
 
-  switch (whence)
+  if (pt->rw_active == SCM_PORT_READ && offset == 0 && whence == SEEK_CUR)
+    /* special case to avoid disturbing the unread-char buffer.  */
     {
-    case SEEK_CUR:
-      if (SCM_CAR (port) & SCM_WRTNG)
-       target = pt->write_pos - pt->write_buf + offset;
+      if (pt->read_buf == pt->putback_buf)
+       {
+         target = pt->saved_read_pos - pt->saved_read_buf
+           - (pt->read_end - pt->read_pos);
+       }
       else
-       target = pt->read_pos - pt->read_buf + offset;
-      break;
-    case SEEK_END:
-      target = pt->write_end - pt->write_buf + offset;
-      break;
-    default: /* SEEK_SET */
-      target = offset;
-      break;
+       {
+         target = pt->read_pos - pt->read_buf;
+       }
     }
-  if (target < 0)
-    scm_misc_error ("st_seek", "negative offset",
-                   scm_cons (SCM_MAKINUM (target), EOF));
-  if (target > pt->read_buf_size)
+  else
+    /* all other cases.  */
     {
-      st_grow_port (pt, target - pt->read_buf_size);
+      if (pt->rw_active == SCM_PORT_WRITE)
+       st_flush (port);
+  
+      if (pt->rw_active == SCM_PORT_READ)
+       scm_end_input (port);
+
+      switch (whence)
+       {
+       case SEEK_CUR:
+         target = pt->read_pos - pt->read_buf + offset;
+         break;
+       case SEEK_END:
+         target = pt->read_end - pt->read_buf + offset;
+         break;
+       default: /* SEEK_SET */
+         target = offset;
+         break;
+       }
+
+      if (target < 0)
+       scm_misc_error ("st_seek", "negative offset", SCM_EOL);
+  
+      if (target >= pt->write_buf_size)
+       {
+         if (!(SCM_CELL_WORD_0 (port) & SCM_WRTNG))
+           {
+             if (target > pt->write_buf_size)
+               {
+                 scm_misc_error ("st_seek", 
+                                 "seek past end of read-only strport",
+                                 SCM_EOL);
+               }
+           }
+         else
+           {
+             st_resize_port (pt, target + (target == pt->write_buf_size
+                                           ? SCM_WRITE_BLOCK
+                                           : 0));
+           }
+       }
+      pt->read_pos = pt->write_pos = pt->read_buf + target;
+      if (pt->read_pos > pt->read_end)
+       {
+         pt->read_end = (unsigned char *) pt->read_pos;
+         pt->read_buf_size = pt->read_end - pt->read_buf;
+       }
     }
-  pt->read_pos = pt->write_pos = pt->read_buf + target;
   return target;
 }
 
 static void
-st_ftruncate (SCM port, off_t length)
+st_truncate (SCM port, off_t length)
 {
   scm_port *pt = SCM_PTAB_ENTRY (port);
-  off_t old_len = pt->write_end - pt->write_buf;
+
+  if (length > pt->write_buf_size)
+    st_resize_port (pt, length);
+
+  pt->read_buf_size = length;
+  pt->read_end = pt->read_buf + length;
+  if (pt->read_pos > pt->read_end)
+    pt->read_pos = pt->read_end;
   
-  if (length != old_len)
-    st_grow_port (pt, length - old_len);
+  if (pt->write_pos > pt->read_end)
+    pt->write_pos = pt->read_end;
 }
 
 SCM 
-scm_mkstrport (pos, str, modes, caller)
-     SCM pos;
-     SCM str;
-     long modes;
-     const char * caller;
+scm_mkstrport (SCM pos, SCM str, long modes, const char *caller)
 {
   SCM z;
   scm_port *pt;
   int str_len;
 
   SCM_ASSERT (SCM_INUMP(pos) && SCM_INUM(pos) >= 0, pos, SCM_ARG1, caller);
-  SCM_ASSERT (SCM_NIMP(str) && SCM_ROSTRINGP(str), str, SCM_ARG1, caller);
-  str_len = SCM_ROLENGTH (str);
+  SCM_ASSERT (SCM_STRINGP (str), str, SCM_ARG1, caller);
+  str_len = SCM_STRING_LENGTH (str);
   if (SCM_INUM (pos) > str_len)
     scm_out_of_range (caller, pos);
   if (!((modes & SCM_WRTNG) || (modes & SCM_RDNG)))
@@ -185,50 +279,52 @@ scm_mkstrport (pos, str, modes, caller)
   SCM_NEWCELL (z);
   SCM_DEFER_INTS;
   pt = scm_add_to_port_table (z);
-  SCM_SETCAR (z, scm_tc16_strport | modes);
+  SCM_SET_CELL_TYPE (z, scm_tc16_strport | modes);
   SCM_SETPTAB_ENTRY (z, pt);
-  SCM_SETSTREAM (z, str);
-  pt->write_buf = pt->read_buf = SCM_ROCHARS (str);
+  SCM_SETSTREAM (z, SCM_UNPACK (str));
+  pt->write_buf = pt->read_buf = SCM_ROUCHARS (str);
   pt->read_pos = pt->write_pos = pt->read_buf + SCM_INUM (pos);
   pt->write_buf_size = pt->read_buf_size = str_len;
   pt->write_end = pt->read_end = pt->read_buf + pt->read_buf_size;
-  pt->rw_random = (modes & SCM_RDNG) && (modes & SCM_WRTNG);
+
+  pt->rw_random = 1;
+
   SCM_ALLOW_INTS;
+
+  /* ensure write_pos is writable. */
   if ((modes & SCM_WRTNG) && pt->write_pos == pt->write_end)
     st_flush (z);
   return z;
 }
 
-SCM_PROC(s_call_with_output_string, "call-with-output-string", 1, 0, 0, scm_call_with_output_string);
+/* create a new string from a string port's buffer.  */
+SCM scm_strport_to_string (SCM port)
+{
+  scm_port *pt = SCM_PTAB_ENTRY (port);
+
+  if (pt->rw_active == SCM_PORT_WRITE)
+    st_flush (port);
+  return scm_makfromstr ((char *) pt->read_buf, pt->read_buf_size, 0);
+}
 
-SCM 
-scm_call_with_output_string (proc)
-     SCM proc;
+SCM_DEFINE (scm_call_with_output_string, "call-with-output-string", 1, 0, 0, 
+           (SCM proc),
+           "Calls the one-argument procedure @var{proc} with a newly created output\n"
+           "port.  When the function returns, the string composed of the characters\n"
+           "written into the port is returned.")
+#define FUNC_NAME s_scm_call_with_output_string
 {
   SCM p;
 
   p = scm_mkstrport (SCM_INUM0, 
                     scm_make_string (SCM_INUM0, SCM_UNDEFINED),
                     SCM_OPN | SCM_WRTNG,
-                    s_call_with_output_string);
+                     FUNC_NAME);
   scm_apply (proc, p, scm_listofnull);
-  {
-    SCM answer;
-
-    /* can't use pt->write_pos, in case port position was changed with
-       seek.
-       
-       The port buffer protocol promises that you can always store at
-       least one character at write_pos.  This means that the
-       underlying string always has one spare character at the end,
-       that the user didn't write.  Make sure we don't include that in
-       the result.  */
-    answer = scm_makfromstr (SCM_CHARS (SCM_STREAM (p)),
-                            SCM_LENGTH (SCM_STREAM (p)) - 1,
-                            0);
-    return answer;
-  }
+
+  return scm_strport_to_string (p);
 }
+#undef FUNC_NAME
 
 
 
@@ -237,49 +333,42 @@ scm_call_with_output_string (proc)
 
 
 SCM
-scm_strprint_obj (obj)
-     SCM obj;
+scm_strprint_obj (SCM obj)
 {
   SCM str;
   SCM port;
 
-  str = scm_makstr (64, 0);
-  port = scm_mkstrport (SCM_MAKINUM (0), str, SCM_OPN | SCM_WRTNG, "scm_strprint_obj");
+  str = scm_makstr (0, 0);
+  port = scm_mkstrport (SCM_INUM0, str, SCM_OPN | SCM_WRTNG, "scm_strprint_obj");
   scm_prin1 (obj, port, 1);
   {
-    scm_port *pt = SCM_PTAB_ENTRY (port);
-    SCM answer;
-
-    answer = scm_makfromstr (SCM_CHARS (SCM_STREAM (port)),
-                            pt->write_pos - pt->write_buf,
-                            0);
-    return answer;
+    return scm_strport_to_string (port);
   }
 }
 
 
 
 
-SCM_PROC(s_call_with_input_string, "call-with-input-string", 2, 0, 0, scm_call_with_input_string);
-
-SCM 
-scm_call_with_input_string (str, proc)
-     SCM str;
-     SCM proc;
+SCM_DEFINE (scm_call_with_input_string, "call-with-input-string", 2, 0, 0,
+           (SCM str, SCM proc),
+           "Calls the one-argument procedure @var{proc} with a newly created input\n"
+           "port from which @var{string}'s contents may be read.  The value yielded\n"
+           "by the @var{proc} is returned.")
+#define FUNC_NAME s_scm_call_with_input_string
 {
-  SCM p = scm_mkstrport(SCM_INUM0, str, SCM_OPN | SCM_RDNG, s_call_with_input_string);
+  SCM p = scm_mkstrport(SCM_INUM0, str, SCM_OPN | SCM_RDNG, FUNC_NAME);
   return scm_apply (proc, p, scm_listofnull);
 }
+#undef FUNC_NAME
 
 
 
 /* Given a null-terminated string EXPR containing a Scheme expression
    read it, and return it as an SCM value. */
 SCM
-scm_read_0str (expr)
-     char *expr;
+scm_read_0str (char *expr)
 {
-  SCM port = scm_mkstrport (SCM_MAKINUM (0),
+  SCM port = scm_mkstrport (SCM_INUM0,
                            scm_makfrom0str (expr),
                            SCM_OPN | SCM_RDNG,
                            "scm_eval_0str");
@@ -295,27 +384,28 @@ scm_read_0str (expr)
 /* Given a null-terminated string EXPR containing Scheme program text,
    evaluate it, and return the result of the last expression evaluated.  */
 SCM
-scm_eval_0str (expr)
-     char *expr;
+scm_eval_0str (const char *expr)
 {
   return scm_eval_string (scm_makfrom0str (expr));
 }
 
 
-SCM_PROC (s_eval_string, "eval-string", 1, 0, 0, scm_eval_string);
-
-SCM
-scm_eval_string (string)
-     SCM string;
+SCM_DEFINE (scm_eval_string, "eval-string", 1, 0, 0, 
+            (SCM string),
+           "Evaluate @var{string} as the text representation of a Scheme form\n"
+           "or forms, and return whatever value they produce.\n"
+           "Evaluation takes place in (interaction-environment).")
+#define FUNC_NAME s_scm_eval_string
 {
-  SCM port = scm_mkstrport (SCM_MAKINUM (0), string, SCM_OPN | SCM_RDNG,
+  SCM port = scm_mkstrport (SCM_INUM0, string, SCM_OPN | SCM_RDNG,
                            "scm_eval_0str");
   SCM form;
   SCM ans = SCM_UNSPECIFIED;
+  SCM module = scm_interaction_environment ();
 
   /* Read expressions from that port; ignore the values.  */
   while (!SCM_EOF_OBJECT_P (form = scm_read (port)))
-    ans = scm_eval_x (form);
+    ans = scm_eval_x (form, module);
 
   /* Don't close the port here; if we re-enter this function via a
      continuation, then the next time we enter it, we'll get an error.
@@ -324,39 +414,30 @@ scm_eval_string (string)
 
   return ans;
 }
+#undef FUNC_NAME
 
+void scm_make_stptob (void); /* Called from ports.c */
 
-
-static int noop0 SCM_P ((SCM stream));
-
-static int 
-noop0 (stream)
-     SCM stream;
+void
+scm_make_stptob ()
 {
-  return 0;
+  long tc = scm_make_port_type ("string", stfill_buffer, st_write);
+  scm_set_port_mark        (tc, scm_markstream);
+  scm_set_port_end_input   (tc, st_end_input);
+  scm_set_port_flush       (tc, st_flush);
+  scm_set_port_seek        (tc, st_seek);
+  scm_set_port_truncate    (tc, st_truncate);
 }
 
-
-scm_ptobfuns scm_stptob =
-{
-  scm_markstream,
-  noop0,
-  prinstpt,
-  0,
-  st_flush,
-  st_read_flush,
-  0,
-  stfill_buffer,
-  st_seek,
-  st_ftruncate,
-  0,
-};
-
-
-
 void
 scm_init_strports ()
 {
-#include "strports.x"
+#include "libguile/strports.x"
 }
 
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/