1 /*
2 * SysDB - src/include/utils/strings.h
3 * Copyright (C) 2016 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * 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
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_UTILS_STRINGS_H
29 #define SDB_UTILS_STRINGS_H 1
31 #include <stdlib.h>
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
37 /*
38 * stringv_copy:
39 * Copy a string vector from 'src' to 'dst'. If non-NULL, 'dst' will be
40 * reallocated to fit the required size and old entries will be freed before
41 * overriding them.
42 *
43 * Returns:
44 * - 0 on success
45 * - a negative value else
46 */
47 int
48 stringv_copy(char ***dst, size_t *dst_len,
49 const char * const *src, size_t src_len);
51 /*
52 * stringv_append:
53 * Append a string to a string vector.
54 *
55 * Returns:
56 * - 0 on success
57 * - a negative value else
58 */
59 int
60 stringv_append(char ***s, size_t *s_len, const char *elem);
61 int
62 stringv_append_if_missing(char ***s, size_t *s_len, const char *elem);
64 /*
65 * stringv_free:
66 * Free the memory used by 's' and all of it's elements.
67 */
68 void
69 stringv_free(char ***s, size_t *s_len);
71 #ifdef __cplusplus
72 } /* extern "C" */
73 #endif
75 #endif /* ! SDB_UTILS_STRINGS_H */
77 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */