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__)
51 * @defgroup XCB_Core_API XCB Core API
52 * @brief Core API of the XCB library.
57 /* Pre-defined constants */
59 /** Current protocol version */
62 /** Current minor version */
63 #define X_PROTOCOL_REVISION 0
65 /** X_TCP_PORT + display number = server port for TCP transport */
66 #define X_TCP_PORT 6000
68 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
70 /* Opaque structures */
73 * @brief XCB Connection structure.
75 * A structure that contain all data that XCB needs to communicate with an X server.
77 typedef struct xcb_connection_t xcb_connection_t; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */
83 * @brief Generic iterator.
85 * A generic iterator structure.
88 void *data; /**< Data of the current iterator */
89 int rem; /**< remaining elements */
90 int index; /**< index of the current iterator */
91 } xcb_generic_iterator_t;
94 * @brief Generic reply.
96 * A generic reply structure.
99 uint8_t response_type; /**< Type of the response */
100 uint8_t pad0; /**< Padding */
101 uint16_t sequence; /**< Sequence number */
102 uint32_t length; /**< Length of the response */
103 } xcb_generic_reply_t;
106 * @brief Generic event.
108 * A generic event structure.
111 uint8_t response_type; /**< Type of the response */
112 uint8_t pad0; /**< Padding */
113 uint16_t sequence; /**< Sequence number */
114 uint32_t pad[7]; /**< Padding */
115 uint32_t full_sequence; /**< full sequence */
116 } xcb_generic_event_t;
121 * An event as sent by the XGE extension. The length field specifies the
122 * number of 4-byte blocks trailing the struct.
125 uint8_t response_type; /**< Type of the response */
126 uint8_t pad0; /**< Padding */
127 uint16_t sequence; /**< Sequence number */
131 uint32_t pad[5]; /**< Padding */
132 uint32_t full_sequence; /**< full sequence */
136 * @brief Generic error.
138 * A generic error structure.
141 uint8_t response_type; /**< Type of the response */
142 uint8_t error_code; /**< Error code */
143 uint16_t sequence; /**< Sequence number */
144 uint32_t resource_id; /** < Resource ID for requests with side effects only */
145 uint16_t minor_code; /** < Minor opcode of the failed request */
146 uint8_t major_code; /** < Major opcode of the failed request */
148 uint32_t pad[5]; /**< Padding */
149 uint32_t full_sequence; /**< full sequence */
150 } xcb_generic_error_t;
153 * @brief Generic cookie.
155 * A generic cookie structure.
158 unsigned int sequence; /**< Sequence number */
162 /* Include the generated xproto header. */
166 /** XCB_NONE is the universal null resource or null atom parameter value for many core X requests */
169 /** XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters */
170 #define XCB_COPY_FROM_PARENT 0L
172 /** XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t */
173 #define XCB_CURRENT_TIME 0L
175 /** XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables */
176 #define XCB_NO_SYMBOL 0L
182 * @brief Container for authorization information.
184 * A container for authorization information to be sent to the X server.
186 typedef struct xcb_auth_info_t {
187 int namelen; /**< Length of the string name (as returned by strlen). */
188 char *name; /**< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". */
189 int datalen; /**< Length of the data member. */
190 char *data; /**< Data interpreted in a protocol-specific manner. */
197 * @brief Forces any buffered output to be written to the server.
198 * @param c: The connection to the X server.
199 * @return > @c 0 on success, <= @c 0 otherwise.
201 * Forces any buffered output to be written to the server. Blocks
202 * until the write is complete.
204 int xcb_flush(xcb_connection_t *c);
207 * @brief Returns the maximum request length that this server accepts.
208 * @param c: The connection to the X server.
209 * @return The maximum request length field.
211 * In the absence of the BIG-REQUESTS extension, returns the
212 * maximum request length field from the connection setup data, which
213 * may be as much as 65535. If the server supports BIG-REQUESTS, then
214 * the maximum request length field from the reply to the
215 * BigRequestsEnable request will be returned instead.
217 * Note that this length is measured in four-byte units, making the
218 * theoretical maximum lengths roughly 256kB without BIG-REQUESTS and
221 uint32_t xcb_get_maximum_request_length(xcb_connection_t *c);
224 * @brief Prefetch the maximum request length without blocking.
225 * @param c: The connection to the X server.
227 * Without blocking, does as much work as possible toward computing
228 * the maximum request length accepted by the X server.
230 * Invoking this function may cause a call to xcb_big_requests_enable,
231 * but will not block waiting for the reply.
232 * xcb_get_maximum_request_length will return the prefetched data
233 * after possibly blocking while the reply is retrieved.
235 * Note that in order for this function to be fully non-blocking, the
236 * application must previously have called
237 * xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply
238 * must have already arrived.
240 void xcb_prefetch_maximum_request_length(xcb_connection_t *c);
246 * @brief Returns the next event or error from the server.
247 * @param c: The connection to the X server.
248 * @return The next event from the server.
250 * Returns the next event or error from the server, or returns null in
251 * the event of an I/O error. Blocks until either an event or error
252 * arrive, or an I/O error occurs.
254 xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);
257 * @brief Returns the next event or error from the server.
258 * @param c: The connection to the X server.
259 * error status of the operation.
260 * @return The next event from the server.
262 * Returns the next event or error from the server, if one is
263 * available, or returns @c NULL otherwise. If no event is available, that
264 * might be because an I/O error like connection close occurred while
265 * attempting to read the next event, in which case the connection is
266 * shut down when this function returns.
268 xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c);
271 * @brief Return the error for a request, or NULL if none can ever arrive.
272 * @param c: The connection to the X server.
273 * @param cookie: The request cookie.
274 * @return The error for the request, or NULL if none can ever arrive.
276 * The xcb_void_cookie_t cookie supplied to this function must have resulted
277 * from a call to xcb_[request_name]_checked(). This function will block
278 * until one of two conditions happens. If an error is received, it will be
279 * returned. If a reply to a subsequent request has already arrived, no error
280 * can arrive for this request, so this function will return NULL.
282 * Note that this function will perform a sync if needed to ensure that the
283 * sequence number will advance beyond that provided in cookie; this is a
284 * convenience to avoid races in determining whether the sync is needed.
286 xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie);
289 * @brief Discards the reply for a request.
290 * @param c: The connection to the X server.
291 * @param sequence: The request sequence number from a cookie.
293 * Discards the reply for a request. Additionally, any error generated
294 * by the request is also discarded (unless it was an _unchecked request
295 * and the error has already arrived).
297 * This function will not block even if the reply is not yet available.
299 * Note that the sequence really does have to come from an xcb cookie;
300 * this function is not designed to operate on socket-handoff replies.
302 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
308 * @typedef typedef struct xcb_extension_t xcb_extension_t
310 typedef struct xcb_extension_t xcb_extension_t; /**< Opaque structure used as key for xcb_get_extension_data_t. */
313 * @brief Caches reply information from QueryExtension requests.
314 * @param c: The connection.
315 * @param ext: The extension data.
316 * @return A pointer to the xcb_query_extension_reply_t for the extension.
318 * This function is the primary interface to the "extension cache",
319 * which caches reply information from QueryExtension
320 * requests. Invoking this function may cause a call to
321 * xcb_query_extension to retrieve extension information from the
322 * server, and may block until extension data is received from the
325 * The result must not be freed. This storage is managed by the cache
328 const xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
331 * @brief Prefetch of extension data into the extension cache
332 * @param c: The connection.
333 * @param ext: The extension data.
335 * This function allows a "prefetch" of extension data into the
336 * extension cache. Invoking the function may cause a call to
337 * xcb_query_extension, but will not block waiting for the
338 * reply. xcb_get_extension_data will return the prefetched data after
339 * possibly blocking while it is retrieved.
341 void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
347 * @brief Access the data returned by the server.
348 * @param c: The connection.
349 * @return A pointer to an xcb_setup_t structure.
351 * Accessor for the data returned by the server when the xcb_connection_t
352 * was initialized. This data includes
353 * - the server's required format for images,
354 * - a list of available visuals,
355 * - a list of available screens,
356 * - the server's maximum request length (in the absence of the
357 * BIG-REQUESTS extension),
358 * - and other assorted information.
360 * See the X protocol specification for more details.
362 * The result must not be freed.
364 const xcb_setup_t *xcb_get_setup(xcb_connection_t *c);
367 * @brief Access the file descriptor of the connection.
368 * @param c: The connection.
369 * @return The file descriptor.
371 * Accessor for the file descriptor that was passed to the
372 * xcb_connect_to_fd call that returned @p c.
374 int xcb_get_file_descriptor(xcb_connection_t *c);
377 * @brief Test whether the connection has shut down due to a fatal error.
378 * @param c: The connection.
379 * @return 1 if the connection is in an error state; 0 otherwise.
381 * Some errors that occur in the context of an xcb_connection_t
382 * are unrecoverable. When such an error occurs, the
383 * connection is shut down and further operations on the
384 * xcb_connection_t have no effect.
386 * @todo Other functions should document the conditions in
387 * which they shut down the connection.
389 int xcb_connection_has_error(xcb_connection_t *c);
392 * @brief Connects to the X server.
393 * @param fd: The file descriptor.
394 * @param auth_info: Authentication data.
395 * @return A newly allocated xcb_connection_t structure.
397 * Connects to an X server, given the open socket @p fd and the
398 * xcb_auth_info_t @p auth_info. The file descriptor @p fd is
399 * bidirectionally connected to an X server. If the connection
400 * should be unauthenticated, @p auth_info must be @c
403 xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info);
406 * @brief Closes the connection.
407 * @param c: The connection.
409 * Closes the file descriptor and frees all memory associated with the
412 void xcb_disconnect(xcb_connection_t *c);
418 * @brief Parses a display string name in the form documented by X(7x).
419 * @param name: The name of the display.
420 * @param host: A pointer to a malloc'd copy of the hostname.
421 * @param display: A pointer to the display number.
422 * @param screen: A pointer to the screen number.
423 * @return 0 on failure, non 0 otherwise.
425 * Parses the display string name @p display_name in the form
426 * documented by X(7x). Has no side effects on failure. If
427 * @p displayname is @c NULL or empty, it uses the environment
428 * variable DISPLAY. @p hostp is a pointer to a newly allocated string
429 * that contain the host name. @p displayp is set to the display
430 * number and @p screenp to the preferred screen number. @p screenp
431 * can be @c NULL. If @p displayname does not contain a screen number,
434 int xcb_parse_display(const char *name, char **host, int *display, int *screen);
437 * @brief Connects to the X server.
438 * @param displayname: The name of the display.
439 * @param screenp: A pointer to a preferred screen number.
440 * @return A newly allocated xcb_connection_t structure.
442 * Connects to the X server specified by @p displayname. If @p
443 * displayname is @c NULL, uses the value of the DISPLAY environment
444 * variable. If a particular screen on that server is preferred, the
445 * int pointed to by @p screenp (if not @c NULL) will be set to that
446 * screen; otherwise the screen will be set to 0.
448 xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
451 * @brief Connects to the X server, using an authorization information.
452 * @param display: The name of the display.
453 * @param auth: The authorization information.
454 * @param screen: A pointer to a preferred screen number.
455 * @return A newly allocated xcb_connection_t structure.
457 * Connects to the X server specified by @p displayname, using the
458 * authorization @p auth. If a particular screen on that server is
459 * preferred, the int pointed to by @p screenp (if not @c NULL) will
460 * be set to that screen; otherwise @p screenp will be set to 0.
462 xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
468 * @brief Allocates an XID for a new object.
469 * @param c: The connection.
470 * @return A newly allocated XID.
472 * Allocates an XID for a new object. Typically used just prior to
473 * various object creation functions, such as xcb_create_window.
475 uint32_t xcb_generate_id(xcb_connection_t *c);
487 #endif /* __XCB_H__ */