Correct, update, improve and clean up a lot of docstrings in order to make
[bpt/guile.git] / libguile / strports.c
index dc47fd1..3a8faaa 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1998,1999 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 "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 "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/validate.h"
 
-#include "strports.h"
+#include "libguile/strports.h"
 
 #ifdef HAVE_STRING_H
 #include <string.h>
    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 0.
+   when rw_active is SCM_PORT_NEITHER.
 */
 
+scm_bits_t scm_tc16_strport;
+
+
 static int
 stfill_buffer (SCM port)
 {
@@ -74,7 +91,7 @@ stfill_buffer (SCM port)
   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
@@ -82,15 +99,23 @@ stfill_buffer (SCM port)
 static void 
 st_resize_port (scm_port *pt, off_t new_size)
 {
+  SCM old_stream = SCM_PACK (pt->stream);
+  SCM new_stream = scm_allocate_string (new_size);
+  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));
+  for (i = 0; i != min_size; ++i)
+    SCM_STRING_CHARS (new_stream) [i] = SCM_STRING_CHARS (old_stream) [i];
 
-  /* reset buffer in case reallocation moved the string. */
+  /* reset buffer. */
   {
-    pt->read_buf = pt->write_buf = SCM_CHARS (pt->stream);
+    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;
@@ -117,11 +142,11 @@ st_flush (SCM port)
       pt->read_end = (unsigned char *) pt->read_pos;
       pt->read_buf_size = pt->read_end - pt->read_buf;
     }
-  pt->rw_active = 0;
+  pt->rw_active = SCM_PORT_NEITHER;
 }
 
 static void
-st_write (SCM port, void *data, size_t size)
+st_write (SCM port, const void *data, size_t size)
 {
   scm_port *pt = SCM_PTAB_ENTRY (port);
   const char *input = (char *) data;
@@ -131,7 +156,7 @@ st_write (SCM port, void *data, size_t size)
       int space = pt->write_end - pt->write_pos;
       int write_len = (size > space) ? space : size;
       
-      strncpy (pt->write_pos, input, write_len);
+      strncpy ((char *) pt->write_pos, input, write_len);
       pt->write_pos += write_len;
       size -= write_len;
       input += write_len;
@@ -141,12 +166,15 @@ st_write (SCM port, void *data, size_t size)
 }
 
 static void
-st_read_flush (SCM port, int offset)
+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->rw_active = 0;
+  pt->write_pos = (unsigned char *) (pt->read_pos = pt->read_pos - offset);
+  pt->rw_active = SCM_PORT_NEITHER;
 }
 
 static off_t
@@ -155,49 +183,74 @@ st_seek (SCM port, off_t offset, int whence)
   scm_port *pt = SCM_PTAB_ENTRY (port);
   off_t target;
 
-  /* we can assume at this point that pt->write_pos == pt->read_pos.  */
-  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:
-      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 (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;
+       }
     }
-  if (target < 0)
-    scm_misc_error ("st_seek", "negative offset", SCM_EOL);
-  if (target >= pt->write_buf_size)
+  else
+    /* all other cases.  */
     {
-      if (!(SCM_CAR (port) & SCM_WRTNG))
+      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 (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
            {
-             scm_misc_error ("st_seek", "seek past end of read-only strport",
-                             SCM_EOL);
+             st_resize_port (pt, target + (target == pt->write_buf_size
+                                           ? SCM_WRITE_BLOCK
+                                           : 0));
            }
        }
-      else
+      pt->read_pos = pt->write_pos = pt->read_buf + target;
+      if (pt->read_pos > pt->read_end)
        {
-         st_resize_port (pt, target + (target == pt->write_buf_size
-                                       ? SCM_WRITE_BLOCK
-                                       : 0));
+         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;
-  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;
-    }
   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);
 
@@ -214,19 +267,15 @@ st_ftruncate (SCM port, off_t length)
 }
 
 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)))
@@ -234,17 +283,15 @@ 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_STRING_UCHARS (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;
 
-  /* doesn't check (modes & SCM_RDNG), since the read_buf must be
-     maintained even for output-only ports.  */
-  pt->rw_random = modes & SCM_WRTNG;
+  pt->rw_random = 1;
 
   SCM_ALLOW_INTS;
 
@@ -261,69 +308,123 @@ SCM scm_strport_to_string (SCM port)
 
   if (pt->rw_active == SCM_PORT_WRITE)
     st_flush (port);
-  return scm_makfromstr (SCM_CHARS (SCM_STREAM (port)),
-                        pt->read_buf_size, 0);
+  return scm_makfromstr ((char *) pt->read_buf, pt->read_buf_size, 0);
 }
 
-SCM_PROC(s_call_with_output_string, "call-with-output-string", 1, 0, 0, scm_call_with_output_string);
-
-SCM 
-scm_call_with_output_string (proc)
-     SCM proc;
+SCM_DEFINE (scm_object_to_string, "object->string", 1, 1, 0,
+           (SCM obj, SCM printer),
+           "Return a Scheme string obtained by printing @var{obj}.\n"
+           "Printing function can be specified by the optional second\n"
+           "argument @var{printer} (default: @code{write}).")
+#define FUNC_NAME s_scm_object_to_string
 {
-  SCM p;
-
-  p = scm_mkstrport (SCM_INUM0, 
-                    scm_make_string (SCM_INUM0, SCM_UNDEFINED),
-                    SCM_OPN | SCM_WRTNG,
-                    s_call_with_output_string);
-  scm_apply (proc, p, scm_listofnull);
+  SCM str, port;
 
-  return scm_strport_to_string (p);
-}
+  if (!SCM_UNBNDP (printer))
+    SCM_VALIDATE_PROC (2, printer);
 
