* strings.h, deprecated.h (SCM_STRING_COERCE_0TERMINATION_X):
[bpt/guile.git] / libguile / strings.h
1 /* classes: h_files */
2
3 #ifndef SCM_STRINGS_H
4 #define SCM_STRINGS_H
5
6 /* Copyright (C) 1995,1996,1997,1998,2000,2001 Free Software Foundation, Inc.
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 \f
24
25 #include "libguile/__scm.h"
26
27 \f
28
29 #define SCM_STRING_MAX_LENGTH ((SCM_T_BITS_MAX-255)/256)
30
31 #define SCM_I_MAKE_STRING_TAG(l) ((((scm_t_bits) (l)) << 8) + scm_tc7_string)
32 #define SCM_I_STRINGP(x) (!SCM_IMP (x) && (SCM_TYP7 (x) == scm_tc7_string))
33 #define SCM_I_STRING_UCHARS(x) ((unsigned char *) (SCM_CELL_WORD_1 (x)))
34 #define SCM_I_STRING_CHARS(x) ((char *) (SCM_CELL_WORD_1 (x)))
35 #define SCM_I_STRING_LENGTH(x) ((size_t) (SCM_CELL_WORD_0 (x) >> 8))
36
37 #define SCM_STRINGP SCM_I_STRINGP
38 #define SCM_STRING_CHARS SCM_I_STRING_CHARS
39 #define SCM_STRING_UCHARS SCM_I_STRING_UCHARS
40 #define SCM_STRING_LENGTH SCM_I_STRING_LENGTH
41
42 \f
43
44 SCM_API SCM scm_string_p (SCM x);
45 SCM_API SCM scm_string (SCM chrs);
46 SCM_API SCM scm_make_string (SCM k, SCM chr);
47 SCM_API SCM scm_string_length (SCM str);
48 SCM_API SCM scm_string_ref (SCM str, SCM k);
49 SCM_API SCM scm_string_set_x (SCM str, SCM k, SCM chr);
50 SCM_API SCM scm_substring (SCM str, SCM start, SCM end);
51 SCM_API SCM scm_string_append (SCM args);
52
53 SCM_API SCM scm_makfromstrs (int argc, char **argv);
54 SCM_API SCM scm_take_str (char *s, size_t len);
55 SCM_API SCM scm_take0str (char *s);
56 SCM_API SCM scm_mem2string (const char *src, size_t len);
57 SCM_API SCM scm_str2string (const char *src);
58 SCM_API SCM scm_makfrom0str (const char *src);
59 SCM_API SCM scm_makfrom0str_opt (const char *src);
60 SCM_API SCM scm_allocate_string (size_t len);
61
62 SCM_API int scm_is_string (SCM x);
63 SCM_API SCM scm_from_locale_string (const char *str);
64 SCM_API SCM scm_from_locale_stringn (const char *str, size_t len);
65 SCM_API SCM scm_take_locale_string (char *str);
66 SCM_API SCM scm_take_locale_stringn (char *str, size_t len);
67 SCM_API char *scm_to_locale_string (SCM str);
68 SCM_API char *scm_to_locale_stringn (SCM str, size_t *lenp);
69 SCM_API size_t scm_to_locale_stringbuf (SCM str, char *buf, size_t max_len);
70
71 /* internal utility functions. */
72
73 SCM_API char **scm_i_allocate_string_pointers (SCM list);
74 SCM_API void scm_i_free_string_pointers (char **pointers);
75
76 SCM_API void scm_init_strings (void);
77
78 #endif /* SCM_STRINGS_H */
79
80 /*
81 Local Variables:
82 c-file-style: "gnu"
83 End:
84 */