a33b7f21fd42ff3bec4549aaf83d8931274094dc
[gnupg.git] / include / util.h
1 /* util.h
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 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  * G10 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_pid( int pid );
60 int  log_get_errorcount( int clear );
61 void log_hexdump( const char *text, char *buf, size_t len );
62 void log_mpidump( const char *text, MPI a );
63
64 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
65   void printstr( int level, const char *fmt, ... )
66                             __attribute__ ((format (printf,2,3)));
67   void log_bug( const char *fmt, ... )
68                             __attribute__ ((noreturn, format (printf,1,2)));
69   void log_bug0( void ) __attribute__ ((noreturn));
70   void log_fatal( const char *fmt, ... )
71                             __attribute__ ((noreturn, format (printf,1,2)));
72   void log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
73   void log_info( const char *fmt, ... )  __attribute__ ((format (printf,1,2)));
74   void log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
75 #else
76   void printstr( int level, const char *fmt, ... );
77   void log_bug( const char *fmt, ... );
78   void log_bug0( void );
79   void log_fatal( const char *fmt, ... );
80   void log_error( const char *fmt, ... );
81   void log_info( const char *fmt, ... );
82   void log_debug( const char *fmt, ... );
83 #endif
84
85
86 /*-- errors.c --*/
87 const char * g10_errstr( int no );
88
89 /*-- argparse.c --*/
90 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
91 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
92                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
93 void usage( int level );
94 const char *default_strusage( int level );
95
96
97 /*-- (main program) --*/
98 const char *strusage( int level );
99
100
101 /*-- fileutil.c --*/
102 char *make_filename( const char *first_part, ... );
103
104 /*-- miscutil.c --*/
105 u32 make_timestamp(void);
106 void print_string( FILE *fp, byte *p, size_t n );
107 int answer_is_yes( const char *s );
108
109 /*-- strgutil.c --*/
110 void free_strlist( STRLIST sl );
111 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
112 void add_to_strlist( STRLIST *list, const char *string );
113 char *memistr( char *buf, size_t buflen, const char *sub );
114 char *trim_spaces( char *string );
115 int string_count_chr( const char *string, int c );
116
117 #define stricmp(a,b) strcasecmp((a),(b))
118 #ifndef HAVE_STPCPY
119 char *stpcpy(char *a,const char *b);
120 #endif
121 #ifndef HAVE_STRLWR
122 char *strlwr(char *a);
123 #endif
124
125
126 /******** some macros ************/
127 #ifndef STR
128   #define STR(v) #v
129 #endif
130 #define STR2(v) STR(v)
131 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
132 #define DIMof(type,member)   DIM(((type *)0)->member)
133 #define BUG() log_bug0()
134
135 #endif /*G10_UTIL_H*/