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