Add 2 missing files and other changes
[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
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     int initialized;
46     int pending;   /* a gpg request is still pending */
47
48     /* at some points we need to allocate memory but we are not
49      * able to handle a malloc problem at that point, so we set this
50      * flag to indicate this condition */
51     int out_of_core;   
52     int cancel;    /* cancel operation request */
53
54
55     GpgObject gpg; /* the running gpg process */
56
57     int verbosity;  /* level of verbosity to use */
58     int use_armor;  
59     int use_textmode;
60
61     ResultType result_type;
62     union {
63         VerifyResult verify;
64         DecryptResult decrypt;
65         SignResult sign;
66     } result;
67
68     GpgmeData notation;    /* last signature notation */
69
70     GpgmeKey tmp_key;       /* used by keylist.c */
71     volatile int key_cond;  /* something new is available */
72     struct key_queue_item_s *key_queue;
73
74     GpgmePassphraseCb passphrase_cb;
75     void *passphrase_cb_value;
76
77     GpgmeProgressCb progress_cb;
78     void *progress_cb_value;
79
80     GpgmeData help_data_1;
81 };
82
83
84 struct gpgme_data_s {
85     size_t len;
86     const char *data;
87     GpgmeDataType type;
88     GpgmeDataMode mode;
89
90     int (*read_cb)( void *, char *, size_t, size_t *);
91     void *read_cb_value;
92     int read_cb_eof;
93
94     size_t readpos;
95     size_t writepos;
96     size_t private_len;
97     char *private_buffer;
98 };
99
100 struct user_id_s {
101     struct user_id_s *next;
102     int validity; /* 0 = undefined, 1 = not, 2 = marginal,
103                      3 = full, 4 = ultimate */
104     char name[1];
105 };
106
107 struct gpgme_recipients_s {
108     struct user_id_s *list;
109     int checked;   /* wether the recipients are all valid */
110 };
111
112
113 #define fail_on_pending_request(c)                            \
114           do {                                                \
115                 if (!(c))         return GPGME_Invalid_Value; \
116                 if ((c)->pending) return GPGME_Busy;          \
117              } while (0)
118
119 #define wait_on_request_or_fail(c)                            \
120           do {                                                \
121                 if (!(c))          return GPGME_Invalid_Value;\
122                 if (!(c)->pending) return GPGME_No_Request;   \
123                 gpgme_wait ((c), 1);                          \
124              } while (0)
125
126
127
128 #endif /* CONTEXT_H */
129
130
131