Merge branch 'master' into justus/pyme3
[gpgme.git] / src / ops.h
1 /* ops.h - Internal operation support.
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 OPS_H
23 #define OPS_H
24
25 #include "gpgme.h"
26 #include "context.h"
27
28 \f
29 /* From gpgme.c.  */
30 gpgme_error_t _gpgme_cancel_with_err (gpgme_ctx_t ctx, gpg_error_t ctx_err,
31                                       gpg_error_t op_err);
32 /* Clear all notation data from the context.  */
33 void _gpgme_sig_notation_clear (gpgme_ctx_t ctx);
34
35 void _gpgme_release_result (gpgme_ctx_t ctx);
36
37 \f
38 /* From wait.c.  */
39 gpgme_error_t _gpgme_wait_one (gpgme_ctx_t ctx);
40 gpgme_error_t _gpgme_wait_one_ext (gpgme_ctx_t ctx, gpgme_error_t *op_err);
41 gpgme_error_t _gpgme_wait_on_condition (gpgme_ctx_t ctx, volatile int *cond,
42                                         gpgme_error_t *op_err);
43
44 \f
45 /* From data.c.  */
46 gpgme_error_t _gpgme_data_inbound_handler (void *opaque, int fd);
47 gpgme_error_t _gpgme_data_outbound_handler (void *opaque, int fd);
48
49 \f
50 /* From op-support.c.  */
51
52 /* Find or create the op data object of type TYPE.  */
53 gpgme_error_t _gpgme_op_data_lookup (gpgme_ctx_t ctx, ctx_op_data_id_t type,
54                                      void **hook, int size,
55                                      void (*cleanup) (void *));
56
57 /* Prepare a new operation on CTX.  */
58 gpgme_error_t _gpgme_op_reset (gpgme_ctx_t ctx, int synchronous);
59
60 /* Parse the INV_RECP status line in ARGS and return the result in
61    KEY.  */
62 gpgme_error_t _gpgme_parse_inv_recp (char *args, gpgme_invalid_key_t *key);
63
64 /* Parse the PLAINTEXT status line in ARGS and return the result in
65    FILENAMEP.  */
66 gpgme_error_t _gpgme_parse_plaintext (char *args, char **filenamep);
67
68 /* Parse a FAILURE status line and return the error code.  ARGS is
69    modified to contain the location part.  */
70 gpgme_error_t _gpgme_parse_failure (char *args);
71
72
73 \f
74 /* From verify.c.  */
75 gpgme_error_t _gpgme_op_verify_init_result (gpgme_ctx_t ctx);
76 gpgme_error_t _gpgme_verify_status_handler (void *priv,
77                                             gpgme_status_code_t code,
78                                             char *args);
79
80 \f
81 /* From decrypt.c.  */
82 gpgme_error_t _gpgme_op_decrypt_init_result (gpgme_ctx_t ctx);
83 gpgme_error_t _gpgme_decrypt_status_handler (void *priv,
84                                              gpgme_status_code_t code,
85                                              char *args);
86
87 \f
88 /* From signers.c.  */
89 void _gpgme_signers_clear (gpgme_ctx_t ctx);
90
91 /* From sign.c.  */
92
93 /* Create an initial op data object for signing.  Needs to be called
94    once before calling _gpgme_sign_status_handler.  */
95 gpgme_error_t _gpgme_op_sign_init_result (gpgme_ctx_t ctx);
96
97 /* Process a status line for signing operations.  */
98 gpgme_error_t _gpgme_sign_status_handler (void *priv,
99                                           gpgme_status_code_t code,
100                                           char *args);
101
102 \f
103 /* From encrypt.c.  */
104
105 /* Create an initial op data object for encrypt.  Needs to be called
106    once before calling _gpgme_encrypt_status_handler.  */
107 gpgme_error_t _gpgme_op_encrypt_init_result (gpgme_ctx_t ctx);
108
109 /* Process a status line for encryption operations.  */
110 gpgme_error_t _gpgme_encrypt_status_handler (void *priv,
111                                              gpgme_status_code_t code,
112                                              char *args);
113
114 \f
115 /* From passphrase.c.  */
116 gpgme_error_t _gpgme_passphrase_status_handler (void *priv,
117                                                 gpgme_status_code_t code,
118                                                 char *args);
119 gpgme_error_t _gpgme_passphrase_command_handler (void *opaque,
120                                                  gpgme_status_code_t code,
121                                                  const char *key, int fd,
122                                                  int *processed);
123
124 \f
125 /* From progress.c.  */
126 gpgme_error_t _gpgme_progress_status_handler (void *priv,
127                                               gpgme_status_code_t code,
128                                               char *args);
129
130 \f
131 /* From key.c.  */
132 gpgme_error_t _gpgme_key_new (gpgme_key_t *r_key);
133 gpgme_error_t _gpgme_key_add_subkey (gpgme_key_t key,
134                                      gpgme_subkey_t *r_subkey);
135 gpgme_error_t _gpgme_key_append_name (gpgme_key_t key, const char *src, int convert);
136 gpgme_key_sig_t _gpgme_key_add_sig (gpgme_key_t key, char *src);
137
138 \f
139 /* From keylist.c.  */
140 void _gpgme_op_keylist_event_cb (void *data, gpgme_event_io_t type,
141                                  void *type_data);
142
143 \f
144 /* From trust-item.c.  */
145
146 /* Create a new trust item.  */
147 gpgme_error_t _gpgme_trust_item_new (gpgme_trust_item_t *r_item);
148
149 \f
150 /* From trustlist.c.  */
151 void _gpgme_op_trustlist_event_cb (void *data, gpgme_event_io_t type,
152                                    void *type_data);
153
154 \f
155 /* From version.c.  */
156
157 /* Return true if MY_VERSION is at least REQ_VERSION, and false
158    otherwise.  */
159 int _gpgme_compare_versions (const char *my_version,
160                              const char *req_version);
161 char *_gpgme_get_program_version (const char *const path);
162
163 \f
164 /* From sig-notation.c.  */
165
166 /* Create a new, empty signature notation data object.  */
167 gpgme_error_t _gpgme_sig_notation_create (gpgme_sig_notation_t *notationp,
168                                           const char *name, int name_len,
169                                           const char *value, int value_len,
170                                           gpgme_sig_notation_flags_t flags);
171
172 /* Free the signature notation object and all associated resources.
173    The object must already be removed from any linked list as the next
174    pointer is ignored.  */
175 void _gpgme_sig_notation_free (gpgme_sig_notation_t notation);
176
177 /* Parse a notation or policy URL subpacket.  If the packet type is
178    not known, return no error but NULL in NOTATION.  */
179 gpgme_error_t _gpgme_parse_notation (gpgme_sig_notation_t *notationp,
180                                      int type, int pkflags, int len,
181                                      char *data);
182
183 #endif /* OPS_H */