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
|
/*
* Copyright (c) 2009-2018 Richard Braun.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Upstream site with license notes :
* http://git.sceen.net/rbraun/librbraun.git/
*/
#ifndef _ERROR_H
#define _ERROR_H
#include <stdnoreturn.h>
#include "macros.h"
/*
* List of errors this library can return.
*
* ERROR_SUCCESS is guaranteed to be 0, allowing code such as :
*
* error = do_smth();
*
* if (error) {
* ...;
* }
*/
enum {
ERROR_SUCCESS,
ERROR_UNKNOWN,
ERROR_INVAL,
ERROR_NOMEM,
ERROR_FORMAT,
ERROR_NORES,
ERROR_PERM,
ERROR_BUSY,
ERROR_TIMEDOUT,
ERROR_AGAIN,
ERROR_EXIST,
};
/*
* Return the message matching the given error.
*
* The returned address points to a statically allocated, read only,
* null-terminated string literal. The caller must not attempt to use it
* for anything else than error reporting.
*/
const char * error_str(unsigned int error);
/*
* Map standard error codes to error values.
*
* This function accepts a subset of the standard error codes in errno.h.
* When called, and if the errno value is handled, it will return the
* corresponding ERROR_xxx code. Otherwise ERROR_UNKNOWN is returned.
*/
unsigned int error_from_errno(int errno_code);
/*
* If error denotes an actual error (i.e. is not 0), abort, using the given
* string as a prefix for the error message. A NULL prefix is allowed.
*/
void error_check(int error, const char *prefix);
#endif /* _ERROR_H */
|
