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