doc/
[gpgme.git] / src / context.h
1 /* context.h - Definitions for a GPGME context.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005 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 CONTEXT_H
23 #define CONTEXT_H
24
25 #include "gpgme.h"
26 #include "engine.h"
27 #include "wait.h"
28 #include "sema.h"
29
30 \f
31 extern gpgme_error_t _gpgme_selftest;
32
33 /* Operations might require to remember arbitrary information and data
34    objects during invocations of the status handler.  The
35    ctx_op_data structure provides a generic framework to hook in
36    such additional data.  */
37 typedef enum
38   {
39     OPDATA_DECRYPT, OPDATA_SIGN, OPDATA_ENCRYPT, OPDATA_PASSPHRASE,
40     OPDATA_IMPORT, OPDATA_GENKEY, OPDATA_KEYLIST, OPDATA_EDIT,
41     OPDATA_VERIFY, OPDATA_TRUSTLIST, OPDATA_ASSUAN
42   } ctx_op_data_id_t;
43
44
45 struct ctx_op_data
46 {
47   /* The next element in the linked list, or NULL if this is the last
48      element.  */
49   struct ctx_op_data *next;
50
51   /* The type of the hook data, which can be used by a routine to
52      lookup the hook data.  */
53   ctx_op_data_id_t type;
54
55   /* The function to release HOOK and all its associated resources.
56      Can be NULL if no special deallocation routine is necessary.  */
57   void (*cleanup) (void *hook);
58
59   /* The hook that points to the operation data.  */
60   void *hook;
61 };
62 typedef struct ctx_op_data *ctx_op_data_t;
63
64 \f
65 /* The context defines an environment in which crypto operations can
66    be performed (sequentially).  */
67 struct gpgme_context
68 {
69   DECLARE_LOCK (lock);
70
71   /* True if the context was canceled asynchronously.  */
72   int canceled;
73
74   /* The engine info for this context.  */
75   gpgme_engine_info_t engine_info;
76
77   /* The protocol used by this context.  */
78   gpgme_protocol_t protocol;
79
80   /* The running engine process.  */
81   engine_t engine;
82
83   /* True if armor mode should be used.  */
84   unsigned int use_armor : 1;
85
86   /* True if text mode should be used.  */
87   unsigned int use_textmode : 1;
88
89   /* Flags for keylist mode.  */
90   gpgme_keylist_mode_t keylist_mode;
91
92   /* Number of certs to be included.  */
93   unsigned int include_certs;
94
95   /* The number of keys in signers.  */
96   unsigned int signers_len;
97
98   /* Size of the following array.  */
99   unsigned int signers_size;
100   gpgme_key_t *signers;
101
102   /* The signature notations for this context.  */
103   gpgme_sig_notation_t sig_notations;
104
105   /* The locale for the pinentry.  */
106   char *lc_ctype;
107   char *lc_messages;
108
109   /* The operation data hooked into the context.  */
110   ctx_op_data_t op_data;
111
112   /* The user provided passphrase callback and its hook value.  */
113   gpgme_passphrase_cb_t passphrase_cb;
114   void *passphrase_cb_value;
115
116   /* The user provided progress callback and its hook value.  */
117   gpgme_progress_cb_t progress_cb;
118   void *progress_cb_value;
119
120   /* A list of file descriptors in active use by the current
121      operation.  */
122   struct fd_table fdt;
123   struct gpgme_io_cbs io_cbs;
124 };
125
126 #endif  /* CONTEXT_H */