See ChangeLog ;-). Key validation should now be faster
[gnupg.git] / include / util.h
1 /* util.h
2  *      Copyright (C) 1998 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 #ifndef G10_UTIL_H
21 #define G10_UTIL_H
22
23 #include "types.h"
24 #include "errors.h"
25 #include "types.h"
26 #include "mpi.h"
27
28
29 typedef struct {
30      int  *argc;            /* pointer to argc (value subject to change) */
31      char ***argv;          /* pointer to argv (value subject to change) */
32      unsigned flags;        /* Global flags (DO NOT CHANGE) */
33      int err;               /* print error about last option */
34                             /* 1 = warning, 2 = abort */
35      int r_opt;             /* return option */
36      int r_type;            /* type of return value (0 = no argument found)*/
37      union {
38          int   ret_int;
39          long  ret_long;
40          ulong ret_ulong;
41          char *ret_str;
42      } r;                   /* Return values */
43      struct {
44          int index;
45          int inarg;
46          int stopped;
47          const char *last;
48          void *aliases;
49      } internal;            /* DO NOT CHANGE */
50 } ARGPARSE_ARGS;
51
52 typedef struct {
53     int         short_opt;
54     const char *long_opt;
55     unsigned flags;
56     const char *description; /* optional option description */
57 } ARGPARSE_OPTS;
58
59 /*-- logger.c --*/
60 void log_set_name( const char *name );
61 const char *log_get_name(void);
62 void log_set_pid( int pid );
63 int  log_get_errorcount( int clear );
64 void g10_log_hexdump( const char *text, char *buf, size_t len );
65 void g10_log_mpidump( const char *text, MPI a );
66
67 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
68   void g10_log_bug( const char *fmt, ... )
69                             __attribute__ ((noreturn, format (printf,1,2)));
70   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
71   void g10_log_fatal( const char *fmt, ... )
72                             __attribute__ ((noreturn, format (printf,1,2)));
73   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
74   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
75   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
76   void g10_log_fatal_f( const char *fname, const char *fmt, ... )
77                             __attribute__ ((noreturn, format (printf,2,3)));
78   void g10_log_error_f( const char *fname, const char *fmt, ... )
79                             __attribute__ ((format (printf,2,3)));
80   void g10_log_info_f( const char *fname, const char *fmt, ... )
81                             __attribute__ ((format (printf,2,3)));
82   void g10_log_debug_f( const char *fname,  const char *fmt, ... )
83                             __attribute__ ((format (printf,2,3)));
84   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
85 #else
86   void g10_log_bug( const char *fmt, ... );
87   void g10_log_bug0( const char *, int );
88   void g10_log_fatal( const char *fmt, ... );
89   void g10_log_error( const char *fmt, ... );
90   void g10_log_info( const char *fmt, ... );
91   void g10_log_debug( const char *fmt, ... );
92   void g10_log_fatal_f( const char *fname, const char *fmt, ... );
93   void g10_log_error_f( const char *fname, const char *fmt, ... );
94   void g10_log_info_f( const char *fname, const char *fmt, ... );
95   void g10_log_debug_f( const char *fname, const char *fmt, ... );
96   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
97 #endif
98
99 #define log_hexdump g10_log_hexdump
100 #define log_mpidump g10_log_mpidump
101 #define log_bug     g10_log_bug
102 #define log_bug0    g10_log_bug0
103 #define log_fatal   g10_log_fatal
104 #define log_error   g10_log_error
105 #define log_info    g10_log_info
106 #define log_debug   g10_log_debug
107 #define log_fatal_f g10_log_fatal_f
108 #define log_error_f g10_log_error_f
109 #define log_info_f  g10_log_info_f
110 #define log_debug_f g10_log_debug_f
111
112
113 /*-- errors.c --*/
114 const char * g10_errstr( int no );
115
116 /*-- argparse.c --*/
117 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
118 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
119                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
120 void usage( int level );
121 const char *default_strusage( int level );
122
123
124 /*-- (main program) --*/
125 const char *strusage( int level );
126
127
128 /*-- fileutil.c --*/
129 char * make_basename(const char *filepath);
130 char * make_dirname(const char *filepath);
131 char *make_filename( const char *first_part, ... );
132 int compare_filenames( const char *a, const char *b );
133 const char *print_fname_stdin( const char *s );
134 const char *print_fname_stdout( const char *s );
135
136
137 /*-- miscutil.c --*/
138 u32 make_timestamp(void);
139 u32 add_days_to_timestamp( u32 stamp, u16 days );
140 const char *strtimestamp( u32 stamp ); /* GMT */
141 const char *asctimestamp( u32 stamp ); /* localized */
142 void print_string( FILE *fp, byte *p, size_t n, int delim );
143 int answer_is_yes( const char *s );
144
145 /*-- strgutil.c --*/
146 void free_strlist( STRLIST sl );
147 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
148 STRLIST add_to_strlist( STRLIST *list, const char *string );
149 STRLIST append_to_strlist( STRLIST *list, const char *string );
150 STRLIST strlist_prev( STRLIST head, STRLIST node );
151 STRLIST strlist_last( STRLIST node );
152 const char *memistr( const char *buf, size_t buflen, const char *sub );
153 char *mem2str( char *, const void *, size_t);
154 char *trim_spaces( char *string );
155 int string_count_chr( const char *string, int c );
156 int set_native_charset( const char *newset );
157 char *native_to_utf8( const char *string );
158 char *utf8_to_native( const char *string );
159 int  check_utf8_string( const char *string );
160
161 #define stricmp(a,b) strcasecmp((a),(b))
162
163 #ifndef HAVE_MEMICMP
164 int memicmp( const char *a, const char *b, size_t n );
165 #endif
166 #ifndef HAVE_STPCPY
167 char *stpcpy(char *a,const char *b);
168 #endif
169 #ifndef HAVE_STRLWR
170 char *strlwr(char *a);
171 #endif
172 #ifndef HAVE_STRTOUL
173   #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
174 #endif
175 #ifndef HAVE_MEMMOVE
176   #define memmove(d, s, n) bcopy((s), (d), (n))
177 #endif
178
179
180 /**** other missing stuff ****/
181 #ifndef HAVE_ATEXIT  /* For SunOS */
182   #define atexit(a)    (on_exit((a),0))
183 #endif
184
185 #ifndef HAVE_RAISE
186   #define raise(a) kill(getpid(), (a))
187 #endif
188
189 /******** some macros ************/
190 #ifndef STR
191   #define STR(v) #v
192 #endif
193 #define STR2(v) STR(v)
194 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
195 #define DIMof(type,member)   DIM(((type *)0)->member)
196
197 #endif /*G10_UTIL_H*/