|
Packit |
071ada |
/*
|
|
Packit |
071ada |
* Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
|
|
Packit |
071ada |
* All Rights Reserved.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
Packit |
071ada |
* copy of this software and associated documentation files (the "Software"),
|
|
Packit |
071ada |
* to deal in the Software without restriction, including without limitation
|
|
Packit |
071ada |
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
Packit |
071ada |
* and/or sell copies of the Software, and to permit persons to whom the
|
|
Packit |
071ada |
* Software is furnished to do so, subject to the following conditions:
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* The above copyright notice and this permission notice shall be included in
|
|
Packit |
071ada |
* all copies or substantial portions of the Software.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
Packit |
071ada |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
Packit |
071ada |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
Packit |
071ada |
* AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
Packit |
071ada |
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
Packit |
071ada |
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Except as contained in this notice, the names of the authors or their
|
|
Packit |
071ada |
* institutions shall not be used in advertising or otherwise to promote the
|
|
Packit |
071ada |
* sale, use or other dealings in this Software without prior written
|
|
Packit |
071ada |
* authorization from the authors.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
|
|
Packit |
071ada |
#ifndef __XCBEXT_H
|
|
Packit |
071ada |
#define __XCBEXT_H
|
|
Packit |
071ada |
|
|
Packit |
071ada |
#include "xcb.h"
|
|
Packit |
071ada |
|
|
Packit |
071ada |
#ifdef __cplusplus
|
|
Packit |
071ada |
extern "C" {
|
|
Packit |
071ada |
#endif
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/* xcb_ext.c */
|
|
Packit |
071ada |
|
|
Packit |
071ada |
struct xcb_extension_t {
|
|
Packit |
071ada |
const char *name;
|
|
Packit |
071ada |
int global_id;
|
|
Packit |
071ada |
};
|
|
Packit |
071ada |
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/* xcb_out.c */
|
|
Packit |
071ada |
|
|
Packit |
071ada |
typedef struct {
|
|
Packit |
071ada |
size_t count;
|
|
Packit |
071ada |
xcb_extension_t *ext;
|
|
Packit |
071ada |
uint8_t opcode;
|
|
Packit |
071ada |
uint8_t isvoid;
|
|
Packit |
071ada |
} xcb_protocol_request_t;
|
|
Packit |
071ada |
|
|
Packit |
071ada |
enum xcb_send_request_flags_t {
|
|
Packit |
071ada |
XCB_REQUEST_CHECKED = 1 << 0,
|
|
Packit |
071ada |
XCB_REQUEST_RAW = 1 << 1,
|
|
Packit |
071ada |
XCB_REQUEST_DISCARD_REPLY = 1 << 2,
|
|
Packit |
071ada |
XCB_REQUEST_REPLY_FDS = 1 << 3
|
|
Packit |
071ada |
};
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Send a request to the server.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param flags A combination of flags from the xcb_send_request_flags_t enumeration.
|
|
Packit |
071ada |
* @param vector Data to send; must have two iovecs before start for internal use.
|
|
Packit |
071ada |
* @param request Information about the request to be sent.
|
|
Packit |
071ada |
* @return The request's sequence number on success, 0 otherwise.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* This function sends a new request to the X server. The data of the request is
|
|
Packit |
071ada |
* given as an array of @c iovecs in the @p vector argument. The length of that
|
|
Packit |
071ada |
* array and the necessary management information are given in the @p request
|
|
Packit |
071ada |
* argument.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* When this function returns, the request might or might not be sent already.
|
|
Packit |
071ada |
* Use xcb_flush() to make sure that it really was sent.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that this function is not the preferred way for sending requests.
|
|
Packit |
071ada |
* It's better to use the generated wrapper functions.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that xcb might use index -1 and -2 of the @p vector array internally,
|
|
Packit |
071ada |
* so they must be valid!
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
unsigned int xcb_send_request(xcb_connection_t *c, int flags, struct iovec *vector, const xcb_protocol_request_t *request);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Send a request to the server.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param flags A combination of flags from the xcb_send_request_flags_t enumeration.
|
|
Packit |
071ada |
* @param vector Data to send; must have two iovecs before start for internal use.
|
|
Packit |
071ada |
* @param request Information about the request to be sent.
|
|
Packit |
071ada |
* @param num_fds Number of additional file descriptors to send to the server
|
|
Packit |
071ada |
* @param fds Additional file descriptors that should be send to the server.
|
|
Packit |
071ada |
* @return The request's sequence number on success, 0 otherwise.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* This function sends a new request to the X server. The data of the request is
|
|
Packit |
071ada |
* given as an array of @c iovecs in the @p vector argument. The length of that
|
|
Packit |
071ada |
* array and the necessary management information are given in the @p request
|
|
Packit |
071ada |
* argument.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* If @p num_fds is non-zero, @p fds points to an array of file descriptors that
|
|
Packit |
071ada |
* will be sent to the X server along with this request. After this function
|
|
Packit |
071ada |
* returns, all file descriptors sent are owned by xcb and will be closed
|
|
Packit |
071ada |
* eventually.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* When this function returns, the request might or might not be sent already.
|
|
Packit |
071ada |
* Use xcb_flush() to make sure that it really was sent.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that this function is not the preferred way for sending requests.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that xcb might use index -1 and -2 of the @p vector array internally,
|
|
Packit |
071ada |
* so they must be valid!
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
unsigned int xcb_send_request_with_fds(xcb_connection_t *c, int flags, struct iovec *vector,
|
|
Packit |
071ada |
const xcb_protocol_request_t *request, unsigned int num_fds, int *fds);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Send a request to the server, with 64-bit sequence number returned.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param flags A combination of flags from the xcb_send_request_flags_t enumeration.
|
|
Packit |
071ada |
* @param vector Data to send; must have two iovecs before start for internal use.
|
|
Packit |
071ada |
* @param request Information about the request to be sent.
|
|
Packit |
071ada |
* @return The request's sequence number on success, 0 otherwise.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* This function sends a new request to the X server. The data of the request is
|
|
Packit |
071ada |
* given as an array of @c iovecs in the @p vector argument. The length of that
|
|
Packit |
071ada |
* array and the necessary management information are given in the @p request
|
|
Packit |
071ada |
* argument.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* When this function returns, the request might or might not be sent already.
|
|
Packit |
071ada |
* Use xcb_flush() to make sure that it really was sent.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that this function is not the preferred way for sending requests.
|
|
Packit |
071ada |
* It's better to use the generated wrapper functions.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that xcb might use index -1 and -2 of the @p vector array internally,
|
|
Packit |
071ada |
* so they must be valid!
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
uint64_t xcb_send_request64(xcb_connection_t *c, int flags, struct iovec *vector, const xcb_protocol_request_t *request);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Send a request to the server, with 64-bit sequence number returned.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param flags A combination of flags from the xcb_send_request_flags_t enumeration.
|
|
Packit |
071ada |
* @param vector Data to send; must have two iovecs before start for internal use.
|
|
Packit |
071ada |
* @param request Information about the request to be sent.
|
|
Packit |
071ada |
* @param num_fds Number of additional file descriptors to send to the server
|
|
Packit |
071ada |
* @param fds Additional file descriptors that should be send to the server.
|
|
Packit |
071ada |
* @return The request's sequence number on success, 0 otherwise.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* This function sends a new request to the X server. The data of the request is
|
|
Packit |
071ada |
* given as an array of @c iovecs in the @p vector argument. The length of that
|
|
Packit |
071ada |
* array and the necessary management information are given in the @p request
|
|
Packit |
071ada |
* argument.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* If @p num_fds is non-zero, @p fds points to an array of file descriptors that
|
|
Packit |
071ada |
* will be sent to the X server along with this request. After this function
|
|
Packit |
071ada |
* returns, all file descriptors sent are owned by xcb and will be closed
|
|
Packit |
071ada |
* eventually.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* When this function returns, the request might or might not be sent already.
|
|
Packit |
071ada |
* Use xcb_flush() to make sure that it really was sent.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that this function is not the preferred way for sending requests.
|
|
Packit |
071ada |
* It's better to use the generated wrapper functions.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Please note that xcb might use index -1 and -2 of the @p vector array internally,
|
|
Packit |
071ada |
* so they must be valid!
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
uint64_t xcb_send_request_with_fds64(xcb_connection_t *c, int flags, struct iovec *vector,
|
|
Packit |
071ada |
const xcb_protocol_request_t *request, unsigned int num_fds, int *fds);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Send a file descriptor to the server in the next call to xcb_send_request.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param fd The file descriptor to send.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* After this function returns, the file descriptor given is owned by xcb and
|
|
Packit |
071ada |
* will be closed eventually.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* @deprecated This function cannot be used in a thread-safe way. Two threads
|
|
Packit |
071ada |
* that run xcb_send_fd(); xcb_send_request(); could mix up their file
|
|
Packit |
071ada |
* descriptors. Instead, xcb_send_request_with_fds() should be used.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
void xcb_send_fd(xcb_connection_t *c, int fd);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Take over the write side of the socket
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param return_socket Callback function that will be called when xcb wants
|
|
Packit |
071ada |
* to use the socket again.
|
|
Packit |
071ada |
* @param closure Argument to the callback function.
|
|
Packit |
071ada |
* @param flags A combination of flags from the xcb_send_request_flags_t enumeration.
|
|
Packit |
071ada |
* @param sent Location to the sequence number of the last sequence request.
|
|
Packit |
071ada |
* Must not be NULL.
|
|
Packit |
071ada |
* @return 1 on success, else 0.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* xcb_take_socket allows external code to ask XCB for permission to
|
|
Packit |
071ada |
* take over the write side of the socket and send raw data with
|
|
Packit |
071ada |
* xcb_writev. xcb_take_socket provides the sequence number of the last
|
|
Packit |
071ada |
* request XCB sent. The caller of xcb_take_socket must supply a
|
|
Packit |
071ada |
* callback which XCB can call when it wants the write side of the
|
|
Packit |
071ada |
* socket back to make a request. This callback synchronizes with the
|
|
Packit |
071ada |
* external socket owner and flushes any output queues if appropriate.
|
|
Packit |
071ada |
* If you are sending requests which won't cause a reply, please note the
|
|
Packit |
071ada |
* comment for xcb_writev which explains some sequence number wrap issues.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* All replies that are generated while the socket is owned externally have
|
|
Packit |
071ada |
* @p flags applied to them. For example, use XCB_REQUEST_CHECK if you don't
|
|
Packit |
071ada |
* want errors to go to xcb's normal error handling, but instead having to be
|
|
Packit |
071ada |
* picked up via xcb_wait_for_reply(), xcb_poll_for_reply() or
|
|
Packit |
071ada |
* xcb_request_check().
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int xcb_take_socket(xcb_connection_t *c, void (*return_socket)(void *closure), void *closure, int flags, uint64_t *sent);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Send raw data to the X server.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param vector Array of data to be sent.
|
|
Packit |
071ada |
* @param count Number of entries in @p vector.
|
|
Packit |
071ada |
* @param requests Number of requests that are being sent.
|
|
Packit |
071ada |
* @return 1 on success, else 0.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* You must own the write-side of the socket (you've called
|
|
Packit |
071ada |
* xcb_take_socket, and haven't returned from return_socket yet) to call
|
|
Packit |
071ada |
* xcb_writev. Also, the iovec must have at least 1 byte of data in it.
|
|
Packit |
071ada |
* You have to make sure that xcb can detect sequence number wraps correctly.
|
|
Packit |
071ada |
* This means that the first request you send after xcb_take_socket must cause a
|
|
Packit |
071ada |
* reply (e.g. just insert a GetInputFocus request). After every (1 << 16) - 1
|
|
Packit |
071ada |
* requests without a reply, you have to insert a request which will cause a
|
|
Packit |
071ada |
* reply. You can again use GetInputFocus for this. You do not have to wait for
|
|
Packit |
071ada |
* any of the GetInputFocus replies, but can instead handle them via
|
|
Packit |
071ada |
* xcb_discard_reply().
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int xcb_writev(xcb_connection_t *c, struct iovec *vector, int count, uint64_t requests);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/* xcb_in.c */
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Wait for the reply of a given request.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param request Sequence number of the request as returned by xcb_send_request().
|
|
Packit |
071ada |
* @param e Location to store errors in, or NULL. Ignored for unchecked requests.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Returns the reply to the given request or returns null in the event of
|
|
Packit |
071ada |
* errors. Blocks until the reply or error for the request arrives, or an I/O
|
|
Packit |
071ada |
* error occurs.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
void *xcb_wait_for_reply(xcb_connection_t *c, unsigned int request, xcb_generic_error_t **e);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Wait for the reply of a given request, with 64-bit sequence number
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param request 64-bit sequence number of the request as returned by xcb_send_request64().
|
|
Packit |
071ada |
* @param e Location to store errors in, or NULL. Ignored for unchecked requests.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Returns the reply to the given request or returns null in the event of
|
|
Packit |
071ada |
* errors. Blocks until the reply or error for the request arrives, or an I/O
|
|
Packit |
071ada |
* error occurs.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Unlike its xcb_wait_for_reply() counterpart, the given sequence number is not
|
|
Packit |
071ada |
* automatically "widened" to 64-bit.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
void *xcb_wait_for_reply64(xcb_connection_t *c, uint64_t request, xcb_generic_error_t **e);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Poll for the reply of a given request.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param request Sequence number of the request as returned by xcb_send_request().
|
|
Packit |
071ada |
* @param reply Location to store the reply in, must not be NULL.
|
|
Packit |
071ada |
* @param error Location to store errors in, or NULL. Ignored for unchecked requests.
|
|
Packit |
071ada |
* @return 1 when the reply to the request was returned, else 0.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Checks if the reply to the given request already received. Does not block.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int xcb_poll_for_reply(xcb_connection_t *c, unsigned int request, void **reply, xcb_generic_error_t **error);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Poll for the reply of a given request, with 64-bit sequence number.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param request 64-bit sequence number of the request as returned by xcb_send_request().
|
|
Packit |
071ada |
* @param reply Location to store the reply in, must not be NULL.
|
|
Packit |
071ada |
* @param error Location to store errors in, or NULL. Ignored for unchecked requests.
|
|
Packit |
071ada |
* @return 1 when the reply to the request was returned, else 0.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Checks if the reply to the given request already received. Does not block.
|
|
Packit |
071ada |
*
|
|
Packit |
071ada |
* Unlike its xcb_poll_for_reply() counterpart, the given sequence number is not
|
|
Packit |
071ada |
* automatically "widened" to 64-bit.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int xcb_poll_for_reply64(xcb_connection_t *c, uint64_t request, void **reply, xcb_generic_error_t **error);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @brief Don't use this, only needed by the generated code.
|
|
Packit |
071ada |
* @param c The connection to the X server.
|
|
Packit |
071ada |
* @param reply A reply that was received from the server
|
|
Packit |
071ada |
* @param replylen The size of the reply.
|
|
Packit |
071ada |
* @return Pointer to the location where received file descriptors are stored.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int *xcb_get_reply_fds(xcb_connection_t *c, void *reply, size_t replylen);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/* xcb_util.c */
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @param mask The mask to check
|
|
Packit |
071ada |
* @return The number of set bits in the mask
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int xcb_popcount(uint32_t mask);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
/**
|
|
Packit |
071ada |
* @param list The base of an array
|
|
Packit |
071ada |
* @param len The length of the array
|
|
Packit |
071ada |
* @return The sum of all entries in the array.
|
|
Packit |
071ada |
*/
|
|
Packit |
071ada |
int xcb_sumof(uint8_t *list, int len);
|
|
Packit |
071ada |
|
|
Packit |
071ada |
#ifdef __cplusplus
|
|
Packit |
071ada |
}
|
|
Packit |
071ada |
#endif
|
|
Packit |
071ada |
|
|
Packit |
071ada |
#endif
|