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