2002-02-02 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 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME is free software; you can redistribute it and/or modify
8  * it 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,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #ifndef CONTEXT_H
23 #define CONTEXT_H
24
25 #include "gpgme.h"
26 #include "types.h"
27 #include "engine.h"
28
29 struct key_queue_item_s {
30     struct key_queue_item_s *next;
31     GpgmeKey key;
32 };
33 struct trust_queue_item_s {
34     struct trust_queue_item_s *next;
35     GpgmeTrustItem item;
36 };
37
38
39 /* Currently we need it at several places, so we put the definition 
40  * into this header file */
41 struct gpgme_context_s {
42     int initialized;
43     int pending;   /* a gpg request is still pending */
44
45     int use_cms;
46
47     /* At some points we need to remember an error which we can't report
48        immediately.  */
49     GpgmeError error;   
50     /* Cancel operation requested.  */
51     int cancel;
52
53     EngineObject engine; /* The running engine process.  */
54
55     int verbosity;  /* level of verbosity to use */
56     int use_armor;  
57     int use_textmode;
58     int keylist_mode;
59
60     int signers_len;   /* The number of keys in signers.  */
61     int signers_size;  /* size of the following array */
62     GpgmeKey *signers;
63
64     struct {
65         VerifyResult verify;
66         DecryptResult decrypt;
67         SignResult sign;
68         EncryptResult encrypt;
69         PassphraseResult passphrase;
70         ImportResult import;
71         DeleteResult delete;
72         GenKeyResult genkey;
73     } result;
74
75     GpgmeData notation;    /* last signature notation */
76     GpgmeData op_info;     /* last operation info */
77
78     GpgmeKey tmp_key;       /* used by keylist.c */
79     volatile int key_cond;  /* something new is available */
80     struct key_queue_item_s *key_queue;
81     struct trust_queue_item_s *trust_queue;
82
83     GpgmePassphraseCb passphrase_cb;
84     void *passphrase_cb_value;
85
86     GpgmeProgressCb progress_cb;
87     void *progress_cb_value;
88
89     GpgmeData help_data_1;
90 };
91
92
93 struct gpgme_data_s {
94     size_t len;
95     const char *data;
96     GpgmeDataType type;
97     GpgmeDataMode mode;
98
99     int (*read_cb)( void *, char *, size_t, size_t *);
100     void *read_cb_value;
101     int read_cb_eof;
102
103     size_t readpos;
104     size_t writepos;
105     size_t private_len;
106     char *private_buffer;
107 };
108
109 struct user_id_s {
110     struct user_id_s *next;
111     unsigned int revoked:1;
112     unsigned int invalid:1;
113     GpgmeValidity validity; 
114     const char *name_part;    /* all 3 point into strings behind name */
115     const char *email_part;   /* or to read-only strings */
116     const char *comment_part;
117     char name[1];
118 };
119
120 struct gpgme_recipients_s {
121     struct user_id_s *list;
122     int checked;   /* wether the recipients are all valid */
123 };
124
125
126 #define fail_on_pending_request(c)                            \
127           do {                                                \
128                 if (!(c))         return GPGME_Invalid_Value; \
129                 if ((c)->pending) return GPGME_Busy;          \
130              } while (0)
131
132 #define wait_on_request_or_fail(c)                            \
133           do {                                                \
134                 if (!(c))          return GPGME_Invalid_Value;\
135                 if (!(c)->pending) return GPGME_No_Request;   \
136                 gpgme_wait ((c), 1);                          \
137              } while (0)
138
139 #endif /* CONTEXT_H */