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