Update portability notes.
[darkstat] / str.h
1 /* darkstat 3
2 * copyright (c) 2001-2014 Emil Mikulic.
3 *
4 * str.h: string buffer with pool-based reallocation
5 *
6 * Permission to use, copy, modify, and distribute this file for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 #ifndef __DARKSTAT_STR_H
19 #define __DARKSTAT_STR_H
20
21 #include "cdefs.h"
22
23 #include <sys/types.h>
24 #include <stdarg.h>
25 #include <stdint.h> /* for uint64_t */
26
27 typedef long long signed int qd; /* as in appendf("%qd") */
28 typedef long long unsigned int qu; /* as in appendf("%qu") */
29 typedef long long unsigned int lld; /* as in printf("%lld") */
30 typedef long long unsigned int llu; /* as in printf("%llu") */
31
32 _Static_assert(sizeof(qd) == sizeof(int64_t), "qd must be int64_t sized");
33 _Static_assert(sizeof(qu) == sizeof(uint64_t), "qu must be uint64_t sized");
34 _Static_assert(sizeof(lld) == sizeof(int64_t), "lld must be int64_t sized");
35 _Static_assert(sizeof(llu) == sizeof(uint64_t), "llu must be uint64_t sized");
36
37 /* Note: the contents are 8-bit clean and not zero terminated! */
38
39 struct str;
40
41 struct str *str_make(void);
42 void str_free(struct str *s);
43 void str_extract(struct str *buf, size_t *len, char **str);
44 void str_appendn(struct str *buf, const char *s, const size_t len);
45 void str_appendstr(struct str *buf, const struct str *s);
46
47 #ifdef __GNUC__
48 /* amusing efficiency hack */
49 # include <string.h>
50 # define str_append(buf, s) \
51 str_appendn(buf, s, \
52 (__builtin_constant_p(s) ? sizeof(s)-1 : strlen(s)) )
53 #else
54 void str_append(struct str *buf, const char *s);
55 #endif
56
57 size_t xvasprintf(char **result, const char *format, va_list va)
58 _printflike_(2, 0);
59 size_t xasprintf(char **result, const char *format, ...) _printflike_(2, 3);
60 void str_vappendf(struct str *s, const char *format, va_list va)
61 _printflike_(2, 0);
62 void str_appendf(struct str *s, const char *format, ...) _printflike_(2, 3);
63
64 struct str *length_of_time(const time_t t);
65 ssize_t str_write(const struct str * const buf, const int fd);
66 size_t str_len(const struct str * const buf);
67
68 #endif /* __DARKSTAT_STR_H */
69 /* vim:set ts=3 sw=3 tw=78 expandtab: */