1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 #include "memcasecmp.h"
28 #include "xvasprintf.h"
32 void buf_reverse (char *, size_t);
33 char *buf_find_reverse (const char *, size_t, const char *, size_t);
34 int buf_compare_case (const char *, const char *, size_t);
35 int buf_compare_rpad (const char *, size_t, const char *, size_t);
36 void buf_copy_lpad (char *, size_t, const char *, size_t);
37 void buf_copy_rpad (char *, size_t, const char *, size_t);
38 void buf_copy_str_lpad (char *, size_t, const char *);
39 void buf_copy_str_rpad (char *, size_t, const char *);
41 int str_compare_rpad (const char *, const char *);
42 void str_copy_rpad (char *, size_t, const char *);
43 void str_copy_trunc (char *, size_t, const char *);
44 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
45 void str_uppercase (char *);
46 void str_lowercase (char *);
48 char *spprintf (char *dst, const char *format, ...);
50 void *mempset (void *, int, size_t);
52 /* Common character classes for use with substring and string functions. */
54 #define CC_SPACES " \t\v\r\n"
55 #define CC_DIGITS "0123456789"
56 #define CC_XDIGITS "0123456789abcdefABCDEF"
57 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
58 #define CC_ALNUM CC_LETTERS CC_DIGITS
67 #define SS_EMPTY_INITIALIZER {NULL, 0}
68 #define SS_LITERAL_INITIALIZER(LITERAL) \
69 {(char *) LITERAL, (sizeof LITERAL) - 1}
72 These functions do not allocate any memory, so the substrings
73 they create should not normally be destroyed. */
74 struct substring ss_empty (void);
75 struct substring ss_cstr (const char *);
76 struct substring ss_buffer (const char *, size_t);
77 struct substring ss_substr (struct substring, size_t start, size_t);
78 struct substring ss_head (struct substring, size_t);
79 struct substring ss_tail (struct substring, size_t);
81 /* Constructors and destructor that allocate and deallocate
84 void ss_alloc_substring (struct substring *, struct substring);
85 void ss_alloc_uninit (struct substring *, size_t);
86 void ss_alloc_substring_pool (struct substring *, struct substring,
88 void ss_alloc_uninit_pool (struct substring *, size_t, struct pool *);
89 void ss_dealloc (struct substring *);
92 Functions that advance the beginning of a string should not be
93 used if a substring is to be deallocated. */
94 void ss_truncate (struct substring *, size_t);
95 size_t ss_rtrim (struct substring *, struct substring trim_set);
96 size_t ss_ltrim (struct substring *, struct substring trim_set);
97 void ss_trim (struct substring *, struct substring trim_set);
98 bool ss_chomp (struct substring *, char);
99 bool ss_separate (struct substring src, struct substring delimiters,
100 size_t *save_idx, struct substring *token);
101 bool ss_tokenize (struct substring src, struct substring delimiters,
102 size_t *save_idx, struct substring *token);
103 void ss_advance (struct substring *, size_t);
104 bool ss_match_char (struct substring *, char);
105 bool ss_match_string (struct substring *, const struct substring);
106 int ss_get_char (struct substring *);
107 size_t ss_get_chars (struct substring *, size_t cnt, struct substring *);
108 bool ss_get_until (struct substring *, char delimiter, struct substring *);
109 size_t ss_get_long (struct substring *, long *);
112 bool ss_is_empty (struct substring);
113 size_t ss_length (struct substring);
114 char *ss_data (struct substring);
115 char *ss_end (struct substring);
116 int ss_at (struct substring, size_t idx);
117 int ss_first (struct substring);
118 int ss_last (struct substring);
119 size_t ss_span (struct substring, struct substring skip_set);
120 size_t ss_cspan (struct substring, struct substring stop_set);
121 size_t ss_find_char (struct substring, char);
122 int ss_compare (struct substring, struct substring);
123 int ss_compare_case (struct substring, struct substring);
124 int ss_equals (struct substring, struct substring);
125 int ss_equals_case (struct substring, struct substring);
126 size_t ss_pointer_to_position (struct substring, const char *);
127 char *ss_xstrdup (struct substring);
129 /* Variable length strings. */
135 size_t capacity; /* Allocated capacity, not including one
136 extra byte allocated for null terminator. */
139 #define DS_EMPTY_INITIALIZER {SS_EMPTY_INITIALIZER, 0}
141 /* Constructors, destructors. */
142 void ds_init_empty (struct string *);
143 void ds_init_string (struct string *, const struct string *);
144 void ds_init_substring (struct string *, struct substring);
145 void ds_init_cstr (struct string *, const char *);
146 void ds_destroy (struct string *);
147 void ds_swap (struct string *, struct string *);
151 void ds_register_pool (struct string *, struct pool *);
152 void ds_unregister_pool (struct string *, struct pool *);
155 void ds_assign_string (struct string *, const struct string *);
156 void ds_assign_substring (struct string *, struct substring);
157 void ds_assign_cstr (struct string *, const char *);
159 /* Shrink, extend. */
160 void ds_clear (struct string *);
161 void ds_extend (struct string *, size_t);
162 void ds_shrink (struct string *);
163 void ds_truncate (struct string *, size_t);
165 /* Padding, trimming. */
166 size_t ds_rtrim (struct string *, struct substring trim_set);
167 size_t ds_ltrim (struct string *, struct substring trim_set);
168 size_t ds_trim (struct string *, struct substring trim_set);
169 bool ds_chomp (struct string *, char);
170 bool ds_separate (const struct string *src, struct substring delimiters,
171 size_t *save_idx, struct substring *token);
172 bool ds_tokenize (const struct string *src, struct substring delimiters,
173 size_t *save_idx, struct substring *token);
174 void ds_rpad (struct string *, size_t length, char pad);
175 void ds_set_length (struct string *, size_t new_length, char pad);
177 /* Extracting substrings. */
178 struct substring ds_ss (const struct string *);
179 struct substring ds_substr (const struct string *, size_t start, size_t);
180 struct substring ds_head (const struct string *, size_t);
181 struct substring ds_tail (const struct string *, size_t);
184 bool ds_is_empty (const struct string *);
185 size_t ds_length (const struct string *);
186 char *ds_data (const struct string *);
187 char *ds_end (const struct string *);
188 int ds_at (const struct string *, size_t idx);
189 int ds_first (const struct string *);
190 int ds_last (const struct string *);
191 size_t ds_span (const struct string *, struct substring skip_set);
192 size_t ds_cspan (const struct string *, struct substring stop_set);
193 size_t ds_find_char (const struct string *, char);
194 int ds_compare (const struct string *, const struct string *);
195 size_t ds_pointer_to_position (const struct string *, const char *);
196 char *ds_xstrdup (const struct string *);
198 size_t ds_capacity (const struct string *);
199 char *ds_cstr (const struct string *);
202 bool ds_read_line (struct string *, FILE *);
203 bool ds_read_config_line (struct string *, int *line_number, FILE *);
204 size_t ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
207 void ds_put_char (struct string *, int ch);
208 void ds_put_char_multiple (struct string *, int ch, size_t);
209 void ds_put_cstr (struct string *, const char *);
210 void ds_put_substring (struct string *, struct substring);
211 void ds_put_vformat (struct string *st, const char *, va_list)
212 PRINTF_FORMAT (2, 0);
213 void ds_put_format (struct string *, const char *, ...)
214 PRINTF_FORMAT (2, 3);
215 char *ds_put_uninit (struct string *st, size_t incr);