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