*** empty log message ***
[bpt/guile.git] / libguile / strports.c
index d76a600..f718c07 100644 (file)
@@ -1,57 +1,45 @@
-/*     Copyright (C) 1995,1996,1998,1999 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.
- *
- * 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 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.
  *
- * 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
+ */
+
+
 \f
 
-#include "_scm.h"
+#if HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include "libguile/_scm.h"
 
 #include <stdio.h>
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 
-#include "unif.h"
-#include "eval.h"
-#include "read.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/validate.h"
+#include "libguile/deprecation.h"
 
-#include "strports.h"
+#include "libguile/strports.h"
 
 #ifdef HAVE_STRING_H
 #include <string.h>
    when rw_active is SCM_PORT_NEITHER.
 */
 
+scm_t_bits scm_tc16_strport;
+
+
 static int
 stfill_buffer (SCM port)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (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
    change read_buf_size.  */
 static void 
-st_resize_port (scm_port *pt, off_t new_size)
+st_resize_port (scm_t_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 = SCM_UNPACK (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;
@@ -110,7 +109,7 @@ st_resize_port (scm_port *pt, off_t new_size)
 static void
 st_flush (SCM port)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
 
   if (pt->write_pos == pt->write_end)
     {
@@ -126,9 +125,9 @@ st_flush (SCM port)
 }
 
 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);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
   const char *input = (char *) data;
 
   while (size > 0)
@@ -136,7 +135,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);
+      memcpy ((char *) pt->write_pos, input, write_len);
       pt->write_pos += write_len;
       size -= write_len;
       input += write_len;
@@ -148,20 +147,19 @@ st_write (SCM port, void *data, size_t size)
 static void
 st_end_input (SCM port, int offset)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
-  const unsigned char *pos = pt->read_pos - offset;
-
-  if (pos < pt->read_buf)
-    scm_misc_error ("st_end_input", "negative position", SCM_EOL);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
   
-  pt->write_pos = (unsigned char *) pt->read_pos = pos;
+  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
 st_seek (SCM port, off_t offset, int whence)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
   off_t target;
 
   if (pt->rw_active == SCM_PORT_READ && offset == 0 && whence == SEEK_CUR)
@@ -204,7 +202,7 @@ st_seek (SCM port, off_t offset, int whence)
   
       if (target >= pt->write_buf_size)
        {
-         if (!(SCM_CAR (port) & SCM_WRTNG))
+         if (!(SCM_CELL_WORD_0 (port) & SCM_WRTNG))
            {
              if (target > pt->write_buf_size)
                {
@@ -233,7 +231,7 @@ st_seek (SCM port, off_t offset, int whence)
 static void
 st_truncate (SCM port, off_t length)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
 
   if (length > pt->write_buf_size)
     st_resize_port (pt, length);
@@ -248,37 +246,33 @@ st_truncate (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_t_port *pt;
+  size_t 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)))
     scm_misc_error ("scm_mkstrport", "port must read or write", SCM_EOL);
-  SCM_NEWCELL (z);
-  SCM_DEFER_INTS;
-  pt = scm_add_to_port_table (z);
-  SCM_SETCAR (z, scm_tc16_strport | modes);
-  SCM_SETPTAB_ENTRY (z, pt);
-  SCM_SETSTREAM (z, str);
-  pt->write_buf = pt->read_buf = SCM_ROCHARS (str);
+
+  scm_mutex_lock (&scm_i_port_table_mutex);
+  z = scm_new_port_table_entry (scm_tc16_strport);
+  pt = SCM_PTAB_ENTRY(z);
+  SCM_SETSTREAM (z, SCM_UNPACK (str));
+  SCM_SET_CELL_TYPE(z, scm_tc16_strport|modes);
+  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;
 
   pt->rw_random = 1;
 
-  SCM_ALLOW_INTS;
+  scm_mutex_unlock (&scm_i_port_table_mutex);
 
   /* ensure write_pos is writable. */
   if ((modes & SCM_WRTNG) && pt->write_pos == pt->write_end)
@@ -289,77 +283,126 @@ scm_mkstrport (pos, str, modes, caller)
 /* create a new string from a string port's buffer.  */
 SCM scm_strport_to_string (SCM port)
 {
-  scm_port *pt = SCM_PTAB_ENTRY (port);
+  scm_t_port *pt = SCM_PTAB_ENTRY (port);
+  SCM str;
 
   if (pt->rw_active == SCM_PORT_WRITE)
     st_flush (port);
-  return scm_makfromstr (pt->read_buf, pt->read_buf_size, 0);
+
+  str = scm_mem2string ((char *) pt->read_buf, pt->read_buf_size);
+  scm_remember_upto_here_1 (port);
+  return str;
 }
 
-SCM_PROC(s_call_with_output_string, "call-with-output-string", 1, 0, 0, scm_call_with_output_string);
+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 str, port;
 
-SCM 
-scm_call_with_output_string (proc)
-     SCM proc;
+  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_call_2 (printer, obj, port);
+
+  return scm_strport_to_string (port);
+}
+#undef FUNC_NAME
+
+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);
-  scm_apply (proc, p, scm_listofnull);
+                     FUNC_NAME);
+  scm_call_1 (proc, p);
 
