Add missing file and other changes.
[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 /* We need this type even if we are not using libreadline and or we
47    did not include libreadline in the current file. */
48 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
49 typedef char **rl_completion_func_t (const char *, int, int);
50 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
51
52
53 /* Handy malloc macros - please use only them. */
54 #define xtrymalloc(a)    gcry_malloc ((a))
55 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
56 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
57 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
58 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
59 #define xtrystrdup(a)    gcry_strdup ((a))
60 #define xfree(a)         gcry_free ((a))
61
62 #define xmalloc(a)       gcry_xmalloc ((a))
63 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
64 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
65 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
66 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
67 #define xstrdup(a)       gcry_xstrdup ((a))
68
69 /* For compatibility with gpg 1.4 we also define these: */
70 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
71 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
72
73 /* Convenience function to return a gpg-error code for memory
74    allocation failures.  This function makes sure that an error will
75    be returned even if accidently ERRNO is not set.  */
76 static inline gpg_error_t
77 out_of_core (void)
78 {
79   return gpg_error_from_syserror ();
80 }
81
82 /* A type to hold the ISO time.  Note that this this is the same as
83    the the KSBA type ksba_isotime_t. */
84 typedef char gnupg_isotime_t[16];
85
86
87 /*-- gettime.c --*/
88 time_t gnupg_get_time (void);
89 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
90 void   gnupg_set_time (time_t newtime, int freeze);
91 int    gnupg_faked_time_p (void);
92 u32    make_timestamp (void);
93 u32    scan_isodatestr (const char *string);
94 u32    add_days_to_timestamp (u32 stamp, u16 days);
95 const char *strtimevalue (u32 stamp);
96 const char *strtimestamp (u32 stamp); /* GMT */
97 const char *isotimestamp (u32 stamp); /* GMT */
98 const char *asctimestamp (u32 stamp); /* localized */
99
100
101 /* Copy one iso ddate to another, this is inline so that we can do a
102    sanity check. */
103 static inline void
104 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
105 {
106   if (*s && (strlen (s) != 15 || s[8] != 'T'))
107     BUG();
108   strcpy (d, s);
109 }
110
111
112 /*-- signal.c --*/
113 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
114 void gnupg_pause_on_sigusr (int which);
115 void gnupg_block_all_signals (void);
116 void gnupg_unblock_all_signals (void);
117
118 /*-- yesno.c --*/
119 int answer_is_yes (const char *s);
120 int answer_is_yes_no_default (const char *s, int def_answer);
121 int answer_is_yes_no_quit (const char *s);
122 int answer_is_okay_cancel (const char *s, int def_answer);
123
124 /*-- xreadline.c --*/
125 ssize_t read_line (FILE *fp, 
126                    char **addr_of_buffer, size_t *length_of_buffer,
127                    size_t *max_length);
128
129
130 /*-- b64enc.c --*/
131 struct b64state 
132
133   unsigned int flags;
134   int idx;
135   int quad_count;
136   FILE *fp;
137   char *title;
138   unsigned char radbuf[4];
139 };
140 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
141 gpg_error_t b64enc_write (struct b64state *state,
142                           const void *buffer, size_t nbytes);
143 gpg_error_t b64enc_finish (struct b64state *state);
144
145 /*-- sexputil.c */
146 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
147                                      unsigned char *grip);
148 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
149 unsigned char *make_simple_sexp_from_hexstr (const char *line,
150                                              size_t *nscanned);
151
152 /*-- convert.c --*/
153 int hexcolon2bin (const char *string, void *buffer, size_t length);
154 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
155 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
156
157
158 /*-- homedir.c --*/
159 const char *default_homedir (void);
160
161 /*-- gpgrlhelp.c --*/
162 void gnupg_rl_initialize (void);
163
164 /*-- miscellaneous.c --*/
165
166 /* Same as asprintf but return an allocated buffer suitable to be
167    freed using xfree.  This function simply dies on memory failure,
168    thus no extra check is required. */
169 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
170 /* Same as asprintf but return an allocated buffer suitable to be
171    freed using xfree.  This function returns NULL on memory failure and
172    sets errno. */
173 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
174
175 const char *print_fname_stdout (const char *s);
176 const char *print_fname_stdin (const char *s);
177 void print_string (FILE *fp, const byte *p, size_t n, int delim);
178 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
179 void print_utf8_string (FILE *fp, const byte *p, size_t n);
180 char *make_printable_string (const void *p, size_t n, int delim);
181
182 int is_file_compressed (const char *s, int *ret_rc);
183
184 int match_multistr (const char *multistr,const char *match);
185
186
187 /*-- Simple replacement functions. */
188 #ifndef HAVE_TTYNAME
189 /* Systems without ttyname (W32) will merely return NULL. */
190 static inline char *
191 ttyname (int fd) 
192 {
193   return NULL
194 };
195 #endif /* !HAVE_TTYNAME */
196
197
198 /*-- Macros to replace ctype ones to avoid locale problems. --*/
199 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
200 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
201 #define hexdigitp(a) (digitp (a)                     \
202                       || (*(a) >= 'A' && *(a) <= 'F')  \
203                       || (*(a) >= 'a' && *(a) <= 'f'))
204   /* Note this isn't identical to a C locale isspace() without \f and
205      \v, but works for the purposes used here. */
206 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
207
208 /* The atoi macros assume that the buffer has only valid digits. */
209 #define atoi_1(p)   (*(p) - '0' )
210 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
211 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
212 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
213                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
214 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
215 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
216
217
218
219 #endif /*GNUPG_COMMON_UTIL_H*/