See ChangeLog: Wed May 26 14:36:29 CEST 1999 Werner Koch
[gnupg.git] / include / util.h
1 /* util.h
2  *      Copyright (C) 1998 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 #include "types.h"
24 #include "errors.h"
25 #include "types.h"
26 #include "mpi.h"
27
28
29 typedef struct {
30      int  *argc;            /* pointer to argc (value subject to change) */
31      char ***argv;          /* pointer to argv (value subject to change) */
32      unsigned flags;        /* Global flags (DO NOT CHANGE) */
33      int err;               /* print error about last option */
34                             /* 1 = warning, 2 = abort */
35      int r_opt;             /* return option */
36      int r_type;            /* type of return value (0 = no argument found)*/
37      union {
38          int   ret_int;
39          long  ret_long;
40          ulong ret_ulong;
41          char *ret_str;
42      } r;                   /* Return values */
43      struct {
44          int idx;
45          int inarg;
46          int stopped;
47          const char *last;
48          void *aliases;
49          const void *cur_alias;
50      } internal;            /* DO NOT CHANGE */
51 } ARGPARSE_ARGS;
52
53 typedef struct {
54     int         short_opt;
55     const char *long_opt;
56     unsigned flags;
57     const char *description; /* optional option description */
58 } ARGPARSE_OPTS;
59
60 /*-- logger.c --*/
61 void log_set_logfile( const char *name, int fd );
62 FILE *log_stream(void);
63 void log_set_name( const char *name );
64 const char *log_get_name(void);
65 void log_set_pid( int pid );
66 int  log_get_errorcount( int clear );
67 void g10_log_hexdump( const char *text, const char *buf, size_t len );
68 void g10_log_mpidump( const char *text, MPI a );
69
70 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
71   void g10_log_bug( const char *fmt, ... )
72                             __attribute__ ((noreturn, format (printf,1,2)));
73   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
74   void g10_log_fatal( const char *fmt, ... )
75                             __attribute__ ((noreturn, format (printf,1,2)));
76   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
77   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
78   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
79   void g10_log_fatal_f( const char *fname, const char *fmt, ... )
80                             __attribute__ ((noreturn, format (printf,2,3)));
81   void g10_log_error_f( const char *fname, const char *fmt, ... )
82                             __attribute__ ((format (printf,2,3)));
83   void g10_log_info_f( const char *fname, const char *fmt, ... )
84                             __attribute__ ((format (printf,2,3)));
85   void g10_log_debug_f( const char *fname,  const char *fmt, ... )
86                             __attribute__ ((format (printf,2,3)));
87   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
88 #else
89   void g10_log_bug( const char *fmt, ... );
90   void g10_log_bug0( const char *, int );
91   void g10_log_fatal( const char *fmt, ... );
92   void g10_log_error( const char *fmt, ... );
93   void g10_log_info( const char *fmt, ... );
94   void g10_log_debug( const char *fmt, ... );
95   void g10_log_fatal_f( const char *fname, const char *fmt, ... );
96   void g10_log_error_f( const char *fname, const char *fmt, ... );
97   void g10_log_info_f( const char *fname, const char *fmt, ... );
98   void g10_log_debug_f( const char *fname, const char *fmt, ... );
99   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
100 #endif
101
102 #define log_hexdump g10_log_hexdump
103 #define log_mpidump g10_log_mpidump
104 #define log_bug     g10_log_bug
105 #define log_bug0    g10_log_bug0
106 #define log_fatal   g10_log_fatal
107 #define log_error   g10_log_error
108 #define log_info    g10_log_info
109 #define log_debug   g10_log_debug
110 #define log_fatal_f g10_log_fatal_f
111 #define log_error_f g10_log_error_f
112 #define log_info_f  g10_log_info_f
113 #define log_debug_f g10_log_debug_f
114
115
116 /*-- errors.c --*/
117 const char * g10_errstr( int no );
118
119 /*-- argparse.c --*/
120 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
121 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
122                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
123 void usage( int level );
124 const char *default_strusage( int level );
125
126
127 /*-- (main program) --*/
128 const char *strusage( int level );
129
130
131 /*-- dotlock.c --*/
132 struct dotlock_handle;
133 typedef struct dotlock_handle *DOTLOCK;
134
135 DOTLOCK create_dotlock( const char *file_to_lock );
136 int make_dotlock( DOTLOCK h, long timeout );
137 int release_dotlock( DOTLOCK h );
138
139
140 /*-- fileutil.c --*/
141 char * make_basename(const char *filepath);
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
148
149 /*-- miscutil.c --*/
150 u32 make_timestamp(void);
151 u32 add_days_to_timestamp( u32 stamp, u16 days );
152 const char *strtimevalue( u32 stamp );
153 const char *strtimestamp( u32 stamp ); /* GMT */
154 const char *asctimestamp( u32 stamp ); /* localized */
155 void print_string( FILE *fp, const byte *p, size_t n, int delim );
156 int answer_is_yes( const char *s );
157
158 /*-- strgutil.c --*/
159 void free_strlist( STRLIST sl );
160 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
161 STRLIST add_to_strlist( STRLIST *list, const char *string );
162 STRLIST append_to_strlist( STRLIST *list, const char *string );
163 STRLIST strlist_prev( STRLIST head, STRLIST node );
164 STRLIST strlist_last( STRLIST node );
165 const char *memistr( const char *buf, size_t buflen, const char *sub );
166 char *mem2str( char *, const void *, size_t);
167 char *trim_spaces( char *string );
168 unsigned trim_trailing_chars( byte *line, unsigned len, const char *trimchars);
169 unsigned trim_trailing_ws( byte *line, unsigned len );
170 int string_count_chr( const char *string, int c );
171 int set_native_charset( const char *newset );
172 const char* get_native_charset(void);
173 char *native_to_utf8( const char *string );
174 char *utf8_to_native( const char *string );
175 int  check_utf8_string( const char *string );
176
177 #define stricmp(a,b) strcasecmp((a),(b))
178
179 #ifndef HAVE_MEMICMP
180 int memicmp( const char *a, const char *b, size_t n );
181 #endif
182 #ifndef HAVE_STPCPY
183 char *stpcpy(char *a,const char *b);
184 #endif
185 #ifndef HAVE_STRLWR
186 char *strlwr(char *a);
187 #endif
188 #ifndef HAVE_STRTOUL
189   #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
190 #endif
191 #ifndef HAVE_MEMMOVE
192   #define memmove(d, s, n) bcopy((s), (d), (n))
193 #endif
194
195
196 /**** other missing stuff ****/
197 #ifndef HAVE_ATEXIT  /* For SunOS */
198   #define atexit(a)    (on_exit((a),0))
199 #endif
200
201 #ifndef HAVE_RAISE
202   #define raise(a) kill(getpid(), (a))
203 #endif
204
205 /******** some macros ************/
206 #ifndef STR
207   #define STR(v) #v
208 #endif
209 #define STR2(v) STR(v)
210 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
211 #define DIMof(type,member)   DIM(((type *)0)->member)
212
213 #endif /*G10_UTIL_H*/