See ChangeLog: Fri Nov 19 17:15:20 CET 1999 Werner Koch
[gnupg.git] / include / util.h
1 /* util.h
2  *      Copyright (C) 1998,1999 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 #ifdef _GCRYPT_IN_LIBGCRYPT
24   #error This header should not be used internally by libgcrypt
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 g10_log_hexdump( const char *text, const char *buf, size_t len );
73
74 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
75   void g10_log_bug( const char *fmt, ... )
76                             __attribute__ ((noreturn, format (printf,1,2)));
77   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
78   void g10_log_fatal( const char *fmt, ... )
79                             __attribute__ ((noreturn, format (printf,1,2)));
80   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
81   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
82   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
83   void g10_log_fatal_f( const char *fname, const char *fmt, ... )
84                             __attribute__ ((noreturn, format (printf,2,3)));
85   void g10_log_error_f( const char *fname, const char *fmt, ... )
86                             __attribute__ ((format (printf,2,3)));
87   void g10_log_info_f( const char *fname, const char *fmt, ... )
88                             __attribute__ ((format (printf,2,3)));
89   void g10_log_debug_f( const char *fname,  const char *fmt, ... )
90                             __attribute__ ((format (printf,2,3)));
91   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
92 #else
93   void g10_log_bug( const char *fmt, ... );
94   void g10_log_bug0( const char *, int );
95   void g10_log_fatal( const char *fmt, ... );
96   void g10_log_error( const char *fmt, ... );
97   void g10_log_info( const char *fmt, ... );
98   void g10_log_debug( const char *fmt, ... );
99   void g10_log_fatal_f( const char *fname, const char *fmt, ... );
100   void g10_log_error_f( const char *fname, const char *fmt, ... );
101   void g10_log_info_f( const char *fname, const char *fmt, ... );
102   void g10_log_debug_f( const char *fname, const char *fmt, ... );
103   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
104 #endif
105
106 #define log_hexdump g10_log_hexdump
107 #define log_bug     g10_log_bug
108 #define log_bug0    g10_log_bug0
109 #define log_fatal   g10_log_fatal
110 #define log_error   g10_log_error
111 #define log_info    g10_log_info
112 #define log_debug   g10_log_debug
113 #define log_fatal_f g10_log_fatal_f
114 #define log_error_f g10_log_error_f
115 #define log_info_f  g10_log_info_f
116 #define log_debug_f g10_log_debug_f
117
118
119 /*-- errors.c --*/
120 const char * g10_errstr( int no );
121
122 /*-- argparse.c --*/
123 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
124 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
125                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
126 void usage( int level );
127 const char *strusage( int level );
128 void set_strusage( const char *(*f)( int ) );
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 scan_isodatestr( const char *string );
152 u32 add_days_to_timestamp( u32 stamp, u16 days );
153 const char *strtimevalue( u32 stamp );
154 const char *strtimestamp( u32 stamp ); /* GMT */
155 const char *asctimestamp( u32 stamp ); /* localized */
156 void print_string( FILE *fp, const byte *p, size_t n, int delim );
157 void  print_utf8_string( FILE *fp, const byte *p, size_t n );
158 char *make_printable_string( const byte *p, size_t n, int delim );
159 int answer_is_yes( const char *s );
160 int answer_is_yes_no_quit( const char *s );
161
162 /*-- strgutil.c --*/
163 void free_strlist( STRLIST sl );
164 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
165 STRLIST add_to_strlist( STRLIST *list, const char *string );
166 STRLIST add_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
167 STRLIST append_to_strlist( STRLIST *list, const char *string );
168 STRLIST append_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
169 STRLIST strlist_prev( STRLIST head, STRLIST node );
170 STRLIST strlist_last( STRLIST node );
171 const char *memistr( const char *buf, size_t buflen, const char *sub );
172 char *mem2str( char *, const void *, size_t);
173 char *trim_spaces( char *string );
174 unsigned trim_trailing_chars( byte *line, unsigned len, const char *trimchars);
175 unsigned trim_trailing_ws( byte *line, unsigned len );
176 int string_count_chr( const char *string, int c );
177 int set_native_charset( const char *newset );
178 const char* get_native_charset(void);
179 char *native_to_utf8( const char *string );
180 char *utf8_to_native( const char *string, size_t length );
181 int  check_utf8_string( const char *string );
182
183 #ifndef HAVE_MEMICMP
184 int memicmp( const char *a, const char *b, size_t n );
185 #endif
186 #ifndef HAVE_STPCPY
187 char *stpcpy(char *a,const char *b);
188 #endif
189 #ifndef HAVE_STRLWR
190 char *strlwr(char *a);
191 #endif
192 #ifndef HAVE_STRTOUL
193   #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
194 #endif
195 #ifndef HAVE_MEMMOVE
196   #define memmove(d, s, n) bcopy((s), (d), (n))
197 #endif
198 #ifndef HAVE_STRICMP
199   #define stricmp(a,b)   strcasecmp( (a), (b) )
200 #endif
201
202 /**** other missing stuff ****/
203 #ifndef HAVE_ATEXIT  /* For SunOS */
204   #define atexit(a)    (on_exit((a),0))
205 #endif
206
207 #ifndef HAVE_RAISE
208   #define raise(a) kill(getpid(), (a))
209 #endif
210
211 /******** some macros ************/
212 #ifndef STR
213   #define STR(v) #v
214 #endif
215 #define STR2(v) STR(v)
216 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
217 #define DIMof(type,member)   DIM(((type *)0)->member)
218
219 #endif /*G10_UTIL_H*/