Mercurial > molko

annotate libcore/core/error.h @ 168:aab824406d3d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: all printf-like function are name foof and vfoof
author David Demelier <markand@malikania.fr>
date Tue, 20 Oct 2020 15:09:39 +0200
parents 789b23e01f52
children eb0a7ab71023
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.
72
6203e1ac9b18 doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents: 59
diff changeset
25 * \ingroup basics
35
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
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #include <stdarg.h>
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
29 #include <stdbool.h>
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 77
diff changeset
30
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 77
diff changeset
31 #include "plat.h"
35
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 /**
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 * Get the last error returned.
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 *
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 77
diff changeset
36 * \return The error string.
35
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 const char *
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 error(void);
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 /**
168
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
42 * Set the game error with a printf-like format.
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
43 *
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
44 * \pre fmt != NULL
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
45 * \param fmt the format string
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
46 * \return Always false.
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
47 */
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
48 bool
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
49 errorf(const char *fmt, ...) PLAT_PRINTF(1, 2);
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
50
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
51 /**
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
52 * Similar to \ref errorf.
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
53 *
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
54 * \pre fmt != NULL
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
55 * \param fmt the format stinrg
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
56 * \param ap the variadic arguments pointer
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
57 * \return Always false.
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
58 */
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
59 bool
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
60 verrorf(const char *fmt, va_list ap) PLAT_PRINTF(1, 0);
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
61
aab824406d3d misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
62 /**
77
837ef1d387b4 doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
63 * Convenient helper that sets last error from global C errno and then return
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
64 * false.
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
65 *
95
e82eca4f8606 core: simplify error/panic routines
David Demelier <markand@malikania.fr>
parents: 77
diff changeset
66 * \return Always false.
39
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
67 */
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
68 bool
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
69 error_errno(void);
9d1421c09dfb core: add more utilities to improve code simplicity
David Demelier <markand@malikania.fr>
parents: 35
diff changeset
70
35
bdb51709fd55 core: implement error functions, closes #2453
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 #endif /* !MOLKO_ERROR_H */