2003-01-30 Marcus Brinkmann <marcus@g10code.de>
[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 "gpgme.h"
25  
26 struct engine_object_s;
27 typedef struct engine_object_s *EngineObject;
28
29 typedef GpgmeError (*EngineStatusHandler) (void *priv, GpgmeStatusCode code,
30                                            char *args);
31 typedef GpgmeError (*EngineColonLineHandler) (void *priv, char *line);
32 typedef GpgmeError (*EngineCommandHandler) (void *priv, GpgmeStatusCode code,
33                                             const char *keyword,
34                                             const char **result);
35
36 GpgmeError _gpgme_engine_new (GpgmeProtocol proto, EngineObject *r_engine);
37 void _gpgme_engine_release (EngineObject engine);
38 void _gpgme_engine_set_status_handler (EngineObject engine,
39                                        EngineStatusHandler fnc,
40                                        void *fnc_value);
41 GpgmeError _gpgme_engine_set_command_handler (EngineObject engine,
42                                               EngineCommandHandler fnc,
43                                               void *fnc_value,
44                                               GpgmeData data);
45 GpgmeError _gpgme_engine_set_colon_line_handler (EngineObject engine,
46                                                  EngineColonLineHandler fnc,
47                                                  void *fnc_value);
48 void _gpgme_engine_set_verbosity (EngineObject engine, int verbosity);
49 GpgmeError _gpgme_engine_op_decrypt (EngineObject engine, GpgmeData ciph,
50                                      GpgmeData plain);
51 GpgmeError _gpgme_engine_op_delete (EngineObject engine, GpgmeKey key,
52                                     int allow_secret);
53 GpgmeError _gpgme_engine_op_edit (EngineObject engine, GpgmeKey key,
54                                   GpgmeData out, GpgmeCtx ctx /* FIXME */);
55 GpgmeError _gpgme_engine_op_encrypt (EngineObject engine, GpgmeRecipients recp,
56                                      GpgmeData plain, GpgmeData ciph,
57                                      int use_armor);
58 GpgmeError _gpgme_engine_op_encrypt_sign (EngineObject engine,
59                                           GpgmeRecipients recp,
60                                           GpgmeData plain, GpgmeData ciph,
61                                           int use_armor,
62                                           GpgmeCtx ctx /* FIXME */);
63 GpgmeError _gpgme_engine_op_export (EngineObject engine, GpgmeRecipients recp,
64                                     GpgmeData keydata, int use_armor);
65 GpgmeError _gpgme_engine_op_genkey (EngineObject engine, GpgmeData help_data,
66                                     int use_armor, GpgmeData pubkey,
67                                     GpgmeData seckey);
68 GpgmeError _gpgme_engine_op_import (EngineObject engine, GpgmeData keydata);
69 GpgmeError _gpgme_engine_op_keylist (EngineObject engine, const char *pattern,
70                                      int secret_only,
71                                      int keylist_mode);
72 GpgmeError _gpgme_engine_op_keylist_ext (EngineObject engine,
73                                          const char *pattern[],
74                                          int secret_only,
75                                          int reserved,
76                                          int keylist_mode);
77 GpgmeError _gpgme_engine_op_sign (EngineObject engine, GpgmeData in,
78                                   GpgmeData out, GpgmeSigMode mode,
79                                   int use_armor, int use_textmode,
80                                   int include_certs,
81                                   GpgmeCtx ctx /* FIXME */);
82 GpgmeError _gpgme_engine_op_trustlist (EngineObject engine,
83                                        const char *pattern);
84 GpgmeError _gpgme_engine_op_verify (EngineObject engine, GpgmeData sig,
85                                     GpgmeData signed_text,
86                                     GpgmeData plaintext);
87
88 void _gpgme_engine_set_io_cbs (EngineObject engine,
89                                struct GpgmeIOCbs *io_cbs);
90 void _gpgme_engine_io_event (EngineObject engine,
91                              GpgmeEventIO type, void *type_data);
92
93 #endif /* ENGINE_H */