XCB  1.16.1
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 
54 #ifdef __GNUC__
55 #define XCB_PACKED __attribute__((__packed__))
56 #else
57 #define XCB_PACKED
58 #endif
59 
67 /* Pre-defined constants */
68 
70 #define X_PROTOCOL 11
71 
73 #define X_PROTOCOL_REVISION 0
74 
76 #define X_TCP_PORT 6000
77 
79 #define XCB_CONN_ERROR 1
80 
82 #define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2
83 
85 #define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3
86 
88 #define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4
89 
91 #define XCB_CONN_CLOSED_PARSE_ERR 5
92 
94 #define XCB_CONN_CLOSED_INVALID_SCREEN 6
95 
97 #define XCB_CONN_CLOSED_FDPASSING_FAILED 7
98 
99 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
100 
101 /* Opaque structures */
102 
111 /* Other types */
112 
118 typedef struct {
119  void *data;
120  int rem;
121  int index;
123 
129 typedef struct {
130  uint8_t response_type;
131  uint8_t pad0;
132  uint16_t sequence;
133  uint32_t length;
135 
141 typedef struct {
142  uint8_t response_type;
143  uint8_t pad0;
144  uint16_t sequence;
145  uint32_t pad[7];
146  uint32_t full_sequence;
148 
154 typedef struct {
155  uint8_t response_type;
156  uint8_t pad0;
157  uint16_t sequence;
158  uint32_t pad[7];
160 
170 typedef struct {
171  uint8_t response_type;
172  uint8_t pad0;
173  uint16_t sequence;
174  uint32_t length;
175  uint16_t event_type;
176  uint16_t pad1;
177  uint32_t pad[5];
178  uint32_t full_sequence;
180 
186 typedef struct {
187  uint8_t response_type;
188  uint8_t error_code;
189  uint16_t sequence;
190  uint32_t resource_id;
191  uint16_t minor_code;
192  uint8_t major_code;
193  uint8_t pad0;
194  uint32_t pad[5];
195  uint32_t full_sequence;
197 
203 typedef struct {
204  unsigned int sequence;
206 
207 
208 /* Include the generated xproto header. */
209 #include "xproto.h"
210 
211 
213 #define XCB_NONE 0L
214 
216 #define XCB_COPY_FROM_PARENT 0L
217 
219 #define XCB_CURRENT_TIME 0L
220 
222 #define XCB_NO_SYMBOL 0L
223 
224 
225 /* xcb_auth.c */
226 
232 typedef struct xcb_auth_info_t {
233  int namelen;
234  char *name;
235  int datalen;
236  char *data;
238 
239 
240 /* xcb_out.c */
241 
251 
268 
287 
288 
289 /* xcb_in.c */
290 
301 
314 
330 
332 
337  xcb_special_event_t *se);
338 
343  xcb_special_event_t *se);
353  xcb_extension_t *ext,
354  uint32_t eid,
355  uint32_t *stamp);
356 
361  xcb_special_event_t *se);
362 
380 
395 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
396 
416 void xcb_discard_reply64(xcb_connection_t *c, uint64_t sequence);
417 
418 /* xcb_ext.c */
419 
437 
450 
451 
452 /* xcb_conn.c */
453 
472 const struct xcb_setup_t *xcb_get_setup(xcb_connection_t *c);
473 
483 
503 
522 
531 
532 
533 /* xcb_util.c */
534 
552 int xcb_parse_display(const char *name, char **host, int *display, int *screen);
553 
571 xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
572 
590 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
591 
592 
593 /* xcb_xid.c */
594 
603 uint32_t xcb_generate_id(xcb_connection_t *c);
604 
605 
617 uint64_t
619 
632 uint64_t
634 
639 #ifdef __cplusplus
640 }
641 #endif
642 
643 
644 #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:186
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:143
GE event.
Definition: xcb.h:170
uint64_t xcb_total_read(xcb_connection_t *c)
Obtain number of bytes read from the connection.
Definition: xcb_conn.c:563
xcb_query_extension_reply_t
Definition: xproto.h:4287
int index
Definition: xcb.h:121
uint8_t major_code
Definition: xcb.h:192
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:220
Definition: xcbext.h:39
Generic reply.
Definition: xcb.h:129
void * data
Definition: xcb.h:119
int namelen
Definition: xcb.h:233
uint8_t response_type
Definition: xcb.h:130
uint32_t xcb_get_maximum_request_length(xcb_connection_t *c)
Returns the maximum request length that this server accepts.
Definition: xcb_out.c:162
char * data
Definition: xcb.h:236
Generic iterator.
Definition: xcb.h:118
xcb_connection_t * xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info)
Connects to the X server.
Definition: xcb_conn.c:354
int xcb_get_file_descriptor(xcb_connection_t *c)
Access the file descriptor of the connection.
Definition: xcb_conn.c:340
char * name
Definition: xcb.h:234
uint8_t pad0
Definition: xcb.h:131
uint8_t response_type
Definition: xcb.h:171
uint16_t sequence
Definition: xcb.h:189
void xcb_disconnect(xcb_connection_t *c)
Closes the connection.
Definition: xcb_conn.c:398
struct xcb_auth_info_t xcb_auth_info_t
Container for authorization information.
uint16_t minor_code
Definition: xcb.h:191
int xcb_flush(xcb_connection_t *c)
Forces any buffered output to be written to the server.
Definition: xcb_out.c:421
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:726
void xcb_prefetch_maximum_request_length(xcb_connection_t *c)
Prefetch the maximum request length without blocking.
Definition: xcb_out.c:139
xcb_connection_t * xcb_connect(const char *displayname, int *screenp)
Connects to the X server.
Definition: xcb_util.c:507
uint32_t full_sequence
Definition: xcb.h:195
uint8_t response_type
Definition: xcb.h:142
uint32_t length
Definition: xcb.h:133
uint8_t pad0
Definition: xcb.h:172
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:736
void xcb_discard_reply64(xcb_connection_t *c, uint64_t sequence)
Discards the reply for a request, given by a 64bit sequence number.
Definition: xcb_in.c:643
uint16_t sequence
Definition: xcb.h:173
uint8_t pad0
Definition: xcb.h:156
uint64_t xcb_total_written(xcb_connection_t *c)
Obtain number of bytes written to the connection.
Definition: xcb_conn.c:576
uint32_t full_sequence
Definition: xcb.h:178
int rem
Definition: xcb.h:120
Definition: xcb_in.c:64
const struct 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
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:777
uint16_t sequence
Definition: xcb.h:144
uint8_t pad0
Definition: xcb.h:193
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:860
uint16_t sequence
Definition: xcb.h:157
uint8_t error_code
Definition: xcb.h:188
uint16_t sequence
Definition: xcb.h:132
int datalen
Definition: xcb.h:235
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:695
Raw Generic event.
Definition: xcb.h:154
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:817
Generic event.
Definition: xcb.h:141
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:731
Definition: xcbint.h:208
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:348
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:512
const struct xcb_setup_t * xcb_get_setup(xcb_connection_t *c)
Access the data returned by the server.
Definition: xcb_conn.c:332
uint32_t full_sequence
Definition: xcb.h:146
xcb_setup_t
Definition: xproto.h:475
uint8_t response_type
Definition: xcb.h:155
void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence)
Discards the reply for a request.
Definition: xcb_in.c:629
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:792
uint8_t response_type
Definition: xcb.h:187
Container for authorization information.
Definition: xcb.h:232