-  return scm_strport_to_string (p);
+  return scm_get_output_string (p);
 }
-
-
-
-/* Return a Scheme string obtained by printing a given object.
- */
-
-
-SCM
-scm_strprint_obj (obj)
-     SCM obj;
+#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 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);
-  }
+  SCM p = scm_mkstrport(SCM_INUM0, string, SCM_OPN | SCM_RDNG, FUNC_NAME);
+  return scm_call_1 (proc, p);
 }
-
-
-
-
-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;
+#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, s_call_with_input_string);
-  return scm_apply (proc, p, scm_listofnull);
+  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_c_read_string (const char *expr)
 {
   SCM port = scm_mkstrport (SCM_INUM0,
                            scm_makfrom0str (expr),
                            SCM_OPN | SCM_RDNG,
-                           "scm_eval_0str");
+                           "scm_c_read_string");
   SCM form;
 
   /* Read expressions from that port; ignore the values.  */
@@ -372,27 +415,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_c_eval_string (const char *expr)
 {
   return scm_eval_string (scm_makfrom0str (expr));
 }
 
+SCM
+scm_c_eval_string_in_module (const char *expr, SCM module)
+{
+  return scm_eval_string_in_module (scm_makfrom0str (expr), module);
+}
 
-SCM_PROC (s_eval_string, "eval-string", 1, 0, 0, scm_eval_string);
 
-SCM
-scm_eval_string (string)
-     SCM string;
+static SCM
+inner_eval_string (void *data)
 {
-  SCM port = scm_mkstrport (SCM_INUM0, string, SCM_OPN | SCM_RDNG,
-                           "scm_eval_0str");
+  SCM port = (SCM)data;
   SCM form;
   SCM ans = SCM_UNSPECIFIED;
 
   /* Read expressions from that port; ignore the values.  */
   while (!SCM_EOF_OBJECT_P (form = scm_read (port)))
-    ans = scm_eval_x (form);
+    ans = scm_primitive_eval_x (form);
 
   /* 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.
@@ -402,22 +446,59 @@ scm_eval_string (string)
   return ans;
 }
 
-void scm_make_stptob (void); /* Called from ports.c */
+SCM_DEFINE (scm_eval_string_in_module, "eval-string", 1, 1, 0, 
+            (SCM string, SCM module),
+           "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 given module, or the current\n"
+            "module when no module is given.\n"
+            "While the code is evaluated, the given module is made the\n"
+           "current one.  The current module is restored when this\n"
+            "procedure returns.")
+#define FUNC_NAME s_scm_eval_string_in_module
+{
+  SCM port = scm_mkstrport (SCM_INUM0, string, SCM_OPN | SCM_RDNG,
+                           FUNC_NAME);
+  if (SCM_UNBNDP (module))
+    module = scm_current_module ();
+  else
+    SCM_VALIDATE_MODULE (2, module);
+  return scm_c_call_with_current_module (module,
+                                        inner_eval_string, (void *)port);
+}
+#undef FUNC_NAME
 
-void
+SCM
+scm_eval_string (SCM string)
+{
+  return scm_eval_string_in_module (string, SCM_UNDEFINED);
+}
+
+static scm_t_bits
 scm_make_stptob ()
 {
-  long tc = scm_make_port_type ("string", stfill_buffer, st_write);
+  scm_t_bits 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);
+
+  return tc;
 }
 
 void
 scm_init_strports ()
 {
-#include "strports.x"
+  scm_tc16_strport = scm_make_stptob ();
+
+#include "libguile/strports.x"
 }
 
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/