Fix copyright year.
[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 "types.h"
26 #include "engine.h"
27 #include "wait.h"
28
29 struct key_queue_item_s
30 {
31   struct key_queue_item_s *next;
32   GpgmeKey key;
33 };
34
35 struct trust_queue_item_s
36 {
37   struct trust_queue_item_s *next;
38   GpgmeTrustItem item;
39 };
40
41
42 /* Currently we need it at several places, so we put the definition
43    into this header file.  */
44 struct gpgme_context_s
45 {
46   int initialized;
47   /* An engine request is still pending.  */
48   int pending;
49
50   int use_cms;
51
52   /* Cancel operation requested.  */
53   int cancel;
54
55   /* The running engine process.  */
56   EngineObject engine;
57
58   /* Level of verbosity to use.  */
59   int verbosity;
60   int use_armor;  
61   int use_textmode;
62   int keylist_mode;
63   int include_certs;
64
65   /* The number of keys in signers.  */
66   int signers_len;
67   /* Size of the following array.  */
68   int signers_size;
69   GpgmeKey *signers;
70
71   struct
72   {
73     VerifyResult verify;
74     DecryptResult decrypt;
75     SignResult sign;
76     EncryptResult encrypt;
77     PassphraseResult passphrase;
78     ImportResult import;
79     DeleteResult delete;
80     GenKeyResult genkey;
81     KeylistResult keylist;
82     EditResult edit;
83   } result;
84
85   /* Last signature notation.  */
86   GpgmeData notation;
87   /* Last operation info.  */
88   GpgmeData op_info;
89
90   /* Used by keylist.c.  */
91   GpgmeKey tmp_key;
92   struct user_id_s *tmp_uid;
93   /* Something new is available.  */
94   volatile int key_cond;
95   struct key_queue_item_s *key_queue;
96   struct trust_queue_item_s *trust_queue;
97
98   GpgmePassphraseCb passphrase_cb;
99   void *passphrase_cb_value;
100
101   GpgmeProgressCb progress_cb;
102   void *progress_cb_value;
103
104   /* A list of file descriptors in active use by the current
105      operation.  */
106   struct fd_table fdt;
107   struct GpgmeIOCbs io_cbs;
108   
109   GpgmeData help_data_1;
110 };
111
112 /* Forward declaration of a structure to store certification
113    signatures.  */
114 struct certsig_s;
115
116 /* Structure to store user IDs.  */
117 struct user_id_s
118 {
119   struct user_id_s *next;
120   unsigned int revoked : 1;
121   unsigned int invalid : 1;
122   GpgmeValidity validity; 
123   struct certsig_s *certsigs;
124   struct certsig_s *last_certsig;
125   const char *name_part;        /* All 3 point into strings behind name  */
126   const char *email_part;       /* or to read-only strings.  */
127   const char *comment_part;
128   char name[1];
129 };
130
131
132 struct gpgme_recipients_s
133 {
134   struct user_id_s *list;
135   int checked;  /* Wether the recipients are all valid.  */
136 };
137
138
139 #define fail_on_pending_request(c)                            \
140           do {                                                \
141                 if (!(c))         return GPGME_Invalid_Value; \
142                 if ((c)->pending) return GPGME_Busy;          \
143              } while (0)
144
145 #endif  /* CONTEXT_H */