annotate lib/util.h @ 30:43333d18e4b8

scid: document theme
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 14:54:43 +0200
parents dd078aea5d02
children 081e1c258e64
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * util.h -- miscellaneous utilities
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2021 David Demelier <markand@malikania.fr>
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_UTIL_H
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_UTIL_H
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stddef.h>
3
215c0c3b3609 misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
23 #include <stdio.h>
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
30
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
25 #include <jansson.h>
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
26
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 #define UTIL_SIZE(x) (sizeof (x) / sizeof (x[0]))
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 void *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 util_malloc(size_t);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 void *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 util_calloc(size_t, size_t);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 void *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 util_realloc(void *, size_t);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 void *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 util_reallocarray(void *, size_t, size_t);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 void *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 util_memdup(const void *, size_t);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 char *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 util_strdup(const char *);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 char *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 util_strndup(const char *, size_t);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 char *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 util_basename(const char *);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 char *
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 util_dirname(const char *);
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
3
215c0c3b3609 misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
56 FILE *
215c0c3b3609 misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
57 util_fmemopen(void *, size_t, const char *);
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
30
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
59 FILE *
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
60 util_open_memstream(char **, size_t *);
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
1
5afdb14df924 sci: add support for storing results
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
62 char *
3
215c0c3b3609 misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents: 2
diff changeset
63 util_read(const char *);
1
5afdb14df924 sci: add support for storing results
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
64
19
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
65 void
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
66 util_die(const char *, ...);
de4bf839b565 misc: revamp SQL
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
67
30
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
68 json_t *
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
69 util_json_pack(const char *, ...);
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
70
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
71 char *
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
72 util_json_dump(const json_t *);
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
73
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
74 /* defined in extern/ */
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
75
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
76 size_t
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
77 util_strlcpy(char *, const char *, size_t);
43333d18e4b8 scid: document theme
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
78
22
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
79 long long
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
80 util_strtonum(const char *, long long, long long, const char **);
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
81
0
f1de39079243 misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 #endif /* !SCI_UTIL_H */