* encode.c (encode_crypt), g10.c (main), sign.c (sign_file,
[gnupg.git] / common / util.h
1 /* util.h - Utility functions for Gnupg
2  *      Copyright (C) 2001 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
27 /* to pass hash functions to libksba we need to cast it */
28 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
29
30 /* get all the stuff from jnlib */
31 #include "../jnlib/logging.h"
32 #include "../jnlib/argparse.h"
33 #include "../jnlib/stringhelp.h"
34 #include "../jnlib/mischelp.h"
35 #include "../jnlib/strlist.h"
36 #include "../jnlib/dotlock.h"
37
38 /* handy malloc macros  - use only them */
39 #define xtrymalloc(a)    gcry_malloc ((a))
40 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
41 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
42 #define xtrystrdup(a)    gcry_strdup ((a))
43 #define xfree(a)         gcry_free ((a))
44
45 #define xmalloc(a)       gcry_xmalloc ((a))
46 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
47 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
48 #define xstrdup(a)       gcry_xstrdup ((a))
49
50 #define seterr(a)  (GNUPG_ ## a)
51
52 /*-- maperror.c --*/
53 int map_ksba_err (int err);
54 int map_gcry_err (int err);
55 int map_kbx_err (int err);
56 int map_assuan_err (int err);
57 int map_to_assuan_status (int rc);
58
59 /*-- gettime.c --*/
60 time_t gnupg_get_time (void);
61 void   gnupg_set_time (time_t newtime, int freeze);
62 int    gnupg_faked_time_p (void);
63
64
65 /*-- replacement functions from funcname.c --*/
66 #if !HAVE_VASPRINTF
67 #include <stdarg.h>
68 int vasprintf (char **result, const char *format, va_list *args);
69 int asprintf (char **result, const char *format, ...);
70 #endif
71
72 #if !HAVE_FOPENCOOKIE
73 typedef struct
74 {
75   ssize_t (*read)(void*,char*,size_t);
76   ssize_t (*write)(void*,const char*,size_t);
77   int (*seek)(void*,off_t*,int);
78   int (*close)(coid*);
79 } _IO_cookie_io_functions_t;
80 typedef _IO_cookie_io_functions_t cookie_io_functions_t;
81 FILE *fopencookie (void *cookie, const char *opentype,
82                    cookie_io_functions_t funclist);
83 #endif /*!HAVE_FOPENCOOKIE*/
84
85
86
87 /*-- some macros to replace ctype ones and avoid locale problems --*/
88 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
89 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
90 #define hexdigitp(a) (digitp (a)                     \
91                       || (*(a) >= 'A' && *(a) <= 'F')  \
92                       || (*(a) >= 'a' && *(a) <= 'f'))
93 /* the atoi macros assume that the buffer has only valid digits */
94 #define atoi_1(p)   (*(p) - '0' )
95 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
96 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
97 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
98                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
99 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
100
101
102
103 #endif /*GNUPG_COMMON_UTIL_H*/
104
105
106
107
108
109
110
111