aboutsummaryrefslogtreecommitdiffstats
path: root/libgamma-error.cc
blob: f7cb5ee058000bae99b5b3bfcc2e52e2b47406ca (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
/* See LICENSE file for copyright and license details. */
#include "libgamma-error.hh"
#include <cstring>
#include <iostream>


namespace libgamma
{
	/**
	 * 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)
	{
		libgamma_perror(name.c_str(), 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)
	{
		const char *cstr = libgamma_name_of_error(value);
		if (cstr == nullptr)
			return nullptr;
		return new std::string(cstr);
	}

	/**
	 * 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
	 */
	int
	value_of_error(const std::string* name)
	{
		const char *cstr = nullptr;
		if (name != nullptr)
			cstr = name->c_str();
		return libgamma_value_of_error(cstr);
	}


#if defined(__GNUC__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wshadow"
#endif

	/**
	 * Constructor
	 * 
	 * @param  error_code  The error code
	 */
	LibgammaException::LibgammaException(int error_code) throw() : error_code(error_code)
	{
		/* do nothing */
	}

	/**
	 * Destructor
	 */
	LibgammaException::~LibgammaException() throw()
	{
		/* do nothing */
	}

	/**
	 * Get the error as a string
	 */
	const char *
	LibgammaException::what() const throw()
	{
		if (this->error_code < 0)
			return libgamma_name_of_error(this->error_code);
		else
			return strerror(this->error_code);
	}

#if defined(__GNUC__)
# pragma GCC diagnostic pop
#endif


	/**
	 * 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)
	{
		if (error_code == LIBGAMMA_ERRNO_SET)
			error_code = errno;
		return LibgammaException(error_code);
	}


	/**
	 * Group that the user needs to be a member of if
	 * `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned
	 */
	GroupGid group_gid;

	/**
	 * 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
	 */
	GroupName group_name;
}