a56ec85f564f9baa3b78c026ccafdfaa3da72a75
[gpgme.git] / gpgme / engine.h
1 /* engine.h -  GPGME engine interface.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003 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 ENGINE_H
22 #define ENGINE_H
23
24 #include "types.h"
25  
26 struct engine_object_s;
27 typedef struct engine_object_s *EngineObject;
28
29 GpgmeError _gpgme_engine_new (GpgmeProtocol proto, EngineObject *r_engine);
30 void _gpgme_engine_release (EngineObject engine);
31 void _gpgme_engine_set_status_handler (EngineObject engine,
32                                        GpgmeStatusHandler fnc,
33                                        void *fnc_value);
34 GpgmeError _gpgme_engine_set_command_handler (EngineObject engine,
35                                               GpgmeCommandHandler fnc,
36                                               void *fnc_value,
37                                               GpgmeData data);
38 GpgmeError _gpgme_engine_set_colon_line_handler (EngineObject engine,
39                                                  GpgmeColonLineHandler fnc,
40                                                  void *fnc_value);
41 void _gpgme_engine_set_verbosity (EngineObject engine, int verbosity);
42 GpgmeError _gpgme_engine_op_decrypt (EngineObject engine, GpgmeData ciph,
43                                      GpgmeData plain);
44 GpgmeError _gpgme_engine_op_delete (EngineObject engine, GpgmeKey key,
45                                     int allow_secret);
46 GpgmeError _gpgme_engine_op_edit (EngineObject engine, GpgmeKey key,
47                                   GpgmeData out, GpgmeCtx ctx /* FIXME */);
48 GpgmeError _gpgme_engine_op_encrypt (EngineObject engine, GpgmeRecipients recp,
49                                      GpgmeData plain, GpgmeData ciph,
50                                      int use_armor);
51 GpgmeError _gpgme_engine_op_encrypt_sign (EngineObject engine,
52                                           GpgmeRecipients recp,
53                                           GpgmeData plain, GpgmeData ciph,
54                                           int use_armor,
55                                           GpgmeCtx ctx /* FIXME */);
56 GpgmeError _gpgme_engine_op_export (EngineObject engine, GpgmeRecipients recp,
57                                     GpgmeData keydata, int use_armor);
58 GpgmeError _gpgme_engine_op_genkey (EngineObject engine, GpgmeData help_data,
59                                     int use_armor, GpgmeData pubkey,
60                                     GpgmeData seckey);
61 GpgmeError _gpgme_engine_op_import (EngineObject engine, GpgmeData keydata);
62 GpgmeError _gpgme_engine_op_keylist (EngineObject engine, const char *pattern,
63                                      int secret_only,
64                                      int keylist_mode);
65 GpgmeError _gpgme_engine_op_keylist_ext (EngineObject engine,
66                                          const char *pattern[],
67                                          int secret_only,
68                                          int reserved,
69                                          int keylist_mode);
70 GpgmeError _gpgme_engine_op_sign (EngineObject engine, GpgmeData in,
71                                   GpgmeData out, GpgmeSigMode mode,
72                                   int use_armor, int use_textmode,
73                                   int include_certs,
74                                   GpgmeCtx ctx /* FIXME */);
75 GpgmeError _gpgme_engine_op_trustlist (EngineObject engine,
76                                        const char *pattern);
77 GpgmeError _gpgme_engine_op_verify (EngineObject engine, GpgmeData sig,
78                                     GpgmeData signed_text,
79                                     GpgmeData plaintext);
80
81 void _gpgme_engine_set_io_cbs (EngineObject engine,
82                                struct GpgmeIOCbs *io_cbs);
83 void _gpgme_engine_io_event (EngineObject engine,
84                              GpgmeEventIO type, void *type_data);
85
86 #endif /* ENGINE_H */