* findkey.c (modify_description): Keep invalid % escapes, so that
[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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef GNUPG_COMMON_UTIL_H
22 #define GNUPG_COMMON_UTIL_H
23
24 #include <gcrypt.h> /* We need this for the memory function protos. */
25 #include <time.h>   /* We need time_t. */
26 #include <gpg-error.h> /* we need gpg-error_t. */
27
28 /* to pass hash functions to libksba we need to cast it */
29 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
30
31 /* get all the stuff from jnlib */
32 #include "../jnlib/logging.h"
33 #include "../jnlib/argparse.h"
34 #include "../jnlib/stringhelp.h"
35 #include "../jnlib/mischelp.h"
36 #include "../jnlib/strlist.h"
37 #include "../jnlib/dotlock.h"
38 #include "../jnlib/utf8conv.h"
39
40 /* Handy malloc macros - please use only them. */
41 #define xtrymalloc(a)    gcry_malloc ((a))
42 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
43 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
44 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
45 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
46 #define xtrystrdup(a)    gcry_strdup ((a))
47 #define xfree(a)         gcry_free ((a))
48
49 #define xmalloc(a)       gcry_xmalloc ((a))
50 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
51 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
52 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
53 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
54 #define xstrdup(a)       gcry_xstrdup ((a))
55
56
57 /* A type to hold the ISO time.  Note that this this is the same as
58    the the KSBA type ksba_isotime_t. */
59 typedef char gnupg_isotime_t[16];
60
61
62 /*-- maperror.c --*/
63 int map_kbx_err (int err);
64 gpg_error_t map_assuan_err_with_source (int source, int err);
65 int map_to_assuan_status (int rc);
66
67 /*-- gettime.c --*/
68 time_t gnupg_get_time (void);
69 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
70 void   gnupg_set_time (time_t newtime, int freeze);
71 int    gnupg_faked_time_p (void);
72 u32    make_timestamp (void);
73 u32    scan_isodatestr (const char *string);
74 u32    add_days_to_timestamp (u32 stamp, u16 days);
75 const char *strtimevalue (u32 stamp);
76 const char *strtimestamp (u32 stamp); /* GMT */
77 const char *asctimestamp (u32 stamp); /* localized */
78
79
80 /* Copy one iso ddate to another, this is inline so that we can do a
81    sanity check. */
82 static inline void
83 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
84 {
85   if (*s && (strlen (s) != 15 || s[8] != 'T'))
86     BUG();
87   strcpy (d, s);
88 }
89
90
91 /*-- signal.c --*/
92 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
93 void gnupg_pause_on_sigusr (int which);
94 void gnupg_block_all_signals (void);
95 void gnupg_unblock_all_signals (void);
96
97 /*-- yesno.c --*/
98 int answer_is_yes (const char *s);
99 int answer_is_yes_no_default (const char *s, int def_answer);
100 int answer_is_yes_no_quit (const char *s);
101
102 /*-- xreadline.c --*/
103 ssize_t read_line (FILE *fp, 
104                    char **addr_of_buffer, size_t *length_of_buffer,
105                    size_t *max_length);
106
107
108 /*-- b64enc.c --*/
109 struct b64state 
110
111   unsigned int flags;
112   int idx;
113   int quad_count;
114   FILE *fp;
115   char *title;
116   unsigned char radbuf[4];
117 };
118 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
119 gpg_error_t b64enc_write (struct b64state *state,
120                           const void *buffer, size_t nbytes);
121 gpg_error_t b64enc_finish (struct b64state *state);
122
123
124 /*-- homedir. c --*/
125 const char *default_homedir (void);
126
127
128 /*-- miscellaneous.c --*/
129
130 /* Same as asprintf but return an allocated buffer suitable to be
131    freed using xfree.  This function simply dies on memory failure,
132    thus no extra check is required. */
133 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
134 /* Same as asprintf but return an allocated buffer suitable to be
135    freed using xfree.  This function returns NULL on memory failure and
136    sets errno. */
137 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
138
139 const char *print_fname_stdout (const char *s);
140 const char *print_fname_stdin (const char *s);
141 void print_string (FILE *fp, const byte *p, size_t n, int delim);
142 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
143 void print_utf8_string (FILE *fp, const byte *p, size_t n);
144 char *make_printable_string (const byte *p, size_t n, int delim);
145
146 int is_file_compressed (const char *s, int *ret_rc);
147
148
149 /*-- replacement functions from funcname.c --*/
150 #if !HAVE_VASPRINTF
151 #include <stdarg.h>
152 int vasprintf (char **result, const char *format, va_list args);
153 int asprintf (char **result, const char *format, ...) JNLIB_GCC_A_PRINTF(2,3);
154 #endif
155 #ifndef HAVE_STRSEP
156 char *strsep (char **stringp, const char *delim);
157 #endif
158 #ifndef HAVE_TTYNAME
159 char *ttyname (int fd);
160 #endif
161 #ifndef HAVE_MKDTEMP
162 char *mkdtemp (char *template);
163 #endif
164
165
166 /*-- some macros to replace ctype ones and avoid locale problems --*/
167 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
168 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
169 #define hexdigitp(a) (digitp (a)                     \
170                       || (*(a) >= 'A' && *(a) <= 'F')  \
171                       || (*(a) >= 'a' && *(a) <= 'f'))
172   /* Note this isn't identical to a C locale isspace() without \f and
173      \v, but works for the purposes used here. */
174 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
175
176 /* The atoi macros assume that the buffer has only valid digits. */
177 #define atoi_1(p)   (*(p) - '0' )
178 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
179 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
180 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
181                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
182 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
183 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
184
185
186
187 #endif /*GNUPG_COMMON_UTIL_H*/