common: Add function print_assuan_status.
[gnupg.git] / common / asshelp.h
1 /* asshelp.h - Helper functions for Assuan
2  *      Copyright (C) 2004, 2007 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef GNUPG_COMMON_ASSHELP_H
21 #define GNUPG_COMMON_ASSHELP_H
22
23 #include <assuan.h>
24 #include <gpg-error.h>
25
26 #include "session-env.h"
27
28 /*-- asshelp.c --*/
29
30 void setup_libassuan_logging (unsigned int *debug_var_address);
31 void set_libassuan_log_cats (unsigned int newcats);
32
33
34 gpg_error_t
35 send_pinentry_environment (assuan_context_t ctx,
36                            gpg_err_source_t errsource,
37                            const char *opt_lc_ctype,
38                            const char *opt_lc_messages,
39                            session_env_t session_env);
40
41 /* This fucntion is used by the call-agent.c modules to fire up a new
42    agent.  */
43 gpg_error_t
44 start_new_gpg_agent (assuan_context_t *r_ctx,
45                      gpg_err_source_t errsource,
46                      const char *homedir,
47                      const char *agent_program,
48                      const char *opt_lc_ctype,
49                      const char *opt_lc_messages,
50                      session_env_t session_env,
51                      int verbose, int debug,
52                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
53                      ctrl_t status_cb_arg);
54
55 /* This function is used to connect to the dirmngr.  On some platforms
56    the function is able starts a dirmngr process if needed.  */
57 gpg_error_t
58 start_new_dirmngr (assuan_context_t *r_ctx,
59                    gpg_err_source_t errsource,
60                    const char *homedir,
61                    const char *dirmngr_program,
62                    int verbose, int debug,
63                    gpg_error_t (*status_cb)(ctrl_t, int, ...),
64                    ctrl_t status_cb_arg);
65
66
67 /*-- asshelp2.c --*/
68
69 /* Helper function to print an assuan status line using a printf
70    format string.  */
71 gpg_error_t print_assuan_status (assuan_context_t ctx,
72                                  const char *keyword,
73                                  const char *format,
74                                  ...) JNLIB_GCC_A_PRINTF(3,4);
75
76
77 #endif /*GNUPG_COMMON_ASSHELP_H*/