2003-05-04 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / context.h
1 /* context.h - Definitions for a GPGME context.
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 CONTEXT_H
22 #define CONTEXT_H
23
24 #include "gpgme.h"
25 #include "engine.h"
26 #include "wait.h"
27
28 \f
29 /* Operations might require to remember arbitrary information and data
30    objects during invocations of the status handler.  The
31    ctx_op_data structure provides a generic framework to hook in
32    such additional data.  */
33 typedef enum
34   {
35     OPDATA_DECRYPT, OPDATA_SIGN, OPDATA_ENCRYPT, OPDATA_PASSPHRASE,
36     OPDATA_IMPORT, OPDATA_GENKEY, OPDATA_KEYLIST, OPDATA_EDIT,
37     OPDATA_VERIFY, OPDATA_TRUSTLIST
38   } ctx_op_data_type;
39
40 struct ctx_op_data
41 {
42   /* The next element in the linked list, or NULL if this is the last
43      element.  */
44   struct ctx_op_data *next;
45
46   /* The type of the hook data, which can be used by a routine to
47      lookup the hook data.  */
48   ctx_op_data_type type;
49
50   /* The function to release HOOK and all its associated resources.
51      Can be NULL if no special dealllocation routine is necessary.  */
52   void (*cleanup) (void *hook);
53
54   /* The hook that points to the operation data.  */
55   void *hook;
56 };
57
58 \f
59 /* The context defines an environment in which crypto operations can
60    be performed (sequentially).  */
61 struct gpgme_context_s
62 {
63   /* The protocol used by this context.  */
64   GpgmeProtocol protocol;
65
66   /* The running engine process.  */
67   EngineObject engine;
68
69   /* True if armor mode should be used.  */
70   unsigned int use_armor : 1;
71
72   /* True if text mode should be used.  */
73   unsigned int use_textmode : 1;
74
75   /* Flags for keylist mode.  */
76   unsigned int keylist_mode;
77
78   /* Number of certs to be included.  */
79   unsigned int include_certs;
80
81   /* The number of keys in signers.  */
82   unsigned int signers_len;
83
84   /* Size of the following array.  */
85   unsigned int signers_size;
86   GpgmeKey *signers;
87
88   /* The operation data hooked into the context.  */
89   struct ctx_op_data *op_data;
90
91   /* The user provided passphrase callback and its hook value.  */
92   GpgmePassphraseCb passphrase_cb;
93   void *passphrase_cb_value;
94
95   /* The user provided progress callback and its hook value.  */
96   GpgmeProgressCb progress_cb;
97   void *progress_cb_value;
98
99   /* A list of file descriptors in active use by the current
100      operation.  */
101   struct fd_table fdt;
102   struct GpgmeIOCbs io_cbs;
103 };
104
105
106 /* A recipient is defined by a user ID, but we define it as an opaque
107    type for the user.  */
108 struct gpgme_recipients_s
109 {
110   GpgmeUserID list;
111 };
112
113 #endif  /* CONTEXT_H */