2003-04-28 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / ops.h
1 /* ops.h - Internal operation support.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003 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 General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (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    General Public License for more details.
16  
17    You should have received a copy of the GNU General Public License
18    along with GPGME; if not, write to the Free Software Foundation,
19    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 #ifndef OPS_H
22 #define OPS_H
23
24 #include "gpgme.h"
25 #include "context.h"
26
27 /*-- gpgme.c --*/
28 void _gpgme_release_result (GpgmeCtx ctx);
29 void _gpgme_set_op_info (GpgmeCtx c, GpgmeData info);
30
31 /*-- wait.c --*/
32 GpgmeError _gpgme_wait_one (GpgmeCtx ctx);
33 GpgmeError _gpgme_wait_on_condition (GpgmeCtx ctx, volatile int *cond);
34
35 /*-- recipient.c --*/
36 int _gpgme_recipients_all_valid ( const GpgmeRecipients rset );
37
38
39 /*-- data.c and conversion.c --*/
40 char *        _gpgme_data_release_and_return_string ( GpgmeData dh );
41 char *        _gpgme_data_get_as_string ( GpgmeData dh );
42 GpgmeError    _gpgme_data_append ( GpgmeData dh,
43                                    const char *buffer, size_t length );
44 GpgmeError    _gpgme_data_append_string ( GpgmeData dh, const char *s );
45 GpgmeError    _gpgme_data_append_string_for_xml ( GpgmeData dh,
46                                                   const char *s);
47 GpgmeError    _gpgme_data_append_for_xml ( GpgmeData dh,
48                                            const char *buffer,
49                                            size_t len );
50 GpgmeError    _gpgme_data_append_percentstring_for_xml ( GpgmeData dh,
51                                                          const char *string );
52
53 GpgmeError _gpgme_data_inbound_handler (void *opaque, int fd);
54 GpgmeError _gpgme_data_outbound_handler (void *opaque, int fd);
55
56 /*-- key.c --*/
57 GpgmeError _gpgme_key_new ( GpgmeKey *r_key );
58 GpgmeError _gpgme_key_new_secret ( GpgmeKey *r_key );
59
60 \f
61 /* From op-support.c.  */
62
63 /* Find or create the op data object of type TYPE.  */
64 GpgmeError _gpgme_op_data_lookup (GpgmeCtx ctx, ctx_op_data_type type,
65                                   void **hook, int size,
66                                   void (*cleanup) (void *));
67
68 /* Prepare a new operation on CTX.  */
69 GpgmeError _gpgme_op_reset (GpgmeCtx ctx, int synchronous);
70
71 /* Parse the invalid user ID status line in ARGS and return the result
72    in USERID.  */
73 GpgmeError _gpgme_parse_inv_userid (char *args, GpgmeInvalidUserID *userid);
74
75 \f
76 /* From verify.c.  */
77 GpgmeError _gpgme_op_verify_init_result (GpgmeCtx ctx);
78 GpgmeError _gpgme_verify_status_handler (void *priv, GpgmeStatusCode code,
79                                          char *args);
80
81 \f
82 /* From decrypt.c.  */
83 GpgmeError _gpgme_op_decrypt_init_result (GpgmeCtx ctx);
84 GpgmeError _gpgme_decrypt_status_handler (void *priv, GpgmeStatusCode code,
85                                           char *args);
86
87 \f
88 /* From sign.c.  */
89
90 /* Create an initial op data object for signing.  Needs to be called
91    once before calling _gpgme_sign_status_handler.  */
92 GpgmeError _gpgme_op_sign_init_result (GpgmeCtx ctx);
93
94 /* Process a status line for signing operations.  */
95 GpgmeError _gpgme_sign_status_handler (void *priv, GpgmeStatusCode code,
96                                        char *args);
97
98 \f
99 /* From encrypt.c.  */
100
101 /* Create an initial op data object for encrypt.  Needs to be called
102    once before calling _gpgme_encrypt_status_handler.  */
103 GpgmeError _gpgme_op_encrypt_init_result (GpgmeCtx ctx);
104
105 /* Process a status line for encryption operations.  */
106 GpgmeError _gpgme_encrypt_status_handler (void *priv, GpgmeStatusCode code,
107                                           char *args);
108
109 \f
110 /*-- passphrase.c --*/
111 GpgmeError _gpgme_passphrase_status_handler (void *priv, GpgmeStatusCode code,
112                                              char *args);
113 GpgmeError _gpgme_passphrase_command_handler (void *opaque,
114                                               GpgmeStatusCode code,
115                                               const char *key, const char **result);
116
117 /*-- progress.c --*/
118 GpgmeError _gpgme_progress_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
119                                            char *args);
120
121 \f
122 /* From key-cache.c.  */
123
124 /* Acquire a reference to KEY and add it to the key cache.  */
125 void _gpgme_key_cache_add (GpgmeKey key);
126
127 /* Look up a key with fingerprint FPR in the key cache.  If such a key
128    is found, a reference is acquired for it and it is returned.
129    Otherwise, NULL is returned.  */
130 GpgmeKey _gpgme_key_cache_get (const char *fpr);
131
132 /*-- keylist.c --*/
133 void _gpgme_op_keylist_event_cb (void *data, GpgmeEventIO type, void *type_data);
134
135 /*-- trustlist.c --*/
136 void _gpgme_op_trustlist_event_cb (void *data, GpgmeEventIO type, void *type_data);
137
138 /*-- version.c --*/
139 const char *_gpgme_compare_versions (const char *my_version,
140                                      const char *req_version);
141 char *_gpgme_get_program_version (const char *const path);
142
143
144 #endif /* OPS_H */