jpayne@69: /* jpayne@69: * Copyright (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett. jpayne@69: * All Rights Reserved. jpayne@69: * jpayne@69: * Permission is hereby granted, free of charge, to any person obtaining a jpayne@69: * copy of this software and associated documentation files (the "Software"), jpayne@69: * to deal in the Software without restriction, including without limitation jpayne@69: * the rights to use, copy, modify, merge, publish, distribute, sublicense, jpayne@69: * and/or sell copies of the Software, and to permit persons to whom the jpayne@69: * Software is furnished to do so, subject to the following conditions: jpayne@69: * jpayne@69: * The above copyright notice and this permission notice shall be included in jpayne@69: * all copies or substantial portions of the Software. jpayne@69: * jpayne@69: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR jpayne@69: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, jpayne@69: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE jpayne@69: * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN jpayne@69: * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN jpayne@69: * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. jpayne@69: * jpayne@69: * Except as contained in this notice, the names of the authors or their jpayne@69: * institutions shall not be used in advertising or otherwise to promote the jpayne@69: * sale, use or other dealings in this Software without prior written jpayne@69: * authorization from the authors. jpayne@69: */ jpayne@69: jpayne@69: #ifndef __XCB_H__ jpayne@69: #define __XCB_H__ jpayne@69: #include jpayne@69: jpayne@69: #if defined(__solaris__) jpayne@69: #include jpayne@69: #else jpayne@69: #include jpayne@69: #endif jpayne@69: jpayne@69: #ifndef _WIN32 jpayne@69: #include jpayne@69: #else jpayne@69: #include "xcb_windefs.h" jpayne@69: #endif jpayne@69: #include jpayne@69: jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: jpayne@69: /** jpayne@69: * @file xcb.h jpayne@69: */ jpayne@69: jpayne@69: #ifdef __GNUC__ jpayne@69: #define XCB_PACKED __attribute__((__packed__)) jpayne@69: #else jpayne@69: #define XCB_PACKED jpayne@69: #endif jpayne@69: jpayne@69: /** jpayne@69: * @defgroup XCB_Core_API XCB Core API jpayne@69: * @brief Core API of the XCB library. jpayne@69: * jpayne@69: * @{ jpayne@69: */ jpayne@69: jpayne@69: /* Pre-defined constants */ jpayne@69: jpayne@69: /** Current protocol version */ jpayne@69: #define X_PROTOCOL 11 jpayne@69: jpayne@69: /** Current minor version */ jpayne@69: #define X_PROTOCOL_REVISION 0 jpayne@69: jpayne@69: /** X_TCP_PORT + display number = server port for TCP transport */ jpayne@69: #define X_TCP_PORT 6000 jpayne@69: jpayne@69: /** xcb connection errors because of socket, pipe and other stream errors. */ jpayne@69: #define XCB_CONN_ERROR 1 jpayne@69: jpayne@69: /** xcb connection shutdown because of extension not supported */ jpayne@69: #define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2 jpayne@69: jpayne@69: /** malloc(), calloc() and realloc() error upon failure, for eg ENOMEM */ jpayne@69: #define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3 jpayne@69: jpayne@69: /** Connection closed, exceeding request length that server accepts. */ jpayne@69: #define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4 jpayne@69: jpayne@69: /** Connection closed, error during parsing display string. */ jpayne@69: #define XCB_CONN_CLOSED_PARSE_ERR 5 jpayne@69: jpayne@69: /** Connection closed because the server does not have a screen matching the display. */ jpayne@69: #define XCB_CONN_CLOSED_INVALID_SCREEN 6 jpayne@69: jpayne@69: /** Connection closed because some FD passing operation failed */ jpayne@69: #define XCB_CONN_CLOSED_FDPASSING_FAILED 7 jpayne@69: jpayne@69: #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1)) jpayne@69: jpayne@69: /* Opaque structures */ jpayne@69: jpayne@69: /** jpayne@69: * @brief XCB Connection structure. jpayne@69: * jpayne@69: * A structure that contain all data that XCB needs to communicate with an X server. jpayne@69: */ jpayne@69: typedef struct xcb_connection_t xcb_connection_t; /**< Opaque structure containing all data that XCB needs to communicate with an X server. */ jpayne@69: jpayne@69: jpayne@69: /* Other types */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Generic iterator. jpayne@69: * jpayne@69: * A generic iterator structure. jpayne@69: */ jpayne@69: typedef struct { jpayne@69: void *data; /**< Data of the current iterator */ jpayne@69: int rem; /**< remaining elements */ jpayne@69: int index; /**< index of the current iterator */ jpayne@69: } xcb_generic_iterator_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief Generic reply. jpayne@69: * jpayne@69: * A generic reply structure. jpayne@69: */ jpayne@69: typedef struct { jpayne@69: uint8_t response_type; /**< Type of the response */ jpayne@69: uint8_t pad0; /**< Padding */ jpayne@69: uint16_t sequence; /**< Sequence number */ jpayne@69: uint32_t length; /**< Length of the response */ jpayne@69: } xcb_generic_reply_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief Generic event. jpayne@69: * jpayne@69: * A generic event structure. jpayne@69: */ jpayne@69: typedef struct { jpayne@69: uint8_t response_type; /**< Type of the response */ jpayne@69: uint8_t pad0; /**< Padding */ jpayne@69: uint16_t sequence; /**< Sequence number */ jpayne@69: uint32_t pad[7]; /**< Padding */ jpayne@69: uint32_t full_sequence; /**< full sequence */ jpayne@69: } xcb_generic_event_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief Raw Generic event. jpayne@69: * jpayne@69: * A generic event structure as used on the wire, i.e., without the full_sequence field jpayne@69: */ jpayne@69: typedef struct { jpayne@69: uint8_t response_type; /**< Type of the response */ jpayne@69: uint8_t pad0; /**< Padding */ jpayne@69: uint16_t sequence; /**< Sequence number */ jpayne@69: uint32_t pad[7]; /**< Padding */ jpayne@69: } xcb_raw_generic_event_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief GE event jpayne@69: * jpayne@69: * An event as sent by the XGE extension. The length field specifies the jpayne@69: * number of 4-byte blocks trailing the struct. jpayne@69: * jpayne@69: * @deprecated Since some fields in this struct have unfortunate names, it is jpayne@69: * recommended to use xcb_ge_generic_event_t instead. jpayne@69: */ jpayne@69: typedef struct { jpayne@69: uint8_t response_type; /**< Type of the response */ jpayne@69: uint8_t pad0; /**< Padding */ jpayne@69: uint16_t sequence; /**< Sequence number */ jpayne@69: uint32_t length; jpayne@69: uint16_t event_type; jpayne@69: uint16_t pad1; jpayne@69: uint32_t pad[5]; /**< Padding */ jpayne@69: uint32_t full_sequence; /**< full sequence */ jpayne@69: } xcb_ge_event_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief Generic error. jpayne@69: * jpayne@69: * A generic error structure. jpayne@69: */ jpayne@69: typedef struct { jpayne@69: uint8_t response_type; /**< Type of the response */ jpayne@69: uint8_t error_code; /**< Error code */ jpayne@69: uint16_t sequence; /**< Sequence number */ jpayne@69: uint32_t resource_id; /** < Resource ID for requests with side effects only */ jpayne@69: uint16_t minor_code; /** < Minor opcode of the failed request */ jpayne@69: uint8_t major_code; /** < Major opcode of the failed request */ jpayne@69: uint8_t pad0; jpayne@69: uint32_t pad[5]; /**< Padding */ jpayne@69: uint32_t full_sequence; /**< full sequence */ jpayne@69: } xcb_generic_error_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief Generic cookie. jpayne@69: * jpayne@69: * A generic cookie structure. jpayne@69: */ jpayne@69: typedef struct { jpayne@69: unsigned int sequence; /**< Sequence number */ jpayne@69: } xcb_void_cookie_t; jpayne@69: jpayne@69: jpayne@69: /* Include the generated xproto header. */ jpayne@69: #include "xproto.h" jpayne@69: jpayne@69: jpayne@69: /** XCB_NONE is the universal null resource or null atom parameter value for many core X requests */ jpayne@69: #define XCB_NONE 0L jpayne@69: jpayne@69: /** XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters */ jpayne@69: #define XCB_COPY_FROM_PARENT 0L jpayne@69: jpayne@69: /** XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t */ jpayne@69: #define XCB_CURRENT_TIME 0L jpayne@69: jpayne@69: /** XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables */ jpayne@69: #define XCB_NO_SYMBOL 0L jpayne@69: jpayne@69: jpayne@69: /* xcb_auth.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Container for authorization information. jpayne@69: * jpayne@69: * A container for authorization information to be sent to the X server. jpayne@69: */ jpayne@69: typedef struct xcb_auth_info_t { jpayne@69: int namelen; /**< Length of the string name (as returned by strlen). */ jpayne@69: char *name; /**< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". */ jpayne@69: int datalen; /**< Length of the data member. */ jpayne@69: char *data; /**< Data interpreted in a protocol-specific manner. */ jpayne@69: } xcb_auth_info_t; jpayne@69: jpayne@69: jpayne@69: /* xcb_out.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Forces any buffered output to be written to the server. jpayne@69: * @param c The connection to the X server. jpayne@69: * @return > @c 0 on success, <= @c 0 otherwise. jpayne@69: * jpayne@69: * Forces any buffered output to be written to the server. Blocks jpayne@69: * until the write is complete. jpayne@69: */ jpayne@69: int xcb_flush(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Returns the maximum request length that this server accepts. jpayne@69: * @param c The connection to the X server. jpayne@69: * @return The maximum request length field. jpayne@69: * jpayne@69: * In the absence of the BIG-REQUESTS extension, returns the jpayne@69: * maximum request length field from the connection setup data, which jpayne@69: * may be as much as 65535. If the server supports BIG-REQUESTS, then jpayne@69: * the maximum request length field from the reply to the jpayne@69: * BigRequestsEnable request will be returned instead. jpayne@69: * jpayne@69: * Note that this length is measured in four-byte units, making the jpayne@69: * theoretical maximum lengths roughly 256kB without BIG-REQUESTS and jpayne@69: * 16GB with. jpayne@69: */ jpayne@69: uint32_t xcb_get_maximum_request_length(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Prefetch the maximum request length without blocking. jpayne@69: * @param c The connection to the X server. jpayne@69: * jpayne@69: * Without blocking, does as much work as possible toward computing jpayne@69: * the maximum request length accepted by the X server. jpayne@69: * jpayne@69: * Invoking this function may cause a call to xcb_big_requests_enable, jpayne@69: * but will not block waiting for the reply. jpayne@69: * xcb_get_maximum_request_length will return the prefetched data jpayne@69: * after possibly blocking while the reply is retrieved. jpayne@69: * jpayne@69: * Note that in order for this function to be fully non-blocking, the jpayne@69: * application must previously have called jpayne@69: * xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply jpayne@69: * must have already arrived. jpayne@69: */ jpayne@69: void xcb_prefetch_maximum_request_length(xcb_connection_t *c); jpayne@69: jpayne@69: jpayne@69: /* xcb_in.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Returns the next event or error from the server. jpayne@69: * @param c The connection to the X server. jpayne@69: * @return The next event from the server. jpayne@69: * jpayne@69: * Returns the next event or error from the server, or returns null in jpayne@69: * the event of an I/O error. Blocks until either an event or error jpayne@69: * arrive, or an I/O error occurs. jpayne@69: */ jpayne@69: xcb_generic_event_t *xcb_wait_for_event(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Returns the next event or error from the server. jpayne@69: * @param c The connection to the X server. jpayne@69: * @return The next event from the server. jpayne@69: * jpayne@69: * Returns the next event or error from the server, if one is jpayne@69: * available, or returns @c NULL otherwise. If no event is available, that jpayne@69: * might be because an I/O error like connection close occurred while jpayne@69: * attempting to read the next event, in which case the connection is jpayne@69: * shut down when this function returns. jpayne@69: */ jpayne@69: xcb_generic_event_t *xcb_poll_for_event(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Returns the next event without reading from the connection. jpayne@69: * @param c The connection to the X server. jpayne@69: * @return The next already queued event from the server. jpayne@69: * jpayne@69: * This is a version of xcb_poll_for_event that only examines the jpayne@69: * event queue for new events. The function doesn't try to read new jpayne@69: * events from the connection if no queued events are found. jpayne@69: * jpayne@69: * This function is useful for callers that know in advance that all jpayne@69: * interesting events have already been read from the connection. For jpayne@69: * example, callers might use xcb_wait_for_reply and be interested jpayne@69: * only of events that preceded a specific reply. jpayne@69: */ jpayne@69: xcb_generic_event_t *xcb_poll_for_queued_event(xcb_connection_t *c); jpayne@69: jpayne@69: typedef struct xcb_special_event xcb_special_event_t; jpayne@69: jpayne@69: /** jpayne@69: * @brief Returns the next event from a special queue jpayne@69: */ jpayne@69: xcb_generic_event_t *xcb_poll_for_special_event(xcb_connection_t *c, jpayne@69: xcb_special_event_t *se); jpayne@69: jpayne@69: /** jpayne@69: * @brief Returns the next event from a special queue, blocking until one arrives jpayne@69: */ jpayne@69: xcb_generic_event_t *xcb_wait_for_special_event(xcb_connection_t *c, jpayne@69: xcb_special_event_t *se); jpayne@69: /** jpayne@69: * @typedef typedef struct xcb_extension_t xcb_extension_t jpayne@69: */ jpayne@69: typedef struct xcb_extension_t xcb_extension_t; /**< Opaque structure used as key for xcb_get_extension_data_t. */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Listen for a special event jpayne@69: */ jpayne@69: xcb_special_event_t *xcb_register_for_special_xge(xcb_connection_t *c, jpayne@69: xcb_extension_t *ext, jpayne@69: uint32_t eid, jpayne@69: uint32_t *stamp); jpayne@69: jpayne@69: /** jpayne@69: * @brief Stop listening for a special event jpayne@69: */ jpayne@69: void xcb_unregister_for_special_event(xcb_connection_t *c, jpayne@69: xcb_special_event_t *se); jpayne@69: jpayne@69: /** jpayne@69: * @brief Return the error for a request, or NULL if none can ever arrive. jpayne@69: * @param c The connection to the X server. jpayne@69: * @param cookie The request cookie. jpayne@69: * @return The error for the request, or NULL if none can ever arrive. jpayne@69: * jpayne@69: * The xcb_void_cookie_t cookie supplied to this function must have resulted jpayne@69: * from a call to xcb_[request_name]_checked(). This function will block jpayne@69: * until one of two conditions happens. If an error is received, it will be jpayne@69: * returned. If a reply to a subsequent request has already arrived, no error jpayne@69: * can arrive for this request, so this function will return NULL. jpayne@69: * jpayne@69: * Note that this function will perform a sync if needed to ensure that the jpayne@69: * sequence number will advance beyond that provided in cookie; this is a jpayne@69: * convenience to avoid races in determining whether the sync is needed. jpayne@69: */ jpayne@69: xcb_generic_error_t *xcb_request_check(xcb_connection_t *c, xcb_void_cookie_t cookie); jpayne@69: jpayne@69: /** jpayne@69: * @brief Discards the reply for a request. jpayne@69: * @param c The connection to the X server. jpayne@69: * @param sequence The request sequence number from a cookie. jpayne@69: * jpayne@69: * Discards the reply for a request. Additionally, any error generated jpayne@69: * by the request is also discarded (unless it was an _unchecked request jpayne@69: * and the error has already arrived). jpayne@69: * jpayne@69: * This function will not block even if the reply is not yet available. jpayne@69: * jpayne@69: * Note that the sequence really does have to come from an xcb cookie; jpayne@69: * this function is not designed to operate on socket-handoff replies. jpayne@69: */ jpayne@69: void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence); jpayne@69: jpayne@69: /** jpayne@69: * @brief Discards the reply for a request, given by a 64bit sequence number jpayne@69: * @param c The connection to the X server. jpayne@69: * @param sequence 64-bit sequence number as returned by xcb_send_request64(). jpayne@69: * jpayne@69: * Discards the reply for a request. Additionally, any error generated jpayne@69: * by the request is also discarded (unless it was an _unchecked request jpayne@69: * and the error has already arrived). jpayne@69: * jpayne@69: * This function will not block even if the reply is not yet available. jpayne@69: * jpayne@69: * Note that the sequence really does have to come from xcb_send_request64(); jpayne@69: * the cookie sequence number is defined as "unsigned" int and therefore jpayne@69: * not 64-bit on all platforms. jpayne@69: * This function is not designed to operate on socket-handoff replies. jpayne@69: * jpayne@69: * Unlike its xcb_discard_reply() counterpart, the given sequence number is not jpayne@69: * automatically "widened" to 64-bit. jpayne@69: */ jpayne@69: void xcb_discard_reply64(xcb_connection_t *c, uint64_t sequence); jpayne@69: jpayne@69: /* xcb_ext.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Caches reply information from QueryExtension requests. jpayne@69: * @param c The connection. jpayne@69: * @param ext The extension data. jpayne@69: * @return A pointer to the xcb_query_extension_reply_t for the extension. jpayne@69: * jpayne@69: * This function is the primary interface to the "extension cache", jpayne@69: * which caches reply information from QueryExtension jpayne@69: * requests. Invoking this function may cause a call to jpayne@69: * xcb_query_extension to retrieve extension information from the jpayne@69: * server, and may block until extension data is received from the jpayne@69: * server. jpayne@69: * jpayne@69: * The result must not be freed. This storage is managed by the cache jpayne@69: * itself. jpayne@69: */ jpayne@69: const struct xcb_query_extension_reply_t *xcb_get_extension_data(xcb_connection_t *c, xcb_extension_t *ext); jpayne@69: jpayne@69: /** jpayne@69: * @brief Prefetch of extension data into the extension cache jpayne@69: * @param c The connection. jpayne@69: * @param ext The extension data. jpayne@69: * jpayne@69: * This function allows a "prefetch" of extension data into the jpayne@69: * extension cache. Invoking the function may cause a call to jpayne@69: * xcb_query_extension, but will not block waiting for the jpayne@69: * reply. xcb_get_extension_data will return the prefetched data after jpayne@69: * possibly blocking while it is retrieved. jpayne@69: */ jpayne@69: void xcb_prefetch_extension_data(xcb_connection_t *c, xcb_extension_t *ext); jpayne@69: jpayne@69: jpayne@69: /* xcb_conn.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Access the data returned by the server. jpayne@69: * @param c The connection. jpayne@69: * @return A pointer to an xcb_setup_t structure. jpayne@69: * jpayne@69: * Accessor for the data returned by the server when the xcb_connection_t jpayne@69: * was initialized. This data includes jpayne@69: * - the server's required format for images, jpayne@69: * - a list of available visuals, jpayne@69: * - a list of available screens, jpayne@69: * - the server's maximum request length (in the absence of the jpayne@69: * BIG-REQUESTS extension), jpayne@69: * - and other assorted information. jpayne@69: * jpayne@69: * See the X protocol specification for more details. jpayne@69: * jpayne@69: * The result must not be freed. jpayne@69: */ jpayne@69: const struct xcb_setup_t *xcb_get_setup(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Access the file descriptor of the connection. jpayne@69: * @param c The connection. jpayne@69: * @return The file descriptor. jpayne@69: * jpayne@69: * Accessor for the file descriptor that was passed to the jpayne@69: * xcb_connect_to_fd call that returned @p c. jpayne@69: */ jpayne@69: int xcb_get_file_descriptor(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Test whether the connection has shut down due to a fatal error. jpayne@69: * @param c The connection. jpayne@69: * @return > 0 if the connection is in an error state; 0 otherwise. jpayne@69: * jpayne@69: * Some errors that occur in the context of an xcb_connection_t jpayne@69: * are unrecoverable. When such an error occurs, the jpayne@69: * connection is shut down and further operations on the jpayne@69: * xcb_connection_t have no effect, but memory will not be freed until jpayne@69: * xcb_disconnect() is called on the xcb_connection_t. jpayne@69: * jpayne@69: * @return XCB_CONN_ERROR, because of socket errors, pipe errors or other stream errors. jpayne@69: * @return XCB_CONN_CLOSED_EXT_NOTSUPPORTED, when extension not supported. jpayne@69: * @return XCB_CONN_CLOSED_MEM_INSUFFICIENT, when memory not available. jpayne@69: * @return XCB_CONN_CLOSED_REQ_LEN_EXCEED, exceeding request length that server accepts. jpayne@69: * @return XCB_CONN_CLOSED_PARSE_ERR, error during parsing display string. jpayne@69: * @return XCB_CONN_CLOSED_INVALID_SCREEN, because the server does not have a screen matching the display. jpayne@69: */ jpayne@69: int xcb_connection_has_error(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @brief Connects to the X server. jpayne@69: * @param fd The file descriptor. jpayne@69: * @param auth_info Authentication data. jpayne@69: * @return A newly allocated xcb_connection_t structure. jpayne@69: * jpayne@69: * Connects to an X server, given the open socket @p fd and the jpayne@69: * xcb_auth_info_t @p auth_info. The file descriptor @p fd is jpayne@69: * bidirectionally connected to an X server. If the connection jpayne@69: * should be unauthenticated, @p auth_info must be @c jpayne@69: * NULL. jpayne@69: * jpayne@69: * Always returns a non-NULL pointer to a xcb_connection_t, even on failure. jpayne@69: * Callers need to use xcb_connection_has_error() to check for failure. jpayne@69: * When finished, use xcb_disconnect() to close the connection and free jpayne@69: * the structure. jpayne@69: */ jpayne@69: xcb_connection_t *xcb_connect_to_fd(int fd, xcb_auth_info_t *auth_info); jpayne@69: jpayne@69: /** jpayne@69: * @brief Closes the connection. jpayne@69: * @param c The connection. jpayne@69: * jpayne@69: * Closes the file descriptor and frees all memory associated with the jpayne@69: * connection @c c. If @p c is @c NULL, nothing is done. jpayne@69: */ jpayne@69: void xcb_disconnect(xcb_connection_t *c); jpayne@69: jpayne@69: jpayne@69: /* xcb_util.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Parses a display string name in the form documented by X(7x). jpayne@69: * @param name The name of the display. jpayne@69: * @param host A pointer to a malloc'd copy of the hostname. jpayne@69: * @param display A pointer to the display number. jpayne@69: * @param screen A pointer to the screen number. jpayne@69: * @return 0 on failure, non 0 otherwise. jpayne@69: * jpayne@69: * Parses the display string name @p display_name in the form jpayne@69: * documented by X(7x). Has no side effects on failure. If jpayne@69: * @p displayname is @c NULL or empty, it uses the environment jpayne@69: * variable DISPLAY. @p hostp is a pointer to a newly allocated string jpayne@69: * that contain the host name. @p displayp is set to the display jpayne@69: * number and @p screenp to the preferred screen number. @p screenp jpayne@69: * can be @c NULL. If @p displayname does not contain a screen number, jpayne@69: * it is set to @c 0. jpayne@69: */ jpayne@69: int xcb_parse_display(const char *name, char **host, int *display, int *screen); jpayne@69: jpayne@69: /** jpayne@69: * @brief Connects to the X server. jpayne@69: * @param displayname The name of the display. jpayne@69: * @param screenp A pointer to a preferred screen number. jpayne@69: * @return A newly allocated xcb_connection_t structure. jpayne@69: * jpayne@69: * Connects to the X server specified by @p displayname. If @p jpayne@69: * displayname is @c NULL, uses the value of the DISPLAY environment jpayne@69: * variable. If a particular screen on that server is preferred, the jpayne@69: * int pointed to by @p screenp (if not @c NULL) will be set to that jpayne@69: * screen; otherwise the screen will be set to 0. jpayne@69: * jpayne@69: * Always returns a non-NULL pointer to a xcb_connection_t, even on failure. jpayne@69: * Callers need to use xcb_connection_has_error() to check for failure. jpayne@69: * When finished, use xcb_disconnect() to close the connection and free jpayne@69: * the structure. jpayne@69: */ jpayne@69: xcb_connection_t *xcb_connect(const char *displayname, int *screenp); jpayne@69: jpayne@69: /** jpayne@69: * @brief Connects to the X server, using an authorization information. jpayne@69: * @param display The name of the display. jpayne@69: * @param auth The authorization information. jpayne@69: * @param screen A pointer to a preferred screen number. jpayne@69: * @return A newly allocated xcb_connection_t structure. jpayne@69: * jpayne@69: * Connects to the X server specified by @p displayname, using the jpayne@69: * authorization @p auth. If a particular screen on that server is jpayne@69: * preferred, the int pointed to by @p screenp (if not @c NULL) will jpayne@69: * be set to that screen; otherwise @p screenp will be set to 0. jpayne@69: * jpayne@69: * Always returns a non-NULL pointer to a xcb_connection_t, even on failure. jpayne@69: * Callers need to use xcb_connection_has_error() to check for failure. jpayne@69: * When finished, use xcb_disconnect() to close the connection and free jpayne@69: * the structure. jpayne@69: */ jpayne@69: xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb_auth_info_t *auth, int *screen); jpayne@69: jpayne@69: jpayne@69: /* xcb_xid.c */ jpayne@69: jpayne@69: /** jpayne@69: * @brief Allocates an XID for a new object. jpayne@69: * @param c The connection. jpayne@69: * @return A newly allocated XID, or -1 on failure. jpayne@69: * jpayne@69: * Allocates an XID for a new object. Typically used just prior to jpayne@69: * various object creation functions, such as xcb_create_window. jpayne@69: */ jpayne@69: uint32_t xcb_generate_id(xcb_connection_t *c); jpayne@69: jpayne@69: jpayne@69: /** jpayne@69: * @brief Obtain number of bytes read from the connection. jpayne@69: * @param c The connection jpayne@69: * @return Number of bytes read from the server. jpayne@69: * jpayne@69: * Returns cumulative number of bytes received from the connection. jpayne@69: * jpayne@69: * This retrieves the total number of bytes read from this connection, jpayne@69: * to be used for diagnostic/monitoring/informative purposes. jpayne@69: */ jpayne@69: jpayne@69: uint64_t jpayne@69: xcb_total_read(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * jpayne@69: * @brief Obtain number of bytes written to the connection. jpayne@69: * @param c The connection jpayne@69: * @return Number of bytes written to the server. jpayne@69: * jpayne@69: * Returns cumulative number of bytes sent to the connection. jpayne@69: * jpayne@69: * This retrieves the total number of bytes written to this connection, jpayne@69: * to be used for diagnostic/monitoring/informative purposes. jpayne@69: */ jpayne@69: jpayne@69: uint64_t jpayne@69: xcb_total_written(xcb_connection_t *c); jpayne@69: jpayne@69: /** jpayne@69: * @} jpayne@69: */ jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: } jpayne@69: #endif jpayne@69: jpayne@69: jpayne@69: #endif /* __XCB_H__ */