intermediate release
[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      } internal;            /* DO NOT CHANGE */
49 } ARGPARSE_ARGS;
50
51 typedef struct {
52     int         short_opt;
53     const char *long_opt;
54     unsigned flags;
55     const char *description; /* optional option description */
56 } ARGPARSE_OPTS;
57
58 /*-- logger.c --*/
59 void log_set_name( const char *name );
60 const char *log_get_name(void);
61 void log_set_pid( int pid );
62 int  log_get_errorcount( int clear );
63 void g10_log_hexdump( const char *text, char *buf, size_t len );
64 void g10_log_mpidump( const char *text, MPI a );
65
66 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
67   void g10_log_bug( const char *fmt, ... )
68                             __attribute__ ((noreturn, format (printf,1,2)));
69   void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
70   void g10_log_fatal( const char *fmt, ... )
71                             __attribute__ ((noreturn, format (printf,1,2)));
72   void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
73   void g10_log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
74   void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
75   #define BUG() g10_log_bug0(  __FILE__ , __LINE__, __FUNCTION__ )
76 #else
77   void g10_log_bug( const char *fmt, ... );
78   void g10_log_bug0( const char *, int );
79   void g10_log_fatal( const char *fmt, ... );
80   void g10_log_error( const char *fmt, ... );
81   void g10_log_info( const char *fmt, ... );
82   void g10_log_debug( const char *fmt, ... );
83   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
84 #endif
85
86 #define log_hexdump g10_log_hexdump
87 #define log_mpidump g10_log_mpidump
88 #define log_bug     g10_log_bug
89 #define log_bug0    g10_log_bug0
90 #define log_fatal   g10_log_fatal
91 #define log_error   g10_log_error
92 #define log_info    g10_log_info
93 #define log_debug   g10_log_debug
94
95
96
97 /*-- errors.c --*/
98 const char * g10_errstr( int no );
99
100 /*-- argparse.c --*/
101 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
102 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
103                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
104 void usage( int level );
105 const char *default_strusage( int level );
106
107
108 /*-- (main program) --*/
109 const char *strusage( int level );
110
111
112 /*-- fileutil.c --*/
113 char *make_filename( const char *first_part, ... );
114 int compare_filenames( const char *a, const char *b );
115 const char *print_fname_stdin( const char *s );
116 const char *print_fname_stdout( const char *s );
117
118
119 /*-- miscutil.c --*/
120 u32 make_timestamp(void);
121 u32 add_days_to_timestamp( u32 stamp, u16 days );
122 const char *strtimestamp( u32 stamp );
123 void print_string( FILE *fp, byte *p, size_t n, int delim );
124 int answer_is_yes( const char *s );
125
126 /*-- strgutil.c --*/
127 void free_strlist( STRLIST sl );
128 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
129 STRLIST add_to_strlist( STRLIST *list, const char *string );
130 STRLIST append_to_strlist( STRLIST *list, const char *string );
131 STRLIST strlist_prev( STRLIST head, STRLIST node );
132 STRLIST strlist_last( STRLIST node );
133 int memicmp( const char *a, const char *b, size_t n );
134 const char *memistr( const char *buf, size_t buflen, const char *sub );
135 char *mem2str( char *, const void *, size_t);
136 char *trim_spaces( char *string );
137 int string_count_chr( const char *string, int c );
138
139 #define stricmp(a,b) strcasecmp((a),(b))
140 #ifndef HAVE_STPCPY
141 char *stpcpy(char *a,const char *b);
142 #endif
143 #ifndef HAVE_STRLWR
144 char *strlwr(char *a);
145 #endif
146 #ifndef HAVE_STRTOUL
147   #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
148 #endif
149 #ifndef HAVE_MEMMOVE
150   #define memmove(d, s, n) bcopy((s), (d), (n))
151 #endif
152
153
154 /******** some macros ************/
155 #ifndef STR
156   #define STR(v) #v
157 #endif
158 #define STR2(v) STR(v)
159 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
160 #define DIMof(type,member)   DIM(((type *)0)->member)
161
162 #endif /*G10_UTIL_H*/