2003-01-19 Miguel Coca <mcoca@gnu.org>
[gpgme.git] / gpgme / ops.h
1 /* ops.h - internal operations stuff 
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002 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 General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (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    General Public License for more details.
16  
17    You should have received a copy of the GNU General Public License
18    along with GPGME; if not, write to the Free Software Foundation,
19    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 #ifndef OPS_H
22 #define OPS_H
23
24 #include "types.h"
25
26 /* Support macros.  */
27
28 #define test_and_allocate_result(ctx,field) \
29   do \
30     { \
31       if (!ctx->result.field) \
32         { \
33           ctx->result.field = calloc (1, sizeof *ctx->result.field); \
34           if (!ctx->result.field) \
35             { \
36               ctx->error = mk_error (Out_Of_Core); \
37               return; \
38             } \
39         } \
40     } \
41   while (0)
42
43 /*-- gpgme.c --*/
44 void _gpgme_release_result ( GpgmeCtx c );
45 void _gpgme_set_op_info (GpgmeCtx c, GpgmeData info);
46
47 void _gpgme_op_event_cb (void *data, GpgmeEventIO type, void *type_data);
48 void _gpgme_op_event_cb_user (void *data, GpgmeEventIO type, void *type_data);
49
50 /*-- wait.c --*/
51 GpgmeError _gpgme_wait_one (GpgmeCtx ctx);
52 GpgmeError _gpgme_wait_on_condition (GpgmeCtx ctx, volatile int *cond);
53
54 /*-- recipient.c --*/
55 int _gpgme_recipients_all_valid ( const GpgmeRecipients rset );
56
57
58 /*-- data.c and conversion.c --*/
59 char *        _gpgme_data_release_and_return_string ( GpgmeData dh );
60 char *        _gpgme_data_get_as_string ( GpgmeData dh );
61 GpgmeError    _gpgme_data_append ( GpgmeData dh,
62                                    const char *buffer, size_t length );
63 GpgmeError    _gpgme_data_append_string ( GpgmeData dh, const char *s );
64 GpgmeError    _gpgme_data_append_string_for_xml ( GpgmeData dh,
65                                                   const char *s);
66 GpgmeError    _gpgme_data_append_for_xml ( GpgmeData dh,
67                                            const char *buffer,
68                                            size_t len );
69 GpgmeError    _gpgme_data_append_percentstring_for_xml ( GpgmeData dh,
70                                                          const char *string );
71
72 GpgmeError    _gpgme_data_unread (GpgmeData dh,
73                                   const char *buffer, size_t length );
74
75 void _gpgme_data_inbound_handler (void *opaque, int fd);
76 void _gpgme_data_outbound_handler (void *opaque, int fd);
77
78 /*-- key.c --*/
79 GpgmeError _gpgme_key_new ( GpgmeKey *r_key );
80 GpgmeError _gpgme_key_new_secret ( GpgmeKey *r_key );
81
82 /*-- op-support.c --*/
83 GpgmeError _gpgme_op_reset (GpgmeCtx ctx, int synchronous);
84
85 /*-- verify.c --*/
86 void _gpgme_release_verify_result (VerifyResult result);
87 void _gpgme_verify_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
88                                    char *args);
89
90 /*-- decrypt.c --*/
91 void _gpgme_release_decrypt_result (DecryptResult result);
92 void _gpgme_decrypt_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
93                                     char *args);
94 GpgmeError _gpgme_decrypt_start (GpgmeCtx ctx, int synchronous,
95                                  GpgmeData ciph, GpgmeData plain,
96                                  void *status_handler);
97 GpgmeError _gpgme_decrypt_result (GpgmeCtx ctx);
98
99 /*-- sign.c --*/
100 void _gpgme_release_sign_result ( SignResult res );
101 void _gpgme_sign_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
102                                  char *args);
103
104 /*-- encrypt.c --*/
105 void _gpgme_release_encrypt_result ( EncryptResult res );
106 void _gpgme_encrypt_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
107                                     char *args);
108
109 /*-- passphrase.c --*/
110 void _gpgme_release_passphrase_result (PassphraseResult result);
111 void _gpgme_passphrase_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
112                                        char *args);
113 const char * _gpgme_passphrase_command_handler (void *opaque,
114                                                 GpgmeStatusCode code,
115                                                 const char *key);
116 GpgmeError _gpgme_passphrase_start (GpgmeCtx ctx);
117
118 /*-- progress.c --*/
119 void _gpgme_progress_status_handler (GpgmeCtx ctx, GpgmeStatusCode code,
120                                      char *args);
121
122 /*-- import.c --*/
123 void _gpgme_release_import_result (ImportResult res);
124
125 /*-- delete.c --*/
126 void _gpgme_release_delete_result (DeleteResult res);
127
128 /*-- genkey.c --*/
129 void _gpgme_release_genkey_result (GenKeyResult res);
130
131 /*-- keylist.c --*/
132 void _gpgme_release_keylist_result (KeylistResult res);
133 void _gpgme_op_keylist_event_cb (void *data, GpgmeEventIO type, void *type_data);
134
135 /*-- trustlist.c --*/
136 void _gpgme_op_trustlist_event_cb (void *data, GpgmeEventIO type, void *type_data);
137
138 /*-- edit.c --*/
139 void _gpgme_release_edit_result (EditResult res);
140
141 /*-- version.c --*/
142 const char *_gpgme_compare_versions (const char *my_version,
143                                      const char *req_version);
144 char *_gpgme_get_program_version (const char *const path);
145
146
147 #endif /* OPS_H */