Add a private connection shutdown method for error cases.
[free-sw/xcb/libxcb] / src / xcbint.h
1 /*
2  * Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  * 
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  * 
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  * 
22  * Except as contained in this notice, the names of the authors or their
23  * institutions shall not be used in advertising or otherwise to promote the
24  * sale, use or other dealings in this Software without prior written
25  * authorization from the authors.
26  */
27
28 #ifndef __XCBINT_H
29 #define __XCBINT_H
30
31 #ifdef HAVE_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #ifdef GCC_HAS_VISIBILITY
36 #pragma GCC visibility push(hidden)
37 #endif
38
39 enum workarounds {
40     WORKAROUND_NONE,
41     WORKAROUND_GLX_GET_FB_CONFIGS_BUG
42 };
43
44 #define XCB_PAD(i) (-(i) & 3)
45
46 #define XCB_SEQUENCE_COMPARE(a,op,b)    ((int) ((a) - (b)) op 0)
47
48 /* xcb_list.c */
49
50 typedef void (*XCBListFreeFunc)(void *);
51
52 typedef struct _xcb_map _xcb_map;
53
54 _xcb_map *_xcb_map_new(void);
55 void _xcb_map_delete(_xcb_map *q, XCBListFreeFunc do_free);
56 int _xcb_map_put(_xcb_map *q, unsigned int key, void *data);
57 void *_xcb_map_remove(_xcb_map *q, unsigned int key);
58
59
60 /* xcb_out.c */
61
62 typedef struct _xcb_out {
63     pthread_cond_t cond;
64     int writing;
65
66     char queue[4096];
67     int queue_len;
68
69     unsigned int request;
70     unsigned int request_written;
71
72     pthread_mutex_t reqlenlock;
73     CARD32 maximum_request_length;
74 } _xcb_out;
75
76 int _xcb_out_init(_xcb_out *out);
77 void _xcb_out_destroy(_xcb_out *out);
78
79 int _xcb_out_send(XCBConnection *c, struct iovec **vector, int *count);
80 int _xcb_out_flush_to(XCBConnection *c, unsigned int request);
81
82
83 /* xcb_in.c */
84
85 typedef struct _xcb_in {
86     pthread_cond_t event_cond;
87     int reading;
88
89     char queue[4096];
90     int queue_len;
91
92     unsigned int request_expected;
93     unsigned int request_read;
94     unsigned int request_completed;
95     struct reply_list *current_reply;
96     struct reply_list **current_reply_tail;
97
98     _xcb_map *replies;
99     struct event_list *events;
100     struct event_list **events_tail;
101     struct reader_list *readers;
102
103     struct pending_reply *pending_replies;
104     struct pending_reply **pending_replies_tail;
105 } _xcb_in;
106
107 int _xcb_in_init(_xcb_in *in);
108 void _xcb_in_destroy(_xcb_in *in);
109
110 int _xcb_in_expect_reply(XCBConnection *c, unsigned int request, enum workarounds workaround, int flags);
111
112 int _xcb_in_read(XCBConnection *c);
113 int _xcb_in_read_block(XCBConnection *c, void *buf, int nread);
114
115
116 /* xcb_xid.c */
117
118 typedef struct _xcb_xid {
119     pthread_mutex_t lock;
120     CARD32 last;
121     CARD32 base;
122     CARD32 max;
123     CARD32 inc;
124 } _xcb_xid;
125
126 int _xcb_xid_init(XCBConnection *c);
127 void _xcb_xid_destroy(XCBConnection *c);
128
129
130 /* xcb_ext.c */
131
132 typedef struct _xcb_ext {
133     pthread_mutex_t lock;
134     struct lazyreply *extensions;
135     int extensions_size;
136 } _xcb_ext;
137
138 int _xcb_ext_init(XCBConnection *c);
139 void _xcb_ext_destroy(XCBConnection *c);
140
141
142 /* xcb_conn.c */
143
144 struct XCBConnection {
145     int has_error;
146
147     /* constant data */
148     XCBSetup *setup;
149     int fd;
150
151     /* I/O data */
152     pthread_mutex_t iolock;
153     _xcb_in in;
154     _xcb_out out;
155
156     /* misc data */
157     _xcb_ext ext;
158     _xcb_xid xid;
159 };
160
161 void _xcb_conn_shutdown(XCBConnection *c);
162 int _xcb_conn_wait(XCBConnection *c, pthread_cond_t *cond, struct iovec **vector, int *count);
163
164
165 /* xcb_auth.c */
166
167 int _xcb_get_auth_info(int fd, XCBAuthInfo *info);
168
169 #ifdef GCC_HAS_VISIBILITY
170 #pragma GCC visibility pop
171 #endif
172
173 #endif