8b8df37e8941e37e732e112b9ff3421a9ef401b3
[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 index;
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_name( const char *name );
62 const char *log_get_name(void);
63 void log_set_pid( int pid );
64 int  log_get_errorcount( int clear );
65 void g10_log_hexdump( const char *text, char *buf, size_t len );
66 void g10_log_mpidump( const char *text, MPI a );
67
68 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
69   void g10_log_bug( const char *fmt, ... )
70                             __attribute__ ((noreturn, format (printf,1,2)));
71   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
72   void g10_log_fatal( const char *fmt, ... )
73                             __attribute__ ((noreturn, format (printf,1,2)));
74   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
75   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
76   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
77   void g10_log_fatal_f( const char *fname, const char *fmt, ... )
78                             __attribute__ ((noreturn, format (printf,2,3)));
79   void g10_log_error_f( const char *fname, const char *fmt, ... )
80                             __attribute__ ((format (printf,2,3)));
81   void g10_log_info_f( const char *fname, const char *fmt, ... )
82                             __attribute__ ((format (printf,2,3)));
83   void g10_log_debug_f( const char *fname,  const char *fmt, ... )
84                             __attribute__ ((format (printf,2,3)));
85   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
86 #else
87   void g10_log_bug( const char *fmt, ... );
88   void g10_log_bug0( const char *, int );
89   void g10_log_fatal( const char *fmt, ... );
90   void g10_log_error( const char *fmt, ... );
91   void g10_log_info( const char *fmt, ... );
92   void g10_log_debug( const char *fmt, ... );
93   void g10_log_fatal_f( const char *fname, const char *fmt, ... );
94   void g10_log_error_f( const char *fname, const char *fmt, ... );
95   void g10_log_info_f( const char *fname, const char *fmt, ... );
96   void g10_log_debug_f( const char *fname, const char *fmt, ... );
97   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
98 #endif
99
100 #define log_hexdump g10_log_hexdump
101 #define log_mpidump g10_log_mpidump
102 #define log_bug     g10_log_bug
103 #define log_bug0    g10_log_bug0
104 #define log_fatal   g10_log_fatal
105 #define log_error   g10_log_error
106 #define log_info    g10_log_info
107 #define log_debug   g10_log_debug
108 #define log_fatal_f g10_log_fatal_f
109 #define log_error_f g10_log_error_f
110 #define log_info_f  g10_log_info_f
111 #define log_debug_f g10_log_debug_f
112
113
114 /*-- errors.c --*/
115 const char * g10_errstr( int no );
116
117 /*-- argparse.c --*/
118 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
119 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
120                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
121 void usage( int level );
122 const char *default_strusage( int level );
123
124
125 /*-- (main program) --*/
126 const char *strusage( int level );
127
128
129 /*-- dotlock.c --*/
130 const char *make_dotlock( const char *file_to_lock, long timeout );
131 int         release_dotlock( const char *lockfile );
132
133
134
135
136 /*-- fileutil.c --*/
137 char * make_basename(const char *filepath);
138 char * make_dirname(const char *filepath);
139 char *make_filename( const char *first_part, ... );
140 int compare_filenames( const char *a, const char *b );
141 const char *print_fname_stdin( const char *s );
142 const char *print_fname_stdout( const char *s );
143
144
145 /*-- miscutil.c --*/
146 u32 make_timestamp(void);
147 u32 add_days_to_timestamp( u32 stamp, u16 days );
148 const char *strtimevalue( u32 stamp );
149 const char *strtimestamp( u32 stamp ); /* GMT */
150 const char *asctimestamp( u32 stamp ); /* localized */
151 void print_string( FILE *fp, byte *p, size_t n, int delim );
152 int answer_is_yes( const char *s );
153
154 /*-- strgutil.c --*/
155 void free_strlist( STRLIST sl );
156 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
157 STRLIST add_to_strlist( STRLIST *list, const char *string );
158 STRLIST append_to_strlist( STRLIST *list, const char *string );
159 STRLIST strlist_prev( STRLIST head, STRLIST node );
160 STRLIST strlist_last( STRLIST node );
161 const char *memistr( const char *buf, size_t buflen, const char *sub );
162 char *mem2str( char *, const void *, size_t);
163 char *trim_spaces( char *string );
164 unsigned trim_trailing_ws( byte *line, unsigned len );
165 int string_count_chr( const char *string, int c );
166 int set_native_charset( const char *newset );
167 char *native_to_utf8( const char *string );
168 char *utf8_to_native( const char *string );
169 int  check_utf8_string( const char *string );
170
171 #define stricmp(a,b) strcasecmp((a),(b))
172
173 #ifndef HAVE_MEMICMP
174 int memicmp( const char *a, const char *b, size_t n );
175 #endif
176 #ifndef HAVE_STPCPY
177 char *stpcpy(char *a,const char *b);
178 #endif
179 #ifndef HAVE_STRLWR
180 char *strlwr(char *a);
181 #endif
182 #ifndef HAVE_STRTOUL
183   #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
184 #endif
185 #ifndef HAVE_MEMMOVE
186   #define memmove(d, s, n) bcopy((s), (d), (n))
187 #endif
188
189
190 /**** other missing stuff ****/
191 #ifndef HAVE_ATEXIT  /* For SunOS */
192   #define atexit(a)    (on_exit((a),0))
193 #endif
194
195 #ifndef HAVE_RAISE
196   #define raise(a) kill(getpid(), (a))
197 #endif
198
199 /******** some macros ************/
200 #ifndef STR
201   #define STR(v) #v
202 #endif
203 #define STR2(v) STR(v)
204 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
205 #define DIMof(type,member)   DIM(((type *)0)->member)
206
207 #endif /*G10_UTIL_H*/