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 #ifdef HAVE_SYS_TYPES_H
  35 # include <sys/types.h>
  36 #endif
  37
  38 #include "gpgme.h"
  39
  40 \f
  41 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
  42
  43 \f
  44 /*-- {posix,w32}-util.c --*/
  45 const char *_gpgme_get_gpg_path (void);
  46 const char *_gpgme_get_gpgsm_path (void);
  47 const char *_gpgme_get_gpgconf_path (void);
  48 const char *_gpgme_get_g13_path (void);
  49 const char *_gpgme_get_uiserver_socket_path (void);
  50
  51 int _gpgme_get_conf_int (const char *key, int *value);
  52 void _gpgme_allow_set_foreground_window (pid_t pid);
  53
  54 /*-- dirinfo.c --*/
  55 const char *_gpgme_get_default_homedir (void);
  56 const char *_gpgme_get_default_agent_socket (void);
  57
  58
  59 \f
  60 /*-- replacement functions in <funcname>.c --*/
  61 #ifdef HAVE_CONFIG_H
  62
  63 #ifndef HAVE_STPCPY
  64 static _GPGME_INLINE char *
  65 _gpgme_stpcpy (char *a, const char *b)
  66 {
  67   while (*b)
  68     *a++ = *b++;
  69   *a = 0;
  70   return a;
  71 }
  72 #define stpcpy(a,b) _gpgme_stpcpy ((a), (b))
  73 #endif /*!HAVE_STPCPY*/
  74
  75 #if !HAVE_VASPRINTF
  76 #include <stdarg.h>
  77 int vasprintf (char **result, const char *format, va_list args);
  78 int asprintf (char **result, const char *format, ...);
  79 #endif
  80
  81 #ifndef HAVE_TTYNAME_R
  82 int ttyname_r (int fd, char *buf, size_t buflen);
  83 #endif
  84 #endif
  85
  86 \f
  87 /*-- conversion.c --*/
  88 /* Convert two hexadecimal digits from STR to the value they
  89    represent.  Returns -1 if one of the characters is not a
  90    hexadecimal digit.  */
  91 int _gpgme_hextobyte (const char *str);
  92
  93 /* Decode the C formatted string SRC and store the result in the
  94    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
  95    large enough buffer is allocated with malloc and *DESTP is set to
  96    the result.  Currently, LEN is only used to specify if allocation
  97    is desired or not, the caller is expected to make sure that *DESTP
  98    is large enough if LEN is not zero.  */
  99 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
 100                                       size_t len);
 101
 102 /* Decode the percent escaped string SRC and store the result in the
 103    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
 104    large enough buffer is allocated with malloc and *DESTP is set to
 105    the result.  Currently, LEN is only used to specify if allocation
 106    is desired or not, the caller is expected to make sure that *DESTP
 107    is large enough if LEN is not zero.  If BINARY is 1, then '\0'
 108    characters are allowed in the output.  */
 109 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
 110                                             size_t len, int binary);
 111
 112 gpgme_error_t _gpgme_encode_percent_string (const char *src, char **destp,
 113                                             size_t len);
 114
 115
 116 /* Parse the string TIMESTAMP into a time_t.  The string may either be
 117    seconds since Epoch or in the ISO 8601 format like
 118    "20390815T143012".  Returns 0 for an empty string or seconds since
 119    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
 120    point to the next non-parsed character in TIMESTRING. */
 121 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
 122
 123
 124 gpgme_error_t _gpgme_map_gnupg_error (char *err);
 125
 126 \f
 127 /* Retrieve the environment variable NAME and return a copy of it in a
 128    malloc()'ed buffer in *VALUE.  If the environment variable is not
 129    set, return NULL in *VALUE.  */
 130 gpgme_error_t _gpgme_getenv (const char *name, char **value);
 131
 132 \f
 133 #ifdef HAVE_W32_SYSTEM
 134 int _gpgme_mkstemp (int *fd, char **name);
 135 const char *_gpgme_get_w32spawn_path (void);
 136 #endif /*HAVE_W32_SYSTEM*/
 137 #ifdef HAVE_W32CE_SYSTEM
 138 char *_gpgme_w32ce_get_debug_envvar (void);
 139 #endif /*HAVE_W32CE_SYSTEM*/
 140
 141 /*--  Error codes not yet available in current gpg-error.h.   --*/
 142 #ifndef GPG_ERR_UNFINISHED
 143 #define GPG_ERR_UNFINISHED 199
 144 #endif
 145 #ifndef GPG_ERR_NOT_OPERATIONAL
 146 #define GPG_ERR_NOT_OPERATIONAL 176
 147 #endif
 148 #ifndef GPG_ERR_MISSING_ISSUER_CERT
 149 #define GPG_ERR_MISSING_ISSUER_CERT 185
 150 #endif
 151
 152 \f
 153 #ifdef ENABLE_ASSUAN
 154 #include <assuan.h>
 155 /* System hooks for assuan integration.  */
 156 extern struct assuan_system_hooks _gpgme_assuan_system_hooks;
 157 extern struct assuan_malloc_hooks _gpgme_assuan_malloc_hooks;
 158 int _gpgme_assuan_log_cb (assuan_context_t ctx, void *hook,
 159                           unsigned int cat, const char *msg);
 160 #endif
 161
 162 #endif /* UTIL_H */