aboutsummaryrefslogtreecommitdiffstats
path: root/include/error.h
blob: 8cce80c82ef5c7b49c07f32d27e5b6428653e79d (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
/**
 * slibc — Yet another C library
 * Copyright © 2015  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 _ERROR_H
#define _ERROR_H
#include <slibc/version.h>
#include <slibc/features.h>
#ifndef __PORTABLE

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


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



/**
 * Print an error message with a detailed description, and optionally exit.
 * 
 * This is a GNU extension.
 * 
 * @param  status  The process will exit, with the function returning, with this
 *                 exit status, unless it is zero. If zero, the process shall not exit.
 * @param  errnum  The value of `errno` when the error occurred, zero if the a textual
 *                 description of the error, further than that of `format`, shall not
 *                 be printed.
 * @param  format  Formatting-string for a detailed description of what happend.
 * @param  args    Formatting-arguments for `format`.
 */
void error(int, int, const char*, ...)
  __GCC_ONLY(__attribute__((format(printf, 3, 4))));

/**
 * Variant of `error` that uses `va_list` instead of variadic arguments.
 * 
 * This is a slibc extension to the GNU extension `error`.
 * 
 * @param  status  The process will exit, with the function returning, with this
 *                 exit status, unless it is zero. If zero, the process shall not exit.
 * @param  errnum  The value of `errno` when the error occurred, zero if the a textual
 *                 description of the error, further than that of `format`, shall not
 *                 be printed.
 * @param  format  Formatting-string for a detailed description of what happend.
 * @param  args    Formatting-arguments for `format`.
 */
#if defined(__SLIBC_SOURCE)
void verror(int, int, const char*, va_list);
#endif


/**
 * Variant of `error` that prints the filename and the line
 * number whence the error occurred.
 * 
 * This is a GNU extension.
 * 
 * @param  status    The process will exit, with the function returning, with this
 *                   exit status, unless it is zero. If zero, the process shall not exit.
 * @param  errnum    The value of `errno` when the error occurred, zero if the a textual
 *                   description of the error, further than that of `format`, shall not
 *                   be printed.
 * @param  filename  The filename of the source code file where the error occurred.
 * @param  linenum   The line number of in the source code file where the error occurred.
 * @param  format    Formatting-string for a detailed description of what happend.
 * @param  args      Formatting-arguments for `format`.
 */
void error_at_line(int, int, const char*, unsigned int, const char*, ...)
  __GCC_ONLY(__attribute__((format(printf, 5, 6))));

/**
 * Variant of `verror` that prints the filename and the line
 * number whence the error occurred.
 * 
 * This is a slibc extension to the GNU extension `error_at_line`.
 * 
 * @param  status    The process will exit, with the function returning, with this
 *                   exit status, unless it is zero. If zero, the process shall not exit.
 * @param  errnum    The value of `errno` when the error occurred, zero if the a textual
 *                   description of the error, further than that of `format`, shall not
 *                   be printed.
 * @param  filename  The filename of the source code file where the error occurred.
 * @param  linenum   The line number of in the source code file where the error occurred.
 * @param  format    Formatting-string for a detailed description of what happend.
 * @param  args      Formatting-arguments for `format`.
 */
#if defined(__SLIBC_SOURCE)
void verror_at_line(int, int, const char*, unsigned int, const char*, va_list);
#endif


/**
 * Counts the number of times `error` ( verror`) and
 * `error_at_line` (`verror_at_line`) has returned.
 * This variable is global and shared by all threads.
 * 
 * This is a GNU extension.
 */
extern volatile unsigned int error_message_count;

/**
 * If set to non-zero (the default), `error_at_line`
 * and `verror_at_line` restrict themself to only
 * print an error the first time it appears. This
 * is determined by the uniqueness of the combination
 * of the values on `filename` and `linenum`. However
 * it will forget the line the next time the function
 * is called from a different line. This variable is
 * global and shared by all threads. Has a slibc
 * modification, `errnum` is also remembered, meaning
 * if the error code is different (zero is considered
 * an error code), the error is printed even if it
 * occurred on the same line as the last time.
 * 
 * This is a GNU extension.
 */
extern volatile int error_one_per_line;

/**
 * If not `NULL`, this function is used instead of
 * flushing stdout and printing the process name to
 * stderr, by `error` (`verror`) and `verror_at_line`
 * (`verror_at_line`). This variable is global and
 * shared by all threads.
 * 
 * This is a GNU extension.
 */
extern void (*volatile error_print_progname)(void);



#endif
#endif