XCB  1.9
xcb.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett.
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 __XCB_H__
29 #define __XCB_H__
30 #include <sys/types.h>
31 
32 #if defined(__solaris__)
33 #include <inttypes.h>
34 #else
35 #include <stdint.h>
36 #endif
37 
38 #ifndef _WIN32
39 #include <sys/uio.h>
40 #else
41 #include "xcb_windefs.h"
42 #endif
43 #include <pthread.h>
44 
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
61 /* Pre-defined constants */
62 
64 #define X_PROTOCOL 11
65 
67 #define X_PROTOCOL_REVISION 0
68 
70 #define X_TCP_PORT 6000
71 
73 #define XCB_CONN_ERROR 1
74 
76 #define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2
77 
79 #define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3
80 
82 #define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4
83 
85 #define XCB_CONN_CLOSED_PARSE_ERR 5
86 
88 #define XCB_CONN_CLOSED_INVALID_SCREEN 6
89 
90 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
91 
92 /* Opaque structures */
93 
102 /* Other types */
103 
109 typedef struct {
110  void *data;
111  int rem;
112  int index;
114 
120 typedef struct {
121  uint8_t response_type;
122  uint8_t pad0;
123  uint16_t sequence;
124  uint32_t length;
126 
132 typedef struct {
133  uint8_t response_type;
134  uint8_t pad0;
135  uint16_t sequence;
136  uint32_t pad[7];
137  uint32_t full_sequence;
139 
146 typedef struct {
147  uint8_t response_type;
148  uint8_t pad0;
149  uint16_t sequence;
150  uint32_t length;
151  uint16_t event_type;
152  uint16_t pad1;
153  uint32_t pad[5];
154  uint32_t full_sequence;
156 
162 typedef struct {
163  uint8_t response_type;
164  uint8_t error_code;
165  uint16_t sequence;
166  uint32_t resource_id;
167  uint16_t minor_code;
168  uint8_t major_code;
169  uint8_t pad0;
170  uint32_t pad[5];
171  uint32_t full_sequence;
173 
179 typedef struct {
180  unsigned int sequence;
182 
183 
184 /* Include the generated xproto header. */
185 #include "xproto.h"
186 
187 
189 #define XCB_NONE 0L
190 
192 #define XCB_COPY_FROM_PARENT 0L
193 
195 #define XCB_CURRENT_TIME 0L
196 
198 #define XCB_NO_SYMBOL 0L
199 
200 
201 /* xcb_auth.c */
202 
208 typedef struct xcb_auth_info_t {
209  int namelen;
210  char *name;
211  int datalen;
212  char *data;
214 
215 
216 /* xcb_out.c */
217 
227 
244 
263 
264 
265 /* xcb_in.c */
266 
277 
291 
307 
325 
340 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
341 
342 
343 /* xcb_ext.c */
344 
367 
380 
381 
382 /* xcb_conn.c */
383 
403 
413 
432 
446 
455 
456 
457 /* xcb_util.c */
458 
476 int xcb_parse_display(const char *name, char **host, int *display, int *screen);
477 
490 xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
491 
504 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
505 
506 
507 /* xcb_xid.c */
508 
517 uint32_t xcb_generate_id(xcb_connection_t *c);
518 
519 
524 #ifdef __cplusplus
525 }
526 #endif
527 
528 
529 #endif /* __XCB_H__ */
uint32_t xcb_generate_id(xcb_connection_t *c)
Allocates an XID for a new object.
Definition: xcb_xid.c:41
Generic error.
Definition: xcb.h:162
void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext)
Prefetch of extension data into the extension cache.
Definition: xcb_ext.c:106
uint8_t pad0
Definition: xcb.h:134
GE event.
Definition: xcb.h:146
xcb_query_extension_reply_t
Definition: xproto.h:4136
int index
Definition: xcb.h:112
uint8_t major_code
Definition: xcb.h:168
int xcb_parse_display(const char *name, char **host, int *display, int *screen)
Parses a display string name in the form documented by X(7x).
Definition: xcb_util.c:154
Definition: xcbext.h:39
Generic reply.
Definition: xcb.h:120
void * data
Definition: xcb.h:110
int namelen
Definition: xcb.h:209
uint8_t response_type
Definition: xcb.h:121
uint32_t xcb_get_maximum_request_length(xcb_connection_t *c)
Returns the maximum request length that this server accepts.
Definition: xcb_out.c:131
char * data
Definition: xcb.h:212
Generic iterator.
Definition: xcb.h:109
xcb_connection_t * xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info)
Connects to the X server.
Definition: xcb_conn.c:269
int xcb_get_file_descriptor(xcb_connection_t *c)
Access the file descriptor of the connection.
Definition: xcb_conn.c:255
char * name
Definition: xcb.h:210
uint8_t pad0
Definition: xcb.h:122
uint8_t response_type
Definition: xcb.h:147
uint16_t sequence
Definition: xcb.h:165
void xcb_disconnect(xcb_connection_t *c)
Closes the connection.
Definition: xcb_conn.c:309
struct xcb_auth_info_t xcb_auth_info_t
Container for authorization information.
uint16_t minor_code
Definition: xcb.h:167
int xcb_flush(xcb_connection_t *c)
Forces any buffered output to be written to the server.
Definition: xcb_out.c:302
xcb_generic_event_t * xcb_poll_for_event(xcb_connection_t *c)
Returns the next event or error from the server.
Definition: xcb_in.c:549
void xcb_prefetch_maximum_request_length(xcb_connection_t *c)
Prefetch the maximum request length without blocking.
Definition: xcb_out.c:108
xcb_connection_t * xcb_connect(const char *displayname, int *screenp)
Connects to the X server.
Definition: xcb_util.c:419
uint32_t full_sequence
Definition: xcb.h:171
uint8_t response_type
Definition: xcb.h:133
uint32_t length
Definition: xcb.h:124
uint8_t pad0
Definition: xcb.h:148
xcb_generic_error_t * xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie)
Return the error for a request, or NULL if none can ever arrive.
Definition: xcb_in.c:559
uint16_t sequence
Definition: xcb.h:149
uint32_t full_sequence
Definition: xcb.h:154
int rem
Definition: xcb.h:111
uint16_t sequence
Definition: xcb.h:135
uint8_t pad0
Definition: xcb.h:169
uint8_t error_code
Definition: xcb.h:164
uint16_t sequence
Definition: xcb.h:123
int datalen
Definition: xcb.h:211
const xcb_setup_t * xcb_get_setup(xcb_connection_t *c)
Access the data returned by the server.
Definition: xcb_conn.c:247
xcb_generic_event_t * xcb_wait_for_event(xcb_connection_t *c)
Returns the next event or error from the server.
Definition: xcb_in.c:518
Generic event.
Definition: xcb.h:132
xcb_generic_event_t * xcb_poll_for_queued_event(xcb_connection_t *c)
Returns the next event without reading from the connection.
Definition: xcb_in.c:554
Definition: xcbint.h:177
int xcb_connection_has_error(xcb_connection_t *c)
Test whether the connection has shut down due to a fatal error.
Definition: xcb_conn.c:263
xcb_connection_t * xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen)
Connects to the X server, using an authorization information.
Definition: xcb_util.c:424
uint32_t full_sequence
Definition: xcb.h:137
xcb_setup_t
Definition: xproto.h:453
void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence)
Discards the reply for a request.
Definition: xcb_in.c:487
uint8_t response_type
Definition: xcb.h:163
Container for authorization information.
Definition: xcb.h:208
const xcb_query_extension_reply_t * xcb_get_extension_data(xcb_connection_t *c, xcb_extension_t *ext)
Caches reply information from QueryExtension requests.
Definition: xcb_ext.c:88