Branch data Line data Source code
1 : : /* Output of mkheader.awk. DO NOT EDIT. -*- buffer-read-only: t -*- */
2 : :
3 : : /* gpg-error.h - Public interface to libgpg-error.
4 : : Copyright (C) 2003, 2004, 2010 g10 Code GmbH
5 : :
6 : : This file is part of libgpg-error.
7 : :
8 : : libgpg-error is free software; you can redistribute it and/or
9 : : modify it under the terms of the GNU Lesser General Public License
10 : : as published by the Free Software Foundation; either version 2.1 of
11 : : the License, or (at your option) any later version.
12 : :
13 : : libgpg-error is distributed in the hope that it will be useful, but
14 : : WITHOUT ANY WARRANTY; without even the implied warranty of
15 : : MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 : : Lesser General Public License for more details.
17 : :
18 : : You should have received a copy of the GNU Lesser General Public
19 : : License along with this program; if not, see <http://www.gnu.org/licenses/>.
20 : : */
21 : :
22 : :
23 : : #ifndef GPG_ERROR_H
24 : : #define GPG_ERROR_H 1
25 : :
26 : : #include <stddef.h>
27 : :
28 : : #ifdef __GNUC__
29 : : #define GPG_ERR_INLINE __inline__
30 : : #elif __STDC_VERSION__ >= 199901L
31 : : #define GPG_ERR_INLINE inline
32 : : #else
33 : : #ifndef GPG_ERR_INLINE
34 : : #define GPG_ERR_INLINE
35 : : #endif
36 : : #endif
37 : :
38 : :
39 : : #ifdef __cplusplus
40 : : extern "C" {
41 : : #if 0 /* just to make Emacs auto-indent happy */
42 : : }
43 : : #endif
44 : : #endif /* __cplusplus */
45 : :
46 : : /* The GnuPG project consists of many components. Error codes are
47 : : exchanged between all components. The common error codes and their
48 : : user-presentable descriptions are kept into a shared library to
49 : : allow adding new error codes and components without recompiling any
50 : : of the other components. The interface will not change in a
51 : : backward incompatible way.
52 : :
53 : : An error code together with an error source build up an error
54 : : value. As the error value is been passed from one component to
55 : : another, it preserver the information about the source and nature
56 : : of the error.
57 : :
58 : : A component of the GnuPG project can define the following macros to
59 : : tune the behaviour of the library:
60 : :
61 : : GPG_ERR_SOURCE_DEFAULT: Define to an error source of type
62 : : gpg_err_source_t to make that source the default for gpg_error().
63 : : Otherwise GPG_ERR_SOURCE_UNKNOWN is used as default.
64 : :
65 : : GPG_ERR_ENABLE_GETTEXT_MACROS: Define to provide macros to map the
66 : : internal gettext API to standard names. This has only an effect on
67 : : Windows platforms. */
68 : :
69 : :
70 : : /* The error source type gpg_err_source_t.
71 : :
72 : : Where as the Poo out of a welle small
73 : : Taketh his firste springing and his sours.
74 : : --Chaucer. */
75 : :
76 : : /* Only use free slots, never change or reorder the existing
77 : : entries. */
78 : : typedef enum
79 : : {
80 : : GPG_ERR_SOURCE_UNKNOWN = 0,
81 : : GPG_ERR_SOURCE_GCRYPT = 1,
82 : : GPG_ERR_SOURCE_GPG = 2,
83 : : GPG_ERR_SOURCE_GPGSM = 3,
84 : : GPG_ERR_SOURCE_GPGAGENT = 4,
85 : : GPG_ERR_SOURCE_PINENTRY = 5,
86 : : GPG_ERR_SOURCE_SCD = 6,
87 : : GPG_ERR_SOURCE_GPGME = 7,
88 : : GPG_ERR_SOURCE_KEYBOX = 8,
89 : : GPG_ERR_SOURCE_KSBA = 9,
90 : : GPG_ERR_SOURCE_DIRMNGR = 10,
91 : : GPG_ERR_SOURCE_GSTI = 11,
92 : : GPG_ERR_SOURCE_GPA = 12,
93 : : GPG_ERR_SOURCE_KLEO = 13,
94 : : GPG_ERR_SOURCE_G13 = 14,
95 : : GPG_ERR_SOURCE_ANY = 31,
96 : : GPG_ERR_SOURCE_USER_1 = 32,
97 : : GPG_ERR_SOURCE_USER_2 = 33,
98 : : GPG_ERR_SOURCE_USER_3 = 34,
99 : : GPG_ERR_SOURCE_USER_4 = 35,
100 : :
101 : : /* This is one more than the largest allowed entry. */
102 : : GPG_ERR_SOURCE_DIM = 128
103 : : } gpg_err_source_t;
104 : :
105 : :
106 : : /* The error code type gpg_err_code_t. */
107 : :
108 : : /* Only use free slots, never change or reorder the existing
109 : : entries. */
110 : : typedef enum
111 : : {
112 : : GPG_ERR_NO_ERROR = 0,
113 : : GPG_ERR_GENERAL = 1,
114 : : GPG_ERR_UNKNOWN_PACKET = 2,
115 : : GPG_ERR_UNKNOWN_VERSION = 3,
116 : : GPG_ERR_PUBKEY_ALGO = 4,
117 : : GPG_ERR_DIGEST_ALGO = 5,
118 : : GPG_ERR_BAD_PUBKEY = 6,
119 : : GPG_ERR_BAD_SECKEY = 7,
120 : : GPG_ERR_BAD_SIGNATURE = 8,
121 : : GPG_ERR_NO_PUBKEY = 9,
122 : : GPG_ERR_CHECKSUM = 10,
123 : : GPG_ERR_BAD_PASSPHRASE = 11,
124 : : GPG_ERR_CIPHER_ALGO = 12,
125 : : GPG_ERR_KEYRING_OPEN = 13,
126 : : GPG_ERR_INV_PACKET = 14,
127 : : GPG_ERR_INV_ARMOR = 15,
128 : : GPG_ERR_NO_USER_ID = 16,
129 : : GPG_ERR_NO_SECKEY = 17,
130 : : GPG_ERR_WRONG_SECKEY = 18,
131 : : GPG_ERR_BAD_KEY = 19,
132 : : GPG_ERR_COMPR_ALGO = 20,
133 : : GPG_ERR_NO_PRIME = 21,
134 : : GPG_ERR_NO_ENCODING_METHOD = 22,
135 : : GPG_ERR_NO_ENCRYPTION_SCHEME = 23,
136 : : GPG_ERR_NO_SIGNATURE_SCHEME = 24,
137 : : GPG_ERR_INV_ATTR = 25,
138 : : GPG_ERR_NO_VALUE = 26,
139 : : GPG_ERR_NOT_FOUND = 27,
140 : : GPG_ERR_VALUE_NOT_FOUND = 28,
141 : : GPG_ERR_SYNTAX = 29,
142 : : GPG_ERR_BAD_MPI = 30,
143 : : GPG_ERR_INV_PASSPHRASE = 31,
144 : : GPG_ERR_SIG_CLASS = 32,
145 : : GPG_ERR_RESOURCE_LIMIT = 33,
146 : : GPG_ERR_INV_KEYRING = 34,
147 : : GPG_ERR_TRUSTDB = 35,
148 : : GPG_ERR_BAD_CERT = 36,
149 : : GPG_ERR_INV_USER_ID = 37,
150 : : GPG_ERR_UNEXPECTED = 38,
151 : : GPG_ERR_TIME_CONFLICT = 39,
152 : : GPG_ERR_KEYSERVER = 40,
153 : : GPG_ERR_WRONG_PUBKEY_ALGO = 41,
154 : : GPG_ERR_TRIBUTE_TO_D_A = 42,
155 : : GPG_ERR_WEAK_KEY = 43,
156 : : GPG_ERR_INV_KEYLEN = 44,
157 : : GPG_ERR_INV_ARG = 45,
158 : : GPG_ERR_BAD_URI = 46,
159 : : GPG_ERR_INV_URI = 47,
160 : : GPG_ERR_NETWORK = 48,
161 : : GPG_ERR_UNKNOWN_HOST = 49,
162 : : GPG_ERR_SELFTEST_FAILED = 50,
163 : : GPG_ERR_NOT_ENCRYPTED = 51,
164 : : GPG_ERR_NOT_PROCESSED = 52,
165 : : GPG_ERR_UNUSABLE_PUBKEY = 53,
166 : : GPG_ERR_UNUSABLE_SECKEY = 54,
167 : : GPG_ERR_INV_VALUE = 55,
168 : : GPG_ERR_BAD_CERT_CHAIN = 56,
169 : : GPG_ERR_MISSING_CERT = 57,
170 : : GPG_ERR_NO_DATA = 58,
171 : : GPG_ERR_BUG = 59,
172 : : GPG_ERR_NOT_SUPPORTED = 60,
173 : : GPG_ERR_INV_OP = 61,
174 : : GPG_ERR_TIMEOUT = 62,
175 : : GPG_ERR_INTERNAL = 63,
176 : : GPG_ERR_EOF_GCRYPT = 64,
177 : : GPG_ERR_INV_OBJ = 65,
178 : : GPG_ERR_TOO_SHORT = 66,
179 : : GPG_ERR_TOO_LARGE = 67,
180 : : GPG_ERR_NO_OBJ = 68,
181 : : GPG_ERR_NOT_IMPLEMENTED = 69,
182 : : GPG_ERR_CONFLICT = 70,
183 : : GPG_ERR_INV_CIPHER_MODE = 71,
184 : : GPG_ERR_INV_FLAG = 72,
185 : : GPG_ERR_INV_HANDLE = 73,
186 : : GPG_ERR_TRUNCATED = 74,
187 : : GPG_ERR_INCOMPLETE_LINE = 75,
188 : : GPG_ERR_INV_RESPONSE = 76,
189 : : GPG_ERR_NO_AGENT = 77,
190 : : GPG_ERR_AGENT = 78,
191 : : GPG_ERR_INV_DATA = 79,
192 : : GPG_ERR_ASSUAN_SERVER_FAULT = 80,
193 : : GPG_ERR_ASSUAN = 81,
194 : : GPG_ERR_INV_SESSION_KEY = 82,
195 : : GPG_ERR_INV_SEXP = 83,
196 : : GPG_ERR_UNSUPPORTED_ALGORITHM = 84,
197 : : GPG_ERR_NO_PIN_ENTRY = 85,
198 : : GPG_ERR_PIN_ENTRY = 86,
199 : : GPG_ERR_BAD_PIN = 87,
200 : : GPG_ERR_INV_NAME = 88,
201 : : GPG_ERR_BAD_DATA = 89,
202 : : GPG_ERR_INV_PARAMETER = 90,
203 : : GPG_ERR_WRONG_CARD = 91,
204 : : GPG_ERR_NO_DIRMNGR = 92,
205 : : GPG_ERR_DIRMNGR = 93,
206 : : GPG_ERR_CERT_REVOKED = 94,
207 : : GPG_ERR_NO_CRL_KNOWN = 95,
208 : : GPG_ERR_CRL_TOO_OLD = 96,
209 : : GPG_ERR_LINE_TOO_LONG = 97,
210 : : GPG_ERR_NOT_TRUSTED = 98,
211 : : GPG_ERR_CANCELED = 99,
212 : : GPG_ERR_BAD_CA_CERT = 100,
213 : : GPG_ERR_CERT_EXPIRED = 101,
214 : : GPG_ERR_CERT_TOO_YOUNG = 102,
215 : : GPG_ERR_UNSUPPORTED_CERT = 103,
216 : : GPG_ERR_UNKNOWN_SEXP = 104,
217 : : GPG_ERR_UNSUPPORTED_PROTECTION = 105,
218 : : GPG_ERR_CORRUPTED_PROTECTION = 106,
219 : : GPG_ERR_AMBIGUOUS_NAME = 107,
220 : : GPG_ERR_CARD = 108,
221 : : GPG_ERR_CARD_RESET = 109,
222 : : GPG_ERR_CARD_REMOVED = 110,
223 : : GPG_ERR_INV_CARD = 111,
224 : : GPG_ERR_CARD_NOT_PRESENT = 112,
225 : : GPG_ERR_NO_PKCS15_APP = 113,
226 : : GPG_ERR_NOT_CONFIRMED = 114,
227 : : GPG_ERR_CONFIGURATION = 115,
228 : : GPG_ERR_NO_POLICY_MATCH = 116,
229 : : GPG_ERR_INV_INDEX = 117,
230 : : GPG_ERR_INV_ID = 118,
231 : : GPG_ERR_NO_SCDAEMON = 119,
232 : : GPG_ERR_SCDAEMON = 120,
233 : : GPG_ERR_UNSUPPORTED_PROTOCOL = 121,
234 : : GPG_ERR_BAD_PIN_METHOD = 122,
235 : : GPG_ERR_CARD_NOT_INITIALIZED = 123,
236 : : GPG_ERR_UNSUPPORTED_OPERATION = 124,
237 : : GPG_ERR_WRONG_KEY_USAGE = 125,
238 : : GPG_ERR_NOTHING_FOUND = 126,
239 : : GPG_ERR_WRONG_BLOB_TYPE = 127,
240 : : GPG_ERR_MISSING_VALUE = 128,
241 : : GPG_ERR_HARDWARE = 129,
242 : : GPG_ERR_PIN_BLOCKED = 130,
243 : : GPG_ERR_USE_CONDITIONS = 131,
244 : : GPG_ERR_PIN_NOT_SYNCED = 132,
245 : : GPG_ERR_INV_CRL = 133,
246 : : GPG_ERR_BAD_BER = 134,
247 : : GPG_ERR_INV_BER = 135,
248 : : GPG_ERR_ELEMENT_NOT_FOUND = 136,
249 : : GPG_ERR_IDENTIFIER_NOT_FOUND = 137,
250 : : GPG_ERR_INV_TAG = 138,
251 : : GPG_ERR_INV_LENGTH = 139,
252 : : GPG_ERR_INV_KEYINFO = 140,
253 : : GPG_ERR_UNEXPECTED_TAG = 141,
254 : : GPG_ERR_NOT_DER_ENCODED = 142,
255 : : GPG_ERR_NO_CMS_OBJ = 143,
256 : : GPG_ERR_INV_CMS_OBJ = 144,
257 : : GPG_ERR_UNKNOWN_CMS_OBJ = 145,
258 : : GPG_ERR_UNSUPPORTED_CMS_OBJ = 146,
259 : : GPG_ERR_UNSUPPORTED_ENCODING = 147,
260 : : GPG_ERR_UNSUPPORTED_CMS_VERSION = 148,
261 : : GPG_ERR_UNKNOWN_ALGORITHM = 149,
262 : : GPG_ERR_INV_ENGINE = 150,
263 : : GPG_ERR_PUBKEY_NOT_TRUSTED = 151,
264 : : GPG_ERR_DECRYPT_FAILED = 152,
265 : : GPG_ERR_KEY_EXPIRED = 153,
266 : : GPG_ERR_SIG_EXPIRED = 154,
267 : : GPG_ERR_ENCODING_PROBLEM = 155,
268 : : GPG_ERR_INV_STATE = 156,
269 : : GPG_ERR_DUP_VALUE = 157,
270 : : GPG_ERR_MISSING_ACTION = 158,
271 : : GPG_ERR_MODULE_NOT_FOUND = 159,
272 : : GPG_ERR_INV_OID_STRING = 160,
273 : : GPG_ERR_INV_TIME = 161,
274 : : GPG_ERR_INV_CRL_OBJ = 162,
275 : : GPG_ERR_UNSUPPORTED_CRL_VERSION = 163,
276 : : GPG_ERR_INV_CERT_OBJ = 164,
277 : : GPG_ERR_UNKNOWN_NAME = 165,
278 : : GPG_ERR_LOCALE_PROBLEM = 166,
279 : : GPG_ERR_NOT_LOCKED = 167,
280 : : GPG_ERR_PROTOCOL_VIOLATION = 168,
281 : : GPG_ERR_INV_MAC = 169,
282 : : GPG_ERR_INV_REQUEST = 170,
283 : : GPG_ERR_UNKNOWN_EXTN = 171,
284 : : GPG_ERR_UNKNOWN_CRIT_EXTN = 172,
285 : : GPG_ERR_LOCKED = 173,
286 : : GPG_ERR_UNKNOWN_OPTION = 174,
287 : : GPG_ERR_UNKNOWN_COMMAND = 175,
288 : : GPG_ERR_NOT_OPERATIONAL = 176,
289 : : GPG_ERR_NO_PASSPHRASE = 177,
290 : : GPG_ERR_NO_PIN = 178,
291 : : GPG_ERR_NOT_ENABLED = 179,
292 : : GPG_ERR_NO_ENGINE = 180,
293 : : GPG_ERR_MISSING_KEY = 181,
294 : : GPG_ERR_TOO_MANY = 182,
295 : : GPG_ERR_LIMIT_REACHED = 183,
296 : : GPG_ERR_NOT_INITIALIZED = 184,
297 : : GPG_ERR_MISSING_ISSUER_CERT = 185,
298 : : GPG_ERR_FULLY_CANCELED = 198,
299 : : GPG_ERR_UNFINISHED = 199,
300 : : GPG_ERR_BUFFER_TOO_SHORT = 200,
301 : : GPG_ERR_SEXP_INV_LEN_SPEC = 201,
302 : : GPG_ERR_SEXP_STRING_TOO_LONG = 202,
303 : : GPG_ERR_SEXP_UNMATCHED_PAREN = 203,
304 : : GPG_ERR_SEXP_NOT_CANONICAL = 204,
305 : : GPG_ERR_SEXP_BAD_CHARACTER = 205,
306 : : GPG_ERR_SEXP_BAD_QUOTATION = 206,
307 : : GPG_ERR_SEXP_ZERO_PREFIX = 207,
308 : : GPG_ERR_SEXP_NESTED_DH = 208,
309 : : GPG_ERR_SEXP_UNMATCHED_DH = 209,
310 : : GPG_ERR_SEXP_UNEXPECTED_PUNC = 210,
311 : : GPG_ERR_SEXP_BAD_HEX_CHAR = 211,
312 : : GPG_ERR_SEXP_ODD_HEX_NUMBERS = 212,
313 : : GPG_ERR_SEXP_BAD_OCT_CHAR = 213,
314 : : GPG_ERR_ASS_GENERAL = 257,
315 : : GPG_ERR_ASS_ACCEPT_FAILED = 258,
316 : : GPG_ERR_ASS_CONNECT_FAILED = 259,
317 : : GPG_ERR_ASS_INV_RESPONSE = 260,
318 : : GPG_ERR_ASS_INV_VALUE = 261,
319 : : GPG_ERR_ASS_INCOMPLETE_LINE = 262,
320 : : GPG_ERR_ASS_LINE_TOO_LONG = 263,
321 : : GPG_ERR_ASS_NESTED_COMMANDS = 264,
322 : : GPG_ERR_ASS_NO_DATA_CB = 265,
323 : : GPG_ERR_ASS_NO_INQUIRE_CB = 266,
324 : : GPG_ERR_ASS_NOT_A_SERVER = 267,
325 : : GPG_ERR_ASS_NOT_A_CLIENT = 268,
326 : : GPG_ERR_ASS_SERVER_START = 269,
327 : : GPG_ERR_ASS_READ_ERROR = 270,
328 : : GPG_ERR_ASS_WRITE_ERROR = 271,
329 : : GPG_ERR_ASS_TOO_MUCH_DATA = 273,
330 : : GPG_ERR_ASS_UNEXPECTED_CMD = 274,
331 : : GPG_ERR_ASS_UNKNOWN_CMD = 275,
332 : : GPG_ERR_ASS_SYNTAX = 276,
333 : : GPG_ERR_ASS_CANCELED = 277,
334 : : GPG_ERR_ASS_NO_INPUT = 278,
335 : : GPG_ERR_ASS_NO_OUTPUT = 279,
336 : : GPG_ERR_ASS_PARAMETER = 280,
337 : : GPG_ERR_ASS_UNKNOWN_INQUIRE = 281,
338 : : GPG_ERR_USER_1 = 1024,
339 : : GPG_ERR_USER_2 = 1025,
340 : : GPG_ERR_USER_3 = 1026,
341 : : GPG_ERR_USER_4 = 1027,
342 : : GPG_ERR_USER_5 = 1028,
343 : : GPG_ERR_USER_6 = 1029,
344 : : GPG_ERR_USER_7 = 1030,
345 : : GPG_ERR_USER_8 = 1031,
346 : : GPG_ERR_USER_9 = 1032,
347 : : GPG_ERR_USER_10 = 1033,
348 : : GPG_ERR_USER_11 = 1034,
349 : : GPG_ERR_USER_12 = 1035,
350 : : GPG_ERR_USER_13 = 1036,
351 : : GPG_ERR_USER_14 = 1037,
352 : : GPG_ERR_USER_15 = 1038,
353 : : GPG_ERR_USER_16 = 1039,
354 : : GPG_ERR_MISSING_ERRNO = 16381,
355 : : GPG_ERR_UNKNOWN_ERRNO = 16382,
356 : : GPG_ERR_EOF = 16383,
357 : :
358 : : /* The following error codes are used to map system errors. */
359 : : #define GPG_ERR_SYSTEM_ERROR (1 << 15)
360 : : GPG_ERR_E2BIG = GPG_ERR_SYSTEM_ERROR | 0,
361 : : GPG_ERR_EACCES = GPG_ERR_SYSTEM_ERROR | 1,
362 : : GPG_ERR_EADDRINUSE = GPG_ERR_SYSTEM_ERROR | 2,
363 : : GPG_ERR_EADDRNOTAVAIL = GPG_ERR_SYSTEM_ERROR | 3,
364 : : GPG_ERR_EADV = GPG_ERR_SYSTEM_ERROR | 4,
365 : : GPG_ERR_EAFNOSUPPORT = GPG_ERR_SYSTEM_ERROR | 5,
366 : : GPG_ERR_EAGAIN = GPG_ERR_SYSTEM_ERROR | 6,
367 : : GPG_ERR_EALREADY = GPG_ERR_SYSTEM_ERROR | 7,
368 : : GPG_ERR_EAUTH = GPG_ERR_SYSTEM_ERROR | 8,
369 : : GPG_ERR_EBACKGROUND = GPG_ERR_SYSTEM_ERROR | 9,
370 : : GPG_ERR_EBADE = GPG_ERR_SYSTEM_ERROR | 10,
371 : : GPG_ERR_EBADF = GPG_ERR_SYSTEM_ERROR | 11,
372 : : GPG_ERR_EBADFD = GPG_ERR_SYSTEM_ERROR | 12,
373 : : GPG_ERR_EBADMSG = GPG_ERR_SYSTEM_ERROR | 13,
374 : : GPG_ERR_EBADR = GPG_ERR_SYSTEM_ERROR | 14,
375 : : GPG_ERR_EBADRPC = GPG_ERR_SYSTEM_ERROR | 15,
376 : : GPG_ERR_EBADRQC = GPG_ERR_SYSTEM_ERROR | 16,
377 : : GPG_ERR_EBADSLT = GPG_ERR_SYSTEM_ERROR | 17,
378 : : GPG_ERR_EBFONT = GPG_ERR_SYSTEM_ERROR | 18,
379 : : GPG_ERR_EBUSY = GPG_ERR_SYSTEM_ERROR | 19,
380 : : GPG_ERR_ECANCELED = GPG_ERR_SYSTEM_ERROR | 20,
381 : : GPG_ERR_ECHILD = GPG_ERR_SYSTEM_ERROR | 21,
382 : : GPG_ERR_ECHRNG = GPG_ERR_SYSTEM_ERROR | 22,
383 : : GPG_ERR_ECOMM = GPG_ERR_SYSTEM_ERROR | 23,
384 : : GPG_ERR_ECONNABORTED = GPG_ERR_SYSTEM_ERROR | 24,
385 : : GPG_ERR_ECONNREFUSED = GPG_ERR_SYSTEM_ERROR | 25,
386 : : GPG_ERR_ECONNRESET = GPG_ERR_SYSTEM_ERROR | 26,
387 : : GPG_ERR_ED = GPG_ERR_SYSTEM_ERROR | 27,
388 : : GPG_ERR_EDEADLK = GPG_ERR_SYSTEM_ERROR | 28,
389 : : GPG_ERR_EDEADLOCK = GPG_ERR_SYSTEM_ERROR | 29,
390 : : GPG_ERR_EDESTADDRREQ = GPG_ERR_SYSTEM_ERROR | 30,
391 : : GPG_ERR_EDIED = GPG_ERR_SYSTEM_ERROR | 31,
392 : : GPG_ERR_EDOM = GPG_ERR_SYSTEM_ERROR | 32,
393 : : GPG_ERR_EDOTDOT = GPG_ERR_SYSTEM_ERROR | 33,
394 : : GPG_ERR_EDQUOT = GPG_ERR_SYSTEM_ERROR | 34,
395 : : GPG_ERR_EEXIST = GPG_ERR_SYSTEM_ERROR | 35,
396 : : GPG_ERR_EFAULT = GPG_ERR_SYSTEM_ERROR | 36,
397 : : GPG_ERR_EFBIG = GPG_ERR_SYSTEM_ERROR | 37,
398 : : GPG_ERR_EFTYPE = GPG_ERR_SYSTEM_ERROR | 38,
399 : : GPG_ERR_EGRATUITOUS = GPG_ERR_SYSTEM_ERROR | 39,
400 : : GPG_ERR_EGREGIOUS = GPG_ERR_SYSTEM_ERROR | 40,
401 : : GPG_ERR_EHOSTDOWN = GPG_ERR_SYSTEM_ERROR | 41,
402 : : GPG_ERR_EHOSTUNREACH = GPG_ERR_SYSTEM_ERROR | 42,
403 : : GPG_ERR_EIDRM = GPG_ERR_SYSTEM_ERROR | 43,
404 : : GPG_ERR_EIEIO = GPG_ERR_SYSTEM_ERROR | 44,
405 : : GPG_ERR_EILSEQ = GPG_ERR_SYSTEM_ERROR | 45,
406 : : GPG_ERR_EINPROGRESS = GPG_ERR_SYSTEM_ERROR | 46,
407 : : GPG_ERR_EINTR = GPG_ERR_SYSTEM_ERROR | 47,
408 : : GPG_ERR_EINVAL = GPG_ERR_SYSTEM_ERROR | 48,
409 : : GPG_ERR_EIO = GPG_ERR_SYSTEM_ERROR | 49,
410 : : GPG_ERR_EISCONN = GPG_ERR_SYSTEM_ERROR | 50,
411 : : GPG_ERR_EISDIR = GPG_ERR_SYSTEM_ERROR | 51,
412 : : GPG_ERR_EISNAM = GPG_ERR_SYSTEM_ERROR | 52,
413 : : GPG_ERR_EL2HLT = GPG_ERR_SYSTEM_ERROR | 53,
414 : : GPG_ERR_EL2NSYNC = GPG_ERR_SYSTEM_ERROR | 54,
415 : : GPG_ERR_EL3HLT = GPG_ERR_SYSTEM_ERROR | 55,
416 : : GPG_ERR_EL3RST = GPG_ERR_SYSTEM_ERROR | 56,
417 : : GPG_ERR_ELIBACC = GPG_ERR_SYSTEM_ERROR | 57,
418 : : GPG_ERR_ELIBBAD = GPG_ERR_SYSTEM_ERROR | 58,
419 : : GPG_ERR_ELIBEXEC = GPG_ERR_SYSTEM_ERROR | 59,
420 : : GPG_ERR_ELIBMAX = GPG_ERR_SYSTEM_ERROR | 60,
421 : : GPG_ERR_ELIBSCN = GPG_ERR_SYSTEM_ERROR | 61,
422 : : GPG_ERR_ELNRNG = GPG_ERR_SYSTEM_ERROR | 62,
423 : : GPG_ERR_ELOOP = GPG_ERR_SYSTEM_ERROR | 63,
424 : : GPG_ERR_EMEDIUMTYPE = GPG_ERR_SYSTEM_ERROR | 64,
425 : : GPG_ERR_EMFILE = GPG_ERR_SYSTEM_ERROR | 65,
426 : : GPG_ERR_EMLINK = GPG_ERR_SYSTEM_ERROR | 66,
427 : : GPG_ERR_EMSGSIZE = GPG_ERR_SYSTEM_ERROR | 67,
428 : : GPG_ERR_EMULTIHOP = GPG_ERR_SYSTEM_ERROR | 68,
429 : : GPG_ERR_ENAMETOOLONG = GPG_ERR_SYSTEM_ERROR | 69,
430 : : GPG_ERR_ENAVAIL = GPG_ERR_SYSTEM_ERROR | 70,
431 : : GPG_ERR_ENEEDAUTH = GPG_ERR_SYSTEM_ERROR | 71,
432 : : GPG_ERR_ENETDOWN = GPG_ERR_SYSTEM_ERROR | 72,
433 : : GPG_ERR_ENETRESET = GPG_ERR_SYSTEM_ERROR | 73,
434 : : GPG_ERR_ENETUNREACH = GPG_ERR_SYSTEM_ERROR | 74,
435 : : GPG_ERR_ENFILE = GPG_ERR_SYSTEM_ERROR | 75,
436 : : GPG_ERR_ENOANO = GPG_ERR_SYSTEM_ERROR | 76,
437 : : GPG_ERR_ENOBUFS = GPG_ERR_SYSTEM_ERROR | 77,
438 : : GPG_ERR_ENOCSI = GPG_ERR_SYSTEM_ERROR | 78,
439 : : GPG_ERR_ENODATA = GPG_ERR_SYSTEM_ERROR | 79,
440 : : GPG_ERR_ENODEV = GPG_ERR_SYSTEM_ERROR | 80,
441 : : GPG_ERR_ENOENT = GPG_ERR_SYSTEM_ERROR | 81,
442 : : GPG_ERR_ENOEXEC = GPG_ERR_SYSTEM_ERROR | 82,
443 : : GPG_ERR_ENOLCK = GPG_ERR_SYSTEM_ERROR | 83,
444 : : GPG_ERR_ENOLINK = GPG_ERR_SYSTEM_ERROR | 84,
445 : : GPG_ERR_ENOMEDIUM = GPG_ERR_SYSTEM_ERROR | 85,
446 : : GPG_ERR_ENOMEM = GPG_ERR_SYSTEM_ERROR | 86,
447 : : GPG_ERR_ENOMSG = GPG_ERR_SYSTEM_ERROR | 87,
448 : : GPG_ERR_ENONET = GPG_ERR_SYSTEM_ERROR | 88,
449 : : GPG_ERR_ENOPKG = GPG_ERR_SYSTEM_ERROR | 89,
450 : : GPG_ERR_ENOPROTOOPT = GPG_ERR_SYSTEM_ERROR | 90,
451 : : GPG_ERR_ENOSPC = GPG_ERR_SYSTEM_ERROR | 91,
452 : : GPG_ERR_ENOSR = GPG_ERR_SYSTEM_ERROR | 92,
453 : : GPG_ERR_ENOSTR = GPG_ERR_SYSTEM_ERROR | 93,
454 : : GPG_ERR_ENOSYS = GPG_ERR_SYSTEM_ERROR | 94,
455 : : GPG_ERR_ENOTBLK = GPG_ERR_SYSTEM_ERROR | 95,
456 : : GPG_ERR_ENOTCONN = GPG_ERR_SYSTEM_ERROR | 96,
457 : : GPG_ERR_ENOTDIR = GPG_ERR_SYSTEM_ERROR | 97,
458 : : GPG_ERR_ENOTEMPTY = GPG_ERR_SYSTEM_ERROR | 98,
459 : : GPG_ERR_ENOTNAM = GPG_ERR_SYSTEM_ERROR | 99,
460 : : GPG_ERR_ENOTSOCK = GPG_ERR_SYSTEM_ERROR | 100,
461 : : GPG_ERR_ENOTSUP = GPG_ERR_SYSTEM_ERROR | 101,
462 : : GPG_ERR_ENOTTY = GPG_ERR_SYSTEM_ERROR | 102,
463 : : GPG_ERR_ENOTUNIQ = GPG_ERR_SYSTEM_ERROR | 103,
464 : : GPG_ERR_ENXIO = GPG_ERR_SYSTEM_ERROR | 104,
465 : : GPG_ERR_EOPNOTSUPP = GPG_ERR_SYSTEM_ERROR | 105,
466 : : GPG_ERR_EOVERFLOW = GPG_ERR_SYSTEM_ERROR | 106,
467 : : GPG_ERR_EPERM = GPG_ERR_SYSTEM_ERROR | 107,
468 : : GPG_ERR_EPFNOSUPPORT = GPG_ERR_SYSTEM_ERROR | 108,
469 : : GPG_ERR_EPIPE = GPG_ERR_SYSTEM_ERROR | 109,
470 : : GPG_ERR_EPROCLIM = GPG_ERR_SYSTEM_ERROR | 110,
471 : : GPG_ERR_EPROCUNAVAIL = GPG_ERR_SYSTEM_ERROR | 111,
472 : : GPG_ERR_EPROGMISMATCH = GPG_ERR_SYSTEM_ERROR | 112,
473 : : GPG_ERR_EPROGUNAVAIL = GPG_ERR_SYSTEM_ERROR | 113,
474 : : GPG_ERR_EPROTO = GPG_ERR_SYSTEM_ERROR | 114,
475 : : GPG_ERR_EPROTONOSUPPORT = GPG_ERR_SYSTEM_ERROR | 115,
476 : : GPG_ERR_EPROTOTYPE = GPG_ERR_SYSTEM_ERROR | 116,
477 : : GPG_ERR_ERANGE = GPG_ERR_SYSTEM_ERROR | 117,
478 : : GPG_ERR_EREMCHG = GPG_ERR_SYSTEM_ERROR | 118,
479 : : GPG_ERR_EREMOTE = GPG_ERR_SYSTEM_ERROR | 119,
480 : : GPG_ERR_EREMOTEIO = GPG_ERR_SYSTEM_ERROR | 120,
481 : : GPG_ERR_ERESTART = GPG_ERR_SYSTEM_ERROR | 121,
482 : : GPG_ERR_EROFS = GPG_ERR_SYSTEM_ERROR | 122,
483 : : GPG_ERR_ERPCMISMATCH = GPG_ERR_SYSTEM_ERROR | 123,
484 : : GPG_ERR_ESHUTDOWN = GPG_ERR_SYSTEM_ERROR | 124,
485 : : GPG_ERR_ESOCKTNOSUPPORT = GPG_ERR_SYSTEM_ERROR | 125,
486 : : GPG_ERR_ESPIPE = GPG_ERR_SYSTEM_ERROR | 126,
487 : : GPG_ERR_ESRCH = GPG_ERR_SYSTEM_ERROR | 127,
488 : : GPG_ERR_ESRMNT = GPG_ERR_SYSTEM_ERROR | 128,
489 : : GPG_ERR_ESTALE = GPG_ERR_SYSTEM_ERROR | 129,
490 : : GPG_ERR_ESTRPIPE = GPG_ERR_SYSTEM_ERROR | 130,
491 : : GPG_ERR_ETIME = GPG_ERR_SYSTEM_ERROR | 131,
492 : : GPG_ERR_ETIMEDOUT = GPG_ERR_SYSTEM_ERROR | 132,
493 : : GPG_ERR_ETOOMANYREFS = GPG_ERR_SYSTEM_ERROR | 133,
494 : : GPG_ERR_ETXTBSY = GPG_ERR_SYSTEM_ERROR | 134,
495 : : GPG_ERR_EUCLEAN = GPG_ERR_SYSTEM_ERROR | 135,
496 : : GPG_ERR_EUNATCH = GPG_ERR_SYSTEM_ERROR | 136,
497 : : GPG_ERR_EUSERS = GPG_ERR_SYSTEM_ERROR | 137,
498 : : GPG_ERR_EWOULDBLOCK = GPG_ERR_SYSTEM_ERROR | 138,
499 : : GPG_ERR_EXDEV = GPG_ERR_SYSTEM_ERROR | 139,
500 : : GPG_ERR_EXFULL = GPG_ERR_SYSTEM_ERROR | 140,
501 : :
502 : : /* This is one more than the largest allowed entry. */
503 : : GPG_ERR_CODE_DIM = 65536
504 : : } gpg_err_code_t;
505 : :
506 : :
507 : : /* The error value type gpg_error_t. */
508 : :
509 : : /* We would really like to use bit-fields in a struct, but using
510 : : structs as return values can cause binary compatibility issues, in
511 : : particular if you want to do it effeciently (also see
512 : : -freg-struct-return option to GCC). */
513 : : typedef unsigned int gpg_error_t;
514 : :
515 : : /* We use the lowest 16 bits of gpg_error_t for error codes. The 16th
516 : : bit indicates system errors. */
517 : : #define GPG_ERR_CODE_MASK (GPG_ERR_CODE_DIM - 1)
518 : :
519 : : /* Bits 17 to 24 are reserved. */
520 : :
521 : : /* We use the upper 7 bits of gpg_error_t for error sources. */
522 : : #define GPG_ERR_SOURCE_MASK (GPG_ERR_SOURCE_DIM - 1)
523 : : #define GPG_ERR_SOURCE_SHIFT 24
524 : :
525 : : /* The highest bit is reserved. It shouldn't be used to prevent
526 : : potential negative numbers when transmitting error values as
527 : : text. */
528 : :
529 : :
530 : : /* GCC feature test. */
531 : : #undef _GPG_ERR_HAVE_CONSTRUCTOR
532 : : #if __GNUC__
533 : : #define _GPG_ERR_GCC_VERSION (__GNUC__ * 10000 \
534 : : + __GNUC_MINOR__ * 100 \
535 : : + __GNUC_PATCHLEVEL__)
536 : :
537 : : #if _GPG_ERR_GCC_VERSION > 30100
538 : : #define _GPG_ERR_CONSTRUCTOR __attribute__ ((__constructor__))
539 : : #define _GPG_ERR_HAVE_CONSTRUCTOR
540 : : #endif
541 : : #endif
542 : :
543 : : #ifndef _GPG_ERR_CONSTRUCTOR
544 : : #define _GPG_ERR_CONSTRUCTOR
545 : : #endif
546 : :
547 : :
548 : : /* Initialization function. */
549 : :
550 : : /* Initialize the library. This function should be run early. */
551 : : gpg_error_t gpg_err_init (void) _GPG_ERR_CONSTRUCTOR;
552 : :
553 : : /* If this is defined, the library is already initialized by the
554 : : constructor and does not need to be initialized explicitely. */
555 : : #undef GPG_ERR_INITIALIZED
556 : : #ifdef _GPG_ERR_HAVE_CONSTRUCTOR
557 : : #define GPG_ERR_INITIALIZED 1
558 : : #endif
559 : :
560 : : /* See the source on how to use the deinit function; it is usually not
561 : : required. */
562 : : void gpg_err_deinit (int mode);
563 : :
564 : :
565 : : /* Constructor and accessor functions. */
566 : :
567 : : /* Construct an error value from an error code and source. Within a
568 : : subsystem, use gpg_error. */
569 : : static GPG_ERR_INLINE gpg_error_t
570 : : gpg_err_make (gpg_err_source_t source, gpg_err_code_t code)
571 : : {
572 : : return code == GPG_ERR_NO_ERROR ? GPG_ERR_NO_ERROR
573 : : : (((source & GPG_ERR_SOURCE_MASK) << GPG_ERR_SOURCE_SHIFT)
574 : : | (code & GPG_ERR_CODE_MASK));
575 : : }
576 : :
577 : :
578 : : /* The user should define GPG_ERR_SOURCE_DEFAULT before including this
579 : : file to specify a default source for gpg_error. */
580 : : #ifndef GPG_ERR_SOURCE_DEFAULT
581 : : #define GPG_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_UNKNOWN
582 : : #endif
583 : :
584 : : static GPG_ERR_INLINE gpg_error_t
585 : : gpg_error (gpg_err_code_t code)
586 : : {
587 : : return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, code);
588 : : }
589 : :
590 : :
591 : : /* Retrieve the error code from an error value. */
592 : : static GPG_ERR_INLINE gpg_err_code_t
593 : 2 : gpg_err_code (gpg_error_t err)
594 : : {
595 : 2 : return (gpg_err_code_t) (err & GPG_ERR_CODE_MASK);
596 : : }
597 : :
598 : :
599 : : /* Retrieve the error source from an error value. */
600 : : static GPG_ERR_INLINE gpg_err_source_t
601 : : gpg_err_source (gpg_error_t err)
602 : : {
603 : : return (gpg_err_source_t) ((err >> GPG_ERR_SOURCE_SHIFT)
604 : : & GPG_ERR_SOURCE_MASK);
605 : : }
606 : :
607 : :
608 : : /* String functions. */
609 : :
610 : : /* Return a pointer to a string containing a description of the error
611 : : code in the error value ERR. This function is not thread-safe. */
612 : : const char *gpg_strerror (gpg_error_t err);
613 : :
614 : : /* Return the error string for ERR in the user-supplied buffer BUF of
615 : : size BUFLEN. This function is, in contrast to gpg_strerror,
616 : : thread-safe if a thread-safe strerror_r() function is provided by
617 : : the system. If the function succeeds, 0 is returned and BUF
618 : : contains the string describing the error. If the buffer was not
619 : : large enough, ERANGE is returned and BUF contains as much of the
620 : : beginning of the error string as fits into the buffer. */
621 : : int gpg_strerror_r (gpg_error_t err, char *buf, size_t buflen);
622 : :
623 : : /* Return a pointer to a string containing a description of the error
624 : : source in the error value ERR. */
625 : : const char *gpg_strsource (gpg_error_t err);
626 : :
627 : :
628 : : /* Mapping of system errors (errno). */
629 : :
630 : : /* Retrieve the error code for the system error ERR. This returns
631 : : GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
632 : : this). */
633 : : gpg_err_code_t gpg_err_code_from_errno (int err);
634 : :
635 : :
636 : : /* Retrieve the system error for the error code CODE. This returns 0
637 : : if CODE is not a system error code. */
638 : : int gpg_err_code_to_errno (gpg_err_code_t code);
639 : :
640 : :
641 : : /* Retrieve the error code directly from the ERRNO variable. This
642 : : returns GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped
643 : : (report this) and GPG_ERR_MISSING_ERRNO if ERRNO has the value 0. */
644 : : gpg_err_code_t gpg_err_code_from_syserror (void);
645 : :
646 : :
647 : : /* Set the ERRNO variable. This function is the preferred way to set
648 : : ERRNO due to peculiarities on WindowsCE. */
649 : : void gpg_err_set_errno (int err);
650 : :
651 : :
652 : : /* Self-documenting convenience functions. */
653 : :
654 : : static GPG_ERR_INLINE gpg_error_t
655 : : gpg_err_make_from_errno (gpg_err_source_t source, int err)
656 : : {
657 : : return gpg_err_make (source, gpg_err_code_from_errno (err));
658 : : }
659 : :
660 : :
661 : : static GPG_ERR_INLINE gpg_error_t
662 : : gpg_error_from_errno (int err)
663 : : {
664 : : return gpg_error (gpg_err_code_from_errno (err));
665 : : }
666 : :
667 : : static GPG_ERR_INLINE gpg_error_t
668 : : gpg_error_from_syserror (void)
669 : : {
670 : : return gpg_error (gpg_err_code_from_syserror ());
671 : : }
672 : :
673 : : #ifdef __cplusplus
674 : : }
675 : : #endif
676 : :
677 : :
678 : : #endif /* GPG_ERROR_H */
|
