Add global flags disable-gpgconf, gpgconf-name, and gpg-name.
[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 #ifdef HAVE_W32_SYSTEM
26 # ifdef HAVE_W32CE_SYSTEM
27 #  include "w32-ce.h"
28 # else
29 #  include "winsock2.h"
30 #  include "windows.h"
31 # endif
32 #endif
33
34 /* For pid_t.  */
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
37 #endif
38 /* We must see the symbol ttyname_r before a redefinition. */
39 #ifdef HAVE_UNISTD_H
40 # include <unistd.h>
41 #endif
42
43 #include "gpgme.h"
44
45 \f
46 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
47
48 \f
49 /*-- {posix,w32}-util.c --*/
50 int _gpgme_get_conf_int (const char *key, int *value);
51 void _gpgme_allow_set_foreground_window (pid_t pid);
52
53 /*-- dirinfo.c --*/
54 void _gpgme_dirinfo_disable_gpgconf (void);
55
56 const char *_gpgme_get_default_homedir (void);
57 const char *_gpgme_get_default_agent_socket (void);
58 const char *_gpgme_get_default_gpg_name (void);
59 const char *_gpgme_get_default_gpgsm_name (void);
60 const char *_gpgme_get_default_g13_name (void);
61 const char *_gpgme_get_default_gpgconf_name (void);
62 const char *_gpgme_get_default_uisrv_socket (void);
63
64
65 \f
66 /*-- replacement functions in <funcname>.c --*/
67 #ifdef HAVE_CONFIG_H
68
69 #ifndef HAVE_STPCPY
70 static _GPGME_INLINE char *
71 _gpgme_stpcpy (char *a, const char *b)
72 {
73   while (*b)
74     *a++ = *b++;
75   *a = 0;
76   return a;
77 }
78 #define stpcpy(a,b) _gpgme_stpcpy ((a), (b))
79 #endif /*!HAVE_STPCPY*/
80
81 #if !HAVE_VASPRINTF
82 #include <stdarg.h>
83 int vasprintf (char **result, const char *format, va_list args);
84 int asprintf (char **result, const char *format, ...);
85 #endif
86
87 #if REPLACE_TTYNAME_R
88 int _gpgme_ttyname_r (int fd, char *buf, size_t buflen);
89 #undef  ttyname_r
90 #define ttyname_r(a,b,c) _gpgme_ttyname_r ((a), (b), (c))
91 #endif
92
93 #endif /*HAVE_CONFIG_H*/
94
95 \f
96 /*-- conversion.c --*/
97 /* Convert two hexadecimal digits from STR to the value they
98    represent.  Returns -1 if one of the characters is not a
99    hexadecimal digit.  */
100 int _gpgme_hextobyte (const char *str);
101
102 /* Decode the C formatted string SRC and store the result in the
103    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
104    large enough buffer is allocated with malloc and *DESTP is set to
105    the result.  Currently, LEN is only used to specify if allocation
106    is desired or not, the caller is expected to make sure that *DESTP
107    is large enough if LEN is not zero.  */
108 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
109                                       size_t len);
110
111 /* Decode the percent escaped string SRC and store the result in the
112    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
113    large enough buffer is allocated with malloc and *DESTP is set to
114    the result.  Currently, LEN is only used to specify if allocation
115    is desired or not, the caller is expected to make sure that *DESTP
116    is large enough if LEN is not zero.  If BINARY is 1, then '\0'
117    characters are allowed in the output.  */
118 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
119                                             size_t len, int binary);
120
121 gpgme_error_t _gpgme_encode_percent_string (const char *src, char **destp,
122                                             size_t len);
123
124
125 /* Parse the string TIMESTAMP into a time_t.  The string may either be
126    seconds since Epoch or in the ISO 8601 format like
127    "20390815T143012".  Returns 0 for an empty string or seconds since
128    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
129    point to the next non-parsed character in TIMESTRING. */
130 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
131
132
133 gpgme_error_t _gpgme_map_gnupg_error (char *err);
134
135 \f
136 /* Retrieve the environment variable NAME and return a copy of it in a
137    malloc()'ed buffer in *VALUE.  If the environment variable is not
138    set, return NULL in *VALUE.  */
139 gpgme_error_t _gpgme_getenv (const char *name, char **value);
140
141 \f
142 /*-- status-table.c --*/
143 /* Convert a status string to a status code.  */
144 void _gpgme_status_init (void);
145 gpgme_status_code_t _gpgme_parse_status (const char *name);
146
147 \f
148 #ifdef HAVE_W32_SYSTEM
149 int _gpgme_mkstemp (int *fd, char **name);
150 const char *_gpgme_get_w32spawn_path (void);
151 #endif /*HAVE_W32_SYSTEM*/
152 #ifdef HAVE_W32CE_SYSTEM
153 char *_gpgme_w32ce_get_debug_envvar (void);
154 #endif /*HAVE_W32CE_SYSTEM*/
155
156
157 \f
158 #include <assuan.h>
159 /* System hooks for assuan integration.  */
160 extern struct assuan_system_hooks _gpgme_assuan_system_hooks;
161 extern struct assuan_malloc_hooks _gpgme_assuan_malloc_hooks;
162 int _gpgme_assuan_log_cb (assuan_context_t ctx, void *hook,
163                           unsigned int cat, const char *msg);
164
165 #endif /* UTIL_H */