tidying up RISC OS stuff
[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 (__MINGW32__) || 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 void g10_log_hexdump( const char *text, const char *buf, size_t len );
74
75 #if defined (__riscos__) \
76     || (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 ))
77   void g10_log_bug( const char *fmt, ... )
78                             __attribute__ ((noreturn, format (printf,1,2)));
79   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
80   void g10_log_fatal( const char *fmt, ... )
81                             __attribute__ ((noreturn, format (printf,1,2)));
82   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
83   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
84   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
85   void g10_log_fatal_f( const char *fname, const char *fmt, ... )
86                             __attribute__ ((noreturn, format (printf,2,3)));
87   void g10_log_error_f( const char *fname, const char *fmt, ... )
88                             __attribute__ ((format (printf,2,3)));
89   void g10_log_info_f( const char *fname, const char *fmt, ... )
90                             __attribute__ ((format (printf,2,3)));
91   void g10_log_debug_f( const char *fname,  const char *fmt, ... )
92                             __attribute__ ((format (printf,2,3)));
93 #ifndef __riscos__
94   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
95 #else
96   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __func__ )
97 #endif
98 #else
99   void g10_log_bug( const char *fmt, ... );
100   void g10_log_bug0( const char *, int );
101   void g10_log_fatal( const char *fmt, ... );
102   void g10_log_error( const char *fmt, ... );
103   void g10_log_info( const char *fmt, ... );
104   void g10_log_debug( const char *fmt, ... );
105   void g10_log_fatal_f( const char *fname, const char *fmt, ... );
106   void g10_log_error_f( const char *fname, const char *fmt, ... );
107   void g10_log_info_f( const char *fname, const char *fmt, ... );
108   void g10_log_debug_f( const char *fname, const char *fmt, ... );
109   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
110 #endif
111
112 #define log_hexdump g10_log_hexdump
113 #define log_bug     g10_log_bug
114 #define log_bug0    g10_log_bug0
115 #define log_fatal   g10_log_fatal
116 #define log_error   g10_log_error
117 #define log_info    g10_log_info
118 #define log_debug   g10_log_debug
119 #define log_fatal_f g10_log_fatal_f
120 #define log_error_f g10_log_error_f
121 #define log_info_f  g10_log_info_f
122 #define log_debug_f g10_log_debug_f
123
124
125 /*-- errors.c --*/
126 const char * g10_errstr( int no );
127
128 /*-- argparse.c --*/
129 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
130 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
131                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
132 void usage( int level );
133 const char *default_strusage( int level );
134
135
136 /*-- (main program) --*/
137 const char *strusage( int level );
138
139
140 /*-- dotlock.c --*/
141 struct dotlock_handle;
142 typedef struct dotlock_handle *DOTLOCK;
143
144 void disable_dotlock(void);
145 DOTLOCK create_dotlock( const char *file_to_lock );
146 int make_dotlock( DOTLOCK h, long timeout );
147 int release_dotlock( DOTLOCK h );
148 void remove_lockfiles (void);
149
150 /*-- fileutil.c --*/
151 char * make_basename(const char *filepath);
152 char * make_dirname(const char *filepath);
153 char *make_filename( const char *first_part, ... );
154 int compare_filenames( const char *a, const char *b );
155 const char *print_fname_stdin( const char *s );
156 const char *print_fname_stdout( const char *s );
157 int  is_file_compressed(const char *s, int *r_status);
158
159
160 /*-- miscutil.c --*/
161 u32 make_timestamp(void);
162 u32 scan_isodatestr( const char *string );
163 u32 add_days_to_timestamp( u32 stamp, u16 days );
164 const char *strtimevalue( u32 stamp );
165 const char *strtimestamp( u32 stamp ); /* GMT */
166 const char *asctimestamp( u32 stamp ); /* localized */
167 void print_string( FILE *fp, const byte *p, size_t n, int delim );
168 void  print_utf8_string( FILE *fp, const byte *p, size_t n );
169 void  print_utf8_string2( FILE *fp, const byte *p, size_t n, int delim);
170 char *make_printable_string( const byte *p, size_t n, int delim );
171 int answer_is_yes_no_default( const char *s, int def_answer );
172 int answer_is_yes( const char *s );
173 int answer_is_yes_no_quit( const char *s );
174
175 /*-- strgutil.c --*/
176 void free_strlist( STRLIST sl );
177 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
178 STRLIST add_to_strlist( STRLIST *list, const char *string );
179 STRLIST add_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
180 STRLIST append_to_strlist( STRLIST *list, const char *string );
181 STRLIST append_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
182 STRLIST strlist_prev( STRLIST head, STRLIST node );
183 STRLIST strlist_last( STRLIST node );
184 char *pop_strlist( STRLIST *list );
185 const char *memistr( const char *buf, size_t buflen, const char *sub );
186 const char *ascii_memistr( const char *buf, size_t buflen, const char *sub );
187 char *mem2str( char *, const void *, size_t);
188 char *trim_spaces( char *string );
189 unsigned int trim_trailing_chars( byte *line, unsigned int len,
190                                   const char *trimchars);
191 unsigned int trim_trailing_ws( byte *line, unsigned len );
192 unsigned int check_trailing_chars( const byte *line, unsigned int len,
193                                    const char *trimchars );
194 unsigned int check_trailing_ws( const byte *line, unsigned int len );
195 int string_count_chr( const char *string, int c );
196 int set_native_charset( const char *newset );
197 const char* get_native_charset(void);
198 char *native_to_utf8( const char *string );
199 char *utf8_to_native( const char *string, size_t length, int delim);
200 int  check_utf8_string( const char *string );
201
202 int ascii_isupper (int c);
203 int ascii_islower (int c);
204 int ascii_toupper (int c);
205 int ascii_tolower (int c);
206 int ascii_strcasecmp( const char *a, const char *b );
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__) || defined (__CYGWIN32__)
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 /******* RISC OS stuff ***********/
260 #ifdef __riscos__
261 /* needed for strcasecmp() */
262 #include <strings.h>
263 /* needed for filename munging */
264 #include <unixlib/local.h>
265 /* needed for image file system feature */
266 #include <unixlib/features.h>
267 void riscos_global_defaults(void);
268 #define RISCOS_GLOBAL_STATICS(a) const char *__dynamic_da_name = (a);
269 void riscos_set_filetype(const char *filename, const char *mimetype);
270 pid_t riscos_getpid(void);
271 int riscos_kill(pid_t pid, int sig);
272 int riscos_access(const char *path, int amode);
273 int riscos_getchar(void);
274 int fdopenfile(const char *filename, const int allow_write);
275 void close_fds(void);
276 int renamefile(const char *old, const char *new);
277 char *gstrans(const char *old);
278 void not_implemented(const char *feature);
279 #ifdef DEBUG
280 void dump_fdlist(void);
281 void list_openfiles(void);
282 #endif
283 #ifndef __RISCOS__C__
284   #define getpid riscos_getpid
285   #define kill(a,b) riscos_kill((a),(b))
286   #define access(a,b) riscos_access((a),(b))
287 #endif /* !__RISCOS__C__ */
288 #endif /* __riscos__ */
289
290 #endif /*G10_UTIL_H*/
291