src/util.h

   1 /* util.h
   2    Copyright (C) 2000 Werner Koch (dd9jn)
   3    Copyright (C) 2001, 2002, 2003, 2004, 2005 g10 Code GmbH
   4
   5    This file is part of GPGME.
   6
   7    GPGME is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU Lesser General Public License as
   9    published by the Free Software Foundation; either version 2.1 of
  10    the License, or (at your option) any later version.
  11
  12    GPGME is distributed in the hope that it will be useful, but
  13    WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    Lesser General Public License for more details.
  16
  17    You should have received a copy of the GNU Lesser General Public
  18    License along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20    02111-1307, USA.  */
  21
  22 #ifndef UTIL_H
  23 #define UTIL_H
  24
  25 #ifdef HAVE_W32_SYSTEM
  26 # ifdef HAVE_W32CE_SYSTEM
  27 #  include "w32-ce.h"
  28 # else
  29 #  include "windows.h"
  30 # endif
  31 #endif
  32
  33 /* For pid_t.  */
  34 #include <sys/types.h>
  35
  36 #include "gpgme.h"
  37
  38 \f
  39 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
  40
  41 \f
  42 /*-- {posix,w32}-util.c --*/
  43 const char *_gpgme_get_gpg_path (void);
  44 const char *_gpgme_get_gpgsm_path (void);
  45 const char *_gpgme_get_gpgconf_path (void);
  46 const char *_gpgme_get_g13_path (void);
  47 const char *_gpgme_get_uiserver_socket_path (void);
  48
  49 int _gpgme_get_conf_int (const char *key, int *value);
  50 void _gpgme_allow_set_foreground_window (pid_t pid);
  51
  52 /*-- dirinfo.c --*/
  53 const char *_gpgme_get_default_homedir (void);
  54 const char *_gpgme_get_default_agent_socket (void);
  55
  56
  57 \f
  58 /*-- replacement functions in <funcname>.c --*/
  59 #ifdef HAVE_CONFIG_H
  60
  61 #ifndef HAVE_STPCPY
  62 static _GPGME_INLINE char *
  63 _gpgme_stpcpy (char *a, const char *b)
  64 {
  65   while (*b)
  66     *a++ = *b++;
  67   *a = 0;
  68   return a;
  69 }
  70 #define stpcpy(a,b) _gpgme_stpcpy ((a), (b))
  71 #endif /*!HAVE_STPCPY*/
  72
  73 #if !HAVE_VASPRINTF
  74 #include <stdarg.h>
  75 int vasprintf (char **result, const char *format, va_list args);
  76 int asprintf (char **result, const char *format, ...);
  77 #endif
  78
  79 #ifndef HAVE_TTYNAME_R
  80 int ttyname_r (int fd, char *buf, size_t buflen);
  81 #endif
  82 #endif
  83
  84 \f
  85 /*-- conversion.c --*/
  86 /* Convert two hexadecimal digits from STR to the value they
  87    represent.  Returns -1 if one of the characters is not a
  88    hexadecimal digit.  */
  89 int _gpgme_hextobyte (const char *str);
  90
  91 /* Decode the C formatted string SRC and store the result in the
  92    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
  93    large enough buffer is allocated with malloc and *DESTP is set to
  94    the result.  Currently, LEN is only used to specify if allocation
  95    is desired or not, the caller is expected to make sure that *DESTP
  96    is large enough if LEN is not zero.  */
  97 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
  98                                       size_t len);
  99
 100 /* Decode the percent escaped string SRC and store the result in the
 101    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
 102    large enough buffer is allocated with malloc and *DESTP is set to
 103    the result.  Currently, LEN is only used to specify if allocation
 104    is desired or not, the caller is expected to make sure that *DESTP
 105    is large enough if LEN is not zero.  If BINARY is 1, then '\0'
 106    characters are allowed in the output.  */
 107 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
 108                                             size_t len, int binary);
 109
 110 gpgme_error_t _gpgme_encode_percent_string (const char *src, char **destp,
 111                                             size_t len);
 112
 113
 114 /* Parse the string TIMESTAMP into a time_t.  The string may either be
 115    seconds since Epoch or in the ISO 8601 format like
 116    "20390815T143012".  Returns 0 for an empty string or seconds since
 117    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
 118    point to the next non-parsed character in TIMESTRING. */
 119 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
 120
 121
 122 gpgme_error_t _gpgme_map_gnupg_error (char *err);
 123
 124 \f
 125 /* Retrieve the environment variable NAME and return a copy of it in a
 126    malloc()'ed buffer in *VALUE.  If the environment variable is not
 127    set, return NULL in *VALUE.  */
 128 gpgme_error_t _gpgme_getenv (const char *name, char **value);
 129
 130 \f
 131 #ifdef HAVE_W32_SYSTEM
 132 int _gpgme_mkstemp (int *fd, char **name);
 133 const char *_gpgme_get_w32spawn_path (void);
 134 #endif /*HAVE_W32_SYSTEM*/
 135 #ifdef HAVE_W32CE_SYSTEM
 136 char *_gpgme_w32ce_get_debug_envvar (void);
 137 #endif /*HAVE_W32CE_SYSTEM*/
 138
 139 /*--  Error codes not yet available in current gpg-error.h.   --*/
 140 #ifndef GPG_ERR_UNFINISHED
 141 #define GPG_ERR_UNFINISHED 199
 142 #endif
 143 #ifndef GPG_ERR_NOT_OPERATIONAL
 144 #define GPG_ERR_NOT_OPERATIONAL 176
 145 #endif
 146 #ifndef GPG_ERR_MISSING_ISSUER_CERT
 147 #define GPG_ERR_MISSING_ISSUER_CERT 185
 148 #endif
 149
 150 \f
 151 #ifdef ENABLE_ASSUAN
 152 #include <assuan.h>
 153 /* System hooks for assuan integration.  */
 154 extern struct assuan_system_hooks _gpgme_assuan_system_hooks;
 155 extern struct assuan_malloc_hooks _gpgme_assuan_malloc_hooks;
 156 int _gpgme_assuan_log_cb (assuan_context_t ctx, void *hook,
 157                           unsigned int cat, const char *msg);
 158 #endif
 159
 160 #endif /* UTIL_H */