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