2004-05-21 Marcus Brinkmann <marcus@g10code.de>
[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  - use only them */
41 #define xtrymalloc(a)    gcry_malloc ((a))
42 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
43 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
44 #define xtrystrdup(a)    gcry_strdup ((a))
45 #define xfree(a)         gcry_free ((a))
46
47 #define xmalloc(a)       gcry_xmalloc ((a))
48 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
49 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
50 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
51 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
52 #define xstrdup(a)       gcry_xstrdup ((a))
53
54
55 /* A type to hold the ISO time.  Note that this this is the same as
56    the the KSBA type ksba_isotime_t. */
57 typedef char gnupg_isotime_t[16];
58
59
60 /*-- maperror.c --*/
61 int map_kbx_err (int err);
62 gpg_error_t map_assuan_err (int err);
63 int map_to_assuan_status (int rc);
64
65 /*-- gettime.c --*/
66 time_t gnupg_get_time (void);
67 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
68 void   gnupg_set_time (time_t newtime, int freeze);
69 int    gnupg_faked_time_p (void);
70 u32    make_timestamp (void);
71 u32    scan_isodatestr (const char *string);
72 u32    add_days_to_timestamp (u32 stamp, u16 days);
73 const char *strtimevalue (u32 stamp);
74 const char *strtimestamp (u32 stamp); /* GMT */
75 const char *asctimestamp (u32 stamp); /* localized */
76
77
78 /* Copy one iso ddate to another, this is inline so that we can do a
79    sanity check. */
80 static inline void
81 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
82 {
83   if (*s && (strlen (s) != 15 || s[8] != 'T'))
84     BUG();
85   strcpy (d, s);
86 }
87
88
89 /*-- signal.c --*/
90 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
91 void gnupg_pause_on_sigusr (int which);
92 void gnupg_block_all_signals (void);
93 void gnupg_unblock_all_signals (void);
94
95 /*-- yesno.c --*/
96 int answer_is_yes (const char *s);
97 int answer_is_yes_no_default (const char *s, int def_answer);
98 int answer_is_yes_no_quit (const char *s);
99
100
101 /*-- b64enc.c --*/
102 struct b64state 
103
104   unsigned int flags;
105   int idx;
106   int quad_count;
107   FILE *fp;
108   char *title;
109   unsigned char radbuf[4];
110 };
111 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
112 gpg_error_t b64enc_write (struct b64state *state,
113                           const void *buffer, size_t nbytes);
114 gpg_error_t b64enc_finish (struct b64state *state);
115
116
117 /*-- miscellaneous.c --*/
118
119 /* Same as asprintf but return an allocated buffer suitable to be
120    freed using xfree.  This function simply dies on memory failure,
121    thus no extra check is required. */
122 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
123
124 const char *print_fname_stdout (const char *s);
125 const char *print_fname_stdin (const char *s);
126 void print_string (FILE *fp, const byte *p, size_t n, int delim);
127 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
128 void print_utf8_string (FILE *fp, const byte *p, size_t n);
129 char *make_printable_string (const byte *p, size_t n, int delim);
130
131 int is_file_compressed (const char *s, int *ret_rc);
132
133
134 /*-- replacement functions from funcname.c --*/
135 #if !HAVE_VASPRINTF
136 #include <stdarg.h>
137 int vasprintf (char **result, const char *format, va_list args);
138 int asprintf (char **result, const char *format, ...) JNLIB_GCC_A_PRINTF(2,3);
139 #endif
140
141
142
143 /*-- some macros to replace ctype ones and avoid locale problems --*/
144 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
145 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
146 #define hexdigitp(a) (digitp (a)                     \
147                       || (*(a) >= 'A' && *(a) <= 'F')  \
148                       || (*(a) >= 'a' && *(a) <= 'f'))
149   /* Note this isn't identical to a C locale isspace() without \f and
150      \v, but works for the purposes used here. */
151 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
152
153 /* The atoi macros assume that the buffer has only valid digits. */
154 #define atoi_1(p)   (*(p) - '0' )
155 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
156 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
157 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
158                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
159 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
160 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
161
162
163
164 #endif /*GNUPG_COMMON_UTIL_H*/