aboutsummaryrefslogtreecommitdiffstats
path: root/src/libgamma/LibgammaException.java
blob: 619c6538aaee51ab8b5499dfc5a8549574c93c84 (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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
/**
 * jlibgamma — Display server abstraction layer for gamma ramp and Java
 * 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/>.
 */
package libgamma;


/**
 * <p>
 *   Class of <tt>libgamma</tt> exceptions including
 *   native system exceptions.
 * </p>
 * <p>
 *   The class contains constants with <tt>libgamma</tt> error
 *   codes. It does however not contain system error codes.
 * </p>
 */
public class LibgammaException extends Exception
{
    /**
     * This error code is never used. It is only provided
     * so you know its error code if you plan to iterate
     * over all <tt>libgamma</tt> error codes.
     */
    public static final int LIBGAMMA_ERRNO_SET = -1;
    
    /**
     * The selected adjustment method does not exist
     * or has been excluded at compile-time.
     */
    public static final int LIBGAMMA_NO_SUCH_ADJUSTMENT_METHOD = -2;
    
    /**
     * The selected site does not exist.
     */
    public static final int LIBGAMMA_NO_SUCH_SITE = -3;
    
    /**
     * The selected partition does not exist.
     */
    public static final int LIBGAMMA_NO_SUCH_PARTITION = -4;
    
    /**
     * The selected CRTC does not exist.
     */
    public static final int LIBGAMMA_NO_SUCH_CRTC = -5;
    
    /**
     * Counter overflowed when counting the number
     * of available items.
     */
    public static final int LIBGAMMA_IMPOSSIBLE_AMOUNT = -6;
    
    /**
     * The selected connector is disabled, it does
     * not have a CRTC.
     */
    public static final int LIBGAMMA_CONNECTOR_DISABLED = -7;
    
    /**
     * The selected CRTC could not be opened,
     * reason unknown.
     */
    public static final int LIBGAMMA_OPEN_CRTC_FAILED = -8;
    
    /**
     * The CRTC information field is not supported
     * by the adjustment method.
     */
    public static final int LIBGAMMA_CRTC_INFO_NOT_SUPPORTED = -9;
    
    /**
     * Failed to read the current gamma ramps for
     * the selected CRTC, reason unknown.
     */
    public static final int LIBGAMMA_GAMMA_RAMP_READ_FAILED = -10;
    
    /**
     * Failed to write the current gamma ramps for
     * the selected CRTC, reason unknown.
     */
    public static final int LIBGAMMA_GAMMA_RAMP_WRITE_FAILED = -11;
    
    /**
     * The specified ramp sizes does not match the
     * ramps sizes returned by the adjustment methods
     * in response to the query/command.
     */
    public static final int LIBGAMMA_GAMMA_RAMP_SIZE_CHANGED = -12;
    
    /**
     * The specified ramp sizes are not identical
     * which is required by the adjustment method.
     * (Only returned in debug mode.)
     */
    public static final int LIBGAMMA_MIXED_GAMMA_RAMP_SIZE = -13;
    
    /**
     * The specified ramp sizes are not supported
     * by the adjustment method.
     * (Only returned in debug mode.)
     */
    public static final int LIBGAMMA_WRONG_GAMMA_RAMP_SIZE = -14;
    
    /**
     * The adjustment method reported that the gamma
     * ramps size is 1, or perhaps even zero or negative.
     */
    public static final int LIBGAMMA_SINGLETON_GAMMA_RAMP = -15;
    
    /**
     * The adjustment method failed to list
     * available CRTC:s, reason unknown.
     */
    public static final int LIBGAMMA_LIST_CRTCS_FAILED = -16;
    
    /**
     * Failed to acquire mode resources from the
     * adjustment method.
     */
    public static final int LIBGAMMA_ACQUIRING_MODE_RESOURCES_FAILED = -17;
    
    /**
     * The adjustment method reported that a negative
     * number of partitions exists in the site.
     */
    public static final int LIBGAMMA_NEGATIVE_PARTITION_COUNT = -18;
    
    /**
     * The adjustment method reported that a negative
     * number of CRTC:s exists in the partition.
     */
    public static final int LIBGAMMA_NEGATIVE_CRTC_COUNT = -19;
    
    /**
     * Device cannot be access becauses of
     * insufficient permissions.
     */
    public static final int LIBGAMMA_DEVICE_RESTRICTED = -20;
    
    /**
     * Device cannot be access, reason unknown.
     */
    public static final int LIBGAMMA_DEVICE_ACCESS_FAILED = -21;
    
    /**
     * Device cannot be access, membership of the
     * {@link #group_gid} (named by {@link #group_name}
     * (can be {@code null}, if so <tt>errno</tt> may have
     * been set to tell why)) is required.
     */
    public static final int LIBGAMMA_DEVICE_REQUIRE_GROUP = -22;
    
    /**
     * The graphics card appear to have been removed.
     */
    public static final int LIBGAMMA_GRAPHICS_CARD_REMOVED = -23;
    
    /**
     * The state of the requested information is unknown.
     */
    public static final int LIBGAMMA_STATE_UNKNOWN = -24;
    
    /**
     * Failed to determine which connector the
     * CRTC belongs to.
     */
    public static final int LIBGAMMA_CONNECTOR_UNKNOWN = -25;
    
    /**
     * The detected connector type is not listed
     * in this library and has to be updated.
     */
    public static final int LIBGAMMA_CONNECTOR_TYPE_NOT_RECOGNISED = -26;
    
    /**
     * The detected subpixel order is not listed
     * in this library and has to be updated.
     */
    public static final int LIBGAMMA_SUBPIXEL_ORDER_NOT_RECOGNISED = -27;
    
    /**
     * The length of the EDID does not match that
     * of any supported EDID structure revision.
     */
    public static final int LIBGAMMA_EDID_LENGTH_UNSUPPORTED = -28;
    
    /**
     * The magic number in the EDID does not match
     * that of any supported EDID structure revision.
     */
    public static final int LIBGAMMA_EDID_WRONG_MAGIC_NUMBER = -29;
    
    /**
     * The EDID structure revision used by the
     * mointor is not supported.
     */
    public static final int LIBGAMMA_EDID_REVISION_UNSUPPORTED = -30;
    
    /**
     * The gamma characteristics field in the EDID
     * is left unspecified.
     * (This could be considered a non-error.)
     */
    public static final int LIBGAMMA_GAMMA_NOT_SPECIFIED = -31;
    
    /**
     * The checksum in the EDID is incorrect, all
     * request information has been provided
     * by you cannot count on it.
     */
    public static final int LIBGAMMA_EDID_CHECKSUM_ERROR = -32;
    
    /**
     * Both of the errors {@link #LIBGAMMA_GAMMA_NOT_SPECIFIED}
     * and {@link #LIBGAMMA_EDID_CHECKSUM_ERROR} have occurred.
     */
    public static final int LIBGAMMA_GAMMA_NOT_SPECIFIED_AND_EDID_CHECKSUM_ERROR = -33;
    
    /**
     * Failed to query the gamma ramps size from the
     * adjustment method, reason unknown.
     */
    public static final int LIBGAMMA_GAMMA_RAMPS_SIZE_QUERY_FAILED = -34;
    
    /**
     * The selected partition could not be opened,
     * reason unknown.
     */
    public static final int LIBGAMMA_OPEN_PARTITION_FAILED = -35;
    
    /**
     * The selected site could not be opened,
     * reason unknown.
     */
    public static final int LIBGAMMA_OPEN_SITE_FAILED = -36;
    
    /**
     * Failed to query the adjustment method for
     * its protocol version, reason unknown.
     */
    public static final int LIBGAMMA_PROTOCOL_VERSION_QUERY_FAILED = -37;
    
    /**
     * The adjustment method's version of its
     * protocol is not supported.
     */
    public static final int LIBGAMMA_PROTOCOL_VERSION_NOT_SUPPORTED = -38;
    
    /**
     * The adjustment method failed to list
     * available partitions, reason unknown.
     */
    public static final int LIBGAMMA_LIST_PARTITIONS_FAILED = -39;
    
    /**
     * Partition exists by index, but the partition
     * at that index does not exist.
     */
    public static final int LIBGAMMA_NULL_PARTITION = -40;
    
    /**
     * There is not mointor connected to the
     * connector of the selected CRTC.
     */
    public static final int LIBGAMMA_NOT_CONNECTED = -41;
    
    /**
     * Data extraction from a reply from the
     * adjustment method failed, reason unknown.
     */
    public static final int LIBGAMMA_REPLY_VALUE_EXTRACTION_FAILED = -42;
    
    /**
     * No EDID property was found on the output.
     */
    public static final int LIBGAMMA_EDID_NOT_FOUND = -43;
    
    /**
     * Failed to list properties on the output,
     * reason unknown.
     */
    public static final int LIBGAMMA_LIST_PROPERTIES_FAILED = -44;
    
    /**
     * Failed to query a property's value from
     * the output, reason unknown.
     */
    public static final int LIBGAMMA_PROPERTY_VALUE_QUERY_FAILED = -45;
    
    /**
     * A request for information on an output
     * failed, reason unknown.
     */
    public static final int LIBGAMMA_OUTPUT_INFORMATION_QUERY_FAILED = -46;
    
    
    /**
     * The number of the libgamma error with the
     * lowest number. If this is lower than the
     * number your program thinks it should be sould
     * update your program for new errors.
     */
    public static final int LIBGAMMA_ERROR_MIN = -46;
    
    
    
    /**
     * Constructor.
     * 
     * @param  error_code  The error code.
     */
    public LibgammaException(int error_code)
    {
	this.error_code = error_code;
	if (error_code == LIBGAMMA_DEVICE_REQUIRE_GROUP)
	{   this.group_gid = libgamma_group_gid();
	    this.group_name = libgamma_group_name();
	}
	else
	{   this.group_gid = 0;
	    this.group_name = null;
	}
	if (error_code < 0)
	    this.string = name_of_error(error_code);
	else
	    this.string = strerror(error_code);
    }
    
    
    /**
     * The error code.
     * Cannot be {@link #LIBGAMMA_ERRNO_SET}.
     */
    public final int error_code;
    
    /**
     * Group that the user needs to be a member of if
     * {@link #error_code} is {@link #LIBGAMMA_DEVICE_REQUIRE_GROUP}.
     */
    public final int group_gid;
    
    /**
     * Group that the user needs to be a member of if
     * {@link #error_code} is {@link #LIBGAMMA_DEVICE_REQUIRE_GROUP},
     * {@code null} if the name of the group {@link #group_gid}
     * cannot be determined.
     */
    public final String group_name;
    
    /**
     * Name of textual description of the error.
     */
    public final String string;
    
    
    
    /**
     * Returns the name of the definition associated with
     * a <tt>libgamma</tt> error code.
     * 
     * @param   value  The error code.
     * @return         The name of the definition associated with the error code,
     *                 {@code null} if the error code does not exist.
     */
    public static native String name_of_error(int value);
    
    /**
     * Return the value of a <tt>libgamma</tt> 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 {@code null}
     *                or does not refer to a <tt>libgamma</tt> error.
     */
    public static native int value_of_error(String name);
    
    
    /**
     * Acquire the value that should go to {@link #group_gid}.
     * 
     * @return  The value that should go to {@link #group_gid}.
     */
    private static native int libgamma_group_gid();
    
    /**
     * Acquire the value that should go to {@link #group_name}.
     * 
     * @return  The value that should go to {@link #group_name}.
     */
    private static native String libgamma_group_name();
    
    /**
     * Get a textual description of a system error code.
     * 
     * @param   error_code  The error code.
     * @return              A textual description of the error code.
     */
    private static native String strerror(int error_code);
    
}