Mercurial > molko
annotate libmlk-core/mlk/core/err.h @ 646:7e1eb7f6c049 default tip @
misc: remove .clang
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 04 Feb 2024 15:24:37 +0100 |
parents | 76ce31b0151f |
children |
rev | line source |
---|---|
419 | 1 /* |
2 * err.h -- error handing | |
3 * | |
445
773a082f0b91
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
437
diff
changeset
|
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr> |
419 | 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 MLK_ERR_H | |
20 #define MLK_ERR_H | |
21 | |
547
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
22 /** |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
23 * \file mlk/core/err.h |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
24 * \brief Error handling |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
25 * |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
26 * Because the Molko's Adventure framework use many different external |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
27 * libraries, it is not an easy task to transform all external error codes to |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
28 * a general one. |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
29 * |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
30 * Instead, the library stores a thread-local [errno]-like API that the user |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
31 * can access as a string. When a function fails, the user should retrieve the |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
32 * error as early as possible. |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
33 * |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
34 * [errno]: https://en.cppreference.com/w/c/error/errno |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
35 */ |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
36 |
585 | 37 #include <stdarg.h> |
38 | |
39 #if defined(__cplusplus) | |
40 extern "C" { | |
41 #endif | |
42 | |
547
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
43 /** |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
44 * Set the error using printf format string. |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
45 * |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
46 * \pre fmt != NULL |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
47 * \param fmt the format string |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
48 * \return -1 for convenience |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
49 */ |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
50 int |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
51 mlk_errf(const char *fmt, ...); |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
52 |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
53 /** |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
54 * Similar to ::mlk_errf but using a `va_list` instead. |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
55 * |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
56 * \pre fmt != NULL |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
57 * \param fmt the printf format string |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
58 * \param ap the variadic handle |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
59 * \return -1 for convenience |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
60 */ |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
61 int |
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
62 mlk_errva(const char *fmt, va_list ap); |
419 | 63 |
585 | 64 /** |
65 * Retrieve the last stored error as a string. | |
66 * | |
67 * \return the current error | |
68 */ | |
419 | 69 const char * |
547
c7664b679a95
misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
70 mlk_err(void); |
419 | 71 |
585 | 72 #if defined(__cplusplus) |
73 } | |
74 #endif | |
75 | |
419 | 76 #endif /* !MLK_ERROR_H */ |