doc/
[gpgme.git] / gpgme / ops.h
1 /* ops.h - Internal operation support.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004 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 void _gpgme_release_result (gpgme_ctx_t ctx);
31
32 \f
33 /* From wait.c.  */
34 gpgme_error_t _gpgme_wait_one (gpgme_ctx_t ctx);
35 gpgme_error_t _gpgme_wait_on_condition (gpgme_ctx_t ctx, volatile int *cond);
36
37 \f
38 /* From data.c.  */
39 gpgme_error_t _gpgme_data_inbound_handler (void *opaque, int fd);
40 gpgme_error_t _gpgme_data_outbound_handler (void *opaque, int fd);
41
42 \f
43 /* From op-support.c.  */
44
45 /* Find or create the op data object of type TYPE.  */
46 gpgme_error_t _gpgme_op_data_lookup (gpgme_ctx_t ctx, ctx_op_data_id_t type,
47                                      void **hook, int size,
48                                      void (*cleanup) (void *));
49
50 /* Prepare a new operation on CTX.  */
51 gpgme_error_t _gpgme_op_reset (gpgme_ctx_t ctx, int synchronous);
52
53 /* Parse the INV_RECP status line in ARGS and return the result in
54    KEY.  */
55 gpgme_error_t _gpgme_parse_inv_recp (char *args, gpgme_invalid_key_t *key);
56
57 /* Parse the PLAINTEXT status line in ARGS and return the result in
58    FILENAMEP.  */
59 gpgme_error_t _gpgme_parse_plaintext (char *args, char **filenamep);
60
61
62 \f
63 /* From verify.c.  */
64 gpgme_error_t _gpgme_op_verify_init_result (gpgme_ctx_t ctx);
65 gpgme_error_t _gpgme_verify_status_handler (void *priv,
66                                             gpgme_status_code_t code,
67                                             char *args);
68
69 \f
70 /* From decrypt.c.  */
71 gpgme_error_t _gpgme_op_decrypt_init_result (gpgme_ctx_t ctx);
72 gpgme_error_t _gpgme_decrypt_status_handler (void *priv,
73                                              gpgme_status_code_t code,
74                                              char *args);
75
76 \f
77 /* From sign.c.  */
78
79 /* Create an initial op data object for signing.  Needs to be called
80    once before calling _gpgme_sign_status_handler.  */
81 gpgme_error_t _gpgme_op_sign_init_result (gpgme_ctx_t ctx);
82
83 /* Process a status line for signing operations.  */
84 gpgme_error_t _gpgme_sign_status_handler (void *priv,
85                                           gpgme_status_code_t code,
86                                           char *args);
87
88 \f
89 /* From encrypt.c.  */
90
91 /* Create an initial op data object for encrypt.  Needs to be called
92    once before calling _gpgme_encrypt_status_handler.  */
93 gpgme_error_t _gpgme_op_encrypt_init_result (gpgme_ctx_t ctx);
94
95 /* Process a status line for encryption operations.  */
96 gpgme_error_t _gpgme_encrypt_status_handler (void *priv,
97                                              gpgme_status_code_t code,
98                                              char *args);
99
100 \f
101 /* From passphrase.c.  */
102 gpgme_error_t _gpgme_passphrase_status_handler (void *priv,
103                                                 gpgme_status_code_t code,
104                                                 char *args);
105 gpgme_error_t _gpgme_passphrase_command_handler (void *opaque,
106                                                  gpgme_status_code_t code,
107                                                  const char *key, int fd);
108 gpgme_error_t _gpgme_passphrase_command_handler_internal (void *opaque,
109                                                  gpgme_status_code_t code,
110                                                  const char *key, int fd,
111                                                  int *processed);
112
113 \f
114 /* From progress.c.  */
115 gpgme_error_t _gpgme_progress_status_handler (void *priv,
116                                               gpgme_status_code_t code,
117                                               char *args);
118
119 \f
120 /* From key.c.  */
121 gpgme_error_t _gpgme_key_new (gpgme_key_t *r_key);
122 gpgme_error_t _gpgme_key_add_subkey (gpgme_key_t key,
123                                      gpgme_subkey_t *r_subkey);
124 gpgme_error_t _gpgme_key_append_name (gpgme_key_t key, char *src);
125 gpgme_key_sig_t _gpgme_key_add_sig (gpgme_key_t key, char *src);
126
127 \f
128 /* From keylist.c.  */
129 void _gpgme_op_keylist_event_cb (void *data, gpgme_event_io_t type,
130                                  void *type_data);
131
132 \f
133 /* From trust-item.c.  */
134
135 /* Create a new trust item.  */
136 gpgme_error_t _gpgme_trust_item_new (gpgme_trust_item_t *r_item);
137
138 \f
139 /* From trustlist.c.  */
140 void _gpgme_op_trustlist_event_cb (void *data, gpgme_event_io_t type,
141                                    void *type_data);
142
143 \f
144 /*-- version.c --*/
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 #endif /* OPS_H */