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? */
37 typedef uint8_t CARD8;
38 typedef uint16_t CARD16;
39 typedef uint32_t CARD32;
41 typedef int16_t INT16;
42 typedef int32_t INT32;
52 #if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
53 #define deprecated __attribute__((__deprecated__))
64 * @defgroup XCB_Core_Api XCB Core API
65 * @brief Core API of the XCB library.
70 /* Pre-defined constants */
72 /** Current protocol version */
75 /** Current minor version */
76 #define X_PROTOCOL_REVISION 0
78 /** X_TCP_PORT + display number = server port for TCP transport */
79 #define X_TCP_PORT 6000
81 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
84 /** XCBNone is the universal null resource or null atom parameter value for many core X requests */
88 /* Opaque structures */
91 * @brief XCB Connection structure.
93 * A structure that contain all data that XCB needs to communicate with an X server.
95 typedef struct XCBConnection XCBConnection; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */
101 * @brief Generic iterator.
103 * A generic iterator structure.
106 void *data; /**< Data of the current iterator */
107 int rem; /**< remaining elements */
108 int index; /**< index of the current iterator */
112 * @brief Generic reply.
114 * A generic reply structure.
117 BYTE response_type; /**< Type of the response */
118 CARD8 pad0; /**< Padding */
119 CARD16 sequence; /**< Sequence number */
120 CARD32 length; /**< Length of the response */
124 * @brief Generic event.
126 * A generic event structure.
129 BYTE response_type; /**< Type of the response */
130 CARD8 pad0; /**< Padding */
131 CARD16 sequence; /**< Sequence number */
132 CARD32 pad[7]; /**< Padding */
133 CARD32 full_sequence;
137 * @brief Generic error.
139 * A generic error structure.
142 BYTE response_type; /**< Type of the response */
143 BYTE error_code; /**< Error code */
144 CARD16 sequence; /**< Sequence number */
145 CARD32 pad[7]; /**< Padding */
146 CARD32 full_sequence;
150 * @brief Generic cookie.
152 * A generic cookie structure.
155 unsigned int sequence; /**< Sequence number */
159 /* Include the generated xproto and xcb_types headers. */
160 #include "xcb_types.h"
167 * @brief Container for authorization information.
169 * A container for authorization information to be sent to the X server.
171 typedef struct XCBAuthInfo {
172 int namelen; /**< Length of the string name (as returned by strlen). */
173 char *name; /**< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". */
174 int datalen; /**< Length of the data member. */
175 char *data; /**< Data interpreted in a protocol-specific manner. */
179 * @brief Gets authorization information.
180 * @param fd: The file descriptor.
181 * @param info: The authorisation info to set.
182 * @return @c 0 on failure, 1 otherwise.
184 * @deprecated This function is deprecated. It must not be used in
185 * newly written code.
187 int XCBGetAuthInfo(int fd, XCBAuthInfo *info) deprecated;
193 * @brief Forces any buffered output to be written to the server.
194 * @param c: The connection to the X server.
195 * @return > @c 0 on success, <= @c 0 otherwise.
197 * Forces any buffered output to be written to the server. Blocks
198 * until the write is complete.
200 int XCBFlush(XCBConnection *c);
203 * @brief Returns the maximum request length field from the connection
205 * @param c: The connection to the X server.
206 * @return The maximum request length field.
208 * In the absence of the BIG-REQUESTS extension, returns the
209 * maximum request length field from the connection setup data, which
210 * may be as much as 65535. If the server supports BIG-REQUESTS, then
211 * the maximum request length field from the reply to the
212 * BigRequestsEnable request will be returned instead.
214 * Note that this length is measured in four-byte units, making the
215 * theoretical maximum lengths roughly 256kB without BIG-REQUESTS and
218 CARD32 XCBGetMaximumRequestLength(XCBConnection *c);
224 * @brief Returns the next event or error from the server.
225 * @param c: The connection to the X server.
226 * @return The next event from the server.
228 * @deprecated This function is deprecated. It must not be used in
229 * newly written code.
231 XCBGenericEvent *XCBWaitEvent(XCBConnection *c) deprecated;
234 * @brief Returns the next event or error from the server.
235 * @param c: The connection to the X server.
236 * @return The next event from the server.
238 * Returns the next event or error from the server, or returns null in
239 * the event of an I/O error. Blocks until either an event or error
240 * arrive, or an I/O error occurs.
242 XCBGenericEvent *XCBWaitForEvent(XCBConnection *c);
245 * @brief Returns the next event or error from the server.
246 * @param c: The connection to the X server.
247 * @param error: A pointer to an int to be filled in with the I/O
248 * error status of the operation.
249 * @return The next event from the server.
251 * Returns the next event or error from the server, if one is
252 * available, or returns @c NULL otherwise. If no event is available, that
253 * might be because an I/O error like connection close occurred while
254 * attempting to read the next event. The @p error parameter is a
255 * pointer to an int to be filled in with the I/O error status of the
256 * operation. If @p error is @c NULL, terminates the application when an
259 XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error);
262 * @brief Returns the last sequence number that the server is known to
264 * @param c: The connection to the X server.
265 * @return The last sequence number.
267 * Returns the last sequence number that the server is known to have
268 * processed. This function enables applications to determine whether
269 * forcing a cookie is going to block.
271 * @todo review that function.
273 unsigned int XCBGetRequestRead(XCBConnection *c);
279 * @typedef typedef struct XCBExtension XCBExtension
281 typedef struct XCBExtension XCBExtension; /**< Opaque structure used as key for XCBGetExtensionData. */
284 * @brief Caches reply information from QueryExtension requests.
285 * @param c: The connection.
286 * @param ext: The extension data.
287 * @return A pointer to a XCBConnSetupSuccessRep pointer.
289 * This function is the primary interface to the "extension cache",
290 * which caches reply information from QueryExtension
291 * requests. Invoking this function may cause a call to
292 * XCBQueryExtension to retrieve extension information from the
293 * server, and may block until extension data is received from the
296 * The result must not be freed. This storage is managed by the cache
299 const XCBQueryExtensionRep *XCBGetExtensionData(XCBConnection *c, XCBExtension *ext);
302 * @brief Prefetch of extension data into the extension cache
303 * @param c: The connection.
304 * @param ext: The extension data.
306 * This function allows a "prefetch" of extension data into the
307 * extension cache. Invoking the function may cause a call to
308 * XCBQueryExtension, but will not block waiting for the
309 * reply. XCBGetExtensionData will return the prefetched data after
310 * possibly blocking while it is retrieved.
312 void XCBPrefetchExtensionData(XCBConnection *c, XCBExtension *ext);
318 * @brief Access the data returned by the server.
319 * @param c: The connection.
320 * @return A pointer to a XCBConnSetupSuccessRep pointer.
322 * Accessor for the data returned by the server when the XCBConnection
323 * was initialized. This data includes
324 * - the server's required format for images,
325 * - a list of available visuals,
326 * - a list of available screens,
327 * - the server's maximum request length (in the absence of the
328 * BIG-REQUESTS extension),
329 * - and other assorted information.
331 * See the X protocol specification for more details.
333 * The result must not be freed.
335 const XCBConnSetupSuccessRep *XCBGetSetup(XCBConnection *c);
338 * @brief Access the file descriptor of the connection.
339 * @param c: The connection.
340 * @return The file descriptor.
342 * Accessor for the file descriptor that was passed to the
343 * XCBConnectToFD call that returned @p c.
345 int XCBGetFileDescriptor(XCBConnection *c);
348 * @brief Connects to the X server.
349 * @param fd: The file descriptor.
350 * @param auth_info: Authentication data.
351 * @return A newly allocated XCBConnection structure.
353 * Connects to an X server, given the open socket @p fd and the
354 * XCBAuthInfo @p auth_info. The file descriptor @p fd is
355 * bidirectionally connected to an X server. XCBGetTCPFD and
356 * XCBGetUnixFD return appropriate file descriptors. If the connection
357 * should be unauthenticated, @p auth_info must be @c
358 * NULL. XCBGetAuthInfo returns appropriate authentication data.
360 XCBConnection *XCBConnectToFD(int fd, XCBAuthInfo *auth_info);
363 * @brief Closes the connection.
364 * @param c: The connection.
366 * Closes the file descriptor and frees all memory associated with the
369 void XCBDisconnect(XCBConnection *c);
375 * @brief Parses a display string name in the form documented by X(7x).
376 * @param displayname: The name of the display.
377 * @param hostp: A pointer to a malloc'd copy of the hostname.
378 * @param displayp: A pointer to the display number.
379 * @param screenp: A pointer to the screen number.
380 * @return 0 on failure, non 0 otherwise.
382 * Parses the display string name @p display_name in the form
383 * documented by X(7x). Has no side effects on failure. If
384 * @p displayname is @c NULL or empty, it uses the environment
385 * variable DISPLAY. @p hostp is a pointer to a newly allocated string
386 * that contain the host name. @p displayp is set to the display
387 * number and @p screenp to the preferred screen number. @p screenp
388 * can be @c NULL. If @p displayname does not contain a screen number,
391 int XCBParseDisplay(const char *name, char **host, int *display, int *screen);
394 * @brief Open a connection to the X server.
395 * @param host: The host name.
396 * @param display: The display number.
397 * @return The file descriptor.
399 * @deprecated This function is deprecated. It must not be used in
400 * newly written code.
402 int XCBOpen(const char *host, int display) deprecated;
405 * @brief Open a connection to the X server.
406 * @param host: The host name.
407 * @param port: The TCP port.
408 * @return The file descriptor.
410 * @deprecated This function is deprecated. It must not be used in
411 * newly written code.
413 int XCBOpenTCP(const char *host, unsigned short port) deprecated;
416 * @brief Connects to the X server.
417 * @param file: The file name.
418 * @return The file descriptor.
420 * @deprecated This function is deprecated. It must not be used in
421 * newly written code.
423 int XCBOpenUnix(const char *file) deprecated;
426 * @brief Connects to the X server.
427 * @return A newly allocated XCBConnection structure.
429 * @deprecated This function is deprecated. It must not be used in
430 * newly written code.
432 XCBConnection *XCBConnectBasic(void) deprecated;
435 * @brief Connects to the X server.
436 * @param displayname: The name of the display.
437 * @param screenp: A pointer to a preferred screen number.
438 * @return A newly allocated XCBConnection structure.
440 * Connects to the X server specified by @p displayname. If @p
441 * displayname is @c NULL, uses the value of the DISPLAY environment
442 * variable. If a particular screen on that server is preferred, the
443 * int pointed to by @p screenp (if not @c NULL) will be set to that
444 * screen; otherwise the screen will be set to 0.
446 XCBConnection *XCBConnect(const char *displayname, int *screenp);
449 * @brief Connects to the X server, using an authorization information.
450 * @param displayname: The name of the display.
451 * @param auth: The authorization information.
452 * @param screenp: A pointer to a preferred screen number.
453 * @return A newly allocated XCBConnection structure.
455 * Connects to the X server specified by @p displayname, using the
456 * authorization @p auth. If a particular screen on that server is
457 * preferred, the int pointed to by @p screenp (if not @c NULL) will
458 * be set to that screen; otherwise @p screenp will be set to 0.
460 XCBConnection *XCBConnectToDisplayWithAuthInfo(const char *display, XCBAuthInfo *auth, int *screen);
463 * @brief Ensures that all events and errors are avalaible in XCB.
464 * @param c: The connection to the X server.
465 * @param e: A pointer to an error.
466 * @return @c 1 on success, @c 0 otherwise.
468 * Blocks the calling thread for the duration of one round trip to the
469 * server, ensuring that all events and errors caused by previous
470 * requests are available to XCB.
472 int XCBSync(XCBConnection *c, XCBGenericError **e);