Commit | Line | Data |
---|---|---|
be54b15d | 1 | /* Copyright (C) 1995,1996,1998,2000,2001 Free Software Foundation, Inc. |
0f2d19dd JB |
2 | * |
3 | * This program is free software; you can redistribute it and/or modify | |
4 | * it under the terms of the GNU General Public License as published by | |
5 | * the Free Software Foundation; either version 2, or (at your option) | |
6 | * any later version. | |
7 | * | |
8 | * This program is distributed in the hope that it will be useful, | |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
12 | * | |
13 | * You should have received a copy of the GNU General Public License | |
14 | * along with this software; see the file COPYING. If not, write to | |
82892bed JB |
15 | * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
16 | * Boston, MA 02111-1307 USA | |
0f2d19dd JB |
17 | * |
18 | * As a special exception, the Free Software Foundation gives permission | |
19 | * for additional uses of the text contained in its release of GUILE. | |
20 | * | |
21 | * The exception is that, if you link the GUILE library with other files | |
22 | * to produce an executable, this does not by itself cause the | |
23 | * resulting executable to be covered by the GNU General Public License. | |
24 | * Your use of that executable is in no way restricted on account of | |
25 | * linking the GUILE library code into it. | |
26 | * | |
27 | * This exception does not however invalidate any other reasons why | |
28 | * the executable file might be covered by the GNU General Public License. | |
29 | * | |
30 | * This exception applies only to the code released by the | |
31 | * Free Software Foundation under the name GUILE. If you copy | |
32 | * code from other Free Software Foundation releases into a copy of | |
33 | * GUILE, as the General Public License permits, the exception does | |
34 | * not apply to the code that you add in this way. To avoid misleading | |
35 | * anyone as to the status of such modified files, you must delete | |
36 | * this exception notice from them. | |
37 | * | |
38 | * If you write modifications of your own for GUILE, it is your choice | |
39 | * whether to permit this exception to apply to your modifications. | |
82892bed | 40 | * If you do not wish that, delete this exception notice. */ |
1bbd0b84 GB |
41 | |
42 | /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999, | |
43 | gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */ | |
44 | ||
0f2d19dd JB |
45 | \f |
46 | ||
faf2c9d7 MD |
47 | #include <string.h> |
48 | ||
a0599745 MD |
49 | #include "libguile/_scm.h" |
50 | #include "libguile/chars.h" | |
7c33806a | 51 | #include "libguile/root.h" |
a0599745 MD |
52 | #include "libguile/strings.h" |
53 | #include "libguile/validate.h" | |
0f2d19dd JB |
54 | \f |
55 | ||
56 | /* {Strings} | |
57 | */ | |
58 | ||
3b3b36dd | 59 | SCM_DEFINE (scm_string_p, "string?", 1, 0, 0, |
0d26a824 | 60 | (SCM obj), |
1e6808ea | 61 | "Return @code{#t} iff @var{obj} is a string, else returns\n" |
0d26a824 | 62 | "@code{#f}.") |
1bbd0b84 | 63 | #define FUNC_NAME s_scm_string_p |
0f2d19dd | 64 | { |
e53cc817 | 65 | return SCM_BOOL (SCM_STRINGP (obj)); |
0f2d19dd | 66 | } |
1bbd0b84 | 67 | #undef FUNC_NAME |
0f2d19dd | 68 | |
e53cc817 MD |
69 | #if SCM_DEBUG_DEPRECATED == 0 |
70 | ||
71 | /* The concept of read-only strings will disappear in next release | |
72 | * of Guile. | |
73 | */ | |
74 | ||
3b3b36dd | 75 | SCM_DEFINE (scm_read_only_string_p, "read-only-string?", 1, 0, 0, |
0d26a824 | 76 | (SCM obj), |
89d04205 NJ |
77 | "Return @code{#t} if @var{obj} is either a string or a symbol,\n" |
78 | "otherwise return @code{#f}.") | |
1bbd0b84 | 79 | #define FUNC_NAME s_scm_read_only_string_p |
0f2d19dd | 80 | { |
0d26a824 | 81 | return SCM_BOOL(SCM_ROSTRINGP (obj)); |
0f2d19dd | 82 | } |
1bbd0b84 | 83 | #undef FUNC_NAME |
0f2d19dd | 84 | |
e53cc817 MD |
85 | #endif /* DEPRECATED */ |
86 | ||
bd9e24b3 | 87 | SCM_REGISTER_PROC (s_scm_list_to_string, "list->string", 1, 0, 0, scm_string); |
1bbd0b84 | 88 | |
3b3b36dd | 89 | SCM_DEFINE (scm_string, "string", 0, 0, 1, |
6fa73e72 | 90 | (SCM chrs), |
11768c04 | 91 | "@deffnx primitive list->string chrs\n" |
1e6808ea | 92 | "Return a newly allocated string composed of the arguments,\n" |
0d26a824 | 93 | "@var{chrs}.") |
1bbd0b84 | 94 | #define FUNC_NAME s_scm_string |
0f2d19dd | 95 | { |
bd9e24b3 GH |
96 | SCM result; |
97 | ||
0f2d19dd | 98 | { |
c014a02e | 99 | long i = scm_ilength (chrs); |
bd9e24b3 GH |
100 | |
101 | SCM_ASSERT (i >= 0, chrs, SCM_ARGn, FUNC_NAME); | |
be54b15d | 102 | result = scm_allocate_string (i); |
0f2d19dd | 103 | } |
bd9e24b3 GH |
104 | |
105 | { | |
322ac0c5 | 106 | unsigned char *data = SCM_STRING_UCHARS (result); |
bd9e24b3 GH |
107 | |
108 | while (SCM_NNULLP (chrs)) | |
109 | { | |
110 | SCM elt = SCM_CAR (chrs); | |
111 | ||
7866a09b GB |
112 | SCM_VALIDATE_CHAR (SCM_ARGn, elt); |
113 | *data++ = SCM_CHAR (elt); | |
bd9e24b3 GH |
114 | chrs = SCM_CDR (chrs); |
115 | } | |
116 | } | |
117 | return result; | |
0f2d19dd | 118 | } |
1bbd0b84 | 119 | #undef FUNC_NAME |
0f2d19dd | 120 | |
be54b15d | 121 | #if (SCM_DEBUG_DEPRECATED == 0) |
cb0d8be2 | 122 | |
0f2d19dd | 123 | SCM |
1be6b49c | 124 | scm_makstr (size_t len, int dummy) |
cb0d8be2 | 125 | #define FUNC_NAME "scm_makstr" |
0f2d19dd JB |
126 | { |
127 | SCM s; | |
cb0d8be2 DH |
128 | char *mem; |
129 | ||
130 | SCM_ASSERT_RANGE (1, scm_long2num (len), len <= SCM_STRING_MAX_LENGTH); | |
fee7ef83 | 131 | |
cb0d8be2 | 132 | mem = (char *) scm_must_malloc (len + 1, FUNC_NAME); |
28b06554 | 133 | mem[len] = 0; |
cb0d8be2 | 134 | |
0f2d19dd | 135 | SCM_NEWCELL (s); |
6a0476fd | 136 | SCM_SET_STRING_CHARS (s, mem); |
93778877 | 137 | SCM_SET_STRING_LENGTH (s, len); |
28b06554 | 138 | |
0f2d19dd JB |
139 | return s; |
140 | } | |
cb0d8be2 DH |
141 | #undef FUNC_NAME |
142 | ||
be54b15d | 143 | #endif /* SCM_DEBUG_DEPRECATED == 0 */ |
0f2d19dd JB |
144 | |
145 | /* converts C scm_array of strings to SCM scm_list of strings. */ | |
146 | /* If argc < 0, a null terminated scm_array is assumed. */ | |
1cc91f1b | 147 | |
0f2d19dd | 148 | SCM |
1bbd0b84 | 149 | scm_makfromstrs (int argc, char **argv) |
0f2d19dd JB |
150 | { |
151 | int i = argc; | |
152 | SCM lst = SCM_EOL; | |
153 | if (0 > i) | |
154 | for (i = 0; argv[i]; i++); | |
155 | while (i--) | |
1be6b49c | 156 | lst = scm_cons (scm_makfromstr (argv[i], (size_t) strlen (argv[i]), 0), lst); |
0f2d19dd JB |
157 | return lst; |
158 | } | |
159 | ||
160 | ||
ee149d03 JB |
161 | /* This function must only be applied to memory obtained via malloc, |
162 | since the GC is going to apply `free' to it when the string is | |
163 | dropped. | |
164 | ||
165 | Also, s[len] must be `\0', since we promise that strings are | |
166 | null-terminated. Perhaps we could handle non-null-terminated | |
167 | strings by claiming they're shared substrings of a string we just | |
168 | made up. */ | |
0f2d19dd | 169 | SCM |
1be6b49c | 170 | scm_take_str (char *s, size_t len) |
cb0d8be2 | 171 | #define FUNC_NAME "scm_take_str" |
0f2d19dd JB |
172 | { |
173 | SCM answer; | |
cb0d8be2 DH |
174 | |
175 | SCM_ASSERT_RANGE (2, scm_ulong2num (len), len <= SCM_STRING_MAX_LENGTH); | |
176 | ||
0f2d19dd | 177 | SCM_NEWCELL (answer); |
cb0d8be2 | 178 | SCM_SET_STRING_CHARS (answer, s); |
93778877 | 179 | SCM_SET_STRING_LENGTH (answer, len); |
ee149d03 | 180 | scm_done_malloc (len + 1); |
cb0d8be2 | 181 | |
0f2d19dd JB |
182 | return answer; |
183 | } | |
cb0d8be2 DH |
184 | #undef FUNC_NAME |
185 | ||
0f2d19dd | 186 | |
ee149d03 JB |
187 | /* `s' must be a malloc'd string. See scm_take_str. */ |
188 | SCM | |
189 | scm_take0str (char *s) | |
190 | { | |
191 | return scm_take_str (s, strlen (s)); | |
192 | } | |
193 | ||
0f2d19dd | 194 | SCM |
e81d98ec | 195 | scm_makfromstr (const char *src, size_t len, int dummy SCM_UNUSED) |
0f2d19dd | 196 | { |
be54b15d | 197 | SCM s = scm_allocate_string (len); |
86c991c2 | 198 | char *dst = SCM_STRING_CHARS (s); |
bd9e24b3 | 199 | |
0f2d19dd JB |
200 | while (len--) |
201 | *dst++ = *src++; | |
202 | return s; | |
203 | } | |
204 | ||
0f2d19dd | 205 | SCM |
1bbd0b84 | 206 | scm_makfrom0str (const char *src) |
0f2d19dd JB |
207 | { |
208 | if (!src) return SCM_BOOL_F; | |
1be6b49c | 209 | return scm_makfromstr (src, (size_t) strlen (src), 0); |
0f2d19dd JB |
210 | } |
211 | ||
1cc91f1b | 212 | |
0f2d19dd | 213 | SCM |
1bbd0b84 | 214 | scm_makfrom0str_opt (const char *src) |
0f2d19dd JB |
215 | { |
216 | return scm_makfrom0str (src); | |
217 | } | |
218 | ||
219 | ||
be54b15d | 220 | SCM |
1be6b49c | 221 | scm_allocate_string (size_t len) |
be54b15d DH |
222 | #define FUNC_NAME "scm_allocate_string" |
223 | { | |
224 | char *mem; | |
225 | SCM s; | |
226 | ||
227 | SCM_ASSERT_RANGE (1, scm_long2num (len), len <= SCM_STRING_MAX_LENGTH); | |
228 | ||
229 | mem = (char *) scm_must_malloc (len + 1, FUNC_NAME); | |
230 | mem[len] = 0; | |
231 | ||
232 | SCM_NEWCELL (s); | |
233 | SCM_SET_STRING_CHARS (s, mem); | |
234 | SCM_SET_STRING_LENGTH (s, len); | |
235 | ||
236 | return s; | |
237 | } | |
238 | #undef FUNC_NAME | |
239 | ||
240 | ||
3b3b36dd | 241 | SCM_DEFINE (scm_make_string, "make-string", 1, 1, 0, |
6fa73e72 | 242 | (SCM k, SCM chr), |
0d26a824 MG |
243 | "Return a newly allocated string of\n" |
244 | "length @var{k}. If @var{chr} is given, then all elements of\n" | |
245 | "the string are initialized to @var{chr}, otherwise the contents\n" | |
246 | "of the @var{string} are unspecified.\n") | |
1bbd0b84 | 247 | #define FUNC_NAME s_scm_make_string |
0f2d19dd | 248 | { |
cb0d8be2 | 249 | if (SCM_INUMP (k)) |
0f2d19dd | 250 | { |
c014a02e | 251 | long int i = SCM_INUM (k); |
cb0d8be2 DH |
252 | SCM res; |
253 | ||
254 | SCM_ASSERT_RANGE (1, k, i >= 0); | |
255 | ||
be54b15d | 256 | res = scm_allocate_string (i); |
cb0d8be2 DH |
257 | if (!SCM_UNBNDP (chr)) |
258 | { | |
259 | unsigned char *dst; | |
260 | ||
261 | SCM_VALIDATE_CHAR (2, chr); | |
262 | ||
263 | dst = SCM_STRING_UCHARS (res); | |
264 | memset (dst, SCM_CHAR (chr), i); | |
265 | } | |
266 | ||
267 | return res; | |
0f2d19dd | 268 | } |
cb0d8be2 DH |
269 | else if (SCM_BIGP (k)) |
270 | SCM_OUT_OF_RANGE (1, k); | |
271 | else | |
272 | SCM_WRONG_TYPE_ARG (1, k); | |
0f2d19dd | 273 | } |
1bbd0b84 | 274 | #undef FUNC_NAME |
0f2d19dd | 275 | |
cb0d8be2 | 276 | |
3b3b36dd | 277 | SCM_DEFINE (scm_string_length, "string-length", 1, 0, 0, |
0d26a824 MG |
278 | (SCM string), |
279 | "Return the number of characters in @var{string}.") | |
1bbd0b84 | 280 | #define FUNC_NAME s_scm_string_length |
0f2d19dd | 281 | { |
d1ca2c64 | 282 | SCM_VALIDATE_STRING (1, string); |
bfa974f0 | 283 | return SCM_MAKINUM (SCM_STRING_LENGTH (string)); |
0f2d19dd | 284 | } |
1bbd0b84 | 285 | #undef FUNC_NAME |
0f2d19dd | 286 | |
bd9e24b3 | 287 | SCM_DEFINE (scm_string_ref, "string-ref", 2, 0, 0, |
6fa73e72 | 288 | (SCM str, SCM k), |
0d26a824 MG |
289 | "Return character @var{k} of @var{str} using zero-origin\n" |
290 | "indexing. @var{k} must be a valid index of @var{str}.") | |
1bbd0b84 | 291 | #define FUNC_NAME s_scm_string_ref |
0f2d19dd | 292 | { |
c014a02e | 293 | long idx; |
bd9e24b3 | 294 | |
d1ca2c64 | 295 | SCM_VALIDATE_STRING (1, str); |
bd9e24b3 | 296 | SCM_VALIDATE_INUM_COPY (2, k, idx); |
d1ca2c64 | 297 | SCM_ASSERT_RANGE (2, k, idx >= 0 && idx < SCM_STRING_LENGTH (str)); |
34f0f2b8 | 298 | return SCM_MAKE_CHAR (SCM_STRING_UCHARS (str)[idx]); |
0f2d19dd | 299 | } |
1bbd0b84 | 300 | #undef FUNC_NAME |
0f2d19dd | 301 | |
f0942910 | 302 | |
3b3b36dd | 303 | SCM_DEFINE (scm_string_set_x, "string-set!", 3, 0, 0, |
6fa73e72 | 304 | (SCM str, SCM k, SCM chr), |
0d26a824 MG |
305 | "Store @var{chr} in element @var{k} of @var{str} and return\n" |
306 | "an unspecified value. @var{k} must be a valid index of\n" | |
307 | "@var{str}.") | |
1bbd0b84 | 308 | #define FUNC_NAME s_scm_string_set_x |
0f2d19dd | 309 | { |
f0942910 DH |
310 | #if (SCM_DEBUG_DEPRECATED == 0) |
311 | SCM_VALIDATE_RWSTRING (1, str); | |
312 | #else | |
313 | SCM_VALIDATE_STRING (1, str); | |
314 | #endif | |
bfa974f0 | 315 | SCM_VALIDATE_INUM_RANGE (2,k,0,SCM_STRING_LENGTH(str)); |
7866a09b | 316 | SCM_VALIDATE_CHAR (3,chr); |
322ac0c5 | 317 | SCM_STRING_UCHARS (str)[SCM_INUM (k)] = SCM_CHAR (chr); |
0f2d19dd JB |
318 | return SCM_UNSPECIFIED; |
319 | } | |
1bbd0b84 | 320 | #undef FUNC_NAME |
0f2d19dd JB |
321 | |
322 | ||
3b3b36dd | 323 | SCM_DEFINE (scm_substring, "substring", 2, 1, 0, |
0d26a824 MG |
324 | (SCM str, SCM start, SCM end), |
325 | "Return a newly allocated string formed from the characters\n" | |
326 | "of @var{str} beginning with index @var{start} (inclusive) and\n" | |
327 | "ending with index @var{end} (exclusive).\n" | |
328 | "@var{str} must be a string, @var{start} and @var{end} must be\n" | |
329 | "exact integers satisfying:\n\n" | |
330 | "0 <= @var{start} <= @var{end} <= (string-length @var{str}).") | |
1bbd0b84 | 331 | #define FUNC_NAME s_scm_substring |
0f2d19dd | 332 | { |
c014a02e ML |
333 | long int from; |
334 | long int to; | |
685c0d71 | 335 | |
d1ca2c64 | 336 | SCM_VALIDATE_STRING (1, str); |
685c0d71 | 337 | SCM_VALIDATE_INUM (2, start); |
d1ca2c64 | 338 | SCM_VALIDATE_INUM_DEF (3, end, SCM_STRING_LENGTH (str)); |
685c0d71 DH |
339 | |
340 | from = SCM_INUM (start); | |
d1ca2c64 | 341 | SCM_ASSERT_RANGE (2, start, 0 <= from && from <= SCM_STRING_LENGTH (str)); |
685c0d71 | 342 | to = SCM_INUM (end); |
d1ca2c64 | 343 | SCM_ASSERT_RANGE (3, end, from <= to && to <= SCM_STRING_LENGTH (str)); |
685c0d71 | 344 | |
1be6b49c | 345 | return scm_makfromstr (&SCM_STRING_CHARS (str)[from], (size_t) (to - from), 0); |
0f2d19dd | 346 | } |
1bbd0b84 | 347 | #undef FUNC_NAME |
0f2d19dd | 348 | |
685c0d71 | 349 | |
3b3b36dd | 350 | SCM_DEFINE (scm_string_append, "string-append", 0, 0, 1, |
6fa73e72 | 351 | (SCM args), |
0d26a824 MG |
352 | "Return a newly allocated string whose characters form the\n" |
353 | "concatenation of the given strings, @var{args}.") | |
1bbd0b84 | 354 | #define FUNC_NAME s_scm_string_append |
0f2d19dd JB |
355 | { |
356 | SCM res; | |
1be6b49c | 357 | size_t i = 0; |
0f2d19dd | 358 | register SCM l, s; |
a65b9c80 | 359 | register unsigned char *data; |
af45e3b0 DH |
360 | |
361 | SCM_VALIDATE_REST_ARGUMENT (args); | |
362 | for (l = args; !SCM_NULLP (l); l = SCM_CDR (l)) { | |
0f2d19dd | 363 | s = SCM_CAR (l); |
d1ca2c64 DH |
364 | SCM_VALIDATE_STRING (SCM_ARGn,s); |
365 | i += SCM_STRING_LENGTH (s); | |
0f2d19dd | 366 | } |
be54b15d | 367 | res = scm_allocate_string (i); |
322ac0c5 | 368 | data = SCM_STRING_UCHARS (res); |
0f2d19dd JB |
369 | for (l = args;SCM_NIMP (l);l = SCM_CDR (l)) { |
370 | s = SCM_CAR (l); | |
34f0f2b8 | 371 | for (i = 0;i<SCM_STRING_LENGTH (s);i++) *data++ = SCM_STRING_UCHARS (s)[i]; |
0f2d19dd JB |
372 | } |
373 | return res; | |
374 | } | |
1bbd0b84 | 375 | #undef FUNC_NAME |
0f2d19dd | 376 | |
e53cc817 MD |
377 | #if SCM_DEBUG_DEPRECATED == 0 |
378 | ||
379 | /* Explicit shared substrings will disappear from Guile. | |
380 | * | |
381 | * Instead, "normal" strings will be implemented using sharing | |
382 | * internally, combined with a copy-on-write strategy. | |
383 | */ | |
384 | ||
3b3b36dd | 385 | SCM_DEFINE (scm_make_shared_substring, "make-shared-substring", 1, 2, 0, |
1e6808ea | 386 | (SCM str, SCM start, SCM end), |
40f83c3e | 387 | "Return a shared substring of @var{str}. The arguments are the\n" |
1e6808ea MG |
388 | "same as for the @code{substring} function: the shared substring\n" |
389 | "returned includes all of the text from @var{str} between\n" | |
390 | "indexes @var{start} (inclusive) and @var{end} (exclusive). If\n" | |
391 | "@var{end} is omitted, it defaults to the end of @var{str}. The\n" | |
392 | "shared substring returned by @code{make-shared-substring}\n" | |
393 | "occupies the same storage space as @var{str}.") | |
1bbd0b84 | 394 | #define FUNC_NAME s_scm_make_shared_substring |
0f2d19dd | 395 | { |
c014a02e ML |
396 | long f; |
397 | long t; | |
0f2d19dd JB |
398 | SCM answer; |
399 | SCM len_str; | |
400 | ||
3b3b36dd | 401 | SCM_VALIDATE_ROSTRING (1,str); |
1e6808ea MG |
402 | SCM_VALIDATE_INUM_DEF_COPY (2,start,0,f); |
403 | SCM_VALIDATE_INUM_DEF_COPY (3,end,SCM_ROLENGTH(str),t); | |
0f2d19dd | 404 | |
1e6808ea MG |
405 | SCM_ASSERT_RANGE (2,start,(f >= 0)); |
406 | SCM_ASSERT_RANGE (3,end, (f <= t) && (t <= SCM_ROLENGTH (str))); | |
0f2d19dd JB |
407 | |
408 | SCM_NEWCELL (answer); | |
409 | SCM_NEWCELL (len_str); | |
410 | ||
411 | SCM_DEFER_INTS; | |
412 | if (SCM_SUBSTRP (str)) | |
413 | { | |
c014a02e | 414 | long offset; |
0f2d19dd JB |
415 | offset = SCM_INUM (SCM_SUBSTR_OFFSET (str)); |
416 | f += offset; | |
417 | t += offset; | |
418 | SCM_SETCAR (len_str, SCM_MAKINUM (f)); | |
419 | SCM_SETCDR (len_str, SCM_SUBSTR_STR (str)); | |
420 | SCM_SETCDR (answer, len_str); | |
421 | SCM_SETLENGTH (answer, t - f, scm_tc7_substring); | |
422 | } | |
423 | else | |
424 | { | |
425 | SCM_SETCAR (len_str, SCM_MAKINUM (f)); | |
426 | SCM_SETCDR (len_str, str); | |
427 | SCM_SETCDR (answer, len_str); | |
428 | SCM_SETLENGTH (answer, t - f, scm_tc7_substring); | |
429 | } | |
430 | SCM_ALLOW_INTS; | |
431 | return answer; | |
432 | } | |
1bbd0b84 | 433 | #undef FUNC_NAME |
1cc91f1b | 434 | |
e53cc817 MD |
435 | #endif /* DEPRECATED */ |
436 | ||
0f2d19dd JB |
437 | void |
438 | scm_init_strings () | |
0f2d19dd | 439 | { |
7c33806a DH |
440 | scm_nullstr = scm_allocate_string (0); |
441 | ||
8dc9439f | 442 | #ifndef SCM_MAGIC_SNARFER |
a0599745 | 443 | #include "libguile/strings.x" |
8dc9439f | 444 | #endif |
0f2d19dd JB |
445 | } |
446 | ||
89e00824 ML |
447 | |
448 | /* | |
449 | Local Variables: | |
450 | c-file-style: "gnu" | |
451 | End: | |
452 | */ |