aboutsummaryrefslogtreecommitdiffstats
path: root/include/err.h
blob: bc93228958711675c6eb8ee461038ffe6cdc21c9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
 * slibc — Yet another C library
 * Copyright © 2015, 2016  Mattias Andrée (maandree@member.fsf.org)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef _ERR_H
#define _ERR_H
#include <slibc/version.h>
#include <slibc/features.h>

#ifndef _SLIBC_SUPPRESS_WARNINGS
# warning "Please consider not using <err.h>."
#endif


#define __NEED_va_list
#include <bits/types.h>



#if defined(__BSD_SOURCE)
/**
 * Print a warning to stderr, followed by a description
 * of the value of `errno`.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  Print (warn)ing!
 * 
 * @param  format  Formatting-string for the warning.
 * @param  ...     Formatting-arguments.
 * 
 * @since  Always.
 */
void warn(const char*, ...)
  __GCC_ONLY(__attribute__((__format__(__slibc_printf__, 1, 2))));

/**
 * Print a warning to stderr, followed by a description
 * of the value of `errno`.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  (V)ariadic version of (`warn`).
 * 
 * @param  format  Formatting-string for the warning.
 * @param  args    Formatting-arguments.
 * 
 * @since  Always.
 */
void vwarn(const char*, va_list);

/**
 * Print a warning to stderr, but do not print a
 * description of the value of `errno`.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  (`warn`), [x=](lesser variant).
 * 
 * @param  format  Formatting-string for the warning.
 * @param  ...     Formatting-arguments.
 * 
 * @since  Always.
 */
void warnx(const char*, ...)
  __GCC_ONLY(__attribute__((__format__(__slibc_printf__, 1, 2))));

/**
 * Print a warning to stderr, but do not print a
 * description of the value of `errno`.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  (V)ariadic version of (`warnx`).
 * 
 * @param  format  Formatting-string for the warning.
 * @param  args    Formatting-arguments.
 * 
 * @since  Always.
 */
void vwarnx(const char*, va_list);

/**
 * Print an error message to stderr, followed by a
 * description of the value of `errno`. Then exit the process.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  Report (err)or!
 * 
 * @param  status  The exit status the process should have.
 * @param  format  Formatting-string for the warning.
 * @param  ...     Formatting-arguments.
 * 
 * @since  Always.
 */
__noreturn void err(int, const char*, ...)
  __GCC_ONLY(__attribute__((__format__(__slibc_printf__, 2, 3))));

/**
 * Print an error message to stderr, followed by a
 * description of the value of `errno`. Then exit the process.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  (V)ariadic version of (`err`).
 * 
 * @param  status  The exit status the process should have.
 * @param  format  Formatting-string for the warning.
 * @param  args    Formatting-arguments.
 * 
 * @since  Always.
 */
__noreturn void verr(int, const char*, va_list);

/**
 * Print an error message to stderr, but do not print a
 * description of the value of `errno`. Then exit the process.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  (`err`), [x=](lesser variant).
 * 
 * @param  status  The exit status the process should have.
 * @param  format  Formatting-string for the warning.
 * @param  ...     Formatting-arguments.
 * 
 * @since  Always.
 */
__noreturn void errx(int, const char*, ...)
  __GCC_ONLY(__attribute__((__format__(__slibc_printf__, 2, 3))));

/**
 * Print an error message to stderr, but do not print a
 * description of the value of `errno`. Then exit the process.
 * 
 * This is a non-standard BSD extension.
 * 
 * @etymology  (V)ariadic version of (`errx`).
 * 
 * @param  status  The exit status the process should have.
 * @param  format  Formatting-string for the warning.
 * @param  args    Formatting-arguments.
 * 
 * @since  Always.
 */
__noreturn void verrx(int, const char*, va_list);
#endif



#endif