X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fxcb.h;h=63864dc37aecc2588b0d6c41e9ec35ac74e719aa;hb=cca607409068ad0948e7283fb8d0465cabc51686;hp=3e61ebdf974f3f20589d28b4f1ce932613949cbe;hpb=2415c11dec5e5adb0c17f98aa52fbb371a4f8f23;p=free-sw%2Fxcb%2Flibxcb diff --git a/src/xcb.h b/src/xcb.h index 3e61ebd..63864dc 100644 --- a/src/xcb.h +++ b/src/xcb.h @@ -69,6 +69,27 @@ extern "C" { /** X_TCP_PORT + display number = server port for TCP transport */ #define X_TCP_PORT 6000 +/** 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 + +/** 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 */ @@ -119,23 +140,6 @@ typedef struct { uint32_t full_sequence; /**< full sequence */ } xcb_generic_event_t; -/** - * @brief GE event - * - * An event as sent by the XGE extension. The length field specifies the - * number of 4-byte blocks trailing the struct. - */ -typedef struct { - uint8_t response_type; /**< Type of the response */ - uint8_t pad0; /**< Padding */ - uint16_t sequence; /**< Sequence number */ - uint32_t length; - uint16_t event_type; - uint16_t pad1; - uint32_t pad[5]; /**< Padding */ - uint32_t full_sequence; /**< full sequence */ -} xcb_ge_event_t; - /** * @brief Generic error. * @@ -260,7 +264,6 @@ 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. - * error status of the operation. * @return The next event from the server. * * Returns the next event or error from the server, if one is @@ -272,39 +275,53 @@ xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c); xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c); /** - * @brief Returns the next event or error that precedes the given request. + * @brief Returns the next event without reading from the connection. * @param c: The connection to the X server. - * @param request: The limiting sequence number. - * @return The next event from the server. - * - * Returns the next event or error with a sequence number less than or - * equal to the given sequence number, or returns NULL if no such event can - * ever arrive. Blocks until either a suitable event or error arrive, or a - * response arrives that proves no such event is coming, or an I/O error - * occurs. - * - * After processing a request, the X server sends responses in a specific - * order. First come any events that the request generated, then any - * replies for the request, then the error response if there is one. After - * that, the server may spontaneously send more events with the same - * sequence number, which are not related to that request. + * @return The next already queued event from the server. * - * This function will always return events from the pre-reply phase of the - * specified request. It may also return events from the unrelated - * post-reply stream, as long as they have the same sequence number. + * 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. * - * This function is useful for callers that need to process responses in - * wire-order. - * - * Implementation note: You cannot currently use this function to ensure - * that you process responses in exactly wire-order, because depending on - * the sequence of calls you make and the timing of server responses, - * post-reply events with the same sequence number may be returned as part - * of the pre-reply event stream, even though they were separated by a - * reply or error. In practice this kind of error is unlikely to matter, - * but it may be fixed in the future. + * 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. */ -xcb_generic_event_t *xcb_wait_for_event_until(xcb_connection_t *c, unsigned int request); +xcb_generic_event_t *xcb_poll_for_queued_event(xcb_connection_t *c); + +typedef struct xcb_special_event xcb_special_event_t; + +/** + * @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); + +/** + * @brief Stop listening for a special event + */ +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. @@ -343,11 +360,6 @@ void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence); /* xcb_ext.c */ -/** - * @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 Caches reply information from QueryExtension requests. * @param c: The connection. @@ -415,15 +427,19 @@ 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 1 if the connection is in an error state; 0 otherwise. + * @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. * - * @todo Other functions should document the conditions in - * which they shut down the connection. + * @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);