Change Guile license to LGPLv3+
[bpt/guile.git] / libguile / strports.c
index 2ce941b..3f8a22e 100644 (file)
@@ -1,49 +1,28 @@
-/* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002, 2003, 2005, 2006 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 3 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 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.
  *
- * 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.
- *
- * 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
 
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
 #include "libguile/_scm.h"
 
 #include <stdio.h>
@@ -59,6 +38,7 @@
 #include "libguile/strings.h"
 #include "libguile/modules.h"
 #include "libguile/validate.h"
+#include "libguile/deprecation.h"
 
 #include "libguile/strports.h"
 
  */
 
 /* NOTES:
+
+   We break the rules set forth by strings.h about accessing the
+   internals of strings here.  We can do this since we can guarantee
+   that the string used as pt->stream is not in use by anyone else.
+   Thus, it's representation will not change asynchronously.
+
+   (Ports aren't thread-safe yet anyway...)
+
    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.
-*/
+
+   ENHANCE-ME - output blocks:
+
+   The current code keeps an output string as a single block.  That means
+   when the size is increased the entire old contents must be copied.  It'd
+   be more efficient to begin a new block when the old one is full, so
+   there's no re-copying of previous data.
+
+   To make seeking efficient, keeping the pieces in a vector might be best,
+   though appending is probably the most common operation.  The size of each
+   block could be progressively increased, so the bigger the string the
+   bigger the blocks.
+
+   When `get-output-string' is called the blocks have to be coalesced into a
+   string, the result could be kept as a single big block.  If blocks were
+   strings then `get-output-string' could notice when there's just one and
+   return that with a copy-on-write (though repeated calls to
+   `get-output-string' are probably unlikely).
+
+   Another possibility would be to extend the port mechanism to let SCM
+   strings come through directly from `display' and friends.  That way if a
+   big string is written it can be kept as a copy-on-write, saving time
+   copying and maybe saving some space.  */
+
 
 scm_t_bits scm_tc16_strport;
 
@@ -100,8 +111,10 @@ static void
 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);
+  const char *src = scm_i_string_chars (old_stream);
+  char *dst;
+  SCM new_stream = scm_i_make_string (new_size, &dst);
+  unsigned long int old_size = scm_i_string_length (old_stream);
   unsigned long int min_size = min (old_size, new_size);
   unsigned long int i;
 
@@ -110,12 +123,14 @@ st_resize_port (scm_t_port *pt, off_t new_size)
   pt->write_buf_size = new_size;
 
   for (i = 0; i != min_size; ++i)