+  str = scm_allocate_string (0);
+  port = scm_mkstrport (SCM_INUM0, str, SCM_OPN | SCM_WRTNG, FUNC_NAME);
 
+  if (SCM_UNBNDP (printer))
+    scm_write (obj, port);
+  else
+    scm_apply (printer, SCM_LIST2 (obj, port), SCM_EOL);
 
-/* Return a Scheme string obtained by printing a given object.
- */
+  return scm_strport_to_string (port);
+}
+#undef FUNC_NAME
 
+#if (SCM_DEBUG_DEPRECATED == 0)
 
 SCM
-scm_strprint_obj (obj)
-     SCM obj;
+scm_strprint_obj (SCM obj)
 {
-  SCM str;
-  SCM port;
-
-  str = scm_makstr (0, 0);
-  port = scm_mkstrport (SCM_INUM0, str, SCM_OPN | SCM_WRTNG, "scm_strprint_obj");
-  scm_prin1 (obj, port, 1);
-  {
-    return scm_strport_to_string (port);
-  }
+  return scm_object_to_string (obj, SCM_UNDEFINED);
 }
 
+#endif /* (SCM_DEBUG_DEPRECATED == 0) */
 
+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,
+                     FUNC_NAME);
+  scm_apply (proc, p, scm_listofnull);
 
-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;
+  return scm_strport_to_string (p);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_call_with_input_string, "call-with-input-string", 2, 0, 0,
+           (SCM string, SCM proc),
+           "Calls the one-argument procedure @var{proc} with a newly\n"
+           "created input port from which @var{string}'s contents may be\n"
+           "read.  The value yielded 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, string, SCM_OPN | SCM_RDNG, FUNC_NAME);
   return scm_apply (proc, p, scm_listofnull);
 }
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_open_input_string, "open-input-string", 1, 0, 0,
+           (SCM str),
+           "Take a string and return an input port that delivers characters\n"
+           "from the string. The port can be closed by\n"
+           "@code{close-input-port}, though its storage will be reclaimed\n"
+           "by the garbage collector if it becomes inaccessible.")
+#define FUNC_NAME s_scm_open_input_string
+{
+  SCM p = scm_mkstrport(SCM_INUM0, str, SCM_OPN | SCM_RDNG, FUNC_NAME);
+  return p;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_open_output_string, "open-output-string", 0, 0, 0, 
+           (void),
+           "Return an output port that will accumulate characters for\n"
+           "retrieval by @code{get-output-string}. The port can be closed\n"
+           "by the procedure @code{close-output-port}, though its storage\n"
+           "will be reclaimed by the garbage collector if it becomes\n"
+           "inaccessible.")
+#define FUNC_NAME s_scm_open_output_string
+{
+  SCM p;
 
+  p = scm_mkstrport (SCM_INUM0, 
+                    scm_make_string (SCM_INUM0, SCM_UNDEFINED),
+                    SCM_OPN | SCM_WRTNG,
+                     FUNC_NAME);
+  return p;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_get_output_string, "get-output-string", 1, 0, 0, 
+           (SCM port),
+           "Given an output port created by @code{open-output-string},\n"
+           "return a string consisting of the characters that have been\n"
+           "output to the port so far.")
+#define FUNC_NAME s_scm_get_output_string
+{
+  SCM_VALIDATE_OPOUTSTRPORT (1, port);
+  return scm_strport_to_string (port);
+}
+#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_INUM0,
                            scm_makfrom0str (expr),
@@ -341,27 +442,29 @@ 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\n"
+           "form or forms, and return whatever value they produce.\n"
+           "Evaluation takes place in the environment returned by the\n"
+           "procedure @code{interaction-environment}.")
+#define FUNC_NAME s_scm_eval_string
 {
   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.
@@ -370,23 +473,35 @@ scm_eval_string (string)
 
   return ans;
 }
+#undef FUNC_NAME
 
-void scm_make_stptob (void); /* Called from ports.c */
-
-void
+static scm_bits_t
 scm_make_stptob ()
 {
-  long tc = scm_make_port_type ("string", stfill_buffer, st_flush);
+  scm_bits_t tc = scm_make_port_type ("string", stfill_buffer, st_write);
+
   scm_set_port_mark        (tc, scm_markstream);
-  scm_set_port_flush_input (tc, st_read_flush);
-  scm_set_port_write       (tc, st_write);
+  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_ftruncate);
+  scm_set_port_truncate    (tc, st_truncate);
+
+  return tc;
 }
 
 void
 scm_init_strports ()
 {
-#include "strports.x"
+  scm_tc16_strport = scm_make_stptob ();
+
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/strports.x"
+#endif
 }
 
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/