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
167
168
169
170
171
|
/* See LICENSE file for copyright and license details. */
#ifndef LIBGAMMA_ERROR_HH
#define LIBGAMMA_ERROR_HH
#include <exception>
#include <string>
#include "libgamma-native.hh"
#if defined(__GNUC__)
# define LIBGAMMAMM_PURE__ __attribute__((__pure__))
#else
# define LIBGAMMAMM_PURE__
#endif
#if !defined(__WIN32__)
# define libgamma_gid_t gid_t
#else
# define libgamma_gid_t short
#endif
namespace libgamma
{
/**
* Class for `group_gid`
*/
class GroupGid;
/**
* Class for `group_name`
*/
class GroupName;
/**
* Prints an error to stderr in a `perror` fashion,
* however this function will not translate the `libgamma`
* errors into human-readable strings, it will simply
* print the name of the error. If the value `error_code`
* is the value of `LIBGAMMA_ERRNO_SET`, `perror` will be
* used to print the current error stored in `errno`.
* If `error_code` is non-negative (an `errno` value`), that
* value will be stored in `errno` and `perror` will be
* used to print it. Additionally, if the `error_code` is
* the value of `LIBGAMMA_DEVICE_REQUIRE_GROUP` the
* required group will be printed with its numerical value
* and, if known, its name.
*
* @param name The text to add at the beginning
* @param value The error code, may be an `errno` value
*/
void perror(const std::string name, int error_code);
/**
* Returns the name of the definition associated with a `nullptr` error code
*
* @param value The error code
* @return The name of the definition associated with the error code,
* `nullptr` if the error code does not exist
*/
std::string *name_of_error(int value);
/**
* Return the value of a `libgamma` error definition refered to by name
*
* @param name The name of the definition associated with the error code
* @return The error code, zero if the name is `nullptr`
* or does not refer to a `libgamma` error
*/
LIBGAMMAMM_PURE__ int value_of_error(const std::string *name);
/**
* Class for `group_gid`
*/
class GroupGid
{
public:
const GroupGid &
operator =(const libgamma_gid_t &value) const
{
libgamma_group_gid_set(value);
return *this;
}
operator libgamma_gid_t() const
{
return libgamma_group_gid_get();
}
};
/**
* Group that the user needs to be a member of if
* `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned
*/
extern GroupGid group_gid;
/**
* Class for `group_name`
*/
class GroupName
{
public:
const GroupName &
operator =(const char *value) const
{
libgamma_group_name_set(value);
return *this;
}
operator const char *() const
{
return libgamma_group_name_get();
}
};
/**
* Group that the user needs to be a member of if
* `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned,
* `nullptr` if the name of the group
* `libgamma::group_gid` cannot be determined
*/
extern GroupName group_name;
/**
* Libgamma exception class
*/
class LibgammaException : public std::exception
{
public:
/**
* Constructor
*
* @param error_code The error code
*/
LibgammaException(int error_code) throw();
/**
* Destructor
*/
virtual ~LibgammaException() throw();
/**
* Get the error as a string
*/
virtual const char *what() const throw();
/**
* The error code
*/
int error_code;
};
/**
* Create an exception from an error code
* that may come from `errno.h` or be a
* `libgamma` error code
*
* @param error_code The error code
* @return The error object
*/
LibgammaException create_error(int error_code);
}
#endif
|
