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 /* TODO: check for stdint in config? (HAVE_STDINT) fallback? */
35 /* FIXME: these names conflict with those defined in Xmd.h. */
39 typedef uint8_t CARD8;
40 typedef uint16_t CARD16;
41 typedef uint32_t CARD32;
43 typedef int16_t INT16;
44 typedef int32_t INT32;
55 #if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
56 #define deprecated __attribute__((__deprecated__))
67 * @defgroup XCB_Core_Api XCB Core API
68 * @brief Core API of the XCB library.
73 /* Pre-defined constants */
75 /** Current protocol version */
78 /** Current minor version */
79 #define X_PROTOCOL_REVISION 0
81 /** X_TCP_PORT + display number = server port for TCP transport */
82 #define X_TCP_PORT 6000
84 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
87 /** XCBNone is the universal null resource or null atom parameter value for many core X requests */
90 /** XCBCopyFromParent can be used for many CreateWindow parameters */
91 #define XCBCopyFromParent 0L
93 /* Opaque structures */
96 * @brief XCB Connection structure.
98 * A structure that contain all data that XCB needs to communicate with an X server.
100 typedef struct XCBConnection XCBConnection; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */
106 * @brief Generic iterator.
108 * A generic iterator structure.
111 void *data; /**< Data of the current iterator */
112 int rem; /**< remaining elements */
113 int index; /**< index of the current iterator */
117 * @brief Generic reply.
119 * A generic reply structure.
122 BYTE response_type; /**< Type of the response */
123 CARD8 pad0; /**< Padding */
124 CARD16 sequence; /**< Sequence number */
125 CARD32 length; /**< Length of the response */
129 * @brief Generic event.
131 * A generic event structure.
134 BYTE response_type; /**< Type of the response */
135 CARD8 pad0; /**< Padding */
136 CARD16 sequence; /**< Sequence number */
137 CARD32 pad[7]; /**< Padding */
138 CARD32 full_sequence;
142 * @brief Generic error.
144 * A generic error structure.
147 BYTE response_type; /**< Type of the response */
148 BYTE error_code; /**< Error code */
149 CARD16 sequence; /**< Sequence number */
150 CARD32 pad[7]; /**< Padding */
151 CARD32 full_sequence;
155 * @brief Generic cookie.
157 * A generic cookie structure.
160 unsigned int sequence; /**< Sequence number */
164 /* Include the generated xproto and xcb_types headers. */
165 #include "xcb_types.h"
172 * @brief Container for authorization information.
174 * A container for authorization information to be sent to the X server.
176 typedef struct XCBAuthInfo {
177 int namelen; /**< Length of the string name (as returned by strlen). */
178 char *name; /**< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". */
179 int datalen; /**< Length of the data member. */
180 char *data; /**< Data interpreted in a protocol-specific manner. */
184 * @brief Gets authorization information.
185 * @param fd: The file descriptor.
186 * @param info: The authorisation info to set.
187 * @return @c 0 on failure, 1 otherwise.
189 * @deprecated This function is deprecated. It must not be used in
190 * newly written code.
192 int XCBGetAuthInfo(int fd, XCBAuthInfo *info) deprecated;
198 * @brief Forces any buffered output to be written to the server.
199 * @param c: The connection to the X server.
200 * @return > @c 0 on success, <= @c 0 otherwise.
202 * Forces any buffered output to be written to the server. Blocks
203 * until the write is complete.
205 int XCBFlush(XCBConnection *c);
208 * @brief Returns the maximum request length field from the connection
210 * @param c: The connection to the X server.
211 * @return The maximum request length field.
213 * In the absence of the BIG-REQUESTS extension, returns the
214 * maximum request length field from the connection setup data, which
215 * may be as much as 65535. If the server supports BIG-REQUESTS, then
216 * the maximum request length field from the reply to the
217 * BigRequestsEnable request will be returned instead.
219 * Note that this length is measured in four-byte units, making the
220 * theoretical maximum lengths roughly 256kB without BIG-REQUESTS and
223 CARD32 XCBGetMaximumRequestLength(XCBConnection *c);
229 * @brief Returns the next event or error from the server.
230 * @param c: The connection to the X server.
231 * @return The next event from the server.
233 * @deprecated This function is deprecated. It must not be used in
234 * newly written code.
236 XCBGenericEvent *XCBWaitEvent(XCBConnection *c) deprecated;
239 * @brief Returns the next event or error from the server.
240 * @param c: The connection to the X server.
241 * @return The next event from the server.
243 * Returns the next event or error from the server, or returns null in
244 * the event of an I/O error. Blocks until either an event or error
245 * arrive, or an I/O error occurs.
247 XCBGenericEvent *XCBWaitForEvent(XCBConnection *c);
250 * @brief Returns the next event or error from the server.
251 * @param c: The connection to the X server.
252 * @param error: A pointer to an int to be filled in with the I/O
253 * error status of the operation.
254 * @return The next event from the server.
256 * Returns the next event or error from the server, if one is
257 * available, or returns @c NULL otherwise. If no event is available, that
258 * might be because an I/O error like connection close occurred while
259 * attempting to read the next event. The @p error parameter is a
260 * pointer to an int to be filled in with the I/O error status of the
261 * operation. If @p error is @c NULL, terminates the application when an
264 XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error);
267 * @brief Returns the last sequence number that the server is known to
269 * @param c: The connection to the X server.
270 * @return The last sequence number.
272 * Returns the last sequence number that the server is known to have
273 * processed. This function enables applications to determine whether
274 * forcing a cookie is going to block.
276 * @todo review that function.
278 unsigned int XCBGetRequestRead(XCBConnection *c);
284 * @typedef typedef struct XCBExtension XCBExtension
286 typedef struct XCBExtension XCBExtension; /**< Opaque structure used as key for XCBGetExtensionData. */
289 * @brief Caches reply information from QueryExtension requests.
290 * @param c: The connection.
291 * @param ext: The extension data.
292 * @return A pointer to a XCBConnSetupSuccessRep pointer.
294 * This function is the primary interface to the "extension cache",
295 * which caches reply information from QueryExtension
296 * requests. Invoking this function may cause a call to
297 * XCBQueryExtension to retrieve extension information from the
298 * server, and may block until extension data is received from the
301 * The result must not be freed. This storage is managed by the cache
304 const XCBQueryExtensionRep *XCBGetExtensionData(XCBConnection *c, XCBExtension *ext);
307 * @brief Prefetch of extension data into the extension cache
308 * @param c: The connection.
309 * @param ext: The extension data.
311 * This function allows a "prefetch" of extension data into the
312 * extension cache. Invoking the function may cause a call to
313 * XCBQueryExtension, but will not block waiting for the
314 * reply. XCBGetExtensionData will return the prefetched data after
315 * possibly blocking while it is retrieved.
317 void XCBPrefetchExtensionData(XCBConnection *c, XCBExtension *ext);
323 * @brief Access the data returned by the server.
324 * @param c: The connection.
325 * @return A pointer to a XCBConnSetupSuccessRep pointer.
327 * Accessor for the data returned by the server when the XCBConnection
328 * was initialized. This data includes
329 * - the server's required format for images,
330 * - a list of available visuals,
331 * - a list of available screens,
332 * - the server's maximum request length (in the absence of the
333 * BIG-REQUESTS extension),
334 * - and other assorted information.
336 * See the X protocol specification for more details.
338 * The result must not be freed.
340 const XCBConnSetupSuccessRep *XCBGetSetup(XCBConnection *c);
343 * @brief Access the file descriptor of the connection.
344 * @param c: The connection.
345 * @return The file descriptor.
347 * Accessor for the file descriptor that was passed to the
348 * XCBConnectToFD call that returned @p c.
350 int XCBGetFileDescriptor(XCBConnection *c);
353 * @brief Connects to the X server.
354 * @param fd: The file descriptor.
355 * @param auth_info: Authentication data.
356 * @return A newly allocated XCBConnection structure.
358 * Connects to an X server, given the open socket @p fd and the
359 * XCBAuthInfo @p auth_info. The file descriptor @p fd is
360 * bidirectionally connected to an X server. XCBGetTCPFD and
361 * XCBGetUnixFD return appropriate file descriptors. If the connection
362 * should be unauthenticated, @p auth_info must be @c
363 * NULL. XCBGetAuthInfo returns appropriate authentication data.
365 XCBConnection *XCBConnectToFD(int fd, XCBAuthInfo *auth_info);
368 * @brief Closes the connection.
369 * @param c: The connection.
371 * Closes the file descriptor and frees all memory associated with the
374 void XCBDisconnect(XCBConnection *c);
380 * @brief Parses a display string name in the form documented by X(7x).
381 * @param displayname: The name of the display.
382 * @param hostp: A pointer to a malloc'd copy of the hostname.
383 * @param displayp: A pointer to the display number.
384 * @param screenp: A pointer to the screen number.
385 * @return 0 on failure, non 0 otherwise.
387 * Parses the display string name @p display_name in the form
388 * documented by X(7x). Has no side effects on failure. If
389 * @p displayname is @c NULL or empty, it uses the environment
390 * variable DISPLAY. @p hostp is a pointer to a newly allocated string
391 * that contain the host name. @p displayp is set to the display
392 * number and @p screenp to the preferred screen number. @p screenp
393 * can be @c NULL. If @p displayname does not contain a screen number,
396 int XCBParseDisplay(const char *name, char **host, int *display, int *screen);
399 * @brief Open a connection to the X server.
400 * @param host: The host name.
401 * @param display: The display number.
402 * @return The file descriptor.
404 * @deprecated This function is deprecated. It must not be used in
405 * newly written code.
407 int XCBOpen(const char *host, int display) deprecated;
410 * @brief Open a connection to the X server.
411 * @param host: The host name.
412 * @param port: The TCP port.
413 * @return The file descriptor.
415 * @deprecated This function is deprecated. It must not be used in
416 * newly written code.
418 int XCBOpenTCP(const char *host, unsigned short port) deprecated;
421 * @brief Connects to the X server.
422 * @param file: The file name.
423 * @return The file descriptor.
425 * @deprecated This function is deprecated. It must not be used in
426 * newly written code.
428 int XCBOpenUnix(const char *file) deprecated;
431 * @brief Connects to the X server.
432 * @return A newly allocated XCBConnection structure.
434 * @deprecated This function is deprecated. It must not be used in
435 * newly written code.
437 XCBConnection *XCBConnectBasic(void) deprecated;
440 * @brief Connects to the X server.
441 * @param displayname: The name of the display.
442 * @param screenp: A pointer to a preferred screen number.
443 * @return A newly allocated XCBConnection structure.
445 * Connects to the X server specified by @p displayname. If @p
446 * displayname is @c NULL, uses the value of the DISPLAY environment
447 * variable. If a particular screen on that server is preferred, the
448 * int pointed to by @p screenp (if not @c NULL) will be set to that
449 * screen; otherwise the screen will be set to 0.
451 XCBConnection *XCBConnect(const char *displayname, int *screenp);
454 * @brief Connects to the X server, using an authorization information.
455 * @param displayname: The name of the display.
456 * @param auth: The authorization information.
457 * @param screenp: A pointer to a preferred screen number.
458 * @return A newly allocated XCBConnection structure.
460 * Connects to the X server specified by @p displayname, using the
461 * authorization @p auth. If a particular screen on that server is
462 * preferred, the int pointed to by @p screenp (if not @c NULL) will
463 * be set to that screen; otherwise @p screenp will be set to 0.
465 XCBConnection *XCBConnectToDisplayWithAuthInfo(const char *display, XCBAuthInfo *auth, int *screen);
468 * @brief Ensures that all events and errors are avalaible in XCB.
469 * @param c: The connection to the X server.
470 * @param e: A pointer to an error.
471 * @return @c 1 on success, @c 0 otherwise.
473 * Blocks the calling thread for the duration of one round trip to the
474 * server, ensuring that all events and errors caused by previous
475 * requests are available to XCB.
477 int XCBSync(XCBConnection *c, XCBGenericError **e);