json: Add additional commands to help
[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 KEY_CONSIDERED status line.  */
61 gpgme_error_t _gpgme_parse_key_considered (const char *args,
62                                            char **r_fpr, unsigned int *r_flags);
63
64 /* Parse the INV_RECP status line in ARGS and return the result in
65    KEY.  */
66 gpgme_error_t _gpgme_parse_inv_recp (char *args, int for_signing,
67                                      const char *kc_fpr, unsigned int kc_flags,
68                                      gpgme_invalid_key_t *key);
69
70 /* Parse the PLAINTEXT status line in ARGS and return the result in
71    FILENAMEP and R_MIME.  */
72 gpgme_error_t _gpgme_parse_plaintext (char *args, char **filenamep,int *r_mime);
73
74 /* Parse a FAILURE status line and return the error code.  ARGS is
75    modified to contain the location part.  */
76 gpgme_error_t _gpgme_parse_failure (char *args);
77
78
79 \f
80 /* From verify.c.  */
81 gpgme_error_t _gpgme_op_verify_init_result (gpgme_ctx_t ctx);
82 gpgme_error_t _gpgme_verify_status_handler (void *priv,
83                                             gpgme_status_code_t code,
84                                             char *args);
85
86 \f
87 /* From decrypt.c.  */
88 gpgme_error_t _gpgme_op_decrypt_init_result (gpgme_ctx_t ctx);
89 gpgme_error_t _gpgme_decrypt_status_handler (void *priv,
90                                              gpgme_status_code_t code,
91                                              char *args);
92 gpgme_error_t _gpgme_decrypt_start (gpgme_ctx_t ctx, int synchronous,
93                                     gpgme_decrypt_flags_t flags,
94                                     gpgme_data_t cipher, gpgme_data_t plain);
95
96 \f
97 /* From signers.c.  */
98 void _gpgme_signers_clear (gpgme_ctx_t ctx);
99
100 /* From sign.c.  */
101
102 /* Create an initial op data object for signing.  Needs to be called
103    once before calling _gpgme_sign_status_handler.  */
104 gpgme_error_t _gpgme_op_sign_init_result (gpgme_ctx_t ctx);
105
106 /* Process a status line for signing operations.  */
107 gpgme_error_t _gpgme_sign_status_handler (void *priv,
108                                           gpgme_status_code_t code,
109                                           char *args);
110
111 \f
112 /* From encrypt.c.  */
113
114 /* Create an initial op data object for encrypt.  Needs to be called
115    once before calling _gpgme_encrypt_status_handler.  */
116 gpgme_error_t _gpgme_op_encrypt_init_result (gpgme_ctx_t ctx);
117
118 /* Process a status line for encryption operations.  */
119 gpgme_error_t _gpgme_encrypt_status_handler (void *priv,
120                                              gpgme_status_code_t code,
121                                              char *args);
122
123 \f
124 /* From passphrase.c.  */
125 gpgme_error_t _gpgme_passphrase_status_handler (void *priv,
126                                                 gpgme_status_code_t code,
127                                                 char *args);
128 gpgme_error_t _gpgme_passphrase_command_handler (void *opaque,
129                                                  gpgme_status_code_t code,
130                                                  const char *key, int fd,
131                                                  int *processed);
132
133 \f
134 /* From progress.c.  */
135 gpgme_error_t _gpgme_progress_status_handler (void *priv,
136                                               gpgme_status_code_t code,
137                                               char *args);
138
139 \f
140 /* From key.c.  */
141 gpgme_error_t _gpgme_key_new (gpgme_key_t *r_key);
142 gpgme_error_t _gpgme_key_add_subkey (gpgme_key_t key,
143                                      gpgme_subkey_t *r_subkey);
144 gpgme_error_t _gpgme_key_append_name (gpgme_key_t key,
145                                       const char *src, int convert);
146 gpgme_key_sig_t _gpgme_key_add_sig (gpgme_key_t key, char *src);
147
148
149 \f
150 /* From keylist.c.  */
151 void _gpgme_op_keylist_event_cb (void *data, gpgme_event_io_t type,
152                                  void *type_data);
153
154 \f
155 /* From trust-item.c.  */
156
157 /* Create a new trust item.  */
158 gpgme_error_t _gpgme_trust_item_new (gpgme_trust_item_t *r_item);
159
160 \f
161 /* From trustlist.c.  */
162 void _gpgme_op_trustlist_event_cb (void *data, gpgme_event_io_t type,
163                                    void *type_data);
164
165 \f
166 /* From version.c.  */
167
168 /* Return true if MY_VERSION is at least REQ_VERSION, and false
169    otherwise.  */
170 int _gpgme_compare_versions (const char *my_version,
171                              const char *req_version);
172 char *_gpgme_get_program_version (const char *const path);
173
174 \f
175 /* From sig-notation.c.  */
176
177 /* Create a new, empty signature notation data object.  */
178 gpgme_error_t _gpgme_sig_notation_create (gpgme_sig_notation_t *notationp,
179                                           const char *name, int name_len,
180                                           const char *value, int value_len,
181                                           gpgme_sig_notation_flags_t flags);
182
183 /* Free the signature notation object and all associated resources.
184    The object must already be removed from any linked list as the next
185    pointer is ignored.  */
186 void _gpgme_sig_notation_free (gpgme_sig_notation_t notation);
187
188 /* Parse a notation or policy URL subpacket.  If the packet type is
189    not known, return no error but NULL in NOTATION.  */
190 gpgme_error_t _gpgme_parse_notation (gpgme_sig_notation_t *notationp,
191                                      int type, int pkflags, int len,
192                                      char *data);
193
194 #endif /* OPS_H */