2009-10-22 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / src / util.h
1 /* util.h 
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005 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 const char *_gpgme_get_gpgconf_path (void);
35 const char *_gpgme_get_g13_path (void);
36 int _gpgme_get_conf_int (const char *key, int *value);
37 void _gpgme_allow_set_foreground_window (pid_t pid);
38
39 /*-- dirinfo.c --*/
40 const char *_gpgme_get_default_homedir (void);
41 const char *_gpgme_get_default_agent_socket (void);
42
43
44 \f
45 /*-- replacement functions in <funcname>.c --*/
46 #ifdef HAVE_CONFIG_H
47
48 #ifndef HAVE_STPCPY
49 static _GPGME_INLINE char *
50 _gpgme_stpcpy (char *a, const char *b)
51 {
52   while (*b)
53     *a++ = *b++;
54   *a = 0;
55   return a;
56 }
57 #define stpcpy(a,b) _gpgme_stpcpy ((a), (b))
58 #endif /*!HAVE_STPCPY*/
59
60 #if !HAVE_VASPRINTF
61 #include <stdarg.h>
62 int vasprintf (char **result, const char *format, va_list args);
63 int asprintf (char **result, const char *format, ...);
64 #endif
65
66 #ifndef HAVE_TTYNAME_R
67 int ttyname_r (int fd, char *buf, size_t buflen);
68 #endif
69 #endif
70
71 \f
72 /*-- conversion.c --*/
73 /* Convert two hexadecimal digits from STR to the value they
74    represent.  Returns -1 if one of the characters is not a
75    hexadecimal digit.  */
76 int _gpgme_hextobyte (const char *str);
77
78 /* Decode the C formatted string SRC and store the result in the
79    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
80    large enough buffer is allocated with malloc and *DESTP is set to
81    the result.  Currently, LEN is only used to specify if allocation
82    is desired or not, the caller is expected to make sure that *DESTP
83    is large enough if LEN is not zero.  */
84 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
85                                       size_t len);
86
87 /* Decode the percent escaped string SRC and store the result in the
88    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
89    large enough buffer is allocated with malloc and *DESTP is set to
90    the result.  Currently, LEN is only used to specify if allocation
91    is desired or not, the caller is expected to make sure that *DESTP
92    is large enough if LEN is not zero.  If BINARY is 1, then '\0'
93    characters are allowed in the output.  */
94 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
95                                             size_t len, int binary);
96
97 gpgme_error_t _gpgme_encode_percent_string (const char *src, char **destp,
98                                             size_t len);
99
100
101 /* Parse the string TIMESTAMP into a time_t.  The string may either be
102    seconds since Epoch or in the ISO 8601 format like
103    "20390815T143012".  Returns 0 for an empty string or seconds since
104    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
105    point to the next non-parsed character in TIMESTRING. */
106 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
107
108
109 gpgme_error_t _gpgme_map_gnupg_error (char *err);
110
111 \f
112 /* Retrieve the environment variable NAME and return a copy of it in a
113    malloc()'ed buffer in *VALUE.  If the environment variable is not
114    set, return NULL in *VALUE.  */
115 gpgme_error_t _gpgme_getenv (const char *name, char **value);
116
117 \f
118 #ifdef HAVE_W32_SYSTEM
119 int _gpgme_mkstemp (int *fd, char **name);
120 const char *_gpgme_get_w32spawn_path (void);
121 #endif
122
123 /*--  Error codes not yet available in current gpg-error.h.   --*/
124 #ifndef GPG_ERR_UNFINISHED
125 #define GPG_ERR_UNFINISHED 199
126 #endif
127 #ifndef GPG_ERR_NOT_OPERATIONAL 
128 #define GPG_ERR_NOT_OPERATIONAL 176
129 #endif
130
131 \f
132 #ifdef ENABLE_ASSUAN
133 #include <assuan.h>
134 /* System hooks for assuan integration.  */
135 extern struct assuan_system_hooks _gpgme_assuan_system_hooks;
136 extern struct assuan_malloc_hooks _gpgme_assuan_malloc_hooks;
137 int _gpgme_assuan_log_cb (assuan_context_t ctx, void *hook,
138                           unsigned int cat, const char *msg);
139 #endif
140
141 #endif /* UTIL_H */