Release 0.1.4
[gpgme.git] / gpgme / context.h
1 /* context.h 
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GPGME is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef CONTEXT_H
22 #define CONTEXT_H
23
24 #include "gpgme.h"
25 #include "types.h"
26 #include "rungpg.h"  /* for GpgObject */
27
28 typedef enum {
29     RESULT_TYPE_NONE = 0,
30     RESULT_TYPE_VERIFY,
31     RESULT_TYPE_DECRYPT,
32     RESULT_TYPE_SIGN,
33 } ResultType;
34
35
36 struct key_queue_item_s {
37     struct key_queue_item_s *next;
38     GpgmeKey key;
39 };
40 struct trust_queue_item_s {
41     struct trust_queue_item_s *next;
42     GpgmeTrustItem item;
43 };
44
45
46 /* Currently we need it at several places, so we put the definition 
47  * into this header file */
48 struct gpgme_context_s {
49     int initialized;
50     int pending;   /* a gpg request is still pending */
51
52     /* at some points we need to allocate memory but we are not
53      * able to handle a malloc problem at that point, so we set this
54      * flag to indicate this condition */
55     int out_of_core;   
56     int cancel;    /* cancel operation request */
57
58
59     GpgObject gpg; /* the running gpg process */
60
61     int verbosity;  /* level of verbosity to use */
62     int use_armor;  
63     int use_textmode;
64     int keylist_mode;
65
66     ResultType result_type;
67     union {
68         VerifyResult verify;
69         DecryptResult decrypt;
70         SignResult sign;
71     } result;
72
73     GpgmeData notation;    /* last signature notation */
74
75     GpgmeKey tmp_key;       /* used by keylist.c */
76     volatile int key_cond;  /* something new is available */
77     struct key_queue_item_s *key_queue;
78     struct trust_queue_item_s *trust_queue;
79
80     GpgmePassphraseCb passphrase_cb;
81     void *passphrase_cb_value;
82
83     GpgmeProgressCb progress_cb;
84     void *progress_cb_value;
85
86     GpgmeData help_data_1;
87 };
88
89
90 struct gpgme_data_s {
91     size_t len;
92     const char *data;
93     GpgmeDataType type;
94     GpgmeDataMode mode;
95
96     int (*read_cb)( void *, char *, size_t, size_t *);
97     void *read_cb_value;
98     int read_cb_eof;
99
100     size_t readpos;
101     size_t writepos;
102     size_t private_len;
103     char *private_buffer;
104 };
105
106 struct user_id_s {
107     struct user_id_s *next;
108     GpgmeValidity validity; 
109     const char *name_part;    /* all 3 point into strings behind name */
110     const char *email_part;   /* or to read-only strings */
111     const char *comment_part;
112     char name[1];
113 };
114
115 struct gpgme_recipients_s {
116     struct user_id_s *list;
117     int checked;   /* wether the recipients are all valid */
118 };
119
120
121 #define fail_on_pending_request(c)                            \
122           do {                                                \
123                 if (!(c))         return GPGME_Invalid_Value; \
124                 if ((c)->pending) return GPGME_Busy;          \
125              } while (0)
126
127 #define wait_on_request_or_fail(c)                            \
128           do {                                                \
129                 if (!(c))          return GPGME_Invalid_Value;\
130                 if (!(c)->pending) return GPGME_No_Request;   \
131                 gpgme_wait ((c), 1);                          \
132              } while (0)
133
134
135
136 #endif /* CONTEXT_H */
137
138
139