1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2014 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/>. */
29 #include "memcasecmp.h"
31 #include "xvasprintf.h"
33 #include "gl/xalloc.h"
39 void buf_reverse (char *, size_t);
40 int buf_compare_case (const char *, const char *, size_t);
41 int buf_compare_rpad (const char *, size_t, const char *, size_t);
42 void buf_copy_lpad (char *, size_t, const char *, size_t, char pad);
43 void buf_copy_rpad (char *, size_t, const char *, size_t, char pad);
44 void buf_copy_str_lpad (char *, size_t, const char *, char pad);
45 void buf_copy_str_rpad (char *, size_t, const char *, char pad);
47 int str_compare_rpad (const char *, const char *);
48 void str_copy_rpad (char *, size_t, const char *);
49 void str_copy_trunc (char *, size_t, const char *);
50 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
51 void str_uppercase (char *);
52 void str_lowercase (char *);
54 bool str_format_26adic (unsigned long int number, bool uppercase,
55 char buffer[], size_t);
57 void str_ellipsize (struct substring in, char *out, size_t out_size);
59 static inline char *xstrdup_if_nonnull (const char *);
61 void *mempset (void *, int, size_t);
63 /* Common character classes for use with substring and string functions. */
65 #define CC_SPACES " \t\v\r\n"
66 #define CC_DIGITS "0123456789"
67 #define CC_XDIGITS "0123456789abcdefABCDEF"
68 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
69 #define CC_ALNUM CC_LETTERS CC_DIGITS
78 #define SS_EMPTY_INITIALIZER {NULL, 0}
79 #define SS_LITERAL_INITIALIZER(LITERAL) \
80 {(char *) LITERAL, (sizeof LITERAL) - 1}
83 These functions do not allocate any memory, so the substrings
84 they create should not normally be destroyed. */
85 static inline struct substring ss_empty (void);
86 static inline struct substring ss_cstr (const char *);
87 static inline struct substring ss_buffer (const char *, size_t);
88 struct substring ss_substr (struct substring, size_t start, size_t);
89 struct substring ss_head (struct substring, size_t);
90 struct substring ss_tail (struct substring, size_t);
92 /* Constructors and destructor that allocate and deallocate
95 void ss_alloc_substring (struct substring *, struct substring);
96 void ss_alloc_uninit (struct substring *, size_t);
97 void ss_realloc (struct substring *, size_t);
98 void ss_alloc_substring_pool (struct substring *, struct substring,
100 void ss_alloc_uninit_pool (struct substring *, size_t, struct pool *);
101 void ss_dealloc (struct substring *);
104 Functions that advance the beginning of a string should not be
105 used if a substring is to be deallocated. */
106 void ss_truncate (struct substring *, size_t);
107 size_t ss_rtrim (struct substring *, struct substring trim_set);
108 size_t ss_ltrim (struct substring *, struct substring trim_set);
109 void ss_trim (struct substring *, struct substring trim_set);
110 bool ss_chomp_byte (struct substring *, char);
111 bool ss_chomp (struct substring *, struct substring);
112 bool ss_separate (struct substring src, struct substring delimiters,
113 size_t *save_idx, struct substring *token);
114 bool ss_tokenize (struct substring src, struct substring delimiters,
115 size_t *save_idx, struct substring *token);
116 void ss_advance (struct substring *, size_t);
117 bool ss_match_byte (struct substring *, char);
118 int ss_match_byte_in (struct substring *, struct substring);
119 bool ss_match_string (struct substring *, const struct substring);
120 int ss_get_byte (struct substring *);
121 size_t ss_get_bytes (struct substring *, size_t cnt, struct substring *);
122 bool ss_get_until (struct substring *, char delimiter, struct substring *);
123 size_t ss_get_long (struct substring *, long *);
126 bool ss_is_empty (struct substring);
127 size_t ss_length (struct substring);
128 char *ss_data (struct substring);
129 char *ss_end (struct substring);
130 int ss_at (struct substring, size_t idx);
131 int ss_first (struct substring);
132 int ss_last (struct substring);
133 bool ss_starts_with (struct substring, struct substring prefix);
134 bool ss_ends_with (struct substring, struct substring suffix);
135 size_t ss_span (struct substring, struct substring skip_set);
136 size_t ss_cspan (struct substring, struct substring stop_set);
137 size_t ss_find_byte (struct substring, char);
138 size_t ss_find_substring (struct substring, struct substring);
139 int ss_compare (struct substring, struct substring);
140 int ss_compare_case (struct substring, struct substring);
141 int ss_equals (struct substring, struct substring);
142 int ss_equals_case (struct substring, struct substring);
143 size_t ss_pointer_to_position (struct substring, const char *);
144 char *ss_xstrdup (struct substring);
147 ucs4_t ss_first_mb (struct substring);
148 int ss_first_mblen (struct substring);
149 ucs4_t ss_get_mb (struct substring *);
150 ucs4_t ss_at_mb (struct substring, size_t ofs);
151 int ss_at_mblen (struct substring, size_t ofs);
153 /* Variable length strings. */
159 size_t capacity; /* Allocated capacity, not including one
160 extra byte allocated for null terminator. */
163 #define DS_EMPTY_INITIALIZER {SS_EMPTY_INITIALIZER, 0}
165 /* Constructors, destructors. */
166 void ds_init_empty (struct string *);
167 void ds_init_string (struct string *, const struct string *);
168 void ds_init_substring (struct string *, struct substring);
169 void ds_init_cstr (struct string *, const char *);
170 void ds_destroy (struct string *);
171 void ds_swap (struct string *, struct string *);
175 void ds_register_pool (struct string *, struct pool *);
176 void ds_unregister_pool (struct string *, struct pool *);
179 void ds_assign_string (struct string *, const struct string *);
180 void ds_assign_substring (struct string *, struct substring);
181 void ds_assign_cstr (struct string *, const char *);
183 /* Shrink, extend. */
184 void ds_clear (struct string *);
185 void ds_extend (struct string *, size_t);
186 void ds_shrink (struct string *);
187 void ds_truncate (struct string *, size_t);
189 /* Padding, trimming. */
190 size_t ds_rtrim (struct string *, struct substring trim_set);
191 size_t ds_ltrim (struct string *, struct substring trim_set);
192 size_t ds_trim (struct string *, struct substring trim_set);
193 bool ds_chomp_byte (struct string *, char);
194 bool ds_chomp (struct string *, struct substring);
195 bool ds_separate (const struct string *src, struct substring delimiters,
196 size_t *save_idx, struct substring *token);
197 bool ds_tokenize (const struct string *src, struct substring delimiters,
198 size_t *save_idx, struct substring *token);
199 void ds_rpad (struct string *, size_t length, char pad);
200 void ds_set_length (struct string *, size_t new_length, char pad);
201 void ds_remove (struct string *, size_t start, size_t n);
203 /* Extracting substrings. */
204 struct substring ds_ss (const struct string *);
205 struct substring ds_substr (const struct string *, size_t start, size_t);
206 struct substring ds_head (const struct string *, size_t);
207 struct substring ds_tail (const struct string *, size_t);
210 bool ds_is_empty (const struct string *);
211 size_t ds_length (const struct string *);
212 char *ds_data (const struct string *);
213 char *ds_end (const struct string *);
214 int ds_at (const struct string *, size_t idx);
215 int ds_first (const struct string *);
216 int ds_last (const struct string *);
217 bool ds_ends_with (const struct string *, struct substring suffix);
218 size_t ds_span (const struct string *, struct substring skip_set);
219 size_t ds_cspan (const struct string *, struct substring stop_set);
220 size_t ds_find_byte (const struct string *, char);
221 int ds_compare (const struct string *, const struct string *);
222 size_t ds_pointer_to_position (const struct string *, const char *);
223 char *ds_xstrdup (const struct string *);
225 size_t ds_capacity (const struct string *);
226 char *ds_cstr (const struct string *);
227 char *ds_steal_cstr (struct string *);
230 bool ds_read_line (struct string *, FILE *, size_t max_length);
231 bool ds_read_config_line (struct string *, int *line_number, FILE *);
232 bool ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
235 void ds_put_byte (struct string *, int ch);
236 void ds_put_byte_multiple (struct string *, int ch, size_t);
237 void ds_put_unichar (struct string *, ucs4_t uc);
238 void ds_put_cstr (struct string *, const char *);
239 void ds_put_substring (struct string *, struct substring);
240 void ds_put_vformat (struct string *st, const char *, va_list)
241 PRINTF_FORMAT (2, 0);
242 void ds_put_c_vformat (struct string *st, const char *, va_list)
243 PRINTF_FORMAT (2, 0);
245 void ds_put_format (struct string *, const char *, ...)
246 PRINTF_FORMAT (2, 3);
247 void ds_put_c_format (struct string *, const char *, ...)
248 PRINTF_FORMAT (2, 3);
250 char *ds_put_uninit (struct string *st, size_t incr);
252 char *ds_splice_uninit (struct string *, size_t ofs, size_t old_len,
256 /* calls relocate from gnulib on ST */
257 void ds_relocate (struct string *st);
260 void u8_buf_copy_rpad (uint8_t *dst, size_t dst_size,
261 const uint8_t *src, size_t src_size,
264 static inline struct substring
273 /* Returns a substring whose contents are the given C-style
275 static inline struct substring
276 ss_cstr (const char *cstr)
278 return ss_buffer (cstr, strlen (cstr));
281 /* Returns a substring whose contents are the CNT characters in
283 static inline struct substring
284 ss_buffer (const char *buffer, size_t cnt)
287 ss.string = (char *) buffer;
293 xstrdup_if_nonnull (const char *s)
295 return s ? xstrdup (s) : NULL;