Preparing 2.0.1
[gnupg.git] / common / util.h
1 /* util.h - Utility functions for GnuPG
2  * Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef GNUPG_COMMON_UTIL_H
23 #define GNUPG_COMMON_UTIL_H
24
25 #include <gcrypt.h> /* We need this for the memory function protos. */
26 #include <time.h>   /* We need time_t. */
27 #include <errno.h>  /* We need errno.  */
28 #include <gpg-error.h> /* We need gpg_error_t. */
29
30 /* Common GNUlib includes (-I ../gl/). */
31 #include "vasprintf.h"
32
33
34 /* Hash function used with libksba. */
35 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
36
37 /* Get all the stuff from jnlib. */
38 #include "../jnlib/logging.h"
39 #include "../jnlib/argparse.h"
40 #include "../jnlib/stringhelp.h"
41 #include "../jnlib/mischelp.h"
42 #include "../jnlib/strlist.h"
43 #include "../jnlib/dotlock.h"
44 #include "../jnlib/utf8conv.h"
45
46
47 #if __GNUC__ >= 4 
48 # define GNUPG_GCC_A_SENTINEL(a) __attribute__ ((sentinel(a)))
49 #else
50 # define GNUPG_GCC_A_SENTINEL(a) 
51 #endif
52
53
54 /* We need this type even if we are not using libreadline and or we
55    did not include libreadline in the current file. */
56 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
57 typedef char **rl_completion_func_t (const char *, int, int);
58 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
59
60
61 /* Handy malloc macros - please use only them. */
62 #define xtrymalloc(a)    gcry_malloc ((a))
63 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
64 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
65 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
66 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
67 #define xtrystrdup(a)    gcry_strdup ((a))
68 #define xfree(a)         gcry_free ((a))
69
70 #define xmalloc(a)       gcry_xmalloc ((a))
71 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
72 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
73 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
74 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
75 #define xstrdup(a)       gcry_xstrdup ((a))
76
77 /* For compatibility with gpg 1.4 we also define these: */
78 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
79 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
80
81 /* Convenience function to return a gpg-error code for memory
82    allocation failures.  This function makes sure that an error will
83    be returned even if accidently ERRNO is not set.  */
84 static inline gpg_error_t
85 out_of_core (void)
86 {
87   return gpg_error_from_syserror ();
88 }
89
90 /* A type to hold the ISO time.  Note that this this is the same as
91    the the KSBA type ksba_isotime_t. */
92 typedef char gnupg_isotime_t[16];
93
94
95 /*-- gettime.c --*/
96 time_t gnupg_get_time (void);
97 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
98 void   gnupg_set_time (time_t newtime, int freeze);
99 int    gnupg_faked_time_p (void);
100 u32    make_timestamp (void);
101 u32    scan_isodatestr (const char *string);
102 u32    add_days_to_timestamp (u32 stamp, u16 days);
103 const char *strtimevalue (u32 stamp);
104 const char *strtimestamp (u32 stamp); /* GMT */
105 const char *isotimestamp (u32 stamp); /* GMT */
106 const char *asctimestamp (u32 stamp); /* localized */
107
108
109 /* Copy one iso ddate to another, this is inline so that we can do a
110    sanity check. */
111 static inline void
112 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
113 {
114   if (*s && (strlen (s) != 15 || s[8] != 'T'))
115     BUG();
116   strcpy (d, s);
117 }
118
119
120 /*-- signal.c --*/
121 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
122 void gnupg_pause_on_sigusr (int which);
123 void gnupg_block_all_signals (void);
124 void gnupg_unblock_all_signals (void);
125
126 /*-- yesno.c --*/
127 int answer_is_yes (const char *s);
128 int answer_is_yes_no_default (const char *s, int def_answer);
129 int answer_is_yes_no_quit (const char *s);
130 int answer_is_okay_cancel (const char *s, int def_answer);
131
132 /*-- xreadline.c --*/
133 ssize_t read_line (FILE *fp, 
134                    char **addr_of_buffer, size_t *length_of_buffer,
135                    size_t *max_length);
136
137
138 /*-- b64enc.c --*/
139 struct b64state 
140
141   unsigned int flags;
142   int idx;
143   int quad_count;
144   FILE *fp;
145   char *title;
146   unsigned char radbuf[4];
147 };
148 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
149 gpg_error_t b64enc_write (struct b64state *state,
150                           const void *buffer, size_t nbytes);
151 gpg_error_t b64enc_finish (struct b64state *state);
152
153 /*-- sexputil.c */
154 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
155                                      unsigned char *grip);
156 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
157 unsigned char *make_simple_sexp_from_hexstr (const char *line,
158                                              size_t *nscanned);
159
160 /*-- convert.c --*/
161 int hex2bin (const char *string, void *buffer, size_t length);
162 int hexcolon2bin (const char *string, void *buffer, size_t length);
163 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
164 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
165
166
167 /*-- homedir.c --*/
168 const char *default_homedir (void);
169
170 /*-- gpgrlhelp.c --*/
171 void gnupg_rl_initialize (void);
172
173 /*-- miscellaneous.c --*/
174
175 /* Same as asprintf but return an allocated buffer suitable to be
176    freed using xfree.  This function simply dies on memory failure,
177    thus no extra check is required. */
178 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
179 /* Same as asprintf but return an allocated buffer suitable to be
180    freed using xfree.  This function returns NULL on memory failure and
181    sets errno. */
182 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
183
184 const char *print_fname_stdout (const char *s);
185 const char *print_fname_stdin (const char *s);
186 void print_string (FILE *fp, const byte *p, size_t n, int delim);
187 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
188 void print_utf8_string (FILE *fp, const byte *p, size_t n);
189 char *make_printable_string (const void *p, size_t n, int delim);
190
191 int is_file_compressed (const char *s, int *ret_rc);
192
193 int match_multistr (const char *multistr,const char *match);
194
195
196 /*-- Simple replacement functions. */
197 #ifndef HAVE_TTYNAME
198 /* Systems without ttyname (W32) will merely return NULL. */
199 static inline char *
200 ttyname (int fd) 
201 {
202   return NULL
203 };
204 #endif /* !HAVE_TTYNAME */
205
206
207 /*-- Macros to replace ctype ones to avoid locale problems. --*/
208 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
209 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
210 #define hexdigitp(a) (digitp (a)                     \
211                       || (*(a) >= 'A' && *(a) <= 'F')  \
212                       || (*(a) >= 'a' && *(a) <= 'f'))
213   /* Note this isn't identical to a C locale isspace() without \f and
214      \v, but works for the purposes used here. */
215 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
216
217 /* The atoi macros assume that the buffer has only valid digits. */
218 #define atoi_1(p)   (*(p) - '0' )
219 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
220 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
221 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
222                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
223 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
224 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
225
226
227
228 #endif /*GNUPG_COMMON_UTIL_H*/