2 * Copyright (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett.
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
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.
30 #include <sys/types.h>
32 #if defined(__solaris__)
41 #include "xcb_windefs.h"
55 * @defgroup XCB_Core_API XCB Core API
56 * @brief Core API of the XCB library.
61 /* Pre-defined constants */
63 /** Current protocol version */
66 /** Current minor version */
67 #define X_PROTOCOL_REVISION 0
69 /** X_TCP_PORT + display number = server port for TCP transport */
70 #define X_TCP_PORT 6000
72 /** xcb connection errors because of socket, pipe and other stream errors. */
73 #define XCB_CONN_ERROR 1
75 /** xcb connection shutdown because of extension not supported */
76 #define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2
78 /** malloc(), calloc() and realloc() error upon failure, for eg ENOMEM */
79 #define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3
81 /** Connection closed, exceeding request length that server accepts. */
82 #define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4
84 /** Connection closed, error during parsing display string. */
85 #define XCB_CONN_CLOSED_PARSE_ERR 5
87 /** Connection closed because the server does not have a screen matching the display. */
88 #define XCB_CONN_CLOSED_INVALID_SCREEN 6
90 /** Connection closed because some FD passing operation failed */
91 #define XCB_CONN_CLOSED_FDPASSING_FAILED 7
93 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
95 /* Opaque structures */
98 * @brief XCB Connection structure.
100 * A structure that contain all data that XCB needs to communicate with an X server.
102 typedef struct xcb_connection_t xcb_connection_t; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */
108 * @brief Generic iterator.
110 * A generic iterator structure.
113 void *data; /**< Data of the current iterator */
114 int rem; /**< remaining elements */
115 int index; /**< index of the current iterator */
116 } xcb_generic_iterator_t;
119 * @brief Generic reply.
121 * A generic reply structure.
124 uint8_t response_type; /**< Type of the response */
125 uint8_t pad0; /**< Padding */
126 uint16_t sequence; /**< Sequence number */
127 uint32_t length; /**< Length of the response */
128 } xcb_generic_reply_t;
131 * @brief Generic event.
133 * A generic event structure.
136 uint8_t response_type; /**< Type of the response */
137 uint8_t pad0; /**< Padding */
138 uint16_t sequence; /**< Sequence number */
139 uint32_t pad[7]; /**< Padding */
140 uint32_t full_sequence; /**< full sequence */
141 } xcb_generic_event_t;
144 * @brief Generic error.
146 * A generic error structure.
149 uint8_t response_type; /**< Type of the response */
150 uint8_t error_code; /**< Error code */
151 uint16_t sequence; /**< Sequence number */
152 uint32_t resource_id; /** < Resource ID for requests with side effects only */
153 uint16_t minor_code; /** < Minor opcode of the failed request */
154 uint8_t major_code; /** < Major opcode of the failed request */
156 uint32_t pad[5]; /**< Padding */
157 uint32_t full_sequence; /**< full sequence */
158 } xcb_generic_error_t;
161 * @brief Generic cookie.
163 * A generic cookie structure.
166 unsigned int sequence; /**< Sequence number */
170 /* Include the generated xproto header. */
174 /** XCB_NONE is the universal null resource or null atom parameter value for many core X requests */
177 /** XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters */
178 #define XCB_COPY_FROM_PARENT 0L
180 /** XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t */
181 #define XCB_CURRENT_TIME 0L
183 /** XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables */
184 #define XCB_NO_SYMBOL 0L
190 * @brief Container for authorization information.
192 * A container for authorization information to be sent to the X server.
194 typedef struct xcb_auth_info_t {
195 int namelen; /**< Length of the string name (as returned by strlen). */
196 char *name; /**< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". */
197 int datalen; /**< Length of the data member. */
198 char *data; /**< Data interpreted in a protocol-specific manner. */
205 * @brief Forces any buffered output to be written to the server.
206 * @param c: The connection to the X server.
207 * @return > @c 0 on success, <= @c 0 otherwise.
209 * Forces any buffered output to be written to the server. Blocks
210 * until the write is complete.
212 int xcb_flush(xcb_connection_t *c);
215 * @brief Returns the maximum request length that this server accepts.
216 * @param c: The connection to the X server.
217 * @return The maximum request length field.
219 * In the absence of the BIG-REQUESTS extension, returns the
220 * maximum request length field from the connection setup data, which
221 * may be as much as 65535. If the server supports BIG-REQUESTS, then
222 * the maximum request length field from the reply to the
223 * BigRequestsEnable request will be returned instead.
225 * Note that this length is measured in four-byte units, making the
226 * theoretical maximum lengths roughly 256kB without BIG-REQUESTS and
229 uint32_t xcb_get_maximum_request_length(xcb_connection_t *c);
232 * @brief Prefetch the maximum request length without blocking.
233 * @param c: The connection to the X server.
235 * Without blocking, does as much work as possible toward computing
236 * the maximum request length accepted by the X server.
238 * Invoking this function may cause a call to xcb_big_requests_enable,
239 * but will not block waiting for the reply.
240 * xcb_get_maximum_request_length will return the prefetched data
241 * after possibly blocking while the reply is retrieved.
243 * Note that in order for this function to be fully non-blocking, the
244 * application must previously have called
245 * xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply
246 * must have already arrived.
248 void xcb_prefetch_maximum_request_length(xcb_connection_t *c);
254 * @brief Returns the next event or error from the server.
255 * @param c: The connection to the X server.
256 * @return The next event from the server.
258 * Returns the next event or error from the server, or returns null in
259 * the event of an I/O error. Blocks until either an event or error
260 * arrive, or an I/O error occurs.
262 xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);
265 * @brief Returns the next event or error from the server.
266 * @param c: The connection to the X server.
267 * @return The next event from the server.
269 * Returns the next event or error from the server, if one is
270 * available, or returns @c NULL otherwise. If no event is available, that
271 * might be because an I/O error like connection close occurred while
272 * attempting to read the next event, in which case the connection is
273 * shut down when this function returns.
275 xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c);
278 * @brief Returns the next event without reading from the connection.
279 * @param c: The connection to the X server.
280 * @return The next already queued event from the server.
282 * This is a version of xcb_poll_for_event that only examines the
283 * event queue for new events. The function doesn't try to read new
284 * events from the connection if no queued events are found.
286 * This function is useful for callers that know in advance that all
287 * interesting events have already been read from the connection. For
288 * example, callers might use xcb_wait_for_reply and be interested
289 * only of events that preceded a specific reply.
291 xcb_generic_event_t *xcb_poll_for_queued_event(xcb_connection_t *c);
293 typedef struct xcb_special_event xcb_special_event_t;
296 * @brief Returns the next event from a special queue
298 xcb_generic_event_t *xcb_poll_for_special_event(xcb_connection_t *c,
299 xcb_special_event_t *se);
302 * @brief Returns the next event from a special queue, blocking until one arrives
304 xcb_generic_event_t *xcb_wait_for_special_event(xcb_connection_t *c,
305 xcb_special_event_t *se);
307 * @typedef typedef struct xcb_extension_t xcb_extension_t
309 typedef struct xcb_extension_t xcb_extension_t; /**< Opaque structure used as key for xcb_get_extension_data_t. */
313 * @brief Listen for a special event
315 xcb_special_event_t *xcb_register_for_special_xge(xcb_connection_t *c,
316 xcb_extension_t *ext,
321 * @brief Stop listening for a special event
323 void xcb_unregister_for_special_event(xcb_connection_t *c,
324 xcb_special_event_t *se);
327 * @brief Return the error for a request, or NULL if none can ever arrive.
328 * @param c: The connection to the X server.
329 * @param cookie: The request cookie.
330 * @return The error for the request, or NULL if none can ever arrive.
332 * The xcb_void_cookie_t cookie supplied to this function must have resulted
333 * from a call to xcb_[request_name]_checked(). This function will block
334 * until one of two conditions happens. If an error is received, it will be
335 * returned. If a reply to a subsequent request has already arrived, no error
336 * can arrive for this request, so this function will return NULL.
338 * Note that this function will perform a sync if needed to ensure that the
339 * sequence number will advance beyond that provided in cookie; this is a
340 * convenience to avoid races in determining whether the sync is needed.
342 xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie);
345 * @brief Discards the reply for a request.
346 * @param c: The connection to the X server.
347 * @param sequence: The request sequence number from a cookie.
349 * Discards the reply for a request. Additionally, any error generated
350 * by the request is also discarded (unless it was an _unchecked request
351 * and the error has already arrived).
353 * This function will not block even if the reply is not yet available.
355 * Note that the sequence really does have to come from an xcb cookie;
356 * this function is not designed to operate on socket-handoff replies.
358 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
364 * @brief Caches reply information from QueryExtension requests.
365 * @param c: The connection.
366 * @param ext: The extension data.
367 * @return A pointer to the xcb_query_extension_reply_t for the extension.
369 * This function is the primary interface to the "extension cache",
370 * which caches reply information from QueryExtension
371 * requests. Invoking this function may cause a call to
372 * xcb_query_extension to retrieve extension information from the
373 * server, and may block until extension data is received from the
376 * The result must not be freed. This storage is managed by the cache
379 const xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
382 * @brief Prefetch of extension data into the extension cache
383 * @param c: The connection.
384 * @param ext: The extension data.
386 * This function allows a "prefetch" of extension data into the
387 * extension cache. Invoking the function may cause a call to
388 * xcb_query_extension, but will not block waiting for the
389 * reply. xcb_get_extension_data will return the prefetched data after
390 * possibly blocking while it is retrieved.
392 void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
398 * @brief Access the data returned by the server.
399 * @param c: The connection.
400 * @return A pointer to an xcb_setup_t structure.
402 * Accessor for the data returned by the server when the xcb_connection_t
403 * was initialized. This data includes
404 * - the server's required format for images,
405 * - a list of available visuals,
406 * - a list of available screens,
407 * - the server's maximum request length (in the absence of the
408 * BIG-REQUESTS extension),
409 * - and other assorted information.
411 * See the X protocol specification for more details.
413 * The result must not be freed.
415 const xcb_setup_t *xcb_get_setup(xcb_connection_t *c);
418 * @brief Access the file descriptor of the connection.
419 * @param c: The connection.
420 * @return The file descriptor.
422 * Accessor for the file descriptor that was passed to the
423 * xcb_connect_to_fd call that returned @p c.
425 int xcb_get_file_descriptor(xcb_connection_t *c);
428 * @brief Test whether the connection has shut down due to a fatal error.
429 * @param c: The connection.
430 * @return > 0 if the connection is in an error state; 0 otherwise.
432 * Some errors that occur in the context of an xcb_connection_t
433 * are unrecoverable. When such an error occurs, the
434 * connection is shut down and further operations on the
435 * xcb_connection_t have no effect.
437 * @return XCB_CONN_ERROR, because of socket errors, pipe errors or other stream errors.
438 * @return XCB_CONN_CLOSED_EXT_NOTSUPPORTED, when extension not supported.
439 * @return XCB_CONN_CLOSED_MEM_INSUFFICIENT, when memory not available.
440 * @return XCB_CONN_CLOSED_REQ_LEN_EXCEED, exceeding request length that server accepts.
441 * @return XCB_CONN_CLOSED_PARSE_ERR, error during parsing display string.
442 * @return XCB_CONN_CLOSED_INVALID_SCREEN, because the server does not have a screen matching the display.
444 int xcb_connection_has_error(xcb_connection_t *c);
447 * @brief Connects to the X server.
448 * @param fd: The file descriptor.
449 * @param auth_info: Authentication data.
450 * @return A newly allocated xcb_connection_t structure.
452 * Connects to an X server, given the open socket @p fd and the
453 * xcb_auth_info_t @p auth_info. The file descriptor @p fd is
454 * bidirectionally connected to an X server. If the connection
455 * should be unauthenticated, @p auth_info must be @c
458 xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info);
461 * @brief Closes the connection.
462 * @param c: The connection.
464 * Closes the file descriptor and frees all memory associated with the
467 void xcb_disconnect(xcb_connection_t *c);
473 * @brief Parses a display string name in the form documented by X(7x).
474 * @param name: The name of the display.
475 * @param host: A pointer to a malloc'd copy of the hostname.
476 * @param display: A pointer to the display number.
477 * @param screen: A pointer to the screen number.
478 * @return 0 on failure, non 0 otherwise.
480 * Parses the display string name @p display_name in the form
481 * documented by X(7x). Has no side effects on failure. If
482 * @p displayname is @c NULL or empty, it uses the environment
483 * variable DISPLAY. @p hostp is a pointer to a newly allocated string
484 * that contain the host name. @p displayp is set to the display
485 * number and @p screenp to the preferred screen number. @p screenp
486 * can be @c NULL. If @p displayname does not contain a screen number,
489 int xcb_parse_display(const char *name, char **host, int *display, int *screen);
492 * @brief Connects to the X server.
493 * @param displayname: The name of the display.
494 * @param screenp: A pointer to a preferred screen number.
495 * @return A newly allocated xcb_connection_t structure.
497 * Connects to the X server specified by @p displayname. If @p
498 * displayname is @c NULL, uses the value of the DISPLAY environment
499 * variable. If a particular screen on that server is preferred, the
500 * int pointed to by @p screenp (if not @c NULL) will be set to that
501 * screen; otherwise the screen will be set to 0.
503 xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
506 * @brief Connects to the X server, using an authorization information.
507 * @param display: The name of the display.
508 * @param auth: The authorization information.
509 * @param screen: A pointer to a preferred screen number.
510 * @return A newly allocated xcb_connection_t structure.
512 * Connects to the X server specified by @p displayname, using the
513 * authorization @p auth. If a particular screen on that server is
514 * preferred, the int pointed to by @p screenp (if not @c NULL) will
515 * be set to that screen; otherwise @p screenp will be set to 0.
517 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
523 * @brief Allocates an XID for a new object.
524 * @param c: The connection.
525 * @return A newly allocated XID.
527 * Allocates an XID for a new object. Typically used just prior to
528 * various object creation functions, such as xcb_create_window.
530 uint32_t xcb_generate_id(xcb_connection_t *c);
542 #endif /* __XCB_H__ */