initially checkin
[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 "errors.h"
24 #include "types.h"
25 #include "mpi.h"
26
27
28 typedef struct {
29      int  *argc;            /* pointer to argc (value subject to change) */
30      char ***argv;          /* pointer to argv (value subject to change) */
31      unsigned flags;        /* Global flags (DO NOT CHANGE) */
32      int err;               /* print error about last option */
33                             /* 1 = warning, 2 = abort */
34      int r_opt;             /* return option */
35      int r_type;            /* type of return value (0 = no argument found)*/
36      union {
37          int   ret_int;
38          long  ret_long;
39          ulong ret_ulong;
40          char *ret_str;
41      } r;                   /* Return values */
42      struct {
43          int index;
44          int inarg;
45          int stopped;
46          const char *last;
47      } internal;            /* DO NOT CHANGE */
48 } ARGPARSE_ARGS;
49
50 typedef struct {
51     int         short_opt;
52     const char *long_opt;
53     unsigned flags;
54     const char *description; /* optional option description */
55 } ARGPARSE_OPTS;
56
57 /*-- logger.c --*/
58 void printstr( int level, const char *fmt, ... );
59 void log_bug( const char *fmt, ... );
60 void log_fatal( const char *fmt, ... );
61 void log_error( const char *fmt, ... );
62 void log_info( const char *fmt, ... );
63 void log_debug( const char *fmt, ... );
64 void log_hexdump( const char *text, char *buf, size_t len );
65 void log_mpidump( const char *text, MPI a );
66
67 /*-- errors.c --*/
68 const char * g10_errstr( int no );
69
70 /*-- argparse.c --*/
71 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
72 void usage( int level );
73 const char *default_strusage( int level );
74
75
76 /*-- (main program) --*/
77 const char *strusage( int level );
78
79
80 /*-- fileutil.c --*/
81
82 /*-- miscutil.c --*/
83 u32 make_timestamp(void);
84
85 /*-- strgutil.c --*/
86 void free_strlist( STRLIST sl );
87 #define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
88 char *memistr( char *buf, size_t buflen, const char *sub );
89 #define stricmp(a,b) strcasecmp((a),(b))
90
91
92 /******** some macros ************/
93 #ifndef STR
94   #define STR(v) #v
95 #endif
96 #define STR2(v) STR(v)
97 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
98 #define DIMof(type,member)   DIM(((type *)0)->member)
99
100 #endif /*G10_UTIL_H*/