-/* Copyright (C) 1995,1996,1998,2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,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
* 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 <stdio.h>
#include <string.h>
#include "libguile/_scm.h"
#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),
- "Returns #t iff OBJ is a string, else returns #f.")
+ (SCM obj),
+ "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 x),
- "Return true if OBJ can be read as a string,\n\n"
- "This illustrates the difference between @code{string?} and\n"
- "@code{read-only-string?}:\n\n"
- "@example\n"
- "(string? \"a string\") @result{} #t\n"
- "(string? 'a-symbol) @result{} #f\n\n"
- "(read-only-string? \"a string\") @result{} #t\n"
- "(read-only-string? 'a-symbol) @result{} #t\n"
- "@end example")
-#define FUNC_NAME s_scm_read_only_string_p
-{
- return SCM_BOOL(SCM_ROSTRINGP (x));
-}
-#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"
- "Returns a newly allocated string composed of the arguments, CHRS.")
+ "@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
{
SCM result;
{
long i = scm_ilength (chrs);
- SCM_ASSERT (i >= 0, chrs, SCM_ARGn, FUNC_NAME);
- result = scm_makstr (i, 0);
+ 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);
#undef FUNC_NAME
-SCM
-scm_makstr (long 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
-
-
/* 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)
{
if (0 > i)
for (i = 0; argv[i]; i++);
while (i--)
- lst = scm_cons (scm_makfromstr (argv[i], (scm_sizet) strlen (argv[i]), 0), lst);
+ lst = scm_cons (scm_mem2string (argv[i], strlen (argv[i])), lst);
return lst;
}
strings by claiming they're shared substrings of a string we just
made up. */
SCM
-scm_take_str (char *s, int len)
+scm_take_str (char *s, size_t len)
#define FUNC_NAME "scm_take_str"
{
SCM answer;
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;
}
return scm_take_str (s, strlen (s));
}
+
SCM
-scm_makfromstr (const char *src, scm_sizet len, int dummy)
+scm_mem2string (const char *src, size_t len)
{
- SCM s = scm_makstr (len, 0);
+ SCM s = scm_allocate_string (len);
char *dst = SCM_STRING_CHARS (s);
while (len--)
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, (scm_sizet) strlen (src), 0);
+ return scm_mem2string (src, strlen (src));
}
}
+SCM
+scm_allocate_string (size_t len)
+#define FUNC_NAME "scm_allocate_string"
+{
+ char *mem;
+ SCM s;
+
+ SCM_ASSERT_RANGE (1, scm_long2num (len), len <= SCM_STRING_MAX_LENGTH);
+
+ mem = (char *) scm_gc_malloc (len + 1, "string");
+ mem[len] = 0;
+
+ s = scm_cell (SCM_MAKE_STRING_TAG (len), (scm_t_bits) mem);
+
+ return s;
+}
+#undef FUNC_NAME
+
+
SCM_DEFINE (scm_make_string, "make-string", 1, 1, 0,
(SCM k, SCM chr),
- "Returns a newly allocated string of\n"
- "length K. If CHR is given, then all elements of the string\n"
- "are initialized to CHR, otherwise the contents of the\n"
- "STRING are unspecified.\n")
+ "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.")
#define FUNC_NAME s_scm_make_string
{
if (SCM_INUMP (k))
SCM_ASSERT_RANGE (1, k, i >= 0);
- res = scm_makstr (i, 0);
+ res = scm_allocate_string (i);
if (!SCM_UNBNDP (chr))
{
unsigned char *dst;
SCM_DEFINE (scm_string_length, "string-length", 1, 0, 0,
- (SCM string),
- "Returns the number of characters in STRING")
+ (SCM string),
+ "Return the number of characters in @var{string}.")
#define FUNC_NAME s_scm_string_length
{
SCM_VALIDATE_STRING (1, string);
SCM_DEFINE (scm_string_ref, "string-ref", 2, 0, 0,
(SCM str, SCM k),
- "Returns character K of STR using zero-origin indexing.\n"
- "K must be a valid index of STR.")
+ "Return character @var{k} of @var{str} using zero-origin\n"
+ "indexing. @var{k} must be a valid index of @var{str}.")
#define FUNC_NAME s_scm_string_ref
{
- int idx;
+ long idx;
SCM_VALIDATE_STRING (1, str);
SCM_VALIDATE_INUM_COPY (2, k, idx);
SCM_DEFINE (scm_string_set_x, "string-set!", 3, 0, 0,
(SCM str, SCM k, SCM chr),
- "Stores CHR in element K of STRING and returns an unspecified value.\n"
- "K must be a valid index of STR.")
+ "Store @var{chr} in element @var{k} of @var{str} and return\n"
+ "an unspecified value. @var{k} must be a valid index of\n"
+ "@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;
}
SCM_DEFINE (scm_substring, "substring", 2, 1, 0,
- (SCM str, SCM start, SCM end),
- "Returns a newly allocated string formed from the characters\n"
- "of STR beginning with index START (inclusive) and ending with\n"
- "index END (exclusive).\n"
- "STR must be a string, START and END must be exact integers satisfying:\n\n"
- "0 <= START <= END <= (string-length STR).")
+ (SCM str, SCM start, SCM end),
+ "Return a newly allocated string formed from the characters\n"
+ "of @var{str} beginning with index @var{start} (inclusive) and\n"
+ "ending with index @var{end} (exclusive).\n"
+ "@var{str} must be a string, @var{start} and @var{end} must be\n"
+ "exact integers satisfying:\n\n"
+ "0 <= @var{start} <= @var{end} <= (string-length @var{str}).")
#define FUNC_NAME s_scm_substring
{
long int from;
long int to;
+ SCM substr;
SCM_VALIDATE_STRING (1, str);
SCM_VALIDATE_INUM (2, start);
to = SCM_INUM (end);
SCM_ASSERT_RANGE (3, end, from <= to && to <= SCM_STRING_LENGTH (str));
- return scm_makfromstr (&SCM_STRING_CHARS (str)[from], (scm_sizet) (to - from), 0);
+ substr = scm_mem2string (&SCM_STRING_CHARS (str)[from], to - from);
+ scm_remember_upto_here_1 (str);
+ return substr;
}
#undef FUNC_NAME
SCM_DEFINE (scm_string_append, "string-append", 0, 0, 1,
(SCM args),
- "Returns a newly allocated string whose characters form the\n"
- "concatenation of the given strings, ARGS.")
+ "Return a newly allocated string whose characters form the\n"
+ "concatenation of the given strings, @var{args}.")
#define FUNC_NAME s_scm_string_append
{
SCM res;
- register long i = 0;
+ size_t i = 0;
register SCM l, s;
register unsigned char *data;
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_makstr (i, 0);
+ 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];
}
}
#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 frm, SCM to),
- "Return a shared substring of @var{str}. The semantics are the same as\n"
- "for the @code{substring} function: the shared substring returned\n"
- "includes all of the text from @var{str} between indexes @var{start}\n"
- "(inclusive) and @var{end} (exclusive). If @var{end} is omitted, it\n"
- "defaults to the end of @var{str}. The shared substring returned by\n"
- "@code{make-shared-substring} occupies the same storage space as\n"
- "@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,frm,0,f);
- SCM_VALIDATE_INUM_DEF_COPY (3,to,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,frm,(f >= 0));
- SCM_ASSERT_RANGE (3,to, (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 ()
{
-#ifndef SCM_MAGIC_SNARFER
+ scm_nullstr = scm_allocate_string (0);
+
#include "libguile/strings.x"
-#endif
}
HCoop / bpt / guile.git / blobdiff