XCB  1.10
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 
91 #define XCB_CONN_CLOSED_FDPASSING_FAILED 7
92 
93 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
94 
95 /* Opaque structures */
96 
105 /* Other types */
106 
112 typedef struct {
113  void *data;
114  int rem;
115  int index;
117 
123 typedef struct {
124  uint8_t response_type;
125  uint8_t pad0;
126  uint16_t sequence;
127  uint32_t length;
129 
135 typedef struct {
136  uint8_t response_type;
137  uint8_t pad0;
138  uint16_t sequence;
139  uint32_t pad[7];
140  uint32_t full_sequence;
142 
152 typedef struct {
153  uint8_t response_type;
154  uint8_t pad0;
155  uint16_t sequence;
156  uint32_t length;
157  uint16_t event_type;
158  uint16_t pad1;
159  uint32_t pad[5];
160  uint32_t full_sequence;
162 
168 typedef struct {
169  uint8_t response_type;
170  uint8_t error_code;
171  uint16_t sequence;
172  uint32_t resource_id;
173  uint16_t minor_code;
174  uint8_t major_code;
175  uint8_t pad0;
176  uint32_t pad[5];
177  uint32_t full_sequence;
179 
185 typedef struct {
186  unsigned int sequence;
188 
189 
190 /* Include the generated xproto header. */
191 #include "xproto.h"
192 
193 
195 #define XCB_NONE 0L
196 
198 #define XCB_COPY_FROM_PARENT 0L
199 
201 #define XCB_CURRENT_TIME 0L
202 
204 #define XCB_NO_SYMBOL 0L
205 
206 
207 /* xcb_auth.c */
208 
214 typedef struct xcb_auth_info_t {
215  int namelen;
216  char *name;
217  int datalen;
218  char *data;
220 
221 
222 /* xcb_out.c */
223 
233 
250 
269 
270 
271 /* xcb_in.c */
272 
283 
296 
312 
314 
319  xcb_special_event_t *se);
320 
325  xcb_special_event_t *se);
336  xcb_extension_t *ext,
337  uint32_t eid,
338  uint32_t *stamp);
339 
344  xcb_special_event_t *se);
345 
363 
378 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
379 
380 
381 /* xcb_ext.c */
382 
400 
413 
414 
415 /* xcb_conn.c */
416 
436 
446 
465 
479 
488 
489 
490 /* xcb_util.c */
491 
509 int xcb_parse_display(const char *name, char **host, int *display, int *screen);
510 
523 xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
524 
537 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
538 
539 
540 /* xcb_xid.c */
541 
550 uint32_t xcb_generate_id(xcb_connection_t *c);
551 
552 
557 #ifdef __cplusplus
558 }
559 #endif
560 
561 
562 #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:168
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:137
GE event.
Definition: xcb.h:152
xcb_query_extension_reply_t
Definition: xproto.h:4152
int index
Definition: xcb.h:115
uint8_t major_code
Definition: xcb.h:174
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:123
void * data
Definition: xcb.h:113
int namelen
Definition: xcb.h:215
uint8_t response_type
Definition: xcb.h:124
uint32_t xcb_get_maximum_request_length(xcb_connection_t *c)
Returns the maximum request length that this server accepts.
Definition: xcb_out.c:158
char * data
Definition: xcb.h:218
Generic iterator.
Definition: xcb.h:112
xcb_connection_t * xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info)
Connects to the X server.
Definition: xcb_conn.c:302
int xcb_get_file_descriptor(xcb_connection_t *c)
Access the file descriptor of the connection.
Definition: xcb_conn.c:288
char * name
Definition: xcb.h:216
uint8_t pad0
Definition: xcb.h:125
uint8_t response_type
Definition: xcb.h:153
uint16_t sequence
Definition: xcb.h:171
void xcb_disconnect(xcb_connection_t *c)
Closes the connection.
Definition: xcb_conn.c:342
struct xcb_auth_info_t xcb_auth_info_t
Container for authorization information.
uint16_t minor_code
Definition: xcb.h:173
int xcb_flush(xcb_connection_t *c)
Forces any buffered output to be written to the server.
Definition: xcb_out.c:346
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:645
void xcb_prefetch_maximum_request_length(xcb_connection_t *c)
Prefetch the maximum request length without blocking.
Definition: xcb_out.c:135
xcb_connection_t * xcb_connect(const char *displayname, int *screenp)
Connects to the X server.
Definition: xcb_util.c:423
uint32_t full_sequence
Definition: xcb.h:177
uint8_t response_type
Definition: xcb.h:136
uint32_t length
Definition: xcb.h:127
uint8_t pad0
Definition: xcb.h:154
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:655
uint16_t sequence
Definition: xcb.h:155
uint32_t full_sequence
Definition: xcb.h:160
int rem
Definition: xcb.h:114
Definition: xcb_in.c:63
xcb_generic_event_t * xcb_poll_for_special_event(xcb_connection_t *c, xcb_special_event_t *se)
Returns the next event from a special queue.
Definition: xcb_in.c:691
uint16_t sequence
Definition: xcb.h:138
uint8_t pad0
Definition: xcb.h:175
void xcb_unregister_for_special_event(xcb_connection_t *c, xcb_special_event_t *se)
Stop listening for a special event.
Definition: xcb_in.c:766
uint8_t error_code
Definition: xcb.h:170
uint16_t sequence
Definition: xcb.h:126
int datalen
Definition: xcb.h:217
const xcb_setup_t * xcb_get_setup(xcb_connection_t *c)
Access the data returned by the server.
Definition: xcb_conn.c:280
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:614
xcb_special_event_t * xcb_register_for_special_xge(xcb_connection_t *c, xcb_extension_t *ext, uint32_t eid, uint32_t *stamp)
Listen for a special event.
Definition: xcb_in.c:723
Generic event.
Definition: xcb.h:135
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:650
Definition: xcbint.h:194
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:296
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:428
uint32_t full_sequence
Definition: xcb.h:140
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:583
xcb_generic_event_t * xcb_wait_for_special_event(xcb_connection_t *c, xcb_special_event_t *se)
Returns the next event from a special queue, blocking until one arrives.
Definition: xcb_in.c:704
uint8_t response_type
Definition: xcb.h:169
Container for authorization information.
Definition: xcb.h:214
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