Mercurial > molko

annotate libmlk-core/mlk/core/panic.h @ 646:7e1eb7f6c049 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: remove .clang
author David Demelier <markand@malikania.fr>
date Sun, 04 Feb 2024 15:24:37 +0100
parents 75944708c55c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * panic.h -- unrecoverable error handling
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 348
diff changeset
19 #ifndef MLK_CORE_PANIC_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 348
diff changeset
20 #define MLK_CORE_PANIC_H
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
22 /**
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
23 * \file panic.h
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
24 * \brief Unrecoverable error handling
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
25 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
26 * This module is intended to be used whenever an unrecoverable error happens
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
27 * and the action is left to the developer.
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
28 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
29 * Most of the API don't call panic directly.
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
30 */
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
31
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
32 #include <stdarg.h>
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
34 /**
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
35 * Maximum trace line
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
36 */
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
37 #define PANIC_LINE_MAX (128)
486
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 475
diff changeset
38
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
39 /**
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
40 * Default panic handler.
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
41 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
42 * The default handler prints the line and exit using C [abort].
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
43 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
44 * [abort]: https://en.cppreference.com/w/c/program/abort
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
45 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
46 * \param line the line to print
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
47 */
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
48 extern void (*mlk_panic_handler)(const char *line);
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
50 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
51 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
52 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
53
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
54 /**
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
55 * Panic the game with using a [printf] format style message
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
56 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
57 * [printf]: https://en.cppreference.com/w/c/io/fprintf
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
58 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
59 * \pre fmt != NULL
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
60 * \param fmt the printf format string
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
61 */
348
7d7991f97acf misc: be more barebone portable
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
62 void
465
01f5580e43d1 core: panic -> mlk_panic
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
63 mlk_panicf(const char *, ...);
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
65 /**
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
66 * Similar to ::mlk_panicf but using a `va_list` instead.
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
67 *
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
68 * \pre fmt != NULL
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
69 * \param fmt the printf format string
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
70 * \param ap the variadic handle
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
71 */
348
7d7991f97acf misc: be more barebone portable
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
72 void
465
01f5580e43d1 core: panic -> mlk_panic
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
73 mlk_panicva(const char *, va_list);
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 88
diff changeset
74
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
75 /**
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
76 * Similar to ::mlk_panicf but uses ::mlk_err to retrieve the last error as the
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
77 * final message.
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
78 */
348
7d7991f97acf misc: be more barebone portable
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
79 void
547
c7664b679a95 misc: remove error codes for now
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
80 mlk_panic(void);
88
44de3c528b63 core: implement basic panic mechanism, continue #2484 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
81
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
82 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
83 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
84 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
85
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 348
diff changeset
86 #endif /* !MLK_CORE_PANIC_H */