2002-07-20 Han-Wen <hanwen@cs.uu.nl>
[bpt/guile.git] / libguile / strings.c
index b878649..cbfab7b 100644 (file)
@@ -39,8 +39,6 @@
  * 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
 
@@ -50,7 +48,9 @@
 #include "libguile/chars.h"
 #include "libguile/root.h"
 #include "libguile/strings.h"
+#include "libguile/deprecation.h"
 #include "libguile/validate.h"
+
 \f
 
 /* {Strings}
 
 SCM_DEFINE (scm_string_p, "string?", 1, 0, 0, 
            (SCM obj),
-           "Return @code{#t} iff @var{obj} is a string, else returns\n"
-           "@code{#f}.")
+           "Return @code{#t} if @var{obj} is a string, else @code{#f}.")
 #define FUNC_NAME s_scm_string_p
 {
   return SCM_BOOL (SCM_STRINGP (obj));
 }
 #undef FUNC_NAME
 
-#if SCM_DEBUG_DEPRECATED == 0
-
-/* The concept of read-only strings will disappear in next release
- * of Guile.
- */
-
-SCM_DEFINE (scm_read_only_string_p, "read-only-string?", 1, 0, 0, 
-           (SCM obj),
-           "Return @code{#t} if @var{obj} is either a string or a symbol,\n"
-            "otherwise return @code{#f}.")
-#define FUNC_NAME s_scm_read_only_string_p
-{
-  return SCM_BOOL(SCM_ROSTRINGP (obj));
-}
-#undef FUNC_NAME
-
-#endif /* DEPRECATED */
 
 SCM_REGISTER_PROC (s_scm_list_to_string, "list->string", 1, 0, 0, scm_string);
 
 SCM_DEFINE (scm_string, "string", 0, 0, 1, 
             (SCM chrs),
-           "@deffnx primitive list->string chrs\n"
+           "@deffnx {Scheme Procedure} list->string chrs\n"
            "Return a newly allocated string composed of the arguments,\n"
            "@var{chrs}.")
 #define FUNC_NAME s_scm_string
@@ -98,14 +80,14 @@ SCM_DEFINE (scm_string, "string", 0, 0, 1,
   {
     long i = scm_ilength (chrs);
 
-    SCM_ASSERT (i >= 0, chrs, SCM_ARGn, FUNC_NAME);
+    SCM_ASSERT (i >= 0, chrs, SCM_ARG1, FUNC_NAME);
     result = scm_allocate_string (i);
   }
 
   {
     unsigned char *data = SCM_STRING_UCHARS (result);
 
-    while (SCM_NNULLP (chrs))
+    while (!SCM_NULLP (chrs))
       {
        SCM elt = SCM_CAR (chrs);
 
@@ -118,33 +100,9 @@ SCM_DEFINE (scm_string, "string", 0, 0, 1,
 }
 #undef FUNC_NAME
 
-#if (SCM_DEBUG_DEPRECATED == 0)
-
-SCM 
-scm_makstr (size_t len, int dummy)
-#define FUNC_NAME "scm_makstr"
-{
-  SCM s;
-  char *mem;
-
-  SCM_ASSERT_RANGE (1, scm_long2num (len), len <= SCM_STRING_MAX_LENGTH);
-
-  mem = (char *) scm_must_malloc (len + 1, FUNC_NAME);
-  mem[len] = 0;
-
-  SCM_NEWCELL (s);
-  SCM_SET_STRING_CHARS (s, mem);
-  SCM_SET_STRING_LENGTH (s, len);
-
-  return s;
-}
-#undef FUNC_NAME
-
-#endif  /* SCM_DEBUG_DEPRECATED == 0 */
 
 /* converts C scm_array of strings to SCM scm_list of strings. */
 /* If argc < 0, a null terminated scm_array is assumed. */
-
 SCM 
 scm_makfromstrs (int argc, char **argv)
 {
@@ -153,7 +111,7 @@ scm_makfromstrs (int argc, char **argv)
   if (0 > i)
     for (i = 0; argv[i]; i++);
   while (i--)
-    lst = scm_cons (scm_makfromstr (argv[i], (size_t) strlen (argv[i]), 0), lst);
+    lst = scm_cons (scm_mem2string (argv[i], strlen (argv[i])), lst);
   return lst;
 }
 
@@ -174,10 +132,8 @@ scm_take_str (char *s, size_t len)
 
   SCM_ASSERT_RANGE (2, scm_ulong2num (len), len <= SCM_STRING_MAX_LENGTH);
 
-  SCM_NEWCELL (answer);
-  SCM_SET_STRING_CHARS (answer, s);
-  SCM_SET_STRING_LENGTH (answer, len);
-  scm_done_malloc (len + 1);
+  answer = scm_cell (SCM_MAKE_STRING_TAG (len), (scm_t_bits) s);
+  scm_gc_register_collectable_memory (s, len+1, "string");
 
   return answer;
 }
@@ -191,8 +147,9 @@ scm_take0str (char *s)
   return scm_take_str (s, strlen (s));
 }
 
+
 SCM 
-scm_makfromstr (const char *src, size_t len, int dummy)
+scm_mem2string (const char *src, size_t len)
 {
   SCM s = scm_allocate_string (len);
   char *dst = SCM_STRING_CHARS (s);
@@ -202,11 +159,19 @@ scm_makfromstr (const char *src, size_t len, int dummy)
   return s;
 }
 
+
+SCM
+scm_str2string (const char *src)
+{
+  return scm_mem2string (src, strlen (src));
+}
+
+
 SCM 
 scm_makfrom0str (const char *src)
 {
   if (!src) return SCM_BOOL_F;
-  return scm_makfromstr (src, (size_t) strlen (src), 0);
+  return scm_mem2string (src, strlen (src));
 }
 
 
@@ -226,12 +191,10 @@ scm_allocate_string (size_t len)
 
   SCM_ASSERT_RANGE (1, scm_long2num (len), len <= SCM_STRING_MAX_LENGTH);
 
-  mem = (char *) scm_must_malloc (len + 1, FUNC_NAME);
+  mem = (char *) scm_gc_malloc (len + 1, "string");
   mem[len] = 0;
 
-  SCM_NEWCELL (s);
-  SCM_SET_STRING_CHARS (s, mem);
-  SCM_SET_STRING_LENGTH (s, len);
+  s = scm_cell (SCM_MAKE_STRING_TAG (len), (scm_t_bits) mem);
 
   return s;
 }
