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