aboutsummaryrefslogtreecommitdiffstats
path: root/src/libgamma_native_error.pyx
blob: 6963a44c2e149538195d332e15c48779317b43ee (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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# -*- python -*-
'''
pylibgamma — Python 3 wrapper for libgamma
Copyright © 2014  Mattias Andrée (maandree@member.fsf.org)

This library 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 library 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 library.  If not, see <http://www.gnu.org/licenses/>.
'''

cimport cython

from posix.unistd cimport gid_t
from libc.string cimport strerror as c_strerror


cdef extern gid_t libgamma_group_gid_get() nogil
cdef extern void libgamma_group_gid_set(gid_t) nogil
'''
Group that the user needs to be a member of if
`LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned.
'''

cdef extern const char* libgamma_group_name_get() nogil
cdef extern void libgamma_group_name_set(const char*) nogil
'''
Group that the user needs to be a member of if
`LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned,
`NULL` if the name of the group `libgamma_group_gid`
cannot be determined.
'''


cdef extern void libgamma_perror(const char* name, int error_code) nogil
'''
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.
'''

cdef extern const char* libgamma_name_of_error(int value) nogil
'''
Returns the name of the definition associated with a `libgamma` error code.

@param   value  The error code.
@return         The name of the definition associated with the error code,
                `NULL` if the error code does not exist. The return string
                should not be `free`:d.
'''

cdef extern int libgamma_value_of_error(const char* name) nogil
'''
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 does is `NULL`
               or does not refer to a `libgamma` error.
'''



def libgamma_native_get_group_gid() -> int:
    '''
    Getter.
    
    Group that the user needs to be a member of if
    `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned.
    '''
    return int(libgamma_group_gid_get())

def libgamma_native_set_group_gid(gid : int):
    '''
    Setter.
    
    Group that the user needs to be a member of if
    `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned.
    '''
    libgamma_group_gid_set(<int>gid)


def libgamma_native_get_group_name() -> str:
    '''
    Getter.
    
    Group that the user needs to be a member of if
    `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned,
    `None` if the name of the group `libgamma_group_gid`
    cannot be determined.
    '''
    cdef const char* group_name
    cdef bytes bs
    group_name = libgamma_group_name_get()
    if group_name is NULL:
        return None
    bs = group_name
    return bs.decode('utf-8', 'strict')

def libgamma_native_set_group_name(name : str):
    '''
    Setter.
    
    Group that the user needs to be a member of if
    `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned,
    `None` if the name of the group `libgamma_group_gid`
    cannot be determined.
    '''
    cdef const char* group_name
    cdef bytes bs
    if name is None:
        libgamma_group_name_set(<char*>NULL)
        return
    bs = name.encode('utf-8') + bytes([0])
    group_name = bs
    libgamma_group_name_set(group_name)


def libgamma_native_perror(name : str, error_code : int):
    '''
    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.
    '''
    cdef bytes bs
    bs = name.encode('utf-8') + bytes([0])
    libgamma_perror(bs, <int>error_code)


def libgamma_native_name_of_error(value : int) -> str:
    '''
    Returns the name of the definition associated with a `libgamma` error code.
    
    @param   value  The error code.
    @return         The name of the definition associated with the error code,
                    `None` if the error code does not exist.
    '''
    cdef const char* name
    cdef bytes bs
    name = libgamma_name_of_error(<int>value)
    if name is NULL:
        return None
    bs = name
    return bs.decode('utf-8', 'strict')


def libgamma_native_value_of_error(name : str) -> int:
    '''
    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 `None`,
                   or does not refer to a `libgamma` error.
    '''
    cdef bytes bs
    if name is None:
        return 0
    bs = name.encode('utf-8') + bytes([0])
    return int(libgamma_value_of_error(bs))
    

def strerror(error : int) -> str:
    '''
    Get a textual description of an error.
    
    @param   error  The number of the error.
    @return         The description of the error.
    '''
    cdef const char* text
    cdef bytes bs
    text = c_strerror(<int>error)
    bs = text
    return bs.decode('utf-8', 'strict')