@@ -243,7 +206,7 @@ SCM_DEFINE (scm_make_string, "make-string", 1, 1, 0,
            "Return a newly allocated string of\n"
             "length @var{k}.  If @var{chr} is given, then all elements of\n"
            "the string are initialized to @var{chr}, otherwise the contents\n"
-           "of the @var{string} are unspecified.\n")
+           "of the @var{string} are unspecified.")
 #define FUNC_NAME s_scm_make_string
 {
   if (SCM_INUMP (k))
@@ -307,13 +270,9 @@ SCM_DEFINE (scm_string_set_x, "string-set!", 3, 0, 0,
            "@var{str}.")
 #define FUNC_NAME s_scm_string_set_x
 {
-#if (SCM_DEBUG_DEPRECATED == 0)
-  SCM_VALIDATE_RWSTRING (1, str);
-#else
   SCM_VALIDATE_STRING (1, str);
-#endif
-  SCM_VALIDATE_INUM_RANGE (2,k,0,SCM_STRING_LENGTH(str));
-  SCM_VALIDATE_CHAR (3,chr);
+  SCM_VALIDATE_INUM_RANGE (2, k,0, SCM_STRING_LENGTH(str));
+  SCM_VALIDATE_CHAR (3, chr);
   SCM_STRING_UCHARS (str)[SCM_INUM (k)] = SCM_CHAR (chr);
   return SCM_UNSPECIFIED;
 }
@@ -332,6 +291,7 @@ SCM_DEFINE (scm_substring, "substring", 2, 1, 0,
 {
   long int from;
   long int to;
+  SCM substr;
 
   SCM_VALIDATE_STRING (1, str);
   SCM_VALIDATE_INUM (2, start);
@@ -342,7 +302,9 @@ SCM_DEFINE (scm_substring, "substring", 2, 1, 0,
   to = SCM_INUM (end);
   SCM_ASSERT_RANGE (3, end, from <= to && to <= SCM_STRING_LENGTH (str));
 
-  return scm_makfromstr (&SCM_STRING_CHARS (str)[from], (size_t) (to - from), 0);
+  substr = scm_mem2string (&SCM_STRING_CHARS (str)[from], to - from);
+  scm_remember_upto_here_1 (str);
+  return substr;
 }
 #undef FUNC_NAME
 
@@ -361,12 +323,12 @@ SCM_DEFINE (scm_string_append, "string-append", 0, 0, 1,
   SCM_VALIDATE_REST_ARGUMENT (args);
   for (l = args; !SCM_NULLP (l); l = SCM_CDR (l)) {
     s = SCM_CAR (l);
-    SCM_VALIDATE_STRING (SCM_ARGn,s);
+    SCM_VALIDATE_STRING (SCM_ARGn, s);
     i += SCM_STRING_LENGTH (s);
   }
   res = scm_allocate_string (i);
   data = SCM_STRING_UCHARS (res);
-  for (l = args;SCM_NIMP (l);l = SCM_CDR (l)) {
+  for (l = args; !SCM_NULLP (l);l = SCM_CDR (l)) {
     s = SCM_CAR (l);
     for (i = 0;i<SCM_STRING_LENGTH (s);i++) *data++ = SCM_STRING_UCHARS (s)[i];
   }
@@ -374,74 +336,79 @@ SCM_DEFINE (scm_string_append, "string-append", 0, 0, 1,
 }
 #undef FUNC_NAME
 
-#if SCM_DEBUG_DEPRECATED == 0
 
-/* Explicit shared substrings will disappear from Guile.
- *
- * Instead, "normal" strings will be implemented using sharing
- * internally, combined with a copy-on-write strategy.
- */
-
-SCM_DEFINE (scm_make_shared_substring, "make-shared-substring", 1, 2, 0,
-           (SCM str, SCM start, SCM end),
-           "Return a shared substring of @var{str}.  The arguments are the\n"
-           "same as for the @code{substring} function: the shared substring\n"
-           "returned includes all of the text from @var{str} between\n"
-           "indexes @var{start} (inclusive) and @var{end} (exclusive).  If\n"
-           "@var{end} is omitted, it defaults to the end of @var{str}.  The\n"
-           "shared substring returned by @code{make-shared-substring}\n"
-           "occupies the same storage space as @var{str}.")
-#define FUNC_NAME s_scm_make_shared_substring
-{
-  long f;
-  long t;
-  SCM answer;
-  SCM len_str;
+/* Converts the given Scheme string OBJ into a C string, containing a copy
+   of OBJ's content with a trailing null byte.  If LENP is non-NULL, set
+   *LENP to the string's length.
 
-  SCM_VALIDATE_ROSTRING (1,str);
-  SCM_VALIDATE_INUM_DEF_COPY (2,start,0,f);
-  SCM_VALIDATE_INUM_DEF_COPY (3,end,SCM_ROLENGTH(str),t);
+   When STR is non-NULL it receives the copy and is returned by the function,
+   otherwise new memory is allocated and the caller is responsible for 
+   freeing it via free().  If out of memory, NULL is returned.
 
-  SCM_ASSERT_RANGE (2,start,(f >= 0));
-  SCM_ASSERT_RANGE (3,end, (f <= t) && (t <= SCM_ROLENGTH (str)));
+   Note that Scheme strings may contain arbitrary data, including null
+   characters.  This means that null termination is not a reliable way to 
+   determine the length of the returned value.  However, the function always 
+   copies the complete contents of OBJ, and sets *LENP to the length of the
+   scheme string (if LENP is non-null).  */
+#define FUNC_NAME "scm_c_string2str"
+char *
+scm_c_string2str (SCM obj, char *str, size_t *lenp)
+{
+  size_t len;
 
-  SCM_NEWCELL (answer);
-  SCM_NEWCELL (len_str);
+  SCM_ASSERT (SCM_STRINGP (obj), obj, SCM_ARG1, FUNC_NAME);
+  len = SCM_STRING_LENGTH (obj);
 
-  SCM_DEFER_INTS;
-  if (SCM_SUBSTRP (str))
+  if (str == NULL)
     {
-      long offset;
-      offset = SCM_INUM (SCM_SUBSTR_OFFSET (str));
-      f += offset;
-      t += offset;
-      SCM_SETCAR (len_str, SCM_MAKINUM (f));
-      SCM_SETCDR (len_str, SCM_SUBSTR_STR (str));
-      SCM_SETCDR (answer, len_str);
-      SCM_SETLENGTH (answer, t - f, scm_tc7_substring);
+      /* FIXME: Should we use exported wrappers for malloc (and free), which
+       * allow windows DLLs to call the correct freeing function? */
+      str = (char *) malloc ((len + 1) * sizeof (char));
+      if (str == NULL)
+       return NULL;
     }
-  else
-    {
-      SCM_SETCAR (len_str, SCM_MAKINUM (f));
-      SCM_SETCDR (len_str, str);
-      SCM_SETCDR (answer, len_str);
-      SCM_SETLENGTH (answer, t - f, scm_tc7_substring);
-    }
-  SCM_ALLOW_INTS;
-  return answer;
+
+  memcpy (str, SCM_STRING_CHARS (obj), len);
+  scm_remember_upto_here_1 (obj);
+  str[len] = '\0';
+
+  if (lenp != NULL)
+    *lenp = len;
+
+  return str;
+}
+#undef FUNC_NAME
+
+
+/* Copy LEN characters at START from the Scheme string OBJ to memory
+   at STR.  START is an index into OBJ; zero means the beginning of
+   the string.  STR has already been allocated by the caller.
+
+   If START + LEN is off the end of OBJ, silently truncate the source
+   region to fit the string.  If truncation occurs, the corresponding
+   area of STR is left unchanged.  */
+#define FUNC_NAME "scm_c_substring2str"
+char *
+scm_c_substring2str (SCM obj, char *str, size_t start, size_t len)
+{
+  size_t src_length, effective_length;
+
+  SCM_ASSERT (SCM_STRINGP (obj), obj, SCM_ARG2, FUNC_NAME);
+  src_length = SCM_STRING_LENGTH (obj);
+  effective_length = (len + start <= src_length) ? len : src_length - start;
+  memcpy (str, SCM_STRING_CHARS (obj) + start, effective_length);
+  scm_remember_upto_here_1 (obj);
+  return str;
 }
 #undef FUNC_NAME
 
-#endif /* DEPRECATED */
 
 void
 scm_init_strings ()
 {
   scm_nullstr = scm_allocate_string (0);
 
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/strings.x"
-#endif
 }