Mon, 14 Jul 2014 13:51:02 +0200
added new sstrcat
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2014 Olaf Wintermann. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28 /**
29 * Bounded string implementation.
30 *
31 * The UCX strings (<code>sstr_t</code>) provide an alternative to C strings.
32 * The main difference to C strings is, that <code>sstr_t</code> does <b>not
33 * need to be <code>NULL</code>-terminated</b>. Instead the length is stored
34 * within the structure.
35 *
36 * When using <code>sstr_t</code>, developers must be full aware of what type
37 * of string (<code>NULL</code>-terminated) or not) they are using, when
38 * accessing the <code>char* ptr</code> directly.
39 *
40 * The UCX string module provides some common string functions, known from
41 * standard libc, working with <code>sstr_t</code>.
42 *
43 * @file string.h
44 * @author Mike Becker
45 * @author Olaf Wintermann
46 */
48 #ifndef UCX_STRING_H
49 #define UCX_STRING_H
51 #include "ucx.h"
52 #include "allocator.h"
53 #include <stddef.h>
55 /** Shortcut for a <code>sstr_t struct</code> literal. */
56 #define ST(s) { (char*)s, sizeof(s)-1 }
58 /** Shortcut for the conversion of a C string to a <code>sstr_t</code>. */
59 #define S(s) sstrn((char*)s, sizeof(s)-1)
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
65 /**
66 * The UCX string structure.
67 */
68 typedef struct {
69 /** A reference to the string (<b>not necessarily <code>NULL</code>
70 * -terminated</b>) */
71 char *ptr;
72 /** The length of the string */
73 size_t length;
74 } sstr_t;
76 /**
77 * Creates a new sstr_t based on a C string.
78 *
79 * The length is implicitly inferred by using a call to <code>strlen()</code>.
80 *
81 * <b>Note:</b> the sstr_t will hold a <i>reference</i> to the C string. If you
82 * do want a copy, use sstrdup() on the return value of this function.
83 *
84 * @param cstring the C string to wrap
85 * @return a new sstr_t containing the C string
86 *
87 * @see sstrn()
88 */
89 sstr_t sstr(char *cstring);
91 /**
92 * Creates a new sstr_t of the specified length based on a C string.
93 *
94 * <b>Note:</b> the sstr_t will hold a <i>reference</i> to the C string. If you
95 * do want a copy, use sstrdup() on the return value of this function.
96 *
97 * @param cstring the C string to wrap
98 * @param length the length of the string
99 * @return a new sstr_t containing the C string
100 *
101 * @see sstr()
102 * @see S()
103 */
104 sstr_t sstrn(char *cstring, size_t length);
107 /**
108 * Returns the cumulated length of all specified strings.
109 *
110 * At least one string must be specified.
111 *
112 * <b>Attention:</b> if the count argument does not match the count of the
113 * specified strings, the behavior is undefined.
114 *
115 * @param count the total number of specified strings (so at least 1)
116 * @param string the first string
117 * @param ... all other strings
118 * @return the cumulated length of all strings
119 */
120 size_t sstrnlen(size_t count, sstr_t string, ...);
122 /**
123 * Concatenates strings.
124 *
125 * @param count the total number of strings to concatenate
126 * @param ... all strings
127 * @return the concatenated string
128 */
129 sstr_t sstrcat(size_t count, sstr_t s1, sstr_t s2, ...);
130 sstr_t sstrcat_a(UcxAllocator *a, size_t count, sstr_t s1, sstr_t s2, ...);
133 /**
134 * Returns a substring starting at the specified location.
135 *
136 * <b>Attention:</b> the new string references the same memory area as the
137 * input string and will <b>NOT</b> be <code>NULL</code>-terminated.
138 * Use sstrdup() to get a copy.
139 *
140 * @param string input string
141 * @param start start location of the substring
142 * @return a substring of <code>string</code> starting at <code>start</code>
143 *
144 * @see sstrsubsl()
145 * @see sstrchr()
146 */
147 sstr_t sstrsubs(sstr_t string, size_t start);
149 /**
150 * Returns a substring with a maximum length starting at the specified location.
151 *
152 * <b>Attention:</b> the new string references the same memory area as the
153 * input string and will <b>NOT</b> be <code>NULL</code>-terminated.
154 * Use sstrdup() to get a copy.
155 *
156 * @param string input string
157 * @param start start location of the substring
158 * @param length the maximum length of the substring
159 * @return a substring of <code>string</code> starting at <code>start</code>
160 * with a maximum length of <code>length</code>
161 *
162 * @see sstrsubs()
163 * @see sstrchr()
164 */
165 sstr_t sstrsubsl(sstr_t string, size_t start, size_t length);
167 /**
168 * Returns a substring starting at the location of the first occurrence of the
169 * specified character.
170 *
171 * If the string does not contain the character, an empty string is returned.
172 *
173 * @param string the string where to locate the character
174 * @param chr the character to locate
175 * @return a substring starting at the first location of <code>chr</code>
176 *
177 * @see sstrsubs()
178 */
179 sstr_t sstrchr(sstr_t string, int chr);
181 /**
182 * Returns a substring starting at the location of the last occurrence of the
183 * specified character.
184 *
185 * If the string does not contain the character, an empty string is returned.
186 *
187 * @param string the string where to locate the character
188 * @param chr the character to locate
189 * @return a substring starting at the last location of <code>chr</code>
190 *
191 * @see sstrsubs()
192 */
193 sstr_t sstrrchr(sstr_t string, int chr);
195 /**
196 * Splits a string into parts by using a delimiter string.
197 *
198 * This function will return <code>NULL</code>, if one of the following happens:
199 * <ul>
200 * <li>the string length is zero</li>
201 * <li>the delimeter length is zero</li>
202 * <li>the string equals the delimeter</li>
203 * <li>memory allocation fails</li>
204 * </ul>
205 *
206 * The integer referenced by <code>count</code> is used as input and determines
207 * the maximum size of the resulting array, i.e. the maximum count of splits to
208 * perform + 1.
209 *
210 * The integer referenced by <code>count</code> is also used as output and is
211 * set to
212 * <ul>
213 * <li>-2, on memory allocation errors</li>
214 * <li>-1, if either the string or the delimiter is an empty string</li>
215 * <li>0, if the string equals the delimiter</li>
216 * <li>1, if the string does not contain the delimiter</li>
217 * <li>the count of array items, otherwise</li>
218 * </ul>
219 *
220 * If the string starts with the delimiter, the first item of the resulting
221 * array will be an empty string.
222 *
223 * If the string ends with the delimiter and the maximum list size is not
224 * exceeded, the last array item will be an empty string.
225 *
226 * <b>Attention:</b> The array pointer <b>AND</b> all sstr_t.ptr of the array
227 * items must be manually passed to <code>free()</code>. Use sstrsplit_a() with
228 * an allocator to managed memory, to avoid this.
229 *
230 * @param string the string to split
231 * @param delim the delimiter string
232 * @param count IN: the maximum size of the resulting array (0 = no limit),
233 * OUT: the actual size of the array
234 * @return a sstr_t array containing the split strings or
235 * <code>NULL</code> on error
236 *
237 * @see sstrsplit_a()
238 */
239 sstr_t* sstrsplit(sstr_t string, sstr_t delim, ssize_t *count);
241 /**
242 * Performing sstrsplit() using an UcxAllocator.
243 *
244 * <i>Read the description of sstrsplit() for details.</i>
245 *
246 * The memory for the sstr_t.ptr pointers of the array items and the memory for
247 * the sstr_t array itself are allocated by using the UcxAllocator.malloc()
248 * function.
249 *
250 * <b>Note:</b> the allocator is not used for memory that is freed within the
251 * same call of this function (locally scoped variables).
252 *
253 * @param allocator the UcxAllocator used for allocating memory
254 * @param string the string to split
255 * @param delim the delimiter string
256 * @param count IN: the maximum size of the resulting array (0 = no limit),
257 * OUT: the actual size of the array
258 * @return a sstr_t array containing the split strings or
259 * <code>NULL</code> on error
260 *
261 * @see sstrsplit()
262 */
263 sstr_t* sstrsplit_a(UcxAllocator *allocator, sstr_t string, sstr_t delim,
264 ssize_t *count);
266 /**
267 * Compares two UCX strings with standard <code>memcmp()</code>.
268 *
269 * At first it compares the sstr_t.length attribute of the two strings. The
270 * <code>memcmp()</code> function is called, if and only if the lengths match.
271 *
272 * @param s1 the first string
273 * @param s2 the second string
274 * @return -1, if the length of s1 is less than the length of s2 or 1, if the
275 * length of s1 is greater than the length of s2 or the result of
276 * <code>memcmp()</code> otherwise (i.e. 0 if the strings match)
277 */
278 int sstrcmp(sstr_t s1, sstr_t s2);
280 /**
281 * Compares two UCX strings ignoring the case.
282 *
283 * At first it compares the sstr_t.length attribute of the two strings. If and
284 * only if the lengths match, both strings are compared char by char ignoring
285 * the case.
286 *
287 * @param s1 the first string
288 * @param s2 the second string
289 * @return -1, if the length of s1 is less than the length of s2 or 1, if the
290 * length of s1 is greater than the length of s2 or the difference between the
291 * first two differing characters otherwise (i.e. 0 if the strings match and
292 * no characters differ)
293 */
294 int sstrcasecmp(sstr_t s1, sstr_t s2);
296 /**
297 * Creates a duplicate of the specified string.
298 *
299 * The new sstr_t will contain a copy allocated by standard
300 * <code>malloc()</code>. So developers <b>MUST</b> pass the sstr_t.ptr to
301 * <code>free()</code>.
302 *
303 * The sstr_t.ptr of the return value will <i>always</i> be <code>NULL</code>-
304 * terminated.
305 *
306 * @param string the string to duplicate
307 * @return a duplicate of the string
308 * @see sstrdup_a()
309 */
310 sstr_t sstrdup(sstr_t string);
312 /**
313 * Creates a duplicate of the specified string using an UcxAllocator.
314 *
315 * The new sstr_t will contain a copy allocated by the allocators
316 * ucx_allocator_malloc function. So it is implementation depended, whether the
317 * returned sstr_t.ptr pointer must be passed to the allocators
318 * ucx_allocator_free function manually.
319 *
320 * The sstr_t.ptr of the return value will <i>always</i> be <code>NULL</code>-
321 * terminated.
322 *
323 * @param allocator a valid instance of an UcxAllocator
324 * @param string the string to duplicate
325 * @return a duplicate of the string
326 * @see sstrdup()
327 */
328 sstr_t sstrdup_a(UcxAllocator *allocator, sstr_t string);
330 /**
331 * Omits leading and trailing spaces.
332 *
333 * This function returns a new sstr_t containing a trimmed version of the
334 * specified string.
335 *
336 * <b>Note:</b> the new sstr_t references the same memory, thus you
337 * <b>MUST NOT</b> pass the sstr_t.ptr of the return value to
338 * <code>free()</code>. It is also highly recommended to avoid assignments like
339 * <code>mystr = sstrtrim(mystr);</code> as you lose the reference to the
340 * source string. Assignments of this type are only permitted, if the
341 * sstr_t.ptr of the source string does not need to be freed or if another
342 * reference to the source string exists.
343 *
344 * @param string the string that shall be trimmed
345 * @return a new sstr_t containing the trimmed string
346 */
347 sstr_t sstrtrim(sstr_t string);
349 /**
350 * Checks, if a string has a specific prefix.
351 * @param string the string to check
352 * @param prefix the prefix the string should have
353 * @return 1, if and only if the string has the specified prefix, 0 otherwise
354 */
355 int sstrprefix(sstr_t string, sstr_t prefix);
357 /**
358 * Checks, if a string has a specific suffix.
359 * @param string the string to check
360 * @param suffix the suffix the string should have
361 * @return 1, if and only if the string has the specified suffix, 0 otherwise
362 */
363 int sstrsuffix(sstr_t string, sstr_t suffix);
365 #ifdef __cplusplus
366 }
367 #endif
369 #endif /* UCX_STRING_H */