XCB 1.8.1

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

xcbext.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 __XCBEXT_H
29 #define __XCBEXT_H
30
31 #include "xcb.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /* xcb_ext.c */
38
39 struct xcb_extension_t {
40 const char *name;
41 int global_id;
42 };
43
44
45 /* xcb_out.c */
46
47 typedef struct {
48 size_t count;
49 xcb_extension_t *ext;
50 uint8_t opcode;
51 uint8_t isvoid;
52 } xcb_protocol_request_t;
53
54 enum xcb_send_request_flags_t {
55 XCB_REQUEST_CHECKED = 1 << 0,
56 XCB_REQUEST_RAW = 1 << 1,
57 XCB_REQUEST_DISCARD_REPLY = 1 << 2
58 };
59
60 unsigned int xcb_send_request(xcb_connection_t *c, int flags, struct iovec *vector, const xcb_protocol_request_t *request);
61
62 /* xcb_take_socket allows external code to ask XCB for permission to
63 * take over the write side of the socket and send raw data with
64 * xcb_writev. xcb_take_socket provides the sequence number of the last
65 * request XCB sent. The caller of xcb_take_socket must supply a
66 * callback which XCB can call when it wants the write side of the
67 * socket back to make a request. This callback synchronizes with the
68 * external socket owner and flushes any output queues if appropriate.
69 * If you are sending requests which won't cause a reply, please note the
70 * comment for xcb_writev which explains some sequence number wrap issues.
71 * */
72 int xcb_take_socket(xcb_connection_t *c, void (*return_socket)(void *closure), void *closure, int flags, uint64_t *sent);
73
74 /* You must own the write-side of the socket (you've called
75 * xcb_take_socket, and haven't returned from return_socket yet) to call
76 * xcb_writev. Also, the iovec must have at least 1 byte of data in it.
77 * You have to make sure that xcb can detect sequence number wraps correctly.
78 * This means that the first request you send after xcb_take_socket must cause a
79 * reply (e.g. just insert a GetInputFocus request). After every (1 << 16) - 1
80 * requests without a reply, you have to insert a request which will cause a
81 * reply. You can again use GetInputFocus for this. You do not have to wait for
82 * any of the GetInputFocus replies, but can instead handle them via
83 * xcb_discard_reply(). */
84 int xcb_writev(xcb_connection_t *c, struct iovec *vector, int count, uint64_t requests);
85
86
87 /* xcb_in.c */
88
89 void *xcb_wait_for_reply(xcb_connection_t *c, unsigned int request, xcb_generic_error_t **e);
90 int xcb_poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error);
91
92
93 /* xcb_util.c */
94
95 int xcb_popcount(uint32_t mask);
96 int xcb_sumof(uint8_t *list, int len);
97
98 #ifdef __cplusplus
99 }
100 #endif
101
102 #endif