Mercurial > sci
annotate libsci/util.h @ 50:b474f0985e39
scictl: add API key support
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Wed, 17 Aug 2022 09:11:58 +0200 |
| parents | e52c762d8ba8 |
| children | 319979427566 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 * util.h -- miscellaneous utilities | |
| 3 * | |
|
32
081e1c258e64
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
30
diff
changeset
|
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr> |
| 0 | 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 | |
| 34 | 19 /** |
| 20 * \file util.h | |
| 21 * \brief Miscellaneous utilities. | |
| 22 * | |
| 23 * Most of the allocations functions will exit with code 1 on memory | |
| 24 * exhaustion. | |
| 25 */ | |
| 26 | |
| 0 | 27 #ifndef SCI_UTIL_H |
| 28 #define SCI_UTIL_H | |
| 29 | |
| 30 #include <stddef.h> | |
|
3
215c0c3b3609
misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents:
2
diff
changeset
|
31 #include <stdio.h> |
| 0 | 32 |
| 30 | 33 #include <jansson.h> |
| 34 | |
| 34 | 35 /** |
| 36 * Compute fixed size array length. | |
| 37 */ | |
| 0 | 38 #define UTIL_SIZE(x) (sizeof (x) / sizeof (x[0])) |
| 39 | |
| 34 | 40 /** |
| 41 * Wrap malloc or exit with code 1. | |
| 42 * | |
| 43 * \param w the bytes to allocate | |
| 44 * \return the pointer to the memory | |
| 45 */ | |
| 0 | 46 void * |
| 34 | 47 util_malloc(size_t w); |
| 0 | 48 |
| 34 | 49 /** |
| 50 * Wrap calloc or exit with code 1. | |
| 51 * | |
| 52 * \param n the number of items | |
| 53 * \param w the bytes per item | |
| 54 * \return the pointer to the memory | |
| 55 */ | |
| 0 | 56 void * |
| 34 | 57 util_calloc(size_t n, size_t w); |
| 0 | 58 |
| 34 | 59 /** |
| 60 * Wrap realloc or exit with code 1. | |
| 61 * | |
| 62 * \param ptr the old memory | |
| 63 * \param w the bytes to allocate | |
| 64 * \return the pointer to the memory | |
| 65 */ | |
| 0 | 66 void * |
| 34 | 67 util_realloc(void *ptr, size_t w); |
| 0 | 68 |
| 34 | 69 /** |
| 70 * Wrap reallocarray or exit with code 1. | |
| 71 * | |
| 72 * \param ptr the old memory | |
| 73 * \param n the number of items | |
| 74 * \param w the bytes per item | |
| 75 * \return the pointer to the memory | |
| 76 */ | |
| 0 | 77 void * |
| 34 | 78 util_reallocarray(void *ptr, size_t n, size_t w); |
| 0 | 79 |
| 34 | 80 /** |
| 81 * Wrap strdup or exit with code 1. | |
| 82 * | |
| 83 * \pre str != NULL | |
| 84 * \param str the string to duplicate | |
| 85 * \return the copied string | |
| 86 */ | |
| 0 | 87 char * |
| 34 | 88 util_strdup(const char *str); |
| 0 | 89 |
| 34 | 90 /** |
| 91 * Wrap strndup or exit with code 1. | |
| 92 * | |
| 93 * \pre str != NULL | |
| 94 * \param str the string to duplicate | |
| 95 * \param n the maximum string to not exceed | |
| 96 * \return the copied string | |
| 97 */ | |
| 0 | 98 char * |
| 34 | 99 util_strndup(const char *str, size_t n); |
| 0 | 100 |
| 34 | 101 /** |
| 102 * Get the base name component from a path. | |
| 103 * | |
| 104 * \pre path != NULL | |
| 105 * \param path the path to extract | |
| 106 * \return a static thread local value containing the base name | |
| 107 */ | |
| 0 | 108 char * |
| 34 | 109 util_basename(const char *path); |
| 0 | 110 |
| 34 | 111 /** |
| 112 * Get the directory name component from a path. | |
| 113 * | |
| 114 * \pre path != NULL | |
| 115 * \param path the path to extract | |
| 116 * \return a static thread local value containing the directory name | |
| 117 */ | |
| 118 char * | |
| 119 util_dirname(const char *path); | |
| 120 | |
| 121 /** | |
| 122 * Wrap open_memstream or exit with code 1. | |
| 123 * | |
| 124 * \pre out != NULL | |
| 125 * \pre outsz != NULL | |
| 126 * \param out the destination string | |
| 127 * \param outsz the destination string length | |
| 128 * \return a non-NULL file pointer | |
| 129 */ | |
|
3
215c0c3b3609
misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents:
2
diff
changeset
|
130 FILE * |
| 34 | 131 util_open_memstream(char **out, size_t *outsz); |
| 0 | 132 |
| 34 | 133 /** |
| 134 * Read the whole content from the given file. | |
| 135 * | |
| 136 * \pre path != NULL | |
| 137 * \param path the file to read | |
| 138 * \return the file content or NULL on error (and errno is set) | |
| 139 */ | |
|
1
5afdb14df924
sci: add support for storing results
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
140 char * |
|
3
215c0c3b3609
misc: use JSON everywhere (scictl/sciwebd)
David Demelier <markand@malikania.fr>
parents:
2
diff
changeset
|
141 util_read(const char *); |
|
1
5afdb14df924
sci: add support for storing results
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
142 |
| 34 | 143 /** |
| 144 * Write an error message to error output and exit with code 1. | |
| 145 * | |
| 146 * \pre fmt != NULL | |
| 147 * \param fmt the format string | |
| 148 */ | |
| 19 | 149 void |
| 34 | 150 util_die(const char *fmt, ...); |
| 19 | 151 |
| 34 | 152 /** |
| 153 * Wrap json_pack or exit with code 1. | |
| 154 * | |
| 155 * \pre fmt != NULL | |
| 156 * \param fmt the json_pack format string and its arguments | |
| 157 * \return a non-NULL JSON document | |
| 158 */ | |
| 30 | 159 json_t * |
| 34 | 160 util_json_pack(const char *fmt, ...); |
| 30 | 161 |
| 34 | 162 /** |
| 163 * Wrap json_dump or exit with code 1. | |
| 164 * | |
| 165 * \pre json != NULL | |
| 166 * \param json the JSON value to transform to string | |
| 167 */ | |
| 30 | 168 char * |
| 34 | 169 util_json_dump(const json_t *json); |
| 30 | 170 |
| 34 | 171 /** |
| 172 * OpenBSD strlcpy extension builtin. | |
| 173 * | |
| 174 * \pre dst != NULL | |
| 175 * \pre src != NULL | |
| 176 * \param dst the destination string | |
| 177 * \param src the source string | |
| 178 * \param size the maximum size in dst | |
| 179 * \return the number of bytes written | |
| 180 */ | |
| 30 | 181 size_t |
| 34 | 182 util_strlcpy(char *dst, const char *src, size_t size); |
| 30 | 183 |
| 34 | 184 /** |
| 185 * OpenBSD strtonum extension builtin. | |
| 186 * | |
| 187 * \pre str != NULL | |
| 188 * \param str the string to convert | |
| 189 * \param min the lower bound (included) | |
| 190 * \param max the upper bound (included) | |
| 191 * \param errstr the error string pointer to be set on error (not dynamically allocated) | |
| 192 * \return the converted value | |
| 193 */ | |
|
22
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
194 long long |
| 34 | 195 util_strtonum(const char *str, long long min, long long max, const char **errstr); |
|
22
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
196 |
| 0 | 197 #endif /* !SCI_UTIL_H */ |