csp2: CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/xcb/xcb.h annotate

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/xcb/xcb.h @ 69:33d812a61356

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d

author	jpayne
date	Tue, 18 Mar 2025 17:55:14 -0400
parents
children

rev	line source
jpayne@69	1 /*
jpayne@69	2 * Copyright (C) 2001-2006 Bart Massey, Jamey Sharp, and Josh Triplett.
jpayne@69	3 * All Rights Reserved.
jpayne@69	4 *
jpayne@69	5 * Permission is hereby granted, free of charge, to any person obtaining a
jpayne@69	6 * copy of this software and associated documentation files (the "Software"),
jpayne@69	7 * to deal in the Software without restriction, including without limitation
jpayne@69	8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jpayne@69	9 * and/or sell copies of the Software, and to permit persons to whom the
jpayne@69	10 * Software is furnished to do so, subject to the following conditions:
jpayne@69	11 *
jpayne@69	12 * The above copyright notice and this permission notice shall be included in
jpayne@69	13 * all copies or substantial portions of the Software.
jpayne@69	14 *
jpayne@69	15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
jpayne@69	16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
jpayne@69	17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
jpayne@69	18 * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
jpayne@69	19 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
jpayne@69	20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jpayne@69	21 *
jpayne@69	22 * Except as contained in this notice, the names of the authors or their
jpayne@69	23 * institutions shall not be used in advertising or otherwise to promote the
jpayne@69	24 * sale, use or other dealings in this Software without prior written
jpayne@69	25 * authorization from the authors.
jpayne@69	26 */
jpayne@69	27
jpayne@69	28 #ifndef __XCB_H__
jpayne@69	29 #define __XCB_H__
jpayne@69	30 #include <sys/types.h>
jpayne@69	31
jpayne@69	32 #if defined(__solaris__)
jpayne@69	33 #include <inttypes.h>
jpayne@69	34 #else
jpayne@69	35 #include <stdint.h>
jpayne@69	36 #endif
jpayne@69	37
jpayne@69	38 #ifndef _WIN32
jpayne@69	39 #include <sys/uio.h>
jpayne@69	40 #else
jpayne@69	41 #include "xcb_windefs.h"
jpayne@69	42 #endif
jpayne@69	43 #include <pthread.h>
jpayne@69	44
jpayne@69	45
jpayne@69	46 #ifdef __cplusplus
jpayne@69	47 extern "C" {
jpayne@69	48 #endif
jpayne@69	49
jpayne@69	50 /**
jpayne@69	51 * @file xcb.h
jpayne@69	52 */
jpayne@69	53
jpayne@69	54 #ifdef __GNUC__
jpayne@69	55 #define XCB_PACKED __attribute__((__packed__))
jpayne@69	56 #else
jpayne@69	57 #define XCB_PACKED
jpayne@69	58 #endif
jpayne@69	59
jpayne@69	60 /**
jpayne@69	61 * @defgroup XCB_Core_API XCB Core API
jpayne@69	62 * @brief Core API of the XCB library.
jpayne@69	63 *
jpayne@69	64 * @{
jpayne@69	65 */
jpayne@69	66
jpayne@69	67 /* Pre-defined constants */
jpayne@69	68
jpayne@69	69 /** Current protocol version */
jpayne@69	70 #define X_PROTOCOL 11
jpayne@69	71
jpayne@69	72 /** Current minor version */
jpayne@69	73 #define X_PROTOCOL_REVISION 0
jpayne@69	74
jpayne@69	75 /** X_TCP_PORT + display number = server port for TCP transport */
jpayne@69	76 #define X_TCP_PORT 6000
jpayne@69	77
jpayne@69	78 /** xcb connection errors because of socket, pipe and other stream errors. */
jpayne@69	79 #define XCB_CONN_ERROR 1
jpayne@69	80
jpayne@69	81 /** xcb connection shutdown because of extension not supported */
jpayne@69	82 #define XCB_CONN_CLOSED_EXT_NOTSUPPORTED 2
jpayne@69	83
jpayne@69	84 /** malloc(), calloc() and realloc() error upon failure, for eg ENOMEM */
jpayne@69	85 #define XCB_CONN_CLOSED_MEM_INSUFFICIENT 3
jpayne@69	86
jpayne@69	87 /** Connection closed, exceeding request length that server accepts. */
jpayne@69	88 #define XCB_CONN_CLOSED_REQ_LEN_EXCEED 4
jpayne@69	89
jpayne@69	90 /** Connection closed, error during parsing display string. */
jpayne@69	91 #define XCB_CONN_CLOSED_PARSE_ERR 5
jpayne@69	92
jpayne@69	93 /** Connection closed because the server does not have a screen matching the display. */
jpayne@69	94 #define XCB_CONN_CLOSED_INVALID_SCREEN 6
jpayne@69	95
jpayne@69	96 /** Connection closed because some FD passing operation failed */
jpayne@69	97 #define XCB_CONN_CLOSED_FDPASSING_FAILED 7
jpayne@69	98
jpayne@69	99 #define XCB_TYPE_PAD(T,I) (-(I) & (sizeof(T) > 4 ? 3 : sizeof(T) - 1))
jpayne@69	100
jpayne@69	101 /* Opaque structures */
jpayne@69	102
jpayne@69	103 /**
jpayne@69	104 * @brief XCB Connection structure.
jpayne@69	105 *
jpayne@69	106 * A structure that contain all data that XCB needs to communicate with an X server.
jpayne@69	107 */
jpayne@69	108 typedef struct xcb_connection_t xcb_connection_t; /*< Opaque structure containing all data that XCB needs to communicate with an X server. /
jpayne@69	109
jpayne@69	110
jpayne@69	111 /* Other types */
jpayne@69	112
jpayne@69	113 /**
jpayne@69	114 * @brief Generic iterator.
jpayne@69	115 *
jpayne@69	116 * A generic iterator structure.
jpayne@69	117 */
jpayne@69	118 typedef struct {
jpayne@69	119 void data; /< Data of the current iterator /
jpayne@69	120 int rem; /*< remaining elements /
jpayne@69	121 int index; /*< index of the current iterator /
jpayne@69	122 } xcb_generic_iterator_t;
jpayne@69	123
jpayne@69	124 /**
jpayne@69	125 * @brief Generic reply.
jpayne@69	126 *
jpayne@69	127 * A generic reply structure.
jpayne@69	128 */
jpayne@69	129 typedef struct {
jpayne@69	130 uint8_t response_type; /*< Type of the response /
jpayne@69	131 uint8_t pad0; /*< Padding /
jpayne@69	132 uint16_t sequence; /*< Sequence number /
jpayne@69	133 uint32_t length; /*< Length of the response /
jpayne@69	134 } xcb_generic_reply_t;
jpayne@69	135
jpayne@69	136 /**
jpayne@69	137 * @brief Generic event.
jpayne@69	138 *
jpayne@69	139 * A generic event structure.
jpayne@69	140 */
jpayne@69	141 typedef struct {
jpayne@69	142 uint8_t response_type; /*< Type of the response /
jpayne@69	143 uint8_t pad0; /*< Padding /
jpayne@69	144 uint16_t sequence; /*< Sequence number /
jpayne@69	145 uint32_t pad[7]; /*< Padding /
jpayne@69	146 uint32_t full_sequence; /*< full sequence /
jpayne@69	147 } xcb_generic_event_t;
jpayne@69	148
jpayne@69	149 /**
jpayne@69	150 * @brief Raw Generic event.
jpayne@69	151 *
jpayne@69	152 * A generic event structure as used on the wire, i.e., without the full_sequence field
jpayne@69	153 */
jpayne@69	154 typedef struct {
jpayne@69	155 uint8_t response_type; /*< Type of the response /
jpayne@69	156 uint8_t pad0; /*< Padding /
jpayne@69	157 uint16_t sequence; /*< Sequence number /
jpayne@69	158 uint32_t pad[7]; /*< Padding /
jpayne@69	159 } xcb_raw_generic_event_t;
jpayne@69	160
jpayne@69	161 /**
jpayne@69	162 * @brief GE event
jpayne@69	163 *
jpayne@69	164 * An event as sent by the XGE extension. The length field specifies the
jpayne@69	165 * number of 4-byte blocks trailing the struct.
jpayne@69	166 *
jpayne@69	167 * @deprecated Since some fields in this struct have unfortunate names, it is
jpayne@69	168 * recommended to use xcb_ge_generic_event_t instead.
jpayne@69	169 */
jpayne@69	170 typedef struct {
jpayne@69	171 uint8_t response_type; /*< Type of the response /
jpayne@69	172 uint8_t pad0; /*< Padding /
jpayne@69	173 uint16_t sequence; /*< Sequence number /
jpayne@69	174 uint32_t length;
jpayne@69	175 uint16_t event_type;
jpayne@69	176 uint16_t pad1;
jpayne@69	177 uint32_t pad[5]; /*< Padding /
jpayne@69	178 uint32_t full_sequence; /*< full sequence /
jpayne@69	179 } xcb_ge_event_t;
jpayne@69	180
jpayne@69	181 /**
jpayne@69	182 * @brief Generic error.
jpayne@69	183 *
jpayne@69	184 * A generic error structure.
jpayne@69	185 */
jpayne@69	186 typedef struct {
jpayne@69	187 uint8_t response_type; /*< Type of the response /
jpayne@69	188 uint8_t error_code; /*< Error code /
jpayne@69	189 uint16_t sequence; /*< Sequence number /
jpayne@69	190 uint32_t resource_id; /** < Resource ID for requests with side effects only */
jpayne@69	191 uint16_t minor_code; /** < Minor opcode of the failed request */
jpayne@69	192 uint8_t major_code; /** < Major opcode of the failed request */
jpayne@69	193 uint8_t pad0;
jpayne@69	194 uint32_t pad[5]; /*< Padding /
jpayne@69	195 uint32_t full_sequence; /*< full sequence /
jpayne@69	196 } xcb_generic_error_t;
jpayne@69	197
jpayne@69	198 /**
jpayne@69	199 * @brief Generic cookie.
jpayne@69	200 *
jpayne@69	201 * A generic cookie structure.
jpayne@69	202 */
jpayne@69	203 typedef struct {
jpayne@69	204 unsigned int sequence; /*< Sequence number /
jpayne@69	205 } xcb_void_cookie_t;
jpayne@69	206
jpayne@69	207
jpayne@69	208 /* Include the generated xproto header. */
jpayne@69	209 #include "xproto.h"
jpayne@69	210
jpayne@69	211
jpayne@69	212 /** XCB_NONE is the universal null resource or null atom parameter value for many core X requests */
jpayne@69	213 #define XCB_NONE 0L
jpayne@69	214
jpayne@69	215 /** XCB_COPY_FROM_PARENT can be used for many xcb_create_window parameters */
jpayne@69	216 #define XCB_COPY_FROM_PARENT 0L
jpayne@69	217
jpayne@69	218 /** XCB_CURRENT_TIME can be used in most requests that take an xcb_timestamp_t */
jpayne@69	219 #define XCB_CURRENT_TIME 0L
jpayne@69	220
jpayne@69	221 /** XCB_NO_SYMBOL fills in unused entries in xcb_keysym_t tables */
jpayne@69	222 #define XCB_NO_SYMBOL 0L
jpayne@69	223
jpayne@69	224
jpayne@69	225 /* xcb_auth.c */
jpayne@69	226
jpayne@69	227 /**
jpayne@69	228 * @brief Container for authorization information.
jpayne@69	229 *
jpayne@69	230 * A container for authorization information to be sent to the X server.
jpayne@69	231 */
jpayne@69	232 typedef struct xcb_auth_info_t {
jpayne@69	233 int namelen; /*< Length of the string name (as returned by strlen). /
jpayne@69	234 char name; /< String containing the authentication protocol name, such as "MIT-MAGIC-COOKIE-1" or "XDM-AUTHORIZATION-1". /
jpayne@69	235 int datalen; /*< Length of the data member. /
jpayne@69	236 char data; /< Data interpreted in a protocol-specific manner. /
jpayne@69	237 } xcb_auth_info_t;
jpayne@69	238
jpayne@69	239
jpayne@69	240 /* xcb_out.c */
jpayne@69	241
jpayne@69	242 /**
jpayne@69	243 * @brief Forces any buffered output to be written to the server.
jpayne@69	244 * @param c The connection to the X server.
jpayne@69	245 * @return > @c 0 on success, <= @c 0 otherwise.
jpayne@69	246 *
jpayne@69	247 * Forces any buffered output to be written to the server. Blocks
jpayne@69	248 * until the write is complete.
jpayne@69	249 */
jpayne@69	250 int xcb_flush(xcb_connection_t *c);
jpayne@69	251
jpayne@69	252 /**
jpayne@69	253 * @brief Returns the maximum request length that this server accepts.
jpayne@69	254 * @param c The connection to the X server.
jpayne@69	255 * @return The maximum request length field.
jpayne@69	256 *
jpayne@69	257 * In the absence of the BIG-REQUESTS extension, returns the
jpayne@69	258 * maximum request length field from the connection setup data, which
jpayne@69	259 * may be as much as 65535. If the server supports BIG-REQUESTS, then
jpayne@69	260 * the maximum request length field from the reply to the
jpayne@69	261 * BigRequestsEnable request will be returned instead.
jpayne@69	262 *
jpayne@69	263 * Note that this length is measured in four-byte units, making the
jpayne@69	264 * theoretical maximum lengths roughly 256kB without BIG-REQUESTS and
jpayne@69	265 * 16GB with.
jpayne@69	266 */
jpayne@69	267 uint32_t xcb_get_maximum_request_length(xcb_connection_t *c);
jpayne@69	268
jpayne@69	269 /**
jpayne@69	270 * @brief Prefetch the maximum request length without blocking.
jpayne@69	271 * @param c The connection to the X server.
jpayne@69	272 *
jpayne@69	273 * Without blocking, does as much work as possible toward computing
jpayne@69	274 * the maximum request length accepted by the X server.
jpayne@69	275 *
jpayne@69	276 * Invoking this function may cause a call to xcb_big_requests_enable,
jpayne@69	277 * but will not block waiting for the reply.
jpayne@69	278 * xcb_get_maximum_request_length will return the prefetched data
jpayne@69	279 * after possibly blocking while the reply is retrieved.
jpayne@69	280 *
jpayne@69	281 * Note that in order for this function to be fully non-blocking, the
jpayne@69	282 * application must previously have called
jpayne@69	283 * xcb_prefetch_extension_data(c, &xcb_big_requests_id) and the reply
jpayne@69	284 * must have already arrived.
jpayne@69	285 */
jpayne@69	286 void xcb_prefetch_maximum_request_length(xcb_connection_t *c);
jpayne@69	287
jpayne@69	288
jpayne@69	289 /* xcb_in.c */
jpayne@69	290
jpayne@69	291 /**
jpayne@69	292 * @brief Returns the next event or error from the server.
jpayne@69	293 * @param c The connection to the X server.
jpayne@69	294 * @return The next event from the server.
jpayne@69	295 *
jpayne@69	296 * Returns the next event or error from the server, or returns null in
jpayne@69	297 * the event of an I/O error. Blocks until either an event or error
jpayne@69	298 * arrive, or an I/O error occurs.
jpayne@69	299 */
jpayne@69	300 xcb_generic_event_t xcb_wait_for_event(xcb_connection_t c);
jpayne@69	301
jpayne@69	302 /**
jpayne@69	303 * @brief Returns the next event or error from the server.
jpayne@69	304 * @param c The connection to the X server.
jpayne@69	305 * @return The next event from the server.
jpayne@69	306 *
jpayne@69	307 * Returns the next event or error from the server, if one is
jpayne@69	308 * available, or returns @c NULL otherwise. If no event is available, that
jpayne@69	309 * might be because an I/O error like connection close occurred while
jpayne@69	310 * attempting to read the next event, in which case the connection is
jpayne@69	311 * shut down when this function returns.
jpayne@69	312 */
jpayne@69	313 xcb_generic_event_t xcb_poll_for_event(xcb_connection_t c);
jpayne@69	314
jpayne@69	315 /**
jpayne@69	316 * @brief Returns the next event without reading from the connection.
jpayne@69	317 * @param c The connection to the X server.
jpayne@69	318 * @return The next already queued event from the server.
jpayne@69	319 *
jpayne@69	320 * This is a version of xcb_poll_for_event that only examines the
jpayne@69	321 * event queue for new events. The function doesn't try to read new
jpayne@69	322 * events from the connection if no queued events are found.
jpayne@69	323 *
jpayne@69	324 * This function is useful for callers that know in advance that all
jpayne@69	325 * interesting events have already been read from the connection. For
jpayne@69	326 * example, callers might use xcb_wait_for_reply and be interested
jpayne@69	327 * only of events that preceded a specific reply.
jpayne@69	328 */
jpayne@69	329 xcb_generic_event_t xcb_poll_for_queued_event(xcb_connection_t c);
jpayne@69	330
jpayne@69	331 typedef struct xcb_special_event xcb_special_event_t;
jpayne@69	332
jpayne@69	333 /**
jpayne@69	334 * @brief Returns the next event from a special queue
jpayne@69	335 */
jpayne@69	336 xcb_generic_event_t xcb_poll_for_special_event(xcb_connection_t c,
jpayne@69	337 xcb_special_event_t *se);
jpayne@69	338
jpayne@69	339 /**
jpayne@69	340 * @brief Returns the next event from a special queue, blocking until one arrives
jpayne@69	341 */
jpayne@69	342 xcb_generic_event_t xcb_wait_for_special_event(xcb_connection_t c,
jpayne@69	343 xcb_special_event_t *se);
jpayne@69	344 /**
jpayne@69	345 * @typedef typedef struct xcb_extension_t xcb_extension_t
jpayne@69	346 */
jpayne@69	347 typedef struct xcb_extension_t xcb_extension_t; /*< Opaque structure used as key for xcb_get_extension_data_t. /
jpayne@69	348
jpayne@69	349 /**
jpayne@69	350 * @brief Listen for a special event
jpayne@69	351 */
jpayne@69	352 xcb_special_event_t xcb_register_for_special_xge(xcb_connection_t c,
jpayne@69	353 xcb_extension_t *ext,
jpayne@69	354 uint32_t eid,
jpayne@69	355 uint32_t *stamp);
jpayne@69	356
jpayne@69	357 /**
jpayne@69	358 * @brief Stop listening for a special event
jpayne@69	359 */
jpayne@69	360 void xcb_unregister_for_special_event(xcb_connection_t *c,
jpayne@69	361 xcb_special_event_t *se);
jpayne@69	362
jpayne@69	363 /**
jpayne@69	364 * @brief Return the error for a request, or NULL if none can ever arrive.
jpayne@69	365 * @param c The connection to the X server.
jpayne@69	366 * @param cookie The request cookie.
jpayne@69	367 * @return The error for the request, or NULL if none can ever arrive.
jpayne@69	368 *
jpayne@69	369 * The xcb_void_cookie_t cookie supplied to this function must have resulted
jpayne@69	370 * from a call to xcb_[request_name]_checked(). This function will block
jpayne@69	371 * until one of two conditions happens. If an error is received, it will be
jpayne@69	372 * returned. If a reply to a subsequent request has already arrived, no error
jpayne@69	373 * can arrive for this request, so this function will return NULL.
jpayne@69	374 *
jpayne@69	375 * Note that this function will perform a sync if needed to ensure that the
jpayne@69	376 * sequence number will advance beyond that provided in cookie; this is a
jpayne@69	377 * convenience to avoid races in determining whether the sync is needed.
jpayne@69	378 */
jpayne@69	379 xcb_generic_error_t xcb_request_check(xcb_connection_t c, xcb_void_cookie_t cookie);
jpayne@69	380
jpayne@69	381 /**
jpayne@69	382 * @brief Discards the reply for a request.
jpayne@69	383 * @param c The connection to the X server.
jpayne@69	384 * @param sequence The request sequence number from a cookie.
jpayne@69	385 *
jpayne@69	386 * Discards the reply for a request. Additionally, any error generated
jpayne@69	387 * by the request is also discarded (unless it was an _unchecked request
jpayne@69	388 * and the error has already arrived).
jpayne@69	389 *
jpayne@69	390 * This function will not block even if the reply is not yet available.
jpayne@69	391 *
jpayne@69	392 * Note that the sequence really does have to come from an xcb cookie;
jpayne@69	393 * this function is not designed to operate on socket-handoff replies.
jpayne@69	394 */
jpayne@69	395 void xcb_discard_reply(xcb_connection_t *c, unsigned int sequence);
jpayne@69	396
jpayne@69	397 /**
jpayne@69	398 * @brief Discards the reply for a request, given by a 64bit sequence number
jpayne@69	399 * @param c The connection to the X server.
jpayne@69	400 * @param sequence 64-bit sequence number as returned by xcb_send_request64().
jpayne@69	401 *
jpayne@69	402 * Discards the reply for a request. Additionally, any error generated
jpayne@69	403 * by the request is also discarded (unless it was an _unchecked request
jpayne@69	404 * and the error has already arrived).
jpayne@69	405 *
jpayne@69	406 * This function will not block even if the reply is not yet available.
jpayne@69	407 *
jpayne@69	408 * Note that the sequence really does have to come from xcb_send_request64();
jpayne@69	409 * the cookie sequence number is defined as "unsigned" int and therefore
jpayne@69	410 * not 64-bit on all platforms.
jpayne@69	411 * This function is not designed to operate on socket-handoff replies.
jpayne@69	412 *
jpayne@69	413 * Unlike its xcb_discard_reply() counterpart, the given sequence number is not
jpayne@69	414 * automatically "widened" to 64-bit.
jpayne@69	415 */
jpayne@69	416 void xcb_discard_reply64(xcb_connection_t *c, uint64_t sequence);
jpayne@69	417
jpayne@69	418 /* xcb_ext.c */
jpayne@69	419
jpayne@69	420 /**
jpayne@69	421 * @brief Caches reply information from QueryExtension requests.
jpayne@69	422 * @param c The connection.
jpayne@69	423 * @param ext The extension data.
jpayne@69	424 * @return A pointer to the xcb_query_extension_reply_t for the extension.
jpayne@69	425 *
jpayne@69	426 * This function is the primary interface to the "extension cache",
jpayne@69	427 * which caches reply information from QueryExtension
jpayne@69	428 * requests. Invoking this function may cause a call to
jpayne@69	429 * xcb_query_extension to retrieve extension information from the
jpayne@69	430 * server, and may block until extension data is received from the
jpayne@69	431 * server.
jpayne@69	432 *
jpayne@69	433 * The result must not be freed. This storage is managed by the cache
jpayne@69	434 * itself.
jpayne@69	435 */
jpayne@69	436 const struct xcb_query_extension_reply_t xcb_get_extension_data(xcb_connection_t c, xcb_extension_t *ext);
jpayne@69	437
jpayne@69	438 /**
jpayne@69	439 * @brief Prefetch of extension data into the extension cache
jpayne@69	440 * @param c The connection.
jpayne@69	441 * @param ext The extension data.
jpayne@69	442 *
jpayne@69	443 * This function allows a "prefetch" of extension data into the
jpayne@69	444 * extension cache. Invoking the function may cause a call to
jpayne@69	445 * xcb_query_extension, but will not block waiting for the
jpayne@69	446 * reply. xcb_get_extension_data will return the prefetched data after
jpayne@69	447 * possibly blocking while it is retrieved.
jpayne@69	448 */
jpayne@69	449 void xcb_prefetch_extension_data(xcb_connection_t c, xcb_extension_t ext);
jpayne@69	450
jpayne@69	451
jpayne@69	452 /* xcb_conn.c */
jpayne@69	453
jpayne@69	454 /**
jpayne@69	455 * @brief Access the data returned by the server.
jpayne@69	456 * @param c The connection.
jpayne@69	457 * @return A pointer to an xcb_setup_t structure.
jpayne@69	458 *
jpayne@69	459 * Accessor for the data returned by the server when the xcb_connection_t
jpayne@69	460 * was initialized. This data includes
jpayne@69	461 * - the server's required format for images,
jpayne@69	462 * - a list of available visuals,
jpayne@69	463 * - a list of available screens,
jpayne@69	464 * - the server's maximum request length (in the absence of the
jpayne@69	465 * BIG-REQUESTS extension),
jpayne@69	466 * - and other assorted information.
jpayne@69	467 *
jpayne@69	468 * See the X protocol specification for more details.
jpayne@69	469 *
jpayne@69	470 * The result must not be freed.
jpayne@69	471 */
jpayne@69	472 const struct xcb_setup_t xcb_get_setup(xcb_connection_t c);
jpayne@69	473
jpayne@69	474 /**
jpayne@69	475 * @brief Access the file descriptor of the connection.
jpayne@69	476 * @param c The connection.
jpayne@69	477 * @return The file descriptor.
jpayne@69	478 *
jpayne@69	479 * Accessor for the file descriptor that was passed to the
jpayne@69	480 * xcb_connect_to_fd call that returned @p c.
jpayne@69	481 */
jpayne@69	482 int xcb_get_file_descriptor(xcb_connection_t *c);
jpayne@69	483
jpayne@69	484 /**
jpayne@69	485 * @brief Test whether the connection has shut down due to a fatal error.
jpayne@69	486 * @param c The connection.
jpayne@69	487 * @return > 0 if the connection is in an error state; 0 otherwise.
jpayne@69	488 *
jpayne@69	489 * Some errors that occur in the context of an xcb_connection_t
jpayne@69	490 * are unrecoverable. When such an error occurs, the
jpayne@69	491 * connection is shut down and further operations on the
jpayne@69	492 * xcb_connection_t have no effect, but memory will not be freed until
jpayne@69	493 * xcb_disconnect() is called on the xcb_connection_t.
jpayne@69	494 *
jpayne@69	495 * @return XCB_CONN_ERROR, because of socket errors, pipe errors or other stream errors.
jpayne@69	496 * @return XCB_CONN_CLOSED_EXT_NOTSUPPORTED, when extension not supported.
jpayne@69	497 * @return XCB_CONN_CLOSED_MEM_INSUFFICIENT, when memory not available.
jpayne@69	498 * @return XCB_CONN_CLOSED_REQ_LEN_EXCEED, exceeding request length that server accepts.
jpayne@69	499 * @return XCB_CONN_CLOSED_PARSE_ERR, error during parsing display string.
jpayne@69	500 * @return XCB_CONN_CLOSED_INVALID_SCREEN, because the server does not have a screen matching the display.
jpayne@69	501 */
jpayne@69	502 int xcb_connection_has_error(xcb_connection_t *c);
jpayne@69	503
jpayne@69	504 /**
jpayne@69	505 * @brief Connects to the X server.
jpayne@69	506 * @param fd The file descriptor.
jpayne@69	507 * @param auth_info Authentication data.
jpayne@69	508 * @return A newly allocated xcb_connection_t structure.
jpayne@69	509 *
jpayne@69	510 * Connects to an X server, given the open socket @p fd and the
jpayne@69	511 * xcb_auth_info_t @p auth_info. The file descriptor @p fd is
jpayne@69	512 * bidirectionally connected to an X server. If the connection
jpayne@69	513 * should be unauthenticated, @p auth_info must be @c
jpayne@69	514 * NULL.
jpayne@69	515 *
jpayne@69	516 * Always returns a non-NULL pointer to a xcb_connection_t, even on failure.
jpayne@69	517 * Callers need to use xcb_connection_has_error() to check for failure.
jpayne@69	518 * When finished, use xcb_disconnect() to close the connection and free
jpayne@69	519 * the structure.
jpayne@69	520 */
jpayne@69	521 xcb_connection_t xcb_connect_to_fd(int fd, xcb_auth_info_t auth_info);
jpayne@69	522
jpayne@69	523 /**
jpayne@69	524 * @brief Closes the connection.
jpayne@69	525 * @param c The connection.
jpayne@69	526 *
jpayne@69	527 * Closes the file descriptor and frees all memory associated with the
jpayne@69	528 * connection @c c. If @p c is @c NULL, nothing is done.
jpayne@69	529 */
jpayne@69	530 void xcb_disconnect(xcb_connection_t *c);
jpayne@69	531
jpayne@69	532
jpayne@69	533 /* xcb_util.c */
jpayne@69	534
jpayne@69	535 /**
jpayne@69	536 * @brief Parses a display string name in the form documented by X(7x).
jpayne@69	537 * @param name The name of the display.
jpayne@69	538 * @param host A pointer to a malloc'd copy of the hostname.
jpayne@69	539 * @param display A pointer to the display number.
jpayne@69	540 * @param screen A pointer to the screen number.
jpayne@69	541 * @return 0 on failure, non 0 otherwise.
jpayne@69	542 *
jpayne@69	543 * Parses the display string name @p display_name in the form
jpayne@69	544 * documented by X(7x). Has no side effects on failure. If
jpayne@69	545 * @p displayname is @c NULL or empty, it uses the environment
jpayne@69	546 * variable DISPLAY. @p hostp is a pointer to a newly allocated string
jpayne@69	547 * that contain the host name. @p displayp is set to the display
jpayne@69	548 * number and @p screenp to the preferred screen number. @p screenp
jpayne@69	549 * can be @c NULL. If @p displayname does not contain a screen number,
jpayne@69	550 * it is set to @c 0.
jpayne@69	551 */
jpayne@69	552 int xcb_parse_display(const char name, char host, int display, int *screen);
jpayne@69	553
jpayne@69	554 /**
jpayne@69	555 * @brief Connects to the X server.
jpayne@69	556 * @param displayname The name of the display.
jpayne@69	557 * @param screenp A pointer to a preferred screen number.
jpayne@69	558 * @return A newly allocated xcb_connection_t structure.
jpayne@69	559 *
jpayne@69	560 * Connects to the X server specified by @p displayname. If @p
jpayne@69	561 * displayname is @c NULL, uses the value of the DISPLAY environment
jpayne@69	562 * variable. If a particular screen on that server is preferred, the
jpayne@69	563 * int pointed to by @p screenp (if not @c NULL) will be set to that
jpayne@69	564 * screen; otherwise the screen will be set to 0.
jpayne@69	565 *
jpayne@69	566 * Always returns a non-NULL pointer to a xcb_connection_t, even on failure.
jpayne@69	567 * Callers need to use xcb_connection_has_error() to check for failure.
jpayne@69	568 * When finished, use xcb_disconnect() to close the connection and free
jpayne@69	569 * the structure.
jpayne@69	570 */
jpayne@69	571 xcb_connection_t xcb_connect(const char displayname, int *screenp);
jpayne@69	572
jpayne@69	573 /**
jpayne@69	574 * @brief Connects to the X server, using an authorization information.
jpayne@69	575 * @param display The name of the display.
jpayne@69	576 * @param auth The authorization information.
jpayne@69	577 * @param screen A pointer to a preferred screen number.
jpayne@69	578 * @return A newly allocated xcb_connection_t structure.
jpayne@69	579 *
jpayne@69	580 * Connects to the X server specified by @p displayname, using the
jpayne@69	581 * authorization @p auth. If a particular screen on that server is
jpayne@69	582 * preferred, the int pointed to by @p screenp (if not @c NULL) will
jpayne@69	583 * be set to that screen; otherwise @p screenp will be set to 0.
jpayne@69	584 *
jpayne@69	585 * Always returns a non-NULL pointer to a xcb_connection_t, even on failure.
jpayne@69	586 * Callers need to use xcb_connection_has_error() to check for failure.
jpayne@69	587 * When finished, use xcb_disconnect() to close the connection and free
jpayne@69	588 * the structure.
jpayne@69	589 */
jpayne@69	590 xcb_connection_t xcb_connect_to_display_with_auth_info(const char display, xcb_auth_info_t auth, int screen);
jpayne@69	591
jpayne@69	592
jpayne@69	593 /* xcb_xid.c */
jpayne@69	594
jpayne@69	595 /**
jpayne@69	596 * @brief Allocates an XID for a new object.
jpayne@69	597 * @param c The connection.
jpayne@69	598 * @return A newly allocated XID, or -1 on failure.
jpayne@69	599 *
jpayne@69	600 * Allocates an XID for a new object. Typically used just prior to
jpayne@69	601 * various object creation functions, such as xcb_create_window.
jpayne@69	602 */
jpayne@69	603 uint32_t xcb_generate_id(xcb_connection_t *c);
jpayne@69	604
jpayne@69	605
jpayne@69	606 /**
jpayne@69	607 * @brief Obtain number of bytes read from the connection.
jpayne@69	608 * @param c The connection
jpayne@69	609 * @return Number of bytes read from the server.
jpayne@69	610 *
jpayne@69	611 * Returns cumulative number of bytes received from the connection.
jpayne@69	612 *
jpayne@69	613 * This retrieves the total number of bytes read from this connection,
jpayne@69	614 * to be used for diagnostic/monitoring/informative purposes.
jpayne@69	615 */
jpayne@69	616
jpayne@69	617 uint64_t
jpayne@69	618 xcb_total_read(xcb_connection_t *c);
jpayne@69	619
jpayne@69	620 /**
jpayne@69	621 *
jpayne@69	622 * @brief Obtain number of bytes written to the connection.
jpayne@69	623 * @param c The connection
jpayne@69	624 * @return Number of bytes written to the server.
jpayne@69	625 *
jpayne@69	626 * Returns cumulative number of bytes sent to the connection.
jpayne@69	627 *
jpayne@69	628 * This retrieves the total number of bytes written to this connection,
jpayne@69	629 * to be used for diagnostic/monitoring/informative purposes.
jpayne@69	630 */
jpayne@69	631
jpayne@69	632 uint64_t
jpayne@69	633 xcb_total_written(xcb_connection_t *c);
jpayne@69	634
jpayne@69	635 /**
jpayne@69	636 * @}
jpayne@69	637 */
jpayne@69	638
jpayne@69	639 #ifdef __cplusplus
jpayne@69	640 }
jpayne@69	641 #endif
jpayne@69	642
jpayne@69	643
jpayne@69	644 #endif /* __XCB_H__ */

Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/xcb/xcb.h @ 69:33d812a61356