mirror of
git://git.gnupg.org/gnupg.git
synced 2024-11-12 21:58:50 +01:00
8044a5acea
* util/argparse.c (iio_item_def_s, IIO_ITEM_DEF): New.
(initialize): Init field IIO_LIST.
(ignore_invalid_option_p): New.
(ignore_invalid_option_add): New.
(ignore_invalid_option_clear): New.
(optfile_parse): Implement meta option.
--
This option is currently of no use. However, as soon as it has been
deployed in all stable versions of GnuPG, it will allow the use of the
same configuration file with an old and a new version of GnuPG. For
example: If a new version implements the option "foobar", and a user
uses it in gpg.conf, an old version of gpg would bail out with the
error "invalid option". To avoid that the following line can be put
above that option in gpg.conf
ignore-invalid-option foobar
This meta option may be given several times or several option names
may be given as arguments (space delimited). Note that this option is
not available on the command line.
(backported from commit 41d564333d
)
328 lines
12 KiB
C
328 lines
12 KiB
C
/* util.h
|
|
* Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
|
|
* 2006 Free Software Foundation, Inc.
|
|
*
|
|
* This file is part of GNUPG.
|
|
*
|
|
* GNUPG is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* GNUPG is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#ifndef G10_UTIL_H
|
|
#define G10_UTIL_H
|
|
|
|
#include <stdarg.h>
|
|
|
|
#include "types.h"
|
|
#include "errors.h"
|
|
#include "types.h"
|
|
#include "mpi.h"
|
|
#include "compat.h"
|
|
|
|
typedef struct {
|
|
int *argc; /* pointer to argc (value subject to change) */
|
|
char ***argv; /* pointer to argv (value subject to change) */
|
|
unsigned flags; /* Global flags (DO NOT CHANGE) */
|
|
int err; /* print error about last option */
|
|
/* 1 = warning, 2 = abort */
|
|
int r_opt; /* return option */
|
|
int r_type; /* type of return value (0 = no argument found)*/
|
|
union {
|
|
int ret_int;
|
|
long ret_long;
|
|
ulong ret_ulong;
|
|
char *ret_str;
|
|
} r; /* Return values */
|
|
struct {
|
|
int idx;
|
|
int inarg;
|
|
int stopped;
|
|
const char *last;
|
|
void *aliases;
|
|
const void *cur_alias;
|
|
void *iio_list;
|
|
} internal; /* DO NOT CHANGE */
|
|
} ARGPARSE_ARGS;
|
|
|
|
typedef struct {
|
|
int short_opt;
|
|
const char *long_opt;
|
|
unsigned flags;
|
|
const char *description; /* optional option description */
|
|
} ARGPARSE_OPTS;
|
|
|
|
/*-- logger.c --*/
|
|
void log_set_logfile( const char *name, int fd );
|
|
FILE *log_stream(void);
|
|
void g10_log_print_prefix(const char *text);
|
|
void log_set_name( const char *name );
|
|
const char *log_get_name(void);
|
|
void log_set_pid( int pid );
|
|
int log_get_errorcount( int clear );
|
|
void log_inc_errorcount(void);
|
|
int log_set_strict(int val);
|
|
void g10_log_hexdump( const char *text, const char *buf, size_t len );
|
|
|
|
#if defined (__riscos__) \
|
|
|| (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 ))
|
|
void g10_log_bug( const char *fmt, ... )
|
|
__attribute__ ((noreturn, format (printf,1,2)));
|
|
void g10_log_bug0( const char *, int, const char * ) __attribute__ ((noreturn));
|
|
void g10_log_fatal( const char *fmt, ... )
|
|
__attribute__ ((noreturn, format (printf,1,2)));
|
|
void g10_log_error( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
|
|
void g10_log_info( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
|
|
void g10_log_warning( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
|
|
void g10_log_debug( const char *fmt, ... ) __attribute__ ((format (printf,1,2)));
|
|
#ifndef __riscos__
|
|
#define BUG() g10_log_bug0( __FILE__ , __LINE__, __FUNCTION__ )
|
|
#else
|
|
#define BUG() g10_log_bug0( __FILE__ , __LINE__, __func__ )
|
|
#endif
|
|
#else
|
|
void g10_log_bug( const char *fmt, ... );
|
|
void g10_log_bug0( const char *, int );
|
|
void g10_log_fatal( const char *fmt, ... );
|
|
void g10_log_error( const char *fmt, ... );
|
|
void g10_log_info( const char *fmt, ... );
|
|
void g10_log_warning( const char *fmt, ... );
|
|
void g10_log_debug( const char *fmt, ... );
|
|
#define BUG() g10_log_bug0( __FILE__ , __LINE__ )
|
|
#endif
|
|
|
|
#define log_hexdump g10_log_hexdump
|
|
#define log_bug g10_log_bug
|
|
#define log_bug0 g10_log_bug0
|
|
#define log_fatal g10_log_fatal
|
|
#define log_error g10_log_error
|
|
#define log_info g10_log_info
|
|
#define log_warning g10_log_warning
|
|
#define log_debug g10_log_debug
|
|
|
|
|
|
/*-- errors.c --*/
|
|
const char * g10_errstr( int no );
|
|
|
|
/*-- argparse.c --*/
|
|
int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
|
|
int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
|
|
ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
|
|
void usage( int level );
|
|
const char *default_strusage( int level );
|
|
|
|
|
|
/*-- (main program) --*/
|
|
const char *strusage( int level );
|
|
|
|
|
|
/*-- dotlock.c --*/
|
|
#include "../include/dotlock.h"
|
|
|
|
/*-- fileutil.c --*/
|
|
char * make_basename(const char *filepath, const char *inputpath);
|
|
char * make_dirname(const char *filepath);
|
|
char *make_filename( const char *first_part, ... );
|
|
int compare_filenames( const char *a, const char *b );
|
|
int same_file_p (const char *name1, const char *name2);
|
|
const char *print_fname_stdin( const char *s );
|
|
const char *print_fname_stdout( const char *s );
|
|
int is_file_compressed(const char *s, int *r_status);
|
|
|
|
/*-- miscutil.c --*/
|
|
u32 make_timestamp(void);
|
|
u32 scan_isodatestr( const char *string );
|
|
u32 isotime2seconds (const char *string);
|
|
const char *strtimevalue( u32 stamp );
|
|
const char *strtimestamp( u32 stamp ); /* GMT */
|
|
const char *isotimestamp( u32 stamp ); /* GMT with hh:mm:ss */
|
|
const char *asctimestamp( u32 stamp ); /* localized */
|
|
void print_string( FILE *fp, const byte *p, size_t n, int delim );
|
|
void print_string2( FILE *fp, const byte *p, size_t n, int delim, int delim2 );
|
|
void print_utf8_string( FILE *fp, const byte *p, size_t n );
|
|
void print_utf8_string2( FILE *fp, const byte *p, size_t n, int delim);
|
|
char *make_printable_string( const byte *p, size_t n, int delim );
|
|
int answer_is_yes_no_default( const char *s, int def_answer );
|
|
int answer_is_yes( const char *s );
|
|
int answer_is_yes_no_quit( const char *s );
|
|
int answer_is_okay_cancel (const char *s, int def_answer);
|
|
int match_multistr(const char *multistr,const char *match);
|
|
|
|
/*-- strgutil.c --*/
|
|
void free_strlist( STRLIST sl );
|
|
#define FREE_STRLIST(a) do { free_strlist((a)); (a) = NULL ; } while(0)
|
|
STRLIST add_to_strlist( STRLIST *list, const char *string );
|
|
STRLIST add_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
|
|
STRLIST append_to_strlist( STRLIST *list, const char *string );
|
|
STRLIST append_to_strlist2( STRLIST *list, const char *string, int is_utf8 );
|
|
STRLIST strlist_prev( STRLIST head, STRLIST node );
|
|
STRLIST strlist_last( STRLIST node );
|
|
char *pop_strlist( STRLIST *list );
|
|
const char *memistr( const char *buf, size_t buflen, const char *sub );
|
|
const char *ascii_memistr( const char *buf, size_t buflen, const char *sub );
|
|
char *mem2str( char *, const void *, size_t);
|
|
char *trim_spaces( char *string );
|
|
unsigned int trim_trailing_chars( byte *line, unsigned int len,
|
|
const char *trimchars);
|
|
unsigned int trim_trailing_ws( byte *line, unsigned len );
|
|
unsigned int check_trailing_chars( const byte *line, unsigned int len,
|
|
const char *trimchars );
|
|
unsigned int check_trailing_ws( const byte *line, unsigned int len );
|
|
int string_count_chr( const char *string, int c );
|
|
int set_native_charset( const char *newset );
|
|
const char* get_native_charset(void);
|
|
char *native_to_utf8( const char *string );
|
|
char *utf8_to_native( const char *string, size_t length, int delim);
|
|
char *string_to_utf8 (const char *string);
|
|
|
|
int ascii_isupper (int c);
|
|
int ascii_islower (int c);
|
|
int ascii_memcasecmp( const char *a, const char *b, size_t n);
|
|
|
|
#ifndef HAVE_STPCPY
|
|
char *stpcpy(char *a,const char *b);
|
|
#endif
|
|
#ifndef HAVE_STRLWR
|
|
char *strlwr(char *a);
|
|
#endif
|
|
#ifndef HAVE_STRCASECMP
|
|
int strcasecmp( const char *, const char *b);
|
|
#endif
|
|
#ifndef HAVE_STRNCASECMP
|
|
int strncasecmp (const char *, const char *b, size_t n);
|
|
#endif
|
|
#ifndef HAVE_STRTOUL
|
|
#define strtoul(a,b,c) ((unsigned long)strtol((a),(b),(c)))
|
|
#endif
|
|
#ifndef HAVE_MEMMOVE
|
|
#define memmove(d, s, n) bcopy((s), (d), (n))
|
|
#endif
|
|
|
|
/*-- membuf.c --*/
|
|
/* The definition of the structure is private, we only need it here,
|
|
so it can be allocated on the stack. */
|
|
struct private_membuf_s {
|
|
size_t len;
|
|
size_t size;
|
|
char *buf;
|
|
int out_of_core;
|
|
};
|
|
|
|
typedef struct private_membuf_s membuf_t;
|
|
|
|
void init_membuf (membuf_t *mb, int initiallen);
|
|
void put_membuf (membuf_t *mb, const void *buf, size_t len);
|
|
void put_membuf_str (membuf_t *mb, const char *buf);
|
|
void *get_membuf (membuf_t *mb, size_t *len);
|
|
|
|
|
|
|
|
#if defined (_WIN32)
|
|
/*-- w32reg.c --*/
|
|
char *read_w32_registry_string( const char *root,
|
|
const char *dir, const char *name );
|
|
int write_w32_registry_string(const char *root, const char *dir,
|
|
const char *name, const char *value);
|
|
|
|
#endif /*_WIN32*/
|
|
|
|
/*-- strgutil.c --*/
|
|
char *xasprintf (const char *fmt, ...);
|
|
char *xtryasprintf (const char *fmt, ...);
|
|
char *xtryvasprintf (const char *fmt, va_list arg_ptr);
|
|
|
|
|
|
/*-- pka.c --*/
|
|
char *get_pka_info (const char *address, unsigned char *fpr);
|
|
|
|
/*-- cert.c --*/
|
|
int get_cert(const char *name,size_t max_size,IOBUF *iobuf,
|
|
unsigned char **fpr,size_t *fpr_len,char **url);
|
|
|
|
/*-- convert.c --*/
|
|
int hex2bin (const char *string, void *buffer, size_t length);
|
|
int hexcolon2bin (const char *string, void *buffer, size_t length);
|
|
char *bin2hex (const void *buffer, size_t length, char *stringbuf);
|
|
char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
|
|
const char *hex2str (const char *hexstring,
|
|
char *buffer, size_t bufsize, size_t *buflen);
|
|
char *hex2str_alloc (const char *hexstring, size_t *r_count);
|
|
|
|
|
|
/**** other missing stuff ****/
|
|
#ifndef HAVE_ATEXIT /* For SunOS */
|
|
#define atexit(a) (on_exit((a),0))
|
|
#endif
|
|
|
|
#ifndef HAVE_RAISE
|
|
#define raise(a) kill(getpid(), (a))
|
|
#endif
|
|
|
|
/*-- Replacement functions from funcname.c --*/
|
|
|
|
|
|
|
|
/******** some macros ************/
|
|
#ifndef STR
|
|
#define STR(v) #v
|
|
#endif
|
|
#define STR2(v) STR(v)
|
|
#define DIM(v) (sizeof(v)/sizeof((v)[0]))
|
|
#define DIMof(type,member) DIM(((type *)0)->member)
|
|
|
|
#define wipememory2(_ptr,_set,_len) do { volatile char *_vptr=(volatile char *)(_ptr); size_t _vlen=(_len); while(_vlen) { *_vptr=(_set); _vptr++; _vlen--; } } while(0)
|
|
#define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
|
|
|
|
/*-- macros to replace ctype ones and avoid locale problems --*/
|
|
#define spacep(p) (*(p) == ' ' || *(p) == '\t')
|
|
#define digitp(p) (*(p) >= '0' && *(p) <= '9')
|
|
#define hexdigitp(a) (digitp (a) \
|
|
|| (*(a) >= 'A' && *(a) <= 'F') \
|
|
|| (*(a) >= 'a' && *(a) <= 'f'))
|
|
/* the atoi macros assume that the buffer has only valid digits */
|
|
#define atoi_1(p) (*(p) - '0' )
|
|
#define atoi_2(p) ((atoi_1(p) * 10) + atoi_1((p)+1))
|
|
#define atoi_4(p) ((atoi_2(p) * 100) + atoi_2((p)+2))
|
|
#define xtoi_1(p) (*(p) <= '9'? (*(p)- '0'): \
|
|
*(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
|
|
#define xtoi_2(p) ((xtoi_1(p) * 16) + xtoi_1((p)+1))
|
|
|
|
/******* RISC OS stuff ***********/
|
|
#ifdef __riscos__
|
|
int riscos_load_module(const char *name, const char * const path[], int fatal);
|
|
int riscos_get_filetype_from_string(const char *string, int len);
|
|
int riscos_get_filetype(const char *filename);
|
|
void riscos_set_filetype_by_number(const char *filename, int type);
|
|
void riscos_set_filetype_by_mimetype(const char *filename, const char *mimetype);
|
|
pid_t riscos_getpid(void);
|
|
int riscos_kill(pid_t pid, int sig);
|
|
int riscos_access(const char *path, int amode);
|
|
int riscos_getchar(void);
|
|
char *riscos_make_basename(const char *filepath, const char *inputpath);
|
|
int riscos_check_regexp(const char *exp, const char *string, int debug);
|
|
int riscos_fdopenfile(const char *filename, const int allow_write);
|
|
void riscos_close_fds(void);
|
|
int riscos_renamefile(const char *old, const char *new);
|
|
char *riscos_gstrans(const char *old);
|
|
void riscos_not_implemented(const char *feature);
|
|
#ifdef DEBUG
|
|
void riscos_dump_fdlist(void);
|
|
void riscos_list_openfiles(void);
|
|
#endif
|
|
#ifndef __RISCOS__C__
|
|
#define getpid riscos_getpid
|
|
#define kill(a,b) riscos_kill((a),(b))
|
|
#define access(a,b) riscos_access((a),(b))
|
|
#endif /* !__RISCOS__C__ */
|
|
#endif /* __riscos__ */
|
|
|
|
#endif /*G10_UTIL_H*/
|