* authorization from the authors.
*/
-#ifndef __XCB_H
-#define __XCB_H
+#ifndef __XCB_H__
+#define __XCB_H__
#include <sys/types.h>
-/* TODO: check for stdint in config? (HAVE_STDINT) fallback? */
+#if defined(__solaris__)
+#include <inttypes.h>
+#else
#include <stdint.h>
+#endif
-typedef uint8_t BYTE;
-typedef uint8_t BOOL;
-typedef uint8_t CARD8;
-typedef uint16_t CARD16;
-typedef uint32_t CARD32;
-typedef int8_t INT8;
-typedef int16_t INT16;
-typedef int32_t INT32;
-
-#include <X11/X.h>
+#ifndef _WIN32
#include <sys/uio.h>
+#else
+#include "xcb_windefs.h"
+#endif
#include <pthread.h>
+
#ifdef __cplusplus
extern "C" {
#endif
-#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
-#define deprecated __attribute__((__deprecated__))
-#else
-#define deprecated
-#endif
-
-
/**
* @file xcb.h
*/
/**
- * @defgroup XCB_Core_Api XCB Core API
+ * @defgroup XCB_Core_API XCB Core API
* @brief Core API of the XCB library.
*
* @{
/** X_TCP_PORT + display number = server port for TCP transport */
#define X_TCP_PORT 6000
-#define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
+/** xcb connection errors because of socket, pipe and other stream errors. */
+#define XCB_CONN_ERROR 1
+
+/** xcb connection shutdown because of extension not supported */
+#define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2
+
+/** malloc(), calloc() and realloc() error upon failure, for eg ENOMEM */
+#define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3
+/** Connection closed, exceeding request length that server accepts. */
+#define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4
-/** XCBNone is the universal null resource or null atom parameter value for many core X requests */
-#define XCBNone 0L
+/** Connection closed, error during parsing display string. */
+#define XCB_CONN_CLOSED_PARSE_ERR 5
+/** Connection closed because the server does not have a screen matching the display. */
+#define XCB_CONN_CLOSED_INVALID_SCREEN 6
+
+/** Connection closed because some FD passing operation failed */
+#define XCB_CONN_CLOSED_FDPASSING_FAILED 7
+
+#define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
/* Opaque structures */
*
* A structure that contain all data that XCB needs to communicate with an X server.
*/
-typedef struct XCBConnection XCBConnection; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */
+typedef struct xcb_connection_t xcb_connection_t; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */
/* Other types */
void *data; /**< Data of the current iterator */
int rem; /**< remaining elements */
int index; /**< index of the current iterator */
-} XCBGenericIter;
+} xcb_generic_iterator_t;
/**
* @brief Generic reply.
* A generic reply structure.
*/
typedef struct {
- BYTE response_type; /**< Type of the response */
- CARD8 pad0; /**< Padding */
- CARD16 sequence; /**< Sequence number */
- CARD32 length; /**< Length of the response */
-} XCBGenericRep;
+ uint8_t response_type; /**< Type of the response */
+ uint8_t pad0; /**< Padding */
+ uint16_t sequence; /**< Sequence number */
+ uint32_t length; /**< Length of the response */
+} xcb_generic_reply_t;
/**
* @brief Generic event.
* A generic event structure.
*/
typedef struct {
- BYTE response_type; /**< Type of the response */
- CARD8 pad0; /**< Padding */
- CARD16 sequence; /**< Sequence number */
- CARD32 pad[7]; /**< Padding */
- CARD32 full_sequence;
-} XCBGenericEvent;
+ uint8_t response_type; /**< Type of the response */
+ uint8_t pad0; /**< Padding */
+ uint16_t sequence; /**< Sequence number */
+ uint32_t pad[7]; /**< Padding */
+ uint32_t full_sequence; /**< full sequence */
+} xcb_generic_event_t;
/**
* @brief Generic error.
* A generic error structure.
*/
typedef struct {
- BYTE response_type; /**< Type of the response */
- BYTE error_code; /**< Error code */
- CARD16 sequence; /**< Sequence number */
- CARD32 pad[7]; /**< Padding */
- CARD32 full_sequence;
-} XCBGenericError;
+ uint8_t response_type; /**< Type of the response */
+ uint8_t error_code; /**< Error code */
+ uint16_t sequence; /**< Sequence number */
+ uint32_t resource_id; /** < Resource ID for requests with side effects only */
+ uint16_t minor_code; /** < Minor opcode of the failed request */
+ uint8_t major_code; /** < Major opcode of the failed request */
+ uint8_t pad0;
+ uint32_t pad[5]; /**< Padding */
+ uint32_t full_sequence; /**< full sequence */
+} xcb_generic_error_t;
/**
* @brief Generic cookie.
*/
typedef struct {
unsigned int sequence; /**< Sequence number */
-} XCBVoidCookie;
+} xcb_void_cookie_t;
-/* Include the generated xproto and xcb_types headers. */
-#include "xcb_types.h"
+/* Include the generated xproto header. */
#include "xproto.h"
+/** XCB_NONE is the universal null resource or null atom parameter value for many core X requests */
+#define XCB_NONE 0L
+
+/** XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters */
+#define XCB_COPY_FROM_PARENT 0L
+
+/** XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t */
+#define XCB_CURRENT_TIME 0L
+
+/** XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables */
+#define XCB_NO_SYMBOL 0L
+
+
/* xcb_auth.c */
/**
*
* A container for authorization information to be sent to the X server.
*/
-typedef struct XCBAuthInfo {
+typedef struct xcb_auth_info_t {
int namelen; /**< Length of the string name (as returned by strlen). */
char *name; /**< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". */
int datalen; /**< Length of the data member. */
char *data; /**< Data interpreted in a protocol-specific manner. */
-} XCBAuthInfo;
-
-/**
- * @brief Gets authorization information.
- * @param fd: The file descriptor.
- * @param info: The authorisation info to set.
- * @return @c 0 on failure, 1 otherwise.
- *
- * @deprecated This function is deprecated. It must not be used in
- * newly written code.
- */
-int XCBGetAuthInfo(int fd, XCBAuthInfo *info) deprecated;
+} xcb_auth_info_t;
/* xcb_out.c */
* Forces any buffered output to be written to the server. Blocks
* until the write is complete.
*/
-int XCBFlush(XCBConnection *c);
+int xcb_flush(xcb_connection_t *c);
/**
- * @brief Returns the maximum request length field from the connection
- * setup data.
+ * @brief Returns the maximum request length that this server accepts.
* @param c: The connection to the X server.
* @return The maximum request length field.
*
* theoretical maximum lengths roughly 256kB without BIG-REQUESTS and
* 16GB with.
*/
-CARD32 XCBGetMaximumRequestLength(XCBConnection *c);
-
-
-/* xcb_in.c */
+uint32_t xcb_get_maximum_request_length(xcb_connection_t *c);
/**
- * @brief Returns the next event or error from the server.
+ * @brief Prefetch the maximum request length without blocking.
* @param c: The connection to the X server.
- * @return The next event from the server.
*
- * @deprecated This function is deprecated. It must not be used in
- * newly written code.
+ * Without blocking, does as much work as possible toward computing
+ * the maximum request length accepted by the X server.
+ *
+ * Invoking this function may cause a call to xcb_big_requests_enable,
+ * but will not block waiting for the reply.
+ * xcb_get_maximum_request_length will return the prefetched data
+ * after possibly blocking while the reply is retrieved.
+ *
+ * Note that in order for this function to be fully non-blocking, the
+ * application must previously have called
+ * xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply
+ * must have already arrived.
*/
-XCBGenericEvent *XCBWaitEvent(XCBConnection *c) deprecated;
+void xcb_prefetch_maximum_request_length(xcb_connection_t *c);
+
+
+/* xcb_in.c */
/**
* @brief Returns the next event or error from the server.
* the event of an I/O error. Blocks until either an event or error
* arrive, or an I/O error occurs.
*/
-XCBGenericEvent *XCBWaitForEvent(XCBConnection *c);
+xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c);
/**
* @brief Returns the next event or error from the server.
* @param c: The connection to the X server.
- * @param error: A pointer to an int to be filled in with the I/O
- * error status of the operation.
* @return The next event from the server.
*
* Returns the next event or error from the server, if one is
* available, or returns @c NULL otherwise. If no event is available, that
* might be because an I/O error like connection close occurred while
- * attempting to read the next event. The @p error parameter is a
- * pointer to an int to be filled in with the I/O error status of the
- * operation. If @p error is @c NULL, terminates the application when an
- * I/O error occurs.
+ * attempting to read the next event, in which case the connection is
+ * shut down when this function returns.
*/
-XCBGenericEvent *XCBPollForEvent(XCBConnection *c, int *error);
+xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c);
/**
- * @brief Returns the last sequence number that the server is known to
- * have processed.
+ * @brief Returns the next event without reading from the connection.
* @param c: The connection to the X server.
- * @return The last sequence number.
+ * @return The next already queued event from the server.
*
- * Returns the last sequence number that the server is known to have
- * processed. This function enables applications to determine whether
- * forcing a cookie is going to block.
+ * This is a version of xcb_poll_for_event that only examines the
+ * event queue for new events. The function doesn't try to read new
+ * events from the connection if no queued events are found.
*
- * @todo review that function.
+ * This function is useful for callers that know in advance that all
+ * interesting events have already been read from the connection. For
+ * example, callers might use xcb_wait_for_reply and be interested
+ * only of events that preceded a specific reply.
*/
-unsigned int XCBGetRequestRead(XCBConnection *c);
+xcb_generic_event_t *xcb_poll_for_queued_event(xcb_connection_t *c);
+typedef struct xcb_special_event xcb_special_event_t;
-/* xcb_ext.c */
+/**
+ * @brief Returns the next event from a special queue
+ */
+xcb_generic_event_t *xcb_poll_for_special_event(xcb_connection_t *c,
+ xcb_special_event_t *se);
+
+/**
+ * @brief Returns the next event from a special queue, blocking until one arrives
+ */
+xcb_generic_event_t *xcb_wait_for_special_event(xcb_connection_t *c,
+ xcb_special_event_t *se);
+/**
+ * @typedef typedef struct xcb_extension_t xcb_extension_t
+ */
+typedef struct xcb_extension_t xcb_extension_t; /**< Opaque structure used as key for xcb_get_extension_data_t. */
+
+
+/**
+ * @brief Listen for a special event
+ */
+xcb_special_event_t *xcb_register_for_special_xge(xcb_connection_t *c,
+ xcb_extension_t *ext,
+ uint32_t eid,
+ uint32_t *stamp);
/**
- * @typedef typedef struct XCBExtension XCBExtension
+ * @brief Stop listening for a special event
*/
-typedef struct XCBExtension XCBExtension; /**< Opaque structure used as key for XCBGetExtensionData. */
+void xcb_unregister_for_special_event(xcb_connection_t *c,
+ xcb_special_event_t *se);
+
+/**
+ * @brief Return the error for a request, or NULL if none can ever arrive.
+ * @param c: The connection to the X server.
+ * @param cookie: The request cookie.
+ * @return The error for the request, or NULL if none can ever arrive.
+ *
+ * The xcb_void_cookie_t cookie supplied to this function must have resulted
+ * from a call to xcb_[request_name]_checked(). This function will block
+ * until one of two conditions happens. If an error is received, it will be
+ * returned. If a reply to a subsequent request has already arrived, no error
+ * can arrive for this request, so this function will return NULL.
+ *
+ * Note that this function will perform a sync if needed to ensure that the
+ * sequence number will advance beyond that provided in cookie; this is a
+ * convenience to avoid races in determining whether the sync is needed.
+ */
+xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie);
+
+/**
+ * @brief Discards the reply for a request.
+ * @param c: The connection to the X server.
+ * @param sequence: The request sequence number from a cookie.
+ *
+ * Discards the reply for a request. Additionally, any error generated
+ * by the request is also discarded (unless it was an _unchecked request
+ * and the error has already arrived).
+ *
+ * This function will not block even if the reply is not yet available.
+ *
+ * Note that the sequence really does have to come from an xcb cookie;
+ * this function is not designed to operate on socket-handoff replies.
+ */
+void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
+
+
+/* xcb_ext.c */
/**
* @brief Caches reply information from QueryExtension requests.
* @param c: The connection.
* @param ext: The extension data.
- * @return A pointer to a XCBConnSetupSuccessRep pointer.
+ * @return A pointer to the xcb_query_extension_reply_t for the extension.
*
* This function is the primary interface to the "extension cache",
* which caches reply information from QueryExtension
* requests. Invoking this function may cause a call to
- * XCBQueryExtension to retrieve extension information from the
+ * xcb_query_extension to retrieve extension information from the
* server, and may block until extension data is received from the
* server.
*
* The result must not be freed. This storage is managed by the cache
* itself.
*/
-const XCBQueryExtensionRep *XCBGetExtensionData(XCBConnection *c, XCBExtension *ext);
+const xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
/**
* @brief Prefetch of extension data into the extension cache
*
* This function allows a "prefetch" of extension data into the
* extension cache. Invoking the function may cause a call to
- * XCBQueryExtension, but will not block waiting for the
- * reply. XCBGetExtensionData will return the prefetched data after
+ * xcb_query_extension, but will not block waiting for the
+ * reply. xcb_get_extension_data will return the prefetched data after
* possibly blocking while it is retrieved.
*/
-void XCBPrefetchExtensionData(XCBConnection *c, XCBExtension *ext);
+void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext);
/* xcb_conn.c */
/**
* @brief Access the data returned by the server.
* @param c: The connection.
- * @return A pointer to a XCBConnSetupSuccessRep pointer.
+ * @return A pointer to an xcb_setup_t structure.
*
- * Accessor for the data returned by the server when the XCBConnection
+ * Accessor for the data returned by the server when the xcb_connection_t
* was initialized. This data includes
* - the server's required format for images,
* - a list of available visuals,
*
* The result must not be freed.
*/
-const XCBConnSetupSuccessRep *XCBGetSetup(XCBConnection *c);
+const xcb_setup_t *xcb_get_setup(xcb_connection_t *c);
/**
* @brief Access the file descriptor of the connection.
* @return The file descriptor.
*
* Accessor for the file descriptor that was passed to the
- * XCBConnectToFD call that returned @p c.
+ * xcb_connect_to_fd call that returned @p c.
*/
-int XCBGetFileDescriptor(XCBConnection *c);
+int xcb_get_file_descriptor(xcb_connection_t *c);
+
+/**
+ * @brief Test whether the connection has shut down due to a fatal error.
+ * @param c: The connection.
+ * @return > 0 if the connection is in an error state; 0 otherwise.
+ *
+ * Some errors that occur in the context of an xcb_connection_t
+ * are unrecoverable. When such an error occurs, the
+ * connection is shut down and further operations on the
+ * xcb_connection_t have no effect.
+ *
+ * @return XCB_CONN_ERROR, because of socket errors, pipe errors or other stream errors.
+ * @return XCB_CONN_CLOSED_EXT_NOTSUPPORTED, when extension not supported.
+ * @return XCB_CONN_CLOSED_MEM_INSUFFICIENT, when memory not available.
+ * @return XCB_CONN_CLOSED_REQ_LEN_EXCEED, exceeding request length that server accepts.
+ * @return XCB_CONN_CLOSED_PARSE_ERR, error during parsing display string.
+ * @return XCB_CONN_CLOSED_INVALID_SCREEN, because the server does not have a screen matching the display.
+ */
+int xcb_connection_has_error(xcb_connection_t *c);
/**
* @brief Connects to the X server.
* @param fd: The file descriptor.
* @param auth_info: Authentication data.
- * @return A newly allocated XCBConnection structure.
+ * @return A newly allocated xcb_connection_t structure.
*
* Connects to an X server, given the open socket @p fd and the
- * XCBAuthInfo @p auth_info. The file descriptor @p fd is
- * bidirectionally connected to an X server. XCBGetTCPFD and
- * XCBGetUnixFD return appropriate file descriptors. If the connection
+ * xcb_auth_info_t @p auth_info. The file descriptor @p fd is
+ * bidirectionally connected to an X server. If the connection
* should be unauthenticated, @p auth_info must be @c
- * NULL. XCBGetAuthInfo returns appropriate authentication data.
+ * NULL.
*/
-XCBConnection *XCBConnectToFD(int fd, XCBAuthInfo *auth_info);
+xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info);
/**
* @brief Closes the connection.
* Closes the file descriptor and frees all memory associated with the
* connection @c c.
*/
-void XCBDisconnect(XCBConnection *c);
+void xcb_disconnect(xcb_connection_t *c);
/* xcb_util.c */
/**
* @brief Parses a display string name in the form documented by X(7x).
- * @param displayname: The name of the display.
- * @param hostp: A pointer to a malloc'd copy of the hostname.
- * @param displayp: A pointer to the display number.
- * @param screenp: A pointer to the screen number.
+ * @param name: The name of the display.
+ * @param host: A pointer to a malloc'd copy of the hostname.
+ * @param display: A pointer to the display number.
+ * @param screen: A pointer to the screen number.
* @return 0 on failure, non 0 otherwise.
*
* Parses the display string name @p display_name in the form
* can be @c NULL. If @p displayname does not contain a screen number,
* it is set to @c 0.
*/
-int XCBParseDisplay(const char *name, char **host, int *display, int *screen);
-
-/**
- * @brief Open a connection to the X server.
- * @param host: The host name.
- * @param display: The display number.
- * @return The file descriptor.
- *
- * @deprecated This function is deprecated. It must not be used in
- * newly written code.
- */
-int XCBOpen(const char *host, int display) deprecated;
-
-/**
- * @brief Open a connection to the X server.
- * @param host: The host name.
- * @param port: The TCP port.
- * @return The file descriptor.
- *
- * @deprecated This function is deprecated. It must not be used in
- * newly written code.
- */
-int XCBOpenTCP(const char *host, unsigned short port) deprecated;
-
-/**
- * @brief Connects to the X server.
- * @param file: The file name.
- * @return The file descriptor.
- *
- * @deprecated This function is deprecated. It must not be used in
- * newly written code.
- */
-int XCBOpenUnix(const char *file) deprecated;
-
-/**
- * @brief Connects to the X server.
- * @return A newly allocated XCBConnection structure.
- *
- * @deprecated This function is deprecated. It must not be used in
- * newly written code.
- */
-XCBConnection *XCBConnectBasic(void) deprecated;
+int xcb_parse_display(const char *name, char **host, int *display, int *screen);
/**
* @brief Connects to the X server.
* @param displayname: The name of the display.
* @param screenp: A pointer to a preferred screen number.
- * @return A newly allocated XCBConnection structure.
+ * @return A newly allocated xcb_connection_t structure.
*
* Connects to the X server specified by @p displayname. If @p
* displayname is @c NULL, uses the value of the DISPLAY environment
* int pointed to by @p screenp (if not @c NULL) will be set to that
* screen; otherwise the screen will be set to 0.
*/
-XCBConnection *XCBConnect(const char *displayname, int *screenp);
+xcb_connection_t *xcb_connect(const char *displayname, int *screenp);
/**
* @brief Connects to the X server, using an authorization information.
- * @param displayname: The name of the display.
+ * @param display: The name of the display.
* @param auth: The authorization information.
- * @param screenp: A pointer to a preferred screen number.
- * @return A newly allocated XCBConnection structure.
+ * @param screen: A pointer to a preferred screen number.
+ * @return A newly allocated xcb_connection_t structure.
*
* Connects to the X server specified by @p displayname, using the
* authorization @p auth. If a particular screen on that server is
* preferred, the int pointed to by @p screenp (if not @c NULL) will
* be set to that screen; otherwise @p screenp will be set to 0.
*/
-XCBConnection *XCBConnectToDisplayWithAuthInfo(const char *display, XCBAuthInfo *auth, int *screen);
+xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen);
+
+
+/* xcb_xid.c */
/**
- * @brief Ensures that all events and errors are avalaible in XCB.
- * @param c: The connection to the X server.
- * @param e: A pointer to an error.
- * @return @c 1 on success, @c 0 otherwise.
+ * @brief Allocates an XID for a new object.
+ * @param c: The connection.
+ * @return A newly allocated XID.
*
- * Blocks the calling thread for the duration of one round trip to the
- * server, ensuring that all events and errors caused by previous
- * requests are available to XCB.
+ * Allocates an XID for a new object. Typically used just prior to
+ * various object creation functions, such as xcb_create_window.
*/
-int XCBSync(XCBConnection *c, XCBGenericError **e);
+uint32_t xcb_generate_id(xcb_connection_t *c);
/**
* @}
*/
-
#ifdef __cplusplus
}
#endif
-#endif
+
+#endif /* __XCB_H__ */
projects / free-sw / xcb / libxcb / blobdiff