Set DISPLAY environment variable if --display option
[pinentry-qt.git] / assuan-defs.h
1 /* assuan-defs.c - Internal definitions to Assuan
2  *      Copyright (C) 2001 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG 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  * GnuPG 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 ASSUAN_DEFS_H
22 #define ASSUAN_DEFS_H
23
24 #ifndef HAVE_W32CE_SYSTEM
25 # include <sys/types.h>
26 #endif
27 #include "assuan.h"
28
29 #define LINELENGTH ASSUAN_LINELENGTH
30
31 struct cmdtbl_s {
32   const char *name;
33   int cmd_id;
34   int (*handler)(ASSUAN_CONTEXT, char *line);
35 };
36
37 struct assuan_context_s {
38   AssuanError err_no;
39   const char *err_str;
40   int os_errno;  /* last system error number used with certain error codes*/
41
42   int confidential;
43   int is_server;  /* set if this is context belongs to a server */
44   int in_inquire;
45   char *hello_line;
46   char *okay_line; /* see assan_set_okay_line() */
47   
48   void *user_pointer;  /* for assuan_[gs]et_pointer () */
49
50   FILE *log_fp;
51
52   struct {
53     int fd;
54     int eof;
55     char line[LINELENGTH];
56     int linelen;  /* w/o CR, LF - might not be the same as
57                      strlen(line) due to embedded nuls. However a nul
58                      is always written at this pos */
59     struct {
60       char line[LINELENGTH];
61       int linelen ;
62       int pending; /* i.e. at least one line is available in the attic */
63     } attic;
64   } inbound;
65
66   struct {
67     int fd;
68     struct {
69       FILE *fp;
70       char line[LINELENGTH];
71       int linelen; 
72       int error;
73     } data; 
74   } outbound;
75
76   int pipe_mode;  /* We are in pipe mode, i.e. we can handle just one
77                      connection and must terminate then */
78   pid_t pid;      /* In pipe mode, the pid of the child server process.  
79                      In socket mode, the pid of the server */
80   int listen_fd;  /* The fd we are listening on (used by socket servers) */
81
82   pid_t client_pid; /* for a socket server the PID of the client or -1
83                        if not available */
84
85   void (*deinit_handler)(ASSUAN_CONTEXT);  
86   int (*accept_handler)(ASSUAN_CONTEXT);
87   int (*finish_handler)(ASSUAN_CONTEXT);
88
89   struct cmdtbl_s *cmdtbl;
90   size_t cmdtbl_used; /* used entries */
91   size_t cmdtbl_size; /* allocated size of table */
92
93   void (*bye_notify_fnc)(ASSUAN_CONTEXT);
94   void (*reset_notify_fnc)(ASSUAN_CONTEXT);
95   void (*cancel_notify_fnc)(ASSUAN_CONTEXT);
96   int  (*option_handler_fnc)(ASSUAN_CONTEXT,const char*, const char*);
97   void (*input_notify_fnc)(ASSUAN_CONTEXT, const char *);
98   void (*output_notify_fnc)(ASSUAN_CONTEXT, const char *);
99
100   int input_fd;   /* set by INPUT command */
101   int output_fd;  /* set by OUTPUT command */
102
103 };
104
105
106 /*-- assuan-pipe-server.c --*/
107 int _assuan_new_context (ASSUAN_CONTEXT *r_ctx);
108 void _assuan_release_context (ASSUAN_CONTEXT ctx);
109
110
111 /*-- assuan-handler.c --*/
112 int _assuan_register_std_commands (ASSUAN_CONTEXT ctx);
113
114 /*-- assuan-buffer.c --*/
115 int _assuan_read_line (ASSUAN_CONTEXT ctx);
116 int _assuan_cookie_write_data (void *cookie, const char *buffer, size_t size);
117 int _assuan_cookie_write_flush (void *cookie);
118
119 /*-- assuan-client.c --*/
120 AssuanError _assuan_read_from_server (ASSUAN_CONTEXT ctx, int *okay, int *off);
121
122
123 /*-- assuan-util.c --*/
124 void *_assuan_malloc (size_t n);
125 void *_assuan_calloc (size_t n, size_t m);
126 void *_assuan_realloc (void *p, size_t n);
127 void  _assuan_free (void *p);
128
129 #define xtrymalloc(a)    _assuan_malloc ((a))
130 #define xtrycalloc(a,b)  _assuan_calloc ((a),(b))
131 #define xtryrealloc(a,b) _assuan_realloc((a),(b))
132 #define xfree(a)         _assuan_free ((a))
133
134 #define set_error(c,e,t) assuan_set_error ((c), ASSUAN_ ## e, (t))
135
136 void _assuan_log_print_buffer (FILE *fp, const void *buffer, size_t  length);
137 void _assuan_log_sanitized_string (const char *string);
138
139
140 #endif /*ASSUAN_DEFS_H*/
141