Release 1.9.0
[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 #if GPG_ERROR_VERSION_NUMBER < 0x011500 /* 1.21 */
49 # define GPG_ERR_FALSE 256
50 #endif
51
52 #if GPG_ERROR_VERSION_NUMBER < 0x011900 /* 1.25 */
53 # define GPG_ERR_ENGINE_TOO_OLD 300
54 # define GPG_ERR_TOO_OLD        308
55 #endif
56
57 #ifndef GPGRT_ATTR_SENTINEL
58 # define GPGRT_ATTR_SENTINEL(a)  /* */
59 #endif
60
61
62 \f
63 /*-- {posix,w32}-util.c --*/
64 int _gpgme_get_conf_int (const char *key, int *value);
65 void _gpgme_allow_set_foreground_window (pid_t pid);
66
67 /*-- dirinfo.c --*/
68 void _gpgme_dirinfo_disable_gpgconf (void);
69
70 const char *_gpgme_get_default_homedir (void);
71 const char *_gpgme_get_default_agent_socket (void);
72 const char *_gpgme_get_default_gpg_name (void);
73 const char *_gpgme_get_default_gpgsm_name (void);
74 const char *_gpgme_get_default_g13_name (void);
75 const char *_gpgme_get_default_gpgconf_name (void);
76 const char *_gpgme_get_default_uisrv_socket (void);
77 int _gpgme_in_gpg_one_mode (void);
78
79 const char *_gpgme_get_basename (const char *name);
80
81
82 \f
83 /*-- replacement functions in <funcname>.c --*/
84 #ifdef HAVE_CONFIG_H
85
86 #ifndef HAVE_STPCPY
87 static _GPGME_INLINE char *
88 _gpgme_stpcpy (char *a, const char *b)
89 {
90   while (*b)
91     *a++ = *b++;
92   *a = 0;
93   return a;
94 }
95 #define stpcpy(a,b) _gpgme_stpcpy ((a), (b))
96 #endif /*!HAVE_STPCPY*/
97
98
99 /* Due to a bug in mingw32's snprintf related to the 'l' modifier and
100    for increased portability we use our snprintf on all systems. */
101 #undef snprintf
102 #define snprintf gpgrt_snprintf
103
104
105 #if REPLACE_TTYNAME_R
106 int _gpgme_ttyname_r (int fd, char *buf, size_t buflen);
107 #undef  ttyname_r
108 #define ttyname_r(a,b,c) _gpgme_ttyname_r ((a), (b), (c))
109 #endif
110
111 #endif /*HAVE_CONFIG_H*/
112
113 \f
114 /*-- conversion.c --*/
115
116 /* Concatenate the string S1 with all the following strings up to a
117    NULL.  Returns a malloced buffer with the new string or NULL on a
118    malloc error or if too many arguments are given.  */
119 char *_gpgme_strconcat (const char *s1, ...) GPGRT_ATTR_SENTINEL(0);
120
121 /* Convert two hexadecimal digits from STR to the value they
122    represent.  Returns -1 if one of the characters is not a
123    hexadecimal digit.  */
124 int _gpgme_hextobyte (const char *str);
125
126 /* Decode the C formatted string SRC and store the result in the
127    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
128    large enough buffer is allocated with malloc and *DESTP is set to
129    the result.  Currently, LEN is only used to specify if allocation
130    is desired or not, the caller is expected to make sure that *DESTP
131    is large enough if LEN is not zero.  */
132 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
133                                       size_t len);
134
135 /* Decode the percent escaped string SRC and store the result in the
136    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
137    large enough buffer is allocated with malloc and *DESTP is set to
138    the result.  Currently, LEN is only used to specify if allocation
139    is desired or not, the caller is expected to make sure that *DESTP
140    is large enough if LEN is not zero.  If BINARY is 1, then '\0'
141    characters are allowed in the output.  */
142 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
143                                             size_t len, int binary);
144
145 gpgme_error_t _gpgme_encode_percent_string (const char *src, char **destp,
146                                             size_t len);
147
148 /* Split a string into space delimited fields and remove leading and
149  * trailing spaces from each field.  A pointer to the each field is
150  * stored in ARRAY.  Stop splitting at ARRAYSIZE fields.  The function
151  * modifies STRING.  The number of parsed fields is returned.  */
152 int _gpgme_split_fields (char *string, char **array, int arraysize);
153
154 /* Convert the field STRING into an unsigned long value.  Check for
155  * trailing garbage.  */
156 gpgme_error_t _gpgme_strtoul_field (const char *string, unsigned long *result);
157
158 /* Convert STRING into an offset value similar to atoi().  */
159 gpgme_off_t _gpgme_string_to_off (const char *string);
160
161 /* Parse the string TIMESTAMP into a time_t.  The string may either be
162    seconds since Epoch or in the ISO 8601 format like
163    "20390815T143012".  Returns 0 for an empty string or seconds since
164    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
165    point to the next non-parsed character in TIMESTRING. */
166 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
167
168 /* Variant of _gpgme_parse_timestamp to return an unsigned long or 0
169  * on error or missing timestamp.  */
170 unsigned long _gpgme_parse_timestamp_ul (const char *timestamp);
171
172 gpgme_error_t _gpgme_map_gnupg_error (char *err);
173
174 int _gpgme_map_pk_algo (int algo, gpgme_protocol_t protocol);
175
176 \f
177 /*-- b64dec.c --*/
178
179 struct b64state
180 {
181   int idx;
182   int quad_count;
183   char *title;
184   unsigned char radbuf[4];
185   int stop_seen:1;
186   int invalid_encoding:1;
187   gpg_error_t lasterr;
188 };
189
190 gpg_error_t _gpgme_b64dec_start (struct b64state *state, const char *title);
191 gpg_error_t _gpgme_b64dec_proc (struct b64state *state,
192                                 void *buffer, size_t length, size_t *r_nbytes);
193 gpg_error_t _gpgme_b64dec_finish (struct b64state *state);
194
195
196 \f
197 /* Retrieve the environment variable NAME and return a copy of it in a
198    malloc()'ed buffer in *VALUE.  If the environment variable is not
199    set, return NULL in *VALUE.  */
200 gpgme_error_t _gpgme_getenv (const char *name, char **value);
201
202 \f
203 /*-- status-table.c --*/
204 /* Convert a status string to a status code.  */
205 void _gpgme_status_init (void);
206 gpgme_status_code_t _gpgme_parse_status (const char *name);
207 const char *_gpgme_status_to_string (gpgme_status_code_t code);
208
209 \f
210 #ifdef HAVE_W32_SYSTEM
211 int _gpgme_mkstemp (int *fd, char **name);
212 const char *_gpgme_get_w32spawn_path (void);
213 #endif /*HAVE_W32_SYSTEM*/
214 #ifdef HAVE_W32CE_SYSTEM
215 char *_gpgme_w32ce_get_debug_envvar (void);
216 #endif /*HAVE_W32CE_SYSTEM*/
217
218
219 \f
220 #include <assuan.h>
221 /* System hooks for assuan integration.  */
222 extern struct assuan_system_hooks _gpgme_assuan_system_hooks;
223 extern struct assuan_malloc_hooks _gpgme_assuan_malloc_hooks;
224 int _gpgme_assuan_log_cb (assuan_context_t ctx, void *hook,
225                           unsigned int cat, const char *msg);
226
227 #endif /* UTIL_H */