jgaunt/bitwardenbackup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Files
2023Export
bitwardenbackup/lib/gpg/include/gpg-error.h

2100 lines
76 KiB
C
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* gpg-error.h or gpgrt.h - Common code for GnuPG and others. -*- c -*-
* Copyright (C) 2001-2020 g10 Code GmbH
*
* This file is part of libgpg-error (aka libgpgrt).
*
* libgpg-error is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* libgpg-error 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, see <https://www.gnu.org/licenses/>.
* SPDX-License-Identifier: LGPL-2.1+
*
* Do not edit. Generated from gpg-error.h.in for:
i686-w64-mingw32
*/
/* The GnuPG project consists of many components. Error codes are
* exchanged between all components. The common error codes and their
* user-presentable descriptions are kept into a shared library to
* allow adding new error codes and components without recompiling any
* of the other components. In addition to error codes this library
* also features several other groups of functions which are common to
* all GnuPG components. They may be used by independet project as
* well. The interfaces will not change in a backward incompatible way.
*
* An error code together with an error source build up an error
* value. As the error value is been passed from one component to
* another, it preserves the information about the source and nature
* of the error.
*
* A component of the GnuPG project can define the following macros to
* tune the behaviour of the library:
*
* GPG_ERR_SOURCE_DEFAULT: Define to an error source of type
* gpg_err_source_t to make that source the default for gpg_error().
* Otherwise GPG_ERR_SOURCE_UNKNOWN is used as default.
*
* GPG_ERR_ENABLE_GETTEXT_MACROS: Define to provide macros to map the
* internal gettext API to standard names. This has only an effect on
* Windows platforms.
*
* GPGRT_ENABLE_ES_MACROS: Define to provide "es_" macros for the
* estream functions.
*
* GPGRT_ENABLE_LOG_MACROS: Define to provide short versions of the
* log functions.
*
* GPGRT_ENABLE_ARGPARSE_MACROS: Needs to be defined to provide the
* mandatory macros of the argparse interface.
*/
#ifndef GPG_ERROR_H
#define GPG_ERROR_H 1
#ifndef GPGRT_H
#define GPGRT_H 1
#include <stddef.h>
#include <stdio.h>
#include <stdarg.h>
/* The version string of this header. */
#define GPG_ERROR_VERSION "1.45"
#define GPGRT_VERSION "1.45"
/* The version number of this header. */
#define GPG_ERROR_VERSION_NUMBER 0x012d00
#define GPGRT_VERSION_NUMBER 0x012d00
#ifdef __GNUC__
# define GPG_ERR_INLINE __inline__
#elif defined(_MSC_VER) && _MSC_VER >= 1300
# define GPG_ERR_INLINE __inline
#elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
# define GPG_ERR_INLINE inline
#else
# ifndef GPG_ERR_INLINE
# define GPG_ERR_INLINE
# endif
#endif
#ifdef __cplusplus
extern "C" {
#if 0 /* just to make Emacs auto-indent happy */
}
#endif
#endif /* __cplusplus */
/* The error source type gpg_err_source_t.
*
* Where as the Poo out of a welle small
* Taketh his firste springing and his sours.
* --Chaucer.
*/
/* Only use free slots, never change or reorder the existing
* entries. */
typedef enum
{
GPG_ERR_SOURCE_UNKNOWN = 0,
GPG_ERR_SOURCE_GCRYPT = 1,
GPG_ERR_SOURCE_GPG = 2,
GPG_ERR_SOURCE_GPGSM = 3,
GPG_ERR_SOURCE_GPGAGENT = 4,
GPG_ERR_SOURCE_PINENTRY = 5,
GPG_ERR_SOURCE_SCD = 6,
GPG_ERR_SOURCE_GPGME = 7,
GPG_ERR_SOURCE_KEYBOX = 8,
GPG_ERR_SOURCE_KSBA = 9,
GPG_ERR_SOURCE_DIRMNGR = 10,
GPG_ERR_SOURCE_GSTI = 11,
GPG_ERR_SOURCE_GPA = 12,
GPG_ERR_SOURCE_KLEO = 13,
GPG_ERR_SOURCE_G13 = 14,
GPG_ERR_SOURCE_ASSUAN = 15,
GPG_ERR_SOURCE_TPM2D = 16,
GPG_ERR_SOURCE_TLS = 17,
GPG_ERR_SOURCE_ANY = 31,
GPG_ERR_SOURCE_USER_1 = 32,
GPG_ERR_SOURCE_USER_2 = 33,
GPG_ERR_SOURCE_USER_3 = 34,
GPG_ERR_SOURCE_USER_4 = 35,
/* This is one more than the largest allowed entry. */
GPG_ERR_SOURCE_DIM = 128
} gpg_err_source_t;
/* The error code type gpg_err_code_t. */
/* Only use free slots, never change or reorder the existing
* entries. */
typedef enum
{
GPG_ERR_NO_ERROR = 0,
GPG_ERR_GENERAL = 1,
GPG_ERR_UNKNOWN_PACKET = 2,
GPG_ERR_UNKNOWN_VERSION = 3,
GPG_ERR_PUBKEY_ALGO = 4,
GPG_ERR_DIGEST_ALGO = 5,
GPG_ERR_BAD_PUBKEY = 6,
GPG_ERR_BAD_SECKEY = 7,
GPG_ERR_BAD_SIGNATURE = 8,
GPG_ERR_NO_PUBKEY = 9,
GPG_ERR_CHECKSUM = 10,
GPG_ERR_BAD_PASSPHRASE = 11,
GPG_ERR_CIPHER_ALGO = 12,
GPG_ERR_KEYRING_OPEN = 13,
GPG_ERR_INV_PACKET = 14,
GPG_ERR_INV_ARMOR = 15,
GPG_ERR_NO_USER_ID = 16,
GPG_ERR_NO_SECKEY = 17,
GPG_ERR_WRONG_SECKEY = 18,
GPG_ERR_BAD_KEY = 19,
GPG_ERR_COMPR_ALGO = 20,
GPG_ERR_NO_PRIME = 21,
GPG_ERR_NO_ENCODING_METHOD = 22,
GPG_ERR_NO_ENCRYPTION_SCHEME = 23,
GPG_ERR_NO_SIGNATURE_SCHEME = 24,
GPG_ERR_INV_ATTR = 25,
GPG_ERR_NO_VALUE = 26,
GPG_ERR_NOT_FOUND = 27,
GPG_ERR_VALUE_NOT_FOUND = 28,
GPG_ERR_SYNTAX = 29,
GPG_ERR_BAD_MPI = 30,
GPG_ERR_INV_PASSPHRASE = 31,
GPG_ERR_SIG_CLASS = 32,
GPG_ERR_RESOURCE_LIMIT = 33,
GPG_ERR_INV_KEYRING = 34,
GPG_ERR_TRUSTDB = 35,
GPG_ERR_BAD_CERT = 36,
GPG_ERR_INV_USER_ID = 37,
GPG_ERR_UNEXPECTED = 38,
GPG_ERR_TIME_CONFLICT = 39,
GPG_ERR_KEYSERVER = 40,
GPG_ERR_WRONG_PUBKEY_ALGO = 41,
GPG_ERR_TRIBUTE_TO_D_A = 42,
GPG_ERR_WEAK_KEY = 43,
GPG_ERR_INV_KEYLEN = 44,
GPG_ERR_INV_ARG = 45,
GPG_ERR_BAD_URI = 46,
GPG_ERR_INV_URI = 47,
GPG_ERR_NETWORK = 48,
GPG_ERR_UNKNOWN_HOST = 49,
GPG_ERR_SELFTEST_FAILED = 50,
GPG_ERR_NOT_ENCRYPTED = 51,
GPG_ERR_NOT_PROCESSED = 52,
GPG_ERR_UNUSABLE_PUBKEY = 53,
GPG_ERR_UNUSABLE_SECKEY = 54,
GPG_ERR_INV_VALUE = 55,
GPG_ERR_BAD_CERT_CHAIN = 56,
GPG_ERR_MISSING_CERT = 57,
GPG_ERR_NO_DATA = 58,
GPG_ERR_BUG = 59,
GPG_ERR_NOT_SUPPORTED = 60,
GPG_ERR_INV_OP = 61,
GPG_ERR_TIMEOUT = 62,
GPG_ERR_INTERNAL = 63,
GPG_ERR_EOF_GCRYPT = 64,
GPG_ERR_INV_OBJ = 65,
GPG_ERR_TOO_SHORT = 66,
GPG_ERR_TOO_LARGE = 67,
GPG_ERR_NO_OBJ = 68,
GPG_ERR_NOT_IMPLEMENTED = 69,
GPG_ERR_CONFLICT = 70,
GPG_ERR_INV_CIPHER_MODE = 71,
GPG_ERR_INV_FLAG = 72,
GPG_ERR_INV_HANDLE = 73,
GPG_ERR_TRUNCATED = 74,
GPG_ERR_INCOMPLETE_LINE = 75,
GPG_ERR_INV_RESPONSE = 76,
GPG_ERR_NO_AGENT = 77,
GPG_ERR_AGENT = 78,
GPG_ERR_INV_DATA = 79,
GPG_ERR_ASSUAN_SERVER_FAULT = 80,
GPG_ERR_ASSUAN = 81,
GPG_ERR_INV_SESSION_KEY = 82,
GPG_ERR_INV_SEXP = 83,
GPG_ERR_UNSUPPORTED_ALGORITHM = 84,
GPG_ERR_NO_PIN_ENTRY = 85,
GPG_ERR_PIN_ENTRY = 86,
GPG_ERR_BAD_PIN = 87,
GPG_ERR_INV_NAME = 88,
GPG_ERR_BAD_DATA = 89,
GPG_ERR_INV_PARAMETER = 90,
GPG_ERR_WRONG_CARD = 91,
GPG_ERR_NO_DIRMNGR = 92,
GPG_ERR_DIRMNGR = 93,
GPG_ERR_CERT_REVOKED = 94,
GPG_ERR_NO_CRL_KNOWN = 95,
GPG_ERR_CRL_TOO_OLD = 96,
GPG_ERR_LINE_TOO_LONG = 97,
GPG_ERR_NOT_TRUSTED = 98,
GPG_ERR_CANCELED = 99,
GPG_ERR_BAD_CA_CERT = 100,
GPG_ERR_CERT_EXPIRED = 101,
GPG_ERR_CERT_TOO_YOUNG = 102,
GPG_ERR_UNSUPPORTED_CERT = 103,
GPG_ERR_UNKNOWN_SEXP = 104,
GPG_ERR_UNSUPPORTED_PROTECTION = 105,
GPG_ERR_CORRUPTED_PROTECTION = 106,
GPG_ERR_AMBIGUOUS_NAME = 107,
GPG_ERR_CARD = 108,
GPG_ERR_CARD_RESET = 109,
GPG_ERR_CARD_REMOVED = 110,
GPG_ERR_INV_CARD = 111,
GPG_ERR_CARD_NOT_PRESENT = 112,
GPG_ERR_NO_PKCS15_APP = 113,
GPG_ERR_NOT_CONFIRMED = 114,
GPG_ERR_CONFIGURATION = 115,
GPG_ERR_NO_POLICY_MATCH = 116,
GPG_ERR_INV_INDEX = 117,
GPG_ERR_INV_ID = 118,
GPG_ERR_NO_SCDAEMON = 119,
GPG_ERR_SCDAEMON = 120,
GPG_ERR_UNSUPPORTED_PROTOCOL = 121,
GPG_ERR_BAD_PIN_METHOD = 122,
GPG_ERR_CARD_NOT_INITIALIZED = 123,
GPG_ERR_UNSUPPORTED_OPERATION = 124,
GPG_ERR_WRONG_KEY_USAGE = 125,
GPG_ERR_NOTHING_FOUND = 126,
GPG_ERR_WRONG_BLOB_TYPE = 127,
GPG_ERR_MISSING_VALUE = 128,
GPG_ERR_HARDWARE = 129,
GPG_ERR_PIN_BLOCKED = 130,
GPG_ERR_USE_CONDITIONS = 131,
GPG_ERR_PIN_NOT_SYNCED = 132,
GPG_ERR_INV_CRL = 133,
GPG_ERR_BAD_BER = 134,
GPG_ERR_INV_BER = 135,
GPG_ERR_ELEMENT_NOT_FOUND = 136,
GPG_ERR_IDENTIFIER_NOT_FOUND = 137,
GPG_ERR_INV_TAG = 138,
GPG_ERR_INV_LENGTH = 139,
GPG_ERR_INV_KEYINFO = 140,
GPG_ERR_UNEXPECTED_TAG = 141,
GPG_ERR_NOT_DER_ENCODED = 142,
GPG_ERR_NO_CMS_OBJ = 143,
GPG_ERR_INV_CMS_OBJ = 144,
GPG_ERR_UNKNOWN_CMS_OBJ = 145,
GPG_ERR_UNSUPPORTED_CMS_OBJ = 146,
GPG_ERR_UNSUPPORTED_ENCODING = 147,
GPG_ERR_UNSUPPORTED_CMS_VERSION = 148,
GPG_ERR_UNKNOWN_ALGORITHM = 149,
GPG_ERR_INV_ENGINE = 150,
GPG_ERR_PUBKEY_NOT_TRUSTED = 151,
GPG_ERR_DECRYPT_FAILED = 152,
GPG_ERR_KEY_EXPIRED = 153,
GPG_ERR_SIG_EXPIRED = 154,
GPG_ERR_ENCODING_PROBLEM = 155,
GPG_ERR_INV_STATE = 156,
GPG_ERR_DUP_VALUE = 157,
GPG_ERR_MISSING_ACTION = 158,
GPG_ERR_MODULE_NOT_FOUND = 159,
GPG_ERR_INV_OID_STRING = 160,
GPG_ERR_INV_TIME = 161,
GPG_ERR_INV_CRL_OBJ = 162,
GPG_ERR_UNSUPPORTED_CRL_VERSION = 163,
GPG_ERR_INV_CERT_OBJ = 164,
GPG_ERR_UNKNOWN_NAME = 165,
GPG_ERR_LOCALE_PROBLEM = 166,
GPG_ERR_NOT_LOCKED = 167,
GPG_ERR_PROTOCOL_VIOLATION = 168,
GPG_ERR_INV_MAC = 169,
GPG_ERR_INV_REQUEST = 170,
GPG_ERR_UNKNOWN_EXTN = 171,
GPG_ERR_UNKNOWN_CRIT_EXTN = 172,
GPG_ERR_LOCKED = 173,
GPG_ERR_UNKNOWN_OPTION = 174,
GPG_ERR_UNKNOWN_COMMAND = 175,
GPG_ERR_NOT_OPERATIONAL = 176,
GPG_ERR_NO_PASSPHRASE = 177,
GPG_ERR_NO_PIN = 178,
GPG_ERR_NOT_ENABLED = 179,
GPG_ERR_NO_ENGINE = 180,
GPG_ERR_MISSING_KEY = 181,
GPG_ERR_TOO_MANY = 182,
GPG_ERR_LIMIT_REACHED = 183,
GPG_ERR_NOT_INITIALIZED = 184,
GPG_ERR_MISSING_ISSUER_CERT = 185,
GPG_ERR_NO_KEYSERVER = 186,
GPG_ERR_INV_CURVE = 187,
GPG_ERR_UNKNOWN_CURVE = 188,
GPG_ERR_DUP_KEY = 189,
GPG_ERR_AMBIGUOUS = 190,
GPG_ERR_NO_CRYPT_CTX = 191,
GPG_ERR_WRONG_CRYPT_CTX = 192,
GPG_ERR_BAD_CRYPT_CTX = 193,
GPG_ERR_CRYPT_CTX_CONFLICT = 194,
GPG_ERR_BROKEN_PUBKEY = 195,
GPG_ERR_BROKEN_SECKEY = 196,
GPG_ERR_MAC_ALGO = 197,
GPG_ERR_FULLY_CANCELED = 198,
GPG_ERR_UNFINISHED = 199,
GPG_ERR_BUFFER_TOO_SHORT = 200,
GPG_ERR_SEXP_INV_LEN_SPEC = 201,
GPG_ERR_SEXP_STRING_TOO_LONG = 202,
GPG_ERR_SEXP_UNMATCHED_PAREN = 203,
GPG_ERR_SEXP_NOT_CANONICAL = 204,
GPG_ERR_SEXP_BAD_CHARACTER = 205,
GPG_ERR_SEXP_BAD_QUOTATION = 206,
GPG_ERR_SEXP_ZERO_PREFIX = 207,
GPG_ERR_SEXP_NESTED_DH = 208,
GPG_ERR_SEXP_UNMATCHED_DH = 209,
GPG_ERR_SEXP_UNEXPECTED_PUNC = 210,
GPG_ERR_SEXP_BAD_HEX_CHAR = 211,
GPG_ERR_SEXP_ODD_HEX_NUMBERS = 212,
GPG_ERR_SEXP_BAD_OCT_CHAR = 213,
GPG_ERR_SUBKEYS_EXP_OR_REV = 217,
GPG_ERR_DB_CORRUPTED = 218,
GPG_ERR_SERVER_FAILED = 219,
GPG_ERR_NO_NAME = 220,
GPG_ERR_NO_KEY = 221,
GPG_ERR_LEGACY_KEY = 222,
GPG_ERR_REQUEST_TOO_SHORT = 223,
GPG_ERR_REQUEST_TOO_LONG = 224,
GPG_ERR_OBJ_TERM_STATE = 225,
GPG_ERR_NO_CERT_CHAIN = 226,
GPG_ERR_CERT_TOO_LARGE = 227,
GPG_ERR_INV_RECORD = 228,
GPG_ERR_BAD_MAC = 229,
GPG_ERR_UNEXPECTED_MSG = 230,
GPG_ERR_COMPR_FAILED = 231,
GPG_ERR_WOULD_WRAP = 232,
GPG_ERR_FATAL_ALERT = 233,
GPG_ERR_NO_CIPHER = 234,
GPG_ERR_MISSING_CLIENT_CERT = 235,
GPG_ERR_CLOSE_NOTIFY = 236,
GPG_ERR_TICKET_EXPIRED = 237,
GPG_ERR_BAD_TICKET = 238,
GPG_ERR_UNKNOWN_IDENTITY = 239,
GPG_ERR_BAD_HS_CERT = 240,
GPG_ERR_BAD_HS_CERT_REQ = 241,
GPG_ERR_BAD_HS_CERT_VER = 242,
GPG_ERR_BAD_HS_CHANGE_CIPHER = 243,
GPG_ERR_BAD_HS_CLIENT_HELLO = 244,
GPG_ERR_BAD_HS_SERVER_HELLO = 245,
GPG_ERR_BAD_HS_SERVER_HELLO_DONE = 246,
GPG_ERR_BAD_HS_FINISHED = 247,
GPG_ERR_BAD_HS_SERVER_KEX = 248,
GPG_ERR_BAD_HS_CLIENT_KEX = 249,
GPG_ERR_BOGUS_STRING = 250,
GPG_ERR_FORBIDDEN = 251,
GPG_ERR_KEY_DISABLED = 252,
GPG_ERR_KEY_ON_CARD = 253,
GPG_ERR_INV_LOCK_OBJ = 254,
GPG_ERR_TRUE = 255,
GPG_ERR_FALSE = 256,
GPG_ERR_ASS_GENERAL = 257,
GPG_ERR_ASS_ACCEPT_FAILED = 258,
GPG_ERR_ASS_CONNECT_FAILED = 259,
GPG_ERR_ASS_INV_RESPONSE = 260,
GPG_ERR_ASS_INV_VALUE = 261,
GPG_ERR_ASS_INCOMPLETE_LINE = 262,
GPG_ERR_ASS_LINE_TOO_LONG = 263,
GPG_ERR_ASS_NESTED_COMMANDS = 264,
GPG_ERR_ASS_NO_DATA_CB = 265,
GPG_ERR_ASS_NO_INQUIRE_CB = 266,
GPG_ERR_ASS_NOT_A_SERVER = 267,
GPG_ERR_ASS_NOT_A_CLIENT = 268,
GPG_ERR_ASS_SERVER_START = 269,
GPG_ERR_ASS_READ_ERROR = 270,
GPG_ERR_ASS_WRITE_ERROR = 271,
GPG_ERR_ASS_TOO_MUCH_DATA = 273,
GPG_ERR_ASS_UNEXPECTED_CMD = 274,
GPG_ERR_ASS_UNKNOWN_CMD = 275,
GPG_ERR_ASS_SYNTAX = 276,
GPG_ERR_ASS_CANCELED = 277,
GPG_ERR_ASS_NO_INPUT = 278,
GPG_ERR_ASS_NO_OUTPUT = 279,
GPG_ERR_ASS_PARAMETER = 280,
GPG_ERR_ASS_UNKNOWN_INQUIRE = 281,
GPG_ERR_ENGINE_TOO_OLD = 300,
GPG_ERR_WINDOW_TOO_SMALL = 301,
GPG_ERR_WINDOW_TOO_LARGE = 302,
GPG_ERR_MISSING_ENVVAR = 303,
GPG_ERR_USER_ID_EXISTS = 304,
GPG_ERR_NAME_EXISTS = 305,
GPG_ERR_DUP_NAME = 306,
GPG_ERR_TOO_YOUNG = 307,
GPG_ERR_TOO_OLD = 308,
GPG_ERR_UNKNOWN_FLAG = 309,
GPG_ERR_INV_ORDER = 310,
GPG_ERR_ALREADY_FETCHED = 311,
GPG_ERR_TRY_LATER = 312,
GPG_ERR_WRONG_NAME = 313,
GPG_ERR_NO_AUTH = 314,
GPG_ERR_BAD_AUTH = 315,
GPG_ERR_NO_KEYBOXD = 316,
GPG_ERR_KEYBOXD = 317,
GPG_ERR_NO_SERVICE = 318,
GPG_ERR_SERVICE = 319,
GPG_ERR_SYSTEM_BUG = 666,
GPG_ERR_DNS_UNKNOWN = 711,
GPG_ERR_DNS_SECTION = 712,
GPG_ERR_DNS_ADDRESS = 713,
GPG_ERR_DNS_NO_QUERY = 714,
GPG_ERR_DNS_NO_ANSWER = 715,
GPG_ERR_DNS_CLOSED = 716,
GPG_ERR_DNS_VERIFY = 717,
GPG_ERR_DNS_TIMEOUT = 718,
GPG_ERR_LDAP_GENERAL = 721,
GPG_ERR_LDAP_ATTR_GENERAL = 722,
GPG_ERR_LDAP_NAME_GENERAL = 723,
GPG_ERR_LDAP_SECURITY_GENERAL = 724,
GPG_ERR_LDAP_SERVICE_GENERAL = 725,
GPG_ERR_LDAP_UPDATE_GENERAL = 726,
GPG_ERR_LDAP_E_GENERAL = 727,
GPG_ERR_LDAP_X_GENERAL = 728,
GPG_ERR_LDAP_OTHER_GENERAL = 729,
GPG_ERR_LDAP_X_CONNECTING = 750,
GPG_ERR_LDAP_REFERRAL_LIMIT = 751,
GPG_ERR_LDAP_CLIENT_LOOP = 752,
GPG_ERR_LDAP_NO_RESULTS = 754,
GPG_ERR_LDAP_CONTROL_NOT_FOUND = 755,
GPG_ERR_LDAP_NOT_SUPPORTED = 756,
GPG_ERR_LDAP_CONNECT = 757,
GPG_ERR_LDAP_NO_MEMORY = 758,
GPG_ERR_LDAP_PARAM = 759,
GPG_ERR_LDAP_USER_CANCELLED = 760,
GPG_ERR_LDAP_FILTER = 761,
GPG_ERR_LDAP_AUTH_UNKNOWN = 762,
GPG_ERR_LDAP_TIMEOUT = 763,
GPG_ERR_LDAP_DECODING = 764,
GPG_ERR_LDAP_ENCODING = 765,
GPG_ERR_LDAP_LOCAL = 766,
GPG_ERR_LDAP_SERVER_DOWN = 767,
GPG_ERR_LDAP_SUCCESS = 768,
GPG_ERR_LDAP_OPERATIONS = 769,
GPG_ERR_LDAP_PROTOCOL = 770,
GPG_ERR_LDAP_TIMELIMIT = 771,
GPG_ERR_LDAP_SIZELIMIT = 772,
GPG_ERR_LDAP_COMPARE_FALSE = 773,
GPG_ERR_LDAP_COMPARE_TRUE = 774,
GPG_ERR_LDAP_UNSUPPORTED_AUTH = 775,
GPG_ERR_LDAP_STRONG_AUTH_RQRD = 776,
GPG_ERR_LDAP_PARTIAL_RESULTS = 777,
GPG_ERR_LDAP_REFERRAL = 778,
GPG_ERR_LDAP_ADMINLIMIT = 779,
GPG_ERR_LDAP_UNAVAIL_CRIT_EXTN = 780,
GPG_ERR_LDAP_CONFIDENT_RQRD = 781,
GPG_ERR_LDAP_SASL_BIND_INPROG = 782,
GPG_ERR_LDAP_NO_SUCH_ATTRIBUTE = 784,
GPG_ERR_LDAP_UNDEFINED_TYPE = 785,
GPG_ERR_LDAP_BAD_MATCHING = 786,
GPG_ERR_LDAP_CONST_VIOLATION = 787,
GPG_ERR_LDAP_TYPE_VALUE_EXISTS = 788,
GPG_ERR_LDAP_INV_SYNTAX = 789,
GPG_ERR_LDAP_NO_SUCH_OBJ = 800,
GPG_ERR_LDAP_ALIAS_PROBLEM = 801,
GPG_ERR_LDAP_INV_DN_SYNTAX = 802,
GPG_ERR_LDAP_IS_LEAF = 803,
GPG_ERR_LDAP_ALIAS_DEREF = 804,
GPG_ERR_LDAP_X_PROXY_AUTH_FAIL = 815,
GPG_ERR_LDAP_BAD_AUTH = 816,
GPG_ERR_LDAP_INV_CREDENTIALS = 817,
GPG_ERR_LDAP_INSUFFICIENT_ACC = 818,
GPG_ERR_LDAP_BUSY = 819,
GPG_ERR_LDAP_UNAVAILABLE = 820,
GPG_ERR_LDAP_UNWILL_TO_PERFORM = 821,
GPG_ERR_LDAP_LOOP_DETECT = 822,
GPG_ERR_LDAP_NAMING_VIOLATION = 832,
GPG_ERR_LDAP_OBJ_CLS_VIOLATION = 833,
GPG_ERR_LDAP_NOT_ALLOW_NONLEAF = 834,
GPG_ERR_LDAP_NOT_ALLOW_ON_RDN = 835,
GPG_ERR_LDAP_ALREADY_EXISTS = 836,
GPG_ERR_LDAP_NO_OBJ_CLASS_MODS = 837,
GPG_ERR_LDAP_RESULTS_TOO_LARGE = 838,
GPG_ERR_LDAP_AFFECTS_MULT_DSAS = 839,
GPG_ERR_LDAP_VLV = 844,
GPG_ERR_LDAP_OTHER = 848,
GPG_ERR_LDAP_CUP_RESOURCE_LIMIT = 881,
GPG_ERR_LDAP_CUP_SEC_VIOLATION = 882,
GPG_ERR_LDAP_CUP_INV_DATA = 883,
GPG_ERR_LDAP_CUP_UNSUP_SCHEME = 884,
GPG_ERR_LDAP_CUP_RELOAD = 885,
GPG_ERR_LDAP_CANCELLED = 886,
GPG_ERR_LDAP_NO_SUCH_OPERATION = 887,
GPG_ERR_LDAP_TOO_LATE = 888,
GPG_ERR_LDAP_CANNOT_CANCEL = 889,
GPG_ERR_LDAP_ASSERTION_FAILED = 890,
GPG_ERR_LDAP_PROX_AUTH_DENIED = 891,
GPG_ERR_USER_1 = 1024,
GPG_ERR_USER_2 = 1025,
GPG_ERR_USER_3 = 1026,
GPG_ERR_USER_4 = 1027,
GPG_ERR_USER_5 = 1028,
GPG_ERR_USER_6 = 1029,
GPG_ERR_USER_7 = 1030,
GPG_ERR_USER_8 = 1031,
GPG_ERR_USER_9 = 1032,
GPG_ERR_USER_10 = 1033,
GPG_ERR_USER_11 = 1034,
GPG_ERR_USER_12 = 1035,
GPG_ERR_USER_13 = 1036,
GPG_ERR_USER_14 = 1037,
GPG_ERR_USER_15 = 1038,
GPG_ERR_USER_16 = 1039,
GPG_ERR_SQL_OK = 1500,
GPG_ERR_SQL_ERROR = 1501,
GPG_ERR_SQL_INTERNAL = 1502,
GPG_ERR_SQL_PERM = 1503,
GPG_ERR_SQL_ABORT = 1504,
GPG_ERR_SQL_BUSY = 1505,
GPG_ERR_SQL_LOCKED = 1506,
GPG_ERR_SQL_NOMEM = 1507,
GPG_ERR_SQL_READONLY = 1508,
GPG_ERR_SQL_INTERRUPT = 1509,
GPG_ERR_SQL_IOERR = 1510,
GPG_ERR_SQL_CORRUPT = 1511,
GPG_ERR_SQL_NOTFOUND = 1512,
GPG_ERR_SQL_FULL = 1513,
GPG_ERR_SQL_CANTOPEN = 1514,
GPG_ERR_SQL_PROTOCOL = 1515,
GPG_ERR_SQL_EMPTY = 1516,
GPG_ERR_SQL_SCHEMA = 1517,
GPG_ERR_SQL_TOOBIG = 1518,
GPG_ERR_SQL_CONSTRAINT = 1519,
GPG_ERR_SQL_MISMATCH = 1520,
GPG_ERR_SQL_MISUSE = 1521,
GPG_ERR_SQL_NOLFS = 1522,
GPG_ERR_SQL_AUTH = 1523,
GPG_ERR_SQL_FORMAT = 1524,
GPG_ERR_SQL_RANGE = 1525,
GPG_ERR_SQL_NOTADB = 1526,
GPG_ERR_SQL_NOTICE = 1527,
GPG_ERR_SQL_WARNING = 1528,
GPG_ERR_SQL_ROW = 1600,
GPG_ERR_SQL_DONE = 1601,
GPG_ERR_MISSING_ERRNO = 16381,
GPG_ERR_UNKNOWN_ERRNO = 16382,
GPG_ERR_EOF = 16383,
/* The following error codes are used to map system errors. */
#define GPG_ERR_SYSTEM_ERROR (1 << 15)
GPG_ERR_E2BIG = GPG_ERR_SYSTEM_ERROR | 0,
GPG_ERR_EACCES = GPG_ERR_SYSTEM_ERROR | 1,
GPG_ERR_EADDRINUSE = GPG_ERR_SYSTEM_ERROR | 2,
GPG_ERR_EADDRNOTAVAIL = GPG_ERR_SYSTEM_ERROR | 3,
GPG_ERR_EADV = GPG_ERR_SYSTEM_ERROR | 4,
GPG_ERR_EAFNOSUPPORT = GPG_ERR_SYSTEM_ERROR | 5,
GPG_ERR_EAGAIN = GPG_ERR_SYSTEM_ERROR | 6,
GPG_ERR_EALREADY = GPG_ERR_SYSTEM_ERROR | 7,
GPG_ERR_EAUTH = GPG_ERR_SYSTEM_ERROR | 8,
GPG_ERR_EBACKGROUND = GPG_ERR_SYSTEM_ERROR | 9,
GPG_ERR_EBADE = GPG_ERR_SYSTEM_ERROR | 10,
GPG_ERR_EBADF = GPG_ERR_SYSTEM_ERROR | 11,
GPG_ERR_EBADFD = GPG_ERR_SYSTEM_ERROR | 12,
GPG_ERR_EBADMSG = GPG_ERR_SYSTEM_ERROR | 13,
GPG_ERR_EBADR = GPG_ERR_SYSTEM_ERROR | 14,
GPG_ERR_EBADRPC = GPG_ERR_SYSTEM_ERROR | 15,
GPG_ERR_EBADRQC = GPG_ERR_SYSTEM_ERROR | 16,
GPG_ERR_EBADSLT = GPG_ERR_SYSTEM_ERROR | 17,
GPG_ERR_EBFONT = GPG_ERR_SYSTEM_ERROR | 18,
GPG_ERR_EBUSY = GPG_ERR_SYSTEM_ERROR | 19,
GPG_ERR_ECANCELED = GPG_ERR_SYSTEM_ERROR | 20,
GPG_ERR_ECHILD = GPG_ERR_SYSTEM_ERROR | 21,
GPG_ERR_ECHRNG = GPG_ERR_SYSTEM_ERROR | 22,
GPG_ERR_ECOMM = GPG_ERR_SYSTEM_ERROR | 23,
GPG_ERR_ECONNABORTED = GPG_ERR_SYSTEM_ERROR | 24,
GPG_ERR_ECONNREFUSED = GPG_ERR_SYSTEM_ERROR | 25,
GPG_ERR_ECONNRESET = GPG_ERR_SYSTEM_ERROR | 26,
GPG_ERR_ED = GPG_ERR_SYSTEM_ERROR | 27,
GPG_ERR_EDEADLK = GPG_ERR_SYSTEM_ERROR | 28,
GPG_ERR_EDEADLOCK = GPG_ERR_SYSTEM_ERROR | 29,
GPG_ERR_EDESTADDRREQ = GPG_ERR_SYSTEM_ERROR | 30,
GPG_ERR_EDIED = GPG_ERR_SYSTEM_ERROR | 31,
GPG_ERR_EDOM = GPG_ERR_SYSTEM_ERROR | 32,
GPG_ERR_EDOTDOT = GPG_ERR_SYSTEM_ERROR | 33,
GPG_ERR_EDQUOT = GPG_ERR_SYSTEM_ERROR | 34,
GPG_ERR_EEXIST = GPG_ERR_SYSTEM_ERROR | 35,
GPG_ERR_EFAULT = GPG_ERR_SYSTEM_ERROR | 36,
GPG_ERR_EFBIG = GPG_ERR_SYSTEM_ERROR | 37,
GPG_ERR_EFTYPE = GPG_ERR_SYSTEM_ERROR | 38,
GPG_ERR_EGRATUITOUS = GPG_ERR_SYSTEM_ERROR | 39,
GPG_ERR_EGREGIOUS = GPG_ERR_SYSTEM_ERROR | 40,
GPG_ERR_EHOSTDOWN = GPG_ERR_SYSTEM_ERROR | 41,
GPG_ERR_EHOSTUNREACH = GPG_ERR_SYSTEM_ERROR | 42,
GPG_ERR_EIDRM = GPG_ERR_SYSTEM_ERROR | 43,
GPG_ERR_EIEIO = GPG_ERR_SYSTEM_ERROR | 44,
GPG_ERR_EILSEQ = GPG_ERR_SYSTEM_ERROR | 45,
GPG_ERR_EINPROGRESS = GPG_ERR_SYSTEM_ERROR | 46,
GPG_ERR_EINTR = GPG_ERR_SYSTEM_ERROR | 47,
GPG_ERR_EINVAL = GPG_ERR_SYSTEM_ERROR | 48,
GPG_ERR_EIO = GPG_ERR_SYSTEM_ERROR | 49,
GPG_ERR_EISCONN = GPG_ERR_SYSTEM_ERROR | 50,
GPG_ERR_EISDIR = GPG_ERR_SYSTEM_ERROR | 51,
GPG_ERR_EISNAM = GPG_ERR_SYSTEM_ERROR | 52,
GPG_ERR_EL2HLT = GPG_ERR_SYSTEM_ERROR | 53,
GPG_ERR_EL2NSYNC = GPG_ERR_SYSTEM_ERROR | 54,
GPG_ERR_EL3HLT = GPG_ERR_SYSTEM_ERROR | 55,
GPG_ERR_EL3RST = GPG_ERR_SYSTEM_ERROR | 56,
GPG_ERR_ELIBACC = GPG_ERR_SYSTEM_ERROR | 57,
GPG_ERR_ELIBBAD = GPG_ERR_SYSTEM_ERROR | 58,
GPG_ERR_ELIBEXEC = GPG_ERR_SYSTEM_ERROR | 59,
GPG_ERR_ELIBMAX = GPG_ERR_SYSTEM_ERROR | 60,
GPG_ERR_ELIBSCN = GPG_ERR_SYSTEM_ERROR | 61,
GPG_ERR_ELNRNG = GPG_ERR_SYSTEM_ERROR | 62,
GPG_ERR_ELOOP = GPG_ERR_SYSTEM_ERROR | 63,
GPG_ERR_EMEDIUMTYPE = GPG_ERR_SYSTEM_ERROR | 64,
GPG_ERR_EMFILE = GPG_ERR_SYSTEM_ERROR | 65,
GPG_ERR_EMLINK = GPG_ERR_SYSTEM_ERROR | 66,
GPG_ERR_EMSGSIZE = GPG_ERR_SYSTEM_ERROR | 67,
GPG_ERR_EMULTIHOP = GPG_ERR_SYSTEM_ERROR | 68,
GPG_ERR_ENAMETOOLONG = GPG_ERR_SYSTEM_ERROR | 69,
GPG_ERR_ENAVAIL = GPG_ERR_SYSTEM_ERROR | 70,
GPG_ERR_ENEEDAUTH = GPG_ERR_SYSTEM_ERROR | 71,
GPG_ERR_ENETDOWN = GPG_ERR_SYSTEM_ERROR | 72,
GPG_ERR_ENETRESET = GPG_ERR_SYSTEM_ERROR | 73,
GPG_ERR_ENETUNREACH = GPG_ERR_SYSTEM_ERROR | 74,
GPG_ERR_ENFILE = GPG_ERR_SYSTEM_ERROR | 75,
GPG_ERR_ENOANO = GPG_ERR_SYSTEM_ERROR | 76,
GPG_ERR_ENOBUFS = GPG_ERR_SYSTEM_ERROR | 77,
GPG_ERR_ENOCSI = GPG_ERR_SYSTEM_ERROR | 78,
GPG_ERR_ENODATA = GPG_ERR_SYSTEM_ERROR | 79,
GPG_ERR_ENODEV = GPG_ERR_SYSTEM_ERROR | 80,
GPG_ERR_ENOENT = GPG_ERR_SYSTEM_ERROR | 81,
GPG_ERR_ENOEXEC = GPG_ERR_SYSTEM_ERROR | 82,
GPG_ERR_ENOLCK = GPG_ERR_SYSTEM_ERROR | 83,
GPG_ERR_ENOLINK = GPG_ERR_SYSTEM_ERROR | 84,
GPG_ERR_ENOMEDIUM = GPG_ERR_SYSTEM_ERROR | 85,
GPG_ERR_ENOMEM = GPG_ERR_SYSTEM_ERROR | 86,
GPG_ERR_ENOMSG = GPG_ERR_SYSTEM_ERROR | 87,
GPG_ERR_ENONET = GPG_ERR_SYSTEM_ERROR | 88,
GPG_ERR_ENOPKG = GPG_ERR_SYSTEM_ERROR | 89,
GPG_ERR_ENOPROTOOPT = GPG_ERR_SYSTEM_ERROR | 90,
GPG_ERR_ENOSPC = GPG_ERR_SYSTEM_ERROR | 91,
GPG_ERR_ENOSR = GPG_ERR_SYSTEM_ERROR | 92,
GPG_ERR_ENOSTR = GPG_ERR_SYSTEM_ERROR | 93,
GPG_ERR_ENOSYS = GPG_ERR_SYSTEM_ERROR | 94,
GPG_ERR_ENOTBLK = GPG_ERR_SYSTEM_ERROR | 95,
GPG_ERR_ENOTCONN = GPG_ERR_SYSTEM_ERROR | 96,
GPG_ERR_ENOTDIR = GPG_ERR_SYSTEM_ERROR | 97,
GPG_ERR_ENOTEMPTY = GPG_ERR_SYSTEM_ERROR | 98,
GPG_ERR_ENOTNAM = GPG_ERR_SYSTEM_ERROR | 99,
GPG_ERR_ENOTSOCK = GPG_ERR_SYSTEM_ERROR | 100,
GPG_ERR_ENOTSUP = GPG_ERR_SYSTEM_ERROR | 101,
GPG_ERR_ENOTTY = GPG_ERR_SYSTEM_ERROR | 102,
GPG_ERR_ENOTUNIQ = GPG_ERR_SYSTEM_ERROR | 103,
GPG_ERR_ENXIO = GPG_ERR_SYSTEM_ERROR | 104,
GPG_ERR_EOPNOTSUPP = GPG_ERR_SYSTEM_ERROR | 105,
GPG_ERR_EOVERFLOW = GPG_ERR_SYSTEM_ERROR | 106,
GPG_ERR_EPERM = GPG_ERR_SYSTEM_ERROR | 107,
GPG_ERR_EPFNOSUPPORT = GPG_ERR_SYSTEM_ERROR | 108,
GPG_ERR_EPIPE = GPG_ERR_SYSTEM_ERROR | 109,
GPG_ERR_EPROCLIM = GPG_ERR_SYSTEM_ERROR | 110,
GPG_ERR_EPROCUNAVAIL = GPG_ERR_SYSTEM_ERROR | 111,
GPG_ERR_EPROGMISMATCH = GPG_ERR_SYSTEM_ERROR | 112,
GPG_ERR_EPROGUNAVAIL = GPG_ERR_SYSTEM_ERROR | 113,
GPG_ERR_EPROTO = GPG_ERR_SYSTEM_ERROR | 114,
GPG_ERR_EPROTONOSUPPORT = GPG_ERR_SYSTEM_ERROR | 115,
GPG_ERR_EPROTOTYPE = GPG_ERR_SYSTEM_ERROR | 116,
GPG_ERR_ERANGE = GPG_ERR_SYSTEM_ERROR | 117,
GPG_ERR_EREMCHG = GPG_ERR_SYSTEM_ERROR | 118,
GPG_ERR_EREMOTE = GPG_ERR_SYSTEM_ERROR | 119,
GPG_ERR_EREMOTEIO = GPG_ERR_SYSTEM_ERROR | 120,
GPG_ERR_ERESTART = GPG_ERR_SYSTEM_ERROR | 121,
GPG_ERR_EROFS = GPG_ERR_SYSTEM_ERROR | 122,
GPG_ERR_ERPCMISMATCH = GPG_ERR_SYSTEM_ERROR | 123,
GPG_ERR_ESHUTDOWN = GPG_ERR_SYSTEM_ERROR | 124,
GPG_ERR_ESOCKTNOSUPPORT = GPG_ERR_SYSTEM_ERROR | 125,
GPG_ERR_ESPIPE = GPG_ERR_SYSTEM_ERROR | 126,
GPG_ERR_ESRCH = GPG_ERR_SYSTEM_ERROR | 127,
GPG_ERR_ESRMNT = GPG_ERR_SYSTEM_ERROR | 128,
GPG_ERR_ESTALE = GPG_ERR_SYSTEM_ERROR | 129,
GPG_ERR_ESTRPIPE = GPG_ERR_SYSTEM_ERROR | 130,
GPG_ERR_ETIME = GPG_ERR_SYSTEM_ERROR | 131,
GPG_ERR_ETIMEDOUT = GPG_ERR_SYSTEM_ERROR | 132,
GPG_ERR_ETOOMANYREFS = GPG_ERR_SYSTEM_ERROR | 133,
GPG_ERR_ETXTBSY = GPG_ERR_SYSTEM_ERROR | 134,
GPG_ERR_EUCLEAN = GPG_ERR_SYSTEM_ERROR | 135,
GPG_ERR_EUNATCH = GPG_ERR_SYSTEM_ERROR | 136,
GPG_ERR_EUSERS = GPG_ERR_SYSTEM_ERROR | 137,
GPG_ERR_EWOULDBLOCK = GPG_ERR_SYSTEM_ERROR | 138,
GPG_ERR_EXDEV = GPG_ERR_SYSTEM_ERROR | 139,
GPG_ERR_EXFULL = GPG_ERR_SYSTEM_ERROR | 140,
/* This is one more than the largest allowed entry. */
GPG_ERR_CODE_DIM = 65536
} gpg_err_code_t;
/* The error value type gpg_error_t. */
/* We would really like to use bit-fields in a struct, but using
* structs as return values can cause binary compatibility issues, in
* particular if you want to do it efficiently (also see
* -freg-struct-return option to GCC). */
typedef unsigned int gpg_error_t;
/* We use the lowest 16 bits of gpg_error_t for error codes. The 16th
* bit indicates system errors. */
#define GPG_ERR_CODE_MASK (GPG_ERR_CODE_DIM - 1)
/* Bits 17 to 24 are reserved. */
/* We use the upper 7 bits of gpg_error_t for error sources. */
#define GPG_ERR_SOURCE_MASK (GPG_ERR_SOURCE_DIM - 1)
#define GPG_ERR_SOURCE_SHIFT 24
/* The highest bit is reserved. It shouldn't be used to prevent
* potential negative numbers when transmitting error values as
* text. */
/*
* GCC feature test.
*/
#if __GNUC__
# define _GPG_ERR_GCC_VERSION (__GNUC__ * 10000 \
+ __GNUC_MINOR__ * 100 \
+ __GNUC_PATCHLEVEL__)
#else
# define _GPG_ERR_GCC_VERSION 0
#endif
#undef _GPG_ERR_HAVE_CONSTRUCTOR
#if _GPG_ERR_GCC_VERSION > 30100
# define _GPG_ERR_CONSTRUCTOR __attribute__ ((__constructor__))
# define _GPG_ERR_HAVE_CONSTRUCTOR
#else
# define _GPG_ERR_CONSTRUCTOR
#endif
#define GPGRT_GCC_VERSION _GPG_ERR_GCC_VERSION
#if _GPG_ERR_GCC_VERSION >= 29200
# define _GPGRT__RESTRICT __restrict__
#else
# define _GPGRT__RESTRICT
#endif
/* The noreturn attribute. */
#if _GPG_ERR_GCC_VERSION >= 20500
# define GPGRT_ATTR_NORETURN __attribute__ ((__noreturn__))
#else
# define GPGRT_ATTR_NORETURN
#endif
/* The printf attributes. */
#if _GPG_ERR_GCC_VERSION >= 40400
# define GPGRT_ATTR_PRINTF(f, a) \
__attribute__ ((format(__gnu_printf__,f,a)))
# define GPGRT_ATTR_NR_PRINTF(f, a) \
__attribute__ ((__noreturn__, format(__gnu_printf__,f,a)))
#elif _GPG_ERR_GCC_VERSION >= 20500
# define GPGRT_ATTR_PRINTF(f, a) \
__attribute__ ((format(printf,f,a)))
# define GPGRT_ATTR_NR_PRINTF(f, a) \
__attribute__ ((__noreturn__, format(printf,f,a)))
#else
# define GPGRT_ATTR_PRINTF(f, a)
# define GPGRT_ATTR_NR_PRINTF(f, a)
#endif
#if _GPG_ERR_GCC_VERSION >= 20800
# define GPGRT_ATTR_FORMAT_ARG(a) __attribute__ ((__format_arg__ (a)))
#else
# define GPGRT_ATTR_FORMAT_ARG(a)
#endif
/* The sentinel attribute. */
#if _GPG_ERR_GCC_VERSION >= 40000
# define GPGRT_ATTR_SENTINEL(a) __attribute__ ((sentinel(a)))
#else
# define GPGRT_ATTR_SENTINEL(a)
#endif
/* The used and unused attributes.
* I am not sure since when the unused attribute is really supported.
* In any case it it only needed for gcc versions which print a
* warning. Thus let us require gcc >= 3.5. */
#if _GPG_ERR_GCC_VERSION >= 40000
# define GPGRT_ATTR_USED __attribute__ ((used))
#else
# define GPGRT_ATTR_USED
#endif
#if _GPG_ERR_GCC_VERSION >= 30500
# define GPGRT_ATTR_UNUSED __attribute__ ((unused))
#else
# define GPGRT_ATTR_UNUSED
#endif
/* The deprecated attribute. */
#if _GPG_ERR_GCC_VERSION >= 30100
# define GPGRT_ATTR_DEPRECATED __attribute__ ((__deprecated__))
#else
# define GPGRT_ATTR_DEPRECATED
#endif
/* The pure attribute. */
#if _GPG_ERR_GCC_VERSION >= 29600
# define GPGRT_ATTR_PURE __attribute__ ((__pure__))
#else
# define GPGRT_ATTR_PURE
#endif
/* The malloc attribute. */
#if _GPG_ERR_GCC_VERSION >= 30200
# define GPGRT_ATTR_MALLOC __attribute__ ((__malloc__))
#else
# define GPGRT_ATTR_MALLOC
#endif
/* A macro defined if a GCC style __FUNCTION__ macro is available. */
#undef GPGRT_HAVE_MACRO_FUNCTION
#if _GPG_ERR_GCC_VERSION >= 20500
# define GPGRT_HAVE_MACRO_FUNCTION 1
#endif
/* A macro defined if the pragma GCC push_options is available. */
#undef GPGRT_HAVE_PRAGMA_GCC_PUSH
#if _GPG_ERR_GCC_VERSION >= 40400
# define GPGRT_HAVE_PRAGMA_GCC_PUSH 1
#endif
/* Detect LeakSanitizer (LSan) support for GCC and Clang based on
* whether AddressSanitizer (ASAN) is enabled via -fsanitize=address).
* Note that -fsanitize=leak just affect the linker options which
* cannot be detected here. In that case you have to define the
* GPGRT_HAVE_LEAK_SANITIZER macro manually. */
#ifdef __GNUC__
# ifdef __SANITIZE_ADDRESS__
# define GPGRT_HAVE_LEAK_SANITIZER
# elif defined(__has_feature)
# if __has_feature(address_sanitizer)
# define GPGRT_HAVE_LEAK_SANITIZER
# endif
# endif
#endif
/* The new name for the inline macro. */
#define GPGRT_INLINE GPG_ERR_INLINE
#ifdef GPGRT_HAVE_LEAK_SANITIZER
# include <sanitizer/lsan_interface.h>
#endif
/* Mark heap objects as non-leaked memory. */
static GPGRT_INLINE void
gpgrt_annotate_leaked_object (const void *p)
{
#ifdef GPGRT_HAVE_LEAK_SANITIZER
__lsan_ignore_object(p);
#else
(void)p;
#endif
}
/*
* Initialization function.
*/
/* Initialize the library. This function should be run early. */
gpg_error_t gpg_err_init (void) _GPG_ERR_CONSTRUCTOR;
/* If this is defined, the library is already initialized by the
constructor and does not need to be initialized explicitely. */
#undef GPG_ERR_INITIALIZED
#ifdef _GPG_ERR_HAVE_CONSTRUCTOR
# define GPG_ERR_INITIALIZED 1
# define gpgrt_init() do { gpg_err_init (); } while (0)
#else
# define gpgrt_init() do { ; } while (0)
#endif
/* See the source on how to use the deinit function; it is usually not
required. */
void gpg_err_deinit (int mode);
/* Register blocking system I/O clamping functions. */
void gpgrt_set_syscall_clamp (void (*pre)(void), void (*post)(void));
/* Get current I/O clamping functions. */
void gpgrt_get_syscall_clamp (void (**r_pre)(void), void (**r_post)(void));
/* Register a custom malloc/realloc/free function. */
void gpgrt_set_alloc_func (void *(*f)(void *a, size_t n));
/* Register an emergency cleanup handler. */
void gpgrt_add_emergency_cleanup (void (*f)(void));
/* Wrapper around abort to make sure emergency cleanups are run. */
void gpgrt_abort (void) GPGRT_ATTR_NORETURN;
/*
* Constructor and accessor functions.
*/
/* Construct an error value from an error code and source. Within a
* subsystem, use gpg_error. */
static GPG_ERR_INLINE gpg_error_t
gpg_err_make (gpg_err_source_t source, gpg_err_code_t code)
{
return code == GPG_ERR_NO_ERROR ? GPG_ERR_NO_ERROR
: (((source & GPG_ERR_SOURCE_MASK) << GPG_ERR_SOURCE_SHIFT)
| (code & GPG_ERR_CODE_MASK));
}
/* The user should define GPG_ERR_SOURCE_DEFAULT before including this
* file to specify a default source for gpg_error. */
#ifndef GPG_ERR_SOURCE_DEFAULT
#define GPG_ERR_SOURCE_DEFAULT GPG_ERR_SOURCE_UNKNOWN
#endif
static GPG_ERR_INLINE gpg_error_t
gpg_error (gpg_err_code_t code)
{
return gpg_err_make (GPG_ERR_SOURCE_DEFAULT, code);
}
/* Retrieve the error code from an error value. */
static GPG_ERR_INLINE gpg_err_code_t
gpg_err_code (gpg_error_t err)
{
return (gpg_err_code_t) (err & GPG_ERR_CODE_MASK);
}
/* Retrieve the error source from an error value. */
static GPG_ERR_INLINE gpg_err_source_t
gpg_err_source (gpg_error_t err)
{
return (gpg_err_source_t) ((err >> GPG_ERR_SOURCE_SHIFT)
& GPG_ERR_SOURCE_MASK);
}
/* String functions. */
/* Return a pointer to a string containing a description of the error
* code in the error value ERR. This function is not thread-safe. */
const char *gpg_strerror (gpg_error_t err);
/* Return the error string for ERR in the user-supplied buffer BUF of
* size BUFLEN. This function is, in contrast to gpg_strerror,
* thread-safe if a thread-safe strerror_r() function is provided by
* the system. If the function succeeds, 0 is returned and BUF
* contains the string describing the error. If the buffer was not
* large enough, ERANGE is returned and BUF contains as much of the
* beginning of the error string as fits into the buffer. */
int gpg_strerror_r (gpg_error_t err, char *buf, size_t buflen);
/* Return a pointer to a string containing a description of the error
* source in the error value ERR. */
const char *gpg_strsource (gpg_error_t err);
/*
* Mapping of system errors (errno).
*/
/* Retrieve the error code for the system error ERR. This returns
* GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped (report
* this). */
gpg_err_code_t gpg_err_code_from_errno (int err);
/* Retrieve the system error for the error code CODE. This returns 0
* if CODE is not a system error code. */
int gpg_err_code_to_errno (gpg_err_code_t code);
/* Retrieve the error code directly from the ERRNO variable. This
* returns GPG_ERR_UNKNOWN_ERRNO if the system error is not mapped
* (report this) and GPG_ERR_MISSING_ERRNO if ERRNO has the value 0. */
gpg_err_code_t gpg_err_code_from_syserror (void);
/* Mapper for SQLite primary error codes. */
static GPG_ERR_INLINE gpg_error_t
gpg_err_code_from_sqlite (int sqlres)
{
return sqlres? GPG_ERR_SQL_OK + (sqlres & 0xff) : 0;
}
/* Set the ERRNO variable. This function is the preferred way to set
* ERRNO due to peculiarities on WindowsCE. */
void gpg_err_set_errno (int err);
/* Return or check the version. Both functions are identical. */
const char *gpgrt_check_version (const char *req_version);
const char *gpg_error_check_version (const char *req_version);
/* System specific type definitions. */
#include <sys/types.h>
typedef long gpgrt_ssize_t;
#include <stdint.h>
typedef int64_t gpgrt_off_t;
/* Decide whether to use the format_arg attribute. */
#if _GPG_ERR_GCC_VERSION > 20800
# define _GPG_ERR_ATTR_FORMAT_ARG(a) __attribute__ ((__format_arg__ (a)))
#else
# define _GPG_ERR_ATTR_FORMAT_ARG(a)
#endif
/* A lean gettext implementation based on GNU style mo files which are
required to be encoded in UTF-8. There is a limit on 65534 entries
to save some RAM. Only Germanic plural rules are supported. */
const char *_gpg_w32_bindtextdomain (const char *domainname,
const char *dirname);
const char *_gpg_w32_textdomain (const char *domainname);
const char *_gpg_w32_gettext (const char *msgid)
_GPG_ERR_ATTR_FORMAT_ARG (1);
const char *_gpg_w32_dgettext (const char *domainname, const char *msgid)
_GPG_ERR_ATTR_FORMAT_ARG (2);
const char *_gpg_w32_dngettext (const char *domainname, const char *msgid1,
const char *msgid2, unsigned long int n)
_GPG_ERR_ATTR_FORMAT_ARG (2) _GPG_ERR_ATTR_FORMAT_ARG (3);
const char *_gpg_w32_gettext_localename (void);
int _gpg_w32_gettext_use_utf8 (int value);
#ifdef GPG_ERR_ENABLE_GETTEXT_MACROS
# define bindtextdomain(a,b) _gpg_w32_bindtextdomain ((a), (b))
# define textdomain(a) _gpg_w32_textdomain ((a))
# define gettext(a) _gpg_w32_gettext ((a))
# define dgettext(a,b) _gpg_w32_dgettext ((a), (b))
# define ngettext(a,b,c) _gpg_w32_dngettext (NULL, (a), (b), (c))
# define dngettext(a,b,c,d) _gpg_w32_dngettext ((a), (b), (c), (d))
# define gettext_localename() _gpg_w32_gettext_localename ()
# define gettext_use_utf8(a) _gpg_w32_gettext_use_utf8 (a)
#endif /*GPG_ERR_ENABLE_GETTEXT_MACROS*/
/* Force the use of the locale NAME or if NAME is NULL the one derived
* from LANGID. This function must be used early and is not thread-safe. */
void gpgrt_w32_override_locale (const char *name, unsigned short langid);
/* A simple iconv implementation w/o the need for an extra DLL. */
struct _gpgrt_w32_iconv_s;
typedef struct _gpgrt_w32_iconv_s *gpgrt_w32_iconv_t;
gpgrt_w32_iconv_t gpgrt_w32_iconv_open (const char *tocode,
const char *fromcode);
int gpgrt_w32_iconv_close (gpgrt_w32_iconv_t cd);
size_t gpgrt_w32_iconv (gpgrt_w32_iconv_t cd,
const char **inbuf, size_t *inbytesleft,
char **outbuf, size_t *outbytesleft);
#ifdef GPGRT_ENABLE_W32_ICONV_MACROS
# define ICONV_CONST const
# define iconv_t gpgrt_w32_iconv_t
# define iconv_open(a,b) gpgrt_w32_iconv_open ((a), (b))
# define iconv_close(a) gpgrt_w32_iconv_close ((a))
# define iconv(a,b,c,d,e) gpgrt_w32_iconv ((a),(b),(c),(d),(e))
#endif /*GPGRT_ENABLE_W32_ICONV_MACROS*/
/* Release a wchar_t * buffer. */
void gpgrt_free_wchar (wchar_t *wstring);
/* Convert an UTF-8 encoded file name to wchar.
* Prepend a '\\?\' prefix if needed. */
wchar_t *gpgrt_fname_to_wchar (const char *fname);
/* Convert an UTF8 string to a WCHAR string. Caller should use
* gpgrt_free_wchar to release the result.
* Returns NULL on error and sets ERRNO. */
wchar_t *gpgrt_utf8_to_wchar (const char *string);
/* Convert a WCHAR string to UTF-8. Caller should use gpgrt_free to
* release the result. Returns NULL on error and sets ERRNO. */
char *gpgrt_wchar_to_utf8 (const wchar_t *wstring);
/* Query a string in the registry. */
char *gpgrt_w32_reg_query_string (const char *root,
const char *dir,
const char *name);
/* Self-documenting convenience functions. */
static GPG_ERR_INLINE gpg_error_t
gpg_err_make_from_errno (gpg_err_source_t source, int err)
{
return gpg_err_make (source, gpg_err_code_from_errno (err));
}
static GPG_ERR_INLINE gpg_error_t
gpg_error_from_errno (int err)
{
return gpg_error (gpg_err_code_from_errno (err));
}
static GPG_ERR_INLINE gpg_error_t
gpg_error_from_syserror (void)
{
return gpg_error (gpg_err_code_from_syserror ());
}
/*
* Malloc and friends
*/
void *gpgrt_realloc (void *a, size_t n);
void *gpgrt_reallocarray (void *a, size_t oldnmemb, size_t nmemb, size_t size);
void *gpgrt_malloc (size_t n);
void *gpgrt_calloc (size_t n, size_t m);
char *gpgrt_strdup (const char *string);
char *gpgrt_strconcat (const char *s1, ...) GPGRT_ATTR_SENTINEL(0);
void gpgrt_free (void *a);
/*
* System specific function wrappers.
*/
/* A getenv replacement which mallocs the returned string. */
char *gpgrt_getenv (const char *name);
/* A setenv and a unsetenv replacement.*/
gpg_err_code_t gpgrt_setenv (const char *name,
const char *value, int overwrite);
#define gpgrt_unsetenv(n) gpgrt_setenv ((n), NULL, 1)
/* A wrapper around mkdir using a string for the mode. */
gpg_err_code_t gpgrt_mkdir (const char *name, const char *modestr);
/* A simple wrapper around chdir. */
gpg_err_code_t gpgrt_chdir (const char *name);
/* Return the current WD as a malloced string. */
char *gpgrt_getcwd (void);
/* A wrapper around access to handle UTF-8 on Windows. */
gpg_err_code_t gpgrt_access (const char *fname, int mode);
/*
* Lock functions.
*/
#ifdef _WIN64
#pragma pack(push, 8)
typedef struct
{
volatile unsigned char priv[56];
} gpgrt_lock_t;
#pragma pack(pop)
#define GPGRT_LOCK_INITIALIZER {{1,0,0,0,0,0,0,0,255,255,255,255, \
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, \
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, \
0,0,0,0,0,0,0,0,0,0,0,0}}
#else
#pragma pack(push, 8)
typedef struct
{
volatile unsigned char priv[36];
} gpgrt_lock_t;
#pragma pack(pop)
#define GPGRT_LOCK_INITIALIZER {{1,0,0,0,0,0,0,0,255,255,255,255, \
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, \
0,0,0,0,0,0,0,0}}
#endif
#define GPGRT_LOCK_DEFINE(name) \
static gpgrt_lock_t name = GPGRT_LOCK_INITIALIZER
/* NB: If GPGRT_LOCK_DEFINE is not used, zero out the lock variable
before passing it to gpgrt_lock_init. */
gpg_err_code_t gpgrt_lock_init (gpgrt_lock_t *lockhd);
gpg_err_code_t gpgrt_lock_lock (gpgrt_lock_t *lockhd);
gpg_err_code_t gpgrt_lock_trylock (gpgrt_lock_t *lockhd);
gpg_err_code_t gpgrt_lock_unlock (gpgrt_lock_t *lockhd);
gpg_err_code_t gpgrt_lock_destroy (gpgrt_lock_t *lockhd);
/*
* Thread functions.
*/
gpg_err_code_t gpgrt_yield (void);
/*
* Estream
*/
/* The definition of this struct is entirely private. You must not
use it for anything. It is only here so some functions can be
implemented as macros. */
struct _gpgrt_stream_internal;
struct _gpgrt__stream
{
/* The layout of this struct must never change. It may be grown,
but only if all functions which access the new members are
versioned. */
/* Various flags. */
struct {
unsigned int magic: 16;
unsigned int writing: 1;
unsigned int reserved: 15;
} flags;
/* A pointer to the stream buffer. */
unsigned char *buffer;
/* The size of the buffer in bytes. */
size_t buffer_size;
/* The length of the usable data in the buffer, only valid when in
read mode (see flags). */
size_t data_len;
/* The current position of the offset pointer, valid in read and
write mode. */
size_t data_offset;
size_t data_flushed;
unsigned char *unread_buffer;
size_t unread_buffer_size;
/* The number of unread bytes. */
size_t unread_data_len;
/* A pointer to our internal data for this stream. */
struct _gpgrt_stream_internal *intern;
};
/* The opaque type for an estream. */
typedef struct _gpgrt__stream *gpgrt_stream_t;
#ifdef GPGRT_ENABLE_ES_MACROS
typedef struct _gpgrt__stream *estream_t;
#endif
typedef gpgrt_ssize_t (*gpgrt_cookie_read_function_t) (void *cookie,
void *buffer, size_t size);
typedef gpgrt_ssize_t (*gpgrt_cookie_write_function_t) (void *cookie,
const void *buffer,
size_t size);
typedef int (*gpgrt_cookie_seek_function_t) (void *cookie,
gpgrt_off_t *pos, int whence);
typedef int (*gpgrt_cookie_close_function_t) (void *cookie);
struct _gpgrt_cookie_io_functions
{
gpgrt_cookie_read_function_t func_read;
gpgrt_cookie_write_function_t func_write;
gpgrt_cookie_seek_function_t func_seek;
gpgrt_cookie_close_function_t func_close;
};
typedef struct _gpgrt_cookie_io_functions gpgrt_cookie_io_functions_t;
#ifdef GPGRT_ENABLE_ES_MACROS
typedef struct _gpgrt_cookie_io_functions es_cookie_io_functions_t;
#define es_cookie_read_function_t gpgrt_cookie_read_function_t
#define es_cookie_write_function_t gpgrt_cookie_read_function_t
#define es_cookie_seek_function_t gpgrt_cookie_read_function_t
#define es_cookie_close_function_t gpgrt_cookie_read_function_t
#endif
enum gpgrt_syshd_types
{
GPGRT_SYSHD_NONE = 0, /* No system handle available. */
GPGRT_SYSHD_FD = 1, /* A file descriptor as returned by open(). */
GPGRT_SYSHD_SOCK = 2, /* A socket as returned by socket(). */
GPGRT_SYSHD_RVID = 3, /* A rendezvous id (see libassuan's gpgcedev.c). */
GPGRT_SYSHD_HANDLE = 4 /* A HANDLE object (Windows). */
};
struct _gpgrt_syshd
{
enum gpgrt_syshd_types type;
union {
int fd;
int sock;
int rvid;
void *handle;
} u;
};
typedef struct _gpgrt_syshd gpgrt_syshd_t;
#ifdef GPGRT_ENABLE_ES_MACROS
typedef struct _gpgrt_syshd es_syshd_t;
#define ES_SYSHD_NONE GPGRT_SYSHD_NONE
#define ES_SYSHD_FD GPGRT_SYSHD_FD
#define ES_SYSHD_SOCK GPGRT_SYSHD_SOCK
#define ES_SYSHD_RVID GPGRT_SYSHD_RVID
#define ES_SYSHD_HANDLE GPGRT_SYSHD_HANDLE
#endif
/* The object used with gpgrt_poll. */
struct _gpgrt_poll_s
{
gpgrt_stream_t stream;
unsigned int want_read:1;
unsigned int want_write:1;
unsigned int want_oob:1;
unsigned int want_rdhup:1;
unsigned int _reserv1:4;
unsigned int got_read:1;
unsigned int got_write:1;
unsigned int got_oob:1;
unsigned int got_rdhup:1;
unsigned int _reserv2:4;
unsigned int got_err:1;
unsigned int got_hup:1;
unsigned int got_nval:1;
unsigned int _reserv3:4;
unsigned int ignore:1;
unsigned int user:8; /* For application use. */
};
typedef struct _gpgrt_poll_s gpgrt_poll_t;
#ifdef GPGRT_ENABLE_ES_MACROS
typedef struct _gpgrt_poll_s es_poll_t;
#endif
/* The type of the string filter function as used by fprintf_sf et al. */
typedef char *(*gpgrt_string_filter_t) (const char *s, int n, void *opaque);
gpgrt_stream_t gpgrt_fopen (const char *_GPGRT__RESTRICT path,
const char *_GPGRT__RESTRICT mode);
gpgrt_stream_t gpgrt_mopen (void *_GPGRT__RESTRICT data,
size_t data_n, size_t data_len,
unsigned int grow,
void *(*func_realloc) (void *mem, size_t size),
void (*func_free) (void *mem),
const char *_GPGRT__RESTRICT mode);
gpgrt_stream_t gpgrt_fopenmem (size_t memlimit,
const char *_GPGRT__RESTRICT mode);
gpgrt_stream_t gpgrt_fopenmem_init (size_t memlimit,
const char *_GPGRT__RESTRICT mode,
const void *data, size_t datalen);
gpgrt_stream_t gpgrt_fdopen (int filedes, const char *mode);
gpgrt_stream_t gpgrt_fdopen_nc (int filedes, const char *mode);
gpgrt_stream_t gpgrt_sysopen (gpgrt_syshd_t *syshd, const char *mode);
gpgrt_stream_t gpgrt_sysopen_nc (gpgrt_syshd_t *syshd, const char *mode);
gpgrt_stream_t gpgrt_fpopen (FILE *fp, const char *mode);
gpgrt_stream_t gpgrt_fpopen_nc (FILE *fp, const char *mode);
gpgrt_stream_t gpgrt_freopen (const char *_GPGRT__RESTRICT path,
const char *_GPGRT__RESTRICT mode,
gpgrt_stream_t _GPGRT__RESTRICT stream);
gpgrt_stream_t gpgrt_fopencookie (void *_GPGRT__RESTRICT cookie,
const char *_GPGRT__RESTRICT mode,
gpgrt_cookie_io_functions_t functions);
int gpgrt_fclose (gpgrt_stream_t stream);
int gpgrt_fcancel (gpgrt_stream_t stream);
int gpgrt_fclose_snatch (gpgrt_stream_t stream,
void **r_buffer, size_t *r_buflen);
int gpgrt_onclose (gpgrt_stream_t stream, int mode,
void (*fnc) (gpgrt_stream_t, void*), void *fnc_value);
int gpgrt_fileno (gpgrt_stream_t stream);
int gpgrt_fileno_unlocked (gpgrt_stream_t stream);
int gpgrt_syshd (gpgrt_stream_t stream, gpgrt_syshd_t *syshd);
int gpgrt_syshd_unlocked (gpgrt_stream_t stream, gpgrt_syshd_t *syshd);
void _gpgrt_set_std_fd (int no, int fd);
gpgrt_stream_t _gpgrt_get_std_stream (int fd);
#define gpgrt_stdin _gpgrt_get_std_stream (0)
#define gpgrt_stdout _gpgrt_get_std_stream (1)
#define gpgrt_stderr _gpgrt_get_std_stream (2)
void gpgrt_flockfile (gpgrt_stream_t stream);
int gpgrt_ftrylockfile (gpgrt_stream_t stream);
void gpgrt_funlockfile (gpgrt_stream_t stream);
int gpgrt_feof (gpgrt_stream_t stream);
int gpgrt_feof_unlocked (gpgrt_stream_t stream);
int gpgrt_ferror (gpgrt_stream_t stream);
int gpgrt_ferror_unlocked (gpgrt_stream_t stream);
void gpgrt_clearerr (gpgrt_stream_t stream);
void gpgrt_clearerr_unlocked (gpgrt_stream_t stream);
int _gpgrt_pending (gpgrt_stream_t stream); /* (private) */
int _gpgrt_pending_unlocked (gpgrt_stream_t stream); /* (private) */
#define gpgrt_pending(stream) _gpgrt_pending (stream)
#define gpgrt_pending_unlocked(stream) \
(((!(stream)->flags.writing) \
&& (((stream)->data_offset < (stream)->data_len) \
|| ((stream)->unread_data_len))) \
? 1 : _gpgrt_pending_unlocked ((stream)))
int gpgrt_fflush (gpgrt_stream_t stream);
int gpgrt_fseek (gpgrt_stream_t stream, long int offset, int whence);
int gpgrt_fseeko (gpgrt_stream_t stream, gpgrt_off_t offset, int whence);
int gpgrt_ftruncate (gpgrt_stream_t stream, gpgrt_off_t length);
long int gpgrt_ftell (gpgrt_stream_t stream);
gpgrt_off_t gpgrt_ftello (gpgrt_stream_t stream);
void gpgrt_rewind (gpgrt_stream_t stream);
int gpgrt_fgetc (gpgrt_stream_t stream);
int gpgrt_fputc (int c, gpgrt_stream_t stream);
int _gpgrt_getc_underflow (gpgrt_stream_t stream); /* (private) */
int _gpgrt_putc_overflow (int c, gpgrt_stream_t stream); /* (private) */
#define gpgrt_getc_unlocked(stream) \
(((!(stream)->flags.writing) \
&& ((stream)->data_offset < (stream)->data_len) \
&& (! (stream)->unread_data_len)) \
? ((int) (stream)->buffer[((stream)->data_offset)++]) \
: _gpgrt_getc_underflow ((stream)))
#define gpgrt_putc_unlocked(c, stream) \
(((stream)->flags.writing \
&& ((stream)->data_offset < (stream)->buffer_size) \
&& (c != '\n')) \
? ((int) ((stream)->buffer[((stream)->data_offset)++] = (c))) \
: _gpgrt_putc_overflow ((c), (stream)))
#define gpgrt_getc(stream) gpgrt_fgetc (stream)
#define gpgrt_putc(c, stream) gpgrt_fputc (c, stream)
int gpgrt_ungetc (int c, gpgrt_stream_t stream);
int gpgrt_read (gpgrt_stream_t _GPGRT__RESTRICT stream,
void *_GPGRT__RESTRICT buffer, size_t bytes_to_read,
size_t *_GPGRT__RESTRICT bytes_read);
int gpgrt_write (gpgrt_stream_t _GPGRT__RESTRICT stream,
const void *_GPGRT__RESTRICT buffer, size_t bytes_to_write,
size_t *_GPGRT__RESTRICT bytes_written);
int gpgrt_write_sanitized (gpgrt_stream_t _GPGRT__RESTRICT stream,
const void *_GPGRT__RESTRICT buffer, size_t length,
const char *delimiters,
size_t *_GPGRT__RESTRICT bytes_written);
int gpgrt_write_hexstring (gpgrt_stream_t _GPGRT__RESTRICT stream,
const void *_GPGRT__RESTRICT buffer, size_t length,
int reserved,
size_t *_GPGRT__RESTRICT bytes_written);
size_t gpgrt_fread (void *_GPGRT__RESTRICT ptr, size_t size, size_t nitems,
gpgrt_stream_t _GPGRT__RESTRICT stream);
size_t gpgrt_fwrite (const void *_GPGRT__RESTRICT ptr, size_t size,
size_t nitems, gpgrt_stream_t _GPGRT__RESTRICT stream);
char *gpgrt_fgets (char *_GPGRT__RESTRICT s, int n,
gpgrt_stream_t _GPGRT__RESTRICT stream);
int gpgrt_fputs (const char *_GPGRT__RESTRICT s,
gpgrt_stream_t _GPGRT__RESTRICT stream);
int gpgrt_fputs_unlocked (const char *_GPGRT__RESTRICT s,
gpgrt_stream_t _GPGRT__RESTRICT stream);
gpgrt_ssize_t gpgrt_getline (char *_GPGRT__RESTRICT *_GPGRT__RESTRICT lineptr,
size_t *_GPGRT__RESTRICT n,
gpgrt_stream_t stream);
gpgrt_ssize_t gpgrt_read_line (gpgrt_stream_t stream,
char **addr_of_buffer, size_t *length_of_buffer,
size_t *max_length);
int gpgrt_fprintf (gpgrt_stream_t _GPGRT__RESTRICT stream,
const char *_GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(2,3);
int gpgrt_fprintf_unlocked (gpgrt_stream_t _GPGRT__RESTRICT stream,
const char *_GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(2,3);
int gpgrt_fprintf_sf (gpgrt_stream_t _GPGRT__RESTRICT stream,
gpgrt_string_filter_t sf, void *sfvalue,
const char *_GPGRT__RESTRICT format,
...) GPGRT_ATTR_PRINTF(4,5);
int gpgrt_fprintf_sf_unlocked (gpgrt_stream_t _GPGRT__RESTRICT stream,
gpgrt_string_filter_t sf, void *sfvalue,
const char *_GPGRT__RESTRICT format,
...) GPGRT_ATTR_PRINTF(4,5);
int gpgrt_printf (const char *_GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(1,2);
int gpgrt_printf_unlocked (const char *_GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(1,2);
int gpgrt_vfprintf (gpgrt_stream_t _GPGRT__RESTRICT stream,
const char *_GPGRT__RESTRICT format, va_list ap)
GPGRT_ATTR_PRINTF(2,0);
int gpgrt_vfprintf_unlocked (gpgrt_stream_t _GPGRT__RESTRICT stream,
const char *_GPGRT__RESTRICT format, va_list ap)
GPGRT_ATTR_PRINTF(2,0);
int gpgrt_setvbuf (gpgrt_stream_t _GPGRT__RESTRICT stream,
char *_GPGRT__RESTRICT buf, int mode, size_t size);
void gpgrt_setbuf (gpgrt_stream_t _GPGRT__RESTRICT stream,
char *_GPGRT__RESTRICT buf);
void gpgrt_set_binary (gpgrt_stream_t stream);
int gpgrt_set_nonblock (gpgrt_stream_t stream, int onoff);
int gpgrt_get_nonblock (gpgrt_stream_t stream);
int gpgrt_poll (gpgrt_poll_t *fdlist, unsigned int nfds, int timeout);
gpgrt_stream_t gpgrt_tmpfile (void);
void gpgrt_opaque_set (gpgrt_stream_t _GPGRT__RESTRICT stream,
void *_GPGRT__RESTRICT opaque);
void *gpgrt_opaque_get (gpgrt_stream_t stream);
void gpgrt_fname_set (gpgrt_stream_t stream, const char *fname);
const char *gpgrt_fname_get (gpgrt_stream_t stream);
int gpgrt_asprintf (char **r_buf, const char * _GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(2,3);
int gpgrt_vasprintf (char **r_buf, const char * _GPGRT__RESTRICT format,
va_list ap)
GPGRT_ATTR_PRINTF(2,0);
char *gpgrt_bsprintf (const char * _GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(1,2);
char *gpgrt_vbsprintf (const char * _GPGRT__RESTRICT format, va_list ap)
GPGRT_ATTR_PRINTF(1,0);
int gpgrt_snprintf (char *buf, size_t bufsize,
const char * _GPGRT__RESTRICT format, ...)
GPGRT_ATTR_PRINTF(3,4);
int gpgrt_vsnprintf (char *buf,size_t bufsize,
const char * _GPGRT__RESTRICT format, va_list arg_ptr)
GPGRT_ATTR_PRINTF(3,0);
#ifdef GPGRT_ENABLE_ES_MACROS
# define es_fopen gpgrt_fopen
# define es_mopen gpgrt_mopen
# define es_fopenmem gpgrt_fopenmem
# define es_fopenmem_init gpgrt_fopenmem_init
# define es_fdopen gpgrt_fdopen
# define es_fdopen_nc gpgrt_fdopen_nc
# define es_sysopen gpgrt_sysopen
# define es_sysopen_nc gpgrt_sysopen_nc
# define es_fpopen gpgrt_fpopen
# define es_fpopen_nc gpgrt_fpopen_nc
# define es_freopen gpgrt_freopen
# define es_fopencookie gpgrt_fopencookie
# define es_fclose gpgrt_fclose
# define es_fclose_snatch gpgrt_fclose_snatch
# define es_onclose gpgrt_onclose
# define es_fileno gpgrt_fileno
# define es_fileno_unlocked gpgrt_fileno_unlocked
# define es_syshd gpgrt_syshd
# define es_syshd_unlocked gpgrt_syshd_unlocked
# define es_stdin _gpgrt_get_std_stream (0)
# define es_stdout _gpgrt_get_std_stream (1)
# define es_stderr _gpgrt_get_std_stream (2)
# define es_flockfile gpgrt_flockfile
# define es_ftrylockfile gpgrt_ftrylockfile
# define es_funlockfile gpgrt_funlockfile
# define es_feof gpgrt_feof
# define es_feof_unlocked gpgrt_feof_unlocked
# define es_ferror gpgrt_ferror
# define es_ferror_unlocked gpgrt_ferror_unlocked
# define es_clearerr gpgrt_clearerr
# define es_clearerr_unlocked gpgrt_clearerr_unlocked
# define es_pending gpgrt_pending
# define es_pending_unlocked gpgrt_pending_unlocked
# define es_fflush gpgrt_fflush
# define es_fseek gpgrt_fseek
# define es_fseeko gpgrt_fseeko
# define es_ftruncate gpgrt_ftruncate
# define es_ftell gpgrt_ftell
# define es_ftello gpgrt_ftello
# define es_rewind gpgrt_rewind
# define es_fgetc gpgrt_fgetc
# define es_fputc gpgrt_fputc
# define es_getc_unlocked gpgrt_getc_unlocked
# define es_putc_unlocked gpgrt_putc_unlocked
# define es_getc gpgrt_getc
# define es_putc gpgrt_putc
# define es_ungetc gpgrt_ungetc
# define es_read gpgrt_read
# define es_write gpgrt_write
# define es_write_sanitized gpgrt_write_sanitized
# define es_write_hexstring gpgrt_write_hexstring
# define es_fread gpgrt_fread
# define es_fwrite gpgrt_fwrite
# define es_fgets gpgrt_fgets
# define es_fputs gpgrt_fputs
# define es_fputs_unlocked gpgrt_fputs_unlocked
# define es_getline gpgrt_getline
# define es_read_line gpgrt_read_line
# define es_free gpgrt_free
# define es_fprintf gpgrt_fprintf
# define es_fprintf_unlocked gpgrt_fprintf_unlocked
# define es_printf gpgrt_printf
# define es_printf_unlocked gpgrt_printf_unlocked
# define es_vfprintf gpgrt_vfprintf
# define es_vfprintf_unlocked gpgrt_vfprintf_unlocked
# define es_setvbuf gpgrt_setvbuf
# define es_setbuf gpgrt_setbuf
# define es_set_binary gpgrt_set_binary
# define es_set_nonblock gpgrt_set_nonblock
# define es_get_nonblock gpgrt_get_nonblock
# define es_poll gpgrt_poll
# define es_tmpfile gpgrt_tmpfile
# define es_opaque_set gpgrt_opaque_set
# define es_opaque_get gpgrt_opaque_get
# define es_fname_set gpgrt_fname_set
# define es_fname_get gpgrt_fname_get
# define es_asprintf gpgrt_asprintf
# define es_vasprintf gpgrt_vasprintf
# define es_bsprintf gpgrt_bsprintf
# define es_vbsprintf gpgrt_vbsprintf
#endif /*GPGRT_ENABLE_ES_MACROS*/
/*
* Base64 encode and decode functions.
*/
struct _gpgrt_b64state;
typedef struct _gpgrt_b64state *gpgrt_b64state_t;
gpgrt_b64state_t gpgrt_b64enc_start (gpgrt_stream_t stream, const char *title);
gpg_err_code_t gpgrt_b64enc_write (gpgrt_b64state_t state,
const void *buffer, size_t nbytes);
gpg_err_code_t gpgrt_b64enc_finish (gpgrt_b64state_t state);
gpgrt_b64state_t gpgrt_b64dec_start (const char *title);
gpg_error_t gpgrt_b64dec_proc (gpgrt_b64state_t state,
void *buffer, size_t length,
size_t *r_nbytes);
gpg_error_t gpgrt_b64dec_finish (gpgrt_b64state_t state);
/*
* Logging functions
*/
/* Flag values for gpgrt_log_set_prefix. */
#define GPGRT_LOG_WITH_PREFIX 1
#define GPGRT_LOG_WITH_TIME 2
#define GPGRT_LOG_WITH_PID 4
#define GPGRT_LOG_RUN_DETACHED 256
#define GPGRT_LOG_NO_REGISTRY 512
/* Log levels as used by gpgrt_log. */
enum gpgrt_log_levels
{
GPGRT_LOGLVL_BEGIN,
GPGRT_LOGLVL_CONT,
GPGRT_LOGLVL_INFO,
GPGRT_LOGLVL_WARN,
GPGRT_LOGLVL_ERROR,
GPGRT_LOGLVL_FATAL,
GPGRT_LOGLVL_BUG,
GPGRT_LOGLVL_DEBUG
};
/* The next 4 functions are not thread-safe - call them early. */
void gpgrt_log_set_sink (const char *name, gpgrt_stream_t stream, int fd);
void gpgrt_log_set_socket_dir_cb (const char *(*fnc)(void));
void gpgrt_log_set_pid_suffix_cb (int (*cb)(unsigned long *r_value));
void gpgrt_log_set_prefix (const char *text, unsigned int flags);
int gpgrt_get_errorcount (int clear);
void gpgrt_inc_errorcount (void);
const char *gpgrt_log_get_prefix (unsigned int *flags);
int gpgrt_log_test_fd (int fd);
int gpgrt_log_get_fd (void);
gpgrt_stream_t gpgrt_log_get_stream (void);
void gpgrt_log (int level, const char *fmt, ...) GPGRT_ATTR_PRINTF(2,3);
void gpgrt_logv (int level, const char *fmt, va_list arg_ptr);
void gpgrt_logv_prefix (int level, const char *prefix,
const char *fmt, va_list arg_ptr);
void gpgrt_log_string (int level, const char *string);
void gpgrt_log_bug (const char *fmt, ...) GPGRT_ATTR_NR_PRINTF(1,2);
void gpgrt_log_fatal (const char *fmt, ...) GPGRT_ATTR_NR_PRINTF(1,2);
void gpgrt_log_error (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
void gpgrt_log_info (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
void gpgrt_log_debug (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
void gpgrt_log_debug_string (const char *string,
const char *fmt, ...) GPGRT_ATTR_PRINTF(2,3);
void gpgrt_log_printf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
void gpgrt_log_printhex (const void *buffer, size_t length,
const char *fmt, ...) GPGRT_ATTR_PRINTF(3,4);
void gpgrt_log_clock (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
void gpgrt_log_flush (void);
void _gpgrt_log_assert (const char *expr, const char *file, int line,
const char *func) GPGRT_ATTR_NORETURN;
#ifdef GPGRT_HAVE_MACRO_FUNCTION
# define gpgrt_assert(expr) \
((expr) \
? (void) 0 \
: _gpgrt_log_assert (#expr, __FILE__, __LINE__, __FUNCTION__))
#else /*!GPGRT_HAVE_MACRO_FUNCTION*/
# define gpgrt_assert(expr) \
((expr) \
? (void) 0 \
: _gpgrt_log_assert (#expr, __FILE__, __LINE__, NULL))
#endif /*!GPGRT_HAVE_MACRO_FUNCTION*/
#ifdef GPGRT_ENABLE_LOG_MACROS
# define log_get_errorcount gpgrt_get_errorcount
# define log_inc_errorcount gpgrt_inc_errorcount
# define log_set_file(a) gpgrt_log_set_sink ((a), NULL, -1)
# define log_set_fd(a) gpgrt_log_set_sink (NULL, NULL, (a))
# define log_set_stream(a) gpgrt_log_set_sink (NULL, (a), -1)
# define log_set_socket_dir_cb gpgrt_log_set_socket_dir_cb
# define log_set_pid_suffix_cb gpgrt_log_set_pid_suffix_cb
# define log_set_prefix gpgrt_log_set_prefix
# define log_get_prefix gpgrt_log_get_prefix
# define log_test_fd gpgrt_log_test_fd
# define log_get_fd gpgrt_log_get_fd
# define log_get_stream gpgrt_log_get_stream
# define log_log gpgrt_log
# define log_logv gpgrt_logv
# define log_logv_prefix gpgrt_logv_prefix
# define log_string gpgrt_log_string
# define log_bug gpgrt_log_bug
# define log_fatal gpgrt_log_fatal
# define log_error gpgrt_log_error
# define log_info gpgrt_log_info
# define log_debug gpgrt_log_debug
# define log_debug_string gpgrt_log_debug_string
# define log_printf gpgrt_log_printf
# define log_printhex gpgrt_log_printhex
# define log_clock gpgrt_log_clock
# define log_flush gpgrt_log_flush
# ifdef GPGRT_HAVE_MACRO_FUNCTION
# define log_assert(expr) \
((expr) \
? (void) 0 \
: _gpgrt_log_assert (#expr, __FILE__, __LINE__, __FUNCTION__))
# else /*!GPGRT_HAVE_MACRO_FUNCTION*/
# define log_assert(expr) \
((expr) \
? (void) 0 \
: _gpgrt_log_assert (#expr, __FILE__, __LINE__, NULL))
# endif /*!GPGRT_HAVE_MACRO_FUNCTION*/
#endif /*GPGRT_ENABLE_LOG_MACROS*/
/*
* Spawn functions (Not yet available)
*/
#define GPGRT_SPAWN_NONBLOCK 16 /* Set the streams to non-blocking. */
#define GPGRT_SPAWN_RUN_ASFW 64 /* Use AllowSetForegroundWindow on W32. */
#define GPGRT_SPAWN_DETACHED 128 /* Start the process in the background. */
#if 0
/* Function and convenience macros to create pipes. */
gpg_err_code_t gpgrt_make_pipe (int filedes[2], gpgrt_stream_t *r_fp,
int direction, int nonblock);
#define gpgrt_create_pipe(a) gpgrt_make_pipe ((a),NULL, 0, 0);
#define gpgrt_create_inbound_pipe(a,b,c) gpgrt_make_pipe ((a), (b), -1,(c));
#define gpgrt_create_outbound_pipe(a,b,c) gpgrt_make_pipe ((a), (b), 1,(c));
/* Fork and exec PGMNAME. */
gpg_err_code_t gpgrt_spawn_process (const char *pgmname, const char *argv[],
int *execpt, void (*preexec)(void),
unsigned int flags,
gpgrt_stream_t *r_infp,
gpgrt_stream_t *r_outfp,
gpgrt_stream_t *r_errfp,
pid_t *pid);
/* Fork and exec PGNNAME and connect the process to the given FDs. */
gpg_err_code_t gpgrt_spawn_process_fd (const char *pgmname, const char *argv[],
int infd, int outfd, int errfd,
pid_t *pid);
/* Fork and exec PGMNAME as a detached process. */
gpg_err_code_t gpgrt_spawn_process_detached (const char *pgmname,
const char *argv[],
const char *envp[] );
/* Wait for a single process. */
gpg_err_code_t gpgrt_wait_process (const char *pgmname, pid_t pid, int hang,
int *r_exitcode);
/* Wait for a multiple processes. */
gpg_err_code_t gpgrt_wait_processes (const char **pgmnames, pid_t *pids,
size_t count, int hang, int *r_exitcodes);
/* Kill the process identified by PID. */
void gpgrt_kill_process (pid_t pid);
/* Release process resources identified by PID. */
void gpgrt_release_process (pid_t pid);
#endif /*0*/
/*
* Option parsing.
*/
struct _gpgrt_argparse_internal_s;
typedef struct
{
int *argc; /* Pointer to ARGC (value subject to change). */
char ***argv; /* Pointer to ARGV (value subject to change). */
unsigned int flags; /* Global flags. May be set prior to calling the
parser. The parser may change the value. */
int err; /* Print error description for last option.
Either 0, ARGPARSE_PRINT_WARNING or
ARGPARSE_PRINT_ERROR. */
unsigned int lineno;/* The current line number. */
int r_opt; /* Returns option code. */
int r_type; /* Returns type of option value. */
union {
int ret_int;
long ret_long;
unsigned long ret_ulong;
char *ret_str;
} r; /* Return values */
struct _gpgrt_argparse_internal_s *internal;
} gpgrt_argparse_t;
typedef struct
{
int short_opt;
const char *long_opt;
unsigned int flags;
const char *description; /* Optional description. */
} gpgrt_opt_t;
#ifdef GPGRT_ENABLE_ARGPARSE_MACROS
/* Global flags for (gpgrt_argparse_t).flags. */
#define ARGPARSE_FLAG_KEEP 1 /* Do not remove options form argv. */
#define ARGPARSE_FLAG_ALL 2 /* Do not stop at last option but return
remaining args with R_OPT set to -1. */
#define ARGPARSE_FLAG_MIXED 4 /* Assume options and args are mixed. */
#define ARGPARSE_FLAG_NOSTOP 8 /* Do not stop processing at "--". */
#define ARGPARSE_FLAG_ARG0 16 /* Do not skip the first arg. */
#define ARGPARSE_FLAG_ONEDASH 32 /* Allow long options with one dash. */
#define ARGPARSE_FLAG_NOVERSION 64 /* No output for "--version". */
#define ARGPARSE_FLAG_RESET 128 /* Request to reset the internal state. */
#define ARGPARSE_FLAG_STOP_SEEN 256 /* Set to true if a "--" has been seen. */
#define ARGPARSE_FLAG_NOLINENO 512 /* Do not zero the lineno field. */
#define ARGPARSE_FLAG_SYS 1024 /* Use system config file. */
#define ARGPARSE_FLAG_USER 2048 /* Use user config file. */
#define ARGPARSE_FLAG_VERBOSE 4096 /* Print additional argparser info. */
#define ARGPARSE_FLAG_USERVERS 8192 /* Try version-ed user config files. */
#define ARGPARSE_FLAG_WITHATTR 16384 /* Return attribute bits. (Make sure */
/* to act upon ARGPARSE_OPT_IGNORE.) */
/* Constants for (gpgrt_argparse_t).err. */
#define ARGPARSE_PRINT_WARNING 1 /* Print a diagnostic. */
#define ARGPARSE_PRINT_ERROR 2 /* Print a diagnostic and call exit. */
/* Special return values of gpgrt_argparse. */
#define ARGPARSE_IS_ARG (-1)
#define ARGPARSE_INVALID_OPTION (-2)
#define ARGPARSE_MISSING_ARG (-3)
#define ARGPARSE_KEYWORD_TOO_LONG (-4)
#define ARGPARSE_READ_ERROR (-5)
#define ARGPARSE_UNEXPECTED_ARG (-6)
#define ARGPARSE_INVALID_COMMAND (-7)
#define ARGPARSE_AMBIGUOUS_OPTION (-8)
#define ARGPARSE_AMBIGUOUS_COMMAND (-9)
#define ARGPARSE_INVALID_ALIAS (-10)
#define ARGPARSE_OUT_OF_CORE (-11)
#define ARGPARSE_INVALID_ARG (-12)
#define ARGPARSE_PERMISSION_ERROR (-13)
#define ARGPARSE_NO_CONFFILE (-14)
#define ARGPARSE_CONFFILE (-15)
#define ARGPARSE_INVALID_META (-16)
#define ARGPARSE_UNKNOWN_META (-17)
#define ARGPARSE_UNEXPECTED_META (-18)
/* Flags for the option descriptor (gpgrt_opt_t)->flags. Note that a
* TYPE constant may be or-ed with the OPT constants but when used as
* return value in r_type these OPT constants are normally not
* included. However with ARGPARSE_FLAG_WITHATTR used and an option
* would normally not be returned, it is returned but
* ARGPARSE_OPT_IGNORE is then set; further ARPARSE_ATTR_* are set.
*/
#define ARGPARSE_TYPE_MASK 0x0007 /* Mask for the type bits. */
#define ARGPARSE_TYPE_NONE 0 /* Does not take an argument. */
#define ARGPARSE_TYPE_INT 1 /* Takes an int argument. */
#define ARGPARSE_TYPE_STRING 2 /* Takes a string argument. */
#define ARGPARSE_TYPE_LONG 3 /* Takes a long argument. */
#define ARGPARSE_TYPE_ULONG 4 /* Takes an unsigned long argument. */
#define ARGPARSE_OPT_OPTIONAL (1<<3) /* Argument is optional. */
#define ARGPARSE_OPT_PREFIX (1<<4) /* Allow 0x etc. prefixed values. */
#define ARGPARSE_OPT_IGNORE (1<<6) /* Ignore command or option. */
#define ARGPARSE_OPT_COMMAND (1<<7) /* The argument is a command. */
#define ARGPARSE_OPT_CONFFILE (1<<8) /* The value is a conffile. */
#define ARGPARSE_OPT_HEADER (1<<9) /* The value is printed as a header. */
#define ARGPARSE_OPT_VERBATIM (1<<10)/* The value is printed verbatim. */
#define ARGPARSE_ATTR_FORCE (1<<14)/* Attribute force is set. */
#define ARGPARSE_ATTR_IGNORE (1<<15)/* Attribute ignore is set. */
/* A set of macros to make option definitions easier to read. */
#define ARGPARSE_x(s,l,t,f,d) \
{ (s), (l), ARGPARSE_TYPE_ ## t | (f), (d) }
#define ARGPARSE_s(s,l,t,d) \
{ (s), (l), ARGPARSE_TYPE_ ## t, (d) }
#define ARGPARSE_s_n(s,l,d) \
{ (s), (l), ARGPARSE_TYPE_NONE, (d) }
#define ARGPARSE_s_i(s,l,d) \
{ (s), (l), ARGPARSE_TYPE_INT, (d) }
#define ARGPARSE_s_s(s,l,d) \
{ (s), (l), ARGPARSE_TYPE_STRING, (d) }
#define ARGPARSE_s_l(s,l,d) \
{ (s), (l), ARGPARSE_TYPE_LONG, (d) }
#define ARGPARSE_s_u(s,l,d) \
{ (s), (l), ARGPARSE_TYPE_ULONG, (d) }
#define ARGPARSE_o(s,l,t,d) \
{ (s), (l), (ARGPARSE_TYPE_ ## t | ARGPARSE_OPT_OPTIONAL), (d) }
#define ARGPARSE_o_n(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_NONE | ARGPARSE_OPT_OPTIONAL), (d) }
#define ARGPARSE_o_i(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_INT | ARGPARSE_OPT_OPTIONAL), (d) }
#define ARGPARSE_o_s(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_STRING | ARGPARSE_OPT_OPTIONAL), (d) }
#define ARGPARSE_o_l(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_LONG | ARGPARSE_OPT_OPTIONAL), (d) }
#define ARGPARSE_o_u(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_ULONG | ARGPARSE_OPT_OPTIONAL), (d) }
#define ARGPARSE_p(s,l,t,d) \
{ (s), (l), (ARGPARSE_TYPE_ ## t | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_p_n(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_NONE | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_p_i(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_INT | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_p_s(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_STRING | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_p_l(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_LONG | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_p_u(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_ULONG | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_op(s,l,t,d) \
{ (s), (l), (ARGPARSE_TYPE_ ## t \
| ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_op_n(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_NONE \
| ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_op_i(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_INT \
| ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_op_s(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_STRING \
| ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_op_l(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_LONG \
| ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_op_u(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_ULONG \
| ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
#define ARGPARSE_c(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_NONE | ARGPARSE_OPT_COMMAND), (d) }
#define ARGPARSE_conffile(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_STRING|ARGPARSE_OPT_CONFFILE), (d) }
#define ARGPARSE_noconffile(s,l,d) \
{ (s), (l), (ARGPARSE_TYPE_NONE|ARGPARSE_OPT_CONFFILE), (d) }
/* This macro is for stub or obsolete options. */
#define ARGPARSE_ignore(s,l) \
{ (s), (l), (ARGPARSE_OPT_IGNORE), "@" }
/* This is a legacy version of ARGPARSE_verbatim which really does
* verbatim printing. */
#define ARGPARSE_group(s,d) \
{ (s), NULL, 0, (d) }
/* Verbatim print the string D in the help output. It does not make
* use of the "@" hack as ARGPARSE_group does. */
#define ARGPARSE_verbatim(d) \
{ 1, NULL, (ARGPARSE_OPT_VERBATIM), (d) }
/* Same as ARGPARSE_verbatim but also print a colon and a LF. N can
* be used give a symbolic name to the header. Nothing is printed if
* D is the empty string. */
#define ARGPARSE_header(n,d) \
{ 1, (n), (ARGPARSE_OPT_HEADER), (d) }
/* Mark the end of the list (mandatory). */
#define ARGPARSE_end() \
{ 0, NULL, 0, NULL }
#endif /* GPGRT_ENABLE_ARGPARSE_MACROS */
/* Values used for gpgrt_set_confdir. */
#define GPGRT_CONFDIR_USER 1 /* The user's configuration dir. */
#define GPGRT_CONFDIR_SYS 2 /* The systems's configuration dir. */
/* Take care: gpgrt_argparse keeps state in ARG and requires that
* either ARGPARSE_FLAG_RESET is used after OPTS has been changed or
* gpgrt_argparse (NULL, ARG, NULL) is called first. */
int gpgrt_argparse (gpgrt_stream_t fp,
gpgrt_argparse_t *arg, gpgrt_opt_t *opts);
int gpgrt_argparser (gpgrt_argparse_t *arg, gpgrt_opt_t *opts,
const char *confname);
void gpgrt_usage (int level);
const char *gpgrt_strusage (int level);
void gpgrt_set_strusage (const char *(*f)(int));
void gpgrt_set_usage_outfnc (int (*f)(int, const char *));
void gpgrt_set_fixed_string_mapper (const char *(*f)(const char*));
void gpgrt_set_confdir (int what, const char *name);
/*
* Various helper functions
*/
/* Compare arbitrary version strings. For the standard m.n.o version
* numbering scheme a LEVEL of 3 is suitable; see the manual. */
int gpgrt_cmp_version (const char *a, const char *b, int level);
/* Construct a filename from the NULL terminated list of parts. Tilde
* expansion is done for the first argument. The caller must release
* the result using gpgrt_free; on error ERRNO is set and NULL
* returned. The second function returns an absolute filename. */
char *gpgrt_fnameconcat (const char *first, ...) GPGRT_ATTR_SENTINEL(0);
char *gpgrt_absfnameconcat (const char *first, ...) GPGRT_ATTR_SENTINEL(0);
#ifdef __cplusplus
}
#endif
#endif /* GPGRT_H */
#endif /* GPG_ERROR_H */
/*
Local Variables:
buffer-read-only: t
End:
*/
Reference in New Issue View Git Blame Copy Permalink