comparison libsci/util.h @ 33:1d0ddf9e6efd

misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents lib/util.h@081e1c258e64
children e52c762d8ba8
comparison
equal deleted inserted replaced
32:081e1c258e64 33:1d0ddf9e6efd
1 /*
2 * util.h -- miscellaneous utilities
3 *
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
5 *
6 * Permission to use, copy, modify, and/or distribute this software 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
19 #ifndef SCI_UTIL_H
20 #define SCI_UTIL_H
21
22 #include <stddef.h>
23 #include <stdio.h>
24
25 #include <jansson.h>
26
27 #define UTIL_SIZE(x) (sizeof (x) / sizeof (x[0]))
28
29 void *
30 util_malloc(size_t);
31
32 void *
33 util_calloc(size_t, size_t);
34
35 void *
36 util_realloc(void *, size_t);
37
38 void *
39 util_reallocarray(void *, size_t, size_t);
40
41 void *
42 util_memdup(const void *, size_t);
43
44 char *
45 util_strdup(const char *);
46
47 char *
48 util_strndup(const char *, size_t);
49
50 char *
51 util_basename(const char *);
52
53 char *
54 util_dirname(const char *);
55
56 FILE *
57 util_fmemopen(void *, size_t, const char *);
58
59 FILE *
60 util_open_memstream(char **, size_t *);
61
62 char *
63 util_read(const char *);
64
65 void
66 util_die(const char *, ...);
67
68 json_t *
69 util_json_pack(const char *, ...);
70
71 char *
72 util_json_dump(const json_t *);
73
74 /* defined in extern/ */
75
76 size_t
77 util_strlcpy(char *, const char *, size_t);
78
79 long long
80 util_strtonum(const char *, long long, long long, const char **);
81
82 #endif /* !SCI_UTIL_H */