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