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