annotate err.h @ 50:2901c594eaef

And last commit applied to parray too
author David Demelier <markand@malikania.fr>
date Fri, 07 Oct 2011 16:58:58 +0200
parents ed6ae3b865c9
children f773c76b1f3c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * err.h -- formtted error messages (portable version)
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2011, David Demelier <markand@malikania.fr>
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _ERR_H_
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _ERR_H_
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stdarg.h>
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 /*
32
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
25 * Attribute noreturn may helps. This may produce a warning with GCC 4.5:
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
26 *
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
27 * int a;
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
28 *
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
29 * if ((a = getstate() < 0)
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
30 * errx(1, "State failed");
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
31 *
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
32 * Because compilator does not know that errx will call exit may produce
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
33 * a warning like `a may be used uninitialized'.
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
34 */
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
35
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
36 #ifdef __GNUC__
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
37 #define _NORETURN_ __attribute__ ((noreturn))
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
38 #endif
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
39
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
40 /*
18
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 * err() functions append the format message to the stderr FILE pointer. They
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 * also append the system error using strerror(errno). Then the functions exit
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 * with the error code given as first argument.
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 */
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
32
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
46 void err(int, const char *, ...) _NORETURN_;
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
47 void verr(int, const char *, va_list) _NORETURN_;
18
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 /*
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * errx() functions are similar to err() except that they do not append the
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * system error message.
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 */
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
32
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
54 void errx(int, const char *, ...) _NORETURN_;
ed6ae3b865c9 Use __attribute__ ((noreturn)) on err(x) functions
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
55 void verrx(int, const char *, va_list) _NORETURN_;
18
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 /*
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 * warn() functions are similar to err() but they do not call exit().
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 */
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 void warn(const char *, ...);
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 void vwarn(const char *, va_list);
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 /*
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 * warnx() functions are similar to warn() except that they do not append the
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 * system error message.
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 */
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 void warnx(const char *, ...);
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 void vwarnx(const char *, va_list);
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
a3841b9c66a1 Import portable version of NetBSD functions err(3)
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 #endif /* _ERR_H_ */