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