Mercurial > molko

annotate src/error.h @ 36:798baf7f3ec0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: implement sys_data* functions for Windows
author David Demelier <markand@malikania.fr>
date Mon, 13 Jan 2020 20:48:41 +0100
parents bdb51709fd55
children 9d1421c09dfb
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>
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #include <stdnoreturn.h>
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
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 * Get the last error returned.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * \return the error string
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 const char *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 error(void);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
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 * Set the game error with a printf-like format.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 * \param fmt the format string
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 void
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 error_printf(const char *fmt, ...);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * \Similar to \a error_printf.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 * \param fmt the format stinrg
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * \param ap the variadic arguments pointer
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 void
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 error_vprintf(const char *fmt, va_list ap);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 * Similar to \a error_printf but close the application.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 * \param fmt the format string
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 noreturn void
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 error_fatalf(const char *fmt, ...);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 * Similar to \a error_fatalf
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 * \param fmt the format string
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 * \param ap the variadic arguments pointer
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 */
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 noreturn void
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 error_vfatalf(const char *fmt, va_list ap);
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 #endif /* !MOLKO_ERROR_H */