diff --git a/NEWS b/NEWS
index 649b85b..1309dcf 100644
--- a/NEWS
+++ b/NEWS
@@ -1,1027 +1,1028 @@
Noteworthy changes in version 1.38 (unreleased) [C28/A28/R_]
-----------------------------------------------
* Interface changes relative to the 1.37 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_fnameconcat NEW.
gpgrt_absfnameconcat NEW.
gpgrt_set_confdir NEW.
gpgrt_argparser NEW.
ARGPARSE_FLAG_SYS NEW.
ARGPARSE_FLAG_USER NEW.
ARGPARSE_FLAG_VERBOSE NEW.
+ ARGPARSE_FLAG_USERVERS NEW.
ARGPARSE_NO_CONFFILE NEW.
ARGPARSE_CONFFILE NEW.
ARGPARSE_OPT_CONFFILE NEW.
ARGPARSE_PERMISSION_ERROR NEW.
ARGPARSE_conffile NEW.
ARGPARSE_noconffile NEW.
GPGRT_CONFDIR_USER NEW.
GPGRT_CONFDIR_SYS NEW.
Release-info: https://dev.gnupg.org/T
Noteworthy changes in version 1.37 (2020-02-07) [C28/A28/R0]
-----------------------------------------------
* Fixes a build problems when using Gawk 5.0 [#4459]
* Fixes Bourne shell incompatibilities on Solaris. [#4574]
* Improves cross-comiling support. [#4643]
* On Windows strerror_s is now used to emulate strerror_r. [#4539]
* New error codes to map SQLite primary error codes.
* Now uses poll(2) instead of select(2) in gpgrt_poll if possible.
* Fixes a bug in gpgrt_close. [#4698]
* Fixes build problem under Cygwin. [#4474]
* Fixes a few minor portability bugs.
* Interface changes relative to the 1.36 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NO_KEYBOXD NEW.
GPG_ERR_KEYBOXD NEW.
GPG_ERR_NO_SERVICE NEW.
GPG_ERR_SERVICE. NEW.
GPG_ERR_SQL_OK NEW.
GPG_ERR_SQL_ERROR NEW.
GPG_ERR_SQL_INTERNAL NEW.
GPG_ERR_SQL_PERM NEW.
GPG_ERR_SQL_ABORT NEW.
GPG_ERR_SQL_BUSY NEW.
GPG_ERR_SQL_LOCKED NEW.
GPG_ERR_SQL_NOMEM NEW.
GPG_ERR_SQL_READONLY NEW.
GPG_ERR_SQL_INTERRUPT NEW.
GPG_ERR_SQL_IOERR NEW.
GPG_ERR_SQL_CORRUPT NEW.
GPG_ERR_SQL_NOTFOUND NEW.
GPG_ERR_SQL_FULL NEW.
GPG_ERR_SQL_CANTOPEN NEW.
GPG_ERR_SQL_PROTOCOL NEW.
GPG_ERR_SQL_EMPTY NEW.
GPG_ERR_SQL_SCHEMA NEW.
GPG_ERR_SQL_TOOBIG NEW.
GPG_ERR_SQL_CONSTRAINT NEW.
GPG_ERR_SQL_MISMATCH NEW.
GPG_ERR_SQL_MISUSE NEW.
GPG_ERR_SQL_NOLFS NEW.
GPG_ERR_SQL_AUTH NEW.
GPG_ERR_SQL_FORMAT NEW.
GPG_ERR_SQL_RANGE NEW.
GPG_ERR_SQL_NOTADB NEW.
GPG_ERR_SQL_NOTICE NEW.
GPG_ERR_SQL_WARNING NEW.
GPG_ERR_SQL_ROW NEW.
GPG_ERR_SQL_DONE NEW.
Release-info: https://dev.gnupg.org/T4772
Noteworthy changes in version 1.36 (2019-03-19) [C27/A27/R0]
-----------------------------------------------
* Two new error codes to better support PIV cards.
* Support armv7a-unknown-linux-gnueabihf.
* Increased estream buffer sizes for Windows.
* Interface changes relative to the 1.34 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NO_AUTH NEW.
GPG_ERR_BAD_AUTH NEW.
Release-info: https://dev.gnupg.org/T4413
Noteworthy changes in version 1.35 (2019-01-28) [C26/A26/R1]
-----------------------------------------------
* Distribute the correct gpgrt-config.
Noteworthy changes in version 1.34 (2019-01-16) [C26/A26/R0]
-----------------------------------------------
* Support for riscv32.
* New API to allow emergency cleanup after internal fatal errors.
* Minor bug and portability fixes. [#4286,#4298
* Interface changes relative to the 1.33 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_abort NEW.
gpgrt_add_emergency_cleanup NEW.
Release-info: https://dev.gnupg.org/T4296
Noteworthy changes in version 1.33 (2018-12-07) [C25/A25/R0]
-----------------------------------------------
* New unified config script gpgrt-config which can now be used by all
GnuPG related packages.
* Support for ARC and arm64ilp32.
* The log functions now sanitize strings printed with the "%s" format
specifier. All control characters are C-escaped in the output.
Users of that function may want to remove their own escaping to
avoid doubling of backslashes.
* New fprintf style function to apply a custom filter for string
arguments.
* New function to compare version strings.
* Interface changes relative to the 1.28 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_cmp_version New.
gpgrt_string_filter_t New.
gpgrt_fprintf_sf New.
gpgrt_fprintf_sf_unlocked New.
gpgrt_ftruncate New but limited functionality.
gpgrt_w32_override_locale New.
Release-info: https://dev.gnupg.org/T4205
Noteworthy changes in version 1.32 (2018-07-12) [C24/A24/R3]
-----------------------------------------------
* Fixes a problem with gpgrt_fflush and gpgrt_fopencookie. [#4069]
* Fixes a problem with the C11 header stdnoreturn.h. [#4002]
* The yat2m tool can now also be build on Windows.
* Updates translations for Spanish, Russian and Ukrainian.
Noteworthy changes in version 1.31 (2018-05-02) [C24/A24/R2]
-----------------------------------------------
* Fixes another problem with gpgrt_poll under Windows. [#3937]
* New translation for Spanish.
Noteworthy changes in version 1.30 (2018-04-30) [C24/A24/R1]
-----------------------------------------------
* Fixes a hang on Windows when using gpgrt_poll under nPth.
* Build fix for Solaris. [#3869]
Noteworthy changes in version 1.29 (2018-04-11) [C24/A24/R0]
-----------------------------------------------
* The yat2m tool is during cross-compile now also installed on the
host platform.
* New option parser and associated functions similar to the one used
by GnuPG.
* New Base-64 encoder.
* Fixes regression in 1.28 for arm64 and w64 builds.
* Interface changes relative to the 1.28 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_argparse New.
gpgrt_usage New.
gpgrt_strusage New.
gpgrt_set_strusage New.
gpgrt_set_usage_outfnc New.
gpgrt_set_fixed_string_mapper New.
GPGRT_ENABLE_ARGPARSE_MACROS New macro.
gpgrt_b64enc_start New.
gpgrt_b64enc_write New.
gpgrt_b64enc_finish New.
Noteworthy changes in version 1.28 (2018-03-13) [C23/A23/R0]
-----------------------------------------------
* The formerly internal yat2m tool is now installed for a native
build.
* The new files gpgrt.m4 and gpgrt-config are now installed. They
can be used instead of gpg-error.m4 and gpg-error-config.
* New logging functions similar to those used by GnuPG.
* New helper functions for platform abstraction.
* Interface changes relative to the 1.27 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_get_errorcount New API.
gpgrt_inc_errorcount New API.
gpgrt_log_set_sink New API.
gpgrt_log_set_socket_dir_cb New API.
gpgrt_log_set_pid_suffix_cb New API.
gpgrt_log_set_prefix New API.
gpgrt_log_get_prefix New API.
gpgrt_log_test_fd New API.
gpgrt_log_get_fd New API.
gpgrt_log_get_stream New API.
gpgrt_log New API.
gpgrt_logv New API.
gpgrt_logv_prefix New API.
gpgrt_log_string New API.
gpgrt_log_info New API.
gpgrt_log_error New API.
gpgrt_log_fatal New API.
gpgrt_log_bug New API.
gpgrt_log_debug New API.
gpgrt_log_debug_string New API.
gpgrt_log_printf New API.
gpgrt_log_flush New API.
gpgrt_log_printhex New API.
gpgrt_log_clock New API.
gpgrt_assert New macro.
_gpgrt_log_assert New internal API.
GPGRT_LOGLVL_BEGIN New const.
GPGRT_LOGLVL_CONT New const.
GPGRT_LOGLVL_INFO New const.
GPGRT_LOGLVL_WARN New const.
GPGRT_LOGLVL_ERROR New const.
GPGRT_LOGLVL_FATAL New const.
GPGRT_LOGLVL_BUG New const.
GPGRT_LOGLVL_DEBUG New const.
gpgrt_realloc New API.
gpgrt_malloc New API.
gpgrt_calloc New API.
gpgrt_strdup New API.
gpgrt_strconcat New API.
gpgrt_w32_reg_query_string New API.
gpgrt_getenv New API.
gpgrt_setenv New API.
gpgrt_mkdir New API.
gpgrt_chdir New API.
gpgrt_getcwd New API.
Noteworthy changes in version 1.27 (2017-02-28) [C22/A22/R0]
-----------------------------------------------
* Added a Base64 decoder.
* Added support for the sh3 architecture.
* Added header gpgrt.h as an alias for gpg-error.h.
* Fixed macro GPGRT_GCC_VERSION.
* Fixed a race in non-blocking I/O on Windows.
* Interface changes relative to the 1.26 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_b64state_t NEW type.
gpgrt_b64dec_start NEW.
gpgrt_b64dec_proc NEW.
gpgrt_b64dec_finish NEW.
GPG_ERR_WRONG_NAME NEW.
gpgrt.h NEW header.
Noteworthy changes in version 1.26 (2016-12-21) [C21/A21/R0]
-----------------------------------------------
* New option --desc for gpg-error.
* Interface changes relative to the 1.25 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_UNKNOWN_FLAG NEW.
GPG_ERR_INV_ORDER NEW.
GPG_ERR_ALREADY_FETCHED NEW.
GPG_ERR_TRY_LATER NEW.
GPG_ERR_SYSTEM_BUG NEW.
GPG_ERR_DNS_UNKNOWN NEW.
GPG_ERR_DNS_SECTION NEW.
GPG_ERR_DNS_ADDRESS NEW.
GPG_ERR_DNS_NO_QUERY NEW.
GPG_ERR_DNS_NO_ANSWER NEW.
GPG_ERR_DNS_CLOSED NEW.
GPG_ERR_DNS_VERIFY NEW.
GPG_ERR_DNS_TIMEOUT NEW.
Noteworthy changes in version 1.25 (2016-11-14) [C20/A20/R0]
-----------------------------------------------
* New interface gpgrt_get_syscall_clamp to allow libaries to make use
of Libgpg-error's system call wrapper functions.
* gpgrt_poll does now work under Windows.
* Fixed bug in the locking code when used with the nPth threading
library.
* Added support for {i686,x86_64}-apple-darwin.
* Added new error codes.
* Interface changes relative to the 1.23 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_get_syscall_clamp NEW.
GPG_ERR_ENGINE_TOO_OLD NEW.
GPG_ERR_WINDOW_TOO_SMALL NEW.
GPG_ERR_WINDOW_TOO_LARGE NEW.
GPG_ERR_MISSING_ENVVAR NEW.
GPG_ERR_USER_ID_EXISTS NEW.
GPG_ERR_NAME_EXISTS NEW.
GPG_ERR_DUP_NAME NEW.
GPG_ERR_TOO_OLD NEW.
GPG_ERR_TOO_YOUNG NEW.
Noteworthy changes in version 1.24 (2016-07-14) [C19/A19/R1]
-----------------------------------------------
* Fixes a bug in es_fclose_snatch when used used after es_fseek.
* Fixes building without thread support.
* New configure option --disable-tests.
Noteworthy changes in version 1.23 (2016-06-15) [C19/A19/R0]
-----------------------------------------------
* Fixes an assertion failure due to es_flush on read/write streams.
* Fixes a bug with a too short memory limit is es_fopenmen.
* Cross-build support for powerpc-unknown-linux-gnuspe and
tilegx-unknown-linux-gnu architectures.
* Interface changes relative to the 1.22 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_SUBKEYS_EXP_OR_REV NEW.
Noteworthy changes in version 1.22 (2016-04-25) [C18/A18/R0]
-----------------------------------------------
* New functions and macros to to provide iconv(3) on Windows.
* Support for LeakSanitizer with the gpgrt_annotate_leaked_object
inline function.
* Interface changes relative to the 1.21 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_DB_CORRUPTED NEW.
gpgrt_annotate_leaked_object NEW inline func.
GPGRT_ENABLE_W32_ICONV_MACROS NEW.
gpgrt_w32_iconv_open NEW.
gpgrt_w32_iconv_close NEW.
gpgrt_w32_iconv NEW.
Noteworthy changes in version 1.21 (2015-12-12) [C17/A17/R0]
-----------------------------------------------
* New functions gpgrt_poll and gpgrt_set_nonblock. For now only
pipes and sockets on Unix are supported.
* Fixes gettext output encoding problems on Windows.
* Interface changes relative to the 1.20 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpgrt_set_nonblock NEW.
gpgrt_get_nonblock NEW.
gpgrt_poll NEW.
gpgrt_poll_t NEW type.
es_poll_t NEW type.
es_set_nonblock NEW macro.
es_get_nonblock NEW macro.
es_poll NEW macro.
GPG_ERR_TRUE NEW.
GPG_ERR_FALSE NEW.
GPG_ERR_NO_NAME NEW.
GPG_ERR_NO_KEY NEW.
GPG_ERR_SERVER_FAILED NEW.
Noteworthy changes in version 1.20 (2015-08-26) [C16/A16/R0]
-----------------------------------------------
* New macros for GCC attributes.
* Make es_set_binary actually work for Windows.
* Allow building without thread support.
* Build without a build timestamp by default.
* Interface changes relative to the 1.19 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPGRT_VERSION NEW macro.
GPGRT_VERSION_NUMBER NEW macro.
GPGRT_INLINE NEW macro.
GPGRT_GCC_VERSION NEW macro.
GPGRT_ATTR_NORETURN NEW macro.
GPGRT_ATTR_PRINTF NEW macro.
GPGRT_ATTR_NR_PRINTF NEW macro.
GPGRT_ATTR_FORMAT_ARG NEW macro.
GPGRT_ATTR_SENTINEL NEW macro.
GPGRT_ATTR_USED NEW macro.
GPGRT_ATTR_UNUSED NEW macro.
GPGRT_ATTR_DEPRECATED NEW macro.
GPGRT_ATTR_PURE NEW macro.
GPGRT_ATTR_MALLOC NEW macro.
GPGRT_HAVE_MACRO_FUNCTION NEW macro.
GPGRT_HAVE_PRAGMA_GCC_PUSH NEW macro.
Noteworthy changes in version 1.19 (2015-04-10) [C15/A15/R0]
-----------------------------------------------
* New set of error codes for use with LDAP.
* New options --help and --defines for gpg-error.
* Allow building with gcc 5.
* Interface changes relative to the 1.18 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_LDAP_* NEW.
Noteworthy changes in version 1.18 (2015-01-26) [C14/A14/R0]
-----------------------------------------------
* New translations for Hungarian, Portuguese, Russian, and
traditional Chinese. Updated other translations.
* New error codes.
* Interface changes relative to the 1.17 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_FORBIDDEN NEW.
GPG_ERR_OBJ_TERM_STATE NEW.
GPG_ERR_REQUEST_TOO_SHORT NEW.
GPG_ERR_REQUEST_TOO_LONG NEW.
GPG_ERR_LEGACY_KEY NEW.
Noteworthy changes in version 1.17 (2014-10-15) [C13/A13/R0]
-----------------------------------------------
* New error codes for TLS protocol libraries.
* New configure option --enable-build-timestamp.
* New man page for gpg-error-config.
* Interface changes relative to the 1.16 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_SOURCE_TLS NEW.
GPG_ERR_NO_CERT_CHAIN NEW.
GPG_ERR_CERT_TOO_LARGE NEW.
GPG_ERR_INV_RECORD NEW.
GPG_ERR_BAD_MAC NEW.
GPG_ERR_UNEXPECTED_MSG NEW.
GPG_ERR_COMPR_FAILED NEW.
GPG_ERR_WOULD_WRAP NEW.
GPG_ERR_FATAL_ALERT NEW.
GPG_ERR_NO_CIPHER NEW.
GPG_ERR_MISSING_CLIENT_CERT NEW.
GPG_ERR_CLOSE_NOTIFY NEW.
GPG_ERR_TICKET_EXPIRED NEW.
GPG_ERR_BAD_TICKET NEW.
GPG_ERR_UNKNOWN_IDENTITY NEW.
GPG_ERR_BAD_HS_CERT NEW.
GPG_ERR_BAD_HS_CERT_REQ NEW.
GPG_ERR_BAD_HS_CERT_VER NEW.
GPG_ERR_BAD_HS_CHANGE_CIPHER NEW.
GPG_ERR_BAD_HS_CLIENT_HELLO NEW.
GPG_ERR_BAD_HS_SERVER_HELLO NEW.
GPG_ERR_BAD_HS_SERVER_HELLO_DONE NEW.
GPG_ERR_BAD_HS_FINISHED NEW.
GPG_ERR_BAD_HS_SERVER_KEX NEW.
GPG_ERR_BAD_HS_CLIENT_KEX NEW.
GPG_ERR_BOGUS_STRING NEW.
gpgrt_pending NEW.
gpgrt_pending_unlocked NEW.
Noteworthy changes in version 1.16 (2014-09-18) [C12/A12/R2]
-----------------------------------------------
* Support building for iOS.
* Fixed a prototype mismatch.
* Fix es_fclose for streams opened with "samethread".
Noteworthy changes in version 1.15 (2014-09-11) [C12/A12/R1]
-----------------------------------------------
* This releases fixes problems with the use of off_t and ssize_t by
the estream functions introduced with 1.14. Although this is
technically an ABI break on some platforms, we take this as a
simple bug fix for 1.14. The new functions are very unlikely in
use by any code and thus no breakage should happen. The 1.14
tarball will be removed from the archive.
* Add type gpgrt_off_t which is guaranteed to be 64 bit.
* Add type gpgrt_ssize_t to make use on Windows easier. On Unix
platforms this is an alias for ssize_t.
Noteworthy changes in version 1.14 (2014-09-08) [C12/A12/R0]
-----------------------------------------------
* Added gpgrt_lock_trylock.
* Added the estream library under the name gpgrt and a set of macros
to use them with their "es_" names.
* Interface changes relative to the 1.13 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_KEY_DISABLED NEW.
gpgrt_init NEW macro.
gpgrt_check_version NEW.
gpgrt_lock_trylock NEW.
gpgrt_set_syscall_clamp NEW.
gpgrt_set_alloc_func NEW.
gpgrt_stream_t NEW.
gpgrt_cookie_io_functions_t NEW.
gpgrt_syshd_t NEW.
GPGRT_SYSHD_NONE NEW.
GPGRT_SYSHD_FD NEW.
GPGRT_SYSHD_SOCK NEW.
GPGRT_SYSHD_RVID NEW.
GPGRT_SYSHD_HANDLE NEW.
gpgrt_stdin NEW macro.
gpgrt_stdout NEW macro.
gpgrt_stderr NEW macro.
gpgrt_fopen NEW.
gpgrt_mopen NEW.
gpgrt_fopenmem NEW.
gpgrt_fopenmem_init NEW.
gpgrt_fdopen NEW.
gpgrt_fdopen_nc NEW.
gpgrt_sysopen NEW.
gpgrt_sysopen_nc NEW.
gpgrt_fpopen NEW.
gpgrt_fpopen_nc NEW.
gpgrt_freopen NEW.
gpgrt_fopencookie NEW.
gpgrt_fclose NEW.
gpgrt_fclose_snatch NEW.
gpgrt_onclose NEW.
gpgrt_fileno NEW.
gpgrt_fileno_unlocked NEW.
gpgrt_syshd NEW.
gpgrt_syshd_unlocked NEW.
gpgrt_flockfile NEW.
gpgrt_ftrylockfile NEW.
gpgrt_funlockfile NEW.
gpgrt_feof NEW.
gpgrt_feof_unlocked NEW.
gpgrt_ferror NEW.
gpgrt_ferror_unlocked NEW.
gpgrt_clearerr NEW.
gpgrt_clearerr_unlocked NEW.
gpgrt_fflush NEW.
gpgrt_fseek NEW.
gpgrt_fseeko NEW.
gpgrt_ftell NEW.
gpgrt_ftello NEW.
gpgrt_rewind NEW.
gpgrt_getc NEW macro.
gpgrt_getc_unlocked NEW macro.
gpgrt_fgetc NEW.
gpgrt_fputc NEW.
gpgrt_ungetc NEW.
gpgrt_read NEW.
gpgrt_write NEW.
gpgrt_write_sanitized NEW.
gpgrt_write_hexstring NEW.
gpgrt_fread NEW.
gpgrt_fwrite NEW.
gpgrt_fgets NEW.
gpgrt_putc NEW macro.
gpgrt_putc_unlocked NEW macro.
gpgrt_fputs NEW.
gpgrt_fputs_unlocked NEW.
gpgrt_getline NEW.
gpgrt_read_line NEW.
gpgrt_free NEW.
gpgrt_fprintf NEW.
gpgrt_fprintf_unlocked NEW.
gpgrt_printf NEW.
gpgrt_printf_unlocked NEW.
gpgrt_vfprintf NEW.
gpgrt_vfprintf_unlocked NEW.
gpgrt_setvbuf NEW.
gpgrt_setbuf NEW.
gpgrt_set_binary NEW.
gpgrt_tmpfile NEW.
gpgrt_opaque_set NEW.
gpgrt_opaque_get NEW.
gpgrt_fname_set NEW.
gpgrt_fname_get NEW.
gpgrt_asprintf NEW.
gpgrt_vasprintf NEW.
gpgrt_bsprintf NEW.
gpgrt_vbsprintf NEW.
gpgrt_snprintf NEW.
gpgrt_vsnprintf NEW.
Noteworthy changes in version 1.13 (2014-04-15) [C11/A11/R0]
-----------------------------------------------
* Added a portable mutex API.
* The AM_PATH_GPG_ERROR macro now defines GPG_ERROR_MT_CFLAGS and
GPG_ERROR_MT_LIBS autoconf output variables for use by programs
which need gpgrt based thread support. gpg-error-config has a new
option --mt.
* Interface changes relative to the 1.12 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_KEY_ON_CARD NEW.
GPG_ERR_MAC_ALGO NEW.
GPG_ERR_INV_LOCK_OBJ NEW.
gpgrt_lock_t NEW.
GPGRT_LOCK_INITIALIZER NEW.
GPGRT_LOCK_DEFINE NEW.
gpgrt_lock_init NEW.
gpgrt_lock_lock NEW.
gpgrt_lock_unlock NEW.
gpgrt_lock_destroy NEW.
gpgrt_yield NEW.
Noteworthy changes in version 1.12 (2013-06-24)
-----------------------------------------------
* Add support for 64 bit Windows (use ./autogen.sh --build-w64).
* Fixed parsing and installing of the Windows .def file.
* Interface changes relative to the 1.11 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NO_CRYPT_CTX NEW.
GPG_ERR_WRONG_CRYPT_CTX NEW.
GPG_ERR_BAD_CRYPT_CTX NEW.
GPG_ERR_CRYPT_CTX_CONFLICT NEW.
GPG_ERR_BROKEN_PUBKEY NEW.
GPG_ERR_BROKEN_SECKEY NEW.
Noteworthy changes in version 1.11 (2013-02-25)
-----------------------------------------------
* New error source GPG_ERR_SOURCE_ASSUAN for Libassuan related
errors.
* New macros GPG_ERROR_VERSION and GPG_ERROR_VERSION_NUMBER. New
function gpg_error_check_version.
* Interface changes relative to the 1.10 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NO_KEYSERVER NEW.
GPG_ERR_INV_CURVE NEW.
GPG_ERR_UNKNOWN_CURVE NEW.
GPG_ERR_DUP_KEY NEW.
GPG_ERR_AMBIGUOUS NEW.
GPG_ERR_SOURCE_ASSUAN NEW.
gpg_error_check_version NEW.
GPG_ERROR_VERSION NEW.
GPG_ERROR_VERSION_NUMBER NEW.
Noteworthy changes in version 1.10 (2010-10-26)
-----------------------------------------------
* Using a static library on W32 does now work.
* Interface changes relative to the 1.9 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NOT_INITIALIZED NEW.
GPG_ERR_MISSING_ISSUER_CERT NEW.
GPG_ERR_FULLY_CANCELED NEW.
Noteworthy changes in version 1.9 (2010-07-21)
----------------------------------------------
* New function gpg_err_deinit.
* Fix building of static lib under W32.
* Interface changes relative to the 1.8 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_MISSING_KEY NEW.
GPG_ERR_TOO_MANY NEW.
GPG_ERR_LIMIT_REACHED NEW.
gpg_err_deinit NEW.
Noteworthy changes in version 1.8 (2010-05-06)
----------------------------------------------
* Support for WindowsCE.
* New option --list for gpg-error.
* Interface changes relative to the 1.7 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NOT_ENABLED NEW.
GPG_ERR_SOURCE_G13 NEW.
GPG_ERR_NO_ENGINE NEW.
gpg_err_set_errno NEW.
Noteworthy changes in version 1.7 (2008-11-26)
----------------------------------------------
* Minor fixes and a few new error codes.
* Interface changes relative to the 1.6 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_NOT_OPERATIONAL NEW
GPG_ERR_NO_PASSPHRASE NEW
GPG_ERR_NO_PIN NEW
Noteworthy changes in version 1.6 (2007-10-29)
----------------------------------------------
* Fixed a build problem under Windows.
* Interface changes relative to the 1.4 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_UNFINISHED NEW
GPG_ERR_SOURCE_GPA NEW
GPG_ERR_SOURCE_KLEO NEW
Noteworthy changes in version 1.5 (2006-11-30)
----------------------------------------------
* Minor build system fixes.
* Updated gettext. Removed included gettext copy.
* gpg-error has a new option --version.
Noteworthy changes in version 1.4 (2006-09-14)
----------------------------------------------
* Support for Common Lisp is included.
* New error codes for the Assuan IPC library.
* New error code GPG_ERR_MISSING_ERRNO to be used in cases when a
system accidentally does not set errno but a system error
definitely occurred.
* New error source GPG_ERR_SOURCE_ANY to allow proper use of
libgpg-error even if a specific source is not available.
* New convenience functions gpg_err_code_from_syserror and
gpg_error_from_syserror which make sure never to return 0.
* Interface changes relative to the 1.2 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpg_err_code_from_syserror NEW
gpg_error_from_syserror NEW
GPG_ERR_SOURCE_ANY NEW
GPG_ERR_MISSING_ERRNO NEW
GPG_ERR_UNKNOWN_OPTION NEW
GPG_ERR_UNKNOWN_COMMAND NEW
GPG_ERR_ASS_GENERAL NEW
GPG_ERR_ASS_ACCEPT_FAILED NEW
GPG_ERR_ASS_CONNECT_FAILED NEW
GPG_ERR_ASS_INV_RESPONSE NEW
GPG_ERR_ASS_INV_VALUE NEW
GPG_ERR_ASS_INCOMPLETE_LINE NEW
GPG_ERR_ASS_LINE_TOO_LONG NEW
GPG_ERR_ASS_NESTED_COMMANDS NEW
GPG_ERR_ASS_NO_DATA_CB NEW
GPG_ERR_ASS_NO_INQUIRE_CB NEW
GPG_ERR_ASS_NOT_A_SERVER NEW
GPG_ERR_ASS_NOT_A_CLIENT NEW
GPG_ERR_ASS_SERVER_START NEW
GPG_ERR_ASS_READ_ERROR NEW
GPG_ERR_ASS_WRITE_ERROR NEW
GPG_ERR_ASS_TOO_MUCH_DATA NEW
GPG_ERR_ASS_UNEXPECTED_CMD NEW
GPG_ERR_ASS_UNKNOWN_CMD NEW
GPG_ERR_ASS_SYNTAX NEW
GPG_ERR_ASS_CANCELED NEW
GPG_ERR_ASS_NO_INPUT NEW
GPG_ERR_ASS_NO_OUTPUT NEW
GPG_ERR_ASS_PARAMETER NEW
GPG_ERR_ASS_UNKNOWN_INQUIRE NEW
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Noteworthy changes in version 1.3 (2006-03-14)
----------------------------------------------
* GNU gettext is included for systems that do not provide it.
Noteworthy changes in version 1.2 (2006-03-03)
----------------------------------------------
* New function gpg_err_init, which binds the locale directory to
the text domain. This function is a constructor on GCC targets,
so it does not need to be called explicitely. The header file
defines GPG_ERR_INITIALIZED in this case. This is experimental for
now.
* "./autogen.sh --build-w32" does now also build a DLL for W32.
Translations are not yet provided for this platform.
* New error codes GPG_ERR_UNKNOWN_EXTN and GPG_ERR_UNKNOWN_CRIT_EXTN.
* New error code GPG_ERR_LOCKED.
* New translations included for France, Romania, and Vietnamese.
* Interface changes relative to the 1.1 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_UNKNOWN_EXTN NEW
GPG_ERR_UNKNOWN_CRIT_EXTN NEW
GPG_ERR_LOCKED NEW
gpg_err_init NEW
GPG_ERR_INITIALIZED NEW
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Noteworthy changes in version 1.1 (2005-06-20)
----------------------------------------------
* Bug fixes.
Noteworthy changes in version 1.0 (2004-07-30)
----------------------------------------------
* Ported to Solaris 2.8.
* Added a new error source GPG_ERR_SOURCE_GSTI, and new error
codes GPG_ERR_PROTOCOL_VIOLATION and GPG_ERR_INV_MAC for this
source.
* Interface changes relative to the 0.7 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_SOURCE_GSTI NEW
GPG_ERR_PROTOCOL_VIOLATION NEW
GPG_ERR_INV_MAC NEW
GPG_ERR_INV_REQUEST NEW
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Noteworthy changes in version 0.7 (2004-03-07)
----------------------------------------------
* libgpg-error can be built on systems where the errno macros do not
evaluate to plain numbers, but expressions. If you want to
cross-compile, you might have to set CC_FOR_BUILD, though.
* A new tool gpg-error to convert error numbers into symbols into
strings is provided.
* Interface changes relative to the 0.6 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_LOCALE_PROBLEM NEW
GPG_ERR_NOT_LOCKED NEW
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Noteworthy changes in version 0.6 (2003-11-14)
----------------------------------------------
* German translation included.
* It is now possible to use the inline functions even for non C99
compliant compilers by given e.g. -DGPG_ERR_INLINE=inline when
compiling an application using this library. Note, that gcc will
use inline anyway.
* Interface changes relative to the 0.5 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GPG_ERR_SOURCE_KSBA NEW
GPG_ERR_SOURCE_DIRMNGR NEW
GPG_ERR_TRUNCATED NEW
GPG_ERR_NO_ENCODING_METHOD NEW
GPG_ERR_NO_ENCRYPTION_SCHEME NEW
GPG_ERR_NO_SIGNATURE_SCHEME NEW
GPG_ERR_INV_ATTR NEW
GPG_ERR_NO_VALUE NEW
GPG_ERR_NOT_FOUND NEW
GPG_ERR_VALUE_NOT_FOUND NEW
GPG_ERR_SYNTAX NEW
GPG_ERR_INV_CRL NEW
GPG_ERR_BAD_BER NEW
GPG_ERR_INV_BER NEW
GPG_ERR_ELEMENT_NOT_FOUND NEW
GPG_ERR_IDENTIFIER_NOT_FOUND NEW
GPG_ERR_INV_TAG NEW
GPG_ERR_INV_LENGTH NEW
GPG_ERR_INV_KEYINFO NEW
GPG_ERR_UNEXPECTED_TAG NEW
GPG_ERR_NOT_DER_ENCODED, NEW
GPG_ERR_NO_CMS_OBJ NEW
GPG_ERR_INV_CMS_OBJ NEW
GPG_ERR_UNKNOWN_CMS_OBJ, NEW
GPG_ERR_UNSUPPORTED_CMS_OBJ NEW
GPG_ERR_UNSUPPORTED_ENCODING, NEW
GPG_ERR_UNSUPPORTED_CMS_VERSION NEW
GPG_ERR_UNKNOWN_ALGORITHM NEW
GPG_ERR_ENCODING_PROBLEM NEW
GPG_ERR_INV_STATE NEW
GPG_ERR_DUP_VALUE, NEW
GPG_ERR_MISSING_ACTION NEW
GPG_ERR_MODULE_NOT_FOUND NEW
GPG_ERR_INV_OID_STRING NEW
GPG_ERR_INV_TIME NEW
GPG_ERR_INV_CRL_OBJ NEW
GPG_ERR_UNSUPPORTED_CRL_VERSION NEW
GPG_ERR_INV_CERT_OBJ NEW
GPG_ERR_UNKNOWN_NAME NEW
GPG_ERR_BUFFER_TOO_SHORT. NEW
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Noteworthy changes in version 0.5 (2003-10-06)
----------------------------------------------
* New thread safe interface gpg_strerror_r.
* New error code GPG_ERR_PIN_NOT_SYNCED has been added.
* Interface changes relative to the 0.4 release:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gpg_strerror_r NEW
GPG_ERR_PIN_NOT_SYNCED NEW
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Noteworthy changes in version 0.4 (2003-09-03)
----------------------------------------------
* Fixed another bug that prevented that system errors were created
correctly in the first place.
* Use inline in public header file only on C99 compilers.
Noteworthy changes in version 0.3 (2003-07-31)
----------------------------------------------
* Fixed bug that prevented that system errors were mapped to error
strings correctly.
Noteworthy changes in version 0.2 (2003-07-30)
----------------------------------------------
* Value of the error code GPG_ERR_CANCELED was fixed.
* New error codes GPG_ERR_WRONG_CARD, GPG_ERR_HARDWARE,
GPG_ERR_PIN_BLOCKED and GPG_ERR_USE_CONDITIONS have been added.
* The header file has been made C++ clean.
* AM_PATH_GPG_ERR has been fixed to work without explicit version
number.
* The header file now uses inline instead __inline__ for non-GNU
compilers.
Noteworthy changes in version 0.1 (2003-06-06)
----------------------------------------------
* Initial release.
Copyright 2003, 2004, 2005, 2010 g10 Code GmbH
This file is free software; as a special exception the author gives
unlimited permission to copy and/or distribute it, with or without
modifications, as long as this notice is preserved.
This file is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/src/argparse.c b/src/argparse.c
index 04c8291..d54ca66 100644
--- a/src/argparse.c
+++ b/src/argparse.c
@@ -1,2090 +1,2145 @@
/* argparse.c - Argument Parser for option handling
* Copyright (C) 1997-2001, 2006-2008, 2013-2017 Werner Koch
* Copyright (C) 1998-2001, 2006-2008, 2012 Free Software Foundation, Inc.
* Copyright (C) 2015-2020 g10 Code GmbH
*
* This file is part of Libgpg-error.
*
* This file 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.
*
* This file is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, see .
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* This file was originally a part of GnuPG.
*/
#ifdef HAVE_CONFIG_H
#include
#endif
#include
#include
#include
#include
#include
#include
#include
+#include
#include "gpgrt-int.h"
#ifdef HAVE_W32_SYSTEM
# define PATHSEP_C ';'
# define DIRSEP_C '\\'
#else
# define PATHSEP_C ':'
# define DIRSEP_C '/'
#endif
/* The malloced configuration directories or NULL. */
static struct
{
char *user;
char *sys;
} confdir;
/* Hidden argparse flag used to mark the object as initialized. */
#define ARGPARSE_FLAG__INITIALIZED (1<< ((8*SIZEOF_INT)-1))
/* Special short options which are auto-inserterd. */
#define ARGPARSE_SHORTOPT_HELP 32768
#define ARGPARSE_SHORTOPT_VERSION 32769
#define ARGPARSE_SHORTOPT_WARRANTY 32770
#define ARGPARSE_SHORTOPT_DUMP_OPTIONS 32771
/* A mask for the types. */
#define ARGPARSE_TYPE_MASK 7 /* Mask for the type values. */
/* The states for the gpgrt_argparser machinery. */
enum argparser_states
{
STATE_init = 0,
STATE_open_sys,
STATE_open_user,
STATE_open_cmdline,
STATE_read_sys,
STATE_read_user,
STATE_read_cmdline,
STATE_finished
};
/* Internal object of the public gpgrt_argparse_t object. */
struct _gpgrt_argparse_internal_s
{
int idx; /* Note that this is saved and restored in _gpgrt_argparser. */
int inarg;
int stopped;
int explicit_confopt; /* A conffile option has been given. */
char *explicit_conffile; /* Malloced name of an explicit conffile. */
unsigned int opt_flags; /* Current option flags. */
enum argparser_states state; /* of gpgrt_argparser. */
const char *last;
void *aliases;
const void *cur_alias;
void *iio_list;
estream_t conffp;
char *confname;
gpgrt_opt_t **opts; /* Malloced array of pointer to user provided opts. */
};
typedef struct alias_def_s *ALIAS_DEF;
struct alias_def_s {
ALIAS_DEF next;
char *name; /* malloced buffer with name, \0, value */
const char *value; /* ptr into name */
};
/* Object to store the names for the --ignore-invalid-option option.
This is a simple linked list. */
typedef struct iio_item_def_s *IIO_ITEM_DEF;
struct iio_item_def_s
{
IIO_ITEM_DEF next;
char name[1]; /* String with the long option name. */
};
/* The almost always needed user handler for strusage. */
static const char *(*strusage_handler)( int ) = NULL;
/* Optional handler to write strings. See _gpgrt_set_usage_outfnc. */
static int (*custom_outfnc) (int, const char *);
/* Optional handler to map strings. See _gpgrt_set_fixed_string_mapper. */
static const char *(*fixed_string_mapper)(const char*);
static int set_opt_arg (gpgrt_argparse_t *arg, unsigned int flags, char *s);
static void show_help (gpgrt_opt_t **opts, unsigned int flags);
static void show_version (void);
static int writestrings (int is_error, const char *string,
...) GPGRT_ATTR_SENTINEL(0);
static int arg_parse (gpgrt_argparse_t *arg, gpgrt_opt_t *opts, int no_init);
/* Return true if the native charset is utf-8. */
static int
is_native_utf8 (void)
{
static char result;
if (!result)
{
const char *p = _gpgrt_strusage (8);
if (!p || !*p || !strcmp (p, "utf-8"))
result = 1;
result |= 128;
}
return (result & 1);
}
static char *
trim_spaces (char *str)
{
char *string, *p, *mark;
string = str;
/* Find first non space character. */
for (p=string; *p && isspace (*(unsigned char*)p) ; p++)
;
/* Move characters. */
for ((mark = NULL); (*string = *p); string++, p++)
if (isspace (*(unsigned char*)p))
{
if (!mark)
mark = string;
}
else
mark = NULL;
if (mark)
*mark = '\0' ; /* Remove trailing spaces. */
return str ;
}
static const char *
map_fixed_string (const char *string)
{
return fixed_string_mapper? fixed_string_mapper (string) : string;
}
/* Write STRING and all following const char * arguments either to
stdout or, if IS_ERROR is set, to stderr. The list of strings must
be terminated by a NULL. */
static int
writestrings (int is_error, const char *string, ...)
{
va_list arg_ptr;
const char *s;
int count = 0;
if (string)
{
s = string;
va_start (arg_ptr, string);
do
{
if (custom_outfnc)
custom_outfnc (is_error? 2:1, s);
else
fputs (s, is_error? stderr : stdout);
count += strlen (s);
}
while ((s = va_arg (arg_ptr, const char *)));
va_end (arg_ptr);
}
return count;
}
static void
flushstrings (int is_error)
{
if (custom_outfnc)
custom_outfnc (is_error? 2:1, NULL);
else
_gpgrt_fflush (is_error? es_stderr : es_stdout);
}
static void
deinitialize (gpgrt_argparse_t *arg)
{
if (arg->internal)
{
xfree (arg->internal->explicit_conffile);
xfree (arg->internal->opts);
xfree (arg->internal);
arg->internal = NULL;
}
arg->flags &= ARGPARSE_FLAG__INITIALIZED;
arg->lineno = 0;
arg->err = 0;
}
/* Our own exit handler to clean up used memory. */
static void
my_exit (gpgrt_argparse_t *arg, int code)
{
deinitialize (arg);
exit (code);
}
static gpg_err_code_t
initialize (gpgrt_argparse_t *arg, gpgrt_opt_t *opts, estream_t fp)
{
/* We use a dedicated flag to detect whether *ARG has been
* initialized. This is because the old version of that struct, as
* used in GnuPG, had no requirement to zero out all fields of the
* object and existing code still sets only argc,argv and flags. */
if (!(arg->flags & ARGPARSE_FLAG__INITIALIZED)
|| (arg->flags & ARGPARSE_FLAG_RESET)
|| !arg->internal)
{
/* Allocate internal data. */
if (!(arg->flags & ARGPARSE_FLAG__INITIALIZED) || !arg->internal)
{
arg->internal = xtrymalloc (sizeof *arg->internal);
if (!arg->internal)
return _gpg_err_code_from_syserror ();
arg->flags |= ARGPARSE_FLAG__INITIALIZED; /* Mark as initialized. */
}
else if (arg->internal->opts)
xfree (arg->internal->opts);
arg->internal->opts = NULL;
/* Initialize this instance. */
arg->internal->idx = 0;
arg->internal->last = NULL;
arg->internal->inarg = 0;
arg->internal->stopped = 0;
arg->internal->explicit_confopt = 0;
arg->internal->explicit_conffile = NULL;
arg->internal->opt_flags = 0;
arg->internal->state = STATE_init;
arg->internal->aliases = NULL;
arg->internal->cur_alias = NULL;
arg->internal->iio_list = NULL;
arg->internal->conffp = NULL;
arg->internal->confname = NULL;
/* Clear the copy of the option list. */
/* Clear the error indicator. */
arg->err = 0;
/* Usually an option file will be parsed from the start.
* However, we do not open the stream and thus we have no way to
* know the current lineno. Using this flag we can allow the
* user to provide a lineno which we don't reset. */
if (fp || arg->internal->conffp || !(arg->flags & ARGPARSE_FLAG_NOLINENO))
arg->lineno = 0;
/* Need to clear the reset request. */
arg->flags &= ~ARGPARSE_FLAG_RESET;
/* Check initial args. */
if ( *arg->argc < 0 )
_gpgrt_log_bug ("invalid argument passed to gpgrt_argparse\n");
}
/* Create an array with pointers to the provided list of options.
* Keeping a copy is useful to sort that array and thus do a binary
* search and to allow for extra space at the end to insert the
* hidden options. An ARGPARSE_FLAG_RESET can be used to reinit
* this array. */
if (!arg->internal->opts)
{
static gpgrt_opt_t help_opt
= ARGPARSE_s_n (ARGPARSE_SHORTOPT_HELP, "help", "@");
static gpgrt_opt_t version_opt
= ARGPARSE_s_n (ARGPARSE_SHORTOPT_VERSION, "version", "@");
static gpgrt_opt_t warranty_opt
= ARGPARSE_s_n (ARGPARSE_SHORTOPT_WARRANTY, "warranty", "@");
static gpgrt_opt_t dump_options_opt
= ARGPARSE_s_n(ARGPARSE_SHORTOPT_DUMP_OPTIONS, "dump-options", "@");
static gpgrt_opt_t end_marker
= ARGPARSE_end ();
int seen_help = 0;
int seen_version = 0;
int seen_warranty = 0;
int seen_dump_options = 0;
int i;
for (i=0; opts[i].short_opt; i++)
{
if (opts[i].long_opt)
{
if (!strcmp(opts[i].long_opt, help_opt.long_opt))
seen_help = 1;
else if (!strcmp(opts[i].long_opt, version_opt.long_opt))
seen_version = 1;
else if (!strcmp(opts[i].long_opt, warranty_opt.long_opt))
seen_warranty = 1;
else if (!strcmp(opts[i].long_opt, dump_options_opt.long_opt))
seen_dump_options = 1;
}
}
i += 4; /* The number of the above internal options. */
i++; /* End of list marker. */
arg->internal->opts = xtrycalloc (i, sizeof *arg->internal->opts);
if (!arg->internal->opts)
return _gpg_err_code_from_syserror ();
for(i=0; opts[i].short_opt; i++)
arg->internal->opts[i] = opts + i;
if (!seen_help)
arg->internal->opts[i++] = &help_opt;
if (!seen_version)
arg->internal->opts[i++] = &version_opt;
if (!seen_warranty)
arg->internal->opts[i++] = &warranty_opt;
if (!seen_dump_options)
arg->internal->opts[i++] = &dump_options_opt;
arg->internal->opts[i] = &end_marker;
}
if (arg->err)
{
/* Last option was erroneous. */
const char *s;
if (!fp && arg->internal->conffp)
fp = arg->internal->conffp;
if (fp)
{
if ( arg->r_opt == ARGPARSE_UNEXPECTED_ARG )
s = _("argument not expected");
else if ( arg->r_opt == ARGPARSE_READ_ERROR )
s = _("read error");
else if ( arg->r_opt == ARGPARSE_KEYWORD_TOO_LONG )
s = _("keyword too long");
else if ( arg->r_opt == ARGPARSE_MISSING_ARG )
s = _("missing argument");
else if ( arg->r_opt == ARGPARSE_INVALID_ARG )
s = _("invalid argument");
else if ( arg->r_opt == ARGPARSE_INVALID_COMMAND )
s = _("invalid command");
else if ( arg->r_opt == ARGPARSE_INVALID_ALIAS )
s = _("invalid alias definition");
else if ( arg->r_opt == ARGPARSE_PERMISSION_ERROR )
s = _("permission error");
else if ( arg->r_opt == ARGPARSE_OUT_OF_CORE )
s = _("out of core");
else if ( arg->r_opt == ARGPARSE_NO_CONFFILE )
s = NULL; /* Error has already been printed. */
else
s = _("invalid option");
if (s)
_gpgrt_log_error ("%s:%u: %s\n",
_gpgrt_fname_get (fp), arg->lineno, s);
}
else
{
s = arg->internal->last? arg->internal->last:"[??]";
if ( arg->r_opt == ARGPARSE_MISSING_ARG )
_gpgrt_log_error (_("missing argument for option \"%.50s\"\n"), s);
else if ( arg->r_opt == ARGPARSE_INVALID_ARG )
_gpgrt_log_error (_("invalid argument for option \"%.50s\"\n"), s);
else if ( arg->r_opt == ARGPARSE_UNEXPECTED_ARG )
_gpgrt_log_error (_("option \"%.50s\" does not expect "
"an argument\n"), s);
else if ( arg->r_opt == ARGPARSE_INVALID_COMMAND )
_gpgrt_log_error (_("invalid command \"%.50s\"\n"), s);
else if ( arg->r_opt == ARGPARSE_AMBIGUOUS_OPTION )
_gpgrt_log_error (_("option \"%.50s\" is ambiguous\n"), s);
else if ( arg->r_opt == ARGPARSE_AMBIGUOUS_COMMAND )
_gpgrt_log_error (_("command \"%.50s\" is ambiguous\n"),s );
else if ( arg->r_opt == ARGPARSE_OUT_OF_CORE )
_gpgrt_log_error ("%s\n", _("out of core"));
else if ( arg->r_opt == ARGPARSE_PERMISSION_ERROR )
_gpgrt_log_error ("%s\n", _("permission error"));
else if ( arg->r_opt == ARGPARSE_NO_CONFFILE)
; /* Error has already been printed. */
else
_gpgrt_log_error (_("invalid option \"%.50s\"\n"), s);
}
if (arg->err != ARGPARSE_PRINT_WARNING)
my_exit (arg, 2);
arg->err = 0;
}
/* Zero out the return value union. */
arg->r.ret_str = NULL;
arg->r.ret_long = 0;
return 0;
}
static void
store_alias( gpgrt_argparse_t *arg, char *name, char *value )
{
/* TODO: replace this dummy function with a rea one
* and fix the probelms IRIX has with (ALIAS_DEV)arg..
* used as lvalue
*/
(void)arg;
(void)name;
(void)value;
#if 0
ALIAS_DEF a = xmalloc( sizeof *a );
a->name = name;
a->value = value;
a->next = (ALIAS_DEF)arg->internal->aliases;
(ALIAS_DEF)arg->internal->aliases = a;
#endif
}
/* Return true if KEYWORD is in the ignore-invalid-option list. */
static int
ignore_invalid_option_p (gpgrt_argparse_t *arg, const char *keyword)
{
IIO_ITEM_DEF item = arg->internal->iio_list;
for (; item; item = item->next)
if (!strcmp (item->name, keyword))
return 1;
return 0;
}
/* Add the keywords up to the next LF to the list of to be ignored
options. After returning FP will either be at EOF or the next
character read wll be the first of a new line. The function
returns 0 on success or true on malloc failure. */
static int
ignore_invalid_option_add (gpgrt_argparse_t *arg, estream_t fp)
{
IIO_ITEM_DEF item;
int c;
char name[100];
int namelen = 0;
int ready = 0;
enum { skipWS, collectNAME, skipNAME, addNAME} state = skipWS;
while (!ready)
{
c = _gpgrt_fgetc (fp);
if (c == '\n')
ready = 1;
else if (c == EOF)
{
c = '\n';
ready = 1;
}
again:
switch (state)
{
case skipWS:
if (!isascii (c) || !isspace(c))
{
namelen = 0;
state = collectNAME;
goto again;
}
break;
case collectNAME:
if (isspace (c))
{
state = addNAME;
goto again;
}
else if (namelen < DIM(name)-1)
name[namelen++] = c;
else /* Too long. */
state = skipNAME;
break;
case skipNAME:
if (isspace (c))
{
state = skipWS;
goto again;
}
break;
case addNAME:
name[namelen] = 0;
if (!ignore_invalid_option_p (arg, name))
{
item = xtrymalloc (sizeof *item + namelen);
if (!item)
return 1;
strcpy (item->name, name);
item->next = (IIO_ITEM_DEF)arg->internal->iio_list;
arg->internal->iio_list = item;
}
state = skipWS;
goto again;
}
}
return 0;
}
/* Clear the entire ignore-invalid-option list. */
static void
ignore_invalid_option_clear (gpgrt_argparse_t *arg)
{
IIO_ITEM_DEF item, tmpitem;
for (item = arg->internal->iio_list; item; item = tmpitem)
{
tmpitem = item->next;
xfree (item);
}
arg->internal->iio_list = NULL;
}
/****************
* Get options from a file.
* Lines starting with '#' are comment lines.
* Syntax is simply a keyword and the argument.
* Valid keywords are all keywords from the long_opt list without
* the leading dashes. The special keywords "help", "warranty" and "version"
* are not valid here.
* The special keyword "alias" may be used to store alias definitions,
* which are later expanded like long options.
* The option
* ignore-invalid-option OPTIONNAMEs
* is recognized and updates a list of option which should be ignored if they
* are not defined.
* Caller must free returned strings.
* If called with FP set to NULL command line args are parse instead.
*
* Q: Should we allow the syntax
* keyword = value
* and accept for boolean options a value of 1/0, yes/no or true/false?
* Note: Abbreviation of options is here not allowed.
*/
int
_gpgrt_argparse (estream_t fp, gpgrt_argparse_t *arg, gpgrt_opt_t *opts_orig)
{
gpgrt_opt_t **opts;
int state, i, c;
int idx = 0;
char keyword[100];
char *buffer = NULL;
size_t buflen = 0;
int in_alias=0;
int unread_buf[3]; /* We use an int so that we can store EOF. */
int unread_buf_count = 0;
if (arg && !opts_orig)
{
deinitialize (arg);
return 0;
}
if (!fp) /* Divert to arg_parse() in this case. */
return arg_parse (arg, opts_orig, 0);
if (initialize (arg, opts_orig, fp))
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
opts = arg->internal->opts;
/* If the LINENO is zero we assume that we are at the start of a
* file and we skip over a possible Byte Order Mark. */
if (!arg->lineno)
{
unread_buf[0] = _gpgrt_fgetc (fp);
unread_buf[1] = _gpgrt_fgetc (fp);
unread_buf[2] = _gpgrt_fgetc (fp);
if (unread_buf[0] != 0xef
|| unread_buf[1] != 0xbb
|| unread_buf[2] != 0xbf)
unread_buf_count = 3;
}
arg->internal->opt_flags = 0;
/* Find the next keyword. */
state = i = 0;
for (;;)
{
if (unread_buf_count)
c = unread_buf[3 - unread_buf_count--];
else
c = _gpgrt_fgetc (fp);
if (c == '\n' || c== EOF )
{
if ( c != EOF )
arg->lineno++;
if (state == -1)
break;
else if (state == 2)
{
keyword[i] = 0;
for (i=0; opts[i]->short_opt; i++ )
{
if (opts[i]->long_opt && !strcmp (opts[i]->long_opt, keyword))
break;
}
idx = i;
arg->r_opt = opts[idx]->short_opt;
if ((opts[idx]->flags & ARGPARSE_OPT_IGNORE))
{
state = i = 0;
continue;
}
else if (!opts[idx]->short_opt )
{
if (!strcmp (keyword, "ignore-invalid-option"))
{
/* No argument - ignore this meta option. */
state = i = 0;
continue;
}
else if (ignore_invalid_option_p (arg, keyword))
{
/* This invalid option is in the iio list. */
state = i = 0;
continue;
}
arg->r_opt = ((opts[idx]->flags & ARGPARSE_OPT_COMMAND)
? ARGPARSE_INVALID_COMMAND
: ARGPARSE_INVALID_OPTION);
}
else if (!(opts[idx]->flags & ARGPARSE_TYPE_MASK))
arg->r_type = 0; /* Does not take an arg. */
else if ((opts[idx]->flags & ARGPARSE_OPT_OPTIONAL) )
arg->r_type = 0; /* Arg is optional. */
else
arg->r_opt = ARGPARSE_MISSING_ARG;
break;
}
else if (state == 3)
{
/* No argument found. */
if (in_alias)
arg->r_opt = ARGPARSE_MISSING_ARG;
else if (!(opts[idx]->flags & ARGPARSE_TYPE_MASK))
arg->r_type = 0; /* Does not take an arg. */
else if ((opts[idx]->flags & ARGPARSE_OPT_OPTIONAL))
arg->r_type = 0; /* No optional argument. */
else
arg->r_opt = ARGPARSE_MISSING_ARG;
break;
}
else if (state == 4)
{
/* Has an argument. */
if (in_alias)
{
if (!buffer)
arg->r_opt = ARGPARSE_UNEXPECTED_ARG;
else
{
char *p;
buffer[i] = 0;
p = strpbrk (buffer, " \t");
if (p)
{
*p++ = 0;
trim_spaces (p);
}
if (!p || !*p)
{
xfree (buffer);
arg->r_opt = ARGPARSE_INVALID_ALIAS;
}
else
{
store_alias (arg, buffer, p);
}
}
}
else if (!(opts[idx]->flags & ARGPARSE_TYPE_MASK))
arg->r_opt = ARGPARSE_UNEXPECTED_ARG;
else
{
char *p;
if (!buffer)
{
keyword[i] = 0;
buffer = xtrystrdup (keyword);
if (!buffer)
arg->r_opt = ARGPARSE_OUT_OF_CORE;
}
else
buffer[i] = 0;
if (buffer)
{
trim_spaces (buffer);
p = buffer;
if (*p == '"')
{
/* Remove quotes. */
p++;
if (*p && p[strlen(p)-1] == '\"' )
p[strlen(p)-1] = 0;
}
if (!set_opt_arg (arg, opts[idx]->flags, p))
xfree (buffer);
else
gpgrt_annotate_leaked_object (buffer);
}
}
break;
}
else if (c == EOF)
{
ignore_invalid_option_clear (arg);
if (_gpgrt_ferror (fp))
arg->r_opt = ARGPARSE_READ_ERROR;
else
arg->r_opt = 0; /* EOF. */
break;
}
state = 0;
i = 0;
}
else if (state == -1)
; /* Skip. */
else if (state == 0 && isascii (c) && isspace(c))
; /* Skip leading white space. */
else if (state == 0 && c == '#' )
state = 1; /* Start of a comment. */
else if (state == 1)
; /* Skip comments. */
else if (state == 2 && isascii (c) && isspace(c))
{
/* Check keyword. */
keyword[i] = 0;
for (i=0; opts[i]->short_opt; i++ )
if (opts[i]->long_opt && !strcmp (opts[i]->long_opt, keyword))
break;
idx = i;
arg->r_opt = opts[idx]->short_opt;
if ((opts[idx]->flags & ARGPARSE_OPT_IGNORE))
{
state = 1; /* Process like a comment. */
}
else if (!opts[idx]->short_opt)
{
if (!strcmp (keyword, "alias"))
{
in_alias = 1;
state = 3;
}
else if (!strcmp (keyword, "ignore-invalid-option"))
{
if (ignore_invalid_option_add (arg, fp))
{
arg->r_opt = ARGPARSE_OUT_OF_CORE;
break;
}
state = i = 0;
arg->lineno++;
}
else if (ignore_invalid_option_p (arg, keyword))
state = 1; /* Process like a comment. */
else
{
arg->r_opt = ((opts[idx]->flags & ARGPARSE_OPT_COMMAND)
? ARGPARSE_INVALID_COMMAND
: ARGPARSE_INVALID_OPTION);
state = -1; /* Skip rest of line and leave. */
}
}
else
state = 3;
}
else if (state == 3)
{
/* Skip leading spaces of the argument. */
if (!isascii (c) || !isspace(c))
{
i = 0;
keyword[i++] = c;
state = 4;
}
}
else if (state == 4)
{
/* Collect the argument. */
if (buffer)
{
if (i < buflen-1)
buffer[i++] = c;
else
{
char *tmp;
size_t tmplen = buflen + 50;
tmp = xtryrealloc (buffer, tmplen);
if (tmp)
{
buflen = tmplen;
buffer = tmp;
buffer[i++] = c;
}
else
{
xfree (buffer);
arg->r_opt = ARGPARSE_OUT_OF_CORE;
break;
}
}
}
else if (i < DIM(keyword)-1)
keyword[i++] = c;
else
{
size_t tmplen = DIM(keyword) + 50;
buffer = xtrymalloc (tmplen);
if (buffer)
{
buflen = tmplen;
memcpy(buffer, keyword, i);
buffer[i++] = c;
}
else
{
arg->r_opt = ARGPARSE_OUT_OF_CORE;
break;
}
}
}
else if (i >= DIM(keyword)-1)
{
arg->r_opt = ARGPARSE_KEYWORD_TOO_LONG;
state = -1; /* Skip rest of line and leave. */
}
else
{
keyword[i++] = c;
state = 2;
}
}
return arg->r_opt;
}
/* Return true if the list of options OPTS has any option marked with
* ARGPARSE_OPT_CONFFILE. */
static int
any_opt_conffile (gpgrt_opt_t *opts)
{
int i;
for (i=0; opts[i].short_opt; i++ )
if ((opts[i].flags & ARGPARSE_OPT_CONFFILE))
return 1;
return 0;
}
/* Return true if FNAME is an absoluete filename. */
static int
is_absfname (const char *fname)
{
const char *s;
#ifdef HAVE_W32_SYSTEM
s = strchr (fname, ':');
if (s)
s++;
else
s = fname;
#else
s = fname;
#endif
return (*s == '/'
#ifdef HAVE_W32_SYSTEM
|| *s == DIRSEP_C
#endif
);
}
/* If FNAME specifies two files of the form
* NAME1:/NAME2 (Unix)
* or
* NAME1;[x:]/NAME2 (Windows)
* return a pointer to the delimiter or NULL if there is none.
*/
static const char *
is_twopartfname (const char *fname)
{
const char *s;
if ((s = strchr (fname, PATHSEP_C)) && is_absfname (s+1) && s != fname)
return s;
return NULL;
}
+
+/* Try to use a version-ed config file name. A version-ed config file
+ * name is one which has the packages version number appended. For
+ * example if the standard config file name is "foo.conf" and the
+ * version of the foo program is 1.2.3-beta1 the following config
+ * files are tried in order until one is readable:
+ *
+ * foo.conf-1.2.3-beta1
+ * foo.conf-1.2.3
+ * foo.conf-1.2
+ * foo.conf-1
+ * foo.conf
+ *
+ * The argument CONFIGNAME should already be expanded. On success a
+ * newly allocated file name is returned. On error NULL is returned.
+ */
+static char *
+try_versioned_conffile (const char *configname)
+{
+ const char *version = _gpgrt_strusage (13);
+ char *name;
+ char *dash, *endp;
+
+ if (!version || !*version)
+ return NULL; /* No program version known. */
+
+ name = _gpgrt_strconcat (configname, "-", version, NULL);
+ if (!name)
+ return NULL; /* Oops: Out of core - ignore. */
+ dash = name + strlen (configname);
+
+ endp = dash + strlen (dash) - 1;
+ while (endp > dash)
+ {
+ if (!access (name, R_OK))
+ {
+ return name;
+ }
+ for (; endp > dash; endp--)
+ {
+ if (*endp == '-' || *endp == '.')
+ {
+ *endp = 0;
+ break;
+ }
+ }
+ }
+
+ _gpgrt_free (name);
+ return NULL;
+}
+
+
/* The full arg parser which handles option files and command line
* arguments. The behaviour depends on the combinations of CONFNAME
* and the ARGPARSE_FLAG_xxx values:
*
* | CONFNAME | SYS | USER | Action |
* |----------+-----+------+--------------------|
* | NULL | - | - | cmdline |
* | string | 0 | 1 | user, cmdline |
* | string | 1 | 0 | sys, cmdline |
* | string | 1 | 1 | sys, user, cmdline |
*
* Note that if an option has been flagged with ARGPARSE_OPT_CONFFILE
* and a type of ARGPARSE_TYPE_STRING that option is not returned but
* the specified configuration file is processed directly; if
* ARGPARSE_TYPE_NONE is used no user configuration files are
* processed and from the system configuration files only those which
* are immutable are processed. The string values for CONFNAME shall
* not include a directory part because that is taken from the values
* set by gpgrt_set_confdir. However, if CONFNAME is a twopart
* filename delimited by a colon (semicolon on Windows) with the
* second part being an absolute filename, the first part is used for
* the SYS file and the the entire second part for the USER file.
*/
int
_gpgrt_argparser (gpgrt_argparse_t *arg, gpgrt_opt_t *opts,
const char *confname)
{
/* First check whether releasing the resources has been requested. */
if (arg && !opts)
{
deinitialize (arg);
return 0;
}
/* Make sure that the internal data object is ready and also print
* warnings or errors from the last iteration. */
if (initialize (arg, opts, NULL))
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
next_state:
switch (arg->internal->state)
{
case STATE_init:
if (arg->argc && arg->argv && *arg->argc
&& any_opt_conffile (opts))
{
/* The list of option allow for conf files
* (e.g. gpg's "--option FILE" and "--no-options")
* Now check whether one was really given on the command
* line. Note that we don't need to run this code if no
* argument array was provided. */
int save_argc = *arg->argc;
char **save_argv = *arg->argv;
unsigned int save_flags = arg->flags;
int save_idx = arg->internal->idx;
int any_no_conffile = 0;
arg->flags = (ARGPARSE_FLAG_KEEP | ARGPARSE_FLAG_NOVERSION
| ARGPARSE_FLAG__INITIALIZED);
while (arg_parse (arg, opts, 1))
{
if ((arg->internal->opt_flags & ARGPARSE_OPT_CONFFILE))
{
arg->internal->explicit_confopt = 1;
if (arg->r_type == ARGPARSE_TYPE_STRING
&& !arg->internal->explicit_conffile)
{
/* Store the first conffile name. All further
* conf file options are not handled. */
arg->internal->explicit_conffile
= xtrystrdup (arg->r.ret_str);
if (!arg->internal->explicit_conffile)
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
}
else if (arg->r_type == ARGPARSE_TYPE_NONE)
any_no_conffile = 1;
}
}
if (any_no_conffile)
{
/* A NoConffile option overrides any other conf file option. */
xfree (arg->internal->explicit_conffile);
arg->internal->explicit_conffile = NULL;
}
/* Restore parser. */
*arg->argc = save_argc;
*arg->argv = save_argv;
arg->flags = save_flags;
arg->internal->idx = save_idx;
}
if (confname && *confname)
{
if ((arg->flags & ARGPARSE_FLAG_SYS))
arg->internal->state = STATE_open_sys;
else if ((arg->flags & ARGPARSE_FLAG_USER))
arg->internal->state = STATE_open_user;
else
return (arg->r_opt = ARGPARSE_INVALID_ARG);
}
else
arg->internal->state = STATE_open_cmdline;
goto next_state;
case STATE_open_sys:
{
/* If it is a two part name take the first part. */
const char *s;
char *tmpname = NULL;
if ((s = is_twopartfname (confname)))
{
tmpname = xtrymalloc (s - confname + 1);
if (!tmpname)
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
memcpy (tmpname, confname, s-confname);
tmpname[s-confname] = 0;
s = tmpname;
}
else
s = confname;
xfree (arg->internal->confname);
arg->internal->confname = _gpgrt_fnameconcat
(confdir.sys? confdir.sys : "/etc", s, NULL);
_gpgrt_free (tmpname);
if (!arg->internal->confname)
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
}
arg->lineno = 0;
arg->internal->idx = 0;
arg->internal->stopped = 0;
arg->internal->inarg = 0;
_gpgrt_fclose (arg->internal->conffp);
arg->internal->conffp = _gpgrt_fopen (arg->internal->confname, "r");
- /* FIXME: Add a callback. */
- /* if (arg->internal->conffp && is_secured_file (fileno (configfp)))*/
- /* { */
- /* es_fclose (arg->internal->conffp); */
- /* arg->internal->conffp = NULL; */
- /* gpg_err_set_errno (EPERM); */
- /* } */
if (!arg->internal->conffp)
{
if ((arg->flags & ARGPARSE_FLAG_VERBOSE))
_gpgrt_log_info (_("Note: no default option file '%s'\n"),
arg->internal->confname);
if ((arg->flags & ARGPARSE_FLAG_USER))
arg->internal->state = STATE_open_user;
else
arg->internal->state = STATE_open_cmdline;
goto next_state;
}
if ((arg->flags & ARGPARSE_FLAG_VERBOSE))
_gpgrt_log_info (_("reading options from '%s'\n"),
arg->internal->confname);
arg->internal->state = STATE_read_sys;
arg->r.ret_str = xtrystrdup (arg->internal->confname);
if (!arg->r.ret_str)
arg->r_opt = ARGPARSE_OUT_OF_CORE;
else
{
gpgrt_annotate_leaked_object (arg->r.ret_str);
arg->r_opt = ARGPARSE_CONFFILE;
arg->r_type = ARGPARSE_TYPE_STRING;
}
break;
case STATE_open_user:
if (arg->internal->explicit_confopt
&& arg->internal->explicit_conffile)
{
/* An explict option to use a specific configuration file
* has been given - use that one. */
xfree (arg->internal->confname);
arg->internal->confname
= xtrystrdup (arg->internal->explicit_conffile);
if (!arg->internal->confname)
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
}
else if (arg->internal->explicit_confopt)
{
/* An explict option not to use a configuration file has
* been given - leap direct to command line reading. */
arg->internal->state = STATE_open_cmdline;
goto next_state;
}
else
{
/* Use the standard configure file. If it is a two part
- * name take the second part. */
+ * name take the second part. If it is the standard name
+ * and ARGPARSE_FLAG_USERVERS is set try versioned config
+ * files. */
const char *s;
+ char *nconf;
xfree (arg->internal->confname);
if ((s = is_twopartfname (confname)))
- arg->internal->confname = _gpgrt_fnameconcat (s + 1, NULL);
+ {
+ arg->internal->confname = _gpgrt_fnameconcat (s + 1, NULL);
+ if (!arg->internal->confname)
+ return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
+ }
else
- arg->internal->confname = _gpgrt_fnameconcat
- (confdir.user? confdir.user : "~/.config", confname, NULL);
- if (!arg->internal->confname)
- return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
+ {
+ arg->internal->confname = _gpgrt_fnameconcat
+ (confdir.user? confdir.user : "~/.config", confname, NULL);
+ if (!arg->internal->confname)
+ return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
+ if ((arg->flags & ARGPARSE_FLAG_USERVERS)
+ && (nconf = try_versioned_conffile (arg->internal->confname)))
+ {
+ xfree (arg->internal->confname);
+ arg->internal->confname = nconf;
+ }
+ }
}
arg->lineno = 0;
arg->internal->idx = 0;
arg->internal->stopped = 0;
arg->internal->inarg = 0;
_gpgrt_fclose (arg->internal->conffp);
arg->internal->conffp = _gpgrt_fopen (arg->internal->confname, "r");
- /* FIXME: Add a callback. */
- /* if (arg->internal->conffp && is_secured_file (fileno (configfp)))*/
- /* { */
- /* es_fclose (arg->internal->conffp); */
- /* arg->internal->conffp = NULL; */
- /* gpg_err_set_errno (EPERM); */
- /* } */
if (!arg->internal->conffp)
{
arg->internal->state = STATE_open_cmdline;
if (arg->internal->explicit_confopt)
{
_gpgrt_log_error (_("option file '%s': %s\n"),
arg->internal->confname, strerror (errno));
return (arg->r_opt = ARGPARSE_NO_CONFFILE);
}
else
{
if ((arg->flags & ARGPARSE_FLAG_VERBOSE))
_gpgrt_log_info (_("Note: no default option file '%s'\n"),
arg->internal->confname);
goto next_state;
}
}
if ((arg->flags & ARGPARSE_FLAG_VERBOSE))
_gpgrt_log_info (_("reading options from '%s'\n"),
arg->internal->confname);
arg->internal->state = STATE_read_user;
arg->r.ret_str = xtrystrdup (arg->internal->confname);
if (!arg->r.ret_str)
arg->r_opt = ARGPARSE_OUT_OF_CORE;
else
{
gpgrt_annotate_leaked_object (arg->r.ret_str);
arg->r_opt = ARGPARSE_CONFFILE;
arg->r_type = ARGPARSE_TYPE_STRING;
}
break;
case STATE_open_cmdline:
_gpgrt_fclose (arg->internal->conffp);
arg->internal->conffp = NULL;
xfree (arg->internal->confname);
arg->internal->confname = NULL;
arg->internal->idx = 0;
arg->internal->stopped = 0;
arg->internal->inarg = 0;
if (!arg->argc || !arg->argv || !*arg->argv)
{
/* No or empty argument vector - don't bother to parse things. */
arg->internal->state = STATE_finished;
goto next_state;
}
arg->r_opt = ARGPARSE_CONFFILE;
arg->r_type = ARGPARSE_TYPE_NONE;
arg->r.ret_str = NULL;
arg->internal->state = STATE_read_cmdline;
break;
case STATE_read_sys:
arg->r_opt = _gpgrt_argparse (arg->internal->conffp, arg, opts);
if (!arg->r_opt)
{
arg->internal->state = STATE_open_user;
goto next_state;
}
if ((arg->internal->opt_flags & ARGPARSE_OPT_CONFFILE))
goto next_state; /* Already handled - again. */
break;
case STATE_read_user:
arg->r_opt = _gpgrt_argparse (arg->internal->conffp, arg, opts);
if (!arg->r_opt)
{
arg->internal->state = STATE_open_cmdline;
goto next_state;
}
if ((arg->internal->opt_flags & ARGPARSE_OPT_CONFFILE))
goto next_state; /* Already handled - again. */
break;
case STATE_read_cmdline:
arg->r_opt = arg_parse (arg, opts, 1);
if (!arg->r_opt)
{
arg->internal->state = STATE_finished;
goto next_state;
}
if ((arg->internal->opt_flags & ARGPARSE_OPT_CONFFILE))
goto next_state; /* Already handled - again. */
break;
case STATE_finished:
arg->r_opt = 0;
break;
}
return arg->r_opt;
}
/* Given the list of options OPTS and a keyword, return the index of
* the long option macthing KEYWORD. On error -1 is retruned for not
* found or -2 for ambigious keyword. */
static int
find_long_option (gpgrt_argparse_t *arg, gpgrt_opt_t **opts,
const char *keyword)
{
int i;
size_t n;
(void)arg; /* Not yet required. */
/* Would be better if we can do a binary search, but it is not
* possible to reorder our option table because we would mess up our
* help strings. What we can do is: Build an option lookup table
* when this function is first invoked. */
if (!*keyword)
return -1;
for (i=0; opts[i]->short_opt; i++ )
if (opts[i]->long_opt && !strcmp (opts[i]->long_opt, keyword))
return i;
#if 0
{
ALIAS_DEF a;
/* see whether it is an alias */
for (a = args->internal->aliases; a; a = a->next)
{
if (!strcmp( a->name, keyword))
{
/* todo: must parse the alias here */
args->internal->cur_alias = a;
return -3; /* alias available */
}
}
}
#endif
/* Not found. See whether it is an abbreviation. Aliases may not
* be abbreviated, though. */
n = strlen (keyword);
for (i=0; opts[i]->short_opt; i++)
{
if (opts[i]->long_opt && !strncmp (opts[i]->long_opt, keyword, n))
{
int j;
for (j=i+1; opts[j]->short_opt; j++)
{
if (opts[j]->long_opt
&& !strncmp (opts[j]->long_opt, keyword, n)
&& !(opts[j]->short_opt == opts[i]->short_opt
&& opts[j]->flags == opts[i]->flags ) )
return -2; /* Abbreviation is ambiguous. */
}
return i;
}
}
return -1; /* Not found. */
}
/* The option parser for command line options. */
static int
arg_parse (gpgrt_argparse_t *arg, gpgrt_opt_t *opts_orig, int no_init)
{
int idx;
gpgrt_opt_t **opts;
int argc;
char **argv;
char *s, *s2;
int i;
if (no_init)
;
else if (initialize (arg, opts_orig, NULL))
return (arg->r_opt = ARGPARSE_OUT_OF_CORE);
opts = arg->internal->opts;
argc = *arg->argc;
argv = *arg->argv;
idx = arg->internal->idx;
if (!idx && argc && !(arg->flags & ARGPARSE_FLAG_ARG0))
{
/* Skip the first argument. */
argc--; argv++; idx++;
}
next_one:
if (!argc)
{
/* No more args. */
arg->r_opt = 0;
goto leave; /* Ready. */
}
s = *argv;
arg->internal->last = s;
arg->internal->opt_flags = 0;
if (arg->internal->stopped && (arg->flags & ARGPARSE_FLAG_ALL))
{
arg->r_opt = ARGPARSE_IS_ARG; /* Not an option but an argument. */
arg->r_type = 2;
arg->r.ret_str = s;
argc--; argv++; idx++; /* set to next one */
}
else if( arg->internal->stopped )
{
arg->r_opt = 0;
goto leave; /* Ready. */
}
else if ( *s == '-' && s[1] == '-' )
{
/* Long option. */
char *argpos;
arg->internal->inarg = 0;
if (!s[2] && !(arg->flags & ARGPARSE_FLAG_NOSTOP))
{
/* Stop option processing. */
arg->internal->stopped = 1;
arg->flags |= ARGPARSE_FLAG_STOP_SEEN;
argc--; argv++; idx++;
goto next_one;
}
argpos = strchr( s+2, '=' );
if ( argpos )
*argpos = 0;
i = find_long_option ( arg, opts, s+2 );
if ( argpos )
*argpos = '=';
if (i > 0 && opts[i]->short_opt == ARGPARSE_SHORTOPT_HELP)
show_help (opts, arg->flags);
else if (i > 0 && opts[i]->short_opt == ARGPARSE_SHORTOPT_VERSION)
{
if (!(arg->flags & ARGPARSE_FLAG_NOVERSION))
{
show_version ();
my_exit (arg, 0);
}
}
else if (i > 0 && opts[i]->short_opt == ARGPARSE_SHORTOPT_WARRANTY)
{
writestrings (0, _gpgrt_strusage (16), "\n", NULL);
my_exit (arg, 0);
}
else if (i > 0 && opts[i]->short_opt == ARGPARSE_SHORTOPT_DUMP_OPTIONS)
{
for (i=0; opts[i]->short_opt; i++ )
{
if (opts[i]->long_opt && !(opts[i]->flags & ARGPARSE_OPT_IGNORE))
writestrings (0, "--", opts[i]->long_opt, "\n", NULL);
}
my_exit (arg, 0);
}
if ( i == -2 )
arg->r_opt = ARGPARSE_AMBIGUOUS_OPTION;
else if ( i == -1 )
{
arg->r_opt = ARGPARSE_INVALID_OPTION;
arg->r.ret_str = s+2;
}
else
arg->r_opt = opts[i]->short_opt;
if ( i < 0 )
;
else if ( (opts[i]->flags & ARGPARSE_TYPE_MASK) )
{
if ( argpos )
{
s2 = argpos+1;
if ( !*s2 )
s2 = NULL;
}
else
s2 = argv[1];
if ( !s2 && (opts[i]->flags & ARGPARSE_OPT_OPTIONAL) )
{
arg->r_type = ARGPARSE_TYPE_NONE; /* Argument is optional. */
}
else if ( !s2 )
{
arg->r_opt = ARGPARSE_MISSING_ARG;
}
else if ( !argpos && *s2 == '-'
&& (opts[i]->flags & ARGPARSE_OPT_OPTIONAL) )
{
/* The argument is optional and the next seems to be an
option. We do not check this possible option but
assume no argument */
arg->r_type = ARGPARSE_TYPE_NONE;
}
else
{
set_opt_arg (arg, opts[i]->flags, s2);
if ( !argpos )
{
argc--; argv++; idx++; /* Skip one. */
}
}
}
else
{
/* Does not take an argument. */
if ( argpos )
arg->r_type = ARGPARSE_UNEXPECTED_ARG;
else
{
arg->internal->opt_flags = opts[i]->flags;
arg->r_type = 0;
}
}
argc--; argv++; idx++; /* Set to next one. */
}
else if ( (*s == '-' && s[1]) || arg->internal->inarg )
{
/* Short option. */
int dash_kludge = 0;
i = 0;
if ( !arg->internal->inarg )
{
arg->internal->inarg++;
if ( (arg->flags & ARGPARSE_FLAG_ONEDASH) )
{
for (i=0; opts[i]->short_opt; i++ )
if ( opts[i]->long_opt && !strcmp (opts[i]->long_opt, s+1))
{
dash_kludge = 1;
break;
}
}
}
s += arg->internal->inarg;
if (!dash_kludge )
{
for (i=0; opts[i]->short_opt; i++ )
if ( opts[i]->short_opt == *s )
break;
}
if ( !opts[i]->short_opt && ( *s == 'h' || *s == '?' ) )
show_help (opts, arg->flags);
arg->r_opt = opts[i]->short_opt;
if (!opts[i]->short_opt )
{
arg->r_opt = (opts[i]->flags & ARGPARSE_OPT_COMMAND)?
ARGPARSE_INVALID_COMMAND:ARGPARSE_INVALID_OPTION;
arg->internal->inarg++; /* Point to the next arg. */
arg->r.ret_str = s;
}
else if ( (opts[i]->flags & ARGPARSE_TYPE_MASK) )
{
if ( s[1] && !dash_kludge )
{
s2 = s+1;
set_opt_arg (arg, opts[i]->flags, s2);
}
else
{
s2 = argv[1];
if ( !s2 && (opts[i]->flags & ARGPARSE_OPT_OPTIONAL) )
{
arg->r_type = ARGPARSE_TYPE_NONE;
arg->internal->opt_flags = opts[i]->flags;
}
else if ( !s2 )
{
arg->r_opt = ARGPARSE_MISSING_ARG;
}
else if ( *s2 == '-' && s2[1]
&& (opts[i]->flags & ARGPARSE_OPT_OPTIONAL) )
{
/* The argument is optional and the next seems to
be an option. We do not check this possible
option but assume no argument. */
arg->r_type = ARGPARSE_TYPE_NONE;
arg->internal->opt_flags = opts[i]->flags;
}
else
{
set_opt_arg (arg, opts[i]->flags, s2);
argc--; argv++; idx++; /* Skip one. */
}
}
s = "x"; /* This is so that !s[1] yields false. */
}
else
{
/* Does not take an argument. */
arg->r_type = ARGPARSE_TYPE_NONE;
arg->internal->opt_flags = opts[i]->flags;
arg->internal->inarg++; /* Point to the next arg. */
}
if ( !s[1] || dash_kludge )
{
/* No more concatenated short options. */
arg->internal->inarg = 0;
argc--; argv++; idx++;
}
}
else if ( arg->flags & ARGPARSE_FLAG_MIXED )
{
arg->r_opt = ARGPARSE_IS_ARG;
arg->r_type = 2;
arg->r.ret_str = s;
argc--; argv++; idx++; /* Set to next one. */
}
else
{
arg->internal->stopped = 1; /* Stop option processing. */
goto next_one;
}
leave:
*arg->argc = argc;
*arg->argv = argv;
arg->internal->idx = idx;
return arg->r_opt;
}
/* Returns: -1 on error, 0 for an integer type and 1 for a non integer
type argument. */
static int
set_opt_arg (gpgrt_argparse_t *arg, unsigned flags, char *s)
{
int base = (flags & ARGPARSE_OPT_PREFIX)? 0 : 10;
long l;
arg->internal->opt_flags = flags;
switch ( (arg->r_type = (flags & ARGPARSE_TYPE_MASK)) )
{
case ARGPARSE_TYPE_LONG:
case ARGPARSE_TYPE_INT:
errno = 0;
l = strtol (s, NULL, base);
if ((l == LONG_MIN || l == LONG_MAX) && errno == ERANGE)
{
arg->r_opt = ARGPARSE_INVALID_ARG;
return -1;
}
if (arg->r_type == ARGPARSE_TYPE_LONG)
arg->r.ret_long = l;
else if ( (l < 0 && l < INT_MIN) || l > INT_MAX )
{
arg->r_opt = ARGPARSE_INVALID_ARG;
return -1;
}
else
arg->r.ret_int = (int)l;
return 0;
case ARGPARSE_TYPE_ULONG:
while (isascii (*s) && isspace(*s))
s++;
if (*s == '-')
{
arg->r.ret_ulong = 0;
arg->r_opt = ARGPARSE_INVALID_ARG;
return -1;
}
errno = 0;
arg->r.ret_ulong = strtoul (s, NULL, base);
if (arg->r.ret_ulong == ULONG_MAX && errno == ERANGE)
{
arg->r_opt = ARGPARSE_INVALID_ARG;
return -1;
}
return 0;
case ARGPARSE_TYPE_STRING:
default:
arg->r.ret_str = s;
return 1;
}
}
/* Return the length of the option O. This needs to consider the
* description as weel as the option name. */
static size_t
long_opt_strlen (gpgrt_opt_t *o)
{
size_t n = strlen (o->long_opt);
if ( o->description && *o->description == '|' )
{
const char *s;
int is_utf8 = is_native_utf8 ();
s=o->description+1;
if ( *s != '=' )
n++;
/* For a (mostly) correct length calculation we exclude
* continuation bytes (10xxxxxx) if we are on a native utf8
* terminal. */
for (; *s && *s != '|'; s++ )
if ( is_utf8 && (*s&0xc0) != 0x80 )
n++;
}
return n;
}
/****************
* Print formatted help. The description string has some special
* meanings:
* - A description string which is "@" suppresses help output for
* this option
* - a description,ine which starts with a '@' and is followed by
* any other characters is printed as is; this may be used for examples
* ans such.
* - A description which starts with a '|' outputs the string between this
* bar and the next one as arguments of the long option.
*/
static void
show_help (gpgrt_opt_t **opts, unsigned int flags)
{
const char *s;
char tmp[2];
show_version ();
writestrings (0, "\n", NULL);
s = _gpgrt_strusage (42);
if (s && *s == '1')
{
s = _gpgrt_strusage (40);
writestrings (1, s, NULL);
if (*s && s[strlen(s)] != '\n')
writestrings (1, "\n", NULL);
}
s = _gpgrt_strusage(41);
writestrings (0, s, "\n", NULL);
if ( opts[0]->description )
{
/* Auto format the option description. */
int i,j, indent;
/* Get max. length of long options. */
for (i=indent=0; opts[i]->short_opt; i++ )
{
if ( opts[i]->long_opt )
if ( !opts[i]->description || *opts[i]->description != '@' )
if ( (j=long_opt_strlen(opts[i])) > indent && j < 35 )
indent = j;
}
/* Example: " -v, --verbose Viele Sachen ausgeben" */
indent += 10;
if ( *opts[0]->description != '@' )
writestrings (0, "Options:", "\n", NULL);
for (i=0; opts[i]->short_opt; i++ )
{
s = map_fixed_string (_( opts[i]->description ));
if ( s && *s== '@' && !s[1] ) /* Hide this line. */
continue;
if ( s && *s == '@' ) /* Unindented comment only line. */
{
for (s++; *s; s++ )
{
if ( *s == '\n' )
{
if( s[1] )
writestrings (0, "\n", NULL);
}
else
{
tmp[0] = *s;
tmp[1] = 0;
writestrings (0, tmp, NULL);
}
}
writestrings (0, "\n", NULL);
continue;
}
j = 3;
if ( opts[i]->short_opt < 256 )
{
tmp[0] = opts[i]->short_opt;
tmp[1] = 0;
writestrings (0, " -", tmp, NULL );
if ( !opts[i]->long_opt )
{
if (s && *s == '|' )
{
writestrings (0, " ", NULL); j++;
for (s++ ; *s && *s != '|'; s++, j++ )
{
tmp[0] = *s;
tmp[1] = 0;
writestrings (0, tmp, NULL);
}
if ( *s )
s++;
}
}
}
else
writestrings (0, " ", NULL);
if ( opts[i]->long_opt )
{
tmp[0] = opts[i]->short_opt < 256?',':' ';
tmp[1] = 0;
j += writestrings (0, tmp, " --", opts[i]->long_opt, NULL);
if (s && *s == '|' )
{
if ( *++s != '=' )
{
writestrings (0, " ", NULL);
j++;
}
for ( ; *s && *s != '|'; s++, j++ )
{
tmp[0] = *s;
tmp[1] = 0;
writestrings (0, tmp, NULL);
}
if ( *s )
s++;
}
writestrings (0, " ", NULL);
j += 3;
}
for (;j < indent; j++ )
writestrings (0, " ", NULL);
if ( s )
{
if ( *s && j > indent )
{
writestrings (0, "\n", NULL);
for (j=0;j < indent; j++ )
writestrings (0, " ", NULL);
}
for (; *s; s++ )
{
if ( *s == '\n' )
{
if ( s[1] )
{
writestrings (0, "\n", NULL);
for (j=0; j < indent; j++ )
writestrings (0, " ", NULL);
}
}
else
{
tmp[0] = *s;
tmp[1] = 0;
writestrings (0, tmp, NULL);
}
}
}
writestrings (0, "\n", NULL);
}
if ( (flags & ARGPARSE_FLAG_ONEDASH) )
writestrings (0, "\n(A single dash may be used "
"instead of the double ones)\n", NULL);
}
if ( (s=_gpgrt_strusage(19)) )
{
writestrings (0, "\n", NULL);
writestrings (0, s, NULL);
}
flushstrings (0);
exit (0);
}
static void
show_version ()
{
const char *s;
int i;
/* Version line. */
writestrings (0, _gpgrt_strusage (11), NULL);
if ((s=_gpgrt_strusage (12)))
writestrings (0, " (", s, ")", NULL);
writestrings (0, " ", _gpgrt_strusage (13), "\n", NULL);
/* Additional version lines. */
for (i=20; i < 30; i++)
if ((s=_gpgrt_strusage (i)))
writestrings (0, s, "\n", NULL);
/* Copyright string. */
if ((s=_gpgrt_strusage (14)))
writestrings (0, s, "\n", NULL);
/* Licence string. */
if( (s=_gpgrt_strusage (10)) )
writestrings (0, s, "\n", NULL);
/* Copying conditions. */
if ( (s=_gpgrt_strusage(15)) )
writestrings (0, s, NULL);
/* Thanks. */
if ((s=_gpgrt_strusage(18)))
writestrings (0, s, NULL);
/* Additional program info. */
for (i=30; i < 40; i++ )
if ( (s=_gpgrt_strusage (i)) )
writestrings (0, s, NULL);
flushstrings (0);
}
void
_gpgrt_usage (int level)
{
const char *p;
if (!level)
{
writestrings (1, _gpgrt_strusage(11), " ", _gpgrt_strusage(13), "; ",
_gpgrt_strusage (14), "\n", NULL);
flushstrings (1);
}
else if (level == 1)
{
p = _gpgrt_strusage (40);
writestrings (1, p, NULL);
if (*p && p[strlen(p)] != '\n')
writestrings (1, "\n", NULL);
exit (2);
}
else if (level == 2)
{
p = _gpgrt_strusage (42);
if (p && *p == '1')
{
p = _gpgrt_strusage (40);
writestrings (1, p, NULL);
if (*p && p[strlen(p)] != '\n')
writestrings (1, "\n", NULL);
}
writestrings (0, _gpgrt_strusage(41), "\n", NULL);
exit (0);
}
}
/* Level
* 0: Print copyright string to stderr
* 1: Print a short usage hint to stderr and terminate
* 2: Print a long usage hint to stdout and terminate
* 8: Return NULL for UTF-8 or string with the native charset.
* 9: Return the SPDX License tag.
* 10: Return license info string
* 11: Return the name of the program
* 12: Return optional name of package which includes this program.
* 13: version string
* 14: copyright string
* 15: Short copying conditions (with LFs)
* 16: Long copying conditions (with LFs)
* 17: Optional printable OS name
* 18: Optional thanks list (with LFs)
* 19: Bug report info
*20..29: Additional lib version strings.
*30..39: Additional program info (with LFs)
* 40: short usage note (with LF)
* 41: long usage note (with LF)
* 42: Flag string:
* First char is '1':
* The short usage notes needs to be printed
* before the long usage note.
*/
const char *
_gpgrt_strusage (int level)
{
const char *p = strusage_handler? strusage_handler(level) : NULL;
const char *tmp;
if ( p )
return map_fixed_string (p);
switch ( level )
{
case 8: break; /* Default to utf-8. */
case 9:
p = "GPL-3.0-or-later"; /* Suggested license. */
break;
case 10:
tmp = _gpgrt_strusage (9);
if (tmp && !strcmp (tmp, "GPL-2.0-or-later"))
p = ("License GNU GPL-2.0-or-later ");
else if (tmp && !strcmp (tmp, "LGPL-2.1-or-later"))
p = ("License GNU LGPL-2.1-or-later ");
else /* Default to GPLv3+. */
p = ("License GNU GPL-3.0-or-later ");
break;
case 11: p = "foo"; break;
case 13: p = "0.0"; break;
case 14: p = "Copyright (C) YEAR NAME"; break;
case 15: p =
"This is free software: you are free to change and redistribute it.\n"
"There is NO WARRANTY, to the extent permitted by law.\n";
break;
case 16:
tmp = _gpgrt_strusage (9);
if (tmp && !strcmp (tmp, "GPL-2.0-or-later"))
p =
"This is free software; you can redistribute it and/or modify\n"
"it under the terms of the GNU General Public License as published by\n"
"the Free Software Foundation; either version 2 of the License, or\n"
"(at your option) any later version.\n\n"
"It is distributed in the hope that it will be useful,\n"
"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
"GNU General Public License for more details.\n\n"
"You should have received a copy of the GNU General Public License\n"
"along with this software. If not, see .\n";
else if (tmp && !strcmp (tmp, "LGPL-2.1-or-later"))
p =
"This is free software; you can redistribute it and/or modify\n"
"it under the terms of the GNU Lesser General Public License as\n"
"published by the Free Software Foundation; either version 2.1 of\n"
"the License, or (at your option) any later version.\n\n"
"It is distributed in the hope that it will be useful,\n"
"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
"GNU Lesser General Public License for more details.\n\n"
"You should have received a copy of the GNU General Public License\n"
"along with this software. If not, see .\n";
else /* Default */
p =
"This is free software; you can redistribute it and/or modify\n"
"it under the terms of the GNU General Public License as published by\n"
"the Free Software Foundation; either version 3 of the License, or\n"
"(at your option) any later version.\n\n"
"It is distributed in the hope that it will be useful,\n"
"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
"GNU General Public License for more details.\n\n"
"You should have received a copy of the GNU General Public License\n"
"along with this software. If not, see .\n";
break;
case 40: /* short and long usage */
case 41: p = ""; break;
}
return p;
}
/* Set the usage handler. This function is basically a constructor. */
void
_gpgrt_set_strusage (const char *(*f)(int) )
{
strusage_handler = f;
}
/* Set a function to write strings which is then used instead of
* estream. The first arg of that function is MODE and the second the
* STRING to write. A mode of 1 is used for writing to stdout and a
* mode of 2 to write to stderr. Other modes are reserved and should
* not output anything. A NULL for STRING requests a flush. */
void
_gpgrt_set_usage_outfnc (int (*f)(int, const char *))
{
custom_outfnc = f;
}
/* Register function F as a string mapper which takes a string as
* argument, replaces known "@FOO@" style macros and returns a new
* fixed string. Warning: The input STRING must have been allocated
* statically. */
void
_gpgrt_set_fixed_string_mapper (const char *(*f)(const char*))
{
fixed_string_mapper = f;
}
/* Register a configuration directory for use by the argparse
* functions. The defined values for WHAT are:
*
* GPGRT_CONFDIR_SYS The systems's configuration dir.
* The default is /etc
*
* GPGRT_CONFDIR_USER The user's configuration directory.
* The default is $HOME.
*
* A trailing slash is ignored; to have the function lookup
* configuration files in the current directory, use ".". There is no
* error return; more configuraion values may be added in future
* revisions of this library.
*/
void
_gpgrt_set_confdir (int what, const char *name)
{
char *buf, *p;
if (what == GPGRT_CONFDIR_SYS)
{
_gpgrt_free (confdir.sys);
buf = confdir.sys = _gpgrt_strdup (name);
}
else if (what == GPGRT_CONFDIR_USER)
{
_gpgrt_free (confdir.user);
buf = confdir.user = _gpgrt_strdup (name);
}
else
return;
if (!buf)
_gpgrt_log_fatal ("out of core in %s\n", __func__);
#ifdef HAVE_W32_SYSTEM
for (p=buf; *p; p++)
if (*p == '\\')
*p = '/';
#endif
/* Strip trailing slashes unless buf is "/" or any other single char
* string. */
if (*buf)
{
for (p=buf + strlen (buf)-1; p > buf; p--)
if (*p == '/')
*p = 0;
else
break;
}
}
diff --git a/src/gpg-error.h.in b/src/gpg-error.h.in
index f8c294d..e353700 100644
--- a/src/gpg-error.h.in
+++ b/src/gpg-error.h.in
@@ -1,1344 +1,1345 @@
/* 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 .
* SPDX-License-Identifier: LGPL-2.1+
*
* @configure_input@
*/
/* 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
#include
#include
/* The version string of this header. */
#define GPG_ERROR_VERSION @version@
#define GPGRT_VERSION @version@
/* The version number of this header. */
#define GPG_ERROR_VERSION_NUMBER @version-number@
#define GPGRT_VERSION_NUMBER @version-number@
#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
{
@include:err-sources@
/* 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
{
@include:err-codes@
/* The following error codes are used to map system errors. */
#define GPG_ERR_SYSTEM_ERROR (1 << 15)
@include:errnos@
/* 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
#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. */
@define:pid_t@
@define:gpgrt_ssize_t@
@define:gpgrt_off_t@
@include:os-add@
/* 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_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);
/*
* Lock functions.
*/
@include:lock-obj@
#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 @api_ssize_t@ (*gpgrt_cookie_read_function_t) (void *cookie,
void *buffer, size_t size);
typedef @api_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_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);
@api_ssize_t@ gpgrt_getline (char *_GPGRT__RESTRICT *_GPGRT__RESTRICT lineptr,
size_t *_GPGRT__RESTRICT n,
gpgrt_stream_t stream);
@api_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. */
/* 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)
/* Flags for the option descriptor (gpgrt_opt_t)->flags. Note that
* a TYPE constant may be or-ed with the OPT constants. */
#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. */
/* 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) }
#define ARGPARSE_ignore(s,l) \
{ (s), (l), (ARGPARSE_OPT_IGNORE), "@" }
#define ARGPARSE_group(s,d) \
{ (s), NULL, 0, (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 */