1 /* classes: src_files */
3 /* Copyright (C) 1994, 1996, 1997, 1999, 2000 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this software; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
21 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
27 #include "libguile/_scm.h"
28 #include "libguile/chars.h"
29 #include "libguile/strings.h"
31 #include "libguile/validate.h"
32 #include "libguile/strop.h"
33 #include "libguile/read.h" /*For SCM_CASE_INSENSITIVE_P*/
42 xSCM_DEFINE (scm_i_index, "i-index", 2, 2, 0,
43 (SCM str, SCM chr, SCM frm, SCM to),
44 "@deftypefn {Internal C Function} {static int} scm_i_index (SCM *@var{str}, \n"
45 "SCM @var{chr}, int @var{direction}, SCM @var{sub_start}, SCM @var{sub_end}, char *@var{why})
46 "This is a workhorse function that performs either an @code{index} or\n"
47 "@code{rindex} function, depending on the value of @var{direction}. I'm\n"
48 "not at all clear on the usage of the pos arguments, though the purpose\n"
49 "seems to be correct reporting of which argument values are reporting\n"
50 "errors. Why you would do that, rather than just use @code{SCM_ARG[1234]}\n"
51 "explicitly is beyond me. Anyone holding any enlightenment?"
53 /* implements index if direction > 0 otherwise rindex. */
55 scm_i_index (SCM
*str
, SCM chr
, int direction
, SCM sub_start
,
56 SCM sub_end
, const char *why
)
64 SCM_ASSERT (SCM_ROSTRINGP (*str
), *str
, SCM_ARG1
, why
);
65 SCM_ASSERT (SCM_CHARP (chr
), chr
, SCM_ARG2
, why
);
67 if (SCM_FALSEP (sub_start
))
68 sub_start
= SCM_MAKINUM (0);
70 SCM_ASSERT (SCM_INUMP (sub_start
), sub_start
, SCM_ARG3
, why
);
71 lower
= SCM_INUM (sub_start
);
73 || lower
> SCM_ROLENGTH (*str
))
74 scm_out_of_range (why
, sub_start
);
76 if (SCM_FALSEP (sub_end
))
77 sub_end
= SCM_MAKINUM (SCM_ROLENGTH (*str
));
79 SCM_ASSERT (SCM_INUMP (sub_end
), sub_end
, SCM_ARG4
, why
);
80 upper
= SCM_INUM (sub_end
);
81 if (upper
< SCM_INUM (sub_start
)
82 || upper
> SCM_ROLENGTH (*str
))
83 scm_out_of_range (why
, sub_end
);
87 p
= (unsigned char *)SCM_ROCHARS (*str
) + lower
;
90 for (x
= SCM_INUM (sub_start
); x
< upper
; ++x
, ++p
)
96 p
= upper
- 1 + (unsigned char *)SCM_ROCHARS (*str
);
98 for (x
= upper
- 1; x
>= lower
; --x
, --p
)
106 SCM_DEFINE (scm_string_index
, "string-index", 2, 2, 0,
107 (SCM str
, SCM chr
, SCM frm
, SCM to
),
108 "Return the index of the first occurrence of @var{chr} in @var{str}. The\n"
109 "optional integer arguments @var{frm} and @var{to} limit the search to\n"
110 "a portion of the string. This procedure essentially implements the\n"
111 "@code{index} or @code{strchr} functions from the C library.\n\n"
112 "(qdocs:) Returns the index of @var{char} in @var{str}, or @code{#f} if the\n"
113 "@var{char} isn't in @var{str}. If @var{frm} is given and not @code{#f},\n"
114 "it is used as the starting index; if @var{to} is given and not @var{#f},\n"
115 "it is used as the ending index (exclusive).\n\n"
117 "(string-index "weiner
" #\e)\n"
119 "(string-index "weiner
" #\e 2)\n"
121 "(string-index "weiner
" #\e 2 4)\n"
124 #define FUNC_NAME s_scm_string_index
128 if (SCM_UNBNDP (frm
))
132 pos
= scm_i_index (&str
, chr
, 1, frm
, to
, FUNC_NAME
);
135 : SCM_MAKINUM (pos
));
139 SCM_DEFINE (scm_string_rindex
, "string-rindex", 2, 2, 0,
140 (SCM str
, SCM chr
, SCM frm
, SCM to
),
141 "Like @code{string-index}, but search from the right of the string rather\n"
142 "than from the left. This procedure essentially implements the\n"
143 "@code{rindex} or @code{strrchr} functions from the C library.\n\n"
144 "(qdocs:) The same as @code{string-index}, except it gives the rightmost occurance\n"
145 "of @var{char} in the range [@var{frm}, @var{to}-1], which defaults to\n"
146 "the entire string.\n\n"
148 "(string-rindex "weiner
" #\e)\n"
150 "(string-rindex "weiner
" #\e 2 4)\n"
152 "(string-rindex "weiner
" #\e 2 5)\n"
155 #define FUNC_NAME s_scm_string_rindex
159 if (SCM_UNBNDP (frm
))
163 pos
= scm_i_index (&str
, chr
, -1, frm
, to
, FUNC_NAME
);
166 : SCM_MAKINUM (pos
));
171 SCM_REGISTER_PROC(s_substring_move_left_x
, "substring-move-left!", 5, 0, 0, scm_substring_move_x
);
172 SCM_REGISTER_PROC(s_substring_move_right_x
, "substring-move-right!", 5, 0, 0, scm_substring_move_x
);
175 @defun substring-move-left! str1 start1 end1 str2 start2
177 @deftypefn {C Function} SCM scm_substring_move_left_x (SCM @var{str1}, SCM @var{start1}, SCM @var{end1}, SCM @var{str2}, SCM @var{start2})
178 [@strong{Note:} this is only valid if you've applied the strop patch].
180 Moves a substring of @var{str1}, from @var{start1} to @var{end1}
181 (@var{end1} is exclusive), into @var{str2}, starting at
182 @var{start2}. Allows overlapping strings.
185 (define x (make-string 10 #\a))
187 (substring-move-left! x 2 5 y 0)
192 @result{} "aaaaaaaaaa"
195 (substring-move-left! x 2 5 y 0)
200 (substring-move-left! y 2 5 y 3)
207 @defun substring-move-right! str1 start1 end1 str2 start2
209 @deftypefn {C Function} SCM scm_substring_move_right_x (SCM @var{str1}, SCM @var{start1}, SCM @var{end1}, SCM @var{str2}, SCM @var{start2})
210 [@strong{Note:} this is only valid if you've applied the strop patch, if
211 it hasn't made it into the guile tree].
213 Does much the same thing as @code{substring-move-left!}, except it
214 starts moving at the end of the sequence, rather than the beginning.
217 (substring-move-right! y 2 5 y 0)
222 (substring-move-right! y 2 5 y 3)
228 SCM_DEFINE (scm_substring_move_x
, "substring-move!", 5, 0, 0,
229 (SCM str1
, SCM start1
, SCM end1
, SCM str2
, SCM start2
),
230 "Copy the substring of @var{str1} bounded by @var{start1} and @var{end1}\n"
231 "into @var{str2} beginning at position @var{end2}.\n"
232 "@code{substring-move-right!} begins copying from the rightmost character\n"
233 "and moves left, and @code{substring-move-left!} copies from the leftmost\n"
234 "character moving right.\n\n"
235 "It is useful to have two functions that copy in different directions so\n"
236 "that substrings can be copied back and forth within a single string. If\n"
237 "you wish to copy text from the left-hand side of a string to the\n"
238 "right-hand side of the same string, and the source and destination\n"
239 "overlap, you must be careful to copy the rightmost characters of the\n"
240 "text first, to avoid clobbering your data. Hence, when @var{str1} and\n"
241 "@var{str2} are the same string, you should use\n"
242 "@code{substring-move-right!} when moving text from left to right, and\n"
243 "@code{substring-move-left!} otherwise. If @code{str1} and @samp{str2}\n"
244 "are different strings, it does not matter which function you use.")
245 #define FUNC_NAME s_scm_substring_move_x
249 SCM_VALIDATE_STRING (1,str1
);
250 SCM_VALIDATE_INUM_COPY (2,start1
,s1
);
251 SCM_VALIDATE_INUM_COPY (3,end1
,e
);
252 SCM_VALIDATE_STRING (4,str2
);
253 SCM_VALIDATE_INUM_COPY (5,start2
,s2
);
255 SCM_ASSERT_RANGE (3,end1
,len
>= 0);
256 SCM_ASSERT_RANGE (2,start1
,s1
<= SCM_LENGTH (str1
) && s1
>= 0);
257 SCM_ASSERT_RANGE (5,start2
,s2
<= SCM_LENGTH (str2
) && s2
>= 0);
258 SCM_ASSERT_RANGE (3,end1
,e
<= SCM_LENGTH (str1
) && e
>= 0);
259 SCM_ASSERT_RANGE (5,start2
,len
+s2
<= SCM_LENGTH (str2
));
261 SCM_SYSCALL(memmove((void *)(&(SCM_CHARS(str2
)[s2
])),
262 (void *)(&(SCM_CHARS(str1
)[s1
])),
265 return scm_return_first(SCM_UNSPECIFIED
, str1
, str2
);
270 SCM_DEFINE (scm_substring_fill_x
, "substring-fill!", 4, 0, 0,
271 (SCM str
, SCM start
, SCM end
, SCM fill
),
272 "Change every character in @var{str} between @var{start} and @var{end} to\n"
273 "@var{fill-char}.\n\n"
274 "(qdocs:) Destructively fills @var{str}, from @var{start} to @var{end}, with @var{fill}.\n\n"
276 "(define y \"abcdefg\")\n"
277 "(substring-fill! y 1 3 #\r)\n"
279 "@result{} \"arrdefg\"\n"
281 #define FUNC_NAME s_scm_substring_fill_x
285 SCM_VALIDATE_STRING (1,str
);
286 SCM_VALIDATE_INUM_COPY (2,start
,i
);
287 SCM_VALIDATE_INUM_COPY (3,end
,e
);
288 SCM_VALIDATE_CHAR_COPY (4,fill
,c
);
289 SCM_ASSERT_RANGE (2,start
,i
<= SCM_LENGTH (str
) && i
>= 0);
290 SCM_ASSERT_RANGE (3,end
,e
<= SCM_LENGTH (str
) && e
>= 0);
291 while (i
<e
) SCM_CHARS (str
)[i
++] = c
;
292 return SCM_UNSPECIFIED
;
297 SCM_DEFINE (scm_string_null_p
, "string-null?", 1, 0, 0,
299 "Return @code{#t} if @var{str}'s length is nonzero, and @code{#f}\n"
301 "(qdocs:) Returns @code{#t} if @var{str} is empty, else returns @code{#f}.\n\n"
303 "(string-null? \"\")\n"
308 #define FUNC_NAME s_scm_string_null_p
310 SCM_VALIDATE_ROSTRING (1,str
);
311 return SCM_NEGATE_BOOL(SCM_ROLENGTH (str
));
316 SCM_DEFINE (scm_string_to_list
, "string->list", 1, 0, 0,
318 "@samp{String->list} returns a newly allocated list of the\n"
319 "characters that make up the given string. @samp{List->string}\n"
320 "returns a newly allocated string formed from the characters in the list\n"
321 "@var{list}, which must be a list of characters. @samp{String->list}\n"
322 "and @samp{list->string} are\n"
323 "inverses so far as @samp{equal?} is concerned. (r5rs)")
324 #define FUNC_NAME s_scm_string_to_list
329 SCM_VALIDATE_ROSTRING (1,str
);
330 src
= SCM_ROUCHARS (str
);
331 for (i
= SCM_ROLENGTH (str
)-1;i
>= 0;i
--) res
= scm_cons (SCM_MAKE_CHAR (src
[i
]), res
);
338 SCM_DEFINE (scm_string_copy
, "string-copy", 1, 0, 0,
340 "Returns a newly allocated copy of the given @var{string}. (r5rs)")
341 #define FUNC_NAME s_scm_string_copy
343 SCM_VALIDATE_STRINGORSUBSTR (1,str
);
344 return scm_makfromstr (SCM_ROCHARS (str
), (scm_sizet
)SCM_ROLENGTH (str
), 0);
349 SCM_DEFINE (scm_string_fill_x
, "string-fill!", 2, 0, 0,
351 "Stores @var{char} in every element of the given @var{string} and returns an\n"
352 "unspecified value. (r5rs)")
353 #define FUNC_NAME s_scm_string_fill_x
355 register char *dst
, c
;
357 SCM_VALIDATE_STRING_COPY (1,str
,dst
);
358 SCM_VALIDATE_CHAR_COPY (2,chr
,c
);
359 for (k
= SCM_LENGTH (str
)-1;k
>= 0;k
--) dst
[k
] = c
;
360 return SCM_UNSPECIFIED
;
364 SCM_DEFINE (scm_string_upcase_x
, "string-upcase!", 1, 0, 0,
366 "Destructively upcase every character in @code{str}.\n\n"
367 "(qdocs:) Converts each element in @var{str} to upper case.\n\n"
369 "(string-upcase! y)\n"
370 "@result{} \"ARRDEFG\"\n\n"
372 "@result{} \"ARRDEFG\"\n"
374 #define FUNC_NAME s_scm_string_upcase_x
377 register unsigned char *cs
;
378 SCM_ASRTGO (SCM_NIMP (v
), badarg1
);
386 cs
[k
] = scm_upcase(cs
[k
]);
389 badarg1
:SCM_WTA (1,v
);
395 SCM_DEFINE (scm_string_upcase
, "string-upcase", 1, 0, 0,
397 "Upcase every character in @code{str}.")
398 #define FUNC_NAME s_scm_string_upcase
400 return scm_string_upcase_x(scm_string_copy(str
));
404 SCM_DEFINE (scm_string_downcase_x
, "string-downcase!", 1, 0, 0,
406 "Destructively downcase every character in @code{str}.\n\n"
407 "(qdocs:) Converts each element in @var{str} to lower case.\n\n"
410 "@result{} \"ARRDEFG\"\n\n"
411 "(string-downcase! y)\n"
412 "@result{} \"arrdefg\"\n\n"
414 "@result{} \"arrdefg\"\n"
416 #define FUNC_NAME s_scm_string_downcase_x
419 register unsigned char *cs
;
420 SCM_ASRTGO (SCM_NIMP (v
), badarg1
);
427 cs
[k
] = scm_downcase(cs
[k
]);
430 badarg1
:SCM_WTA (1,v
);
436 SCM_DEFINE (scm_string_downcase
, "string-downcase", 1, 0, 0,
438 "Downcase every character in @code{str}.")
439 #define FUNC_NAME s_scm_string_downcase
441 SCM_VALIDATE_STRING (1,str
);
442 return scm_string_downcase_x(scm_string_copy(str
));
446 SCM_DEFINE (scm_string_capitalize_x
, "string-capitalize!", 1, 0, 0,
448 "Destructively capitalize every character in @code{str}.")
449 #define FUNC_NAME s_scm_string_capitalize_x
452 int i
, len
, in_word
=0;
453 SCM_VALIDATE_STRING (1,str
);
454 len
= SCM_LENGTH(str
);
456 for(i
=0; i
<len
; i
++) {
457 if(SCM_NFALSEP(scm_char_alphabetic_p(SCM_MAKE_CHAR(sz
[i
])))) {
459 sz
[i
] = scm_upcase(sz
[i
]);
462 sz
[i
] = scm_downcase(sz
[i
]);
471 SCM_DEFINE (scm_string_capitalize
, "string-capitalize", 1, 0, 0,
473 "Capitalize every character in @code{str}.")
474 #define FUNC_NAME s_scm_string_capitalize
476 SCM_VALIDATE_STRING (1,str
);
477 return scm_string_capitalize_x(scm_string_copy(str
));
481 SCM_DEFINE (scm_string_ci_to_symbol
, "string-ci->symbol", 1, 0, 0,
483 "Return the symbol whose name is @var{str}, downcased in necessary(???).")
484 #define FUNC_NAME s_scm_string_ci_to_symbol
486 return scm_string_to_symbol (SCM_CASE_INSENSITIVE_P
487 ? scm_string_downcase(str
)
495 #include "libguile/strop.x"