2005-04-14 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / util.h
1 /* util.h 
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004 g10 Code GmbH
4
5    This file is part of GPGME.
6  
7    GPGME is free software; you can redistribute it and/or modify it
8    under the terms of the GNU Lesser General Public License as
9    published by the Free Software Foundation; either version 2.1 of
10    the License, or (at your option) any later version.
11    
12    GPGME is distributed in the hope that it will be useful, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16    
17    You should have received a copy of the GNU Lesser General Public
18    License along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #ifndef UTIL_H
23 #define UTIL_H
24
25 #include "gpgme.h"
26
27 \f
28 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
29
30 \f
31 /*-- {posix,w32}-util.c --*/
32 const char *_gpgme_get_gpg_path (void);
33 const char *_gpgme_get_gpgsm_path (void);
34
35 \f
36 /*-- replacement functions in <funcname>.c --*/
37 #ifdef HAVE_CONFIG_H
38 #ifndef HAVE_STPCPY
39 char *stpcpy (char *a, const char *b);
40 #endif
41
42 #if !HAVE_VASPRINTF
43 #include <stdarg.h>
44 int vasprintf (char **result, const char *format, va_list args);
45 int asprintf (char **result, const char *format, ...);
46 #endif
47
48 #ifndef HAVE_TTYNAME_R
49 int ttyname_r (int fd, char *buf, size_t buflen);
50 #endif
51 #endif
52
53 \f
54 /*-- conversion.c --*/
55 /* Convert two hexadecimal digits from STR to the value they
56    represent.  Returns -1 if one of the characters is not a
57    hexadecimal digit.  */
58 int _gpgme_hextobyte (const char *str);
59
60 /* Decode the C formatted string SRC and store the result in the
61    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
62    large enough buffer is allocated with malloc and *DESTP is set to
63    the result.  Currently, LEN is only used to specify if allocation
64    is desired or not, the caller is expected to make sure that *DESTP
65    is large enough if LEN is not zero.  */
66 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
67                                       size_t len);
68
69 /* Decode the percent escaped string SRC and store the result in the
70    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
71    large enough buffer is allocated with malloc and *DESTP is set to
72    the result.  Currently, LEN is only used to specify if allocation
73    is desired or not, the caller is expected to make sure that *DESTP
74    is large enough if LEN is not zero.  */
75 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
76                                             size_t len);
77
78
79 /* Parse the string TIMESTAMP into a time_t.  The string may either be
80    seconds since Epoch or in the ISO 8601 format like
81    "20390815T143012".  Returns 0 for an empty string or seconds since
82    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
83    point to the next non-parsed character in TIMESTRING. */
84 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
85
86
87 gpgme_error_t _gpgme_map_gnupg_error (char *err);
88
89 \f
90 /* Retrieve the environment variable NAME and return a copy of it in a
91    malloc()'ed buffer in *VALUE.  If the environment variable is not
92    set, return NULL in *VALUE.  */
93 gpgme_error_t _gpgme_getenv (const char *name, char **value);
94
95 #endif /* UTIL_H */