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