Take advantage of newer gpg-error features.
[gnupg.git] / common / util.h
index b9ffe65..92b88aa 100644 (file)
@@ -15,7 +15,8 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ * USA.
  */
 
 #ifndef GNUPG_COMMON_UTIL_H
 
 #include <gcrypt.h> /* We need this for the memory function protos. */
 #include <time.h>   /* We need time_t. */
-#include <gpg-error.h> /* we need gpg-error_t. */
+#include <errno.h>  /* We need errno.  */
+#include <gpg-error.h> /* We need gpg_error_t. */
 
-/* to pass hash functions to libksba we need to cast it */
+/* Common GNUlib includes (-I ../gl/). */
+#include "strpbrk.h"
+#include "strsep.h"
+#include "vasprintf.h"
+
+
+/* Hash function used with libksba. */
 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
 
 /* get all the stuff from jnlib */
 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
 #define xstrdup(a)       gcry_xstrdup ((a))
 
+/* For compatibility with gpg 1.4 we also define these: */
+#define xmalloc_clear(a) gcry_xcalloc (1, (a))
+#define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
+
+/* Convenience function to return a gpg-error code for memory
+   allocation failures.  This function makes sure that an error will
+   be returned even if accidently ERRNO is not set.  */
+static inline gpg_error_t
+out_of_core (void)
+{
+  return gpg_error_from_syserror ();
+}
 
 /* A type to hold the ISO time.  Note that this this is the same as
    the the KSBA type ksba_isotime_t. */
 typedef char gnupg_isotime_t[16];
 
 
-/*-- maperror.c --*/
-int map_kbx_err (int err);
-gpg_error_t map_assuan_err (int err);
-int map_to_assuan_status (int rc);
-
 /*-- gettime.c --*/
 time_t gnupg_get_time (void);
 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
@@ -74,6 +89,7 @@ u32    scan_isodatestr (const char *string);
 u32    add_days_to_timestamp (u32 stamp, u16 days);
 const char *strtimevalue (u32 stamp);
 const char *strtimestamp (u32 stamp); /* GMT */
+const char *isotimestamp (u32 stamp); /* GMT */
 const char *asctimestamp (u32 stamp); /* localized */
 
 
@@ -98,6 +114,7 @@ void gnupg_unblock_all_signals (void);
 int answer_is_yes (const char *s);
 int answer_is_yes_no_default (const char *s, int def_answer);
 int answer_is_yes_no_quit (const char *s);
+int answer_is_okay_cancel (const char *s, int def_answer);
 
 /*-- xreadline.c --*/
 ssize_t read_line (FILE *fp, 
@@ -120,6 +137,16 @@ gpg_error_t b64enc_write (struct b64state *state,
                           const void *buffer, size_t nbytes);
 gpg_error_t b64enc_finish (struct b64state *state);
 
+/*-- sexputil.c */
+gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
+                                     unsigned char *grip);
+int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
+unsigned char *make_simple_sexp_from_hexstr (const char *line,
+                                             size_t *nscanned);
+
+/*-- homedir.c --*/
+const char *default_homedir (void);
+
 
 /*-- miscellaneous.c --*/
 
@@ -127,27 +154,42 @@ gpg_error_t b64enc_finish (struct b64state *state);
    freed using xfree.  This function simply dies on memory failure,
    thus no extra check is required. */
 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
+/* Same as asprintf but return an allocated buffer suitable to be
+   freed using xfree.  This function returns NULL on memory failure and
+   sets errno. */
+char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
 
 const char *print_fname_stdout (const char *s);
 const char *print_fname_stdin (const char *s);
 void print_string (FILE *fp, const byte *p, size_t n, int delim);
 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
 void print_utf8_string (FILE *fp, const byte *p, size_t n);
-char *make_printable_string (const byte *p, size_t n, int delim);
+char *make_printable_string (const void *p, size_t n, int delim);
 
 int is_file_compressed (const char *s, int *ret_rc);
 
+int match_multistr (const char *multistr,const char *match);
 
-/*-- replacement functions from funcname.c --*/
-#if !HAVE_VASPRINTF
-#include <stdarg.h>
-int vasprintf (char **result, const char *format, va_list args);
-int asprintf (char **result, const char *format, ...) JNLIB_GCC_A_PRINTF(2,3);
-#endif
 
+/*-- Simple replacement functions. */
+#ifndef HAVE_TTYNAME
+/* Systems without ttyname (W32) will merely return NULL. */
+static inline char *
+ttyname (int fd) 
+{
+  return NULL
+};
+#endif /* !HAVE_TTYNAME */
 
+#ifndef HAVE_ISASCII
+static inline int 
+isascii (int c)
+{
+  return (((c) & ~0x7f) == 0);
+}
+#endif /* !HAVE_ISASCII */
 
-/*-- some macros to replace ctype ones and avoid locale problems --*/
+/*-- Macros to replace ctype ones to avoid locale problems. --*/
 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
 #define hexdigitp(a) (digitp (a)                     \