a2c65e497dab65092a2e94f30a76358306de3bca
[gnupg.git] / include / util.h
1 /* util.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
3  *               2004 Free Software Foundation, Inc.
4  *
5  * This file is part of GNUPG.
6  *
7  * GNUPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GNUPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21 #ifndef G10_UTIL_H
22 #define G10_UTIL_H
23
24 #if defined (_WIN32) || defined (__CYGWIN32__)
25 #include <stdarg.h>
26 #endif
27
28 #include "types.h"
29 #include "errors.h"
30 #include "types.h"
31 #include "mpi.h"
32
33
34 typedef struct {
35      int  *argc;            /* pointer to argc (value subject to change) */
36      char ***argv;          /* pointer to argv (value subject to change) */
37      unsigned flags;        /* Global flags (DO NOT CHANGE) */
38      int err;               /* print error about last option */
39                             /* 1 = warning, 2 = abort */
40      int r_opt;             /* return option */
41      int r_type;            /* type of return value (0 = no argument found)*/
42      union {
43          int   ret_int;
44          long  ret_long;
45          ulong ret_ulong;
46          char *ret_str;
47      } r;                   /* Return values */
48      struct {
49          int idx;
50          int inarg;
51          int stopped;
52          const char *last;
53          void *aliases;
54          const void *cur_alias;
55      } internal;            /* DO NOT CHANGE */
56 } ARGPARSE_ARGS;
57
58 typedef struct {
59     int         short_opt;
60     const char *long_opt;
61     unsigned flags;
62     const char *description; /* optional option description */
63 } ARGPARSE_OPTS;
64
65 /*-- logger.c --*/
66 void log_set_logfile( const char *name, int fd );
67 FILE *log_stream(void);
68 void g10_log_print_prefix(const char *text);
69 void log_set_name( const char *name );
70 const char *log_get_name(void);
71 void log_set_pid( int pid );
72 int  log_get_errorcount( int clear );
73 void log_inc_errorcount(void);
74 int log_set_strict(int val);
75 void g10_log_hexdump( const char *text, const char *buf, size_t len );
76
77 #if defined (__riscos__) \
78     || (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 ))
79   void g10_log_bug( const char *fmt, ... )
80                             __attribute__ ((noreturn, format (printf,1,2)));
81   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
82   void g10_log_fatal( const char *fmt, ... )
83                             __attribute__ ((noreturn, format (printf,1,2)));
84   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
85   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
86   void g10_log_warning( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
87   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
88 #ifndef __riscos__
89 #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
90 #else
91 #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __func__ )
92 #endif
93 #else
94   void g10_log_bug( const char *fmt, ... );
95   void g10_log_bug0( const char *, int );
96   void g10_log_fatal( const char *fmt, ... );
97   void g10_log_error( const char *fmt, ... );
98   void g10_log_info( const char *fmt, ... );
99   void g10_log_warning( const char *fmt, ... );
100   void g10_log_debug( const char *fmt, ... );
101 #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
102 #endif
103
104 #define log_hexdump g10_log_hexdump
105 #define log_bug     g10_log_bug
106 #define log_bug0    g10_log_bug0
107 #define log_fatal   g10_log_fatal
108 #define log_error   g10_log_error
109 #define log_info    g10_log_info
110 #define log_warning g10_log_warning
111 #define log_debug   g10_log_debug
112
113
114 /*-- errors.c --*/
115 const char * g10_errstr( int no );
116
117 /*-- argparse.c --*/
118 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
119 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
120                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
121 void usage( int level );
122 const char *default_strusage( int level );
123
124
125 /*-- (main program) --*/
126 const char *strusage( int level );
127
128
129 /*-- dotlock.c --*/
130 struct dotlock_handle;
131 typedef struct dotlock_handle *DOTLOCK;
132
133 void disable_dotlock(void);
134 DOTLOCK create_dotlock( const char *file_to_lock );
135 void destroy_dotlock ( DOTLOCK h );
136 int make_dotlock( DOTLOCK h, long timeout );
137 int release_dotlock( DOTLOCK h );
138 void remove_lockfiles (void);
139
140 /*-- fileutil.c --*/
141 char * make_basename(const char *filepath, const char *inputpath);
142 char * make_dirname(const char *filepath);
143 char *make_filename( const char *first_part, ... );
144 int compare_filenames( const char *a, const char *b );
145 const char *print_fname_stdin( const char *s );
146 const char *print_fname_stdout( const char *s );
147 int is_file_compressed(const char *s, int *r_status);
148
149 /*-- miscutil.c --*/
150 u32 make_timestamp(void);
151 u32 scan_isodatestr( const char *string );
152 u32 add_days_to_timestamp( u32 stamp, u16 days );
153 const char *strtimevalue( u32 stamp );
154 const char *strtimestamp( u32 stamp ); /* GMT */
155 const char *asctimestamp( u32 stamp ); /* localized */
156 void print_string( FILE *fp, const byte *p, size_t n, int delim );
157 void print_string2( FILE *fp, const byte *p, size_t n, int delim, int delim2 );
158 void  print_utf8_string( FILE *fp, const byte *p, size_t n );
159 void  print_utf8_string2( FILE *fp, const byte *p, size_t n, int delim);
160 char *make_printable_string( const byte *p, size_t n, int delim );
161 int answer_is_yes_no_default( const char *s, int def_answer );
162 int answer_is_yes( const char *s );
163 int answer_is_yes_no_quit( const char *s );
164 int answer_is_okay_cancel (const char *s, int def_answer);
165 int match_multistr(const char *multistr,const char *match);
166 int hextobyte( const char *s );
167
168 /*-- strgutil.c --*/
169 void free_strlist( STRLIST sl );
170 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
171 STRLIST add_to_strlist( STRLIST *list, const char *string );
172 STRLIST add_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
173 STRLIST append_to_strlist( STRLIST *list, const char *string );
174 STRLIST append_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
175 STRLIST strlist_prev( STRLIST head, STRLIST node );
176 STRLIST strlist_last( STRLIST node );
177 char *pop_strlist( STRLIST *list );
178 const char *memistr( const char *buf, size_t buflen, const char *sub );
179 const char *ascii_memistr( const char *buf, size_t buflen, const char *sub );
180 char *mem2str( char *, const void *, size_t);
181 char *trim_spaces( char *string );
182 unsigned int trim_trailing_chars( byte *line, unsigned int len,
183                                   const char *trimchars);
184 unsigned int trim_trailing_ws( byte *line, unsigned len );
185 unsigned int check_trailing_chars( const byte *line, unsigned int len,
186                                    const char *trimchars );
187 unsigned int check_trailing_ws( const byte *line, unsigned int len );
188 int string_count_chr( const char *string, int c );
189 int set_native_charset( const char *newset );
190 const char* get_native_charset(void);
191 char *native_to_utf8( const char *string );
192 char *utf8_to_native( const char *string, size_t length, int delim);
193 int  check_utf8_string( const char *string );
194
195 int ascii_isupper (int c);
196 int ascii_islower (int c);
197 int ascii_toupper (int c);
198 int ascii_tolower (int c);
199 int ascii_strcasecmp( const char *a, const char *b );
200 int ascii_strncasecmp( const char *a, const char *b, size_t n);
201 int ascii_memcasecmp( const char *a, const char *b, size_t n);
202
203 #ifndef HAVE_STPCPY
204 char *stpcpy(char *a,const char *b);
205 #endif
206 #ifndef HAVE_STRLWR
207 char *strlwr(char *a);
208 #endif
209 #ifndef HAVE_STRSEP
210 char *strsep (char **stringp, const char *delim);
211 #endif
212 #ifndef HAVE_STRCASECMP
213 int strcasecmp( const char *, const char *b);
214 #endif
215 #ifndef HAVE_STRNCASECMP
216 int strncasecmp (const char *, const char *b, size_t n);
217 #endif
218 #ifndef HAVE_STRTOUL
219 #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
220 #endif
221 #ifndef HAVE_MEMMOVE
222 #define memmove(d, s, n) bcopy((s), (d), (n))
223 #endif
224
225 #if defined (_WIN32)
226 /*-- w32reg.c --*/
227 char *read_w32_registry_string( const char *root,
228                                 const char *dir, const char *name );
229 int write_w32_registry_string(const char *root, const char *dir,
230                               const char *name, const char *value);
231
232 /*-- strgutil.c --*/
233 int vasprintf (char **result, const char *format, va_list args);
234 int asprintf (char **buf, const char *fmt, ...);
235 #endif
236
237 /**** other missing stuff ****/
238 #ifndef HAVE_ATEXIT  /* For SunOS */
239 #define atexit(a)    (on_exit((a),0))
240 #endif
241
242 #ifndef HAVE_RAISE
243 #define raise(a) kill(getpid(), (a))
244 #endif
245
246 /*-- Replacement functions from funcname.c --*/
247
248 #if !HAVE_VASPRINTF
249 int asprintf (char **result, const char *format, ...) 
250 #if defined (__riscos__) \
251     || (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 ))
252                             __attribute__ ((format (printf,2,3)))
253 #endif
254      ;
255
256 #endif
257
258
259 /******** some macros ************/
260 #ifndef STR
261 #define STR(v) #v
262 #endif
263 #define STR2(v) STR(v)
264 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
265 #define DIMof(type,member)   DIM(((type *)0)->member)
266
267 #define wipememory2(_ptr,_set,_len) do { volatile char *_vptr=(volatile char *)(_ptr); size_t _vlen=(_len); while(_vlen) { *_vptr=(_set); _vptr++; _vlen--; } } while(0)
268 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
269
270 /*-- macros to replace ctype ones and avoid locale problems --*/
271 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
272 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
273 #define hexdigitp(a) (digitp (a)                     \
274                       || (*(a) >= 'A' && *(a) <= 'F')  \
275                       || (*(a) >= 'a' && *(a) <= 'f'))
276 /* the atoi macros assume that the buffer has only valid digits */
277 #define atoi_1(p)   (*(p) - '0' )
278 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
279 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
280 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
281                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
282 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
283
284 /* Note this isn't identical to a C locale isspace() without \f and
285    \v, but works for the purposes used here. */
286 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
287
288 /******* RISC OS stuff ***********/
289 #ifdef __riscos__
290 int riscos_load_module(const char *name, const char * const path[], int fatal);
291 int riscos_get_filetype_from_string(const char *string, int len);
292 int riscos_get_filetype(const char *filename);
293 void riscos_set_filetype_by_number(const char *filename, int type);
294 void riscos_set_filetype_by_mimetype(const char *filename, const char *mimetype);
295 pid_t riscos_getpid(void);
296 int riscos_kill(pid_t pid, int sig);
297 int riscos_access(const char *path, int amode);
298 int riscos_getchar(void);
299 char *riscos_make_basename(const char *filepath, const char *inputpath);
300 int riscos_check_regexp(const char *exp, const char *string, int debug);
301 int riscos_fdopenfile(const char *filename, const int allow_write);
302 void riscos_close_fds(void);
303 int riscos_renamefile(const char *old, const char *new);
304 char *riscos_gstrans(const char *old);
305 void riscos_not_implemented(const char *feature);
306 #ifdef DEBUG
307 void riscos_dump_fdlist(void);
308 void riscos_list_openfiles(void);
309 #endif
310 #ifndef __RISCOS__C__
311 #define getpid riscos_getpid
312 #define kill(a,b) riscos_kill((a),(b))
313 #define access(a,b) riscos_access((a),(b))
314 #endif /* !__RISCOS__C__ */
315 #endif /* __riscos__ */
316
317 #endif /*G10_UTIL_H*/