2003-01-30 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / context.h
1 /* context.h
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_COLLECTING, OPDATA_VERIFY
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 struct key_queue_item_s
60 {
61   struct key_queue_item_s *next;
62   GpgmeKey key;
63 };
64
65
66 struct trust_queue_item_s
67 {
68   struct trust_queue_item_s *next;
69   GpgmeTrustItem item;
70 };
71
72
73 /* Currently we need it at several places, so we put the definition
74    into this header file.  */
75 struct gpgme_context_s
76 {
77   int initialized;
78   /* An engine request is still pending.  */
79   int pending;
80
81   int use_cms;
82
83   /* Cancel operation requested.  */
84   int cancel;
85
86   /* The running engine process.  */
87   EngineObject engine;
88
89   /* Level of verbosity to use.  */
90   int verbosity;
91   int use_armor;  
92   int use_textmode;
93   int keylist_mode;
94   int include_certs;
95
96   /* The number of keys in signers.  */
97   int signers_len;
98   /* Size of the following array.  */
99   int signers_size;
100   GpgmeKey *signers;
101
102   /* The operation data hooked into the context.  */
103   struct ctx_op_data *op_data;
104
105   /* Last signature notation.  */
106   GpgmeData notation;
107   /* Last operation info.  */
108   GpgmeData op_info;
109
110   /* Used by keylist.c.  */
111   GpgmeKey tmp_key;
112   struct user_id_s *tmp_uid;
113   /* Something new is available.  */
114   volatile int key_cond;
115   struct key_queue_item_s *key_queue;
116   struct trust_queue_item_s *trust_queue;
117
118   GpgmePassphraseCb passphrase_cb;
119   void *passphrase_cb_value;
120
121   GpgmeProgressCb progress_cb;
122   void *progress_cb_value;
123
124   /* A list of file descriptors in active use by the current
125      operation.  */
126   struct fd_table fdt;
127   struct GpgmeIOCbs io_cbs;
128   
129   GpgmeData help_data_1;
130 };
131
132 /* Forward declaration of a structure to store certification
133    signatures.  */
134 struct certsig_s;
135
136 /* Structure to store user IDs.  */
137 struct user_id_s
138 {
139   struct user_id_s *next;
140   unsigned int revoked : 1;
141   unsigned int invalid : 1;
142   GpgmeValidity validity; 
143   struct certsig_s *certsigs;
144   struct certsig_s *last_certsig;
145   const char *name_part;        /* All 3 point into strings behind name  */
146   const char *email_part;       /* or to read-only strings.  */
147   const char *comment_part;
148   char name[1];
149 };
150
151
152 struct gpgme_recipients_s
153 {
154   struct user_id_s *list;
155   int checked;  /* Whether the recipients are all valid.  */
156 };
157
158
159 #endif  /* CONTEXT_H */