Notation stuff added
[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 } ResultType;
32
33
34 struct key_queue_item_s {
35     struct key_queue_item_s *next;
36     GpgmeKey key;
37 };
38
39
40 /* Currently we need it at several places, so we put the definition 
41  * into this header file */
42 struct gpgme_context_s {
43     int initialized;
44     int pending;   /* a gpg request is still pending */
45
46     /* at some points we need to allocate memory but we are not
47      * able to handle a malloc problem at that point, so we set this
48      * flag to indicate this condition */
49     int out_of_core;   
50
51     GpgObject gpg; /* the running gpg process */
52
53     int verbosity;  /* level of verbosity to use */
54     int use_armor;  /* use armoring */
55
56     
57
58     ResultType result_type;
59     union {
60         VerifyResult verify;
61     } result;
62
63     GpgmeData notation;    /* last signature notation */
64
65     GpgmeKey tmp_key;       /* used by keylist.c */
66     volatile int key_cond;  /* something new is available */
67     struct key_queue_item_s *key_queue;
68 };
69
70
71 struct gpgme_data_s {
72     size_t len;
73     const char *data;
74     GpgmeDataType type;
75     GpgmeDataMode mode;
76     size_t readpos;
77     size_t writepos;
78     size_t private_len;
79     char *private_buffer;
80 };
81
82 struct user_id_s {
83     struct user_id_s *next;
84     int validity; /* 0 = undefined, 1 = not, 2 = marginal,
85                      3 = full, 4 = ultimate */
86     char name[1];
87 };
88
89 struct gpgme_recipients_s {
90     struct user_id_s *list;
91     int checked;   /* wether the recipients are all valid */
92 };
93
94
95 #define fail_on_pending_request(c)                            \
96           do {                                                \
97                 if (!(c))         return GPGME_Invalid_Value; \
98                 if ((c)->pending) return GPGME_Busy;          \
99              } while (0)
100
101 #define wait_on_request_or_fail(c)                            \
102           do {                                                \
103                 if (!(c))          return GPGME_Invalid_Value;\
104                 if (!(c)->pending) return GPGME_No_Request;   \
105                 gpgme_wait ((c), 1);                          \
106              } while (0)
107
108
109
110 #endif /* CONTEXT_H */
111
112
113