Mercurial > molko

annotate src/core/error.h @ 59:52792b863ff7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: separate core from game
author David Demelier <markand@malikania.fr>
date Tue, 21 Jan 2020 12:42:33 +0100
parents src/error.h@9d1421c09dfb
children 6203e1ac9b18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * error.h -- error routines
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_ERROR_H
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_ERROR_H
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file error.h
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Error routines.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 #include <stdarg.h>
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
28 #include <stdbool.h>
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #include <stdnoreturn.h>
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * Get the last error returned.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * \return the error string
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 const char *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 error(void);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 /**
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
40 * Convenient handler that sets last error from global C errno and then return
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
41 * false.
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
42 *
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
43 * \return false
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
44 */
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
45 bool
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
46 error_errno(void);
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
47
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
48 /**
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 * Set the game error with a printf-like format.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * \param fmt the format string
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
52 * \return false
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 */
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
54 bool
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 error_printf(const char *fmt, ...);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 /**
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
58 * Similar to \a error_printf.
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 * \param fmt the format stinrg
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 * \param ap the variadic arguments pointer
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
62 * \return false
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 */
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
64 bool
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 error_vprintf(const char *fmt, va_list ap);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 /**
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
68 * Print last registered error and exit with code 1.
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
69 */
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
70 noreturn void
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
71 error_fatal(void);
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
72
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
73 /**
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
74 * Prints an error to stderr and exit.
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 * \param fmt the format string
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 noreturn void
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 error_fatalf(const char *fmt, ...);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 * Similar to \a error_fatalf
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 * \param fmt the format string
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 * \param ap the variadic arguments pointer
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 noreturn void
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 error_vfatalf(const char *fmt, va_list ap);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
89
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 #endif /* !MOLKO_ERROR_H */