-    SCM_STRING_CHARS (new_stream) [i] = SCM_STRING_CHARS (old_stream) [i];
+    dst[i] = src[i];
+
+  scm_remember_upto_here_1 (old_stream);
 
   /* reset buffer. */
   {
     pt->stream = SCM_UNPACK (new_stream);
-    pt->read_buf = pt->write_buf = SCM_STRING_UCHARS (new_stream);
+    pt->read_buf = pt->write_buf = (unsigned char *)dst;
     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;
@@ -126,7 +141,14 @@ st_resize_port (scm_t_port *pt, off_t new_size)
 #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.  */
+   necessary.  update read_buf to account for written chars.
+
+   The buffer is enlarged by 1.5 times, plus SCM_WRITE_BLOCK.  Adding just a
+   fixed amount is no good, because there's a block copy for each increment,
+   and that copying would take quadratic time.  In the past it was found to
+   be very slow just adding 80 bytes each time (eg. about 10 seconds for
+   writing a 100kbyte string).  */
+
 static void
 st_flush (SCM port)
 {
@@ -134,7 +156,7 @@ st_flush (SCM port)
 
   if (pt->write_pos == pt->write_end)
     {
-      st_resize_port (pt, pt->write_buf_size + SCM_WRITE_BLOCK);
+      st_resize_port (pt, pt->write_buf_size * 3 / 2 + SCM_WRITE_BLOCK);
     }
   pt->read_pos = pt->write_pos;
   if (pt->read_pos > pt->read_end)
@@ -156,7 +178,7 @@ st_write (SCM port, const void *data, size_t size)
       int space = pt->write_end - pt->write_pos;
       int write_len = (size > space) ? space : size;
       
-      strncpy ((char *) 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;
@@ -271,29 +293,46 @@ scm_mkstrport (SCM pos, SCM str, long modes, const char *caller)
 {
   SCM z;
   scm_t_port *pt;
-  size_t str_len;
+  size_t str_len, c_pos;
+
+  SCM_ASSERT (scm_is_string (str), str, SCM_ARG1, caller);
+
+  str_len = scm_i_string_length (str);
+  c_pos = scm_to_unsigned_integer (pos, 0, str_len);
 
-  SCM_ASSERT (SCM_INUMP(pos) && SCM_INUM(pos) >= 0, pos, SCM_ARG1, caller);
-  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_SET_CELL_TYPE (z, scm_tc16_strport | modes);
-  SCM_SETPTAB_ENTRY (z, pt);
+
+  /* XXX
+     Make a new string to isolate us from changes to the original.
+     This is done so that we can rely on scm_i_string_chars to stay in
+     place even across SCM_TICKs.
+
+     Additionally, when we are going to write to the string, we make a
+     copy so that we can write to it without having to use
+     scm_i_string_writable_chars.
+  */
+
+  if (modes & SCM_WRTNG)
+    str = scm_c_substring_copy (str, 0, str_len);
+  else
+    str = scm_c_substring (str, 0, str_len);
+
+  scm_i_scm_pthread_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));
-  pt->write_buf = pt->read_buf = SCM_STRING_UCHARS (str);
-  pt->read_pos = pt->write_pos = pt->read_buf + SCM_INUM (pos);
+  SCM_SET_CELL_TYPE(z, scm_tc16_strport|modes);
+  /* see above why we can use scm_i_string_chars here. */
+  pt->write_buf = pt->read_buf = (unsigned char *) scm_i_string_chars (str);
+  pt->read_pos = pt->write_pos = pt->read_buf + c_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_i_pthread_mutex_unlock (&scm_i_port_table_mutex);
 
   /* ensure write_pos is writable. */
   if ((modes & SCM_WRTNG) && pt->write_pos == pt->write_end)
@@ -306,11 +345,13 @@ SCM scm_strport_to_string (SCM port)
 {
   scm_t_port *pt = SCM_PTAB_ENTRY (port);
   SCM str;
-
+  char *dst;
+  
   if (pt->rw_active == SCM_PORT_WRITE)
     st_flush (port);
 
-  str = scm_mem2string ((char *) pt->read_buf, pt->read_buf_size);
+  str = scm_i_make_string (pt->read_buf_size, &dst);
+  memcpy (dst, (char *) pt->read_buf, pt->read_buf_size);
   scm_remember_upto_here_1 (port);
   return str;
 }
@@ -327,28 +368,18 @@ SCM_DEFINE (scm_object_to_string, "object->string", 1, 1, 0,
   if (!SCM_UNBNDP (printer))
     SCM_VALIDATE_PROC (2, printer);
 
-  str = scm_allocate_string (0);
+  str = scm_c_make_string (0, SCM_UNDEFINED);
   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);
+    scm_call_2 (printer, obj, port);
 
   return scm_strport_to_string (port);
 }
 #undef FUNC_NAME
 
-#if (SCM_DEBUG_DEPRECATED == 0)
-
-SCM
-scm_strprint_obj (SCM obj)
-{
-  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"
@@ -362,9 +393,9 @@ SCM_DEFINE (scm_call_with_output_string, "call-with-output-string", 1, 0, 0,
                     scm_make_string (SCM_INUM0, SCM_UNDEFINED),
                     SCM_OPN | SCM_WRTNG,
                      FUNC_NAME);
-  scm_apply (proc, p, scm_listofnull);
+  scm_call_1 (proc, p);
 
-  return scm_strport_to_string (p);
+  return scm_get_output_string (p);
 }
 #undef FUNC_NAME
 
@@ -376,7 +407,7 @@ SCM_DEFINE (scm_call_with_input_string, "call-with-input-string", 2, 0, 0,
 #define FUNC_NAME s_scm_call_with_input_string
 {
   SCM p = scm_mkstrport(SCM_INUM0, string, SCM_OPN | SCM_RDNG, FUNC_NAME);
-  return scm_apply (proc, p, scm_listofnull);
+  return scm_call_1 (proc, p);
 }
 #undef FUNC_NAME
 
@@ -428,12 +459,12 @@ SCM_DEFINE (scm_get_output_string, "get-output-string", 1, 0, 0,
 /* Given a null-terminated string EXPR containing a Scheme expression
    read it, and return it as an SCM value. */
 SCM
-scm_read_0str (char *expr)
+scm_c_read_string (const char *expr)
 {
   SCM port = scm_mkstrport (SCM_INUM0,
-                           scm_makfrom0str (expr),
+                           scm_from_locale_string (expr),
                            SCM_OPN | SCM_RDNG,
-                           "scm_eval_0str");
+                           "scm_c_read_string");
   SCM form;
 
   /* Read expressions from that port; ignore the values.  */
@@ -446,11 +477,18 @@ scm_read_0str (char *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 (const char *expr)
+scm_c_eval_string (const char *expr)
 {
-  return scm_eval_string (scm_makfrom0str (expr));
+  return scm_eval_string (scm_from_locale_string (expr));
 }
 
+SCM
+scm_c_eval_string_in_module (const char *expr, SCM module)
+{
+  return scm_eval_string_in_module (scm_from_locale_string (expr), module);
+}
+
+
 static SCM
 inner_eval_string (void *data)
 {
@@ -470,21 +508,34 @@ inner_eval_string (void *data)
   return ans;
 }
 
-SCM_DEFINE (scm_eval_string, "eval-string", 1, 0, 0, 
-            (SCM string),
+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 environment returned by the\n"
-           "procedure @code{interaction-environment}.")
-#define FUNC_NAME s_scm_eval_string
+           "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,
-                           "scm_eval_0str");
-  return scm_c_call_with_current_module (scm_interaction_environment (),
+                           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
 
+SCM
+scm_eval_string (SCM string)
+{
+  return scm_eval_string_in_module (string, SCM_UNDEFINED);
+}
+
 static scm_t_bits
 scm_make_stptob ()
 {
@@ -504,9 +555,7 @@ scm_init_strports ()
 {
   scm_tc16_strport = scm_make_stptob ();
 
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/strports.x"
-#endif
 }