e888aa8d488b18484fe3a8d8b6f861aca56f7596
[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
53     GpgObject gpg; /* the running gpg process */
54
55     int verbosity;  /* level of verbosity to use */
56     int use_armor;  
57     int use_textmode;
58
59     /*   GpgmePassphraseCb passphrase_cb;*/
60     /* void *            passphrase_cb_value;*/
61     
62     ResultType result_type;
63     union {
64         VerifyResult verify;
65         DecryptResult decrypt;
66         SignResult sign;
67     } result;
68
69     GpgmeData notation;    /* last signature notation */
70
71     GpgmeKey tmp_key;       /* used by keylist.c */
72     volatile int key_cond;  /* something new is available */
73     struct key_queue_item_s *key_queue;
74 };
75
76
77 struct gpgme_data_s {
78     size_t len;
79     const char *data;
80     GpgmeDataType type;
81     GpgmeDataMode mode;
82     size_t readpos;
83     size_t writepos;
84     size_t private_len;
85     char *private_buffer;
86 };
87
88 struct user_id_s {
89     struct user_id_s *next;
90     int validity; /* 0 = undefined, 1 = not, 2 = marginal,
91                      3 = full, 4 = ultimate */
92     char name[1];
93 };
94
95 struct gpgme_recipients_s {
96     struct user_id_s *list;
97     int checked;   /* wether the recipients are all valid */
98 };
99
100
101 #define fail_on_pending_request(c)                            \
102           do {                                                \
103                 if (!(c))         return GPGME_Invalid_Value; \
104                 if ((c)->pending) return GPGME_Busy;          \
105              } while (0)
106
107 #define wait_on_request_or_fail(c)                            \
108           do {                                                \
109                 if (!(c))          return GPGME_Invalid_Value;\
110                 if (!(c)->pending) return GPGME_No_Request;   \
111                 gpgme_wait ((c), 1);                          \
112              } while (0)
113
114
115
116 #endif /* CONTEXT_H */
117
118
119